sync
[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 "util.h"
36 #include "rmd.h"
37 #include "ttyio.h"
38 #include "i18n.h"
39 #include "rand-internal.h"
40
41
42 #if SIZEOF_UNSIGNED_LONG == 8
43   #define ADD_VALUE 0xa5a5a5a5a5a5a5a5
44 #elif SIZEOF_UNSIGNED_LONG == 4
45   #define ADD_VALUE 0xa5a5a5a5
46 #else
47   #error weird size for an unsigned long
48 #endif
49
50 struct cache {
51     int len;
52     int size;
53     byte *buffer;
54 };
55
56
57 static int is_initialized;
58 static struct cache cache[3];
59 #define MASK_LEVEL(a) do {if( a > 2 ) a = 2; else if( a < 0 ) a = 0; } while(0)
60 static char *rndpool;   /* allocated size is POOLSIZE+BLOCKLEN */
61 static char *keypool;   /* allocated size is POOLSIZE+BLOCKLEN */
62 static size_t pool_readpos;
63 static size_t pool_writepos;
64 static int pool_filled;
65 static int pool_balance;
66 static int just_mixed;
67
68 static int secure_alloc;
69 static int quick_test;
70
71
72 static void read_pool( byte *buffer, size_t length, int level );
73
74
75 static void
76 initialize()
77 {
78     /* The data buffer is allocated somewhat larger, so that
79      * we can use this extra space (which is allocated in secure memory)
80      * as a temporary hash buffer */
81     rndpool = secure_alloc ? m_alloc_secure_clear(POOLSIZE+BLOCKLEN)
82                            : m_alloc_clear(POOLSIZE+BLOCKLEN);
83     keypool = secure_alloc ? m_alloc_secure_clear(POOLSIZE+BLOCKLEN)
84                            : m_alloc_clear(POOLSIZE+BLOCKLEN);
85     is_initialized = 1;
86 }
87
88 void
89 secure_random_alloc()
90 {
91     secure_alloc = 1;
92 }
93
94
95 int
96 quick_random_gen( int onoff )
97 {
98     int last = quick_test;
99     if( onoff != -1 )
100         quick_test = onoff;
101   #ifdef USE_RAND_DUMMY
102     last = 1; /* insecure RNG */
103   #endif
104     return last;
105 }
106
107
108 /****************
109  * Fill the buffer with LENGTH bytes of cryptographically strong
110  * random bytes. level 0 is not very strong, 1 is strong enough
111  * for most usage, 2 is good for key generation stuff but may be very slow.
112  */
113 void
114 randomize_buffer( byte *buffer, size_t length, int level )
115 {
116     for( ; length; length-- )
117         *buffer++ = get_random_byte(level);
118 }
119
120
121 byte
122 get_random_byte( int level )
123 {
124     MASK_LEVEL(level);
125     if( !cache[level].len ) {
126         if( !is_initialized )
127             initialize();
128         if( !cache[level].buffer ) {
129             cache[level].size = 100;
130             cache[level].buffer = level && secure_alloc?
131                                          m_alloc_secure( cache[level].size )
132                                        : m_alloc( cache[level].size );
133         }
134         read_pool(cache[level].buffer, cache[level].size, level );
135         cache[level].len = cache[level].size;
136     }
137
138     return cache[level].buffer[--cache[level].len];
139 }
140
141
142
143 /****************
144  * Return a pointer to a randomized buffer of level 0 and LENGTH bits
145  * caller must free the buffer. This function does not use the
146  * cache (will be removed in future). Note: The returned value is
147  * rounded up to bytes.
148  */
149 byte *
150 get_random_bits( size_t nbits, int level, int secure )
151 {
152     byte *buf;
153     size_t nbytes = (nbits+7)/8;
154
155     MASK_LEVEL(level);
156     buf = secure && secure_alloc ? m_alloc_secure( nbytes ) : m_alloc( nbytes );
157     read_pool( buf, nbytes, level );
158     return buf;
159 }
160
161
162 /****************
163  * Mix the pool
164  */
165 static void
166 mix_pool(byte *pool)
167 {
168     char *hashbuf = pool + POOLSIZE;
169     char *p, *pend;
170     int i, n;
171     RMD160_CONTEXT md;
172
173     rmd160_init( &md );
174  #if DIGESTLEN != 20
175     #error must have a digest length of 20 for ripe-md-160
176  #endif
177     /* loop over the pool */
178     pend = pool + POOLSIZE;
179     memcpy(hashbuf, pend - DIGESTLEN, DIGESTLEN );
180     memcpy(hashbuf+DIGESTLEN, pool, BLOCKLEN-DIGESTLEN);
181     rmd160_mixblock( &md, hashbuf);
182     memcpy(pool, hashbuf, 20 );
183
184     p = pool;
185     for( n=1; n < POOLBLOCKS; n++ ) {
186         memcpy(hashbuf, p, DIGESTLEN );
187
188         p += DIGESTLEN;
189         if( p+DIGESTLEN+BLOCKLEN < pend )
190             memcpy(hashbuf+DIGESTLEN, p+DIGESTLEN, BLOCKLEN-DIGESTLEN);
191         else {
192             char *pp = p+DIGESTLEN;
193             for(i=DIGESTLEN; i < BLOCKLEN; i++ ) {
194                 if( pp >= pend )
195                     pp = pool;
196                 hashbuf[i] = *pp++;
197             }
198         }
199
200         rmd160_mixblock( &md, hashbuf);
201         memcpy(p, hashbuf, 20 );
202     }
203 }
204
205
206 static void
207 read_pool( byte *buffer, size_t length, int level )
208 {
209     int i;
210     ulong *sp, *dp;
211
212     if( length >= POOLSIZE )
213         BUG(); /* not allowed */
214
215     /* for level 2 make sure that there is enough random in the pool */
216     if( level == 2 && pool_balance < length ) {
217         size_t needed;
218         byte *p;
219
220         if( pool_balance < 0 )
221             pool_balance = 0;
222         needed = length - pool_balance;
223         if( needed > POOLSIZE )
224             BUG();
225         p = secure_alloc ? m_alloc_secure( needed ) : m_alloc(needed);
226         read_random_source( p, needed, 2 ); /* read /dev/random */
227         add_randomness( p, needed, 3);
228         m_free(p);
229         pool_balance += needed;
230     }
231
232     /* make sure the pool is filled */
233     while( !pool_filled )
234         random_poll();
235
236     /* do always a fast random poll */
237     fast_random_poll();
238
239     if( !level ) { /* no need for cryptographic strong random */
240         /* create a new pool */
241         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
242                                     i < POOLWORDS; i++, dp++, sp++ )
243             *dp = *sp + ADD_VALUE;
244         /* must mix both pools */
245         mix_pool(rndpool);
246         mix_pool(keypool);
247         memcpy( buffer, keypool, length );
248     }
249     else {
250         /* mix the pool (if add_randomness() didn't it) */
251         if( !just_mixed )
252             mix_pool(rndpool);
253         /* create a new pool */
254         for(i=0,dp=(ulong*)keypool, sp=(ulong*)rndpool;
255                                     i < POOLWORDS; i++, dp++, sp++ )
256             *dp = *sp + ADD_VALUE;
257         /* and mix both pools */
258         mix_pool(rndpool);
259         mix_pool(keypool);
260         /* read the required data
261          * we use a readpoiter to read from a different postion each
262          * time */
263         while( length-- ) {
264             *buffer++ = keypool[pool_readpos++];
265             if( pool_readpos >= POOLSIZE )
266                 pool_readpos = 0;
267             pool_balance--;
268         }
269         if( pool_balance < 0 )
270             pool_balance = 0;
271         /* and clear the keypool */
272         memset( keypool, 0, POOLSIZE );
273     }
274 }
275
276
277 /****************
278  * Add LENGTH bytes of randomness from buffer to the pool.
279  * source may be used to specify the randomeness source.
280  */
281 void
282 add_randomness( const void *buffer, size_t length, int source )
283 {
284     if( !is_initialized )
285         initialize();
286     while( length-- ) {
287         rndpool[pool_writepos++] = *((byte*)buffer)++;
288         if( pool_writepos >= POOLSIZE ) {
289             if( source > 1 )
290                 pool_filled = 1;
291             pool_writepos = 0;
292             mix_pool(rndpool);
293             just_mixed = !length;
294         }
295     }
296 }
297
298
299