be08e06658d17a256eb78b1e379f40538e2ffa0c
[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 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 /* #define NORAND       1 */
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 unsigned entropy=0;
142
143 const char *RAND_version="RAND" OPENSSL_VERSION_PTEXT;
144
145 static void ssleay_rand_cleanup(void);
146 static void ssleay_rand_seed(const void *buf, int num);
147 static void ssleay_rand_add(const void *buf, int num, int add_entropy);
148 static int ssleay_rand_bytes(unsigned char *buf, int num);
149 static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num);
150
151 RAND_METHOD rand_ssleay_meth={
152         ssleay_rand_seed,
153         ssleay_rand_bytes,
154         ssleay_rand_cleanup,
155         ssleay_rand_add,
156         ssleay_rand_pseudo_bytes,
157         }; 
158
159 RAND_METHOD *RAND_SSLeay(void)
160         {
161         return(&rand_ssleay_meth);
162         }
163
164 static void ssleay_rand_cleanup(void)
165         {
166         memset(state,0,sizeof(state));
167         state_num=0;
168         state_index=0;
169         memset(md,0,MD_DIGEST_LENGTH);
170         md_count[0]=0;
171         md_count[1]=0;
172         entropy=0;
173         }
174
175 static void ssleay_rand_add(const void *buf, int num, int add)
176         {
177         int i,j,k,st_idx;
178         long md_c[2];
179         unsigned char local_md[MD_DIGEST_LENGTH];
180         MD_CTX m;
181
182 #ifdef NORAND
183         return;
184 #endif
185
186         /*
187          * (Based on the rand(3) manpage)
188          *
189          * The input is chopped up into units of 20 bytes (or less for
190          * the last block).  Each of these blocks is run through the hash
191          * function as follows:  The data passed to the hash function
192          * is the current 'md', the same number of bytes from the 'state'
193          * (the location determined by in incremented looping index) as
194          * the current 'block', the new key data 'block', and 'count'
195          * (which is incremented after each use).
196          * The result of this is kept in 'md' and also xored into the
197          * 'state' at the same locations that were used as input into the
198          * hash function.
199          */
200
201         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
202         st_idx=state_index;
203
204         /* use our own copies of the counters so that even
205          * if a concurrent thread seeds with exactly the
206          * same data and uses the same subarray there's _some_
207          * difference */
208         md_c[0] = md_count[0];
209         md_c[1] = md_count[1];
210
211         memcpy(local_md, md, sizeof md);
212
213         /* state_index <= state_num <= STATE_SIZE */
214         state_index += num;
215         if (state_index >= STATE_SIZE)
216                 {
217                 state_index%=STATE_SIZE;
218                 state_num=STATE_SIZE;
219                 }
220         else if (state_num < STATE_SIZE)        
221                 {
222                 if (state_index > state_num)
223                         state_num=state_index;
224                 }
225         /* state_index <= state_num <= STATE_SIZE */
226
227         /* state[st_idx], ..., state[(st_idx + num - 1) % STATE_SIZE]
228          * are what we will use now, but other threads may use them
229          * as well */
230
231         md_count[1] += (num / MD_DIGEST_LENGTH) + (num % MD_DIGEST_LENGTH > 0);
232
233         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
234
235         for (i=0; i<num; i+=MD_DIGEST_LENGTH)
236                 {
237                 j=(num-i);
238                 j=(j > MD_DIGEST_LENGTH)?MD_DIGEST_LENGTH:j;
239
240                 MD_Init(&m);
241                 MD_Update(&m,local_md,MD_DIGEST_LENGTH);
242                 k=(st_idx+j)-STATE_SIZE;
243                 if (k > 0)
244                         {
245                         MD_Update(&m,&(state[st_idx]),j-k);
246                         MD_Update(&m,&(state[0]),k);
247                         }
248                 else
249                         MD_Update(&m,&(state[st_idx]),j);
250                         
251                 MD_Update(&m,buf,j);
252                 MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
253                 MD_Final(local_md,&m);
254                 md_c[1]++;
255
256                 buf=(const char *)buf + j;
257
258                 for (k=0; k<j; k++)
259                         {
260                         /* Parallel threads may interfere with this,
261                          * but always each byte of the new state is
262                          * the XOR of some previous value of its
263                          * and local_md (itermediate values may be lost).
264                          * Alway using locking could hurt performance more
265                          * than necessary given that conflicts occur only
266                          * when the total seeding is longer than the random
267                          * state. */
268                         state[st_idx++]^=local_md[k];
269                         if (st_idx >= STATE_SIZE)
270                                 st_idx=0;
271                         }
272                 }
273         memset((char *)&m,0,sizeof(m));
274
275         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
276         /* Don't just copy back local_md into md -- this could mean that
277          * other thread's seeding remains without effect (except for
278          * the incremented counter).  By XORing it we keep at least as
279          * much entropy as fits into md. */
280         for (k = 0; k < sizeof md; k++)
281                 {
282                 md[k] ^= local_md[k];
283                 }
284         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
285         
286 #ifndef THREADS 
287         assert(md_c[1] == md_count[1]);
288 #endif
289         if (entropy < ENTROPY_NEEDED)
290             entropy += add;
291         }
292
293 static void ssleay_rand_seed(const void *buf, int num)
294         {
295         ssleay_rand_add(buf, num, num);
296         }
297
298 static int ssleay_rand_bytes(unsigned char *buf, int num)
299         {
300         int i,j,k,st_num,st_idx;
301         int ok;
302         long md_c[2];
303         unsigned char local_md[MD_DIGEST_LENGTH];
304         MD_CTX m;
305         static int init=1;
306         unsigned long l;
307 #ifndef GETPID_IS_MEANINGLESS
308         pid_t curr_pid = getpid();
309 #endif
310 #ifdef DEVRANDOM
311         FILE *fh;
312 #endif
313
314 #ifdef PREDICT
315         {
316         static unsigned char val=0;
317
318         for (i=0; i<num; i++)
319                 buf[i]=val++;
320         return(1);
321         }
322 #endif
323
324         /*
325          * (Based on the rand(3) manpage:)
326          *
327          * For each group of 10 bytes (or less), we do the following:
328          *
329          * Input into the hash function the top 10 bytes from the
330          * local 'md' (which is initialized from the global 'md'
331          * before any bytes are generated), the bytes that are
332          * to be overwritten by the random bytes, and bytes from the
333          * 'state' (incrementing looping index).  From this digest output
334          * (which is kept in 'md'), the top (up to) 10 bytes are
335          * returned to the caller and the bottom (up to) 10 bytes are xored
336          * into the 'state'.
337          * Finally, after we have finished 'num' random bytes for the
338          * caller, 'count' (which is incremented) and the local and global 'md'
339          * are fed into the hash function and the results are kept in the
340          * global 'md'.
341          */
342
343         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
344
345         if (init)
346                 {
347                 CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
348                 /* put in some default random data, we need more than
349                  * just this */
350                 RAND_add(&m,sizeof(m),0);
351 #ifndef GETPID_IS_MEANINGLESS
352                 l=curr_pid;
353                 RAND_add(&l,sizeof(l),0);
354                 l=getuid();
355                 RAND_add(&l,sizeof(l),0);
356 #endif
357                 l=time(NULL);
358                 RAND_add(&l,sizeof(l),0);
359
360 #ifdef DEVRANDOM
361                 /* 
362                  * Use a random entropy pool device.
363                  * Linux 1.3.x and FreeBSD-Current has 
364                  * this. Use /dev/urandom if you can
365                  * as /dev/random will block if it runs out
366                  * of random entries.
367                  */
368                 if ((fh = fopen(DEVRANDOM, "r")) != NULL)
369                         {
370                         unsigned char tmpbuf[ENTROPY_NEEDED];
371                         int n;
372
373                         n=fread((unsigned char *)tmpbuf,1,ENTROPY_NEEDED,fh);
374                         fclose(fh);
375                         RAND_add(tmpbuf,sizeof tmpbuf,n);
376                         memset(tmpbuf,0,n);
377                         }
378 #endif
379 #ifdef PURIFY
380                 memset(state,0,STATE_SIZE);
381                 memset(md,0,MD_DIGEST_LENGTH);
382 #endif
383                 CRYPTO_w_lock(CRYPTO_LOCK_RAND);
384                 init=0;
385                 }
386
387         ok = (entropy >= ENTROPY_NEEDED);
388
389         st_idx=state_index;
390         st_num=state_num;
391         md_c[0] = md_count[0];
392         md_c[1] = md_count[1];
393         memcpy(local_md, md, sizeof md);
394
395         state_index+=num;
396         if (state_index > state_num)
397                 state_index %= state_num;
398
399         /* state[st_idx], ..., state[(st_idx + num - 1) % st_num]
400          * are now ours (but other threads may use them too) */
401
402         md_count[0] += 1;
403         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
404
405         while (num > 0)
406                 {
407                 j=(num >= MD_DIGEST_LENGTH/2)?MD_DIGEST_LENGTH/2:num;
408                 num-=j;
409                 MD_Init(&m);
410 #ifndef GETPID_IS_MEANINGLESS
411                 if (curr_pid) /* just in the first iteration to save time */
412                         {
413                         MD_Update(&m,(unsigned char*)&curr_pid,sizeof curr_pid);
414                         curr_pid = 0;
415                         }
416 #endif
417                 MD_Update(&m,&(local_md[MD_DIGEST_LENGTH/2]),MD_DIGEST_LENGTH/2);
418                 MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
419 #ifndef PURIFY
420                 MD_Update(&m,buf,j); /* purify complains */
421 #endif
422                 k=(st_idx+j)-st_num;
423                 if (k > 0)
424                         {
425                         MD_Update(&m,&(state[st_idx]),j-k);
426                         MD_Update(&m,&(state[0]),k);
427                         }
428                 else
429                         MD_Update(&m,&(state[st_idx]),j);
430                 MD_Final(local_md,&m);
431
432                 for (i=0; i<j; i++)
433                         {
434                         state[st_idx++]^=local_md[i]; /* may compete with other threads */
435                         *(buf++)=local_md[i+MD_DIGEST_LENGTH/2];
436                         if (st_idx >= st_num)
437                                 st_idx=0;
438                         }
439                 }
440
441         MD_Init(&m);
442         MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
443         MD_Update(&m,local_md,MD_DIGEST_LENGTH);
444         CRYPTO_w_lock(CRYPTO_LOCK_RAND);
445         MD_Update(&m,md,MD_DIGEST_LENGTH);
446         MD_Final(md,&m);
447         CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
448
449         memset(&m,0,sizeof(m));
450         if (ok)
451                 return(1);
452         else
453                 {
454                 RANDerr(RAND_F_SSLEAY_RAND_BYTES,RAND_R_PRNG_NOT_SEEDED);
455                 return(0);
456                 }
457         }
458
459 /* pseudo-random bytes that are guaranteed to be unique but not
460    unpredictable */
461 static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num) 
462         {
463         int ret, err;
464
465         ret = RAND_bytes(buf, num);
466         if (ret == 0)
467                 {
468                 err = ERR_peek_error();
469                 if (ERR_GET_LIB(err) == ERR_LIB_RAND &&
470                     ERR_GET_REASON(err) == RAND_R_PRNG_NOT_SEEDED)
471                         (void)ERR_get_error();
472                 }
473         return (ret);
474         }
475
476 #ifdef WINDOWS
477 #include <windows.h>
478 #include <openssl/rand.h>
479
480 /*****************************************************************************
481  * Initialisation function for the SSL random generator.  Takes the contents
482  * of the screen as random seed.
483  *
484  * Created 960901 by Gertjan van Oosten, gertjan@West.NL, West Consulting B.V.
485  *
486  * Code adapted from
487  * <URL:http://www.microsoft.com/kb/developr/win_dk/q97193.htm>;
488  * the original copyright message is:
489  *
490  *   (C) Copyright Microsoft Corp. 1993.  All rights reserved.
491  *
492  *   You have a royalty-free right to use, modify, reproduce and
493  *   distribute the Sample Files (and/or any modified version) in
494  *   any way you find useful, provided that you agree that
495  *   Microsoft has no warranty obligations or liability for any
496  *   Sample Application Files which are modified.
497  */
498 /*
499  * I have modified the loading of bytes via RAND_seed() mechanism since
500  * the original would have been very very CPU intensive since RAND_seed()
501  * does an MD5 per 16 bytes of input.  The cost to digest 16 bytes is the same
502  * as that to digest 56 bytes.  So under the old system, a screen of
503  * 1024*768*256 would have been CPU cost of approximately 49,000 56 byte MD5
504  * digests or digesting 2.7 mbytes.  What I have put in place would
505  * be 48 16k MD5 digests, or effectively 48*16+48 MD5 bytes or 816 kbytes
506  * or about 3.5 times as much.
507  * - eric 
508  */
509 void RAND_screen(void)
510 {
511   HDC           hScrDC;         /* screen DC */
512   HDC           hMemDC;         /* memory DC */
513   HBITMAP       hBitmap;        /* handle for our bitmap */
514   HBITMAP       hOldBitmap;     /* handle for previous bitmap */
515   BITMAP        bm;             /* bitmap properties */
516   unsigned int  size;           /* size of bitmap */
517   char          *bmbits;        /* contents of bitmap */
518   int           w;              /* screen width */
519   int           h;              /* screen height */
520   int           y;              /* y-coordinate of screen lines to grab */
521   int           n = 16;         /* number of screen lines to grab at a time */
522
523   /* Create a screen DC and a memory DC compatible to screen DC */
524   hScrDC = CreateDC("DISPLAY", NULL, NULL, NULL);
525   hMemDC = CreateCompatibleDC(hScrDC);
526
527   /* Get screen resolution */
528   w = GetDeviceCaps(hScrDC, HORZRES);
529   h = GetDeviceCaps(hScrDC, VERTRES);
530
531   /* Create a bitmap compatible with the screen DC */
532   hBitmap = CreateCompatibleBitmap(hScrDC, w, n);
533
534   /* Select new bitmap into memory DC */
535   hOldBitmap = SelectObject(hMemDC, hBitmap);
536
537   /* Get bitmap properties */
538   GetObject(hBitmap, sizeof(BITMAP), (LPSTR)&bm);
539   size = (unsigned int)bm.bmWidthBytes * bm.bmHeight * bm.bmPlanes;
540
541   bmbits = Malloc(size);
542   if (bmbits) {
543     /* Now go through the whole screen, repeatedly grabbing n lines */
544     for (y = 0; y < h-n; y += n)
545         {
546         unsigned char md[MD_DIGEST_LENGTH];
547
548         /* Bitblt screen DC to memory DC */
549         BitBlt(hMemDC, 0, 0, w, n, hScrDC, 0, y, SRCCOPY);
550
551         /* Copy bitmap bits from memory DC to bmbits */
552         GetBitmapBits(hBitmap, size, bmbits);
553
554         /* Get the MD5 of the bitmap */
555         MD(bmbits,size,md);
556
557         /* Seed the random generator with the MD5 digest */
558         RAND_seed(md, MD_DIGEST_LENGTH);
559         }
560
561     Free(bmbits);
562   }
563
564   /* Select old bitmap back into memory DC */
565   hBitmap = SelectObject(hMemDC, hOldBitmap);
566
567   /* Clean up */
568   DeleteObject(hBitmap);
569   DeleteDC(hMemDC);
570   DeleteDC(hScrDC);
571 }
572 #endif