$NetBSD: RAND_DRBG_generate.3,v 1.3 2020/12/10 00:33:12 christos Exp $

Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)

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
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
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 "RAND_DRBG_generate 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
RAND_DRBG_generate, RAND_DRBG_bytes \- generate random bytes using the given drbg instance libcrypto, -lcrypto Header "SYNOPSIS" .Vb 1 #include <openssl/rand_drbg.h> \& int RAND_DRBG_generate(RAND_DRBG *drbg, unsigned char *out, size_t outlen, int prediction_resistance, const unsigned char *adin, size_t adinlen); \& int RAND_DRBG_bytes(RAND_DRBG *drbg, unsigned char *out, size_t outlen); .Ve Header "DESCRIPTION" \fBRAND_DRBG_generate() generates outlen random bytes using the given \s-1DRBG\s0 instance drbg and stores them in the buffer at out.

Before generating the output, the \s-1DRBG\s0 instance checks whether the maximum number of generate requests (reseed interval) or the maximum timespan (reseed time interval) since its last seeding have been reached. If this is the case, the \s-1DRBG\s0 reseeds automatically. Additionally, an immediate reseeding can be requested by setting the \fBprediction_resistance flag to 1. See \s-1NOTES\s0 section for more details.

The caller can optionally provide additional data to be used for reseeding by passing a pointer adin to a buffer of length adinlen. This additional data is mixed into the internal state of the random generator but does not contribute to the entropy count. The additional data can be omitted by setting adin to \s-1NULL\s0 and \fBadinlen to 0;

\fBRAND_DRBG_bytes() generates outlen random bytes using the given \s-1DRBG\s0 instance drbg and stores them in the buffer at out. This function is a wrapper around the RAND_DRBG_generate() call, which collects some additional data from low entropy sources (e.g., a high resolution timer) and calls RAND_DRBG_generate(drbg, out, outlen, 0, adin, adinlen).

Header "RETURN VALUES" \fBRAND_DRBG_generate() and RAND_DRBG_bytes() return 1 on success, and 0 on failure. Header "NOTES" The reseed interval and reseed time interval of the drbg are set to reasonable default values, which in general do not have to be adjusted. If necessary, they can be changed using RAND_DRBG_set_reseed_interval\|(3) and RAND_DRBG_set_reseed_time_interval\|(3), respectively.

A request for prediction resistance can only be satisfied by pulling fresh entropy from one of the approved entropy sources listed in section 5.5.2 of [\s-1NIST SP 800-90C\s0]. Since the default \s-1DRBG\s0 implementation does not have access to such an approved entropy source, a request for prediction resistance will always fail. In other words, prediction resistance is currently not supported yet by the \s-1DRBG.\s0

Header "SEE ALSO" \fBRAND_bytes\|(3), \fBRAND_DRBG_set_reseed_interval\|(3), \fBRAND_DRBG_set_reseed_time_interval\|(3), \s-1RAND_DRBG\s0\|(7) Header "HISTORY" The \s-1RAND_DRBG\s0 functions were added in OpenSSL 1.1.1. Header "COPYRIGHT" Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (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>.