See ChangeLog: Sat Jan 16 09:27:30 CET 1999 Werner Koch
[libgcrypt.git] / cipher / random.c
index 5a63719..b0bc832 100644 (file)
@@ -1,14 +1,14 @@
 /* random.c  - random number generator
  *     Copyright (C) 1998 Free Software Foundation, Inc.
  *
- * This file is part of GNUPG.
+ * This file is part of GnuPG.
  *
- * GNUPG is free software; you can redistribute it and/or modify
+ * GnuPG is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
- * GNUPG is distributed in the hope that it will be useful,
+ * GnuPG is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
 
 
 /****************
- * How it works:
- *
- * See Peter Gutmann's Paper: "Software Generation of Practically
- * Strong Random Numbers"
- *
- * fixme!
+ * This random number generator is modelled after the one described
+ * in Peter Gutmann's Paper: "Software Generation of Practically
+ * Strong Random Numbers".
  */
 
 
 #include <stdlib.h>
 #include <assert.h>
 #include <errno.h>
+#include <string.h>
 #include <sys/time.h>
 #include <sys/types.h>
 #include <sys/stat.h>
-#ifndef HAVE_GETTIMEOFTIME
+#include <unistd.h>
+#ifdef HAVE_GETHRTIME
+  #include <sys/times.h>
+#endif
+#ifdef HAVE_GETTIMEOFDAY
   #include <sys/times.h>
 #endif
 #ifdef HAVE_GETRUSAGE
   #include <sys/resource.h>
 #endif
-#include <string.h>
-#include <unistd.h>
-#include <fcntl.h>
 #include "util.h"
-#include "random.h"
 #include "rmd.h"
 #include "ttyio.h"
 #include "i18n.h"
+#include "random.h"
+#include "rand-internal.h"
+#include "dynload.h"
+
 
+#ifndef RAND_MAX   /* for SunOS */
+  #define RAND_MAX 32767
+#endif
+
+
+#if SIZEOF_UNSIGNED_LONG == 8
+  #define ADD_VALUE 0xa5a5a5a5a5a5a5a5
+#elif SIZEOF_UNSIGNED_LONG == 4
+  #define ADD_VALUE 0xa5a5a5a5
+#else
+  #error weird size for an unsigned long
+#endif
 
 #define BLOCKLEN  64   /* hash this amount of bytes */
 #define DIGESTLEN 20   /* into a digest of this length (rmd160) */
   #error Please make sure that poolsize is a multiple of ulong
 #endif
 #define POOLWORDS (POOLSIZE / SIZEOF_UNSIGNED_LONG)
-#if SIZEOF_UNSIGNED_LONG == 8
-  #define ADD_VALUE 0xa5a5a5a5a5a5a5a5
-#elif SIZEOF_UNSIGNED_LONG == 4
-  #define ADD_VALUE 0xa5a5a5a5
-#else
-  #error weird size for an unsigned long
-#endif
-
-struct cache {
-    int len;
-    int size;
-    byte *buffer;
-};
 
 
 static int is_initialized;
-static struct cache cache[3];
 #define MASK_LEVEL(a) do {if( a > 2 ) a = 2; else if( a < 0 ) a = 0; } while(0)
 static char *rndpool;  /* allocated size is POOLSIZE+BLOCKLEN */
 static char *keypool;  /* allocated size is POOLSIZE+BLOCKLEN */
 static size_t pool_readpos;
 static size_t pool_writepos;
 static int pool_filled;
+static int pool_balance;
 static int just_mixed;
 
 static int secure_alloc;
 static int quick_test;
-
+static int faked_rng;
 
 
 static void read_pool( byte *buffer, size_t length, int level );
-static void read_dev_random( byte *buffer, size_t length, int level );
+static void add_randomness( const void *buffer, size_t length, int source );
+static void random_poll(void);
+static void read_random_source( int requester, size_t length, int level);
+static int gather_faked( void (*add)(const void*, size_t, int), int requester,
+                                                   size_t length, int level );
 
 
 static void
@@ -111,6 +116,16 @@ initialize()
     keypool = secure_alloc ? m_alloc_secure_clear(POOLSIZE+BLOCKLEN)
                           : m_alloc_clear(POOLSIZE+BLOCKLEN);
     is_initialized = 1;
+
+  #if  USE_RNDLINUX
+    rndlinux_constructor();
+  #elif USE_RNDUNIX
+    rndunix_constructor();
+  #elif USE_RNDW32
+  #elif USE_RNDOS2
+  #elif USE_RNDATARI
+  #elif USE_RNDMVS
+  #endif
 }
 
 void
@@ -119,50 +134,59 @@ secure_random_alloc()
     secure_alloc = 1;
 }
 
+
 int
 quick_random_gen( int onoff )
 {
-    int last = quick_test;
+    int last;
+
+    read_random_source(0,0,0); /* init */
+    last = quick_test;
     if( onoff != -1 )
        quick_test = onoff;
-  #ifndef HAVE_DEV_RANDOM
-    last = 1; /* insecure RNG */
-  #endif
-    return last;
+    return faked_rng? 1 : last;
 }
 
 
 /****************
- * Fill the buffer with LENGTH bytes of cryptologic strong
+ * Fill the buffer with LENGTH bytes of cryptographically strong
  * random bytes. level 0 is not very strong, 1 is strong enough
  * for most usage, 2 is good for key generation stuff but may be very slow.
  */
 void
 randomize_buffer( byte *buffer, size_t length, int level )
 {
-    for( ; length; length-- )
-       *buffer++ = get_random_byte(level);
+    char *p = get_random_bits( length*8, level, m_is_secure(buffer) );
+    memcpy( buffer, p, length );
+    m_free(p);
 }
 
 
-byte
-get_random_byte( int level )
+int
+random_is_faked()
 {
-    MASK_LEVEL(level);
-    if( !cache[level].len ) {
-       if( !is_initialized )
-           initialize();
-       if( !cache[level].buffer ) {
-           cache[level].size = 100;
-           cache[level].buffer = level && secure_alloc?
-                                        m_alloc_secure( cache[level].size )
-                                      : m_alloc( cache[level].size );
-       }
-       read_pool(cache[level].buffer, cache[level].size, level );
-       cache[level].len = cache[level].size;
-    }
+    if( !is_initialized )
+       initialize();
+    return faked_rng || quick_test;
+}
 
-    return cache[level].buffer[--cache[level].len];
+/****************
+ * Return a pointer to a randomized buffer of level 0 and LENGTH bits
+ * caller must free the buffer.
+ * Note: The returned value is rounded up to bytes.
+ */
+byte *
+get_random_bits( size_t nbits, int level, int secure )
+{
+    byte *buf;
+    size_t nbytes = (nbits+7)/8;
+
+    if( quick_test && level > 1 )
+       level = 1;
+    MASK_LEVEL(level);
+    buf = secure && secure_alloc ? m_alloc_secure( nbytes ) : m_alloc( nbytes );
+    read_pool( buf, nbytes, level );
+    return buf;
 }
 
 
@@ -218,49 +242,70 @@ read_pool( byte *buffer, size_t length, int level )
 
     if( length >= POOLSIZE )
        BUG(); /* not allowed */
-    if( !level ) { /* read simple random bytes */
-       read_dev_random( buffer, length, level );
-       return;
+
+    /* for level 2 make sure that there is enough random in the pool */
+    if( level == 2 && pool_balance < length ) {
+       size_t needed;
+
+       if( pool_balance < 0 )
+           pool_balance = 0;
+       needed = length - pool_balance;
+       if( needed > POOLSIZE )
+           BUG();
+       read_random_source( 3, needed, 2 );
+       pool_balance += needed;
     }
 
-    /* always do a random poll if we need strong numbers */
-    if( pool_filled && level == 2 )
-       random_poll();
     /* make sure the pool is filled */
     while( !pool_filled )
        random_poll();
+
     /* do always a fast random poll */
     fast_random_poll();
 
-    /* mix the pool (if add_randomness() didn't it) */
-    if( !just_mixed )
+    if( !level ) { /* no need for cryptographic strong random */
+       /* create a new pool */
+       for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
+                                   i < POOLWORDS; i++, dp++, sp++ )
+           *dp = *sp + ADD_VALUE;
+       /* must mix both pools */
        mix_pool(rndpool);
-
-    /* create a new pool */
-    for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
-                               i < POOLWORDS; i++, dp++, sp++ )
-       *dp = *sp + ADD_VALUE;
-    /* and mix both pools */
-    mix_pool(rndpool);
-    mix_pool(keypool);
-    /* read the required data
-     * we use a readpoiter to read from a different postion each
-     * time */
-    while( length-- ) {
-       *buffer++ = keypool[pool_readpos++];
-       if( pool_readpos >= POOLSIZE )
-           pool_readpos = 0;
+       mix_pool(keypool);
+       memcpy( buffer, keypool, length );
+    }
+    else {
+       /* mix the pool (if add_randomness() didn't it) */
+       if( !just_mixed )
+           mix_pool(rndpool);
+       /* create a new pool */
+       for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
+                                   i < POOLWORDS; i++, dp++, sp++ )
+           *dp = *sp + ADD_VALUE;
+       /* and mix both pools */
+       mix_pool(rndpool);
+       mix_pool(keypool);
+       /* read the required data
+        * we use a readpoiter to read from a different postion each
+        * time */
+       while( length-- ) {
+           *buffer++ = keypool[pool_readpos++];
+           if( pool_readpos >= POOLSIZE )
+               pool_readpos = 0;
+           pool_balance--;
+       }
+       if( pool_balance < 0 )
+           pool_balance = 0;
+       /* and clear the keypool */
+       memset( keypool, 0, POOLSIZE );
     }
-    /* and clear the keypool */
-    memset( keypool, 0, POOLSIZE );
 }
 
 
 /****************
  * Add LENGTH bytes of randomness from buffer to the pool.
- * source may be used to specify the randomeness source.
+ * source may be used to specify the randomness source.
  */
-void
+static void
 add_randomness( const void *buffer, size_t length, int source )
 {
     if( !is_initialized )
@@ -268,7 +313,8 @@ add_randomness( const void *buffer, size_t length, int source )
     while( length-- ) {
        rndpool[pool_writepos++] = *((byte*)buffer)++;
        if( pool_writepos >= POOLSIZE ) {
-           pool_filled = 1;
+           if( source > 1 )
+               pool_filled = 1;
            pool_writepos = 0;
            mix_pool(rndpool);
            just_mixed = !length;
@@ -278,24 +324,37 @@ add_randomness( const void *buffer, size_t length, int source )
 
 
 
-/********************
- *  FIXME: move these functions to rand_unix.c
- */
-
-void
+static void
 random_poll()
 {
-    char buf[POOLSIZE/5];
-    read_dev_random( buf, POOLSIZE/5, 1 ); /* read /dev/urandom */
-    add_randomness( buf, POOLSIZE/5, 2);
-    memset( buf, 0, POOLSIZE/5);
+    read_random_source( 2, POOLSIZE/5, 1 );
 }
 
 
 void
 fast_random_poll()
 {
-  #ifdef HAVE_GETTIMEOFTIME
+    static void (*fnc)( void (*)(const void*, size_t, int), int) = NULL;
+    static int initialized = 0;
+
+    if( !initialized ) {
+       if( !is_initialized )
+           initialize();
+       initialized = 1;
+       fnc = dynload_getfnc_fast_random_poll();
+    }
+    if( fnc ) {
+       (*fnc)( add_randomness, 1 );
+       return;
+    }
+
+    /* fall back to the generic function */
+  #if HAVE_GETHRTIME
+    {  hrtime_t tv;
+       tv = gethrtime();
+       add_randomness( &tv, sizeof(tv), 1 );
+    }
+  #elif HAVE_GETTIMEOFDAY
     {  struct timeval tv;
        if( gettimeofday( &tv, NULL ) )
            BUG();
@@ -319,108 +378,40 @@ fast_random_poll()
 }
 
 
-#ifdef HAVE_DEV_RANDOM
-
-static int
-open_device( const char *name, int minor )
-{
-    int fd;
-    struct stat sb;
-
-    fd = open( name, O_RDONLY );
-    if( fd == -1 )
-       log_fatal("can't open %s: %s\n", name, strerror(errno) );
-    if( fstat( fd, &sb ) )
-       log_fatal("stat() off %s failed: %s\n", name, strerror(errno) );
-  #if defined(__sparc__) && defined(__linux__)
-    #warning something is wrong with UltraPenguin /dev/random
-  #else
-    if( !S_ISCHR(sb.st_mode) )
-       log_fatal("invalid random device!\n" );
-  #endif
-    return fd;
-}
-
 
 static void
-read_dev_random( byte *buffer, size_t length, int level )
+read_random_source( int requester, size_t length, int level )
 {
-    static int fd_urandom = -1;
-    static int fd_random = -1;
-    int fd;
-    int n;
-    int warn=0;
-
-    if( level == 2 && !quick_test ) {
-       if( fd_random == -1 )
-           fd_random = open_device( "/dev/random", 8 );
-       fd = fd_random;
-    }
-    else {
-       /* fixme: we should use a simpler one for level 0,
-        * because reading from /dev/urandom removes entropy
-        * and the next read on /dev/random may have to wait */
-       if( fd_urandom == -1 )
-           fd_urandom = open_device( "/dev/urandom", 9 );
-       fd = fd_urandom;
-    }
-
-
-    do {
-       fd_set rfds;
-       struct timeval tv;
-       int rc;
-
-       FD_ZERO(&rfds);
-       FD_SET(fd, &rfds);
-       tv.tv_sec = 3;
-       tv.tv_usec = 0;
-       if( !(rc=select(fd+1, &rfds, NULL, NULL, &tv)) ) {
-           if( !warn )
-               tty_printf( _(
-"\n"
-"Not enough random bytes available.  Please do some other work to give\n"
-"the OS a chance to collect more entropy! (Need %d more bytes)\n"), length );
-           warn = 1;
-           continue;
-       }
-       else if( rc == -1 ) {
-           tty_printf("select() error: %s\n", strerror(errno));
-           continue;
+    static int (*fnc)(void (*)(const void*, size_t, int), int,
+                                                   size_t, int) = NULL;
+    if( !fnc ) {
+       if( !is_initialized )
+           initialize();
+       fnc = dynload_getfnc_gather_random();
+       if( !fnc ) {
+           faked_rng = 1;
+           fnc = gather_faked;
        }
-
-       assert( length < 500 );
-       do {
-           n = read(fd, buffer, length );
-           if( n >= 0 && n > length ) {
-               log_error("bogus read from random device (n=%d)\n", n );
-               n = length;
-           }
-       } while( n == -1 && errno == EINTR );
-       if( n == -1 )
-           log_fatal("read error on random device: %s\n", strerror(errno) );
-       assert( n <= length );
-       buffer += n;
-       length -= n;
-    } while( length );
+       if( !requester && !length && !level )
+           return; /* init only */
+    }
+    if( (*fnc)( add_randomness, requester, length, level ) < 0 )
+       log_fatal("No way to gather entropy for the RNG\n");
 }
 
-#else /* not HAVE_DEV_RANDOM */
 
-
-#ifndef RAND_MAX   /* for SunOS */
-  #define RAND_MAX 32767
-#endif
-
-static void
-read_dev_random( byte *buffer, size_t length, int level )
+static int
+gather_faked( void (*add)(const void*, size_t, int), int requester,
+             size_t length, int level )
 {
     static int initialized=0;
+    size_t n;
+    char *buffer, *p;
 
     if( !initialized ) {
-       log_info(_("warning: using insecure random number generator!!\n"));
+       log_info(_("WARNING: using insecure random number generator!!\n"));
        tty_printf(_("The random number generator is only a kludge to let\n"
-                  "it compile - it is in no way a strong RNG!\n\n"
+                  "it run - it is in no way a strong RNG!\n\n"
                   "DON'T USE ANY DATA GENERATED BY THIS PROGRAM!!\n\n"));
        initialized=1;
       #ifdef HAVE_RAND
@@ -430,14 +421,17 @@ read_dev_random( byte *buffer, size_t length, int level )
       #endif
     }
 
+    p = buffer = m_alloc( length );
+    n = length;
   #ifdef HAVE_RAND
-    while( length-- )
-       *buffer++ = ((unsigned)(1 + (int) (256.0*rand()/(RAND_MAX+1.0)))-1);
+    while( n-- )
+       *p++ = ((unsigned)(1 + (int) (256.0*rand()/(RAND_MAX+1.0)))-1);
   #else
-    while( length-- )
-       *buffer++ = ((unsigned)(1 + (int) (256.0*random()/(RAND_MAX+1.0)))-1);
+    while( n-- )
+       *p++ = ((unsigned)(1 + (int) (256.0*random()/(RAND_MAX+1.0)))-1);
   #endif
+    add_randomness( buffer, length, requester );
+    m_free(buffer);
+    return 0; /* okay */
 }
 
-#endif
-