xref: /freebsd/secure/lib/libcrypto/man/man7/EVP_RAND-HMAC-DRBG.7 (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "EVP_RAND-HMAC-DRBG 7ossl"
EVP_RAND-HMAC-DRBG 7ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
EVP_RAND-HMAC-DRBG - The HMAC DRBG EVP_RAND implementation
"DESCRIPTION"
Header "DESCRIPTION" Support for the \s-1HMAC\s0 deterministic random bit generator through the \fB\s-1EVP_RAND\s0 \s-1API.\s0
"Identity"
Subsection "Identity" \*(L"HMAC-DRBG\*(R" is the name for this implementation; it can be used with the \fBEVP_RAND_fetch() function.
"Supported parameters"
Subsection "Supported parameters" The supported parameters are: Item "state (OSSL_RAND_PARAM_STATE) <integer>"

0 Item "strength (OSSL_RAND_PARAM_STRENGTH) <unsigned integer>" Item "max_request (OSSL_RAND_PARAM_MAX_REQUEST) <unsigned integer>" Item "reseed_requests (OSSL_DRBG_PARAM_RESEED_REQUESTS) <unsigned integer>" Item "reseed_time_interval (OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL) <integer>" Item "min_entropylen (OSSL_DRBG_PARAM_MIN_ENTROPYLEN) <unsigned integer>" Item "max_entropylen (OSSL_DRBG_PARAM_MAX_ENTROPYLEN) <unsigned integer>" Item "min_noncelen (OSSL_DRBG_PARAM_MIN_NONCELEN) <unsigned integer>" Item "max_noncelen (OSSL_DRBG_PARAM_MAX_NONCELEN) <unsigned integer>" Item "max_perslen (OSSL_DRBG_PARAM_MAX_PERSLEN) <unsigned integer>" Item "max_adinlen (OSSL_DRBG_PARAM_MAX_ADINLEN) <unsigned integer>" Item "reseed_counter (OSSL_DRBG_PARAM_RESEED_COUNTER) <unsigned integer>" Item "properties (OSSL_DRBG_PARAM_PROPERTIES) <UTF8 string>" Item "mac (OSSL_DRBG_PARAM_MAC) <UTF8 string>" Item "digest (OSSL_DRBG_PARAM_DIGEST) <UTF8 string>"

These parameters work as described in \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1EVP_RAND\s0\|(3).

"NOTES"
Header "NOTES" A context for \s-1HMAC DRBG\s0 can be obtained by calling:

.Vb 2 EVP_RAND *rand = EVP_RAND_fetch(NULL, "HMAC-DRBG", NULL); EVP_RAND_CTX *rctx = EVP_RAND_CTX_new(rand); .Ve

"EXAMPLES"
Header "EXAMPLES" .Vb 5 EVP_RAND *rand; EVP_RAND_CTX *rctx; unsigned char bytes[100]; OSSL_PARAM params[3], *p = params; unsigned int strength = 128; \& rand = EVP_RAND_fetch(NULL, "HMAC-DRBG", NULL); rctx = EVP_RAND_CTX_new(rand, NULL); EVP_RAND_free(rand); \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_MAC, SN_hmac, 0); *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_DIGEST, SN_sha256, 0); *p = OSSL_PARAM_construct_end(); EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params); \& EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0); \& EVP_RAND_CTX_free(rctx); .Ve
"CONFORMING TO"
Header "CONFORMING TO" \s-1NIST SP 800-90A\s0 and \s-1SP 800-90B\s0
"SEE ALSO"
Header "SEE ALSO" \s-1EVP_RAND\s0\|(3), \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1EVP_RAND\s0\|(3)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.