blob: c7afc068c28dcf6a64306754953682b0f9cfb70e [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>
Andrea Righi27ac7922008-07-23 21:28:13 -0700239#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240#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
Christoph Lameter6c036522005-07-07 17:56:59 -0700274static int trickle_thresh __read_mostly = INPUT_POOL_WORDS * 28;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Matt Mackall90b75ee2008-04-29 01:02:55 -0700276static DEFINE_PER_CPU(int, trickle_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
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);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700374static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376#if 0
Matt Mackall90b75ee2008-04-29 01:02:55 -0700377static int debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378module_param(debug, bool, 0644);
Matt Mackall90b75ee2008-04-29 01:02:55 -0700379#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387#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 {
Matt Mackall43358202008-04-29 01:03:01 -0700400 /* read-only data: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 struct poolinfo *poolinfo;
402 __u32 *pool;
403 const char *name;
404 int limit;
405 struct entropy_store *pull;
406
407 /* read-write data: */
Matt Mackall43358202008-04-29 01:03:01 -0700408 spinlock_t lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 unsigned add_ptr;
Andrew Morton8b76f462008-09-02 14:36:14 -0700410 int entropy_count; /* Must at no time exceed ->POOLBITS! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 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,
Ingo Molnare4d91912006-07-03 00:24:34 -0700422 .lock = __SPIN_LOCK_UNLOCKED(&input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 .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,
Ingo Molnare4d91912006-07-03 00:24:34 -0700431 .lock = __SPIN_LOCK_UNLOCKED(&blocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 .pool = blocking_pool_data
433};
434
435static struct entropy_store nonblocking_pool = {
436 .poolinfo = &poolinfo_table[1],
437 .name = "nonblocking",
438 .pull = &input_pool,
Ingo Molnare4d91912006-07-03 00:24:34 -0700439 .lock = __SPIN_LOCK_UNLOCKED(&nonblocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 .pool = nonblocking_pool_data
441};
442
443/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700444 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700446 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 *
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 */
Matt Mackalle68e5b62008-04-29 01:03:05 -0700453static void mix_pool_bytes_extract(struct entropy_store *r, const void *in,
454 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
456 static __u32 const twist_table[8] = {
457 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
458 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
Matt Mackall993ba212008-04-29 01:03:04 -0700459 unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700460 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700462 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700463 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473 spin_lock_irqsave(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 input_rotate = r->input_rotate;
Matt Mackall993ba212008-04-29 01:03:04 -0700475 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
Matt Mackalle68e5b62008-04-29 01:03:05 -0700477 /* mix one byte at a time to simplify size handling and churn faster */
478 while (nbytes--) {
479 w = rol32(*bytes++, input_rotate & 31);
Matt Mackall993ba212008-04-29 01:03:04 -0700480 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
482 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700483 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 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];
Matt Mackall993ba212008-04-29 01:03:04 -0700489
490 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700492
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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 }
501
502 r->input_rotate = input_rotate;
Matt Mackall993ba212008-04-29 01:03:04 -0700503 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
Matt Mackall993ba212008-04-29 01:03:04 -0700505 if (out)
506 for (j = 0; j < 16; j++)
Matt Mackalle68e5b62008-04-29 01:03:05 -0700507 ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509 spin_unlock_irqrestore(&r->lock, flags);
510}
511
Matt Mackalle68e5b62008-04-29 01:03:05 -0700512static void mix_pool_bytes(struct entropy_store *r, const void *in, int bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513{
Matt Mackalle68e5b62008-04-29 01:03:05 -0700514 mix_pool_bytes_extract(r, in, bytes, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515}
516
517/*
518 * Credit (or debit) the entropy store with n bits of entropy
519 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700520static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521{
522 unsigned long flags;
Andrew Morton8b76f462008-09-02 14:36:14 -0700523 int entropy_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Matt Mackalladc782d2008-04-29 01:03:07 -0700525 if (!nbits)
526 return;
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 spin_lock_irqsave(&r->lock, flags);
529
Matt Mackalladc782d2008-04-29 01:03:07 -0700530 DEBUG_ENT("added %d entropy credits to %s\n", nbits, r->name);
Andrew Morton8b76f462008-09-02 14:36:14 -0700531 entropy_count = r->entropy_count;
532 entropy_count += nbits;
533 if (entropy_count < 0) {
Matt Mackalladc782d2008-04-29 01:03:07 -0700534 DEBUG_ENT("negative entropy/overflow\n");
Andrew Morton8b76f462008-09-02 14:36:14 -0700535 entropy_count = 0;
536 } else if (entropy_count > r->poolinfo->POOLBITS)
537 entropy_count = r->poolinfo->POOLBITS;
538 r->entropy_count = entropy_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Matt Mackall88c730d2008-04-29 01:02:56 -0700540 /* should we wake readers? */
Andrew Morton8b76f462008-09-02 14:36:14 -0700541 if (r == &input_pool && entropy_count >= random_read_wakeup_thresh) {
Matt Mackall88c730d2008-04-29 01:02:56 -0700542 wake_up_interruptible(&random_read_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700543 kill_fasync(&fasync, SIGIO, POLL_IN);
544 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 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;
Matt Mackall90b75ee2008-04-29 01:02:55 -0700557 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 unsigned dont_count_entropy:1;
559};
560
Yinghai Lu0b8f1ef2008-12-05 18:58:31 -0800561#ifndef CONFIG_SPARSE_IRQ
Yinghai Lu2f983572009-01-03 00:06:34 -0800562
563static struct timer_rand_state *irq_timer_state[NR_IRQS];
564
565static struct timer_rand_state *get_timer_rand_state(unsigned int irq)
566{
567 return irq_timer_state[irq];
568}
569
570static void set_timer_rand_state(unsigned int irq,
571 struct timer_rand_state *state)
572{
573 irq_timer_state[irq] = state;
574}
575
576#else
577
578static struct timer_rand_state *get_timer_rand_state(unsigned int irq)
579{
580 struct irq_desc *desc;
581
582 desc = irq_to_desc(irq);
583
584 return desc->timer_rand_state;
585}
586
587static void set_timer_rand_state(unsigned int irq,
588 struct timer_rand_state *state)
589{
590 struct irq_desc *desc;
591
592 desc = irq_to_desc(irq);
593
594 desc->timer_rand_state = state;
595}
Yinghai Lu0b8f1ef2008-12-05 18:58:31 -0800596#endif
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700597
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700598static struct timer_rand_state input_timer_state;
599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600/*
601 * This function adds entropy to the entropy "pool" by using timing
602 * delays. It uses the timer_rand_state structure to make an estimate
603 * of how many bits of entropy this call has added to the pool.
604 *
605 * The number "num" is also added to the pool - it should somehow describe
606 * the type of event which just happened. This is currently 0-255 for
607 * keyboard scan codes, and 256 upwards for interrupts.
608 *
609 */
610static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
611{
612 struct {
613 cycles_t cycles;
614 long jiffies;
615 unsigned num;
616 } sample;
617 long delta, delta2, delta3;
618
619 preempt_disable();
620 /* if over the trickle threshold, use only 1 in 4096 samples */
621 if (input_pool.entropy_count > trickle_thresh &&
622 (__get_cpu_var(trickle_count)++ & 0xfff))
623 goto out;
624
625 sample.jiffies = jiffies;
626 sample.cycles = get_cycles();
627 sample.num = num;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700628 mix_pool_bytes(&input_pool, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
630 /*
631 * Calculate number of bits of randomness we probably added.
632 * We take into account the first, second and third-order deltas
633 * in order to make our estimate.
634 */
635
636 if (!state->dont_count_entropy) {
637 delta = sample.jiffies - state->last_time;
638 state->last_time = sample.jiffies;
639
640 delta2 = delta - state->last_delta;
641 state->last_delta = delta;
642
643 delta3 = delta2 - state->last_delta2;
644 state->last_delta2 = delta2;
645
646 if (delta < 0)
647 delta = -delta;
648 if (delta2 < 0)
649 delta2 = -delta2;
650 if (delta3 < 0)
651 delta3 = -delta3;
652 if (delta > delta2)
653 delta = delta2;
654 if (delta > delta3)
655 delta = delta3;
656
657 /*
658 * delta is now minimum absolute delta.
659 * Round down by 1 bit on general principles,
660 * and limit entropy entimate to 12 bits.
661 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700662 credit_entropy_bits(&input_pool,
663 min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665out:
666 preempt_enable();
667}
668
Stephen Hemmingerd2515752006-01-11 12:17:38 -0800669void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 unsigned int value)
671{
672 static unsigned char last_value;
673
674 /* ignore autorepeat and the like */
675 if (value == last_value)
676 return;
677
678 DEBUG_ENT("input event\n");
679 last_value = value;
680 add_timer_randomness(&input_timer_state,
681 (type << 4) ^ code ^ (code >> 4) ^ value);
682}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400683EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
685void add_interrupt_randomness(int irq)
686{
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700687 struct timer_rand_state *state;
688
689 state = get_timer_rand_state(irq);
690
691 if (state == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 return;
693
694 DEBUG_ENT("irq event %d\n", irq);
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700695 add_timer_randomness(state, 0x100 + irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696}
697
David Howells93614012006-09-30 20:45:40 +0200698#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699void add_disk_randomness(struct gendisk *disk)
700{
701 if (!disk || !disk->random)
702 return;
703 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +0200704 DEBUG_ENT("disk event %d:%d\n",
705 MAJOR(disk_devt(disk)), MINOR(disk_devt(disk)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Tejun Heof331c022008-09-03 09:01:48 +0200707 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708}
David Howells93614012006-09-30 20:45:40 +0200709#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
711#define EXTRACT_SIZE 10
712
713/*********************************************************************
714 *
715 * Entropy extraction routines
716 *
717 *********************************************************************/
718
Matt Mackall90b75ee2008-04-29 01:02:55 -0700719static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 size_t nbytes, int min, int rsvd);
721
722/*
723 * This utility inline function is responsible for transfering entropy
724 * from the primary pool to the secondary extraction pool. We make
725 * sure we pull enough for a 'catastrophic reseed'.
726 */
727static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
728{
729 __u32 tmp[OUTPUT_POOL_WORDS];
730
731 if (r->pull && r->entropy_count < nbytes * 8 &&
732 r->entropy_count < r->poolinfo->POOLBITS) {
Matt Mackall5a021e92007-07-19 11:30:14 -0700733 /* If we're limited, always leave two wakeup worth's BITS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
Matt Mackall5a021e92007-07-19 11:30:14 -0700735 int bytes = nbytes;
736
737 /* pull at least as many as BYTES as wakeup BITS */
738 bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
739 /* but never more than the buffer size */
740 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
742 DEBUG_ENT("going to reseed %s with %d bits "
743 "(%d of %d requested)\n",
744 r->name, bytes * 8, nbytes * 8, r->entropy_count);
745
Matt Mackall90b75ee2008-04-29 01:02:55 -0700746 bytes = extract_entropy(r->pull, tmp, bytes,
747 random_read_wakeup_thresh / 8, rsvd);
Matt Mackalle68e5b62008-04-29 01:03:05 -0700748 mix_pool_bytes(r, tmp, bytes);
Matt Mackalladc782d2008-04-29 01:03:07 -0700749 credit_entropy_bits(r, bytes*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 }
751}
752
753/*
754 * These functions extracts randomness from the "entropy pool", and
755 * returns it in a buffer.
756 *
757 * The min parameter specifies the minimum amount we can pull before
758 * failing to avoid races that defeat catastrophic reseeding while the
759 * reserved parameter indicates how much entropy we must leave in the
760 * pool after each pull to avoid starving other readers.
761 *
762 * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
763 */
764
765static size_t account(struct entropy_store *r, size_t nbytes, int min,
766 int reserved)
767{
768 unsigned long flags;
769
770 BUG_ON(r->entropy_count > r->poolinfo->POOLBITS);
771
772 /* Hold lock while accounting */
773 spin_lock_irqsave(&r->lock, flags);
774
775 DEBUG_ENT("trying to extract %d bits from %s\n",
776 nbytes * 8, r->name);
777
778 /* Can we pull enough? */
779 if (r->entropy_count / 8 < min + reserved) {
780 nbytes = 0;
781 } else {
782 /* If limited, never pull more than available */
783 if (r->limit && nbytes + reserved >= r->entropy_count / 8)
784 nbytes = r->entropy_count/8 - reserved;
785
Matt Mackall90b75ee2008-04-29 01:02:55 -0700786 if (r->entropy_count / 8 >= nbytes + reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 r->entropy_count -= nbytes*8;
788 else
789 r->entropy_count = reserved;
790
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700791 if (r->entropy_count < random_write_wakeup_thresh) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 wake_up_interruptible(&random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700793 kill_fasync(&fasync, SIGIO, POLL_OUT);
794 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 }
796
797 DEBUG_ENT("debiting %d entropy credits from %s%s\n",
798 nbytes * 8, r->name, r->limit ? "" : " (unlimited)");
799
800 spin_unlock_irqrestore(&r->lock, flags);
801
802 return nbytes;
803}
804
805static void extract_buf(struct entropy_store *r, __u8 *out)
806{
Matt Mackall602b6ae2007-05-29 21:54:27 -0500807 int i;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700808 __u32 hash[5], workspace[SHA_WORKSPACE_WORDS];
809 __u8 extract[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700811 /* Generate a hash across the pool, 16 words (512 bits) at a time */
Matt Mackallffd8d3f2008-04-29 01:02:59 -0700812 sha_init(hash);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700813 for (i = 0; i < r->poolinfo->poolwords; i += 16)
Matt Mackallffd8d3f2008-04-29 01:02:59 -0700814 sha_transform(hash, (__u8 *)(r->pool + i), workspace);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
816 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700817 * We mix the hash back into the pool to prevent backtracking
818 * attacks (where the attacker knows the state of the pool
819 * plus the current outputs, and attempts to find previous
820 * ouputs), unless the hash function can be inverted. By
821 * mixing at least a SHA1 worth of hash data back, we make
822 * brute-forcing the feedback as hard as brute-forcing the
823 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 */
Matt Mackalle68e5b62008-04-29 01:03:05 -0700825 mix_pool_bytes_extract(r, hash, sizeof(hash), extract);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700826
827 /*
828 * To avoid duplicates, we atomically extract a portion of the
829 * pool while mixing, and hash one final time.
830 */
Matt Mackalle68e5b62008-04-29 01:03:05 -0700831 sha_transform(hash, extract, workspace);
Matt Mackallffd8d3f2008-04-29 01:02:59 -0700832 memset(extract, 0, sizeof(extract));
833 memset(workspace, 0, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
835 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700836 * In case the hash function has some recognizable output
837 * pattern, we fold it in half. Thus, we always feed back
838 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 */
Matt Mackallffd8d3f2008-04-29 01:02:59 -0700840 hash[0] ^= hash[3];
841 hash[1] ^= hash[4];
842 hash[2] ^= rol32(hash[2], 16);
843 memcpy(out, hash, EXTRACT_SIZE);
844 memset(hash, 0, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845}
846
Matt Mackall90b75ee2008-04-29 01:02:55 -0700847static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 size_t nbytes, int min, int reserved)
849{
850 ssize_t ret = 0, i;
851 __u8 tmp[EXTRACT_SIZE];
852
853 xfer_secondary_pool(r, nbytes);
854 nbytes = account(r, nbytes, min, reserved);
855
856 while (nbytes) {
857 extract_buf(r, tmp);
858 i = min_t(int, nbytes, EXTRACT_SIZE);
859 memcpy(buf, tmp, i);
860 nbytes -= i;
861 buf += i;
862 ret += i;
863 }
864
865 /* Wipe data just returned from memory */
866 memset(tmp, 0, sizeof(tmp));
867
868 return ret;
869}
870
871static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
872 size_t nbytes)
873{
874 ssize_t ret = 0, i;
875 __u8 tmp[EXTRACT_SIZE];
876
877 xfer_secondary_pool(r, nbytes);
878 nbytes = account(r, nbytes, 0, 0);
879
880 while (nbytes) {
881 if (need_resched()) {
882 if (signal_pending(current)) {
883 if (ret == 0)
884 ret = -ERESTARTSYS;
885 break;
886 }
887 schedule();
888 }
889
890 extract_buf(r, tmp);
891 i = min_t(int, nbytes, EXTRACT_SIZE);
892 if (copy_to_user(buf, tmp, i)) {
893 ret = -EFAULT;
894 break;
895 }
896
897 nbytes -= i;
898 buf += i;
899 ret += i;
900 }
901
902 /* Wipe data just returned from memory */
903 memset(tmp, 0, sizeof(tmp));
904
905 return ret;
906}
907
908/*
909 * This function is the exported kernel interface. It returns some
910 * number of good random numbers, suitable for seeding TCP sequence
911 * numbers, etc.
912 */
913void get_random_bytes(void *buf, int nbytes)
914{
915 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
916}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917EXPORT_SYMBOL(get_random_bytes);
918
919/*
920 * init_std_data - initialize pool with system data
921 *
922 * @r: pool to initialize
923 *
924 * This function clears the pool's entropy count and mixes some system
925 * data into the pool to prepare it for use. The pool is not cleared
926 * as that can only decrease the entropy in the pool.
927 */
928static void init_std_data(struct entropy_store *r)
929{
Eric Dumazetf8595812007-03-28 14:22:33 -0700930 ktime_t now;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 unsigned long flags;
932
933 spin_lock_irqsave(&r->lock, flags);
934 r->entropy_count = 0;
935 spin_unlock_irqrestore(&r->lock, flags);
936
Eric Dumazetf8595812007-03-28 14:22:33 -0700937 now = ktime_get_real();
Matt Mackalle68e5b62008-04-29 01:03:05 -0700938 mix_pool_bytes(r, &now, sizeof(now));
939 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940}
941
Matt Mackall53c3f632008-04-29 01:02:58 -0700942static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943{
944 init_std_data(&input_pool);
945 init_std_data(&blocking_pool);
946 init_std_data(&nonblocking_pool);
947 return 0;
948}
949module_init(rand_initialize);
950
951void rand_initialize_irq(int irq)
952{
953 struct timer_rand_state *state;
954
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700955 state = get_timer_rand_state(irq);
956
957 if (state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 return;
959
960 /*
Eric Dumazetf8595812007-03-28 14:22:33 -0700961 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 * source.
963 */
Eric Dumazetf8595812007-03-28 14:22:33 -0700964 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
965 if (state)
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700966 set_timer_rand_state(irq, state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967}
968
David Howells93614012006-09-30 20:45:40 +0200969#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970void rand_initialize_disk(struct gendisk *disk)
971{
972 struct timer_rand_state *state;
973
974 /*
Eric Dumazetf8595812007-03-28 14:22:33 -0700975 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 * source.
977 */
Eric Dumazetf8595812007-03-28 14:22:33 -0700978 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
979 if (state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 disk->random = state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981}
David Howells93614012006-09-30 20:45:40 +0200982#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
984static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -0700985random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986{
987 ssize_t n, retval = 0, count = 0;
988
989 if (nbytes == 0)
990 return 0;
991
992 while (nbytes > 0) {
993 n = nbytes;
994 if (n > SEC_XFER_SIZE)
995 n = SEC_XFER_SIZE;
996
997 DEBUG_ENT("reading %d bits\n", n*8);
998
999 n = extract_entropy_user(&blocking_pool, buf, n);
1000
1001 DEBUG_ENT("read got %d bits (%d still needed)\n",
1002 n*8, (nbytes-n)*8);
1003
1004 if (n == 0) {
1005 if (file->f_flags & O_NONBLOCK) {
1006 retval = -EAGAIN;
1007 break;
1008 }
1009
1010 DEBUG_ENT("sleeping?\n");
1011
1012 wait_event_interruptible(random_read_wait,
1013 input_pool.entropy_count >=
1014 random_read_wakeup_thresh);
1015
1016 DEBUG_ENT("awake\n");
1017
1018 if (signal_pending(current)) {
1019 retval = -ERESTARTSYS;
1020 break;
1021 }
1022
1023 continue;
1024 }
1025
1026 if (n < 0) {
1027 retval = n;
1028 break;
1029 }
1030 count += n;
1031 buf += n;
1032 nbytes -= n;
1033 break; /* This break makes the device work */
1034 /* like a named pipe */
1035 }
1036
1037 /*
1038 * If we gave the user some bytes, update the access time.
1039 */
1040 if (count)
1041 file_accessed(file);
1042
1043 return (count ? count : retval);
1044}
1045
1046static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001047urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048{
1049 return extract_entropy_user(&nonblocking_pool, buf, nbytes);
1050}
1051
1052static unsigned int
1053random_poll(struct file *file, poll_table * wait)
1054{
1055 unsigned int mask;
1056
1057 poll_wait(file, &random_read_wait, wait);
1058 poll_wait(file, &random_write_wait, wait);
1059 mask = 0;
1060 if (input_pool.entropy_count >= random_read_wakeup_thresh)
1061 mask |= POLLIN | POLLRDNORM;
1062 if (input_pool.entropy_count < random_write_wakeup_thresh)
1063 mask |= POLLOUT | POLLWRNORM;
1064 return mask;
1065}
1066
Matt Mackall7f397dc2007-05-29 21:58:10 -05001067static int
1068write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1069{
1070 size_t bytes;
1071 __u32 buf[16];
1072 const char __user *p = buffer;
1073
1074 while (count > 0) {
1075 bytes = min(count, sizeof(buf));
1076 if (copy_from_user(&buf, p, bytes))
1077 return -EFAULT;
1078
1079 count -= bytes;
1080 p += bytes;
1081
Matt Mackalle68e5b62008-04-29 01:03:05 -07001082 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001083 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001084 }
1085
1086 return 0;
1087}
1088
Matt Mackall90b75ee2008-04-29 01:02:55 -07001089static ssize_t random_write(struct file *file, const char __user *buffer,
1090 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001092 size_t ret;
1093 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
Matt Mackall7f397dc2007-05-29 21:58:10 -05001095 ret = write_pool(&blocking_pool, buffer, count);
1096 if (ret)
1097 return ret;
1098 ret = write_pool(&nonblocking_pool, buffer, count);
1099 if (ret)
1100 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Matt Mackall7f397dc2007-05-29 21:58:10 -05001102 inode->i_mtime = current_fs_time(inode->i_sb);
1103 mark_inode_dirty(inode);
1104 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105}
1106
Matt Mackall43ae4862008-04-29 01:02:58 -07001107static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108{
1109 int size, ent_count;
1110 int __user *p = (int __user *)arg;
1111 int retval;
1112
1113 switch (cmd) {
1114 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001115 /* inherently racy, no point locking */
1116 if (put_user(input_pool.entropy_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 return -EFAULT;
1118 return 0;
1119 case RNDADDTOENTCNT:
1120 if (!capable(CAP_SYS_ADMIN))
1121 return -EPERM;
1122 if (get_user(ent_count, p))
1123 return -EFAULT;
Matt Mackalladc782d2008-04-29 01:03:07 -07001124 credit_entropy_bits(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 return 0;
1126 case RNDADDENTROPY:
1127 if (!capable(CAP_SYS_ADMIN))
1128 return -EPERM;
1129 if (get_user(ent_count, p++))
1130 return -EFAULT;
1131 if (ent_count < 0)
1132 return -EINVAL;
1133 if (get_user(size, p++))
1134 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001135 retval = write_pool(&input_pool, (const char __user *)p,
1136 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 if (retval < 0)
1138 return retval;
Matt Mackalladc782d2008-04-29 01:03:07 -07001139 credit_entropy_bits(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 return 0;
1141 case RNDZAPENTCNT:
1142 case RNDCLEARPOOL:
1143 /* Clear the entropy pool counters. */
1144 if (!capable(CAP_SYS_ADMIN))
1145 return -EPERM;
Matt Mackall53c3f632008-04-29 01:02:58 -07001146 rand_initialize();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 return 0;
1148 default:
1149 return -EINVAL;
1150 }
1151}
1152
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001153static int random_fasync(int fd, struct file *filp, int on)
1154{
1155 return fasync_helper(fd, filp, on, &fasync);
1156}
1157
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001158const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 .read = random_read,
1160 .write = random_write,
1161 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001162 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001163 .fasync = random_fasync,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164};
1165
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001166const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 .read = urandom_read,
1168 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001169 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001170 .fasync = random_fasync,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171};
1172
1173/***************************************************************
1174 * Random UUID interface
1175 *
1176 * Used here for a Boot ID, but can be useful for other kernel
1177 * drivers.
1178 ***************************************************************/
1179
1180/*
1181 * Generate random UUID
1182 */
1183void generate_random_uuid(unsigned char uuid_out[16])
1184{
1185 get_random_bytes(uuid_out, 16);
1186 /* Set UUID version to 4 --- truely random generation */
1187 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1188 /* Set the UUID variant to DCE */
1189 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1190}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191EXPORT_SYMBOL(generate_random_uuid);
1192
1193/********************************************************************
1194 *
1195 * Sysctl interface
1196 *
1197 ********************************************************************/
1198
1199#ifdef CONFIG_SYSCTL
1200
1201#include <linux/sysctl.h>
1202
1203static int min_read_thresh = 8, min_write_thresh;
1204static int max_read_thresh = INPUT_POOL_WORDS * 32;
1205static int max_write_thresh = INPUT_POOL_WORDS * 32;
1206static char sysctl_bootid[16];
1207
1208/*
1209 * These functions is used to return both the bootid UUID, and random
1210 * UUID. The difference is in whether table->data is NULL; if it is,
1211 * then a new UUID is generated and returned to the user.
1212 *
1213 * If the user accesses this via the proc interface, it will be returned
1214 * as an ASCII string in the standard UUID format. If accesses via the
1215 * sysctl system call, it is returned as 16 bytes of binary data.
1216 */
1217static int proc_do_uuid(ctl_table *table, int write, struct file *filp,
1218 void __user *buffer, size_t *lenp, loff_t *ppos)
1219{
1220 ctl_table fake_table;
1221 unsigned char buf[64], tmp_uuid[16], *uuid;
1222
1223 uuid = table->data;
1224 if (!uuid) {
1225 uuid = tmp_uuid;
1226 uuid[8] = 0;
1227 }
1228 if (uuid[8] == 0)
1229 generate_random_uuid(uuid);
1230
1231 sprintf(buf, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-"
1232 "%02x%02x%02x%02x%02x%02x",
1233 uuid[0], uuid[1], uuid[2], uuid[3],
1234 uuid[4], uuid[5], uuid[6], uuid[7],
1235 uuid[8], uuid[9], uuid[10], uuid[11],
1236 uuid[12], uuid[13], uuid[14], uuid[15]);
1237 fake_table.data = buf;
1238 fake_table.maxlen = sizeof(buf);
1239
1240 return proc_dostring(&fake_table, write, filp, buffer, lenp, ppos);
1241}
1242
Alexey Dobriyanf221e722008-10-15 22:04:23 -07001243static int uuid_strategy(ctl_table *table,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 void __user *oldval, size_t __user *oldlenp,
Alexey Dobriyan1f29bcd2006-12-10 02:19:10 -08001245 void __user *newval, size_t newlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246{
1247 unsigned char tmp_uuid[16], *uuid;
1248 unsigned int len;
1249
1250 if (!oldval || !oldlenp)
1251 return 1;
1252
1253 uuid = table->data;
1254 if (!uuid) {
1255 uuid = tmp_uuid;
1256 uuid[8] = 0;
1257 }
1258 if (uuid[8] == 0)
1259 generate_random_uuid(uuid);
1260
1261 if (get_user(len, oldlenp))
1262 return -EFAULT;
1263 if (len) {
1264 if (len > 16)
1265 len = 16;
1266 if (copy_to_user(oldval, uuid, len) ||
1267 put_user(len, oldlenp))
1268 return -EFAULT;
1269 }
1270 return 1;
1271}
1272
1273static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
1274ctl_table random_table[] = {
1275 {
1276 .ctl_name = RANDOM_POOLSIZE,
1277 .procname = "poolsize",
1278 .data = &sysctl_poolsize,
1279 .maxlen = sizeof(int),
1280 .mode = 0444,
1281 .proc_handler = &proc_dointvec,
1282 },
1283 {
1284 .ctl_name = RANDOM_ENTROPY_COUNT,
1285 .procname = "entropy_avail",
1286 .maxlen = sizeof(int),
1287 .mode = 0444,
1288 .proc_handler = &proc_dointvec,
1289 .data = &input_pool.entropy_count,
1290 },
1291 {
1292 .ctl_name = RANDOM_READ_THRESH,
1293 .procname = "read_wakeup_threshold",
1294 .data = &random_read_wakeup_thresh,
1295 .maxlen = sizeof(int),
1296 .mode = 0644,
1297 .proc_handler = &proc_dointvec_minmax,
1298 .strategy = &sysctl_intvec,
1299 .extra1 = &min_read_thresh,
1300 .extra2 = &max_read_thresh,
1301 },
1302 {
1303 .ctl_name = RANDOM_WRITE_THRESH,
1304 .procname = "write_wakeup_threshold",
1305 .data = &random_write_wakeup_thresh,
1306 .maxlen = sizeof(int),
1307 .mode = 0644,
1308 .proc_handler = &proc_dointvec_minmax,
1309 .strategy = &sysctl_intvec,
1310 .extra1 = &min_write_thresh,
1311 .extra2 = &max_write_thresh,
1312 },
1313 {
1314 .ctl_name = RANDOM_BOOT_ID,
1315 .procname = "boot_id",
1316 .data = &sysctl_bootid,
1317 .maxlen = 16,
1318 .mode = 0444,
1319 .proc_handler = &proc_do_uuid,
1320 .strategy = &uuid_strategy,
1321 },
1322 {
1323 .ctl_name = RANDOM_UUID,
1324 .procname = "uuid",
1325 .maxlen = 16,
1326 .mode = 0444,
1327 .proc_handler = &proc_do_uuid,
1328 .strategy = &uuid_strategy,
1329 },
1330 { .ctl_name = 0 }
1331};
1332#endif /* CONFIG_SYSCTL */
1333
1334/********************************************************************
1335 *
1336 * Random funtions for networking
1337 *
1338 ********************************************************************/
1339
1340/*
1341 * TCP initial sequence number picking. This uses the random number
1342 * generator to pick an initial secret value. This value is hashed
1343 * along with the TCP endpoint information to provide a unique
1344 * starting point for each pair of TCP endpoints. This defeats
1345 * attacks which rely on guessing the initial TCP sequence number.
1346 * This algorithm was suggested by Steve Bellovin.
1347 *
1348 * Using a very strong hash was taking an appreciable amount of the total
1349 * TCP connection establishment time, so this is a weaker hash,
1350 * compensated for by changing the secret periodically.
1351 */
1352
1353/* F, G and H are basic MD4 functions: selection, majority, parity */
1354#define F(x, y, z) ((z) ^ ((x) & ((y) ^ (z))))
1355#define G(x, y, z) (((x) & (y)) + (((x) ^ (y)) & (z)))
1356#define H(x, y, z) ((x) ^ (y) ^ (z))
1357
1358/*
1359 * The generic round function. The application is so specific that
1360 * we don't bother protecting all the arguments with parens, as is generally
1361 * good macro practice, in favor of extra legibility.
1362 * Rotation is separate from addition to prevent recomputation
1363 */
1364#define ROUND(f, a, b, c, d, x, s) \
1365 (a += f(b, c, d) + x, a = (a << s) | (a >> (32 - s)))
1366#define K1 0
1367#define K2 013240474631UL
1368#define K3 015666365641UL
1369
1370#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
1371
Matt Mackall90b75ee2008-04-29 01:02:55 -07001372static __u32 twothirdsMD4Transform(__u32 const buf[4], __u32 const in[12])
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373{
1374 __u32 a = buf[0], b = buf[1], c = buf[2], d = buf[3];
1375
1376 /* Round 1 */
1377 ROUND(F, a, b, c, d, in[ 0] + K1, 3);
1378 ROUND(F, d, a, b, c, in[ 1] + K1, 7);
1379 ROUND(F, c, d, a, b, in[ 2] + K1, 11);
1380 ROUND(F, b, c, d, a, in[ 3] + K1, 19);
1381 ROUND(F, a, b, c, d, in[ 4] + K1, 3);
1382 ROUND(F, d, a, b, c, in[ 5] + K1, 7);
1383 ROUND(F, c, d, a, b, in[ 6] + K1, 11);
1384 ROUND(F, b, c, d, a, in[ 7] + K1, 19);
1385 ROUND(F, a, b, c, d, in[ 8] + K1, 3);
1386 ROUND(F, d, a, b, c, in[ 9] + K1, 7);
1387 ROUND(F, c, d, a, b, in[10] + K1, 11);
1388 ROUND(F, b, c, d, a, in[11] + K1, 19);
1389
1390 /* Round 2 */
1391 ROUND(G, a, b, c, d, in[ 1] + K2, 3);
1392 ROUND(G, d, a, b, c, in[ 3] + K2, 5);
1393 ROUND(G, c, d, a, b, in[ 5] + K2, 9);
1394 ROUND(G, b, c, d, a, in[ 7] + K2, 13);
1395 ROUND(G, a, b, c, d, in[ 9] + K2, 3);
1396 ROUND(G, d, a, b, c, in[11] + K2, 5);
1397 ROUND(G, c, d, a, b, in[ 0] + K2, 9);
1398 ROUND(G, b, c, d, a, in[ 2] + K2, 13);
1399 ROUND(G, a, b, c, d, in[ 4] + K2, 3);
1400 ROUND(G, d, a, b, c, in[ 6] + K2, 5);
1401 ROUND(G, c, d, a, b, in[ 8] + K2, 9);
1402 ROUND(G, b, c, d, a, in[10] + K2, 13);
1403
1404 /* Round 3 */
1405 ROUND(H, a, b, c, d, in[ 3] + K3, 3);
1406 ROUND(H, d, a, b, c, in[ 7] + K3, 9);
1407 ROUND(H, c, d, a, b, in[11] + K3, 11);
1408 ROUND(H, b, c, d, a, in[ 2] + K3, 15);
1409 ROUND(H, a, b, c, d, in[ 6] + K3, 3);
1410 ROUND(H, d, a, b, c, in[10] + K3, 9);
1411 ROUND(H, c, d, a, b, in[ 1] + K3, 11);
1412 ROUND(H, b, c, d, a, in[ 5] + K3, 15);
1413 ROUND(H, a, b, c, d, in[ 9] + K3, 3);
1414 ROUND(H, d, a, b, c, in[ 0] + K3, 9);
1415 ROUND(H, c, d, a, b, in[ 4] + K3, 11);
1416 ROUND(H, b, c, d, a, in[ 8] + K3, 15);
1417
1418 return buf[1] + b; /* "most hashed" word */
1419 /* Alternative: return sum of all words? */
1420}
1421#endif
1422
1423#undef ROUND
1424#undef F
1425#undef G
1426#undef H
1427#undef K1
1428#undef K2
1429#undef K3
1430
1431/* This should not be decreased so low that ISNs wrap too fast. */
1432#define REKEY_INTERVAL (300 * HZ)
1433/*
1434 * Bit layout of the tcp sequence numbers (before adding current time):
1435 * bit 24-31: increased after every key exchange
1436 * bit 0-23: hash(source,dest)
1437 *
1438 * The implementation is similar to the algorithm described
1439 * in the Appendix of RFC 1185, except that
1440 * - it uses a 1 MHz clock instead of a 250 kHz clock
1441 * - it performs a rekey every 5 minutes, which is equivalent
1442 * to a (source,dest) tulple dependent forward jump of the
1443 * clock by 0..2^(HASH_BITS+1)
1444 *
1445 * Thus the average ISN wraparound time is 68 minutes instead of
1446 * 4.55 hours.
1447 *
1448 * SMP cleanup and lock avoidance with poor man's RCU.
1449 * Manfred Spraul <manfred@colorfullife.com>
1450 *
1451 */
1452#define COUNT_BITS 8
1453#define COUNT_MASK ((1 << COUNT_BITS) - 1)
1454#define HASH_BITS 24
1455#define HASH_MASK ((1 << HASH_BITS) - 1)
1456
1457static struct keydata {
1458 __u32 count; /* already shifted to the final position */
1459 __u32 secret[12];
1460} ____cacheline_aligned ip_keydata[2];
1461
1462static unsigned int ip_cnt;
1463
David Howells65f27f32006-11-22 14:55:48 +00001464static void rekey_seq_generator(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465
David Howells65f27f32006-11-22 14:55:48 +00001466static DECLARE_DELAYED_WORK(rekey_work, rekey_seq_generator);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
1468/*
1469 * Lock avoidance:
1470 * The ISN generation runs lockless - it's just a hash over random data.
1471 * State changes happen every 5 minutes when the random key is replaced.
1472 * Synchronization is performed by having two copies of the hash function
1473 * state and rekey_seq_generator always updates the inactive copy.
1474 * The copy is then activated by updating ip_cnt.
1475 * The implementation breaks down if someone blocks the thread
1476 * that processes SYN requests for more than 5 minutes. Should never
1477 * happen, and even if that happens only a not perfectly compliant
1478 * ISN is generated, nothing fatal.
1479 */
David Howells65f27f32006-11-22 14:55:48 +00001480static void rekey_seq_generator(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481{
1482 struct keydata *keyptr = &ip_keydata[1 ^ (ip_cnt & 1)];
1483
1484 get_random_bytes(keyptr->secret, sizeof(keyptr->secret));
1485 keyptr->count = (ip_cnt & COUNT_MASK) << HASH_BITS;
1486 smp_wmb();
1487 ip_cnt++;
1488 schedule_delayed_work(&rekey_work, REKEY_INTERVAL);
1489}
1490
1491static inline struct keydata *get_keyptr(void)
1492{
1493 struct keydata *keyptr = &ip_keydata[ip_cnt & 1];
1494
1495 smp_rmb();
1496
1497 return keyptr;
1498}
1499
1500static __init int seqgen_init(void)
1501{
1502 rekey_seq_generator(NULL);
1503 return 0;
1504}
1505late_initcall(seqgen_init);
1506
1507#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
Al Virob09b845c2006-11-14 20:52:19 -08001508__u32 secure_tcpv6_sequence_number(__be32 *saddr, __be32 *daddr,
1509 __be16 sport, __be16 dport)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 __u32 seq;
1512 __u32 hash[12];
1513 struct keydata *keyptr = get_keyptr();
1514
1515 /* The procedure is the same as for IPv4, but addresses are longer.
1516 * Thus we must use twothirdsMD4Transform.
1517 */
1518
1519 memcpy(hash, saddr, 16);
Matt Mackall90b75ee2008-04-29 01:02:55 -07001520 hash[4] = ((__force u16)sport << 16) + (__force u16)dport;
1521 memcpy(&hash[5], keyptr->secret, sizeof(__u32) * 7);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
Al Virob09b845c2006-11-14 20:52:19 -08001523 seq = twothirdsMD4Transform((const __u32 *)daddr, hash) & HASH_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 seq += keyptr->count;
1525
Eric Dumazet6dd10a62007-11-13 21:12:14 -08001526 seq += ktime_to_ns(ktime_get_real());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
1528 return seq;
1529}
1530EXPORT_SYMBOL(secure_tcpv6_sequence_number);
1531#endif
1532
1533/* The code below is shamelessly stolen from secure_tcp_sequence_number().
1534 * All blames to Andrey V. Savochkin <saw@msu.ru>.
1535 */
Al Virob09b845c2006-11-14 20:52:19 -08001536__u32 secure_ip_id(__be32 daddr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537{
1538 struct keydata *keyptr;
1539 __u32 hash[4];
1540
1541 keyptr = get_keyptr();
1542
1543 /*
1544 * Pick a unique starting offset for each IP destination.
1545 * The dest ip address is placed in the starting vector,
1546 * which is then hashed with random data.
1547 */
Al Virob09b845c2006-11-14 20:52:19 -08001548 hash[0] = (__force __u32)daddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 hash[1] = keyptr->secret[9];
1550 hash[2] = keyptr->secret[10];
1551 hash[3] = keyptr->secret[11];
1552
1553 return half_md4_transform(hash, keyptr->secret);
1554}
1555
1556#ifdef CONFIG_INET
1557
Al Virob09b845c2006-11-14 20:52:19 -08001558__u32 secure_tcp_sequence_number(__be32 saddr, __be32 daddr,
1559 __be16 sport, __be16 dport)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 __u32 seq;
1562 __u32 hash[4];
1563 struct keydata *keyptr = get_keyptr();
1564
1565 /*
1566 * Pick a unique starting offset for each TCP connection endpoints
1567 * (saddr, daddr, sport, dport).
1568 * Note that the words are placed into the starting vector, which is
1569 * then mixed with a partial MD4 over random data.
1570 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001571 hash[0] = (__force u32)saddr;
1572 hash[1] = (__force u32)daddr;
1573 hash[2] = ((__force u16)sport << 16) + (__force u16)dport;
1574 hash[3] = keyptr->secret[11];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
1576 seq = half_md4_transform(hash, keyptr->secret) & HASH_MASK;
1577 seq += keyptr->count;
1578 /*
1579 * As close as possible to RFC 793, which
1580 * suggests using a 250 kHz clock.
1581 * Further reading shows this assumes 2 Mb/s networks.
Eric Dumazet9b42c332007-10-01 13:58:36 -07001582 * For 10 Mb/s Ethernet, a 1 MHz clock is appropriate.
1583 * For 10 Gb/s Ethernet, a 1 GHz clock should be ok, but
1584 * we also need to limit the resolution so that the u32 seq
1585 * overlaps less than one time per MSL (2 minutes).
1586 * Choosing a clock of 64 ns period is OK. (period of 274 s)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 */
Eric Dumazet6dd10a62007-11-13 21:12:14 -08001588 seq += ktime_to_ns(ktime_get_real()) >> 6;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001589
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 return seq;
1591}
1592
Arnaldo Carvalho de Meloa7f5e7f2005-12-13 23:25:31 -08001593/* Generate secure starting point for ephemeral IPV4 transport port search */
Al Virob09b845c2006-11-14 20:52:19 -08001594u32 secure_ipv4_port_ephemeral(__be32 saddr, __be32 daddr, __be16 dport)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595{
1596 struct keydata *keyptr = get_keyptr();
1597 u32 hash[4];
1598
1599 /*
1600 * Pick a unique starting offset for each ephemeral port search
1601 * (saddr, daddr, dport) and 48bits of random data.
1602 */
Al Virob09b845c2006-11-14 20:52:19 -08001603 hash[0] = (__force u32)saddr;
1604 hash[1] = (__force u32)daddr;
1605 hash[2] = (__force u32)dport ^ keyptr->secret[10];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 hash[3] = keyptr->secret[11];
1607
1608 return half_md4_transform(hash, keyptr->secret);
1609}
Stephen Hemminger9f593652008-08-18 21:32:32 -07001610EXPORT_SYMBOL_GPL(secure_ipv4_port_ephemeral);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
1612#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
Matt Mackall90b75ee2008-04-29 01:02:55 -07001613u32 secure_ipv6_port_ephemeral(const __be32 *saddr, const __be32 *daddr,
1614 __be16 dport)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615{
1616 struct keydata *keyptr = get_keyptr();
1617 u32 hash[12];
1618
1619 memcpy(hash, saddr, 16);
Al Virob09b845c2006-11-14 20:52:19 -08001620 hash[4] = (__force u32)dport;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001621 memcpy(&hash[5], keyptr->secret, sizeof(__u32) * 7);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
Al Virob09b845c2006-11-14 20:52:19 -08001623 return twothirdsMD4Transform((const __u32 *)daddr, hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625#endif
1626
Arnaldo Carvalho de Meloc4365c92005-08-09 20:12:30 -07001627#if defined(CONFIG_IP_DCCP) || defined(CONFIG_IP_DCCP_MODULE)
1628/* Similar to secure_tcp_sequence_number but generate a 48 bit value
1629 * bit's 32-47 increase every key exchange
1630 * 0-31 hash(source, dest)
1631 */
Al Virob09b845c2006-11-14 20:52:19 -08001632u64 secure_dccp_sequence_number(__be32 saddr, __be32 daddr,
1633 __be16 sport, __be16 dport)
Arnaldo Carvalho de Meloc4365c92005-08-09 20:12:30 -07001634{
Arnaldo Carvalho de Meloc4365c92005-08-09 20:12:30 -07001635 u64 seq;
1636 __u32 hash[4];
1637 struct keydata *keyptr = get_keyptr();
1638
Al Virob09b845c2006-11-14 20:52:19 -08001639 hash[0] = (__force u32)saddr;
1640 hash[1] = (__force u32)daddr;
1641 hash[2] = ((__force u16)sport << 16) + (__force u16)dport;
Arnaldo Carvalho de Meloc4365c92005-08-09 20:12:30 -07001642 hash[3] = keyptr->secret[11];
1643
1644 seq = half_md4_transform(hash, keyptr->secret);
1645 seq |= ((u64)keyptr->count) << (32 - HASH_BITS);
1646
Eric Dumazet6dd10a62007-11-13 21:12:14 -08001647 seq += ktime_to_ns(ktime_get_real());
Arnaldo Carvalho de Meloc4365c92005-08-09 20:12:30 -07001648 seq &= (1ull << 48) - 1;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001649
Arnaldo Carvalho de Meloc4365c92005-08-09 20:12:30 -07001650 return seq;
1651}
Arnaldo Carvalho de Meloc4365c92005-08-09 20:12:30 -07001652EXPORT_SYMBOL(secure_dccp_sequence_number);
1653#endif
1654
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655#endif /* CONFIG_INET */
1656
1657
1658/*
1659 * Get a random word for internal kernel use only. Similar to urandom but
1660 * with the goal of minimal entropy pool depletion. As a result, the random
1661 * value is not cryptographically secure but for several uses the cost of
1662 * depleting entropy is too high
1663 */
1664unsigned int get_random_int(void)
1665{
1666 /*
1667 * Use IP's RNG. It suits our purpose perfectly: it re-keys itself
1668 * every second, from the entropy pool (and thus creates a limited
1669 * drain on it), and uses halfMD4Transform within the second. We
1670 * also mix it with jiffies and the PID:
1671 */
Al Virob09b845c2006-11-14 20:52:19 -08001672 return secure_ip_id((__force __be32)(current->pid + jiffies));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673}
1674
1675/*
1676 * randomize_range() returns a start address such that
1677 *
1678 * [...... <range> .....]
1679 * start end
1680 *
1681 * a <range> with size "len" starting at the return value is inside in the
1682 * area defined by [start, end], but is otherwise randomized.
1683 */
1684unsigned long
1685randomize_range(unsigned long start, unsigned long end, unsigned long len)
1686{
1687 unsigned long range = end - len - start;
1688
1689 if (end <= start + len)
1690 return 0;
1691 return PAGE_ALIGN(get_random_int() % range + start);
1692}