RAND_add.pod 2.9 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4
=pod

=head1 NAME

5
RAND_add, RAND_poll, RAND_seed, RAND_status, RAND_event, RAND_screen
R
Rich Salz 已提交
6
- add randomness to the PRNG or get its status
U
Ulf Möller 已提交
7 8 9 10 11

=head1 SYNOPSIS

 #include <openssl/rand.h>

R
Rich Salz 已提交
12
 int RAND_status(void);
R
Rich Salz 已提交
13
 int RAND_poll();
U
Ulf Möller 已提交
14

R
Rich Salz 已提交
15
 void RAND_add(const void *buf, int num, double randomness);
R
Rich Salz 已提交
16
 void RAND_seed(const void *buf, int num);
U
Ulf Möller 已提交
17

R
Rich Salz 已提交
18
Deprecated:
U
Ulf Möller 已提交
19

20
 #if OPENSSL_API_COMPAT < 0x10100000L
R
Rich Salz 已提交
21
 int RAND_event(UINT iMsg, WPARAM wParam, LPARAM lParam);
22
 void RAND_screen(void);
23
 #endif
24

U
Ulf Möller 已提交
25 26
=head1 DESCRIPTION

27 28 29 30 31 32 33 34 35 36 37 38
These functions can be used to seed the random generator and to check its
seeded state.
In general, manual (re-)seeding of the default OpenSSL random generator
(L<RAND_OpenSSL(3)>) is not necessary (but allowed), since it does (re-)seed
itself automatically using trusted system entropy sources.
This holds unless the default RAND_METHOD has been replaced or OpenSSL was
built with automatic reseeding disabled, see L<RAND(7)> for more details.

RAND_status() indicates whether or not the random generator has been sufficiently
seeded. If not, functions such as L<RAND_bytes(3)> will fail.

RAND_poll() uses the system's capabilities to seed the random generator using
39
random input obtained from polling various trusted entropy sources.
40 41
The default choice of the entropy source can be modified at build time,
see L<RAND(7)> for more details.
R
Rich Salz 已提交
42

43 44 45
RAND_add() mixes the B<num> bytes at B<buf> into the internal state
of the random generator.
This function will not normally be needed, as mentioned above.
R
Rich Salz 已提交
46 47
The B<randomness> argument is an estimate of how much randomness is
contained in
R
Rich Salz 已提交
48 49
B<buf>, in bytes, and should be a number between zero and B<num>.
Details about sources of randomness and how to estimate their randomness
50 51 52 53
can be found in the literature; for example [NIST SP 800-90B].
The content of B<buf> cannot be recovered from subsequent random generator output.
Applications that intend to save and restore random state in an external file
should consider using L<RAND_load_file(3)> instead.
U
Ulf Möller 已提交
54

R
Rich Salz 已提交
55
RAND_seed() is equivalent to RAND_add() with B<randomness> set to B<num>.
U
Ulf Möller 已提交
56

57 58
RAND_event() and RAND_screen() are equivalent to RAND_poll() and exist
for compatibility reasons only. See HISTORY section below.
59

U
Ulf Möller 已提交
60 61
=head1 RETURN VALUES

62
RAND_status() returns 1 if the random generator has been seeded
U
Ulf Möller 已提交
63
with enough data, 0 otherwise.
U
Ulf Möller 已提交
64

R
Rich Salz 已提交
65
RAND_poll() returns 1 if it generated seed data, 0 otherwise.
66

R
Rich Salz 已提交
67
RAND_event() returns RAND_status().
68

U
Ulf Möller 已提交
69
The other functions do not return values.
U
Ulf Möller 已提交
70

71 72
=head1 HISTORY

R
Rich Salz 已提交
73 74
RAND_event() and RAND_screen() were deprecated in OpenSSL 1.1.0 and should
not be used.
75

U
Ulf Möller 已提交
76 77
=head1 SEE ALSO

78 79 80 81
L<RAND_bytes(3)>,
L<RAND_egd(3)>,
L<RAND_load_file(3)>,
L<RAND(7)>
U
Ulf Möller 已提交
82

R
Rich Salz 已提交
83 84
=head1 COPYRIGHT

85
Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
R
Rich Salz 已提交
86 87 88 89 90 91 92

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut