Point to Peter Gutmann's revised paper.
[openssl.git] / crypto / rand / rand_win.c
1 /* crypto/rand/rand_win.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 #include "cryptlib.h"
113 #include <openssl/rand.h>
114 #include "rand_lcl.h"
115
116 #if defined(WINDOWS) || defined(WIN32)
117 #include <windows.h>
118 #ifndef _WIN32_WINNT
119 # define _WIN32_WINNT 0x0400
120 #endif
121 #include <wincrypt.h>
122 #include <tlhelp32.h>
123
124 /* Intel hardware RNG CSP -- available from
125  * http://developer.intel.com/design/security/rng/redist_license.htm
126  */
127 #define PROV_INTEL_SEC 22
128 #define INTEL_DEF_PROV "Intel Hardware Cryptographic Service Provider"
129
130 static void readtimer(void);
131 static void readscreen(void);
132
133 /* It appears like PCURSORINFO is only defined when WINVER is 0x0500 and up,
134    which currently only happens on Win2000.  Unfortunately, that is a typedef,
135    so it's a little bit difficult to detect properly.  On the other hand, the
136    macro CURSOR_SHOWING is defined within the same conditional, so it can be
137    use to detect the absence of PCURSORINFO. */
138 #ifndef CURSOR_SHOWING
139 typedef void *PCURSORINFO;
140 #endif
141
142 typedef BOOL (WINAPI *CRYPTACQUIRECONTEXT)(HCRYPTPROV *, LPCTSTR, LPCTSTR,
143                                     DWORD, DWORD);
144 typedef BOOL (WINAPI *CRYPTGENRANDOM)(HCRYPTPROV, DWORD, BYTE *);
145 typedef BOOL (WINAPI *CRYPTRELEASECONTEXT)(HCRYPTPROV, DWORD);
146
147 typedef HWND (WINAPI *GETFOREGROUNDWINDOW)(VOID);
148 typedef BOOL (WINAPI *GETCURSORINFO)(PCURSORINFO);
149 typedef DWORD (WINAPI *GETQUEUESTATUS)(UINT);
150
151 typedef HANDLE (WINAPI *CREATETOOLHELP32SNAPSHOT)(DWORD, DWORD);
152 typedef BOOL (WINAPI *HEAP32FIRST)(LPHEAPENTRY32, DWORD, DWORD);
153 typedef BOOL (WINAPI *HEAP32NEXT)(LPHEAPENTRY32);
154 typedef BOOL (WINAPI *HEAP32LIST)(HANDLE, LPHEAPLIST32);
155 typedef BOOL (WINAPI *PROCESS32)(HANDLE, LPPROCESSENTRY32);
156 typedef BOOL (WINAPI *THREAD32)(HANDLE, LPTHREADENTRY32);
157 typedef BOOL (WINAPI *MODULE32)(HANDLE, LPMODULEENTRY32);
158
159 int RAND_poll(void)
160 {
161         MEMORYSTATUS m;
162         HCRYPTPROV hProvider = 0;
163         BYTE buf[64];
164         DWORD w;
165         HWND h;
166
167         HMODULE advapi, kernel, user;
168         CRYPTACQUIRECONTEXT acquire;
169         CRYPTGENRANDOM gen;
170         CRYPTRELEASECONTEXT release;
171
172         /* load functions dynamically - not available on all systems */
173         advapi = GetModuleHandle("ADVAPI32.DLL");
174         kernel = GetModuleHandle("KERNEL32.DLL");
175         user = GetModuleHandle("USER32.DLL");
176
177         if (advapi)
178                 {
179                 acquire = (CRYPTACQUIRECONTEXT) GetProcAddress(advapi,
180                         "CryptAcquireContextA");
181                 gen = (CRYPTGENRANDOM) GetProcAddress(advapi,
182                         "CryptGenRandom");
183                 release = (CRYPTRELEASECONTEXT) GetProcAddress(advapi,
184                         "CryptReleaseContext");
185                 }
186
187         if (acquire && gen && release)
188                 {
189                 /* poll the CryptoAPI PRNG */
190                 if (acquire(&hProvider, 0, 0, PROV_RSA_FULL,
191                         CRYPT_VERIFYCONTEXT))
192                         {
193                         if (gen(hProvider, sizeof(buf), buf) != 0)
194                                 {
195                                 RAND_add(buf, sizeof(buf), 0);
196 #ifdef DEBUG
197                                 printf("randomness from PROV_RSA_FULL\n");
198 #endif
199                                 }
200                         release(hProvider, 0); 
201                         }
202                 
203                 /* poll the Pentium PRG with CryptoAPI */
204                 if (acquire(&hProvider, 0, INTEL_DEF_PROV, PROV_INTEL_SEC, 0))
205                         {
206                         if (gen(hProvider, sizeof(buf), buf) != 0)
207                                 {
208                                 RAND_add(buf, sizeof(buf), 0);
209 #ifdef DEBUG
210                                 printf("randomness from PROV_INTEL_SEC\n");
211 #endif
212                                 }
213                         release(hProvider, 0);
214                         }
215                 }
216
217         /* timer data */
218         readtimer();
219         
220         /* memory usage statistics */
221         GlobalMemoryStatus(&m);
222         RAND_add(&m, sizeof(m), 1);
223
224         /* process ID */
225         w = GetCurrentProcessId();
226         RAND_add(&w, sizeof(w), 0);
227
228         if (user)
229                 {
230                 GETCURSORINFO cursor;
231                 GETFOREGROUNDWINDOW win;
232                 GETQUEUESTATUS queue;
233
234                 win = (GETFOREGROUNDWINDOW) GetProcAddress(user, "GetForegroundWindow");
235                 cursor = (GETCURSORINFO) GetProcAddress(user, "GetCursorInfo");
236                 queue = (GETQUEUESTATUS) GetProcAddress(user, "GetQueueStatus");
237
238                 if (win)
239                 {
240                         /* window handle */
241                         h = win();
242                         RAND_add(&h, sizeof(h), 0);
243                 }
244
245                 if (cursor)
246                         {
247                         /* cursor position */
248                         cursor((PCURSORINFO)buf);
249                         RAND_add(buf, sizeof(buf), 0);
250                         }
251
252                 if (queue)
253                         {
254                         /* message queue status */
255                         w = queue(QS_ALLEVENTS);
256                         RAND_add(&w, sizeof(w), 0);
257                         }
258                 }
259
260         /* Toolhelp32 snapshot: enumerate processes, threads, modules and heap
261          * http://msdn.microsoft.com/library/psdk/winbase/toolhelp_5pfd.htm
262          * (Win 9x only, not available on NT)
263          *
264          * This seeding method was proposed in Peter Gutmann, Software
265          * Generation of Practically Strong Random Numbers,
266          * http://www.usenix.org/publications/library/proceedings/sec98/gutmann.html
267      * revised version at http://www.cryptoengines.com/~peter/06_random.pdf
268          * (The assignment of entropy estimates below is arbitrary, but based
269          * on Peter's analysis the full poll appears to be safe. Additional
270          * interactive seeding is encouraged.)
271          */
272
273         if (kernel)
274                 {
275                 CREATETOOLHELP32SNAPSHOT snap;
276                 HANDLE handle;
277
278                 HEAP32FIRST heap_first;
279                 HEAP32NEXT heap_next;
280                 HEAP32LIST heaplist_first, heaplist_next;
281                 PROCESS32 process_first, process_next;
282                 THREAD32 thread_first, thread_next;
283                 MODULE32 module_first, module_next;
284
285                 HEAPLIST32 hlist;
286                 HEAPENTRY32 hentry;
287                 PROCESSENTRY32 p;
288                 THREADENTRY32 t;
289                 MODULEENTRY32 m;
290
291                 snap = (CREATETOOLHELP32SNAPSHOT)
292                   GetProcAddress(kernel, "CreateToolhelp32Snapshot");
293                 heap_first = (HEAP32FIRST) GetProcAddress(kernel, "Heap32First");
294                 heap_next = (HEAP32NEXT) GetProcAddress(kernel, "Heap32Next");
295                 heaplist_first = (HEAP32LIST) GetProcAddress(kernel, "Heap32ListFirst");
296                 heaplist_next = (HEAP32LIST) GetProcAddress(kernel, "Heap32ListNext");
297                 process_first = (PROCESS32) GetProcAddress(kernel, "Process32First");
298                 process_next = (PROCESS32) GetProcAddress(kernel, "Process32Next");
299                 thread_first = (THREAD32) GetProcAddress(kernel, "Thread32First");
300                 thread_next = (THREAD32) GetProcAddress(kernel, "Thread32Next");
301                 module_first = (MODULE32) GetProcAddress(kernel, "Module32First");
302                 module_next = (MODULE32) GetProcAddress(kernel, "Module32Next");
303
304                 if (snap && heap_first && heap_next && heaplist_first &&
305                         heaplist_next && process_first && process_next &&
306                         thread_first && thread_next && module_first &&
307                         module_next && (handle = snap(TH32CS_SNAPALL,0))
308                         != NULL)
309                         {
310                         /* heap list and heap walking */
311                         hlist.dwSize = sizeof(HEAPLIST32);              
312                         if (heaplist_first(handle, &hlist))
313                                 do
314                                         {
315                                         RAND_add(&hlist, hlist.dwSize, 0);
316                                         hentry.dwSize = sizeof(HEAPENTRY32);
317                                         if (heap_first(&hentry,
318                                                 hlist.th32ProcessID,
319                                                 hlist.th32HeapID))
320                                                 {
321                                                 int entrycnt = 50;
322                                                 do
323                                                         RAND_add(&hentry,
324                                                                 hentry.dwSize, 0);
325                                                 while (heap_next(&hentry)
326                                                         && --entrycnt > 0);
327                                                 }
328                                         } while (heaplist_next(handle,
329                                                 &hlist));
330
331                         /* process walking */
332                         p.dwSize = sizeof(PROCESSENTRY32);
333                         if (process_first(handle, &p))
334                                 do
335                                         RAND_add(&p, p.dwSize, 0);
336                                 while (process_next(handle, &p));
337                         
338                         /* thread walking */
339                         t.dwSize = sizeof(THREADENTRY32);
340                         if (thread_first(handle, &t))
341                                 do
342                                         RAND_add(&t, t.dwSize, 0);
343                                 while (thread_next(handle, &t));
344                         
345                         /* module walking */
346                         m.dwSize = sizeof(MODULEENTRY32);
347                         if (module_first(handle, &m))
348                                 do
349                                         RAND_add(&m, m.dwSize, 1);
350                                 while (module_next(handle, &m));
351                         
352                         CloseHandle(handle);
353                         }
354                 }
355
356 #ifdef DEBUG
357         printf("Exiting RAND_poll\n");
358 #endif
359
360         return(1);
361 }
362
363 int RAND_event(UINT iMsg, WPARAM wParam, LPARAM lParam)
364         {
365         double add_entropy=0;
366
367         switch (iMsg)
368                 {
369         case WM_KEYDOWN:
370                         {
371                         static WPARAM key;
372                         if (key != wParam)
373                                 add_entropy = 0.05;
374                         key = wParam;
375                         }
376                         break;
377         case WM_MOUSEMOVE:
378                         {
379                         static int lastx,lasty,lastdx,lastdy;
380                         int x,y,dx,dy;
381
382                         x=LOWORD(lParam);
383                         y=HIWORD(lParam);
384                         dx=lastx-x;
385                         dy=lasty-y;
386                         if (dx != 0 && dy != 0 && dx-lastdx != 0 && dy-lastdy != 0)
387                                 add_entropy=.2;
388                         lastx=x, lasty=y;
389                         lastdx=dx, lastdy=dy;
390                         }
391                 break;
392                 }
393
394         readtimer();
395         RAND_add(&iMsg, sizeof(iMsg), add_entropy);
396         RAND_add(&wParam, sizeof(wParam), 0);
397         RAND_add(&lParam, sizeof(lParam), 0);
398  
399         return (RAND_status());
400         }
401
402
403 void RAND_screen(void) /* function available for backward compatibility */
404 {
405         RAND_poll();
406         readscreen();
407 }
408
409
410 /* feed timing information to the PRNG */
411 static void readtimer(void)
412 {
413         DWORD w, cyclecount;
414         LARGE_INTEGER l;
415         static int have_perfc = 1;
416 #ifndef __GNUC__
417         static int have_tsc = 1;
418
419         if (have_tsc) {
420           __try {
421             __asm {
422               rdtsc
423               mov cyclecount, eax
424               }
425             RAND_add(&cyclecount, sizeof(cyclecount), 1);
426           } __except(EXCEPTION_EXECUTE_HANDLER) {
427             have_tsc = 0;
428           }
429         }
430 #else
431 # define have_tsc 0
432 #endif
433
434         if (have_perfc) {
435           if (QueryPerformanceCounter(&l) == 0)
436             have_perfc = 0;
437           else
438             RAND_add(&l, sizeof(l), 0);
439         }
440
441         if (!have_tsc && !have_perfc) {
442           w = GetTickCount();
443           RAND_add(&w, sizeof(w), 0);
444         }
445 }
446
447 /* feed screen contents to PRNG */
448 /*****************************************************************************
449  *
450  * Created 960901 by Gertjan van Oosten, gertjan@West.NL, West Consulting B.V.
451  *
452  * Code adapted from
453  * <URL:http://www.microsoft.com/kb/developr/win_dk/q97193.htm>;
454  * the original copyright message is:
455  *
456  *   (C) Copyright Microsoft Corp. 1993.  All rights reserved.
457  *
458  *   You have a royalty-free right to use, modify, reproduce and
459  *   distribute the Sample Files (and/or any modified version) in
460  *   any way you find useful, provided that you agree that
461  *   Microsoft has no warranty obligations or liability for any
462  *   Sample Application Files which are modified.
463  */
464
465 static void readscreen(void)
466 {
467   HDC           hScrDC;         /* screen DC */
468   HDC           hMemDC;         /* memory DC */
469   HBITMAP       hBitmap;        /* handle for our bitmap */
470   HBITMAP       hOldBitmap;     /* handle for previous bitmap */
471   BITMAP        bm;             /* bitmap properties */
472   unsigned int  size;           /* size of bitmap */
473   char          *bmbits;        /* contents of bitmap */
474   int           w;              /* screen width */
475   int           h;              /* screen height */
476   int           y;              /* y-coordinate of screen lines to grab */
477   int           n = 16;         /* number of screen lines to grab at a time */
478
479   /* Create a screen DC and a memory DC compatible to screen DC */
480   hScrDC = CreateDC("DISPLAY", NULL, NULL, NULL);
481   hMemDC = CreateCompatibleDC(hScrDC);
482
483   /* Get screen resolution */
484   w = GetDeviceCaps(hScrDC, HORZRES);
485   h = GetDeviceCaps(hScrDC, VERTRES);
486
487   /* Create a bitmap compatible with the screen DC */
488   hBitmap = CreateCompatibleBitmap(hScrDC, w, n);
489
490   /* Select new bitmap into memory DC */
491   hOldBitmap = SelectObject(hMemDC, hBitmap);
492
493   /* Get bitmap properties */
494   GetObject(hBitmap, sizeof(BITMAP), (LPSTR)&bm);
495   size = (unsigned int)bm.bmWidthBytes * bm.bmHeight * bm.bmPlanes;
496
497   bmbits = OPENSSL_malloc(size);
498   if (bmbits) {
499     /* Now go through the whole screen, repeatedly grabbing n lines */
500     for (y = 0; y < h-n; y += n)
501         {
502         unsigned char md[MD_DIGEST_LENGTH];
503
504         /* Bitblt screen DC to memory DC */
505         BitBlt(hMemDC, 0, 0, w, n, hScrDC, 0, y, SRCCOPY);
506
507         /* Copy bitmap bits from memory DC to bmbits */
508         GetBitmapBits(hBitmap, size, bmbits);
509
510         /* Get the hash of the bitmap */
511         MD(bmbits,size,md);
512
513         /* Seed the random generator with the hash value */
514         RAND_add(md, MD_DIGEST_LENGTH, 0);
515         }
516
517     OPENSSL_free(bmbits);
518   }
519
520   /* Select old bitmap back into memory DC */
521   hBitmap = SelectObject(hMemDC, hOldBitmap);
522
523   /* Clean up */
524   DeleteObject(hBitmap);
525   DeleteDC(hMemDC);
526   DeleteDC(hScrDC);
527 }
528
529 #else /* Unix version */
530
531 #include <time.h>
532
533 int RAND_poll(void)
534 {
535         unsigned long l;
536         pid_t curr_pid = getpid();
537 #ifdef DEVRANDOM
538         FILE *fh;
539 #endif
540
541 #ifdef DEVRANDOM
542         /* Use a random entropy pool device. Linux, FreeBSD and OpenBSD
543          * have this. Use /dev/urandom if you can as /dev/random may block
544          * if it runs out of random entries.  */
545
546         if ((fh = fopen(DEVRANDOM, "r")) != NULL)
547                 {
548                 unsigned char tmpbuf[ENTROPY_NEEDED];
549                 int n;
550                 
551                 setvbuf(fh, NULL, _IONBF, 0);
552                 n=fread((unsigned char *)tmpbuf,1,ENTROPY_NEEDED,fh);
553                 fclose(fh);
554                 RAND_add(tmpbuf,sizeof tmpbuf,n);
555                 memset(tmpbuf,0,n);
556                 }
557 #endif
558
559         /* put in some default random data, we need more than just this */
560         l=curr_pid;
561         RAND_add(&l,sizeof(l),0);
562         l=getuid();
563         RAND_add(&l,sizeof(l),0);
564
565         l=time(NULL);
566         RAND_add(&l,sizeof(l),0);
567
568 #ifdef DEVRANDOM
569         return 1;
570 #endif
571         return 0;
572 }
573
574 #endif