secure/lib/libcrypto/man/RAND_egd.3

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "RAND_egd 3"
 132 .TH RAND_egd 3 "2017-11-02" "1.0.2m" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 RAND_egd, RAND_egd_bytes, RAND_query_egd_bytes \- query entropy gathering daemon
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/rand.h>
 143 \&
 144 \& int RAND_egd(const char *path);
 145 \& int RAND_egd_bytes(const char *path, int bytes);
 146 \&
 147 \& int RAND_query_egd_bytes(const char *path, unsigned char *buf, int bytes);
 148 .Ve
 149 .SH "DESCRIPTION"
 150 .IX Header "DESCRIPTION"
 151 \&\fIRAND_egd()\fR queries the entropy gathering daemon \s-1EGD\s0 on socket \fBpath\fR.
 152 It queries 255 bytes and uses \fIRAND_add\fR\|(3) to seed the
 153 OpenSSL built-in \s-1PRNG.\s0 RAND_egd(path) is a wrapper for
 154 RAND_egd_bytes(path, 255);
 155 .PP
 156 \&\fIRAND_egd_bytes()\fR queries the entropy gathering daemon \s-1EGD\s0 on socket \fBpath\fR.
 157 It queries \fBbytes\fR bytes and uses \fIRAND_add\fR\|(3) to seed the
 158 OpenSSL built-in \s-1PRNG.\s0
 159 This function is more flexible than \fIRAND_egd()\fR.
 160 When only one secret key must
 161 be generated, it is not necessary to request the full amount 255 bytes from
 162 the \s-1EGD\s0 socket. This can be advantageous, since the amount of entropy
 163 that can be retrieved from \s-1EGD\s0 over time is limited.
 164 .PP
 165 \&\fIRAND_query_egd_bytes()\fR performs the actual query of the \s-1EGD\s0 daemon on socket
 166 \&\fBpath\fR. If \fBbuf\fR is given, \fBbytes\fR bytes are queried and written into
 167 \&\fBbuf\fR. If \fBbuf\fR is \s-1NULL, \s0\fBbytes\fR bytes are queried and used to seed the
 168 OpenSSL built-in \s-1PRNG\s0 using \fIRAND_add\fR\|(3).
 169 .SH "NOTES"
 170 .IX Header "NOTES"
 171 On systems without /dev/*random devices providing entropy from the kernel,
 172 the \s-1EGD\s0 entropy gathering daemon can be used to collect entropy. It provides
 173 a socket interface through which entropy can be gathered in chunks up to
 174 255 bytes. Several chunks can be queried during one connection.
 175 .PP
 176 \&\s-1EGD\s0 is available from http://www.lothar.com/tech/crypto/ (\f(CW\*(C`perl
 177 Makefile.PL; make; make install\*(C'\fR to install). It is run as \fBegd\fR
 178 \&\fIpath\fR, where \fIpath\fR is an absolute path designating a socket. When
 179 \&\fIRAND_egd()\fR is called with that path as an argument, it tries to read
 180 random bytes that \s-1EGD\s0 has collected. \fIRAND_egd()\fR retrieves entropy from the
 181 daemon using the daemon's \*(L"non-blocking read\*(R" command which shall
 182 be answered immediately by the daemon without waiting for additional
 183 entropy to be collected. The write and read socket operations in the
 184 communication are blocking.
 185 .PP
 186 Alternatively, the EGD-interface compatible daemon \s-1PRNGD\s0 can be used. It is
 187 available from
 188 http://prngd.sourceforge.net/ .
 189 \&\s-1PRNGD\s0 does employ an internal \s-1PRNG\s0 itself and can therefore never run
 190 out of entropy.
 191 .PP
 192 OpenSSL automatically queries \s-1EGD\s0 when entropy is requested via \fIRAND_bytes()\fR
 193 or the status is checked via \fIRAND_status()\fR for the first time, if the socket
 194 is located at /var/run/egd\-pool, /dev/egd\-pool or /etc/egd\-pool.
 195 .SH "RETURN VALUE"
 196 .IX Header "RETURN VALUE"
 197 \&\fIRAND_egd()\fR and \fIRAND_egd_bytes()\fR return the number of bytes read from the
 198 daemon on success, and \-1 if the connection failed or the daemon did not
 199 return enough data to fully seed the \s-1PRNG.\s0
 200 .PP
 201 \&\fIRAND_query_egd_bytes()\fR returns the number of bytes read from the daemon on
 202 success, and \-1 if the connection failed. The \s-1PRNG\s0 state is not considered.
 203 .SH "SEE ALSO"
 204 .IX Header "SEE ALSO"
 205 \&\fIrand\fR\|(3), \fIRAND_add\fR\|(3),
 206 \&\fIRAND_cleanup\fR\|(3)
 207 .SH "HISTORY"
 208 .IX Header "HISTORY"
 209 \&\fIRAND_egd()\fR is available since OpenSSL 0.9.5.
 210 .PP
 211 \&\fIRAND_egd_bytes()\fR is available since OpenSSL 0.9.6.
 212 .PP
 213 \&\fIRAND_query_egd_bytes()\fR is available since OpenSSL 0.9.7.
 214 .PP
 215 The automatic query of /var/run/egd\-pool et al was added in OpenSSL 0.9.7.