96901f109e64e3cdbd461684c02ff063663ce378
[openssl.git] / doc / crypto / rand.pod
1 =pod
2
3 =head1 NAME
4
5 rand - pseudo-random number generator
6
7 =head1 SYNOPSIS
8
9  #include <openssl/rand.h>
10
11  int  RAND_bytes(unsigned char *buf, int num);
12  int  RAND_pseudo_bytes(unsigned char *buf, int num);
13
14  void RAND_seed(const void *buf, int num);
15  void RAND_add(const void *buf, int num, int entropy);
16  int  RAND_status(void);
17  void RAND_screen(void);
18
19  int  RAND_load_file(const char *file, long max_bytes);
20  int  RAND_write_file(const char *file);
21  const char *RAND_file_name(char *file, size_t num);
22
23  int  RAND_egd(const char *path);
24
25  void RAND_set_rand_method(RAND_METHOD *meth);
26  RAND_METHOD *RAND_get_rand_method(void);
27  RAND_METHOD *RAND_SSLeay(void);
28
29  void RAND_cleanup(void);
30
31 =head1 DESCRIPTION
32
33 These functions implement a cryptographically secure pseudo-random
34 number generator (PRNG). It is used by other library functions for
35 example to generate random keys, and applications can use it when they
36 need randomness.
37
38 A cryptographic PRNG must be seeded with unpredictable data such as
39 mouse movements or keys pressed at random by the user. This is
40 described in L<RAND_add(3)|RAND_add(3)>. Its state can be saved in a seed file
41 (see L<RAND_load_file(3)|RAND_load_file(3)>) to avoid having to go through the
42 seeding process whenever the application is started.
43
44 L<RAND_bytes(3)|RAND_bytes(3)> describes how to obtain random data from the
45 PRNG. 
46
47 =head1 INTERNALS
48
49 The RAND_SSLeay() method implements a PRNG based on a cryptographic
50 hash function.
51
52 The following description of its design is based on the SSLeay
53 documentation:
54
55 First up I will state the things I believe I need for a good RNG.
56
57 =over 4
58
59 =item 1
60
61 A good hashing algorithm to mix things up and to convert the RNG 'state'
62 to random numbers.
63
64 =item 2
65
66 An initial source of random 'state'.
67
68 =item 3
69
70 The state should be very large.  If the RNG is being used to generate
71 4096 bit RSA keys, 2 2048 bit random strings are required (at a minimum).
72 If your RNG state only has 128 bits, you are obviously limiting the
73 search space to 128 bits, not 2048.  I'm probably getting a little
74 carried away on this last point but it does indicate that it may not be
75 a bad idea to keep quite a lot of RNG state.  It should be easier to
76 break a cipher than guess the RNG seed data.
77
78 =item 4
79
80 Any RNG seed data should influence all subsequent random numbers
81 generated.  This implies that any random seed data entered will have
82 an influence on all subsequent random numbers generated.
83
84 =item 5
85
86 When using data to seed the RNG state, the data used should not be
87 extractable from the RNG state.  I believe this should be a
88 requirement because one possible source of 'secret' semi random
89 data would be a private key or a password.  This data must
90 not be disclosed by either subsequent random numbers or a
91 'core' dump left by a program crash.
92
93 =item 6
94
95 Given the same initial 'state', 2 systems should deviate in their RNG state
96 (and hence the random numbers generated) over time if at all possible.
97
98 =item 7
99
100 Given the random number output stream, it should not be possible to determine
101 the RNG state or the next random number.
102
103 =back
104
105 The algorithm is as follows.
106
107 There is global state made up of a 1023 byte buffer (the 'state'), a
108 working hash value ('md'), and a counter ('count').
109
110 Whenever seed data is added, it is inserted into the 'state' as
111 follows.
112
113 The input is chopped up into units of 20 bytes (or less for
114 the last block).  Each of these blocks is run through the hash
115 function as follows:  The data passed to the hash function
116 is the current 'md', the same number of bytes from the 'state'
117 (the location determined by in incremented looping index) as
118 the current 'block', the new key data 'block', and 'count'
119 (which is incremented after each use).
120 The result of this is kept in 'md' and also xored into the
121 'state' at the same locations that were used as input into the
122 hash function. I
123 believe this system addresses points 1 (hash function; currently
124 SHA-1), 3 (the 'state'), 4 (via the 'md'), 5 (by the use of a hash
125 function and xor).
126
127 When bytes are extracted from the RNG, the following process is used.
128 For each group of 10 bytes (or less), we do the following:
129
130 Input into the hash function the local 'md' (which is initialized from
131 the global 'md' before any bytes are generated), the bytes that are to
132 be overwritten by the random bytes, and bytes from the 'state'
133 (incrementing looping index). From this digest output (which is kept
134 in 'md'), the top (up to) 10 bytes are returned to the caller and the
135 bottom 10 bytes are xored into the 'state'.
136
137 Finally, after we have finished 'num' random bytes for the caller,
138 'count' (which is incremented) and the local and global 'md' are fed
139 into the hash function and the results are kept in the global 'md'.
140
141 I believe the above addressed points 1 (use of SHA-1), 6 (by hashing
142 into the 'state' the 'old' data from the caller that is about to be
143 overwritten) and 7 (by not using the 10 bytes given to the caller to
144 update the 'state', but they are used to update 'md').
145
146 So of the points raised, only 2 is not addressed (but see
147 L<RAND_add(3)|RAND_add(3)>).
148
149 =head1 SEE ALSO
150
151 L<BN_rand(3)|BN_rand(3)>, L<RAND_add(3)|RAND_add(3)>,
152 L<RAND_load_file(3)|RAND_load_file(3)>, L<RAND_egd(3)|RAND_egd(3)>,
153 L<RAND_bytes(3)|RAND_bytes(3)>,
154 L<RAND_set_rand_method(3)|RAND_set_rand_method(3)>,
155 L<RAND_cleanup(3)|RAND_cleanup(3)> 
156
157 =cut