Debian Codegraph @

upstream/debian-unstable/man3/RAND_egd.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "RAND_EGD 3SSL"
58 .TH RAND_EGD 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 RAND_egd, RAND_egd_bytes, RAND_query_egd_bytes \- query entropy gathering daemon
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/rand.h>
69 \&
70 \& int RAND_egd_bytes(const char *path, int num);
71 \& int RAND_egd(const char *path);
72 \&
73 \& int RAND_query_egd_bytes(const char *path, unsigned char *buf, int num);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 On older platforms without a good source of randomness such as \f(CW\*(C`/dev/urandom\*(C'\fR,
78 it is possible to query an Entropy Gathering Daemon (EGD) over a local
79 socket to obtain randomness and seed the OpenSSL RNG.
80 The protocol used is defined by the EGDs available at
81 <http://egd.sourceforge.net/> or <http://prngd.sourceforge.net>.
82 .PP
83 \&\fBRAND_egd_bytes()\fR requests \fBnum\fR bytes of randomness from an EGD at the
84 specified socket \fBpath\fR, and passes the data it receives into \fBRAND_add()\fR.
85 \&\fBRAND_egd()\fR is equivalent to \fBRAND_egd_bytes()\fR with \fBnum\fR set to 255.
86 .PP
87 \&\fBRAND_query_egd_bytes()\fR requests \fBnum\fR bytes of randomness from an EGD at
88 the specified socket \fBpath\fR, where \fBnum\fR must be less than 256.
89 If \fBbuf\fR is \fBNULL\fR, it is equivalent to \fBRAND_egd_bytes()\fR.
90 If \fBbuf\fR is not \fBNULL\fR, then the data is copied to the buffer and
91 \&\fBRAND_add()\fR is not called.
92 .PP
93 OpenSSL can be configured at build time to try to use the EGD for seeding
94 automatically.
95 .SH "RETURN VALUES"
96 .IX Header "RETURN VALUES"
97 \&\fBRAND_egd()\fR and \fBRAND_egd_bytes()\fR return the number of bytes read from the
98 daemon on success, or \-1 if the connection failed or the daemon did not
99 return enough data to fully seed the PRNG.
100 .PP
101 \&\fBRAND_query_egd_bytes()\fR returns the number of bytes read from the daemon on
102 success, or \-1 if the connection failed.
103 .SH "SEE ALSO"
104 .IX Header "SEE ALSO"
105 \&\fBRAND_add\fR\|(3),
106 \&\fBRAND_bytes\fR\|(3),
107 \&\fBRAND\fR\|(7)
108 .SH COPYRIGHT
109 .IX Header "COPYRIGHT"
110 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
111 .PP
112 Licensed under the Apache License 2.0 (the "License"). You may not use
113 this file except in compliance with the License. You can obtain a copy
114 in the file LICENSE in the source distribution or at
115 <https://www.openssl.org/source/license.html>.