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