Merge branch 'vendor/OPENSSL'
[dragonfly.git] / secure / lib / libcrypto / man / RAND_egd.3
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "RAND_egd 3"
135 .TH RAND_egd 3 "2009-01-11" "0.9.8j" "OpenSSL"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 RAND_egd \- query entropy gathering daemon
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 .Vb 1
145 \& #include <openssl/rand.h>
146 \&
147 \& int RAND_egd(const char *path);
148 \& int RAND_egd_bytes(const char *path, int bytes);
149 \&
150 \& int RAND_query_egd_bytes(const char *path, unsigned char *buf, int bytes);
151 .Ve
152 .SH "DESCRIPTION"
153 .IX Header "DESCRIPTION"
154 \&\fIRAND_egd()\fR queries the entropy gathering daemon \s-1EGD\s0 on socket \fBpath\fR.
155 It queries 255 bytes and uses \fIRAND_add\fR\|(3) to seed the
156 OpenSSL built-in \s-1PRNG\s0. RAND_egd(path) is a wrapper for
157 RAND_egd_bytes(path, 255);
158 .PP
159 \&\fIRAND_egd_bytes()\fR queries the entropy gathering daemon \s-1EGD\s0 on socket \fBpath\fR.
160 It queries \fBbytes\fR bytes and uses \fIRAND_add\fR\|(3) to seed the
161 OpenSSL built-in \s-1PRNG\s0.
162 This function is more flexible than \fIRAND_egd()\fR.
163 When only one secret key must
164 be generated, it is not necessary to request the full amount 255 bytes from
165 the \s-1EGD\s0 socket. This can be advantageous, since the amount of entropy
166 that can be retrieved from \s-1EGD\s0 over time is limited.
167 .PP
168 \&\fIRAND_query_egd_bytes()\fR performs the actual query of the \s-1EGD\s0 daemon on socket
169 \&\fBpath\fR. If \fBbuf\fR is given, \fBbytes\fR bytes are queried and written into
170 \&\fBbuf\fR. If \fBbuf\fR is \s-1NULL\s0, \fBbytes\fR bytes are queried and used to seed the
171 OpenSSL built-in \s-1PRNG\s0 using \fIRAND_add\fR\|(3).
172 .SH "NOTES"
173 .IX Header "NOTES"
174 On systems without /dev/*random devices providing entropy from the kernel,
175 the \s-1EGD\s0 entropy gathering daemon can be used to collect entropy. It provides
176 a socket interface through which entropy can be gathered in chunks up to
177 255 bytes. Several chunks can be queried during one connection.
178 .PP
179 \&\s-1EGD\s0 is available from http://www.lothar.com/tech/crypto/ (\f(CW\*(C`perl
180 Makefile.PL; make; make install\*(C'\fR to install). It is run as \fBegd\fR
181 \&\fIpath\fR, where \fIpath\fR is an absolute path designating a socket. When
182 \&\fIRAND_egd()\fR is called with that path as an argument, it tries to read
183 random bytes that \s-1EGD\s0 has collected. \fIRAND_egd()\fR retrieves entropy from the
184 daemon using the daemon's \*(L"non-blocking read\*(R" command which shall
185 be answered immediately by the daemon without waiting for additional
186 entropy to be collected. The write and read socket operations in the
187 communication are blocking.
188 .PP
189 Alternatively, the EGD-interface compatible daemon \s-1PRNGD\s0 can be used. It is
190 available from
191 http://prngd.sourceforge.net/ .
192 \&\s-1PRNGD\s0 does employ an internal \s-1PRNG\s0 itself and can therefore never run
193 out of entropy.
194 .PP
195 OpenSSL automatically queries \s-1EGD\s0 when entropy is requested via \fIRAND_bytes()\fR
196 or the status is checked via \fIRAND_status()\fR for the first time, if the socket
197 is located at /var/run/egd\-pool, /dev/egd\-pool or /etc/egd\-pool.
198 .SH "RETURN VALUE"
199 .IX Header "RETURN VALUE"
200 \&\fIRAND_egd()\fR and \fIRAND_egd_bytes()\fR return the number of bytes read from the
201 daemon on success, and \-1 if the connection failed or the daemon did not
202 return enough data to fully seed the \s-1PRNG\s0.
203 .PP
204 \&\fIRAND_query_egd_bytes()\fR returns the number of bytes read from the daemon on
205 success, and \-1 if the connection failed. The \s-1PRNG\s0 state is not considered.
206 .SH "SEE ALSO"
207 .IX Header "SEE ALSO"
208 \&\fIrand\fR\|(3), \fIRAND_add\fR\|(3),
209 \&\fIRAND_cleanup\fR\|(3)
210 .SH "HISTORY"
211 .IX Header "HISTORY"
212 \&\fIRAND_egd()\fR is available since OpenSSL 0.9.5.
213 .PP
214 \&\fIRAND_egd_bytes()\fR is available since OpenSSL 0.9.6.
215 .PP
216 \&\fIRAND_query_egd_bytes()\fR is available since OpenSSL 0.9.7.
217 .PP
218 The automatic query of /var/run/egd\-pool et al was added in OpenSSL 0.9.7.