xref: /freebsd/secure/lib/libcrypto/man/man3/BN_rand.3 (revision 058ac3e8063366dafa634d9107642e12b038bf09)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

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 "BN_RAND 3"
BN_RAND 3 "2022-11-01" "1.1.1s" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
BN_rand, BN_priv_rand, BN_pseudo_rand, BN_rand_range, BN_priv_rand_range, BN_pseudo_rand_range \- generate pseudo-random number
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/bn.h> \& int BN_rand(BIGNUM *rnd, int bits, int top, int bottom); \& int BN_priv_rand(BIGNUM *rnd, int bits, int top, int bottom); \& int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom); \& int BN_rand_range(BIGNUM *rnd, BIGNUM *range); \& int BN_priv_rand_range(BIGNUM *rnd, BIGNUM *range); \& int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBBN_rand() generates a cryptographically strong pseudo-random number of \fBbits in length and stores it in rnd. If bits is less than zero, or too small to accommodate the requirements specified by the top and bottom parameters, an error is returned. The top parameters specifies requirements on the most significant bit of the generated number. If it is \s-1BN_RAND_TOP_ANY\s0, there is no constraint. If it is \s-1BN_RAND_TOP_ONE\s0, the top bit must be one. If it is \s-1BN_RAND_TOP_TWO\s0, the two most significant bits of the number will be set to 1, so that the product of two such random numbers will always have 2*bits length. If bottom is \s-1BN_RAND_BOTTOM_ODD\s0, the number will be odd; if it is \s-1BN_RAND_BOTTOM_ANY\s0 it can be odd or even. If bits is 1 then top cannot also be \s-1BN_RAND_TOP_TWO\s0.

\fBBN_rand_range() generates a cryptographically strong pseudo-random number rnd in the range 0 <= rnd < range.

\fBBN_priv_rand() and BN_priv_rand_range() have the same semantics as \fBBN_rand() and BN_rand_range() respectively. They are intended to be used for generating values that should remain private, and mirror the same difference between RAND_bytes\|(3) and RAND_priv_bytes\|(3).

"NOTES"
Header "NOTES" Always check the error return value of these functions and do not take randomness for granted: an error occurs if the \s-1CSPRNG\s0 has not been seeded with enough randomness to ensure an unpredictable byte sequence.
"RETURN VALUES"
Header "RETURN VALUES" The functions return 1 on success, 0 on error. The error codes can be obtained by ERR_get_error\|(3).
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3), \fBRAND_add\|(3), \fBRAND_bytes\|(3), \fBRAND_priv_bytes\|(3), \s-1RAND\s0\|(7), \s-1RAND_DRBG\s0\|(7)
"HISTORY"
Header "HISTORY"
"\(bu" 2
Starting with OpenSSL release 1.1.0, BN_pseudo_rand() has been identical to BN_rand() and BN_pseudo_rand_range() has been identical to \fBBN_rand_range(). The \*(L"pseudo\*(R" functions should not be used and may be deprecated in a future release.
"\(bu" 2
The \fBBN_priv_rand() and BN_priv_rand_range() functions were added in OpenSSL 1.1.1.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2021 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>.