xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/EVP_RAND-CTR-DRBG.7 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: EVP_RAND-CTR-DRBG.7,v 1.5 2024/09/08 13:08:24 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================

Title "EVP_RAND-CTR-DRBG 7"
EVP_RAND-CTR-DRBG 7 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
EVP_RAND-CTR-DRBG - The CTR DRBG EVP_RAND implementation
DESCRIPTION
Header "DESCRIPTION" Support for the counter deterministic random bit generator through the \fBEVP_RAND API.
Identity
Subsection "Identity" "CTR-DRBG" 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:
"""state"" (OSSL_RAND_PARAM_STATE) <integer>" 4
Item """state"" (OSSL_RAND_PARAM_STATE) <integer>"

0

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

These parameters work as described in "PARAMETERS" in EVP_RAND\|(3).

"""use_derivation_function"" (OSSL_DRBG_PARAM_USE_DF) <integer>" 4
Item """use_derivation_function"" (OSSL_DRBG_PARAM_USE_DF) <integer>" This Boolean indicates if a derivation function should be used or not. A nonzero value (the default) uses the derivation function. A zero value does not.
NOTES
Header "NOTES" A context for CTR DRBG can be obtained by calling:

.Vb 2 EVP_RAND *rand = EVP_RAND_fetch(NULL, "CTR-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[2], *p = params; unsigned int strength = 128; \& rand = EVP_RAND_fetch(NULL, "CTR-DRBG", NULL); rctx = EVP_RAND_CTX_new(rand, NULL); EVP_RAND_free(rand); \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_CIPHER, SN_aes_256_ctr, 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" NIST SP 800-90A and SP 800-90B
"SEE ALSO"
Header "SEE ALSO" \fBEVP_RAND\|(3), "PARAMETERS" in EVP_RAND\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.

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