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