blob: 2c532a6b0a219f53244ee0ef2c0fdb08195027e8 [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>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200259#include <linux/irq.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261#include <asm/processor.h>
262#include <asm/uaccess.h>
263#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400264#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265#include <asm/io.h>
266
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400267#define CREATE_TRACE_POINTS
268#include <trace/events/random.h>
269
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270/*
271 * Configuration information
272 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400273#define INPUT_POOL_SHIFT 12
274#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
275#define OUTPUT_POOL_SHIFT 10
276#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
277#define SEC_XFER_SIZE 512
278#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
Theodore Ts'o392a5462013-11-03 18:24:08 -0500280#define DEBUG_RANDOM_BOOT 0
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 */
Theodore Ts'o6265e162013-10-03 01:08:15 -0400305static int random_write_wakeup_thresh = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307/*
Greg Pricedfd38752013-11-29 14:58:06 -0500308 * The minimum number of seconds between urandom pool reseeding. We
Theodore Ts'of5c27422013-09-22 15:14:32 -0400309 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400312static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400320 * 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
Greg Pricedfd38752013-11-29 14:58:06 -0500325 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400326 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 *
328 * Thanks to Colin Plumb for suggesting this.
329 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400330 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 * decrease the uncertainty).
346 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400347 * 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359static 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};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399/*
400 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406/**********************************************************************
407 *
408 * OS independent entropy store. Here are the functions which handle
409 * storing entropy in an entropy pool.
410 *
411 **********************************************************************/
412
413struct entropy_store;
414struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700415 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400416 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 __u32 *pool;
418 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400420 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400423 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700424 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400425 unsigned short add_ptr;
426 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800427 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400428 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400429 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400430 unsigned int limit:1;
431 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000432 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433};
434
Theodore Ts'o6265e162013-10-03 01:08:15 -0400435static void push_to_pool(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436static __u32 input_pool_data[INPUT_POOL_WORDS];
437static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
438static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
439
440static struct entropy_store input_pool = {
441 .poolinfo = &poolinfo_table[0],
442 .name = "input",
443 .limit = 1,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200444 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 .pool = input_pool_data
446};
447
448static struct entropy_store blocking_pool = {
449 .poolinfo = &poolinfo_table[1],
450 .name = "blocking",
451 .limit = 1,
452 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200453 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400454 .pool = blocking_pool_data,
455 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
456 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457};
458
459static struct entropy_store nonblocking_pool = {
460 .poolinfo = &poolinfo_table[1],
461 .name = "nonblocking",
462 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200463 .lock = __SPIN_LOCK_UNLOCKED(nonblocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400464 .pool = nonblocking_pool_data,
465 .push_work = __WORK_INITIALIZER(nonblocking_pool.push_work,
466 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467};
468
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400469static __u32 const twist_table[8] = {
470 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
471 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
472
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700474 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700476 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 *
478 * The pool is stirred with a primitive polynomial of the appropriate
479 * degree, and then twisted. We twist by three bits at a time because
480 * it's cheap to do so and helps slightly in the expected case where
481 * the entropy is concentrated in the low-order bits.
482 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400483static void _mix_pool_bytes(struct entropy_store *r, const void *in,
484 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485{
Matt Mackall993ba212008-04-29 01:03:04 -0700486 unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700487 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700489 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700490 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 tap1 = r->poolinfo->tap1;
493 tap2 = r->poolinfo->tap2;
494 tap3 = r->poolinfo->tap3;
495 tap4 = r->poolinfo->tap4;
496 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
Theodore Ts'o902c0982012-07-04 10:38:30 -0400498 smp_rmb();
499 input_rotate = ACCESS_ONCE(r->input_rotate);
500 i = ACCESS_ONCE(r->add_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
Matt Mackalle68e5b62008-04-29 01:03:05 -0700502 /* mix one byte at a time to simplify size handling and churn faster */
503 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400504 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700505 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
507 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700508 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 w ^= r->pool[(i + tap1) & wordmask];
510 w ^= r->pool[(i + tap2) & wordmask];
511 w ^= r->pool[(i + tap3) & wordmask];
512 w ^= r->pool[(i + tap4) & wordmask];
513 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700514
515 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700517
518 /*
519 * Normally, we add 7 bits of rotation to the pool.
520 * At the beginning of the pool, add an extra 7 bits
521 * rotation, so that successive passes spread the
522 * input bits across the pool evenly.
523 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400524 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 }
526
Theodore Ts'o902c0982012-07-04 10:38:30 -0400527 ACCESS_ONCE(r->input_rotate) = input_rotate;
528 ACCESS_ONCE(r->add_ptr) = i;
529 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Matt Mackall993ba212008-04-29 01:03:04 -0700531 if (out)
532 for (j = 0; j < 16; j++)
Matt Mackalle68e5b62008-04-29 01:03:05 -0700533 ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534}
535
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400536static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o902c0982012-07-04 10:38:30 -0400537 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400539 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
540 _mix_pool_bytes(r, in, nbytes, out);
541}
542
543static void mix_pool_bytes(struct entropy_store *r, const void *in,
544 int nbytes, __u8 out[64])
545{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400546 unsigned long flags;
547
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400548 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400549 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400550 _mix_pool_bytes(r, in, nbytes, out);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400551 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552}
553
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400554struct fast_pool {
555 __u32 pool[4];
556 unsigned long last;
557 unsigned short count;
558 unsigned char rotate;
559 unsigned char last_timer_intr;
560};
561
562/*
563 * This is a fast mixing routine used by the interrupt randomness
564 * collector. It's hardcoded for an 128 bit pool and assumes that any
565 * locks that might be needed are taken by the caller.
566 */
Theodore Ts'o655b2262013-09-22 15:24:02 -0400567static void fast_mix(struct fast_pool *f, __u32 input[4])
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400568{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400569 __u32 w;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400570 unsigned input_rotate = f->rotate;
571
Theodore Ts'o655b2262013-09-22 15:24:02 -0400572 w = rol32(input[0], input_rotate) ^ f->pool[0] ^ f->pool[3];
573 f->pool[0] = (w >> 3) ^ twist_table[w & 7];
574 input_rotate = (input_rotate + 14) & 31;
575 w = rol32(input[1], input_rotate) ^ f->pool[1] ^ f->pool[0];
576 f->pool[1] = (w >> 3) ^ twist_table[w & 7];
577 input_rotate = (input_rotate + 7) & 31;
578 w = rol32(input[2], input_rotate) ^ f->pool[2] ^ f->pool[1];
579 f->pool[2] = (w >> 3) ^ twist_table[w & 7];
580 input_rotate = (input_rotate + 7) & 31;
581 w = rol32(input[3], input_rotate) ^ f->pool[3] ^ f->pool[2];
582 f->pool[3] = (w >> 3) ^ twist_table[w & 7];
583 input_rotate = (input_rotate + 7) & 31;
584
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400585 f->rotate = input_rotate;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400586 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400587}
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400590 * Credit (or debit) the entropy store with n bits of entropy.
591 * Use credit_entropy_bits_safe() if the value comes from userspace
592 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700594static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400596 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400597 const int pool_size = r->poolinfo->poolfracbits;
598 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Matt Mackalladc782d2008-04-29 01:03:07 -0700600 if (!nbits)
601 return;
602
Theodore Ts'o902c0982012-07-04 10:38:30 -0400603retry:
604 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400605 if (nfrac < 0) {
606 /* Debit */
607 entropy_count += nfrac;
608 } else {
609 /*
610 * Credit: we have to account for the possibility of
611 * overwriting already present entropy. Even in the
612 * ideal case of pure Shannon entropy, new contributions
613 * approach the full value asymptotically:
614 *
615 * entropy <- entropy + (pool_size - entropy) *
616 * (1 - exp(-add_entropy/pool_size))
617 *
618 * For add_entropy <= pool_size/2 then
619 * (1 - exp(-add_entropy/pool_size)) >=
620 * (add_entropy/pool_size)*0.7869...
621 * so we can approximate the exponential with
622 * 3/4*add_entropy/pool_size and still be on the
623 * safe side by adding at most pool_size/2 at a time.
624 *
625 * The use of pool_size-2 in the while statement is to
626 * prevent rounding artifacts from making the loop
627 * arbitrarily long; this limits the loop to log2(pool_size)*2
628 * turns no matter how large nbits is.
629 */
630 int pnfrac = nfrac;
631 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
632 /* The +2 corresponds to the /4 in the denominator */
633
634 do {
635 unsigned int anfrac = min(pnfrac, pool_size/2);
636 unsigned int add =
637 ((pool_size - entropy_count)*anfrac*3) >> s;
638
639 entropy_count += add;
640 pnfrac -= anfrac;
641 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
642 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400643
Andrew Morton8b76f462008-09-02 14:36:14 -0700644 if (entropy_count < 0) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400645 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
646 r->name, entropy_count);
647 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700648 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400649 } else if (entropy_count > pool_size)
650 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400651 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
652 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Theodore Ts'o6265e162013-10-03 01:08:15 -0400654 r->entropy_total += nbits;
Linus Torvalds0891ad82013-11-16 10:19:15 -0800655 if (!r->initialized && r->entropy_total > 128) {
656 r->initialized = 1;
657 r->entropy_total = 0;
658 if (r == &nonblocking_pool) {
659 prandom_reseed_late();
660 pr_notice("random: %s pool is initialized\n", r->name);
Hannes Frederic Sowa4af712e2013-11-11 12:20:34 +0100661 }
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400662 }
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
Theodore Ts'o6265e162013-10-03 01:08:15 -0400668 if (r == &input_pool) {
669 int entropy_bytes = entropy_count >> ENTROPY_SHIFT;
670
671 /* should we wake readers? */
672 if (entropy_bytes >= random_read_wakeup_thresh) {
673 wake_up_interruptible(&random_read_wait);
674 kill_fasync(&fasync, SIGIO, POLL_IN);
675 }
676 /* If the input pool is getting full, send some
677 * entropy to the two output pools, flipping back and
678 * forth between them, until the output pools are 75%
679 * full.
680 */
681 if (entropy_bytes > random_write_wakeup_thresh &&
682 r->initialized &&
683 r->entropy_total >= 2*random_read_wakeup_thresh) {
684 static struct entropy_store *last = &blocking_pool;
685 struct entropy_store *other = &blocking_pool;
686
687 if (last == &blocking_pool)
688 other = &nonblocking_pool;
689 if (other->entropy_count <=
690 3 * other->poolinfo->poolfracbits / 4)
691 last = other;
692 if (last->entropy_count <=
693 3 * last->poolinfo->poolfracbits / 4) {
694 schedule_work(&last->push_work);
695 r->entropy_total = 0;
696 }
697 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700698 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699}
700
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400701static void credit_entropy_bits_safe(struct entropy_store *r, int nbits)
702{
703 const int nbits_max = (int)(~0U >> (ENTROPY_SHIFT + 1));
704
705 /* Cap the value to avoid overflows */
706 nbits = min(nbits, nbits_max);
707 nbits = max(nbits, -nbits_max);
708
709 credit_entropy_bits(r, nbits);
710}
711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712/*********************************************************************
713 *
714 * Entropy input management
715 *
716 *********************************************************************/
717
718/* There is one of these per entropy source */
719struct timer_rand_state {
720 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -0700721 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 unsigned dont_count_entropy:1;
723};
724
Theodore Ts'o644008d2013-11-03 16:40:53 -0500725#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
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
Theodore Ts'o644008d2013-11-03 16:40:53 -0500753static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700754
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{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 __u32 tmp[OUTPUT_POOL_WORDS];
926
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;
Matt Mackall5a021e92007-07-19 11:30:14 -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));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
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}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
Theodore Ts'o6265e162013-10-03 01:08:15 -0400944/*
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/*
Greg Price19fa5be2013-11-29 15:50:06 -0500961 * This function decides how many bytes to actually take from the
962 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964static size_t account(struct entropy_store *r, size_t nbytes, int min,
965 int reserved)
966{
967 unsigned long flags;
Theodore Ts'ob9809552013-03-04 11:59:12 -0500968 int wakeup_write = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400969 int have_bytes;
970 int entropy_count, orig;
971 size_t ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 /* Hold lock while accounting */
974 spin_lock_irqsave(&r->lock, flags);
975
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400976 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
978 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -0700979retry:
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400980 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
981 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
982 ibytes = nbytes;
983 if (have_bytes < min + reserved) {
984 ibytes = 0;
985 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 /* If limited, never pull more than available */
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400987 if (r->limit && ibytes + reserved >= have_bytes)
988 ibytes = have_bytes - reserved;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400990 if (have_bytes >= ibytes + reserved)
991 entropy_count -= ibytes << (ENTROPY_SHIFT + 3);
992 else
993 entropy_count = reserved << (ENTROPY_SHIFT + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400995 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
996 goto retry;
997
998 if ((r->entropy_count >> ENTROPY_SHIFT)
999 < random_write_wakeup_thresh)
Theodore Ts'ob9809552013-03-04 11:59:12 -05001000 wakeup_write = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 spin_unlock_irqrestore(&r->lock, flags);
1003
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001004 trace_debit_entropy(r->name, 8 * ibytes);
Theodore Ts'ob9809552013-03-04 11:59:12 -05001005 if (wakeup_write) {
1006 wake_up_interruptible(&random_write_wait);
1007 kill_fasync(&fasync, SIGIO, POLL_OUT);
1008 }
1009
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001010 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011}
1012
Greg Price19fa5be2013-11-29 15:50:06 -05001013/*
1014 * This function does the actual extraction for extract_entropy and
1015 * extract_entropy_user.
1016 *
1017 * Note: we assume that .poolwords is a multiple of 16 words.
1018 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019static void extract_buf(struct entropy_store *r, __u8 *out)
1020{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001021 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001022 union {
1023 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001024 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001025 } hash;
1026 __u32 workspace[SHA_WORKSPACE_WORDS];
Matt Mackalle68e5b62008-04-29 01:03:05 -07001027 __u8 extract[64];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001028 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001030 /* Generate a hash across the pool, 16 words (512 bits) at a time */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001031 sha_init(hash.w);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001032 spin_lock_irqsave(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001033 for (i = 0; i < r->poolinfo->poolwords; i += 16)
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001034 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
1036 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001037 * If we have an architectural hardware random number
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001038 * generator, mix that in, too.
1039 */
1040 for (i = 0; i < LONGS(20); i++) {
1041 unsigned long v;
1042 if (!arch_get_random_long(&v))
1043 break;
1044 hash.l[i] ^= v;
1045 }
1046
1047 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001048 * We mix the hash back into the pool to prevent backtracking
1049 * attacks (where the attacker knows the state of the pool
1050 * plus the current outputs, and attempts to find previous
1051 * ouputs), unless the hash function can be inverted. By
1052 * mixing at least a SHA1 worth of hash data back, we make
1053 * brute-forcing the feedback as hard as brute-forcing the
1054 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001056 __mix_pool_bytes(r, hash.w, sizeof(hash.w), extract);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001057 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001058
1059 /*
1060 * To avoid duplicates, we atomically extract a portion of the
1061 * pool while mixing, and hash one final time.
1062 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001063 sha_transform(hash.w, extract, workspace);
Matt Mackallffd8d3f2008-04-29 01:02:59 -07001064 memset(extract, 0, sizeof(extract));
1065 memset(workspace, 0, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
1067 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001068 * In case the hash function has some recognizable output
1069 * pattern, we fold it in half. Thus, we always feed back
1070 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001072 hash.w[0] ^= hash.w[3];
1073 hash.w[1] ^= hash.w[4];
1074 hash.w[2] ^= rol32(hash.w[2], 16);
1075
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001076 memcpy(out, &hash, EXTRACT_SIZE);
1077 memset(&hash, 0, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078}
1079
Greg Price19fa5be2013-11-29 15:50:06 -05001080/*
1081 * This function extracts randomness from the "entropy pool", and
1082 * returns it in a buffer.
1083 *
1084 * The min parameter specifies the minimum amount we can pull before
1085 * failing to avoid races that defeat catastrophic reseeding while the
1086 * reserved parameter indicates how much entropy we must leave in the
1087 * pool after each pull to avoid starving other readers.
1088 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001089static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001090 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091{
1092 ssize_t ret = 0, i;
1093 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001094 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001096 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001097 if (fips_enabled) {
1098 spin_lock_irqsave(&r->lock, flags);
1099 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001100 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001101 spin_unlock_irqrestore(&r->lock, flags);
1102 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001103 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001104 xfer_secondary_pool(r, EXTRACT_SIZE);
1105 extract_buf(r, tmp);
1106 spin_lock_irqsave(&r->lock, flags);
1107 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1108 }
1109 spin_unlock_irqrestore(&r->lock, flags);
1110 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001111
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001112 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 xfer_secondary_pool(r, nbytes);
1114 nbytes = account(r, nbytes, min, reserved);
1115
1116 while (nbytes) {
1117 extract_buf(r, tmp);
Neil Horman5b739ef2009-06-18 19:50:21 +08001118
Matt Mackalle954bc92010-05-20 19:55:01 +10001119 if (fips_enabled) {
Neil Horman5b739ef2009-06-18 19:50:21 +08001120 spin_lock_irqsave(&r->lock, flags);
1121 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1122 panic("Hardware RNG duplicated output!\n");
1123 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1124 spin_unlock_irqrestore(&r->lock, flags);
1125 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 i = min_t(int, nbytes, EXTRACT_SIZE);
1127 memcpy(buf, tmp, i);
1128 nbytes -= i;
1129 buf += i;
1130 ret += i;
1131 }
1132
1133 /* Wipe data just returned from memory */
1134 memset(tmp, 0, sizeof(tmp));
1135
1136 return ret;
1137}
1138
Greg Price19fa5be2013-11-29 15:50:06 -05001139/*
1140 * This function extracts randomness from the "entropy pool", and
1141 * returns it in a userspace buffer.
1142 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1144 size_t nbytes)
1145{
1146 ssize_t ret = 0, i;
1147 __u8 tmp[EXTRACT_SIZE];
1148
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001149 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 xfer_secondary_pool(r, nbytes);
1151 nbytes = account(r, nbytes, 0, 0);
1152
1153 while (nbytes) {
1154 if (need_resched()) {
1155 if (signal_pending(current)) {
1156 if (ret == 0)
1157 ret = -ERESTARTSYS;
1158 break;
1159 }
1160 schedule();
1161 }
1162
1163 extract_buf(r, tmp);
1164 i = min_t(int, nbytes, EXTRACT_SIZE);
1165 if (copy_to_user(buf, tmp, i)) {
1166 ret = -EFAULT;
1167 break;
1168 }
1169
1170 nbytes -= i;
1171 buf += i;
1172 ret += i;
1173 }
1174
1175 /* Wipe data just returned from memory */
1176 memset(tmp, 0, sizeof(tmp));
1177
1178 return ret;
1179}
1180
1181/*
1182 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001183 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001184 * TCP sequence numbers, etc. It does not rely on the hardware random
1185 * number generator. For random bytes direct from the hardware RNG
1186 * (when available), use get_random_bytes_arch().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 */
1188void get_random_bytes(void *buf, int nbytes)
1189{
Theodore Ts'o392a5462013-11-03 18:24:08 -05001190#if DEBUG_RANDOM_BOOT > 0
1191 if (unlikely(nonblocking_pool.initialized == 0))
1192 printk(KERN_NOTICE "random: %pF get_random_bytes called "
1193 "with %d bits of entropy available\n",
1194 (void *) _RET_IP_,
1195 nonblocking_pool.entropy_total);
1196#endif
Theodore Ts'o59108952013-09-12 14:10:25 -04001197 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001198 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
1199}
1200EXPORT_SYMBOL(get_random_bytes);
1201
1202/*
1203 * This function will use the architecture-specific hardware random
1204 * number generator if it is available. The arch-specific hw RNG will
1205 * almost certainly be faster than what we can do in software, but it
1206 * is impossible to verify that it is implemented securely (as
1207 * opposed, to, say, the AES encryption of a sequence number using a
1208 * key known by the NSA). So it's useful if we need the speed, but
1209 * only if we're willing to trust the hardware manufacturer not to
1210 * have put in a back door.
1211 */
1212void get_random_bytes_arch(void *buf, int nbytes)
1213{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001214 char *p = buf;
1215
Theodore Ts'o59108952013-09-12 14:10:25 -04001216 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001217 while (nbytes) {
1218 unsigned long v;
1219 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001220
H. Peter Anvin63d77172011-07-31 13:54:50 -07001221 if (!arch_get_random_long(&v))
1222 break;
1223
Luck, Tonybd29e562011-11-16 10:50:56 -08001224 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001225 p += chunk;
1226 nbytes -= chunk;
1227 }
1228
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001229 if (nbytes)
1230 extract_entropy(&nonblocking_pool, p, nbytes, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001232EXPORT_SYMBOL(get_random_bytes_arch);
1233
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
1235/*
1236 * init_std_data - initialize pool with system data
1237 *
1238 * @r: pool to initialize
1239 *
1240 * This function clears the pool's entropy count and mixes some system
1241 * data into the pool to prepare it for use. The pool is not cleared
1242 * as that can only decrease the entropy in the pool.
1243 */
1244static void init_std_data(struct entropy_store *r)
1245{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001246 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001247 ktime_t now = ktime_get_real();
1248 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249
Theodore Ts'of5c27422013-09-22 15:14:32 -04001250 r->last_pulled = jiffies;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001251 mix_pool_bytes(r, &now, sizeof(now), NULL);
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001252 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
Theodore Ts'o902c0982012-07-04 10:38:30 -04001253 if (!arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001254 rv = random_get_entropy();
Theodore Ts'o902c0982012-07-04 10:38:30 -04001255 mix_pool_bytes(r, &rv, sizeof(rv), NULL);
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001256 }
Theodore Ts'o902c0982012-07-04 10:38:30 -04001257 mix_pool_bytes(r, utsname(), sizeof(*(utsname())), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258}
1259
Tony Luckcbc96b72012-07-23 09:47:57 -07001260/*
1261 * Note that setup_arch() may call add_device_randomness()
1262 * long before we get here. This allows seeding of the pools
1263 * with some platform dependent data very early in the boot
1264 * process. But it limits our options here. We must use
1265 * statically allocated structures that already have all
1266 * initializations complete at compile time. We should also
1267 * take care not to overwrite the precious per platform data
1268 * we were given.
1269 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001270static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271{
1272 init_std_data(&input_pool);
1273 init_std_data(&blocking_pool);
1274 init_std_data(&nonblocking_pool);
1275 return 0;
1276}
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001277early_initcall(rand_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278
David Howells93614012006-09-30 20:45:40 +02001279#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280void rand_initialize_disk(struct gendisk *disk)
1281{
1282 struct timer_rand_state *state;
1283
1284 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001285 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 * source.
1287 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001288 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001289 if (state) {
1290 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001292 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293}
David Howells93614012006-09-30 20:45:40 +02001294#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
1296static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001297random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298{
Greg Price12ff3a52013-11-29 15:02:33 -05001299 ssize_t n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
1301 if (nbytes == 0)
1302 return 0;
1303
Greg Price12ff3a52013-11-29 15:02:33 -05001304 nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1305 while (1) {
1306 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1307 if (n < 0)
1308 return n;
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001309 trace_random_read(n*8, (nbytes-n)*8,
1310 ENTROPY_BITS(&blocking_pool),
1311 ENTROPY_BITS(&input_pool));
Greg Price12ff3a52013-11-29 15:02:33 -05001312 if (n > 0)
1313 return n;
1314 /* Pool is (near) empty. Maybe wait and retry. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315
Greg Price12ff3a52013-11-29 15:02:33 -05001316 if (file->f_flags & O_NONBLOCK)
1317 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
Greg Price12ff3a52013-11-29 15:02:33 -05001319 wait_event_interruptible(random_read_wait,
1320 ENTROPY_BITS(&input_pool) >=
1321 random_read_wakeup_thresh);
1322 if (signal_pending(current))
1323 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325}
1326
1327static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001328urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329{
Theodore Ts'o301f0592013-11-03 06:54:51 -05001330 int ret;
1331
1332 if (unlikely(nonblocking_pool.initialized == 0))
1333 printk_once(KERN_NOTICE "random: %s urandom read "
1334 "with %d bits of entropy available\n",
1335 current->comm, nonblocking_pool.entropy_total);
1336
1337 ret = extract_entropy_user(&nonblocking_pool, buf, nbytes);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001338
1339 trace_urandom_read(8 * nbytes, ENTROPY_BITS(&nonblocking_pool),
1340 ENTROPY_BITS(&input_pool));
1341 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342}
1343
1344static unsigned int
1345random_poll(struct file *file, poll_table * wait)
1346{
1347 unsigned int mask;
1348
1349 poll_wait(file, &random_read_wait, wait);
1350 poll_wait(file, &random_write_wait, wait);
1351 mask = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001352 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 mask |= POLLIN | POLLRDNORM;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001354 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 mask |= POLLOUT | POLLWRNORM;
1356 return mask;
1357}
1358
Matt Mackall7f397dc2007-05-29 21:58:10 -05001359static int
1360write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1361{
1362 size_t bytes;
1363 __u32 buf[16];
1364 const char __user *p = buffer;
1365
1366 while (count > 0) {
1367 bytes = min(count, sizeof(buf));
1368 if (copy_from_user(&buf, p, bytes))
1369 return -EFAULT;
1370
1371 count -= bytes;
1372 p += bytes;
1373
Theodore Ts'o902c0982012-07-04 10:38:30 -04001374 mix_pool_bytes(r, buf, bytes, NULL);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001375 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001376 }
1377
1378 return 0;
1379}
1380
Matt Mackall90b75ee2008-04-29 01:02:55 -07001381static ssize_t random_write(struct file *file, const char __user *buffer,
1382 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001384 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Matt Mackall7f397dc2007-05-29 21:58:10 -05001386 ret = write_pool(&blocking_pool, buffer, count);
1387 if (ret)
1388 return ret;
1389 ret = write_pool(&nonblocking_pool, buffer, count);
1390 if (ret)
1391 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Matt Mackall7f397dc2007-05-29 21:58:10 -05001393 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394}
1395
Matt Mackall43ae4862008-04-29 01:02:58 -07001396static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397{
1398 int size, ent_count;
1399 int __user *p = (int __user *)arg;
1400 int retval;
1401
1402 switch (cmd) {
1403 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001404 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001405 ent_count = ENTROPY_BITS(&input_pool);
1406 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 return -EFAULT;
1408 return 0;
1409 case RNDADDTOENTCNT:
1410 if (!capable(CAP_SYS_ADMIN))
1411 return -EPERM;
1412 if (get_user(ent_count, p))
1413 return -EFAULT;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001414 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 return 0;
1416 case RNDADDENTROPY:
1417 if (!capable(CAP_SYS_ADMIN))
1418 return -EPERM;
1419 if (get_user(ent_count, p++))
1420 return -EFAULT;
1421 if (ent_count < 0)
1422 return -EINVAL;
1423 if (get_user(size, p++))
1424 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001425 retval = write_pool(&input_pool, (const char __user *)p,
1426 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 if (retval < 0)
1428 return retval;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001429 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 return 0;
1431 case RNDZAPENTCNT:
1432 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001433 /*
1434 * Clear the entropy pool counters. We no longer clear
1435 * the entropy pool, as that's silly.
1436 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 if (!capable(CAP_SYS_ADMIN))
1438 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001439 input_pool.entropy_count = 0;
1440 nonblocking_pool.entropy_count = 0;
1441 blocking_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 return 0;
1443 default:
1444 return -EINVAL;
1445 }
1446}
1447
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001448static int random_fasync(int fd, struct file *filp, int on)
1449{
1450 return fasync_helper(fd, filp, on, &fasync);
1451}
1452
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001453const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 .read = random_read,
1455 .write = random_write,
1456 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001457 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001458 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001459 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460};
1461
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001462const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 .read = urandom_read,
1464 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001465 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001466 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001467 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468};
1469
1470/***************************************************************
1471 * Random UUID interface
1472 *
1473 * Used here for a Boot ID, but can be useful for other kernel
1474 * drivers.
1475 ***************************************************************/
1476
1477/*
1478 * Generate random UUID
1479 */
1480void generate_random_uuid(unsigned char uuid_out[16])
1481{
1482 get_random_bytes(uuid_out, 16);
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05001483 /* Set UUID version to 4 --- truly random generation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1485 /* Set the UUID variant to DCE */
1486 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1487}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488EXPORT_SYMBOL(generate_random_uuid);
1489
1490/********************************************************************
1491 *
1492 * Sysctl interface
1493 *
1494 ********************************************************************/
1495
1496#ifdef CONFIG_SYSCTL
1497
1498#include <linux/sysctl.h>
1499
1500static int min_read_thresh = 8, min_write_thresh;
1501static int max_read_thresh = INPUT_POOL_WORDS * 32;
1502static int max_write_thresh = INPUT_POOL_WORDS * 32;
1503static char sysctl_bootid[16];
1504
1505/*
Greg Pricef22052b2013-11-29 14:58:16 -05001506 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 * UUID. The difference is in whether table->data is NULL; if it is,
1508 * then a new UUID is generated and returned to the user.
1509 *
Greg Pricef22052b2013-11-29 14:58:16 -05001510 * If the user accesses this via the proc interface, the UUID will be
1511 * returned as an ASCII string in the standard UUID format; if via the
1512 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 */
Joe Perchesa1514272013-06-13 19:37:35 -07001514static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 void __user *buffer, size_t *lenp, loff_t *ppos)
1516{
Joe Perchesa1514272013-06-13 19:37:35 -07001517 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 unsigned char buf[64], tmp_uuid[16], *uuid;
1519
1520 uuid = table->data;
1521 if (!uuid) {
1522 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001524 } else {
1525 static DEFINE_SPINLOCK(bootid_spinlock);
1526
1527 spin_lock(&bootid_spinlock);
1528 if (!uuid[8])
1529 generate_random_uuid(uuid);
1530 spin_unlock(&bootid_spinlock);
1531 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Joe Perches35900772009-12-14 18:01:11 -08001533 sprintf(buf, "%pU", uuid);
1534
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 fake_table.data = buf;
1536 fake_table.maxlen = sizeof(buf);
1537
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001538 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539}
1540
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001541/*
1542 * Return entropy available scaled to integral bits
1543 */
1544static int proc_do_entropy(ctl_table *table, int write,
1545 void __user *buffer, size_t *lenp, loff_t *ppos)
1546{
1547 ctl_table fake_table;
1548 int entropy_count;
1549
1550 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
1551
1552 fake_table.data = &entropy_count;
1553 fake_table.maxlen = sizeof(entropy_count);
1554
1555 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1556}
1557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07001559extern struct ctl_table random_table[];
1560struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 .procname = "poolsize",
1563 .data = &sysctl_poolsize,
1564 .maxlen = sizeof(int),
1565 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001566 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 },
1568 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 .procname = "entropy_avail",
1570 .maxlen = sizeof(int),
1571 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001572 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 .data = &input_pool.entropy_count,
1574 },
1575 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 .procname = "read_wakeup_threshold",
1577 .data = &random_read_wakeup_thresh,
1578 .maxlen = sizeof(int),
1579 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001580 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 .extra1 = &min_read_thresh,
1582 .extra2 = &max_read_thresh,
1583 },
1584 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 .procname = "write_wakeup_threshold",
1586 .data = &random_write_wakeup_thresh,
1587 .maxlen = sizeof(int),
1588 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001589 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 .extra1 = &min_write_thresh,
1591 .extra2 = &max_write_thresh,
1592 },
1593 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04001594 .procname = "urandom_min_reseed_secs",
1595 .data = &random_min_urandom_seed,
1596 .maxlen = sizeof(int),
1597 .mode = 0644,
1598 .proc_handler = proc_dointvec,
1599 },
1600 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 .procname = "boot_id",
1602 .data = &sysctl_bootid,
1603 .maxlen = 16,
1604 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001605 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 },
1607 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 .procname = "uuid",
1609 .maxlen = 16,
1610 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001611 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 },
Eric W. Biederman894d2492009-11-05 14:34:02 -08001613 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614};
1615#endif /* CONFIG_SYSCTL */
1616
David S. Miller6e5714e2011-08-03 20:50:44 -07001617static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
Theodore Ts'o47d06e52013-09-10 10:52:35 -04001619int random_int_secret_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620{
David S. Miller6e5714e2011-08-03 20:50:44 -07001621 get_random_bytes(random_int_secret, sizeof(random_int_secret));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 return 0;
1623}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
1625/*
1626 * Get a random word for internal kernel use only. Similar to urandom but
1627 * with the goal of minimal entropy pool depletion. As a result, the random
1628 * value is not cryptographically secure but for several uses the cost of
1629 * depleting entropy is too high
1630 */
Theodore Ts'o74feec52012-07-06 14:03:18 -04001631static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632unsigned int get_random_int(void)
1633{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001634 __u32 *hash;
David S. Miller6e5714e2011-08-03 20:50:44 -07001635 unsigned int ret;
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001636
H. Peter Anvin63d77172011-07-31 13:54:50 -07001637 if (arch_get_random_int(&ret))
1638 return ret;
1639
1640 hash = get_cpu_var(get_random_int_hash);
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001641
Theodore Ts'o61875f32013-09-21 13:58:22 -04001642 hash[0] += current->pid + jiffies + random_get_entropy();
David S. Miller6e5714e2011-08-03 20:50:44 -07001643 md5_transform(hash, random_int_secret);
1644 ret = hash[0];
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001645 put_cpu_var(get_random_int_hash);
1646
1647 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648}
Andy Shevchenko16c7fa02013-04-30 15:27:30 -07001649EXPORT_SYMBOL(get_random_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
1651/*
1652 * randomize_range() returns a start address such that
1653 *
1654 * [...... <range> .....]
1655 * start end
1656 *
1657 * a <range> with size "len" starting at the return value is inside in the
1658 * area defined by [start, end], but is otherwise randomized.
1659 */
1660unsigned long
1661randomize_range(unsigned long start, unsigned long end, unsigned long len)
1662{
1663 unsigned long range = end - len - start;
1664
1665 if (end <= start + len)
1666 return 0;
1667 return PAGE_ALIGN(get_random_int() % range + start);
1668}