See ChangeLog: Fri Jul 14 19:38:23 CEST 2000 Werner Koch
[gnupg.git] / cipher / random.c
1 /* random.c  -  random number generator
2  *      Copyright (C) 1998, 2000 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21
22 /****************
23  * This random number generator is modelled after the one described
24  * in Peter Gutmann's Paper: "Software Generation of Practically
25  * Strong Random Numbers".
26  */
27
28
29 #include <config.h>
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <assert.h>
33 #include <errno.h>
34 #include <string.h>
35 #include <sys/time.h>
36 #include <sys/types.h>
37 #include <sys/stat.h>
38 #include <unistd.h>
39 #include <fcntl.h>
40 #ifdef  HAVE_GETHRTIME
41   #include <sys/times.h>
42 #endif
43 #ifdef HAVE_GETTIMEOFDAY
44   #include <sys/times.h>
45 #endif
46 #ifdef HAVE_CLOCK_GETTIME
47   #include <time.h>
48 #endif
49 #ifdef HAVE_GETRUSAGE
50   #include <sys/resource.h>
51 #endif
52 #ifdef __MINGW32__
53   #include <process.h>
54 #endif
55 #include "g10lib.h"
56 #include "rmd.h"
57 #include "random.h"
58 #include "rand-internal.h"
59 #include "dynload.h"
60
61
62 #ifndef RAND_MAX   /* for SunOS */
63   #define RAND_MAX 32767
64 #endif
65
66
67 #if SIZEOF_UNSIGNED_LONG == 8
68   #define ADD_VALUE 0xa5a5a5a5a5a5a5a5
69 #elif SIZEOF_UNSIGNED_LONG == 4
70   #define ADD_VALUE 0xa5a5a5a5
71 #else
72   #error weird size for an unsigned long
73 #endif
74
75 #define BLOCKLEN  64   /* hash this amount of bytes */
76 #define DIGESTLEN 20   /* into a digest of this length (rmd160) */
77 /* poolblocks is the number of digests which make up the pool
78  * and poolsize must be a multiple of the digest length
79  * to make the AND operations faster, the size should also be
80  * a multiple of ulong
81  */
82 #define POOLBLOCKS 30
83 #define POOLSIZE (POOLBLOCKS*DIGESTLEN)
84 #if (POOLSIZE % SIZEOF_UNSIGNED_LONG)
85   #error Please make sure that poolsize is a multiple of ulong
86 #endif
87 #define POOLWORDS (POOLSIZE / SIZEOF_UNSIGNED_LONG)
88
89
90 static int is_initialized;
91 #define MASK_LEVEL(a) do {if( a > 2 ) a = 2; else if( a < 0 ) a = 0; } while(0)
92 static char *rndpool;   /* allocated size is POOLSIZE+BLOCKLEN */
93 static char *keypool;   /* allocated size is POOLSIZE+BLOCKLEN */
94 static size_t pool_readpos;
95 static size_t pool_writepos;
96 static int pool_filled;
97 static int pool_balance;
98 static int just_mixed;
99 static int did_initial_extra_seeding;
100 static char *seed_file_name;
101 static int allow_seed_file_update;
102
103 static int secure_alloc;
104 static int quick_test;
105 static int faked_rng;
106
107
108 static byte *get_random_bytes( size_t nbytes, int level, int secure );
109 static void read_pool( byte *buffer, size_t length, int level );
110 static void add_randomness( const void *buffer, size_t length, int source );
111 static void random_poll(void);
112 static void read_random_source( int requester, size_t length, int level);
113 static int gather_faked( void (*add)(const void*, size_t, int), int requester,
114                                                     size_t length, int level );
115
116 static struct {
117     ulong mixrnd;
118     ulong mixkey;
119     ulong slowpolls;
120     ulong fastpolls;
121     ulong getbytes1;
122     ulong ngetbytes1;
123     ulong getbytes2;
124     ulong ngetbytes2;
125     ulong addbytes;
126     ulong naddbytes;
127 } rndstats;
128
129 static void
130 initialize(void)
131 {
132     /* The data buffer is allocated somewhat larger, so that
133      * we can use this extra space (which is allocated in secure memory)
134      * as a temporary hash buffer */
135     rndpool = secure_alloc ? g10_xcalloc_secure(1,POOLSIZE+BLOCKLEN)
136                            : g10_xcalloc(1,POOLSIZE+BLOCKLEN);
137     keypool = secure_alloc ? g10_xcalloc_secure(1,POOLSIZE+BLOCKLEN)
138                            : g10_xcalloc(1,POOLSIZE+BLOCKLEN);
139     is_initialized = 1;
140     cipher_modules_constructor();
141 }
142
143
144 void
145 random_dump_stats()
146 {
147     fprintf(stderr,
148             "random usage: poolsize=%d mixed=%lu polls=%lu/%lu added=%lu/%lu\n"
149             "              outmix=%lu getlvl1=%lu/%lu getlvl2=%lu/%lu\n",
150         POOLSIZE, rndstats.mixrnd, rndstats.slowpolls, rndstats.fastpolls,
151                   rndstats.naddbytes, rndstats.addbytes,
152         rndstats.mixkey, rndstats.ngetbytes1, rndstats.getbytes1,
153                     rndstats.ngetbytes2, rndstats.getbytes2 );
154 }
155
156 void
157 secure_random_alloc()
158 {
159     secure_alloc = 1;
160 }
161
162
163 int
164 quick_random_gen( int onoff )
165 {
166     int last;
167
168     read_random_source(0,0,0); /* init */
169     last = quick_test;
170     if( onoff != -1 )
171         quick_test = onoff;
172     return faked_rng? 1 : last;
173 }
174
175
176 /****************
177  * Fill the buffer with LENGTH bytes of cryptographically strong
178  * random bytes. level 0 is not very strong, 1 is strong enough
179  * for most usage, 2 is good for key generation stuff but may be very slow.
180  */
181 void
182 gcry_randomize( byte *buffer, size_t length, enum gcry_random_level level )
183 {
184     char *p = get_random_bytes( length, level, 1 );
185     memcpy( buffer, p, length );
186     g10_free(p);
187 }
188
189
190 int
191 random_is_faked()
192 {
193     if( !is_initialized )
194         initialize();
195     return faked_rng || quick_test;
196 }
197
198 /****************
199  * Return a pointer to a randomized buffer of level 0 and LENGTH bits
200  * caller must free the buffer.
201  * Note: The returned value is rounded up to bytes.
202  */
203 static byte *
204 get_random_bytes( size_t nbytes, int level, int secure )
205 {
206     byte *buf, *p;
207
208     if( quick_test && level > 1 )
209         level = 1;
210     MASK_LEVEL(level);
211     if( level == 1 ) {
212         rndstats.getbytes1 += nbytes;
213         rndstats.ngetbytes1++;
214     }
215     else if( level >= 2 ) {
216         rndstats.getbytes2 += nbytes;
217         rndstats.ngetbytes2++;
218     }
219
220     buf = secure && secure_alloc ? g10_xmalloc_secure( nbytes )
221                                  : g10_xmalloc( nbytes );
222     for( p = buf; nbytes > 0; ) {
223         size_t n = nbytes > POOLSIZE? POOLSIZE : nbytes;
224         read_pool( p, n, level );
225         nbytes -= n;
226         p += n;
227     }
228     return buf;
229 }
230
231 void *
232 gcry_random_bytes( size_t nbytes, enum gcry_random_level level )
233 {
234     return get_random_bytes( nbytes, level, 0 );
235 }
236
237 void *
238 gcry_random_bytes_secure( size_t nbytes, enum gcry_random_level level )
239 {
240     return get_random_bytes( nbytes, level, 1 );
241 }
242
243
244 /****************
245  * Mix the pool
246  */
247 static void
248 mix_pool(byte *pool)
249 {
250     char *hashbuf = pool + POOLSIZE;
251     char *p, *pend;
252     int i, n;
253     RMD160_CONTEXT md;
254
255     rmd160_init( &md );
256  #if DIGESTLEN != 20
257     #error must have a digest length of 20 for ripe-md-160
258  #endif
259     /* loop over the pool */
260     pend = pool + POOLSIZE;
261     memcpy(hashbuf, pend - DIGESTLEN, DIGESTLEN );
262     memcpy(hashbuf+DIGESTLEN, pool, BLOCKLEN-DIGESTLEN);
263     rmd160_mixblock( &md, hashbuf);
264     memcpy(pool, hashbuf, 20 );
265
266     p = pool;
267     for( n=1; n < POOLBLOCKS; n++ ) {
268         memcpy(hashbuf, p, DIGESTLEN );
269
270         p += DIGESTLEN;
271         if( p+DIGESTLEN+BLOCKLEN < pend )
272             memcpy(hashbuf+DIGESTLEN, p+DIGESTLEN, BLOCKLEN-DIGESTLEN);
273         else {
274             char *pp = p+DIGESTLEN;
275             for(i=DIGESTLEN; i < BLOCKLEN; i++ ) {
276                 if( pp >= pend )
277                     pp = pool;
278                 hashbuf[i] = *pp++;
279             }
280         }
281
282         rmd160_mixblock( &md, hashbuf);
283         memcpy(p, hashbuf, 20 );
284     }
285 }
286
287 void
288 set_random_seed_file( const char *name )
289 {
290     if( seed_file_name )
291         BUG();
292     seed_file_name = g10_xstrdup( name );
293 }
294
295 /****************
296  * Read in a seed form the random_seed file
297  * and return true if this was successful
298  */
299 static int
300 read_seed_file()
301 {
302     int fd;
303     struct stat sb;
304     unsigned char buffer[POOLSIZE];
305     int n;
306
307     if( !seed_file_name )
308         return 0;
309
310   #ifdef HAVE_DOSISH_SYSTEM
311     fd = open( seed_file_name, O_RDONLY | O_BINARY );
312   #else
313     fd = open( seed_file_name, O_RDONLY );
314   #endif
315     if( fd == -1 && errno == ENOENT) {
316         allow_seed_file_update = 1;
317         return 0;
318     }
319
320     if( fd == -1 ) {
321         log_info(_("can't open `%s': %s\n"), seed_file_name, strerror(errno) );
322         return 0;
323     }
324     if( fstat( fd, &sb ) ) {
325         log_info(_("can't stat `%s': %s\n"), seed_file_name, strerror(errno) );
326         close(fd);
327         return 0;
328     }
329     if( !S_ISREG(sb.st_mode) ) {
330         log_info(_("`%s' is not a regular file - ignored\n"), seed_file_name );
331         close(fd);
332         return 0;
333     }
334     if( !sb.st_size ) {
335         log_info(_("note: random_seed file is empty\n") );
336         close(fd);
337         allow_seed_file_update = 1;
338         return 0;
339     }
340     if( sb.st_size != POOLSIZE ) {
341         log_info(_("warning: invalid size of random_seed file - not used\n") );
342         close(fd);
343         return 0;
344     }
345     do {
346         n = read( fd, buffer, POOLSIZE );
347     } while( n == -1 && errno == EINTR );
348     if( n != POOLSIZE ) {
349         log_fatal(_("can't read `%s': %s\n"), seed_file_name,strerror(errno) );
350         close(fd);
351         return 0;
352     }
353
354     close(fd);
355
356     add_randomness( buffer, POOLSIZE, 0 );
357     /* add some minor entropy to the pool now (this will also force a mixing) */
358     {   pid_t x = getpid();
359         add_randomness( &x, sizeof(x), 0 );
360     }
361     {   time_t x = time(NULL);
362         add_randomness( &x, sizeof(x), 0 );
363     }
364     {   clock_t x = clock();
365         add_randomness( &x, sizeof(x), 0 );
366     }
367     /* And read a few bytes from our entropy source.  By using
368      * a level of 0 this will not block and might not return anything
369      * with some entropy drivers, however the rndlinux driver will use
370      * /dev/urandom and return some stuff - Do not read to much as we
371      * want to be friendly to the scare system entropy resource. */
372     read_random_source( 0, 16, 0 );
373
374     allow_seed_file_update = 1;
375     return 1;
376 }
377
378 void
379 update_random_seed_file()
380 {
381     ulong *sp, *dp;
382     int fd, i;
383
384     if( !seed_file_name || !is_initialized || !pool_filled )
385         return;
386     if( !allow_seed_file_update ) {
387         log_info(_("note: random_seed file not updated\n"));
388         return;
389     }
390
391
392     /* copy the entropy pool to a scratch pool and mix both of them */
393     for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
394                                     i < POOLWORDS; i++, dp++, sp++ ) {
395         *dp = *sp + ADD_VALUE;
396     }
397     mix_pool(rndpool); rndstats.mixrnd++;
398     mix_pool(keypool); rndstats.mixkey++;
399
400   #ifdef HAVE_DOSISH_SYSTEM
401     fd = open( seed_file_name, O_WRONLY|O_CREAT|O_TRUNC|O_BINARY,
402                                                         S_IRUSR|S_IWUSR );
403   #else
404     fd = open( seed_file_name, O_WRONLY|O_CREAT|O_TRUNC, S_IRUSR|S_IWUSR );
405   #endif
406     if( fd == -1 ) {
407         log_info(_("can't create `%s': %s\n"), seed_file_name, strerror(errno) );
408         return;
409     }
410     do {
411         i = write( fd, keypool, POOLSIZE );
412     } while( i == -1 && errno == EINTR );
413     if( i != POOLSIZE ) {
414         log_info(_("can't write `%s': %s\n"), seed_file_name, strerror(errno) );
415     }
416     if( close(fd) )
417         log_info(_("can't close `%s': %s\n"), seed_file_name, strerror(errno) );
418 }
419
420
421 static void
422 read_pool( byte *buffer, size_t length, int level )
423 {
424     int i;
425     ulong *sp, *dp;
426
427     if( length >= POOLSIZE ) {
428         log_fatal(_("too many random bits requested; the limit is %d\n"),
429                   POOLSIZE*8-1 );
430     }
431
432     if( !pool_filled ) {
433         if( read_seed_file() )
434             pool_filled = 1;
435     }
436
437     /* For level 2 quality (key generation) we alwas make
438      * sure that the pool has been seeded enough initially */
439     if( level == 2 && !did_initial_extra_seeding ) {
440         size_t needed;
441
442         pool_balance = 0;
443         needed = length - pool_balance;
444         if( needed < POOLSIZE/2 )
445             needed = POOLSIZE/2;
446         else if( needed > POOLSIZE )
447             BUG();
448         read_random_source( 3, needed, 2 );
449         pool_balance += needed;
450         did_initial_extra_seeding=1;
451     }
452
453     /* for level 2 make sure that there is enough random in the pool */
454     if( level == 2 && pool_balance < length ) {
455         size_t needed;
456
457         if( pool_balance < 0 )
458             pool_balance = 0;
459         needed = length - pool_balance;
460         if( needed > POOLSIZE )
461             BUG();
462         read_random_source( 3, needed, 2 );
463         pool_balance += needed;
464     }
465
466     /* make sure the pool is filled */
467     while( !pool_filled )
468         random_poll();
469
470     /* do always a fast random poll */
471     fast_random_poll();
472
473     if( !level ) { /* no need for cryptographic strong random */
474         /* create a new pool */
475         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
476                                     i < POOLWORDS; i++, dp++, sp++ )
477             *dp = *sp + ADD_VALUE;
478         /* must mix both pools */
479         mix_pool(rndpool); rndstats.mixrnd++;
480         mix_pool(keypool); rndstats.mixkey++;
481         memcpy( buffer, keypool, length );
482     }
483     else {
484         /* mix the pool (if add_randomness() didn't it) */
485         if( !just_mixed ) {
486             mix_pool(rndpool);
487             rndstats.mixrnd++;
488         }
489         /* create a new pool */
490         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
491                                     i < POOLWORDS; i++, dp++, sp++ )
492             *dp = *sp + ADD_VALUE;
493         /* and mix both pools */
494         mix_pool(rndpool); rndstats.mixrnd++;
495         mix_pool(keypool); rndstats.mixkey++;
496         /* read the required data
497          * we use a readpoiter to read from a different postion each
498          * time */
499         while( length-- ) {
500             *buffer++ = keypool[pool_readpos++];
501             if( pool_readpos >= POOLSIZE )
502                 pool_readpos = 0;
503             pool_balance--;
504         }
505         if( pool_balance < 0 )
506             pool_balance = 0;
507         /* and clear the keypool */
508         memset( keypool, 0, POOLSIZE );
509     }
510 }
511
512
513 /****************
514  * Add LENGTH bytes of randomness from buffer to the pool.
515  * source may be used to specify the randomness source.
516  * Source is:
517  *      0 - used ony for initialization
518  *      1 - fast random poll function
519  *      2 - normal poll function
520  *      3 - used when level 2 random quality has been requested
521  *          to do an extra pool seed.
522  */
523 static void
524 add_randomness( const void *buffer, size_t length, int source )
525 {
526     const byte *p = buffer;
527
528     if( !is_initialized )
529         initialize();
530     rndstats.addbytes += length;
531     rndstats.naddbytes++;
532     while( length-- ) {
533         rndpool[pool_writepos++] = *p++;
534         if( pool_writepos >= POOLSIZE ) {
535             if( source > 1 )
536                 pool_filled = 1;
537             pool_writepos = 0;
538             mix_pool(rndpool); rndstats.mixrnd++;
539             just_mixed = !length;
540         }
541     }
542 }
543
544
545
546 static void
547 random_poll()
548 {
549     rndstats.slowpolls++;
550     read_random_source( 2, POOLSIZE/5, 1 );
551 }
552
553
554 void
555 fast_random_poll()
556 {
557     static void (*fnc)( void (*)(const void*, size_t, int), int) = NULL;
558     static int initialized = 0;
559
560     rndstats.fastpolls++;
561     if( !initialized ) {
562         if( !is_initialized )
563             initialize();
564         initialized = 1;
565         fnc = dynload_getfnc_fast_random_poll();
566     }
567     if( fnc ) {
568         (*fnc)( add_randomness, 1 );
569         return;
570     }
571
572     /* fall back to the generic function */
573   #if HAVE_GETHRTIME
574     {   hrtime_t tv;
575         tv = gethrtime();
576         add_randomness( &tv, sizeof(tv), 1 );
577     }
578   #elif HAVE_GETTIMEOFDAY
579     {   struct timeval tv;
580         if( gettimeofday( &tv, NULL ) )
581             BUG();
582         add_randomness( &tv.tv_sec, sizeof(tv.tv_sec), 1 );
583         add_randomness( &tv.tv_usec, sizeof(tv.tv_usec), 1 );
584     }
585   #elif HAVE_CLOCK_GETTIME
586     {   struct timespec tv;
587         if( clock_gettime( CLOCK_REALTIME, &tv ) == -1 )
588             BUG();
589         add_randomness( &tv.tv_sec, sizeof(tv.tv_sec), 1 );
590         add_randomness( &tv.tv_nsec, sizeof(tv.tv_nsec), 1 );
591     }
592   #else /* use times */
593     #ifndef HAVE_DOSISH_SYSTEM
594     {   struct tms buf;
595         times( &buf );
596         add_randomness( &buf, sizeof buf, 1 );
597     }
598     #endif
599   #endif
600   #ifdef HAVE_GETRUSAGE
601     #ifndef RUSAGE_SELF
602       #ifdef __GCC__
603         #warning There is no RUSAGE_SELF on this system
604       #endif
605     #else
606     {   struct rusage buf;
607         if( getrusage( RUSAGE_SELF, &buf ) )
608             BUG();
609         add_randomness( &buf, sizeof buf, 1 );
610         memset( &buf, 0, sizeof buf );
611     }
612     #endif
613   #endif
614     /* time and clock are availabe on all systems - so
615      * we better do it just in case one of the above functions
616      * didn't work */
617     {   time_t x = time(NULL);
618         add_randomness( &x, sizeof(x), 1 );
619     }
620     {   clock_t x = clock();
621         add_randomness( &x, sizeof(x), 1 );
622     }
623 }
624
625
626
627 static void
628 read_random_source( int requester, size_t length, int level )
629 {
630     static int (*fnc)(void (*)(const void*, size_t, int), int,
631                                                     size_t, int) = NULL;
632     if( !fnc ) {
633         if( !is_initialized )
634             initialize();
635         fnc = dynload_getfnc_gather_random();
636         if( !fnc ) {
637             faked_rng = 1;
638             fnc = gather_faked;
639         }
640         if( !requester && !length && !level )
641             return; /* init only */
642     }
643     if( (*fnc)( add_randomness, requester, length, level ) < 0 )
644         log_fatal("No way to gather entropy for the RNG\n");
645 }
646
647
648 static int
649 gather_faked( void (*add)(const void*, size_t, int), int requester,
650               size_t length, int level )
651 {
652     static int initialized=0;
653     size_t n;
654     char *buffer, *p;
655
656     if( !initialized ) {
657         log_info(_("WARNING: using insecure random number generator!!\n"));
658         /* we can't use tty_printf here - do we need this function at
659           all - does it really make sense or canit be viewed as a potential
660           security problem ? wk 17.11.99 */
661         #warning Extended warning disabled
662       #if 0
663         tty_printf(_("The random number generator is only a kludge to let\n"
664                    "it run - it is in no way a strong RNG!\n\n"
665                    "DON'T USE ANY DATA GENERATED BY THIS PROGRAM!!\n\n"));
666       #endif
667         initialized=1;
668       #ifdef HAVE_RAND
669         srand(make_timestamp()*getpid());
670       #else
671         srandom(make_timestamp()*getpid());
672       #endif
673     }
674
675     p = buffer = g10_xmalloc( length );
676     n = length;
677   #ifdef HAVE_RAND
678     while( n-- )
679         *p++ = ((unsigned)(1 + (int) (256.0*rand()/(RAND_MAX+1.0)))-1);
680   #else
681     while( n-- )
682         *p++ = ((unsigned)(1 + (int) (256.0*random()/(RAND_MAX+1.0)))-1);
683   #endif
684     add_randomness( buffer, length, requester );
685     g10_free(buffer);
686     return 0; /* okay */
687 }
688