clarify which functions are the CMS functions which must have CMS_PARTIAL set
[openssl.git] / doc / man7 / RAND.pod
1 =pod
2
3 =head1 NAME
4
5 RAND
6 - the OpenSSL random generator
7
8 =head1 DESCRIPTION
9
10 Random numbers are a vital part of cryptography, they are needed to provide
11 unpredictability for tasks like key generation, creating salts, and many more.
12 Software-based generators must be seeded with external randomness before they
13 can be used as a cryptographically-secure pseudo-random number generator
14 (CSPRNG).
15 The availability of common hardware with special instructions and
16 modern operating systems, which may use items such as interrupt jitter
17 and network packet timings, can be reasonable sources of seeding material.
18
19 OpenSSL comes with a default implementation of the RAND API which is based on
20 the deterministic random bit generator (DRBG) model as described in
21 [NIST SP 800-90A Rev. 1]. The default random generator will initialize
22 automatically on first use and will be fully functional without having
23 to be initialized ('seeded') explicitly.
24 It seeds and reseeds itself automatically using trusted random sources
25 provided by the operating system.
26
27 As a normal application developer, you do not have to worry about any details,
28 just use L<RAND_bytes(3)> to obtain random data.
29 Having said that, there is one important rule to obey: Always check the error
30 return value of L<RAND_bytes(3)> and do not take randomness for granted.
31
32 For values that should remain secret, you can use L<RAND_priv_bytes(3)>
33 instead.
34 This method does not provide 'better' randomness, it uses the same type of CSPRNG.
35 The intention behind using a dedicated CSPRNG exclusively for private
36 values is that none of its output should be visible to an attacker (e.g.,
37 used as salt value), in order to reveal as little information as
38 possible about its internal state, and that a compromise of the "public"
39 CSPRNG instance will not affect the secrecy of these private values.
40
41 In the rare case where the default implementation does not satisfy your special
42 requirements, there are two options:
43
44 =over 2
45
46 =item *
47
48 Replace the default RAND method by your own RAND method using
49 L<RAND_set_rand_method(3)>.
50
51 =item *
52
53 Modify the default settings of the OpenSSL RAND method by modifying the security
54 parameters of the underlying DRBG, which is described in detail in L<RAND_DRBG(7)>.
55
56 =back
57
58 Changing the default random generator or its default parameters should be necessary
59 only in exceptional cases and is not recommended, unless you have a profound knowledge
60 of cryptographic principles and understand the implications of your changes.
61
62 =head1 SEE ALSO
63
64 L<RAND_add(3)>,
65 L<RAND_bytes(3)>,
66 L<RAND_priv_bytes(3)>,
67 L<RAND_get_rand_method(3)>,
68 L<RAND_set_rand_method(3)>,
69 L<RAND_OpenSSL(3)>,
70 L<RAND_DRBG(7)>
71
72 =head1 COPYRIGHT
73
74 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
75
76 Licensed under the OpenSSL license (the "License").  You may not use
77 this file except in compliance with the License.  You can obtain a copy
78 in the file LICENSE in the source distribution or at
79 L<https://www.openssl.org/source/license.html>.
80
81 =cut