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