Debian Codegraph @

upstream/debian-unstable/man7/EVP_RAND-SEED-SRC.7ssl

raw
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-SEED-SRC 7SSL"
58 .TH EVP_RAND-SEED-SRC 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\-SEED\-SRC \- The randomness seed source EVP_RAND implementation
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Support for deterministic random number generator seeding through the
68 \&\fBEVP_RAND\fR API.
69 .PP
70 The seed sources used are specified at the time OpenSSL is configured for
71 building using the \fB\-\-with\-rand\-seed=\fR option. By default, operating system
72 randomness sources are used.
73 .SS Identity
74 .IX Subsection "Identity"
75 "SEED-SRC" is the name for this implementation; it can be used with the
76 \&\fBEVP_RAND_fetch()\fR function.
77 .SS "Supported parameters"
78 .IX Subsection "Supported parameters"
79 The supported parameters are:
80 .IP """state"" (\fBOSSL_RAND_PARAM_STATE\fR) <integer>" 4
81 .IX Item """state"" (OSSL_RAND_PARAM_STATE) <integer>"
82 .PD 0
83 .IP """strength"" (\fBOSSL_RAND_PARAM_STRENGTH\fR) <unsigned integer>" 4
84 .IX Item """strength"" (OSSL_RAND_PARAM_STRENGTH) <unsigned integer>"
85 .IP """max_request"" (\fBOSSL_RAND_PARAM_MAX_REQUEST\fR) <unsigned integer>" 4
86 .IX Item """max_request"" (OSSL_RAND_PARAM_MAX_REQUEST) <unsigned integer>"
87 .PD
88 These parameters work as described in "PARAMETERS" in \fBEVP_RAND\fR\|(3).
89 .SH NOTES
90 .IX Header "NOTES"
91 A context for the seed source can be obtained by calling:
92 .PP
93 .Vb 2
94 \& EVP_RAND *rand = EVP_RAND_fetch(NULL, "SEED\-SRC", NULL);
95 \& EVP_RAND_CTX *rctx = EVP_RAND_CTX_new(rand, NULL);
96 .Ve
97 .SH EXAMPLES
98 .IX Header "EXAMPLES"
99 .Vb 5
100 \& EVP_RAND *rand;
101 \& EVP_RAND_CTX *seed, *rctx;
102 \& unsigned char bytes[100];
103 \& OSSL_PARAM params[2], *p = params;
104 \& unsigned int strength = 128;
105 \&
106 \& /* Create and instantiate a seed source */
107 \& rand = EVP_RAND_fetch(NULL, "SEED\-SRC", NULL);
108 \& seed = EVP_RAND_CTX_new(rand, NULL);
109 \& EVP_RAND_instantiate(seed, strength, 0, NULL, 0, NULL);
110 \& EVP_RAND_free(rand);
111 \&
112 \& /* Feed this into a DRBG */
113 \& rand = EVP_RAND_fetch(NULL, "CTR\-DRBG", NULL);
114 \& rctx = EVP_RAND_CTX_new(rand, seed);
115 \& EVP_RAND_free(rand);
116 \&
117 \& /* Configure the DRBG */
118 \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_CIPHER,
119 \& SN_aes_256_ctr, 0);
120 \& *p = OSSL_PARAM_construct_end();
121 \& EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params);
122 \&
123 \& EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0);
124 \&
125 \& EVP_RAND_CTX_free(rctx);
126 \& EVP_RAND_CTX_free(seed);
127 .Ve
128 .SH "SEE ALSO"
129 .IX Header "SEE ALSO"
130 \&\fBEVP_RAND\fR\|(3),
131 "PARAMETERS" in \fBEVP_RAND\fR\|(3)
132 .SH COPYRIGHT
133 .IX Header "COPYRIGHT"
134 Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved.
135 .PP
136 Licensed under the Apache License 2.0 (the "License"). You may not use
137 this file except in compliance with the License. You can obtain a copy
138 in the file LICENSE in the source distribution or at
139 <https://www.openssl.org/source/license.html>.