secure/lib/libcrypto/man/man3/BN_rand.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "BN_RAND 3"
 136 .TH BN_RAND 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 BN_rand, BN_priv_rand, BN_pseudo_rand, BN_rand_range, BN_priv_rand_range, BN_pseudo_rand_range \&\- generate pseudo\-random number
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/bn.h>
 147 \&
 148 \& int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
 149 \&
 150 \& int BN_priv_rand(BIGNUM *rnd, int bits, int top, int bottom);
 151 \&
 152 \& int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
 153 \&
 154 \& int BN_rand_range(BIGNUM *rnd, BIGNUM *range);
 155 \&
 156 \& int BN_priv_rand_range(BIGNUM *rnd, BIGNUM *range);
 157 \&
 158 \& int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
 159 .Ve
 160 .SH "DESCRIPTION"
 161 .IX Header "DESCRIPTION"
 162 \&\fBBN_rand()\fR generates a cryptographically strong pseudo-random number of
 163 \&\fBbits\fR in length and stores it in \fBrnd\fR.
 164 If \fBbits\fR is less than zero, or too small to
 165 accommodate the requirements specified by the \fBtop\fR and \fBbottom\fR
 166 parameters, an error is returned.
 167 The \fBtop\fR parameters specifies
 168 requirements on the most significant bit of the generated number.
 169 If it is \fB\s-1BN_RAND_TOP_ANY\s0\fR, there is no constraint.
 170 If it is \fB\s-1BN_RAND_TOP_ONE\s0\fR, the top bit must be one.
 171 If it is \fB\s-1BN_RAND_TOP_TWO\s0\fR, the two most significant bits of
 172 the number will be set to 1, so that the product of two such random
 173 numbers will always have 2*\fBbits\fR length.
 174 If \fBbottom\fR is \fB\s-1BN_RAND_BOTTOM_ODD\s0\fR, the number will be odd; if it
 175 is \fB\s-1BN_RAND_BOTTOM_ANY\s0\fR it can be odd or even.
 176 If \fBbits\fR is 1 then \fBtop\fR cannot also be \fB\s-1BN_RAND_TOP_TWO\s0\fR.
 177 .PP
 178 \&\fBBN_rand_range()\fR generates a cryptographically strong pseudo-random
 179 number \fBrnd\fR in the range 0 <= \fBrnd\fR < \fBrange\fR.
 180 .PP
 181 \&\fBBN_priv_rand()\fR and \fBBN_priv_rand_range()\fR have the same semantics as
 182 \&\fBBN_rand()\fR and \fBBN_rand_range()\fR respectively.  They are intended to be
 183 used for generating values that should remain private, and mirror the
 184 same difference between \fBRAND_bytes\fR\|(3) and \fBRAND_priv_bytes\fR\|(3).
 185 .SH "NOTES"
 186 .IX Header "NOTES"
 187 Always check the error return value of these functions and do not take
 188 randomness for granted: an error occurs if the \s-1CSPRNG\s0 has not been
 189 seeded with enough randomness to ensure an unpredictable byte sequence.
 190 .SH "RETURN VALUES"
 191 .IX Header "RETURN VALUES"
 192 The functions return 1 on success, 0 on error.
 193 The error codes can be obtained by \fBERR_get_error\fR\|(3).
 194 .SH "SEE ALSO"
 195 .IX Header "SEE ALSO"
 196 \&\fBERR_get_error\fR\|(3),
 197 \&\fBRAND_add\fR\|(3),
 198 \&\fBRAND_bytes\fR\|(3),
 199 \&\fBRAND_priv_bytes\fR\|(3),
 200 \&\s-1\fBRAND\s0\fR\|(7),
 201 \&\s-1\fBRAND_DRBG\s0\fR\|(7)
 202 .SH "HISTORY"
 203 .IX Header "HISTORY"
 204 .IP "\(bu" 2
 205 Starting with OpenSSL release 1.1.0, \fBBN_pseudo_rand()\fR has been identical
 206 to \fBBN_rand()\fR and \fBBN_pseudo_rand_range()\fR has been identical to
 207 \&\fBBN_rand_range()\fR.
 208 The \*(L"pseudo\*(R" functions should not be used and may be deprecated in
 209 a future release.
 210 .IP "\(bu" 2
 211 The
 212 \&\fBBN_priv_rand()\fR and \fBBN_priv_rand_range()\fR functions were added in OpenSSL 1.1.1.
 213 .SH "COPYRIGHT"
 214 .IX Header "COPYRIGHT"
 215 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
 216 .PP
 217 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 218 this file except in compliance with the License.  You can obtain a copy
 219 in the file \s-1LICENSE\s0 in the source distribution or at
 220 <https://www.openssl.org/source/license.html>.