See ChangeLog: Wed Dec 8 21:58:32 CET 1999 Werner Koch
[libgcrypt.git] / cipher / random.c
1 /* random.c  -  random number generator
2  *      Copyright (C) 1998 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 #ifdef  HAVE_GETHRTIME
40   #include <sys/times.h>
41 #endif
42 #ifdef HAVE_GETTIMEOFDAY
43   #include <sys/times.h>
44 #endif
45 #ifdef HAVE_GETRUSAGE
46   #include <sys/resource.h>
47 #endif
48 #include "g10lib.h"
49 #include "rmd.h"
50 #include "random.h"
51 #include "rand-internal.h"
52 #include "dynload.h"
53
54
55 #ifndef RAND_MAX   /* for SunOS */
56   #define RAND_MAX 32767
57 #endif
58
59
60 #if SIZEOF_UNSIGNED_LONG == 8
61   #define ADD_VALUE 0xa5a5a5a5a5a5a5a5
62 #elif SIZEOF_UNSIGNED_LONG == 4
63   #define ADD_VALUE 0xa5a5a5a5
64 #else
65   #error weird size for an unsigned long
66 #endif
67
68 #define BLOCKLEN  64   /* hash this amount of bytes */
69 #define DIGESTLEN 20   /* into a digest of this length (rmd160) */
70 /* poolblocks is the number of digests which make up the pool
71  * and poolsize must be a multiple of the digest length
72  * to make the AND operations faster, the size should also be
73  * a multiple of ulong
74  */
75 #define POOLBLOCKS 30
76 #define POOLSIZE (POOLBLOCKS*DIGESTLEN)
77 #if (POOLSIZE % SIZEOF_UNSIGNED_LONG)
78   #error Please make sure that poolsize is a multiple of ulong
79 #endif
80 #define POOLWORDS (POOLSIZE / SIZEOF_UNSIGNED_LONG)
81
82
83 static int is_initialized;
84 #define MASK_LEVEL(a) do {if( a > 2 ) a = 2; else if( a < 0 ) a = 0; } while(0)
85 static char *rndpool;   /* allocated size is POOLSIZE+BLOCKLEN */
86 static char *keypool;   /* allocated size is POOLSIZE+BLOCKLEN */
87 static size_t pool_readpos;
88 static size_t pool_writepos;
89 static int pool_filled;
90 static int pool_balance;
91 static int just_mixed;
92
93 static int secure_alloc;
94 static int quick_test;
95 static int faked_rng;
96
97
98 static byte *get_random_bytes( size_t nbytes, int level, int secure );
99 static void read_pool( byte *buffer, size_t length, int level );
100 static void add_randomness( const void *buffer, size_t length, int source );
101 static void random_poll(void);
102 static void read_random_source( int requester, size_t length, int level);
103 static int gather_faked( void (*add)(const void*, size_t, int), int requester,
104                                                     size_t length, int level );
105
106 static struct {
107     ulong mixrnd;
108     ulong mixkey;
109     ulong slowpolls;
110     ulong fastpolls;
111     ulong getbytes1;
112     ulong ngetbytes1;
113     ulong getbytes2;
114     ulong ngetbytes2;
115     ulong addbytes;
116     ulong naddbytes;
117 } rndstats;
118
119 static void
120 initialize(void)
121 {
122     /* The data buffer is allocated somewhat larger, so that
123      * we can use this extra space (which is allocated in secure memory)
124      * as a temporary hash buffer */
125     rndpool = secure_alloc ? g10_xcalloc_secure(1,POOLSIZE+BLOCKLEN)
126                            : g10_xcalloc(1,POOLSIZE+BLOCKLEN);
127     keypool = secure_alloc ? g10_xcalloc_secure(1,POOLSIZE+BLOCKLEN)
128                            : g10_xcalloc(1,POOLSIZE+BLOCKLEN);
129     is_initialized = 1;
130     cipher_modules_constructor();
131 }
132
133
134 void
135 random_dump_stats()
136 {
137     fprintf(stderr,
138             "random usage: poolsize=%d mixed=%lu polls=%lu/%lu added=%lu/%lu\n"
139             "              outmix=%lu getlvl1=%lu/%lu getlvl2=%lu/%lu\n",
140         POOLSIZE, rndstats.mixrnd, rndstats.slowpolls, rndstats.fastpolls,
141                   rndstats.naddbytes, rndstats.addbytes,
142         rndstats.mixkey, rndstats.ngetbytes1, rndstats.getbytes1,
143                     rndstats.ngetbytes2, rndstats.getbytes2 );
144 }
145
146 void
147 secure_random_alloc()
148 {
149     secure_alloc = 1;
150 }
151
152
153 int
154 quick_random_gen( int onoff )
155 {
156     int last;
157
158     read_random_source(0,0,0); /* init */
159     last = quick_test;
160     if( onoff != -1 )
161         quick_test = onoff;
162     return faked_rng? 1 : last;
163 }
164
165
166 /****************
167  * Fill the buffer with LENGTH bytes of cryptographically strong
168  * random bytes. level 0 is not very strong, 1 is strong enough
169  * for most usage, 2 is good for key generation stuff but may be very slow.
170  */
171 void
172 gcry_randomize( byte *buffer, size_t length, enum gcry_random_level level )
173 {
174     char *p = get_random_bytes( length, level, 1 );
175     memcpy( buffer, p, length );
176     g10_free(p);
177 }
178
179
180 int
181 random_is_faked()
182 {
183     if( !is_initialized )
184         initialize();
185     return faked_rng || quick_test;
186 }
187
188 /****************
189  * Return a pointer to a randomized buffer of level 0 and LENGTH bits
190  * caller must free the buffer.
191  * Note: The returned value is rounded up to bytes.
192  */
193 static byte *
194 get_random_bytes( size_t nbytes, int level, int secure )
195 {
196     byte *buf, *p;
197
198     if( quick_test && level > 1 )
199         level = 1;
200     MASK_LEVEL(level);
201     if( level == 1 ) {
202         rndstats.getbytes1 += nbytes;
203         rndstats.ngetbytes1++;
204     }
205     else if( level >= 2 ) {
206         rndstats.getbytes2 += nbytes;
207         rndstats.ngetbytes2++;
208     }
209
210     buf = secure && secure_alloc ? g10_xmalloc_secure( nbytes )
211                                  : g10_xmalloc( nbytes );
212     for( p = buf; nbytes > 0; ) {
213         size_t n = nbytes > POOLSIZE? POOLSIZE : nbytes;
214         read_pool( p, n, level );
215         nbytes -= n;
216         p += n;
217     }
218     return buf;
219 }
220
221 void *
222 gcry_random_bytes( size_t nbytes, enum gcry_random_level level )
223 {
224     return get_random_bytes( nbytes, level, 0 );
225 }
226
227 void *
228 gcry_random_bytes_secure( size_t nbytes, enum gcry_random_level level )
229 {
230     return get_random_bytes( nbytes, level, 1 );
231 }
232
233
234 /****************
235  * Mix the pool
236  */
237 static void
238 mix_pool(byte *pool)
239 {
240     char *hashbuf = pool + POOLSIZE;
241     char *p, *pend;
242     int i, n;
243     RMD160_CONTEXT md;
244
245     rmd160_init( &md );
246  #if DIGESTLEN != 20
247     #error must have a digest length of 20 for ripe-md-160
248  #endif
249     /* loop over the pool */
250     pend = pool + POOLSIZE;
251     memcpy(hashbuf, pend - DIGESTLEN, DIGESTLEN );
252     memcpy(hashbuf+DIGESTLEN, pool, BLOCKLEN-DIGESTLEN);
253     rmd160_mixblock( &md, hashbuf);
254     memcpy(pool, hashbuf, 20 );
255
256     p = pool;
257     for( n=1; n < POOLBLOCKS; n++ ) {
258         memcpy(hashbuf, p, DIGESTLEN );
259
260         p += DIGESTLEN;
261         if( p+DIGESTLEN+BLOCKLEN < pend )
262             memcpy(hashbuf+DIGESTLEN, p+DIGESTLEN, BLOCKLEN-DIGESTLEN);
263         else {
264             char *pp = p+DIGESTLEN;
265             for(i=DIGESTLEN; i < BLOCKLEN; i++ ) {
266                 if( pp >= pend )
267                     pp = pool;
268                 hashbuf[i] = *pp++;
269             }
270         }
271
272         rmd160_mixblock( &md, hashbuf);
273         memcpy(p, hashbuf, 20 );
274     }
275 }
276
277
278 static void
279 read_pool( byte *buffer, size_t length, int level )
280 {
281     int i;
282     ulong *sp, *dp;
283
284     if( length >= POOLSIZE )
285         BUG(); /* not allowed */
286
287     /* for level 2 make sure that there is enough random in the pool */
288     if( level == 2 && pool_balance < length ) {
289         size_t needed;
290
291         if( pool_balance < 0 )
292             pool_balance = 0;
293         needed = length - pool_balance;
294         if( needed > POOLSIZE )
295             BUG();
296         read_random_source( 3, needed, 2 );
297         pool_balance += needed;
298     }
299
300     /* make sure the pool is filled */
301     while( !pool_filled )
302         random_poll();
303
304     /* do always a fast random poll */
305     fast_random_poll();
306
307     if( !level ) { /* no need for cryptographic strong random */
308         /* create a new pool */
309         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
310                                     i < POOLWORDS; i++, dp++, sp++ )
311             *dp = *sp + ADD_VALUE;
312         /* must mix both pools */
313         mix_pool(rndpool); rndstats.mixrnd++;
314         mix_pool(keypool); rndstats.mixkey++;
315         memcpy( buffer, keypool, length );
316     }
317     else {
318         /* mix the pool (if add_randomness() didn't it) */
319         if( !just_mixed ) {
320             mix_pool(rndpool);
321             rndstats.mixrnd++;
322         }
323         /* create a new pool */
324         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
325                                     i < POOLWORDS; i++, dp++, sp++ )
326             *dp = *sp + ADD_VALUE;
327         /* and mix both pools */
328         mix_pool(rndpool); rndstats.mixrnd++;
329         mix_pool(keypool); rndstats.mixkey++;
330         /* read the required data
331          * we use a readpoiter to read from a different postion each
332          * time */
333         while( length-- ) {
334             *buffer++ = keypool[pool_readpos++];
335             if( pool_readpos >= POOLSIZE )
336                 pool_readpos = 0;
337             pool_balance--;
338         }
339         if( pool_balance < 0 )
340             pool_balance = 0;
341         /* and clear the keypool */
342         memset( keypool, 0, POOLSIZE );
343     }
344 }
345
346
347 /****************
348  * Add LENGTH bytes of randomness from buffer to the pool.
349  * source may be used to specify the randomness source.
350  */
351 static void
352 add_randomness( const void *buffer, size_t length, int source )
353 {
354     const byte *p = buffer;
355
356     if( !is_initialized )
357         initialize();
358     rndstats.addbytes += length;
359     rndstats.naddbytes++;
360     while( length-- ) {
361         rndpool[pool_writepos++] = *p++;
362         if( pool_writepos >= POOLSIZE ) {
363             if( source > 1 )
364                 pool_filled = 1;
365             pool_writepos = 0;
366             mix_pool(rndpool); rndstats.mixrnd++;
367             just_mixed = !length;
368         }
369     }
370 }
371
372
373
374 static void
375 random_poll()
376 {
377     rndstats.slowpolls++;
378     read_random_source( 2, POOLSIZE/5, 1 );
379 }
380
381
382 void
383 fast_random_poll()
384 {
385     static void (*fnc)( void (*)(const void*, size_t, int), int) = NULL;
386     static int initialized = 0;
387
388     rndstats.fastpolls++;
389     if( !initialized ) {
390         if( !is_initialized )
391             initialize();
392         initialized = 1;
393         fnc = dynload_getfnc_fast_random_poll();
394     }
395     if( fnc ) {
396         (*fnc)( add_randomness, 1 );
397         return;
398     }
399
400     /* fall back to the generic function */
401   #if HAVE_GETHRTIME
402     {   hrtime_t tv;
403         tv = gethrtime();
404         add_randomness( &tv, sizeof(tv), 1 );
405     }
406   #elif HAVE_GETTIMEOFDAY
407     {   struct timeval tv;
408         if( gettimeofday( &tv, NULL ) )
409             BUG();
410         add_randomness( &tv.tv_sec, sizeof(tv.tv_sec), 1 );
411         add_randomness( &tv.tv_usec, sizeof(tv.tv_usec), 1 );
412     }
413   #else /* use times */
414     #ifndef HAVE_DOSISH_SYSTEM
415     {   struct tms buf;
416         times( &buf );
417         add_randomness( &buf, sizeof buf, 1 );
418     }
419     #endif
420   #endif
421   #ifdef HAVE_GETRUSAGE
422     {   struct rusage buf;
423         if( getrusage( RUSAGE_SELF, &buf ) )
424             BUG();
425         add_randomness( &buf, sizeof buf, 1 );
426         memset( &buf, 0, sizeof buf );
427     }
428   #endif
429 }
430
431
432
433 static void
434 read_random_source( int requester, size_t length, int level )
435 {
436     static int (*fnc)(void (*)(const void*, size_t, int), int,
437                                                     size_t, int) = NULL;
438     if( !fnc ) {
439         if( !is_initialized )
440             initialize();
441         fnc = dynload_getfnc_gather_random();
442         if( !fnc ) {
443             faked_rng = 1;
444             fnc = gather_faked;
445         }
446         if( !requester && !length && !level )
447             return; /* init only */
448     }
449     if( (*fnc)( add_randomness, requester, length, level ) < 0 )
450         log_fatal("No way to gather entropy for the RNG\n");
451 }
452
453
454 static int
455 gather_faked( void (*add)(const void*, size_t, int), int requester,
456               size_t length, int level )
457 {
458     static int initialized=0;
459     size_t n;
460     char *buffer, *p;
461
462     if( !initialized ) {
463         log_info(_("WARNING: using insecure random number generator!!\n"));
464         /* we can't use tty_printf here - do we need this function at
465           all - does it really make sense or canit be viewed as a potential
466           security problem ? wk 17.11.99 */
467         #warning Extended warning disabled
468       #if 0
469         tty_printf(_("The random number generator is only a kludge to let\n"
470                    "it run - it is in no way a strong RNG!\n\n"
471                    "DON'T USE ANY DATA GENERATED BY THIS PROGRAM!!\n\n"));
472       #endif
473         initialized=1;
474       #ifdef HAVE_RAND
475         srand( time(NULL) * getpid());
476       #else
477         srandom( time(NULL) * getpid());
478       #endif
479     }
480
481     p = buffer = g10_xmalloc( length );
482     n = length;
483   #ifdef HAVE_RAND
484     while( n-- )
485         *p++ = ((unsigned)(1 + (int) (256.0*rand()/(RAND_MAX+1.0)))-1);
486   #else
487     while( n-- )
488         *p++ = ((unsigned)(1 + (int) (256.0*random()/(RAND_MAX+1.0)))-1);
489   #endif
490     add_randomness( buffer, length, requester );
491     g10_free(buffer);
492     return 0; /* okay */
493 }
494