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