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