192cfd618758c8d346c68d342c304ad58b76979c
[openssl.git] / doc / man3 / RAND_add.pod
1 =pod
2
3 =head1 NAME
4
5 RAND_add, RAND_poll, RAND_seed, RAND_status, RAND_event, RAND_screen,
6 RAND_keep_random_devices_open
7 - add randomness to the PRNG or get its status
8
9 =head1 SYNOPSIS
10
11  #include <openssl/rand.h>
12
13  int RAND_status(void);
14  int RAND_poll();
15
16  void RAND_add(const void *buf, int num, double randomness);
17  void RAND_seed(const void *buf, int num);
18
19  void RAND_keep_random_devices_open(int keep);
20
21 Deprecated since OpenSSL 1.1.0, can be hidden entirely by defining
22 B<OPENSSL_API_COMPAT> with a suitable version value, see
23 L<openssl_user_macros(7)>:
24
25  int RAND_event(UINT iMsg, WPARAM wParam, LPARAM lParam);
26  void RAND_screen(void);
27
28 =head1 DESCRIPTION
29
30 These functions can be used to seed the random generator and to check its
31 seeded state.
32 In general, manual (re-)seeding of the default OpenSSL random generator
33 (L<RAND_OpenSSL(3)>) is not necessary (but allowed), since it does (re-)seed
34 itself automatically using trusted system entropy sources.
35 This holds unless the default RAND_METHOD has been replaced or OpenSSL was
36 built with automatic reseeding disabled, see L<RAND(7)> for more details.
37
38 RAND_status() indicates whether or not the random generator has been sufficiently
39 seeded. If not, functions such as L<RAND_bytes(3)> will fail.
40
41 RAND_poll() uses the system's capabilities to seed the random generator using
42 random input obtained from polling various trusted entropy sources.
43 The default choice of the entropy source can be modified at build time,
44 see L<RAND(7)> for more details.
45
46 RAND_add() mixes the B<num> bytes at B<buf> into the internal state
47 of the random generator.
48 This function will not normally be needed, as mentioned above.
49 The B<randomness> argument is an estimate of how much randomness is
50 contained in
51 B<buf>, in bytes, and should be a number between zero and B<num>.
52 Details about sources of randomness and how to estimate their randomness
53 can be found in the literature; for example [NIST SP 800-90B].
54 The content of B<buf> cannot be recovered from subsequent random generator output.
55 Applications that intend to save and restore random state in an external file
56 should consider using L<RAND_load_file(3)> instead.
57
58 NOTE: In FIPS mode, random data provided by the application is not considered to
59 be a trusted entropy source. It is mixed into the internal state of the RNG as
60 additional data only and this does not count as a full reseed.
61 For more details, see L<RAND_DRBG(7)>.
62
63 RAND_seed() is equivalent to RAND_add() with B<randomness> set to B<num>.
64
65 RAND_keep_random_devices_open() is used to control file descriptor
66 usage by the random seed sources. Some seed sources maintain open file
67 descriptors by default, which allows such sources to operate in a
68 chroot(2) jail without the associated device nodes being available. When
69 the B<keep> argument is zero, this call disables the retention of file
70 descriptors. Conversely, a non-zero argument enables the retention of
71 file descriptors. This function is usually called during initialization
72 and it takes effect immediately.
73
74 RAND_event() and RAND_screen() are equivalent to RAND_poll() and exist
75 for compatibility reasons only. See HISTORY section below.
76
77 =head1 RETURN VALUES
78
79 RAND_status() returns 1 if the random generator has been seeded
80 with enough data, 0 otherwise.
81
82 RAND_poll() returns 1 if it generated seed data, 0 otherwise.
83
84 RAND_event() returns RAND_status().
85
86 The other functions do not return values.
87
88 =head1 SEE ALSO
89
90 L<RAND_bytes(3)>,
91 L<RAND_egd(3)>,
92 L<RAND_load_file(3)>,
93 L<RAND(7)>
94 L<RAND_DRBG(7)>
95
96 =head1 HISTORY
97
98 RAND_event() and RAND_screen() were deprecated in OpenSSL 1.1.0 and should
99 not be used.
100
101 =head1 COPYRIGHT
102
103 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
104
105 Licensed under the Apache License 2.0 (the "License").  You may not use
106 this file except in compliance with the License.  You can obtain a copy
107 in the file LICENSE in the source distribution or at
108 L<https://www.openssl.org/source/license.html>.
109
110 =cut