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