See ChangeLog: Tue Dec 29 14:41:47 CET 1998 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 "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
120   #if   USE_RNDLINUX
121     rndlinux_constructor();
122   #elif USE_RNDUNIX
123     rndunix_constructor();
124   #elif USE_RNDW32
125     rndw32_constructor();
126   #elif USE_RNDOS2
127     rndos2_constructor();
128   #elif USE_RNDATARI
129     rndatari_constructor();
130   #elif USE_RNDMVS
131     rndmvs_constructor();
132   #endif
133 }
134
135 void
136 secure_random_alloc()
137 {
138     secure_alloc = 1;
139 }
140
141
142 int
143 quick_random_gen( int onoff )
144 {
145     int last;
146
147     read_random_source(0,0,0); /* init */
148     last = quick_test;
149     if( onoff != -1 )
150         quick_test = onoff;
151     return faked_rng? 1 : last;
152 }
153
154
155 /****************
156  * Fill the buffer with LENGTH bytes of cryptographically strong
157  * random bytes. level 0 is not very strong, 1 is strong enough
158  * for most usage, 2 is good for key generation stuff but may be very slow.
159  */
160 void
161 randomize_buffer( byte *buffer, size_t length, int level )
162 {
163     char *p = get_random_bits( length*8, level, m_is_secure(buffer) );
164     memcpy( buffer, p, length );
165     m_free(p);
166 }
167
168
169
170 /****************
171  * Return a pointer to a randomized buffer of level 0 and LENGTH bits
172  * caller must free the buffer.
173  * Note: The returned value is rounded up to bytes.
174  */
175 byte *
176 get_random_bits( size_t nbits, int level, int secure )
177 {
178     byte *buf;
179     size_t nbytes = (nbits+7)/8;
180
181     if( quick_test && level > 1 )
182         level = 1;
183     MASK_LEVEL(level);
184     buf = secure && secure_alloc ? m_alloc_secure( nbytes ) : m_alloc( nbytes );
185     read_pool( buf, nbytes, level );
186     return buf;
187 }
188
189
190 /****************
191  * Mix the pool
192  */
193 static void
194 mix_pool(byte *pool)
195 {
196     char *hashbuf = pool + POOLSIZE;
197     char *p, *pend;
198     int i, n;
199     RMD160_CONTEXT md;
200
201     rmd160_init( &md );
202  #if DIGESTLEN != 20
203     #error must have a digest length of 20 for ripe-md-160
204  #endif
205     /* loop over the pool */
206     pend = pool + POOLSIZE;
207     memcpy(hashbuf, pend - DIGESTLEN, DIGESTLEN );
208     memcpy(hashbuf+DIGESTLEN, pool, BLOCKLEN-DIGESTLEN);
209     rmd160_mixblock( &md, hashbuf);
210     memcpy(pool, hashbuf, 20 );
211
212     p = pool;
213     for( n=1; n < POOLBLOCKS; n++ ) {
214         memcpy(hashbuf, p, DIGESTLEN );
215
216         p += DIGESTLEN;
217         if( p+DIGESTLEN+BLOCKLEN < pend )
218             memcpy(hashbuf+DIGESTLEN, p+DIGESTLEN, BLOCKLEN-DIGESTLEN);
219         else {
220             char *pp = p+DIGESTLEN;
221             for(i=DIGESTLEN; i < BLOCKLEN; i++ ) {
222                 if( pp >= pend )
223                     pp = pool;
224                 hashbuf[i] = *pp++;
225             }
226         }
227
228         rmd160_mixblock( &md, hashbuf);
229         memcpy(p, hashbuf, 20 );
230     }
231 }
232
233
234 static void
235 read_pool( byte *buffer, size_t length, int level )
236 {
237     int i;
238     ulong *sp, *dp;
239
240     if( length >= POOLSIZE )
241         BUG(); /* not allowed */
242
243     /* for level 2 make sure that there is enough random in the pool */
244     if( level == 2 && pool_balance < length ) {
245         size_t needed;
246
247         if( pool_balance < 0 )
248             pool_balance = 0;
249         needed = length - pool_balance;
250         if( needed > POOLSIZE )
251             BUG();
252         read_random_source( 3, needed, 2 );
253         pool_balance += needed;
254     }
255
256     /* make sure the pool is filled */
257     while( !pool_filled )
258         random_poll();
259
260     /* do always a fast random poll */
261     fast_random_poll();
262
263     if( !level ) { /* no need for cryptographic strong random */
264         /* create a new pool */
265         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
266                                     i < POOLWORDS; i++, dp++, sp++ )
267             *dp = *sp + ADD_VALUE;
268         /* must mix both pools */
269         mix_pool(rndpool);
270         mix_pool(keypool);
271         memcpy( buffer, keypool, length );
272     }
273     else {
274         /* mix the pool (if add_randomness() didn't it) */
275         if( !just_mixed )
276             mix_pool(rndpool);
277         /* create a new pool */
278         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
279                                     i < POOLWORDS; i++, dp++, sp++ )
280             *dp = *sp + ADD_VALUE;
281         /* and mix both pools */
282         mix_pool(rndpool);
283         mix_pool(keypool);
284         /* read the required data
285          * we use a readpoiter to read from a different postion each
286          * time */
287         while( length-- ) {
288             *buffer++ = keypool[pool_readpos++];
289             if( pool_readpos >= POOLSIZE )
290                 pool_readpos = 0;
291             pool_balance--;
292         }
293         if( pool_balance < 0 )
294             pool_balance = 0;
295         /* and clear the keypool */
296         memset( keypool, 0, POOLSIZE );
297     }
298 }
299
300
301 /****************
302  * Add LENGTH bytes of randomness from buffer to the pool.
303  * source may be used to specify the randomness source.
304  */
305 static void
306 add_randomness( const void *buffer, size_t length, int source )
307 {
308     if( !is_initialized )
309         initialize();
310     while( length-- ) {
311         rndpool[pool_writepos++] = *((byte*)buffer)++;
312         if( pool_writepos >= POOLSIZE ) {
313             if( source > 1 )
314                 pool_filled = 1;
315             pool_writepos = 0;
316             mix_pool(rndpool);
317             just_mixed = !length;
318         }
319     }
320 }
321
322
323
324 static void
325 random_poll()
326 {
327     read_random_source( 2, POOLSIZE/5, 1 );
328 }
329
330
331 void
332 fast_random_poll()
333 {
334     static void (*fnc)( void (*)(const void*, size_t, int), 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, 1 );
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( int requester, size_t length, int level )
381 {
382     static int (*fnc)(void (*)(const void*, size_t, int), int,
383                                                     size_t, int) = NULL;
384     int nbytes;
385     int goodness;
386
387     if( !fnc ) {
388         if( !is_initialized )
389             initialize();
390         fnc = dynload_getfnc_gather_random();
391         if( !fnc ) {
392             faked_rng = 1;
393             fnc = gather_faked;
394         }
395         if( !requester && !length && !level )
396             return; /* init only */
397     }
398     if( (*fnc)( add_randomness, requester, length, level ) < 0 )
399         log_fatal("No way to gather entropy for the RNG\n");
400 }
401
402
403 static int
404 gather_faked( void (*add)(const void*, size_t, int), int requester,
405               size_t length, int level )
406 {
407     static int initialized=0;
408     size_t n;
409     char *buffer, *p;
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     p = buffer = m_alloc( length );
425     n = length;
426   #ifdef HAVE_RAND
427     while( n-- )
428         *p++ = ((unsigned)(1 + (int) (256.0*rand()/(RAND_MAX+1.0)))-1);
429   #else
430     while( n-- )
431         *p++ = ((unsigned)(1 + (int) (256.0*random()/(RAND_MAX+1.0)))-1);
432   #endif
433     add_randomness( buffer, length, requester );
434     m_free(buffer);
435     return 0; /* okay */
436 }
437