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