Debian Codegraph @

upstream/debian-unstable/man3/RAND_add.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_ADD 3SSL"
58 .TH RAND_ADD 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_add, RAND_poll, RAND_seed, RAND_status, RAND_event, RAND_screen,
65 RAND_keep_random_devices_open
66 \&\- add randomness to the PRNG or get its status
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/rand.h>
71 \&
72 \& int RAND_status(void);
73 \& int RAND_poll();
74 \&
75 \& void RAND_add(const void *buf, int num, double randomness);
76 \& void RAND_seed(const void *buf, int num);
77 \&
78 \& void RAND_keep_random_devices_open(int keep);
79 .Ve
80 .PP
81 The following functions have been deprecated since OpenSSL 1.1.0, and can be
82 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
83 see \fBopenssl_user_macros\fR\|(7):
84 .PP
85 .Vb 2
86 \& int RAND_event(UINT iMsg, WPARAM wParam, LPARAM lParam);
87 \& void RAND_screen(void);
88 .Ve
89 .SH DESCRIPTION
90 .IX Header "DESCRIPTION"
91 These functions can be used to seed the random generator and to check its
92 seeded state.
93 In general, manual (re\-)seeding of the default OpenSSL random generator
94 (\fBRAND_OpenSSL\fR\|(3)) is not necessary (but allowed), since it does (re\-)seed
95 itself automatically using trusted system entropy sources.
96 This holds unless the default RAND_METHOD has been replaced or OpenSSL was
97 built with automatic reseeding disabled, see \fBRAND\fR\|(7) for more details.
98 .PP
99 \&\fBRAND_status()\fR indicates whether or not the random generator has been sufficiently
100 seeded. If not, functions such as \fBRAND_bytes\fR\|(3) will fail.
101 .PP
102 \&\fBRAND_poll()\fR uses the system's capabilities to seed the random generator using
103 random input obtained from polling various trusted entropy sources.
104 The default choice of the entropy source can be modified at build time,
105 see \fBRAND\fR\|(7) for more details.
106 .PP
107 \&\fBRAND_add()\fR mixes the \fBnum\fR bytes at \fBbuf\fR into the internal state
108 of the random generator.
109 This function will not normally be needed, as mentioned above.
110 The \fBrandomness\fR argument is an estimate of how much randomness is
111 contained in
112 \&\fBbuf\fR, in bytes, and should be a number between zero and \fBnum\fR.
113 Details about sources of randomness and how to estimate their randomness
114 can be found in the literature; for example [NIST SP 800\-90B].
115 The content of \fBbuf\fR cannot be recovered from subsequent random generator output.
116 Applications that intend to save and restore random state in an external file
117 should consider using \fBRAND_load_file\fR\|(3) instead.
118 .PP
119 NOTE: In FIPS mode, random data provided by the application is not considered to
120 be a trusted entropy source. It is mixed into the internal state of the RNG as
121 additional data only and this does not count as a full reseed.
122 For more details, see \fBEVP_RAND\fR\|(7).
123 .PP
124 \&\fBRAND_seed()\fR is equivalent to \fBRAND_add()\fR with \fBrandomness\fR set to \fBnum\fR.
125 .PP
126 \&\fBRAND_keep_random_devices_open()\fR is used to control file descriptor
127 usage by the random seed sources. Some seed sources maintain open file
128 descriptors by default, which allows such sources to operate in a
129 \&\fBchroot\fR\|(2) jail without the associated device nodes being available. When
130 the \fBkeep\fR argument is zero, this call disables the retention of file
131 descriptors. Conversely, a nonzero argument enables the retention of
132 file descriptors. This function is usually called during initialization
133 and it takes effect immediately. This capability only applies to the default
134 provider.
135 .PP
136 \&\fBRAND_event()\fR and \fBRAND_screen()\fR are equivalent to \fBRAND_poll()\fR and exist
137 for compatibility reasons only. See HISTORY section below.
138 .SH "RETURN VALUES"
139 .IX Header "RETURN VALUES"
140 \&\fBRAND_status()\fR returns 1 if the random generator has been seeded
141 with enough data, 0 otherwise.
142 .PP
143 \&\fBRAND_poll()\fR returns 1 if it generated seed data, 0 otherwise.
144 .PP
145 \&\fBRAND_event()\fR returns \fBRAND_status()\fR.
146 .PP
147 The other functions do not return values.
148 .SH "SEE ALSO"
149 .IX Header "SEE ALSO"
150 \&\fBRAND_bytes\fR\|(3),
151 \&\fBRAND_egd\fR\|(3),
152 \&\fBRAND_load_file\fR\|(3),
153 \&\fBRAND\fR\|(7)
154 \&\fBEVP_RAND\fR\|(7)
155 .SH HISTORY
156 .IX Header "HISTORY"
157 \&\fBRAND_event()\fR and \fBRAND_screen()\fR were deprecated in OpenSSL 1.1.0 and should
158 not be used.
159 .SH COPYRIGHT
160 .IX Header "COPYRIGHT"
161 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
162 .PP
163 Licensed under the Apache License 2.0 (the "License"). You may not use
164 this file except in compliance with the License. You can obtain a copy
165 in the file LICENSE in the source distribution or at
166 <https://www.openssl.org/source/license.html>.