secure/lib/libcrypto/man/rand.3

   1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" Escape single quotes in literal strings from groff's Unicode transform.
  52 .ie \n(.g .ds Aq \(aq
  53 .el       .ds Aq '
  54 .\"
  55 .\" If the F register is turned on, we'll generate index entries on stderr for
  56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  58 .\" output yourself in some meaningful fashion.
  59 .ie \nF \{\
  60 .    de IX
  61 .    tm Index:\\$1\t\\n%\t"\\$2"
  62 ..
  63 .    nr % 0
  64 .    rr F
  65 .\}
  66 .el \{\
  67 .    de IX
  68 ..
  69 .\}
  70 .\"
  71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  73 .    \" fudge factors for nroff and troff
  74 .if n \{\
  75 .    ds #H 0
  76 .    ds #V .8m
  77 .    ds #F .3m
  78 .    ds #[ \f1
  79 .    ds #] \fP
  80 .\}
  81 .if t \{\
  82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  83 .    ds #V .6m
  84 .    ds #F 0
  85 .    ds #[ \&
  86 .    ds #] \&
  87 .\}
  88 .    \" simple accents for nroff and troff
  89 .if n \{\
  90 .    ds ' \&
  91 .    ds ` \&
  92 .    ds ^ \&
  93 .    ds , \&
  94 .    ds ~ ~
  95 .    ds /
  96 .\}
  97 .if t \{\
  98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 104 .\}
 105 .    \" troff and (daisy-wheel) nroff accents
 106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 113 .ds ae a\h'-(\w'a'u*4/10)'e
 114 .ds Ae A\h'-(\w'A'u*4/10)'E
 115 .    \" corrections for vroff
 116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 118 .    \" for low resolution devices (crt and lpr)
 119 .if \n(.H>23 .if \n(.V>19 \
 120 \{\
 121 .    ds : e
 122 .    ds 8 ss
 123 .    ds o a
 124 .    ds d- d\h'-1'\(ga
 125 .    ds D- D\h'-1'\(hy
 126 .    ds th \o'bp'
 127 .    ds Th \o'LP'
 128 .    ds ae ae
 129 .    ds Ae AE
 130 .\}
 131 .rm #[ #] #H #V #F C
 132 .\" ========================================================================
 133 .\"
 134 .IX Title "rand 3"
 135 .TH rand 3 "2009-11-06" "0.9.8l" "OpenSSL"
 136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 137 .\" way too many mistakes in technical documents.
 138 .if n .ad l
 139 .nh
 140 .SH "NAME"
 141 rand \- pseudo\-random number generator
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 .Vb 1
 145 \& #include <openssl/rand.h>
 146 \&
 147 \& int  RAND_set_rand_engine(ENGINE *engine);
 148 \&
 149 \& int  RAND_bytes(unsigned char *buf, int num);
 150 \& int  RAND_pseudo_bytes(unsigned char *buf, int num);
 151 \&
 152 \& void RAND_seed(const void *buf, int num);
 153 \& void RAND_add(const void *buf, int num, int entropy);
 154 \& int  RAND_status(void);
 155 \&
 156 \& int  RAND_load_file(const char *file, long max_bytes);
 157 \& int  RAND_write_file(const char *file);
 158 \& const char *RAND_file_name(char *file, size_t num);
 159 \&
 160 \& int  RAND_egd(const char *path);
 161 \&
 162 \& void RAND_set_rand_method(const RAND_METHOD *meth);
 163 \& const RAND_METHOD *RAND_get_rand_method(void);
 164 \& RAND_METHOD *RAND_SSLeay(void);
 165 \&
 166 \& void RAND_cleanup(void);
 167 \&
 168 \& /* For Win32 only */
 169 \& void RAND_screen(void);
 170 \& int RAND_event(UINT, WPARAM, LPARAM);
 171 .Ve
 172 .SH "DESCRIPTION"
 173 .IX Header "DESCRIPTION"
 174 Since the introduction of the \s-1ENGINE\s0 \s-1API\s0, the recommended way of controlling
 175 default implementations is by using the \s-1ENGINE\s0 \s-1API\s0 functions. The default
 176 \&\fB\s-1RAND_METHOD\s0\fR, as set by \fIRAND_set_rand_method()\fR and returned by
 177 \&\fIRAND_get_rand_method()\fR, is only used if no \s-1ENGINE\s0 has been set as the default
 178 \&\*(L"rand\*(R" implementation. Hence, these two functions are no longer the recommened
 179 way to control defaults.
 180 .PP
 181 If an alternative \fB\s-1RAND_METHOD\s0\fR implementation is being used (either set
 182 directly or as provided by an \s-1ENGINE\s0 module), then it is entirely responsible
 183 for the generation and management of a cryptographically secure \s-1PRNG\s0 stream. The
 184 mechanisms described below relate solely to the software \s-1PRNG\s0 implementation
 185 built in to OpenSSL and used by default.
 186 .PP
 187 These functions implement a cryptographically secure pseudo-random
 188 number generator (\s-1PRNG\s0). It is used by other library functions for
 189 example to generate random keys, and applications can use it when they
 190 need randomness.
 191 .PP
 192 A cryptographic \s-1PRNG\s0 must be seeded with unpredictable data such as
 193 mouse movements or keys pressed at random by the user. This is
 194 described in \fIRAND_add\fR\|(3). Its state can be saved in a seed file
 195 (see \fIRAND_load_file\fR\|(3)) to avoid having to go through the
 196 seeding process whenever the application is started.
 197 .PP
 198 \&\fIRAND_bytes\fR\|(3) describes how to obtain random data from the
 199 \&\s-1PRNG\s0.
 200 .SH "INTERNALS"
 201 .IX Header "INTERNALS"
 202 The \fIRAND_SSLeay()\fR method implements a \s-1PRNG\s0 based on a cryptographic
 203 hash function.
 204 .PP
 205 The following description of its design is based on the SSLeay
 206 documentation:
 207 .PP
 208 First up I will state the things I believe I need for a good \s-1RNG\s0.
 209 .IP "1." 4
 210 A good hashing algorithm to mix things up and to convert the \s-1RNG\s0 'state'
 211 to random numbers.
 212 .IP "2." 4
 213 An initial source of random 'state'.
 214 .IP "3." 4
 215 The state should be very large.  If the \s-1RNG\s0 is being used to generate
 216 4096 bit \s-1RSA\s0 keys, 2 2048 bit random strings are required (at a minimum).
 217 If your \s-1RNG\s0 state only has 128 bits, you are obviously limiting the
 218 search space to 128 bits, not 2048.  I'm probably getting a little
 219 carried away on this last point but it does indicate that it may not be
 220 a bad idea to keep quite a lot of \s-1RNG\s0 state.  It should be easier to
 221 break a cipher than guess the \s-1RNG\s0 seed data.
 222 .IP "4." 4
 223 Any \s-1RNG\s0 seed data should influence all subsequent random numbers
 224 generated.  This implies that any random seed data entered will have
 225 an influence on all subsequent random numbers generated.
 226 .IP "5." 4
 227 When using data to seed the \s-1RNG\s0 state, the data used should not be
 228 extractable from the \s-1RNG\s0 state.  I believe this should be a
 229 requirement because one possible source of 'secret' semi random
 230 data would be a private key or a password.  This data must
 231 not be disclosed by either subsequent random numbers or a
 232 \&'core' dump left by a program crash.
 233 .IP "6." 4
 234 Given the same initial 'state', 2 systems should deviate in their \s-1RNG\s0 state
 235 (and hence the random numbers generated) over time if at all possible.
 236 .IP "7." 4
 237 Given the random number output stream, it should not be possible to determine
 238 the \s-1RNG\s0 state or the next random number.
 239 .PP
 240 The algorithm is as follows.
 241 .PP
 242 There is global state made up of a 1023 byte buffer (the 'state'), a
 243 working hash value ('md'), and a counter ('count').
 244 .PP
 245 Whenever seed data is added, it is inserted into the 'state' as
 246 follows.
 247 .PP
 248 The input is chopped up into units of 20 bytes (or less for
 249 the last block).  Each of these blocks is run through the hash
 250 function as follows:  The data passed to the hash function
 251 is the current 'md', the same number of bytes from the 'state'
 252 (the location determined by in incremented looping index) as
 253 the current 'block', the new key data 'block', and 'count'
 254 (which is incremented after each use).
 255 The result of this is kept in 'md' and also xored into the
 256 \&'state' at the same locations that were used as input into the
 257 hash function. I
 258 believe this system addresses points 1 (hash function; currently
 259 \&\s-1SHA\-1\s0), 3 (the 'state'), 4 (via the 'md'), 5 (by the use of a hash
 260 function and xor).
 261 .PP
 262 When bytes are extracted from the \s-1RNG\s0, the following process is used.
 263 For each group of 10 bytes (or less), we do the following:
 264 .PP
 265 Input into the hash function the local 'md' (which is initialized from
 266 the global 'md' before any bytes are generated), the bytes that are to
 267 be overwritten by the random bytes, and bytes from the 'state'
 268 (incrementing looping index). From this digest output (which is kept
 269 in 'md'), the top (up to) 10 bytes are returned to the caller and the
 270 bottom 10 bytes are xored into the 'state'.
 271 .PP
 272 Finally, after we have finished 'num' random bytes for the caller,
 273 \&'count' (which is incremented) and the local and global 'md' are fed
 274 into the hash function and the results are kept in the global 'md'.
 275 .PP
 276 I believe the above addressed points 1 (use of \s-1SHA\-1\s0), 6 (by hashing
 277 into the 'state' the 'old' data from the caller that is about to be
 278 overwritten) and 7 (by not using the 10 bytes given to the caller to
 279 update the 'state', but they are used to update 'md').
 280 .PP
 281 So of the points raised, only 2 is not addressed (but see
 282 \&\fIRAND_add\fR\|(3)).
 283 .SH "SEE ALSO"
 284 .IX Header "SEE ALSO"
 285 \&\fIBN_rand\fR\|(3), \fIRAND_add\fR\|(3),
 286 \&\fIRAND_load_file\fR\|(3), \fIRAND_egd\fR\|(3),
 287 \&\fIRAND_bytes\fR\|(3),
 288 \&\fIRAND_set_rand_method\fR\|(3),
 289 \&\fIRAND_cleanup\fR\|(3)