handle entropy estimate correctly
[openssl.git] / crypto / rand / md_rand.c
index dbed1dcde26c10f0c6275b08b64cafe774d4505c..6b158f034953ec1477834d985af6d38b8b42656d 100644 (file)
@@ -56,7 +56,7 @@
  * [including the GNU Public Licence.]
  */
 
-#define ENTROPY_NEEDED 32  /* require 128 bits of randomness */
+#define ENTROPY_NEEDED 16  /* require 128 bits = 16 bytes of randomness */
 
 #ifndef MD_RAND_DEBUG
 # ifndef NDEBUG
@@ -138,20 +138,23 @@ static int state_num=0,state_index=0;
 static unsigned char state[STATE_SIZE+MD_DIGEST_LENGTH];
 static unsigned char md[MD_DIGEST_LENGTH];
 static long md_count[2]={0,0};
-static int entropy=0;
+static double entropy=0;
+static int initialized=0;
 
 const char *RAND_version="RAND" OPENSSL_VERSION_PTEXT;
 
 static void ssleay_rand_cleanup(void);
 static void ssleay_rand_seed(const void *buf, int num);
-static void ssleay_rand_add(const void *buf, int num, int add_entropy);
+static void ssleay_rand_add(const void *buf, int num, double add_entropy);
 static int ssleay_rand_bytes(unsigned char *buf, int num);
+static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num);
 
 RAND_METHOD rand_ssleay_meth={
        ssleay_rand_seed,
        ssleay_rand_bytes,
        ssleay_rand_cleanup,
        ssleay_rand_add,
+       ssleay_rand_pseudo_bytes,
        }; 
 
 RAND_METHOD *RAND_SSLeay(void)
@@ -170,7 +173,7 @@ static void ssleay_rand_cleanup(void)
        entropy=0;
        }
 
-static void ssleay_rand_add(const void *buf, int num, int add)
+static void ssleay_rand_add(const void *buf, int num, double add)
        {
        int i,j,k,st_idx;
        long md_c[2];
@@ -182,17 +185,18 @@ static void ssleay_rand_add(const void *buf, int num, int add)
 #endif
 
        /*
-        * (Based on doc/ssleay.txt, section rand.doc:)
+        * (Based on the rand(3) manpage)
         *
-        * The input is chopped up into units of 16 bytes (or less for
-        * the last block).  Each of these blocks is run through the MD5
-        * message digest as follow:  The data passed to the MD5 digest
+        * The input is chopped up into units of 20 bytes (or less for
+        * the last block).  Each of these blocks is run through the hash
+        * function as follows:  The data passed to the hash function
         * is the current 'md', the same number of bytes from the 'state'
         * (the location determined by in incremented looping index) as
         * the current 'block', the new key data 'block', and 'count'
         * (which is incremented after each use).
         * The result of this is kept in 'md' and also xored into the
-        * 'state' at the same locations that were used as input into the MD5.
+        * 'state' at the same locations that were used as input into the
+         * hash function.
         */
 
        CRYPTO_w_lock(CRYPTO_LOCK_RAND);
@@ -278,12 +282,13 @@ static void ssleay_rand_add(const void *buf, int num, int add)
                {
                md[k] ^= local_md[k];
                }
+       if (entropy < ENTROPY_NEEDED) /* stop counting when we have enough */
+           entropy += add;
        CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
        
 #ifndef THREADS        
        assert(md_c[1] == md_count[1]);
 #endif
-       entropy += add;
        }
 
 static void ssleay_rand_seed(const void *buf, int num)
@@ -291,6 +296,52 @@ static void ssleay_rand_seed(const void *buf, int num)
        ssleay_rand_add(buf, num, num);
        }
 
+static void ssleay_rand_initialize(void)
+       {
+       unsigned long l;
+#ifndef GETPID_IS_MEANINGLESS
+       pid_t curr_pid = getpid();
+#endif
+#ifdef DEVRANDOM
+       FILE *fh;
+#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)
        {
        int i,j,k,st_num,st_idx;
@@ -298,14 +349,9 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
        long md_c[2];
        unsigned char local_md[MD_DIGEST_LENGTH];
        MD_CTX m;
-       static int init=1;
-       unsigned long l;
 #ifndef GETPID_IS_MEANINGLESS
        pid_t curr_pid = getpid();
 #endif
-#ifdef DEVRANDOM
-       FILE *fh;
-#endif
 
 #ifdef PREDICT
        {
@@ -318,67 +364,44 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
 #endif
 
        /*
-        * (Based on doc/ssleay.txt, section rand.doc:)
+        * (Based on the rand(3) manpage:)
         *
-        * For each group of 8 bytes (or less), we do the following,
+        * For each group of 10 bytes (or less), we do the following:
         *
-        * Input into MD5, the top 8 bytes from 'md', the byte that are
-        * to be overwritten by the random bytes and bytes from the
+        * 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 (upto) 8 bytes are
-        * returned to the caller and the bottom (upto) 8 bytes are xored
+        * (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'.
         * Finally, after we have finished 'num' random bytes for the
-        * caller, 'count' (which is incremented) and the local and globl 'md'
-        * are fed into MD5 and the results are kept in the global 'md'.
+        * caller, 'count' (which is incremented) and the local and global 'md'
+        * are fed into the hash function and the results are kept in the
+        * global 'md'.
         */
 
        CRYPTO_w_lock(CRYPTO_LOCK_RAND);
 
-       if (init)
-               {
-               CRYPTO_w_unlock(CRYPTO_LOCK_RAND);
-               /* put in some default random data, we need more than
-                * just this */
-               RAND_add(&m,sizeof(m),0);
-#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);
+       if (!initialized)
+               ssleay_rand_initialize();
 
-#ifdef DEVRANDOM
-               /* 
-                * Use a random entropy pool device.
-                * Linux 1.3.x and FreeBSD-Current has 
-                * this. Use /dev/urandom if you can
-                * as /dev/random will block if it runs out
-                * of random entries.
+       ok = (entropy >= ENTROPY_NEEDED);
+       if (!ok)
+               {
+               /* If the PRNG state is not yet unpredictable, then seeing
+                * the PRNG output may help attackers to determine the new
+                * state; thus we have to decrease the entropy estimate.
+                * Once we've had enough initial seeding we don't bother to
+                * adjust the entropy count, though, because we're not ambitious
+                * to provide *information-theoretic* randomness.
                 */
-               if ((fh = fopen(DEVRANDOM, "r")) != NULL)
-                       {
-                       unsigned char tmpbuf[ENTROPY_NEEDED];
-                       int n;
-
-                       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);
-               init=0;
+               entropy -= num;
+               if (entropy < 0)
+                       entropy = 0;
                }
 
-       ok = (entropy >= ENTROPY_NEEDED);
-
        st_idx=state_index;
        st_num=state_num;
        md_c[0] = md_count[0];
@@ -449,6 +472,30 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
                }
        }
 
+/* pseudo-random bytes that are guaranteed to be unique but not
+   unpredictable */
+static int ssleay_rand_pseudo_bytes(unsigned char *buf, int num) 
+       {
+       int ret, err;
+
+       ret = RAND_bytes(buf, num);
+       if (ret == 0)
+               {
+               err = ERR_peek_error();
+               if (ERR_GET_LIB(err) == ERR_LIB_RAND &&
+                   ERR_GET_REASON(err) == RAND_R_PRNG_NOT_SEEDED)
+                       (void)ERR_get_error();
+               }
+       return (ret);
+       }
+
+int RAND_status(void)
+       {
+       if (!initialized)
+               ssleay_rand_initialize();
+       return (entropy >= ENTROPY_NEEDED);
+       }
+
 #ifdef WINDOWS
 #include <windows.h>
 #include <openssl/rand.h>
@@ -473,12 +520,12 @@ static int ssleay_rand_bytes(unsigned char *buf, int num)
  */
 /*
  * I have modified the loading of bytes via RAND_seed() mechanism since
- * the origional would have been very very CPU intensive since RAND_seed()
+ * the original would have been very very CPU intensive since RAND_seed()
  * does an MD5 per 16 bytes of input.  The cost to digest 16 bytes is the same
  * as that to digest 56 bytes.  So under the old system, a screen of
- * 1024*768*256 would have been CPU cost of approximatly 49,000 56 byte MD5
+ * 1024*768*256 would have been CPU cost of approximately 49,000 56 byte MD5
  * digests or digesting 2.7 mbytes.  What I have put in place would
- * be 48 16k MD5 digests, or efectivly 48*16+48 MD5 bytes or 816 kbytes
+ * be 48 16k MD5 digests, or effectively 48*16+48 MD5 bytes or 816 kbytes
  * or about 3.5 times as much.
  * - eric 
  */