rand_win.c: handel GetTickCount wrap-around [from HEAD].
[openssl.git] / crypto / rand / rand_win.c
index c1b955b06f07b21f89aecb337f75b21fc6746658..9bad067f43202540c7b79d71713c258f7d1e9061 100644 (file)
 #include <wincrypt.h>
 #include <tlhelp32.h>
 
+/* Limit the time spent walking through the heap, processes, threads and modules to
+   a maximum of 1000 miliseconds each, unless CryptoGenRandom failed */
+#define MAXDELAY 1000
+
 /* Intel hardware RNG CSP -- available from
  * http://developer.intel.com/design/security/rng/redist_license.htm
  */
 #define PROV_INTEL_SEC 22
-#define INTEL_DEF_PROV "Intel Hardware Cryptographic Service Provider"
+#define INTEL_DEF_PROV L"Intel Hardware Cryptographic Service Provider"
 
 static void readtimer(void);
 static void readscreen(void);
@@ -152,7 +156,8 @@ typedef struct tagCURSORINFO
 #define CURSOR_SHOWING     0x00000001
 #endif /* CURSOR_SHOWING */
 
-typedef BOOL (WINAPI *CRYPTACQUIRECONTEXT)(HCRYPTPROV *, LPCTSTR, LPCTSTR,
+#if !defined(OPENSSL_SYS_WINCE)
+typedef BOOL (WINAPI *CRYPTACQUIRECONTEXTW)(HCRYPTPROV *, LPCWSTR, LPCWSTR,
                                    DWORD, DWORD);
 typedef BOOL (WINAPI *CRYPTGENRANDOM)(HCRYPTPROV, DWORD, BYTE *);
 typedef BOOL (WINAPI *CRYPTRELEASECONTEXT)(HCRYPTPROV, DWORD);
@@ -162,7 +167,8 @@ typedef BOOL (WINAPI *GETCURSORINFO)(PCURSORINFO);
 typedef DWORD (WINAPI *GETQUEUESTATUS)(UINT);
 
 typedef HANDLE (WINAPI *CREATETOOLHELP32SNAPSHOT)(DWORD, DWORD);
-typedef BOOL (WINAPI *HEAP32FIRST)(LPHEAPENTRY32, DWORD, DWORD);
+typedef BOOL (WINAPI *CLOSETOOLHELP32SNAPSHOT)(HANDLE);
+typedef BOOL (WINAPI *HEAP32FIRST)(LPHEAPENTRY32, DWORD, size_t);
 typedef BOOL (WINAPI *HEAP32NEXT)(LPHEAPENTRY32);
 typedef BOOL (WINAPI *HEAP32LIST)(HANDLE, LPHEAPLIST32);
 typedef BOOL (WINAPI *PROCESS32)(HANDLE, LPPROCESSENTRY32);
@@ -181,26 +187,14 @@ typedef NET_API_STATUS (NET_API_FUNCTION * NETSTATGET)
         (LPWSTR, LPWSTR, DWORD, DWORD, LPBYTE*);
 typedef NET_API_STATUS (NET_API_FUNCTION * NETFREE)(LPBYTE);
 #endif /* 1 */
+#endif /* !OPENSSL_SYS_WINCE */
 
 int RAND_poll(void)
 {
        MEMORYSTATUS m;
        HCRYPTPROV hProvider = 0;
-       BYTE buf[64];
        DWORD w;
-       HWND h;
-
-       HMODULE advapi, kernel, user, netapi;
-       CRYPTACQUIRECONTEXT acquire = 0;
-       CRYPTGENRANDOM gen = 0;
-       CRYPTRELEASECONTEXT release = 0;
-#if 1 /* There was previously a problem with NETSTATGET.  Currently, this
-       * section is still experimental, but if all goes well, this conditional
-       * will be removed
-       */
-       NETSTATGET netstatget = 0;
-       NETFREE netfree = 0;
-#endif /* 1 */
+       int good = 0;
 
        /* Determine the OS version we are on so we can turn off things 
         * that do not work properly.
@@ -209,16 +203,50 @@ int RAND_poll(void)
         osverinfo.dwOSVersionInfoSize = sizeof(OSVERSIONINFO) ;
         GetVersionEx( &osverinfo ) ;
 
+#if defined(OPENSSL_SYS_WINCE)
+# if defined(_WIN32_WCE) && _WIN32_WCE>=300
+/* Even though MSDN says _WIN32_WCE>=210, it doesn't seem to be available
+ * in commonly available implementations prior 300... */
+       {
+       BYTE buf[64];
+       /* poll the CryptoAPI PRNG */
+       /* The CryptoAPI returns sizeof(buf) bytes of randomness */
+       if (CryptAcquireContextW(&hProvider, NULL, NULL, PROV_RSA_FULL,
+                               CRYPT_VERIFYCONTEXT))
+               {
+               if (CryptGenRandom(hProvider, sizeof(buf), buf))
+                       RAND_add(buf, sizeof(buf), sizeof(buf));
+               CryptReleaseContext(hProvider, 0); 
+               }
+       }
+# endif
+#else  /* OPENSSL_SYS_WINCE */
+       /*
+        * None of below libraries are present on Windows CE, which is
+        * why we #ifndef the whole section. This also excuses us from
+        * handling the GetProcAddress issue. The trouble is that in
+        * real Win32 API GetProcAddress is available in ANSI flavor
+        * only. In WinCE on the other hand GetProcAddress is a macro
+        * most commonly defined as GetProcAddressW, which accepts
+        * Unicode argument. If we were to call GetProcAddress under
+        * WinCE, I'd recommend to either redefine GetProcAddress as
+        * GetProcAddressA (there seem to be one in common CE spec) or
+        * implement own shim routine, which would accept ANSI argument
+        * and expand it to Unicode.
+        */
+       {
        /* load functions dynamically - not available on all systems */
-       advapi = LoadLibrary("ADVAPI32.DLL");
-       kernel = LoadLibrary("KERNEL32.DLL");
-       user = LoadLibrary("USER32.DLL");
-       netapi = LoadLibrary("NETAPI32.DLL");
-
-#if 1 /* There was previously a problem with NETSTATGET.  Currently, this
-       * section is still experimental, but if all goes well, this conditional
-       * will be removed
-       */
+       HMODULE advapi = LoadLibrary(TEXT("ADVAPI32.DLL"));
+       HMODULE kernel = LoadLibrary(TEXT("KERNEL32.DLL"));
+       HMODULE user = NULL;
+       HMODULE netapi = LoadLibrary(TEXT("NETAPI32.DLL"));
+       CRYPTACQUIRECONTEXTW acquire = NULL;
+       CRYPTGENRANDOM gen = NULL;
+       CRYPTRELEASECONTEXT release = NULL;
+       NETSTATGET netstatget = NULL;
+       NETFREE netfree = NULL;
+       BYTE buf[64];
+
        if (netapi)
                {
                netstatget = (NETSTATGET) GetProcAddress(netapi,"NetStatisticsGet");
@@ -248,8 +276,7 @@ int RAND_poll(void)
 
        if (netapi)
                FreeLibrary(netapi);
-#endif /* 1 */
+
         /* It appears like this can cause an exception deep within ADVAPI32.DLL
          * at random times on Windows 2000.  Reported by Jeffrey Altman.  
          * Only use it on NT.
@@ -280,16 +307,25 @@ int RAND_poll(void)
                        bufsz += 8192;
 
                        length = bufsz;
-                       rc = RegQueryValueEx(HKEY_PERFORMANCE_DATA, "Global",
+                       rc = RegQueryValueEx(HKEY_PERFORMANCE_DATA, TEXT("Global"),
                                NULL, NULL, buf, &length);
                        }
                if (rc == ERROR_SUCCESS)
                        {
                         /* For entropy count assume only least significant
                         * byte of each DWORD is random.
-                         */
+                        */
                        RAND_add(&length, sizeof(length), 0);
                        RAND_add(buf, length, length / 4.0);
+
+                       /* Close the Registry Key to allow Windows to cleanup/close
+                        * the open handle
+                        * Note: The 'HKEY_PERFORMANCE_DATA' key is implicitly opened
+                        *       when the RegQueryValueEx above is done.  However, if
+                        *       it is not explicitly closed, it can cause disk
+                        *       partition manipulation problems.
+                        */
+                       RegCloseKey(HKEY_PERFORMANCE_DATA);
                        }
                if (buf)
                        free(buf);
@@ -298,8 +334,13 @@ int RAND_poll(void)
 
        if (advapi)
                {
-               acquire = (CRYPTACQUIRECONTEXT) GetProcAddress(advapi,
-                       "CryptAcquireContextA");
+               /*
+                * If it's available, then it's available in both ANSI
+                * and UNICODE flavors even in Win9x, documentation says.
+                * We favor Unicode...
+                */
+               acquire = (CRYPTACQUIRECONTEXTW) GetProcAddress(advapi,
+                       "CryptAcquireContextW");
                gen = (CRYPTGENRANDOM) GetProcAddress(advapi,
                        "CryptGenRandom");
                release = (CRYPTRELEASECONTEXT) GetProcAddress(advapi,
@@ -310,12 +351,13 @@ int RAND_poll(void)
                {
                /* poll the CryptoAPI PRNG */
                 /* The CryptoAPI returns sizeof(buf) bytes of randomness */
-               if (acquire(&hProvider, 0, 0, PROV_RSA_FULL,
+               if (acquire(&hProvider, NULL, NULL, PROV_RSA_FULL,
                        CRYPT_VERIFYCONTEXT))
                        {
                        if (gen(hProvider, sizeof(buf), buf) != 0)
                                {
                                RAND_add(buf, sizeof(buf), 0);
+                               good = 1;
 #if 0
                                printf("randomness from PROV_RSA_FULL\n");
 #endif
@@ -329,6 +371,7 @@ int RAND_poll(void)
                        if (gen(hProvider, sizeof(buf), buf) != 0)
                                {
                                RAND_add(buf, sizeof(buf), sizeof(buf));
+                               good = 1;
 #if 0
                                printf("randomness from PROV_INTEL_SEC\n");
 #endif
@@ -340,18 +383,9 @@ int RAND_poll(void)
         if (advapi)
                FreeLibrary(advapi);
 
-       /* timer data */
-       readtimer();
-       
-       /* memory usage statistics */
-       GlobalMemoryStatus(&m);
-       RAND_add(&m, sizeof(m), 1);
-
-       /* process ID */
-       w = GetCurrentProcessId();
-       RAND_add(&w, sizeof(w), 1);
-
-       if (user)
+       if ((osverinfo.dwPlatformId != VER_PLATFORM_WIN32_NT ||
+            !OPENSSL_isservice()) &&
+           (user = LoadLibrary(TEXT("USER32.DLL"))))
                {
                GETCURSORINFO cursor;
                GETFOREGROUNDWINDOW win;
@@ -364,7 +398,7 @@ int RAND_poll(void)
                if (win)
                        {
                        /* window handle */
-                       h = win();
+                       HWND h = win();
                        RAND_add(&h, sizeof(h), 0);
                        }
                if (cursor)
@@ -405,7 +439,7 @@ int RAND_poll(void)
         * This seeding method was proposed in Peter Gutmann, Software
         * Generation of Practically Strong Random Numbers,
         * http://www.usenix.org/publications/library/proceedings/sec98/gutmann.html
-     * revised version at http://www.cryptoengines.com/~peter/06_random.pdf
+        * revised version at http://www.cryptoengines.com/~peter/06_random.pdf
         * (The assignment of entropy estimates below is arbitrary, but based
         * on Peter's analysis the full poll appears to be safe. Additional
         * interactive seeding is encouraged.)
@@ -414,6 +448,7 @@ int RAND_poll(void)
        if (kernel)
                {
                CREATETOOLHELP32SNAPSHOT snap;
+               CLOSETOOLHELP32SNAPSHOT close_snap;
                HANDLE handle;
 
                HEAP32FIRST heap_first;
@@ -428,9 +463,12 @@ int RAND_poll(void)
                PROCESSENTRY32 p;
                THREADENTRY32 t;
                MODULEENTRY32 m;
+               DWORD starttime = 0;
 
                snap = (CREATETOOLHELP32SNAPSHOT)
                        GetProcAddress(kernel, "CreateToolhelp32Snapshot");
+               close_snap = (CLOSETOOLHELP32SNAPSHOT)
+                       GetProcAddress(kernel, "CloseToolhelp32Snapshot");
                heap_first = (HEAP32FIRST) GetProcAddress(kernel, "Heap32First");
                heap_next = (HEAP32NEXT) GetProcAddress(kernel, "Heap32Next");
                heaplist_first = (HEAP32LIST) GetProcAddress(kernel, "Heap32ListFirst");
@@ -446,7 +484,7 @@ int RAND_poll(void)
                        heaplist_next && process_first && process_next &&
                        thread_first && thread_next && module_first &&
                        module_next && (handle = snap(TH32CS_SNAPALL,0))
-                       != NULL)
+                       != INVALID_HANDLE_VALUE)
                        {
                        /* heap list and heap walking */
                         /* HEAPLIST32 contains 3 fields that will change with
@@ -456,11 +494,29 @@ int RAND_poll(void)
                          * each entry.  Consider each field a source of 1 byte
                          * of entropy.
                          */
+                       ZeroMemory(&hlist, sizeof(HEAPLIST32));
                        hlist.dwSize = sizeof(HEAPLIST32);              
+                       if (good) starttime = GetTickCount();
+#ifdef _MSC_VER
                        if (heaplist_first(handle, &hlist))
+                               {
+                               /*
+                                  following discussion on dev ML, exception on WinCE (or other Win
+                                  platform) is theoretically of unknown origin; prevent infinite
+                                  loop here when this theoretical case occurs; otherwise cope with
+                                  the expected (MSDN documented) exception-throwing behaviour of
+                                  Heap32Next() on WinCE.
+
+                                  based on patch in original message by Tanguy Fautré (2009/03/02)
+                                  Subject: RAND_poll() and CreateToolhelp32Snapshot() stability
+                            */
+                               int ex_cnt_limit = 42; 
                                do
                                        {
                                        RAND_add(&hlist, hlist.dwSize, 3);
+                                       __try
+                                               {
+                                               ZeroMemory(&hentry, sizeof(HEAPENTRY32));
                                        hentry.dwSize = sizeof(HEAPENTRY32);
                                        if (heap_first(&hentry,
                                                hlist.th32ProcessID,
@@ -473,19 +529,52 @@ int RAND_poll(void)
                                                while (heap_next(&hentry)
                                                        && --entrycnt > 0);
                                                }
-                                       } while (heaplist_next(handle,
-                                               &hlist));
-                       
+                                               }
+                                       __except (EXCEPTION_EXECUTE_HANDLER)
+                                               {
+                                                       /* ignore access violations when walking the heap list */
+                                                       ex_cnt_limit--;
+                                               }
+                                       } while (heaplist_next(handle, &hlist) 
+                                               && (!good || (GetTickCount()-starttime)<MAXDELAY)
+                                               && ex_cnt_limit > 0);
+                               }
+
+#else
+                       if (heaplist_first(handle, &hlist))
+                               {
+                               do
+                                       {
+                                       RAND_add(&hlist, hlist.dwSize, 3);
+                                       hentry.dwSize = sizeof(HEAPENTRY32);
+                                       if (heap_first(&hentry,
+                                               hlist.th32ProcessID,
+                                               hlist.th32HeapID))
+                                               {
+                                               int entrycnt = 80;
+                                               do
+                                                       RAND_add(&hentry,
+                                                               hentry.dwSize, 5);
+                                               while (heap_next(&hentry)
+                                                       && --entrycnt > 0);
+                                               }
+                                       } while (heaplist_next(handle, &hlist) 
+                                               && (!good || (GetTickCount()-starttime)<MAXDELAY));
+                               }
+#endif
+
                        /* process walking */
                         /* PROCESSENTRY32 contains 9 fields that will change
                          * with each entry.  Consider each field a source of
                          * 1 byte of entropy.
                          */
                        p.dwSize = sizeof(PROCESSENTRY32);
+               
+                       if (good) starttime = GetTickCount();
                        if (process_first(handle, &p))
                                do
                                        RAND_add(&p, p.dwSize, 9);
-                               while (process_next(handle, &p));
+                               while (process_next(handle, &p) && (!good || (GetTickCount()-starttime)<MAXDELAY));
 
                        /* thread walking */
                         /* THREADENTRY32 contains 6 fields that will change
@@ -493,10 +582,11 @@ int RAND_poll(void)
                          * 1 byte of entropy.
                          */
                        t.dwSize = sizeof(THREADENTRY32);
+                       if (good) starttime = GetTickCount();
                        if (thread_first(handle, &t))
                                do
                                        RAND_add(&t, t.dwSize, 6);
-                               while (thread_next(handle, &t));
+                               while (thread_next(handle, &t) && (!good || (GetTickCount()-starttime)<MAXDELAY));
 
                        /* module walking */
                         /* MODULEENTRY32 contains 9 fields that will change
@@ -504,16 +594,34 @@ int RAND_poll(void)
                          * 1 byte of entropy.
                          */
                        m.dwSize = sizeof(MODULEENTRY32);
+                       if (good) starttime = GetTickCount();
                        if (module_first(handle, &m))
                                do
                                        RAND_add(&m, m.dwSize, 9);
-                               while (module_next(handle, &m));
+                               while (module_next(handle, &m)
+                                               && (!good || (GetTickCount()-starttime)<MAXDELAY));
+                       if (close_snap)
+                               close_snap(handle);
+                       else
+                               CloseHandle(handle);
 
-                       CloseHandle(handle);
                        }
 
                FreeLibrary(kernel);
                }
+       }
+#endif /* !OPENSSL_SYS_WINCE */
+
+       /* timer data */
+       readtimer();
+       
+       /* memory usage statistics */
+       GlobalMemoryStatus(&m);
+       RAND_add(&m, sizeof(m), 1);
+
+       /* process ID */
+       w = GetCurrentProcessId();
+       RAND_add(&w, sizeof(w), 1);
 
 #if 0
        printf("Exiting RAND_poll\n");
@@ -575,7 +683,7 @@ static void readtimer(void)
        DWORD w;
        LARGE_INTEGER l;
        static int have_perfc = 1;
-#ifdef _MSC_VER
+#if defined(_MSC_VER) && defined(_M_X86)
        static int have_tsc = 1;
        DWORD cyclecount;
 
@@ -614,7 +722,7 @@ static void readtimer(void)
  * Created 960901 by Gertjan van Oosten, gertjan@West.NL, West Consulting B.V.
  *
  * Code adapted from
- * <URL:http://www.microsoft.com/kb/developr/win_dk/q97193.htm>;
+ * <URL:http://support.microsoft.com/default.aspx?scid=kb;[LN];97193>;
  * the original copyright message is:
  *
  *   (C) Copyright Microsoft Corp. 1993.  All rights reserved.
@@ -628,6 +736,7 @@ static void readtimer(void)
 
 static void readscreen(void)
 {
+#if !defined(OPENSSL_SYS_WINCE) && !defined(OPENSSL_SYS_WIN32_CYGWIN)
   HDC          hScrDC;         /* screen DC */
   HDC          hMemDC;         /* memory DC */
   HBITMAP      hBitmap;        /* handle for our bitmap */
@@ -640,8 +749,11 @@ static void readscreen(void)
   int          y;              /* y-coordinate of screen lines to grab */
   int          n = 16;         /* number of screen lines to grab at a time */
 
+  if (GetVersion() >= 0x80000000 || !OPENSSL_isservice())
+    return;
+
   /* Create a screen DC and a memory DC compatible to screen DC */
-  hScrDC = CreateDC("DISPLAY", NULL, NULL, NULL);
+  hScrDC = CreateDC(TEXT("DISPLAY"), NULL, NULL, NULL);
   hMemDC = CreateCompatibleDC(hScrDC);
 
   /* Get screen resolution */
@@ -688,6 +800,7 @@ static void readscreen(void)
   DeleteObject(hBitmap);
   DeleteDC(hMemDC);
   DeleteDC(hScrDC);
+#endif /* !OPENSSL_SYS_WINCE */
 }
 
 #endif