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