0a5037464f659665bea986d7f96f8550378486ae
[openssl.git] / crypto / rand / md_rand.c
1 /* crypto/rand/md_rand.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
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.
8  * 
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).
15  * 
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.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
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)"
40  * 
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
51  * SUCH DAMAGE.
52  * 
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.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
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
71  *    distribution.
72  *
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/)"
77  *
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.
82  *
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.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
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  * ====================================================================
105  *
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).
109  *
110  */
111
112 #ifdef MD_RAND_DEBUG
113 # ifndef NDEBUG
114 #   define NDEBUG
115 # endif
116 #endif
117
118 #include <assert.h>
119 #include <stdio.h>
120 #include <string.h>
121
122 #include "e_os.h"
123
124 #include <openssl/rand.h>
125 #include "rand_lcl.h"
126
127 #include <openssl/crypto.h>
128 #include <openssl/err.h>
129 #include <openssl/evp.h>
130 #include <openssl/sha.h>
131
132 #ifdef BN_DEBUG
133 # define PREDICT
134 #endif
135
136 /* #define PREDICT      1 */
137
138 #define STATE_SIZE      1023
139 static int state_num=0,state_index=0;
140 static unsigned char state[STATE_SIZE+MD_DIGEST_LENGTH];
141 static unsigned char md[MD_DIGEST_LENGTH];
142 static long md_count[2]={0,0};
143 static double entropy=0;
144 static int initialized=0;
145
146 static unsigned int crypto_lock_rand = 0; /* may be set only when a thread
147                                            * holds CRYPTO_LOCK_RAND
148                                            * (to prevent double locking) */
149 /* access to lockin_thread is synchronized by CRYPTO_LOCK_RAND2 */
150 static unsigned long locking_thread = 0; /* valid iff crypto_lock_rand is set */
151
152
153 #ifdef PREDICT
154 int rand_predictable=0;
155 #endif
156
157 const char *RAND_version="RAND" OPENSSL_VERSION_PTEXT;
158
159 static void ssleay_rand_cleanup(void);
160 static void ssleay_rand_seed(const void *buf, int num);
161 static void ssleay_rand_add(const void *buf, int num, double add_entropy);
162 static int ssleay_rand_bytes(unsigned char *buf, int num);
163 static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num);
164 static int ssleay_rand_status(void);
165
166 RAND_METHOD rand_ssleay_meth={
167         ssleay_rand_seed,
168         ssleay_rand_bytes,
169         ssleay_rand_cleanup,
170         ssleay_rand_add,
171         ssleay_rand_pseudo_bytes,
172         ssleay_rand_status
173         }; 
174
175 RAND_METHOD *RAND_SSLeay(void)
176         {
177         return(&rand_ssleay_meth);
178         }
179
180 static void ssleay_rand_cleanup(void)
181         {
182         memset(state,0,sizeof(state));
183         state_num=0;
184         state_index=0;
185         memset(md,0,MD_DIGEST_LENGTH);
186         md_count[0]=0;
187         md_count[1]=0;
188         entropy=0;
189         initialized=0;
190         }
191
192 static void ssleay_rand_add(const void *buf, int num, double add)
193         {
194         int i,j,k,st_idx;
195         long md_c[2];
196         unsigned char local_md[MD_DIGEST_LENGTH];
197         EVP_MD_CTX m;
198         int do_not_lock;
199
200         /*
201          * (Based on the rand(3) manpage)
202          *
203          * The input is chopped up into units of 20 bytes (or less for
204          * the last block).  Each of these blocks is run through the hash
205          * function as follows:  The data passed to the hash function
206          * is the current 'md', the same number of bytes from the 'state'
207          * (the location determined by in incremented looping index) as
208          * the current 'block', the new key data 'block', and 'count'
209          * (which is incremented after each use).
210          * The result of this is kept in 'md' and also xored into the
211          * 'state' at the same locations that were used as input into the
212          * hash function.
213          */
214
215         /* check if we already have the lock */
216         if (crypto_lock_rand)
217                 {
218                 CRYPTO_r_lock(CRYPTO_LOCK_RAND2);
219                 do_not_lock = (locking_thread == CRYPTO_thread_id());
220                 CRYPTO_r_unlock(CRYPTO_LOCK_RAND2);
221                 }
222         else
223                 do_not_lock = 0;
224
225         if (!do_not_lock) CRYPTO_w_lock(CRYPTO_LOCK_RAND);
226         st_idx=state_index;
227
228         /* use our own copies of the counters so that even
229          * if a concurrent thread seeds with exactly the
230          * same data and uses the same subarray there's _some_
231          * difference */
232         md_c[0] = md_count[0];
233         md_c[1] = md_count[1];
234
235         memcpy(local_md, md, sizeof md);
236
237         /* state_index <= state_num <= STATE_SIZE */
238         state_index += num;
239         if (state_index >= STATE_SIZE)
240                 {
241                 state_index%=STATE_SIZE;
242                 state_num=STATE_SIZE;
243                 }
244         else if (state_num < STATE_SIZE)        
245                 {
246                 if (state_index > state_num)
247                         state_num=state_index;
248                 }
249         /* state_index <= state_num <= STATE_SIZE */
250
251         /* state[st_idx], ..., state[(st_idx + num - 1) % STATE_SIZE]
252          * are what we will use now, but other threads may use them
253          * as well */
254
255         md_count[1] += (num / MD_DIGEST_LENGTH) + (num % MD_DIGEST_LENGTH > 0);
256
257         if (!do_not_lock) CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
258
259         EVP_MD_CTX_init(&m);
260         for (i=0; i<num; i+=MD_DIGEST_LENGTH)
261                 {
262                 j=(num-i);
263                 j=(j > MD_DIGEST_LENGTH)?MD_DIGEST_LENGTH:j;
264
265                 MD_Init(&m);
266                 MD_Update(&m,local_md,MD_DIGEST_LENGTH);
267                 k=(st_idx+j)-STATE_SIZE;
268                 if (k > 0)
269                         {
270                         MD_Update(&m,&(state[st_idx]),j-k);
271                         MD_Update(&m,&(state[0]),k);
272                         }
273                 else
274                         MD_Update(&m,&(state[st_idx]),j);
275                         
276                 MD_Update(&m,buf,j);
277                 MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
278                 MD_Final(&m,local_md);
279                 md_c[1]++;
280
281                 buf=(const char *)buf + j;
282
283                 for (k=0; k<j; k++)
284                         {
285                         /* Parallel threads may interfere with this,
286                          * but always each byte of the new state is
287                          * the XOR of some previous value of its
288                          * and local_md (itermediate values may be lost).
289                          * Alway using locking could hurt performance more
290                          * than necessary given that conflicts occur only
291                          * when the total seeding is longer than the random
292                          * state. */
293                         state[st_idx++]^=local_md[k];
294                         if (st_idx >= STATE_SIZE)
295                                 st_idx=0;
296                         }
297                 }
298         EVP_MD_CTX_cleanup(&m);
299
300         if (!do_not_lock) CRYPTO_w_lock(CRYPTO_LOCK_RAND);
301         /* Don't just copy back local_md into md -- this could mean that
302          * other thread's seeding remains without effect (except for
303          * the incremented counter).  By XORing it we keep at least as
304          * much entropy as fits into md. */
305         for (k = 0; k < sizeof md; k++)
306                 {
307                 md[k] ^= local_md[k];
308                 }
309         if (entropy < ENTROPY_NEEDED) /* stop counting when we have enough */
310             entropy += add;
311         if (!do_not_lock) CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
312         
313 #if !defined(OPENSSL_THREADS) && !defined(OPENSSL_SYS_WIN32)
314         assert(md_c[1] == md_count[1]);
315 #endif
316         }
317
318 static void ssleay_rand_seed(const void *buf, int num)
319         {
320         ssleay_rand_add(buf, num, num);
321         }
322
323 static int ssleay_rand_bytes(unsigned char *buf, int num)
324         {
325         static volatile int stirred_pool = 0;
326         int i,j,k,st_num,st_idx;
327         int num_ceil;
328         int ok;
329         long md_c[2];
330         unsigned char local_md[MD_DIGEST_LENGTH];
331         EVP_MD_CTX m;
332 #ifndef GETPID_IS_MEANINGLESS
333         pid_t curr_pid = getpid();
334 #endif
335         int do_stir_pool = 0;
336
337 #ifdef PREDICT
338         if (rand_predictable)
339                 {
340                 static unsigned char val=0;
341
342                 for (i=0; i<num; i++)
343                         buf[i]=val++;
344                 return(1);
345                 }
346 #endif
347
348         if (num <= 0)
349                 return 1;
350
351         EVP_MD_CTX_init(&m);
352         /* round upwards to multiple of MD_DIGEST_LENGTH/2 */
353         num_ceil = (1 + (num-1)/(MD_DIGEST_LENGTH/2)) * (MD_DIGEST_LENGTH/2);
354
355         /*
356          * (Based on the rand(3) manpage:)
357          *
358          * For each group of 10 bytes (or less), we do the following:
359          *
360          * Input into the hash function the local 'md' (which is initialized from
361          * the global 'md' before any bytes are generated), the bytes that are to
362          * be overwritten by the random bytes, and bytes from the 'state'
363          * (incrementing looping index). From this digest output (which is kept
364          * in 'md'), the top (up to) 10 bytes are returned to the caller and the
365          * bottom 10 bytes are xored into the 'state'.
366          * 
367          * Finally, after we have finished 'num' random bytes for the
368          * caller, 'count' (which is incremented) and the local and global 'md'
369          * are fed into the hash function and the results are kept in the
370          * global 'md'.
371          */
372
373         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
374
375         /* prevent ssleay_rand_bytes() from trying to obtain the lock again */
376         CRYPTO_w_lock(CRYPTO_LOCK_RAND2);
377         locking_thread = CRYPTO_thread_id();
378         CRYPTO_w_unlock(CRYPTO_LOCK_RAND2);
379         crypto_lock_rand = 1;
380
381         if (!initialized)
382                 {
383                 RAND_poll();
384                 initialized = 1;
385                 }
386         
387         if (!stirred_pool)
388                 do_stir_pool = 1;
389         
390         ok = (entropy >= ENTROPY_NEEDED);
391         if (!ok)
392                 {
393                 /* If the PRNG state is not yet unpredictable, then seeing
394                  * the PRNG output may help attackers to determine the new
395                  * state; thus we have to decrease the entropy estimate.
396                  * Once we've had enough initial seeding we don't bother to
397                  * adjust the entropy count, though, because we're not ambitious
398                  * to provide *information-theoretic* randomness.
399                  *
400                  * NOTE: This approach fails if the program forks before
401                  * we have enough entropy. Entropy should be collected
402                  * in a separate input pool and be transferred to the
403                  * output pool only when the entropy limit has been reached.
404                  */
405                 entropy -= num;
406                 if (entropy < 0)
407                         entropy = 0;
408                 }
409
410         if (do_stir_pool)
411                 {
412                 /* In the output function only half of 'md' remains secret,
413                  * so we better make sure that the required entropy gets
414                  * 'evenly distributed' through 'state', our randomness pool.
415                  * The input function (ssleay_rand_add) chains all of 'md',
416                  * which makes it more suitable for this purpose.
417                  */
418
419                 int n = STATE_SIZE; /* so that the complete pool gets accessed */
420                 while (n > 0)
421                         {
422 #if MD_DIGEST_LENGTH > 20
423 # error "Please adjust DUMMY_SEED."
424 #endif
425 #define DUMMY_SEED "...................." /* at least MD_DIGEST_LENGTH */
426                         /* Note that the seed does not matter, it's just that
427                          * ssleay_rand_add expects to have something to hash. */
428                         ssleay_rand_add(DUMMY_SEED, MD_DIGEST_LENGTH, 0.0);
429                         n -= MD_DIGEST_LENGTH;
430                         }
431                 if (ok)
432                         stirred_pool = 1;
433                 }
434
435         st_idx=state_index;
436         st_num=state_num;
437         md_c[0] = md_count[0];
438         md_c[1] = md_count[1];
439         memcpy(local_md, md, sizeof md);
440
441         state_index+=num_ceil;
442         if (state_index > state_num)
443                 state_index %= state_num;
444
445         /* state[st_idx], ..., state[(st_idx + num_ceil - 1) % st_num]
446          * are now ours (but other threads may use them too) */
447
448         md_count[0] += 1;
449
450         /* before unlocking, we must clear 'crypto_lock_rand' */
451         crypto_lock_rand = 0;
452         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
453
454         while (num > 0)
455                 {
456                 /* num_ceil -= MD_DIGEST_LENGTH/2 */
457                 j=(num >= MD_DIGEST_LENGTH/2)?MD_DIGEST_LENGTH/2:num;
458                 num-=j;
459                 MD_Init(&m);
460 #ifndef GETPID_IS_MEANINGLESS
461                 if (curr_pid) /* just in the first iteration to save time */
462                         {
463                         MD_Update(&m,(unsigned char*)&curr_pid,sizeof curr_pid);
464                         curr_pid = 0;
465                         }
466 #endif
467                 MD_Update(&m,local_md,MD_DIGEST_LENGTH);
468                 MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
469 #ifndef PURIFY
470                 MD_Update(&m,buf,j); /* purify complains */
471 #endif
472                 k=(st_idx+MD_DIGEST_LENGTH/2)-st_num;
473                 if (k > 0)
474                         {
475                         MD_Update(&m,&(state[st_idx]),MD_DIGEST_LENGTH/2-k);
476                         MD_Update(&m,&(state[0]),k);
477                         }
478                 else
479                         MD_Update(&m,&(state[st_idx]),MD_DIGEST_LENGTH/2);
480                 MD_Final(&m,local_md);
481
482                 for (i=0; i<MD_DIGEST_LENGTH/2; i++)
483                         {
484                         state[st_idx++]^=local_md[i]; /* may compete with other threads */
485                         if (st_idx >= st_num)
486                                 st_idx=0;
487                         if (i < j)
488                                 *(buf++)=local_md[i+MD_DIGEST_LENGTH/2];
489                         }
490                 }
491
492         MD_Init(&m);
493         MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
494         MD_Update(&m,local_md,MD_DIGEST_LENGTH);
495         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
496         MD_Update(&m,md,MD_DIGEST_LENGTH);
497         MD_Final(&m,md);
498         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
499
500         EVP_MD_CTX_cleanup(&m);
501         if (ok)
502                 return(1);
503         else
504                 {
505                 RANDerr(RAND_F_SSLEAY_RAND_BYTES,RAND_R_PRNG_NOT_SEEDED);
506                 ERR_add_error_data(1, "You need to read the OpenSSL FAQ, "
507                         "http://www.openssl.org/support/faq.html");
508                 return(0);
509                 }
510         }
511
512 /* pseudo-random bytes that are guaranteed to be unique but not
513    unpredictable */
514 static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num) 
515         {
516         int ret;
517         unsigned long err;
518
519         ret = RAND_bytes(buf, num);
520         if (ret == 0)
521                 {
522                 err = ERR_peek_error();
523                 if (ERR_GET_LIB(err) == ERR_LIB_RAND &&
524                     ERR_GET_REASON(err) == RAND_R_PRNG_NOT_SEEDED)
525                         (void)ERR_get_error();
526                 }
527         return (ret);
528         }
529
530 static int ssleay_rand_status(void)
531         {
532         int ret;
533         int do_not_lock;
534
535         /* check if we already have the lock
536          * (could happen if a RAND_poll() implementation calls RAND_status()) */
537         if (crypto_lock_rand)
538                 {
539                 CRYPTO_r_lock(CRYPTO_LOCK_RAND2);
540                 do_not_lock = (locking_thread == CRYPTO_thread_id());
541                 CRYPTO_r_unlock(CRYPTO_LOCK_RAND2);
542                 }
543         else
544                 do_not_lock = 0;
545         
546         if (!do_not_lock)
547                 {
548                 CRYPTO_w_lock(CRYPTO_LOCK_RAND);
549                 
550                 /* prevent ssleay_rand_bytes() from trying to obtain the lock again */
551                 CRYPTO_w_lock(CRYPTO_LOCK_RAND2);
552                 locking_thread = CRYPTO_thread_id();
553                 CRYPTO_w_unlock(CRYPTO_LOCK_RAND2);
554                 crypto_lock_rand = 1;
555                 }
556         
557         if (!initialized)
558                 {
559                 RAND_poll();
560                 initialized = 1;
561                 }
562
563         ret = entropy >= ENTROPY_NEEDED;
564
565         if (!do_not_lock)
566                 {
567                 /* before unlocking, we must clear 'crypto_lock_rand' */
568                 crypto_lock_rand = 0;
569                 
570                 CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
571                 }
572         
573         return ret;
574         }