secure/lib/libcrypto/man/man3/RAND_bytes.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 "RAND_BYTES 3"
 136 .TH RAND_BYTES 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 RAND_bytes, RAND_priv_bytes, RAND_pseudo_bytes \- generate random data
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/rand.h>
 147 \&
 148 \& int RAND_bytes(unsigned char *buf, int num);
 149 \& int RAND_priv_bytes(unsigned char *buf, int num);
 150 .Ve
 151 .PP
 152 Deprecated:
 153 .PP
 154 .Vb 3
 155 \& #if OPENSSL_API_COMPAT < 0x10100000L
 156 \& int RAND_pseudo_bytes(unsigned char *buf, int num);
 157 \& #endif
 158 .Ve
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 \&\fBRAND_bytes()\fR generates \fBnum\fR random bytes using a cryptographically
 162 secure pseudo random generator (\s-1CSPRNG\s0) and stores them in \fBbuf\fR.
 163 .PP
 164 \&\fBRAND_priv_bytes()\fR has the same semantics as \fBRAND_bytes()\fR.  It is intended to
 165 be used for generating values that should remain private. If using the
 166 default \s-1RAND_METHOD,\s0 this function uses a separate \*(L"private\*(R" \s-1PRNG\s0
 167 instance so that a compromise of the \*(L"public\*(R" \s-1PRNG\s0 instance will not
 168 affect the secrecy of these private values, as described in \s-1\fBRAND\s0\fR\|(7)
 169 and \s-1\fBRAND_DRBG\s0\fR\|(7).
 170 .SH "NOTES"
 171 .IX Header "NOTES"
 172 By default, the OpenSSL \s-1CSPRNG\s0 supports a security level of 256 bits, provided it
 173 was able to seed itself from a trusted entropy source.
 174 On all major platforms supported by OpenSSL (including the Unix-like platforms
 175 and Windows), OpenSSL is configured to automatically seed the \s-1CSPRNG\s0 on first use
 176 using the operating systems's random generator.
 177 .PP
 178 If the entropy source fails or is not available, the \s-1CSPRNG\s0 will enter an
 179 error state and refuse to generate random bytes. For that reason, it is important
 180 to always check the error return value of \fBRAND_bytes()\fR and \fBRAND_priv_bytes()\fR and
 181 not take randomness for granted.
 182 .PP
 183 On other platforms, there might not be a trusted entropy source available
 184 or OpenSSL might have been explicitly configured to use different entropy sources.
 185 If you are in doubt about the quality of the entropy source, don't hesitate to ask
 186 your operating system vendor or post a question on GitHub or the openssl-users
 187 mailing list.
 188 .SH "RETURN VALUES"
 189 .IX Header "RETURN VALUES"
 190 \&\fBRAND_bytes()\fR and \fBRAND_priv_bytes()\fR
 191 return 1 on success, \-1 if not supported by the current
 192 \&\s-1RAND\s0 method, or 0 on other failure. The error code can be
 193 obtained by \fBERR_get_error\fR\|(3).
 194 .SH "SEE ALSO"
 195 .IX Header "SEE ALSO"
 196 \&\fBRAND_add\fR\|(3),
 197 \&\fBRAND_bytes\fR\|(3),
 198 \&\fBRAND_priv_bytes\fR\|(3),
 199 \&\fBERR_get_error\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 \&\fBRAND_pseudo_bytes()\fR was deprecated in OpenSSL 1.1.0; use \fBRAND_bytes()\fR instead.
 206 .IP "\(bu" 2
 207 The \fBRAND_priv_bytes()\fR function was added in OpenSSL 1.1.1.
 208 .SH "COPYRIGHT"
 209 .IX Header "COPYRIGHT"
 210 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
 211 .PP
 212 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 213 this file except in compliance with the License.  You can obtain a copy
 214 in the file \s-1LICENSE\s0 in the source distribution or at
 215 <https://www.openssl.org/source/license.html>.