1
/* crypto/rand/md_rand.c */
2
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5
* This package is an SSL implementation written
6
* by Eric Young (eay@cryptsoft.com).
7
* The implementation was written so as to conform with Netscapes SSL.
9
* This library is free for commercial and non-commercial use as long as
10
* the following conditions are aheared to. The following conditions
11
* apply to all code found in this distribution, be it the RC4, RSA,
12
* lhash, DES, etc., code; not just the SSL code. The SSL documentation
13
* included with this distribution is covered by the same copyright terms
14
* except that the holder is Tim Hudson (tjh@cryptsoft.com).
16
* Copyright remains Eric Young's, and as such any Copyright notices in
17
* the code are not to be removed.
18
* If this package is used in a product, Eric Young should be given attribution
19
* as the author of the parts of the library used.
20
* This can be in the form of a textual message at program startup or
21
* in documentation (online or textual) provided with the package.
23
* Redistribution and use in source and binary forms, with or without
24
* modification, are permitted provided that the following conditions
26
* 1. Redistributions of source code must retain the copyright
27
* notice, this list of conditions and the following disclaimer.
28
* 2. Redistributions in binary form must reproduce the above copyright
29
* notice, this list of conditions and the following disclaimer in the
30
* documentation and/or other materials provided with the distribution.
31
* 3. All advertising materials mentioning features or use of this software
32
* must display the following acknowledgement:
33
* "This product includes cryptographic software written by
34
* Eric Young (eay@cryptsoft.com)"
35
* The word 'cryptographic' can be left out if the rouines from the library
36
* being used are not cryptographic related :-).
37
* 4. If you include any Windows specific code (or a derivative thereof) from
38
* the apps directory (application code) you must include an acknowledgement:
39
* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41
* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53
* The licence and distribution terms for any publically available version or
54
* derivative of this code cannot be changed. i.e. this code cannot simply be
55
* copied and put under another distribution licence
56
* [including the GNU Public Licence.]
58
/* ====================================================================
59
* Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
61
* Redistribution and use in source and binary forms, with or without
62
* modification, are permitted provided that the following conditions
65
* 1. Redistributions of source code must retain the above copyright
66
* notice, this list of conditions and the following disclaimer.
68
* 2. Redistributions in binary form must reproduce the above copyright
69
* notice, this list of conditions and the following disclaimer in
70
* the documentation and/or other materials provided with the
73
* 3. All advertising materials mentioning features or use of this
74
* software must display the following acknowledgment:
75
* "This product includes software developed by the OpenSSL Project
76
* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
78
* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79
* endorse or promote products derived from this software without
80
* prior written permission. For written permission, please contact
81
* openssl-core@openssl.org.
83
* 5. Products derived from this software may not be called "OpenSSL"
84
* nor may "OpenSSL" appear in their names without prior written
85
* permission of the OpenSSL Project.
87
* 6. Redistributions of any form whatsoever must retain the following
89
* "This product includes software developed by the OpenSSL Project
90
* for use in the OpenSSL Toolkit (http://www.openssl.org/)"
92
* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103
* OF THE POSSIBILITY OF SUCH DAMAGE.
104
* ====================================================================
106
* This product includes cryptographic software written by Eric Young
107
* (eay@cryptsoft.com). This product includes software written by Tim
108
* Hudson (tjh@cryptsoft.com).
124
#include <openssl/rand.h>
125
#include "rand_lcl.h"
127
#include <openssl/crypto.h>
128
#include <openssl/err.h>
130
#include <openssl/fips.h>
138
/* #define PREDICT 1 */
140
#define STATE_SIZE 1023
141
static int state_num=0,state_index=0;
142
static unsigned char state[STATE_SIZE+MD_DIGEST_LENGTH];
143
static unsigned char md[MD_DIGEST_LENGTH];
144
static long md_count[2]={0,0};
145
static double entropy=0;
146
static int initialized=0;
148
static unsigned int crypto_lock_rand = 0; /* may be set only when a thread
149
* holds CRYPTO_LOCK_RAND
150
* (to prevent double locking) */
151
/* access to lockin_thread is synchronized by CRYPTO_LOCK_RAND2 */
152
static unsigned long locking_thread = 0; /* valid iff crypto_lock_rand is set */
156
int rand_predictable=0;
159
const char RAND_version[]="RAND" OPENSSL_VERSION_PTEXT;
161
static void ssleay_rand_cleanup(void);
162
static void ssleay_rand_seed(const void *buf, int num);
163
static void ssleay_rand_add(const void *buf, int num, double add_entropy);
164
static int ssleay_rand_bytes(unsigned char *buf, int num);
165
static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num);
166
static int ssleay_rand_status(void);
168
RAND_METHOD rand_ssleay_meth={
173
ssleay_rand_pseudo_bytes,
177
RAND_METHOD *RAND_SSLeay(void)
179
return(&rand_ssleay_meth);
182
static void ssleay_rand_cleanup(void)
184
OPENSSL_cleanse(state,sizeof(state));
187
OPENSSL_cleanse(md,MD_DIGEST_LENGTH);
194
static void ssleay_rand_add(const void *buf, int num, double add)
198
unsigned char local_md[MD_DIGEST_LENGTH];
203
* (Based on the rand(3) manpage)
205
* The input is chopped up into units of 20 bytes (or less for
206
* the last block). Each of these blocks is run through the hash
207
* function as follows: The data passed to the hash function
208
* is the current 'md', the same number of bytes from the 'state'
209
* (the location determined by in incremented looping index) as
210
* the current 'block', the new key data 'block', and 'count'
211
* (which is incremented after each use).
212
* The result of this is kept in 'md' and also xored into the
213
* 'state' at the same locations that were used as input into the
217
/* check if we already have the lock */
218
if (crypto_lock_rand)
220
CRYPTO_r_lock(CRYPTO_LOCK_RAND2);
221
do_not_lock = (locking_thread == CRYPTO_thread_id());
222
CRYPTO_r_unlock(CRYPTO_LOCK_RAND2);
227
if (!do_not_lock) CRYPTO_w_lock(CRYPTO_LOCK_RAND);
230
/* use our own copies of the counters so that even
231
* if a concurrent thread seeds with exactly the
232
* same data and uses the same subarray there's _some_
234
md_c[0] = md_count[0];
235
md_c[1] = md_count[1];
237
memcpy(local_md, md, sizeof md);
239
/* state_index <= state_num <= STATE_SIZE */
241
if (state_index >= STATE_SIZE)
243
state_index%=STATE_SIZE;
244
state_num=STATE_SIZE;
246
else if (state_num < STATE_SIZE)
248
if (state_index > state_num)
249
state_num=state_index;
251
/* state_index <= state_num <= STATE_SIZE */
253
/* state[st_idx], ..., state[(st_idx + num - 1) % STATE_SIZE]
254
* are what we will use now, but other threads may use them
257
md_count[1] += (num / MD_DIGEST_LENGTH) + (num % MD_DIGEST_LENGTH > 0);
259
if (!do_not_lock) CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
262
for (i=0; i<num; i+=MD_DIGEST_LENGTH)
265
j=(j > MD_DIGEST_LENGTH)?MD_DIGEST_LENGTH:j;
268
MD_Update(&m,local_md,MD_DIGEST_LENGTH);
269
k=(st_idx+j)-STATE_SIZE;
272
MD_Update(&m,&(state[st_idx]),j-k);
273
MD_Update(&m,&(state[0]),k);
276
MD_Update(&m,&(state[st_idx]),j);
279
MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
280
MD_Final(&m,local_md);
283
buf=(const char *)buf + j;
287
/* Parallel threads may interfere with this,
288
* but always each byte of the new state is
289
* the XOR of some previous value of its
290
* and local_md (itermediate values may be lost).
291
* Alway using locking could hurt performance more
292
* than necessary given that conflicts occur only
293
* when the total seeding is longer than the random
295
state[st_idx++]^=local_md[k];
296
if (st_idx >= STATE_SIZE)
300
EVP_MD_CTX_cleanup(&m);
302
if (!do_not_lock) CRYPTO_w_lock(CRYPTO_LOCK_RAND);
303
/* Don't just copy back local_md into md -- this could mean that
304
* other thread's seeding remains without effect (except for
305
* the incremented counter). By XORing it we keep at least as
306
* much entropy as fits into md. */
307
for (k = 0; k < (int)sizeof(md); k++)
309
md[k] ^= local_md[k];
311
if (entropy < ENTROPY_NEEDED) /* stop counting when we have enough */
313
if (!do_not_lock) CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
315
#if !defined(OPENSSL_THREADS) && !defined(OPENSSL_SYS_WIN32)
316
assert(md_c[1] == md_count[1]);
320
static void ssleay_rand_seed(const void *buf, int num)
322
ssleay_rand_add(buf, num, (double)num);
325
static int ssleay_rand_bytes(unsigned char *buf, int num)
327
static volatile int stirred_pool = 0;
328
int i,j,k,st_num,st_idx;
332
unsigned char local_md[MD_DIGEST_LENGTH];
334
#ifndef GETPID_IS_MEANINGLESS
335
pid_t curr_pid = getpid();
337
int do_stir_pool = 0;
342
FIPSerr(FIPS_F_SSLEAY_RAND_BYTES,FIPS_R_NON_FIPS_METHOD);
348
if (rand_predictable)
350
static unsigned char val=0;
352
for (i=0; i<num; i++)
362
/* round upwards to multiple of MD_DIGEST_LENGTH/2 */
363
num_ceil = (1 + (num-1)/(MD_DIGEST_LENGTH/2)) * (MD_DIGEST_LENGTH/2);
366
* (Based on the rand(3) manpage:)
368
* For each group of 10 bytes (or less), we do the following:
370
* Input into the hash function the local 'md' (which is initialized from
371
* the global 'md' before any bytes are generated), the bytes that are to
372
* be overwritten by the random bytes, and bytes from the 'state'
373
* (incrementing looping index). From this digest output (which is kept
374
* in 'md'), the top (up to) 10 bytes are returned to the caller and the
375
* bottom 10 bytes are xored into the 'state'.
377
* Finally, after we have finished 'num' random bytes for the
378
* caller, 'count' (which is incremented) and the local and global 'md'
379
* are fed into the hash function and the results are kept in the
383
CRYPTO_w_lock(CRYPTO_LOCK_RAND);
385
/* prevent ssleay_rand_bytes() from trying to obtain the lock again */
386
CRYPTO_w_lock(CRYPTO_LOCK_RAND2);
387
locking_thread = CRYPTO_thread_id();
388
CRYPTO_w_unlock(CRYPTO_LOCK_RAND2);
389
crypto_lock_rand = 1;
400
ok = (entropy >= ENTROPY_NEEDED);
403
/* If the PRNG state is not yet unpredictable, then seeing
404
* the PRNG output may help attackers to determine the new
405
* state; thus we have to decrease the entropy estimate.
406
* Once we've had enough initial seeding we don't bother to
407
* adjust the entropy count, though, because we're not ambitious
408
* to provide *information-theoretic* randomness.
410
* NOTE: This approach fails if the program forks before
411
* we have enough entropy. Entropy should be collected
412
* in a separate input pool and be transferred to the
413
* output pool only when the entropy limit has been reached.
422
/* In the output function only half of 'md' remains secret,
423
* so we better make sure that the required entropy gets
424
* 'evenly distributed' through 'state', our randomness pool.
425
* The input function (ssleay_rand_add) chains all of 'md',
426
* which makes it more suitable for this purpose.
429
int n = STATE_SIZE; /* so that the complete pool gets accessed */
432
#if MD_DIGEST_LENGTH > 20
433
# error "Please adjust DUMMY_SEED."
435
#define DUMMY_SEED "...................." /* at least MD_DIGEST_LENGTH */
436
/* Note that the seed does not matter, it's just that
437
* ssleay_rand_add expects to have something to hash. */
438
ssleay_rand_add(DUMMY_SEED, MD_DIGEST_LENGTH, 0.0);
439
n -= MD_DIGEST_LENGTH;
447
md_c[0] = md_count[0];
448
md_c[1] = md_count[1];
449
memcpy(local_md, md, sizeof md);
451
state_index+=num_ceil;
452
if (state_index > state_num)
453
state_index %= state_num;
455
/* state[st_idx], ..., state[(st_idx + num_ceil - 1) % st_num]
456
* are now ours (but other threads may use them too) */
460
/* before unlocking, we must clear 'crypto_lock_rand' */
461
crypto_lock_rand = 0;
462
CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
466
/* num_ceil -= MD_DIGEST_LENGTH/2 */
467
j=(num >= MD_DIGEST_LENGTH/2)?MD_DIGEST_LENGTH/2:num;
470
#ifndef GETPID_IS_MEANINGLESS
471
if (curr_pid) /* just in the first iteration to save time */
473
MD_Update(&m,(unsigned char*)&curr_pid,sizeof curr_pid);
477
MD_Update(&m,local_md,MD_DIGEST_LENGTH);
478
MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
480
MD_Update(&m,buf,j); /* purify complains */
482
k=(st_idx+MD_DIGEST_LENGTH/2)-st_num;
485
MD_Update(&m,&(state[st_idx]),MD_DIGEST_LENGTH/2-k);
486
MD_Update(&m,&(state[0]),k);
489
MD_Update(&m,&(state[st_idx]),MD_DIGEST_LENGTH/2);
490
MD_Final(&m,local_md);
492
for (i=0; i<MD_DIGEST_LENGTH/2; i++)
494
state[st_idx++]^=local_md[i]; /* may compete with other threads */
495
if (st_idx >= st_num)
498
*(buf++)=local_md[i+MD_DIGEST_LENGTH/2];
503
MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
504
MD_Update(&m,local_md,MD_DIGEST_LENGTH);
505
CRYPTO_w_lock(CRYPTO_LOCK_RAND);
506
MD_Update(&m,md,MD_DIGEST_LENGTH);
508
CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
510
EVP_MD_CTX_cleanup(&m);
515
RANDerr(RAND_F_SSLEAY_RAND_BYTES,RAND_R_PRNG_NOT_SEEDED);
516
ERR_add_error_data(1, "You need to read the OpenSSL FAQ, "
517
"http://www.openssl.org/support/faq.html");
522
/* pseudo-random bytes that are guaranteed to be unique but not
524
static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num)
529
ret = RAND_bytes(buf, num);
532
err = ERR_peek_error();
533
if (ERR_GET_LIB(err) == ERR_LIB_RAND &&
534
ERR_GET_REASON(err) == RAND_R_PRNG_NOT_SEEDED)
540
static int ssleay_rand_status(void)
545
/* check if we already have the lock
546
* (could happen if a RAND_poll() implementation calls RAND_status()) */
547
if (crypto_lock_rand)
549
CRYPTO_r_lock(CRYPTO_LOCK_RAND2);
550
do_not_lock = (locking_thread == CRYPTO_thread_id());
551
CRYPTO_r_unlock(CRYPTO_LOCK_RAND2);
558
CRYPTO_w_lock(CRYPTO_LOCK_RAND);
560
/* prevent ssleay_rand_bytes() from trying to obtain the lock again */
561
CRYPTO_w_lock(CRYPTO_LOCK_RAND2);
562
locking_thread = CRYPTO_thread_id();
563
CRYPTO_w_unlock(CRYPTO_LOCK_RAND2);
564
crypto_lock_rand = 1;
573
ret = entropy >= ENTROPY_NEEDED;
577
/* before unlocking, we must clear 'crypto_lock_rand' */
578
crypto_lock_rand = 0;
580
CRYPTO_w_unlock(CRYPTO_LOCK_RAND);