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