Merge git://git.kernel.org/pub/scm/linux/kernel/git/sam/kbuild-fixes
[linux-2.6-block.git] / drivers / char / random.c
CommitLineData
1da177e4
LT
1/*
2 * random.c -- A strong random number generator
3 *
9e95ce27 4 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
1da177e4
LT
5 *
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>
1da177e4
LT
227#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>
27ac792c 239#include <linux/mm.h>
1da177e4
LT
240#include <linux/spinlock.h>
241#include <linux/percpu.h>
242#include <linux/cryptohash.h>
243
244#include <asm/processor.h>
245#include <asm/uaccess.h>
246#include <asm/irq.h>
247#include <asm/io.h>
248
249/*
250 * Configuration information
251 */
252#define INPUT_POOL_WORDS 128
253#define OUTPUT_POOL_WORDS 32
254#define SEC_XFER_SIZE 512
255
256/*
257 * The minimum number of bits of entropy before we wake up a read on
258 * /dev/random. Should be enough to do a significant reseed.
259 */
260static int random_read_wakeup_thresh = 64;
261
262/*
263 * If the entropy count falls under this number of bits, then we
264 * should wake up processes which are selecting or polling on write
265 * access to /dev/random.
266 */
267static int random_write_wakeup_thresh = 128;
268
269/*
270 * When the input pool goes over trickle_thresh, start dropping most
271 * samples to avoid wasting CPU time and reduce lock contention.
272 */
273
6c036527 274static int trickle_thresh __read_mostly = INPUT_POOL_WORDS * 28;
1da177e4 275
90b75ee5 276static DEFINE_PER_CPU(int, trickle_count);
1da177e4
LT
277
278/*
279 * A pool of size .poolwords is stirred with a primitive polynomial
280 * of degree .poolwords over GF(2). The taps for various sizes are
281 * defined below. They are chosen to be evenly spaced (minimum RMS
282 * distance from evenly spaced; the numbers in the comments are a
283 * scaled squared error sum) except for the last tap, which is 1 to
284 * get the twisting happening as fast as possible.
285 */
286static struct poolinfo {
287 int poolwords;
288 int tap1, tap2, tap3, tap4, tap5;
289} poolinfo_table[] = {
290 /* x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 -- 105 */
291 { 128, 103, 76, 51, 25, 1 },
292 /* x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 -- 15 */
293 { 32, 26, 20, 14, 7, 1 },
294#if 0
295 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
296 { 2048, 1638, 1231, 819, 411, 1 },
297
298 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
299 { 1024, 817, 615, 412, 204, 1 },
300
301 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
302 { 1024, 819, 616, 410, 207, 2 },
303
304 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
305 { 512, 411, 308, 208, 104, 1 },
306
307 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
308 { 512, 409, 307, 206, 102, 2 },
309 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
310 { 512, 409, 309, 205, 103, 2 },
311
312 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
313 { 256, 205, 155, 101, 52, 1 },
314
315 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
316 { 128, 103, 78, 51, 27, 2 },
317
318 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
319 { 64, 52, 39, 26, 14, 1 },
320#endif
321};
322
323#define POOLBITS poolwords*32
324#define POOLBYTES poolwords*4
325
326/*
327 * For the purposes of better mixing, we use the CRC-32 polynomial as
328 * well to make a twisted Generalized Feedback Shift Reigster
329 *
330 * (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR generators. ACM
331 * Transactions on Modeling and Computer Simulation 2(3):179-194.
332 * Also see M. Matsumoto & Y. Kurita, 1994. Twisted GFSR generators
333 * II. ACM Transactions on Mdeling and Computer Simulation 4:254-266)
334 *
335 * Thanks to Colin Plumb for suggesting this.
336 *
337 * We have not analyzed the resultant polynomial to prove it primitive;
338 * in fact it almost certainly isn't. Nonetheless, the irreducible factors
339 * of a random large-degree polynomial over GF(2) are more than large enough
340 * that periodicity is not a concern.
341 *
342 * The input hash is much less sensitive than the output hash. All
343 * that we want of it is that it be a good non-cryptographic hash;
344 * i.e. it not produce collisions when fed "random" data of the sort
345 * we expect to see. As long as the pool state differs for different
346 * inputs, we have preserved the input entropy and done a good job.
347 * The fact that an intelligent attacker can construct inputs that
348 * will produce controlled alterations to the pool's state is not
349 * important because we don't consider such inputs to contribute any
350 * randomness. The only property we need with respect to them is that
351 * the attacker can't increase his/her knowledge of the pool's state.
352 * Since all additions are reversible (knowing the final state and the
353 * input, you can reconstruct the initial state), if an attacker has
354 * any uncertainty about the initial state, he/she can only shuffle
355 * that uncertainty about, but never cause any collisions (which would
356 * decrease the uncertainty).
357 *
358 * The chosen system lets the state of the pool be (essentially) the input
359 * modulo the generator polymnomial. Now, for random primitive polynomials,
360 * this is a universal class of hash functions, meaning that the chance
361 * of a collision is limited by the attacker's knowledge of the generator
362 * polynomail, so if it is chosen at random, an attacker can never force
363 * a collision. Here, we use a fixed polynomial, but we *can* assume that
364 * ###--> it is unknown to the processes generating the input entropy. <-###
365 * Because of this important property, this is a good, collision-resistant
366 * hash; hash collisions will occur no more often than chance.
367 */
368
369/*
370 * Static global variables
371 */
372static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
373static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
9a6f70bb 374static struct fasync_struct *fasync;
1da177e4
LT
375
376#if 0
90b75ee5 377static int debug;
1da177e4 378module_param(debug, bool, 0644);
90b75ee5
MM
379#define DEBUG_ENT(fmt, arg...) do { \
380 if (debug) \
381 printk(KERN_DEBUG "random %04d %04d %04d: " \
382 fmt,\
383 input_pool.entropy_count,\
384 blocking_pool.entropy_count,\
385 nonblocking_pool.entropy_count,\
386 ## arg); } while (0)
1da177e4
LT
387#else
388#define DEBUG_ENT(fmt, arg...) do {} while (0)
389#endif
390
391/**********************************************************************
392 *
393 * OS independent entropy store. Here are the functions which handle
394 * storing entropy in an entropy pool.
395 *
396 **********************************************************************/
397
398struct entropy_store;
399struct entropy_store {
43358209 400 /* read-only data: */
1da177e4
LT
401 struct poolinfo *poolinfo;
402 __u32 *pool;
403 const char *name;
404 int limit;
405 struct entropy_store *pull;
406
407 /* read-write data: */
43358209 408 spinlock_t lock;
1da177e4 409 unsigned add_ptr;
8b76f46a 410 int entropy_count; /* Must at no time exceed ->POOLBITS! */
1da177e4
LT
411 int input_rotate;
412};
413
414static __u32 input_pool_data[INPUT_POOL_WORDS];
415static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
416static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
417
418static struct entropy_store input_pool = {
419 .poolinfo = &poolinfo_table[0],
420 .name = "input",
421 .limit = 1,
e4d91918 422 .lock = __SPIN_LOCK_UNLOCKED(&input_pool.lock),
1da177e4
LT
423 .pool = input_pool_data
424};
425
426static struct entropy_store blocking_pool = {
427 .poolinfo = &poolinfo_table[1],
428 .name = "blocking",
429 .limit = 1,
430 .pull = &input_pool,
e4d91918 431 .lock = __SPIN_LOCK_UNLOCKED(&blocking_pool.lock),
1da177e4
LT
432 .pool = blocking_pool_data
433};
434
435static struct entropy_store nonblocking_pool = {
436 .poolinfo = &poolinfo_table[1],
437 .name = "nonblocking",
438 .pull = &input_pool,
e4d91918 439 .lock = __SPIN_LOCK_UNLOCKED(&nonblocking_pool.lock),
1da177e4
LT
440 .pool = nonblocking_pool_data
441};
442
443/*
e68e5b66 444 * This function adds bytes into the entropy "pool". It does not
1da177e4 445 * update the entropy estimate. The caller should call
adc782da 446 * credit_entropy_bits if this is appropriate.
1da177e4
LT
447 *
448 * The pool is stirred with a primitive polynomial of the appropriate
449 * degree, and then twisted. We twist by three bits at a time because
450 * it's cheap to do so and helps slightly in the expected case where
451 * the entropy is concentrated in the low-order bits.
452 */
e68e5b66
MM
453static void mix_pool_bytes_extract(struct entropy_store *r, const void *in,
454 int nbytes, __u8 out[64])
1da177e4
LT
455{
456 static __u32 const twist_table[8] = {
457 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
458 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
993ba211 459 unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
feee7697 460 int input_rotate;
1da177e4 461 int wordmask = r->poolinfo->poolwords - 1;
e68e5b66 462 const char *bytes = in;
6d38b827 463 __u32 w;
1da177e4
LT
464 unsigned long flags;
465
466 /* Taps are constant, so we can load them without holding r->lock. */
467 tap1 = r->poolinfo->tap1;
468 tap2 = r->poolinfo->tap2;
469 tap3 = r->poolinfo->tap3;
470 tap4 = r->poolinfo->tap4;
471 tap5 = r->poolinfo->tap5;
1da177e4
LT
472
473 spin_lock_irqsave(&r->lock, flags);
1da177e4 474 input_rotate = r->input_rotate;
993ba211 475 i = r->add_ptr;
1da177e4 476
e68e5b66
MM
477 /* mix one byte at a time to simplify size handling and churn faster */
478 while (nbytes--) {
479 w = rol32(*bytes++, input_rotate & 31);
993ba211 480 i = (i - 1) & wordmask;
1da177e4
LT
481
482 /* XOR in the various taps */
993ba211 483 w ^= r->pool[i];
1da177e4
LT
484 w ^= r->pool[(i + tap1) & wordmask];
485 w ^= r->pool[(i + tap2) & wordmask];
486 w ^= r->pool[(i + tap3) & wordmask];
487 w ^= r->pool[(i + tap4) & wordmask];
488 w ^= r->pool[(i + tap5) & wordmask];
993ba211
MM
489
490 /* Mix the result back in with a twist */
1da177e4 491 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
feee7697
MM
492
493 /*
494 * Normally, we add 7 bits of rotation to the pool.
495 * At the beginning of the pool, add an extra 7 bits
496 * rotation, so that successive passes spread the
497 * input bits across the pool evenly.
498 */
499 input_rotate += i ? 7 : 14;
1da177e4
LT
500 }
501
502 r->input_rotate = input_rotate;
993ba211 503 r->add_ptr = i;
1da177e4 504
993ba211
MM
505 if (out)
506 for (j = 0; j < 16; j++)
e68e5b66 507 ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
1da177e4
LT
508
509 spin_unlock_irqrestore(&r->lock, flags);
510}
511
e68e5b66 512static void mix_pool_bytes(struct entropy_store *r, const void *in, int bytes)
1da177e4 513{
e68e5b66 514 mix_pool_bytes_extract(r, in, bytes, NULL);
1da177e4
LT
515}
516
517/*
518 * Credit (or debit) the entropy store with n bits of entropy
519 */
adc782da 520static void credit_entropy_bits(struct entropy_store *r, int nbits)
1da177e4
LT
521{
522 unsigned long flags;
8b76f46a 523 int entropy_count;
1da177e4 524
adc782da
MM
525 if (!nbits)
526 return;
527
1da177e4
LT
528 spin_lock_irqsave(&r->lock, flags);
529
adc782da 530 DEBUG_ENT("added %d entropy credits to %s\n", nbits, r->name);
8b76f46a
AM
531 entropy_count = r->entropy_count;
532 entropy_count += nbits;
533 if (entropy_count < 0) {
adc782da 534 DEBUG_ENT("negative entropy/overflow\n");
8b76f46a
AM
535 entropy_count = 0;
536 } else if (entropy_count > r->poolinfo->POOLBITS)
537 entropy_count = r->poolinfo->POOLBITS;
538 r->entropy_count = entropy_count;
1da177e4 539
88c730da 540 /* should we wake readers? */
8b76f46a 541 if (r == &input_pool && entropy_count >= random_read_wakeup_thresh) {
88c730da 542 wake_up_interruptible(&random_read_wait);
9a6f70bb
JD
543 kill_fasync(&fasync, SIGIO, POLL_IN);
544 }
1da177e4
LT
545 spin_unlock_irqrestore(&r->lock, flags);
546}
547
548/*********************************************************************
549 *
550 * Entropy input management
551 *
552 *********************************************************************/
553
554/* There is one of these per entropy source */
555struct timer_rand_state {
556 cycles_t last_time;
90b75ee5 557 long last_delta, last_delta2;
1da177e4
LT
558 unsigned dont_count_entropy:1;
559};
560
1da177e4
LT
561static struct timer_rand_state *irq_timer_state[NR_IRQS];
562
3060d6fe
YL
563static struct timer_rand_state *get_timer_rand_state(unsigned int irq)
564{
565 if (irq >= nr_irqs)
566 return NULL;
567
568 return irq_timer_state[irq];
569}
570
571static void set_timer_rand_state(unsigned int irq, struct timer_rand_state *state)
572{
573 if (irq >= nr_irqs)
574 return;
575
576 irq_timer_state[irq] = state;
577}
578
3060d6fe
YL
579static struct timer_rand_state input_timer_state;
580
1da177e4
LT
581/*
582 * This function adds entropy to the entropy "pool" by using timing
583 * delays. It uses the timer_rand_state structure to make an estimate
584 * of how many bits of entropy this call has added to the pool.
585 *
586 * The number "num" is also added to the pool - it should somehow describe
587 * the type of event which just happened. This is currently 0-255 for
588 * keyboard scan codes, and 256 upwards for interrupts.
589 *
590 */
591static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
592{
593 struct {
594 cycles_t cycles;
595 long jiffies;
596 unsigned num;
597 } sample;
598 long delta, delta2, delta3;
599
600 preempt_disable();
601 /* if over the trickle threshold, use only 1 in 4096 samples */
602 if (input_pool.entropy_count > trickle_thresh &&
603 (__get_cpu_var(trickle_count)++ & 0xfff))
604 goto out;
605
606 sample.jiffies = jiffies;
607 sample.cycles = get_cycles();
608 sample.num = num;
e68e5b66 609 mix_pool_bytes(&input_pool, &sample, sizeof(sample));
1da177e4
LT
610
611 /*
612 * Calculate number of bits of randomness we probably added.
613 * We take into account the first, second and third-order deltas
614 * in order to make our estimate.
615 */
616
617 if (!state->dont_count_entropy) {
618 delta = sample.jiffies - state->last_time;
619 state->last_time = sample.jiffies;
620
621 delta2 = delta - state->last_delta;
622 state->last_delta = delta;
623
624 delta3 = delta2 - state->last_delta2;
625 state->last_delta2 = delta2;
626
627 if (delta < 0)
628 delta = -delta;
629 if (delta2 < 0)
630 delta2 = -delta2;
631 if (delta3 < 0)
632 delta3 = -delta3;
633 if (delta > delta2)
634 delta = delta2;
635 if (delta > delta3)
636 delta = delta3;
637
638 /*
639 * delta is now minimum absolute delta.
640 * Round down by 1 bit on general principles,
641 * and limit entropy entimate to 12 bits.
642 */
adc782da
MM
643 credit_entropy_bits(&input_pool,
644 min_t(int, fls(delta>>1), 11));
1da177e4 645 }
1da177e4
LT
646out:
647 preempt_enable();
648}
649
d251575a 650void add_input_randomness(unsigned int type, unsigned int code,
1da177e4
LT
651 unsigned int value)
652{
653 static unsigned char last_value;
654
655 /* ignore autorepeat and the like */
656 if (value == last_value)
657 return;
658
659 DEBUG_ENT("input event\n");
660 last_value = value;
661 add_timer_randomness(&input_timer_state,
662 (type << 4) ^ code ^ (code >> 4) ^ value);
663}
80fc9f53 664EXPORT_SYMBOL_GPL(add_input_randomness);
1da177e4
LT
665
666void add_interrupt_randomness(int irq)
667{
3060d6fe
YL
668 struct timer_rand_state *state;
669
670 state = get_timer_rand_state(irq);
671
672 if (state == NULL)
1da177e4
LT
673 return;
674
675 DEBUG_ENT("irq event %d\n", irq);
3060d6fe 676 add_timer_randomness(state, 0x100 + irq);
1da177e4
LT
677}
678
9361401e 679#ifdef CONFIG_BLOCK
1da177e4
LT
680void add_disk_randomness(struct gendisk *disk)
681{
682 if (!disk || !disk->random)
683 return;
684 /* first major is 1, so we get >= 0x200 here */
f331c029
TH
685 DEBUG_ENT("disk event %d:%d\n",
686 MAJOR(disk_devt(disk)), MINOR(disk_devt(disk)));
1da177e4 687
f331c029 688 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
1da177e4 689}
9361401e 690#endif
1da177e4
LT
691
692#define EXTRACT_SIZE 10
693
694/*********************************************************************
695 *
696 * Entropy extraction routines
697 *
698 *********************************************************************/
699
90b75ee5 700static ssize_t extract_entropy(struct entropy_store *r, void *buf,
1da177e4
LT
701 size_t nbytes, int min, int rsvd);
702
703/*
704 * This utility inline function is responsible for transfering entropy
705 * from the primary pool to the secondary extraction pool. We make
706 * sure we pull enough for a 'catastrophic reseed'.
707 */
708static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
709{
710 __u32 tmp[OUTPUT_POOL_WORDS];
711
712 if (r->pull && r->entropy_count < nbytes * 8 &&
713 r->entropy_count < r->poolinfo->POOLBITS) {
5a021e9f 714 /* If we're limited, always leave two wakeup worth's BITS */
1da177e4 715 int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
5a021e9f
MM
716 int bytes = nbytes;
717
718 /* pull at least as many as BYTES as wakeup BITS */
719 bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
720 /* but never more than the buffer size */
721 bytes = min_t(int, bytes, sizeof(tmp));
1da177e4
LT
722
723 DEBUG_ENT("going to reseed %s with %d bits "
724 "(%d of %d requested)\n",
725 r->name, bytes * 8, nbytes * 8, r->entropy_count);
726
90b75ee5
MM
727 bytes = extract_entropy(r->pull, tmp, bytes,
728 random_read_wakeup_thresh / 8, rsvd);
e68e5b66 729 mix_pool_bytes(r, tmp, bytes);
adc782da 730 credit_entropy_bits(r, bytes*8);
1da177e4
LT
731 }
732}
733
734/*
735 * These functions extracts randomness from the "entropy pool", and
736 * returns it in a buffer.
737 *
738 * The min parameter specifies the minimum amount we can pull before
739 * failing to avoid races that defeat catastrophic reseeding while the
740 * reserved parameter indicates how much entropy we must leave in the
741 * pool after each pull to avoid starving other readers.
742 *
743 * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
744 */
745
746static size_t account(struct entropy_store *r, size_t nbytes, int min,
747 int reserved)
748{
749 unsigned long flags;
750
751 BUG_ON(r->entropy_count > r->poolinfo->POOLBITS);
752
753 /* Hold lock while accounting */
754 spin_lock_irqsave(&r->lock, flags);
755
756 DEBUG_ENT("trying to extract %d bits from %s\n",
757 nbytes * 8, r->name);
758
759 /* Can we pull enough? */
760 if (r->entropy_count / 8 < min + reserved) {
761 nbytes = 0;
762 } else {
763 /* If limited, never pull more than available */
764 if (r->limit && nbytes + reserved >= r->entropy_count / 8)
765 nbytes = r->entropy_count/8 - reserved;
766
90b75ee5 767 if (r->entropy_count / 8 >= nbytes + reserved)
1da177e4
LT
768 r->entropy_count -= nbytes*8;
769 else
770 r->entropy_count = reserved;
771
9a6f70bb 772 if (r->entropy_count < random_write_wakeup_thresh) {
1da177e4 773 wake_up_interruptible(&random_write_wait);
9a6f70bb
JD
774 kill_fasync(&fasync, SIGIO, POLL_OUT);
775 }
1da177e4
LT
776 }
777
778 DEBUG_ENT("debiting %d entropy credits from %s%s\n",
779 nbytes * 8, r->name, r->limit ? "" : " (unlimited)");
780
781 spin_unlock_irqrestore(&r->lock, flags);
782
783 return nbytes;
784}
785
786static void extract_buf(struct entropy_store *r, __u8 *out)
787{
602b6aee 788 int i;
e68e5b66
MM
789 __u32 hash[5], workspace[SHA_WORKSPACE_WORDS];
790 __u8 extract[64];
1da177e4 791
1c0ad3d4 792 /* Generate a hash across the pool, 16 words (512 bits) at a time */
ffd8d3fa 793 sha_init(hash);
1c0ad3d4
MM
794 for (i = 0; i < r->poolinfo->poolwords; i += 16)
795 sha_transform(hash, (__u8 *)(r->pool + i), workspace);
796
1da177e4 797 /*
1c0ad3d4
MM
798 * We mix the hash back into the pool to prevent backtracking
799 * attacks (where the attacker knows the state of the pool
800 * plus the current outputs, and attempts to find previous
801 * ouputs), unless the hash function can be inverted. By
802 * mixing at least a SHA1 worth of hash data back, we make
803 * brute-forcing the feedback as hard as brute-forcing the
804 * hash.
1da177e4 805 */
e68e5b66 806 mix_pool_bytes_extract(r, hash, sizeof(hash), extract);
1da177e4
LT
807
808 /*
1c0ad3d4
MM
809 * To avoid duplicates, we atomically extract a portion of the
810 * pool while mixing, and hash one final time.
1da177e4 811 */
e68e5b66 812 sha_transform(hash, extract, workspace);
ffd8d3fa
MM
813 memset(extract, 0, sizeof(extract));
814 memset(workspace, 0, sizeof(workspace));
1da177e4
LT
815
816 /*
1c0ad3d4
MM
817 * In case the hash function has some recognizable output
818 * pattern, we fold it in half. Thus, we always feed back
819 * twice as much data as we output.
1da177e4 820 */
ffd8d3fa
MM
821 hash[0] ^= hash[3];
822 hash[1] ^= hash[4];
823 hash[2] ^= rol32(hash[2], 16);
824 memcpy(out, hash, EXTRACT_SIZE);
825 memset(hash, 0, sizeof(hash));
1da177e4
LT
826}
827
90b75ee5 828static ssize_t extract_entropy(struct entropy_store *r, void *buf,
1da177e4
LT
829 size_t nbytes, int min, int reserved)
830{
831 ssize_t ret = 0, i;
832 __u8 tmp[EXTRACT_SIZE];
833
834 xfer_secondary_pool(r, nbytes);
835 nbytes = account(r, nbytes, min, reserved);
836
837 while (nbytes) {
838 extract_buf(r, tmp);
839 i = min_t(int, nbytes, EXTRACT_SIZE);
840 memcpy(buf, tmp, i);
841 nbytes -= i;
842 buf += i;
843 ret += i;
844 }
845
846 /* Wipe data just returned from memory */
847 memset(tmp, 0, sizeof(tmp));
848
849 return ret;
850}
851
852static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
853 size_t nbytes)
854{
855 ssize_t ret = 0, i;
856 __u8 tmp[EXTRACT_SIZE];
857
858 xfer_secondary_pool(r, nbytes);
859 nbytes = account(r, nbytes, 0, 0);
860
861 while (nbytes) {
862 if (need_resched()) {
863 if (signal_pending(current)) {
864 if (ret == 0)
865 ret = -ERESTARTSYS;
866 break;
867 }
868 schedule();
869 }
870
871 extract_buf(r, tmp);
872 i = min_t(int, nbytes, EXTRACT_SIZE);
873 if (copy_to_user(buf, tmp, i)) {
874 ret = -EFAULT;
875 break;
876 }
877
878 nbytes -= i;
879 buf += i;
880 ret += i;
881 }
882
883 /* Wipe data just returned from memory */
884 memset(tmp, 0, sizeof(tmp));
885
886 return ret;
887}
888
889/*
890 * This function is the exported kernel interface. It returns some
891 * number of good random numbers, suitable for seeding TCP sequence
892 * numbers, etc.
893 */
894void get_random_bytes(void *buf, int nbytes)
895{
896 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
897}
1da177e4
LT
898EXPORT_SYMBOL(get_random_bytes);
899
900/*
901 * init_std_data - initialize pool with system data
902 *
903 * @r: pool to initialize
904 *
905 * This function clears the pool's entropy count and mixes some system
906 * data into the pool to prepare it for use. The pool is not cleared
907 * as that can only decrease the entropy in the pool.
908 */
909static void init_std_data(struct entropy_store *r)
910{
f8595815 911 ktime_t now;
1da177e4
LT
912 unsigned long flags;
913
914 spin_lock_irqsave(&r->lock, flags);
915 r->entropy_count = 0;
916 spin_unlock_irqrestore(&r->lock, flags);
917
f8595815 918 now = ktime_get_real();
e68e5b66
MM
919 mix_pool_bytes(r, &now, sizeof(now));
920 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
1da177e4
LT
921}
922
53c3f63e 923static int rand_initialize(void)
1da177e4
LT
924{
925 init_std_data(&input_pool);
926 init_std_data(&blocking_pool);
927 init_std_data(&nonblocking_pool);
928 return 0;
929}
930module_init(rand_initialize);
931
932void rand_initialize_irq(int irq)
933{
934 struct timer_rand_state *state;
935
3060d6fe
YL
936 if (irq >= nr_irqs)
937 return;
3060d6fe
YL
938
939 state = get_timer_rand_state(irq);
940
941 if (state)
1da177e4
LT
942 return;
943
944 /*
f8595815 945 * If kzalloc returns null, we just won't use that entropy
1da177e4
LT
946 * source.
947 */
f8595815
ED
948 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
949 if (state)
3060d6fe 950 set_timer_rand_state(irq, state);
1da177e4
LT
951}
952
9361401e 953#ifdef CONFIG_BLOCK
1da177e4
LT
954void rand_initialize_disk(struct gendisk *disk)
955{
956 struct timer_rand_state *state;
957
958 /*
f8595815 959 * If kzalloc returns null, we just won't use that entropy
1da177e4
LT
960 * source.
961 */
f8595815
ED
962 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
963 if (state)
1da177e4 964 disk->random = state;
1da177e4 965}
9361401e 966#endif
1da177e4
LT
967
968static ssize_t
90b75ee5 969random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1da177e4
LT
970{
971 ssize_t n, retval = 0, count = 0;
972
973 if (nbytes == 0)
974 return 0;
975
976 while (nbytes > 0) {
977 n = nbytes;
978 if (n > SEC_XFER_SIZE)
979 n = SEC_XFER_SIZE;
980
981 DEBUG_ENT("reading %d bits\n", n*8);
982
983 n = extract_entropy_user(&blocking_pool, buf, n);
984
985 DEBUG_ENT("read got %d bits (%d still needed)\n",
986 n*8, (nbytes-n)*8);
987
988 if (n == 0) {
989 if (file->f_flags & O_NONBLOCK) {
990 retval = -EAGAIN;
991 break;
992 }
993
994 DEBUG_ENT("sleeping?\n");
995
996 wait_event_interruptible(random_read_wait,
997 input_pool.entropy_count >=
998 random_read_wakeup_thresh);
999
1000 DEBUG_ENT("awake\n");
1001
1002 if (signal_pending(current)) {
1003 retval = -ERESTARTSYS;
1004 break;
1005 }
1006
1007 continue;
1008 }
1009
1010 if (n < 0) {
1011 retval = n;
1012 break;
1013 }
1014 count += n;
1015 buf += n;
1016 nbytes -= n;
1017 break; /* This break makes the device work */
1018 /* like a named pipe */
1019 }
1020
1021 /*
1022 * If we gave the user some bytes, update the access time.
1023 */
1024 if (count)
1025 file_accessed(file);
1026
1027 return (count ? count : retval);
1028}
1029
1030static ssize_t
90b75ee5 1031urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1da177e4
LT
1032{
1033 return extract_entropy_user(&nonblocking_pool, buf, nbytes);
1034}
1035
1036static unsigned int
1037random_poll(struct file *file, poll_table * wait)
1038{
1039 unsigned int mask;
1040
1041 poll_wait(file, &random_read_wait, wait);
1042 poll_wait(file, &random_write_wait, wait);
1043 mask = 0;
1044 if (input_pool.entropy_count >= random_read_wakeup_thresh)
1045 mask |= POLLIN | POLLRDNORM;
1046 if (input_pool.entropy_count < random_write_wakeup_thresh)
1047 mask |= POLLOUT | POLLWRNORM;
1048 return mask;
1049}
1050
7f397dcd
MM
1051static int
1052write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1da177e4 1053{
1da177e4
LT
1054 size_t bytes;
1055 __u32 buf[16];
1056 const char __user *p = buffer;
1da177e4 1057
7f397dcd
MM
1058 while (count > 0) {
1059 bytes = min(count, sizeof(buf));
1060 if (copy_from_user(&buf, p, bytes))
1061 return -EFAULT;
1da177e4 1062
7f397dcd 1063 count -= bytes;
1da177e4
LT
1064 p += bytes;
1065
e68e5b66 1066 mix_pool_bytes(r, buf, bytes);
91f3f1e3 1067 cond_resched();
1da177e4 1068 }
7f397dcd
MM
1069
1070 return 0;
1071}
1072
90b75ee5
MM
1073static ssize_t random_write(struct file *file, const char __user *buffer,
1074 size_t count, loff_t *ppos)
7f397dcd
MM
1075{
1076 size_t ret;
1077 struct inode *inode = file->f_path.dentry->d_inode;
1078
1079 ret = write_pool(&blocking_pool, buffer, count);
1080 if (ret)
1081 return ret;
1082 ret = write_pool(&nonblocking_pool, buffer, count);
1083 if (ret)
1084 return ret;
1085
1086 inode->i_mtime = current_fs_time(inode->i_sb);
1087 mark_inode_dirty(inode);
1088 return (ssize_t)count;
1da177e4
LT
1089}
1090
43ae4860 1091static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
1da177e4
LT
1092{
1093 int size, ent_count;
1094 int __user *p = (int __user *)arg;
1095 int retval;
1096
1097 switch (cmd) {
1098 case RNDGETENTCNT:
43ae4860
MM
1099 /* inherently racy, no point locking */
1100 if (put_user(input_pool.entropy_count, p))
1da177e4
LT
1101 return -EFAULT;
1102 return 0;
1103 case RNDADDTOENTCNT:
1104 if (!capable(CAP_SYS_ADMIN))
1105 return -EPERM;
1106 if (get_user(ent_count, p))
1107 return -EFAULT;
adc782da 1108 credit_entropy_bits(&input_pool, ent_count);
1da177e4
LT
1109 return 0;
1110 case RNDADDENTROPY:
1111 if (!capable(CAP_SYS_ADMIN))
1112 return -EPERM;
1113 if (get_user(ent_count, p++))
1114 return -EFAULT;
1115 if (ent_count < 0)
1116 return -EINVAL;
1117 if (get_user(size, p++))
1118 return -EFAULT;
7f397dcd
MM
1119 retval = write_pool(&input_pool, (const char __user *)p,
1120 size);
1da177e4
LT
1121 if (retval < 0)
1122 return retval;
adc782da 1123 credit_entropy_bits(&input_pool, ent_count);
1da177e4
LT
1124 return 0;
1125 case RNDZAPENTCNT:
1126 case RNDCLEARPOOL:
1127 /* Clear the entropy pool counters. */
1128 if (!capable(CAP_SYS_ADMIN))
1129 return -EPERM;
53c3f63e 1130 rand_initialize();
1da177e4
LT
1131 return 0;
1132 default:
1133 return -EINVAL;
1134 }
1135}
1136
9a6f70bb
JD
1137static int random_fasync(int fd, struct file *filp, int on)
1138{
1139 return fasync_helper(fd, filp, on, &fasync);
1140}
1141
1142static int random_release(struct inode *inode, struct file *filp)
1143{
1144 return fasync_helper(-1, filp, 0, &fasync);
1145}
1146
2b8693c0 1147const struct file_operations random_fops = {
1da177e4
LT
1148 .read = random_read,
1149 .write = random_write,
1150 .poll = random_poll,
43ae4860 1151 .unlocked_ioctl = random_ioctl,
9a6f70bb
JD
1152 .fasync = random_fasync,
1153 .release = random_release,
1da177e4
LT
1154};
1155
2b8693c0 1156const struct file_operations urandom_fops = {
1da177e4
LT
1157 .read = urandom_read,
1158 .write = random_write,
43ae4860 1159 .unlocked_ioctl = random_ioctl,
9a6f70bb
JD
1160 .fasync = random_fasync,
1161 .release = random_release,
1da177e4
LT
1162};
1163
1164/***************************************************************
1165 * Random UUID interface
1166 *
1167 * Used here for a Boot ID, but can be useful for other kernel
1168 * drivers.
1169 ***************************************************************/
1170
1171/*
1172 * Generate random UUID
1173 */
1174void generate_random_uuid(unsigned char uuid_out[16])
1175{
1176 get_random_bytes(uuid_out, 16);
1177 /* Set UUID version to 4 --- truely random generation */
1178 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1179 /* Set the UUID variant to DCE */
1180 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1181}
1da177e4
LT
1182EXPORT_SYMBOL(generate_random_uuid);
1183
1184/********************************************************************
1185 *
1186 * Sysctl interface
1187 *
1188 ********************************************************************/
1189
1190#ifdef CONFIG_SYSCTL
1191
1192#include <linux/sysctl.h>
1193
1194static int min_read_thresh = 8, min_write_thresh;
1195static int max_read_thresh = INPUT_POOL_WORDS * 32;
1196static int max_write_thresh = INPUT_POOL_WORDS * 32;
1197static char sysctl_bootid[16];
1198
1199/*
1200 * These functions is used to return both the bootid UUID, and random
1201 * UUID. The difference is in whether table->data is NULL; if it is,
1202 * then a new UUID is generated and returned to the user.
1203 *
1204 * If the user accesses this via the proc interface, it will be returned
1205 * as an ASCII string in the standard UUID format. If accesses via the
1206 * sysctl system call, it is returned as 16 bytes of binary data.
1207 */
1208static int proc_do_uuid(ctl_table *table, int write, struct file *filp,
1209 void __user *buffer, size_t *lenp, loff_t *ppos)
1210{
1211 ctl_table fake_table;
1212 unsigned char buf[64], tmp_uuid[16], *uuid;
1213
1214 uuid = table->data;
1215 if (!uuid) {
1216 uuid = tmp_uuid;
1217 uuid[8] = 0;
1218 }
1219 if (uuid[8] == 0)
1220 generate_random_uuid(uuid);
1221
1222 sprintf(buf, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-"
1223 "%02x%02x%02x%02x%02x%02x",
1224 uuid[0], uuid[1], uuid[2], uuid[3],
1225 uuid[4], uuid[5], uuid[6], uuid[7],
1226 uuid[8], uuid[9], uuid[10], uuid[11],
1227 uuid[12], uuid[13], uuid[14], uuid[15]);
1228 fake_table.data = buf;
1229 fake_table.maxlen = sizeof(buf);
1230
1231 return proc_dostring(&fake_table, write, filp, buffer, lenp, ppos);
1232}
1233
f221e726 1234static int uuid_strategy(ctl_table *table,
1da177e4 1235 void __user *oldval, size_t __user *oldlenp,
1f29bcd7 1236 void __user *newval, size_t newlen)
1da177e4
LT
1237{
1238 unsigned char tmp_uuid[16], *uuid;
1239 unsigned int len;
1240
1241 if (!oldval || !oldlenp)
1242 return 1;
1243
1244 uuid = table->data;
1245 if (!uuid) {
1246 uuid = tmp_uuid;
1247 uuid[8] = 0;
1248 }
1249 if (uuid[8] == 0)
1250 generate_random_uuid(uuid);
1251
1252 if (get_user(len, oldlenp))
1253 return -EFAULT;
1254 if (len) {
1255 if (len > 16)
1256 len = 16;
1257 if (copy_to_user(oldval, uuid, len) ||
1258 put_user(len, oldlenp))
1259 return -EFAULT;
1260 }
1261 return 1;
1262}
1263
1264static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
1265ctl_table random_table[] = {
1266 {
1267 .ctl_name = RANDOM_POOLSIZE,
1268 .procname = "poolsize",
1269 .data = &sysctl_poolsize,
1270 .maxlen = sizeof(int),
1271 .mode = 0444,
1272 .proc_handler = &proc_dointvec,
1273 },
1274 {
1275 .ctl_name = RANDOM_ENTROPY_COUNT,
1276 .procname = "entropy_avail",
1277 .maxlen = sizeof(int),
1278 .mode = 0444,
1279 .proc_handler = &proc_dointvec,
1280 .data = &input_pool.entropy_count,
1281 },
1282 {
1283 .ctl_name = RANDOM_READ_THRESH,
1284 .procname = "read_wakeup_threshold",
1285 .data = &random_read_wakeup_thresh,
1286 .maxlen = sizeof(int),
1287 .mode = 0644,
1288 .proc_handler = &proc_dointvec_minmax,
1289 .strategy = &sysctl_intvec,
1290 .extra1 = &min_read_thresh,
1291 .extra2 = &max_read_thresh,
1292 },
1293 {
1294 .ctl_name = RANDOM_WRITE_THRESH,
1295 .procname = "write_wakeup_threshold",
1296 .data = &random_write_wakeup_thresh,
1297 .maxlen = sizeof(int),
1298 .mode = 0644,
1299 .proc_handler = &proc_dointvec_minmax,
1300 .strategy = &sysctl_intvec,
1301 .extra1 = &min_write_thresh,
1302 .extra2 = &max_write_thresh,
1303 },
1304 {
1305 .ctl_name = RANDOM_BOOT_ID,
1306 .procname = "boot_id",
1307 .data = &sysctl_bootid,
1308 .maxlen = 16,
1309 .mode = 0444,
1310 .proc_handler = &proc_do_uuid,
1311 .strategy = &uuid_strategy,
1312 },
1313 {
1314 .ctl_name = RANDOM_UUID,
1315 .procname = "uuid",
1316 .maxlen = 16,
1317 .mode = 0444,
1318 .proc_handler = &proc_do_uuid,
1319 .strategy = &uuid_strategy,
1320 },
1321 { .ctl_name = 0 }
1322};
1323#endif /* CONFIG_SYSCTL */
1324
1325/********************************************************************
1326 *
1327 * Random funtions for networking
1328 *
1329 ********************************************************************/
1330
1331/*
1332 * TCP initial sequence number picking. This uses the random number
1333 * generator to pick an initial secret value. This value is hashed
1334 * along with the TCP endpoint information to provide a unique
1335 * starting point for each pair of TCP endpoints. This defeats
1336 * attacks which rely on guessing the initial TCP sequence number.
1337 * This algorithm was suggested by Steve Bellovin.
1338 *
1339 * Using a very strong hash was taking an appreciable amount of the total
1340 * TCP connection establishment time, so this is a weaker hash,
1341 * compensated for by changing the secret periodically.
1342 */
1343
1344/* F, G and H are basic MD4 functions: selection, majority, parity */
1345#define F(x, y, z) ((z) ^ ((x) & ((y) ^ (z))))
1346#define G(x, y, z) (((x) & (y)) + (((x) ^ (y)) & (z)))
1347#define H(x, y, z) ((x) ^ (y) ^ (z))
1348
1349/*
1350 * The generic round function. The application is so specific that
1351 * we don't bother protecting all the arguments with parens, as is generally
1352 * good macro practice, in favor of extra legibility.
1353 * Rotation is separate from addition to prevent recomputation
1354 */
1355#define ROUND(f, a, b, c, d, x, s) \
1356 (a += f(b, c, d) + x, a = (a << s) | (a >> (32 - s)))
1357#define K1 0
1358#define K2 013240474631UL
1359#define K3 015666365641UL
1360
1361#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
1362
90b75ee5 1363static __u32 twothirdsMD4Transform(__u32 const buf[4], __u32 const in[12])
1da177e4
LT
1364{
1365 __u32 a = buf[0], b = buf[1], c = buf[2], d = buf[3];
1366
1367 /* Round 1 */
1368 ROUND(F, a, b, c, d, in[ 0] + K1, 3);
1369 ROUND(F, d, a, b, c, in[ 1] + K1, 7);
1370 ROUND(F, c, d, a, b, in[ 2] + K1, 11);
1371 ROUND(F, b, c, d, a, in[ 3] + K1, 19);
1372 ROUND(F, a, b, c, d, in[ 4] + K1, 3);
1373 ROUND(F, d, a, b, c, in[ 5] + K1, 7);
1374 ROUND(F, c, d, a, b, in[ 6] + K1, 11);
1375 ROUND(F, b, c, d, a, in[ 7] + K1, 19);
1376 ROUND(F, a, b, c, d, in[ 8] + K1, 3);
1377 ROUND(F, d, a, b, c, in[ 9] + K1, 7);
1378 ROUND(F, c, d, a, b, in[10] + K1, 11);
1379 ROUND(F, b, c, d, a, in[11] + K1, 19);
1380
1381 /* Round 2 */
1382 ROUND(G, a, b, c, d, in[ 1] + K2, 3);
1383 ROUND(G, d, a, b, c, in[ 3] + K2, 5);
1384 ROUND(G, c, d, a, b, in[ 5] + K2, 9);
1385 ROUND(G, b, c, d, a, in[ 7] + K2, 13);
1386 ROUND(G, a, b, c, d, in[ 9] + K2, 3);
1387 ROUND(G, d, a, b, c, in[11] + K2, 5);
1388 ROUND(G, c, d, a, b, in[ 0] + K2, 9);
1389 ROUND(G, b, c, d, a, in[ 2] + K2, 13);
1390 ROUND(G, a, b, c, d, in[ 4] + K2, 3);
1391 ROUND(G, d, a, b, c, in[ 6] + K2, 5);
1392 ROUND(G, c, d, a, b, in[ 8] + K2, 9);
1393 ROUND(G, b, c, d, a, in[10] + K2, 13);
1394
1395 /* Round 3 */
1396 ROUND(H, a, b, c, d, in[ 3] + K3, 3);
1397 ROUND(H, d, a, b, c, in[ 7] + K3, 9);
1398 ROUND(H, c, d, a, b, in[11] + K3, 11);
1399 ROUND(H, b, c, d, a, in[ 2] + K3, 15);
1400 ROUND(H, a, b, c, d, in[ 6] + K3, 3);
1401 ROUND(H, d, a, b, c, in[10] + K3, 9);
1402 ROUND(H, c, d, a, b, in[ 1] + K3, 11);
1403 ROUND(H, b, c, d, a, in[ 5] + K3, 15);
1404 ROUND(H, a, b, c, d, in[ 9] + K3, 3);
1405 ROUND(H, d, a, b, c, in[ 0] + K3, 9);
1406 ROUND(H, c, d, a, b, in[ 4] + K3, 11);
1407 ROUND(H, b, c, d, a, in[ 8] + K3, 15);
1408
1409 return buf[1] + b; /* "most hashed" word */
1410 /* Alternative: return sum of all words? */
1411}
1412#endif
1413
1414#undef ROUND
1415#undef F
1416#undef G
1417#undef H
1418#undef K1
1419#undef K2
1420#undef K3
1421
1422/* This should not be decreased so low that ISNs wrap too fast. */
1423#define REKEY_INTERVAL (300 * HZ)
1424/*
1425 * Bit layout of the tcp sequence numbers (before adding current time):
1426 * bit 24-31: increased after every key exchange
1427 * bit 0-23: hash(source,dest)
1428 *
1429 * The implementation is similar to the algorithm described
1430 * in the Appendix of RFC 1185, except that
1431 * - it uses a 1 MHz clock instead of a 250 kHz clock
1432 * - it performs a rekey every 5 minutes, which is equivalent
1433 * to a (source,dest) tulple dependent forward jump of the
1434 * clock by 0..2^(HASH_BITS+1)
1435 *
1436 * Thus the average ISN wraparound time is 68 minutes instead of
1437 * 4.55 hours.
1438 *
1439 * SMP cleanup and lock avoidance with poor man's RCU.
1440 * Manfred Spraul <manfred@colorfullife.com>
1441 *
1442 */
1443#define COUNT_BITS 8
1444#define COUNT_MASK ((1 << COUNT_BITS) - 1)
1445#define HASH_BITS 24
1446#define HASH_MASK ((1 << HASH_BITS) - 1)
1447
1448static struct keydata {
1449 __u32 count; /* already shifted to the final position */
1450 __u32 secret[12];
1451} ____cacheline_aligned ip_keydata[2];
1452
1453static unsigned int ip_cnt;
1454
65f27f38 1455static void rekey_seq_generator(struct work_struct *work);
1da177e4 1456
65f27f38 1457static DECLARE_DELAYED_WORK(rekey_work, rekey_seq_generator);
1da177e4
LT
1458
1459/*
1460 * Lock avoidance:
1461 * The ISN generation runs lockless - it's just a hash over random data.
1462 * State changes happen every 5 minutes when the random key is replaced.
1463 * Synchronization is performed by having two copies of the hash function
1464 * state and rekey_seq_generator always updates the inactive copy.
1465 * The copy is then activated by updating ip_cnt.
1466 * The implementation breaks down if someone blocks the thread
1467 * that processes SYN requests for more than 5 minutes. Should never
1468 * happen, and even if that happens only a not perfectly compliant
1469 * ISN is generated, nothing fatal.
1470 */
65f27f38 1471static void rekey_seq_generator(struct work_struct *work)
1da177e4
LT
1472{
1473 struct keydata *keyptr = &ip_keydata[1 ^ (ip_cnt & 1)];
1474
1475 get_random_bytes(keyptr->secret, sizeof(keyptr->secret));
1476 keyptr->count = (ip_cnt & COUNT_MASK) << HASH_BITS;
1477 smp_wmb();
1478 ip_cnt++;
1479 schedule_delayed_work(&rekey_work, REKEY_INTERVAL);
1480}
1481
1482static inline struct keydata *get_keyptr(void)
1483{
1484 struct keydata *keyptr = &ip_keydata[ip_cnt & 1];
1485
1486 smp_rmb();
1487
1488 return keyptr;
1489}
1490
1491static __init int seqgen_init(void)
1492{
1493 rekey_seq_generator(NULL);
1494 return 0;
1495}
1496late_initcall(seqgen_init);
1497
1498#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
b09b845c
AV
1499__u32 secure_tcpv6_sequence_number(__be32 *saddr, __be32 *daddr,
1500 __be16 sport, __be16 dport)
1da177e4 1501{
1da177e4
LT
1502 __u32 seq;
1503 __u32 hash[12];
1504 struct keydata *keyptr = get_keyptr();
1505
1506 /* The procedure is the same as for IPv4, but addresses are longer.
1507 * Thus we must use twothirdsMD4Transform.
1508 */
1509
1510 memcpy(hash, saddr, 16);
90b75ee5
MM
1511 hash[4] = ((__force u16)sport << 16) + (__force u16)dport;
1512 memcpy(&hash[5], keyptr->secret, sizeof(__u32) * 7);
1da177e4 1513
b09b845c 1514 seq = twothirdsMD4Transform((const __u32 *)daddr, hash) & HASH_MASK;
1da177e4
LT
1515 seq += keyptr->count;
1516
6dd10a62 1517 seq += ktime_to_ns(ktime_get_real());
1da177e4
LT
1518
1519 return seq;
1520}
1521EXPORT_SYMBOL(secure_tcpv6_sequence_number);
1522#endif
1523
1524/* The code below is shamelessly stolen from secure_tcp_sequence_number().
1525 * All blames to Andrey V. Savochkin <saw@msu.ru>.
1526 */
b09b845c 1527__u32 secure_ip_id(__be32 daddr)
1da177e4
LT
1528{
1529 struct keydata *keyptr;
1530 __u32 hash[4];
1531
1532 keyptr = get_keyptr();
1533
1534 /*
1535 * Pick a unique starting offset for each IP destination.
1536 * The dest ip address is placed in the starting vector,
1537 * which is then hashed with random data.
1538 */
b09b845c 1539 hash[0] = (__force __u32)daddr;
1da177e4
LT
1540 hash[1] = keyptr->secret[9];
1541 hash[2] = keyptr->secret[10];
1542 hash[3] = keyptr->secret[11];
1543
1544 return half_md4_transform(hash, keyptr->secret);
1545}
1546
1547#ifdef CONFIG_INET
1548
b09b845c
AV
1549__u32 secure_tcp_sequence_number(__be32 saddr, __be32 daddr,
1550 __be16 sport, __be16 dport)
1da177e4 1551{
1da177e4
LT
1552 __u32 seq;
1553 __u32 hash[4];
1554 struct keydata *keyptr = get_keyptr();
1555
1556 /*
1557 * Pick a unique starting offset for each TCP connection endpoints
1558 * (saddr, daddr, sport, dport).
1559 * Note that the words are placed into the starting vector, which is
1560 * then mixed with a partial MD4 over random data.
1561 */
90b75ee5
MM
1562 hash[0] = (__force u32)saddr;
1563 hash[1] = (__force u32)daddr;
1564 hash[2] = ((__force u16)sport << 16) + (__force u16)dport;
1565 hash[3] = keyptr->secret[11];
1da177e4
LT
1566
1567 seq = half_md4_transform(hash, keyptr->secret) & HASH_MASK;
1568 seq += keyptr->count;
1569 /*
1570 * As close as possible to RFC 793, which
1571 * suggests using a 250 kHz clock.
1572 * Further reading shows this assumes 2 Mb/s networks.
9b42c336
ED
1573 * For 10 Mb/s Ethernet, a 1 MHz clock is appropriate.
1574 * For 10 Gb/s Ethernet, a 1 GHz clock should be ok, but
1575 * we also need to limit the resolution so that the u32 seq
1576 * overlaps less than one time per MSL (2 minutes).
1577 * Choosing a clock of 64 ns period is OK. (period of 274 s)
1da177e4 1578 */
6dd10a62 1579 seq += ktime_to_ns(ktime_get_real()) >> 6;
90b75ee5 1580
1da177e4
LT
1581 return seq;
1582}
1583
a7f5e7f1 1584/* Generate secure starting point for ephemeral IPV4 transport port search */
b09b845c 1585u32 secure_ipv4_port_ephemeral(__be32 saddr, __be32 daddr, __be16 dport)
1da177e4
LT
1586{
1587 struct keydata *keyptr = get_keyptr();
1588 u32 hash[4];
1589
1590 /*
1591 * Pick a unique starting offset for each ephemeral port search
1592 * (saddr, daddr, dport) and 48bits of random data.
1593 */
b09b845c
AV
1594 hash[0] = (__force u32)saddr;
1595 hash[1] = (__force u32)daddr;
1596 hash[2] = (__force u32)dport ^ keyptr->secret[10];
1da177e4
LT
1597 hash[3] = keyptr->secret[11];
1598
1599 return half_md4_transform(hash, keyptr->secret);
1600}
9f593653 1601EXPORT_SYMBOL_GPL(secure_ipv4_port_ephemeral);
1da177e4
LT
1602
1603#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
90b75ee5
MM
1604u32 secure_ipv6_port_ephemeral(const __be32 *saddr, const __be32 *daddr,
1605 __be16 dport)
1da177e4
LT
1606{
1607 struct keydata *keyptr = get_keyptr();
1608 u32 hash[12];
1609
1610 memcpy(hash, saddr, 16);
b09b845c 1611 hash[4] = (__force u32)dport;
90b75ee5 1612 memcpy(&hash[5], keyptr->secret, sizeof(__u32) * 7);
1da177e4 1613
b09b845c 1614 return twothirdsMD4Transform((const __u32 *)daddr, hash);
1da177e4 1615}
1da177e4
LT
1616#endif
1617
c4365c92
ACM
1618#if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
1619/* Similar to secure_tcp_sequence_number but generate a 48 bit value
1620 * bit's 32-47 increase every key exchange
1621 * 0-31 hash(source, dest)
1622 */
b09b845c
AV
1623u64 secure_dccp_sequence_number(__be32 saddr, __be32 daddr,
1624 __be16 sport, __be16 dport)
c4365c92 1625{
c4365c92
ACM
1626 u64 seq;
1627 __u32 hash[4];
1628 struct keydata *keyptr = get_keyptr();
1629
b09b845c
AV
1630 hash[0] = (__force u32)saddr;
1631 hash[1] = (__force u32)daddr;
1632 hash[2] = ((__force u16)sport << 16) + (__force u16)dport;
c4365c92
ACM
1633 hash[3] = keyptr->secret[11];
1634
1635 seq = half_md4_transform(hash, keyptr->secret);
1636 seq |= ((u64)keyptr->count) << (32 - HASH_BITS);
1637
6dd10a62 1638 seq += ktime_to_ns(ktime_get_real());
c4365c92 1639 seq &= (1ull << 48) - 1;
90b75ee5 1640
c4365c92
ACM
1641 return seq;
1642}
c4365c92
ACM
1643EXPORT_SYMBOL(secure_dccp_sequence_number);
1644#endif
1645
1da177e4
LT
1646#endif /* CONFIG_INET */
1647
1648
1649/*
1650 * Get a random word for internal kernel use only. Similar to urandom but
1651 * with the goal of minimal entropy pool depletion. As a result, the random
1652 * value is not cryptographically secure but for several uses the cost of
1653 * depleting entropy is too high
1654 */
1655unsigned int get_random_int(void)
1656{
1657 /*
1658 * Use IP's RNG. It suits our purpose perfectly: it re-keys itself
1659 * every second, from the entropy pool (and thus creates a limited
1660 * drain on it), and uses halfMD4Transform within the second. We
1661 * also mix it with jiffies and the PID:
1662 */
b09b845c 1663 return secure_ip_id((__force __be32)(current->pid + jiffies));
1da177e4
LT
1664}
1665
1666/*
1667 * randomize_range() returns a start address such that
1668 *
1669 * [...... <range> .....]
1670 * start end
1671 *
1672 * a <range> with size "len" starting at the return value is inside in the
1673 * area defined by [start, end], but is otherwise randomized.
1674 */
1675unsigned long
1676randomize_range(unsigned long start, unsigned long end, unsigned long len)
1677{
1678 unsigned long range = end - len - start;
1679
1680 if (end <= start + len)
1681 return 0;
1682 return PAGE_ALIGN(get_random_int() % range + start);
1683}