Close the implicitely opened registry key.
[openssl.git] / crypto / rand / rand_win.c
index acdef305186d139a277e658073537b9aca0e3452..242febe270ba40320b138f6cdfa0bda9269755c0 100644 (file)
 #include <openssl/rand.h>
 #include "rand_lcl.h"
 
-#if defined(WINDOWS) || defined(WIN32)
+#if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
 #include <windows.h>
 #ifndef _WIN32_WINNT
 # define _WIN32_WINNT 0x0400
@@ -171,13 +171,16 @@ typedef BOOL (WINAPI *MODULE32)(HANDLE, LPMODULEENTRY32);
 
 #include <lmcons.h>
 #include <lmstats.h>
-#if 0 /* Some compilers use LMSTR, others (VC6, for example) use LPTSTR.
-       * This part is disabled until a fix is found.
+#if 1 /* The NET API is Unicode only.  It requires the use of the UNICODE
+       * macro.  When UNICODE is defined LPTSTR becomes LPWSTR.  LMSTR was
+       * was added to the Platform SDK to allow the NET API to be used in
+       * non-Unicode applications provided that Unicode strings were still
+       * used for input.  LMSTR is defined as LPWSTR.
        */
 typedef NET_API_STATUS (NET_API_FUNCTION * NETSTATGET)
-        (LMSTR, LMSTR, DWORD, DWORD, LPBYTE*);
+        (LPWSTR, LPWSTR, DWORD, DWORD, LPBYTE*);
 typedef NET_API_STATUS (NET_API_FUNCTION * NETFREE)(LPBYTE);
-#endif
+#endif /* 1 */
 
 int RAND_poll(void)
 {
@@ -191,12 +194,20 @@ int RAND_poll(void)
        CRYPTACQUIRECONTEXT acquire = 0;
        CRYPTGENRANDOM gen = 0;
        CRYPTRELEASECONTEXT release = 0;
-#if 0 /* This part is disabled until a fix for the problem with the
-       * definition of NETSTATGET is found.
+#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
+#endif /* 1 */
+
+       /* Determine the OS version we are on so we can turn off things 
+        * that do not work properly.
+        */
+        OSVERSIONINFO osverinfo ;
+        osverinfo.dwOSVersionInfoSize = sizeof(OSVERSIONINFO) ;
+        GetVersionEx( &osverinfo ) ;
 
        /* load functions dynamically - not available on all systems */
        advapi = LoadLibrary("ADVAPI32.DLL");
@@ -204,9 +215,9 @@ int RAND_poll(void)
        user = LoadLibrary("USER32.DLL");
        netapi = LoadLibrary("NETAPI32.DLL");
 
-#if 0 /* This part is disabled until a fix for the problem with the
-       * definition of NETSTATGET is found.  Also, note that VC6 doesn't
-       * understand strings starting with L".
+#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
        */
        if (netapi)
                {
@@ -217,53 +228,82 @@ int RAND_poll(void)
        if (netstatget && netfree)
                {
                LPBYTE outbuf;
-               /* NetStatisticsGet() is a Unicode only function */
+               /* NetStatisticsGet() is a Unicode only function
+                * STAT_WORKSTATION_0 contains 45 fields and STAT_SERVER_0
+                * contains 17 fields.  We treat each field as a source of
+                * one byte of entropy.
+                 */
+
                if (netstatget(NULL, L"LanmanWorkstation", 0, 0, &outbuf) == 0)
                        {
-                       RAND_add(outbuf, sizeof(STAT_WORKSTATION_0), 0);
+                       RAND_add(outbuf, sizeof(STAT_WORKSTATION_0), 45);
                        netfree(outbuf);
                        }
                if (netstatget(NULL, L"LanmanServer", 0, 0, &outbuf) == 0)
                        {
-                       RAND_add(outbuf, sizeof(STAT_SERVER_0), 0);
+                       RAND_add(outbuf, sizeof(STAT_SERVER_0), 17);
                        netfree(outbuf);
                        }
                }
 
        if (netapi)
                FreeLibrary(netapi);
-#endif
+#endif /* 1 */
  
-       /* Read Performance Statistics from NT/2000 registry */
-       /* The size of the performance data can vary from call to call */
-       /* so we must guess the size of the buffer to use and increase */
-       /* its size if we get an ERROR_MORE_DATA return instead of     */
-       /* ERROR_SUCCESS.                                              */
-       {
-       LONG   rc=ERROR_MORE_DATA;
-       char * buf=NULL;
-       DWORD bufsz=0;
-       DWORD length;
-
-       while (rc == ERROR_MORE_DATA)
-               {
-               buf = realloc(buf,bufsz+8192);
-               if (!buf)
-                       break;
-               bufsz += 8192;
-
-               length = bufsz;
-               rc = RegQueryValueEx(HKEY_PERFORMANCE_DATA, "Global",
-                       NULL, NULL, buf, &length);
-               }
-       if (rc == ERROR_SUCCESS)
+        /* 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.
+        */
+       /* Wolfgang Marczy <WMarczy@topcall.co.at> reports that
+        * the RegQueryValueEx call below can hang on NT4.0 (SP6).
+        * So we don't use this at all for now. */
+#if 0
+        if ( osverinfo.dwPlatformId == VER_PLATFORM_WIN32_NT &&
+               osverinfo.dwMajorVersion < 5)
                {
-               RAND_add(&length, sizeof(length), 0);
-               RAND_add(buf, length, 0);
+               /* Read Performance Statistics from NT/2000 registry
+                * The size of the performance data can vary from call
+                * to call so we must guess the size of the buffer to use
+                * and increase its size if we get an ERROR_MORE_DATA
+                * return instead of ERROR_SUCCESS.
+                */
+               LONG   rc=ERROR_MORE_DATA;
+               char * buf=NULL;
+               DWORD bufsz=0;
+               DWORD length;
+
+               while (rc == ERROR_MORE_DATA)
+                       {
+                       buf = realloc(buf,bufsz+8192);
+                       if (!buf)
+                               break;
+                       bufsz += 8192;
+
+                       length = bufsz;
+                       rc = RegQueryValueEx(HKEY_PERFORMANCE_DATA, "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);
                }
-       if (buf)
-               free(buf);
-       }
+#endif
 
        if (advapi)
                {
@@ -278,13 +318,14 @@ int RAND_poll(void)
        if (acquire && gen && release)
                {
                /* poll the CryptoAPI PRNG */
+                /* The CryptoAPI returns sizeof(buf) bytes of randomness */
                if (acquire(&hProvider, 0, 0, PROV_RSA_FULL,
                        CRYPT_VERIFYCONTEXT))
                        {
                        if (gen(hProvider, sizeof(buf), buf) != 0)
                                {
                                RAND_add(buf, sizeof(buf), 0);
-#ifdef DEBUG
+#if 0
                                printf("randomness from PROV_RSA_FULL\n");
 #endif
                                }
@@ -296,8 +337,8 @@ int RAND_poll(void)
                        {
                        if (gen(hProvider, sizeof(buf), buf) != 0)
                                {
-                               RAND_add(buf, sizeof(buf), 0);
-#ifdef DEBUG
+                               RAND_add(buf, sizeof(buf), sizeof(buf));
+#if 0
                                printf("randomness from PROV_INTEL_SEC\n");
 #endif
                                }
@@ -317,7 +358,7 @@ int RAND_poll(void)
 
        /* process ID */
        w = GetCurrentProcessId();
-       RAND_add(&w, sizeof(w), 0);
+       RAND_add(&w, sizeof(w), 1);
 
        if (user)
                {
@@ -330,41 +371,37 @@ int RAND_poll(void)
                queue = (GETQUEUESTATUS) GetProcAddress(user, "GetQueueStatus");
 
                if (win)
-               {
+                       {
                        /* window handle */
                        h = win();
                        RAND_add(&h, sizeof(h), 0);
-               }
-
+                       }
                if (cursor)
                        {
                        /* unfortunately, its not safe to call GetCursorInfo()
                         * on NT4 even though it exists in SP3 (or SP6) and
                         * higher.
                         */
-                       OSVERSIONINFO osverinfo ;
-                       osverinfo.dwOSVersionInfoSize = sizeof(OSVERSIONINFO) ;
-                       GetVersionEx( &osverinfo ) ;
-
                        if ( osverinfo.dwPlatformId == VER_PLATFORM_WIN32_NT &&
                                osverinfo.dwMajorVersion < 5)
                                cursor = 0;
                        }
-
                if (cursor)
                        {
                        /* cursor position */
+                        /* assume 2 bytes of entropy */
                        CURSORINFO ci;
                        ci.cbSize = sizeof(CURSORINFO);
                        if (cursor(&ci))
-                               RAND_add(&ci, ci.cbSize, 0);
+                               RAND_add(&ci, ci.cbSize, 2);
                        }
 
                if (queue)
                        {
                        /* message queue status */
+                        /* assume 1 byte of entropy */
                        w = queue(QS_ALLEVENTS);
-                       RAND_add(&w, sizeof(w), 0);
+                       RAND_add(&w, sizeof(w), 1);
                        }
 
                FreeLibrary(user);
@@ -402,7 +439,7 @@ int RAND_poll(void)
                MODULEENTRY32 m;
 
                snap = (CREATETOOLHELP32SNAPSHOT)
-                 GetProcAddress(kernel, "CreateToolhelp32Snapshot");
+                       GetProcAddress(kernel, "CreateToolhelp32Snapshot");
                heap_first = (HEAP32FIRST) GetProcAddress(kernel, "Heap32First");
                heap_next = (HEAP32NEXT) GetProcAddress(kernel, "Heap32Next");
                heaplist_first = (HEAP32LIST) GetProcAddress(kernel, "Heap32ListFirst");
@@ -421,54 +458,73 @@ int RAND_poll(void)
                        != NULL)
                        {
                        /* heap list and heap walking */
+                        /* HEAPLIST32 contains 3 fields that will change with
+                         * each entry.  Consider each field a source of 1 byte
+                         * of entropy.
+                         * HEAPENTRY32 contains 5 fields that will change with 
+                         * each entry.  Consider each field a source of 1 byte
+                         * of entropy.
+                         */
                        hlist.dwSize = sizeof(HEAPLIST32);              
                        if (heaplist_first(handle, &hlist))
                                do
                                        {
-                                       RAND_add(&hlist, hlist.dwSize, 0);
+                                       RAND_add(&hlist, hlist.dwSize, 3);
                                        hentry.dwSize = sizeof(HEAPENTRY32);
                                        if (heap_first(&hentry,
                                                hlist.th32ProcessID,
                                                hlist.th32HeapID))
                                                {
-                                               int entrycnt = 50;
+                                               int entrycnt = 80;
                                                do
                                                        RAND_add(&hentry,
-                                                               hentry.dwSize, 0);
+                                                               hentry.dwSize, 5);
                                                while (heap_next(&hentry)
                                                        && --entrycnt > 0);
                                                }
                                        } while (heaplist_next(handle,
                                                &hlist));
-
+                       
                        /* 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 (process_first(handle, &p))
                                do
-                                       RAND_add(&p, p.dwSize, 0);
+                                       RAND_add(&p, p.dwSize, 9);
                                while (process_next(handle, &p));
-                       
+
                        /* thread walking */
+                        /* THREADENTRY32 contains 6 fields that will change
+                         * with each entry.  Consider each field a source of
+                         * 1 byte of entropy.
+                         */
                        t.dwSize = sizeof(THREADENTRY32);
                        if (thread_first(handle, &t))
                                do
-                                       RAND_add(&t, t.dwSize, 0);
+                                       RAND_add(&t, t.dwSize, 6);
                                while (thread_next(handle, &t));
-                       
+
                        /* module walking */
+                        /* MODULEENTRY32 contains 9 fields that will change
+                         * with each entry.  Consider each field a source of
+                         * 1 byte of entropy.
+                         */
                        m.dwSize = sizeof(MODULEENTRY32);
                        if (module_first(handle, &m))
                                do
-                                       RAND_add(&m, m.dwSize, 1);
+                                       RAND_add(&m, m.dwSize, 9);
                                while (module_next(handle, &m));
-                       
+
                        CloseHandle(handle);
                        }
 
                FreeLibrary(kernel);
                }
 
-#ifdef DEBUG
+#if 0
        printf("Exiting RAND_poll\n");
 #endif
 
@@ -528,14 +584,15 @@ static void readtimer(void)
        DWORD w;
        LARGE_INTEGER l;
        static int have_perfc = 1;
-#ifndef __GNUC__
+#ifdef _MSC_VER
        static int have_tsc = 1;
        DWORD cyclecount;
 
        if (have_tsc) {
          __try {
            __asm {
-             rdtsc
+             _emit 0x0f
+             _emit 0x31
              mov cyclecount, eax
              }
            RAND_add(&cyclecount, sizeof(cyclecount), 1);
@@ -642,49 +699,4 @@ static void readscreen(void)
   DeleteDC(hScrDC);
 }
 
-#else /* Unix version */
-
-#include <time.h>
-
-int RAND_poll(void)
-{
-       unsigned long l;
-       pid_t curr_pid = getpid();
-#ifdef DEVRANDOM
-       FILE *fh;
-#endif
-
-#ifdef DEVRANDOM
-       /* Use a random entropy pool device. Linux, FreeBSD and OpenBSD
-        * have this. Use /dev/urandom if you can as /dev/random may block
-        * if it runs out of random entries.  */
-
-       if ((fh = fopen(DEVRANDOM, "r")) != NULL)
-               {
-               unsigned char tmpbuf[ENTROPY_NEEDED];
-               int n;
-               
-               setvbuf(fh, NULL, _IONBF, 0);
-               n=fread((unsigned char *)tmpbuf,1,ENTROPY_NEEDED,fh);
-               fclose(fh);
-               RAND_add(tmpbuf,sizeof tmpbuf,n);
-               memset(tmpbuf,0,n);
-               }
-#endif
-
-       /* put in some default random data, we need more than just this */
-       l=curr_pid;
-       RAND_add(&l,sizeof(l),0);
-       l=getuid();
-       RAND_add(&l,sizeof(l),0);
-
-       l=time(NULL);
-       RAND_add(&l,sizeof(l),0);
-
-#ifdef DEVRANDOM
-       return 1;
-#endif
-       return 0;
-}
-
 #endif