blob: a68b4a0932726030035415e7b519dd64f7d2ed77 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * random.c -- A strong random number generator
3 *
Matt Mackall9e95ce22005-04-16 15:25:56 -07004 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
7 * rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, and the entire permission notice in its entirety,
14 * including the disclaimer of warranties.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote
19 * products derived from this software without specific prior
20 * written permission.
21 *
22 * ALTERNATIVELY, this product may be distributed under the terms of
23 * the GNU General Public License, in which case the provisions of the GPL are
24 * required INSTEAD OF the above restrictions. (This clause is
25 * necessary due to a potential bad interaction between the GPL and
26 * the restrictions contained in a BSD-style copyright.)
27 *
28 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
31 * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
32 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
34 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
35 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
38 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
39 * DAMAGE.
40 */
41
42/*
43 * (now, with legal B.S. out of the way.....)
44 *
45 * This routine gathers environmental noise from device drivers, etc.,
46 * and returns good random numbers, suitable for cryptographic use.
47 * Besides the obvious cryptographic uses, these numbers are also good
48 * for seeding TCP sequence numbers, and other places where it is
49 * desirable to have numbers which are not only random, but hard to
50 * predict by an attacker.
51 *
52 * Theory of operation
53 * ===================
54 *
55 * Computers are very predictable devices. Hence it is extremely hard
56 * to produce truly random numbers on a computer --- as opposed to
57 * pseudo-random numbers, which can easily generated by using a
58 * algorithm. Unfortunately, it is very easy for attackers to guess
59 * the sequence of pseudo-random number generators, and for some
60 * applications this is not acceptable. So instead, we must try to
61 * gather "environmental noise" from the computer's environment, which
62 * must be hard for outside attackers to observe, and use that to
63 * generate random numbers. In a Unix environment, this is best done
64 * from inside the kernel.
65 *
66 * Sources of randomness from the environment include inter-keyboard
67 * timings, inter-interrupt timings from some interrupts, and other
68 * events which are both (a) non-deterministic and (b) hard for an
69 * outside observer to measure. Randomness from these sources are
70 * added to an "entropy pool", which is mixed using a CRC-like function.
71 * This is not cryptographically strong, but it is adequate assuming
72 * the randomness is not chosen maliciously, and it is fast enough that
73 * the overhead of doing it on every interrupt is very reasonable.
74 * As random bytes are mixed into the entropy pool, the routines keep
75 * an *estimate* of how many bits of randomness have been stored into
76 * the random number generator's internal state.
77 *
78 * When random bytes are desired, they are obtained by taking the SHA
79 * hash of the contents of the "entropy pool". The SHA hash avoids
80 * exposing the internal state of the entropy pool. It is believed to
81 * be computationally infeasible to derive any useful information
82 * about the input of SHA from its output. Even if it is possible to
83 * analyze SHA in some clever way, as long as the amount of data
84 * returned from the generator is less than the inherent entropy in
85 * the pool, the output data is totally unpredictable. For this
86 * reason, the routine decreases its internal estimate of how many
87 * bits of "true randomness" are contained in the entropy pool as it
88 * outputs random numbers.
89 *
90 * If this estimate goes to zero, the routine can still generate
91 * random numbers; however, an attacker may (at least in theory) be
92 * able to infer the future output of the generator from prior
93 * outputs. This requires successful cryptanalysis of SHA, which is
94 * not believed to be feasible, but there is a remote possibility.
95 * Nonetheless, these numbers should be useful for the vast majority
96 * of purposes.
97 *
98 * Exported interfaces ---- output
99 * ===============================
100 *
101 * There are three exported interfaces; the first is one designed to
102 * be used from within the kernel:
103 *
104 * void get_random_bytes(void *buf, int nbytes);
105 *
106 * This interface will return the requested number of random bytes,
107 * and place it in the requested buffer.
108 *
109 * The two other interfaces are two character devices /dev/random and
110 * /dev/urandom. /dev/random is suitable for use when very high
111 * quality randomness is desired (for example, for key generation or
112 * one-time pads), as it will only return a maximum of the number of
113 * bits of randomness (as estimated by the random number generator)
114 * contained in the entropy pool.
115 *
116 * The /dev/urandom device does not have this limit, and will return
117 * as many bytes as are requested. As more and more random bytes are
118 * requested without giving time for the entropy pool to recharge,
119 * this will result in random numbers that are merely cryptographically
120 * strong. For many applications, however, this is acceptable.
121 *
122 * Exported interfaces ---- input
123 * ==============================
124 *
125 * The current exported interfaces for gathering environmental noise
126 * from the devices are:
127 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400128 * void add_device_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 * void add_input_randomness(unsigned int type, unsigned int code,
130 * unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400131 * void add_interrupt_randomness(int irq, int irq_flags);
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100132 * void add_disk_randomness(struct gendisk *disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400134 * add_device_randomness() is for adding data to the random pool that
135 * is likely to differ between two devices (or possibly even per boot).
136 * This would be things like MAC addresses or serial numbers, or the
137 * read-out of the RTC. This does *not* add any actual entropy to the
138 * pool, but it initializes the pool to different values for devices
139 * that might otherwise be identical and have very little entropy
140 * available to them (particularly common in the embedded world).
141 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 * add_input_randomness() uses the input layer interrupt timing, as well as
143 * the event type information from the hardware.
144 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400145 * add_interrupt_randomness() uses the interrupt timing as random
146 * inputs to the entropy pool. Using the cycle counters and the irq source
147 * as inputs, it feeds the randomness roughly once a second.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100148 *
149 * add_disk_randomness() uses what amounts to the seek time of block
150 * layer request events, on a per-disk_devt basis, as input to the
151 * entropy pool. Note that high-speed solid state drives with very low
152 * seek times do not make for good sources of entropy, as their seek
153 * times are usually fairly consistent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 *
155 * All of these routines try to estimate how many bits of randomness a
156 * particular randomness source. They do this by keeping track of the
157 * first and second order deltas of the event timings.
158 *
159 * Ensuring unpredictability at system startup
160 * ============================================
161 *
162 * When any operating system starts up, it will go through a sequence
163 * of actions that are fairly predictable by an adversary, especially
164 * if the start-up does not involve interaction with a human operator.
165 * This reduces the actual number of bits of unpredictability in the
166 * entropy pool below the value in entropy_count. In order to
167 * counteract this effect, it helps to carry information in the
168 * entropy pool across shut-downs and start-ups. To do this, put the
169 * following lines an appropriate script which is run during the boot
170 * sequence:
171 *
172 * echo "Initializing random number generator..."
173 * random_seed=/var/run/random-seed
174 * # Carry a random seed from start-up to start-up
175 * # Load and then save the whole entropy pool
176 * if [ -f $random_seed ]; then
177 * cat $random_seed >/dev/urandom
178 * else
179 * touch $random_seed
180 * fi
181 * chmod 600 $random_seed
182 * dd if=/dev/urandom of=$random_seed count=1 bs=512
183 *
184 * and the following lines in an appropriate script which is run as
185 * the system is shutdown:
186 *
187 * # Carry a random seed from shut-down to start-up
188 * # Save the whole entropy pool
189 * echo "Saving random seed..."
190 * random_seed=/var/run/random-seed
191 * touch $random_seed
192 * chmod 600 $random_seed
193 * dd if=/dev/urandom of=$random_seed count=1 bs=512
194 *
195 * For example, on most modern systems using the System V init
196 * scripts, such code fragments would be found in
197 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
198 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
199 *
200 * Effectively, these commands cause the contents of the entropy pool
201 * to be saved at shut-down time and reloaded into the entropy pool at
202 * start-up. (The 'dd' in the addition to the bootup script is to
203 * make sure that /etc/random-seed is different for every start-up,
204 * even if the system crashes without executing rc.0.) Even with
205 * complete knowledge of the start-up activities, predicting the state
206 * of the entropy pool requires knowledge of the previous history of
207 * the system.
208 *
209 * Configuring the /dev/random driver under Linux
210 * ==============================================
211 *
212 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
213 * the /dev/mem major number (#1). So if your system does not have
214 * /dev/random and /dev/urandom created already, they can be created
215 * by using the commands:
216 *
217 * mknod /dev/random c 1 8
218 * mknod /dev/urandom c 1 9
219 *
220 * Acknowledgements:
221 * =================
222 *
223 * Ideas for constructing this random number generator were derived
224 * from Pretty Good Privacy's random number generator, and from private
225 * discussions with Phil Karn. Colin Plumb provided a faster random
226 * number generator, which speed up the mixing function of the entropy
227 * pool, taken from PGPfone. Dale Worley has also contributed many
228 * useful ideas and suggestions to improve this driver.
229 *
230 * Any flaws in the design are solely my responsibility, and should
231 * not be attributed to the Phil, Colin, or any of authors of PGP.
232 *
233 * Further background information on this topic may be obtained from
234 * RFC 1750, "Randomness Recommendations for Security", by Donald
235 * Eastlake, Steve Crocker, and Jeff Schiller.
236 */
237
238#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239#include <linux/module.h>
240#include <linux/kernel.h>
241#include <linux/major.h>
242#include <linux/string.h>
243#include <linux/fcntl.h>
244#include <linux/slab.h>
245#include <linux/random.h>
246#include <linux/poll.h>
247#include <linux/init.h>
248#include <linux/fs.h>
249#include <linux/genhd.h>
250#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700251#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252#include <linux/spinlock.h>
253#include <linux/percpu.h>
254#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800255#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400256#include <linux/ptrace.h>
Theodore Ts'oe6d49472012-07-05 10:21:01 -0400257#include <linux/kmemcheck.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Yinghai Lud178a1e2009-01-11 00:35:42 -0800259#ifdef CONFIG_GENERIC_HARDIRQS
260# include <linux/irq.h>
261#endif
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263#include <asm/processor.h>
264#include <asm/uaccess.h>
265#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400266#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267#include <asm/io.h>
268
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400269#define CREATE_TRACE_POINTS
270#include <trace/events/random.h>
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272/*
273 * Configuration information
274 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400275#define INPUT_POOL_SHIFT 12
276#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
277#define OUTPUT_POOL_SHIFT 10
278#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
279#define SEC_XFER_SIZE 512
280#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400282#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400285 * To allow fractional bits to be tracked, the following fields contain
286 * this many fractional bits:
287 *
288 * entropy_count, trickle_thresh
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400289 *
290 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
291 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400292 */
293#define ENTROPY_SHIFT 3
294#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
295
296/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 * The minimum number of bits of entropy before we wake up a read on
298 * /dev/random. Should be enough to do a significant reseed.
299 */
300static int random_read_wakeup_thresh = 64;
301
302/*
303 * If the entropy count falls under this number of bits, then we
304 * should wake up processes which are selecting or polling on write
305 * access to /dev/random.
306 */
307static int random_write_wakeup_thresh = 128;
308
309/*
Theodore Ts'of5c27422013-09-22 15:14:32 -0400310 * The minimum number of seconds between urandom pool resending. We
311 * do this to limit the amount of entropy that can be drained from the
312 * input pool even if there are heavy demands on /dev/urandom.
313 */
314static int random_min_urandom_seed = 60;
315
316/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 * When the input pool goes over trickle_thresh, start dropping most
318 * samples to avoid wasting CPU time and reduce lock contention.
319 */
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400320static const int trickle_thresh = (INPUT_POOL_WORDS * 28) << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
Matt Mackall90b75ee2008-04-29 01:02:55 -0700322static DEFINE_PER_CPU(int, trickle_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
324/*
325 * A pool of size .poolwords is stirred with a primitive polynomial
326 * of degree .poolwords over GF(2). The taps for various sizes are
327 * defined below. They are chosen to be evenly spaced (minimum RMS
328 * distance from evenly spaced; the numbers in the comments are a
329 * scaled squared error sum) except for the last tap, which is 1 to
330 * get the twisting happening as fast as possible.
331 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400332
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400334 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
335#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 int tap1, tap2, tap3, tap4, tap5;
337} poolinfo_table[] = {
338 /* x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 -- 105 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400339 { S(128), 103, 76, 51, 25, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 /* x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400341 { S(32), 26, 20, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342#if 0
343 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400344 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400347 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400350 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400353 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400356 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400358 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400361 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
363 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400364 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
366 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400367 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368#endif
369};
370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371/*
372 * For the purposes of better mixing, we use the CRC-32 polynomial as
373 * well to make a twisted Generalized Feedback Shift Reigster
374 *
375 * (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR generators. ACM
376 * Transactions on Modeling and Computer Simulation 2(3):179-194.
377 * Also see M. Matsumoto & Y. Kurita, 1994. Twisted GFSR generators
378 * II. ACM Transactions on Mdeling and Computer Simulation 4:254-266)
379 *
380 * Thanks to Colin Plumb for suggesting this.
381 *
382 * We have not analyzed the resultant polynomial to prove it primitive;
383 * in fact it almost certainly isn't. Nonetheless, the irreducible factors
384 * of a random large-degree polynomial over GF(2) are more than large enough
385 * that periodicity is not a concern.
386 *
387 * The input hash is much less sensitive than the output hash. All
388 * that we want of it is that it be a good non-cryptographic hash;
389 * i.e. it not produce collisions when fed "random" data of the sort
390 * we expect to see. As long as the pool state differs for different
391 * inputs, we have preserved the input entropy and done a good job.
392 * The fact that an intelligent attacker can construct inputs that
393 * will produce controlled alterations to the pool's state is not
394 * important because we don't consider such inputs to contribute any
395 * randomness. The only property we need with respect to them is that
396 * the attacker can't increase his/her knowledge of the pool's state.
397 * Since all additions are reversible (knowing the final state and the
398 * input, you can reconstruct the initial state), if an attacker has
399 * any uncertainty about the initial state, he/she can only shuffle
400 * that uncertainty about, but never cause any collisions (which would
401 * decrease the uncertainty).
402 *
403 * The chosen system lets the state of the pool be (essentially) the input
404 * modulo the generator polymnomial. Now, for random primitive polynomials,
405 * this is a universal class of hash functions, meaning that the chance
406 * of a collision is limited by the attacker's knowledge of the generator
407 * polynomail, so if it is chosen at random, an attacker can never force
408 * a collision. Here, we use a fixed polynomial, but we *can* assume that
409 * ###--> it is unknown to the processes generating the input entropy. <-###
410 * Because of this important property, this is a good, collision-resistant
411 * hash; hash collisions will occur no more often than chance.
412 */
413
414/*
415 * Static global variables
416 */
417static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
418static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700419static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030421static bool debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422module_param(debug, bool, 0644);
Matt Mackall90b75ee2008-04-29 01:02:55 -0700423#define DEBUG_ENT(fmt, arg...) do { \
424 if (debug) \
425 printk(KERN_DEBUG "random %04d %04d %04d: " \
426 fmt,\
427 input_pool.entropy_count,\
428 blocking_pool.entropy_count,\
429 nonblocking_pool.entropy_count,\
430 ## arg); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432/**********************************************************************
433 *
434 * OS independent entropy store. Here are the functions which handle
435 * storing entropy in an entropy pool.
436 *
437 **********************************************************************/
438
439struct entropy_store;
440struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700441 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400442 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 __u32 *pool;
444 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 struct entropy_store *pull;
446
447 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400448 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700449 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400450 unsigned short add_ptr;
451 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800452 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400453 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400454 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400455 unsigned int limit:1;
456 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000457 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458};
459
460static __u32 input_pool_data[INPUT_POOL_WORDS];
461static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
462static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
463
464static struct entropy_store input_pool = {
465 .poolinfo = &poolinfo_table[0],
466 .name = "input",
467 .limit = 1,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200468 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 .pool = input_pool_data
470};
471
472static struct entropy_store blocking_pool = {
473 .poolinfo = &poolinfo_table[1],
474 .name = "blocking",
475 .limit = 1,
476 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200477 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 .pool = blocking_pool_data
479};
480
481static struct entropy_store nonblocking_pool = {
482 .poolinfo = &poolinfo_table[1],
483 .name = "nonblocking",
484 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200485 .lock = __SPIN_LOCK_UNLOCKED(nonblocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 .pool = nonblocking_pool_data
487};
488
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400489static __u32 const twist_table[8] = {
490 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
491 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700494 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700496 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 *
498 * The pool is stirred with a primitive polynomial of the appropriate
499 * degree, and then twisted. We twist by three bits at a time because
500 * it's cheap to do so and helps slightly in the expected case where
501 * the entropy is concentrated in the low-order bits.
502 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400503static void _mix_pool_bytes(struct entropy_store *r, const void *in,
504 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
Matt Mackall993ba212008-04-29 01:03:04 -0700506 unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700507 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700509 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700510 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 tap1 = r->poolinfo->tap1;
513 tap2 = r->poolinfo->tap2;
514 tap3 = r->poolinfo->tap3;
515 tap4 = r->poolinfo->tap4;
516 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
Theodore Ts'o902c0982012-07-04 10:38:30 -0400518 smp_rmb();
519 input_rotate = ACCESS_ONCE(r->input_rotate);
520 i = ACCESS_ONCE(r->add_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
Matt Mackalle68e5b62008-04-29 01:03:05 -0700522 /* mix one byte at a time to simplify size handling and churn faster */
523 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400524 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700525 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
527 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700528 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 w ^= r->pool[(i + tap1) & wordmask];
530 w ^= r->pool[(i + tap2) & wordmask];
531 w ^= r->pool[(i + tap3) & wordmask];
532 w ^= r->pool[(i + tap4) & wordmask];
533 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700534
535 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700537
538 /*
539 * Normally, we add 7 bits of rotation to the pool.
540 * At the beginning of the pool, add an extra 7 bits
541 * rotation, so that successive passes spread the
542 * input bits across the pool evenly.
543 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400544 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 }
546
Theodore Ts'o902c0982012-07-04 10:38:30 -0400547 ACCESS_ONCE(r->input_rotate) = input_rotate;
548 ACCESS_ONCE(r->add_ptr) = i;
549 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Matt Mackall993ba212008-04-29 01:03:04 -0700551 if (out)
552 for (j = 0; j < 16; j++)
Matt Mackalle68e5b62008-04-29 01:03:05 -0700553 ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554}
555
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400556static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o902c0982012-07-04 10:38:30 -0400557 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400559 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
560 _mix_pool_bytes(r, in, nbytes, out);
561}
562
563static void mix_pool_bytes(struct entropy_store *r, const void *in,
564 int nbytes, __u8 out[64])
565{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400566 unsigned long flags;
567
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400568 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400569 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400570 _mix_pool_bytes(r, in, nbytes, out);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400571 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572}
573
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400574struct fast_pool {
575 __u32 pool[4];
576 unsigned long last;
577 unsigned short count;
578 unsigned char rotate;
579 unsigned char last_timer_intr;
580};
581
582/*
583 * This is a fast mixing routine used by the interrupt randomness
584 * collector. It's hardcoded for an 128 bit pool and assumes that any
585 * locks that might be needed are taken by the caller.
586 */
587static void fast_mix(struct fast_pool *f, const void *in, int nbytes)
588{
589 const char *bytes = in;
590 __u32 w;
591 unsigned i = f->count;
592 unsigned input_rotate = f->rotate;
593
594 while (nbytes--) {
595 w = rol32(*bytes++, input_rotate & 31) ^ f->pool[i & 3] ^
596 f->pool[(i + 1) & 3];
597 f->pool[i & 3] = (w >> 3) ^ twist_table[w & 7];
598 input_rotate += (i++ & 3) ? 7 : 14;
599 }
600 f->count = i;
601 f->rotate = input_rotate;
602}
603
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400605 * Credit (or debit) the entropy store with n bits of entropy.
606 * Use credit_entropy_bits_safe() if the value comes from userspace
607 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700609static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400611 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400612 const int pool_size = r->poolinfo->poolfracbits;
613 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
Matt Mackalladc782d2008-04-29 01:03:07 -0700615 if (!nbits)
616 return;
617
Matt Mackalladc782d2008-04-29 01:03:07 -0700618 DEBUG_ENT("added %d entropy credits to %s\n", nbits, r->name);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400619retry:
620 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400621 if (nfrac < 0) {
622 /* Debit */
623 entropy_count += nfrac;
624 } else {
625 /*
626 * Credit: we have to account for the possibility of
627 * overwriting already present entropy. Even in the
628 * ideal case of pure Shannon entropy, new contributions
629 * approach the full value asymptotically:
630 *
631 * entropy <- entropy + (pool_size - entropy) *
632 * (1 - exp(-add_entropy/pool_size))
633 *
634 * For add_entropy <= pool_size/2 then
635 * (1 - exp(-add_entropy/pool_size)) >=
636 * (add_entropy/pool_size)*0.7869...
637 * so we can approximate the exponential with
638 * 3/4*add_entropy/pool_size and still be on the
639 * safe side by adding at most pool_size/2 at a time.
640 *
641 * The use of pool_size-2 in the while statement is to
642 * prevent rounding artifacts from making the loop
643 * arbitrarily long; this limits the loop to log2(pool_size)*2
644 * turns no matter how large nbits is.
645 */
646 int pnfrac = nfrac;
647 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
648 /* The +2 corresponds to the /4 in the denominator */
649
650 do {
651 unsigned int anfrac = min(pnfrac, pool_size/2);
652 unsigned int add =
653 ((pool_size - entropy_count)*anfrac*3) >> s;
654
655 entropy_count += add;
656 pnfrac -= anfrac;
657 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
658 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400659
Andrew Morton8b76f462008-09-02 14:36:14 -0700660 if (entropy_count < 0) {
Matt Mackalladc782d2008-04-29 01:03:07 -0700661 DEBUG_ENT("negative entropy/overflow\n");
Andrew Morton8b76f462008-09-02 14:36:14 -0700662 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400663 } else if (entropy_count > pool_size)
664 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400665 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
666 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400668 if (!r->initialized && nbits > 0) {
669 r->entropy_total += nbits;
670 if (r->entropy_total > 128)
671 r->initialized = 1;
672 }
673
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400674 trace_credit_entropy_bits(r->name, nbits,
675 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400676 r->entropy_total, _RET_IP_);
677
Matt Mackall88c730d2008-04-29 01:02:56 -0700678 /* should we wake readers? */
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400679 if (r == &input_pool &&
680 (entropy_count >> ENTROPY_SHIFT) >= random_read_wakeup_thresh) {
Matt Mackall88c730d2008-04-29 01:02:56 -0700681 wake_up_interruptible(&random_read_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700682 kill_fasync(&fasync, SIGIO, POLL_IN);
683 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684}
685
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400686static void credit_entropy_bits_safe(struct entropy_store *r, int nbits)
687{
688 const int nbits_max = (int)(~0U >> (ENTROPY_SHIFT + 1));
689
690 /* Cap the value to avoid overflows */
691 nbits = min(nbits, nbits_max);
692 nbits = max(nbits, -nbits_max);
693
694 credit_entropy_bits(r, nbits);
695}
696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697/*********************************************************************
698 *
699 * Entropy input management
700 *
701 *********************************************************************/
702
703/* There is one of these per entropy source */
704struct timer_rand_state {
705 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -0700706 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 unsigned dont_count_entropy:1;
708};
709
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400710/*
711 * Add device- or boot-specific data to the input and nonblocking
712 * pools to help initialize them to unique values.
713 *
714 * None of this adds any entropy, it is meant to avoid the
715 * problem of the nonblocking pool having similar initial state
716 * across largely identical devices.
717 */
718void add_device_randomness(const void *buf, unsigned int size)
719{
Theodore Ts'o61875f32013-09-21 13:58:22 -0400720 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400721 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400722
Theodore Ts'o59108952013-09-12 14:10:25 -0400723 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400724 spin_lock_irqsave(&input_pool.lock, flags);
725 _mix_pool_bytes(&input_pool, buf, size, NULL);
726 _mix_pool_bytes(&input_pool, &time, sizeof(time), NULL);
727 spin_unlock_irqrestore(&input_pool.lock, flags);
728
729 spin_lock_irqsave(&nonblocking_pool.lock, flags);
730 _mix_pool_bytes(&nonblocking_pool, buf, size, NULL);
731 _mix_pool_bytes(&nonblocking_pool, &time, sizeof(time), NULL);
732 spin_unlock_irqrestore(&nonblocking_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400733}
734EXPORT_SYMBOL(add_device_randomness);
735
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700736static struct timer_rand_state input_timer_state;
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738/*
739 * This function adds entropy to the entropy "pool" by using timing
740 * delays. It uses the timer_rand_state structure to make an estimate
741 * of how many bits of entropy this call has added to the pool.
742 *
743 * The number "num" is also added to the pool - it should somehow describe
744 * the type of event which just happened. This is currently 0-255 for
745 * keyboard scan codes, and 256 upwards for interrupts.
746 *
747 */
748static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
749{
750 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -0800752 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 unsigned num;
754 } sample;
755 long delta, delta2, delta3;
756
757 preempt_disable();
758 /* if over the trickle threshold, use only 1 in 4096 samples */
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400759 if (ENTROPY_BITS(&input_pool) > trickle_thresh &&
Christoph Lameterb29c6172010-12-06 11:40:06 -0600760 ((__this_cpu_inc_return(trickle_count) - 1) & 0xfff))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 goto out;
762
763 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -0400764 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 sample.num = num;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400766 mix_pool_bytes(&input_pool, &sample, sizeof(sample), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
768 /*
769 * Calculate number of bits of randomness we probably added.
770 * We take into account the first, second and third-order deltas
771 * in order to make our estimate.
772 */
773
774 if (!state->dont_count_entropy) {
775 delta = sample.jiffies - state->last_time;
776 state->last_time = sample.jiffies;
777
778 delta2 = delta - state->last_delta;
779 state->last_delta = delta;
780
781 delta3 = delta2 - state->last_delta2;
782 state->last_delta2 = delta2;
783
784 if (delta < 0)
785 delta = -delta;
786 if (delta2 < 0)
787 delta2 = -delta2;
788 if (delta3 < 0)
789 delta3 = -delta3;
790 if (delta > delta2)
791 delta = delta2;
792 if (delta > delta3)
793 delta = delta3;
794
795 /*
796 * delta is now minimum absolute delta.
797 * Round down by 1 bit on general principles,
798 * and limit entropy entimate to 12 bits.
799 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700800 credit_entropy_bits(&input_pool,
801 min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803out:
804 preempt_enable();
805}
806
Stephen Hemmingerd2515752006-01-11 12:17:38 -0800807void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 unsigned int value)
809{
810 static unsigned char last_value;
811
812 /* ignore autorepeat and the like */
813 if (value == last_value)
814 return;
815
816 DEBUG_ENT("input event\n");
817 last_value = value;
818 add_timer_randomness(&input_timer_state,
819 (type << 4) ^ code ^ (code >> 4) ^ value);
820}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400821EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400823static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
824
825void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400827 struct entropy_store *r;
828 struct fast_pool *fast_pool = &__get_cpu_var(irq_randomness);
829 struct pt_regs *regs = get_irq_regs();
830 unsigned long now = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -0400831 __u32 input[4], cycles = random_get_entropy();
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700832
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400833 input[0] = cycles ^ jiffies;
834 input[1] = irq;
835 if (regs) {
836 __u64 ip = instruction_pointer(regs);
837 input[2] = ip;
838 input[3] = ip >> 32;
839 }
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700840
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400841 fast_mix(fast_pool, input, sizeof(input));
842
843 if ((fast_pool->count & 1023) &&
844 !time_after(now, fast_pool->last + HZ))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 return;
846
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400847 fast_pool->last = now;
848
849 r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400850 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool), NULL);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400851 /*
852 * If we don't have a valid cycle counter, and we see
853 * back-to-back timer interrupts, then skip giving credit for
854 * any entropy.
855 */
856 if (cycles == 0) {
857 if (irq_flags & __IRQF_TIMER) {
858 if (fast_pool->last_timer_intr)
859 return;
860 fast_pool->last_timer_intr = 1;
861 } else
862 fast_pool->last_timer_intr = 0;
863 }
864 credit_entropy_bits(r, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865}
866
David Howells93614012006-09-30 20:45:40 +0200867#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868void add_disk_randomness(struct gendisk *disk)
869{
870 if (!disk || !disk->random)
871 return;
872 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +0200873 DEBUG_ENT("disk event %d:%d\n",
874 MAJOR(disk_devt(disk)), MINOR(disk_devt(disk)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875
Tejun Heof331c022008-09-03 09:01:48 +0200876 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877}
David Howells93614012006-09-30 20:45:40 +0200878#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880/*********************************************************************
881 *
882 * Entropy extraction routines
883 *
884 *********************************************************************/
885
Matt Mackall90b75ee2008-04-29 01:02:55 -0700886static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 size_t nbytes, int min, int rsvd);
888
889/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300890 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 * from the primary pool to the secondary extraction pool. We make
892 * sure we pull enough for a 'catastrophic reseed'.
893 */
894static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
895{
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400896 __u32 tmp[OUTPUT_POOL_WORDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897
Theodore Ts'of5c27422013-09-22 15:14:32 -0400898 if (r->limit == 0 && random_min_urandom_seed) {
899 unsigned long now = jiffies;
900
901 if (time_before(now,
902 r->last_pulled + random_min_urandom_seed * HZ))
903 return;
904 r->last_pulled = now;
905 }
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400906 if (r->pull &&
907 r->entropy_count < (nbytes << (ENTROPY_SHIFT + 3)) &&
908 r->entropy_count < r->poolinfo->poolfracbits) {
Matt Mackall5a021e92007-07-19 11:30:14 -0700909 /* If we're limited, always leave two wakeup worth's BITS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
Matt Mackall5a021e92007-07-19 11:30:14 -0700911 int bytes = nbytes;
912
913 /* pull at least as many as BYTES as wakeup BITS */
914 bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
915 /* but never more than the buffer size */
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400916 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
918 DEBUG_ENT("going to reseed %s with %d bits "
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200919 "(%zu of %d requested)\n",
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400920 r->name, bytes * 8, nbytes * 8,
921 r->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400923 bytes = extract_entropy(r->pull, tmp, bytes,
Matt Mackall90b75ee2008-04-29 01:02:55 -0700924 random_read_wakeup_thresh / 8, rsvd);
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400925 mix_pool_bytes(r, tmp, bytes, NULL);
Matt Mackalladc782d2008-04-29 01:03:07 -0700926 credit_entropy_bits(r, bytes*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 }
928}
929
930/*
931 * These functions extracts randomness from the "entropy pool", and
932 * returns it in a buffer.
933 *
934 * The min parameter specifies the minimum amount we can pull before
935 * failing to avoid races that defeat catastrophic reseeding while the
936 * reserved parameter indicates how much entropy we must leave in the
937 * pool after each pull to avoid starving other readers.
938 *
939 * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
940 */
941
942static size_t account(struct entropy_store *r, size_t nbytes, int min,
943 int reserved)
944{
945 unsigned long flags;
Theodore Ts'ob9809552013-03-04 11:59:12 -0500946 int wakeup_write = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400947 int have_bytes;
948 int entropy_count, orig;
949 size_t ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 /* Hold lock while accounting */
952 spin_lock_irqsave(&r->lock, flags);
953
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400954 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200955 DEBUG_ENT("trying to extract %zu bits from %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 nbytes * 8, r->name);
957
958 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -0700959retry:
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400960 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
961 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
962 ibytes = nbytes;
963 if (have_bytes < min + reserved) {
964 ibytes = 0;
965 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 /* If limited, never pull more than available */
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400967 if (r->limit && ibytes + reserved >= have_bytes)
968 ibytes = have_bytes - reserved;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400970 if (have_bytes >= ibytes + reserved)
971 entropy_count -= ibytes << (ENTROPY_SHIFT + 3);
972 else
973 entropy_count = reserved << (ENTROPY_SHIFT + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400975 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
976 goto retry;
977
978 if ((r->entropy_count >> ENTROPY_SHIFT)
979 < random_write_wakeup_thresh)
Theodore Ts'ob9809552013-03-04 11:59:12 -0500980 wakeup_write = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 }
982
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200983 DEBUG_ENT("debiting %zu entropy credits from %s%s\n",
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400984 ibytes * 8, r->name, r->limit ? "" : " (unlimited)");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985
986 spin_unlock_irqrestore(&r->lock, flags);
987
Theodore Ts'ob9809552013-03-04 11:59:12 -0500988 if (wakeup_write) {
989 wake_up_interruptible(&random_write_wait);
990 kill_fasync(&fasync, SIGIO, POLL_OUT);
991 }
992
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400993 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994}
995
996static void extract_buf(struct entropy_store *r, __u8 *out)
997{
Matt Mackall602b6ae2007-05-29 21:54:27 -0500998 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400999 union {
1000 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001001 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001002 } hash;
1003 __u32 workspace[SHA_WORKSPACE_WORDS];
Matt Mackalle68e5b62008-04-29 01:03:05 -07001004 __u8 extract[64];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001005 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001007 /* Generate a hash across the pool, 16 words (512 bits) at a time */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001008 sha_init(hash.w);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001009 spin_lock_irqsave(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001010 for (i = 0; i < r->poolinfo->poolwords; i += 16)
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001011 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
1013 /*
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001014 * If we have a architectural hardware random number
1015 * generator, mix that in, too.
1016 */
1017 for (i = 0; i < LONGS(20); i++) {
1018 unsigned long v;
1019 if (!arch_get_random_long(&v))
1020 break;
1021 hash.l[i] ^= v;
1022 }
1023
1024 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001025 * We mix the hash back into the pool to prevent backtracking
1026 * attacks (where the attacker knows the state of the pool
1027 * plus the current outputs, and attempts to find previous
1028 * ouputs), unless the hash function can be inverted. By
1029 * mixing at least a SHA1 worth of hash data back, we make
1030 * brute-forcing the feedback as hard as brute-forcing the
1031 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001033 __mix_pool_bytes(r, hash.w, sizeof(hash.w), extract);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001034 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001035
1036 /*
1037 * To avoid duplicates, we atomically extract a portion of the
1038 * pool while mixing, and hash one final time.
1039 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001040 sha_transform(hash.w, extract, workspace);
Matt Mackallffd8d3f2008-04-29 01:02:59 -07001041 memset(extract, 0, sizeof(extract));
1042 memset(workspace, 0, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
1044 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001045 * In case the hash function has some recognizable output
1046 * pattern, we fold it in half. Thus, we always feed back
1047 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001049 hash.w[0] ^= hash.w[3];
1050 hash.w[1] ^= hash.w[4];
1051 hash.w[2] ^= rol32(hash.w[2], 16);
1052
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001053 memcpy(out, &hash, EXTRACT_SIZE);
1054 memset(&hash, 0, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055}
1056
Matt Mackall90b75ee2008-04-29 01:02:55 -07001057static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001058 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059{
1060 ssize_t ret = 0, i;
1061 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001062 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001064 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001065 if (fips_enabled) {
1066 spin_lock_irqsave(&r->lock, flags);
1067 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001068 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001069 spin_unlock_irqrestore(&r->lock, flags);
1070 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001071 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001072 xfer_secondary_pool(r, EXTRACT_SIZE);
1073 extract_buf(r, tmp);
1074 spin_lock_irqsave(&r->lock, flags);
1075 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1076 }
1077 spin_unlock_irqrestore(&r->lock, flags);
1078 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001079
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001080 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 xfer_secondary_pool(r, nbytes);
1082 nbytes = account(r, nbytes, min, reserved);
1083
1084 while (nbytes) {
1085 extract_buf(r, tmp);
Neil Horman5b739ef2009-06-18 19:50:21 +08001086
Matt Mackalle954bc92010-05-20 19:55:01 +10001087 if (fips_enabled) {
Neil Horman5b739ef2009-06-18 19:50:21 +08001088 spin_lock_irqsave(&r->lock, flags);
1089 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1090 panic("Hardware RNG duplicated output!\n");
1091 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1092 spin_unlock_irqrestore(&r->lock, flags);
1093 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 i = min_t(int, nbytes, EXTRACT_SIZE);
1095 memcpy(buf, tmp, i);
1096 nbytes -= i;
1097 buf += i;
1098 ret += i;
1099 }
1100
1101 /* Wipe data just returned from memory */
1102 memset(tmp, 0, sizeof(tmp));
1103
1104 return ret;
1105}
1106
1107static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1108 size_t nbytes)
1109{
1110 ssize_t ret = 0, i;
1111 __u8 tmp[EXTRACT_SIZE];
1112
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001113 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 xfer_secondary_pool(r, nbytes);
1115 nbytes = account(r, nbytes, 0, 0);
1116
1117 while (nbytes) {
1118 if (need_resched()) {
1119 if (signal_pending(current)) {
1120 if (ret == 0)
1121 ret = -ERESTARTSYS;
1122 break;
1123 }
1124 schedule();
1125 }
1126
1127 extract_buf(r, tmp);
1128 i = min_t(int, nbytes, EXTRACT_SIZE);
1129 if (copy_to_user(buf, tmp, i)) {
1130 ret = -EFAULT;
1131 break;
1132 }
1133
1134 nbytes -= i;
1135 buf += i;
1136 ret += i;
1137 }
1138
1139 /* Wipe data just returned from memory */
1140 memset(tmp, 0, sizeof(tmp));
1141
1142 return ret;
1143}
1144
1145/*
1146 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001147 * number of good random numbers, suitable for key generation, seeding
1148 * TCP sequence numbers, etc. It does not use the hw random number
1149 * generator, if available; use get_random_bytes_arch() for that.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 */
1151void get_random_bytes(void *buf, int nbytes)
1152{
Theodore Ts'o59108952013-09-12 14:10:25 -04001153 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001154 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
1155}
1156EXPORT_SYMBOL(get_random_bytes);
1157
1158/*
1159 * This function will use the architecture-specific hardware random
1160 * number generator if it is available. The arch-specific hw RNG will
1161 * almost certainly be faster than what we can do in software, but it
1162 * is impossible to verify that it is implemented securely (as
1163 * opposed, to, say, the AES encryption of a sequence number using a
1164 * key known by the NSA). So it's useful if we need the speed, but
1165 * only if we're willing to trust the hardware manufacturer not to
1166 * have put in a back door.
1167 */
1168void get_random_bytes_arch(void *buf, int nbytes)
1169{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001170 char *p = buf;
1171
Theodore Ts'o59108952013-09-12 14:10:25 -04001172 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001173 while (nbytes) {
1174 unsigned long v;
1175 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001176
H. Peter Anvin63d77172011-07-31 13:54:50 -07001177 if (!arch_get_random_long(&v))
1178 break;
1179
Luck, Tonybd29e562011-11-16 10:50:56 -08001180 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001181 p += chunk;
1182 nbytes -= chunk;
1183 }
1184
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001185 if (nbytes)
1186 extract_entropy(&nonblocking_pool, p, nbytes, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001188EXPORT_SYMBOL(get_random_bytes_arch);
1189
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190
1191/*
1192 * init_std_data - initialize pool with system data
1193 *
1194 * @r: pool to initialize
1195 *
1196 * This function clears the pool's entropy count and mixes some system
1197 * data into the pool to prepare it for use. The pool is not cleared
1198 * as that can only decrease the entropy in the pool.
1199 */
1200static void init_std_data(struct entropy_store *r)
1201{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001202 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001203 ktime_t now = ktime_get_real();
1204 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 r->entropy_count = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001207 r->entropy_total = 0;
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001208 r->last_data_init = 0;
Theodore Ts'of5c27422013-09-22 15:14:32 -04001209 r->last_pulled = jiffies;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001210 mix_pool_bytes(r, &now, sizeof(now), NULL);
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001211 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
Theodore Ts'o902c0982012-07-04 10:38:30 -04001212 if (!arch_get_random_long(&rv))
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001213 break;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001214 mix_pool_bytes(r, &rv, sizeof(rv), NULL);
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001215 }
Theodore Ts'o902c0982012-07-04 10:38:30 -04001216 mix_pool_bytes(r, utsname(), sizeof(*(utsname())), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217}
1218
Tony Luckcbc96b72012-07-23 09:47:57 -07001219/*
1220 * Note that setup_arch() may call add_device_randomness()
1221 * long before we get here. This allows seeding of the pools
1222 * with some platform dependent data very early in the boot
1223 * process. But it limits our options here. We must use
1224 * statically allocated structures that already have all
1225 * initializations complete at compile time. We should also
1226 * take care not to overwrite the precious per platform data
1227 * we were given.
1228 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001229static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230{
1231 init_std_data(&input_pool);
1232 init_std_data(&blocking_pool);
1233 init_std_data(&nonblocking_pool);
1234 return 0;
1235}
1236module_init(rand_initialize);
1237
David Howells93614012006-09-30 20:45:40 +02001238#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239void rand_initialize_disk(struct gendisk *disk)
1240{
1241 struct timer_rand_state *state;
1242
1243 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001244 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 * source.
1246 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001247 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1248 if (state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 disk->random = state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250}
David Howells93614012006-09-30 20:45:40 +02001251#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252
1253static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001254random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255{
1256 ssize_t n, retval = 0, count = 0;
1257
1258 if (nbytes == 0)
1259 return 0;
1260
1261 while (nbytes > 0) {
1262 n = nbytes;
1263 if (n > SEC_XFER_SIZE)
1264 n = SEC_XFER_SIZE;
1265
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001266 DEBUG_ENT("reading %zu bits\n", n*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
1268 n = extract_entropy_user(&blocking_pool, buf, n);
1269
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001270 if (n < 0) {
1271 retval = n;
1272 break;
1273 }
1274
1275 DEBUG_ENT("read got %zd bits (%zd still needed)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 n*8, (nbytes-n)*8);
1277
1278 if (n == 0) {
1279 if (file->f_flags & O_NONBLOCK) {
1280 retval = -EAGAIN;
1281 break;
1282 }
1283
1284 DEBUG_ENT("sleeping?\n");
1285
1286 wait_event_interruptible(random_read_wait,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001287 ENTROPY_BITS(&input_pool) >=
1288 random_read_wakeup_thresh);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
1290 DEBUG_ENT("awake\n");
1291
1292 if (signal_pending(current)) {
1293 retval = -ERESTARTSYS;
1294 break;
1295 }
1296
1297 continue;
1298 }
1299
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 count += n;
1301 buf += n;
1302 nbytes -= n;
1303 break; /* This break makes the device work */
1304 /* like a named pipe */
1305 }
1306
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 return (count ? count : retval);
1308}
1309
1310static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001311urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312{
1313 return extract_entropy_user(&nonblocking_pool, buf, nbytes);
1314}
1315
1316static unsigned int
1317random_poll(struct file *file, poll_table * wait)
1318{
1319 unsigned int mask;
1320
1321 poll_wait(file, &random_read_wait, wait);
1322 poll_wait(file, &random_write_wait, wait);
1323 mask = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001324 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 mask |= POLLIN | POLLRDNORM;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001326 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 mask |= POLLOUT | POLLWRNORM;
1328 return mask;
1329}
1330
Matt Mackall7f397dc2007-05-29 21:58:10 -05001331static int
1332write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1333{
1334 size_t bytes;
1335 __u32 buf[16];
1336 const char __user *p = buffer;
1337
1338 while (count > 0) {
1339 bytes = min(count, sizeof(buf));
1340 if (copy_from_user(&buf, p, bytes))
1341 return -EFAULT;
1342
1343 count -= bytes;
1344 p += bytes;
1345
Theodore Ts'o902c0982012-07-04 10:38:30 -04001346 mix_pool_bytes(r, buf, bytes, NULL);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001347 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001348 }
1349
1350 return 0;
1351}
1352
Matt Mackall90b75ee2008-04-29 01:02:55 -07001353static ssize_t random_write(struct file *file, const char __user *buffer,
1354 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001356 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357
Matt Mackall7f397dc2007-05-29 21:58:10 -05001358 ret = write_pool(&blocking_pool, buffer, count);
1359 if (ret)
1360 return ret;
1361 ret = write_pool(&nonblocking_pool, buffer, count);
1362 if (ret)
1363 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Matt Mackall7f397dc2007-05-29 21:58:10 -05001365 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366}
1367
Matt Mackall43ae4862008-04-29 01:02:58 -07001368static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369{
1370 int size, ent_count;
1371 int __user *p = (int __user *)arg;
1372 int retval;
1373
1374 switch (cmd) {
1375 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001376 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001377 ent_count = ENTROPY_BITS(&input_pool);
1378 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 return -EFAULT;
1380 return 0;
1381 case RNDADDTOENTCNT:
1382 if (!capable(CAP_SYS_ADMIN))
1383 return -EPERM;
1384 if (get_user(ent_count, p))
1385 return -EFAULT;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001386 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 return 0;
1388 case RNDADDENTROPY:
1389 if (!capable(CAP_SYS_ADMIN))
1390 return -EPERM;
1391 if (get_user(ent_count, p++))
1392 return -EFAULT;
1393 if (ent_count < 0)
1394 return -EINVAL;
1395 if (get_user(size, p++))
1396 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001397 retval = write_pool(&input_pool, (const char __user *)p,
1398 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 if (retval < 0)
1400 return retval;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001401 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 return 0;
1403 case RNDZAPENTCNT:
1404 case RNDCLEARPOOL:
1405 /* Clear the entropy pool counters. */
1406 if (!capable(CAP_SYS_ADMIN))
1407 return -EPERM;
Matt Mackall53c3f632008-04-29 01:02:58 -07001408 rand_initialize();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 return 0;
1410 default:
1411 return -EINVAL;
1412 }
1413}
1414
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001415static int random_fasync(int fd, struct file *filp, int on)
1416{
1417 return fasync_helper(fd, filp, on, &fasync);
1418}
1419
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001420const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 .read = random_read,
1422 .write = random_write,
1423 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001424 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001425 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001426 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427};
1428
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001429const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 .read = urandom_read,
1431 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001432 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001433 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001434 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435};
1436
1437/***************************************************************
1438 * Random UUID interface
1439 *
1440 * Used here for a Boot ID, but can be useful for other kernel
1441 * drivers.
1442 ***************************************************************/
1443
1444/*
1445 * Generate random UUID
1446 */
1447void generate_random_uuid(unsigned char uuid_out[16])
1448{
1449 get_random_bytes(uuid_out, 16);
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05001450 /* Set UUID version to 4 --- truly random generation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1452 /* Set the UUID variant to DCE */
1453 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1454}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455EXPORT_SYMBOL(generate_random_uuid);
1456
1457/********************************************************************
1458 *
1459 * Sysctl interface
1460 *
1461 ********************************************************************/
1462
1463#ifdef CONFIG_SYSCTL
1464
1465#include <linux/sysctl.h>
1466
1467static int min_read_thresh = 8, min_write_thresh;
1468static int max_read_thresh = INPUT_POOL_WORDS * 32;
1469static int max_write_thresh = INPUT_POOL_WORDS * 32;
1470static char sysctl_bootid[16];
1471
1472/*
1473 * These functions is used to return both the bootid UUID, and random
1474 * UUID. The difference is in whether table->data is NULL; if it is,
1475 * then a new UUID is generated and returned to the user.
1476 *
1477 * If the user accesses this via the proc interface, it will be returned
1478 * as an ASCII string in the standard UUID format. If accesses via the
1479 * sysctl system call, it is returned as 16 bytes of binary data.
1480 */
Joe Perchesa1514272013-06-13 19:37:35 -07001481static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 void __user *buffer, size_t *lenp, loff_t *ppos)
1483{
Joe Perchesa1514272013-06-13 19:37:35 -07001484 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 unsigned char buf[64], tmp_uuid[16], *uuid;
1486
1487 uuid = table->data;
1488 if (!uuid) {
1489 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001491 } else {
1492 static DEFINE_SPINLOCK(bootid_spinlock);
1493
1494 spin_lock(&bootid_spinlock);
1495 if (!uuid[8])
1496 generate_random_uuid(uuid);
1497 spin_unlock(&bootid_spinlock);
1498 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
Joe Perches35900772009-12-14 18:01:11 -08001500 sprintf(buf, "%pU", uuid);
1501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 fake_table.data = buf;
1503 fake_table.maxlen = sizeof(buf);
1504
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001505 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506}
1507
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001508/*
1509 * Return entropy available scaled to integral bits
1510 */
1511static int proc_do_entropy(ctl_table *table, int write,
1512 void __user *buffer, size_t *lenp, loff_t *ppos)
1513{
1514 ctl_table fake_table;
1515 int entropy_count;
1516
1517 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
1518
1519 fake_table.data = &entropy_count;
1520 fake_table.maxlen = sizeof(entropy_count);
1521
1522 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1523}
1524
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07001526extern struct ctl_table random_table[];
1527struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 .procname = "poolsize",
1530 .data = &sysctl_poolsize,
1531 .maxlen = sizeof(int),
1532 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001533 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 },
1535 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 .procname = "entropy_avail",
1537 .maxlen = sizeof(int),
1538 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001539 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 .data = &input_pool.entropy_count,
1541 },
1542 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 .procname = "read_wakeup_threshold",
1544 .data = &random_read_wakeup_thresh,
1545 .maxlen = sizeof(int),
1546 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001547 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 .extra1 = &min_read_thresh,
1549 .extra2 = &max_read_thresh,
1550 },
1551 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 .procname = "write_wakeup_threshold",
1553 .data = &random_write_wakeup_thresh,
1554 .maxlen = sizeof(int),
1555 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001556 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 .extra1 = &min_write_thresh,
1558 .extra2 = &max_write_thresh,
1559 },
1560 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04001561 .procname = "urandom_min_reseed_secs",
1562 .data = &random_min_urandom_seed,
1563 .maxlen = sizeof(int),
1564 .mode = 0644,
1565 .proc_handler = proc_dointvec,
1566 },
1567 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 .procname = "boot_id",
1569 .data = &sysctl_bootid,
1570 .maxlen = 16,
1571 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001572 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 },
1574 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 .procname = "uuid",
1576 .maxlen = 16,
1577 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001578 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 },
Eric W. Biederman894d2492009-11-05 14:34:02 -08001580 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581};
1582#endif /* CONFIG_SYSCTL */
1583
David S. Miller6e5714e2011-08-03 20:50:44 -07001584static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
Theodore Ts'o47d06e52013-09-10 10:52:35 -04001586int random_int_secret_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587{
David S. Miller6e5714e2011-08-03 20:50:44 -07001588 get_random_bytes(random_int_secret, sizeof(random_int_secret));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 return 0;
1590}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
1592/*
1593 * Get a random word for internal kernel use only. Similar to urandom but
1594 * with the goal of minimal entropy pool depletion. As a result, the random
1595 * value is not cryptographically secure but for several uses the cost of
1596 * depleting entropy is too high
1597 */
Theodore Ts'o74feec52012-07-06 14:03:18 -04001598static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599unsigned int get_random_int(void)
1600{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001601 __u32 *hash;
David S. Miller6e5714e2011-08-03 20:50:44 -07001602 unsigned int ret;
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001603
H. Peter Anvin63d77172011-07-31 13:54:50 -07001604 if (arch_get_random_int(&ret))
1605 return ret;
1606
1607 hash = get_cpu_var(get_random_int_hash);
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001608
Theodore Ts'o61875f32013-09-21 13:58:22 -04001609 hash[0] += current->pid + jiffies + random_get_entropy();
David S. Miller6e5714e2011-08-03 20:50:44 -07001610 md5_transform(hash, random_int_secret);
1611 ret = hash[0];
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001612 put_cpu_var(get_random_int_hash);
1613
1614 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615}
Andy Shevchenko16c7fa02013-04-30 15:27:30 -07001616EXPORT_SYMBOL(get_random_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617
1618/*
1619 * randomize_range() returns a start address such that
1620 *
1621 * [...... <range> .....]
1622 * start end
1623 *
1624 * a <range> with size "len" starting at the return value is inside in the
1625 * area defined by [start, end], but is otherwise randomized.
1626 */
1627unsigned long
1628randomize_range(unsigned long start, unsigned long end, unsigned long len)
1629{
1630 unsigned long range = end - len - start;
1631
1632 if (end <= start + len)
1633 return 0;
1634 return PAGE_ALIGN(get_random_int() % range + start);
1635}