| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "EVP_RAND-TEST-RAND 7SSL" |
| 58 |
.TH EVP_RAND-TEST-RAND 7SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
EVP_RAND\-TEST\-RAND \- The test EVP_RAND implementation |
| 65 |
.SH DESCRIPTION |
| 66 |
.IX Header "DESCRIPTION" |
| 67 |
Support for a test generator through the \fBEVP_RAND\fR API. This generator is |
| 68 |
for test purposes only, it does not generate random numbers. |
| 69 |
.SS Identity |
| 70 |
.IX Subsection "Identity" |
| 71 |
"TEST-RAND" is the name for this implementation; it can be used with the |
| 72 |
\&\fBEVP_RAND_fetch()\fR function. |
| 73 |
.SS "Supported parameters" |
| 74 |
.IX Subsection "Supported parameters" |
| 75 |
The supported parameters are: |
| 76 |
.IP """state"" (\fBOSSL_RAND_PARAM_STATE\fR) <integer>" 4 |
| 77 |
.IX Item """state"" (OSSL_RAND_PARAM_STATE) <integer>" |
| 78 |
.PD 0 |
| 79 |
.IP """fips-indicator"" (\fBOSSL_RAND_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4 |
| 80 |
.IX Item """fips-indicator"" (OSSL_RAND_PARAM_FIPS_APPROVED_INDICATOR) <integer>" |
| 81 |
.PD |
| 82 |
These parameter works as described in "PARAMETERS" in \fBEVP_RAND\fR\|(3). |
| 83 |
.IP """strength"" (\fBOSSL_RAND_PARAM_STRENGTH\fR) <unsigned integer>" 4 |
| 84 |
.IX Item """strength"" (OSSL_RAND_PARAM_STRENGTH) <unsigned integer>" |
| 85 |
.PD 0 |
| 86 |
.IP """reseed_requests"" (\fBOSSL_DRBG_PARAM_RESEED_REQUESTS\fR) <unsigned integer>" 4 |
| 87 |
.IX Item """reseed_requests"" (OSSL_DRBG_PARAM_RESEED_REQUESTS) <unsigned integer>" |
| 88 |
.IP """reseed_time_interval"" (\fBOSSL_DRBG_PARAM_RESEED_TIME_INTERVAL\fR) <integer>" 4 |
| 89 |
.IX Item """reseed_time_interval"" (OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL) <integer>" |
| 90 |
.IP """max_request"" (\fBOSSL_DRBG_PARAM_RESEED_REQUESTS\fR) <unsigned integer>" 4 |
| 91 |
.IX Item """max_request"" (OSSL_DRBG_PARAM_RESEED_REQUESTS) <unsigned integer>" |
| 92 |
.IP """min_entropylen"" (\fBOSSL_DRBG_PARAM_MIN_ENTROPYLEN\fR) <unsigned integer>" 4 |
| 93 |
.IX Item """min_entropylen"" (OSSL_DRBG_PARAM_MIN_ENTROPYLEN) <unsigned integer>" |
| 94 |
.IP """max_entropylen"" (\fBOSSL_DRBG_PARAM_MAX_ENTROPYLEN\fR) <unsigned integer>" 4 |
| 95 |
.IX Item """max_entropylen"" (OSSL_DRBG_PARAM_MAX_ENTROPYLEN) <unsigned integer>" |
| 96 |
.IP """min_noncelen"" (\fBOSSL_DRBG_PARAM_MIN_NONCELEN\fR) <unsigned integer>" 4 |
| 97 |
.IX Item """min_noncelen"" (OSSL_DRBG_PARAM_MIN_NONCELEN) <unsigned integer>" |
| 98 |
.IP """max_noncelen"" (\fBOSSL_DRBG_PARAM_MAX_NONCELEN\fR) <unsigned integer>" 4 |
| 99 |
.IX Item """max_noncelen"" (OSSL_DRBG_PARAM_MAX_NONCELEN) <unsigned integer>" |
| 100 |
.IP """max_perslen"" (\fBOSSL_DRBG_PARAM_MAX_PERSLEN\fR) <unsigned integer>" 4 |
| 101 |
.IX Item """max_perslen"" (OSSL_DRBG_PARAM_MAX_PERSLEN) <unsigned integer>" |
| 102 |
.IP """max_adinlen"" (\fBOSSL_DRBG_PARAM_MAX_ADINLEN\fR) <unsigned integer>" 4 |
| 103 |
.IX Item """max_adinlen"" (OSSL_DRBG_PARAM_MAX_ADINLEN) <unsigned integer>" |
| 104 |
.IP """reseed_counter"" (\fBOSSL_DRBG_PARAM_RESEED_COUNTER\fR) <unsigned integer>" 4 |
| 105 |
.IX Item """reseed_counter"" (OSSL_DRBG_PARAM_RESEED_COUNTER) <unsigned integer>" |
| 106 |
.PD |
| 107 |
These parameters work as described in "PARAMETERS" in \fBEVP_RAND\fR\|(3), except that |
| 108 |
they can all be set as well as read. |
| 109 |
.IP """test_entropy"" (\fBOSSL_RAND_PARAM_TEST_ENTROPY\fR) <octet string>" 4 |
| 110 |
.IX Item """test_entropy"" (OSSL_RAND_PARAM_TEST_ENTROPY) <octet string>" |
| 111 |
Sets the bytes returned when the test generator is sent an entropy request. |
| 112 |
The current position is remembered across generate calls. |
| 113 |
If there are insufficient data present to satisfy a call, an error is returned. |
| 114 |
.IP """test_nonce"" (\fBOSSL_RAND_PARAM_TEST_NONCE\fR) <octet string>" 4 |
| 115 |
.IX Item """test_nonce"" (OSSL_RAND_PARAM_TEST_NONCE) <octet string>" |
| 116 |
Sets the bytes returned when the test generator is sent a nonce request. |
| 117 |
Each nonce request will return all of the bytes. |
| 118 |
.IP """generate"" (\fBOSSL_RAND_PARAM_GENERATE\fR) <integer>" 4 |
| 119 |
.IX Item """generate"" (OSSL_RAND_PARAM_GENERATE) <integer>" |
| 120 |
If this parameter is zero, it will only emit the nonce and entropy data |
| 121 |
supplied via the aforementioned parameters. Otherwise, low quality |
| 122 |
non-cryptographic pseudorandom output is produced. This parameter defaults |
| 123 |
to zero. |
| 124 |
.SH NOTES |
| 125 |
.IX Header "NOTES" |
| 126 |
A context for a test generator can be obtained by calling: |
| 127 |
.PP |
| 128 |
.Vb 2 |
| 129 |
\& EVP_RAND *rand = EVP_RAND_fetch(NULL, "TEST\-RAND", NULL); |
| 130 |
\& EVP_RAND_CTX *rctx = EVP_RAND_CTX_new(rand, NULL); |
| 131 |
.Ve |
| 132 |
.SH EXAMPLES |
| 133 |
.IX Header "EXAMPLES" |
| 134 |
.Vb 7 |
| 135 |
\& EVP_RAND *rand; |
| 136 |
\& EVP_RAND_CTX *rctx; |
| 137 |
\& unsigned char bytes[100]; |
| 138 |
\& OSSL_PARAM params[4], *p = params; |
| 139 |
\& unsigned char entropy[1000] = { ... }; |
| 140 |
\& unsigned char nonce[20] = { ... }; |
| 141 |
\& unsigned int strength = 48; |
| 142 |
\& |
| 143 |
\& rand = EVP_RAND_fetch(NULL, "TEST\-RAND", NULL); |
| 144 |
\& rctx = EVP_RAND_CTX_new(rand, NULL); |
| 145 |
\& EVP_RAND_free(rand); |
| 146 |
\& |
| 147 |
\& *p++ = OSSL_PARAM_construct_uint(OSSL_RAND_PARAM_STRENGTH, &strength); |
| 148 |
\& *p++ = OSSL_PARAM_construct_octet_string(OSSL_RAND_PARAM_TEST_ENTROPY, |
| 149 |
\& entropy, sizeof(entropy)); |
| 150 |
\& *p++ = OSSL_PARAM_construct_octet_string(OSSL_RAND_PARAM_TEST_NONCE, |
| 151 |
\& nonce, sizeof(nonce)); |
| 152 |
\& *p = OSSL_PARAM_construct_end(); |
| 153 |
\& EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params); |
| 154 |
\& |
| 155 |
\& EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0); |
| 156 |
\& |
| 157 |
\& EVP_RAND_CTX_free(rctx); |
| 158 |
.Ve |
| 159 |
.SH "SEE ALSO" |
| 160 |
.IX Header "SEE ALSO" |
| 161 |
\&\fBEVP_RAND\fR\|(3), |
| 162 |
"PARAMETERS" in \fBEVP_RAND\fR\|(3) |
| 163 |
.SH HISTORY |
| 164 |
.IX Header "HISTORY" |
| 165 |
This functionality was added in OpenSSL 3.0. |
| 166 |
.SH COPYRIGHT |
| 167 |
.IX Header "COPYRIGHT" |
| 168 |
Copyright 2020\-2024 The OpenSSL Project Authors. All Rights Reserved. |
| 169 |
.PP |
| 170 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 171 |
this file except in compliance with the License. You can obtain a copy |
| 172 |
in the file LICENSE in the source distribution or at |
| 173 |
<https://www.openssl.org/source/license.html>. |