blob: 6da3f250804c9339b2b399ffd9db3d88252ffbab [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 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400128 * void add_device_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 * void add_input_randomness(unsigned int type, unsigned int code,
130 * unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400131 * void add_interrupt_randomness(int irq, int irq_flags);
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100132 * void add_disk_randomness(struct gendisk *disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400134 * 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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 * add_input_randomness() uses the input layer interrupt timing, as well as
143 * the event type information from the hardware.
144 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400145 * 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.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100148 *
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 *
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239#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>
Andrea Righi27ac7922008-07-23 21:28:13 -0700251#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252#include <linux/spinlock.h>
253#include <linux/percpu.h>
254#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800255#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400256#include <linux/ptrace.h>
Theodore Ts'oe6d49472012-07-05 10:21:01 -0400257#include <linux/kmemcheck.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Yinghai Lud178a1e2009-01-11 00:35:42 -0800259#ifdef CONFIG_GENERIC_HARDIRQS
260# include <linux/irq.h>
261#endif
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263#include <asm/processor.h>
264#include <asm/uaccess.h>
265#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400266#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267#include <asm/io.h>
268
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400269#define CREATE_TRACE_POINTS
270#include <trace/events/random.h>
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272/*
273 * Configuration information
274 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400275#define INPUT_POOL_SHIFT 12
276#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
277#define OUTPUT_POOL_SHIFT 10
278#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
279#define SEC_XFER_SIZE 512
280#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400282#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400285 * To allow fractional bits to be tracked, the entropy_count field is
286 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400287 *
288 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
289 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400290 */
291#define ENTROPY_SHIFT 3
292#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
293
294/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 * 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 */
298static int random_read_wakeup_thresh = 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 */
305static int random_write_wakeup_thresh = 128;
306
307/*
Theodore Ts'of5c27422013-09-22 15:14:32 -0400308 * The minimum number of seconds between urandom pool resending. 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 */
312static int random_min_urandom_seed = 60;
313
314/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400315 * 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 Mdeling 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 */
359static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400360 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
361#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 int tap1, tap2, tap3, tap4, tap5;
363} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400364 /* 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 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370#if 0
371 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400372 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
374 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400375 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400378 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400381 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400384 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400386 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400389 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400392 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400395 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396#endif
397};
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 * Static global variables
401 */
402static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
403static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700404static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030406static bool debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407module_param(debug, bool, 0644);
Matt Mackall90b75ee2008-04-29 01:02:55 -0700408#define DEBUG_ENT(fmt, arg...) do { \
409 if (debug) \
410 printk(KERN_DEBUG "random %04d %04d %04d: " \
411 fmt,\
412 input_pool.entropy_count,\
413 blocking_pool.entropy_count,\
414 nonblocking_pool.entropy_count,\
415 ## arg); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
417/**********************************************************************
418 *
419 * OS independent entropy store. Here are the functions which handle
420 * storing entropy in an entropy pool.
421 *
422 **********************************************************************/
423
424struct entropy_store;
425struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700426 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400427 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 __u32 *pool;
429 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 struct entropy_store *pull;
431
432 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400433 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700434 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400435 unsigned short add_ptr;
436 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800437 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400438 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400439 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400440 unsigned int limit:1;
441 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000442 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443};
444
445static __u32 input_pool_data[INPUT_POOL_WORDS];
446static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
447static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
448
449static struct entropy_store input_pool = {
450 .poolinfo = &poolinfo_table[0],
451 .name = "input",
452 .limit = 1,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200453 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 .pool = input_pool_data
455};
456
457static struct entropy_store blocking_pool = {
458 .poolinfo = &poolinfo_table[1],
459 .name = "blocking",
460 .limit = 1,
461 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200462 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 .pool = blocking_pool_data
464};
465
466static struct entropy_store nonblocking_pool = {
467 .poolinfo = &poolinfo_table[1],
468 .name = "nonblocking",
469 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200470 .lock = __SPIN_LOCK_UNLOCKED(nonblocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 .pool = nonblocking_pool_data
472};
473
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400474static __u32 const twist_table[8] = {
475 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
476 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
477
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700479 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700481 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 *
483 * The pool is stirred with a primitive polynomial of the appropriate
484 * degree, and then twisted. We twist by three bits at a time because
485 * it's cheap to do so and helps slightly in the expected case where
486 * the entropy is concentrated in the low-order bits.
487 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400488static void _mix_pool_bytes(struct entropy_store *r, const void *in,
489 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
Matt Mackall993ba212008-04-29 01:03:04 -0700491 unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700492 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700494 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700495 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 tap1 = r->poolinfo->tap1;
498 tap2 = r->poolinfo->tap2;
499 tap3 = r->poolinfo->tap3;
500 tap4 = r->poolinfo->tap4;
501 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Theodore Ts'o902c0982012-07-04 10:38:30 -0400503 smp_rmb();
504 input_rotate = ACCESS_ONCE(r->input_rotate);
505 i = ACCESS_ONCE(r->add_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Matt Mackalle68e5b62008-04-29 01:03:05 -0700507 /* mix one byte at a time to simplify size handling and churn faster */
508 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400509 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700510 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
512 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700513 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 w ^= r->pool[(i + tap1) & wordmask];
515 w ^= r->pool[(i + tap2) & wordmask];
516 w ^= r->pool[(i + tap3) & wordmask];
517 w ^= r->pool[(i + tap4) & wordmask];
518 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700519
520 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700522
523 /*
524 * Normally, we add 7 bits of rotation to the pool.
525 * At the beginning of the pool, add an extra 7 bits
526 * rotation, so that successive passes spread the
527 * input bits across the pool evenly.
528 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400529 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 }
531
Theodore Ts'o902c0982012-07-04 10:38:30 -0400532 ACCESS_ONCE(r->input_rotate) = input_rotate;
533 ACCESS_ONCE(r->add_ptr) = i;
534 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Matt Mackall993ba212008-04-29 01:03:04 -0700536 if (out)
537 for (j = 0; j < 16; j++)
Matt Mackalle68e5b62008-04-29 01:03:05 -0700538 ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539}
540
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400541static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o902c0982012-07-04 10:38:30 -0400542 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400544 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
545 _mix_pool_bytes(r, in, nbytes, out);
546}
547
548static void mix_pool_bytes(struct entropy_store *r, const void *in,
549 int nbytes, __u8 out[64])
550{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400551 unsigned long flags;
552
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400553 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400554 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400555 _mix_pool_bytes(r, in, nbytes, out);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400556 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557}
558
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400559struct fast_pool {
560 __u32 pool[4];
561 unsigned long last;
562 unsigned short count;
563 unsigned char rotate;
564 unsigned char last_timer_intr;
565};
566
567/*
568 * This is a fast mixing routine used by the interrupt randomness
569 * collector. It's hardcoded for an 128 bit pool and assumes that any
570 * locks that might be needed are taken by the caller.
571 */
Theodore Ts'o655b2262013-09-22 15:24:02 -0400572static void fast_mix(struct fast_pool *f, __u32 input[4])
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400573{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400574 __u32 w;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400575 unsigned input_rotate = f->rotate;
576
Theodore Ts'o655b2262013-09-22 15:24:02 -0400577 w = rol32(input[0], input_rotate) ^ f->pool[0] ^ f->pool[3];
578 f->pool[0] = (w >> 3) ^ twist_table[w & 7];
579 input_rotate = (input_rotate + 14) & 31;
580 w = rol32(input[1], input_rotate) ^ f->pool[1] ^ f->pool[0];
581 f->pool[1] = (w >> 3) ^ twist_table[w & 7];
582 input_rotate = (input_rotate + 7) & 31;
583 w = rol32(input[2], input_rotate) ^ f->pool[2] ^ f->pool[1];
584 f->pool[2] = (w >> 3) ^ twist_table[w & 7];
585 input_rotate = (input_rotate + 7) & 31;
586 w = rol32(input[3], input_rotate) ^ f->pool[3] ^ f->pool[2];
587 f->pool[3] = (w >> 3) ^ twist_table[w & 7];
588 input_rotate = (input_rotate + 7) & 31;
589
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400590 f->rotate = input_rotate;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400591 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400592}
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400595 * Credit (or debit) the entropy store with n bits of entropy.
596 * Use credit_entropy_bits_safe() if the value comes from userspace
597 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700599static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400601 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400602 const int pool_size = r->poolinfo->poolfracbits;
603 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
Matt Mackalladc782d2008-04-29 01:03:07 -0700605 if (!nbits)
606 return;
607
Matt Mackalladc782d2008-04-29 01:03:07 -0700608 DEBUG_ENT("added %d entropy credits to %s\n", nbits, r->name);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400609retry:
610 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400611 if (nfrac < 0) {
612 /* Debit */
613 entropy_count += nfrac;
614 } else {
615 /*
616 * Credit: we have to account for the possibility of
617 * overwriting already present entropy. Even in the
618 * ideal case of pure Shannon entropy, new contributions
619 * approach the full value asymptotically:
620 *
621 * entropy <- entropy + (pool_size - entropy) *
622 * (1 - exp(-add_entropy/pool_size))
623 *
624 * For add_entropy <= pool_size/2 then
625 * (1 - exp(-add_entropy/pool_size)) >=
626 * (add_entropy/pool_size)*0.7869...
627 * so we can approximate the exponential with
628 * 3/4*add_entropy/pool_size and still be on the
629 * safe side by adding at most pool_size/2 at a time.
630 *
631 * The use of pool_size-2 in the while statement is to
632 * prevent rounding artifacts from making the loop
633 * arbitrarily long; this limits the loop to log2(pool_size)*2
634 * turns no matter how large nbits is.
635 */
636 int pnfrac = nfrac;
637 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
638 /* The +2 corresponds to the /4 in the denominator */
639
640 do {
641 unsigned int anfrac = min(pnfrac, pool_size/2);
642 unsigned int add =
643 ((pool_size - entropy_count)*anfrac*3) >> s;
644
645 entropy_count += add;
646 pnfrac -= anfrac;
647 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
648 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400649
Andrew Morton8b76f462008-09-02 14:36:14 -0700650 if (entropy_count < 0) {
Matt Mackalladc782d2008-04-29 01:03:07 -0700651 DEBUG_ENT("negative entropy/overflow\n");
Andrew Morton8b76f462008-09-02 14:36:14 -0700652 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400653 } else if (entropy_count > pool_size)
654 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400655 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
656 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400658 if (!r->initialized && nbits > 0) {
659 r->entropy_total += nbits;
660 if (r->entropy_total > 128)
661 r->initialized = 1;
662 }
663
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400664 trace_credit_entropy_bits(r->name, nbits,
665 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400666 r->entropy_total, _RET_IP_);
667
Matt Mackall88c730d2008-04-29 01:02:56 -0700668 /* should we wake readers? */
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400669 if (r == &input_pool &&
670 (entropy_count >> ENTROPY_SHIFT) >= random_read_wakeup_thresh) {
Matt Mackall88c730d2008-04-29 01:02:56 -0700671 wake_up_interruptible(&random_read_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700672 kill_fasync(&fasync, SIGIO, POLL_IN);
673 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674}
675
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400676static void credit_entropy_bits_safe(struct entropy_store *r, int nbits)
677{
678 const int nbits_max = (int)(~0U >> (ENTROPY_SHIFT + 1));
679
680 /* Cap the value to avoid overflows */
681 nbits = min(nbits, nbits_max);
682 nbits = max(nbits, -nbits_max);
683
684 credit_entropy_bits(r, nbits);
685}
686
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687/*********************************************************************
688 *
689 * Entropy input management
690 *
691 *********************************************************************/
692
693/* There is one of these per entropy source */
694struct timer_rand_state {
695 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -0700696 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 unsigned dont_count_entropy:1;
698};
699
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400700/*
701 * Add device- or boot-specific data to the input and nonblocking
702 * pools to help initialize them to unique values.
703 *
704 * None of this adds any entropy, it is meant to avoid the
705 * problem of the nonblocking pool having similar initial state
706 * across largely identical devices.
707 */
708void add_device_randomness(const void *buf, unsigned int size)
709{
Theodore Ts'o61875f32013-09-21 13:58:22 -0400710 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400711 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400712
Theodore Ts'o59108952013-09-12 14:10:25 -0400713 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400714 spin_lock_irqsave(&input_pool.lock, flags);
715 _mix_pool_bytes(&input_pool, buf, size, NULL);
716 _mix_pool_bytes(&input_pool, &time, sizeof(time), NULL);
717 spin_unlock_irqrestore(&input_pool.lock, flags);
718
719 spin_lock_irqsave(&nonblocking_pool.lock, flags);
720 _mix_pool_bytes(&nonblocking_pool, buf, size, NULL);
721 _mix_pool_bytes(&nonblocking_pool, &time, sizeof(time), NULL);
722 spin_unlock_irqrestore(&nonblocking_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400723}
724EXPORT_SYMBOL(add_device_randomness);
725
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700726static struct timer_rand_state input_timer_state;
727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728/*
729 * This function adds entropy to the entropy "pool" by using timing
730 * delays. It uses the timer_rand_state structure to make an estimate
731 * of how many bits of entropy this call has added to the pool.
732 *
733 * The number "num" is also added to the pool - it should somehow describe
734 * the type of event which just happened. This is currently 0-255 for
735 * keyboard scan codes, and 256 upwards for interrupts.
736 *
737 */
738static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
739{
740 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -0800742 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 unsigned num;
744 } sample;
745 long delta, delta2, delta3;
746
747 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -0400750 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 sample.num = num;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400752 mix_pool_bytes(&input_pool, &sample, sizeof(sample), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
754 /*
755 * Calculate number of bits of randomness we probably added.
756 * We take into account the first, second and third-order deltas
757 * in order to make our estimate.
758 */
759
760 if (!state->dont_count_entropy) {
761 delta = sample.jiffies - state->last_time;
762 state->last_time = sample.jiffies;
763
764 delta2 = delta - state->last_delta;
765 state->last_delta = delta;
766
767 delta3 = delta2 - state->last_delta2;
768 state->last_delta2 = delta2;
769
770 if (delta < 0)
771 delta = -delta;
772 if (delta2 < 0)
773 delta2 = -delta2;
774 if (delta3 < 0)
775 delta3 = -delta3;
776 if (delta > delta2)
777 delta = delta2;
778 if (delta > delta3)
779 delta = delta3;
780
781 /*
782 * delta is now minimum absolute delta.
783 * Round down by 1 bit on general principles,
784 * and limit entropy entimate to 12 bits.
785 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700786 credit_entropy_bits(&input_pool,
787 min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 preempt_enable();
790}
791
Stephen Hemmingerd2515752006-01-11 12:17:38 -0800792void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 unsigned int value)
794{
795 static unsigned char last_value;
796
797 /* ignore autorepeat and the like */
798 if (value == last_value)
799 return;
800
801 DEBUG_ENT("input event\n");
802 last_value = value;
803 add_timer_randomness(&input_timer_state,
804 (type << 4) ^ code ^ (code >> 4) ^ value);
805}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400806EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400808static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
809
810void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400812 struct entropy_store *r;
813 struct fast_pool *fast_pool = &__get_cpu_var(irq_randomness);
814 struct pt_regs *regs = get_irq_regs();
815 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400816 cycles_t cycles = random_get_entropy();
817 __u32 input[4], c_high, j_high;
818 __u64 ip;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700819
Theodore Ts'o655b2262013-09-22 15:24:02 -0400820 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
821 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
822 input[0] = cycles ^ j_high ^ irq;
823 input[1] = now ^ c_high;
824 ip = regs ? instruction_pointer(regs) : _RET_IP_;
825 input[2] = ip;
826 input[3] = ip >> 32;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700827
Theodore Ts'o655b2262013-09-22 15:24:02 -0400828 fast_mix(fast_pool, input);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400829
Theodore Ts'o655b2262013-09-22 15:24:02 -0400830 if ((fast_pool->count & 63) && !time_after(now, fast_pool->last + HZ))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 return;
832
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400833 fast_pool->last = now;
834
835 r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400836 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool), NULL);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400837 /*
838 * If we don't have a valid cycle counter, and we see
839 * back-to-back timer interrupts, then skip giving credit for
840 * any entropy.
841 */
842 if (cycles == 0) {
843 if (irq_flags & __IRQF_TIMER) {
844 if (fast_pool->last_timer_intr)
845 return;
846 fast_pool->last_timer_intr = 1;
847 } else
848 fast_pool->last_timer_intr = 0;
849 }
850 credit_entropy_bits(r, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851}
852
David Howells93614012006-09-30 20:45:40 +0200853#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854void add_disk_randomness(struct gendisk *disk)
855{
856 if (!disk || !disk->random)
857 return;
858 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +0200859 DEBUG_ENT("disk event %d:%d\n",
860 MAJOR(disk_devt(disk)), MINOR(disk_devt(disk)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
Tejun Heof331c022008-09-03 09:01:48 +0200862 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863}
David Howells93614012006-09-30 20:45:40 +0200864#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866/*********************************************************************
867 *
868 * Entropy extraction routines
869 *
870 *********************************************************************/
871
Matt Mackall90b75ee2008-04-29 01:02:55 -0700872static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 size_t nbytes, int min, int rsvd);
874
875/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300876 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 * from the primary pool to the secondary extraction pool. We make
878 * sure we pull enough for a 'catastrophic reseed'.
879 */
880static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
881{
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400882 __u32 tmp[OUTPUT_POOL_WORDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Theodore Ts'of5c27422013-09-22 15:14:32 -0400884 if (r->limit == 0 && random_min_urandom_seed) {
885 unsigned long now = jiffies;
886
887 if (time_before(now,
888 r->last_pulled + random_min_urandom_seed * HZ))
889 return;
890 r->last_pulled = now;
891 }
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400892 if (r->pull &&
893 r->entropy_count < (nbytes << (ENTROPY_SHIFT + 3)) &&
894 r->entropy_count < r->poolinfo->poolfracbits) {
Matt Mackall5a021e92007-07-19 11:30:14 -0700895 /* If we're limited, always leave two wakeup worth's BITS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
Matt Mackall5a021e92007-07-19 11:30:14 -0700897 int bytes = nbytes;
898
899 /* pull at least as many as BYTES as wakeup BITS */
900 bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
901 /* but never more than the buffer size */
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400902 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
904 DEBUG_ENT("going to reseed %s with %d bits "
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200905 "(%zu of %d requested)\n",
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400906 r->name, bytes * 8, nbytes * 8,
907 r->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400909 bytes = extract_entropy(r->pull, tmp, bytes,
Matt Mackall90b75ee2008-04-29 01:02:55 -0700910 random_read_wakeup_thresh / 8, rsvd);
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400911 mix_pool_bytes(r, tmp, bytes, NULL);
Matt Mackalladc782d2008-04-29 01:03:07 -0700912 credit_entropy_bits(r, bytes*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 }
914}
915
916/*
917 * These functions extracts randomness from the "entropy pool", and
918 * returns it in a buffer.
919 *
920 * The min parameter specifies the minimum amount we can pull before
921 * failing to avoid races that defeat catastrophic reseeding while the
922 * reserved parameter indicates how much entropy we must leave in the
923 * pool after each pull to avoid starving other readers.
924 *
925 * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
926 */
927
928static size_t account(struct entropy_store *r, size_t nbytes, int min,
929 int reserved)
930{
931 unsigned long flags;
Theodore Ts'ob9809552013-03-04 11:59:12 -0500932 int wakeup_write = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400933 int have_bytes;
934 int entropy_count, orig;
935 size_t ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 /* Hold lock while accounting */
938 spin_lock_irqsave(&r->lock, flags);
939
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400940 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200941 DEBUG_ENT("trying to extract %zu bits from %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 nbytes * 8, r->name);
943
944 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -0700945retry:
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400946 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
947 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
948 ibytes = nbytes;
949 if (have_bytes < min + reserved) {
950 ibytes = 0;
951 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 /* If limited, never pull more than available */
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400953 if (r->limit && ibytes + reserved >= have_bytes)
954 ibytes = have_bytes - reserved;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400956 if (have_bytes >= ibytes + reserved)
957 entropy_count -= ibytes << (ENTROPY_SHIFT + 3);
958 else
959 entropy_count = reserved << (ENTROPY_SHIFT + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400961 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
962 goto retry;
963
964 if ((r->entropy_count >> ENTROPY_SHIFT)
965 < random_write_wakeup_thresh)
Theodore Ts'ob9809552013-03-04 11:59:12 -0500966 wakeup_write = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 }
968
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200969 DEBUG_ENT("debiting %zu entropy credits from %s%s\n",
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400970 ibytes * 8, r->name, r->limit ? "" : " (unlimited)");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971
972 spin_unlock_irqrestore(&r->lock, flags);
973
Theodore Ts'ob9809552013-03-04 11:59:12 -0500974 if (wakeup_write) {
975 wake_up_interruptible(&random_write_wait);
976 kill_fasync(&fasync, SIGIO, POLL_OUT);
977 }
978
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400979 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980}
981
982static void extract_buf(struct entropy_store *r, __u8 *out)
983{
Matt Mackall602b6ae2007-05-29 21:54:27 -0500984 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400985 union {
986 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -0400987 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400988 } hash;
989 __u32 workspace[SHA_WORKSPACE_WORDS];
Matt Mackalle68e5b62008-04-29 01:03:05 -0700990 __u8 extract[64];
Theodore Ts'o902c0982012-07-04 10:38:30 -0400991 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700993 /* Generate a hash across the pool, 16 words (512 bits) at a time */
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400994 sha_init(hash.w);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400995 spin_lock_irqsave(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700996 for (i = 0; i < r->poolinfo->poolwords; i += 16)
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400997 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
999 /*
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001000 * If we have a architectural hardware random number
1001 * generator, mix that in, too.
1002 */
1003 for (i = 0; i < LONGS(20); i++) {
1004 unsigned long v;
1005 if (!arch_get_random_long(&v))
1006 break;
1007 hash.l[i] ^= v;
1008 }
1009
1010 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001011 * We mix the hash back into the pool to prevent backtracking
1012 * attacks (where the attacker knows the state of the pool
1013 * plus the current outputs, and attempts to find previous
1014 * ouputs), unless the hash function can be inverted. By
1015 * mixing at least a SHA1 worth of hash data back, we make
1016 * brute-forcing the feedback as hard as brute-forcing the
1017 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001019 __mix_pool_bytes(r, hash.w, sizeof(hash.w), extract);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001020 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001021
1022 /*
1023 * To avoid duplicates, we atomically extract a portion of the
1024 * pool while mixing, and hash one final time.
1025 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001026 sha_transform(hash.w, extract, workspace);
Matt Mackallffd8d3f2008-04-29 01:02:59 -07001027 memset(extract, 0, sizeof(extract));
1028 memset(workspace, 0, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
1030 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001031 * In case the hash function has some recognizable output
1032 * pattern, we fold it in half. Thus, we always feed back
1033 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001035 hash.w[0] ^= hash.w[3];
1036 hash.w[1] ^= hash.w[4];
1037 hash.w[2] ^= rol32(hash.w[2], 16);
1038
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001039 memcpy(out, &hash, EXTRACT_SIZE);
1040 memset(&hash, 0, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041}
1042
Matt Mackall90b75ee2008-04-29 01:02:55 -07001043static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001044 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045{
1046 ssize_t ret = 0, i;
1047 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001048 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001050 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001051 if (fips_enabled) {
1052 spin_lock_irqsave(&r->lock, flags);
1053 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001054 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001055 spin_unlock_irqrestore(&r->lock, flags);
1056 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001057 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001058 xfer_secondary_pool(r, EXTRACT_SIZE);
1059 extract_buf(r, tmp);
1060 spin_lock_irqsave(&r->lock, flags);
1061 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1062 }
1063 spin_unlock_irqrestore(&r->lock, flags);
1064 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001065
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001066 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 xfer_secondary_pool(r, nbytes);
1068 nbytes = account(r, nbytes, min, reserved);
1069
1070 while (nbytes) {
1071 extract_buf(r, tmp);
Neil Horman5b739ef2009-06-18 19:50:21 +08001072
Matt Mackalle954bc92010-05-20 19:55:01 +10001073 if (fips_enabled) {
Neil Horman5b739ef2009-06-18 19:50:21 +08001074 spin_lock_irqsave(&r->lock, flags);
1075 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1076 panic("Hardware RNG duplicated output!\n");
1077 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1078 spin_unlock_irqrestore(&r->lock, flags);
1079 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 i = min_t(int, nbytes, EXTRACT_SIZE);
1081 memcpy(buf, tmp, i);
1082 nbytes -= i;
1083 buf += i;
1084 ret += i;
1085 }
1086
1087 /* Wipe data just returned from memory */
1088 memset(tmp, 0, sizeof(tmp));
1089
1090 return ret;
1091}
1092
1093static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1094 size_t nbytes)
1095{
1096 ssize_t ret = 0, i;
1097 __u8 tmp[EXTRACT_SIZE];
1098
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001099 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 xfer_secondary_pool(r, nbytes);
1101 nbytes = account(r, nbytes, 0, 0);
1102
1103 while (nbytes) {
1104 if (need_resched()) {
1105 if (signal_pending(current)) {
1106 if (ret == 0)
1107 ret = -ERESTARTSYS;
1108 break;
1109 }
1110 schedule();
1111 }
1112
1113 extract_buf(r, tmp);
1114 i = min_t(int, nbytes, EXTRACT_SIZE);
1115 if (copy_to_user(buf, tmp, i)) {
1116 ret = -EFAULT;
1117 break;
1118 }
1119
1120 nbytes -= i;
1121 buf += i;
1122 ret += i;
1123 }
1124
1125 /* Wipe data just returned from memory */
1126 memset(tmp, 0, sizeof(tmp));
1127
1128 return ret;
1129}
1130
1131/*
1132 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001133 * number of good random numbers, suitable for key generation, seeding
1134 * TCP sequence numbers, etc. It does not use the hw random number
1135 * generator, if available; use get_random_bytes_arch() for that.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 */
1137void get_random_bytes(void *buf, int nbytes)
1138{
Theodore Ts'o59108952013-09-12 14:10:25 -04001139 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001140 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
1141}
1142EXPORT_SYMBOL(get_random_bytes);
1143
1144/*
1145 * This function will use the architecture-specific hardware random
1146 * number generator if it is available. The arch-specific hw RNG will
1147 * almost certainly be faster than what we can do in software, but it
1148 * is impossible to verify that it is implemented securely (as
1149 * opposed, to, say, the AES encryption of a sequence number using a
1150 * key known by the NSA). So it's useful if we need the speed, but
1151 * only if we're willing to trust the hardware manufacturer not to
1152 * have put in a back door.
1153 */
1154void get_random_bytes_arch(void *buf, int nbytes)
1155{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001156 char *p = buf;
1157
Theodore Ts'o59108952013-09-12 14:10:25 -04001158 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001159 while (nbytes) {
1160 unsigned long v;
1161 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001162
H. Peter Anvin63d77172011-07-31 13:54:50 -07001163 if (!arch_get_random_long(&v))
1164 break;
1165
Luck, Tonybd29e562011-11-16 10:50:56 -08001166 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001167 p += chunk;
1168 nbytes -= chunk;
1169 }
1170
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001171 if (nbytes)
1172 extract_entropy(&nonblocking_pool, p, nbytes, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001174EXPORT_SYMBOL(get_random_bytes_arch);
1175
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176
1177/*
1178 * init_std_data - initialize pool with system data
1179 *
1180 * @r: pool to initialize
1181 *
1182 * This function clears the pool's entropy count and mixes some system
1183 * data into the pool to prepare it for use. The pool is not cleared
1184 * as that can only decrease the entropy in the pool.
1185 */
1186static void init_std_data(struct entropy_store *r)
1187{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001188 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001189 ktime_t now = ktime_get_real();
1190 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 r->entropy_count = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001193 r->entropy_total = 0;
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001194 r->last_data_init = 0;
Theodore Ts'of5c27422013-09-22 15:14:32 -04001195 r->last_pulled = jiffies;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001196 mix_pool_bytes(r, &now, sizeof(now), NULL);
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001197 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
Theodore Ts'o902c0982012-07-04 10:38:30 -04001198 if (!arch_get_random_long(&rv))
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001199 break;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001200 mix_pool_bytes(r, &rv, sizeof(rv), NULL);
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001201 }
Theodore Ts'o902c0982012-07-04 10:38:30 -04001202 mix_pool_bytes(r, utsname(), sizeof(*(utsname())), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203}
1204
Tony Luckcbc96b72012-07-23 09:47:57 -07001205/*
1206 * Note that setup_arch() may call add_device_randomness()
1207 * long before we get here. This allows seeding of the pools
1208 * with some platform dependent data very early in the boot
1209 * process. But it limits our options here. We must use
1210 * statically allocated structures that already have all
1211 * initializations complete at compile time. We should also
1212 * take care not to overwrite the precious per platform data
1213 * we were given.
1214 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001215static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216{
1217 init_std_data(&input_pool);
1218 init_std_data(&blocking_pool);
1219 init_std_data(&nonblocking_pool);
1220 return 0;
1221}
1222module_init(rand_initialize);
1223
David Howells93614012006-09-30 20:45:40 +02001224#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225void rand_initialize_disk(struct gendisk *disk)
1226{
1227 struct timer_rand_state *state;
1228
1229 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001230 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 * source.
1232 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001233 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1234 if (state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 disk->random = state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236}
David Howells93614012006-09-30 20:45:40 +02001237#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
1239static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001240random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241{
1242 ssize_t n, retval = 0, count = 0;
1243
1244 if (nbytes == 0)
1245 return 0;
1246
1247 while (nbytes > 0) {
1248 n = nbytes;
1249 if (n > SEC_XFER_SIZE)
1250 n = SEC_XFER_SIZE;
1251
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001252 DEBUG_ENT("reading %zu bits\n", n*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
1254 n = extract_entropy_user(&blocking_pool, buf, n);
1255
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001256 if (n < 0) {
1257 retval = n;
1258 break;
1259 }
1260
1261 DEBUG_ENT("read got %zd bits (%zd still needed)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 n*8, (nbytes-n)*8);
1263
1264 if (n == 0) {
1265 if (file->f_flags & O_NONBLOCK) {
1266 retval = -EAGAIN;
1267 break;
1268 }
1269
1270 DEBUG_ENT("sleeping?\n");
1271
1272 wait_event_interruptible(random_read_wait,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001273 ENTROPY_BITS(&input_pool) >=
1274 random_read_wakeup_thresh);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
1276 DEBUG_ENT("awake\n");
1277
1278 if (signal_pending(current)) {
1279 retval = -ERESTARTSYS;
1280 break;
1281 }
1282
1283 continue;
1284 }
1285
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 count += n;
1287 buf += n;
1288 nbytes -= n;
1289 break; /* This break makes the device work */
1290 /* like a named pipe */
1291 }
1292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 return (count ? count : retval);
1294}
1295
1296static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001297urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298{
1299 return extract_entropy_user(&nonblocking_pool, buf, nbytes);
1300}
1301
1302static unsigned int
1303random_poll(struct file *file, poll_table * wait)
1304{
1305 unsigned int mask;
1306
1307 poll_wait(file, &random_read_wait, wait);
1308 poll_wait(file, &random_write_wait, wait);
1309 mask = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001310 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 mask |= POLLIN | POLLRDNORM;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001312 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 mask |= POLLOUT | POLLWRNORM;
1314 return mask;
1315}
1316
Matt Mackall7f397dc2007-05-29 21:58:10 -05001317static int
1318write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1319{
1320 size_t bytes;
1321 __u32 buf[16];
1322 const char __user *p = buffer;
1323
1324 while (count > 0) {
1325 bytes = min(count, sizeof(buf));
1326 if (copy_from_user(&buf, p, bytes))
1327 return -EFAULT;
1328
1329 count -= bytes;
1330 p += bytes;
1331
Theodore Ts'o902c0982012-07-04 10:38:30 -04001332 mix_pool_bytes(r, buf, bytes, NULL);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001333 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001334 }
1335
1336 return 0;
1337}
1338
Matt Mackall90b75ee2008-04-29 01:02:55 -07001339static ssize_t random_write(struct file *file, const char __user *buffer,
1340 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001342 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343
Matt Mackall7f397dc2007-05-29 21:58:10 -05001344 ret = write_pool(&blocking_pool, buffer, count);
1345 if (ret)
1346 return ret;
1347 ret = write_pool(&nonblocking_pool, buffer, count);
1348 if (ret)
1349 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
Matt Mackall7f397dc2007-05-29 21:58:10 -05001351 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352}
1353
Matt Mackall43ae4862008-04-29 01:02:58 -07001354static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355{
1356 int size, ent_count;
1357 int __user *p = (int __user *)arg;
1358 int retval;
1359
1360 switch (cmd) {
1361 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001362 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001363 ent_count = ENTROPY_BITS(&input_pool);
1364 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 return -EFAULT;
1366 return 0;
1367 case RNDADDTOENTCNT:
1368 if (!capable(CAP_SYS_ADMIN))
1369 return -EPERM;
1370 if (get_user(ent_count, p))
1371 return -EFAULT;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001372 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 return 0;
1374 case RNDADDENTROPY:
1375 if (!capable(CAP_SYS_ADMIN))
1376 return -EPERM;
1377 if (get_user(ent_count, p++))
1378 return -EFAULT;
1379 if (ent_count < 0)
1380 return -EINVAL;
1381 if (get_user(size, p++))
1382 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001383 retval = write_pool(&input_pool, (const char __user *)p,
1384 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 if (retval < 0)
1386 return retval;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001387 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 return 0;
1389 case RNDZAPENTCNT:
1390 case RNDCLEARPOOL:
1391 /* Clear the entropy pool counters. */
1392 if (!capable(CAP_SYS_ADMIN))
1393 return -EPERM;
Matt Mackall53c3f632008-04-29 01:02:58 -07001394 rand_initialize();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 return 0;
1396 default:
1397 return -EINVAL;
1398 }
1399}
1400
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001401static int random_fasync(int fd, struct file *filp, int on)
1402{
1403 return fasync_helper(fd, filp, on, &fasync);
1404}
1405
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001406const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 .read = random_read,
1408 .write = random_write,
1409 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001410 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001411 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001412 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413};
1414
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001415const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 .read = urandom_read,
1417 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001418 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001419 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001420 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421};
1422
1423/***************************************************************
1424 * Random UUID interface
1425 *
1426 * Used here for a Boot ID, but can be useful for other kernel
1427 * drivers.
1428 ***************************************************************/
1429
1430/*
1431 * Generate random UUID
1432 */
1433void generate_random_uuid(unsigned char uuid_out[16])
1434{
1435 get_random_bytes(uuid_out, 16);
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05001436 /* Set UUID version to 4 --- truly random generation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1438 /* Set the UUID variant to DCE */
1439 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1440}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441EXPORT_SYMBOL(generate_random_uuid);
1442
1443/********************************************************************
1444 *
1445 * Sysctl interface
1446 *
1447 ********************************************************************/
1448
1449#ifdef CONFIG_SYSCTL
1450
1451#include <linux/sysctl.h>
1452
1453static int min_read_thresh = 8, min_write_thresh;
1454static int max_read_thresh = INPUT_POOL_WORDS * 32;
1455static int max_write_thresh = INPUT_POOL_WORDS * 32;
1456static char sysctl_bootid[16];
1457
1458/*
1459 * These functions is used to return both the bootid UUID, and random
1460 * UUID. The difference is in whether table->data is NULL; if it is,
1461 * then a new UUID is generated and returned to the user.
1462 *
1463 * If the user accesses this via the proc interface, it will be returned
1464 * as an ASCII string in the standard UUID format. If accesses via the
1465 * sysctl system call, it is returned as 16 bytes of binary data.
1466 */
Joe Perchesa1514272013-06-13 19:37:35 -07001467static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 void __user *buffer, size_t *lenp, loff_t *ppos)
1469{
Joe Perchesa1514272013-06-13 19:37:35 -07001470 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 unsigned char buf[64], tmp_uuid[16], *uuid;
1472
1473 uuid = table->data;
1474 if (!uuid) {
1475 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001477 } else {
1478 static DEFINE_SPINLOCK(bootid_spinlock);
1479
1480 spin_lock(&bootid_spinlock);
1481 if (!uuid[8])
1482 generate_random_uuid(uuid);
1483 spin_unlock(&bootid_spinlock);
1484 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485
Joe Perches35900772009-12-14 18:01:11 -08001486 sprintf(buf, "%pU", uuid);
1487
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 fake_table.data = buf;
1489 fake_table.maxlen = sizeof(buf);
1490
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001491 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492}
1493
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001494/*
1495 * Return entropy available scaled to integral bits
1496 */
1497static int proc_do_entropy(ctl_table *table, int write,
1498 void __user *buffer, size_t *lenp, loff_t *ppos)
1499{
1500 ctl_table fake_table;
1501 int entropy_count;
1502
1503 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
1504
1505 fake_table.data = &entropy_count;
1506 fake_table.maxlen = sizeof(entropy_count);
1507
1508 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1509}
1510
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07001512extern struct ctl_table random_table[];
1513struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 .procname = "poolsize",
1516 .data = &sysctl_poolsize,
1517 .maxlen = sizeof(int),
1518 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001519 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 },
1521 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 .procname = "entropy_avail",
1523 .maxlen = sizeof(int),
1524 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001525 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 .data = &input_pool.entropy_count,
1527 },
1528 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 .procname = "read_wakeup_threshold",
1530 .data = &random_read_wakeup_thresh,
1531 .maxlen = sizeof(int),
1532 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001533 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 .extra1 = &min_read_thresh,
1535 .extra2 = &max_read_thresh,
1536 },
1537 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 .procname = "write_wakeup_threshold",
1539 .data = &random_write_wakeup_thresh,
1540 .maxlen = sizeof(int),
1541 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001542 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 .extra1 = &min_write_thresh,
1544 .extra2 = &max_write_thresh,
1545 },
1546 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04001547 .procname = "urandom_min_reseed_secs",
1548 .data = &random_min_urandom_seed,
1549 .maxlen = sizeof(int),
1550 .mode = 0644,
1551 .proc_handler = proc_dointvec,
1552 },
1553 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 .procname = "boot_id",
1555 .data = &sysctl_bootid,
1556 .maxlen = 16,
1557 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001558 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 },
1560 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 .procname = "uuid",
1562 .maxlen = 16,
1563 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001564 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 },
Eric W. Biederman894d2492009-11-05 14:34:02 -08001566 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567};
1568#endif /* CONFIG_SYSCTL */
1569
David S. Miller6e5714e2011-08-03 20:50:44 -07001570static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Theodore Ts'o47d06e52013-09-10 10:52:35 -04001572int random_int_secret_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573{
David S. Miller6e5714e2011-08-03 20:50:44 -07001574 get_random_bytes(random_int_secret, sizeof(random_int_secret));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 return 0;
1576}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
1578/*
1579 * Get a random word for internal kernel use only. Similar to urandom but
1580 * with the goal of minimal entropy pool depletion. As a result, the random
1581 * value is not cryptographically secure but for several uses the cost of
1582 * depleting entropy is too high
1583 */
Theodore Ts'o74feec52012-07-06 14:03:18 -04001584static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585unsigned int get_random_int(void)
1586{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001587 __u32 *hash;
David S. Miller6e5714e2011-08-03 20:50:44 -07001588 unsigned int ret;
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001589
H. Peter Anvin63d77172011-07-31 13:54:50 -07001590 if (arch_get_random_int(&ret))
1591 return ret;
1592
1593 hash = get_cpu_var(get_random_int_hash);
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001594
Theodore Ts'o61875f32013-09-21 13:58:22 -04001595 hash[0] += current->pid + jiffies + random_get_entropy();
David S. Miller6e5714e2011-08-03 20:50:44 -07001596 md5_transform(hash, random_int_secret);
1597 ret = hash[0];
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001598 put_cpu_var(get_random_int_hash);
1599
1600 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601}
Andy Shevchenko16c7fa02013-04-30 15:27:30 -07001602EXPORT_SYMBOL(get_random_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
1604/*
1605 * randomize_range() returns a start address such that
1606 *
1607 * [...... <range> .....]
1608 * start end
1609 *
1610 * a <range> with size "len" starting at the return value is inside in the
1611 * area defined by [start, end], but is otherwise randomized.
1612 */
1613unsigned long
1614randomize_range(unsigned long start, unsigned long end, unsigned long len)
1615{
1616 unsigned long range = end - len - start;
1617
1618 if (end <= start + len)
1619 return 0;
1620 return PAGE_ALIGN(get_random_int() % range + start);
1621}