Debian Codegraph @

upstream/debian-unstable/man7/EVP_RAND-JITTER.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-JITTER 7SSL"
58 .TH EVP_RAND-JITTER 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\-JITTER \- 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 This software seed source produces randomness based on tiny CPU
71 "jitter" fluctuations.
72 .PP
73 It is available when OpenSSL is compiled with \fBenable-jitter\fR
74 option. When available it is listed in \fBopenssl list
75 \&\-random\-generators\fR and \fBopenssl info \-seeds\fR.
76 .SS Identity
77 .IX Subsection "Identity"
78 "JITTER" is the name for this implementation; it can be used with the
79 \&\fBEVP_RAND_fetch()\fR function.
80 .SS "Supported parameters"
81 .IX Subsection "Supported parameters"
82 The supported parameters are:
83 .IP """state"" (\fBOSSL_RAND_PARAM_STATE\fR) <integer>" 4
84 .IX Item """state"" (OSSL_RAND_PARAM_STATE) <integer>"
85 .PD 0
86 .IP """strength"" (\fBOSSL_RAND_PARAM_STRENGTH\fR) <unsigned integer>" 4
87 .IX Item """strength"" (OSSL_RAND_PARAM_STRENGTH) <unsigned integer>"
88 .IP """max_request"" (\fBOSSL_RAND_PARAM_MAX_REQUEST\fR) <unsigned integer>" 4
89 .IX Item """max_request"" (OSSL_RAND_PARAM_MAX_REQUEST) <unsigned integer>"
90 .PD
91 These parameters work as described in "PARAMETERS" in \fBEVP_RAND\fR\|(3).
92 .SH NOTES
93 .IX Header "NOTES"
94 A context for the seed source can be obtained by calling:
95 .PP
96 .Vb 2
97 \& EVP_RAND *rand = EVP_RAND_fetch(NULL, "JITTER", NULL);
98 \& EVP_RAND_CTX *rctx = EVP_RAND_CTX_new(rand, NULL);
99 .Ve
100 .PP
101 The \fBenable-jitter\fR option was added in OpenSSL 3.4.
102 .PP
103 By specifying the \fBenable-fips-jitter\fR configuration option, the FIPS
104 provider will use an internal jitter source for its entropy. Enabling
105 this option will cause the FIPS provider to operate in a non-compliant
106 mode unless an entropy assessment
107 ESV <https://csrc.nist.gov/Projects/cryptographic-module-validation-program/entropy-validations>
108 and validation through the
109 CMVP <https://csrc.nist.gov/projects/cryptographic-module-validation-program>
110 are additionally conducted. This option was added in OpenSSL 3.5.
111 .SH EXAMPLES
112 .IX Header "EXAMPLES"
113 .Vb 5
114 \& EVP_RAND *rand;
115 \& EVP_RAND_CTX *seed, *rctx;
116 \& unsigned char bytes[100];
117 \& OSSL_PARAM params[2], *p = params;
118 \& unsigned int strength = 128;
119 \&
120 \& /* Create and instantiate a seed source */
121 \& rand = EVP_RAND_fetch(NULL, "JITTER", NULL);
122 \& seed = EVP_RAND_CTX_new(rand, NULL);
123 \& EVP_RAND_instantiate(seed, strength, 0, NULL, 0, NULL);
124 \& EVP_RAND_free(rand);
125 \&
126 \& /* Feed this into a DRBG */
127 \& rand = EVP_RAND_fetch(NULL, "CTR\-DRBG", NULL);
128 \& rctx = EVP_RAND_CTX_new(rand, seed);
129 \& EVP_RAND_free(rand);
130 \&
131 \& /* Configure the DRBG */
132 \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_CIPHER,
133 \& SN_aes_256_ctr, 0);
134 \& *p = OSSL_PARAM_construct_end();
135 \& EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params);
136 \&
137 \& EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0);
138 \&
139 \& EVP_RAND_CTX_free(rctx);
140 \& EVP_RAND_CTX_free(seed);
141 .Ve
142 .SH "SEE ALSO"
143 .IX Header "SEE ALSO"
144 \&\fBEVP_RAND\fR\|(3),
145 "PARAMETERS" in \fBEVP_RAND\fR\|(3)
146 .SH COPYRIGHT
147 .IX Header "COPYRIGHT"
148 Copyright 2024 The OpenSSL Project Authors. All Rights Reserved.
149 .PP
150 Licensed under the Apache License 2.0 (the "License"). You may not use
151 this file except in compliance with the License. You can obtain a copy
152 in the file LICENSE in the source distribution or at
153 <https://www.openssl.org/source/license.html>.