Use randomness not entropy
[openssl.git] / doc / man3 / RAND_add.pod
1 =pod
2
3 =head1 NAME
4
5 RAND_add, RAND_seed, RAND_status, RAND_event, RAND_screen - add
6 randomness to the PRNG
7
8 =head1 SYNOPSIS
9
10  #include <openssl/rand.h>
11
12  void RAND_seed(const void *buf, int num);
13
14  void RAND_add(const void *buf, int num, double randomness);
15
16  int  RAND_status(void);
17
18  #if OPENSSL_API_COMPAT < 0x10100000L
19  int  RAND_event(UINT iMsg, WPARAM wParam, LPARAM lParam);
20  void RAND_screen(void);
21  #endif
22
23 =head1 DESCRIPTION
24
25 RAND_add() mixes the B<num> bytes at B<buf> into the PRNG state. Thus,
26 if the data at B<buf> are unpredictable to an adversary, this
27 increases the uncertainty about the state and makes the PRNG output
28 less predictable. Suitable input comes from user interaction (random
29 key presses, mouse movements) and certain hardware events. The
30 B<randomness> argument is an estimate of how much randomness is contained in
31 B<buf>, in bytes, and should be a number between zero and B<num>.
32 Details about sources of randomness and how to estimate their randomness
33 can be found in the literature; for example IETF RFC 4086.
34
35 RAND_add() may be called with sensitive data such as user entered
36 passwords. The seed values cannot be recovered from the PRNG output.
37
38 OpenSSL makes sure that the PRNG state is unique for each thread. On
39 systems that provide C</dev/urandom>, the randomness device is used
40 to seed the PRNG transparently. However, on all other systems, the
41 application is responsible for seeding the PRNG by calling RAND_add(),
42 L<RAND_egd(3)>
43 or L<RAND_load_file(3)>.
44
45 RAND_seed() is equivalent to RAND_add() with B<randomness> set to B<num>.
46
47 RAND_event() and RAND_screen() are deprecated and should not be called.
48
49 =head1 RETURN VALUES
50
51 RAND_status() returns 1 if the PRNG has been seeded
52 with enough data, 0 otherwise.
53
54 RAND_event() calls RAND_poll() and returns RAND_status().
55
56 RAND_screen calls RAND_poll().
57
58 The other functions do not return values.
59
60 =head1 HISTORY
61
62 RAND_event() and RAND_screen() are deprecated since OpenSSL
63 1.1.0.  Use the functions described above instead.
64
65 =head1 SEE ALSO
66
67 L<RAND_bytes(3)>, L<RAND_egd(3)>,
68 L<RAND_load_file(3)>, L<RAND_cleanup(3)>
69
70 =head1 COPYRIGHT
71
72 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
73
74 Licensed under the OpenSSL license (the "License").  You may not use
75 this file except in compliance with the License.  You can obtain a copy
76 in the file LICENSE in the source distribution or at
77 L<https://www.openssl.org/source/license.html>.
78
79 =cut