blob: b430a12eb8190d9266ccd0de322c243021a1086e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * random.c -- A strong random number generator
3 *
Matt Mackall9e95ce22005-04-16 15:25:56 -07004 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
7 * rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, and the entire permission notice in its entirety,
14 * including the disclaimer of warranties.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote
19 * products derived from this software without specific prior
20 * written permission.
21 *
22 * ALTERNATIVELY, this product may be distributed under the terms of
23 * the GNU General Public License, in which case the provisions of the GPL are
24 * required INSTEAD OF the above restrictions. (This clause is
25 * necessary due to a potential bad interaction between the GPL and
26 * the restrictions contained in a BSD-style copyright.)
27 *
28 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
31 * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
32 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
34 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
35 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
38 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
39 * DAMAGE.
40 */
41
42/*
43 * (now, with legal B.S. out of the way.....)
44 *
45 * This routine gathers environmental noise from device drivers, etc.,
46 * and returns good random numbers, suitable for cryptographic use.
47 * Besides the obvious cryptographic uses, these numbers are also good
48 * for seeding TCP sequence numbers, and other places where it is
49 * desirable to have numbers which are not only random, but hard to
50 * predict by an attacker.
51 *
52 * Theory of operation
53 * ===================
54 *
55 * Computers are very predictable devices. Hence it is extremely hard
56 * to produce truly random numbers on a computer --- as opposed to
57 * pseudo-random numbers, which can easily generated by using a
58 * algorithm. Unfortunately, it is very easy for attackers to guess
59 * the sequence of pseudo-random number generators, and for some
60 * applications this is not acceptable. So instead, we must try to
61 * gather "environmental noise" from the computer's environment, which
62 * must be hard for outside attackers to observe, and use that to
63 * generate random numbers. In a Unix environment, this is best done
64 * from inside the kernel.
65 *
66 * Sources of randomness from the environment include inter-keyboard
67 * timings, inter-interrupt timings from some interrupts, and other
68 * events which are both (a) non-deterministic and (b) hard for an
69 * outside observer to measure. Randomness from these sources are
70 * added to an "entropy pool", which is mixed using a CRC-like function.
71 * This is not cryptographically strong, but it is adequate assuming
72 * the randomness is not chosen maliciously, and it is fast enough that
73 * the overhead of doing it on every interrupt is very reasonable.
74 * As random bytes are mixed into the entropy pool, the routines keep
75 * an *estimate* of how many bits of randomness have been stored into
76 * the random number generator's internal state.
77 *
78 * When random bytes are desired, they are obtained by taking the SHA
79 * hash of the contents of the "entropy pool". The SHA hash avoids
80 * exposing the internal state of the entropy pool. It is believed to
81 * be computationally infeasible to derive any useful information
82 * about the input of SHA from its output. Even if it is possible to
83 * analyze SHA in some clever way, as long as the amount of data
84 * returned from the generator is less than the inherent entropy in
85 * the pool, the output data is totally unpredictable. For this
86 * reason, the routine decreases its internal estimate of how many
87 * bits of "true randomness" are contained in the entropy pool as it
88 * outputs random numbers.
89 *
90 * If this estimate goes to zero, the routine can still generate
91 * random numbers; however, an attacker may (at least in theory) be
92 * able to infer the future output of the generator from prior
93 * outputs. This requires successful cryptanalysis of SHA, which is
94 * not believed to be feasible, but there is a remote possibility.
95 * Nonetheless, these numbers should be useful for the vast majority
96 * of purposes.
97 *
98 * Exported interfaces ---- output
99 * ===============================
100 *
101 * There are three exported interfaces; the first is one designed to
102 * be used from within the kernel:
103 *
104 * void get_random_bytes(void *buf, int nbytes);
105 *
106 * This interface will return the requested number of random bytes,
107 * and place it in the requested buffer.
108 *
109 * The two other interfaces are two character devices /dev/random and
110 * /dev/urandom. /dev/random is suitable for use when very high
111 * quality randomness is desired (for example, for key generation or
112 * one-time pads), as it will only return a maximum of the number of
113 * bits of randomness (as estimated by the random number generator)
114 * contained in the entropy pool.
115 *
116 * The /dev/urandom device does not have this limit, and will return
117 * as many bytes as are requested. As more and more random bytes are
118 * requested without giving time for the entropy pool to recharge,
119 * this will result in random numbers that are merely cryptographically
120 * strong. For many applications, however, this is acceptable.
121 *
122 * Exported interfaces ---- input
123 * ==============================
124 *
125 * The current exported interfaces for gathering environmental noise
126 * from the devices are:
127 *
128 * void add_input_randomness(unsigned int type, unsigned int code,
129 * unsigned int value);
130 * void add_interrupt_randomness(int irq);
131 *
132 * add_input_randomness() uses the input layer interrupt timing, as well as
133 * the event type information from the hardware.
134 *
135 * add_interrupt_randomness() uses the inter-interrupt timing as random
136 * inputs to the entropy pool. Note that not all interrupts are good
137 * sources of randomness! For example, the timer interrupts is not a
138 * good choice, because the periodicity of the interrupts is too
139 * regular, and hence predictable to an attacker. Disk interrupts are
140 * a better measure, since the timing of the disk interrupts are more
141 * unpredictable.
142 *
143 * All of these routines try to estimate how many bits of randomness a
144 * particular randomness source. They do this by keeping track of the
145 * first and second order deltas of the event timings.
146 *
147 * Ensuring unpredictability at system startup
148 * ============================================
149 *
150 * When any operating system starts up, it will go through a sequence
151 * of actions that are fairly predictable by an adversary, especially
152 * if the start-up does not involve interaction with a human operator.
153 * This reduces the actual number of bits of unpredictability in the
154 * entropy pool below the value in entropy_count. In order to
155 * counteract this effect, it helps to carry information in the
156 * entropy pool across shut-downs and start-ups. To do this, put the
157 * following lines an appropriate script which is run during the boot
158 * sequence:
159 *
160 * echo "Initializing random number generator..."
161 * random_seed=/var/run/random-seed
162 * # Carry a random seed from start-up to start-up
163 * # Load and then save the whole entropy pool
164 * if [ -f $random_seed ]; then
165 * cat $random_seed >/dev/urandom
166 * else
167 * touch $random_seed
168 * fi
169 * chmod 600 $random_seed
170 * dd if=/dev/urandom of=$random_seed count=1 bs=512
171 *
172 * and the following lines in an appropriate script which is run as
173 * the system is shutdown:
174 *
175 * # Carry a random seed from shut-down to start-up
176 * # Save the whole entropy pool
177 * echo "Saving random seed..."
178 * random_seed=/var/run/random-seed
179 * touch $random_seed
180 * chmod 600 $random_seed
181 * dd if=/dev/urandom of=$random_seed count=1 bs=512
182 *
183 * For example, on most modern systems using the System V init
184 * scripts, such code fragments would be found in
185 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
186 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
187 *
188 * Effectively, these commands cause the contents of the entropy pool
189 * to be saved at shut-down time and reloaded into the entropy pool at
190 * start-up. (The 'dd' in the addition to the bootup script is to
191 * make sure that /etc/random-seed is different for every start-up,
192 * even if the system crashes without executing rc.0.) Even with
193 * complete knowledge of the start-up activities, predicting the state
194 * of the entropy pool requires knowledge of the previous history of
195 * the system.
196 *
197 * Configuring the /dev/random driver under Linux
198 * ==============================================
199 *
200 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
201 * the /dev/mem major number (#1). So if your system does not have
202 * /dev/random and /dev/urandom created already, they can be created
203 * by using the commands:
204 *
205 * mknod /dev/random c 1 8
206 * mknod /dev/urandom c 1 9
207 *
208 * Acknowledgements:
209 * =================
210 *
211 * Ideas for constructing this random number generator were derived
212 * from Pretty Good Privacy's random number generator, and from private
213 * discussions with Phil Karn. Colin Plumb provided a faster random
214 * number generator, which speed up the mixing function of the entropy
215 * pool, taken from PGPfone. Dale Worley has also contributed many
216 * useful ideas and suggestions to improve this driver.
217 *
218 * Any flaws in the design are solely my responsibility, and should
219 * not be attributed to the Phil, Colin, or any of authors of PGP.
220 *
221 * Further background information on this topic may be obtained from
222 * RFC 1750, "Randomness Recommendations for Security", by Donald
223 * Eastlake, Steve Crocker, and Jeff Schiller.
224 */
225
226#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227#include <linux/module.h>
228#include <linux/kernel.h>
229#include <linux/major.h>
230#include <linux/string.h>
231#include <linux/fcntl.h>
232#include <linux/slab.h>
233#include <linux/random.h>
234#include <linux/poll.h>
235#include <linux/init.h>
236#include <linux/fs.h>
237#include <linux/genhd.h>
238#include <linux/interrupt.h>
239#include <linux/spinlock.h>
240#include <linux/percpu.h>
241#include <linux/cryptohash.h>
242
243#include <asm/processor.h>
244#include <asm/uaccess.h>
245#include <asm/irq.h>
246#include <asm/io.h>
247
248/*
249 * Configuration information
250 */
251#define INPUT_POOL_WORDS 128
252#define OUTPUT_POOL_WORDS 32
253#define SEC_XFER_SIZE 512
254
255/*
256 * The minimum number of bits of entropy before we wake up a read on
257 * /dev/random. Should be enough to do a significant reseed.
258 */
259static int random_read_wakeup_thresh = 64;
260
261/*
262 * If the entropy count falls under this number of bits, then we
263 * should wake up processes which are selecting or polling on write
264 * access to /dev/random.
265 */
266static int random_write_wakeup_thresh = 128;
267
268/*
269 * When the input pool goes over trickle_thresh, start dropping most
270 * samples to avoid wasting CPU time and reduce lock contention.
271 */
272
Christoph Lameter6c036522005-07-07 17:56:59 -0700273static int trickle_thresh __read_mostly = INPUT_POOL_WORDS * 28;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
275static DEFINE_PER_CPU(int, trickle_count) = 0;
276
277/*
278 * A pool of size .poolwords is stirred with a primitive polynomial
279 * of degree .poolwords over GF(2). The taps for various sizes are
280 * defined below. They are chosen to be evenly spaced (minimum RMS
281 * distance from evenly spaced; the numbers in the comments are a
282 * scaled squared error sum) except for the last tap, which is 1 to
283 * get the twisting happening as fast as possible.
284 */
285static struct poolinfo {
286 int poolwords;
287 int tap1, tap2, tap3, tap4, tap5;
288} poolinfo_table[] = {
289 /* x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 -- 105 */
290 { 128, 103, 76, 51, 25, 1 },
291 /* x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 -- 15 */
292 { 32, 26, 20, 14, 7, 1 },
293#if 0
294 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
295 { 2048, 1638, 1231, 819, 411, 1 },
296
297 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
298 { 1024, 817, 615, 412, 204, 1 },
299
300 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
301 { 1024, 819, 616, 410, 207, 2 },
302
303 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
304 { 512, 411, 308, 208, 104, 1 },
305
306 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
307 { 512, 409, 307, 206, 102, 2 },
308 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
309 { 512, 409, 309, 205, 103, 2 },
310
311 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
312 { 256, 205, 155, 101, 52, 1 },
313
314 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
315 { 128, 103, 78, 51, 27, 2 },
316
317 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
318 { 64, 52, 39, 26, 14, 1 },
319#endif
320};
321
322#define POOLBITS poolwords*32
323#define POOLBYTES poolwords*4
324
325/*
326 * For the purposes of better mixing, we use the CRC-32 polynomial as
327 * well to make a twisted Generalized Feedback Shift Reigster
328 *
329 * (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR generators. ACM
330 * Transactions on Modeling and Computer Simulation 2(3):179-194.
331 * Also see M. Matsumoto & Y. Kurita, 1994. Twisted GFSR generators
332 * II. ACM Transactions on Mdeling and Computer Simulation 4:254-266)
333 *
334 * Thanks to Colin Plumb for suggesting this.
335 *
336 * We have not analyzed the resultant polynomial to prove it primitive;
337 * in fact it almost certainly isn't. Nonetheless, the irreducible factors
338 * of a random large-degree polynomial over GF(2) are more than large enough
339 * that periodicity is not a concern.
340 *
341 * The input hash is much less sensitive than the output hash. All
342 * that we want of it is that it be a good non-cryptographic hash;
343 * i.e. it not produce collisions when fed "random" data of the sort
344 * we expect to see. As long as the pool state differs for different
345 * inputs, we have preserved the input entropy and done a good job.
346 * The fact that an intelligent attacker can construct inputs that
347 * will produce controlled alterations to the pool's state is not
348 * important because we don't consider such inputs to contribute any
349 * randomness. The only property we need with respect to them is that
350 * the attacker can't increase his/her knowledge of the pool's state.
351 * Since all additions are reversible (knowing the final state and the
352 * input, you can reconstruct the initial state), if an attacker has
353 * any uncertainty about the initial state, he/she can only shuffle
354 * that uncertainty about, but never cause any collisions (which would
355 * decrease the uncertainty).
356 *
357 * The chosen system lets the state of the pool be (essentially) the input
358 * modulo the generator polymnomial. Now, for random primitive polynomials,
359 * this is a universal class of hash functions, meaning that the chance
360 * of a collision is limited by the attacker's knowledge of the generator
361 * polynomail, so if it is chosen at random, an attacker can never force
362 * a collision. Here, we use a fixed polynomial, but we *can* assume that
363 * ###--> it is unknown to the processes generating the input entropy. <-###
364 * Because of this important property, this is a good, collision-resistant
365 * hash; hash collisions will occur no more often than chance.
366 */
367
368/*
369 * Static global variables
370 */
371static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
372static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
373
374#if 0
375static int debug = 0;
376module_param(debug, bool, 0644);
377#define DEBUG_ENT(fmt, arg...) do { if (debug) \
378 printk(KERN_DEBUG "random %04d %04d %04d: " \
379 fmt,\
380 input_pool.entropy_count,\
381 blocking_pool.entropy_count,\
382 nonblocking_pool.entropy_count,\
383 ## arg); } while (0)
384#else
385#define DEBUG_ENT(fmt, arg...) do {} while (0)
386#endif
387
388/**********************************************************************
389 *
390 * OS independent entropy store. Here are the functions which handle
391 * storing entropy in an entropy pool.
392 *
393 **********************************************************************/
394
395struct entropy_store;
396struct entropy_store {
397 /* mostly-read data: */
398 struct poolinfo *poolinfo;
399 __u32 *pool;
400 const char *name;
401 int limit;
402 struct entropy_store *pull;
403
404 /* read-write data: */
405 spinlock_t lock ____cacheline_aligned_in_smp;
406 unsigned add_ptr;
407 int entropy_count;
408 int input_rotate;
409};
410
411static __u32 input_pool_data[INPUT_POOL_WORDS];
412static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
413static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
414
415static struct entropy_store input_pool = {
416 .poolinfo = &poolinfo_table[0],
417 .name = "input",
418 .limit = 1,
Ingo Molnare4d91912006-07-03 00:24:34 -0700419 .lock = __SPIN_LOCK_UNLOCKED(&input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 .pool = input_pool_data
421};
422
423static struct entropy_store blocking_pool = {
424 .poolinfo = &poolinfo_table[1],
425 .name = "blocking",
426 .limit = 1,
427 .pull = &input_pool,
Ingo Molnare4d91912006-07-03 00:24:34 -0700428 .lock = __SPIN_LOCK_UNLOCKED(&blocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 .pool = blocking_pool_data
430};
431
432static struct entropy_store nonblocking_pool = {
433 .poolinfo = &poolinfo_table[1],
434 .name = "nonblocking",
435 .pull = &input_pool,
Ingo Molnare4d91912006-07-03 00:24:34 -0700436 .lock = __SPIN_LOCK_UNLOCKED(&nonblocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 .pool = nonblocking_pool_data
438};
439
440/*
441 * This function adds a byte into the entropy "pool". It does not
442 * update the entropy estimate. The caller should call
443 * credit_entropy_store if this is appropriate.
444 *
445 * The pool is stirred with a primitive polynomial of the appropriate
446 * degree, and then twisted. We twist by three bits at a time because
447 * it's cheap to do so and helps slightly in the expected case where
448 * the entropy is concentrated in the low-order bits.
449 */
450static void __add_entropy_words(struct entropy_store *r, const __u32 *in,
451 int nwords, __u32 out[16])
452{
453 static __u32 const twist_table[8] = {
454 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
455 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
456 unsigned long i, add_ptr, tap1, tap2, tap3, tap4, tap5;
457 int new_rotate, input_rotate;
458 int wordmask = r->poolinfo->poolwords - 1;
459 __u32 w, next_w;
460 unsigned long flags;
461
462 /* Taps are constant, so we can load them without holding r->lock. */
463 tap1 = r->poolinfo->tap1;
464 tap2 = r->poolinfo->tap2;
465 tap3 = r->poolinfo->tap3;
466 tap4 = r->poolinfo->tap4;
467 tap5 = r->poolinfo->tap5;
468 next_w = *in++;
469
470 spin_lock_irqsave(&r->lock, flags);
471 prefetch_range(r->pool, wordmask);
472 input_rotate = r->input_rotate;
473 add_ptr = r->add_ptr;
474
475 while (nwords--) {
476 w = rol32(next_w, input_rotate);
477 if (nwords > 0)
478 next_w = *in++;
479 i = add_ptr = (add_ptr - 1) & wordmask;
480 /*
481 * Normally, we add 7 bits of rotation to the pool.
482 * At the beginning of the pool, add an extra 7 bits
483 * rotation, so that successive passes spread the
484 * input bits across the pool evenly.
485 */
486 new_rotate = input_rotate + 14;
487 if (i)
488 new_rotate = input_rotate + 7;
489 input_rotate = new_rotate & 31;
490
491 /* XOR in the various taps */
492 w ^= r->pool[(i + tap1) & wordmask];
493 w ^= r->pool[(i + tap2) & wordmask];
494 w ^= r->pool[(i + tap3) & wordmask];
495 w ^= r->pool[(i + tap4) & wordmask];
496 w ^= r->pool[(i + tap5) & wordmask];
497 w ^= r->pool[i];
498 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
499 }
500
501 r->input_rotate = input_rotate;
502 r->add_ptr = add_ptr;
503
504 if (out) {
505 for (i = 0; i < 16; i++) {
506 out[i] = r->pool[add_ptr];
507 add_ptr = (add_ptr - 1) & wordmask;
508 }
509 }
510
511 spin_unlock_irqrestore(&r->lock, flags);
512}
513
514static inline void add_entropy_words(struct entropy_store *r, const __u32 *in,
515 int nwords)
516{
517 __add_entropy_words(r, in, nwords, NULL);
518}
519
520/*
521 * Credit (or debit) the entropy store with n bits of entropy
522 */
523static void credit_entropy_store(struct entropy_store *r, int nbits)
524{
525 unsigned long flags;
526
527 spin_lock_irqsave(&r->lock, flags);
528
529 if (r->entropy_count + nbits < 0) {
530 DEBUG_ENT("negative entropy/overflow (%d+%d)\n",
531 r->entropy_count, nbits);
532 r->entropy_count = 0;
533 } else if (r->entropy_count + nbits > r->poolinfo->POOLBITS) {
534 r->entropy_count = r->poolinfo->POOLBITS;
535 } else {
536 r->entropy_count += nbits;
537 if (nbits)
538 DEBUG_ENT("added %d entropy credits to %s\n",
539 nbits, r->name);
540 }
541
542 spin_unlock_irqrestore(&r->lock, flags);
543}
544
545/*********************************************************************
546 *
547 * Entropy input management
548 *
549 *********************************************************************/
550
551/* There is one of these per entropy source */
552struct timer_rand_state {
553 cycles_t last_time;
554 long last_delta,last_delta2;
555 unsigned dont_count_entropy:1;
556};
557
558static struct timer_rand_state input_timer_state;
559static struct timer_rand_state *irq_timer_state[NR_IRQS];
560
561/*
562 * This function adds entropy to the entropy "pool" by using timing
563 * delays. It uses the timer_rand_state structure to make an estimate
564 * of how many bits of entropy this call has added to the pool.
565 *
566 * The number "num" is also added to the pool - it should somehow describe
567 * the type of event which just happened. This is currently 0-255 for
568 * keyboard scan codes, and 256 upwards for interrupts.
569 *
570 */
571static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
572{
573 struct {
574 cycles_t cycles;
575 long jiffies;
576 unsigned num;
577 } sample;
578 long delta, delta2, delta3;
579
580 preempt_disable();
581 /* if over the trickle threshold, use only 1 in 4096 samples */
582 if (input_pool.entropy_count > trickle_thresh &&
583 (__get_cpu_var(trickle_count)++ & 0xfff))
584 goto out;
585
586 sample.jiffies = jiffies;
587 sample.cycles = get_cycles();
588 sample.num = num;
589 add_entropy_words(&input_pool, (u32 *)&sample, sizeof(sample)/4);
590
591 /*
592 * Calculate number of bits of randomness we probably added.
593 * We take into account the first, second and third-order deltas
594 * in order to make our estimate.
595 */
596
597 if (!state->dont_count_entropy) {
598 delta = sample.jiffies - state->last_time;
599 state->last_time = sample.jiffies;
600
601 delta2 = delta - state->last_delta;
602 state->last_delta = delta;
603
604 delta3 = delta2 - state->last_delta2;
605 state->last_delta2 = delta2;
606
607 if (delta < 0)
608 delta = -delta;
609 if (delta2 < 0)
610 delta2 = -delta2;
611 if (delta3 < 0)
612 delta3 = -delta3;
613 if (delta > delta2)
614 delta = delta2;
615 if (delta > delta3)
616 delta = delta3;
617
618 /*
619 * delta is now minimum absolute delta.
620 * Round down by 1 bit on general principles,
621 * and limit entropy entimate to 12 bits.
622 */
623 credit_entropy_store(&input_pool,
624 min_t(int, fls(delta>>1), 11));
625 }
626
627 if(input_pool.entropy_count >= random_read_wakeup_thresh)
628 wake_up_interruptible(&random_read_wait);
629
630out:
631 preempt_enable();
632}
633
Stephen Hemmingerd2515752006-01-11 12:17:38 -0800634void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 unsigned int value)
636{
637 static unsigned char last_value;
638
639 /* ignore autorepeat and the like */
640 if (value == last_value)
641 return;
642
643 DEBUG_ENT("input event\n");
644 last_value = value;
645 add_timer_randomness(&input_timer_state,
646 (type << 4) ^ code ^ (code >> 4) ^ value);
647}
648
649void add_interrupt_randomness(int irq)
650{
651 if (irq >= NR_IRQS || irq_timer_state[irq] == 0)
652 return;
653
654 DEBUG_ENT("irq event %d\n", irq);
655 add_timer_randomness(irq_timer_state[irq], 0x100 + irq);
656}
657
David Howells93614012006-09-30 20:45:40 +0200658#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659void add_disk_randomness(struct gendisk *disk)
660{
661 if (!disk || !disk->random)
662 return;
663 /* first major is 1, so we get >= 0x200 here */
664 DEBUG_ENT("disk event %d:%d\n", disk->major, disk->first_minor);
665
666 add_timer_randomness(disk->random,
667 0x100 + MKDEV(disk->major, disk->first_minor));
668}
669
670EXPORT_SYMBOL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +0200671#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
673#define EXTRACT_SIZE 10
674
675/*********************************************************************
676 *
677 * Entropy extraction routines
678 *
679 *********************************************************************/
680
681static ssize_t extract_entropy(struct entropy_store *r, void * buf,
682 size_t nbytes, int min, int rsvd);
683
684/*
685 * This utility inline function is responsible for transfering entropy
686 * from the primary pool to the secondary extraction pool. We make
687 * sure we pull enough for a 'catastrophic reseed'.
688 */
689static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
690{
691 __u32 tmp[OUTPUT_POOL_WORDS];
692
693 if (r->pull && r->entropy_count < nbytes * 8 &&
694 r->entropy_count < r->poolinfo->POOLBITS) {
695 int bytes = max_t(int, random_read_wakeup_thresh / 8,
696 min_t(int, nbytes, sizeof(tmp)));
697 int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
698
699 DEBUG_ENT("going to reseed %s with %d bits "
700 "(%d of %d requested)\n",
701 r->name, bytes * 8, nbytes * 8, r->entropy_count);
702
703 bytes=extract_entropy(r->pull, tmp, bytes,
704 random_read_wakeup_thresh / 8, rsvd);
705 add_entropy_words(r, tmp, (bytes + 3) / 4);
706 credit_entropy_store(r, bytes*8);
707 }
708}
709
710/*
711 * These functions extracts randomness from the "entropy pool", and
712 * returns it in a buffer.
713 *
714 * The min parameter specifies the minimum amount we can pull before
715 * failing to avoid races that defeat catastrophic reseeding while the
716 * reserved parameter indicates how much entropy we must leave in the
717 * pool after each pull to avoid starving other readers.
718 *
719 * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
720 */
721
722static size_t account(struct entropy_store *r, size_t nbytes, int min,
723 int reserved)
724{
725 unsigned long flags;
726
727 BUG_ON(r->entropy_count > r->poolinfo->POOLBITS);
728
729 /* Hold lock while accounting */
730 spin_lock_irqsave(&r->lock, flags);
731
732 DEBUG_ENT("trying to extract %d bits from %s\n",
733 nbytes * 8, r->name);
734
735 /* Can we pull enough? */
736 if (r->entropy_count / 8 < min + reserved) {
737 nbytes = 0;
738 } else {
739 /* If limited, never pull more than available */
740 if (r->limit && nbytes + reserved >= r->entropy_count / 8)
741 nbytes = r->entropy_count/8 - reserved;
742
743 if(r->entropy_count / 8 >= nbytes + reserved)
744 r->entropy_count -= nbytes*8;
745 else
746 r->entropy_count = reserved;
747
748 if (r->entropy_count < random_write_wakeup_thresh)
749 wake_up_interruptible(&random_write_wait);
750 }
751
752 DEBUG_ENT("debiting %d entropy credits from %s%s\n",
753 nbytes * 8, r->name, r->limit ? "" : " (unlimited)");
754
755 spin_unlock_irqrestore(&r->lock, flags);
756
757 return nbytes;
758}
759
760static void extract_buf(struct entropy_store *r, __u8 *out)
761{
762 int i, x;
763 __u32 data[16], buf[5 + SHA_WORKSPACE_WORDS];
764
765 sha_init(buf);
766 /*
767 * As we hash the pool, we mix intermediate values of
768 * the hash back into the pool. This eliminates
769 * backtracking attacks (where the attacker knows
770 * the state of the pool plus the current outputs, and
771 * attempts to find previous ouputs), unless the hash
772 * function can be inverted.
773 */
774 for (i = 0, x = 0; i < r->poolinfo->poolwords; i += 16, x+=2) {
775 sha_transform(buf, (__u8 *)r->pool+i, buf + 5);
776 add_entropy_words(r, &buf[x % 5], 1);
777 }
778
779 /*
780 * To avoid duplicates, we atomically extract a
781 * portion of the pool while mixing, and hash one
782 * final time.
783 */
784 __add_entropy_words(r, &buf[x % 5], 1, data);
785 sha_transform(buf, (__u8 *)data, buf + 5);
786
787 /*
788 * In case the hash function has some recognizable
789 * output pattern, we fold it in half.
790 */
791
792 buf[0] ^= buf[3];
793 buf[1] ^= buf[4];
794 buf[0] ^= rol32(buf[3], 16);
795 memcpy(out, buf, EXTRACT_SIZE);
796 memset(buf, 0, sizeof(buf));
797}
798
799static ssize_t extract_entropy(struct entropy_store *r, void * buf,
800 size_t nbytes, int min, int reserved)
801{
802 ssize_t ret = 0, i;
803 __u8 tmp[EXTRACT_SIZE];
804
805 xfer_secondary_pool(r, nbytes);
806 nbytes = account(r, nbytes, min, reserved);
807
808 while (nbytes) {
809 extract_buf(r, tmp);
810 i = min_t(int, nbytes, EXTRACT_SIZE);
811 memcpy(buf, tmp, i);
812 nbytes -= i;
813 buf += i;
814 ret += i;
815 }
816
817 /* Wipe data just returned from memory */
818 memset(tmp, 0, sizeof(tmp));
819
820 return ret;
821}
822
823static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
824 size_t nbytes)
825{
826 ssize_t ret = 0, i;
827 __u8 tmp[EXTRACT_SIZE];
828
829 xfer_secondary_pool(r, nbytes);
830 nbytes = account(r, nbytes, 0, 0);
831
832 while (nbytes) {
833 if (need_resched()) {
834 if (signal_pending(current)) {
835 if (ret == 0)
836 ret = -ERESTARTSYS;
837 break;
838 }
839 schedule();
840 }
841
842 extract_buf(r, tmp);
843 i = min_t(int, nbytes, EXTRACT_SIZE);
844 if (copy_to_user(buf, tmp, i)) {
845 ret = -EFAULT;
846 break;
847 }
848
849 nbytes -= i;
850 buf += i;
851 ret += i;
852 }
853
854 /* Wipe data just returned from memory */
855 memset(tmp, 0, sizeof(tmp));
856
857 return ret;
858}
859
860/*
861 * This function is the exported kernel interface. It returns some
862 * number of good random numbers, suitable for seeding TCP sequence
863 * numbers, etc.
864 */
865void get_random_bytes(void *buf, int nbytes)
866{
867 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
868}
869
870EXPORT_SYMBOL(get_random_bytes);
871
872/*
873 * init_std_data - initialize pool with system data
874 *
875 * @r: pool to initialize
876 *
877 * This function clears the pool's entropy count and mixes some system
878 * data into the pool to prepare it for use. The pool is not cleared
879 * as that can only decrease the entropy in the pool.
880 */
881static void init_std_data(struct entropy_store *r)
882{
883 struct timeval tv;
884 unsigned long flags;
885
886 spin_lock_irqsave(&r->lock, flags);
887 r->entropy_count = 0;
888 spin_unlock_irqrestore(&r->lock, flags);
889
890 do_gettimeofday(&tv);
891 add_entropy_words(r, (__u32 *)&tv, sizeof(tv)/4);
892 add_entropy_words(r, (__u32 *)&system_utsname,
893 sizeof(system_utsname)/4);
894}
895
896static int __init rand_initialize(void)
897{
898 init_std_data(&input_pool);
899 init_std_data(&blocking_pool);
900 init_std_data(&nonblocking_pool);
901 return 0;
902}
903module_init(rand_initialize);
904
905void rand_initialize_irq(int irq)
906{
907 struct timer_rand_state *state;
908
909 if (irq >= NR_IRQS || irq_timer_state[irq])
910 return;
911
912 /*
913 * If kmalloc returns null, we just won't use that entropy
914 * source.
915 */
916 state = kmalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
917 if (state) {
918 memset(state, 0, sizeof(struct timer_rand_state));
919 irq_timer_state[irq] = state;
920 }
921}
922
David Howells93614012006-09-30 20:45:40 +0200923#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924void rand_initialize_disk(struct gendisk *disk)
925{
926 struct timer_rand_state *state;
927
928 /*
929 * If kmalloc returns null, we just won't use that entropy
930 * source.
931 */
932 state = kmalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
933 if (state) {
934 memset(state, 0, sizeof(struct timer_rand_state));
935 disk->random = state;
936 }
937}
David Howells93614012006-09-30 20:45:40 +0200938#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
940static ssize_t
941random_read(struct file * file, char __user * buf, size_t nbytes, loff_t *ppos)
942{
943 ssize_t n, retval = 0, count = 0;
944
945 if (nbytes == 0)
946 return 0;
947
948 while (nbytes > 0) {
949 n = nbytes;
950 if (n > SEC_XFER_SIZE)
951 n = SEC_XFER_SIZE;
952
953 DEBUG_ENT("reading %d bits\n", n*8);
954
955 n = extract_entropy_user(&blocking_pool, buf, n);
956
957 DEBUG_ENT("read got %d bits (%d still needed)\n",
958 n*8, (nbytes-n)*8);
959
960 if (n == 0) {
961 if (file->f_flags & O_NONBLOCK) {
962 retval = -EAGAIN;
963 break;
964 }
965
966 DEBUG_ENT("sleeping?\n");
967
968 wait_event_interruptible(random_read_wait,
969 input_pool.entropy_count >=
970 random_read_wakeup_thresh);
971
972 DEBUG_ENT("awake\n");
973
974 if (signal_pending(current)) {
975 retval = -ERESTARTSYS;
976 break;
977 }
978
979 continue;
980 }
981
982 if (n < 0) {
983 retval = n;
984 break;
985 }
986 count += n;
987 buf += n;
988 nbytes -= n;
989 break; /* This break makes the device work */
990 /* like a named pipe */
991 }
992
993 /*
994 * If we gave the user some bytes, update the access time.
995 */
996 if (count)
997 file_accessed(file);
998
999 return (count ? count : retval);
1000}
1001
1002static ssize_t
1003urandom_read(struct file * file, char __user * buf,
1004 size_t nbytes, loff_t *ppos)
1005{
1006 return extract_entropy_user(&nonblocking_pool, buf, nbytes);
1007}
1008
1009static unsigned int
1010random_poll(struct file *file, poll_table * wait)
1011{
1012 unsigned int mask;
1013
1014 poll_wait(file, &random_read_wait, wait);
1015 poll_wait(file, &random_write_wait, wait);
1016 mask = 0;
1017 if (input_pool.entropy_count >= random_read_wakeup_thresh)
1018 mask |= POLLIN | POLLRDNORM;
1019 if (input_pool.entropy_count < random_write_wakeup_thresh)
1020 mask |= POLLOUT | POLLWRNORM;
1021 return mask;
1022}
1023
1024static ssize_t
1025random_write(struct file * file, const char __user * buffer,
1026 size_t count, loff_t *ppos)
1027{
1028 int ret = 0;
1029 size_t bytes;
1030 __u32 buf[16];
1031 const char __user *p = buffer;
1032 size_t c = count;
1033
1034 while (c > 0) {
1035 bytes = min(c, sizeof(buf));
1036
1037 bytes -= copy_from_user(&buf, p, bytes);
1038 if (!bytes) {
1039 ret = -EFAULT;
1040 break;
1041 }
1042 c -= bytes;
1043 p += bytes;
1044
1045 add_entropy_words(&input_pool, buf, (bytes + 3) / 4);
1046 }
1047 if (p == buffer) {
1048 return (ssize_t)ret;
1049 } else {
1050 struct inode *inode = file->f_dentry->d_inode;
1051 inode->i_mtime = current_fs_time(inode->i_sb);
1052 mark_inode_dirty(inode);
1053 return (ssize_t)(p - buffer);
1054 }
1055}
1056
1057static int
1058random_ioctl(struct inode * inode, struct file * file,
1059 unsigned int cmd, unsigned long arg)
1060{
1061 int size, ent_count;
1062 int __user *p = (int __user *)arg;
1063 int retval;
1064
1065 switch (cmd) {
1066 case RNDGETENTCNT:
1067 ent_count = input_pool.entropy_count;
1068 if (put_user(ent_count, p))
1069 return -EFAULT;
1070 return 0;
1071 case RNDADDTOENTCNT:
1072 if (!capable(CAP_SYS_ADMIN))
1073 return -EPERM;
1074 if (get_user(ent_count, p))
1075 return -EFAULT;
1076 credit_entropy_store(&input_pool, ent_count);
1077 /*
1078 * Wake up waiting processes if we have enough
1079 * entropy.
1080 */
1081 if (input_pool.entropy_count >= random_read_wakeup_thresh)
1082 wake_up_interruptible(&random_read_wait);
1083 return 0;
1084 case RNDADDENTROPY:
1085 if (!capable(CAP_SYS_ADMIN))
1086 return -EPERM;
1087 if (get_user(ent_count, p++))
1088 return -EFAULT;
1089 if (ent_count < 0)
1090 return -EINVAL;
1091 if (get_user(size, p++))
1092 return -EFAULT;
1093 retval = random_write(file, (const char __user *) p,
1094 size, &file->f_pos);
1095 if (retval < 0)
1096 return retval;
1097 credit_entropy_store(&input_pool, ent_count);
1098 /*
1099 * Wake up waiting processes if we have enough
1100 * entropy.
1101 */
1102 if (input_pool.entropy_count >= random_read_wakeup_thresh)
1103 wake_up_interruptible(&random_read_wait);
1104 return 0;
1105 case RNDZAPENTCNT:
1106 case RNDCLEARPOOL:
1107 /* Clear the entropy pool counters. */
1108 if (!capable(CAP_SYS_ADMIN))
1109 return -EPERM;
1110 init_std_data(&input_pool);
1111 init_std_data(&blocking_pool);
1112 init_std_data(&nonblocking_pool);
1113 return 0;
1114 default:
1115 return -EINVAL;
1116 }
1117}
1118
1119struct file_operations random_fops = {
1120 .read = random_read,
1121 .write = random_write,
1122 .poll = random_poll,
1123 .ioctl = random_ioctl,
1124};
1125
1126struct file_operations urandom_fops = {
1127 .read = urandom_read,
1128 .write = random_write,
1129 .ioctl = random_ioctl,
1130};
1131
1132/***************************************************************
1133 * Random UUID interface
1134 *
1135 * Used here for a Boot ID, but can be useful for other kernel
1136 * drivers.
1137 ***************************************************************/
1138
1139/*
1140 * Generate random UUID
1141 */
1142void generate_random_uuid(unsigned char uuid_out[16])
1143{
1144 get_random_bytes(uuid_out, 16);
1145 /* Set UUID version to 4 --- truely random generation */
1146 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1147 /* Set the UUID variant to DCE */
1148 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1149}
1150
1151EXPORT_SYMBOL(generate_random_uuid);
1152
1153/********************************************************************
1154 *
1155 * Sysctl interface
1156 *
1157 ********************************************************************/
1158
1159#ifdef CONFIG_SYSCTL
1160
1161#include <linux/sysctl.h>
1162
1163static int min_read_thresh = 8, min_write_thresh;
1164static int max_read_thresh = INPUT_POOL_WORDS * 32;
1165static int max_write_thresh = INPUT_POOL_WORDS * 32;
1166static char sysctl_bootid[16];
1167
1168/*
1169 * These functions is used to return both the bootid UUID, and random
1170 * UUID. The difference is in whether table->data is NULL; if it is,
1171 * then a new UUID is generated and returned to the user.
1172 *
1173 * If the user accesses this via the proc interface, it will be returned
1174 * as an ASCII string in the standard UUID format. If accesses via the
1175 * sysctl system call, it is returned as 16 bytes of binary data.
1176 */
1177static int proc_do_uuid(ctl_table *table, int write, struct file *filp,
1178 void __user *buffer, size_t *lenp, loff_t *ppos)
1179{
1180 ctl_table fake_table;
1181 unsigned char buf[64], tmp_uuid[16], *uuid;
1182
1183 uuid = table->data;
1184 if (!uuid) {
1185 uuid = tmp_uuid;
1186 uuid[8] = 0;
1187 }
1188 if (uuid[8] == 0)
1189 generate_random_uuid(uuid);
1190
1191 sprintf(buf, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-"
1192 "%02x%02x%02x%02x%02x%02x",
1193 uuid[0], uuid[1], uuid[2], uuid[3],
1194 uuid[4], uuid[5], uuid[6], uuid[7],
1195 uuid[8], uuid[9], uuid[10], uuid[11],
1196 uuid[12], uuid[13], uuid[14], uuid[15]);
1197 fake_table.data = buf;
1198 fake_table.maxlen = sizeof(buf);
1199
1200 return proc_dostring(&fake_table, write, filp, buffer, lenp, ppos);
1201}
1202
1203static int uuid_strategy(ctl_table *table, int __user *name, int nlen,
1204 void __user *oldval, size_t __user *oldlenp,
1205 void __user *newval, size_t newlen, void **context)
1206{
1207 unsigned char tmp_uuid[16], *uuid;
1208 unsigned int len;
1209
1210 if (!oldval || !oldlenp)
1211 return 1;
1212
1213 uuid = table->data;
1214 if (!uuid) {
1215 uuid = tmp_uuid;
1216 uuid[8] = 0;
1217 }
1218 if (uuid[8] == 0)
1219 generate_random_uuid(uuid);
1220
1221 if (get_user(len, oldlenp))
1222 return -EFAULT;
1223 if (len) {
1224 if (len > 16)
1225 len = 16;
1226 if (copy_to_user(oldval, uuid, len) ||
1227 put_user(len, oldlenp))
1228 return -EFAULT;
1229 }
1230 return 1;
1231}
1232
1233static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
1234ctl_table random_table[] = {
1235 {
1236 .ctl_name = RANDOM_POOLSIZE,
1237 .procname = "poolsize",
1238 .data = &sysctl_poolsize,
1239 .maxlen = sizeof(int),
1240 .mode = 0444,
1241 .proc_handler = &proc_dointvec,
1242 },
1243 {
1244 .ctl_name = RANDOM_ENTROPY_COUNT,
1245 .procname = "entropy_avail",
1246 .maxlen = sizeof(int),
1247 .mode = 0444,
1248 .proc_handler = &proc_dointvec,
1249 .data = &input_pool.entropy_count,
1250 },
1251 {
1252 .ctl_name = RANDOM_READ_THRESH,
1253 .procname = "read_wakeup_threshold",
1254 .data = &random_read_wakeup_thresh,
1255 .maxlen = sizeof(int),
1256 .mode = 0644,
1257 .proc_handler = &proc_dointvec_minmax,
1258 .strategy = &sysctl_intvec,
1259 .extra1 = &min_read_thresh,
1260 .extra2 = &max_read_thresh,
1261 },
1262 {
1263 .ctl_name = RANDOM_WRITE_THRESH,
1264 .procname = "write_wakeup_threshold",
1265 .data = &random_write_wakeup_thresh,
1266 .maxlen = sizeof(int),
1267 .mode = 0644,
1268 .proc_handler = &proc_dointvec_minmax,
1269 .strategy = &sysctl_intvec,
1270 .extra1 = &min_write_thresh,
1271 .extra2 = &max_write_thresh,
1272 },
1273 {
1274 .ctl_name = RANDOM_BOOT_ID,
1275 .procname = "boot_id",
1276 .data = &sysctl_bootid,
1277 .maxlen = 16,
1278 .mode = 0444,
1279 .proc_handler = &proc_do_uuid,
1280 .strategy = &uuid_strategy,
1281 },
1282 {
1283 .ctl_name = RANDOM_UUID,
1284 .procname = "uuid",
1285 .maxlen = 16,
1286 .mode = 0444,
1287 .proc_handler = &proc_do_uuid,
1288 .strategy = &uuid_strategy,
1289 },
1290 { .ctl_name = 0 }
1291};
1292#endif /* CONFIG_SYSCTL */
1293
1294/********************************************************************
1295 *
1296 * Random funtions for networking
1297 *
1298 ********************************************************************/
1299
1300/*
1301 * TCP initial sequence number picking. This uses the random number
1302 * generator to pick an initial secret value. This value is hashed
1303 * along with the TCP endpoint information to provide a unique
1304 * starting point for each pair of TCP endpoints. This defeats
1305 * attacks which rely on guessing the initial TCP sequence number.
1306 * This algorithm was suggested by Steve Bellovin.
1307 *
1308 * Using a very strong hash was taking an appreciable amount of the total
1309 * TCP connection establishment time, so this is a weaker hash,
1310 * compensated for by changing the secret periodically.
1311 */
1312
1313/* F, G and H are basic MD4 functions: selection, majority, parity */
1314#define F(x, y, z) ((z) ^ ((x) & ((y) ^ (z))))
1315#define G(x, y, z) (((x) & (y)) + (((x) ^ (y)) & (z)))
1316#define H(x, y, z) ((x) ^ (y) ^ (z))
1317
1318/*
1319 * The generic round function. The application is so specific that
1320 * we don't bother protecting all the arguments with parens, as is generally
1321 * good macro practice, in favor of extra legibility.
1322 * Rotation is separate from addition to prevent recomputation
1323 */
1324#define ROUND(f, a, b, c, d, x, s) \
1325 (a += f(b, c, d) + x, a = (a << s) | (a >> (32 - s)))
1326#define K1 0
1327#define K2 013240474631UL
1328#define K3 015666365641UL
1329
1330#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
1331
1332static __u32 twothirdsMD4Transform (__u32 const buf[4], __u32 const in[12])
1333{
1334 __u32 a = buf[0], b = buf[1], c = buf[2], d = buf[3];
1335
1336 /* Round 1 */
1337 ROUND(F, a, b, c, d, in[ 0] + K1, 3);
1338 ROUND(F, d, a, b, c, in[ 1] + K1, 7);
1339 ROUND(F, c, d, a, b, in[ 2] + K1, 11);
1340 ROUND(F, b, c, d, a, in[ 3] + K1, 19);
1341 ROUND(F, a, b, c, d, in[ 4] + K1, 3);
1342 ROUND(F, d, a, b, c, in[ 5] + K1, 7);
1343 ROUND(F, c, d, a, b, in[ 6] + K1, 11);
1344 ROUND(F, b, c, d, a, in[ 7] + K1, 19);
1345 ROUND(F, a, b, c, d, in[ 8] + K1, 3);
1346 ROUND(F, d, a, b, c, in[ 9] + K1, 7);
1347 ROUND(F, c, d, a, b, in[10] + K1, 11);
1348 ROUND(F, b, c, d, a, in[11] + K1, 19);
1349
1350 /* Round 2 */
1351 ROUND(G, a, b, c, d, in[ 1] + K2, 3);
1352 ROUND(G, d, a, b, c, in[ 3] + K2, 5);
1353 ROUND(G, c, d, a, b, in[ 5] + K2, 9);
1354 ROUND(G, b, c, d, a, in[ 7] + K2, 13);
1355 ROUND(G, a, b, c, d, in[ 9] + K2, 3);
1356 ROUND(G, d, a, b, c, in[11] + K2, 5);
1357 ROUND(G, c, d, a, b, in[ 0] + K2, 9);
1358 ROUND(G, b, c, d, a, in[ 2] + K2, 13);
1359 ROUND(G, a, b, c, d, in[ 4] + K2, 3);
1360 ROUND(G, d, a, b, c, in[ 6] + K2, 5);
1361 ROUND(G, c, d, a, b, in[ 8] + K2, 9);
1362 ROUND(G, b, c, d, a, in[10] + K2, 13);
1363
1364 /* Round 3 */
1365 ROUND(H, a, b, c, d, in[ 3] + K3, 3);
1366 ROUND(H, d, a, b, c, in[ 7] + K3, 9);
1367 ROUND(H, c, d, a, b, in[11] + K3, 11);
1368 ROUND(H, b, c, d, a, in[ 2] + K3, 15);
1369 ROUND(H, a, b, c, d, in[ 6] + K3, 3);
1370 ROUND(H, d, a, b, c, in[10] + K3, 9);
1371 ROUND(H, c, d, a, b, in[ 1] + K3, 11);
1372 ROUND(H, b, c, d, a, in[ 5] + K3, 15);
1373 ROUND(H, a, b, c, d, in[ 9] + K3, 3);
1374 ROUND(H, d, a, b, c, in[ 0] + K3, 9);
1375 ROUND(H, c, d, a, b, in[ 4] + K3, 11);
1376 ROUND(H, b, c, d, a, in[ 8] + K3, 15);
1377
1378 return buf[1] + b; /* "most hashed" word */
1379 /* Alternative: return sum of all words? */
1380}
1381#endif
1382
1383#undef ROUND
1384#undef F
1385#undef G
1386#undef H
1387#undef K1
1388#undef K2
1389#undef K3
1390
1391/* This should not be decreased so low that ISNs wrap too fast. */
1392#define REKEY_INTERVAL (300 * HZ)
1393/*
1394 * Bit layout of the tcp sequence numbers (before adding current time):
1395 * bit 24-31: increased after every key exchange
1396 * bit 0-23: hash(source,dest)
1397 *
1398 * The implementation is similar to the algorithm described
1399 * in the Appendix of RFC 1185, except that
1400 * - it uses a 1 MHz clock instead of a 250 kHz clock
1401 * - it performs a rekey every 5 minutes, which is equivalent
1402 * to a (source,dest) tulple dependent forward jump of the
1403 * clock by 0..2^(HASH_BITS+1)
1404 *
1405 * Thus the average ISN wraparound time is 68 minutes instead of
1406 * 4.55 hours.
1407 *
1408 * SMP cleanup and lock avoidance with poor man's RCU.
1409 * Manfred Spraul <manfred@colorfullife.com>
1410 *
1411 */
1412#define COUNT_BITS 8
1413#define COUNT_MASK ((1 << COUNT_BITS) - 1)
1414#define HASH_BITS 24
1415#define HASH_MASK ((1 << HASH_BITS) - 1)
1416
1417static struct keydata {
1418 __u32 count; /* already shifted to the final position */
1419 __u32 secret[12];
1420} ____cacheline_aligned ip_keydata[2];
1421
1422static unsigned int ip_cnt;
1423
1424static void rekey_seq_generator(void *private_);
1425
1426static DECLARE_WORK(rekey_work, rekey_seq_generator, NULL);
1427
1428/*
1429 * Lock avoidance:
1430 * The ISN generation runs lockless - it's just a hash over random data.
1431 * State changes happen every 5 minutes when the random key is replaced.
1432 * Synchronization is performed by having two copies of the hash function
1433 * state and rekey_seq_generator always updates the inactive copy.
1434 * The copy is then activated by updating ip_cnt.
1435 * The implementation breaks down if someone blocks the thread
1436 * that processes SYN requests for more than 5 minutes. Should never
1437 * happen, and even if that happens only a not perfectly compliant
1438 * ISN is generated, nothing fatal.
1439 */
1440static void rekey_seq_generator(void *private_)
1441{
1442 struct keydata *keyptr = &ip_keydata[1 ^ (ip_cnt & 1)];
1443
1444 get_random_bytes(keyptr->secret, sizeof(keyptr->secret));
1445 keyptr->count = (ip_cnt & COUNT_MASK) << HASH_BITS;
1446 smp_wmb();
1447 ip_cnt++;
1448 schedule_delayed_work(&rekey_work, REKEY_INTERVAL);
1449}
1450
1451static inline struct keydata *get_keyptr(void)
1452{
1453 struct keydata *keyptr = &ip_keydata[ip_cnt & 1];
1454
1455 smp_rmb();
1456
1457 return keyptr;
1458}
1459
1460static __init int seqgen_init(void)
1461{
1462 rekey_seq_generator(NULL);
1463 return 0;
1464}
1465late_initcall(seqgen_init);
1466
1467#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
1468__u32 secure_tcpv6_sequence_number(__u32 *saddr, __u32 *daddr,
1469 __u16 sport, __u16 dport)
1470{
1471 struct timeval tv;
1472 __u32 seq;
1473 __u32 hash[12];
1474 struct keydata *keyptr = get_keyptr();
1475
1476 /* The procedure is the same as for IPv4, but addresses are longer.
1477 * Thus we must use twothirdsMD4Transform.
1478 */
1479
1480 memcpy(hash, saddr, 16);
1481 hash[4]=(sport << 16) + dport;
1482 memcpy(&hash[5],keyptr->secret,sizeof(__u32) * 7);
1483
1484 seq = twothirdsMD4Transform(daddr, hash) & HASH_MASK;
1485 seq += keyptr->count;
1486
1487 do_gettimeofday(&tv);
1488 seq += tv.tv_usec + tv.tv_sec * 1000000;
1489
1490 return seq;
1491}
1492EXPORT_SYMBOL(secure_tcpv6_sequence_number);
1493#endif
1494
1495/* The code below is shamelessly stolen from secure_tcp_sequence_number().
1496 * All blames to Andrey V. Savochkin <saw@msu.ru>.
1497 */
1498__u32 secure_ip_id(__u32 daddr)
1499{
1500 struct keydata *keyptr;
1501 __u32 hash[4];
1502
1503 keyptr = get_keyptr();
1504
1505 /*
1506 * Pick a unique starting offset for each IP destination.
1507 * The dest ip address is placed in the starting vector,
1508 * which is then hashed with random data.
1509 */
1510 hash[0] = daddr;
1511 hash[1] = keyptr->secret[9];
1512 hash[2] = keyptr->secret[10];
1513 hash[3] = keyptr->secret[11];
1514
1515 return half_md4_transform(hash, keyptr->secret);
1516}
1517
1518#ifdef CONFIG_INET
1519
1520__u32 secure_tcp_sequence_number(__u32 saddr, __u32 daddr,
1521 __u16 sport, __u16 dport)
1522{
1523 struct timeval tv;
1524 __u32 seq;
1525 __u32 hash[4];
1526 struct keydata *keyptr = get_keyptr();
1527
1528 /*
1529 * Pick a unique starting offset for each TCP connection endpoints
1530 * (saddr, daddr, sport, dport).
1531 * Note that the words are placed into the starting vector, which is
1532 * then mixed with a partial MD4 over random data.
1533 */
1534 hash[0]=saddr;
1535 hash[1]=daddr;
1536 hash[2]=(sport << 16) + dport;
1537 hash[3]=keyptr->secret[11];
1538
1539 seq = half_md4_transform(hash, keyptr->secret) & HASH_MASK;
1540 seq += keyptr->count;
1541 /*
1542 * As close as possible to RFC 793, which
1543 * suggests using a 250 kHz clock.
1544 * Further reading shows this assumes 2 Mb/s networks.
1545 * For 10 Mb/s Ethernet, a 1 MHz clock is appropriate.
1546 * That's funny, Linux has one built in! Use it!
1547 * (Networks are faster now - should this be increased?)
1548 */
1549 do_gettimeofday(&tv);
1550 seq += tv.tv_usec + tv.tv_sec * 1000000;
1551#if 0
1552 printk("init_seq(%lx, %lx, %d, %d) = %d\n",
1553 saddr, daddr, sport, dport, seq);
1554#endif
1555 return seq;
1556}
1557
1558EXPORT_SYMBOL(secure_tcp_sequence_number);
1559
Arnaldo Carvalho de Meloa7f5e7f2005-12-13 23:25:31 -08001560/* Generate secure starting point for ephemeral IPV4 transport port search */
1561u32 secure_ipv4_port_ephemeral(__u32 saddr, __u32 daddr, __u16 dport)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562{
1563 struct keydata *keyptr = get_keyptr();
1564 u32 hash[4];
1565
1566 /*
1567 * Pick a unique starting offset for each ephemeral port search
1568 * (saddr, daddr, dport) and 48bits of random data.
1569 */
1570 hash[0] = saddr;
1571 hash[1] = daddr;
1572 hash[2] = dport ^ keyptr->secret[10];
1573 hash[3] = keyptr->secret[11];
1574
1575 return half_md4_transform(hash, keyptr->secret);
1576}
1577
1578#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
Arnaldo Carvalho de Melod8313f52005-12-13 23:25:44 -08001579u32 secure_ipv6_port_ephemeral(const __u32 *saddr, const __u32 *daddr, __u16 dport)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580{
1581 struct keydata *keyptr = get_keyptr();
1582 u32 hash[12];
1583
1584 memcpy(hash, saddr, 16);
1585 hash[4] = dport;
1586 memcpy(&hash[5],keyptr->secret,sizeof(__u32) * 7);
1587
1588 return twothirdsMD4Transform(daddr, hash);
1589}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590#endif
1591
Arnaldo Carvalho de Meloc4365c92005-08-09 20:12:30 -07001592#if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
1593/* Similar to secure_tcp_sequence_number but generate a 48 bit value
1594 * bit's 32-47 increase every key exchange
1595 * 0-31 hash(source, dest)
1596 */
1597u64 secure_dccp_sequence_number(__u32 saddr, __u32 daddr,
1598 __u16 sport, __u16 dport)
1599{
1600 struct timeval tv;
1601 u64 seq;
1602 __u32 hash[4];
1603 struct keydata *keyptr = get_keyptr();
1604
1605 hash[0] = saddr;
1606 hash[1] = daddr;
1607 hash[2] = (sport << 16) + dport;
1608 hash[3] = keyptr->secret[11];
1609
1610 seq = half_md4_transform(hash, keyptr->secret);
1611 seq |= ((u64)keyptr->count) << (32 - HASH_BITS);
1612
1613 do_gettimeofday(&tv);
1614 seq += tv.tv_usec + tv.tv_sec * 1000000;
1615 seq &= (1ull << 48) - 1;
1616#if 0
1617 printk("dccp init_seq(%lx, %lx, %d, %d) = %d\n",
1618 saddr, daddr, sport, dport, seq);
1619#endif
1620 return seq;
1621}
1622
1623EXPORT_SYMBOL(secure_dccp_sequence_number);
1624#endif
1625
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626#endif /* CONFIG_INET */
1627
1628
1629/*
1630 * Get a random word for internal kernel use only. Similar to urandom but
1631 * with the goal of minimal entropy pool depletion. As a result, the random
1632 * value is not cryptographically secure but for several uses the cost of
1633 * depleting entropy is too high
1634 */
1635unsigned int get_random_int(void)
1636{
1637 /*
1638 * Use IP's RNG. It suits our purpose perfectly: it re-keys itself
1639 * every second, from the entropy pool (and thus creates a limited
1640 * drain on it), and uses halfMD4Transform within the second. We
1641 * also mix it with jiffies and the PID:
1642 */
1643 return secure_ip_id(current->pid + jiffies);
1644}
1645
1646/*
1647 * randomize_range() returns a start address such that
1648 *
1649 * [...... <range> .....]
1650 * start end
1651 *
1652 * a <range> with size "len" starting at the return value is inside in the
1653 * area defined by [start, end], but is otherwise randomized.
1654 */
1655unsigned long
1656randomize_range(unsigned long start, unsigned long end, unsigned long len)
1657{
1658 unsigned long range = end - len - start;
1659
1660 if (end <= start + len)
1661 return 0;
1662 return PAGE_ALIGN(get_random_int() % range + start);
1663}