8ade26c11db7e541d6bf487498097fbd29b462cf
[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 "util.h"
49 #include "rmd.h"
50 #include "ttyio.h"
51 #include "i18n.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 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 ? m_alloc_secure_clear(POOLSIZE+BLOCKLEN)
127                            : m_alloc_clear(POOLSIZE+BLOCKLEN);
128     keypool = secure_alloc ? m_alloc_secure_clear(POOLSIZE+BLOCKLEN)
129                            : m_alloc_clear(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 randomize_buffer( byte *buffer, size_t length, int level )
174 {
175     char *p = get_random_bits( length*8, level, 1 );
176     memcpy( buffer, p, length );
177     m_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 byte *
195 get_random_bits( size_t nbits, int level, int secure )
196 {
197     byte *buf, *p;
198     size_t nbytes = (nbits+7)/8;
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 ? m_alloc_secure( nbytes ) : m_alloc( 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
223 /****************
224  * Mix the pool
225  */
226 static void
227 mix_pool(byte *pool)
228 {
229     char *hashbuf = pool + POOLSIZE;
230     char *p, *pend;
231     int i, n;
232     RMD160_CONTEXT md;
233
234     rmd160_init( &md );
235  #if DIGESTLEN != 20
236     #error must have a digest length of 20 for ripe-md-160
237  #endif
238     /* loop over the pool */
239     pend = pool + POOLSIZE;
240     memcpy(hashbuf, pend - DIGESTLEN, DIGESTLEN );
241     memcpy(hashbuf+DIGESTLEN, pool, BLOCKLEN-DIGESTLEN);
242     rmd160_mixblock( &md, hashbuf);
243     memcpy(pool, hashbuf, 20 );
244
245     p = pool;
246     for( n=1; n < POOLBLOCKS; n++ ) {
247         memcpy(hashbuf, p, DIGESTLEN );
248
249         p += DIGESTLEN;
250         if( p+DIGESTLEN+BLOCKLEN < pend )
251             memcpy(hashbuf+DIGESTLEN, p+DIGESTLEN, BLOCKLEN-DIGESTLEN);
252         else {
253             char *pp = p+DIGESTLEN;
254             for(i=DIGESTLEN; i < BLOCKLEN; i++ ) {
255                 if( pp >= pend )
256                     pp = pool;
257                 hashbuf[i] = *pp++;
258             }
259         }
260
261         rmd160_mixblock( &md, hashbuf);
262         memcpy(p, hashbuf, 20 );
263     }
264 }
265
266
267 static void
268 read_pool( byte *buffer, size_t length, int level )
269 {
270     int i;
271     ulong *sp, *dp;
272
273     if( length >= POOLSIZE )
274         BUG(); /* not allowed */
275
276     /* for level 2 make sure that there is enough random in the pool */
277     if( level == 2 && pool_balance < length ) {
278         size_t needed;
279
280         if( pool_balance < 0 )
281             pool_balance = 0;
282         needed = length - pool_balance;
283         if( needed > POOLSIZE )
284             BUG();
285         read_random_source( 3, needed, 2 );
286         pool_balance += needed;
287     }
288
289     /* make sure the pool is filled */
290     while( !pool_filled )
291         random_poll();
292
293     /* do always a fast random poll */
294     fast_random_poll();
295
296     if( !level ) { /* no need for cryptographic strong random */
297         /* create a new pool */
298         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
299                                     i < POOLWORDS; i++, dp++, sp++ )
300             *dp = *sp + ADD_VALUE;
301         /* must mix both pools */
302         mix_pool(rndpool); rndstats.mixrnd++;
303         mix_pool(keypool); rndstats.mixkey++;
304         memcpy( buffer, keypool, length );
305     }
306     else {
307         /* mix the pool (if add_randomness() didn't it) */
308         if( !just_mixed ) {
309             mix_pool(rndpool);
310             rndstats.mixrnd++;
311         }
312         /* create a new pool */
313         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
314                                     i < POOLWORDS; i++, dp++, sp++ )
315             *dp = *sp + ADD_VALUE;
316         /* and mix both pools */
317         mix_pool(rndpool); rndstats.mixrnd++;
318         mix_pool(keypool); rndstats.mixkey++;
319         /* read the required data
320          * we use a readpoiter to read from a different postion each
321          * time */
322         while( length-- ) {
323             *buffer++ = keypool[pool_readpos++];
324             if( pool_readpos >= POOLSIZE )
325                 pool_readpos = 0;
326             pool_balance--;
327         }
328         if( pool_balance < 0 )
329             pool_balance = 0;
330         /* and clear the keypool */
331         memset( keypool, 0, POOLSIZE );
332     }
333 }
334
335
336 /****************
337  * Add LENGTH bytes of randomness from buffer to the pool.
338  * source may be used to specify the randomness source.
339  */
340 static void
341 add_randomness( const void *buffer, size_t length, int source )
342 {
343     const byte *p = buffer;
344
345     if( !is_initialized )
346         initialize();
347     rndstats.addbytes += length;
348     rndstats.naddbytes++;
349     while( length-- ) {
350         rndpool[pool_writepos++] = *p++;
351         if( pool_writepos >= POOLSIZE ) {
352             if( source > 1 )
353                 pool_filled = 1;
354             pool_writepos = 0;
355             mix_pool(rndpool); rndstats.mixrnd++;
356             just_mixed = !length;
357         }
358     }
359 }
360
361
362
363 static void
364 random_poll()
365 {
366     rndstats.slowpolls++;
367     read_random_source( 2, POOLSIZE/5, 1 );
368 }
369
370
371 void
372 fast_random_poll()
373 {
374     static void (*fnc)( void (*)(const void*, size_t, int), int) = NULL;
375     static int initialized = 0;
376
377     rndstats.fastpolls++;
378     if( !initialized ) {
379         if( !is_initialized )
380             initialize();
381         initialized = 1;
382         fnc = dynload_getfnc_fast_random_poll();
383     }
384     if( fnc ) {
385         (*fnc)( add_randomness, 1 );
386         return;
387     }
388
389     /* fall back to the generic function */
390   #if HAVE_GETHRTIME
391     {   hrtime_t tv;
392         tv = gethrtime();
393         add_randomness( &tv, sizeof(tv), 1 );
394     }
395   #elif HAVE_GETTIMEOFDAY
396     {   struct timeval tv;
397         if( gettimeofday( &tv, NULL ) )
398             BUG();
399         add_randomness( &tv.tv_sec, sizeof(tv.tv_sec), 1 );
400         add_randomness( &tv.tv_usec, sizeof(tv.tv_usec), 1 );
401     }
402   #else /* use times */
403     #ifndef HAVE_DOSISH_SYSTEM
404     {   struct tms buf;
405         times( &buf );
406         add_randomness( &buf, sizeof buf, 1 );
407     }
408     #endif
409   #endif
410   #ifdef HAVE_GETRUSAGE
411     {   struct rusage buf;
412         if( getrusage( RUSAGE_SELF, &buf ) )
413             BUG();
414         add_randomness( &buf, sizeof buf, 1 );
415         memset( &buf, 0, sizeof buf );
416     }
417   #endif
418 }
419
420
421
422 static void
423 read_random_source( int requester, size_t length, int level )
424 {
425     static int (*fnc)(void (*)(const void*, size_t, int), int,
426                                                     size_t, int) = NULL;
427     if( !fnc ) {
428         if( !is_initialized )
429             initialize();
430         fnc = dynload_getfnc_gather_random();
431         if( !fnc ) {
432             faked_rng = 1;
433             fnc = gather_faked;
434         }
435         if( !requester && !length && !level )
436             return; /* init only */
437     }
438     if( (*fnc)( add_randomness, requester, length, level ) < 0 )
439         log_fatal("No way to gather entropy for the RNG\n");
440 }
441
442
443 static int
444 gather_faked( void (*add)(const void*, size_t, int), int requester,
445               size_t length, int level )
446 {
447     static int initialized=0;
448     size_t n;
449     char *buffer, *p;
450
451     if( !initialized ) {
452         log_info(_("WARNING: using insecure random number generator!!\n"));
453         tty_printf(_("The random number generator is only a kludge to let\n"
454                    "it run - it is in no way a strong RNG!\n\n"
455                    "DON'T USE ANY DATA GENERATED BY THIS PROGRAM!!\n\n"));
456         initialized=1;
457       #ifdef HAVE_RAND
458         srand(make_timestamp()*getpid());
459       #else
460         srandom(make_timestamp()*getpid());
461       #endif
462     }
463
464     p = buffer = m_alloc( length );
465     n = length;
466   #ifdef HAVE_RAND
467     while( n-- )
468         *p++ = ((unsigned)(1 + (int) (256.0*rand()/(RAND_MAX+1.0)))-1);
469   #else
470     while( n-- )
471         *p++ = ((unsigned)(1 + (int) (256.0*random()/(RAND_MAX+1.0)))-1);
472   #endif
473     add_randomness( buffer, length, requester );
474     m_free(buffer);
475     return 0; /* okay */
476 }
477