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