blob: 84c576ec20e907b078c8d8a8be9b0356f2d8db6d [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
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030407static bool debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408module_param(debug, bool, 0644);
Matt Mackall90b75ee2008-04-29 01:02:55 -0700409#define DEBUG_ENT(fmt, arg...) do { \
410 if (debug) \
411 printk(KERN_DEBUG "random %04d %04d %04d: " \
412 fmt,\
413 input_pool.entropy_count,\
414 blocking_pool.entropy_count,\
415 nonblocking_pool.entropy_count,\
416 ## arg); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
418/**********************************************************************
419 *
420 * OS independent entropy store. Here are the functions which handle
421 * storing entropy in an entropy pool.
422 *
423 **********************************************************************/
424
425struct entropy_store;
426struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700427 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400428 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 __u32 *pool;
430 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400432 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
434 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400435 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700436 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400437 unsigned short add_ptr;
438 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800439 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400440 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400441 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400442 unsigned int limit:1;
443 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000444 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445};
446
Theodore Ts'o6265e162013-10-03 01:08:15 -0400447static void push_to_pool(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448static __u32 input_pool_data[INPUT_POOL_WORDS];
449static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
450static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
451
452static struct entropy_store input_pool = {
453 .poolinfo = &poolinfo_table[0],
454 .name = "input",
455 .limit = 1,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200456 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 .pool = input_pool_data
458};
459
460static struct entropy_store blocking_pool = {
461 .poolinfo = &poolinfo_table[1],
462 .name = "blocking",
463 .limit = 1,
464 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200465 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400466 .pool = blocking_pool_data,
467 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
468 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469};
470
471static struct entropy_store nonblocking_pool = {
472 .poolinfo = &poolinfo_table[1],
473 .name = "nonblocking",
474 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200475 .lock = __SPIN_LOCK_UNLOCKED(nonblocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400476 .pool = nonblocking_pool_data,
477 .push_work = __WORK_INITIALIZER(nonblocking_pool.push_work,
478 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479};
480
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400481static __u32 const twist_table[8] = {
482 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
483 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
484
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700486 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700488 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 *
490 * The pool is stirred with a primitive polynomial of the appropriate
491 * degree, and then twisted. We twist by three bits at a time because
492 * it's cheap to do so and helps slightly in the expected case where
493 * the entropy is concentrated in the low-order bits.
494 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400495static void _mix_pool_bytes(struct entropy_store *r, const void *in,
496 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
Matt Mackall993ba212008-04-29 01:03:04 -0700498 unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700499 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700501 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700502 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 tap1 = r->poolinfo->tap1;
505 tap2 = r->poolinfo->tap2;
506 tap3 = r->poolinfo->tap3;
507 tap4 = r->poolinfo->tap4;
508 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Theodore Ts'o902c0982012-07-04 10:38:30 -0400510 smp_rmb();
511 input_rotate = ACCESS_ONCE(r->input_rotate);
512 i = ACCESS_ONCE(r->add_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Matt Mackalle68e5b62008-04-29 01:03:05 -0700514 /* mix one byte at a time to simplify size handling and churn faster */
515 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400516 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700517 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700520 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 w ^= r->pool[(i + tap1) & wordmask];
522 w ^= r->pool[(i + tap2) & wordmask];
523 w ^= r->pool[(i + tap3) & wordmask];
524 w ^= r->pool[(i + tap4) & wordmask];
525 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700526
527 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700529
530 /*
531 * Normally, we add 7 bits of rotation to the pool.
532 * At the beginning of the pool, add an extra 7 bits
533 * rotation, so that successive passes spread the
534 * input bits across the pool evenly.
535 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400536 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 }
538
Theodore Ts'o902c0982012-07-04 10:38:30 -0400539 ACCESS_ONCE(r->input_rotate) = input_rotate;
540 ACCESS_ONCE(r->add_ptr) = i;
541 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
Matt Mackall993ba212008-04-29 01:03:04 -0700543 if (out)
544 for (j = 0; j < 16; j++)
Matt Mackalle68e5b62008-04-29 01:03:05 -0700545 ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546}
547
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400548static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o902c0982012-07-04 10:38:30 -0400549 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400551 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
552 _mix_pool_bytes(r, in, nbytes, out);
553}
554
555static void mix_pool_bytes(struct entropy_store *r, const void *in,
556 int nbytes, __u8 out[64])
557{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400558 unsigned long flags;
559
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400560 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400561 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400562 _mix_pool_bytes(r, in, nbytes, out);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400563 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564}
565
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400566struct fast_pool {
567 __u32 pool[4];
568 unsigned long last;
569 unsigned short count;
570 unsigned char rotate;
571 unsigned char last_timer_intr;
572};
573
574/*
575 * This is a fast mixing routine used by the interrupt randomness
576 * collector. It's hardcoded for an 128 bit pool and assumes that any
577 * locks that might be needed are taken by the caller.
578 */
Theodore Ts'o655b2262013-09-22 15:24:02 -0400579static void fast_mix(struct fast_pool *f, __u32 input[4])
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400580{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400581 __u32 w;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400582 unsigned input_rotate = f->rotate;
583
Theodore Ts'o655b2262013-09-22 15:24:02 -0400584 w = rol32(input[0], input_rotate) ^ f->pool[0] ^ f->pool[3];
585 f->pool[0] = (w >> 3) ^ twist_table[w & 7];
586 input_rotate = (input_rotate + 14) & 31;
587 w = rol32(input[1], input_rotate) ^ f->pool[1] ^ f->pool[0];
588 f->pool[1] = (w >> 3) ^ twist_table[w & 7];
589 input_rotate = (input_rotate + 7) & 31;
590 w = rol32(input[2], input_rotate) ^ f->pool[2] ^ f->pool[1];
591 f->pool[2] = (w >> 3) ^ twist_table[w & 7];
592 input_rotate = (input_rotate + 7) & 31;
593 w = rol32(input[3], input_rotate) ^ f->pool[3] ^ f->pool[2];
594 f->pool[3] = (w >> 3) ^ twist_table[w & 7];
595 input_rotate = (input_rotate + 7) & 31;
596
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400597 f->rotate = input_rotate;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400598 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400599}
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400602 * Credit (or debit) the entropy store with n bits of entropy.
603 * Use credit_entropy_bits_safe() if the value comes from userspace
604 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700606static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400608 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400609 const int pool_size = r->poolinfo->poolfracbits;
610 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Matt Mackalladc782d2008-04-29 01:03:07 -0700612 if (!nbits)
613 return;
614
Matt Mackalladc782d2008-04-29 01:03:07 -0700615 DEBUG_ENT("added %d entropy credits to %s\n", nbits, r->name);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400616retry:
617 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400618 if (nfrac < 0) {
619 /* Debit */
620 entropy_count += nfrac;
621 } else {
622 /*
623 * Credit: we have to account for the possibility of
624 * overwriting already present entropy. Even in the
625 * ideal case of pure Shannon entropy, new contributions
626 * approach the full value asymptotically:
627 *
628 * entropy <- entropy + (pool_size - entropy) *
629 * (1 - exp(-add_entropy/pool_size))
630 *
631 * For add_entropy <= pool_size/2 then
632 * (1 - exp(-add_entropy/pool_size)) >=
633 * (add_entropy/pool_size)*0.7869...
634 * so we can approximate the exponential with
635 * 3/4*add_entropy/pool_size and still be on the
636 * safe side by adding at most pool_size/2 at a time.
637 *
638 * The use of pool_size-2 in the while statement is to
639 * prevent rounding artifacts from making the loop
640 * arbitrarily long; this limits the loop to log2(pool_size)*2
641 * turns no matter how large nbits is.
642 */
643 int pnfrac = nfrac;
644 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
645 /* The +2 corresponds to the /4 in the denominator */
646
647 do {
648 unsigned int anfrac = min(pnfrac, pool_size/2);
649 unsigned int add =
650 ((pool_size - entropy_count)*anfrac*3) >> s;
651
652 entropy_count += add;
653 pnfrac -= anfrac;
654 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
655 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400656
Andrew Morton8b76f462008-09-02 14:36:14 -0700657 if (entropy_count < 0) {
Matt Mackalladc782d2008-04-29 01:03:07 -0700658 DEBUG_ENT("negative entropy/overflow\n");
Andrew Morton8b76f462008-09-02 14:36:14 -0700659 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400660 } else if (entropy_count > pool_size)
661 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400662 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
663 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
Theodore Ts'o6265e162013-10-03 01:08:15 -0400665 r->entropy_total += nbits;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400666 if (!r->initialized && nbits > 0) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400667 if (r->entropy_total > 128) {
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400668 r->initialized = 1;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400669 r->entropy_total = 0;
670 }
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400671 }
672
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400673 trace_credit_entropy_bits(r->name, nbits,
674 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400675 r->entropy_total, _RET_IP_);
676
Theodore Ts'o6265e162013-10-03 01:08:15 -0400677 if (r == &input_pool) {
678 int entropy_bytes = entropy_count >> ENTROPY_SHIFT;
679
680 /* should we wake readers? */
681 if (entropy_bytes >= random_read_wakeup_thresh) {
682 wake_up_interruptible(&random_read_wait);
683 kill_fasync(&fasync, SIGIO, POLL_IN);
684 }
685 /* If the input pool is getting full, send some
686 * entropy to the two output pools, flipping back and
687 * forth between them, until the output pools are 75%
688 * full.
689 */
690 if (entropy_bytes > random_write_wakeup_thresh &&
691 r->initialized &&
692 r->entropy_total >= 2*random_read_wakeup_thresh) {
693 static struct entropy_store *last = &blocking_pool;
694 struct entropy_store *other = &blocking_pool;
695
696 if (last == &blocking_pool)
697 other = &nonblocking_pool;
698 if (other->entropy_count <=
699 3 * other->poolinfo->poolfracbits / 4)
700 last = other;
701 if (last->entropy_count <=
702 3 * last->poolinfo->poolfracbits / 4) {
703 schedule_work(&last->push_work);
704 r->entropy_total = 0;
705 }
706 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700707 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708}
709
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400710static void credit_entropy_bits_safe(struct entropy_store *r, int nbits)
711{
712 const int nbits_max = (int)(~0U >> (ENTROPY_SHIFT + 1));
713
714 /* Cap the value to avoid overflows */
715 nbits = min(nbits, nbits_max);
716 nbits = max(nbits, -nbits_max);
717
718 credit_entropy_bits(r, nbits);
719}
720
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721/*********************************************************************
722 *
723 * Entropy input management
724 *
725 *********************************************************************/
726
727/* There is one of these per entropy source */
728struct timer_rand_state {
729 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -0700730 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 unsigned dont_count_entropy:1;
732};
733
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400734/*
735 * Add device- or boot-specific data to the input and nonblocking
736 * pools to help initialize them to unique values.
737 *
738 * None of this adds any entropy, it is meant to avoid the
739 * problem of the nonblocking pool having similar initial state
740 * across largely identical devices.
741 */
742void add_device_randomness(const void *buf, unsigned int size)
743{
Theodore Ts'o61875f32013-09-21 13:58:22 -0400744 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400745 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400746
Theodore Ts'o59108952013-09-12 14:10:25 -0400747 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400748 spin_lock_irqsave(&input_pool.lock, flags);
749 _mix_pool_bytes(&input_pool, buf, size, NULL);
750 _mix_pool_bytes(&input_pool, &time, sizeof(time), NULL);
751 spin_unlock_irqrestore(&input_pool.lock, flags);
752
753 spin_lock_irqsave(&nonblocking_pool.lock, flags);
754 _mix_pool_bytes(&nonblocking_pool, buf, size, NULL);
755 _mix_pool_bytes(&nonblocking_pool, &time, sizeof(time), NULL);
756 spin_unlock_irqrestore(&nonblocking_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400757}
758EXPORT_SYMBOL(add_device_randomness);
759
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700760static struct timer_rand_state input_timer_state;
761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762/*
763 * This function adds entropy to the entropy "pool" by using timing
764 * delays. It uses the timer_rand_state structure to make an estimate
765 * of how many bits of entropy this call has added to the pool.
766 *
767 * The number "num" is also added to the pool - it should somehow describe
768 * the type of event which just happened. This is currently 0-255 for
769 * keyboard scan codes, and 256 upwards for interrupts.
770 *
771 */
772static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
773{
774 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -0800776 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 unsigned num;
778 } sample;
779 long delta, delta2, delta3;
780
781 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
783 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -0400784 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 sample.num = num;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400786 mix_pool_bytes(&input_pool, &sample, sizeof(sample), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
788 /*
789 * Calculate number of bits of randomness we probably added.
790 * We take into account the first, second and third-order deltas
791 * in order to make our estimate.
792 */
793
794 if (!state->dont_count_entropy) {
795 delta = sample.jiffies - state->last_time;
796 state->last_time = sample.jiffies;
797
798 delta2 = delta - state->last_delta;
799 state->last_delta = delta;
800
801 delta3 = delta2 - state->last_delta2;
802 state->last_delta2 = delta2;
803
804 if (delta < 0)
805 delta = -delta;
806 if (delta2 < 0)
807 delta2 = -delta2;
808 if (delta3 < 0)
809 delta3 = -delta3;
810 if (delta > delta2)
811 delta = delta2;
812 if (delta > delta3)
813 delta = delta3;
814
815 /*
816 * delta is now minimum absolute delta.
817 * Round down by 1 bit on general principles,
818 * and limit entropy entimate to 12 bits.
819 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700820 credit_entropy_bits(&input_pool,
821 min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 preempt_enable();
824}
825
Stephen Hemmingerd2515752006-01-11 12:17:38 -0800826void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 unsigned int value)
828{
829 static unsigned char last_value;
830
831 /* ignore autorepeat and the like */
832 if (value == last_value)
833 return;
834
835 DEBUG_ENT("input event\n");
836 last_value = value;
837 add_timer_randomness(&input_timer_state,
838 (type << 4) ^ code ^ (code >> 4) ^ value);
839}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400840EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400842static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
843
844void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400846 struct entropy_store *r;
847 struct fast_pool *fast_pool = &__get_cpu_var(irq_randomness);
848 struct pt_regs *regs = get_irq_regs();
849 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400850 cycles_t cycles = random_get_entropy();
851 __u32 input[4], c_high, j_high;
852 __u64 ip;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700853
Theodore Ts'o655b2262013-09-22 15:24:02 -0400854 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
855 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
856 input[0] = cycles ^ j_high ^ irq;
857 input[1] = now ^ c_high;
858 ip = regs ? instruction_pointer(regs) : _RET_IP_;
859 input[2] = ip;
860 input[3] = ip >> 32;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700861
Theodore Ts'o655b2262013-09-22 15:24:02 -0400862 fast_mix(fast_pool, input);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400863
Theodore Ts'o655b2262013-09-22 15:24:02 -0400864 if ((fast_pool->count & 63) && !time_after(now, fast_pool->last + HZ))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 return;
866
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400867 fast_pool->last = now;
868
869 r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400870 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool), NULL);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400871 /*
872 * If we don't have a valid cycle counter, and we see
873 * back-to-back timer interrupts, then skip giving credit for
874 * any entropy.
875 */
876 if (cycles == 0) {
877 if (irq_flags & __IRQF_TIMER) {
878 if (fast_pool->last_timer_intr)
879 return;
880 fast_pool->last_timer_intr = 1;
881 } else
882 fast_pool->last_timer_intr = 0;
883 }
884 credit_entropy_bits(r, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885}
886
David Howells93614012006-09-30 20:45:40 +0200887#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888void add_disk_randomness(struct gendisk *disk)
889{
890 if (!disk || !disk->random)
891 return;
892 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +0200893 DEBUG_ENT("disk event %d:%d\n",
894 MAJOR(disk_devt(disk)), MINOR(disk_devt(disk)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Tejun Heof331c022008-09-03 09:01:48 +0200896 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897}
David Howells93614012006-09-30 20:45:40 +0200898#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900/*********************************************************************
901 *
902 * Entropy extraction routines
903 *
904 *********************************************************************/
905
Matt Mackall90b75ee2008-04-29 01:02:55 -0700906static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 size_t nbytes, int min, int rsvd);
908
909/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300910 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 * from the primary pool to the secondary extraction pool. We make
912 * sure we pull enough for a 'catastrophic reseed'.
913 */
Theodore Ts'o6265e162013-10-03 01:08:15 -0400914static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
916{
Theodore Ts'of5c27422013-09-22 15:14:32 -0400917 if (r->limit == 0 && random_min_urandom_seed) {
918 unsigned long now = jiffies;
919
920 if (time_before(now,
921 r->last_pulled + random_min_urandom_seed * HZ))
922 return;
923 r->last_pulled = now;
924 }
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400925 if (r->pull &&
926 r->entropy_count < (nbytes << (ENTROPY_SHIFT + 3)) &&
Theodore Ts'o6265e162013-10-03 01:08:15 -0400927 r->entropy_count < r->poolinfo->poolfracbits)
928 _xfer_secondary_pool(r, nbytes);
929}
Matt Mackall5a021e92007-07-19 11:30:14 -0700930
Theodore Ts'o6265e162013-10-03 01:08:15 -0400931static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
932{
933 __u32 tmp[OUTPUT_POOL_WORDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
Theodore Ts'o6265e162013-10-03 01:08:15 -0400935 /* For /dev/random's pool, always leave two wakeup worth's BITS */
936 int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
937 int bytes = nbytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Theodore Ts'o6265e162013-10-03 01:08:15 -0400939 /* pull at least as many as BYTES as wakeup BITS */
940 bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
941 /* but never more than the buffer size */
942 bytes = min_t(int, bytes, sizeof(tmp));
943
944 DEBUG_ENT("going to reseed %s with %d bits (%zu of %d requested)\n",
945 r->name, bytes * 8, nbytes * 8,
946 r->entropy_count >> ENTROPY_SHIFT);
947
948 bytes = extract_entropy(r->pull, tmp, bytes,
949 random_read_wakeup_thresh / 8, rsvd);
950 mix_pool_bytes(r, tmp, bytes, NULL);
951 credit_entropy_bits(r, bytes*8);
952}
953
954/*
955 * Used as a workqueue function so that when the input pool is getting
956 * full, we can "spill over" some entropy to the output pools. That
957 * way the output pools can store some of the excess entropy instead
958 * of letting it go to waste.
959 */
960static void push_to_pool(struct work_struct *work)
961{
962 struct entropy_store *r = container_of(work, struct entropy_store,
963 push_work);
964 BUG_ON(!r);
965 _xfer_secondary_pool(r, random_read_wakeup_thresh/8);
966 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
967 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968}
969
970/*
971 * These functions extracts randomness from the "entropy pool", and
972 * returns it in a buffer.
973 *
974 * The min parameter specifies the minimum amount we can pull before
975 * failing to avoid races that defeat catastrophic reseeding while the
976 * reserved parameter indicates how much entropy we must leave in the
977 * pool after each pull to avoid starving other readers.
978 *
979 * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
980 */
981
982static size_t account(struct entropy_store *r, size_t nbytes, int min,
983 int reserved)
984{
985 unsigned long flags;
Theodore Ts'ob9809552013-03-04 11:59:12 -0500986 int wakeup_write = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400987 int have_bytes;
988 int entropy_count, orig;
989 size_t ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 /* Hold lock while accounting */
992 spin_lock_irqsave(&r->lock, flags);
993
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400994 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200995 DEBUG_ENT("trying to extract %zu bits from %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 nbytes * 8, r->name);
997
998 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -0700999retry:
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001000 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
1001 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
1002 ibytes = nbytes;
1003 if (have_bytes < min + reserved) {
1004 ibytes = 0;
1005 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 /* If limited, never pull more than available */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001007 if (r->limit && ibytes + reserved >= have_bytes)
1008 ibytes = have_bytes - reserved;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001010 if (have_bytes >= ibytes + reserved)
1011 entropy_count -= ibytes << (ENTROPY_SHIFT + 3);
1012 else
1013 entropy_count = reserved << (ENTROPY_SHIFT + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001015 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1016 goto retry;
1017
1018 if ((r->entropy_count >> ENTROPY_SHIFT)
1019 < random_write_wakeup_thresh)
Theodore Ts'ob9809552013-03-04 11:59:12 -05001020 wakeup_write = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 }
1022
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001023 DEBUG_ENT("debiting %zu entropy credits from %s%s\n",
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001024 ibytes * 8, r->name, r->limit ? "" : " (unlimited)");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
1026 spin_unlock_irqrestore(&r->lock, flags);
1027
Theodore Ts'ob9809552013-03-04 11:59:12 -05001028 if (wakeup_write) {
1029 wake_up_interruptible(&random_write_wait);
1030 kill_fasync(&fasync, SIGIO, POLL_OUT);
1031 }
1032
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001033 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034}
1035
1036static void extract_buf(struct entropy_store *r, __u8 *out)
1037{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001038 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001039 union {
1040 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001041 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001042 } hash;
1043 __u32 workspace[SHA_WORKSPACE_WORDS];
Matt Mackalle68e5b62008-04-29 01:03:05 -07001044 __u8 extract[64];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001045 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001047 /* Generate a hash across the pool, 16 words (512 bits) at a time */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001048 sha_init(hash.w);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001049 spin_lock_irqsave(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001050 for (i = 0; i < r->poolinfo->poolwords; i += 16)
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001051 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
1053 /*
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001054 * If we have a architectural hardware random number
1055 * generator, mix that in, too.
1056 */
1057 for (i = 0; i < LONGS(20); i++) {
1058 unsigned long v;
1059 if (!arch_get_random_long(&v))
1060 break;
1061 hash.l[i] ^= v;
1062 }
1063
1064 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001065 * We mix the hash back into the pool to prevent backtracking
1066 * attacks (where the attacker knows the state of the pool
1067 * plus the current outputs, and attempts to find previous
1068 * ouputs), unless the hash function can be inverted. By
1069 * mixing at least a SHA1 worth of hash data back, we make
1070 * brute-forcing the feedback as hard as brute-forcing the
1071 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001073 __mix_pool_bytes(r, hash.w, sizeof(hash.w), extract);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001074 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001075
1076 /*
1077 * To avoid duplicates, we atomically extract a portion of the
1078 * pool while mixing, and hash one final time.
1079 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001080 sha_transform(hash.w, extract, workspace);
Matt Mackallffd8d3f2008-04-29 01:02:59 -07001081 memset(extract, 0, sizeof(extract));
1082 memset(workspace, 0, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
1084 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001085 * In case the hash function has some recognizable output
1086 * pattern, we fold it in half. Thus, we always feed back
1087 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001089 hash.w[0] ^= hash.w[3];
1090 hash.w[1] ^= hash.w[4];
1091 hash.w[2] ^= rol32(hash.w[2], 16);
1092
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001093 memcpy(out, &hash, EXTRACT_SIZE);
1094 memset(&hash, 0, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095}
1096
Matt Mackall90b75ee2008-04-29 01:02:55 -07001097static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001098 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099{
1100 ssize_t ret = 0, i;
1101 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001102 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001104 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001105 if (fips_enabled) {
1106 spin_lock_irqsave(&r->lock, flags);
1107 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001108 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001109 spin_unlock_irqrestore(&r->lock, flags);
1110 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001111 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001112 xfer_secondary_pool(r, EXTRACT_SIZE);
1113 extract_buf(r, tmp);
1114 spin_lock_irqsave(&r->lock, flags);
1115 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1116 }
1117 spin_unlock_irqrestore(&r->lock, flags);
1118 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001119
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001120 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 xfer_secondary_pool(r, nbytes);
1122 nbytes = account(r, nbytes, min, reserved);
1123
1124 while (nbytes) {
1125 extract_buf(r, tmp);
Neil Horman5b739ef2009-06-18 19:50:21 +08001126
Matt Mackalle954bc92010-05-20 19:55:01 +10001127 if (fips_enabled) {
Neil Horman5b739ef2009-06-18 19:50:21 +08001128 spin_lock_irqsave(&r->lock, flags);
1129 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1130 panic("Hardware RNG duplicated output!\n");
1131 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1132 spin_unlock_irqrestore(&r->lock, flags);
1133 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 i = min_t(int, nbytes, EXTRACT_SIZE);
1135 memcpy(buf, tmp, i);
1136 nbytes -= i;
1137 buf += i;
1138 ret += i;
1139 }
1140
1141 /* Wipe data just returned from memory */
1142 memset(tmp, 0, sizeof(tmp));
1143
1144 return ret;
1145}
1146
1147static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1148 size_t nbytes)
1149{
1150 ssize_t ret = 0, i;
1151 __u8 tmp[EXTRACT_SIZE];
1152
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001153 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 xfer_secondary_pool(r, nbytes);
1155 nbytes = account(r, nbytes, 0, 0);
1156
1157 while (nbytes) {
1158 if (need_resched()) {
1159 if (signal_pending(current)) {
1160 if (ret == 0)
1161 ret = -ERESTARTSYS;
1162 break;
1163 }
1164 schedule();
1165 }
1166
1167 extract_buf(r, tmp);
1168 i = min_t(int, nbytes, EXTRACT_SIZE);
1169 if (copy_to_user(buf, tmp, i)) {
1170 ret = -EFAULT;
1171 break;
1172 }
1173
1174 nbytes -= i;
1175 buf += i;
1176 ret += i;
1177 }
1178
1179 /* Wipe data just returned from memory */
1180 memset(tmp, 0, sizeof(tmp));
1181
1182 return ret;
1183}
1184
1185/*
1186 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001187 * number of good random numbers, suitable for key generation, seeding
1188 * TCP sequence numbers, etc. It does not use the hw random number
1189 * generator, if available; use get_random_bytes_arch() for that.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 */
1191void get_random_bytes(void *buf, int nbytes)
1192{
Theodore Ts'o59108952013-09-12 14:10:25 -04001193 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001194 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
1195}
1196EXPORT_SYMBOL(get_random_bytes);
1197
1198/*
1199 * This function will use the architecture-specific hardware random
1200 * number generator if it is available. The arch-specific hw RNG will
1201 * almost certainly be faster than what we can do in software, but it
1202 * is impossible to verify that it is implemented securely (as
1203 * opposed, to, say, the AES encryption of a sequence number using a
1204 * key known by the NSA). So it's useful if we need the speed, but
1205 * only if we're willing to trust the hardware manufacturer not to
1206 * have put in a back door.
1207 */
1208void get_random_bytes_arch(void *buf, int nbytes)
1209{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001210 char *p = buf;
1211
Theodore Ts'o59108952013-09-12 14:10:25 -04001212 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001213 while (nbytes) {
1214 unsigned long v;
1215 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001216
H. Peter Anvin63d77172011-07-31 13:54:50 -07001217 if (!arch_get_random_long(&v))
1218 break;
1219
Luck, Tonybd29e562011-11-16 10:50:56 -08001220 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001221 p += chunk;
1222 nbytes -= chunk;
1223 }
1224
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001225 if (nbytes)
1226 extract_entropy(&nonblocking_pool, p, nbytes, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001228EXPORT_SYMBOL(get_random_bytes_arch);
1229
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
1231/*
1232 * init_std_data - initialize pool with system data
1233 *
1234 * @r: pool to initialize
1235 *
1236 * This function clears the pool's entropy count and mixes some system
1237 * data into the pool to prepare it for use. The pool is not cleared
1238 * as that can only decrease the entropy in the pool.
1239 */
1240static void init_std_data(struct entropy_store *r)
1241{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001242 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001243 ktime_t now = ktime_get_real();
1244 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 r->entropy_count = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001247 r->entropy_total = 0;
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001248 r->last_data_init = 0;
Theodore Ts'of5c27422013-09-22 15:14:32 -04001249 r->last_pulled = jiffies;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001250 mix_pool_bytes(r, &now, sizeof(now), NULL);
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001251 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
Theodore Ts'o902c0982012-07-04 10:38:30 -04001252 if (!arch_get_random_long(&rv))
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001253 break;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001254 mix_pool_bytes(r, &rv, sizeof(rv), NULL);
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001255 }
Theodore Ts'o902c0982012-07-04 10:38:30 -04001256 mix_pool_bytes(r, utsname(), sizeof(*(utsname())), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257}
1258
Tony Luckcbc96b72012-07-23 09:47:57 -07001259/*
1260 * Note that setup_arch() may call add_device_randomness()
1261 * long before we get here. This allows seeding of the pools
1262 * with some platform dependent data very early in the boot
1263 * process. But it limits our options here. We must use
1264 * statically allocated structures that already have all
1265 * initializations complete at compile time. We should also
1266 * take care not to overwrite the precious per platform data
1267 * we were given.
1268 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001269static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270{
1271 init_std_data(&input_pool);
1272 init_std_data(&blocking_pool);
1273 init_std_data(&nonblocking_pool);
1274 return 0;
1275}
1276module_init(rand_initialize);
1277
David Howells93614012006-09-30 20:45:40 +02001278#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279void rand_initialize_disk(struct gendisk *disk)
1280{
1281 struct timer_rand_state *state;
1282
1283 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001284 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 * source.
1286 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001287 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1288 if (state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 disk->random = state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290}
David Howells93614012006-09-30 20:45:40 +02001291#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
1293static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001294random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295{
1296 ssize_t n, retval = 0, count = 0;
1297
1298 if (nbytes == 0)
1299 return 0;
1300
1301 while (nbytes > 0) {
1302 n = nbytes;
1303 if (n > SEC_XFER_SIZE)
1304 n = SEC_XFER_SIZE;
1305
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001306 DEBUG_ENT("reading %zu bits\n", n*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
1308 n = extract_entropy_user(&blocking_pool, buf, n);
1309
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001310 if (n < 0) {
1311 retval = n;
1312 break;
1313 }
1314
1315 DEBUG_ENT("read got %zd bits (%zd still needed)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 n*8, (nbytes-n)*8);
1317
1318 if (n == 0) {
1319 if (file->f_flags & O_NONBLOCK) {
1320 retval = -EAGAIN;
1321 break;
1322 }
1323
1324 DEBUG_ENT("sleeping?\n");
1325
1326 wait_event_interruptible(random_read_wait,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001327 ENTROPY_BITS(&input_pool) >=
1328 random_read_wakeup_thresh);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329
1330 DEBUG_ENT("awake\n");
1331
1332 if (signal_pending(current)) {
1333 retval = -ERESTARTSYS;
1334 break;
1335 }
1336
1337 continue;
1338 }
1339
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 count += n;
1341 buf += n;
1342 nbytes -= n;
1343 break; /* This break makes the device work */
1344 /* like a named pipe */
1345 }
1346
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 return (count ? count : retval);
1348}
1349
1350static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001351urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352{
1353 return extract_entropy_user(&nonblocking_pool, buf, nbytes);
1354}
1355
1356static unsigned int
1357random_poll(struct file *file, poll_table * wait)
1358{
1359 unsigned int mask;
1360
1361 poll_wait(file, &random_read_wait, wait);
1362 poll_wait(file, &random_write_wait, wait);
1363 mask = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001364 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 mask |= POLLIN | POLLRDNORM;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001366 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 mask |= POLLOUT | POLLWRNORM;
1368 return mask;
1369}
1370
Matt Mackall7f397dc2007-05-29 21:58:10 -05001371static int
1372write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1373{
1374 size_t bytes;
1375 __u32 buf[16];
1376 const char __user *p = buffer;
1377
1378 while (count > 0) {
1379 bytes = min(count, sizeof(buf));
1380 if (copy_from_user(&buf, p, bytes))
1381 return -EFAULT;
1382
1383 count -= bytes;
1384 p += bytes;
1385
Theodore Ts'o902c0982012-07-04 10:38:30 -04001386 mix_pool_bytes(r, buf, bytes, NULL);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001387 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001388 }
1389
1390 return 0;
1391}
1392
Matt Mackall90b75ee2008-04-29 01:02:55 -07001393static ssize_t random_write(struct file *file, const char __user *buffer,
1394 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001396 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397
Matt Mackall7f397dc2007-05-29 21:58:10 -05001398 ret = write_pool(&blocking_pool, buffer, count);
1399 if (ret)
1400 return ret;
1401 ret = write_pool(&nonblocking_pool, buffer, count);
1402 if (ret)
1403 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Matt Mackall7f397dc2007-05-29 21:58:10 -05001405 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406}
1407
Matt Mackall43ae4862008-04-29 01:02:58 -07001408static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409{
1410 int size, ent_count;
1411 int __user *p = (int __user *)arg;
1412 int retval;
1413
1414 switch (cmd) {
1415 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001416 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001417 ent_count = ENTROPY_BITS(&input_pool);
1418 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 return -EFAULT;
1420 return 0;
1421 case RNDADDTOENTCNT:
1422 if (!capable(CAP_SYS_ADMIN))
1423 return -EPERM;
1424 if (get_user(ent_count, p))
1425 return -EFAULT;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001426 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 return 0;
1428 case RNDADDENTROPY:
1429 if (!capable(CAP_SYS_ADMIN))
1430 return -EPERM;
1431 if (get_user(ent_count, p++))
1432 return -EFAULT;
1433 if (ent_count < 0)
1434 return -EINVAL;
1435 if (get_user(size, p++))
1436 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001437 retval = write_pool(&input_pool, (const char __user *)p,
1438 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 if (retval < 0)
1440 return retval;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001441 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 return 0;
1443 case RNDZAPENTCNT:
1444 case RNDCLEARPOOL:
1445 /* Clear the entropy pool counters. */
1446 if (!capable(CAP_SYS_ADMIN))
1447 return -EPERM;
Matt Mackall53c3f632008-04-29 01:02:58 -07001448 rand_initialize();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 return 0;
1450 default:
1451 return -EINVAL;
1452 }
1453}
1454
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001455static int random_fasync(int fd, struct file *filp, int on)
1456{
1457 return fasync_helper(fd, filp, on, &fasync);
1458}
1459
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001460const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 .read = random_read,
1462 .write = random_write,
1463 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001464 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001465 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001466 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467};
1468
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001469const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 .read = urandom_read,
1471 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001472 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001473 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001474 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475};
1476
1477/***************************************************************
1478 * Random UUID interface
1479 *
1480 * Used here for a Boot ID, but can be useful for other kernel
1481 * drivers.
1482 ***************************************************************/
1483
1484/*
1485 * Generate random UUID
1486 */
1487void generate_random_uuid(unsigned char uuid_out[16])
1488{
1489 get_random_bytes(uuid_out, 16);
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05001490 /* Set UUID version to 4 --- truly random generation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1492 /* Set the UUID variant to DCE */
1493 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1494}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495EXPORT_SYMBOL(generate_random_uuid);
1496
1497/********************************************************************
1498 *
1499 * Sysctl interface
1500 *
1501 ********************************************************************/
1502
1503#ifdef CONFIG_SYSCTL
1504
1505#include <linux/sysctl.h>
1506
1507static int min_read_thresh = 8, min_write_thresh;
1508static int max_read_thresh = INPUT_POOL_WORDS * 32;
1509static int max_write_thresh = INPUT_POOL_WORDS * 32;
1510static char sysctl_bootid[16];
1511
1512/*
1513 * These functions is used to return both the bootid UUID, and random
1514 * UUID. The difference is in whether table->data is NULL; if it is,
1515 * then a new UUID is generated and returned to the user.
1516 *
1517 * If the user accesses this via the proc interface, it will be returned
1518 * as an ASCII string in the standard UUID format. If accesses via the
1519 * sysctl system call, it is returned as 16 bytes of binary data.
1520 */
Joe Perchesa1514272013-06-13 19:37:35 -07001521static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 void __user *buffer, size_t *lenp, loff_t *ppos)
1523{
Joe Perchesa1514272013-06-13 19:37:35 -07001524 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 unsigned char buf[64], tmp_uuid[16], *uuid;
1526
1527 uuid = table->data;
1528 if (!uuid) {
1529 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001531 } else {
1532 static DEFINE_SPINLOCK(bootid_spinlock);
1533
1534 spin_lock(&bootid_spinlock);
1535 if (!uuid[8])
1536 generate_random_uuid(uuid);
1537 spin_unlock(&bootid_spinlock);
1538 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
Joe Perches35900772009-12-14 18:01:11 -08001540 sprintf(buf, "%pU", uuid);
1541
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 fake_table.data = buf;
1543 fake_table.maxlen = sizeof(buf);
1544
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001545 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546}
1547
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001548/*
1549 * Return entropy available scaled to integral bits
1550 */
1551static int proc_do_entropy(ctl_table *table, int write,
1552 void __user *buffer, size_t *lenp, loff_t *ppos)
1553{
1554 ctl_table fake_table;
1555 int entropy_count;
1556
1557 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
1558
1559 fake_table.data = &entropy_count;
1560 fake_table.maxlen = sizeof(entropy_count);
1561
1562 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1563}
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07001566extern struct ctl_table random_table[];
1567struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 .procname = "poolsize",
1570 .data = &sysctl_poolsize,
1571 .maxlen = sizeof(int),
1572 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001573 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 },
1575 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 .procname = "entropy_avail",
1577 .maxlen = sizeof(int),
1578 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001579 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 .data = &input_pool.entropy_count,
1581 },
1582 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 .procname = "read_wakeup_threshold",
1584 .data = &random_read_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_read_thresh,
1589 .extra2 = &max_read_thresh,
1590 },
1591 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 .procname = "write_wakeup_threshold",
1593 .data = &random_write_wakeup_thresh,
1594 .maxlen = sizeof(int),
1595 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001596 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 .extra1 = &min_write_thresh,
1598 .extra2 = &max_write_thresh,
1599 },
1600 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04001601 .procname = "urandom_min_reseed_secs",
1602 .data = &random_min_urandom_seed,
1603 .maxlen = sizeof(int),
1604 .mode = 0644,
1605 .proc_handler = proc_dointvec,
1606 },
1607 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 .procname = "boot_id",
1609 .data = &sysctl_bootid,
1610 .maxlen = 16,
1611 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001612 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 },
1614 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 .procname = "uuid",
1616 .maxlen = 16,
1617 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001618 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 },
Eric W. Biederman894d2492009-11-05 14:34:02 -08001620 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621};
1622#endif /* CONFIG_SYSCTL */
1623
David S. Miller6e5714e2011-08-03 20:50:44 -07001624static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Theodore Ts'o47d06e52013-09-10 10:52:35 -04001626int random_int_secret_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627{
David S. Miller6e5714e2011-08-03 20:50:44 -07001628 get_random_bytes(random_int_secret, sizeof(random_int_secret));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 return 0;
1630}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
1632/*
1633 * Get a random word for internal kernel use only. Similar to urandom but
1634 * with the goal of minimal entropy pool depletion. As a result, the random
1635 * value is not cryptographically secure but for several uses the cost of
1636 * depleting entropy is too high
1637 */
Theodore Ts'o74feec52012-07-06 14:03:18 -04001638static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639unsigned int get_random_int(void)
1640{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001641 __u32 *hash;
David S. Miller6e5714e2011-08-03 20:50:44 -07001642 unsigned int ret;
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001643
H. Peter Anvin63d77172011-07-31 13:54:50 -07001644 if (arch_get_random_int(&ret))
1645 return ret;
1646
1647 hash = get_cpu_var(get_random_int_hash);
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001648
Theodore Ts'o61875f32013-09-21 13:58:22 -04001649 hash[0] += current->pid + jiffies + random_get_entropy();
David S. Miller6e5714e2011-08-03 20:50:44 -07001650 md5_transform(hash, random_int_secret);
1651 ret = hash[0];
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001652 put_cpu_var(get_random_int_hash);
1653
1654 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655}
Andy Shevchenko16c7fa02013-04-30 15:27:30 -07001656EXPORT_SYMBOL(get_random_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
1658/*
1659 * randomize_range() returns a start address such that
1660 *
1661 * [...... <range> .....]
1662 * start end
1663 *
1664 * a <range> with size "len" starting at the return value is inside in the
1665 * area defined by [start, end], but is otherwise randomized.
1666 */
1667unsigned long
1668randomize_range(unsigned long start, unsigned long end, unsigned long len)
1669{
1670 unsigned long range = end - len - start;
1671
1672 if (end <= start + len)
1673 return 0;
1674 return PAGE_ALIGN(get_random_int() % range + start);
1675}