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