← Back to branch summary

~andersk/ubuntu/oneiric/openssl/spurious-reboot

« back to all changes in this revision

Viewing changes to doc/crypto/RAND_egd.pod

  • Committer: Bazaar Package Importer
  • Author(s): Christoph Martin
  • Date: 2004-05-24 17:02:29 UTC
  • Revision ID: james.westby@ubuntu.com-20040524170229-ixlo08bbbly0xied
Tags: upstream-0.9.7d
Import upstream version 0.9.7d

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
This function is more flexible than RAND_egd().
 
27
When only one secret key must
 
28
be generated, it is not necessary to request the full amount 255 bytes from
 
29
the EGD socket. This can be advantageous, since the amount of entropy
 
30
that can be retrieved from EGD over time is limited.
 
31
 
 
32
RAND_query_egd_bytes() performs the actual query of the EGD daemon on socket
 
33
B<path>. If B<buf> is given, B<bytes> bytes are queried and written into
 
34
B<buf>. If B<buf> is NULL, B<bytes> bytes are queried and used to seed the
 
35
OpenSSL built-in PRNG using L<RAND_add(3)|RAND_add(3)>.
 
36
 
 
37
=head1 NOTES
 
38
 
 
39
On systems without /dev/*random devices providing entropy from the kernel,
 
40
the EGD entropy gathering daemon can be used to collect entropy. It provides
 
41
a socket interface through which entropy can be gathered in chunks up to
 
42
255 bytes. Several chunks can be queried during one connection.
 
43
 
 
44
EGD is available from http://www.lothar.com/tech/crypto/ (C<perl
 
45
Makefile.PL; make; make install> to install). It is run as B<egd>
 
46
I<path>, where I<path> is an absolute path designating a socket. When
 
47
RAND_egd() is called with that path as an argument, it tries to read
 
48
random bytes that EGD has collected. The read is performed in
 
49
non-blocking mode.
 
50
 
 
51
Alternatively, the EGD-interface compatible daemon PRNGD can be used. It is
 
52
available from
 
53
http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html .
 
54
PRNGD does employ an internal PRNG itself and can therefore never run
 
55
out of entropy.
 
56
 
 
57
OpenSSL automatically queries EGD when entropy is requested via RAND_bytes()
 
58
or the status is checked via RAND_status() for the first time, if the socket
 
59
is located at /var/run/egd-pool, /dev/egd-pool or /etc/egd-pool.
 
60
 
 
61
=head1 RETURN VALUE
 
62
 
 
63
RAND_egd() and RAND_egd_bytes() return the number of bytes read from the
 
64
daemon on success, and -1 if the connection failed or the daemon did not
 
65
return enough data to fully seed the PRNG.
 
66
 
 
67
RAND_query_egd_bytes() returns the number of bytes read from the daemon on
 
68
success, and -1 if the connection failed. The PRNG state is not considered.
 
69
 
 
70
=head1 SEE ALSO
 
71
 
 
72
L<rand(3)|rand(3)>, L<RAND_add(3)|RAND_add(3)>,
 
73
L<RAND_cleanup(3)|RAND_cleanup(3)>
 
74
 
 
75
=head1 HISTORY
 
76
 
 
77
RAND_egd() is available since OpenSSL 0.9.5.
 
78
 
 
79
RAND_egd_bytes() is available since OpenSSL 0.9.6.
 
80
 
 
81
RAND_query_egd_bytes() is available since OpenSSL 0.9.7.
 
82
 
 
83
The automatic query of /var/run/egd-pool et al was added in OpenSSL 0.9.7.
 
84
 
 
85
=cut