583fc137d81fbc5ec5308a9f38b88da1a68d62c0
[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 #define ENTROPY_NEEDED 16  /* require 128 bits = 16 bytes of randomness */
60
61 #ifndef MD_RAND_DEBUG
62 # ifndef NDEBUG
63 #   define NDEBUG
64 # endif
65 #endif
66
67 #include <assert.h>
68 #include <stdio.h>
69 #include <time.h>
70 #include <string.h>
71
72 #include "openssl/e_os.h"
73
74 #include <openssl/crypto.h>
75 #include <openssl/err.h>
76
77 #if !defined(USE_MD5_RAND) && !defined(USE_SHA1_RAND) && !defined(USE_MDC2_RAND) && !defined(USE_MD2_RAND)
78 #if !defined(NO_SHA) && !defined(NO_SHA1)
79 #define USE_SHA1_RAND
80 #elif !defined(NO_MD5)
81 #define USE_MD5_RAND
82 #elif !defined(NO_MDC2) && !defined(NO_DES)
83 #define USE_MDC2_RAND
84 #elif !defined(NO_MD2)
85 #define USE_MD2_RAND
86 #else
87 #error No message digest algorithm available
88 #endif
89 #endif
90
91 /* Changed how the state buffer used.  I now attempt to 'wrap' such
92  * that I don't run over the same locations the next time  go through
93  * the 1023 bytes - many thanks to
94  * Robert J. LeBlanc <rjl@renaissoft.com> for his comments
95  */
96
97 #if defined(USE_MD5_RAND)
98 #include <openssl/md5.h>
99 #define MD_DIGEST_LENGTH        MD5_DIGEST_LENGTH
100 #define MD_CTX                  MD5_CTX
101 #define MD_Init(a)              MD5_Init(a)
102 #define MD_Update(a,b,c)        MD5_Update(a,b,c)
103 #define MD_Final(a,b)           MD5_Final(a,b)
104 #define MD(a,b,c)               MD5(a,b,c)
105 #elif defined(USE_SHA1_RAND)
106 #include <openssl/sha.h>
107 #define MD_DIGEST_LENGTH        SHA_DIGEST_LENGTH
108 #define MD_CTX                  SHA_CTX
109 #define MD_Init(a)              SHA1_Init(a)
110 #define MD_Update(a,b,c)        SHA1_Update(a,b,c)
111 #define MD_Final(a,b)           SHA1_Final(a,b)
112 #define MD(a,b,c)               SHA1(a,b,c)
113 #elif defined(USE_MDC2_RAND)
114 #include <openssl/mdc2.h>
115 #define MD_DIGEST_LENGTH        MDC2_DIGEST_LENGTH
116 #define MD_CTX                  MDC2_CTX
117 #define MD_Init(a)              MDC2_Init(a)
118 #define MD_Update(a,b,c)        MDC2_Update(a,b,c)
119 #define MD_Final(a,b)           MDC2_Final(a,b)
120 #define MD(a,b,c)               MDC2(a,b,c)
121 #elif defined(USE_MD2_RAND)
122 #include <openssl/md2.h>
123 #define MD_DIGEST_LENGTH        MD2_DIGEST_LENGTH
124 #define MD_CTX                  MD2_CTX
125 #define MD_Init(a)              MD2_Init(a)
126 #define MD_Update(a,b,c)        MD2_Update(a,b,c)
127 #define MD_Final(a,b)           MD2_Final(a,b)
128 #define MD(a,b,c)               MD2(a,b,c)
129 #endif
130
131 #include <openssl/rand.h>
132
133 #ifdef BN_DEBUG
134 # define PREDICT
135 #endif
136
137 /* #define NORAND       1 */
138 /* #define PREDICT      1 */
139
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;
147
148 #ifdef PREDICT
149 int rand_predictable=0;
150 #endif
151
152 const char *RAND_version="RAND" OPENSSL_VERSION_PTEXT;
153
154 static void ssleay_rand_cleanup(void);
155 static void ssleay_rand_seed(const void *buf, int num);
156 static void ssleay_rand_add(const void *buf, int num, double add_entropy);
157 static int ssleay_rand_bytes(unsigned char *buf, int num);
158 static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num);
159
160 RAND_METHOD rand_ssleay_meth={
161         ssleay_rand_seed,
162         ssleay_rand_bytes,
163         ssleay_rand_cleanup,
164         ssleay_rand_add,
165         ssleay_rand_pseudo_bytes,
166         }; 
167
168 RAND_METHOD *RAND_SSLeay(void)
169         {
170         return(&rand_ssleay_meth);
171         }
172
173 static void ssleay_rand_cleanup(void)
174         {
175         memset(state,0,sizeof(state));
176         state_num=0;
177         state_index=0;
178         memset(md,0,MD_DIGEST_LENGTH);
179         md_count[0]=0;
180         md_count[1]=0;
181         entropy=0;
182         }
183
184 static void ssleay_rand_add(const void *buf, int num, double add)
185         {
186         int i,j,k,st_idx;
187         long md_c[2];
188         unsigned char local_md[MD_DIGEST_LENGTH];
189         MD_CTX m;
190
191 #ifdef NORAND
192         return;
193 #endif
194
195         /*
196          * (Based on the rand(3) manpage)
197          *
198          * The input is chopped up into units of 20 bytes (or less for
199          * the last block).  Each of these blocks is run through the hash
200          * function as follows:  The data passed to the hash function
201          * is the current 'md', the same number of bytes from the 'state'
202          * (the location determined by in incremented looping index) as
203          * the current 'block', the new key data 'block', and 'count'
204          * (which is incremented after each use).
205          * The result of this is kept in 'md' and also xored into the
206          * 'state' at the same locations that were used as input into the
207          * hash function.
208          */
209
210         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
211         st_idx=state_index;
212
213         /* use our own copies of the counters so that even
214          * if a concurrent thread seeds with exactly the
215          * same data and uses the same subarray there's _some_
216          * difference */
217         md_c[0] = md_count[0];
218         md_c[1] = md_count[1];
219
220         memcpy(local_md, md, sizeof md);
221
222         /* state_index <= state_num <= STATE_SIZE */
223         state_index += num;
224         if (state_index >= STATE_SIZE)
225                 {
226                 state_index%=STATE_SIZE;
227                 state_num=STATE_SIZE;
228                 }
229         else if (state_num < STATE_SIZE)        
230                 {
231                 if (state_index > state_num)
232                         state_num=state_index;
233                 }
234         /* state_index <= state_num <= STATE_SIZE */
235
236         /* state[st_idx], ..., state[(st_idx + num - 1) % STATE_SIZE]
237          * are what we will use now, but other threads may use them
238          * as well */
239
240         md_count[1] += (num / MD_DIGEST_LENGTH) + (num % MD_DIGEST_LENGTH > 0);
241
242         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
243
244         for (i=0; i<num; i+=MD_DIGEST_LENGTH)
245                 {
246                 j=(num-i);
247                 j=(j > MD_DIGEST_LENGTH)?MD_DIGEST_LENGTH:j;
248
249                 MD_Init(&m);
250                 MD_Update(&m,local_md,MD_DIGEST_LENGTH);
251                 k=(st_idx+j)-STATE_SIZE;
252                 if (k > 0)
253                         {
254                         MD_Update(&m,&(state[st_idx]),j-k);
255                         MD_Update(&m,&(state[0]),k);
256                         }
257                 else
258                         MD_Update(&m,&(state[st_idx]),j);
259                         
260                 MD_Update(&m,buf,j);
261                 MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
262                 MD_Final(local_md,&m);
263                 md_c[1]++;
264
265                 buf=(const char *)buf + j;
266
267                 for (k=0; k<j; k++)
268                         {
269                         /* Parallel threads may interfere with this,
270                          * but always each byte of the new state is
271                          * the XOR of some previous value of its
272                          * and local_md (itermediate values may be lost).
273                          * Alway using locking could hurt performance more
274                          * than necessary given that conflicts occur only
275                          * when the total seeding is longer than the random
276                          * state. */
277                         state[st_idx++]^=local_md[k];
278                         if (st_idx >= STATE_SIZE)
279                                 st_idx=0;
280                         }
281                 }
282         memset((char *)&m,0,sizeof(m));
283
284         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
285         /* Don't just copy back local_md into md -- this could mean that
286          * other thread's seeding remains without effect (except for
287          * the incremented counter).  By XORing it we keep at least as
288          * much entropy as fits into md. */
289         for (k = 0; k < sizeof md; k++)
290                 {
291                 md[k] ^= local_md[k];
292                 }
293         if (entropy < ENTROPY_NEEDED) /* stop counting when we have enough */
294             entropy += add;
295         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
296         
297 #ifndef THREADS 
298         assert(md_c[1] == md_count[1]);
299 #endif
300         }
301
302 static void ssleay_rand_seed(const void *buf, int num)
303         {
304         ssleay_rand_add(buf, num, num);
305         }
306
307 static void ssleay_rand_initialize(void)
308         {
309         unsigned long l;
310 #ifndef GETPID_IS_MEANINGLESS
311         pid_t curr_pid = getpid();
312 #endif
313 #ifdef DEVRANDOM
314         FILE *fh;
315 #endif
316
317 #ifdef NORAND
318         return;
319 #endif
320
321         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
322         /* put in some default random data, we need more than just this */
323 #ifndef GETPID_IS_MEANINGLESS
324         l=curr_pid;
325         RAND_add(&l,sizeof(l),0);
326         l=getuid();
327         RAND_add(&l,sizeof(l),0);
328 #endif
329         l=time(NULL);
330         RAND_add(&l,sizeof(l),0);
331
332 #ifdef DEVRANDOM
333         /* Use a random entropy pool device. Linux, FreeBSD and OpenBSD
334          * have this. Use /dev/urandom if you can as /dev/random may block
335          * if it runs out of random entries.  */
336
337         if ((fh = fopen(DEVRANDOM, "r")) != NULL)
338                 {
339                 unsigned char tmpbuf[ENTROPY_NEEDED];
340                 int n;
341                 
342                 setvbuf(fh, NULL, _IONBF, 0);
343                 n=fread((unsigned char *)tmpbuf,1,ENTROPY_NEEDED,fh);
344                 fclose(fh);
345                 RAND_add(tmpbuf,sizeof tmpbuf,n);
346                 memset(tmpbuf,0,n);
347                 }
348 #endif
349 #ifdef PURIFY
350         memset(state,0,STATE_SIZE);
351         memset(md,0,MD_DIGEST_LENGTH);
352 #endif
353         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
354         initialized=1;
355         }
356
357 static int ssleay_rand_bytes(unsigned char *buf, int num)
358         {
359         int i,j,k,st_num,st_idx;
360         int ok;
361         long md_c[2];
362         unsigned char local_md[MD_DIGEST_LENGTH];
363         MD_CTX m;
364 #ifndef GETPID_IS_MEANINGLESS
365         pid_t curr_pid = getpid();
366 #endif
367
368 #ifdef PREDICT
369         if (rand_predictable)
370                 {
371                 static unsigned char val=0;
372
373                 for (i=0; i<num; i++)
374                         buf[i]=val++;
375                 return(1);
376                 }
377 #endif
378
379         /*
380          * (Based on the rand(3) manpage:)
381          *
382          * For each group of 10 bytes (or less), we do the following:
383          *
384          * Input into the hash function the top 10 bytes from the
385          * local 'md' (which is initialized from the global 'md'
386          * before any bytes are generated), the bytes that are
387          * to be overwritten by the random bytes, and bytes from the
388          * 'state' (incrementing looping index).  From this digest output
389          * (which is kept in 'md'), the top (up to) 10 bytes are
390          * returned to the caller and the bottom (up to) 10 bytes are xored
391          * into the 'state'.
392          * Finally, after we have finished 'num' random bytes for the
393          * caller, 'count' (which is incremented) and the local and global 'md'
394          * are fed into the hash function and the results are kept in the
395          * global 'md'.
396          */
397
398         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
399
400         if (!initialized)
401                 ssleay_rand_initialize();
402
403         ok = (entropy >= ENTROPY_NEEDED);
404         if (!ok)
405                 {
406                 /* If the PRNG state is not yet unpredictable, then seeing
407                  * the PRNG output may help attackers to determine the new
408                  * state; thus we have to decrease the entropy estimate.
409                  * Once we've had enough initial seeding we don't bother to
410                  * adjust the entropy count, though, because we're not ambitious
411                  * to provide *information-theoretic* randomness.
412                  */
413                 entropy -= num;
414                 if (entropy < 0)
415                         entropy = 0;
416                 }
417
418         st_idx=state_index;
419         st_num=state_num;
420         md_c[0] = md_count[0];
421         md_c[1] = md_count[1];
422         memcpy(local_md, md, sizeof md);
423
424         state_index+=num;
425         if (state_index > state_num)
426                 state_index %= state_num;
427
428         /* state[st_idx], ..., state[(st_idx + num - 1) % st_num]
429          * are now ours (but other threads may use them too) */
430
431         md_count[0] += 1;
432         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
433
434         while (num > 0)
435                 {
436                 j=(num >= MD_DIGEST_LENGTH/2)?MD_DIGEST_LENGTH/2:num;
437                 num-=j;
438                 MD_Init(&m);
439 #ifndef GETPID_IS_MEANINGLESS
440                 if (curr_pid) /* just in the first iteration to save time */
441                         {
442                         MD_Update(&m,(unsigned char*)&curr_pid,sizeof curr_pid);
443                         curr_pid = 0;
444                         }
445 #endif
446                 MD_Update(&m,&(local_md[MD_DIGEST_LENGTH/2]),MD_DIGEST_LENGTH/2);
447                 MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
448 #ifndef PURIFY
449                 MD_Update(&m,buf,j); /* purify complains */
450 #endif
451                 k=(st_idx+j)-st_num;
452                 if (k > 0)
453                         {
454                         MD_Update(&m,&(state[st_idx]),j-k);
455                         MD_Update(&m,&(state[0]),k);
456                         }
457                 else
458                         MD_Update(&m,&(state[st_idx]),j);
459                 MD_Final(local_md,&m);
460
461                 for (i=0; i<j; i++)
462                         {
463                         state[st_idx++]^=local_md[i]; /* may compete with other threads */
464                         *(buf++)=local_md[i+MD_DIGEST_LENGTH/2];
465                         if (st_idx >= st_num)
466                                 st_idx=0;
467                         }
468                 }
469
470         MD_Init(&m);
471         MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
472         MD_Update(&m,local_md,MD_DIGEST_LENGTH);
473         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
474         MD_Update(&m,md,MD_DIGEST_LENGTH);
475         MD_Final(md,&m);
476         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
477
478         memset(&m,0,sizeof(m));
479         if (ok)
480                 return(1);
481         else
482                 {
483                 RANDerr(RAND_F_SSLEAY_RAND_BYTES,RAND_R_PRNG_NOT_SEEDED);
484                 return(0);
485                 }
486         }
487
488 /* pseudo-random bytes that are guaranteed to be unique but not
489    unpredictable */
490 static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num) 
491         {
492         int ret, err;
493
494         ret = RAND_bytes(buf, num);
495         if (ret == 0)
496                 {
497                 err = ERR_peek_error();
498                 if (ERR_GET_LIB(err) == ERR_LIB_RAND &&
499                     ERR_GET_REASON(err) == RAND_R_PRNG_NOT_SEEDED)
500                         (void)ERR_get_error();
501                 }
502         return (ret);
503         }
504
505 int RAND_status(void)
506         {
507         if (!initialized)
508                 ssleay_rand_initialize();
509         return (entropy >= ENTROPY_NEEDED);
510         }
511
512 #ifdef WINDOWS
513 #include <windows.h>
514 #include <openssl/rand.h>
515
516 /*****************************************************************************
517  * Initialisation function for the SSL random generator.  Takes the contents
518  * of the screen as random seed.
519  *
520  * Created 960901 by Gertjan van Oosten, gertjan@West.NL, West Consulting B.V.
521  *
522  * Code adapted from
523  * <URL:http://www.microsoft.com/kb/developr/win_dk/q97193.htm>;
524  * the original copyright message is:
525  *
526  *   (C) Copyright Microsoft Corp. 1993.  All rights reserved.
527  *
528  *   You have a royalty-free right to use, modify, reproduce and
529  *   distribute the Sample Files (and/or any modified version) in
530  *   any way you find useful, provided that you agree that
531  *   Microsoft has no warranty obligations or liability for any
532  *   Sample Application Files which are modified.
533  */
534 /*
535  * I have modified the loading of bytes via RAND_seed() mechanism since
536  * the original would have been very very CPU intensive since RAND_seed()
537  * does an MD5 per 16 bytes of input.  The cost to digest 16 bytes is the same
538  * as that to digest 56 bytes.  So under the old system, a screen of
539  * 1024*768*256 would have been CPU cost of approximately 49,000 56 byte MD5
540  * digests or digesting 2.7 mbytes.  What I have put in place would
541  * be 48 16k MD5 digests, or effectively 48*16+48 MD5 bytes or 816 kbytes
542  * or about 3.5 times as much.
543  * - eric 
544  */
545 void RAND_screen(void)
546 {
547   HDC           hScrDC;         /* screen DC */
548   HDC           hMemDC;         /* memory DC */
549   HBITMAP       hBitmap;        /* handle for our bitmap */
550   HBITMAP       hOldBitmap;     /* handle for previous bitmap */
551   BITMAP        bm;             /* bitmap properties */
552   unsigned int  size;           /* size of bitmap */
553   char          *bmbits;        /* contents of bitmap */
554   int           w;              /* screen width */
555   int           h;              /* screen height */
556   int           y;              /* y-coordinate of screen lines to grab */
557   int           n = 16;         /* number of screen lines to grab at a time */
558
559   /* Create a screen DC and a memory DC compatible to screen DC */
560   hScrDC = CreateDC("DISPLAY", NULL, NULL, NULL);
561   hMemDC = CreateCompatibleDC(hScrDC);
562
563   /* Get screen resolution */
564   w = GetDeviceCaps(hScrDC, HORZRES);
565   h = GetDeviceCaps(hScrDC, VERTRES);
566
567   /* Create a bitmap compatible with the screen DC */
568   hBitmap = CreateCompatibleBitmap(hScrDC, w, n);
569
570   /* Select new bitmap into memory DC */
571   hOldBitmap = SelectObject(hMemDC, hBitmap);
572
573   /* Get bitmap properties */
574   GetObject(hBitmap, sizeof(BITMAP), (LPSTR)&bm);
575   size = (unsigned int)bm.bmWidthBytes * bm.bmHeight * bm.bmPlanes;
576
577   bmbits = Malloc(size);
578   if (bmbits) {
579     /* Now go through the whole screen, repeatedly grabbing n lines */
580     for (y = 0; y < h-n; y += n)
581         {
582         unsigned char md[MD_DIGEST_LENGTH];
583
584         /* Bitblt screen DC to memory DC */
585         BitBlt(hMemDC, 0, 0, w, n, hScrDC, 0, y, SRCCOPY);
586
587         /* Copy bitmap bits from memory DC to bmbits */
588         GetBitmapBits(hBitmap, size, bmbits);
589
590         /* Get the MD5 of the bitmap */
591         MD(bmbits,size,md);
592
593         /* Seed the random generator with the MD5 digest */
594         RAND_seed(md, MD_DIGEST_LENGTH);
595         }
596
597     Free(bmbits);
598   }
599
600   /* Select old bitmap back into memory DC */
601   hBitmap = SelectObject(hMemDC, hOldBitmap);
602
603   /* Clean up */
604   DeleteObject(hBitmap);
605   DeleteDC(hMemDC);
606   DeleteDC(hScrDC);
607 }
608 #endif