blob: aa22fe551c2abe6b8857fa93dd60fd561fc1d36a [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>
Torsten Duwec84dbf62014-06-14 23:38:36 -0400253#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254#include <linux/percpu.h>
255#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800256#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400257#include <linux/ptrace.h>
Theodore Ts'oe6d49472012-07-05 10:21:01 -0400258#include <linux/kmemcheck.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400259#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200260#include <linux/irq.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262#include <asm/processor.h>
263#include <asm/uaccess.h>
264#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400265#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266#include <asm/io.h>
267
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400268#define CREATE_TRACE_POINTS
269#include <trace/events/random.h>
270
Theodore Ts'o43759d42014-06-14 21:43:13 -0400271/* #define ADD_INTERRUPT_BENCH */
272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273/*
274 * Configuration information
275 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400276#define INPUT_POOL_SHIFT 12
277#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
278#define OUTPUT_POOL_SHIFT 10
279#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
280#define SEC_XFER_SIZE 512
281#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Theodore Ts'o392a5462013-11-03 18:24:08 -0500283#define DEBUG_RANDOM_BOOT 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400285#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
286
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400288 * To allow fractional bits to be tracked, the entropy_count field is
289 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400290 *
291 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
292 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400293 */
294#define ENTROPY_SHIFT 3
295#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
296
297/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 * The minimum number of bits of entropy before we wake up a read on
299 * /dev/random. Should be enough to do a significant reseed.
300 */
Greg Price2132a962013-12-06 21:28:03 -0500301static int random_read_wakeup_bits = 64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
303/*
304 * If the entropy count falls under this number of bits, then we
305 * should wake up processes which are selecting or polling on write
306 * access to /dev/random.
307 */
Greg Price2132a962013-12-06 21:28:03 -0500308static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310/*
Greg Pricedfd38752013-11-29 14:58:06 -0500311 * The minimum number of seconds between urandom pool reseeding. We
Theodore Ts'of5c27422013-09-22 15:14:32 -0400312 * do this to limit the amount of entropy that can be drained from the
313 * input pool even if there are heavy demands on /dev/urandom.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400315static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400318 * Originally, we used a primitive polynomial of degree .poolwords
319 * over GF(2). The taps for various sizes are defined below. They
320 * were chosen to be evenly spaced except for the last tap, which is 1
321 * to get the twisting happening as fast as possible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400323 * For the purposes of better mixing, we use the CRC-32 polynomial as
324 * well to make a (modified) twisted Generalized Feedback Shift
325 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
326 * generators. ACM Transactions on Modeling and Computer Simulation
327 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
Greg Pricedfd38752013-11-29 14:58:06 -0500328 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400329 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 *
331 * Thanks to Colin Plumb for suggesting this.
332 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400333 * The mixing operation is much less sensitive than the output hash,
334 * where we use SHA-1. All that we want of mixing operation is that
335 * it be a good non-cryptographic hash; i.e. it not produce collisions
336 * when fed "random" data of the sort we expect to see. As long as
337 * the pool state differs for different inputs, we have preserved the
338 * input entropy and done a good job. The fact that an intelligent
339 * attacker can construct inputs that will produce controlled
340 * alterations to the pool's state is not important because we don't
341 * consider such inputs to contribute any randomness. The only
342 * property we need with respect to them is that the attacker can't
343 * increase his/her knowledge of the pool's state. Since all
344 * additions are reversible (knowing the final state and the input,
345 * you can reconstruct the initial state), if an attacker has any
346 * uncertainty about the initial state, he/she can only shuffle that
347 * uncertainty about, but never cause any collisions (which would
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 * decrease the uncertainty).
349 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400350 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
351 * Videau in their paper, "The Linux Pseudorandom Number Generator
352 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
353 * paper, they point out that we are not using a true Twisted GFSR,
354 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
355 * is, with only three taps, instead of the six that we are using).
356 * As a result, the resulting polynomial is neither primitive nor
357 * irreducible, and hence does not have a maximal period over
358 * GF(2**32). They suggest a slight change to the generator
359 * polynomial which improves the resulting TGFSR polynomial to be
360 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400363 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
364#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 int tap1, tap2, tap3, tap4, tap5;
366} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400367 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
368 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
369 { S(128), 104, 76, 51, 25, 1 },
370 /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
371 /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
372 { S(32), 26, 19, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373#if 0
374 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400375 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400378 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400381 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400384 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
386 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400387 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400389 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400392 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400395 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400398 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399#endif
400};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402/*
403 * Static global variables
404 */
405static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
406static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700407static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409/**********************************************************************
410 *
411 * OS independent entropy store. Here are the functions which handle
412 * storing entropy in an entropy pool.
413 *
414 **********************************************************************/
415
416struct entropy_store;
417struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700418 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400419 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 __u32 *pool;
421 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400423 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
425 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400426 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700427 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400428 unsigned short add_ptr;
429 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800430 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400431 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400432 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400433 unsigned int limit:1;
434 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000435 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436};
437
Theodore Ts'o6265e162013-10-03 01:08:15 -0400438static void push_to_pool(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439static __u32 input_pool_data[INPUT_POOL_WORDS];
440static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
441static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
442
443static struct entropy_store input_pool = {
444 .poolinfo = &poolinfo_table[0],
445 .name = "input",
446 .limit = 1,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200447 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 .pool = input_pool_data
449};
450
451static struct entropy_store blocking_pool = {
452 .poolinfo = &poolinfo_table[1],
453 .name = "blocking",
454 .limit = 1,
455 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200456 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400457 .pool = blocking_pool_data,
458 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
459 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460};
461
462static struct entropy_store nonblocking_pool = {
463 .poolinfo = &poolinfo_table[1],
464 .name = "nonblocking",
465 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200466 .lock = __SPIN_LOCK_UNLOCKED(nonblocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400467 .pool = nonblocking_pool_data,
468 .push_work = __WORK_INITIALIZER(nonblocking_pool.push_work,
469 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470};
471
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400472static __u32 const twist_table[8] = {
473 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
474 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700477 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700479 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 *
481 * The pool is stirred with a primitive polynomial of the appropriate
482 * degree, and then twisted. We twist by three bits at a time because
483 * it's cheap to do so and helps slightly in the expected case where
484 * the entropy is concentrated in the low-order bits.
485 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400486static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400487 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400489 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700490 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700492 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700493 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 tap1 = r->poolinfo->tap1;
496 tap2 = r->poolinfo->tap2;
497 tap3 = r->poolinfo->tap3;
498 tap4 = r->poolinfo->tap4;
499 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400501 input_rotate = r->input_rotate;
502 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
Matt Mackalle68e5b62008-04-29 01:03:05 -0700504 /* mix one byte at a time to simplify size handling and churn faster */
505 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400506 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700507 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700510 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 w ^= r->pool[(i + tap1) & wordmask];
512 w ^= r->pool[(i + tap2) & wordmask];
513 w ^= r->pool[(i + tap3) & wordmask];
514 w ^= r->pool[(i + tap4) & wordmask];
515 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700516
517 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700519
520 /*
521 * Normally, we add 7 bits of rotation to the pool.
522 * At the beginning of the pool, add an extra 7 bits
523 * rotation, so that successive passes spread the
524 * input bits across the pool evenly.
525 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400526 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 }
528
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400529 r->input_rotate = input_rotate;
530 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531}
532
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400533static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400534 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400536 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400537 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400538}
539
540static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400541 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400542{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400543 unsigned long flags;
544
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400545 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400546 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400547 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400548 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549}
550
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400551struct fast_pool {
552 __u32 pool[4];
553 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400554 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400555 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400556};
557
558/*
559 * This is a fast mixing routine used by the interrupt randomness
560 * collector. It's hardcoded for an 128 bit pool and assumes that any
561 * locks that might be needed are taken by the caller.
562 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400563static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400564{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400565 __u32 a = f->pool[0], b = f->pool[1];
566 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400567
Theodore Ts'o43759d42014-06-14 21:43:13 -0400568 a += b; c += d;
569 b = rol32(a, 6); d = rol32(c, 27);
570 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400571
Theodore Ts'o43759d42014-06-14 21:43:13 -0400572 a += b; c += d;
573 b = rol32(a, 16); d = rol32(c, 14);
574 d ^= a; b ^= c;
575
576 a += b; c += d;
577 b = rol32(a, 6); d = rol32(c, 27);
578 d ^= a; b ^= c;
579
580 a += b; c += d;
581 b = rol32(a, 16); d = rol32(c, 14);
582 d ^= a; b ^= c;
583
584 f->pool[0] = a; f->pool[1] = b;
585 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400586 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400587}
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400590 * Credit (or debit) the entropy store with n bits of entropy.
591 * Use credit_entropy_bits_safe() if the value comes from userspace
592 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700594static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400596 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400597 const int pool_size = r->poolinfo->poolfracbits;
598 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Matt Mackalladc782d2008-04-29 01:03:07 -0700600 if (!nbits)
601 return;
602
Theodore Ts'o902c0982012-07-04 10:38:30 -0400603retry:
604 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400605 if (nfrac < 0) {
606 /* Debit */
607 entropy_count += nfrac;
608 } else {
609 /*
610 * Credit: we have to account for the possibility of
611 * overwriting already present entropy. Even in the
612 * ideal case of pure Shannon entropy, new contributions
613 * approach the full value asymptotically:
614 *
615 * entropy <- entropy + (pool_size - entropy) *
616 * (1 - exp(-add_entropy/pool_size))
617 *
618 * For add_entropy <= pool_size/2 then
619 * (1 - exp(-add_entropy/pool_size)) >=
620 * (add_entropy/pool_size)*0.7869...
621 * so we can approximate the exponential with
622 * 3/4*add_entropy/pool_size and still be on the
623 * safe side by adding at most pool_size/2 at a time.
624 *
625 * The use of pool_size-2 in the while statement is to
626 * prevent rounding artifacts from making the loop
627 * arbitrarily long; this limits the loop to log2(pool_size)*2
628 * turns no matter how large nbits is.
629 */
630 int pnfrac = nfrac;
631 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
632 /* The +2 corresponds to the /4 in the denominator */
633
634 do {
635 unsigned int anfrac = min(pnfrac, pool_size/2);
636 unsigned int add =
637 ((pool_size - entropy_count)*anfrac*3) >> s;
638
639 entropy_count += add;
640 pnfrac -= anfrac;
641 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
642 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400643
Andrew Morton8b76f462008-09-02 14:36:14 -0700644 if (entropy_count < 0) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400645 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
646 r->name, entropy_count);
647 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700648 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400649 } else if (entropy_count > pool_size)
650 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400651 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
652 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Theodore Ts'o6265e162013-10-03 01:08:15 -0400654 r->entropy_total += nbits;
Linus Torvalds0891ad82013-11-16 10:19:15 -0800655 if (!r->initialized && r->entropy_total > 128) {
656 r->initialized = 1;
657 r->entropy_total = 0;
658 if (r == &nonblocking_pool) {
659 prandom_reseed_late();
660 pr_notice("random: %s pool is initialized\n", r->name);
Hannes Frederic Sowa4af712e2013-11-11 12:20:34 +0100661 }
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400662 }
663
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400664 trace_credit_entropy_bits(r->name, nbits,
665 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400666 r->entropy_total, _RET_IP_);
667
Theodore Ts'o6265e162013-10-03 01:08:15 -0400668 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500669 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400670
671 /* should we wake readers? */
Greg Price2132a962013-12-06 21:28:03 -0500672 if (entropy_bits >= random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400673 wake_up_interruptible(&random_read_wait);
674 kill_fasync(&fasync, SIGIO, POLL_IN);
675 }
676 /* If the input pool is getting full, send some
677 * entropy to the two output pools, flipping back and
678 * forth between them, until the output pools are 75%
679 * full.
680 */
Greg Price2132a962013-12-06 21:28:03 -0500681 if (entropy_bits > random_write_wakeup_bits &&
Theodore Ts'o6265e162013-10-03 01:08:15 -0400682 r->initialized &&
Greg Price2132a962013-12-06 21:28:03 -0500683 r->entropy_total >= 2*random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400684 static struct entropy_store *last = &blocking_pool;
685 struct entropy_store *other = &blocking_pool;
686
687 if (last == &blocking_pool)
688 other = &nonblocking_pool;
689 if (other->entropy_count <=
690 3 * other->poolinfo->poolfracbits / 4)
691 last = other;
692 if (last->entropy_count <=
693 3 * last->poolinfo->poolfracbits / 4) {
694 schedule_work(&last->push_work);
695 r->entropy_total = 0;
696 }
697 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700698 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699}
700
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400701static void credit_entropy_bits_safe(struct entropy_store *r, int nbits)
702{
703 const int nbits_max = (int)(~0U >> (ENTROPY_SHIFT + 1));
704
705 /* Cap the value to avoid overflows */
706 nbits = min(nbits, nbits_max);
707 nbits = max(nbits, -nbits_max);
708
709 credit_entropy_bits(r, nbits);
710}
711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712/*********************************************************************
713 *
714 * Entropy input management
715 *
716 *********************************************************************/
717
718/* There is one of these per entropy source */
719struct timer_rand_state {
720 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -0700721 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 unsigned dont_count_entropy:1;
723};
724
Theodore Ts'o644008d2013-11-03 16:40:53 -0500725#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
726
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400727/*
728 * Add device- or boot-specific data to the input and nonblocking
729 * pools to help initialize them to unique values.
730 *
731 * None of this adds any entropy, it is meant to avoid the
732 * problem of the nonblocking pool having similar initial state
733 * across largely identical devices.
734 */
735void add_device_randomness(const void *buf, unsigned int size)
736{
Theodore Ts'o61875f32013-09-21 13:58:22 -0400737 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400738 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400739
Theodore Ts'o59108952013-09-12 14:10:25 -0400740 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400741 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400742 _mix_pool_bytes(&input_pool, buf, size);
743 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400744 spin_unlock_irqrestore(&input_pool.lock, flags);
745
746 spin_lock_irqsave(&nonblocking_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400747 _mix_pool_bytes(&nonblocking_pool, buf, size);
748 _mix_pool_bytes(&nonblocking_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400749 spin_unlock_irqrestore(&nonblocking_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400750}
751EXPORT_SYMBOL(add_device_randomness);
752
Theodore Ts'o644008d2013-11-03 16:40:53 -0500753static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700754
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755/*
756 * This function adds entropy to the entropy "pool" by using timing
757 * delays. It uses the timer_rand_state structure to make an estimate
758 * of how many bits of entropy this call has added to the pool.
759 *
760 * The number "num" is also added to the pool - it should somehow describe
761 * the type of event which just happened. This is currently 0-255 for
762 * keyboard scan codes, and 256 upwards for interrupts.
763 *
764 */
765static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
766{
Theodore Ts'o40db23e2013-11-03 00:15:05 -0400767 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -0800770 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 unsigned num;
772 } sample;
773 long delta, delta2, delta3;
774
775 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
777 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -0400778 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 sample.num = num;
Theodore Ts'o40db23e2013-11-03 00:15:05 -0400780 r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -0400781 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
783 /*
784 * Calculate number of bits of randomness we probably added.
785 * We take into account the first, second and third-order deltas
786 * in order to make our estimate.
787 */
788
789 if (!state->dont_count_entropy) {
790 delta = sample.jiffies - state->last_time;
791 state->last_time = sample.jiffies;
792
793 delta2 = delta - state->last_delta;
794 state->last_delta = delta;
795
796 delta3 = delta2 - state->last_delta2;
797 state->last_delta2 = delta2;
798
799 if (delta < 0)
800 delta = -delta;
801 if (delta2 < 0)
802 delta2 = -delta2;
803 if (delta3 < 0)
804 delta3 = -delta3;
805 if (delta > delta2)
806 delta = delta2;
807 if (delta > delta3)
808 delta = delta3;
809
810 /*
811 * delta is now minimum absolute delta.
812 * Round down by 1 bit on general principles,
813 * and limit entropy entimate to 12 bits.
814 */
Theodore Ts'o40db23e2013-11-03 00:15:05 -0400815 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 preempt_enable();
818}
819
Stephen Hemmingerd2515752006-01-11 12:17:38 -0800820void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 unsigned int value)
822{
823 static unsigned char last_value;
824
825 /* ignore autorepeat and the like */
826 if (value == last_value)
827 return;
828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 last_value = value;
830 add_timer_randomness(&input_timer_state,
831 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400832 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400834EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400836static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
837
Theodore Ts'o43759d42014-06-14 21:43:13 -0400838#ifdef ADD_INTERRUPT_BENCH
839static unsigned long avg_cycles, avg_deviation;
840
841#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
842#define FIXED_1_2 (1 << (AVG_SHIFT-1))
843
844static void add_interrupt_bench(cycles_t start)
845{
846 long delta = random_get_entropy() - start;
847
848 /* Use a weighted moving average */
849 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
850 avg_cycles += delta;
851 /* And average deviation */
852 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
853 avg_deviation += delta;
854}
855#else
856#define add_interrupt_bench(x)
857#endif
858
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400859static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
860{
861 __u32 *ptr = (__u32 *) regs;
862
863 if (regs == NULL)
864 return 0;
865 if (f->reg_idx >= sizeof(struct pt_regs) / sizeof(__u32))
866 f->reg_idx = 0;
867 return *(ptr + f->reg_idx++);
868}
869
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400870void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400872 struct entropy_store *r;
873 struct fast_pool *fast_pool = &__get_cpu_var(irq_randomness);
874 struct pt_regs *regs = get_irq_regs();
875 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400876 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -0400877 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400878 __u64 ip;
H. Peter Anvin83664a62014-03-17 16:36:28 -0700879 unsigned long seed;
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400880 int credit = 0;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700881
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400882 if (cycles == 0)
883 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -0400884 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
885 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -0400886 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
887 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400888 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -0400889 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400890 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
891 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700892
Theodore Ts'o43759d42014-06-14 21:43:13 -0400893 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400894 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400895
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400896 if ((fast_pool->count < 64) &&
897 !time_after(now, fast_pool->last + HZ))
898 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400900 r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400901 if (!spin_trylock(&r->lock))
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400902 return;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400903
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400904 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -0400905 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
H. Peter Anvin83664a62014-03-17 16:36:28 -0700906
907 /*
908 * If we have architectural seed generator, produce a seed and
909 * add it to the pool. For the sake of paranoia count it as
910 * 50% entropic.
911 */
912 if (arch_get_random_seed_long(&seed)) {
Theodore Ts'o85608f82014-06-10 23:09:20 -0400913 __mix_pool_bytes(r, &seed, sizeof(seed));
H. Peter Anvin83664a62014-03-17 16:36:28 -0700914 credit += sizeof(seed) * 4;
915 }
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400916 spin_unlock(&r->lock);
917
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400918 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400919
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400920 /* award one bit for the contents of the fast pool */
921 credit_entropy_bits(r, credit + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922}
923
David Howells93614012006-09-30 20:45:40 +0200924#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925void add_disk_randomness(struct gendisk *disk)
926{
927 if (!disk || !disk->random)
928 return;
929 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +0200930 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400931 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -0700933EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +0200934#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936/*********************************************************************
937 *
938 * Entropy extraction routines
939 *
940 *********************************************************************/
941
Matt Mackall90b75ee2008-04-29 01:02:55 -0700942static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 size_t nbytes, int min, int rsvd);
944
945/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300946 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 * from the primary pool to the secondary extraction pool. We make
948 * sure we pull enough for a 'catastrophic reseed'.
949 */
Theodore Ts'o6265e162013-10-03 01:08:15 -0400950static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
952{
Theodore Ts'ocff85032014-06-10 23:18:16 -0400953 if (!r->pull ||
954 r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
955 r->entropy_count > r->poolinfo->poolfracbits)
956 return;
957
Theodore Ts'of5c27422013-09-22 15:14:32 -0400958 if (r->limit == 0 && random_min_urandom_seed) {
959 unsigned long now = jiffies;
960
961 if (time_before(now,
962 r->last_pulled + random_min_urandom_seed * HZ))
963 return;
964 r->last_pulled = now;
965 }
Theodore Ts'ocff85032014-06-10 23:18:16 -0400966
967 _xfer_secondary_pool(r, nbytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400968}
Matt Mackall5a021e92007-07-19 11:30:14 -0700969
Theodore Ts'o6265e162013-10-03 01:08:15 -0400970static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
971{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 __u32 tmp[OUTPUT_POOL_WORDS];
973
Greg Price2132a962013-12-06 21:28:03 -0500974 /* For /dev/random's pool, always leave two wakeups' worth */
975 int rsvd_bytes = r->limit ? 0 : random_read_wakeup_bits / 4;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400976 int bytes = nbytes;
Matt Mackall5a021e92007-07-19 11:30:14 -0700977
Greg Price2132a962013-12-06 21:28:03 -0500978 /* pull at least as much as a wakeup */
979 bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400980 /* but never more than the buffer size */
981 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400983 trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
984 ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
Theodore Ts'o6265e162013-10-03 01:08:15 -0400985 bytes = extract_entropy(r->pull, tmp, bytes,
Greg Price2132a962013-12-06 21:28:03 -0500986 random_read_wakeup_bits / 8, rsvd_bytes);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400987 mix_pool_bytes(r, tmp, bytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400988 credit_entropy_bits(r, bytes*8);
989}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Theodore Ts'o6265e162013-10-03 01:08:15 -0400991/*
992 * Used as a workqueue function so that when the input pool is getting
993 * full, we can "spill over" some entropy to the output pools. That
994 * way the output pools can store some of the excess entropy instead
995 * of letting it go to waste.
996 */
997static void push_to_pool(struct work_struct *work)
998{
999 struct entropy_store *r = container_of(work, struct entropy_store,
1000 push_work);
1001 BUG_ON(!r);
Greg Price2132a962013-12-06 21:28:03 -05001002 _xfer_secondary_pool(r, random_read_wakeup_bits/8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001003 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
1004 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005}
1006
1007/*
Greg Price19fa5be2013-11-29 15:50:06 -05001008 * This function decides how many bytes to actually take from the
1009 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011static size_t account(struct entropy_store *r, size_t nbytes, int min,
1012 int reserved)
1013{
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001014 int entropy_count, orig;
1015 size_t ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001017 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
1019 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001020retry:
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001021 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001022 ibytes = nbytes;
Greg Price0fb7a012013-12-05 19:32:19 -05001023 /* If limited, never pull more than available */
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001024 if (r->limit) {
1025 int have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
1026
1027 if ((have_bytes -= reserved) < 0)
1028 have_bytes = 0;
1029 ibytes = min_t(size_t, ibytes, have_bytes);
1030 }
Greg Price0fb7a012013-12-05 19:32:19 -05001031 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001032 ibytes = 0;
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001033 if ((entropy_count -= ibytes << (ENTROPY_SHIFT + 3)) < 0)
1034 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001035
Greg Price0fb7a012013-12-05 19:32:19 -05001036 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1037 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001039 trace_debit_entropy(r->name, 8 * ibytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001040 if (ibytes &&
Greg Price2132a962013-12-06 21:28:03 -05001041 (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
Theodore Ts'ob9809552013-03-04 11:59:12 -05001042 wake_up_interruptible(&random_write_wait);
1043 kill_fasync(&fasync, SIGIO, POLL_OUT);
1044 }
1045
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001046 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047}
1048
Greg Price19fa5be2013-11-29 15:50:06 -05001049/*
1050 * This function does the actual extraction for extract_entropy and
1051 * extract_entropy_user.
1052 *
1053 * Note: we assume that .poolwords is a multiple of 16 words.
1054 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055static void extract_buf(struct entropy_store *r, __u8 *out)
1056{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001057 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001058 union {
1059 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001060 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001061 } hash;
1062 __u32 workspace[SHA_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001063 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001066 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001067 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001068 */
Theodore Ts'o46884442013-12-17 21:16:39 -05001069 sha_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001070 for (i = 0; i < LONGS(20); i++) {
1071 unsigned long v;
1072 if (!arch_get_random_long(&v))
1073 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001074 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001075 }
1076
Theodore Ts'o46884442013-12-17 21:16:39 -05001077 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1078 spin_lock_irqsave(&r->lock, flags);
1079 for (i = 0; i < r->poolinfo->poolwords; i += 16)
1080 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1081
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001082 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001083 * We mix the hash back into the pool to prevent backtracking
1084 * attacks (where the attacker knows the state of the pool
1085 * plus the current outputs, and attempts to find previous
1086 * ouputs), unless the hash function can be inverted. By
1087 * mixing at least a SHA1 worth of hash data back, we make
1088 * brute-forcing the feedback as hard as brute-forcing the
1089 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001091 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001092 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001093
Matt Mackallffd8d3f2008-04-29 01:02:59 -07001094 memset(workspace, 0, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
1096 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001097 * In case the hash function has some recognizable output
1098 * pattern, we fold it in half. Thus, we always feed back
1099 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001101 hash.w[0] ^= hash.w[3];
1102 hash.w[1] ^= hash.w[4];
1103 hash.w[2] ^= rol32(hash.w[2], 16);
1104
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001105 memcpy(out, &hash, EXTRACT_SIZE);
1106 memset(&hash, 0, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107}
1108
Greg Price19fa5be2013-11-29 15:50:06 -05001109/*
1110 * This function extracts randomness from the "entropy pool", and
1111 * returns it in a buffer.
1112 *
1113 * The min parameter specifies the minimum amount we can pull before
1114 * failing to avoid races that defeat catastrophic reseeding while the
1115 * reserved parameter indicates how much entropy we must leave in the
1116 * pool after each pull to avoid starving other readers.
1117 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001118static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001119 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120{
1121 ssize_t ret = 0, i;
1122 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001123 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001125 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001126 if (fips_enabled) {
1127 spin_lock_irqsave(&r->lock, flags);
1128 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001129 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001130 spin_unlock_irqrestore(&r->lock, flags);
1131 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001132 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001133 xfer_secondary_pool(r, EXTRACT_SIZE);
1134 extract_buf(r, tmp);
1135 spin_lock_irqsave(&r->lock, flags);
1136 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1137 }
1138 spin_unlock_irqrestore(&r->lock, flags);
1139 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001140
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001141 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 xfer_secondary_pool(r, nbytes);
1143 nbytes = account(r, nbytes, min, reserved);
1144
1145 while (nbytes) {
1146 extract_buf(r, tmp);
Neil Horman5b739ef2009-06-18 19:50:21 +08001147
Matt Mackalle954bc92010-05-20 19:55:01 +10001148 if (fips_enabled) {
Neil Horman5b739ef2009-06-18 19:50:21 +08001149 spin_lock_irqsave(&r->lock, flags);
1150 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1151 panic("Hardware RNG duplicated output!\n");
1152 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1153 spin_unlock_irqrestore(&r->lock, flags);
1154 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 i = min_t(int, nbytes, EXTRACT_SIZE);
1156 memcpy(buf, tmp, i);
1157 nbytes -= i;
1158 buf += i;
1159 ret += i;
1160 }
1161
1162 /* Wipe data just returned from memory */
1163 memset(tmp, 0, sizeof(tmp));
1164
1165 return ret;
1166}
1167
Greg Price19fa5be2013-11-29 15:50:06 -05001168/*
1169 * This function extracts randomness from the "entropy pool", and
1170 * returns it in a userspace buffer.
1171 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1173 size_t nbytes)
1174{
1175 ssize_t ret = 0, i;
1176 __u8 tmp[EXTRACT_SIZE];
1177
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001178 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 xfer_secondary_pool(r, nbytes);
1180 nbytes = account(r, nbytes, 0, 0);
1181
1182 while (nbytes) {
1183 if (need_resched()) {
1184 if (signal_pending(current)) {
1185 if (ret == 0)
1186 ret = -ERESTARTSYS;
1187 break;
1188 }
1189 schedule();
1190 }
1191
1192 extract_buf(r, tmp);
1193 i = min_t(int, nbytes, EXTRACT_SIZE);
1194 if (copy_to_user(buf, tmp, i)) {
1195 ret = -EFAULT;
1196 break;
1197 }
1198
1199 nbytes -= i;
1200 buf += i;
1201 ret += i;
1202 }
1203
1204 /* Wipe data just returned from memory */
1205 memset(tmp, 0, sizeof(tmp));
1206
1207 return ret;
1208}
1209
1210/*
1211 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001212 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001213 * TCP sequence numbers, etc. It does not rely on the hardware random
1214 * number generator. For random bytes direct from the hardware RNG
1215 * (when available), use get_random_bytes_arch().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 */
1217void get_random_bytes(void *buf, int nbytes)
1218{
Theodore Ts'o392a5462013-11-03 18:24:08 -05001219#if DEBUG_RANDOM_BOOT > 0
1220 if (unlikely(nonblocking_pool.initialized == 0))
1221 printk(KERN_NOTICE "random: %pF get_random_bytes called "
1222 "with %d bits of entropy available\n",
1223 (void *) _RET_IP_,
1224 nonblocking_pool.entropy_total);
1225#endif
Theodore Ts'o59108952013-09-12 14:10:25 -04001226 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001227 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
1228}
1229EXPORT_SYMBOL(get_random_bytes);
1230
1231/*
1232 * This function will use the architecture-specific hardware random
1233 * number generator if it is available. The arch-specific hw RNG will
1234 * almost certainly be faster than what we can do in software, but it
1235 * is impossible to verify that it is implemented securely (as
1236 * opposed, to, say, the AES encryption of a sequence number using a
1237 * key known by the NSA). So it's useful if we need the speed, but
1238 * only if we're willing to trust the hardware manufacturer not to
1239 * have put in a back door.
1240 */
1241void get_random_bytes_arch(void *buf, int nbytes)
1242{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001243 char *p = buf;
1244
Theodore Ts'o59108952013-09-12 14:10:25 -04001245 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001246 while (nbytes) {
1247 unsigned long v;
1248 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001249
H. Peter Anvin63d77172011-07-31 13:54:50 -07001250 if (!arch_get_random_long(&v))
1251 break;
1252
Luck, Tonybd29e562011-11-16 10:50:56 -08001253 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001254 p += chunk;
1255 nbytes -= chunk;
1256 }
1257
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001258 if (nbytes)
1259 extract_entropy(&nonblocking_pool, p, nbytes, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001261EXPORT_SYMBOL(get_random_bytes_arch);
1262
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
1264/*
1265 * init_std_data - initialize pool with system data
1266 *
1267 * @r: pool to initialize
1268 *
1269 * This function clears the pool's entropy count and mixes some system
1270 * data into the pool to prepare it for use. The pool is not cleared
1271 * as that can only decrease the entropy in the pool.
1272 */
1273static void init_std_data(struct entropy_store *r)
1274{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001275 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001276 ktime_t now = ktime_get_real();
1277 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278
Theodore Ts'of5c27422013-09-22 15:14:32 -04001279 r->last_pulled = jiffies;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001280 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001281 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001282 if (!arch_get_random_seed_long(&rv) &&
1283 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001284 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001285 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001286 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001287 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288}
1289
Tony Luckcbc96b72012-07-23 09:47:57 -07001290/*
1291 * Note that setup_arch() may call add_device_randomness()
1292 * long before we get here. This allows seeding of the pools
1293 * with some platform dependent data very early in the boot
1294 * process. But it limits our options here. We must use
1295 * statically allocated structures that already have all
1296 * initializations complete at compile time. We should also
1297 * take care not to overwrite the precious per platform data
1298 * we were given.
1299 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001300static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301{
1302 init_std_data(&input_pool);
1303 init_std_data(&blocking_pool);
1304 init_std_data(&nonblocking_pool);
1305 return 0;
1306}
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001307early_initcall(rand_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
David Howells93614012006-09-30 20:45:40 +02001309#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310void rand_initialize_disk(struct gendisk *disk)
1311{
1312 struct timer_rand_state *state;
1313
1314 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001315 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 * source.
1317 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001318 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001319 if (state) {
1320 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001322 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323}
David Howells93614012006-09-30 20:45:40 +02001324#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
H. Peter Anvin331c6492014-03-17 16:36:29 -07001326/*
1327 * Attempt an emergency refill using arch_get_random_seed_long().
1328 *
1329 * As with add_interrupt_randomness() be paranoid and only
1330 * credit the output as 50% entropic.
1331 */
1332static int arch_random_refill(void)
1333{
1334 const unsigned int nlongs = 64; /* Arbitrary number */
1335 unsigned int n = 0;
1336 unsigned int i;
1337 unsigned long buf[nlongs];
1338
H. Peter Anvin7b878d42014-03-17 16:36:30 -07001339 if (!arch_has_random_seed())
1340 return 0;
1341
H. Peter Anvin331c6492014-03-17 16:36:29 -07001342 for (i = 0; i < nlongs; i++) {
1343 if (arch_get_random_seed_long(&buf[n]))
1344 n++;
1345 }
1346
1347 if (n) {
1348 unsigned int rand_bytes = n * sizeof(unsigned long);
1349
Theodore Ts'o85608f82014-06-10 23:09:20 -04001350 mix_pool_bytes(&input_pool, buf, rand_bytes);
H. Peter Anvin331c6492014-03-17 16:36:29 -07001351 credit_entropy_bits(&input_pool, rand_bytes*4);
1352 }
1353
1354 return n;
1355}
1356
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001358random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359{
Greg Price12ff3a52013-11-29 15:02:33 -05001360 ssize_t n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
1362 if (nbytes == 0)
1363 return 0;
1364
Greg Price12ff3a52013-11-29 15:02:33 -05001365 nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1366 while (1) {
1367 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1368 if (n < 0)
1369 return n;
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001370 trace_random_read(n*8, (nbytes-n)*8,
1371 ENTROPY_BITS(&blocking_pool),
1372 ENTROPY_BITS(&input_pool));
Greg Price12ff3a52013-11-29 15:02:33 -05001373 if (n > 0)
1374 return n;
H. Peter Anvin331c6492014-03-17 16:36:29 -07001375
Greg Price12ff3a52013-11-29 15:02:33 -05001376 /* Pool is (near) empty. Maybe wait and retry. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377
H. Peter Anvin331c6492014-03-17 16:36:29 -07001378 /* First try an emergency refill */
1379 if (arch_random_refill())
1380 continue;
1381
Greg Price12ff3a52013-11-29 15:02:33 -05001382 if (file->f_flags & O_NONBLOCK)
1383 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
Greg Price12ff3a52013-11-29 15:02:33 -05001385 wait_event_interruptible(random_read_wait,
1386 ENTROPY_BITS(&input_pool) >=
Greg Price2132a962013-12-06 21:28:03 -05001387 random_read_wakeup_bits);
Greg Price12ff3a52013-11-29 15:02:33 -05001388 if (signal_pending(current))
1389 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391}
1392
1393static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001394urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395{
Theodore Ts'o301f0592013-11-03 06:54:51 -05001396 int ret;
1397
1398 if (unlikely(nonblocking_pool.initialized == 0))
1399 printk_once(KERN_NOTICE "random: %s urandom read "
1400 "with %d bits of entropy available\n",
1401 current->comm, nonblocking_pool.entropy_total);
1402
1403 ret = extract_entropy_user(&nonblocking_pool, buf, nbytes);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001404
1405 trace_urandom_read(8 * nbytes, ENTROPY_BITS(&nonblocking_pool),
1406 ENTROPY_BITS(&input_pool));
1407 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408}
1409
1410static unsigned int
1411random_poll(struct file *file, poll_table * wait)
1412{
1413 unsigned int mask;
1414
1415 poll_wait(file, &random_read_wait, wait);
1416 poll_wait(file, &random_write_wait, wait);
1417 mask = 0;
Greg Price2132a962013-12-06 21:28:03 -05001418 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 mask |= POLLIN | POLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05001420 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 mask |= POLLOUT | POLLWRNORM;
1422 return mask;
1423}
1424
Matt Mackall7f397dc2007-05-29 21:58:10 -05001425static int
1426write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1427{
1428 size_t bytes;
1429 __u32 buf[16];
1430 const char __user *p = buffer;
1431
1432 while (count > 0) {
1433 bytes = min(count, sizeof(buf));
1434 if (copy_from_user(&buf, p, bytes))
1435 return -EFAULT;
1436
1437 count -= bytes;
1438 p += bytes;
1439
Theodore Ts'o85608f82014-06-10 23:09:20 -04001440 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001441 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001442 }
1443
1444 return 0;
1445}
1446
Matt Mackall90b75ee2008-04-29 01:02:55 -07001447static ssize_t random_write(struct file *file, const char __user *buffer,
1448 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001450 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Matt Mackall7f397dc2007-05-29 21:58:10 -05001452 ret = write_pool(&blocking_pool, buffer, count);
1453 if (ret)
1454 return ret;
1455 ret = write_pool(&nonblocking_pool, buffer, count);
1456 if (ret)
1457 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
Matt Mackall7f397dc2007-05-29 21:58:10 -05001459 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460}
1461
Matt Mackall43ae4862008-04-29 01:02:58 -07001462static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463{
1464 int size, ent_count;
1465 int __user *p = (int __user *)arg;
1466 int retval;
1467
1468 switch (cmd) {
1469 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001470 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001471 ent_count = ENTROPY_BITS(&input_pool);
1472 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 return -EFAULT;
1474 return 0;
1475 case RNDADDTOENTCNT:
1476 if (!capable(CAP_SYS_ADMIN))
1477 return -EPERM;
1478 if (get_user(ent_count, p))
1479 return -EFAULT;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001480 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 return 0;
1482 case RNDADDENTROPY:
1483 if (!capable(CAP_SYS_ADMIN))
1484 return -EPERM;
1485 if (get_user(ent_count, p++))
1486 return -EFAULT;
1487 if (ent_count < 0)
1488 return -EINVAL;
1489 if (get_user(size, p++))
1490 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001491 retval = write_pool(&input_pool, (const char __user *)p,
1492 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 if (retval < 0)
1494 return retval;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001495 credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 return 0;
1497 case RNDZAPENTCNT:
1498 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001499 /*
1500 * Clear the entropy pool counters. We no longer clear
1501 * the entropy pool, as that's silly.
1502 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 if (!capable(CAP_SYS_ADMIN))
1504 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001505 input_pool.entropy_count = 0;
1506 nonblocking_pool.entropy_count = 0;
1507 blocking_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 return 0;
1509 default:
1510 return -EINVAL;
1511 }
1512}
1513
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001514static int random_fasync(int fd, struct file *filp, int on)
1515{
1516 return fasync_helper(fd, filp, on, &fasync);
1517}
1518
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001519const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 .read = random_read,
1521 .write = random_write,
1522 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001523 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001524 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001525 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526};
1527
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001528const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 .read = urandom_read,
1530 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001531 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001532 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001533 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534};
1535
1536/***************************************************************
1537 * Random UUID interface
1538 *
1539 * Used here for a Boot ID, but can be useful for other kernel
1540 * drivers.
1541 ***************************************************************/
1542
1543/*
1544 * Generate random UUID
1545 */
1546void generate_random_uuid(unsigned char uuid_out[16])
1547{
1548 get_random_bytes(uuid_out, 16);
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05001549 /* Set UUID version to 4 --- truly random generation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1551 /* Set the UUID variant to DCE */
1552 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1553}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554EXPORT_SYMBOL(generate_random_uuid);
1555
1556/********************************************************************
1557 *
1558 * Sysctl interface
1559 *
1560 ********************************************************************/
1561
1562#ifdef CONFIG_SYSCTL
1563
1564#include <linux/sysctl.h>
1565
1566static int min_read_thresh = 8, min_write_thresh;
Greg Price8c2aa332013-12-05 19:19:29 -05001567static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568static int max_write_thresh = INPUT_POOL_WORDS * 32;
1569static char sysctl_bootid[16];
1570
1571/*
Greg Pricef22052b2013-11-29 14:58:16 -05001572 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 * UUID. The difference is in whether table->data is NULL; if it is,
1574 * then a new UUID is generated and returned to the user.
1575 *
Greg Pricef22052b2013-11-29 14:58:16 -05001576 * If the user accesses this via the proc interface, the UUID will be
1577 * returned as an ASCII string in the standard UUID format; if via the
1578 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 */
Joe Perchesa1514272013-06-13 19:37:35 -07001580static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 void __user *buffer, size_t *lenp, loff_t *ppos)
1582{
Joe Perchesa1514272013-06-13 19:37:35 -07001583 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 unsigned char buf[64], tmp_uuid[16], *uuid;
1585
1586 uuid = table->data;
1587 if (!uuid) {
1588 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001590 } else {
1591 static DEFINE_SPINLOCK(bootid_spinlock);
1592
1593 spin_lock(&bootid_spinlock);
1594 if (!uuid[8])
1595 generate_random_uuid(uuid);
1596 spin_unlock(&bootid_spinlock);
1597 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Joe Perches35900772009-12-14 18:01:11 -08001599 sprintf(buf, "%pU", uuid);
1600
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 fake_table.data = buf;
1602 fake_table.maxlen = sizeof(buf);
1603
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001604 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605}
1606
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001607/*
1608 * Return entropy available scaled to integral bits
1609 */
Joe Perches5eb10d92014-06-06 14:37:58 -07001610static int proc_do_entropy(struct ctl_table *table, int write,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001611 void __user *buffer, size_t *lenp, loff_t *ppos)
1612{
Joe Perches5eb10d92014-06-06 14:37:58 -07001613 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001614 int entropy_count;
1615
1616 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
1617
1618 fake_table.data = &entropy_count;
1619 fake_table.maxlen = sizeof(entropy_count);
1620
1621 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1622}
1623
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07001625extern struct ctl_table random_table[];
1626struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 .procname = "poolsize",
1629 .data = &sysctl_poolsize,
1630 .maxlen = sizeof(int),
1631 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001632 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 },
1634 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 .procname = "entropy_avail",
1636 .maxlen = sizeof(int),
1637 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001638 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 .data = &input_pool.entropy_count,
1640 },
1641 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 .procname = "read_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05001643 .data = &random_read_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 .maxlen = sizeof(int),
1645 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001646 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 .extra1 = &min_read_thresh,
1648 .extra2 = &max_read_thresh,
1649 },
1650 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05001652 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 .maxlen = sizeof(int),
1654 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001655 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656 .extra1 = &min_write_thresh,
1657 .extra2 = &max_write_thresh,
1658 },
1659 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04001660 .procname = "urandom_min_reseed_secs",
1661 .data = &random_min_urandom_seed,
1662 .maxlen = sizeof(int),
1663 .mode = 0644,
1664 .proc_handler = proc_dointvec,
1665 },
1666 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 .procname = "boot_id",
1668 .data = &sysctl_bootid,
1669 .maxlen = 16,
1670 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001671 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 },
1673 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 .procname = "uuid",
1675 .maxlen = 16,
1676 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001677 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04001679#ifdef ADD_INTERRUPT_BENCH
1680 {
1681 .procname = "add_interrupt_avg_cycles",
1682 .data = &avg_cycles,
1683 .maxlen = sizeof(avg_cycles),
1684 .mode = 0444,
1685 .proc_handler = proc_doulongvec_minmax,
1686 },
1687 {
1688 .procname = "add_interrupt_avg_deviation",
1689 .data = &avg_deviation,
1690 .maxlen = sizeof(avg_deviation),
1691 .mode = 0444,
1692 .proc_handler = proc_doulongvec_minmax,
1693 },
1694#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08001695 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696};
1697#endif /* CONFIG_SYSCTL */
1698
David S. Miller6e5714e2011-08-03 20:50:44 -07001699static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Theodore Ts'o47d06e52013-09-10 10:52:35 -04001701int random_int_secret_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702{
David S. Miller6e5714e2011-08-03 20:50:44 -07001703 get_random_bytes(random_int_secret, sizeof(random_int_secret));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 return 0;
1705}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706
1707/*
1708 * Get a random word for internal kernel use only. Similar to urandom but
1709 * with the goal of minimal entropy pool depletion. As a result, the random
1710 * value is not cryptographically secure but for several uses the cost of
1711 * depleting entropy is too high
1712 */
Theodore Ts'o74feec52012-07-06 14:03:18 -04001713static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714unsigned int get_random_int(void)
1715{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001716 __u32 *hash;
David S. Miller6e5714e2011-08-03 20:50:44 -07001717 unsigned int ret;
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001718
H. Peter Anvin63d77172011-07-31 13:54:50 -07001719 if (arch_get_random_int(&ret))
1720 return ret;
1721
1722 hash = get_cpu_var(get_random_int_hash);
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001723
Theodore Ts'o61875f32013-09-21 13:58:22 -04001724 hash[0] += current->pid + jiffies + random_get_entropy();
David S. Miller6e5714e2011-08-03 20:50:44 -07001725 md5_transform(hash, random_int_secret);
1726 ret = hash[0];
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001727 put_cpu_var(get_random_int_hash);
1728
1729 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730}
Andy Shevchenko16c7fa02013-04-30 15:27:30 -07001731EXPORT_SYMBOL(get_random_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732
1733/*
1734 * randomize_range() returns a start address such that
1735 *
1736 * [...... <range> .....]
1737 * start end
1738 *
1739 * a <range> with size "len" starting at the return value is inside in the
1740 * area defined by [start, end], but is otherwise randomized.
1741 */
1742unsigned long
1743randomize_range(unsigned long start, unsigned long end, unsigned long len)
1744{
1745 unsigned long range = end - len - start;
1746
1747 if (end <= start + len)
1748 return 0;
1749 return PAGE_ALIGN(get_random_int() % range + start);
1750}
Torsten Duwec84dbf62014-06-14 23:38:36 -04001751
1752/* Interface for in-kernel drivers of true hardware RNGs.
1753 * Those devices may produce endless random bits and will be throttled
1754 * when our pool is full.
1755 */
1756void add_hwgenerator_randomness(const char *buffer, size_t count,
1757 size_t entropy)
1758{
1759 struct entropy_store *poolp = &input_pool;
1760
1761 /* Suspend writing if we're above the trickle threshold.
1762 * We'll be woken up again once below random_write_wakeup_thresh,
1763 * or when the calling thread is about to terminate.
1764 */
1765 wait_event_interruptible(random_write_wait, kthread_should_stop() ||
1766 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
1767 mix_pool_bytes(poolp, buffer, count);
1768 credit_entropy_bits(poolp, entropy);
1769}
1770EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);