Support EGD.
[openssl.git] / doc / crypto / RAND_add.pod
1 =pod
2
3 =head1 NAME
4
5 RAND_add, RAND_seed, RAND_screen - Add entropy to the PRNG
6
7 =head1 SYNOPSIS
8
9  #include <openssl/rand.h>
10
11  void RAND_seed(const void *buf, int num);
12
13  void RAND_add(const void *buf, int num, double entropy);
14
15  int  RAND_status(void);
16
17  void RAND_screen(void);
18
19 =head1 DESCRIPTION
20
21 RAND_add() mixes the B<num> bytes at B<buf> into the PRNG state. Thus,
22 if the data at B<buf> are unpredictable to an adversary, this
23 increases the uncertainty about the state and makes the PRNG output
24 less predictable. Suitable input comes from user interaction (random
25 key presses, mouse movements) and certain hardware events. The
26 B<entropy> argument is (the lower bound of) an estimate of how much
27 randomness is contained in B<buf>, measured in bytes. Details about
28 sources of randomness and how to estimate their entropy can be found
29 in the literature, e.g. RFC 1750.
30
31 RAND_add() may be called with sensitive data such as user entered
32 passwords. The seed values cannot be recovered from the PRNG output.
33
34 OpenSSL makes sure that the PRNG state is unique for each thread. On
35 systems that provide C</dev/urandom>, the randomness device is used
36 to seed the PRNG transparently. However, on all other systems, the
37 application is responsible for seeding the PRNG by calling RAND_add()
38 or L<RAND_load_file(3)|RAND_load_file(3)>.
39
40 RAND_seed() is equivalent to RAND_add() when B<num == entropy>.
41
42 The RAND_screen() function is available for the convenience of Windows
43 programmers. It adds the current contents of the screen to the PRNG.
44 For applications that can catch Windows events, seeding the PRNG with
45 the parameters of B<WM_MOUSEMOVE> events is a significantly better
46 source of randomness. It should be noted that both methods cannot be
47 used on servers that run without user interaction.
48
49 =head1 RETURN VALUES
50
51 RAND_status() returns 1 if the PRNG has been seeded with enough data,
52 0 otherwise.
53
54 The other functions do not return values.
55
56 =head1 SEE ALSO
57
58 L<rand(3)|rand(3)>, L<RAND_load_file(3)|RAND_load_file(3)>, L<RAND_cleanup(3)|RAND_cleanup(3)>
59
60 =head1 HISTORY
61
62 RAND_seed() and RAND_screen() are available in all versions of SSLeay
63 and OpenSSL. RAND_add() and RAND_status() have been added in OpenSSL
64 0.9.5.
65
66 =cut