blob: 7ae7ea65da6874eedc21c4719a32d6d2ba9fcacb [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/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400325 * Originally, we used a primitive polynomial of degree .poolwords
326 * over GF(2). The taps for various sizes are defined below. They
327 * were chosen to be evenly spaced except for the last tap, which is 1
328 * to get the twisting happening as fast as possible.
329 *
330 * For the purposes of better mixing, we use the CRC-32 polynomial as
331 * well to make a (modified) twisted Generalized Feedback Shift
332 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
333 * generators. ACM Transactions on Modeling and Computer Simulation
334 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
335 * GFSR generators II. ACM Transactions on Mdeling and Computer
336 * Simulation 4:254-266)
337 *
338 * Thanks to Colin Plumb for suggesting this.
339 *
340 * The mixing operation is much less sensitive than the output hash,
341 * where we use SHA-1. All that we want of mixing operation is that
342 * it be a good non-cryptographic hash; i.e. it not produce collisions
343 * when fed "random" data of the sort we expect to see. As long as
344 * the pool state differs for different inputs, we have preserved the
345 * input entropy and done a good job. The fact that an intelligent
346 * attacker can construct inputs that will produce controlled
347 * alterations to the pool's state is not important because we don't
348 * consider such inputs to contribute any randomness. The only
349 * property we need with respect to them is that the attacker can't
350 * increase his/her knowledge of the pool's state. Since all
351 * additions are reversible (knowing the final state and the input,
352 * you can reconstruct the initial state), if an attacker has any
353 * uncertainty about the initial state, he/she can only shuffle that
354 * uncertainty about, but never cause any collisions (which would
355 * decrease the uncertainty).
356 *
357 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
358 * Videau in their paper, "The Linux Pseudorandom Number Generator
359 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
360 * paper, they point out that we are not using a true Twisted GFSR,
361 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
362 * is, with only three taps, instead of the six that we are using).
363 * As a result, the resulting polynomial is neither primitive nor
364 * irreducible, and hence does not have a maximal period over
365 * GF(2**32). They suggest a slight change to the generator
366 * polynomial which improves the resulting TGFSR polynomial to be
367 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 */
369static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400370 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
371#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 int tap1, tap2, tap3, tap4, tap5;
373} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400374 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
375 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
376 { S(128), 104, 76, 51, 25, 1 },
377 /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
378 /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
379 { S(32), 26, 19, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380#if 0
381 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400382 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400385 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
387 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400388 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400391 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400394 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400396 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400399 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400402 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
404 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400405 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406#endif
407};
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 * Static global variables
411 */
412static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
413static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700414static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030416static bool debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417module_param(debug, bool, 0644);
Matt Mackall90b75ee2008-04-29 01:02:55 -0700418#define DEBUG_ENT(fmt, arg...) do { \
419 if (debug) \
420 printk(KERN_DEBUG "random %04d %04d %04d: " \
421 fmt,\
422 input_pool.entropy_count,\
423 blocking_pool.entropy_count,\
424 nonblocking_pool.entropy_count,\
425 ## arg); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
427/**********************************************************************
428 *
429 * OS independent entropy store. Here are the functions which handle
430 * storing entropy in an entropy pool.
431 *
432 **********************************************************************/
433
434struct entropy_store;
435struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700436 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400437 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 __u32 *pool;
439 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 struct entropy_store *pull;
441
442 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400443 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700444 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400445 unsigned short add_ptr;
446 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800447 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400448 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400449 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400450 unsigned int limit:1;
451 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000452 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453};
454
455static __u32 input_pool_data[INPUT_POOL_WORDS];
456static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
457static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
458
459static struct entropy_store input_pool = {
460 .poolinfo = &poolinfo_table[0],
461 .name = "input",
462 .limit = 1,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200463 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 .pool = input_pool_data
465};
466
467static struct entropy_store blocking_pool = {
468 .poolinfo = &poolinfo_table[1],
469 .name = "blocking",
470 .limit = 1,
471 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200472 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 .pool = blocking_pool_data
474};
475
476static struct entropy_store nonblocking_pool = {
477 .poolinfo = &poolinfo_table[1],
478 .name = "nonblocking",
479 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200480 .lock = __SPIN_LOCK_UNLOCKED(nonblocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 .pool = nonblocking_pool_data
482};
483
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400484static __u32 const twist_table[8] = {
485 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
486 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
487
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700489 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700491 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 *
493 * The pool is stirred with a primitive polynomial of the appropriate
494 * degree, and then twisted. We twist by three bits at a time because
495 * it's cheap to do so and helps slightly in the expected case where
496 * the entropy is concentrated in the low-order bits.
497 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400498static void _mix_pool_bytes(struct entropy_store *r, const void *in,
499 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500{
Matt Mackall993ba212008-04-29 01:03:04 -0700501 unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700502 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700504 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700505 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 tap1 = r->poolinfo->tap1;
508 tap2 = r->poolinfo->tap2;
509 tap3 = r->poolinfo->tap3;
510 tap4 = r->poolinfo->tap4;
511 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Theodore Ts'o902c0982012-07-04 10:38:30 -0400513 smp_rmb();
514 input_rotate = ACCESS_ONCE(r->input_rotate);
515 i = ACCESS_ONCE(r->add_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
Matt Mackalle68e5b62008-04-29 01:03:05 -0700517 /* mix one byte at a time to simplify size handling and churn faster */
518 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400519 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700520 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
522 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700523 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 w ^= r->pool[(i + tap1) & wordmask];
525 w ^= r->pool[(i + tap2) & wordmask];
526 w ^= r->pool[(i + tap3) & wordmask];
527 w ^= r->pool[(i + tap4) & wordmask];
528 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700529
530 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700532
533 /*
534 * Normally, we add 7 bits of rotation to the pool.
535 * At the beginning of the pool, add an extra 7 bits
536 * rotation, so that successive passes spread the
537 * input bits across the pool evenly.
538 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400539 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 }
541
Theodore Ts'o902c0982012-07-04 10:38:30 -0400542 ACCESS_ONCE(r->input_rotate) = input_rotate;
543 ACCESS_ONCE(r->add_ptr) = i;
544 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Matt Mackall993ba212008-04-29 01:03:04 -0700546 if (out)
547 for (j = 0; j < 16; j++)
Matt Mackalle68e5b62008-04-29 01:03:05 -0700548 ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549}
550
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400551static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o902c0982012-07-04 10:38:30 -0400552 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400554 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
555 _mix_pool_bytes(r, in, nbytes, out);
556}
557
558static void mix_pool_bytes(struct entropy_store *r, const void *in,
559 int nbytes, __u8 out[64])
560{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400561 unsigned long flags;
562
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400563 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400564 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400565 _mix_pool_bytes(r, in, nbytes, out);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400566 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567}
568
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400569struct fast_pool {
570 __u32 pool[4];
571 unsigned long last;
572 unsigned short count;
573 unsigned char rotate;
574 unsigned char last_timer_intr;
575};
576
577/*
578 * This is a fast mixing routine used by the interrupt randomness
579 * collector. It's hardcoded for an 128 bit pool and assumes that any
580 * locks that might be needed are taken by the caller.
581 */
Theodore Ts'o655b2262013-09-22 15:24:02 -0400582static void fast_mix(struct fast_pool *f, __u32 input[4])
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400583{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400584 __u32 w;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400585 unsigned input_rotate = f->rotate;
586
Theodore Ts'o655b2262013-09-22 15:24:02 -0400587 w = rol32(input[0], input_rotate) ^ f->pool[0] ^ f->pool[3];
588 f->pool[0] = (w >> 3) ^ twist_table[w & 7];
589 input_rotate = (input_rotate + 14) & 31;
590 w = rol32(input[1], input_rotate) ^ f->pool[1] ^ f->pool[0];
591 f->pool[1] = (w >> 3) ^ twist_table[w & 7];
592 input_rotate = (input_rotate + 7) & 31;
593 w = rol32(input[2], input_rotate) ^ f->pool[2] ^ f->pool[1];
594 f->pool[2] = (w >> 3) ^ twist_table[w & 7];
595 input_rotate = (input_rotate + 7) & 31;
596 w = rol32(input[3], input_rotate) ^ f->pool[3] ^ f->pool[2];
597 f->pool[3] = (w >> 3) ^ twist_table[w & 7];
598 input_rotate = (input_rotate + 7) & 31;
599
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400600 f->rotate = input_rotate;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400601 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400602}
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'o655b2262013-09-22 15:24:02 -0400831 cycles_t cycles = random_get_entropy();
832 __u32 input[4], c_high, j_high;
833 __u64 ip;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700834
Theodore Ts'o655b2262013-09-22 15:24:02 -0400835 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
836 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
837 input[0] = cycles ^ j_high ^ irq;
838 input[1] = now ^ c_high;
839 ip = regs ? instruction_pointer(regs) : _RET_IP_;
840 input[2] = ip;
841 input[3] = ip >> 32;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700842
Theodore Ts'o655b2262013-09-22 15:24:02 -0400843 fast_mix(fast_pool, input);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400844
Theodore Ts'o655b2262013-09-22 15:24:02 -0400845 if ((fast_pool->count & 63) && !time_after(now, fast_pool->last + HZ))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 return;
847
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400848 fast_pool->last = now;
849
850 r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400851 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool), NULL);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400852 /*
853 * If we don't have a valid cycle counter, and we see
854 * back-to-back timer interrupts, then skip giving credit for
855 * any entropy.
856 */
857 if (cycles == 0) {
858 if (irq_flags & __IRQF_TIMER) {
859 if (fast_pool->last_timer_intr)
860 return;
861 fast_pool->last_timer_intr = 1;
862 } else
863 fast_pool->last_timer_intr = 0;
864 }
865 credit_entropy_bits(r, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866}
867
David Howells93614012006-09-30 20:45:40 +0200868#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869void add_disk_randomness(struct gendisk *disk)
870{
871 if (!disk || !disk->random)
872 return;
873 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +0200874 DEBUG_ENT("disk event %d:%d\n",
875 MAJOR(disk_devt(disk)), MINOR(disk_devt(disk)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
Tejun Heof331c022008-09-03 09:01:48 +0200877 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878}
David Howells93614012006-09-30 20:45:40 +0200879#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881/*********************************************************************
882 *
883 * Entropy extraction routines
884 *
885 *********************************************************************/
886
Matt Mackall90b75ee2008-04-29 01:02:55 -0700887static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 size_t nbytes, int min, int rsvd);
889
890/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300891 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 * from the primary pool to the secondary extraction pool. We make
893 * sure we pull enough for a 'catastrophic reseed'.
894 */
895static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
896{
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400897 __u32 tmp[OUTPUT_POOL_WORDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898
Theodore Ts'of5c27422013-09-22 15:14:32 -0400899 if (r->limit == 0 && random_min_urandom_seed) {
900 unsigned long now = jiffies;
901
902 if (time_before(now,
903 r->last_pulled + random_min_urandom_seed * HZ))
904 return;
905 r->last_pulled = now;
906 }
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400907 if (r->pull &&
908 r->entropy_count < (nbytes << (ENTROPY_SHIFT + 3)) &&
909 r->entropy_count < r->poolinfo->poolfracbits) {
Matt Mackall5a021e92007-07-19 11:30:14 -0700910 /* If we're limited, always leave two wakeup worth's BITS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
Matt Mackall5a021e92007-07-19 11:30:14 -0700912 int bytes = nbytes;
913
914 /* pull at least as many as BYTES as wakeup BITS */
915 bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
916 /* but never more than the buffer size */
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400917 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919 DEBUG_ENT("going to reseed %s with %d bits "
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200920 "(%zu of %d requested)\n",
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400921 r->name, bytes * 8, nbytes * 8,
922 r->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400924 bytes = extract_entropy(r->pull, tmp, bytes,
Matt Mackall90b75ee2008-04-29 01:02:55 -0700925 random_read_wakeup_thresh / 8, rsvd);
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400926 mix_pool_bytes(r, tmp, bytes, NULL);
Matt Mackalladc782d2008-04-29 01:03:07 -0700927 credit_entropy_bits(r, bytes*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 }
929}
930
931/*
932 * These functions extracts randomness from the "entropy pool", and
933 * returns it in a buffer.
934 *
935 * The min parameter specifies the minimum amount we can pull before
936 * failing to avoid races that defeat catastrophic reseeding while the
937 * reserved parameter indicates how much entropy we must leave in the
938 * pool after each pull to avoid starving other readers.
939 *
940 * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
941 */
942
943static size_t account(struct entropy_store *r, size_t nbytes, int min,
944 int reserved)
945{
946 unsigned long flags;
Theodore Ts'ob9809552013-03-04 11:59:12 -0500947 int wakeup_write = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400948 int have_bytes;
949 int entropy_count, orig;
950 size_t ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 /* Hold lock while accounting */
953 spin_lock_irqsave(&r->lock, flags);
954
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400955 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200956 DEBUG_ENT("trying to extract %zu bits from %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 nbytes * 8, r->name);
958
959 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -0700960retry:
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400961 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
962 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
963 ibytes = nbytes;
964 if (have_bytes < min + reserved) {
965 ibytes = 0;
966 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 /* If limited, never pull more than available */
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400968 if (r->limit && ibytes + reserved >= have_bytes)
969 ibytes = have_bytes - reserved;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400971 if (have_bytes >= ibytes + reserved)
972 entropy_count -= ibytes << (ENTROPY_SHIFT + 3);
973 else
974 entropy_count = reserved << (ENTROPY_SHIFT + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400976 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
977 goto retry;
978
979 if ((r->entropy_count >> ENTROPY_SHIFT)
980 < random_write_wakeup_thresh)
Theodore Ts'ob9809552013-03-04 11:59:12 -0500981 wakeup_write = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 }
983
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200984 DEBUG_ENT("debiting %zu entropy credits from %s%s\n",
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400985 ibytes * 8, r->name, r->limit ? "" : " (unlimited)");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
987 spin_unlock_irqrestore(&r->lock, flags);
988
Theodore Ts'ob9809552013-03-04 11:59:12 -0500989 if (wakeup_write) {
990 wake_up_interruptible(&random_write_wait);
991 kill_fasync(&fasync, SIGIO, POLL_OUT);
992 }
993
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400994 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995}
996
997static void extract_buf(struct entropy_store *r, __u8 *out)
998{
Matt Mackall602b6ae2007-05-29 21:54:27 -0500999 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001000 union {
1001 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001002 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001003 } hash;
1004 __u32 workspace[SHA_WORKSPACE_WORDS];
Matt Mackalle68e5b62008-04-29 01:03:05 -07001005 __u8 extract[64];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001006 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001008 /* Generate a hash across the pool, 16 words (512 bits) at a time */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001009 sha_init(hash.w);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001010 spin_lock_irqsave(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001011 for (i = 0; i < r->poolinfo->poolwords; i += 16)
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001012 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
1014 /*
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001015 * If we have a architectural hardware random number
1016 * generator, mix that in, too.
1017 */
1018 for (i = 0; i < LONGS(20); i++) {
1019 unsigned long v;
1020 if (!arch_get_random_long(&v))
1021 break;
1022 hash.l[i] ^= v;
1023 }
1024
1025 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001026 * We mix the hash back into the pool to prevent backtracking
1027 * attacks (where the attacker knows the state of the pool
1028 * plus the current outputs, and attempts to find previous
1029 * ouputs), unless the hash function can be inverted. By
1030 * mixing at least a SHA1 worth of hash data back, we make
1031 * brute-forcing the feedback as hard as brute-forcing the
1032 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001034 __mix_pool_bytes(r, hash.w, sizeof(hash.w), extract);
Theodore Ts'o902c0982012-07-04 10:38:30 -04001035 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001036
1037 /*
1038 * To avoid duplicates, we atomically extract a portion of the
1039 * pool while mixing, and hash one final time.
1040 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001041 sha_transform(hash.w, extract, workspace);
Matt Mackallffd8d3f2008-04-29 01:02:59 -07001042 memset(extract, 0, sizeof(extract));
1043 memset(workspace, 0, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
1045 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001046 * In case the hash function has some recognizable output
1047 * pattern, we fold it in half. Thus, we always feed back
1048 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001050 hash.w[0] ^= hash.w[3];
1051 hash.w[1] ^= hash.w[4];
1052 hash.w[2] ^= rol32(hash.w[2], 16);
1053
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001054 memcpy(out, &hash, EXTRACT_SIZE);
1055 memset(&hash, 0, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056}
1057
Matt Mackall90b75ee2008-04-29 01:02:55 -07001058static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001059 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060{
1061 ssize_t ret = 0, i;
1062 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001063 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001065 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001066 if (fips_enabled) {
1067 spin_lock_irqsave(&r->lock, flags);
1068 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001069 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001070 spin_unlock_irqrestore(&r->lock, flags);
1071 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001072 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001073 xfer_secondary_pool(r, EXTRACT_SIZE);
1074 extract_buf(r, tmp);
1075 spin_lock_irqsave(&r->lock, flags);
1076 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1077 }
1078 spin_unlock_irqrestore(&r->lock, flags);
1079 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001080
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001081 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 xfer_secondary_pool(r, nbytes);
1083 nbytes = account(r, nbytes, min, reserved);
1084
1085 while (nbytes) {
1086 extract_buf(r, tmp);
Neil Horman5b739ef2009-06-18 19:50:21 +08001087
Matt Mackalle954bc92010-05-20 19:55:01 +10001088 if (fips_enabled) {
Neil Horman5b739ef2009-06-18 19:50:21 +08001089 spin_lock_irqsave(&r->lock, flags);
1090 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1091 panic("Hardware RNG duplicated output!\n");
1092 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1093 spin_unlock_irqrestore(&r->lock, flags);
1094 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 i = min_t(int, nbytes, EXTRACT_SIZE);
1096 memcpy(buf, tmp, i);
1097 nbytes -= i;
1098 buf += i;
1099 ret += i;
1100 }
1101
1102 /* Wipe data just returned from memory */
1103 memset(tmp, 0, sizeof(tmp));
1104
1105 return ret;
1106}
1107
1108static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1109 size_t nbytes)
1110{
1111 ssize_t ret = 0, i;
1112 __u8 tmp[EXTRACT_SIZE];
1113
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001114 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 xfer_secondary_pool(r, nbytes);
1116 nbytes = account(r, nbytes, 0, 0);
1117
1118 while (nbytes) {
1119 if (need_resched()) {
1120 if (signal_pending(current)) {
1121 if (ret == 0)
1122 ret = -ERESTARTSYS;
1123 break;
1124 }
1125 schedule();
1126 }
1127
1128 extract_buf(r, tmp);
1129 i = min_t(int, nbytes, EXTRACT_SIZE);
1130 if (copy_to_user(buf, tmp, i)) {
1131 ret = -EFAULT;
1132 break;
1133 }
1134
1135 nbytes -= i;
1136 buf += i;
1137 ret += i;
1138 }
1139
1140 /* Wipe data just returned from memory */
1141 memset(tmp, 0, sizeof(tmp));
1142
1143 return ret;
1144}
1145
1146/*
1147 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001148 * number of good random numbers, suitable for key generation, seeding
1149 * TCP sequence numbers, etc. It does not use the hw random number
1150 * generator, if available; use get_random_bytes_arch() for that.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 */
1152void get_random_bytes(void *buf, int nbytes)
1153{
Theodore Ts'o59108952013-09-12 14:10:25 -04001154 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001155 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
1156}
1157EXPORT_SYMBOL(get_random_bytes);
1158
1159/*
1160 * This function will use the architecture-specific hardware random
1161 * number generator if it is available. The arch-specific hw RNG will
1162 * almost certainly be faster than what we can do in software, but it
1163 * is impossible to verify that it is implemented securely (as
1164 * opposed, to, say, the AES encryption of a sequence number using a
1165 * key known by the NSA). So it's useful if we need the speed, but
1166 * only if we're willing to trust the hardware manufacturer not to
1167 * have put in a back door.
1168 */
1169void get_random_bytes_arch(void *buf, int nbytes)
1170{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001171 char *p = buf;
1172
Theodore Ts'o59108952013-09-12 14:10:25 -04001173 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001174 while (nbytes) {
1175 unsigned long v;
1176 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001177
H. Peter Anvin63d77172011-07-31 13:54:50 -07001178 if (!arch_get_random_long(&v))
1179 break;
1180
Luck, Tonybd29e562011-11-16 10:50:56 -08001181 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001182 p += chunk;
1183 nbytes -= chunk;
1184 }
1185
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001186 if (nbytes)
1187 extract_entropy(&nonblocking_pool, p, nbytes, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001189EXPORT_SYMBOL(get_random_bytes_arch);
1190
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191
1192/*
1193 * init_std_data - initialize pool with system data
1194 *
1195 * @r: pool to initialize
1196 *
1197 * This function clears the pool's entropy count and mixes some system
1198 * data into the pool to prepare it for use. The pool is not cleared
1199 * as that can only decrease the entropy in the pool.
1200 */
1201static void init_std_data(struct entropy_store *r)
1202{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001203 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001204 ktime_t now = ktime_get_real();
1205 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 r->entropy_count = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001208 r->entropy_total = 0;
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001209 r->last_data_init = 0;
Theodore Ts'of5c27422013-09-22 15:14:32 -04001210 r->last_pulled = jiffies;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001211 mix_pool_bytes(r, &now, sizeof(now), NULL);
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001212 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
Theodore Ts'o902c0982012-07-04 10:38:30 -04001213 if (!arch_get_random_long(&rv))
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001214 break;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001215 mix_pool_bytes(r, &rv, sizeof(rv), NULL);
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001216 }
Theodore Ts'o902c0982012-07-04 10:38:30 -04001217 mix_pool_bytes(r, utsname(), sizeof(*(utsname())), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218}
1219
Tony Luckcbc96b72012-07-23 09:47:57 -07001220/*
1221 * Note that setup_arch() may call add_device_randomness()
1222 * long before we get here. This allows seeding of the pools
1223 * with some platform dependent data very early in the boot
1224 * process. But it limits our options here. We must use
1225 * statically allocated structures that already have all
1226 * initializations complete at compile time. We should also
1227 * take care not to overwrite the precious per platform data
1228 * we were given.
1229 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001230static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231{
1232 init_std_data(&input_pool);
1233 init_std_data(&blocking_pool);
1234 init_std_data(&nonblocking_pool);
1235 return 0;
1236}
1237module_init(rand_initialize);
1238
David Howells93614012006-09-30 20:45:40 +02001239#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240void rand_initialize_disk(struct gendisk *disk)
1241{
1242 struct timer_rand_state *state;
1243
1244 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001245 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 * source.
1247 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001248 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1249 if (state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 disk->random = state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251}
David Howells93614012006-09-30 20:45:40 +02001252#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
1254static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001255random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256{
1257 ssize_t n, retval = 0, count = 0;
1258
1259 if (nbytes == 0)
1260 return 0;
1261
1262 while (nbytes > 0) {
1263 n = nbytes;
1264 if (n > SEC_XFER_SIZE)
1265 n = SEC_XFER_SIZE;
1266
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001267 DEBUG_ENT("reading %zu bits\n", n*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268
1269 n = extract_entropy_user(&blocking_pool, buf, n);
1270
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001271 if (n < 0) {
1272 retval = n;
1273 break;
1274 }
1275
1276 DEBUG_ENT("read got %zd bits (%zd still needed)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 n*8, (nbytes-n)*8);
1278
1279 if (n == 0) {
1280 if (file->f_flags & O_NONBLOCK) {
1281 retval = -EAGAIN;
1282 break;
1283 }
1284
1285 DEBUG_ENT("sleeping?\n");
1286
1287 wait_event_interruptible(random_read_wait,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001288 ENTROPY_BITS(&input_pool) >=
1289 random_read_wakeup_thresh);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
1291 DEBUG_ENT("awake\n");
1292
1293 if (signal_pending(current)) {
1294 retval = -ERESTARTSYS;
1295 break;
1296 }
1297
1298 continue;
1299 }
1300
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 count += n;
1302 buf += n;
1303 nbytes -= n;
1304 break; /* This break makes the device work */
1305 /* like a named pipe */
1306 }
1307
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 return (count ? count : retval);
1309}
1310
1311static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001312urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313{
1314 return extract_entropy_user(&nonblocking_pool, buf, nbytes);
1315}
1316
1317static unsigned int
1318random_poll(struct file *file, poll_table * wait)
1319{
1320 unsigned int mask;
1321
1322 poll_wait(file, &random_read_wait, wait);
1323 poll_wait(file, &random_write_wait, wait);
1324 mask = 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001325 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 mask |= POLLIN | POLLRDNORM;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001327 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_thresh)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 mask |= POLLOUT | POLLWRNORM;
1329 return mask;
1330}
1331
Matt Mackall7f397dc2007-05-29 21:58:10 -05001332static int
1333write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1334{
1335 size_t bytes;
1336 __u32 buf[16];
1337 const char __user *p = buffer;
1338
1339 while (count > 0) {
1340 bytes = min(count, sizeof(buf));
1341 if (copy_from_user(&buf, p, bytes))
1342 return -EFAULT;
1343
1344 count -= bytes;
1345 p += bytes;
1346
Theodore Ts'o902c0982012-07-04 10:38:30 -04001347 mix_pool_bytes(r, buf, bytes, NULL);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001348 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001349 }
1350
1351 return 0;
1352}
1353
Matt Mackall90b75ee2008-04-29 01:02:55 -07001354static ssize_t random_write(struct file *file, const char __user *buffer,
1355 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001357 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358
Matt Mackall7f397dc2007-05-29 21:58:10 -05001359 ret = write_pool(&blocking_pool, buffer, count);
1360 if (ret)
1361 return ret;
1362 ret = write_pool(&nonblocking_pool, buffer, count);
1363 if (ret)
1364 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
Matt Mackall7f397dc2007-05-29 21:58:10 -05001366 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367}
1368
Matt Mackall43ae4862008-04-29 01:02:58 -07001369static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370{
1371 int size, ent_count;
1372 int __user *p = (int __user *)arg;
1373 int retval;
1374
1375 switch (cmd) {
1376 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001377 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001378 ent_count = ENTROPY_BITS(&input_pool);
1379 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 return -EFAULT;
1381 return 0;
1382 case RNDADDTOENTCNT:
1383 if (!capable(CAP_SYS_ADMIN))
1384 return -EPERM;
1385 if (get_user(ent_count, p))
1386 return -EFAULT;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001387 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 return 0;
1389 case RNDADDENTROPY:
1390 if (!capable(CAP_SYS_ADMIN))
1391 return -EPERM;
1392 if (get_user(ent_count, p++))
1393 return -EFAULT;
1394 if (ent_count < 0)
1395 return -EINVAL;
1396 if (get_user(size, p++))
1397 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001398 retval = write_pool(&input_pool, (const char __user *)p,
1399 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 if (retval < 0)
1401 return retval;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001402 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 return 0;
1404 case RNDZAPENTCNT:
1405 case RNDCLEARPOOL:
1406 /* Clear the entropy pool counters. */
1407 if (!capable(CAP_SYS_ADMIN))
1408 return -EPERM;
Matt Mackall53c3f632008-04-29 01:02:58 -07001409 rand_initialize();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 return 0;
1411 default:
1412 return -EINVAL;
1413 }
1414}
1415
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001416static int random_fasync(int fd, struct file *filp, int on)
1417{
1418 return fasync_helper(fd, filp, on, &fasync);
1419}
1420
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001421const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 .read = random_read,
1423 .write = random_write,
1424 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001425 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001426 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001427 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428};
1429
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001430const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 .read = urandom_read,
1432 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001433 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001434 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001435 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436};
1437
1438/***************************************************************
1439 * Random UUID interface
1440 *
1441 * Used here for a Boot ID, but can be useful for other kernel
1442 * drivers.
1443 ***************************************************************/
1444
1445/*
1446 * Generate random UUID
1447 */
1448void generate_random_uuid(unsigned char uuid_out[16])
1449{
1450 get_random_bytes(uuid_out, 16);
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05001451 /* Set UUID version to 4 --- truly random generation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1453 /* Set the UUID variant to DCE */
1454 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1455}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456EXPORT_SYMBOL(generate_random_uuid);
1457
1458/********************************************************************
1459 *
1460 * Sysctl interface
1461 *
1462 ********************************************************************/
1463
1464#ifdef CONFIG_SYSCTL
1465
1466#include <linux/sysctl.h>
1467
1468static int min_read_thresh = 8, min_write_thresh;
1469static int max_read_thresh = INPUT_POOL_WORDS * 32;
1470static int max_write_thresh = INPUT_POOL_WORDS * 32;
1471static char sysctl_bootid[16];
1472
1473/*
1474 * These functions is used to return both the bootid UUID, and random
1475 * UUID. The difference is in whether table->data is NULL; if it is,
1476 * then a new UUID is generated and returned to the user.
1477 *
1478 * If the user accesses this via the proc interface, it will be returned
1479 * as an ASCII string in the standard UUID format. If accesses via the
1480 * sysctl system call, it is returned as 16 bytes of binary data.
1481 */
Joe Perchesa1514272013-06-13 19:37:35 -07001482static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 void __user *buffer, size_t *lenp, loff_t *ppos)
1484{
Joe Perchesa1514272013-06-13 19:37:35 -07001485 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 unsigned char buf[64], tmp_uuid[16], *uuid;
1487
1488 uuid = table->data;
1489 if (!uuid) {
1490 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001492 } else {
1493 static DEFINE_SPINLOCK(bootid_spinlock);
1494
1495 spin_lock(&bootid_spinlock);
1496 if (!uuid[8])
1497 generate_random_uuid(uuid);
1498 spin_unlock(&bootid_spinlock);
1499 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
Joe Perches35900772009-12-14 18:01:11 -08001501 sprintf(buf, "%pU", uuid);
1502
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 fake_table.data = buf;
1504 fake_table.maxlen = sizeof(buf);
1505
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001506 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507}
1508
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001509/*
1510 * Return entropy available scaled to integral bits
1511 */
1512static int proc_do_entropy(ctl_table *table, int write,
1513 void __user *buffer, size_t *lenp, loff_t *ppos)
1514{
1515 ctl_table fake_table;
1516 int entropy_count;
1517
1518 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
1519
1520 fake_table.data = &entropy_count;
1521 fake_table.maxlen = sizeof(entropy_count);
1522
1523 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1524}
1525
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07001527extern struct ctl_table random_table[];
1528struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 .procname = "poolsize",
1531 .data = &sysctl_poolsize,
1532 .maxlen = sizeof(int),
1533 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001534 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 },
1536 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 .procname = "entropy_avail",
1538 .maxlen = sizeof(int),
1539 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001540 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 .data = &input_pool.entropy_count,
1542 },
1543 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 .procname = "read_wakeup_threshold",
1545 .data = &random_read_wakeup_thresh,
1546 .maxlen = sizeof(int),
1547 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001548 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 .extra1 = &min_read_thresh,
1550 .extra2 = &max_read_thresh,
1551 },
1552 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 .procname = "write_wakeup_threshold",
1554 .data = &random_write_wakeup_thresh,
1555 .maxlen = sizeof(int),
1556 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001557 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 .extra1 = &min_write_thresh,
1559 .extra2 = &max_write_thresh,
1560 },
1561 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04001562 .procname = "urandom_min_reseed_secs",
1563 .data = &random_min_urandom_seed,
1564 .maxlen = sizeof(int),
1565 .mode = 0644,
1566 .proc_handler = proc_dointvec,
1567 },
1568 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 .procname = "boot_id",
1570 .data = &sysctl_bootid,
1571 .maxlen = 16,
1572 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001573 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 },
1575 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 .procname = "uuid",
1577 .maxlen = 16,
1578 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001579 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 },
Eric W. Biederman894d2492009-11-05 14:34:02 -08001581 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582};
1583#endif /* CONFIG_SYSCTL */
1584
David S. Miller6e5714e2011-08-03 20:50:44 -07001585static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586
Theodore Ts'o47d06e52013-09-10 10:52:35 -04001587int random_int_secret_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588{
David S. Miller6e5714e2011-08-03 20:50:44 -07001589 get_random_bytes(random_int_secret, sizeof(random_int_secret));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 return 0;
1591}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
1593/*
1594 * Get a random word for internal kernel use only. Similar to urandom but
1595 * with the goal of minimal entropy pool depletion. As a result, the random
1596 * value is not cryptographically secure but for several uses the cost of
1597 * depleting entropy is too high
1598 */
Theodore Ts'o74feec52012-07-06 14:03:18 -04001599static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600unsigned int get_random_int(void)
1601{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001602 __u32 *hash;
David S. Miller6e5714e2011-08-03 20:50:44 -07001603 unsigned int ret;
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001604
H. Peter Anvin63d77172011-07-31 13:54:50 -07001605 if (arch_get_random_int(&ret))
1606 return ret;
1607
1608 hash = get_cpu_var(get_random_int_hash);
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001609
Theodore Ts'o61875f32013-09-21 13:58:22 -04001610 hash[0] += current->pid + jiffies + random_get_entropy();
David S. Miller6e5714e2011-08-03 20:50:44 -07001611 md5_transform(hash, random_int_secret);
1612 ret = hash[0];
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001613 put_cpu_var(get_random_int_hash);
1614
1615 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616}
Andy Shevchenko16c7fa02013-04-30 15:27:30 -07001617EXPORT_SYMBOL(get_random_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
1619/*
1620 * randomize_range() returns a start address such that
1621 *
1622 * [...... <range> .....]
1623 * start end
1624 *
1625 * a <range> with size "len" starting at the return value is inside in the
1626 * area defined by [start, end], but is otherwise randomized.
1627 */
1628unsigned long
1629randomize_range(unsigned long start, unsigned long end, unsigned long len)
1630{
1631 unsigned long range = end - len - start;
1632
1633 if (end <= start + len)
1634 return 0;
1635 return PAGE_ALIGN(get_random_int() % range + start);
1636}