]> git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/rand/drbg_lib.c
drbg_lib: avoid NULL pointer dereference in drbg_add
[thirdparty/openssl.git] / crypto / rand / drbg_lib.c
1 /*
2 * Copyright 2011-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 #include <string.h>
11 #include <openssl/crypto.h>
12 #include <openssl/err.h>
13 #include <openssl/rand.h>
14 #include "rand_lcl.h"
15 #include "internal/thread_once.h"
16 #include "internal/rand_int.h"
17 #include "internal/cryptlib_int.h"
18
19 /*
20 * Support framework for NIST SP 800-90A DRBG
21 *
22 * See manual page RAND_DRBG(7) for a general overview.
23 *
24 * The OpenSSL model is to have new and free functions, and that new
25 * does all initialization. That is not the NIST model, which has
26 * instantiation and un-instantiate, and re-use within a new/free
27 * lifecycle. (No doubt this comes from the desire to support hardware
28 * DRBG, where allocation of resources on something like an HSM is
29 * a much bigger deal than just re-setting an allocated resource.)
30 */
31
32 /*
33 * The three shared DRBG instances
34 *
35 * There are three shared DRBG instances: <master>, <public>, and <private>.
36 */
37
38 /*
39 * The <master> DRBG
40 *
41 * Not used directly by the application, only for reseeding the two other
42 * DRBGs. It reseeds itself by pulling either randomness from os entropy
43 * sources or by consuming randomness which was added by RAND_add().
44 *
45 * The <master> DRBG is a global instance which is accessed concurrently by
46 * all threads. The necessary locking is managed automatically by its child
47 * DRBG instances during reseeding.
48 */
49 static RAND_DRBG *master_drbg;
50 /*
51 * The <public> DRBG
52 *
53 * Used by default for generating random bytes using RAND_bytes().
54 *
55 * The <public> DRBG is thread-local, i.e., there is one instance per thread.
56 */
57 static CRYPTO_THREAD_LOCAL public_drbg;
58 /*
59 * The <private> DRBG
60 *
61 * Used by default for generating private keys using RAND_priv_bytes()
62 *
63 * The <private> DRBG is thread-local, i.e., there is one instance per thread.
64 */
65 static CRYPTO_THREAD_LOCAL private_drbg;
66
67
68
69 /* NIST SP 800-90A DRBG recommends the use of a personalization string. */
70 static const char ossl_pers_string[] = "OpenSSL NIST SP 800-90A DRBG";
71
72 static CRYPTO_ONCE rand_drbg_init = CRYPTO_ONCE_STATIC_INIT;
73
74
75 #define RAND_DRBG_TYPE_FLAGS ( \
76 RAND_DRBG_FLAG_MASTER | RAND_DRBG_FLAG_PUBLIC | RAND_DRBG_FLAG_PRIVATE )
77
78 #define RAND_DRBG_TYPE_MASTER 0
79 #define RAND_DRBG_TYPE_PUBLIC 1
80 #define RAND_DRBG_TYPE_PRIVATE 2
81
82 /* Defaults */
83 static int rand_drbg_type[3] = {
84 RAND_DRBG_TYPE, /* Master */
85 RAND_DRBG_TYPE, /* Public */
86 RAND_DRBG_TYPE /* Private */
87 };
88 static unsigned int rand_drbg_flags[3] = {
89 RAND_DRBG_FLAGS | RAND_DRBG_FLAG_MASTER, /* Master */
90 RAND_DRBG_FLAGS | RAND_DRBG_FLAG_PUBLIC, /* Public */
91 RAND_DRBG_FLAGS | RAND_DRBG_FLAG_PRIVATE /* Private */
92 };
93
94 static unsigned int master_reseed_interval = MASTER_RESEED_INTERVAL;
95 static unsigned int slave_reseed_interval = SLAVE_RESEED_INTERVAL;
96
97 static time_t master_reseed_time_interval = MASTER_RESEED_TIME_INTERVAL;
98 static time_t slave_reseed_time_interval = SLAVE_RESEED_TIME_INTERVAL;
99
100 /* A logical OR of all used DRBG flag bits (currently there is only one) */
101 static const unsigned int rand_drbg_used_flags =
102 RAND_DRBG_FLAG_CTR_NO_DF | RAND_DRBG_FLAG_HMAC | RAND_DRBG_TYPE_FLAGS;
103
104
105 static RAND_DRBG *drbg_setup(RAND_DRBG *parent, int drbg_type);
106
107 static RAND_DRBG *rand_drbg_new(int secure,
108 int type,
109 unsigned int flags,
110 RAND_DRBG *parent);
111
112 static int is_ctr(int type)
113 {
114 switch (type) {
115 case NID_aes_128_ctr:
116 case NID_aes_192_ctr:
117 case NID_aes_256_ctr:
118 return 1;
119 default:
120 return 0;
121 }
122 }
123
124 static int is_digest(int type)
125 {
126 switch (type) {
127 case NID_sha1:
128 case NID_sha224:
129 case NID_sha256:
130 case NID_sha384:
131 case NID_sha512:
132 case NID_sha512_224:
133 case NID_sha512_256:
134 case NID_sha3_224:
135 case NID_sha3_256:
136 case NID_sha3_384:
137 case NID_sha3_512:
138 return 1;
139 default:
140 return 0;
141 }
142 }
143
144 /*
145 * Set/initialize |drbg| to be of type |type|, with optional |flags|.
146 *
147 * If |type| and |flags| are zero, use the defaults
148 *
149 * Returns 1 on success, 0 on failure.
150 */
151 int RAND_DRBG_set(RAND_DRBG *drbg, int type, unsigned int flags)
152 {
153 int ret = 1;
154
155 if (type == 0 && flags == 0) {
156 type = rand_drbg_type[RAND_DRBG_TYPE_MASTER];
157 flags = rand_drbg_flags[RAND_DRBG_TYPE_MASTER];
158 }
159
160 /* If set is called multiple times - clear the old one */
161 if (type != drbg->type && drbg->type != 0 && drbg->meth != NULL) {
162 drbg->meth->uninstantiate(drbg);
163 }
164
165 drbg->state = DRBG_UNINITIALISED;
166 drbg->flags = flags;
167 drbg->type = type;
168
169 if (type == 0) {
170 /* Uninitialized; that's okay. */
171 return 1;
172 } else if (is_ctr(type)) {
173 ret = drbg_ctr_init(drbg);
174 } else if (is_digest(type)) {
175 if (flags & RAND_DRBG_FLAG_HMAC)
176 ret = drbg_hmac_init(drbg);
177 else
178 ret = drbg_hash_init(drbg);
179 } else {
180 RANDerr(RAND_F_RAND_DRBG_SET, RAND_R_UNSUPPORTED_DRBG_TYPE);
181 return 0;
182 }
183
184 if (ret == 0)
185 RANDerr(RAND_F_RAND_DRBG_SET, RAND_R_ERROR_INITIALISING_DRBG);
186 return ret;
187 }
188
189 /*
190 * Set/initialize default |type| and |flag| for new drbg instances.
191 *
192 * Returns 1 on success, 0 on failure.
193 */
194 int RAND_DRBG_set_defaults(int type, unsigned int flags)
195 {
196 int all;
197 if (!(is_digest(type) || is_ctr(type))) {
198 RANDerr(RAND_F_RAND_DRBG_SET_DEFAULTS, RAND_R_UNSUPPORTED_DRBG_TYPE);
199 return 0;
200 }
201
202 if ((flags & ~rand_drbg_used_flags) != 0) {
203 RANDerr(RAND_F_RAND_DRBG_SET_DEFAULTS, RAND_R_UNSUPPORTED_DRBG_FLAGS);
204 return 0;
205 }
206
207 all = ((flags & RAND_DRBG_TYPE_FLAGS) == 0);
208 if (all || (flags & RAND_DRBG_FLAG_MASTER) != 0) {
209 rand_drbg_type[RAND_DRBG_TYPE_MASTER] = type;
210 rand_drbg_flags[RAND_DRBG_TYPE_MASTER] = flags | RAND_DRBG_FLAG_MASTER;
211 }
212 if (all || (flags & RAND_DRBG_FLAG_PUBLIC) != 0) {
213 rand_drbg_type[RAND_DRBG_TYPE_PUBLIC] = type;
214 rand_drbg_flags[RAND_DRBG_TYPE_PUBLIC] = flags | RAND_DRBG_FLAG_PUBLIC;
215 }
216 if (all || (flags & RAND_DRBG_FLAG_PRIVATE) != 0) {
217 rand_drbg_type[RAND_DRBG_TYPE_PRIVATE] = type;
218 rand_drbg_flags[RAND_DRBG_TYPE_PRIVATE] = flags | RAND_DRBG_FLAG_PRIVATE;
219 }
220 return 1;
221 }
222
223
224 /*
225 * Allocate memory and initialize a new DRBG. The DRBG is allocated on
226 * the secure heap if |secure| is nonzero and the secure heap is enabled.
227 * The |parent|, if not NULL, will be used as random source for reseeding.
228 *
229 * Returns a pointer to the new DRBG instance on success, NULL on failure.
230 */
231 static RAND_DRBG *rand_drbg_new(int secure,
232 int type,
233 unsigned int flags,
234 RAND_DRBG *parent)
235 {
236 RAND_DRBG *drbg = secure ?
237 OPENSSL_secure_zalloc(sizeof(*drbg)) : OPENSSL_zalloc(sizeof(*drbg));
238
239 if (drbg == NULL) {
240 RANDerr(RAND_F_RAND_DRBG_NEW, ERR_R_MALLOC_FAILURE);
241 return NULL;
242 }
243
244 drbg->secure = secure && CRYPTO_secure_allocated(drbg);
245 drbg->fork_count = rand_fork_count;
246 drbg->parent = parent;
247
248 if (parent == NULL) {
249 drbg->get_entropy = rand_drbg_get_entropy;
250 drbg->cleanup_entropy = rand_drbg_cleanup_entropy;
251 #ifndef RAND_DRBG_GET_RANDOM_NONCE
252 drbg->get_nonce = rand_drbg_get_nonce;
253 drbg->cleanup_nonce = rand_drbg_cleanup_nonce;
254 #endif
255
256 drbg->reseed_interval = master_reseed_interval;
257 drbg->reseed_time_interval = master_reseed_time_interval;
258 } else {
259 drbg->get_entropy = rand_drbg_get_entropy;
260 drbg->cleanup_entropy = rand_drbg_cleanup_entropy;
261 /*
262 * Do not provide nonce callbacks, the child DRBGs will
263 * obtain their nonce using random bits from the parent.
264 */
265
266 drbg->reseed_interval = slave_reseed_interval;
267 drbg->reseed_time_interval = slave_reseed_time_interval;
268 }
269
270 if (RAND_DRBG_set(drbg, type, flags) == 0)
271 goto err;
272
273 if (parent != NULL) {
274 rand_drbg_lock(parent);
275 if (drbg->strength > parent->strength) {
276 /*
277 * We currently don't support the algorithm from NIST SP 800-90C
278 * 10.1.2 to use a weaker DRBG as source
279 */
280 rand_drbg_unlock(parent);
281 RANDerr(RAND_F_RAND_DRBG_NEW, RAND_R_PARENT_STRENGTH_TOO_WEAK);
282 goto err;
283 }
284 rand_drbg_unlock(parent);
285 }
286
287 return drbg;
288
289 err:
290 if (drbg->secure)
291 OPENSSL_secure_free(drbg);
292 else
293 OPENSSL_free(drbg);
294
295 return NULL;
296 }
297
298 RAND_DRBG *RAND_DRBG_new(int type, unsigned int flags, RAND_DRBG *parent)
299 {
300 return rand_drbg_new(0, type, flags, parent);
301 }
302
303 RAND_DRBG *RAND_DRBG_secure_new(int type, unsigned int flags, RAND_DRBG *parent)
304 {
305 return rand_drbg_new(1, type, flags, parent);
306 }
307
308 /*
309 * Uninstantiate |drbg| and free all memory.
310 */
311 void RAND_DRBG_free(RAND_DRBG *drbg)
312 {
313 if (drbg == NULL)
314 return;
315
316 if (drbg->meth != NULL)
317 drbg->meth->uninstantiate(drbg);
318 CRYPTO_THREAD_lock_free(drbg->lock);
319 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_DRBG, drbg, &drbg->ex_data);
320
321 if (drbg->secure)
322 OPENSSL_secure_clear_free(drbg, sizeof(*drbg));
323 else
324 OPENSSL_clear_free(drbg, sizeof(*drbg));
325 }
326
327 /*
328 * Instantiate |drbg|, after it has been initialized. Use |pers| and
329 * |perslen| as prediction-resistance input.
330 *
331 * Requires that drbg->lock is already locked for write, if non-null.
332 *
333 * Returns 1 on success, 0 on failure.
334 */
335 int RAND_DRBG_instantiate(RAND_DRBG *drbg,
336 const unsigned char *pers, size_t perslen)
337 {
338 unsigned char *nonce = NULL, *entropy = NULL;
339 size_t noncelen = 0, entropylen = 0;
340 size_t min_entropy = drbg->strength;
341 size_t min_entropylen = drbg->min_entropylen;
342 size_t max_entropylen = drbg->max_entropylen;
343
344 if (perslen > drbg->max_perslen) {
345 RANDerr(RAND_F_RAND_DRBG_INSTANTIATE,
346 RAND_R_PERSONALISATION_STRING_TOO_LONG);
347 goto end;
348 }
349
350 if (drbg->meth == NULL) {
351 RANDerr(RAND_F_RAND_DRBG_INSTANTIATE,
352 RAND_R_NO_DRBG_IMPLEMENTATION_SELECTED);
353 goto end;
354 }
355
356 if (drbg->state != DRBG_UNINITIALISED) {
357 RANDerr(RAND_F_RAND_DRBG_INSTANTIATE,
358 drbg->state == DRBG_ERROR ? RAND_R_IN_ERROR_STATE
359 : RAND_R_ALREADY_INSTANTIATED);
360 goto end;
361 }
362
363 drbg->state = DRBG_ERROR;
364
365 /*
366 * NIST SP800-90Ar1 section 9.1 says you can combine getting the entropy
367 * and nonce in 1 call by increasing the entropy with 50% and increasing
368 * the minimum length to accomadate the length of the nonce.
369 * We do this in case a nonce is require and get_nonce is NULL.
370 */
371 if (drbg->min_noncelen > 0 && drbg->get_nonce == NULL) {
372 min_entropy += drbg->strength / 2;
373 min_entropylen += drbg->min_noncelen;
374 max_entropylen += drbg->max_noncelen;
375 }
376
377 drbg->reseed_next_counter = tsan_load(&drbg->reseed_prop_counter);
378 if (drbg->reseed_next_counter) {
379 drbg->reseed_next_counter++;
380 if(!drbg->reseed_next_counter)
381 drbg->reseed_next_counter = 1;
382 }
383
384 if (drbg->get_entropy != NULL)
385 entropylen = drbg->get_entropy(drbg, &entropy, min_entropy,
386 min_entropylen, max_entropylen, 0);
387 if (entropylen < min_entropylen
388 || entropylen > max_entropylen) {
389 RANDerr(RAND_F_RAND_DRBG_INSTANTIATE, RAND_R_ERROR_RETRIEVING_ENTROPY);
390 goto end;
391 }
392
393 if (drbg->min_noncelen > 0 && drbg->get_nonce != NULL) {
394 noncelen = drbg->get_nonce(drbg, &nonce, drbg->strength / 2,
395 drbg->min_noncelen, drbg->max_noncelen);
396 if (noncelen < drbg->min_noncelen || noncelen > drbg->max_noncelen) {
397 RANDerr(RAND_F_RAND_DRBG_INSTANTIATE, RAND_R_ERROR_RETRIEVING_NONCE);
398 goto end;
399 }
400 }
401
402 if (!drbg->meth->instantiate(drbg, entropy, entropylen,
403 nonce, noncelen, pers, perslen)) {
404 RANDerr(RAND_F_RAND_DRBG_INSTANTIATE, RAND_R_ERROR_INSTANTIATING_DRBG);
405 goto end;
406 }
407
408 drbg->state = DRBG_READY;
409 drbg->reseed_gen_counter = 1;
410 drbg->reseed_time = time(NULL);
411 tsan_store(&drbg->reseed_prop_counter, drbg->reseed_next_counter);
412
413 end:
414 if (entropy != NULL && drbg->cleanup_entropy != NULL)
415 drbg->cleanup_entropy(drbg, entropy, entropylen);
416 if (nonce != NULL && drbg->cleanup_nonce != NULL)
417 drbg->cleanup_nonce(drbg, nonce, noncelen);
418 if (drbg->pool != NULL) {
419 if (drbg->state == DRBG_READY) {
420 RANDerr(RAND_F_RAND_DRBG_INSTANTIATE,
421 RAND_R_ERROR_ENTROPY_POOL_WAS_IGNORED);
422 drbg->state = DRBG_ERROR;
423 }
424 rand_pool_free(drbg->pool);
425 drbg->pool = NULL;
426 }
427 if (drbg->state == DRBG_READY)
428 return 1;
429 return 0;
430 }
431
432 /*
433 * Uninstantiate |drbg|. Must be instantiated before it can be used.
434 *
435 * Requires that drbg->lock is already locked for write, if non-null.
436 *
437 * Returns 1 on success, 0 on failure.
438 */
439 int RAND_DRBG_uninstantiate(RAND_DRBG *drbg)
440 {
441 int index = -1, type, flags;
442 if (drbg->meth == NULL) {
443 RANDerr(RAND_F_RAND_DRBG_UNINSTANTIATE,
444 RAND_R_NO_DRBG_IMPLEMENTATION_SELECTED);
445 return 0;
446 }
447
448 /* Clear the entire drbg->ctr struct, then reset some important
449 * members of the drbg->ctr struct (e.g. keysize, df_ks) to their
450 * initial values.
451 */
452 drbg->meth->uninstantiate(drbg);
453
454 /* The reset uses the default values for type and flags */
455 if (drbg->flags & RAND_DRBG_FLAG_MASTER)
456 index = RAND_DRBG_TYPE_MASTER;
457 else if (drbg->flags & RAND_DRBG_FLAG_PRIVATE)
458 index = RAND_DRBG_TYPE_PRIVATE;
459 else if (drbg->flags & RAND_DRBG_FLAG_PUBLIC)
460 index = RAND_DRBG_TYPE_PUBLIC;
461
462 if (index != -1) {
463 flags = rand_drbg_flags[index];
464 type = rand_drbg_type[index];
465 } else {
466 flags = drbg->flags;
467 type = drbg->type;
468 }
469 return RAND_DRBG_set(drbg, type, flags);
470 }
471
472 /*
473 * Reseed |drbg|, mixing in the specified data
474 *
475 * Requires that drbg->lock is already locked for write, if non-null.
476 *
477 * Returns 1 on success, 0 on failure.
478 */
479 int RAND_DRBG_reseed(RAND_DRBG *drbg,
480 const unsigned char *adin, size_t adinlen,
481 int prediction_resistance)
482 {
483 unsigned char *entropy = NULL;
484 size_t entropylen = 0;
485
486 if (drbg->state == DRBG_ERROR) {
487 RANDerr(RAND_F_RAND_DRBG_RESEED, RAND_R_IN_ERROR_STATE);
488 return 0;
489 }
490 if (drbg->state == DRBG_UNINITIALISED) {
491 RANDerr(RAND_F_RAND_DRBG_RESEED, RAND_R_NOT_INSTANTIATED);
492 return 0;
493 }
494
495 if (adin == NULL) {
496 adinlen = 0;
497 } else if (adinlen > drbg->max_adinlen) {
498 RANDerr(RAND_F_RAND_DRBG_RESEED, RAND_R_ADDITIONAL_INPUT_TOO_LONG);
499 return 0;
500 }
501
502 drbg->state = DRBG_ERROR;
503
504 drbg->reseed_next_counter = tsan_load(&drbg->reseed_prop_counter);
505 if (drbg->reseed_next_counter) {
506 drbg->reseed_next_counter++;
507 if(!drbg->reseed_next_counter)
508 drbg->reseed_next_counter = 1;
509 }
510
511 if (drbg->get_entropy != NULL)
512 entropylen = drbg->get_entropy(drbg, &entropy, drbg->strength,
513 drbg->min_entropylen,
514 drbg->max_entropylen,
515 prediction_resistance);
516 if (entropylen < drbg->min_entropylen
517 || entropylen > drbg->max_entropylen) {
518 RANDerr(RAND_F_RAND_DRBG_RESEED, RAND_R_ERROR_RETRIEVING_ENTROPY);
519 goto end;
520 }
521
522 if (!drbg->meth->reseed(drbg, entropy, entropylen, adin, adinlen))
523 goto end;
524
525 drbg->state = DRBG_READY;
526 drbg->reseed_gen_counter = 1;
527 drbg->reseed_time = time(NULL);
528 tsan_store(&drbg->reseed_prop_counter, drbg->reseed_next_counter);
529
530 end:
531 if (entropy != NULL && drbg->cleanup_entropy != NULL)
532 drbg->cleanup_entropy(drbg, entropy, entropylen);
533 if (drbg->state == DRBG_READY)
534 return 1;
535 return 0;
536 }
537
538 /*
539 * Restart |drbg|, using the specified entropy or additional input
540 *
541 * Tries its best to get the drbg instantiated by all means,
542 * regardless of its current state.
543 *
544 * Optionally, a |buffer| of |len| random bytes can be passed,
545 * which is assumed to contain at least |entropy| bits of entropy.
546 *
547 * If |entropy| > 0, the buffer content is used as entropy input.
548 *
549 * If |entropy| == 0, the buffer content is used as additional input
550 *
551 * Returns 1 on success, 0 on failure.
552 *
553 * This function is used internally only.
554 */
555 int rand_drbg_restart(RAND_DRBG *drbg,
556 const unsigned char *buffer, size_t len, size_t entropy)
557 {
558 int reseeded = 0;
559 const unsigned char *adin = NULL;
560 size_t adinlen = 0;
561
562 if (drbg->pool != NULL) {
563 RANDerr(RAND_F_RAND_DRBG_RESTART, ERR_R_INTERNAL_ERROR);
564 drbg->state = DRBG_ERROR;
565 rand_pool_free(drbg->pool);
566 drbg->pool = NULL;
567 return 0;
568 }
569
570 if (buffer != NULL) {
571 if (entropy > 0) {
572 if (drbg->max_entropylen < len) {
573 RANDerr(RAND_F_RAND_DRBG_RESTART,
574 RAND_R_ENTROPY_INPUT_TOO_LONG);
575 drbg->state = DRBG_ERROR;
576 return 0;
577 }
578
579 if (entropy > 8 * len) {
580 RANDerr(RAND_F_RAND_DRBG_RESTART, RAND_R_ENTROPY_OUT_OF_RANGE);
581 drbg->state = DRBG_ERROR;
582 return 0;
583 }
584
585 /* will be picked up by the rand_drbg_get_entropy() callback */
586 drbg->pool = rand_pool_attach(buffer, len, entropy);
587 if (drbg->pool == NULL)
588 return 0;
589 } else {
590 if (drbg->max_adinlen < len) {
591 RANDerr(RAND_F_RAND_DRBG_RESTART,
592 RAND_R_ADDITIONAL_INPUT_TOO_LONG);
593 drbg->state = DRBG_ERROR;
594 return 0;
595 }
596 adin = buffer;
597 adinlen = len;
598 }
599 }
600
601 /* repair error state */
602 if (drbg->state == DRBG_ERROR)
603 RAND_DRBG_uninstantiate(drbg);
604
605 /* repair uninitialized state */
606 if (drbg->state == DRBG_UNINITIALISED) {
607 /* reinstantiate drbg */
608 RAND_DRBG_instantiate(drbg,
609 (const unsigned char *) ossl_pers_string,
610 sizeof(ossl_pers_string) - 1);
611 /* already reseeded. prevent second reseeding below */
612 reseeded = (drbg->state == DRBG_READY);
613 }
614
615 /* refresh current state if entropy or additional input has been provided */
616 if (drbg->state == DRBG_READY) {
617 if (adin != NULL) {
618 /*
619 * mix in additional input without reseeding
620 *
621 * Similar to RAND_DRBG_reseed(), but the provided additional
622 * data |adin| is mixed into the current state without pulling
623 * entropy from the trusted entropy source using get_entropy().
624 * This is not a reseeding in the strict sense of NIST SP 800-90A.
625 */
626 drbg->meth->reseed(drbg, adin, adinlen, NULL, 0);
627 } else if (reseeded == 0) {
628 /* do a full reseeding if it has not been done yet above */
629 RAND_DRBG_reseed(drbg, NULL, 0, 0);
630 }
631 }
632
633 /* check whether a given entropy pool was cleared properly during reseed */
634 if (drbg->pool != NULL) {
635 drbg->state = DRBG_ERROR;
636 RANDerr(RAND_F_RAND_DRBG_RESTART, ERR_R_INTERNAL_ERROR);
637 rand_pool_free(drbg->pool);
638 drbg->pool = NULL;
639 return 0;
640 }
641
642 return drbg->state == DRBG_READY;
643 }
644
645 /*
646 * Generate |outlen| bytes into the buffer at |out|. Reseed if we need
647 * to or if |prediction_resistance| is set. Additional input can be
648 * sent in |adin| and |adinlen|.
649 *
650 * Requires that drbg->lock is already locked for write, if non-null.
651 *
652 * Returns 1 on success, 0 on failure.
653 *
654 */
655 int RAND_DRBG_generate(RAND_DRBG *drbg, unsigned char *out, size_t outlen,
656 int prediction_resistance,
657 const unsigned char *adin, size_t adinlen)
658 {
659 int reseed_required = 0;
660
661 if (drbg->state != DRBG_READY) {
662 /* try to recover from previous errors */
663 rand_drbg_restart(drbg, NULL, 0, 0);
664
665 if (drbg->state == DRBG_ERROR) {
666 RANDerr(RAND_F_RAND_DRBG_GENERATE, RAND_R_IN_ERROR_STATE);
667 return 0;
668 }
669 if (drbg->state == DRBG_UNINITIALISED) {
670 RANDerr(RAND_F_RAND_DRBG_GENERATE, RAND_R_NOT_INSTANTIATED);
671 return 0;
672 }
673 }
674
675 if (outlen > drbg->max_request) {
676 RANDerr(RAND_F_RAND_DRBG_GENERATE, RAND_R_REQUEST_TOO_LARGE_FOR_DRBG);
677 return 0;
678 }
679 if (adinlen > drbg->max_adinlen) {
680 RANDerr(RAND_F_RAND_DRBG_GENERATE, RAND_R_ADDITIONAL_INPUT_TOO_LONG);
681 return 0;
682 }
683
684 if (drbg->fork_count != rand_fork_count) {
685 drbg->fork_count = rand_fork_count;
686 reseed_required = 1;
687 }
688
689 if (drbg->reseed_interval > 0) {
690 if (drbg->reseed_gen_counter > drbg->reseed_interval)
691 reseed_required = 1;
692 }
693 if (drbg->reseed_time_interval > 0) {
694 time_t now = time(NULL);
695 if (now < drbg->reseed_time
696 || now - drbg->reseed_time >= drbg->reseed_time_interval)
697 reseed_required = 1;
698 }
699 if (drbg->parent != NULL) {
700 unsigned int reseed_counter = tsan_load(&drbg->reseed_prop_counter);
701 if (reseed_counter > 0
702 && tsan_load(&drbg->parent->reseed_prop_counter)
703 != reseed_counter)
704 reseed_required = 1;
705 }
706
707 if (reseed_required || prediction_resistance) {
708 if (!RAND_DRBG_reseed(drbg, adin, adinlen, prediction_resistance)) {
709 RANDerr(RAND_F_RAND_DRBG_GENERATE, RAND_R_RESEED_ERROR);
710 return 0;
711 }
712 adin = NULL;
713 adinlen = 0;
714 }
715
716 if (!drbg->meth->generate(drbg, out, outlen, adin, adinlen)) {
717 drbg->state = DRBG_ERROR;
718 RANDerr(RAND_F_RAND_DRBG_GENERATE, RAND_R_GENERATE_ERROR);
719 return 0;
720 }
721
722 drbg->reseed_gen_counter++;
723
724 return 1;
725 }
726
727 /*
728 * Generates |outlen| random bytes and stores them in |out|. It will
729 * using the given |drbg| to generate the bytes.
730 *
731 * Requires that drbg->lock is already locked for write, if non-null.
732 *
733 * Returns 1 on success 0 on failure.
734 */
735 int RAND_DRBG_bytes(RAND_DRBG *drbg, unsigned char *out, size_t outlen)
736 {
737 unsigned char *additional = NULL;
738 size_t additional_len;
739 size_t chunk;
740 size_t ret;
741
742 additional_len = rand_drbg_get_additional_data(&additional, drbg->max_adinlen);
743
744 for ( ; outlen > 0; outlen -= chunk, out += chunk) {
745 chunk = outlen;
746 if (chunk > drbg->max_request)
747 chunk = drbg->max_request;
748 ret = RAND_DRBG_generate(drbg, out, chunk, 0, additional, additional_len);
749 if (!ret)
750 goto err;
751 }
752 ret = 1;
753
754 err:
755 if (additional_len != 0)
756 OPENSSL_secure_clear_free(additional, additional_len);
757
758 return ret;
759 }
760
761 /*
762 * Set the RAND_DRBG callbacks for obtaining entropy and nonce.
763 *
764 * Setting the callbacks is allowed only if the drbg has not been
765 * initialized yet. Otherwise, the operation will fail.
766 *
767 * Returns 1 on success, 0 on failure.
768 */
769 int RAND_DRBG_set_callbacks(RAND_DRBG *drbg,
770 RAND_DRBG_get_entropy_fn get_entropy,
771 RAND_DRBG_cleanup_entropy_fn cleanup_entropy,
772 RAND_DRBG_get_nonce_fn get_nonce,
773 RAND_DRBG_cleanup_nonce_fn cleanup_nonce)
774 {
775 if (drbg->state != DRBG_UNINITIALISED
776 || drbg->parent != NULL)
777 return 0;
778 drbg->get_entropy = get_entropy;
779 drbg->cleanup_entropy = cleanup_entropy;
780 drbg->get_nonce = get_nonce;
781 drbg->cleanup_nonce = cleanup_nonce;
782 return 1;
783 }
784
785 /*
786 * Set the reseed interval.
787 *
788 * The drbg will reseed automatically whenever the number of generate
789 * requests exceeds the given reseed interval. If the reseed interval
790 * is 0, then this feature is disabled.
791 *
792 * Returns 1 on success, 0 on failure.
793 */
794 int RAND_DRBG_set_reseed_interval(RAND_DRBG *drbg, unsigned int interval)
795 {
796 if (interval > MAX_RESEED_INTERVAL)
797 return 0;
798 drbg->reseed_interval = interval;
799 return 1;
800 }
801
802 /*
803 * Set the reseed time interval.
804 *
805 * The drbg will reseed automatically whenever the time elapsed since
806 * the last reseeding exceeds the given reseed time interval. For safety,
807 * a reseeding will also occur if the clock has been reset to a smaller
808 * value.
809 *
810 * Returns 1 on success, 0 on failure.
811 */
812 int RAND_DRBG_set_reseed_time_interval(RAND_DRBG *drbg, time_t interval)
813 {
814 if (interval > MAX_RESEED_TIME_INTERVAL)
815 return 0;
816 drbg->reseed_time_interval = interval;
817 return 1;
818 }
819
820 /*
821 * Set the default values for reseed (time) intervals of new DRBG instances
822 *
823 * The default values can be set independently for master DRBG instances
824 * (without a parent) and slave DRBG instances (with parent).
825 *
826 * Returns 1 on success, 0 on failure.
827 */
828
829 int RAND_DRBG_set_reseed_defaults(
830 unsigned int _master_reseed_interval,
831 unsigned int _slave_reseed_interval,
832 time_t _master_reseed_time_interval,
833 time_t _slave_reseed_time_interval
834 )
835 {
836 if (_master_reseed_interval > MAX_RESEED_INTERVAL
837 || _slave_reseed_interval > MAX_RESEED_INTERVAL)
838 return 0;
839
840 if (_master_reseed_time_interval > MAX_RESEED_TIME_INTERVAL
841 || _slave_reseed_time_interval > MAX_RESEED_TIME_INTERVAL)
842 return 0;
843
844 master_reseed_interval = _master_reseed_interval;
845 slave_reseed_interval = _slave_reseed_interval;
846
847 master_reseed_time_interval = _master_reseed_time_interval;
848 slave_reseed_time_interval = _slave_reseed_time_interval;
849
850 return 1;
851 }
852
853 /*
854 * Locks the given drbg. Locking a drbg which does not have locking
855 * enabled is considered a successful no-op.
856 *
857 * Returns 1 on success, 0 on failure.
858 */
859 int rand_drbg_lock(RAND_DRBG *drbg)
860 {
861 if (drbg->lock != NULL)
862 return CRYPTO_THREAD_write_lock(drbg->lock);
863
864 return 1;
865 }
866
867 /*
868 * Unlocks the given drbg. Unlocking a drbg which does not have locking
869 * enabled is considered a successful no-op.
870 *
871 * Returns 1 on success, 0 on failure.
872 */
873 int rand_drbg_unlock(RAND_DRBG *drbg)
874 {
875 if (drbg->lock != NULL)
876 return CRYPTO_THREAD_unlock(drbg->lock);
877
878 return 1;
879 }
880
881 /*
882 * Enables locking for the given drbg
883 *
884 * Locking can only be enabled if the random generator
885 * is in the uninitialized state.
886 *
887 * Returns 1 on success, 0 on failure.
888 */
889 int rand_drbg_enable_locking(RAND_DRBG *drbg)
890 {
891 if (drbg->state != DRBG_UNINITIALISED) {
892 RANDerr(RAND_F_RAND_DRBG_ENABLE_LOCKING,
893 RAND_R_DRBG_ALREADY_INITIALIZED);
894 return 0;
895 }
896
897 if (drbg->lock == NULL) {
898 if (drbg->parent != NULL && drbg->parent->lock == NULL) {
899 RANDerr(RAND_F_RAND_DRBG_ENABLE_LOCKING,
900 RAND_R_PARENT_LOCKING_NOT_ENABLED);
901 return 0;
902 }
903
904 drbg->lock = CRYPTO_THREAD_lock_new();
905 if (drbg->lock == NULL) {
906 RANDerr(RAND_F_RAND_DRBG_ENABLE_LOCKING,
907 RAND_R_FAILED_TO_CREATE_LOCK);
908 return 0;
909 }
910 }
911
912 return 1;
913 }
914
915 /*
916 * Get and set the EXDATA
917 */
918 int RAND_DRBG_set_ex_data(RAND_DRBG *drbg, int idx, void *arg)
919 {
920 return CRYPTO_set_ex_data(&drbg->ex_data, idx, arg);
921 }
922
923 void *RAND_DRBG_get_ex_data(const RAND_DRBG *drbg, int idx)
924 {
925 return CRYPTO_get_ex_data(&drbg->ex_data, idx);
926 }
927
928
929 /*
930 * The following functions provide a RAND_METHOD that works on the
931 * global DRBG. They lock.
932 */
933
934 /*
935 * Allocates a new global DRBG on the secure heap (if enabled) and
936 * initializes it with default settings.
937 *
938 * Returns a pointer to the new DRBG instance on success, NULL on failure.
939 */
940 static RAND_DRBG *drbg_setup(RAND_DRBG *parent, int drbg_type)
941 {
942 RAND_DRBG *drbg;
943
944 drbg = RAND_DRBG_secure_new(rand_drbg_type[drbg_type],
945 rand_drbg_flags[drbg_type], parent);
946 if (drbg == NULL)
947 return NULL;
948
949 /* Only the master DRBG needs to have a lock */
950 if (parent == NULL && rand_drbg_enable_locking(drbg) == 0)
951 goto err;
952
953 /* enable seed propagation */
954 tsan_store(&drbg->reseed_prop_counter, 1);
955
956 /*
957 * Ignore instantiation error to support just-in-time instantiation.
958 *
959 * The state of the drbg will be checked in RAND_DRBG_generate() and
960 * an automatic recovery is attempted.
961 */
962 (void)RAND_DRBG_instantiate(drbg,
963 (const unsigned char *) ossl_pers_string,
964 sizeof(ossl_pers_string) - 1);
965 return drbg;
966
967 err:
968 RAND_DRBG_free(drbg);
969 return NULL;
970 }
971
972 /*
973 * Initialize the global DRBGs on first use.
974 * Returns 1 on success, 0 on failure.
975 */
976 DEFINE_RUN_ONCE_STATIC(do_rand_drbg_init)
977 {
978 /*
979 * ensure that libcrypto is initialized, otherwise the
980 * DRBG locks are not cleaned up properly
981 */
982 if (!OPENSSL_init_crypto(0, NULL))
983 return 0;
984
985 if (!CRYPTO_THREAD_init_local(&private_drbg, NULL))
986 return 0;
987
988 if (!CRYPTO_THREAD_init_local(&public_drbg, NULL))
989 goto err1;
990
991 master_drbg = drbg_setup(NULL, RAND_DRBG_TYPE_MASTER);
992 if (master_drbg == NULL)
993 goto err2;
994
995 return 1;
996
997 err2:
998 CRYPTO_THREAD_cleanup_local(&public_drbg);
999 err1:
1000 CRYPTO_THREAD_cleanup_local(&private_drbg);
1001 return 0;
1002 }
1003
1004 /* Clean up the global DRBGs before exit */
1005 void rand_drbg_cleanup_int(void)
1006 {
1007 if (master_drbg != NULL) {
1008 RAND_DRBG_free(master_drbg);
1009 master_drbg = NULL;
1010
1011 CRYPTO_THREAD_cleanup_local(&private_drbg);
1012 CRYPTO_THREAD_cleanup_local(&public_drbg);
1013 }
1014 }
1015
1016 void drbg_delete_thread_state(void)
1017 {
1018 RAND_DRBG *drbg;
1019
1020 drbg = CRYPTO_THREAD_get_local(&public_drbg);
1021 CRYPTO_THREAD_set_local(&public_drbg, NULL);
1022 RAND_DRBG_free(drbg);
1023
1024 drbg = CRYPTO_THREAD_get_local(&private_drbg);
1025 CRYPTO_THREAD_set_local(&private_drbg, NULL);
1026 RAND_DRBG_free(drbg);
1027 }
1028
1029 /* Implements the default OpenSSL RAND_bytes() method */
1030 static int drbg_bytes(unsigned char *out, int count)
1031 {
1032 int ret;
1033 RAND_DRBG *drbg = RAND_DRBG_get0_public();
1034
1035 if (drbg == NULL)
1036 return 0;
1037
1038 ret = RAND_DRBG_bytes(drbg, out, count);
1039
1040 return ret;
1041 }
1042
1043 /*
1044 * Calculates the minimum length of a full entropy buffer
1045 * which is necessary to seed (i.e. instantiate) the DRBG
1046 * successfully.
1047 *
1048 * NOTE: There is a copy of this function in drbgtest.c.
1049 * If you change anything here, you need to update
1050 * the copy accordingly.
1051 */
1052 static size_t rand_drbg_seedlen(RAND_DRBG *drbg)
1053 {
1054 /*
1055 * If no os entropy source is available then RAND_seed(buffer, bufsize)
1056 * is expected to succeed if and only if the buffer length satisfies
1057 * the following requirements, which follow from the calculations
1058 * in RAND_DRBG_instantiate().
1059 */
1060 size_t min_entropy = drbg->strength;
1061 size_t min_entropylen = drbg->min_entropylen;
1062
1063 /*
1064 * Extra entropy for the random nonce in the absence of a
1065 * get_nonce callback, see comment in RAND_DRBG_instantiate().
1066 */
1067 if (drbg->min_noncelen > 0 && drbg->get_nonce == NULL) {
1068 min_entropy += drbg->strength / 2;
1069 min_entropylen += drbg->min_noncelen;
1070 }
1071
1072 /*
1073 * Convert entropy requirement from bits to bytes
1074 * (dividing by 8 without rounding upwards, because
1075 * all entropy requirements are divisible by 8).
1076 */
1077 min_entropy >>= 3;
1078
1079 /* Return a value that satisfies both requirements */
1080 return min_entropy > min_entropylen ? min_entropy : min_entropylen;
1081 }
1082
1083 /* Implements the default OpenSSL RAND_add() method */
1084 static int drbg_add(const void *buf, int num, double randomness)
1085 {
1086 int ret = 0;
1087 RAND_DRBG *drbg = RAND_DRBG_get0_master();
1088 size_t buflen;
1089 size_t seedlen;
1090
1091 if (drbg == NULL)
1092 return 0;
1093
1094 if (num < 0 || randomness < 0.0)
1095 return 0;
1096
1097 seedlen = rand_drbg_seedlen(drbg);
1098
1099 buflen = (size_t)num;
1100
1101 if (buflen < seedlen || randomness < (double) seedlen) {
1102 #if defined(OPENSSL_RAND_SEED_NONE)
1103 /*
1104 * If no os entropy source is available, a reseeding will fail
1105 * inevitably. So we use a trick to mix the buffer contents into
1106 * the DRBG state without forcing a reseeding: we generate a
1107 * dummy random byte, using the buffer content as additional data.
1108 */
1109 unsigned char dummy[1];
1110
1111 return RAND_DRBG_generate(drbg, dummy, sizeof(dummy), 0, buf, buflen);
1112 #else
1113 /*
1114 * If an os entropy source is avaible then we declare the buffer content
1115 * as additional data by setting randomness to zero and trigger a regular
1116 * reseeding.
1117 */
1118 randomness = 0.0;
1119 #endif
1120 }
1121
1122
1123 if (randomness > (double)seedlen) {
1124 /*
1125 * The purpose of this check is to bound |randomness| by a
1126 * relatively small value in order to prevent an integer
1127 * overflow when multiplying by 8 in the rand_drbg_restart()
1128 * call below. Note that randomness is measured in bytes,
1129 * not bits, so this value corresponds to eight times the
1130 * security strength.
1131 */
1132 randomness = (double)seedlen;
1133 }
1134
1135 rand_drbg_lock(drbg);
1136 ret = rand_drbg_restart(drbg, buf, buflen, (size_t)(8 * randomness));
1137 rand_drbg_unlock(drbg);
1138
1139 return ret;
1140 }
1141
1142 /* Implements the default OpenSSL RAND_seed() method */
1143 static int drbg_seed(const void *buf, int num)
1144 {
1145 return drbg_add(buf, num, num);
1146 }
1147
1148 /* Implements the default OpenSSL RAND_status() method */
1149 static int drbg_status(void)
1150 {
1151 int ret;
1152 RAND_DRBG *drbg = RAND_DRBG_get0_master();
1153
1154 if (drbg == NULL)
1155 return 0;
1156
1157 rand_drbg_lock(drbg);
1158 ret = drbg->state == DRBG_READY ? 1 : 0;
1159 rand_drbg_unlock(drbg);
1160 return ret;
1161 }
1162
1163 /*
1164 * Get the master DRBG.
1165 * Returns pointer to the DRBG on success, NULL on failure.
1166 *
1167 */
1168 RAND_DRBG *RAND_DRBG_get0_master(void)
1169 {
1170 if (!RUN_ONCE(&rand_drbg_init, do_rand_drbg_init))
1171 return NULL;
1172
1173 return master_drbg;
1174 }
1175
1176 /*
1177 * Get the public DRBG.
1178 * Returns pointer to the DRBG on success, NULL on failure.
1179 */
1180 RAND_DRBG *RAND_DRBG_get0_public(void)
1181 {
1182 RAND_DRBG *drbg;
1183
1184 if (!RUN_ONCE(&rand_drbg_init, do_rand_drbg_init))
1185 return NULL;
1186
1187 drbg = CRYPTO_THREAD_get_local(&public_drbg);
1188 if (drbg == NULL) {
1189 if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_RAND))
1190 return NULL;
1191 drbg = drbg_setup(master_drbg, RAND_DRBG_TYPE_PUBLIC);
1192 CRYPTO_THREAD_set_local(&public_drbg, drbg);
1193 }
1194 return drbg;
1195 }
1196
1197 /*
1198 * Get the private DRBG.
1199 * Returns pointer to the DRBG on success, NULL on failure.
1200 */
1201 RAND_DRBG *RAND_DRBG_get0_private(void)
1202 {
1203 RAND_DRBG *drbg;
1204
1205 if (!RUN_ONCE(&rand_drbg_init, do_rand_drbg_init))
1206 return NULL;
1207
1208 drbg = CRYPTO_THREAD_get_local(&private_drbg);
1209 if (drbg == NULL) {
1210 if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_RAND))
1211 return NULL;
1212 drbg = drbg_setup(master_drbg, RAND_DRBG_TYPE_PRIVATE);
1213 CRYPTO_THREAD_set_local(&private_drbg, drbg);
1214 }
1215 return drbg;
1216 }
1217
1218 RAND_METHOD rand_meth = {
1219 drbg_seed,
1220 drbg_bytes,
1221 NULL,
1222 drbg_add,
1223 drbg_bytes,
1224 drbg_status
1225 };
1226
1227 RAND_METHOD *RAND_OpenSSL(void)
1228 {
1229 return &rand_meth;
1230 }