blob: a19a7a63ec3589fccccb856cf8ea978cf5e7e44a [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>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400258#include <linux/workqueue.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Yinghai Lud178a1e2009-01-11 00:35:42 -0800260#ifdef CONFIG_GENERIC_HARDIRQS
261# include <linux/irq.h>
262#endif
263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264#include <asm/processor.h>
265#include <asm/uaccess.h>
266#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400267#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268#include <asm/io.h>
269
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400270#define CREATE_TRACE_POINTS
271#include <trace/events/random.h>
272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273/*
274 * Configuration information
275 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400276#define INPUT_POOL_SHIFT 12
277#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
278#define OUTPUT_POOL_SHIFT 10
279#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
280#define SEC_XFER_SIZE 512
281#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400283#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400286 * To allow fractional bits to be tracked, the entropy_count field is
287 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400288 *
289 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
290 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400291 */
292#define ENTROPY_SHIFT 3
293#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
294
295/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 * The minimum number of bits of entropy before we wake up a read on
297 * /dev/random. Should be enough to do a significant reseed.
298 */
299static int random_read_wakeup_thresh = 64;
300
301/*
302 * If the entropy count falls under this number of bits, then we
303 * should wake up processes which are selecting or polling on write
304 * access to /dev/random.
305 */
Theodore Ts'o6265e162013-10-03 01:08:15 -0400306static int random_write_wakeup_thresh = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307
308/*
Theodore Ts'of5c27422013-09-22 15:14:32 -0400309 * The minimum number of seconds between urandom pool resending. We
310 * do this to limit the amount of entropy that can be drained from the
311 * input pool even if there are heavy demands on /dev/urandom.
312 */
313static int random_min_urandom_seed = 60;
314
315/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400316 * Originally, we used a primitive polynomial of degree .poolwords
317 * over GF(2). The taps for various sizes are defined below. They
318 * were chosen to be evenly spaced except for the last tap, which is 1
319 * to get the twisting happening as fast as possible.
320 *
321 * For the purposes of better mixing, we use the CRC-32 polynomial as
322 * well to make a (modified) twisted Generalized Feedback Shift
323 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
324 * generators. ACM Transactions on Modeling and Computer Simulation
325 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
326 * GFSR generators II. ACM Transactions on Mdeling and Computer
327 * Simulation 4:254-266)
328 *
329 * Thanks to Colin Plumb for suggesting this.
330 *
331 * The mixing operation is much less sensitive than the output hash,
332 * where we use SHA-1. All that we want of mixing operation is that
333 * it be a good non-cryptographic hash; i.e. it not produce collisions
334 * when fed "random" data of the sort we expect to see. As long as
335 * the pool state differs for different inputs, we have preserved the
336 * input entropy and done a good job. The fact that an intelligent
337 * attacker can construct inputs that will produce controlled
338 * alterations to the pool's state is not important because we don't
339 * consider such inputs to contribute any randomness. The only
340 * property we need with respect to them is that the attacker can't
341 * increase his/her knowledge of the pool's state. Since all
342 * additions are reversible (knowing the final state and the input,
343 * you can reconstruct the initial state), if an attacker has any
344 * uncertainty about the initial state, he/she can only shuffle that
345 * uncertainty about, but never cause any collisions (which would
346 * decrease the uncertainty).
347 *
348 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
349 * Videau in their paper, "The Linux Pseudorandom Number Generator
350 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
351 * paper, they point out that we are not using a true Twisted GFSR,
352 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
353 * is, with only three taps, instead of the six that we are using).
354 * As a result, the resulting polynomial is neither primitive nor
355 * irreducible, and hence does not have a maximal period over
356 * GF(2**32). They suggest a slight change to the generator
357 * polynomial which improves the resulting TGFSR polynomial to be
358 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 */
360static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400361 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
362#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 int tap1, tap2, tap3, tap4, tap5;
364} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400365 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
366 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
367 { S(128), 104, 76, 51, 25, 1 },
368 /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
369 /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
370 { S(32), 26, 19, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371#if 0
372 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400373 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400376 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400379 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400382 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400385 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400387 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
389 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400390 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400393 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400396 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397#endif
398};
399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 * Static global variables
402 */
403static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
404static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700405static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407/**********************************************************************
408 *
409 * OS independent entropy store. Here are the functions which handle
410 * storing entropy in an entropy pool.
411 *
412 **********************************************************************/
413
414struct entropy_store;
415struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700416 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400417 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 __u32 *pool;
419 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400421 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400424 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700425 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400426 unsigned short add_ptr;
427 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800428 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400429 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400430 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400431 unsigned int limit:1;
432 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000433 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434};
435
Theodore Ts'o6265e162013-10-03 01:08:15 -0400436static void push_to_pool(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437static __u32 input_pool_data[INPUT_POOL_WORDS];
438static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
439static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
440
441static struct entropy_store input_pool = {
442 .poolinfo = &poolinfo_table[0],
443 .name = "input",
444 .limit = 1,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200445 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 .pool = input_pool_data
447};
448
449static struct entropy_store blocking_pool = {
450 .poolinfo = &poolinfo_table[1],
451 .name = "blocking",
452 .limit = 1,
453 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200454 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400455 .pool = blocking_pool_data,
456 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
457 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458};
459
460static struct entropy_store nonblocking_pool = {
461 .poolinfo = &poolinfo_table[1],
462 .name = "nonblocking",
463 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200464 .lock = __SPIN_LOCK_UNLOCKED(nonblocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400465 .pool = nonblocking_pool_data,
466 .push_work = __WORK_INITIALIZER(nonblocking_pool.push_work,
467 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468};
469
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400470static __u32 const twist_table[8] = {
471 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
472 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
473
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700475 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700477 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 *
479 * The pool is stirred with a primitive polynomial of the appropriate
480 * degree, and then twisted. We twist by three bits at a time because
481 * it's cheap to do so and helps slightly in the expected case where
482 * the entropy is concentrated in the low-order bits.
483 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400484static void _mix_pool_bytes(struct entropy_store *r, const void *in,
485 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486{
Matt Mackall993ba212008-04-29 01:03:04 -0700487 unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700488 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700490 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700491 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 tap1 = r->poolinfo->tap1;
494 tap2 = r->poolinfo->tap2;
495 tap3 = r->poolinfo->tap3;
496 tap4 = r->poolinfo->tap4;
497 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Theodore Ts'o902c0982012-07-04 10:38:30 -0400499 smp_rmb();
500 input_rotate = ACCESS_ONCE(r->input_rotate);
501 i = ACCESS_ONCE(r->add_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Matt Mackalle68e5b62008-04-29 01:03:05 -0700503 /* mix one byte at a time to simplify size handling and churn faster */
504 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400505 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700506 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507
508 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700509 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 w ^= r->pool[(i + tap1) & wordmask];
511 w ^= r->pool[(i + tap2) & wordmask];
512 w ^= r->pool[(i + tap3) & wordmask];
513 w ^= r->pool[(i + tap4) & wordmask];
514 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700515
516 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700518
519 /*
520 * Normally, we add 7 bits of rotation to the pool.
521 * At the beginning of the pool, add an extra 7 bits
522 * rotation, so that successive passes spread the
523 * input bits across the pool evenly.
524 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400525 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 }
527
Theodore Ts'o902c0982012-07-04 10:38:30 -0400528 ACCESS_ONCE(r->input_rotate) = input_rotate;
529 ACCESS_ONCE(r->add_ptr) = i;
530 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
Matt Mackall993ba212008-04-29 01:03:04 -0700532 if (out)
533 for (j = 0; j < 16; j++)
Matt Mackalle68e5b62008-04-29 01:03:05 -0700534 ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535}
536
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400537static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o902c0982012-07-04 10:38:30 -0400538 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400540 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
541 _mix_pool_bytes(r, in, nbytes, out);
542}
543
544static void mix_pool_bytes(struct entropy_store *r, const void *in,
545 int nbytes, __u8 out[64])
546{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400547 unsigned long flags;
548
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400549 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400550 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400551 _mix_pool_bytes(r, in, nbytes, out);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400552 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553}
554
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400555struct fast_pool {
556 __u32 pool[4];
557 unsigned long last;
558 unsigned short count;
559 unsigned char rotate;
560 unsigned char last_timer_intr;
561};
562
563/*
564 * This is a fast mixing routine used by the interrupt randomness
565 * collector. It's hardcoded for an 128 bit pool and assumes that any
566 * locks that might be needed are taken by the caller.
567 */
Theodore Ts'o655b2262013-09-22 15:24:02 -0400568static void fast_mix(struct fast_pool *f, __u32 input[4])
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400569{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400570 __u32 w;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400571 unsigned input_rotate = f->rotate;
572
Theodore Ts'o655b2262013-09-22 15:24:02 -0400573 w = rol32(input[0], input_rotate) ^ f->pool[0] ^ f->pool[3];
574 f->pool[0] = (w >> 3) ^ twist_table[w & 7];
575 input_rotate = (input_rotate + 14) & 31;
576 w = rol32(input[1], input_rotate) ^ f->pool[1] ^ f->pool[0];
577 f->pool[1] = (w >> 3) ^ twist_table[w & 7];
578 input_rotate = (input_rotate + 7) & 31;
579 w = rol32(input[2], input_rotate) ^ f->pool[2] ^ f->pool[1];
580 f->pool[2] = (w >> 3) ^ twist_table[w & 7];
581 input_rotate = (input_rotate + 7) & 31;
582 w = rol32(input[3], input_rotate) ^ f->pool[3] ^ f->pool[2];
583 f->pool[3] = (w >> 3) ^ twist_table[w & 7];
584 input_rotate = (input_rotate + 7) & 31;
585
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400586 f->rotate = input_rotate;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400587 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400588}
589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400591 * Credit (or debit) the entropy store with n bits of entropy.
592 * Use credit_entropy_bits_safe() if the value comes from userspace
593 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700595static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400597 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400598 const int pool_size = r->poolinfo->poolfracbits;
599 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Matt Mackalladc782d2008-04-29 01:03:07 -0700601 if (!nbits)
602 return;
603
Theodore Ts'o902c0982012-07-04 10:38:30 -0400604retry:
605 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400606 if (nfrac < 0) {
607 /* Debit */
608 entropy_count += nfrac;
609 } else {
610 /*
611 * Credit: we have to account for the possibility of
612 * overwriting already present entropy. Even in the
613 * ideal case of pure Shannon entropy, new contributions
614 * approach the full value asymptotically:
615 *
616 * entropy <- entropy + (pool_size - entropy) *
617 * (1 - exp(-add_entropy/pool_size))
618 *
619 * For add_entropy <= pool_size/2 then
620 * (1 - exp(-add_entropy/pool_size)) >=
621 * (add_entropy/pool_size)*0.7869...
622 * so we can approximate the exponential with
623 * 3/4*add_entropy/pool_size and still be on the
624 * safe side by adding at most pool_size/2 at a time.
625 *
626 * The use of pool_size-2 in the while statement is to
627 * prevent rounding artifacts from making the loop
628 * arbitrarily long; this limits the loop to log2(pool_size)*2
629 * turns no matter how large nbits is.
630 */
631 int pnfrac = nfrac;
632 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
633 /* The +2 corresponds to the /4 in the denominator */
634
635 do {
636 unsigned int anfrac = min(pnfrac, pool_size/2);
637 unsigned int add =
638 ((pool_size - entropy_count)*anfrac*3) >> s;
639
640 entropy_count += add;
641 pnfrac -= anfrac;
642 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
643 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400644
Andrew Morton8b76f462008-09-02 14:36:14 -0700645 if (entropy_count < 0) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400646 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
647 r->name, entropy_count);
648 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700649 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400650 } else if (entropy_count > pool_size)
651 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400652 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
653 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Theodore Ts'o6265e162013-10-03 01:08:15 -0400655 r->entropy_total += nbits;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400656 if (!r->initialized && nbits > 0) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400657 if (r->entropy_total > 128) {
Theodore Ts'o301f0592013-11-03 06:54:51 -0500658 if (r == &nonblocking_pool)
659 pr_notice("random: %s pool is initialized\n",
660 r->name);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400661 r->initialized = 1;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400662 r->entropy_total = 0;
663 }
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400664 }
665
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400666 trace_credit_entropy_bits(r->name, nbits,
667 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400668 r->entropy_total, _RET_IP_);
669
Theodore Ts'o6265e162013-10-03 01:08:15 -0400670 if (r == &input_pool) {
671 int entropy_bytes = entropy_count >> ENTROPY_SHIFT;
672
673 /* should we wake readers? */
674 if (entropy_bytes >= random_read_wakeup_thresh) {
675 wake_up_interruptible(&random_read_wait);
676 kill_fasync(&fasync, SIGIO, POLL_IN);
677 }
678 /* If the input pool is getting full, send some
679 * entropy to the two output pools, flipping back and
680 * forth between them, until the output pools are 75%
681 * full.
682 */
683 if (entropy_bytes > random_write_wakeup_thresh &&
684 r->initialized &&
685 r->entropy_total >= 2*random_read_wakeup_thresh) {
686 static struct entropy_store *last = &blocking_pool;
687 struct entropy_store *other = &blocking_pool;
688
689 if (last == &blocking_pool)
690 other = &nonblocking_pool;
691 if (other->entropy_count <=
692 3 * other->poolinfo->poolfracbits / 4)
693 last = other;
694 if (last->entropy_count <=
695 3 * last->poolinfo->poolfracbits / 4) {
696 schedule_work(&last->push_work);
697 r->entropy_total = 0;
698 }
699 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700700 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701}
702
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400703static void credit_entropy_bits_safe(struct entropy_store *r, int nbits)
704{
705 const int nbits_max = (int)(~0U >> (ENTROPY_SHIFT + 1));
706
707 /* Cap the value to avoid overflows */
708 nbits = min(nbits, nbits_max);
709 nbits = max(nbits, -nbits_max);
710
711 credit_entropy_bits(r, nbits);
712}
713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714/*********************************************************************
715 *
716 * Entropy input management
717 *
718 *********************************************************************/
719
720/* There is one of these per entropy source */
721struct timer_rand_state {
722 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -0700723 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 unsigned dont_count_entropy:1;
725};
726
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400727/*
728 * Add device- or boot-specific data to the input and nonblocking
729 * pools to help initialize them to unique values.
730 *
731 * None of this adds any entropy, it is meant to avoid the
732 * problem of the nonblocking pool having similar initial state
733 * across largely identical devices.
734 */
735void add_device_randomness(const void *buf, unsigned int size)
736{
Theodore Ts'o61875f32013-09-21 13:58:22 -0400737 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400738 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400739
Theodore Ts'o59108952013-09-12 14:10:25 -0400740 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400741 spin_lock_irqsave(&input_pool.lock, flags);
742 _mix_pool_bytes(&input_pool, buf, size, NULL);
743 _mix_pool_bytes(&input_pool, &time, sizeof(time), NULL);
744 spin_unlock_irqrestore(&input_pool.lock, flags);
745
746 spin_lock_irqsave(&nonblocking_pool.lock, flags);
747 _mix_pool_bytes(&nonblocking_pool, buf, size, NULL);
748 _mix_pool_bytes(&nonblocking_pool, &time, sizeof(time), NULL);
749 spin_unlock_irqrestore(&nonblocking_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400750}
751EXPORT_SYMBOL(add_device_randomness);
752
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700753static struct timer_rand_state input_timer_state;
754
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755/*
756 * This function adds entropy to the entropy "pool" by using timing
757 * delays. It uses the timer_rand_state structure to make an estimate
758 * of how many bits of entropy this call has added to the pool.
759 *
760 * The number "num" is also added to the pool - it should somehow describe
761 * the type of event which just happened. This is currently 0-255 for
762 * keyboard scan codes, and 256 upwards for interrupts.
763 *
764 */
765static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
766{
Theodore Ts'o40db23e2013-11-03 00:15:05 -0400767 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -0800770 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 unsigned num;
772 } sample;
773 long delta, delta2, delta3;
774
775 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
777 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -0400778 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 sample.num = num;
Theodore Ts'o40db23e2013-11-03 00:15:05 -0400780 r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
781 mix_pool_bytes(r, &sample, sizeof(sample), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
783 /*
784 * Calculate number of bits of randomness we probably added.
785 * We take into account the first, second and third-order deltas
786 * in order to make our estimate.
787 */
788
789 if (!state->dont_count_entropy) {
790 delta = sample.jiffies - state->last_time;
791 state->last_time = sample.jiffies;
792
793 delta2 = delta - state->last_delta;
794 state->last_delta = delta;
795
796 delta3 = delta2 - state->last_delta2;
797 state->last_delta2 = delta2;
798
799 if (delta < 0)
800 delta = -delta;
801 if (delta2 < 0)
802 delta2 = -delta2;
803 if (delta3 < 0)
804 delta3 = -delta3;
805 if (delta > delta2)
806 delta = delta2;
807 if (delta > delta3)
808 delta = delta3;
809
810 /*
811 * delta is now minimum absolute delta.
812 * Round down by 1 bit on general principles,
813 * and limit entropy entimate to 12 bits.
814 */
Theodore Ts'o40db23e2013-11-03 00:15:05 -0400815 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 preempt_enable();
818}
819
Stephen Hemmingerd2515752006-01-11 12:17:38 -0800820void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 unsigned int value)
822{
823 static unsigned char last_value;
824
825 /* ignore autorepeat and the like */
826 if (value == last_value)
827 return;
828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 last_value = value;
830 add_timer_randomness(&input_timer_state,
831 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400832 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400834EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400836static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
837
838void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400840 struct entropy_store *r;
841 struct fast_pool *fast_pool = &__get_cpu_var(irq_randomness);
842 struct pt_regs *regs = get_irq_regs();
843 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400844 cycles_t cycles = random_get_entropy();
845 __u32 input[4], c_high, j_high;
846 __u64 ip;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700847
Theodore Ts'o655b2262013-09-22 15:24:02 -0400848 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;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700855
Theodore Ts'o655b2262013-09-22 15:24:02 -0400856 fast_mix(fast_pool, input);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400857
Theodore Ts'o655b2262013-09-22 15:24:02 -0400858 if ((fast_pool->count & 63) && !time_after(now, fast_pool->last + HZ))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 return;
860
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400861 fast_pool->last = now;
862
863 r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400864 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool), NULL);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400865 /*
866 * If we don't have a valid cycle counter, and we see
867 * back-to-back timer interrupts, then skip giving credit for
868 * any entropy.
869 */
870 if (cycles == 0) {
871 if (irq_flags & __IRQF_TIMER) {
872 if (fast_pool->last_timer_intr)
873 return;
874 fast_pool->last_timer_intr = 1;
875 } else
876 fast_pool->last_timer_intr = 0;
877 }
878 credit_entropy_bits(r, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879}
880
David Howells93614012006-09-30 20:45:40 +0200881#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882void add_disk_randomness(struct gendisk *disk)
883{
884 if (!disk || !disk->random)
885 return;
886 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +0200887 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400888 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889}
David Howells93614012006-09-30 20:45:40 +0200890#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892/*********************************************************************
893 *
894 * Entropy extraction routines
895 *
896 *********************************************************************/
897
Matt Mackall90b75ee2008-04-29 01:02:55 -0700898static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 size_t nbytes, int min, int rsvd);
900
901/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300902 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 * from the primary pool to the secondary extraction pool. We make
904 * sure we pull enough for a 'catastrophic reseed'.
905 */
Theodore Ts'o6265e162013-10-03 01:08:15 -0400906static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
908{
Theodore Ts'of5c27422013-09-22 15:14:32 -0400909 if (r->limit == 0 && random_min_urandom_seed) {
910 unsigned long now = jiffies;
911
912 if (time_before(now,
913 r->last_pulled + random_min_urandom_seed * HZ))
914 return;
915 r->last_pulled = now;
916 }
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400917 if (r->pull &&
918 r->entropy_count < (nbytes << (ENTROPY_SHIFT + 3)) &&
Theodore Ts'o6265e162013-10-03 01:08:15 -0400919 r->entropy_count < r->poolinfo->poolfracbits)
920 _xfer_secondary_pool(r, nbytes);
921}
Matt Mackall5a021e92007-07-19 11:30:14 -0700922
Theodore Ts'o6265e162013-10-03 01:08:15 -0400923static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
924{
925 __u32 tmp[OUTPUT_POOL_WORDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Theodore Ts'o6265e162013-10-03 01:08:15 -0400927 /* For /dev/random's pool, always leave two wakeup worth's BITS */
928 int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
929 int bytes = nbytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930
Theodore Ts'o6265e162013-10-03 01:08:15 -0400931 /* pull at least as many as BYTES as wakeup BITS */
932 bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
933 /* but never more than the buffer size */
934 bytes = min_t(int, bytes, sizeof(tmp));
935
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400936 trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
937 ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
Theodore Ts'o6265e162013-10-03 01:08:15 -0400938 bytes = extract_entropy(r->pull, tmp, bytes,
939 random_read_wakeup_thresh / 8, rsvd);
940 mix_pool_bytes(r, tmp, bytes, NULL);
941 credit_entropy_bits(r, bytes*8);
942}
943
944/*
945 * Used as a workqueue function so that when the input pool is getting
946 * full, we can "spill over" some entropy to the output pools. That
947 * way the output pools can store some of the excess entropy instead
948 * of letting it go to waste.
949 */
950static void push_to_pool(struct work_struct *work)
951{
952 struct entropy_store *r = container_of(work, struct entropy_store,
953 push_work);
954 BUG_ON(!r);
955 _xfer_secondary_pool(r, random_read_wakeup_thresh/8);
956 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
957 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958}
959
960/*
961 * These functions extracts randomness from the "entropy pool", and
962 * returns it in a buffer.
963 *
964 * The min parameter specifies the minimum amount we can pull before
965 * failing to avoid races that defeat catastrophic reseeding while the
966 * reserved parameter indicates how much entropy we must leave in the
967 * pool after each pull to avoid starving other readers.
968 *
969 * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
970 */
971
972static size_t account(struct entropy_store *r, size_t nbytes, int min,
973 int reserved)
974{
975 unsigned long flags;
Theodore Ts'ob9809552013-03-04 11:59:12 -0500976 int wakeup_write = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400977 int have_bytes;
978 int entropy_count, orig;
979 size_t ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 /* Hold lock while accounting */
982 spin_lock_irqsave(&r->lock, flags);
983
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400984 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985
986 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -0700987retry:
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400988 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
989 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
990 ibytes = nbytes;
991 if (have_bytes < min + reserved) {
992 ibytes = 0;
993 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 /* If limited, never pull more than available */
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400995 if (r->limit && ibytes + reserved >= have_bytes)
996 ibytes = have_bytes - reserved;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400998 if (have_bytes >= ibytes + reserved)
999 entropy_count -= ibytes << (ENTROPY_SHIFT + 3);
1000 else
1001 entropy_count = reserved << (ENTROPY_SHIFT + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001003 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1004 goto retry;
1005
1006 if ((r->entropy_count >> ENTROPY_SHIFT)
1007 < random_write_wakeup_thresh)
Theodore Ts'ob9809552013-03-04 11:59:12 -05001008 wakeup_write = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 spin_unlock_irqrestore(&r->lock, flags);
1011
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001012 trace_debit_entropy(r->name, 8 * ibytes);
Theodore Ts'ob9809552013-03-04 11:59:12 -05001013 if (wakeup_write) {
1014 wake_up_interruptible(&random_write_wait);
1015 kill_fasync(&fasync, SIGIO, POLL_OUT);
1016 }
1017
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001018 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019}
1020
1021static void extract_buf(struct entropy_store *r, __u8 *out)
1022{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001023 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001024 union {
1025 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001026 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001027 } hash;
1028 __u32 workspace[SHA_WORKSPACE_WORDS];
Matt Mackalle68e5b62008-04-29 01:03:05 -07001029 __u8 extract[64];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001030 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001032 /* Generate a hash across the pool, 16 words (512 bits) at a time */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001033 sha_init(hash.w);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001034 spin_lock_irqsave(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001035 for (i = 0; i < r->poolinfo->poolwords; i += 16)
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001036 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
1038 /*
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001039 * If we have a architectural hardware random number
1040 * generator, mix that in, too.
1041 */
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 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001050 * We mix the hash back into the pool to prevent backtracking
1051 * attacks (where the attacker knows the state of the pool
1052 * plus the current outputs, and attempts to find previous
1053 * ouputs), unless the hash function can be inverted. By
1054 * mixing at least a SHA1 worth of hash data back, we make
1055 * brute-forcing the feedback as hard as brute-forcing the
1056 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001058 __mix_pool_bytes(r, hash.w, sizeof(hash.w), extract);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001059 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001060
1061 /*
1062 * To avoid duplicates, we atomically extract a portion of the
1063 * pool while mixing, and hash one final time.
1064 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001065 sha_transform(hash.w, extract, workspace);
Matt Mackallffd8d3f2008-04-29 01:02:59 -07001066 memset(extract, 0, sizeof(extract));
1067 memset(workspace, 0, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068
1069 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001070 * In case the hash function has some recognizable output
1071 * pattern, we fold it in half. Thus, we always feed back
1072 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001074 hash.w[0] ^= hash.w[3];
1075 hash.w[1] ^= hash.w[4];
1076 hash.w[2] ^= rol32(hash.w[2], 16);
1077
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001078 memcpy(out, &hash, EXTRACT_SIZE);
1079 memset(&hash, 0, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080}
1081
Matt Mackall90b75ee2008-04-29 01:02:55 -07001082static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001083 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084{
1085 ssize_t ret = 0, i;
1086 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001087 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001089 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001090 if (fips_enabled) {
1091 spin_lock_irqsave(&r->lock, flags);
1092 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001093 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001094 spin_unlock_irqrestore(&r->lock, flags);
1095 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001096 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001097 xfer_secondary_pool(r, EXTRACT_SIZE);
1098 extract_buf(r, tmp);
1099 spin_lock_irqsave(&r->lock, flags);
1100 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1101 }
1102 spin_unlock_irqrestore(&r->lock, flags);
1103 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001104
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001105 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 xfer_secondary_pool(r, nbytes);
1107 nbytes = account(r, nbytes, min, reserved);
1108
1109 while (nbytes) {
1110 extract_buf(r, tmp);
Neil Horman5b739ef2009-06-18 19:50:21 +08001111
Matt Mackalle954bc92010-05-20 19:55:01 +10001112 if (fips_enabled) {
Neil Horman5b739ef2009-06-18 19:50:21 +08001113 spin_lock_irqsave(&r->lock, flags);
1114 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1115 panic("Hardware RNG duplicated output!\n");
1116 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1117 spin_unlock_irqrestore(&r->lock, flags);
1118 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 i = min_t(int, nbytes, EXTRACT_SIZE);
1120 memcpy(buf, tmp, i);
1121 nbytes -= i;
1122 buf += i;
1123 ret += i;
1124 }
1125
1126 /* Wipe data just returned from memory */
1127 memset(tmp, 0, sizeof(tmp));
1128
1129 return ret;
1130}
1131
1132static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1133 size_t nbytes)
1134{
1135 ssize_t ret = 0, i;
1136 __u8 tmp[EXTRACT_SIZE];
1137
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001138 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 xfer_secondary_pool(r, nbytes);
1140 nbytes = account(r, nbytes, 0, 0);
1141
1142 while (nbytes) {
1143 if (need_resched()) {
1144 if (signal_pending(current)) {
1145 if (ret == 0)
1146 ret = -ERESTARTSYS;
1147 break;
1148 }
1149 schedule();
1150 }
1151
1152 extract_buf(r, tmp);
1153 i = min_t(int, nbytes, EXTRACT_SIZE);
1154 if (copy_to_user(buf, tmp, i)) {
1155 ret = -EFAULT;
1156 break;
1157 }
1158
1159 nbytes -= i;
1160 buf += i;
1161 ret += i;
1162 }
1163
1164 /* Wipe data just returned from memory */
1165 memset(tmp, 0, sizeof(tmp));
1166
1167 return ret;
1168}
1169
1170/*
1171 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001172 * number of good random numbers, suitable for key generation, seeding
1173 * TCP sequence numbers, etc. It does not use the hw random number
1174 * generator, if available; use get_random_bytes_arch() for that.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 */
1176void get_random_bytes(void *buf, int nbytes)
1177{
Theodore Ts'o59108952013-09-12 14:10:25 -04001178 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001179 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
1180}
1181EXPORT_SYMBOL(get_random_bytes);
1182
1183/*
1184 * This function will use the architecture-specific hardware random
1185 * number generator if it is available. The arch-specific hw RNG will
1186 * almost certainly be faster than what we can do in software, but it
1187 * is impossible to verify that it is implemented securely (as
1188 * opposed, to, say, the AES encryption of a sequence number using a
1189 * key known by the NSA). So it's useful if we need the speed, but
1190 * only if we're willing to trust the hardware manufacturer not to
1191 * have put in a back door.
1192 */
1193void get_random_bytes_arch(void *buf, int nbytes)
1194{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001195 char *p = buf;
1196
Theodore Ts'o59108952013-09-12 14:10:25 -04001197 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001198 while (nbytes) {
1199 unsigned long v;
1200 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001201
H. Peter Anvin63d77172011-07-31 13:54:50 -07001202 if (!arch_get_random_long(&v))
1203 break;
1204
Luck, Tonybd29e562011-11-16 10:50:56 -08001205 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001206 p += chunk;
1207 nbytes -= chunk;
1208 }
1209
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001210 if (nbytes)
1211 extract_entropy(&nonblocking_pool, p, nbytes, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001213EXPORT_SYMBOL(get_random_bytes_arch);
1214
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
1216/*
1217 * init_std_data - initialize pool with system data
1218 *
1219 * @r: pool to initialize
1220 *
1221 * This function clears the pool's entropy count and mixes some system
1222 * data into the pool to prepare it for use. The pool is not cleared
1223 * as that can only decrease the entropy in the pool.
1224 */
1225static void init_std_data(struct entropy_store *r)
1226{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001227 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001228 ktime_t now = ktime_get_real();
1229 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 r->entropy_count = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001232 r->entropy_total = 0;
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001233 r->last_data_init = 0;
Theodore Ts'of5c27422013-09-22 15:14:32 -04001234 r->last_pulled = jiffies;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001235 mix_pool_bytes(r, &now, sizeof(now), NULL);
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001236 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
Theodore Ts'o902c0982012-07-04 10:38:30 -04001237 if (!arch_get_random_long(&rv))
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001238 break;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001239 mix_pool_bytes(r, &rv, sizeof(rv), NULL);
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001240 }
Theodore Ts'o902c0982012-07-04 10:38:30 -04001241 mix_pool_bytes(r, utsname(), sizeof(*(utsname())), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242}
1243
Tony Luckcbc96b72012-07-23 09:47:57 -07001244/*
1245 * Note that setup_arch() may call add_device_randomness()
1246 * long before we get here. This allows seeding of the pools
1247 * with some platform dependent data very early in the boot
1248 * process. But it limits our options here. We must use
1249 * statically allocated structures that already have all
1250 * initializations complete at compile time. We should also
1251 * take care not to overwrite the precious per platform data
1252 * we were given.
1253 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001254static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255{
1256 init_std_data(&input_pool);
1257 init_std_data(&blocking_pool);
1258 init_std_data(&nonblocking_pool);
1259 return 0;
1260}
1261module_init(rand_initialize);
1262
David Howells93614012006-09-30 20:45:40 +02001263#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264void rand_initialize_disk(struct gendisk *disk)
1265{
1266 struct timer_rand_state *state;
1267
1268 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001269 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 * source.
1271 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001272 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1273 if (state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 disk->random = state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275}
David Howells93614012006-09-30 20:45:40 +02001276#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
1278static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001279random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280{
1281 ssize_t n, retval = 0, count = 0;
1282
1283 if (nbytes == 0)
1284 return 0;
1285
1286 while (nbytes > 0) {
1287 n = nbytes;
1288 if (n > SEC_XFER_SIZE)
1289 n = SEC_XFER_SIZE;
1290
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 n = extract_entropy_user(&blocking_pool, buf, n);
1292
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001293 if (n < 0) {
1294 retval = n;
1295 break;
1296 }
1297
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001298 trace_random_read(n*8, (nbytes-n)*8,
1299 ENTROPY_BITS(&blocking_pool),
1300 ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301
1302 if (n == 0) {
1303 if (file->f_flags & O_NONBLOCK) {
1304 retval = -EAGAIN;
1305 break;
1306 }
1307
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 wait_event_interruptible(random_read_wait,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001309 ENTROPY_BITS(&input_pool) >=
1310 random_read_wakeup_thresh);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 if (signal_pending(current)) {
1313 retval = -ERESTARTSYS;
1314 break;
1315 }
1316
1317 continue;
1318 }
1319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 count += n;
1321 buf += n;
1322 nbytes -= n;
1323 break; /* This break makes the device work */
1324 /* like a named pipe */
1325 }
1326
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 return (count ? count : retval);
1328}
1329
1330static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001331urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332{
Theodore Ts'o301f0592013-11-03 06:54:51 -05001333 int ret;
1334
1335 if (unlikely(nonblocking_pool.initialized == 0))
1336 printk_once(KERN_NOTICE "random: %s urandom read "
1337 "with %d bits of entropy available\n",
1338 current->comm, nonblocking_pool.entropy_total);
1339
1340 ret = extract_entropy_user(&nonblocking_pool, buf, nbytes);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001341
1342 trace_urandom_read(8 * nbytes, ENTROPY_BITS(&nonblocking_pool),
1343 ENTROPY_BITS(&input_pool));
1344 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345}
1346
1347static unsigned int
1348random_poll(struct file *file, poll_table * wait)
1349{
1350 unsigned int mask;
1351
1352 poll_wait(file, &random_read_wait, wait);
1353 poll_wait(file, &random_write_wait, wait);
1354 mask = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001355 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 mask |= POLLIN | POLLRDNORM;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001357 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 mask |= POLLOUT | POLLWRNORM;
1359 return mask;
1360}
1361
Matt Mackall7f397dc2007-05-29 21:58:10 -05001362static int
1363write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1364{
1365 size_t bytes;
1366 __u32 buf[16];
1367 const char __user *p = buffer;
1368
1369 while (count > 0) {
1370 bytes = min(count, sizeof(buf));
1371 if (copy_from_user(&buf, p, bytes))
1372 return -EFAULT;
1373
1374 count -= bytes;
1375 p += bytes;
1376
Theodore Ts'o902c0982012-07-04 10:38:30 -04001377 mix_pool_bytes(r, buf, bytes, NULL);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001378 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001379 }
1380
1381 return 0;
1382}
1383
Matt Mackall90b75ee2008-04-29 01:02:55 -07001384static ssize_t random_write(struct file *file, const char __user *buffer,
1385 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001387 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388
Matt Mackall7f397dc2007-05-29 21:58:10 -05001389 ret = write_pool(&blocking_pool, buffer, count);
1390 if (ret)
1391 return ret;
1392 ret = write_pool(&nonblocking_pool, buffer, count);
1393 if (ret)
1394 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Matt Mackall7f397dc2007-05-29 21:58:10 -05001396 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397}
1398
Matt Mackall43ae4862008-04-29 01:02:58 -07001399static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400{
1401 int size, ent_count;
1402 int __user *p = (int __user *)arg;
1403 int retval;
1404
1405 switch (cmd) {
1406 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001407 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001408 ent_count = ENTROPY_BITS(&input_pool);
1409 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 return -EFAULT;
1411 return 0;
1412 case RNDADDTOENTCNT:
1413 if (!capable(CAP_SYS_ADMIN))
1414 return -EPERM;
1415 if (get_user(ent_count, p))
1416 return -EFAULT;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001417 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 return 0;
1419 case RNDADDENTROPY:
1420 if (!capable(CAP_SYS_ADMIN))
1421 return -EPERM;
1422 if (get_user(ent_count, p++))
1423 return -EFAULT;
1424 if (ent_count < 0)
1425 return -EINVAL;
1426 if (get_user(size, p++))
1427 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001428 retval = write_pool(&input_pool, (const char __user *)p,
1429 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 if (retval < 0)
1431 return retval;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001432 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 return 0;
1434 case RNDZAPENTCNT:
1435 case RNDCLEARPOOL:
1436 /* Clear the entropy pool counters. */
1437 if (!capable(CAP_SYS_ADMIN))
1438 return -EPERM;
Matt Mackall53c3f632008-04-29 01:02:58 -07001439 rand_initialize();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 return 0;
1441 default:
1442 return -EINVAL;
1443 }
1444}
1445
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001446static int random_fasync(int fd, struct file *filp, int on)
1447{
1448 return fasync_helper(fd, filp, on, &fasync);
1449}
1450
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001451const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 .read = random_read,
1453 .write = random_write,
1454 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001455 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001456 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001457 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458};
1459
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001460const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 .read = urandom_read,
1462 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001463 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001464 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001465 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466};
1467
1468/***************************************************************
1469 * Random UUID interface
1470 *
1471 * Used here for a Boot ID, but can be useful for other kernel
1472 * drivers.
1473 ***************************************************************/
1474
1475/*
1476 * Generate random UUID
1477 */
1478void generate_random_uuid(unsigned char uuid_out[16])
1479{
1480 get_random_bytes(uuid_out, 16);
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05001481 /* Set UUID version to 4 --- truly random generation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1483 /* Set the UUID variant to DCE */
1484 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1485}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486EXPORT_SYMBOL(generate_random_uuid);
1487
1488/********************************************************************
1489 *
1490 * Sysctl interface
1491 *
1492 ********************************************************************/
1493
1494#ifdef CONFIG_SYSCTL
1495
1496#include <linux/sysctl.h>
1497
1498static int min_read_thresh = 8, min_write_thresh;
1499static int max_read_thresh = INPUT_POOL_WORDS * 32;
1500static int max_write_thresh = INPUT_POOL_WORDS * 32;
1501static char sysctl_bootid[16];
1502
1503/*
1504 * These functions is used to return both the bootid UUID, and random
1505 * UUID. The difference is in whether table->data is NULL; if it is,
1506 * then a new UUID is generated and returned to the user.
1507 *
1508 * If the user accesses this via the proc interface, it will be returned
1509 * as an ASCII string in the standard UUID format. If accesses via the
1510 * sysctl system call, it is returned as 16 bytes of binary data.
1511 */
Joe Perchesa1514272013-06-13 19:37:35 -07001512static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 void __user *buffer, size_t *lenp, loff_t *ppos)
1514{
Joe Perchesa1514272013-06-13 19:37:35 -07001515 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 unsigned char buf[64], tmp_uuid[16], *uuid;
1517
1518 uuid = table->data;
1519 if (!uuid) {
1520 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001522 } else {
1523 static DEFINE_SPINLOCK(bootid_spinlock);
1524
1525 spin_lock(&bootid_spinlock);
1526 if (!uuid[8])
1527 generate_random_uuid(uuid);
1528 spin_unlock(&bootid_spinlock);
1529 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Joe Perches35900772009-12-14 18:01:11 -08001531 sprintf(buf, "%pU", uuid);
1532
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 fake_table.data = buf;
1534 fake_table.maxlen = sizeof(buf);
1535
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001536 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537}
1538
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001539/*
1540 * Return entropy available scaled to integral bits
1541 */
1542static int proc_do_entropy(ctl_table *table, int write,
1543 void __user *buffer, size_t *lenp, loff_t *ppos)
1544{
1545 ctl_table fake_table;
1546 int entropy_count;
1547
1548 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
1549
1550 fake_table.data = &entropy_count;
1551 fake_table.maxlen = sizeof(entropy_count);
1552
1553 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1554}
1555
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07001557extern struct ctl_table random_table[];
1558struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 .procname = "poolsize",
1561 .data = &sysctl_poolsize,
1562 .maxlen = sizeof(int),
1563 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001564 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 },
1566 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 .procname = "entropy_avail",
1568 .maxlen = sizeof(int),
1569 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001570 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 .data = &input_pool.entropy_count,
1572 },
1573 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 .procname = "read_wakeup_threshold",
1575 .data = &random_read_wakeup_thresh,
1576 .maxlen = sizeof(int),
1577 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001578 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 .extra1 = &min_read_thresh,
1580 .extra2 = &max_read_thresh,
1581 },
1582 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 .procname = "write_wakeup_threshold",
1584 .data = &random_write_wakeup_thresh,
1585 .maxlen = sizeof(int),
1586 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001587 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 .extra1 = &min_write_thresh,
1589 .extra2 = &max_write_thresh,
1590 },
1591 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04001592 .procname = "urandom_min_reseed_secs",
1593 .data = &random_min_urandom_seed,
1594 .maxlen = sizeof(int),
1595 .mode = 0644,
1596 .proc_handler = proc_dointvec,
1597 },
1598 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 .procname = "boot_id",
1600 .data = &sysctl_bootid,
1601 .maxlen = 16,
1602 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001603 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 },
1605 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 .procname = "uuid",
1607 .maxlen = 16,
1608 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001609 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 },
Eric W. Biederman894d2492009-11-05 14:34:02 -08001611 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612};
1613#endif /* CONFIG_SYSCTL */
1614
David S. Miller6e5714e2011-08-03 20:50:44 -07001615static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616
Theodore Ts'o47d06e52013-09-10 10:52:35 -04001617int random_int_secret_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618{
David S. Miller6e5714e2011-08-03 20:50:44 -07001619 get_random_bytes(random_int_secret, sizeof(random_int_secret));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 return 0;
1621}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
1623/*
1624 * Get a random word for internal kernel use only. Similar to urandom but
1625 * with the goal of minimal entropy pool depletion. As a result, the random
1626 * value is not cryptographically secure but for several uses the cost of
1627 * depleting entropy is too high
1628 */
Theodore Ts'o74feec52012-07-06 14:03:18 -04001629static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630unsigned int get_random_int(void)
1631{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001632 __u32 *hash;
David S. Miller6e5714e2011-08-03 20:50:44 -07001633 unsigned int ret;
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001634
H. Peter Anvin63d77172011-07-31 13:54:50 -07001635 if (arch_get_random_int(&ret))
1636 return ret;
1637
1638 hash = get_cpu_var(get_random_int_hash);
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001639
Theodore Ts'o61875f32013-09-21 13:58:22 -04001640 hash[0] += current->pid + jiffies + random_get_entropy();
David S. Miller6e5714e2011-08-03 20:50:44 -07001641 md5_transform(hash, random_int_secret);
1642 ret = hash[0];
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001643 put_cpu_var(get_random_int_hash);
1644
1645 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646}
Andy Shevchenko16c7fa02013-04-30 15:27:30 -07001647EXPORT_SYMBOL(get_random_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
1649/*
1650 * randomize_range() returns a start address such that
1651 *
1652 * [...... <range> .....]
1653 * start end
1654 *
1655 * a <range> with size "len" starting at the return value is inside in the
1656 * area defined by [start, end], but is otherwise randomized.
1657 */
1658unsigned long
1659randomize_range(unsigned long start, unsigned long end, unsigned long len)
1660{
1661 unsigned long range = end - len - start;
1662
1663 if (end <= start + len)
1664 return 0;
1665 return PAGE_ALIGN(get_random_int() % range + start);
1666}