random: always update the entropy pool under the spinlock
[cascardo/linux.git] / drivers / char / random.c
1 /*
2  * random.c -- A strong random number generator
3  *
4  * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
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_device_randomness(const void *buf, unsigned int size);
129  *      void add_input_randomness(unsigned int type, unsigned int code,
130  *                                unsigned int value);
131  *      void add_interrupt_randomness(int irq, int irq_flags);
132  *      void add_disk_randomness(struct gendisk *disk);
133  *
134  * add_device_randomness() is for adding data to the random pool that
135  * is likely to differ between two devices (or possibly even per boot).
136  * This would be things like MAC addresses or serial numbers, or the
137  * read-out of the RTC. This does *not* add any actual entropy to the
138  * pool, but it initializes the pool to different values for devices
139  * that might otherwise be identical and have very little entropy
140  * available to them (particularly common in the embedded world).
141  *
142  * add_input_randomness() uses the input layer interrupt timing, as well as
143  * the event type information from the hardware.
144  *
145  * add_interrupt_randomness() uses the interrupt timing as random
146  * inputs to the entropy pool. Using the cycle counters and the irq source
147  * as inputs, it feeds the randomness roughly once a second.
148  *
149  * add_disk_randomness() uses what amounts to the seek time of block
150  * layer request events, on a per-disk_devt basis, as input to the
151  * entropy pool. Note that high-speed solid state drives with very low
152  * seek times do not make for good sources of entropy, as their seek
153  * times are usually fairly consistent.
154  *
155  * All of these routines try to estimate how many bits of randomness a
156  * particular randomness source.  They do this by keeping track of the
157  * first and second order deltas of the event timings.
158  *
159  * Ensuring unpredictability at system startup
160  * ============================================
161  *
162  * When any operating system starts up, it will go through a sequence
163  * of actions that are fairly predictable by an adversary, especially
164  * if the start-up does not involve interaction with a human operator.
165  * This reduces the actual number of bits of unpredictability in the
166  * entropy pool below the value in entropy_count.  In order to
167  * counteract this effect, it helps to carry information in the
168  * entropy pool across shut-downs and start-ups.  To do this, put the
169  * following lines an appropriate script which is run during the boot
170  * sequence:
171  *
172  *      echo "Initializing random number generator..."
173  *      random_seed=/var/run/random-seed
174  *      # Carry a random seed from start-up to start-up
175  *      # Load and then save the whole entropy pool
176  *      if [ -f $random_seed ]; then
177  *              cat $random_seed >/dev/urandom
178  *      else
179  *              touch $random_seed
180  *      fi
181  *      chmod 600 $random_seed
182  *      dd if=/dev/urandom of=$random_seed count=1 bs=512
183  *
184  * and the following lines in an appropriate script which is run as
185  * the system is shutdown:
186  *
187  *      # Carry a random seed from shut-down to start-up
188  *      # Save the whole entropy pool
189  *      echo "Saving random seed..."
190  *      random_seed=/var/run/random-seed
191  *      touch $random_seed
192  *      chmod 600 $random_seed
193  *      dd if=/dev/urandom of=$random_seed count=1 bs=512
194  *
195  * For example, on most modern systems using the System V init
196  * scripts, such code fragments would be found in
197  * /etc/rc.d/init.d/random.  On older Linux systems, the correct script
198  * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
199  *
200  * Effectively, these commands cause the contents of the entropy pool
201  * to be saved at shut-down time and reloaded into the entropy pool at
202  * start-up.  (The 'dd' in the addition to the bootup script is to
203  * make sure that /etc/random-seed is different for every start-up,
204  * even if the system crashes without executing rc.0.)  Even with
205  * complete knowledge of the start-up activities, predicting the state
206  * of the entropy pool requires knowledge of the previous history of
207  * the system.
208  *
209  * Configuring the /dev/random driver under Linux
210  * ==============================================
211  *
212  * The /dev/random driver under Linux uses minor numbers 8 and 9 of
213  * the /dev/mem major number (#1).  So if your system does not have
214  * /dev/random and /dev/urandom created already, they can be created
215  * by using the commands:
216  *
217  *      mknod /dev/random c 1 8
218  *      mknod /dev/urandom c 1 9
219  *
220  * Acknowledgements:
221  * =================
222  *
223  * Ideas for constructing this random number generator were derived
224  * from Pretty Good Privacy's random number generator, and from private
225  * discussions with Phil Karn.  Colin Plumb provided a faster random
226  * number generator, which speed up the mixing function of the entropy
227  * pool, taken from PGPfone.  Dale Worley has also contributed many
228  * useful ideas and suggestions to improve this driver.
229  *
230  * Any flaws in the design are solely my responsibility, and should
231  * not be attributed to the Phil, Colin, or any of authors of PGP.
232  *
233  * Further background information on this topic may be obtained from
234  * RFC 1750, "Randomness Recommendations for Security", by Donald
235  * Eastlake, Steve Crocker, and Jeff Schiller.
236  */
237
238 #include <linux/utsname.h>
239 #include <linux/module.h>
240 #include <linux/kernel.h>
241 #include <linux/major.h>
242 #include <linux/string.h>
243 #include <linux/fcntl.h>
244 #include <linux/slab.h>
245 #include <linux/random.h>
246 #include <linux/poll.h>
247 #include <linux/init.h>
248 #include <linux/fs.h>
249 #include <linux/genhd.h>
250 #include <linux/interrupt.h>
251 #include <linux/mm.h>
252 #include <linux/spinlock.h>
253 #include <linux/percpu.h>
254 #include <linux/cryptohash.h>
255 #include <linux/fips.h>
256 #include <linux/ptrace.h>
257 #include <linux/kmemcheck.h>
258 #include <linux/workqueue.h>
259 #include <linux/irq.h>
260
261 #include <asm/processor.h>
262 #include <asm/uaccess.h>
263 #include <asm/irq.h>
264 #include <asm/irq_regs.h>
265 #include <asm/io.h>
266
267 #define CREATE_TRACE_POINTS
268 #include <trace/events/random.h>
269
270 /*
271  * Configuration information
272  */
273 #define INPUT_POOL_SHIFT        12
274 #define INPUT_POOL_WORDS        (1 << (INPUT_POOL_SHIFT-5))
275 #define OUTPUT_POOL_SHIFT       10
276 #define OUTPUT_POOL_WORDS       (1 << (OUTPUT_POOL_SHIFT-5))
277 #define SEC_XFER_SIZE           512
278 #define EXTRACT_SIZE            10
279
280 #define DEBUG_RANDOM_BOOT 0
281
282 #define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
283
284 /*
285  * To allow fractional bits to be tracked, the entropy_count field is
286  * denominated in units of 1/8th bits.
287  *
288  * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
289  * credit_entropy_bits() needs to be 64 bits wide.
290  */
291 #define ENTROPY_SHIFT 3
292 #define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
293
294 /*
295  * The minimum number of bits of entropy before we wake up a read on
296  * /dev/random.  Should be enough to do a significant reseed.
297  */
298 static int random_read_wakeup_bits = 64;
299
300 /*
301  * If the entropy count falls under this number of bits, then we
302  * should wake up processes which are selecting or polling on write
303  * access to /dev/random.
304  */
305 static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
306
307 /*
308  * The minimum number of seconds between urandom pool reseeding.  We
309  * do this to limit the amount of entropy that can be drained from the
310  * input pool even if there are heavy demands on /dev/urandom.
311  */
312 static int random_min_urandom_seed = 60;
313
314 /*
315  * Originally, we used a primitive polynomial of degree .poolwords
316  * over GF(2).  The taps for various sizes are defined below.  They
317  * were chosen to be evenly spaced except for the last tap, which is 1
318  * to get the twisting happening as fast as possible.
319  *
320  * For the purposes of better mixing, we use the CRC-32 polynomial as
321  * well to make a (modified) twisted Generalized Feedback Shift
322  * Register.  (See M. Matsumoto & Y. Kurita, 1992.  Twisted GFSR
323  * generators.  ACM Transactions on Modeling and Computer Simulation
324  * 2(3):179-194.  Also see M. Matsumoto & Y. Kurita, 1994.  Twisted
325  * GFSR generators II.  ACM Transactions on Modeling and Computer
326  * Simulation 4:254-266)
327  *
328  * Thanks to Colin Plumb for suggesting this.
329  *
330  * The mixing operation is much less sensitive than the output hash,
331  * where we use SHA-1.  All that we want of mixing operation is that
332  * it be a good non-cryptographic hash; i.e. it not produce collisions
333  * when fed "random" data of the sort we expect to see.  As long as
334  * the pool state differs for different inputs, we have preserved the
335  * input entropy and done a good job.  The fact that an intelligent
336  * attacker can construct inputs that will produce controlled
337  * alterations to the pool's state is not important because we don't
338  * consider such inputs to contribute any randomness.  The only
339  * property we need with respect to them is that the attacker can't
340  * increase his/her knowledge of the pool's state.  Since all
341  * additions are reversible (knowing the final state and the input,
342  * you can reconstruct the initial state), if an attacker has any
343  * uncertainty about the initial state, he/she can only shuffle that
344  * uncertainty about, but never cause any collisions (which would
345  * decrease the uncertainty).
346  *
347  * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
348  * Videau in their paper, "The Linux Pseudorandom Number Generator
349  * Revisited" (see: http://eprint.iacr.org/2012/251.pdf).  In their
350  * paper, they point out that we are not using a true Twisted GFSR,
351  * since Matsumoto & Kurita used a trinomial feedback polynomial (that
352  * is, with only three taps, instead of the six that we are using).
353  * As a result, the resulting polynomial is neither primitive nor
354  * irreducible, and hence does not have a maximal period over
355  * GF(2**32).  They suggest a slight change to the generator
356  * polynomial which improves the resulting TGFSR polynomial to be
357  * irreducible, which we have made here.
358  */
359 static struct poolinfo {
360         int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
361 #define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
362         int tap1, tap2, tap3, tap4, tap5;
363 } poolinfo_table[] = {
364         /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
365         /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
366         { S(128),       104,    76,     51,     25,     1 },
367         /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
368         /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
369         { S(32),        26,     19,     14,     7,      1 },
370 #if 0
371         /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1  -- 115 */
372         { S(2048),      1638,   1231,   819,    411,    1 },
373
374         /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
375         { S(1024),      817,    615,    412,    204,    1 },
376
377         /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
378         { S(1024),      819,    616,    410,    207,    2 },
379
380         /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
381         { S(512),       411,    308,    208,    104,    1 },
382
383         /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
384         { S(512),       409,    307,    206,    102,    2 },
385         /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
386         { S(512),       409,    309,    205,    103,    2 },
387
388         /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
389         { S(256),       205,    155,    101,    52,     1 },
390
391         /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
392         { S(128),       103,    78,     51,     27,     2 },
393
394         /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
395         { S(64),        52,     39,     26,     14,     1 },
396 #endif
397 };
398
399 /*
400  * Static global variables
401  */
402 static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
403 static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
404 static struct fasync_struct *fasync;
405
406 /**********************************************************************
407  *
408  * OS independent entropy store.   Here are the functions which handle
409  * storing entropy in an entropy pool.
410  *
411  **********************************************************************/
412
413 struct entropy_store;
414 struct entropy_store {
415         /* read-only data: */
416         const struct poolinfo *poolinfo;
417         __u32 *pool;
418         const char *name;
419         struct entropy_store *pull;
420         struct work_struct push_work;
421
422         /* read-write data: */
423         unsigned long last_pulled;
424         spinlock_t lock;
425         unsigned short add_ptr;
426         unsigned short input_rotate;
427         int entropy_count;
428         int entropy_total;
429         unsigned int initialized:1;
430         unsigned int limit:1;
431         unsigned int last_data_init:1;
432         __u8 last_data[EXTRACT_SIZE];
433 };
434
435 static void push_to_pool(struct work_struct *work);
436 static __u32 input_pool_data[INPUT_POOL_WORDS];
437 static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
438 static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
439
440 static struct entropy_store input_pool = {
441         .poolinfo = &poolinfo_table[0],
442         .name = "input",
443         .limit = 1,
444         .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
445         .pool = input_pool_data
446 };
447
448 static struct entropy_store blocking_pool = {
449         .poolinfo = &poolinfo_table[1],
450         .name = "blocking",
451         .limit = 1,
452         .pull = &input_pool,
453         .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
454         .pool = blocking_pool_data,
455         .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
456                                         push_to_pool),
457 };
458
459 static struct entropy_store nonblocking_pool = {
460         .poolinfo = &poolinfo_table[1],
461         .name = "nonblocking",
462         .pull = &input_pool,
463         .lock = __SPIN_LOCK_UNLOCKED(nonblocking_pool.lock),
464         .pool = nonblocking_pool_data,
465         .push_work = __WORK_INITIALIZER(nonblocking_pool.push_work,
466                                         push_to_pool),
467 };
468
469 static __u32 const twist_table[8] = {
470         0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
471         0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
472
473 /*
474  * This function adds bytes into the entropy "pool".  It does not
475  * update the entropy estimate.  The caller should call
476  * credit_entropy_bits if this is appropriate.
477  *
478  * The pool is stirred with a primitive polynomial of the appropriate
479  * degree, and then twisted.  We twist by three bits at a time because
480  * it's cheap to do so and helps slightly in the expected case where
481  * the entropy is concentrated in the low-order bits.
482  */
483 static void _mix_pool_bytes(struct entropy_store *r, const void *in,
484                             int nbytes, __u8 out[64])
485 {
486         unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
487         int input_rotate;
488         int wordmask = r->poolinfo->poolwords - 1;
489         const char *bytes = in;
490         __u32 w;
491
492         tap1 = r->poolinfo->tap1;
493         tap2 = r->poolinfo->tap2;
494         tap3 = r->poolinfo->tap3;
495         tap4 = r->poolinfo->tap4;
496         tap5 = r->poolinfo->tap5;
497
498         input_rotate = r->input_rotate;
499         i = r->add_ptr;
500
501         /* mix one byte at a time to simplify size handling and churn faster */
502         while (nbytes--) {
503                 w = rol32(*bytes++, input_rotate);
504                 i = (i - 1) & wordmask;
505
506                 /* XOR in the various taps */
507                 w ^= r->pool[i];
508                 w ^= r->pool[(i + tap1) & wordmask];
509                 w ^= r->pool[(i + tap2) & wordmask];
510                 w ^= r->pool[(i + tap3) & wordmask];
511                 w ^= r->pool[(i + tap4) & wordmask];
512                 w ^= r->pool[(i + tap5) & wordmask];
513
514                 /* Mix the result back in with a twist */
515                 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
516
517                 /*
518                  * Normally, we add 7 bits of rotation to the pool.
519                  * At the beginning of the pool, add an extra 7 bits
520                  * rotation, so that successive passes spread the
521                  * input bits across the pool evenly.
522                  */
523                 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
524         }
525
526         r->input_rotate = input_rotate;
527         r->add_ptr = i;
528
529         if (out)
530                 for (j = 0; j < 16; j++)
531                         ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
532 }
533
534 static void __mix_pool_bytes(struct entropy_store *r, const void *in,
535                              int nbytes, __u8 out[64])
536 {
537         trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
538         _mix_pool_bytes(r, in, nbytes, out);
539 }
540
541 static void mix_pool_bytes(struct entropy_store *r, const void *in,
542                            int nbytes, __u8 out[64])
543 {
544         unsigned long flags;
545
546         trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
547         spin_lock_irqsave(&r->lock, flags);
548         _mix_pool_bytes(r, in, nbytes, out);
549         spin_unlock_irqrestore(&r->lock, flags);
550 }
551
552 struct fast_pool {
553         __u32           pool[4];
554         unsigned long   last;
555         unsigned short  count;
556         unsigned char   rotate;
557         unsigned char   last_timer_intr;
558 };
559
560 /*
561  * This is a fast mixing routine used by the interrupt randomness
562  * collector.  It's hardcoded for an 128 bit pool and assumes that any
563  * locks that might be needed are taken by the caller.
564  */
565 static void fast_mix(struct fast_pool *f, __u32 input[4])
566 {
567         __u32           w;
568         unsigned        input_rotate = f->rotate;
569
570         w = rol32(input[0], input_rotate) ^ f->pool[0] ^ f->pool[3];
571         f->pool[0] = (w >> 3) ^ twist_table[w & 7];
572         input_rotate = (input_rotate + 14) & 31;
573         w = rol32(input[1], input_rotate) ^ f->pool[1] ^ f->pool[0];
574         f->pool[1] = (w >> 3) ^ twist_table[w & 7];
575         input_rotate = (input_rotate + 7) & 31;
576         w = rol32(input[2], input_rotate) ^ f->pool[2] ^ f->pool[1];
577         f->pool[2] = (w >> 3) ^ twist_table[w & 7];
578         input_rotate = (input_rotate + 7) & 31;
579         w = rol32(input[3], input_rotate) ^ f->pool[3] ^ f->pool[2];
580         f->pool[3] = (w >> 3) ^ twist_table[w & 7];
581         input_rotate = (input_rotate + 7) & 31;
582
583         f->rotate = input_rotate;
584         f->count++;
585 }
586
587 /*
588  * Credit (or debit) the entropy store with n bits of entropy.
589  * Use credit_entropy_bits_safe() if the value comes from userspace
590  * or otherwise should be checked for extreme values.
591  */
592 static void credit_entropy_bits(struct entropy_store *r, int nbits)
593 {
594         int entropy_count, orig;
595         const int pool_size = r->poolinfo->poolfracbits;
596         int nfrac = nbits << ENTROPY_SHIFT;
597
598         if (!nbits)
599                 return;
600
601 retry:
602         entropy_count = orig = ACCESS_ONCE(r->entropy_count);
603         if (nfrac < 0) {
604                 /* Debit */
605                 entropy_count += nfrac;
606         } else {
607                 /*
608                  * Credit: we have to account for the possibility of
609                  * overwriting already present entropy.  Even in the
610                  * ideal case of pure Shannon entropy, new contributions
611                  * approach the full value asymptotically:
612                  *
613                  * entropy <- entropy + (pool_size - entropy) *
614                  *      (1 - exp(-add_entropy/pool_size))
615                  *
616                  * For add_entropy <= pool_size/2 then
617                  * (1 - exp(-add_entropy/pool_size)) >=
618                  *    (add_entropy/pool_size)*0.7869...
619                  * so we can approximate the exponential with
620                  * 3/4*add_entropy/pool_size and still be on the
621                  * safe side by adding at most pool_size/2 at a time.
622                  *
623                  * The use of pool_size-2 in the while statement is to
624                  * prevent rounding artifacts from making the loop
625                  * arbitrarily long; this limits the loop to log2(pool_size)*2
626                  * turns no matter how large nbits is.
627                  */
628                 int pnfrac = nfrac;
629                 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
630                 /* The +2 corresponds to the /4 in the denominator */
631
632                 do {
633                         unsigned int anfrac = min(pnfrac, pool_size/2);
634                         unsigned int add =
635                                 ((pool_size - entropy_count)*anfrac*3) >> s;
636
637                         entropy_count += add;
638                         pnfrac -= anfrac;
639                 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
640         }
641
642         if (entropy_count < 0) {
643                 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
644                         r->name, entropy_count);
645                 WARN_ON(1);
646                 entropy_count = 0;
647         } else if (entropy_count > pool_size)
648                 entropy_count = pool_size;
649         if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
650                 goto retry;
651
652         r->entropy_total += nbits;
653         if (!r->initialized && r->entropy_total > 128) {
654                 r->initialized = 1;
655                 r->entropy_total = 0;
656                 if (r == &nonblocking_pool) {
657                         prandom_reseed_late();
658                         pr_notice("random: %s pool is initialized\n", r->name);
659                 }
660         }
661
662         trace_credit_entropy_bits(r->name, nbits,
663                                   entropy_count >> ENTROPY_SHIFT,
664                                   r->entropy_total, _RET_IP_);
665
666         if (r == &input_pool) {
667                 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
668
669                 /* should we wake readers? */
670                 if (entropy_bits >= random_read_wakeup_bits) {
671                         wake_up_interruptible(&random_read_wait);
672                         kill_fasync(&fasync, SIGIO, POLL_IN);
673                 }
674                 /* If the input pool is getting full, send some
675                  * entropy to the two output pools, flipping back and
676                  * forth between them, until the output pools are 75%
677                  * full.
678                  */
679                 if (entropy_bits > random_write_wakeup_bits &&
680                     r->initialized &&
681                     r->entropy_total >= 2*random_read_wakeup_bits) {
682                         static struct entropy_store *last = &blocking_pool;
683                         struct entropy_store *other = &blocking_pool;
684
685                         if (last == &blocking_pool)
686                                 other = &nonblocking_pool;
687                         if (other->entropy_count <=
688                             3 * other->poolinfo->poolfracbits / 4)
689                                 last = other;
690                         if (last->entropy_count <=
691                             3 * last->poolinfo->poolfracbits / 4) {
692                                 schedule_work(&last->push_work);
693                                 r->entropy_total = 0;
694                         }
695                 }
696         }
697 }
698
699 static void credit_entropy_bits_safe(struct entropy_store *r, int nbits)
700 {
701         const int nbits_max = (int)(~0U >> (ENTROPY_SHIFT + 1));
702
703         /* Cap the value to avoid overflows */
704         nbits = min(nbits,  nbits_max);
705         nbits = max(nbits, -nbits_max);
706
707         credit_entropy_bits(r, nbits);
708 }
709
710 /*********************************************************************
711  *
712  * Entropy input management
713  *
714  *********************************************************************/
715
716 /* There is one of these per entropy source */
717 struct timer_rand_state {
718         cycles_t last_time;
719         long last_delta, last_delta2;
720         unsigned dont_count_entropy:1;
721 };
722
723 #define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
724
725 /*
726  * Add device- or boot-specific data to the input and nonblocking
727  * pools to help initialize them to unique values.
728  *
729  * None of this adds any entropy, it is meant to avoid the
730  * problem of the nonblocking pool having similar initial state
731  * across largely identical devices.
732  */
733 void add_device_randomness(const void *buf, unsigned int size)
734 {
735         unsigned long time = random_get_entropy() ^ jiffies;
736         unsigned long flags;
737
738         trace_add_device_randomness(size, _RET_IP_);
739         spin_lock_irqsave(&input_pool.lock, flags);
740         _mix_pool_bytes(&input_pool, buf, size, NULL);
741         _mix_pool_bytes(&input_pool, &time, sizeof(time), NULL);
742         spin_unlock_irqrestore(&input_pool.lock, flags);
743
744         spin_lock_irqsave(&nonblocking_pool.lock, flags);
745         _mix_pool_bytes(&nonblocking_pool, buf, size, NULL);
746         _mix_pool_bytes(&nonblocking_pool, &time, sizeof(time), NULL);
747         spin_unlock_irqrestore(&nonblocking_pool.lock, flags);
748 }
749 EXPORT_SYMBOL(add_device_randomness);
750
751 static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
752
753 /*
754  * This function adds entropy to the entropy "pool" by using timing
755  * delays.  It uses the timer_rand_state structure to make an estimate
756  * of how many bits of entropy this call has added to the pool.
757  *
758  * The number "num" is also added to the pool - it should somehow describe
759  * the type of event which just happened.  This is currently 0-255 for
760  * keyboard scan codes, and 256 upwards for interrupts.
761  *
762  */
763 static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
764 {
765         struct entropy_store    *r;
766         struct {
767                 long jiffies;
768                 unsigned cycles;
769                 unsigned num;
770         } sample;
771         long delta, delta2, delta3;
772
773         preempt_disable();
774
775         sample.jiffies = jiffies;
776         sample.cycles = random_get_entropy();
777         sample.num = num;
778         r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
779         mix_pool_bytes(r, &sample, sizeof(sample), NULL);
780
781         /*
782          * Calculate number of bits of randomness we probably added.
783          * We take into account the first, second and third-order deltas
784          * in order to make our estimate.
785          */
786
787         if (!state->dont_count_entropy) {
788                 delta = sample.jiffies - state->last_time;
789                 state->last_time = sample.jiffies;
790
791                 delta2 = delta - state->last_delta;
792                 state->last_delta = delta;
793
794                 delta3 = delta2 - state->last_delta2;
795                 state->last_delta2 = delta2;
796
797                 if (delta < 0)
798                         delta = -delta;
799                 if (delta2 < 0)
800                         delta2 = -delta2;
801                 if (delta3 < 0)
802                         delta3 = -delta3;
803                 if (delta > delta2)
804                         delta = delta2;
805                 if (delta > delta3)
806                         delta = delta3;
807
808                 /*
809                  * delta is now minimum absolute delta.
810                  * Round down by 1 bit on general principles,
811                  * and limit entropy entimate to 12 bits.
812                  */
813                 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
814         }
815         preempt_enable();
816 }
817
818 void add_input_randomness(unsigned int type, unsigned int code,
819                                  unsigned int value)
820 {
821         static unsigned char last_value;
822
823         /* ignore autorepeat and the like */
824         if (value == last_value)
825                 return;
826
827         last_value = value;
828         add_timer_randomness(&input_timer_state,
829                              (type << 4) ^ code ^ (code >> 4) ^ value);
830         trace_add_input_randomness(ENTROPY_BITS(&input_pool));
831 }
832 EXPORT_SYMBOL_GPL(add_input_randomness);
833
834 static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
835
836 void add_interrupt_randomness(int irq, int irq_flags)
837 {
838         struct entropy_store    *r;
839         struct fast_pool        *fast_pool = &__get_cpu_var(irq_randomness);
840         struct pt_regs          *regs = get_irq_regs();
841         unsigned long           now = jiffies;
842         cycles_t                cycles = random_get_entropy();
843         __u32                   input[4], c_high, j_high;
844         __u64                   ip;
845         unsigned long           seed;
846         int                     credit = 0;
847
848         c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
849         j_high = (sizeof(now) > 4) ? now >> 32 : 0;
850         input[0] = cycles ^ j_high ^ irq;
851         input[1] = now ^ c_high;
852         ip = regs ? instruction_pointer(regs) : _RET_IP_;
853         input[2] = ip;
854         input[3] = ip >> 32;
855
856         fast_mix(fast_pool, input);
857
858         if ((fast_pool->count & 63) && !time_after(now, fast_pool->last + HZ))
859                 return;
860
861         r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
862         if (!spin_trylock(&r->lock)) {
863                 fast_pool->count--;
864                 return;
865         }
866         fast_pool->last = now;
867         __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool), NULL);
868
869         /*
870          * If we have architectural seed generator, produce a seed and
871          * add it to the pool.  For the sake of paranoia count it as
872          * 50% entropic.
873          */
874         if (arch_get_random_seed_long(&seed)) {
875                 __mix_pool_bytes(r, &seed, sizeof(seed), NULL);
876                 credit += sizeof(seed) * 4;
877         }
878         spin_unlock(&r->lock);
879
880         /*
881          * If we don't have a valid cycle counter, and we see
882          * back-to-back timer interrupts, then skip giving credit for
883          * any entropy, otherwise credit 1 bit.
884          */
885         credit++;
886         if (cycles == 0) {
887                 if (irq_flags & __IRQF_TIMER) {
888                         if (fast_pool->last_timer_intr)
889                                 credit--;
890                         fast_pool->last_timer_intr = 1;
891                 } else
892                         fast_pool->last_timer_intr = 0;
893         }
894
895         credit_entropy_bits(r, credit);
896 }
897
898 #ifdef CONFIG_BLOCK
899 void add_disk_randomness(struct gendisk *disk)
900 {
901         if (!disk || !disk->random)
902                 return;
903         /* first major is 1, so we get >= 0x200 here */
904         add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
905         trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
906 }
907 EXPORT_SYMBOL_GPL(add_disk_randomness);
908 #endif
909
910 /*********************************************************************
911  *
912  * Entropy extraction routines
913  *
914  *********************************************************************/
915
916 static ssize_t extract_entropy(struct entropy_store *r, void *buf,
917                                size_t nbytes, int min, int rsvd);
918
919 /*
920  * This utility inline function is responsible for transferring entropy
921  * from the primary pool to the secondary extraction pool. We make
922  * sure we pull enough for a 'catastrophic reseed'.
923  */
924 static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
925 static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
926 {
927         if (r->limit == 0 && random_min_urandom_seed) {
928                 unsigned long now = jiffies;
929
930                 if (time_before(now,
931                                 r->last_pulled + random_min_urandom_seed * HZ))
932                         return;
933                 r->last_pulled = now;
934         }
935         if (r->pull &&
936             r->entropy_count < (nbytes << (ENTROPY_SHIFT + 3)) &&
937             r->entropy_count < r->poolinfo->poolfracbits)
938                 _xfer_secondary_pool(r, nbytes);
939 }
940
941 static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
942 {
943         __u32   tmp[OUTPUT_POOL_WORDS];
944
945         /* For /dev/random's pool, always leave two wakeups' worth */
946         int rsvd_bytes = r->limit ? 0 : random_read_wakeup_bits / 4;
947         int bytes = nbytes;
948
949         /* pull at least as much as a wakeup */
950         bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
951         /* but never more than the buffer size */
952         bytes = min_t(int, bytes, sizeof(tmp));
953
954         trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
955                                   ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
956         bytes = extract_entropy(r->pull, tmp, bytes,
957                                 random_read_wakeup_bits / 8, rsvd_bytes);
958         mix_pool_bytes(r, tmp, bytes, NULL);
959         credit_entropy_bits(r, bytes*8);
960 }
961
962 /*
963  * Used as a workqueue function so that when the input pool is getting
964  * full, we can "spill over" some entropy to the output pools.  That
965  * way the output pools can store some of the excess entropy instead
966  * of letting it go to waste.
967  */
968 static void push_to_pool(struct work_struct *work)
969 {
970         struct entropy_store *r = container_of(work, struct entropy_store,
971                                               push_work);
972         BUG_ON(!r);
973         _xfer_secondary_pool(r, random_read_wakeup_bits/8);
974         trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
975                            r->pull->entropy_count >> ENTROPY_SHIFT);
976 }
977
978 /*
979  * This function decides how many bytes to actually take from the
980  * given pool, and also debits the entropy count accordingly.
981  */
982 static size_t account(struct entropy_store *r, size_t nbytes, int min,
983                       int reserved)
984 {
985         int entropy_count, orig;
986         size_t ibytes;
987
988         BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
989
990         /* Can we pull enough? */
991 retry:
992         entropy_count = orig = ACCESS_ONCE(r->entropy_count);
993         ibytes = nbytes;
994         /* If limited, never pull more than available */
995         if (r->limit) {
996                 int have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
997
998                 if ((have_bytes -= reserved) < 0)
999                         have_bytes = 0;
1000                 ibytes = min_t(size_t, ibytes, have_bytes);
1001         }
1002         if (ibytes < min)
1003                 ibytes = 0;
1004         if ((entropy_count -= ibytes << (ENTROPY_SHIFT + 3)) < 0)
1005                 entropy_count = 0;
1006
1007         if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1008                 goto retry;
1009
1010         trace_debit_entropy(r->name, 8 * ibytes);
1011         if (ibytes &&
1012             (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
1013                 wake_up_interruptible(&random_write_wait);
1014                 kill_fasync(&fasync, SIGIO, POLL_OUT);
1015         }
1016
1017         return ibytes;
1018 }
1019
1020 /*
1021  * This function does the actual extraction for extract_entropy and
1022  * extract_entropy_user.
1023  *
1024  * Note: we assume that .poolwords is a multiple of 16 words.
1025  */
1026 static void extract_buf(struct entropy_store *r, __u8 *out)
1027 {
1028         int i;
1029         union {
1030                 __u32 w[5];
1031                 unsigned long l[LONGS(20)];
1032         } hash;
1033         __u32 workspace[SHA_WORKSPACE_WORDS];
1034         __u8 extract[64];
1035         unsigned long flags;
1036
1037         /*
1038          * If we have an architectural hardware random number
1039          * generator, use it for SHA's initial vector
1040          */
1041         sha_init(hash.w);
1042         for (i = 0; i < LONGS(20); i++) {
1043                 unsigned long v;
1044                 if (!arch_get_random_long(&v))
1045                         break;
1046                 hash.l[i] = v;
1047         }
1048
1049         /* Generate a hash across the pool, 16 words (512 bits) at a time */
1050         spin_lock_irqsave(&r->lock, flags);
1051         for (i = 0; i < r->poolinfo->poolwords; i += 16)
1052                 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1053
1054         /*
1055          * We mix the hash back into the pool to prevent backtracking
1056          * attacks (where the attacker knows the state of the pool
1057          * plus the current outputs, and attempts to find previous
1058          * ouputs), unless the hash function can be inverted. By
1059          * mixing at least a SHA1 worth of hash data back, we make
1060          * brute-forcing the feedback as hard as brute-forcing the
1061          * hash.
1062          */
1063         __mix_pool_bytes(r, hash.w, sizeof(hash.w), extract);
1064         spin_unlock_irqrestore(&r->lock, flags);
1065
1066         /*
1067          * To avoid duplicates, we atomically extract a portion of the
1068          * pool while mixing, and hash one final time.
1069          */
1070         sha_transform(hash.w, extract, workspace);
1071         memset(extract, 0, sizeof(extract));
1072         memset(workspace, 0, sizeof(workspace));
1073
1074         /*
1075          * In case the hash function has some recognizable output
1076          * pattern, we fold it in half. Thus, we always feed back
1077          * twice as much data as we output.
1078          */
1079         hash.w[0] ^= hash.w[3];
1080         hash.w[1] ^= hash.w[4];
1081         hash.w[2] ^= rol32(hash.w[2], 16);
1082
1083         memcpy(out, &hash, EXTRACT_SIZE);
1084         memset(&hash, 0, sizeof(hash));
1085 }
1086
1087 /*
1088  * This function extracts randomness from the "entropy pool", and
1089  * returns it in a buffer.
1090  *
1091  * The min parameter specifies the minimum amount we can pull before
1092  * failing to avoid races that defeat catastrophic reseeding while the
1093  * reserved parameter indicates how much entropy we must leave in the
1094  * pool after each pull to avoid starving other readers.
1095  */
1096 static ssize_t extract_entropy(struct entropy_store *r, void *buf,
1097                                  size_t nbytes, int min, int reserved)
1098 {
1099         ssize_t ret = 0, i;
1100         __u8 tmp[EXTRACT_SIZE];
1101         unsigned long flags;
1102
1103         /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
1104         if (fips_enabled) {
1105                 spin_lock_irqsave(&r->lock, flags);
1106                 if (!r->last_data_init) {
1107                         r->last_data_init = 1;
1108                         spin_unlock_irqrestore(&r->lock, flags);
1109                         trace_extract_entropy(r->name, EXTRACT_SIZE,
1110                                               ENTROPY_BITS(r), _RET_IP_);
1111                         xfer_secondary_pool(r, EXTRACT_SIZE);
1112                         extract_buf(r, tmp);
1113                         spin_lock_irqsave(&r->lock, flags);
1114                         memcpy(r->last_data, tmp, EXTRACT_SIZE);
1115                 }
1116                 spin_unlock_irqrestore(&r->lock, flags);
1117         }
1118
1119         trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
1120         xfer_secondary_pool(r, nbytes);
1121         nbytes = account(r, nbytes, min, reserved);
1122
1123         while (nbytes) {
1124                 extract_buf(r, tmp);
1125
1126                 if (fips_enabled) {
1127                         spin_lock_irqsave(&r->lock, flags);
1128                         if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1129                                 panic("Hardware RNG duplicated output!\n");
1130                         memcpy(r->last_data, tmp, EXTRACT_SIZE);
1131                         spin_unlock_irqrestore(&r->lock, flags);
1132                 }
1133                 i = min_t(int, nbytes, EXTRACT_SIZE);
1134                 memcpy(buf, tmp, i);
1135                 nbytes -= i;
1136                 buf += i;
1137                 ret += i;
1138         }
1139
1140         /* Wipe data just returned from memory */
1141         memset(tmp, 0, sizeof(tmp));
1142
1143         return ret;
1144 }
1145
1146 /*
1147  * This function extracts randomness from the "entropy pool", and
1148  * returns it in a userspace buffer.
1149  */
1150 static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1151                                     size_t nbytes)
1152 {
1153         ssize_t ret = 0, i;
1154         __u8 tmp[EXTRACT_SIZE];
1155
1156         trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
1157         xfer_secondary_pool(r, nbytes);
1158         nbytes = account(r, nbytes, 0, 0);
1159
1160         while (nbytes) {
1161                 if (need_resched()) {
1162                         if (signal_pending(current)) {
1163                                 if (ret == 0)
1164                                         ret = -ERESTARTSYS;
1165                                 break;
1166                         }
1167                         schedule();
1168                 }
1169
1170                 extract_buf(r, tmp);
1171                 i = min_t(int, nbytes, EXTRACT_SIZE);
1172                 if (copy_to_user(buf, tmp, i)) {
1173                         ret = -EFAULT;
1174                         break;
1175                 }
1176
1177                 nbytes -= i;
1178                 buf += i;
1179                 ret += i;
1180         }
1181
1182         /* Wipe data just returned from memory */
1183         memset(tmp, 0, sizeof(tmp));
1184
1185         return ret;
1186 }
1187
1188 /*
1189  * This function is the exported kernel interface.  It returns some
1190  * number of good random numbers, suitable for key generation, seeding
1191  * TCP sequence numbers, etc.  It does not rely on the hardware random
1192  * number generator.  For random bytes direct from the hardware RNG
1193  * (when available), use get_random_bytes_arch().
1194  */
1195 void get_random_bytes(void *buf, int nbytes)
1196 {
1197 #if DEBUG_RANDOM_BOOT > 0
1198         if (unlikely(nonblocking_pool.initialized == 0))
1199                 printk(KERN_NOTICE "random: %pF get_random_bytes called "
1200                        "with %d bits of entropy available\n",
1201                        (void *) _RET_IP_,
1202                        nonblocking_pool.entropy_total);
1203 #endif
1204         trace_get_random_bytes(nbytes, _RET_IP_);
1205         extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
1206 }
1207 EXPORT_SYMBOL(get_random_bytes);
1208
1209 /*
1210  * This function will use the architecture-specific hardware random
1211  * number generator if it is available.  The arch-specific hw RNG will
1212  * almost certainly be faster than what we can do in software, but it
1213  * is impossible to verify that it is implemented securely (as
1214  * opposed, to, say, the AES encryption of a sequence number using a
1215  * key known by the NSA).  So it's useful if we need the speed, but
1216  * only if we're willing to trust the hardware manufacturer not to
1217  * have put in a back door.
1218  */
1219 void get_random_bytes_arch(void *buf, int nbytes)
1220 {
1221         char *p = buf;
1222
1223         trace_get_random_bytes_arch(nbytes, _RET_IP_);
1224         while (nbytes) {
1225                 unsigned long v;
1226                 int chunk = min(nbytes, (int)sizeof(unsigned long));
1227
1228                 if (!arch_get_random_long(&v))
1229                         break;
1230                 
1231                 memcpy(p, &v, chunk);
1232                 p += chunk;
1233                 nbytes -= chunk;
1234         }
1235
1236         if (nbytes)
1237                 extract_entropy(&nonblocking_pool, p, nbytes, 0, 0);
1238 }
1239 EXPORT_SYMBOL(get_random_bytes_arch);
1240
1241
1242 /*
1243  * init_std_data - initialize pool with system data
1244  *
1245  * @r: pool to initialize
1246  *
1247  * This function clears the pool's entropy count and mixes some system
1248  * data into the pool to prepare it for use. The pool is not cleared
1249  * as that can only decrease the entropy in the pool.
1250  */
1251 static void init_std_data(struct entropy_store *r)
1252 {
1253         int i;
1254         ktime_t now = ktime_get_real();
1255         unsigned long rv;
1256
1257         r->last_pulled = jiffies;
1258         mix_pool_bytes(r, &now, sizeof(now), NULL);
1259         for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
1260                 if (!arch_get_random_seed_long(&rv) &&
1261                     !arch_get_random_long(&rv))
1262                         rv = random_get_entropy();
1263                 mix_pool_bytes(r, &rv, sizeof(rv), NULL);
1264         }
1265         mix_pool_bytes(r, utsname(), sizeof(*(utsname())), NULL);
1266 }
1267
1268 /*
1269  * Note that setup_arch() may call add_device_randomness()
1270  * long before we get here. This allows seeding of the pools
1271  * with some platform dependent data very early in the boot
1272  * process. But it limits our options here. We must use
1273  * statically allocated structures that already have all
1274  * initializations complete at compile time. We should also
1275  * take care not to overwrite the precious per platform data
1276  * we were given.
1277  */
1278 static int rand_initialize(void)
1279 {
1280         init_std_data(&input_pool);
1281         init_std_data(&blocking_pool);
1282         init_std_data(&nonblocking_pool);
1283         return 0;
1284 }
1285 early_initcall(rand_initialize);
1286
1287 #ifdef CONFIG_BLOCK
1288 void rand_initialize_disk(struct gendisk *disk)
1289 {
1290         struct timer_rand_state *state;
1291
1292         /*
1293          * If kzalloc returns null, we just won't use that entropy
1294          * source.
1295          */
1296         state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1297         if (state) {
1298                 state->last_time = INITIAL_JIFFIES;
1299                 disk->random = state;
1300         }
1301 }
1302 #endif
1303
1304 /*
1305  * Attempt an emergency refill using arch_get_random_seed_long().
1306  *
1307  * As with add_interrupt_randomness() be paranoid and only
1308  * credit the output as 50% entropic.
1309  */
1310 static int arch_random_refill(void)
1311 {
1312         const unsigned int nlongs = 64; /* Arbitrary number */
1313         unsigned int n = 0;
1314         unsigned int i;
1315         unsigned long buf[nlongs];
1316
1317         if (!arch_has_random_seed())
1318                 return 0;
1319
1320         for (i = 0; i < nlongs; i++) {
1321                 if (arch_get_random_seed_long(&buf[n]))
1322                         n++;
1323         }
1324
1325         if (n) {
1326                 unsigned int rand_bytes = n * sizeof(unsigned long);
1327
1328                 mix_pool_bytes(&input_pool, buf, rand_bytes, NULL);
1329                 credit_entropy_bits(&input_pool, rand_bytes*4);
1330         }
1331
1332         return n;
1333 }
1334
1335 static ssize_t
1336 random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1337 {
1338         ssize_t n;
1339
1340         if (nbytes == 0)
1341                 return 0;
1342
1343         nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1344         while (1) {
1345                 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1346                 if (n < 0)
1347                         return n;
1348                 trace_random_read(n*8, (nbytes-n)*8,
1349                                   ENTROPY_BITS(&blocking_pool),
1350                                   ENTROPY_BITS(&input_pool));
1351                 if (n > 0)
1352                         return n;
1353
1354                 /* Pool is (near) empty.  Maybe wait and retry. */
1355
1356                 /* First try an emergency refill */
1357                 if (arch_random_refill())
1358                         continue;
1359
1360                 if (file->f_flags & O_NONBLOCK)
1361                         return -EAGAIN;
1362
1363                 wait_event_interruptible(random_read_wait,
1364                         ENTROPY_BITS(&input_pool) >=
1365                         random_read_wakeup_bits);
1366                 if (signal_pending(current))
1367                         return -ERESTARTSYS;
1368         }
1369 }
1370
1371 static ssize_t
1372 urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1373 {
1374         int ret;
1375
1376         if (unlikely(nonblocking_pool.initialized == 0))
1377                 printk_once(KERN_NOTICE "random: %s urandom read "
1378                             "with %d bits of entropy available\n",
1379                             current->comm, nonblocking_pool.entropy_total);
1380
1381         ret = extract_entropy_user(&nonblocking_pool, buf, nbytes);
1382
1383         trace_urandom_read(8 * nbytes, ENTROPY_BITS(&nonblocking_pool),
1384                            ENTROPY_BITS(&input_pool));
1385         return ret;
1386 }
1387
1388 static unsigned int
1389 random_poll(struct file *file, poll_table * wait)
1390 {
1391         unsigned int mask;
1392
1393         poll_wait(file, &random_read_wait, wait);
1394         poll_wait(file, &random_write_wait, wait);
1395         mask = 0;
1396         if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
1397                 mask |= POLLIN | POLLRDNORM;
1398         if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
1399                 mask |= POLLOUT | POLLWRNORM;
1400         return mask;
1401 }
1402
1403 static int
1404 write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1405 {
1406         size_t bytes;
1407         __u32 buf[16];
1408         const char __user *p = buffer;
1409
1410         while (count > 0) {
1411                 bytes = min(count, sizeof(buf));
1412                 if (copy_from_user(&buf, p, bytes))
1413                         return -EFAULT;
1414
1415                 count -= bytes;
1416                 p += bytes;
1417
1418                 mix_pool_bytes(r, buf, bytes, NULL);
1419                 cond_resched();
1420         }
1421
1422         return 0;
1423 }
1424
1425 static ssize_t random_write(struct file *file, const char __user *buffer,
1426                             size_t count, loff_t *ppos)
1427 {
1428         size_t ret;
1429
1430         ret = write_pool(&blocking_pool, buffer, count);
1431         if (ret)
1432                 return ret;
1433         ret = write_pool(&nonblocking_pool, buffer, count);
1434         if (ret)
1435                 return ret;
1436
1437         return (ssize_t)count;
1438 }
1439
1440 static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
1441 {
1442         int size, ent_count;
1443         int __user *p = (int __user *)arg;
1444         int retval;
1445
1446         switch (cmd) {
1447         case RNDGETENTCNT:
1448                 /* inherently racy, no point locking */
1449                 ent_count = ENTROPY_BITS(&input_pool);
1450                 if (put_user(ent_count, p))
1451                         return -EFAULT;
1452                 return 0;
1453         case RNDADDTOENTCNT:
1454                 if (!capable(CAP_SYS_ADMIN))
1455                         return -EPERM;
1456                 if (get_user(ent_count, p))
1457                         return -EFAULT;
1458                 credit_entropy_bits_safe(&input_pool, ent_count);
1459                 return 0;
1460         case RNDADDENTROPY:
1461                 if (!capable(CAP_SYS_ADMIN))
1462                         return -EPERM;
1463                 if (get_user(ent_count, p++))
1464                         return -EFAULT;
1465                 if (ent_count < 0)
1466                         return -EINVAL;
1467                 if (get_user(size, p++))
1468                         return -EFAULT;
1469                 retval = write_pool(&input_pool, (const char __user *)p,
1470                                     size);
1471                 if (retval < 0)
1472                         return retval;
1473                 credit_entropy_bits_safe(&input_pool, ent_count);
1474                 return 0;
1475         case RNDZAPENTCNT:
1476         case RNDCLEARPOOL:
1477                 /*
1478                  * Clear the entropy pool counters. We no longer clear
1479                  * the entropy pool, as that's silly.
1480                  */
1481                 if (!capable(CAP_SYS_ADMIN))
1482                         return -EPERM;
1483                 input_pool.entropy_count = 0;
1484                 nonblocking_pool.entropy_count = 0;
1485                 blocking_pool.entropy_count = 0;
1486                 return 0;
1487         default:
1488                 return -EINVAL;
1489         }
1490 }
1491
1492 static int random_fasync(int fd, struct file *filp, int on)
1493 {
1494         return fasync_helper(fd, filp, on, &fasync);
1495 }
1496
1497 const struct file_operations random_fops = {
1498         .read  = random_read,
1499         .write = random_write,
1500         .poll  = random_poll,
1501         .unlocked_ioctl = random_ioctl,
1502         .fasync = random_fasync,
1503         .llseek = noop_llseek,
1504 };
1505
1506 const struct file_operations urandom_fops = {
1507         .read  = urandom_read,
1508         .write = random_write,
1509         .unlocked_ioctl = random_ioctl,
1510         .fasync = random_fasync,
1511         .llseek = noop_llseek,
1512 };
1513
1514 /***************************************************************
1515  * Random UUID interface
1516  *
1517  * Used here for a Boot ID, but can be useful for other kernel
1518  * drivers.
1519  ***************************************************************/
1520
1521 /*
1522  * Generate random UUID
1523  */
1524 void generate_random_uuid(unsigned char uuid_out[16])
1525 {
1526         get_random_bytes(uuid_out, 16);
1527         /* Set UUID version to 4 --- truly random generation */
1528         uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1529         /* Set the UUID variant to DCE */
1530         uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1531 }
1532 EXPORT_SYMBOL(generate_random_uuid);
1533
1534 /********************************************************************
1535  *
1536  * Sysctl interface
1537  *
1538  ********************************************************************/
1539
1540 #ifdef CONFIG_SYSCTL
1541
1542 #include <linux/sysctl.h>
1543
1544 static int min_read_thresh = 8, min_write_thresh;
1545 static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
1546 static int max_write_thresh = INPUT_POOL_WORDS * 32;
1547 static char sysctl_bootid[16];
1548
1549 /*
1550  * This function is used to return both the bootid UUID, and random
1551  * UUID.  The difference is in whether table->data is NULL; if it is,
1552  * then a new UUID is generated and returned to the user.
1553  *
1554  * If the user accesses this via the proc interface, the UUID will be
1555  * returned as an ASCII string in the standard UUID format; if via the
1556  * sysctl system call, as 16 bytes of binary data.
1557  */
1558 static int proc_do_uuid(struct ctl_table *table, int write,
1559                         void __user *buffer, size_t *lenp, loff_t *ppos)
1560 {
1561         struct ctl_table fake_table;
1562         unsigned char buf[64], tmp_uuid[16], *uuid;
1563
1564         uuid = table->data;
1565         if (!uuid) {
1566                 uuid = tmp_uuid;
1567                 generate_random_uuid(uuid);
1568         } else {
1569                 static DEFINE_SPINLOCK(bootid_spinlock);
1570
1571                 spin_lock(&bootid_spinlock);
1572                 if (!uuid[8])
1573                         generate_random_uuid(uuid);
1574                 spin_unlock(&bootid_spinlock);
1575         }
1576
1577         sprintf(buf, "%pU", uuid);
1578
1579         fake_table.data = buf;
1580         fake_table.maxlen = sizeof(buf);
1581
1582         return proc_dostring(&fake_table, write, buffer, lenp, ppos);
1583 }
1584
1585 /*
1586  * Return entropy available scaled to integral bits
1587  */
1588 static int proc_do_entropy(struct ctl_table *table, int write,
1589                            void __user *buffer, size_t *lenp, loff_t *ppos)
1590 {
1591         struct ctl_table fake_table;
1592         int entropy_count;
1593
1594         entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
1595
1596         fake_table.data = &entropy_count;
1597         fake_table.maxlen = sizeof(entropy_count);
1598
1599         return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1600 }
1601
1602 static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
1603 extern struct ctl_table random_table[];
1604 struct ctl_table random_table[] = {
1605         {
1606                 .procname       = "poolsize",
1607                 .data           = &sysctl_poolsize,
1608                 .maxlen         = sizeof(int),
1609                 .mode           = 0444,
1610                 .proc_handler   = proc_dointvec,
1611         },
1612         {
1613                 .procname       = "entropy_avail",
1614                 .maxlen         = sizeof(int),
1615                 .mode           = 0444,
1616                 .proc_handler   = proc_do_entropy,
1617                 .data           = &input_pool.entropy_count,
1618         },
1619         {
1620                 .procname       = "read_wakeup_threshold",
1621                 .data           = &random_read_wakeup_bits,
1622                 .maxlen         = sizeof(int),
1623                 .mode           = 0644,
1624                 .proc_handler   = proc_dointvec_minmax,
1625                 .extra1         = &min_read_thresh,
1626                 .extra2         = &max_read_thresh,
1627         },
1628         {
1629                 .procname       = "write_wakeup_threshold",
1630                 .data           = &random_write_wakeup_bits,
1631                 .maxlen         = sizeof(int),
1632                 .mode           = 0644,
1633                 .proc_handler   = proc_dointvec_minmax,
1634                 .extra1         = &min_write_thresh,
1635                 .extra2         = &max_write_thresh,
1636         },
1637         {
1638                 .procname       = "urandom_min_reseed_secs",
1639                 .data           = &random_min_urandom_seed,
1640                 .maxlen         = sizeof(int),
1641                 .mode           = 0644,
1642                 .proc_handler   = proc_dointvec,
1643         },
1644         {
1645                 .procname       = "boot_id",
1646                 .data           = &sysctl_bootid,
1647                 .maxlen         = 16,
1648                 .mode           = 0444,
1649                 .proc_handler   = proc_do_uuid,
1650         },
1651         {
1652                 .procname       = "uuid",
1653                 .maxlen         = 16,
1654                 .mode           = 0444,
1655                 .proc_handler   = proc_do_uuid,
1656         },
1657         { }
1658 };
1659 #endif  /* CONFIG_SYSCTL */
1660
1661 static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
1662
1663 int random_int_secret_init(void)
1664 {
1665         get_random_bytes(random_int_secret, sizeof(random_int_secret));
1666         return 0;
1667 }
1668
1669 /*
1670  * Get a random word for internal kernel use only. Similar to urandom but
1671  * with the goal of minimal entropy pool depletion. As a result, the random
1672  * value is not cryptographically secure but for several uses the cost of
1673  * depleting entropy is too high
1674  */
1675 static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash);
1676 unsigned int get_random_int(void)
1677 {
1678         __u32 *hash;
1679         unsigned int ret;
1680
1681         if (arch_get_random_int(&ret))
1682                 return ret;
1683
1684         hash = get_cpu_var(get_random_int_hash);
1685
1686         hash[0] += current->pid + jiffies + random_get_entropy();
1687         md5_transform(hash, random_int_secret);
1688         ret = hash[0];
1689         put_cpu_var(get_random_int_hash);
1690
1691         return ret;
1692 }
1693 EXPORT_SYMBOL(get_random_int);
1694
1695 /*
1696  * randomize_range() returns a start address such that
1697  *
1698  *    [...... <range> .....]
1699  *  start                  end
1700  *
1701  * a <range> with size "len" starting at the return value is inside in the
1702  * area defined by [start, end], but is otherwise randomized.
1703  */
1704 unsigned long
1705 randomize_range(unsigned long start, unsigned long end, unsigned long len)
1706 {
1707         unsigned long range = end - len - start;
1708
1709         if (end <= start + len)
1710                 return 0;
1711         return PAGE_ALIGN(get_random_int() % range + start);
1712 }