9004809a8b597b3d4b9e66c2bb7fe329c1f42ca8
[openssl.git] / crypto / rand / rand_lcl.h
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef HEADER_RAND_LCL_H
11 # define HEADER_RAND_LCL_H
12
13 # include <openssl/aes.h>
14 # include <openssl/evp.h>
15 # include <openssl/sha.h>
16 # include <openssl/hmac.h>
17 # include <openssl/ec.h>
18 # include <openssl/rand_drbg.h>
19
20 # include "internal/numbers.h"
21
22 /* How many times to read the TSC as a randomness source. */
23 # define TSC_READ_COUNT                 4
24
25 /* Maximum reseed intervals */
26 # define MAX_RESEED_INTERVAL                     (1 << 24)
27 # define MAX_RESEED_TIME_INTERVAL                (1 << 20) /* approx. 12 days */
28
29 /* Default reseed intervals */
30 # define MASTER_RESEED_INTERVAL                  (1 << 8)
31 # define SLAVE_RESEED_INTERVAL                   (1 << 16)
32 # define MASTER_RESEED_TIME_INTERVAL             (60*60)   /* 1 hour */
33 # define SLAVE_RESEED_TIME_INTERVAL              (7*60)    /* 7 minutes */
34
35
36
37 /*
38  * Maximum input size for the DRBG (entropy, nonce, personalization string)
39  *
40  * NIST SP800 90Ar1 allows a maximum of (1 << 35) bits i.e., (1 << 32) bytes.
41  *
42  * We lower it to 'only' INT32_MAX bytes, which is equivalent to 2 gigabytes.
43  */
44 # define DRBG_MAX_LENGTH                         INT32_MAX
45
46
47
48 /*
49  * Maximum allocation size for RANDOM_POOL buffers
50  *
51  * The max_len value for the buffer provided to the rand_drbg_get_entropy()
52  * callback is currently 2^31 bytes (2 gigabytes), if a derivation function
53  * is used. Since this is much too large to be allocated, the rand_pool_new()
54  * function chooses more modest values as default pool length, bounded
55  * by RAND_POOL_MIN_LENGTH and RAND_POOL_MAX_LENGTH
56  *
57  * The choice of the RAND_POOL_FACTOR is large enough such that the
58  * RAND_POOL can store a random input which has a lousy entropy rate of
59  * 8/256 (= 0.03125) bits per byte. This input will be sent through the
60  * derivation function which 'compresses' the low quality input into a
61  * high quality output.
62  *
63  * The factor 1.5 below is the pessimistic estimate for the extra amount
64  * of entropy required when no get_nonce() callback is defined.
65  */
66 # define RAND_POOL_FACTOR        256
67 # define RAND_POOL_MAX_LENGTH    (RAND_POOL_FACTOR * \
68                                   3 * (RAND_DRBG_STRENGTH / 16))
69 /*
70  *                             = (RAND_POOL_FACTOR * \
71  *                                1.5 * (RAND_DRBG_STRENGTH / 8))
72  */
73
74
75 /* DRBG status values */
76 typedef enum drbg_status_e {
77     DRBG_UNINITIALISED,
78     DRBG_READY,
79     DRBG_ERROR
80 } DRBG_STATUS;
81
82
83 /* instantiate */
84 typedef int (*RAND_DRBG_instantiate_fn)(RAND_DRBG *ctx,
85                                         const unsigned char *ent,
86                                         size_t entlen,
87                                         const unsigned char *nonce,
88                                         size_t noncelen,
89                                         const unsigned char *pers,
90                                         size_t perslen);
91 /* reseed */
92 typedef int (*RAND_DRBG_reseed_fn)(RAND_DRBG *ctx,
93                                    const unsigned char *ent,
94                                    size_t entlen,
95                                    const unsigned char *adin,
96                                    size_t adinlen);
97 /* generate output */
98 typedef int (*RAND_DRBG_generate_fn)(RAND_DRBG *ctx,
99                                      unsigned char *out,
100                                      size_t outlen,
101                                      const unsigned char *adin,
102                                      size_t adinlen);
103 /* uninstantiate */
104 typedef int (*RAND_DRBG_uninstantiate_fn)(RAND_DRBG *ctx);
105
106
107 /*
108  * The DRBG methods
109  */
110
111 typedef struct rand_drbg_method_st {
112     RAND_DRBG_instantiate_fn instantiate;
113     RAND_DRBG_reseed_fn reseed;
114     RAND_DRBG_generate_fn generate;
115     RAND_DRBG_uninstantiate_fn uninstantiate;
116 } RAND_DRBG_METHOD;
117
118 /* 888 bits from SP800-90Ar1 10.1 table 2 */
119 #define HASH_PRNG_MAX_SEEDLEN    (888/8)
120
121 typedef struct rand_drbg_hash_st {
122     const EVP_MD *md;
123     EVP_MD_CTX *ctx;
124     size_t blocklen;
125     unsigned char V[HASH_PRNG_MAX_SEEDLEN];
126     unsigned char C[HASH_PRNG_MAX_SEEDLEN];
127     /* Temporary value storage: should always exceed max digest length */
128     unsigned char vtmp[HASH_PRNG_MAX_SEEDLEN];
129 } RAND_DRBG_HASH;
130
131 typedef struct rand_drbg_hmac_st {
132     const EVP_MD *md;
133     HMAC_CTX *ctx;
134     size_t blocklen;
135     unsigned char K[EVP_MAX_MD_SIZE];
136     unsigned char V[EVP_MAX_MD_SIZE];
137 } RAND_DRBG_HMAC;
138
139 /*
140  * The state of a DRBG AES-CTR.
141  */
142 typedef struct rand_drbg_ctr_st {
143     EVP_CIPHER_CTX *ctx;
144     EVP_CIPHER_CTX *ctx_df;
145     const EVP_CIPHER *cipher;
146     size_t keylen;
147     unsigned char K[32];
148     unsigned char V[16];
149     /* Temporary block storage used by ctr_df */
150     unsigned char bltmp[16];
151     size_t bltmp_pos;
152     unsigned char KX[48];
153 } RAND_DRBG_CTR;
154
155
156 /*
157  * The 'random pool' acts as a dumb container for collecting random
158  * input from various entropy sources. The pool has no knowledge about
159  * whether its randomness is fed into a legacy RAND_METHOD via RAND_add()
160  * or into a new style RAND_DRBG. It is the callers duty to 1) initialize the
161  * random pool, 2) pass it to the polling callbacks, 3) seed the RNG, and
162  * 4) cleanup the random pool again.
163  *
164  * The random pool contains no locking mechanism because its scope and
165  * lifetime is intended to be restricted to a single stack frame.
166  */
167 struct rand_pool_st {
168     unsigned char *buffer;  /* points to the beginning of the random pool */
169     size_t len; /* current number of random bytes contained in the pool */
170
171     int attached;  /* true pool was attached to existing buffer */
172
173     size_t min_len; /* minimum number of random bytes requested */
174     size_t max_len; /* maximum number of random bytes (allocated buffer size) */
175     size_t entropy; /* current entropy count in bits */
176     size_t entropy_requested; /* requested entropy count in bits */
177 };
178
179 /*
180  * The state of all types of DRBGs, even though we only have CTR mode
181  * right now.
182  */
183 struct rand_drbg_st {
184     CRYPTO_RWLOCK *lock;
185     RAND_DRBG *parent;
186     int secure; /* 1: allocated on the secure heap, 0: otherwise */
187     int type; /* the nid of the underlying algorithm */
188     /*
189      * Stores the value of the rand_fork_count global as of when we last
190      * reseeded.  The DRBG reseeds automatically whenever drbg->fork_count !=
191      * rand_fork_count.  Used to provide fork-safety and reseed this DRBG in
192      * the child process.
193      */
194     int fork_count;
195     unsigned short flags; /* various external flags */
196
197     /*
198      * The random_data is used by RAND_add()/drbg_add() to attach random
199      * data to the global drbg, such that the rand_drbg_get_entropy() callback
200      * can pull it during instantiation and reseeding. This is necessary to
201      * reconcile the different philosophies of the RAND and the RAND_DRBG
202      * with respect to how randomness is added to the RNG during reseeding
203      * (see PR #4328).
204      */
205     struct rand_pool_st *pool;
206
207     /*
208      * The following parameters are setup by the per-type "init" function.
209      *
210      * The supported types and their init functions are:
211      *    (1) CTR_DRBG:  drbg_ctr_init().
212      *    (2) HMAC_DRBG: drbg_hmac_init().
213      *    (3) HASH_DRBG: drbg_hash_init().
214      *
215      * The parameters are closely related to the ones described in
216      * section '10.2.1 CTR_DRBG' of [NIST SP 800-90Ar1], with one
217      * crucial difference: In the NIST standard, all counts are given
218      * in bits, whereas in OpenSSL entropy counts are given in bits
219      * and buffer lengths are given in bytes.
220      *
221      * Since this difference has lead to some confusion in the past,
222      * (see [GitHub Issue #2443], formerly [rt.openssl.org #4055])
223      * the 'len' suffix has been added to all buffer sizes for
224      * clarification.
225      */
226
227     int strength;
228     size_t max_request;
229     size_t min_entropylen, max_entropylen;
230     size_t min_noncelen, max_noncelen;
231     size_t max_perslen, max_adinlen;
232
233     /*
234      * Counts the number of generate requests since the last reseed
235      * (Starts at 1). This value is the reseed_counter as defined in
236      * NIST SP 800-90Ar1
237      */
238     unsigned int reseed_gen_counter;
239     /*
240      * Maximum number of generate requests until a reseed is required.
241      * This value is ignored if it is zero.
242      */
243     unsigned int reseed_interval;
244     /* Stores the time when the last reseeding occurred */
245     time_t reseed_time;
246     /*
247      * Specifies the maximum time interval (in seconds) between reseeds.
248      * This value is ignored if it is zero.
249      */
250     time_t reseed_time_interval;
251     /*
252      * Counts the number of reseeds since instantiation.
253      * This value is ignored if it is zero.
254      *
255      * This counter is used only for seed propagation from the <master> DRBG
256      * to its two children, the <public> and <private> DRBG. This feature is
257      * very special and its sole purpose is to ensure that any randomness which
258      * is added by RAND_add() or RAND_seed() will have an immediate effect on
259      * the output of RAND_bytes() resp. RAND_priv_bytes().
260      */
261     unsigned int reseed_prop_counter;
262
263     size_t seedlen;
264     DRBG_STATUS state;
265
266     /* Application data, mainly used in the KATs. */
267     CRYPTO_EX_DATA ex_data;
268
269     /* Implementation specific data */
270     union {
271         RAND_DRBG_CTR ctr;
272         RAND_DRBG_HASH hash;
273         RAND_DRBG_HMAC hmac;
274     } data;
275
276     /* Implementation specific methods */
277     RAND_DRBG_METHOD *meth;
278
279     /* Callback functions.  See comments in rand_lib.c */
280     RAND_DRBG_get_entropy_fn get_entropy;
281     RAND_DRBG_cleanup_entropy_fn cleanup_entropy;
282     RAND_DRBG_get_nonce_fn get_nonce;
283     RAND_DRBG_cleanup_nonce_fn cleanup_nonce;
284 };
285
286 /* The global RAND method, and the global buffer and DRBG instance. */
287 extern RAND_METHOD rand_meth;
288
289 /*
290  * A "generation count" of forks.  Incremented in the child process after a
291  * fork.  Since rand_fork_count is increment-only, and only ever written to in
292  * the child process of the fork, which is guaranteed to be single-threaded, no
293  * locking is needed for normal (read) accesses; the rest of pthread fork
294  * processing is assumed to introduce the necessary memory barriers.  Sibling
295  * children of a given parent will produce duplicate values, but this is not
296  * problematic because the reseeding process pulls input from the system CSPRNG
297  * and/or other global sources, so the siblings will end up generating
298  * different output streams.
299  */
300 extern int rand_fork_count;
301
302 /* DRBG helpers */
303 int rand_drbg_restart(RAND_DRBG *drbg,
304                       const unsigned char *buffer, size_t len, size_t entropy);
305
306 /* locking api */
307 int rand_drbg_lock(RAND_DRBG *drbg);
308 int rand_drbg_unlock(RAND_DRBG *drbg);
309 int rand_drbg_enable_locking(RAND_DRBG *drbg);
310
311
312 /* initializes the DRBG implementation */
313 int drbg_ctr_init(RAND_DRBG *drbg);
314 int drbg_hash_init(RAND_DRBG *drbg);
315 int drbg_hmac_init(RAND_DRBG *drbg);
316
317 #endif