2000-01-21 17:50:27 +00:00
|
|
|
=pod
|
|
|
|
|
|
|
|
=head1 NAME
|
|
|
|
|
2000-02-24 11:55:57 +00:00
|
|
|
rand - pseudo-random number generator
|
2000-01-21 17:50:27 +00:00
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
|
|
|
#include <openssl/rand.h>
|
|
|
|
|
2001-03-21 15:26:47 +00:00
|
|
|
int RAND_bytes(unsigned char *buf, int num);
|
|
|
|
int RAND_pseudo_bytes(unsigned char *buf, int num);
|
2000-01-21 17:50:27 +00:00
|
|
|
|
2001-03-21 15:26:47 +00:00
|
|
|
void RAND_seed(const void *buf, int num);
|
|
|
|
void RAND_add(const void *buf, int num, int entropy);
|
2000-02-24 02:51:47 +00:00
|
|
|
int RAND_status(void);
|
2000-01-21 17:50:27 +00:00
|
|
|
void RAND_screen(void);
|
|
|
|
|
2001-03-21 15:26:47 +00:00
|
|
|
int RAND_load_file(const char *file, long max_bytes);
|
2000-01-21 17:50:27 +00:00
|
|
|
int RAND_write_file(const char *file);
|
2001-03-21 15:26:47 +00:00
|
|
|
const char *RAND_file_name(char *file, size_t num);
|
2000-01-21 17:50:27 +00:00
|
|
|
|
2000-02-24 02:51:47 +00:00
|
|
|
int RAND_egd(const char *path);
|
|
|
|
|
2000-01-21 17:50:27 +00:00
|
|
|
void RAND_set_rand_method(RAND_METHOD *meth);
|
|
|
|
RAND_METHOD *RAND_get_rand_method(void);
|
|
|
|
RAND_METHOD *RAND_SSLeay(void);
|
|
|
|
|
|
|
|
void RAND_cleanup(void);
|
|
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
|
|
|
These functions implement a cryptographically secure pseudo-random
|
|
|
|
number generator (PRNG). It is used by other library functions for
|
|
|
|
example to generate random keys, and applications can use it when they
|
|
|
|
need randomness.
|
|
|
|
|
|
|
|
A cryptographic PRNG must be seeded with unpredictable data such as
|
|
|
|
mouse movements or keys pressed at random by the user. This is
|
2000-01-27 01:25:31 +00:00
|
|
|
described in L<RAND_add(3)|RAND_add(3)>. Its state can be saved in a seed file
|
|
|
|
(see L<RAND_load_file(3)|RAND_load_file(3)>) to avoid having to go through the
|
|
|
|
seeding process whenever the application is started.
|
2000-01-21 17:50:27 +00:00
|
|
|
|
2000-01-27 01:25:31 +00:00
|
|
|
L<RAND_bytes(3)|RAND_bytes(3)> describes how to obtain random data from the
|
|
|
|
PRNG.
|
2000-01-21 17:50:27 +00:00
|
|
|
|
|
|
|
=head1 INTERNALS
|
|
|
|
|
|
|
|
The RAND_SSLeay() method implements a PRNG based on a cryptographic
|
|
|
|
hash function.
|
|
|
|
|
|
|
|
The following description of its design is based on the SSLeay
|
|
|
|
documentation:
|
|
|
|
|
|
|
|
First up I will state the things I believe I need for a good RNG.
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item 1
|
|
|
|
|
|
|
|
A good hashing algorithm to mix things up and to convert the RNG 'state'
|
|
|
|
to random numbers.
|
|
|
|
|
|
|
|
=item 2
|
|
|
|
|
|
|
|
An initial source of random 'state'.
|
|
|
|
|
|
|
|
=item 3
|
|
|
|
|
|
|
|
The state should be very large. If the RNG is being used to generate
|
|
|
|
4096 bit RSA keys, 2 2048 bit random strings are required (at a minimum).
|
|
|
|
If your RNG state only has 128 bits, you are obviously limiting the
|
|
|
|
search space to 128 bits, not 2048. I'm probably getting a little
|
|
|
|
carried away on this last point but it does indicate that it may not be
|
|
|
|
a bad idea to keep quite a lot of RNG state. It should be easier to
|
|
|
|
break a cipher than guess the RNG seed data.
|
|
|
|
|
|
|
|
=item 4
|
|
|
|
|
|
|
|
Any RNG seed data should influence all subsequent random numbers
|
|
|
|
generated. This implies that any random seed data entered will have
|
|
|
|
an influence on all subsequent random numbers generated.
|
|
|
|
|
|
|
|
=item 5
|
|
|
|
|
|
|
|
When using data to seed the RNG state, the data used should not be
|
|
|
|
extractable from the RNG state. I believe this should be a
|
|
|
|
requirement because one possible source of 'secret' semi random
|
|
|
|
data would be a private key or a password. This data must
|
|
|
|
not be disclosed by either subsequent random numbers or a
|
|
|
|
'core' dump left by a program crash.
|
|
|
|
|
|
|
|
=item 6
|
|
|
|
|
|
|
|
Given the same initial 'state', 2 systems should deviate in their RNG state
|
|
|
|
(and hence the random numbers generated) over time if at all possible.
|
|
|
|
|
|
|
|
=item 7
|
|
|
|
|
|
|
|
Given the random number output stream, it should not be possible to determine
|
|
|
|
the RNG state or the next random number.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
|
|
|
The algorithm is as follows.
|
|
|
|
|
|
|
|
There is global state made up of a 1023 byte buffer (the 'state'), a
|
2000-01-22 23:11:13 +00:00
|
|
|
working hash value ('md'), and a counter ('count').
|
2000-01-21 17:50:27 +00:00
|
|
|
|
|
|
|
Whenever seed data is added, it is inserted into the 'state' as
|
|
|
|
follows.
|
|
|
|
|
2000-01-22 23:11:13 +00:00
|
|
|
The input is chopped up into units of 20 bytes (or less for
|
2000-01-21 23:36:40 +00:00
|
|
|
the last block). Each of these blocks is run through the hash
|
|
|
|
function as follows: The data passed to the hash function
|
|
|
|
is the current 'md', the same number of bytes from the 'state'
|
|
|
|
(the location determined by in incremented looping index) as
|
|
|
|
the current 'block', the new key data 'block', and 'count'
|
|
|
|
(which is incremented after each use).
|
|
|
|
The result of this is kept in 'md' and also xored into the
|
|
|
|
'state' at the same locations that were used as input into the
|
|
|
|
hash function. I
|
2000-01-21 17:50:27 +00:00
|
|
|
believe this system addresses points 1 (hash function; currently
|
|
|
|
SHA-1), 3 (the 'state'), 4 (via the 'md'), 5 (by the use of a hash
|
|
|
|
function and xor).
|
|
|
|
|
|
|
|
When bytes are extracted from the RNG, the following process is used.
|
2000-01-22 23:11:13 +00:00
|
|
|
For each group of 10 bytes (or less), we do the following:
|
2000-01-21 17:50:27 +00:00
|
|
|
|
2000-01-22 23:11:13 +00:00
|
|
|
Input into the hash function the top 10 bytes from the local 'md'
|
|
|
|
(which is initialized from the global 'md' before any bytes are
|
|
|
|
generated), the bytes that are to be overwritten by the random bytes,
|
|
|
|
and bytes from the 'state' (incrementing looping index). From this
|
|
|
|
digest output (which is kept in 'md'), the top (up to) 10 bytes are
|
|
|
|
returned to the caller and the bottom (up to) 10 bytes are xored into
|
|
|
|
the 'state'.
|
2000-01-21 17:50:27 +00:00
|
|
|
|
2000-01-21 23:39:15 +00:00
|
|
|
Finally, after we have finished 'num' random bytes for the caller,
|
|
|
|
'count' (which is incremented) and the local and global 'md' are fed
|
|
|
|
into the hash function and the results are kept in the global 'md'.
|
|
|
|
|
|
|
|
I believe the above addressed points 1 (use of SHA-1), 6 (by hashing
|
|
|
|
into the 'state' the 'old' data from the caller that is about to be
|
2000-01-22 23:11:13 +00:00
|
|
|
overwritten) and 7 (by not using the 10 bytes given to the caller to
|
2000-01-21 23:39:15 +00:00
|
|
|
update the 'state', but they are used to update 'md').
|
2000-01-21 17:50:27 +00:00
|
|
|
|
|
|
|
So of the points raised, only 2 is not addressed (but see
|
2000-01-27 01:25:31 +00:00
|
|
|
L<RAND_add(3)|RAND_add(3)>).
|
2000-01-21 17:50:27 +00:00
|
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
|
2000-01-27 01:25:31 +00:00
|
|
|
L<BN_rand(3)|BN_rand(3)>, L<RAND_add(3)|RAND_add(3)>,
|
2000-02-24 02:51:47 +00:00
|
|
|
L<RAND_load_file(3)|RAND_load_file(3)>, L<RAND_egd(3)|RAND_egd(3)>,
|
|
|
|
L<RAND_bytes(3)|RAND_bytes(3)>,
|
2000-01-27 01:25:31 +00:00
|
|
|
L<RAND_set_rand_method(3)|RAND_set_rand_method(3)>,
|
|
|
|
L<RAND_cleanup(3)|RAND_cleanup(3)>
|
2000-01-21 17:50:27 +00:00
|
|
|
|
|
|
|
=cut
|