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