Made Arcfour work
[libgcrypt.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 Libgcrypt.
5  *
6  * Libgcrypt 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  * Libgcrypt 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 #include <time.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 "g10lib.h"
54 #include "rmd.h"
55 #include "random.h"
56 #include "rand-internal.h"
57 #include "dynload.h"
58
59
60 #ifndef RAND_MAX   /* for SunOS */
61   #define RAND_MAX 32767
62 #endif
63
64
65 #if SIZEOF_UNSIGNED_LONG == 8
66   #define ADD_VALUE 0xa5a5a5a5a5a5a5a5
67 #elif SIZEOF_UNSIGNED_LONG == 4
68   #define ADD_VALUE 0xa5a5a5a5
69 #else
70   #error weird size for an unsigned long
71 #endif
72
73 #define BLOCKLEN  64   /* hash this amount of bytes */
74 #define DIGESTLEN 20   /* into a digest of this length (rmd160) */
75 /* poolblocks is the number of digests which make up the pool
76  * and poolsize must be a multiple of the digest length
77  * to make the AND operations faster, the size should also be
78  * a multiple of ulong
79  */
80 #define POOLBLOCKS 30
81 #define POOLSIZE (POOLBLOCKS*DIGESTLEN)
82 #if (POOLSIZE % SIZEOF_UNSIGNED_LONG)
83   #error Please make sure that poolsize is a multiple of ulong
84 #endif
85 #define POOLWORDS (POOLSIZE / SIZEOF_UNSIGNED_LONG)
86
87
88 static int is_initialized;
89 #define MASK_LEVEL(a) do {if( a > 2 ) a = 2; else if( a < 0 ) a = 0; } while(0)
90 static char *rndpool;   /* allocated size is POOLSIZE+BLOCKLEN */
91 static char *keypool;   /* allocated size is POOLSIZE+BLOCKLEN */
92 static size_t pool_readpos;
93 static size_t pool_writepos;
94 static int pool_filled;
95 static int pool_balance;
96 static int just_mixed;
97 static int did_initial_extra_seeding;
98 static char *seed_file_name;
99 static int allow_seed_file_update;
100
101 static int secure_alloc;
102 static int quick_test;
103 static int faked_rng;
104
105
106 static byte *get_random_bytes( size_t nbytes, int level, int secure );
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 static void
128 initialize(void)
129 {
130     /* The data buffer is allocated somewhat larger, so that
131      * we can use this extra space (which is allocated in secure memory)
132      * as a temporary hash buffer */
133     rndpool = secure_alloc ? gcry_xcalloc_secure(1,POOLSIZE+BLOCKLEN)
134                            : gcry_xcalloc(1,POOLSIZE+BLOCKLEN);
135     keypool = secure_alloc ? gcry_xcalloc_secure(1,POOLSIZE+BLOCKLEN)
136                            : gcry_xcalloc(1,POOLSIZE+BLOCKLEN);
137     is_initialized = 1;
138     _gcry_cipher_modules_constructor();
139 }
140
141
142 void
143 _gcry_random_dump_stats()
144 {
145     fprintf(stderr,
146             "random usage: poolsize=%d mixed=%lu polls=%lu/%lu added=%lu/%lu\n"
147             "              outmix=%lu getlvl1=%lu/%lu getlvl2=%lu/%lu\n",
148         POOLSIZE, rndstats.mixrnd, rndstats.slowpolls, rndstats.fastpolls,
149                   rndstats.naddbytes, rndstats.addbytes,
150         rndstats.mixkey, rndstats.ngetbytes1, rndstats.getbytes1,
151                     rndstats.ngetbytes2, rndstats.getbytes2 );
152 }
153
154 void
155 _gcry_secure_random_alloc()
156 {
157     secure_alloc = 1;
158 }
159
160
161 int
162 _gcry_quick_random_gen( int onoff )
163 {
164     int last;
165
166     read_random_source(0,0,0); /* init */
167     last = quick_test;
168     if( onoff != -1 )
169         quick_test = onoff;
170     return faked_rng? 1 : last;
171 }
172
173
174 /****************
175  * Fill the buffer with LENGTH bytes of cryptographically strong
176  * random bytes. level 0 is not very strong, 1 is strong enough
177  * for most usage, 2 is good for key generation stuff but may be very slow.
178  */
179 void
180 gcry_randomize( byte *buffer, size_t length, enum gcry_random_level level )
181 {
182     char *p = get_random_bytes( length, level, 1 );
183     memcpy( buffer, p, length );
184     gcry_free(p);
185 }
186
187
188 int
189 _gcry_random_is_faked()
190 {
191     if( !is_initialized )
192         initialize();
193     return faked_rng || quick_test;
194 }
195
196 /****************
197  * Return a pointer to a randomized buffer of level 0 and LENGTH bits
198  * caller must free the buffer.
199  * Note: The returned value is rounded up to bytes.
200  */
201 static byte *
202 get_random_bytes( size_t nbytes, int level, int secure )
203 {
204     byte *buf, *p;
205
206     if( quick_test && level > 1 )
207         level = 1;
208     MASK_LEVEL(level);
209     if( level == 1 ) {
210         rndstats.getbytes1 += nbytes;
211         rndstats.ngetbytes1++;
212     }
213     else if( level >= 2 ) {
214         rndstats.getbytes2 += nbytes;
215         rndstats.ngetbytes2++;
216     }
217
218     buf = secure && secure_alloc ? gcry_xmalloc_secure( nbytes )
219                                  : gcry_xmalloc( nbytes );
220     for( p = buf; nbytes > 0; ) {
221         size_t n = nbytes > POOLSIZE? POOLSIZE : nbytes;
222         read_pool( p, n, level );
223         nbytes -= n;
224         p += n;
225     }
226     return buf;
227 }
228
229 void *
230 gcry_random_bytes( size_t nbytes, enum gcry_random_level level )
231 {
232     return get_random_bytes( nbytes, level, 0 );
233 }
234
235 void *
236 gcry_random_bytes_secure( size_t nbytes, enum gcry_random_level level )
237 {
238     return get_random_bytes( nbytes, level, 1 );
239 }
240
241
242 /****************
243  * Mix the pool
244  */
245 static void
246 mix_pool(byte *pool)
247 {
248     char *hashbuf = pool + POOLSIZE;
249     char *p, *pend;
250     int i, n;
251     RMD160_CONTEXT md;
252
253     _gcry_rmd160_init( &md );
254  #if DIGESTLEN != 20
255     #error must have a digest length of 20 for ripe-md-160
256  #endif
257     /* loop over the pool */
258     pend = pool + POOLSIZE;
259     memcpy(hashbuf, pend - DIGESTLEN, DIGESTLEN );
260     memcpy(hashbuf+DIGESTLEN, pool, BLOCKLEN-DIGESTLEN);
261     _gcry_rmd160_mixblock( &md, hashbuf);
262     memcpy(pool, hashbuf, 20 );
263
264     p = pool;
265     for( n=1; n < POOLBLOCKS; n++ ) {
266         memcpy(hashbuf, p, DIGESTLEN );
267
268         p += DIGESTLEN;
269         if( p+DIGESTLEN+BLOCKLEN < pend )
270             memcpy(hashbuf+DIGESTLEN, p+DIGESTLEN, BLOCKLEN-DIGESTLEN);
271         else {
272             char *pp = p+DIGESTLEN;
273             for(i=DIGESTLEN; i < BLOCKLEN; i++ ) {
274                 if( pp >= pend )
275                     pp = pool;
276                 hashbuf[i] = *pp++;
277             }
278         }
279
280         _gcry_rmd160_mixblock( &md, hashbuf);
281         memcpy(p, hashbuf, 20 );
282     }
283 }
284
285 void
286 _gcry_set_random_seed_file( const char *name )
287 {
288     if( seed_file_name )
289         BUG();
290     seed_file_name = gcry_xstrdup( name );
291 }
292
293 /****************
294  * Read in a seed form the random_seed file
295  * and return true if this was successful
296  */
297 static int
298 read_seed_file()
299 {
300     int fd;
301     struct stat sb;
302     unsigned char buffer[POOLSIZE];
303     int n;
304
305     if( !seed_file_name )
306         return 0;
307
308   #ifdef HAVE_DOSISH_SYSTEM
309     fd = open( seed_file_name, O_RDONLY | O_BINARY );
310   #else
311     fd = open( seed_file_name, O_RDONLY );
312   #endif
313     if( fd == -1 && errno == ENOENT) {
314         allow_seed_file_update = 1;
315         return 0;
316     }
317
318     if( fd == -1 ) {
319         log_info(_("can't open `%s': %s\n"), seed_file_name, strerror(errno) );
320         return 0;
321     }
322     if( fstat( fd, &sb ) ) {
323         log_info(_("can't stat `%s': %s\n"), seed_file_name, strerror(errno) );
324         close(fd);
325         return 0;
326     }
327     if( !S_ISREG(sb.st_mode) ) {
328         log_info(_("`%s' is not a regular file - ignored\n"), seed_file_name );
329         close(fd);
330         return 0;
331     }
332     if( !sb.st_size ) {
333         log_info(_("note: random_seed file is empty\n") );
334         close(fd);
335         allow_seed_file_update = 1;
336         return 0;
337     }
338     if( sb.st_size != POOLSIZE ) {
339         log_info(_("warning: invalid size of random_seed file - not used\n") );
340         close(fd);
341         return 0;
342     }
343     do {
344         n = read( fd, buffer, POOLSIZE );
345     } while( n == -1 && errno == EINTR );
346     if( n != POOLSIZE ) {
347         log_fatal(_("can't read `%s': %s\n"), seed_file_name,strerror(errno) );
348         close(fd);
349         return 0;
350     }
351
352     close(fd);
353
354     add_randomness( buffer, POOLSIZE, 0 );
355     /* add some minor entropy to the pool now (this will also force a mixing) */
356     {   pid_t x = getpid();
357         add_randomness( &x, sizeof(x), 0 );
358     }
359     {   time_t x = time(NULL);
360         add_randomness( &x, sizeof(x), 0 );
361     }
362     {   clock_t x = clock();
363         add_randomness( &x, sizeof(x), 0 );
364     }
365     /* And read a few bytes from our entropy source.  By using
366      * a level of 0 this will not block and might not return anything
367      * with some entropy drivers, however the rndlinux driver will use
368      * /dev/urandom and return some stuff - Do not read to much as we
369      * want to be friendly to the scare system entropy resource. */
370     read_random_source( 0, 16, 0 );
371
372     allow_seed_file_update = 1;
373     return 1;
374 }
375
376 void
377 _gcry_update_random_seed_file()
378 {
379     ulong *sp, *dp;
380     int fd, i;
381
382     if( !seed_file_name || !is_initialized || !pool_filled )
383         return;
384     if( !allow_seed_file_update ) {
385         log_info(_("note: random_seed file not updated\n"));
386         return;
387     }
388
389
390     /* copy the entropy pool to a scratch pool and mix both of them */
391     for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
392                                     i < POOLWORDS; i++, dp++, sp++ ) {
393         *dp = *sp + ADD_VALUE;
394     }
395     mix_pool(rndpool); rndstats.mixrnd++;
396     mix_pool(keypool); rndstats.mixkey++;
397
398   #ifdef HAVE_DOSISH_SYSTEM
399     fd = open( seed_file_name, O_WRONLY|O_CREAT|O_TRUNC|O_BINARY,
400                                                         S_IRUSR|S_IWUSR );
401   #else
402     fd = open( seed_file_name, O_WRONLY|O_CREAT|O_TRUNC, S_IRUSR|S_IWUSR );
403   #endif
404     if( fd == -1 ) {
405         log_info(_("can't create `%s': %s\n"), seed_file_name, strerror(errno) );
406         return;
407     }
408     do {
409         i = write( fd, keypool, POOLSIZE );
410     } while( i == -1 && errno == EINTR );
411     if( i != POOLSIZE ) {
412         log_info(_("can't write `%s': %s\n"), seed_file_name, strerror(errno) );
413     }
414     if( close(fd) )
415         log_info(_("can't close `%s': %s\n"), seed_file_name, strerror(errno) );
416 }
417
418
419 static void
420 read_pool( byte *buffer, size_t length, int level )
421 {
422     int i;
423     ulong *sp, *dp;
424
425     if( length >= POOLSIZE ) {
426         log_fatal(_("too many random bits requested; the limit is %d\n"),
427                   POOLSIZE*8-1 );
428     }
429
430     if( !pool_filled ) {
431         if( read_seed_file() )
432             pool_filled = 1;
433     }
434
435     /* For level 2 quality (key generation) we alwas make
436      * sure that the pool has been seeded enough initially */
437     if( level == 2 && !did_initial_extra_seeding ) {
438         size_t needed;
439
440         pool_balance = 0;
441         needed = length - pool_balance;
442         if( needed < POOLSIZE/2 )
443             needed = POOLSIZE/2;
444         else if( needed > POOLSIZE )
445             BUG();
446         read_random_source( 3, needed, 2 );
447         pool_balance += needed;
448         did_initial_extra_seeding=1;
449     }
450
451     /* for level 2 make sure that there is enough random in the pool */
452     if( level == 2 && pool_balance < length ) {
453         size_t needed;
454
455         if( pool_balance < 0 )
456             pool_balance = 0;
457         needed = length - pool_balance;
458         if( needed > POOLSIZE )
459             BUG();
460         read_random_source( 3, needed, 2 );
461         pool_balance += needed;
462     }
463
464     /* make sure the pool is filled */
465     while( !pool_filled )
466         random_poll();
467
468     /* do always a fast random poll */
469     fast_random_poll();
470
471     if( !level ) { /* no need for cryptographic strong random */
472         /* create a new pool */
473         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
474                                     i < POOLWORDS; i++, dp++, sp++ )
475             *dp = *sp + ADD_VALUE;
476         /* must mix both pools */
477         mix_pool(rndpool); rndstats.mixrnd++;
478         mix_pool(keypool); rndstats.mixkey++;
479         memcpy( buffer, keypool, length );
480     }
481     else {
482         /* mix the pool (if add_randomness() didn't it) */
483         if( !just_mixed ) {
484             mix_pool(rndpool);
485             rndstats.mixrnd++;
486         }
487         /* create a new pool */
488         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
489                                     i < POOLWORDS; i++, dp++, sp++ )
490             *dp = *sp + ADD_VALUE;
491         /* and mix both pools */
492         mix_pool(rndpool); rndstats.mixrnd++;
493         mix_pool(keypool); rndstats.mixkey++;
494         /* read the required data
495          * we use a readpoiter to read from a different postion each
496          * time */
497         while( length-- ) {
498             *buffer++ = keypool[pool_readpos++];
499             if( pool_readpos >= POOLSIZE )
500                 pool_readpos = 0;
501             pool_balance--;
502         }
503         if( pool_balance < 0 )
504             pool_balance = 0;
505         /* and clear the keypool */
506         memset( keypool, 0, POOLSIZE );
507     }
508 }
509
510
511 /****************
512  * Add LENGTH bytes of randomness from buffer to the pool.
513  * source may be used to specify the randomness source.
514  * Source is:
515  *      0 - used ony for initialization
516  *      1 - fast random poll function
517  *      2 - normal poll function
518  *      3 - used when level 2 random quality has been requested
519  *          to do an extra pool seed.
520  */
521 static void
522 add_randomness( const void *buffer, size_t length, int source )
523 {
524     const byte *p = buffer;
525
526     if( !is_initialized )
527         initialize();
528     rndstats.addbytes += length;
529     rndstats.naddbytes++;
530     while( length-- ) {
531         rndpool[pool_writepos++] = *p++;
532         if( pool_writepos >= POOLSIZE ) {
533             if( source > 1 )
534                 pool_filled = 1;
535             pool_writepos = 0;
536             mix_pool(rndpool); rndstats.mixrnd++;
537             just_mixed = !length;
538         }
539     }
540 }
541
542
543
544 static void
545 random_poll()
546 {
547     rndstats.slowpolls++;
548     read_random_source( 2, POOLSIZE/5, 1 );
549 }
550
551
552 void
553 _gcry_fast_random_poll()
554 {
555     static void (*fnc)( void (*)(const void*, size_t, int), int) = NULL;
556     static int initialized = 0;
557
558     rndstats.fastpolls++;
559     if( !initialized ) {
560         if( !is_initialized )
561             initialize();
562         initialized = 1;
563         fnc = _gcry_dynload_getfnc_fast_random_poll();
564     }
565     if( fnc ) {
566         (*fnc)( add_randomness, 1 );
567         return;
568     }
569
570     /* fall back to the generic function */
571   #if HAVE_GETHRTIME
572     {   hrtime_t tv;
573         tv = gethrtime();
574         add_randomness( &tv, sizeof(tv), 1 );
575     }
576   #elif HAVE_GETTIMEOFDAY
577     {   struct timeval tv;
578         if( gettimeofday( &tv, NULL ) )
579             BUG();
580         add_randomness( &tv.tv_sec, sizeof(tv.tv_sec), 1 );
581         add_randomness( &tv.tv_usec, sizeof(tv.tv_usec), 1 );
582     }
583   #elif HAVE_CLOCK_GETTIME
584     {   struct timespec tv;
585         if( clock_gettime( CLOCK_REALTIME, &tv ) == -1 )
586             BUG();
587         add_randomness( &tv.tv_sec, sizeof(tv.tv_sec), 1 );
588         add_randomness( &tv.tv_nsec, sizeof(tv.tv_nsec), 1 );
589     }
590   #else /* use times */
591     #ifndef HAVE_DOSISH_SYSTEM
592     {   struct tms buf;
593         times( &buf );
594         add_randomness( &buf, sizeof buf, 1 );
595     }
596     #endif
597   #endif
598   #ifdef HAVE_GETRUSAGE
599     #ifndef RUSAGE_SELF
600       #ifdef __GCC__
601         #warning There is no RUSAGE_SELF on this system
602       #endif
603     #else
604     {   struct rusage buf;
605         /* QNX/Neutrino does return ENOSYS - so we just ignore it and
606          * add whatever is in buf */
607         if( getrusage( RUSAGE_SELF, &buf ) && errno != ENOSYS )
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 = _gcry_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( time(NULL)*getpid());
670       #else
671         srandom( time(NULL)*getpid());
672       #endif
673     }
674
675     p = buffer = gcry_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     gcry_free(buffer);
686     return 0; /* okay */
687 }
688