Remove DEC Alpha support.
[dragonfly.git] / sys / kern / kern_random.c
1 /*
2  * kern_random.c -- A strong random number generator
3  *
4  * $FreeBSD: src/sys/kern/kern_random.c,v 1.36.2.4 2002/09/17 17:11:57 sam Exp $
5  * $DragonFly: src/sys/kern/Attic/kern_random.c,v 1.7 2005/04/30 23:04:21 swildner Exp $
6  *
7  * Version 0.95, last modified 18-Oct-95
8  * 
9  * Copyright Theodore Ts'o, 1994, 1995.  All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, and the entire permission notice in its entirety,
16  *    including the disclaimer of warranties.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. The name of the author may not be used to endorse or promote
21  *    products derived from this software without specific prior
22  *    written permission.
23  * 
24  * ALTERNATIVELY, this product may be distributed under the terms of
25  * the GNU Public License, in which case the provisions of the GPL are
26  * required INSTEAD OF the above restrictions.  (This clause is
27  * necessary due to a potential bad interaction between the GPL and
28  * the restrictions contained in a BSD-style copyright.)
29  * 
30  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
31  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
33  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
34  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
35  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
36  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
38  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
40  * OF THE POSSIBILITY OF SUCH DAMAGE.
41  */
42
43 #include <sys/param.h>
44 #include <sys/kernel.h>
45 #include <sys/md5.h>
46 #include <sys/poll.h>
47 #include <sys/random.h>
48 #include <sys/select.h>
49 #include <sys/systm.h>
50 #include <sys/systimer.h>
51
52 #ifdef __i386__
53 #include <i386/isa/icu.h>
54 #endif
55
56 #define MAX_BLKDEV 4
57
58 /*
59  * The pool is stirred with a primitive polynomial of degree 128
60  * over GF(2), namely x^128 + x^99 + x^59 + x^31 + x^9 + x^7 + 1.
61  * For a pool of size 64, try x^64+x^62+x^38+x^10+x^6+x+1.
62  */
63 #define POOLWORDS 128    /* Power of 2 - note that this is 32-bit words */
64 #define POOLBITS (POOLWORDS*32)
65
66 #if POOLWORDS == 128
67 #define TAP1    99     /* The polynomial taps */
68 #define TAP2    59
69 #define TAP3    31
70 #define TAP4    9
71 #define TAP5    7
72 #elif POOLWORDS == 64
73 #define TAP1    62      /* The polynomial taps */
74 #define TAP2    38
75 #define TAP3    10
76 #define TAP4    6
77 #define TAP5    1
78 #else
79 #error No primitive polynomial available for chosen POOLWORDS
80 #endif
81
82 #define WRITEBUFFER 512 /* size in bytes */
83
84 /* There is actually only one of these, globally. */
85 struct random_bucket {
86         u_int   add_ptr;
87         u_int   entropy_count;
88         int     input_rotate;
89         u_int32_t *pool;
90         struct  selinfo rsel;
91 };
92
93 /* There is one of these per entropy source */
94 struct timer_rand_state {
95         u_long  last_time;
96         int     last_delta;
97         int     nbits;
98 };
99
100 static struct random_bucket random_state;
101 static u_int32_t random_pool[POOLWORDS];
102 static struct timer_rand_state keyboard_timer_state;
103 static struct timer_rand_state extract_timer_state;
104 static struct timer_rand_state irq_timer_state[MAX_INTS];
105 #ifdef notyet
106 static struct timer_rand_state blkdev_timer_state[MAX_BLKDEV];
107 #endif
108 static struct wait_queue *random_wait;
109
110 void
111 rand_initialize(void)
112 {
113         random_state.add_ptr = 0;
114         random_state.entropy_count = 0;
115         random_state.pool = random_pool;
116         random_wait = NULL;
117         random_state.rsel.si_flags = 0;
118         random_state.rsel.si_pid = 0;
119 }
120
121 /*
122  * This function adds an int into the entropy "pool".  It does not
123  * update the entropy estimate.  The caller must do this if appropriate.
124  *
125  * The pool is stirred with a primitive polynomial of degree 128
126  * over GF(2), namely x^128 + x^99 + x^59 + x^31 + x^9 + x^7 + 1.
127  * For a pool of size 64, try x^64+x^62+x^38+x^10+x^6+x+1.
128  * 
129  * We rotate the input word by a changing number of bits, to help
130  * assure that all bits in the entropy get toggled.  Otherwise, if we
131  * consistently feed the entropy pool small numbers (like ticks and
132  * scancodes, for example), the upper bits of the entropy pool don't
133  * get affected. --- TYT, 10/11/95
134  */
135 static __inline void
136 add_entropy_word(struct random_bucket *r, const u_int32_t input)
137 {
138         u_int i;
139         u_int32_t w;
140
141         w = (input << r->input_rotate) | (input >> (32 - r->input_rotate));
142         i = r->add_ptr = (r->add_ptr - 1) & (POOLWORDS-1);
143         if (i)
144                 r->input_rotate = (r->input_rotate + 7) & 31;
145         else
146                 /*
147                  * At the beginning of the pool, add an extra 7 bits
148                  * rotation, so that successive passes spread the
149                  * input bits across the pool evenly.
150                  */
151                 r->input_rotate = (r->input_rotate + 14) & 31;
152
153         /* XOR in the various taps */
154         w ^= r->pool[(i+TAP1)&(POOLWORDS-1)];
155         w ^= r->pool[(i+TAP2)&(POOLWORDS-1)];
156         w ^= r->pool[(i+TAP3)&(POOLWORDS-1)];
157         w ^= r->pool[(i+TAP4)&(POOLWORDS-1)];
158         w ^= r->pool[(i+TAP5)&(POOLWORDS-1)];
159         w ^= r->pool[i];
160         /* Rotate w left 1 bit (stolen from SHA) and store */
161         r->pool[i] = (w << 1) | (w >> 31);
162 }
163
164 /*
165  * This function adds entropy to the entropy "pool" by using timing
166  * delays.  It uses the timer_rand_state structure to make an estimate
167  * of how  any bits of entropy this call has added to the pool.
168  *
169  * The number "num" is also added to the pool - it should somehow describe
170  * the type of event which just happened.  This is currently 0-255 for
171  * keyboard scan codes, and 256 upwards for interrupts.
172  * On the i386, this is assumed to be at most 16 bits, and the high bits
173  * are used for a high-resolution timer.
174  */
175 static void
176 add_timer_randomness(struct random_bucket *r, struct timer_rand_state *state,
177         u_int num)
178 {
179         int             delta, delta2;
180         u_int           nbits;
181         u_int32_t       time;
182
183         num ^= cputimer_count() << 16;
184         r->entropy_count += 2;
185                 
186         time = ticks;
187
188         add_entropy_word(r, (u_int32_t) num);
189         add_entropy_word(r, time);
190
191         /*
192          * Calculate number of bits of randomness we probably
193          * added.  We take into account the first and second order
194          * deltas in order to make our estimate.
195          */
196         delta = time - state->last_time;
197         state->last_time = time;
198
199         delta2 = delta - state->last_delta;
200         state->last_delta = delta;
201
202         if (delta < 0) delta = -delta;
203         if (delta2 < 0) delta2 = -delta2;
204         delta = MIN(delta, delta2) >> 1;
205         for (nbits = 0; delta; nbits++)
206                 delta >>= 1;
207
208         r->entropy_count += nbits;
209         
210         /* Prevent overflow */
211         if (r->entropy_count > POOLBITS)
212                 r->entropy_count = POOLBITS;
213
214         if (r->entropy_count >= 8)
215                 selwakeup(&random_state.rsel);
216 }
217
218 void
219 add_keyboard_randomness(u_char scancode)
220 {
221         add_timer_randomness(&random_state, &keyboard_timer_state, scancode);
222 }
223
224 void
225 add_interrupt_randomness(int intr)
226 {
227         add_timer_randomness(&random_state, &irq_timer_state[intr], intr);
228 }
229
230 #ifdef notused
231 void
232 add_blkdev_randomness(int major)
233 {
234         if (major >= MAX_BLKDEV)
235                 return;
236
237         add_timer_randomness(&random_state, &blkdev_timer_state[major],
238                              0x200+major);
239 }
240 #endif /* notused */
241
242 #if POOLWORDS % 16
243 #error extract_entropy() assumes that POOLWORDS is a multiple of 16 words.
244 #endif
245 /*
246  * This function extracts randomness from the "entropy pool", and
247  * returns it in a buffer.  This function computes how many remaining
248  * bits of entropy are left in the pool, but it does not restrict the
249  * number of bytes that are actually obtained.
250  */
251 static __inline int
252 extract_entropy(struct random_bucket *r, char *buf, int nbytes)
253 {
254         int ret, i;
255         u_int32_t tmp[4];
256         
257         add_timer_randomness(r, &extract_timer_state, nbytes);
258         
259         /* Redundant, but just in case... */
260         if (r->entropy_count > POOLBITS) 
261                 r->entropy_count = POOLBITS;
262         /* Why is this here?  Left in from Ted Ts'o.  Perhaps to limit time. */
263         if (nbytes > 32768)
264                 nbytes = 32768;
265
266         ret = nbytes;
267         if (r->entropy_count / 8 >= nbytes)
268                 r->entropy_count -= nbytes*8;
269         else
270                 r->entropy_count = 0;
271
272         while (nbytes) {
273                 /* Hash the pool to get the output */
274                 tmp[0] = 0x67452301;
275                 tmp[1] = 0xefcdab89;
276                 tmp[2] = 0x98badcfe;
277                 tmp[3] = 0x10325476;
278                 for (i = 0; i < POOLWORDS; i += 16)
279                         MD5Transform(tmp, (char *)(r->pool+i));
280                 /* Modify pool so next hash will produce different results */
281                 add_entropy_word(r, tmp[0]);
282                 add_entropy_word(r, tmp[1]);
283                 add_entropy_word(r, tmp[2]);
284                 add_entropy_word(r, tmp[3]);
285                 /*
286                  * Run the MD5 Transform one more time, since we want
287                  * to add at least minimal obscuring of the inputs to
288                  * add_entropy_word().  --- TYT
289                  */
290                 MD5Transform(tmp, (char *)(r->pool));
291                 
292                 /* Copy data to destination buffer */
293                 i = MIN(nbytes, 16);
294                 bcopy(tmp, buf, i);
295                 nbytes -= i;
296                 buf += i;
297         }
298
299         /* Wipe data from memory */
300         bzero(tmp, sizeof(tmp));
301         
302         return ret;
303 }
304
305 #ifdef notused /* XXX NOT the exported kernel interface */
306 /*
307  * This function is the exported kernel interface.  It returns some
308  * number of good random numbers, suitable for seeding TCP sequence
309  * numbers, etc.
310  */
311 void
312 get_random_bytes(void *buf, u_int nbytes)
313 {
314         extract_entropy(&random_state, (char *) buf, nbytes);
315 }
316 #endif /* notused */
317
318 u_int
319 read_random(void *buf, u_int nbytes)
320 {
321         if ((nbytes * 8) > random_state.entropy_count)
322                 nbytes = random_state.entropy_count / 8;
323         
324         return extract_entropy(&random_state, (char *)buf, nbytes);
325 }
326
327 u_int
328 read_random_unlimited(void *buf, u_int nbytes)
329 {
330         return extract_entropy(&random_state, (char *)buf, nbytes);
331 }
332
333 #ifdef notused
334 u_int
335 write_random(const char *buf, u_int nbytes)
336 {
337         u_int i;
338         u_int32_t word, *p;
339
340         for (i = nbytes, p = (u_int32_t *)buf;
341              i >= sizeof(u_int32_t);
342              i-= sizeof(u_int32_t), p++)
343                 add_entropy_word(&random_state, *p);
344         if (i) {
345                 word = 0;
346                 bcopy(p, &word, i);
347                 add_entropy_word(&random_state, word);
348         }
349         return nbytes;
350 }
351 #endif /* notused */
352
353 void
354 add_true_randomness(int val)
355 {
356         add_entropy_word(&random_state, val);
357         random_state.entropy_count += 8*sizeof (val);
358         if (random_state.entropy_count > POOLBITS)
359                 random_state.entropy_count = POOLBITS;
360         selwakeup(&random_state.rsel);
361 }
362
363 int
364 random_poll(dev_t dev, int events, struct thread *td)
365 {
366         int s;
367         int revents = 0;
368
369         s = splhigh();
370         if (events & (POLLIN | POLLRDNORM)) {
371                 if (random_state.entropy_count >= 8)
372                         revents |= events & (POLLIN | POLLRDNORM);
373                 else
374                         selrecord(td, &random_state.rsel);
375         }
376         splx(s);
377         if (events & (POLLOUT | POLLWRNORM))
378                 revents |= events & (POLLOUT | POLLWRNORM);     /* heh */
379
380         return (revents);
381 }
382