1RAND_egd(3)                         OpenSSL                        RAND_egd(3)
2
3
4

NAME

6       RAND_egd - query entropy gathering daemon
7

SYNOPSIS

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

DESCRIPTION

17       RAND_egd() queries the entropy gathering daemon EGD on socket path.  It
18       queries 255 bytes and uses RAND_add(3) to seed the OpenSSL built-in
19       PRNG. RAND_egd(path) is a wrapper for RAND_egd_bytes(path, 255);
20
21       RAND_egd_bytes() queries the entropy gathering daemon EGD on socket
22       path.  It queries bytes bytes and uses RAND_add(3) to seed the OpenSSL
23       built-in PRNG.  This function is more flexible than RAND_egd().  When
24       only one secret key must be generated, it is not necessary to request
25       the full amount 255 bytes from the EGD socket. This can be advanta‐
26       geous, since the amount of entropy that can be retrieved from EGD over
27       time is limited.
28
29       RAND_query_egd_bytes() performs the actual query of the EGD daemon on
30       socket path. If buf is given, bytes bytes are queried and written into
31       buf. If buf is NULL, bytes bytes are queried and used to seed the
32       OpenSSL built-in PRNG using RAND_add(3).
33

NOTES

35       On systems without /dev/*random devices providing entropy from the ker‐
36       nel, the EGD entropy gathering daemon can be used to collect entropy.
37       It provides a socket interface through which entropy can be gathered in
38       chunks up to 255 bytes. Several chunks can be queried during one con‐
39       nection.
40
41       EGD is available from http://www.lothar.com/tech/crypto/ ("perl Make‐
42       file.PL; make; make install" to install). It is run as egd path, where
43       path is an absolute path designating a socket. When RAND_egd() is
44       called with that path as an argument, it tries to read random bytes
45       that EGD has collected. The read is performed in non-blocking mode.
46
47       Alternatively, the EGD-interface compatible daemon PRNGD can be used.
48       It is available from http://www.aet.tu-cottbus.de/perso‐
49       nen/jaenicke/postfix_tls/prngd.html .  PRNGD does employ an internal
50       PRNG itself and can therefore never run out of entropy.
51
52       OpenSSL automatically queries EGD when entropy is requested via
53       RAND_bytes() or the status is checked via RAND_status() for the first
54       time, if the socket is located at /var/run/egd-pool, /dev/egd-pool or
55       /etc/egd-pool.
56

RETURN VALUE

58       RAND_egd() and RAND_egd_bytes() return the number of bytes read from
59       the daemon on success, and -1 if the connection failed or the daemon
60       did not return enough data to fully seed the PRNG.
61
62       RAND_query_egd_bytes() returns the number of bytes read from the daemon
63       on success, and -1 if the connection failed. The PRNG state is not con‐
64       sidered.
65

SEE ALSO

67       rand(3), RAND_add(3), RAND_cleanup(3)
68

HISTORY

70       RAND_egd() is available since OpenSSL 0.9.5.
71
72       RAND_egd_bytes() is available since OpenSSL 0.9.6.
73
74       RAND_query_egd_bytes() is available since OpenSSL 0.9.7.
75
76       The automatic query of /var/run/egd-pool et al was added in OpenSSL
77       0.9.7.
78
79
80
810.9.8b                            2001-02-10                       RAND_egd(3)