copyright
[openssl.git] / crypto / rand / md_rand.c
index 88a608a..a00ed70 100644 (file)
@@ -56,7 +56,7 @@
  * [including the GNU Public Licence.]
  */
 /* ====================================================================
- * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
+ * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  *
  */
 
-#define ENTROPY_NEEDED 20  /* require 160 bits = 20 bytes of randomness */
-
 #ifdef MD_RAND_DEBUG
 # ifndef NDEBUG
 #   define NDEBUG
 
 #include <assert.h>
 #include <stdio.h>
-#include <time.h>
 #include <string.h>
 
-#include "openssl/e_os.h"
+#include "e_os.h"
+
+#include <openssl/rand.h>
+#include "rand_lcl.h"
 
 #include <openssl/crypto.h>
 #include <openssl/err.h>
 
-#if !defined(USE_MD5_RAND) && !defined(USE_SHA1_RAND) && !defined(USE_MDC2_RAND) && !defined(USE_MD2_RAND)
-#if !defined(NO_SHA) && !defined(NO_SHA1)
-#define USE_SHA1_RAND
-#elif !defined(NO_MD5)
-#define USE_MD5_RAND
-#elif !defined(NO_MDC2) && !defined(NO_DES)
-#define USE_MDC2_RAND
-#elif !defined(NO_MD2)
-#define USE_MD2_RAND
-#else
-#error No message digest algorithm available
-#endif
-#endif
-
-/* Changed how the state buffer used.  I now attempt to 'wrap' such
- * that I don't run over the same locations the next time  go through
- * the 1023 bytes - many thanks to
- * Robert J. LeBlanc <rjl@renaissoft.com> for his comments
- */
-
-#if defined(USE_MD5_RAND)
-#include <openssl/md5.h>
-#define MD_DIGEST_LENGTH       MD5_DIGEST_LENGTH
-#define MD_CTX                 MD5_CTX
-#define MD_Init(a)             MD5_Init(a)
-#define MD_Update(a,b,c)       MD5_Update(a,b,c)
-#define        MD_Final(a,b)           MD5_Final(a,b)
-#define        MD(a,b,c)               MD5(a,b,c)
-#elif defined(USE_SHA1_RAND)
-#include <openssl/sha.h>
-#define MD_DIGEST_LENGTH       SHA_DIGEST_LENGTH
-#define MD_CTX                 SHA_CTX
-#define MD_Init(a)             SHA1_Init(a)
-#define MD_Update(a,b,c)       SHA1_Update(a,b,c)
-#define        MD_Final(a,b)           SHA1_Final(a,b)
-#define        MD(a,b,c)               SHA1(a,b,c)
-#elif defined(USE_MDC2_RAND)
-#include <openssl/mdc2.h>
-#define MD_DIGEST_LENGTH       MDC2_DIGEST_LENGTH
-#define MD_CTX                 MDC2_CTX
-#define MD_Init(a)             MDC2_Init(a)
-#define MD_Update(a,b,c)       MDC2_Update(a,b,c)
-#define        MD_Final(a,b)           MDC2_Final(a,b)
-#define        MD(a,b,c)               MDC2(a,b,c)
-#elif defined(USE_MD2_RAND)
-#include <openssl/md2.h>
-#define MD_DIGEST_LENGTH       MD2_DIGEST_LENGTH
-#define MD_CTX                 MD2_CTX
-#define MD_Init(a)             MD2_Init(a)
-#define MD_Update(a,b,c)       MD2_Update(a,b,c)
-#define        MD_Final(a,b)           MD2_Final(a,b)
-#define        MD(a,b,c)               MD2(a,b,c)
-#endif
-
-#include <openssl/rand.h>
-
 #ifdef BN_DEBUG
 # define PREDICT
 #endif
 
-/* #define NORAND      1 */
 /* #define PREDICT     1 */
 
 #define STATE_SIZE     1023
@@ -198,6 +141,13 @@ static long md_count[2]={0,0};
 static double entropy=0;
 static int initialized=0;
 
+static unsigned int crypto_lock_rand = 0; /* may be set only when a thread
+                                           * holds CRYPTO_LOCK_RAND
+                                           * (to prevent double locking) */
+/* access to lockin_thread is synchronized by CRYPTO_LOCK_RAND2 */
+static unsigned long locking_thread = 0; /* valid iff crypto_lock_rand is set */
+
+
 #ifdef PREDICT
 int rand_predictable=0;
 #endif
@@ -234,6 +184,7 @@ static void ssleay_rand_cleanup(void)
        md_count[0]=0;
        md_count[1]=0;
        entropy=0;
+       initialized=0;
        }
 
 static void ssleay_rand_add(const void *buf, int num, double add)
@@ -241,11 +192,8 @@ static void ssleay_rand_add(const void *buf, int num, double add)
        int i,j,k,st_idx;
        long md_c[2];
        unsigned char local_md[MD_DIGEST_LENGTH];
-       MD_CTX m;
-
-#ifdef NORAND
-       return;
-#endif
+       EVP_MD_CTX m;
+       int do_not_lock;
 
        /*
         * (Based on the rand(3) manpage)
@@ -262,7 +210,17 @@ static void ssleay_rand_add(const void *buf, int num, double add)
          * hash function.
         */
 
-       CRYPTO_w_lock(CRYPTO_LOCK_RAND);
+       /* check if we already have the lock */
+       if (crypto_lock_rand)
+               {
+               CRYPTO_r_lock(CRYPTO_LOCK_RAND2);
+               do_not_lock = (locking_thread == CRYPTO_thread_id());
+               CRYPTO_r_unlock(CRYPTO_LOCK_RAND2);
+               }
+       else
+               do_not_lock = 0;
+
+       if (!do_not_lock) CRYPTO_w_lock(CRYPTO_LOCK_RAND);
        st_idx=state_index;
 
        /* use our own copies of the counters so that even
@@ -294,8 +252,9 @@ static void ssleay_rand_add(const void *buf, int num, double add)
 
        md_count[1] += (num / MD_DIGEST_LENGTH) + (num % MD_DIGEST_LENGTH > 0);
 
-       CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
+       if (!do_not_lock) CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
 
+       EVP_MD_CTX_init(&m);
        for (i=0; i<num; i+=MD_DIGEST_LENGTH)
                {
                j=(num-i);
@@ -314,7 +273,7 @@ static void ssleay_rand_add(const void *buf, int num, double add)
                        
                MD_Update(&m,buf,j);
                MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
-               MD_Final(local_md,&m);
+               MD_Final(&m,local_md);
                md_c[1]++;
 
                buf=(const char *)buf + j;
@@ -334,9 +293,9 @@ static void ssleay_rand_add(const void *buf, int num, double add)
                                st_idx=0;
                        }
                }
-       memset((char *)&m,0,sizeof(m));
+       EVP_MD_CTX_cleanup(&m);
 
-       CRYPTO_w_lock(CRYPTO_LOCK_RAND);
+       if (!do_not_lock) CRYPTO_w_lock(CRYPTO_LOCK_RAND);
        /* Don't just copy back local_md into md -- this could mean that
         * other thread's seeding remains without effect (except for
         * the incremented counter).  By XORing it we keep at least as
@@ -347,9 +306,9 @@ static void ssleay_rand_add(const void *buf, int num, double add)
                }
        if (entropy < ENTROPY_NEEDED) /* stop counting when we have enough */
            entropy += add;
-       CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
+       if (!do_not_lock) CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
        
-#ifndef THREADS        
+#if !defined(OPENSSL_THREADS) && !defined(OPENSSL_SYS_WIN32)
        assert(md_c[1] == md_count[1]);
 #endif
        }
@@ -359,64 +318,15 @@ static void ssleay_rand_seed(const void *buf, int num)
        ssleay_rand_add(buf, num, num);
        }
 
-static void ssleay_rand_initialize(void) /* not exported in RAND_METHOD */
-       {
-       unsigned long l;
-#ifndef GETPID_IS_MEANINGLESS
-       pid_t curr_pid = getpid();
-#endif
-#ifdef DEVRANDOM
-       FILE *fh;
-#endif
-
-#ifdef NORAND
-       return;
-#endif
-
-       CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
-       /* put in some default random data, we need more than just this */
-#ifndef GETPID_IS_MEANINGLESS
-       l=curr_pid;
-       RAND_add(&l,sizeof(l),0);
-       l=getuid();
-       RAND_add(&l,sizeof(l),0);
-#endif
-       l=time(NULL);
-       RAND_add(&l,sizeof(l),0);
-
-#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
-#ifdef PURIFY
-       memset(state,0,STATE_SIZE);
-       memset(md,0,MD_DIGEST_LENGTH);
-#endif
-       CRYPTO_w_lock(CRYPTO_LOCK_RAND);
-       initialized=1;
-       }
-
 static int ssleay_rand_bytes(unsigned char *buf, int num)
        {
        static volatile int stirred_pool = 0;
        int i,j,k,st_num,st_idx;
+       int num_ceil;
        int ok;
        long md_c[2];
        unsigned char local_md[MD_DIGEST_LENGTH];
-       MD_CTX m;
+       EVP_MD_CTX m;
 #ifndef GETPID_IS_MEANINGLESS
        pid_t curr_pid = getpid();
 #endif
@@ -433,19 +343,25 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
                }
 #endif
 
+       if (num <= 0)
+               return 1;
+
+       EVP_MD_CTX_init(&m);
+       /* round upwards to multiple of MD_DIGEST_LENGTH/2 */
+       num_ceil = (1 + (num-1)/(MD_DIGEST_LENGTH/2)) * (MD_DIGEST_LENGTH/2);
+
        /*
         * (Based on the rand(3) manpage:)
         *
         * For each group of 10 bytes (or less), we do the following:
         *
-        * Input into the hash function the top 10 bytes from the
-        * local 'md' (which is initialized from the global 'md'
-        * before any bytes are generated), the bytes that are
-        * to be overwritten by the random bytes, and bytes from the
-        * 'state' (incrementing looping index).  From this digest output
-        * (which is kept in 'md'), the top (up to) 10 bytes are
-        * returned to the caller and the bottom (up to) 10 bytes are xored
-        * into the 'state'.
+        * Input into the hash function the local 'md' (which is initialized from
+        * the global 'md' before any bytes are generated), the bytes that are to
+        * be overwritten by the random bytes, and bytes from the 'state'
+        * (incrementing looping index). From this digest output (which is kept
+        * in 'md'), the top (up to) 10 bytes are returned to the caller and the
+        * bottom 10 bytes are xored into the 'state'.
+        * 
         * Finally, after we have finished 'num' random bytes for the
         * caller, 'count' (which is incremented) and the local and global 'md'
         * are fed into the hash function and the results are kept in the
@@ -454,9 +370,18 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
 
        CRYPTO_w_lock(CRYPTO_LOCK_RAND);
 
-       if (!initialized)
-               ssleay_rand_initialize();
+       /* prevent ssleay_rand_bytes() from trying to obtain the lock again */
+       CRYPTO_w_lock(CRYPTO_LOCK_RAND2);
+       locking_thread = CRYPTO_thread_id();
+       CRYPTO_w_unlock(CRYPTO_LOCK_RAND2);
+       crypto_lock_rand = 1;
 
+       if (!initialized)
+               {
+               RAND_poll();
+               initialized = 1;
+               }
+       
        if (!stirred_pool)
                do_stir_pool = 1;
        
@@ -482,11 +407,11 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
 
        if (do_stir_pool)
                {
-               /* Our output function chains only half of 'md', so we better
-                * make sure that the required entropy gets 'evenly distributed'
-                * through 'state', our randomness pool.  The input function
-                * (ssleay_rand_add) chains all of 'md', which makes it more
-                * suitable for this purpose.
+               /* In the output function only half of 'md' remains secret,
+                * so we better make sure that the required entropy gets
+                * 'evenly distributed' through 'state', our randomness pool.
+                * The input function (ssleay_rand_add) chains all of 'md',
+                * which makes it more suitable for this purpose.
                 */
 
                int n = STATE_SIZE; /* so that the complete pool gets accessed */
@@ -511,18 +436,22 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
        md_c[1] = md_count[1];
        memcpy(local_md, md, sizeof md);
 
-       state_index+=num;
+       state_index+=num_ceil;
        if (state_index > state_num)
                state_index %= state_num;
 
-       /* state[st_idx], ..., state[(st_idx + num - 1) % st_num]
+       /* state[st_idx], ..., state[(st_idx + num_ceil - 1) % st_num]
         * are now ours (but other threads may use them too) */
 
        md_count[0] += 1;
+
+       /* before unlocking, we must clear 'crypto_lock_rand' */
+       crypto_lock_rand = 0;
        CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
 
        while (num > 0)
                {
+               /* num_ceil -= MD_DIGEST_LENGTH/2 */
                j=(num >= MD_DIGEST_LENGTH/2)?MD_DIGEST_LENGTH/2:num;
                num-=j;
                MD_Init(&m);
@@ -533,27 +462,28 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
                        curr_pid = 0;
                        }
 #endif
-               MD_Update(&m,&(local_md[MD_DIGEST_LENGTH/2]),MD_DIGEST_LENGTH/2);
+               MD_Update(&m,local_md,MD_DIGEST_LENGTH);
                MD_Update(&m,(unsigned char *)&(md_c[0]),sizeof(md_c));
 #ifndef PURIFY
                MD_Update(&m,buf,j); /* purify complains */
 #endif
-               k=(st_idx+j)-st_num;
+               k=(st_idx+MD_DIGEST_LENGTH/2)-st_num;
                if (k > 0)
                        {
-                       MD_Update(&m,&(state[st_idx]),j-k);
+                       MD_Update(&m,&(state[st_idx]),MD_DIGEST_LENGTH/2-k);
                        MD_Update(&m,&(state[0]),k);
                        }
                else
-                       MD_Update(&m,&(state[st_idx]),j);
-               MD_Final(local_md,&m);
+                       MD_Update(&m,&(state[st_idx]),MD_DIGEST_LENGTH/2);
+               MD_Final(&m,local_md);
 
-               for (i=0; i<j; i++)
+               for (i=0; i<MD_DIGEST_LENGTH/2; i++)
                        {
                        state[st_idx++]^=local_md[i]; /* may compete with other threads */
-                       *(buf++)=local_md[i+MD_DIGEST_LENGTH/2];
                        if (st_idx >= st_num)
                                st_idx=0;
+                       if (i < j)
+                               *(buf++)=local_md[i+MD_DIGEST_LENGTH/2];
                        }
                }
 
@@ -562,15 +492,17 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
        MD_Update(&m,local_md,MD_DIGEST_LENGTH);
        CRYPTO_w_lock(CRYPTO_LOCK_RAND);
        MD_Update(&m,md,MD_DIGEST_LENGTH);
-       MD_Final(md,&m);
+       MD_Final(&m,md);
        CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
 
-       memset(&m,0,sizeof(m));
+       EVP_MD_CTX_cleanup(&m);
        if (ok)
                return(1);
        else
                {
                RANDerr(RAND_F_SSLEAY_RAND_BYTES,RAND_R_PRNG_NOT_SEEDED);
+               ERR_add_error_data(1, "You need to read the OpenSSL FAQ, "
+                       "http://www.openssl.org/support/faq.html");
                return(0);
                }
        }
@@ -579,7 +511,8 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
    unpredictable */
 static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num) 
        {
-       int ret, err;
+       int ret;
+       unsigned long err;
 
        ret = RAND_bytes(buf, num);
        if (ret == 0)
@@ -595,14 +528,45 @@ static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num)
 static int ssleay_rand_status(void)
        {
        int ret;
+       int do_not_lock;
 
-       CRYPTO_w_lock(CRYPTO_LOCK_RAND);
-
+       /* check if we already have the lock
+        * (could happen if a RAND_poll() implementation calls RAND_status()) */
+       if (crypto_lock_rand)
+               {
+               CRYPTO_r_lock(CRYPTO_LOCK_RAND2);
+               do_not_lock = (locking_thread == CRYPTO_thread_id());
+               CRYPTO_r_unlock(CRYPTO_LOCK_RAND2);
+               }
+       else
+               do_not_lock = 0;
+       
+       if (!do_not_lock)
+               {
+               CRYPTO_w_lock(CRYPTO_LOCK_RAND);
+               
+               /* prevent ssleay_rand_bytes() from trying to obtain the lock again */
+               CRYPTO_w_lock(CRYPTO_LOCK_RAND2);
+               locking_thread = CRYPTO_thread_id();
+               CRYPTO_w_unlock(CRYPTO_LOCK_RAND2);
+               crypto_lock_rand = 1;
+               }
+       
        if (!initialized)
-               ssleay_rand_initialize();
-       ret = entropy >= ENTROPY_NEEDED;
+               {
+               RAND_poll();
+               initialized = 1;
+               }
 
-       CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
+       ret = entropy >= ENTROPY_NEEDED;
 
+       if (!do_not_lock)
+               {
+               /* before unlocking, we must clear 'crypto_lock_rand' */
+               crypto_lock_rand = 0;
+               
+               CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
+               }
+       
        return ret;
        }