Randomness polling function for Win9x.
[openssl.git] / crypto / rand / rand_win.c
1 #define DEBUG
2 /* crypto/rand/rand_win.c */
3 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4  * All rights reserved.
5  *
6  * This package is an SSL implementation written
7  * by Eric Young (eay@cryptsoft.com).
8  * The implementation was written so as to conform with Netscapes SSL.
9  * 
10  * This library is free for commercial and non-commercial use as long as
11  * the following conditions are aheared to.  The following conditions
12  * apply to all code found in this distribution, be it the RC4, RSA,
13  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
14  * included with this distribution is covered by the same copyright terms
15  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16  * 
17  * Copyright remains Eric Young's, and as such any Copyright notices in
18  * the code are not to be removed.
19  * If this package is used in a product, Eric Young should be given attribution
20  * as the author of the parts of the library used.
21  * This can be in the form of a textual message at program startup or
22  * in documentation (online or textual) provided with the package.
23  * 
24  * Redistribution and use in source and binary forms, with or without
25  * modification, are permitted provided that the following conditions
26  * are met:
27  * 1. Redistributions of source code must retain the copyright
28  *    notice, this list of conditions and the following disclaimer.
29  * 2. Redistributions in binary form must reproduce the above copyright
30  *    notice, this list of conditions and the following disclaimer in the
31  *    documentation and/or other materials provided with the distribution.
32  * 3. All advertising materials mentioning features or use of this software
33  *    must display the following acknowledgement:
34  *    "This product includes cryptographic software written by
35  *     Eric Young (eay@cryptsoft.com)"
36  *    The word 'cryptographic' can be left out if the rouines from the library
37  *    being used are not cryptographic related :-).
38  * 4. If you include any Windows specific code (or a derivative thereof) from 
39  *    the apps directory (application code) you must include an acknowledgement:
40  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41  * 
42  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52  * SUCH DAMAGE.
53  * 
54  * The licence and distribution terms for any publically available version or
55  * derivative of this code cannot be changed.  i.e. this code cannot simply be
56  * copied and put under another distribution licence
57  * [including the GNU Public Licence.]
58  */
59 /* ====================================================================
60  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
61  *
62  * Redistribution and use in source and binary forms, with or without
63  * modification, are permitted provided that the following conditions
64  * are met:
65  *
66  * 1. Redistributions of source code must retain the above copyright
67  *    notice, this list of conditions and the following disclaimer. 
68  *
69  * 2. Redistributions in binary form must reproduce the above copyright
70  *    notice, this list of conditions and the following disclaimer in
71  *    the documentation and/or other materials provided with the
72  *    distribution.
73  *
74  * 3. All advertising materials mentioning features or use of this
75  *    software must display the following acknowledgment:
76  *    "This product includes software developed by the OpenSSL Project
77  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
78  *
79  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
80  *    endorse or promote products derived from this software without
81  *    prior written permission. For written permission, please contact
82  *    openssl-core@openssl.org.
83  *
84  * 5. Products derived from this software may not be called "OpenSSL"
85  *    nor may "OpenSSL" appear in their names without prior written
86  *    permission of the OpenSSL Project.
87  *
88  * 6. Redistributions of any form whatsoever must retain the following
89  *    acknowledgment:
90  *    "This product includes software developed by the OpenSSL Project
91  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
92  *
93  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
94  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
95  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
96  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
97  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
98  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
99  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
100  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
101  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
102  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
103  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
104  * OF THE POSSIBILITY OF SUCH DAMAGE.
105  * ====================================================================
106  *
107  * This product includes cryptographic software written by Eric Young
108  * (eay@cryptsoft.com).  This product includes software written by Tim
109  * Hudson (tjh@cryptsoft.com).
110  *
111  */
112
113 #include "cryptlib.h"
114 #include <openssl/rand.h>
115 #include "rand_lcl.h"
116
117 #if defined(WINDOWS) || defined(WIN32)
118 #include <windows.h>
119 #ifndef _WIN32_WINNT
120 # define _WIN32_WINNT 0x0400
121 #endif
122 #include <wincrypt.h>
123 #include <tlhelp32.h>
124
125 /* Intel hardware RNG CSP -- available from
126  * http://developer.intel.com/design/security/rng/redist_license.htm
127  */
128 #define PROV_INTEL_SEC 22
129 #define INTEL_DEF_PROV "Intel Hardware Cryptographic Service Provider"
130
131 static void readtimer(void);
132 static void readscreen(void);
133
134 typedef BOOL (WINAPI *CRYPTACQUIRECONTEXT)(HCRYPTPROV *, LPCTSTR, LPCTSTR,
135                                     DWORD, DWORD);
136 typedef BOOL (WINAPI *CRYPTGENRANDOM)(HCRYPTPROV, DWORD, BYTE *);
137 typedef BOOL (WINAPI *CRYPTRELEASECONTEXT)(HCRYPTPROV, DWORD);
138
139 typedef HWND (WINAPI *GETFOREGROUNDWINDOW)(VOID);
140 typedef BOOL (WINAPI *GETCURSORINFO)(PCURSORINFO);
141 typedef DWORD (WINAPI *GETQUEUESTATUS)(UINT);
142
143 typedef HANDLE (WINAPI *CREATETOOLHELP32SNAPSHOT)(DWORD, DWORD);
144 typedef BOOL (WINAPI *HEAP32FIRST)(LPHEAPENTRY32, DWORD, DWORD);
145 typedef BOOL (WINAPI *HEAP32NEXT)(LPHEAPENTRY32);
146 typedef BOOL (WINAPI *HEAP32LIST)(HANDLE, LPHEAPLIST32);
147 typedef BOOL (WINAPI *PROCESS32)(HANDLE, LPPROCESSENTRY32);
148 typedef BOOL (WINAPI *THREAD32)(HANDLE, LPTHREADENTRY32);
149 typedef BOOL (WINAPI *MODULE32)(HANDLE, LPMODULEENTRY32);
150
151 int RAND_poll(void)
152 {
153         MEMORYSTATUS m;
154         HCRYPTPROV hProvider = 0;
155         BYTE buf[64];
156         DWORD w;
157         HWND h;
158
159         HMODULE advapi, kernel, user;
160         CRYPTACQUIRECONTEXT acquire;
161         CRYPTGENRANDOM gen;
162         CRYPTRELEASECONTEXT release;
163
164         /* load functions dynamically - not available on all systems */
165         advapi = GetModuleHandle("ADVAPI32.DLL");
166         kernel = GetModuleHandle("KERNEL32.DLL");
167         user = GetModuleHandle("USER32.DLL");
168
169         if (advapi)
170                 {
171                 acquire = (CRYPTACQUIRECONTEXT) GetProcAddress(advapi,
172                         "CryptAcquireContextA");
173                 gen = (CRYPTGENRANDOM) GetProcAddress(advapi,
174                         "CryptGenRandom");
175                 release = (CRYPTRELEASECONTEXT) GetProcAddress(advapi,
176                         "CryptReleaseContext");
177                 }
178
179         if (acquire && gen && release)
180                 {
181                 /* poll the CryptoAPI PRNG */
182                 if (acquire(&hProvider, 0, 0, PROV_RSA_FULL,
183                         CRYPT_VERIFYCONTEXT))
184                         {
185                         if (gen(hProvider, sizeof(buf), buf) != 0)
186                                 {
187                                 RAND_add(buf, sizeof(buf), 0);
188 #ifdef DEBUG
189                                 printf("randomness from PROV_RSA_FULL\n");
190 #endif
191                                 }
192                         release(hProvider, 0); 
193                         }
194                 
195                 /* poll the Pentium PRG with CryptoAPI */
196                 if (acquire(&hProvider, 0, INTEL_DEF_PROV, PROV_INTEL_SEC, 0))
197                         {
198                         if (gen(hProvider, sizeof(buf), buf) != 0)
199                                 {
200                                 RAND_add(buf, sizeof(buf), 0);
201 #ifdef DEBUG
202                                 printf("randomness from PROV_INTEL_SEC\n");
203 #endif
204                                 }
205                         release(hProvider, 0);
206                         }
207                 }
208
209         /* timer data */
210         readtimer();
211         
212         /* memory usage statistics */
213         GlobalMemoryStatus(&m);
214         RAND_add(&m, sizeof(m), 1);
215
216         /* process ID */
217         w = GetCurrentProcessId();
218         RAND_add(&w, sizeof(w), 0);
219
220         if (user)
221                 {
222                 GETCURSORINFO cursor;
223                 GETFOREGROUNDWINDOW win;
224                 GETQUEUESTATUS queue;
225
226                 win = (GETFOREGROUNDWINDOW) GetProcAddress(user, "GetForegroundWindow");
227                 cursor = (GETCURSORINFO) GetProcAddress(user, "GetCursorInfo");
228                 queue = (GETQUEUESTATUS) GetProcAddress(user, "GetQueueStatus");
229
230                 if (win)
231                 {
232                         /* window handle */
233                         h = win();
234                         RAND_add(&h, sizeof(h), 0);
235                 }
236
237                 if (cursor)
238                         {
239                         /* cursor position */
240                         cursor(buf);
241                         RAND_add(buf, sizeof(buf), 0);
242                         }
243
244                 if (queue)
245                         {
246                         /* message queue status */
247                         w = queue(QS_ALLEVENTS);
248                         RAND_add(&w, sizeof(w), 0);
249                         }
250                 }
251
252         /* Toolhelp32 snapshot: enumerate processes, threads, modules and heap
253          * http://msdn.microsoft.com/library/psdk/winbase/toolhelp_5pfd.htm
254          * (Win 9x only, not available on NT)
255          *
256          * This seeding method was proposed in Peter Gutmann, Software
257          * Generation of Practically Strong Random Numbers,
258          * http://www.somewhere.nzhttp://www.cs.auckland.ac.nz/~pgut001/pubs/random2.pdf
259          * (The assignment of entropy estimates below is arbitrary, but based
260          * on Peter's analysis the full poll appears to be safe. Additional
261          * interactive seeding is encouraged.)
262          */
263
264         if (kernel)
265                 {
266                 CREATETOOLHELP32SNAPSHOT snap;
267                 HANDLE handle;
268
269                 HEAP32FIRST heap_first;
270                 HEAP32NEXT heap_next;
271                 HEAP32LIST heaplist_first, heaplist_next;
272                 PROCESS32 process_first, process_next;
273                 THREAD32 thread_first, thread_next;
274                 MODULE32 module_first, module_next;
275
276                 HEAPLIST32 hlist;
277                 HEAPENTRY32 hentry;
278                 PROCESSENTRY32 p;
279                 THREADENTRY32 t;
280                 MODULEENTRY32 m;
281
282                 snap = (CREATETOOLHELP32SNAPSHOT)
283                   GetProcAddress(kernel, "CreateToolhelp32Snapshot");
284                 heap_first = (HEAP32FIRST) GetProcAddress(kernel, "Heap32First");
285                 heap_next = (HEAP32NEXT) GetProcAddress(kernel, "Heap32Next");
286                 heaplist_first = (HEAP32LIST) GetProcAddress(kernel, "Heap32ListFirst");
287                 heaplist_next = (HEAP32LIST) GetProcAddress(kernel, "Heap32ListNext");
288                 process_first = (PROCESS32) GetProcAddress(kernel, "Process32First");
289                 process_next = (PROCESS32) GetProcAddress(kernel, "Process32Next");
290                 thread_first = (THREAD32) GetProcAddress(kernel, "Thread32First");
291                 thread_next = (THREAD32) GetProcAddress(kernel, "Thread32Next");
292                 module_first = (MODULE32) GetProcAddress(kernel, "Module32First");
293                 module_next = (MODULE32) GetProcAddress(kernel, "Module32Next");
294
295                 if (snap && heap_first && heap_next && heaplist_first &&
296                         heaplist_next && process_first && process_next &&
297                         thread_first && thread_next && module_first &&
298                         module_next && (handle = snap(TH32CS_SNAPALL,0))
299                         != NULL)
300                         {
301                         /* heap list and heap walking */
302                         hlist.dwSize = sizeof(HEAPLIST32);              
303                         if (heaplist_first(handle, &hlist))
304                                 do
305                                         {
306                                         RAND_add(&hlist, hlist.dwSize, 0);
307                                         hentry.dwSize = sizeof(HEAPENTRY32);
308                                         if (heap_first(&hentry,
309                                                 hlist.th32ProcessID,
310                                                 hlist.th32HeapID))
311                                                 do
312                                                         RAND_add(&hentry,
313                                                                 hentry.dwSize, 0);
314                                                 while (heap_next(&hentry));
315                                         } while (heaplist_next(handle,
316                                                 &hlist));
317
318                         /* process walking */
319                         p.dwSize = sizeof(PROCESSENTRY32);
320                         if (process_first(handle, &p))
321                                 do
322                                         RAND_add(&p, p.dwSize, 0);
323                                 while (process_next(handle, &p));
324                         
325                         /* thread walking */
326                         t.dwSize = sizeof(THREADENTRY32);
327                         if (thread_first(handle, &t))
328                                 do
329                                         RAND_add(&t, t.dwSize, 0);
330                                 while (thread_next(handle, &t));
331                         
332                         /* module walking */
333                         m.dwSize = sizeof(MODULEENTRY32);
334                         if (module_first(handle, &m))
335                                 do
336                                         RAND_add(&m, m.dwSize, 1);
337                                 while (module_next(handle, &m));
338                         
339                         CloseHandle(handle);
340                         }
341                 }
342
343 #ifdef DEBUG
344         printf("Exiting RAND_poll\n");
345 #endif
346
347         return(1);
348 }
349
350 int RAND_event(UINT iMsg, WPARAM wParam, LPARAM lParam)
351         {
352         double add_entropy=0;
353
354         switch (iMsg)
355                 {
356         case WM_KEYDOWN:
357                         {
358                         static WPARAM key;
359                         if (key != wParam)
360                                 add_entropy = 0.05;
361                         key = wParam;
362                         }
363                         break;
364         case WM_MOUSEMOVE:
365                         {
366                         static int lastx,lasty,lastdx,lastdy;
367                         int x,y,dx,dy;
368
369                         x=LOWORD(lParam);
370                         y=HIWORD(lParam);
371                         dx=lastx-x;
372                         dy=lasty-y;
373                         if (dx != 0 && dy != 0 && dx-lastdx != 0 && dy-lastdy != 0)
374                                 add_entropy=.2;
375                         lastx=x, lasty=y;
376                         lastdx=dx, lastdy=dy;
377                         }
378                 break;
379                 }
380
381         readtimer();
382         RAND_add(&iMsg, sizeof(iMsg), add_entropy);
383         RAND_add(&wParam, sizeof(wParam), 0);
384         RAND_add(&lParam, sizeof(lParam), 0);
385  
386         return (RAND_status());
387         }
388
389
390 void RAND_screen(void) /* function available for backward compatibility */
391 {
392         RAND_poll();
393         readscreen();
394 }
395
396
397 /* feed timing information to the PRNG */
398 static void readtimer(void)
399 {
400         DWORD w, cyclecount;
401         LARGE_INTEGER l;
402         static int have_perfc = 1;
403 #ifndef __GNUC__
404         static int have_tsc = 1;
405
406         if (have_tsc) {
407           __try {
408             __asm {
409               rdtsc
410               mov cyclecount, eax
411               }
412             RAND_add(&cyclecount, sizeof(cyclecount), 1);
413           } __except(EXCEPTION_EXECUTE_HANDLER) {
414             have_tsc = 0;
415           }
416         }
417 #else
418 # define have_tsc 0
419 #endif
420
421         if (have_perfc) {
422           if (QueryPerformanceCounter(&l) == 0)
423             have_perfc = 0;
424           else
425             RAND_add(&l, sizeof(l), 0);
426         }
427
428         if (!have_tsc && !have_perfc) {
429           w = GetTickCount();
430           RAND_add(&w, sizeof(w), 0);
431         }
432 }
433
434 /* feed screen contents to PRNG */
435 /*****************************************************************************
436  *
437  * Created 960901 by Gertjan van Oosten, gertjan@West.NL, West Consulting B.V.
438  *
439  * Code adapted from
440  * <URL:http://www.microsoft.com/kb/developr/win_dk/q97193.htm>;
441  * the original copyright message is:
442  *
443  *   (C) Copyright Microsoft Corp. 1993.  All rights reserved.
444  *
445  *   You have a royalty-free right to use, modify, reproduce and
446  *   distribute the Sample Files (and/or any modified version) in
447  *   any way you find useful, provided that you agree that
448  *   Microsoft has no warranty obligations or liability for any
449  *   Sample Application Files which are modified.
450  */
451
452 static void readscreen(void)
453 {
454   HDC           hScrDC;         /* screen DC */
455   HDC           hMemDC;         /* memory DC */
456   HBITMAP       hBitmap;        /* handle for our bitmap */
457   HBITMAP       hOldBitmap;     /* handle for previous bitmap */
458   BITMAP        bm;             /* bitmap properties */
459   unsigned int  size;           /* size of bitmap */
460   char          *bmbits;        /* contents of bitmap */
461   int           w;              /* screen width */
462   int           h;              /* screen height */
463   int           y;              /* y-coordinate of screen lines to grab */
464   int           n = 16;         /* number of screen lines to grab at a time */
465
466   /* Create a screen DC and a memory DC compatible to screen DC */
467   hScrDC = CreateDC("DISPLAY", NULL, NULL, NULL);
468   hMemDC = CreateCompatibleDC(hScrDC);
469
470   /* Get screen resolution */
471   w = GetDeviceCaps(hScrDC, HORZRES);
472   h = GetDeviceCaps(hScrDC, VERTRES);
473
474   /* Create a bitmap compatible with the screen DC */
475   hBitmap = CreateCompatibleBitmap(hScrDC, w, n);
476
477   /* Select new bitmap into memory DC */
478   hOldBitmap = SelectObject(hMemDC, hBitmap);
479
480   /* Get bitmap properties */
481   GetObject(hBitmap, sizeof(BITMAP), (LPSTR)&bm);
482   size = (unsigned int)bm.bmWidthBytes * bm.bmHeight * bm.bmPlanes;
483
484   bmbits = OPENSSL_malloc(size);
485   if (bmbits) {
486     /* Now go through the whole screen, repeatedly grabbing n lines */
487     for (y = 0; y < h-n; y += n)
488         {
489         unsigned char md[MD_DIGEST_LENGTH];
490
491         /* Bitblt screen DC to memory DC */
492         BitBlt(hMemDC, 0, 0, w, n, hScrDC, 0, y, SRCCOPY);
493
494         /* Copy bitmap bits from memory DC to bmbits */
495         GetBitmapBits(hBitmap, size, bmbits);
496
497         /* Get the hash of the bitmap */
498         MD(bmbits,size,md);
499
500         /* Seed the random generator with the hash value */
501         RAND_add(md, MD_DIGEST_LENGTH, 0);
502         }
503
504     OPENSSL_free(bmbits);
505   }
506
507   /* Select old bitmap back into memory DC */
508   hBitmap = SelectObject(hMemDC, hOldBitmap);
509
510   /* Clean up */
511   DeleteObject(hBitmap);
512   DeleteDC(hMemDC);
513   DeleteDC(hScrDC);
514 }
515
516 #else /* Unix version */
517
518 #include <time.h>
519
520 int RAND_poll(void)
521 {
522         unsigned long l;
523         pid_t curr_pid = getpid();
524 #ifdef DEVRANDOM
525         FILE *fh;
526 #endif
527
528 #ifdef DEVRANDOM
529         /* Use a random entropy pool device. Linux, FreeBSD and OpenBSD
530          * have this. Use /dev/urandom if you can as /dev/random may block
531          * if it runs out of random entries.  */
532
533         if ((fh = fopen(DEVRANDOM, "r")) != NULL)
534                 {
535                 unsigned char tmpbuf[ENTROPY_NEEDED];
536                 int n;
537                 
538                 setvbuf(fh, NULL, _IONBF, 0);
539                 n=fread((unsigned char *)tmpbuf,1,ENTROPY_NEEDED,fh);
540                 fclose(fh);
541                 RAND_add(tmpbuf,sizeof tmpbuf,n);
542                 memset(tmpbuf,0,n);
543                 }
544 #endif
545
546         /* put in some default random data, we need more than just this */
547         l=curr_pid;
548         RAND_add(&l,sizeof(l),0);
549         l=getuid();
550         RAND_add(&l,sizeof(l),0);
551
552         l=time(NULL);
553         RAND_add(&l,sizeof(l),0);
554
555 #ifdef DEVRANDOM
556         return 1;
557 #endif
558         return 0;
559 }
560
561 #endif