doc/crypto/RAND_add.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RAND_add, RAND_seed, RAND_screen - Add entropy to the PRNG
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rand.h>
  10
  11  void RAND_seed(const void *buf, int num);
  12
  13  void RAND_add(const void *buf, int num, int entropy);
  14
  15  void RAND_screen(void);
  16
  17 =head1 DESCRIPTION
  18
  19 RAND_add() mixes the B<num> bytes at B<buf> into the PRNG state. Thus,
  20 if the data at B<buf> are unpredictable to an adversary, this
  21 increases the uncertainty about the state and makes the PRNG output
  22 less predictable. Suitable input comes from user interaction (random
  23 key presses, mouse movements) and certain hardware events. The
  24 B<entropy> argument is (the lower bound of) an estimate of how much
  25 randomness is contained in B<buf>. Details about sources of randomness
  26 and how to estimate their entropy can be found in the literature,
  27 e.g. RFC 1750.
  28
  29 RAND_add() may be called with sensitive data such as user entered
  30 passwords. The seed values cannot be recovered from the PRNG output.
  31
  32 OpenSSL makes sure that the PRNG state is unique for each thread. On
  33 systems that provide C</dev/urandom>, the randomness device is used
  34 to seed the PRNG transparently. However, on all other systems, the
  35 application is responsible for seeding the PRNG by calling RAND_add()
  36 or RAND_load_file(3).
  37
  38 RAND_seed() is equivalent to RAND_add() when B<num == entropy>.
  39
  40 The RAND_screen() function is available for the convenience of Windows
  41 programmers. It adds the current contents of the screen to the PRNG.
  42 For applications that can catch Windows events, seeding the PRNG with
  43 the parameters of B<WM_MOUSEMOVE> events is a significantly better
  44 source of randomness. It should be noted that both methods cannot be
  45 used on servers that run without user interaction.
  46
  47 =head1 RETURN VALUES
  48
  49 These functions do not return values.
  50
  51 =head1 SEE ALSO
  52
  53 rand(3), RAND_load_file(3), RAND_cleanup(3)
  54
  55 =head1 HISTORY
  56
  57 RAND_seed() and RAND_screen() are available in all versions of SSLeay
  58 and OpenSSL. RAND_add() was added in OpenSSL 0.9.5.
  59
  60 =cut