doc/crypto/RAND_egd.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RAND_egd - query entropy gathering daemon
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rand.h>
  10
  11  int RAND_egd(const char *path);
  12  int RAND_egd_bytes(const char *path, int bytes);
  13
  14  int RAND_query_egd_bytes(const char *path, unsigned char *buf, int bytes);
  15
  16 =head1 DESCRIPTION
  17
  18 RAND_egd() queries the entropy gathering daemon EGD on socket B<path>.
  19 It queries 255 bytes and uses L<RAND_add(3)|RAND_add(3)> to seed the
  20 OpenSSL built-in PRNG. RAND_egd(path) is a wrapper for
  21 RAND_egd_bytes(path, 255);
  22
  23 RAND_egd_bytes() queries the entropy gathering daemon EGD on socket B<path>.
  24 It queries B<bytes> bytes and uses L<RAND_add(3)|RAND_add(3)> to seed the
  25 OpenSSL built-in PRNG.
  26
  27 RAND_query_egd_bytes() performs the actual query of the EGD daemon on socket
  28 B<path>. If B<buf> is given, B<bytes> bytes are queried and written into
  29 B<buf>. If B<buf> is NULL, B<bytes> bytes are queried and used to seed the
  30 OpenSSL built-in PRNG using L<RAND_add(3)|RAND_add(3)>.
  31
  32 =head1 NOTES
  33
  34 On systems without /dev/*random devices providing entropy from the kernel,
  35 the EGD entropy gathering daemon can be used to collect entropy. It provides
  36 a socket interface through which entropy can be gathered in chunks up to
  37 255 bytes. Several chunks can be queried during one connection.
  38
  39 While RAND_egd() is longer available (see HISTORY section), the
  40 RAND_egd_bytes() function is more flexible. When only one secret key must
  41 be generated, it is not needed to request the full amount 255 bytes from
  42 the EGD socket. This can be advantageous, since the amount of entropy
  43 that can be retrieved from EGD over time is limited.
  44
  45 EGD is available from http://www.lothar.com/tech/crypto/ (C<perl
  46 Makefile.PL; make; make install> to install). It is run as B<egd>
  47 I<path>, where I<path> is an absolute path designating a socket. When
  48 RAND_egd() is called with that path as an argument, it tries to read
  49 random bytes that EGD has collected. The read is performed in
  50 non-blocking mode.
  51
  52 Alternatively, the EGD-interface compatible daemon PRNGD can be used. It is
  53 available from
  54 http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html .
  55 PRNGD does employ an internal PRNG itself and can therefore never run
  56 out of entropy.
  57
  58 =head1 RETURN VALUE
  59
  60 RAND_egd() and RAND_egd_bytes() return the number of bytes read from the
  61 daemon on success, and -1 if the connection failed or the daemon did not
  62 return enough data to fully seed the PRNG.
  63
  64 RAND_query_egd_bytes() returns the number of bytes read from the daemon on
  65 success, and -1 if the connection failed. The PRNG state is not considered.
  66
  67 =head1 SEE ALSO
  68
  69 L<rand(3)|rand(3)>, L<RAND_add(3)|RAND_add(3)>,
  70 L<RAND_cleanup(3)|RAND_cleanup(3)>
  71
  72 =head1 HISTORY
  73
  74 RAND_egd() is available since OpenSSL 0.9.5.
  75
  76 RAND_egd_bytes() is available since OpenSSL 0.9.6.
  77
  78 RAND_query_egd_bytes() is available since OpenSSL 0.9.7.
  79
  80 =cut