Debian Codegraph @

upstream/debian-unstable/man7/EVP_RAND-HMAC-DRBG.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-HMAC-DRBG 7SSL"
58 .TH EVP_RAND-HMAC-DRBG 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\-HMAC\-DRBG \- The HMAC DRBG EVP_RAND implementation
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Support for the HMAC deterministic random bit generator through the
68 \&\fBEVP_RAND\fR API.
69 .SS Identity
70 .IX Subsection "Identity"
71 "HMAC-DRBG" 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 """strength"" (\fBOSSL_RAND_PARAM_STRENGTH\fR) <unsigned integer>" 4
80 .IX Item """strength"" (OSSL_RAND_PARAM_STRENGTH) <unsigned integer>"
81 .IP """max_request"" (\fBOSSL_RAND_PARAM_MAX_REQUEST\fR) <unsigned integer>" 4
82 .IX Item """max_request"" (OSSL_RAND_PARAM_MAX_REQUEST) <unsigned integer>"
83 .IP """reseed_requests"" (\fBOSSL_DRBG_PARAM_RESEED_REQUESTS\fR) <unsigned integer>" 4
84 .IX Item """reseed_requests"" (OSSL_DRBG_PARAM_RESEED_REQUESTS) <unsigned integer>"
85 .IP """reseed_time_interval"" (\fBOSSL_DRBG_PARAM_RESEED_TIME_INTERVAL\fR) <integer>" 4
86 .IX Item """reseed_time_interval"" (OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL) <integer>"
87 .IP """min_entropylen"" (\fBOSSL_DRBG_PARAM_MIN_ENTROPYLEN\fR) <unsigned integer>" 4
88 .IX Item """min_entropylen"" (OSSL_DRBG_PARAM_MIN_ENTROPYLEN) <unsigned integer>"
89 .IP """max_entropylen"" (\fBOSSL_DRBG_PARAM_MAX_ENTROPYLEN\fR) <unsigned integer>" 4
90 .IX Item """max_entropylen"" (OSSL_DRBG_PARAM_MAX_ENTROPYLEN) <unsigned integer>"
91 .IP """min_noncelen"" (\fBOSSL_DRBG_PARAM_MIN_NONCELEN\fR) <unsigned integer>" 4
92 .IX Item """min_noncelen"" (OSSL_DRBG_PARAM_MIN_NONCELEN) <unsigned integer>"
93 .IP """max_noncelen"" (\fBOSSL_DRBG_PARAM_MAX_NONCELEN\fR) <unsigned integer>" 4
94 .IX Item """max_noncelen"" (OSSL_DRBG_PARAM_MAX_NONCELEN) <unsigned integer>"
95 .IP """max_perslen"" (\fBOSSL_DRBG_PARAM_MAX_PERSLEN\fR) <unsigned integer>" 4
96 .IX Item """max_perslen"" (OSSL_DRBG_PARAM_MAX_PERSLEN) <unsigned integer>"
97 .IP """max_adinlen"" (\fBOSSL_DRBG_PARAM_MAX_ADINLEN\fR) <unsigned integer>" 4
98 .IX Item """max_adinlen"" (OSSL_DRBG_PARAM_MAX_ADINLEN) <unsigned integer>"
99 .IP """reseed_counter"" (\fBOSSL_DRBG_PARAM_RESEED_COUNTER\fR) <unsigned integer>" 4
100 .IX Item """reseed_counter"" (OSSL_DRBG_PARAM_RESEED_COUNTER) <unsigned integer>"
101 .IP """properties"" (\fBOSSL_DRBG_PARAM_PROPERTIES\fR) <UTF8 string>" 4
102 .IX Item """properties"" (OSSL_DRBG_PARAM_PROPERTIES) <UTF8 string>"
103 .IP """mac"" (\fBOSSL_DRBG_PARAM_MAC\fR) <UTF8 string>" 4
104 .IX Item """mac"" (OSSL_DRBG_PARAM_MAC) <UTF8 string>"
105 .IP """digest"" (\fBOSSL_DRBG_PARAM_DIGEST\fR) <UTF8 string>" 4
106 .IX Item """digest"" (OSSL_DRBG_PARAM_DIGEST) <UTF8 string>"
107 .PD
108 These parameters work as described in "PARAMETERS" in \fBEVP_RAND\fR\|(3).
109 .IP """fips-indicator"" (\fBOSSL_DRBG_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
110 .IX Item """fips-indicator"" (OSSL_DRBG_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
111 .PD 0
112 .IP """digest-check"" (\fBOSSL_DRBG_PARAM_FIPS_DIGEST_CHECK\fR) <integer>" 4
113 .IX Item """digest-check"" (OSSL_DRBG_PARAM_FIPS_DIGEST_CHECK) <integer>"
114 .PD
115 These parameters work as described in "PARAMETERS" in \fBprovider\-rand\fR\|(7).
116 .SH NOTES
117 .IX Header "NOTES"
118 When using the FIPS provider, only these digests are permitted (as per
119 FIPS 140\-3 IG D.R <https://csrc.nist.gov/CSRC/media/Projects/cryptographic-module-validation-program/documents/fips%20140-3/FIPS%20140-3%20IG.pdf>):
120 .PP
121 The default HMAC-DRBG implementation attempts to fetch the required internal
122 algorithms from the provider they are built into (eg the default provider)
123 regardless of the properties provided. Should the provider not implement
124 the required algorithms then properties will be used to find a different
125 implementation.
126 .IP SHA\-1 4
127 .IX Item "SHA-1"
128 .PD 0
129 .IP SHA2\-256 4
130 .IX Item "SHA2-256"
131 .IP SHA2\-512 4
132 .IX Item "SHA2-512"
133 .IP SHA3\-256 4
134 .IX Item "SHA3-256"
135 .IP SHA3\-512 4
136 .IX Item "SHA3-512"
137 .PD
138 .PP
139 A context for HMAC DRBG can be obtained by calling:
140 .PP
141 .Vb 2
142 \& EVP_RAND *rand = EVP_RAND_fetch(NULL, "HMAC\-DRBG", NULL);
143 \& EVP_RAND_CTX *rctx = EVP_RAND_CTX_new(rand, NULL);
144 .Ve
145 .SH EXAMPLES
146 .IX Header "EXAMPLES"
147 .Vb 5
148 \& EVP_RAND *rand;
149 \& EVP_RAND_CTX *rctx;
150 \& unsigned char bytes[100];
151 \& OSSL_PARAM params[3], *p = params;
152 \& unsigned int strength = 128;
153 \&
154 \& rand = EVP_RAND_fetch(NULL, "HMAC\-DRBG", NULL);
155 \& rctx = EVP_RAND_CTX_new(rand, NULL);
156 \& EVP_RAND_free(rand);
157 \&
158 \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_MAC, SN_hmac, 0);
159 \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_DIGEST, SN_sha256, 0);
160 \& *p = OSSL_PARAM_construct_end();
161 \& EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params);
162 \&
163 \& EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0);
164 \&
165 \& EVP_RAND_CTX_free(rctx);
166 .Ve
167 .SH "CONFORMING TO"
168 .IX Header "CONFORMING TO"
169 NIST SP 800\-90A and SP 800\-90B
170 .SH "SEE ALSO"
171 .IX Header "SEE ALSO"
172 \&\fBEVP_RAND\fR\|(3),
173 "PARAMETERS" in \fBEVP_RAND\fR\|(3),
174 \&\fBopenssl\-fipsinstall\fR\|(1)
175 .SH HISTORY
176 .IX Header "HISTORY"
177 OpenSSL 3.1.1 introduced the \fB\-no_drbg_truncated_digests\fR option to
178 fipsinstall which restricts the permitted digests when using the FIPS
179 provider in a complaint manner. For details refer to
180 FIPS 140\-3 IG D.R <https://csrc.nist.gov/CSRC/media/Projects/cryptographic-module-validation-program/documents/fips%20140-3/FIPS%20140-3%20IG.pdf>).
181 .SH COPYRIGHT
182 .IX Header "COPYRIGHT"
183 Copyright 2020\-2025 The OpenSSL Project Authors. All Rights Reserved.
184 .PP
185 Licensed under the Apache License 2.0 (the "License"). You may not use
186 this file except in compliance with the License. You can obtain a copy
187 in the file LICENSE in the source distribution or at
188 <https://www.openssl.org/source/license.html>.