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