blob: 05d255e1c112fef87c4c8c6da5cb810fea1999cf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * random.c -- A strong random number generator
3 *
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04004 * Copyright (C) 2017 Jason A. Donenfeld <Jason@zx2c4.com>. All
5 * Rights Reserved.
6 *
Matt Mackall9e95ce22005-04-16 15:25:56 -07007 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
10 * rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, and the entire permission notice in its entirety,
17 * including the disclaimer of warranties.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. The name of the author may not be used to endorse or promote
22 * products derived from this software without specific prior
23 * written permission.
24 *
25 * ALTERNATIVELY, this product may be distributed under the terms of
26 * the GNU General Public License, in which case the provisions of the GPL are
27 * required INSTEAD OF the above restrictions. (This clause is
28 * necessary due to a potential bad interaction between the GPL and
29 * the restrictions contained in a BSD-style copyright.)
30 *
31 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
32 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
34 * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
35 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
37 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
38 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
41 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
42 * DAMAGE.
43 */
44
45/*
46 * (now, with legal B.S. out of the way.....)
47 *
48 * This routine gathers environmental noise from device drivers, etc.,
49 * and returns good random numbers, suitable for cryptographic use.
50 * Besides the obvious cryptographic uses, these numbers are also good
51 * for seeding TCP sequence numbers, and other places where it is
52 * desirable to have numbers which are not only random, but hard to
53 * predict by an attacker.
54 *
55 * Theory of operation
56 * ===================
57 *
58 * Computers are very predictable devices. Hence it is extremely hard
59 * to produce truly random numbers on a computer --- as opposed to
60 * pseudo-random numbers, which can easily generated by using a
61 * algorithm. Unfortunately, it is very easy for attackers to guess
62 * the sequence of pseudo-random number generators, and for some
63 * applications this is not acceptable. So instead, we must try to
64 * gather "environmental noise" from the computer's environment, which
65 * must be hard for outside attackers to observe, and use that to
66 * generate random numbers. In a Unix environment, this is best done
67 * from inside the kernel.
68 *
69 * Sources of randomness from the environment include inter-keyboard
70 * timings, inter-interrupt timings from some interrupts, and other
71 * events which are both (a) non-deterministic and (b) hard for an
72 * outside observer to measure. Randomness from these sources are
73 * added to an "entropy pool", which is mixed using a CRC-like function.
74 * This is not cryptographically strong, but it is adequate assuming
75 * the randomness is not chosen maliciously, and it is fast enough that
76 * the overhead of doing it on every interrupt is very reasonable.
77 * As random bytes are mixed into the entropy pool, the routines keep
78 * an *estimate* of how many bits of randomness have been stored into
79 * the random number generator's internal state.
80 *
81 * When random bytes are desired, they are obtained by taking the SHA
82 * hash of the contents of the "entropy pool". The SHA hash avoids
83 * exposing the internal state of the entropy pool. It is believed to
84 * be computationally infeasible to derive any useful information
85 * about the input of SHA from its output. Even if it is possible to
86 * analyze SHA in some clever way, as long as the amount of data
87 * returned from the generator is less than the inherent entropy in
88 * the pool, the output data is totally unpredictable. For this
89 * reason, the routine decreases its internal estimate of how many
90 * bits of "true randomness" are contained in the entropy pool as it
91 * outputs random numbers.
92 *
93 * If this estimate goes to zero, the routine can still generate
94 * random numbers; however, an attacker may (at least in theory) be
95 * able to infer the future output of the generator from prior
96 * outputs. This requires successful cryptanalysis of SHA, which is
97 * not believed to be feasible, but there is a remote possibility.
98 * Nonetheless, these numbers should be useful for the vast majority
99 * of purposes.
100 *
101 * Exported interfaces ---- output
102 * ===============================
103 *
104 * There are three exported interfaces; the first is one designed to
105 * be used from within the kernel:
106 *
107 * void get_random_bytes(void *buf, int nbytes);
108 *
109 * This interface will return the requested number of random bytes,
110 * and place it in the requested buffer.
111 *
112 * The two other interfaces are two character devices /dev/random and
113 * /dev/urandom. /dev/random is suitable for use when very high
114 * quality randomness is desired (for example, for key generation or
115 * one-time pads), as it will only return a maximum of the number of
116 * bits of randomness (as estimated by the random number generator)
117 * contained in the entropy pool.
118 *
119 * The /dev/urandom device does not have this limit, and will return
120 * as many bytes as are requested. As more and more random bytes are
121 * requested without giving time for the entropy pool to recharge,
122 * this will result in random numbers that are merely cryptographically
123 * strong. For many applications, however, this is acceptable.
124 *
125 * Exported interfaces ---- input
126 * ==============================
127 *
128 * The current exported interfaces for gathering environmental noise
129 * from the devices are:
130 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400131 * void add_device_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * void add_input_randomness(unsigned int type, unsigned int code,
133 * unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400134 * void add_interrupt_randomness(int irq, int irq_flags);
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100135 * void add_disk_randomness(struct gendisk *disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400137 * add_device_randomness() is for adding data to the random pool that
138 * is likely to differ between two devices (or possibly even per boot).
139 * This would be things like MAC addresses or serial numbers, or the
140 * read-out of the RTC. This does *not* add any actual entropy to the
141 * pool, but it initializes the pool to different values for devices
142 * that might otherwise be identical and have very little entropy
143 * available to them (particularly common in the embedded world).
144 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 * add_input_randomness() uses the input layer interrupt timing, as well as
146 * the event type information from the hardware.
147 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400148 * add_interrupt_randomness() uses the interrupt timing as random
149 * inputs to the entropy pool. Using the cycle counters and the irq source
150 * as inputs, it feeds the randomness roughly once a second.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100151 *
152 * add_disk_randomness() uses what amounts to the seek time of block
153 * layer request events, on a per-disk_devt basis, as input to the
154 * entropy pool. Note that high-speed solid state drives with very low
155 * seek times do not make for good sources of entropy, as their seek
156 * times are usually fairly consistent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 *
158 * All of these routines try to estimate how many bits of randomness a
159 * particular randomness source. They do this by keeping track of the
160 * first and second order deltas of the event timings.
161 *
162 * Ensuring unpredictability at system startup
163 * ============================================
164 *
165 * When any operating system starts up, it will go through a sequence
166 * of actions that are fairly predictable by an adversary, especially
167 * if the start-up does not involve interaction with a human operator.
168 * This reduces the actual number of bits of unpredictability in the
169 * entropy pool below the value in entropy_count. In order to
170 * counteract this effect, it helps to carry information in the
171 * entropy pool across shut-downs and start-ups. To do this, put the
172 * following lines an appropriate script which is run during the boot
173 * sequence:
174 *
175 * echo "Initializing random number generator..."
176 * random_seed=/var/run/random-seed
177 * # Carry a random seed from start-up to start-up
178 * # Load and then save the whole entropy pool
179 * if [ -f $random_seed ]; then
180 * cat $random_seed >/dev/urandom
181 * else
182 * touch $random_seed
183 * fi
184 * chmod 600 $random_seed
185 * dd if=/dev/urandom of=$random_seed count=1 bs=512
186 *
187 * and the following lines in an appropriate script which is run as
188 * the system is shutdown:
189 *
190 * # Carry a random seed from shut-down to start-up
191 * # Save the whole entropy pool
192 * echo "Saving random seed..."
193 * random_seed=/var/run/random-seed
194 * touch $random_seed
195 * chmod 600 $random_seed
196 * dd if=/dev/urandom of=$random_seed count=1 bs=512
197 *
198 * For example, on most modern systems using the System V init
199 * scripts, such code fragments would be found in
200 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
201 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
202 *
203 * Effectively, these commands cause the contents of the entropy pool
204 * to be saved at shut-down time and reloaded into the entropy pool at
205 * start-up. (The 'dd' in the addition to the bootup script is to
206 * make sure that /etc/random-seed is different for every start-up,
207 * even if the system crashes without executing rc.0.) Even with
208 * complete knowledge of the start-up activities, predicting the state
209 * of the entropy pool requires knowledge of the previous history of
210 * the system.
211 *
212 * Configuring the /dev/random driver under Linux
213 * ==============================================
214 *
215 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
216 * the /dev/mem major number (#1). So if your system does not have
217 * /dev/random and /dev/urandom created already, they can be created
218 * by using the commands:
219 *
220 * mknod /dev/random c 1 8
221 * mknod /dev/urandom c 1 9
222 *
223 * Acknowledgements:
224 * =================
225 *
226 * Ideas for constructing this random number generator were derived
227 * from Pretty Good Privacy's random number generator, and from private
228 * discussions with Phil Karn. Colin Plumb provided a faster random
229 * number generator, which speed up the mixing function of the entropy
230 * pool, taken from PGPfone. Dale Worley has also contributed many
231 * useful ideas and suggestions to improve this driver.
232 *
233 * Any flaws in the design are solely my responsibility, and should
234 * not be attributed to the Phil, Colin, or any of authors of PGP.
235 *
236 * Further background information on this topic may be obtained from
237 * RFC 1750, "Randomness Recommendations for Security", by Donald
238 * Eastlake, Steve Crocker, and Jeff Schiller.
239 */
240
241#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242#include <linux/module.h>
243#include <linux/kernel.h>
244#include <linux/major.h>
245#include <linux/string.h>
246#include <linux/fcntl.h>
247#include <linux/slab.h>
248#include <linux/random.h>
249#include <linux/poll.h>
250#include <linux/init.h>
251#include <linux/fs.h>
252#include <linux/genhd.h>
253#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700254#include <linux/mm.h>
Michael Ellermandd0f0cf2016-07-31 00:23:08 +1000255#include <linux/nodemask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256#include <linux/spinlock.h>
Torsten Duwec84dbf62014-06-14 23:38:36 -0400257#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#include <linux/percpu.h>
259#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800260#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400261#include <linux/ptrace.h>
Theodore Ts'oe6d49472012-07-05 10:21:01 -0400262#include <linux/kmemcheck.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400263#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200264#include <linux/irq.h>
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400265#include <linux/syscalls.h>
266#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700267#include <linux/uuid.h>
Theodore Ts'oe192be92016-06-12 18:13:36 -0400268#include <crypto/chacha20.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800269
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270#include <asm/processor.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800271#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400273#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#include <asm/io.h>
275
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400276#define CREATE_TRACE_POINTS
277#include <trace/events/random.h>
278
Theodore Ts'o43759d42014-06-14 21:43:13 -0400279/* #define ADD_INTERRUPT_BENCH */
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281/*
282 * Configuration information
283 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400284#define INPUT_POOL_SHIFT 12
285#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
286#define OUTPUT_POOL_SHIFT 10
287#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
288#define SEC_XFER_SIZE 512
289#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400292#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400295 * To allow fractional bits to be tracked, the entropy_count field is
296 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400297 *
298 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
299 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400300 */
301#define ENTROPY_SHIFT 3
302#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
303
304/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 * The minimum number of bits of entropy before we wake up a read on
306 * /dev/random. Should be enough to do a significant reseed.
307 */
Greg Price2132a962013-12-06 21:28:03 -0500308static int random_read_wakeup_bits = 64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310/*
311 * If the entropy count falls under this number of bits, then we
312 * should wake up processes which are selecting or polling on write
313 * access to /dev/random.
314 */
Greg Price2132a962013-12-06 21:28:03 -0500315static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
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
Herbert Xu205a5252015-06-09 18:19:39 +0800409static DEFINE_SPINLOCK(random_ready_list_lock);
410static LIST_HEAD(random_ready_list);
411
Theodore Ts'oe192be92016-06-12 18:13:36 -0400412struct crng_state {
413 __u32 state[16];
414 unsigned long init_time;
415 spinlock_t lock;
416};
417
418struct crng_state primary_crng = {
419 .lock = __SPIN_LOCK_UNLOCKED(primary_crng.lock),
420};
421
422/*
423 * crng_init = 0 --> Uninitialized
424 * 1 --> Initialized
425 * 2 --> Initialized from input_pool
426 *
427 * crng_init is protected by primary_crng->lock, and only increases
428 * its value (from 0->1->2).
429 */
430static int crng_init = 0;
431#define crng_ready() (likely(crng_init > 0))
432static int crng_init_cnt = 0;
433#define CRNG_INIT_CNT_THRESH (2*CHACHA20_KEY_SIZE)
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400434static void _extract_crng(struct crng_state *crng,
435 __u8 out[CHACHA20_BLOCK_SIZE]);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400436static void _crng_backtrack_protect(struct crng_state *crng,
437 __u8 tmp[CHACHA20_BLOCK_SIZE], int used);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400438static void process_random_ready_list(void);
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400439static void _get_random_bytes(void *buf, int nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400440
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441/**********************************************************************
442 *
443 * OS independent entropy store. Here are the functions which handle
444 * storing entropy in an entropy pool.
445 *
446 **********************************************************************/
447
448struct entropy_store;
449struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700450 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400451 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 __u32 *pool;
453 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400455 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400458 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700459 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400460 unsigned short add_ptr;
461 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800462 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400463 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400464 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400465 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000466 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467};
468
Theodore Ts'oe192be92016-06-12 18:13:36 -0400469static ssize_t extract_entropy(struct entropy_store *r, void *buf,
470 size_t nbytes, int min, int rsvd);
471static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
472 size_t nbytes, int fips);
473
474static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400475static void push_to_pool(struct work_struct *work);
Emese Revfy0766f782016-06-20 20:42:34 +0200476static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
477static __u32 blocking_pool_data[OUTPUT_POOL_WORDS] __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
479static struct entropy_store input_pool = {
480 .poolinfo = &poolinfo_table[0],
481 .name = "input",
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200482 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 .pool = input_pool_data
484};
485
486static struct entropy_store blocking_pool = {
487 .poolinfo = &poolinfo_table[1],
488 .name = "blocking",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200490 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400491 .pool = blocking_pool_data,
492 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
493 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494};
495
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400496static __u32 const twist_table[8] = {
497 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
498 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700501 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700503 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 *
505 * The pool is stirred with a primitive polynomial of the appropriate
506 * degree, and then twisted. We twist by three bits at a time because
507 * it's cheap to do so and helps slightly in the expected case where
508 * the entropy is concentrated in the low-order bits.
509 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400510static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400511 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400513 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700514 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700516 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700517 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 tap1 = r->poolinfo->tap1;
520 tap2 = r->poolinfo->tap2;
521 tap3 = r->poolinfo->tap3;
522 tap4 = r->poolinfo->tap4;
523 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400525 input_rotate = r->input_rotate;
526 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Matt Mackalle68e5b62008-04-29 01:03:05 -0700528 /* mix one byte at a time to simplify size handling and churn faster */
529 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400530 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700531 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
533 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700534 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 w ^= r->pool[(i + tap1) & wordmask];
536 w ^= r->pool[(i + tap2) & wordmask];
537 w ^= r->pool[(i + tap3) & wordmask];
538 w ^= r->pool[(i + tap4) & wordmask];
539 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700540
541 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700543
544 /*
545 * Normally, we add 7 bits of rotation to the pool.
546 * At the beginning of the pool, add an extra 7 bits
547 * rotation, so that successive passes spread the
548 * input bits across the pool evenly.
549 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400550 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
552
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400553 r->input_rotate = input_rotate;
554 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555}
556
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400557static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400558 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400560 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400561 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400562}
563
564static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400565 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400566{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400567 unsigned long flags;
568
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400569 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400570 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400571 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400572 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573}
574
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400575struct fast_pool {
576 __u32 pool[4];
577 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400578 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400579 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400580};
581
582/*
583 * This is a fast mixing routine used by the interrupt randomness
584 * collector. It's hardcoded for an 128 bit pool and assumes that any
585 * locks that might be needed are taken by the caller.
586 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400587static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400588{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400589 __u32 a = f->pool[0], b = f->pool[1];
590 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400591
Theodore Ts'o43759d42014-06-14 21:43:13 -0400592 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500593 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400594 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400595
Theodore Ts'o43759d42014-06-14 21:43:13 -0400596 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500597 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400598 d ^= a; b ^= c;
599
600 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500601 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400602 d ^= a; b ^= c;
603
604 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500605 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400606 d ^= a; b ^= c;
607
608 f->pool[0] = a; f->pool[1] = b;
609 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400610 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400611}
612
Herbert Xu205a5252015-06-09 18:19:39 +0800613static void process_random_ready_list(void)
614{
615 unsigned long flags;
616 struct random_ready_callback *rdy, *tmp;
617
618 spin_lock_irqsave(&random_ready_list_lock, flags);
619 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
620 struct module *owner = rdy->owner;
621
622 list_del_init(&rdy->list);
623 rdy->func(rdy);
624 module_put(owner);
625 }
626 spin_unlock_irqrestore(&random_ready_list_lock, flags);
627}
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400630 * Credit (or debit) the entropy store with n bits of entropy.
631 * Use credit_entropy_bits_safe() if the value comes from userspace
632 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700634static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400636 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400637 const int pool_size = r->poolinfo->poolfracbits;
638 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Matt Mackalladc782d2008-04-29 01:03:07 -0700640 if (!nbits)
641 return;
642
Theodore Ts'o902c0982012-07-04 10:38:30 -0400643retry:
644 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400645 if (nfrac < 0) {
646 /* Debit */
647 entropy_count += nfrac;
648 } else {
649 /*
650 * Credit: we have to account for the possibility of
651 * overwriting already present entropy. Even in the
652 * ideal case of pure Shannon entropy, new contributions
653 * approach the full value asymptotically:
654 *
655 * entropy <- entropy + (pool_size - entropy) *
656 * (1 - exp(-add_entropy/pool_size))
657 *
658 * For add_entropy <= pool_size/2 then
659 * (1 - exp(-add_entropy/pool_size)) >=
660 * (add_entropy/pool_size)*0.7869...
661 * so we can approximate the exponential with
662 * 3/4*add_entropy/pool_size and still be on the
663 * safe side by adding at most pool_size/2 at a time.
664 *
665 * The use of pool_size-2 in the while statement is to
666 * prevent rounding artifacts from making the loop
667 * arbitrarily long; this limits the loop to log2(pool_size)*2
668 * turns no matter how large nbits is.
669 */
670 int pnfrac = nfrac;
671 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
672 /* The +2 corresponds to the /4 in the denominator */
673
674 do {
675 unsigned int anfrac = min(pnfrac, pool_size/2);
676 unsigned int add =
677 ((pool_size - entropy_count)*anfrac*3) >> s;
678
679 entropy_count += add;
680 pnfrac -= anfrac;
681 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
682 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400683
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -0400684 if (unlikely(entropy_count < 0)) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400685 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
686 r->name, entropy_count);
687 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700688 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400689 } else if (entropy_count > pool_size)
690 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400691 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
692 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Theodore Ts'o6265e162013-10-03 01:08:15 -0400694 r->entropy_total += nbits;
Linus Torvalds0891ad82013-11-16 10:19:15 -0800695 if (!r->initialized && r->entropy_total > 128) {
696 r->initialized = 1;
697 r->entropy_total = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400698 }
699
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400700 trace_credit_entropy_bits(r->name, nbits,
701 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400702 r->entropy_total, _RET_IP_);
703
Theodore Ts'o6265e162013-10-03 01:08:15 -0400704 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500705 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400706
Theodore Ts'oe192be92016-06-12 18:13:36 -0400707 if (crng_init < 2 && entropy_bits >= 128) {
708 crng_reseed(&primary_crng, r);
709 entropy_bits = r->entropy_count >> ENTROPY_SHIFT;
710 }
711
Theodore Ts'o6265e162013-10-03 01:08:15 -0400712 /* should we wake readers? */
Greg Price2132a962013-12-06 21:28:03 -0500713 if (entropy_bits >= random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400714 wake_up_interruptible(&random_read_wait);
715 kill_fasync(&fasync, SIGIO, POLL_IN);
716 }
717 /* If the input pool is getting full, send some
Theodore Ts'oe192be92016-06-12 18:13:36 -0400718 * entropy to the blocking pool until it is 75% full.
Theodore Ts'o6265e162013-10-03 01:08:15 -0400719 */
Greg Price2132a962013-12-06 21:28:03 -0500720 if (entropy_bits > random_write_wakeup_bits &&
Theodore Ts'o6265e162013-10-03 01:08:15 -0400721 r->initialized &&
Greg Price2132a962013-12-06 21:28:03 -0500722 r->entropy_total >= 2*random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400723 struct entropy_store *other = &blocking_pool;
724
Theodore Ts'o6265e162013-10-03 01:08:15 -0400725 if (other->entropy_count <=
Theodore Ts'oe192be92016-06-12 18:13:36 -0400726 3 * other->poolinfo->poolfracbits / 4) {
727 schedule_work(&other->push_work);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400728 r->entropy_total = 0;
729 }
730 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700731 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732}
733
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400734static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400735{
736 const int nbits_max = (int)(~0U >> (ENTROPY_SHIFT + 1));
737
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400738 if (nbits < 0)
739 return -EINVAL;
740
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400741 /* Cap the value to avoid overflows */
742 nbits = min(nbits, nbits_max);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400743
744 credit_entropy_bits(r, nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400745 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400746}
747
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748/*********************************************************************
749 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400750 * CRNG using CHACHA20
751 *
752 *********************************************************************/
753
754#define CRNG_RESEED_INTERVAL (300*HZ)
755
756static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
757
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400758#ifdef CONFIG_NUMA
759/*
760 * Hack to deal with crazy userspace progams when they are all trying
761 * to access /dev/urandom in parallel. The programs are almost
762 * certainly doing something terribly wrong, but we'll work around
763 * their brain damage.
764 */
765static struct crng_state **crng_node_pool __read_mostly;
766#endif
767
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400768static void invalidate_batched_entropy(void);
769
Theodore Ts'oe192be92016-06-12 18:13:36 -0400770static void crng_initialize(struct crng_state *crng)
771{
772 int i;
773 unsigned long rv;
774
775 memcpy(&crng->state[0], "expand 32-byte k", 16);
776 if (crng == &primary_crng)
777 _extract_entropy(&input_pool, &crng->state[4],
778 sizeof(__u32) * 12, 0);
779 else
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400780 _get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400781 for (i = 4; i < 16; i++) {
782 if (!arch_get_random_seed_long(&rv) &&
783 !arch_get_random_long(&rv))
784 rv = random_get_entropy();
785 crng->state[i] ^= rv;
786 }
787 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
788}
789
790static int crng_fast_load(const char *cp, size_t len)
791{
792 unsigned long flags;
793 char *p;
794
795 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
796 return 0;
797 if (crng_ready()) {
798 spin_unlock_irqrestore(&primary_crng.lock, flags);
799 return 0;
800 }
801 p = (unsigned char *) &primary_crng.state[4];
802 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
803 p[crng_init_cnt % CHACHA20_KEY_SIZE] ^= *cp;
804 cp++; crng_init_cnt++; len--;
805 }
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200806 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400807 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400808 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400809 crng_init = 1;
810 wake_up_interruptible(&crng_init_wait);
811 pr_notice("random: fast init done\n");
812 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400813 return 1;
814}
815
816static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
817{
818 unsigned long flags;
819 int i, num;
820 union {
821 __u8 block[CHACHA20_BLOCK_SIZE];
822 __u32 key[8];
823 } buf;
824
825 if (r) {
826 num = extract_entropy(r, &buf, 32, 16, 0);
827 if (num == 0)
828 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400829 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400830 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400831 _crng_backtrack_protect(&primary_crng, buf.block,
832 CHACHA20_KEY_SIZE);
833 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400834 spin_lock_irqsave(&primary_crng.lock, flags);
835 for (i = 0; i < 8; i++) {
836 unsigned long rv;
837 if (!arch_get_random_seed_long(&rv) &&
838 !arch_get_random_long(&rv))
839 rv = random_get_entropy();
840 crng->state[i+4] ^= buf.key[i] ^ rv;
841 }
842 memzero_explicit(&buf, sizeof(buf));
843 crng->init_time = jiffies;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200844 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400845 if (crng == &primary_crng && crng_init < 2) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400846 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400847 crng_init = 2;
848 process_random_ready_list();
849 wake_up_interruptible(&crng_init_wait);
850 pr_notice("random: crng init done\n");
851 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400852}
853
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400854static void _extract_crng(struct crng_state *crng,
855 __u8 out[CHACHA20_BLOCK_SIZE])
Theodore Ts'oe192be92016-06-12 18:13:36 -0400856{
857 unsigned long v, flags;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400858
859 if (crng_init > 1 &&
860 time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL))
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400861 crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400862 spin_lock_irqsave(&crng->lock, flags);
863 if (arch_get_random_long(&v))
864 crng->state[14] ^= v;
865 chacha20_block(&crng->state[0], out);
866 if (crng->state[12] == 0)
867 crng->state[13]++;
868 spin_unlock_irqrestore(&crng->lock, flags);
869}
870
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400871static void extract_crng(__u8 out[CHACHA20_BLOCK_SIZE])
872{
873 struct crng_state *crng = NULL;
874
875#ifdef CONFIG_NUMA
876 if (crng_node_pool)
877 crng = crng_node_pool[numa_node_id()];
878 if (crng == NULL)
879#endif
880 crng = &primary_crng;
881 _extract_crng(crng, out);
882}
883
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400884/*
885 * Use the leftover bytes from the CRNG block output (if there is
886 * enough) to mutate the CRNG key to provide backtracking protection.
887 */
888static void _crng_backtrack_protect(struct crng_state *crng,
889 __u8 tmp[CHACHA20_BLOCK_SIZE], int used)
890{
891 unsigned long flags;
892 __u32 *s, *d;
893 int i;
894
895 used = round_up(used, sizeof(__u32));
896 if (used + CHACHA20_KEY_SIZE > CHACHA20_BLOCK_SIZE) {
897 extract_crng(tmp);
898 used = 0;
899 }
900 spin_lock_irqsave(&crng->lock, flags);
901 s = (__u32 *) &tmp[used];
902 d = &crng->state[4];
903 for (i=0; i < 8; i++)
904 *d++ ^= *s++;
905 spin_unlock_irqrestore(&crng->lock, flags);
906}
907
908static void crng_backtrack_protect(__u8 tmp[CHACHA20_BLOCK_SIZE], int used)
909{
910 struct crng_state *crng = NULL;
911
912#ifdef CONFIG_NUMA
913 if (crng_node_pool)
914 crng = crng_node_pool[numa_node_id()];
915 if (crng == NULL)
916#endif
917 crng = &primary_crng;
918 _crng_backtrack_protect(crng, tmp, used);
919}
920
Theodore Ts'oe192be92016-06-12 18:13:36 -0400921static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
922{
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400923 ssize_t ret = 0, i = CHACHA20_BLOCK_SIZE;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400924 __u8 tmp[CHACHA20_BLOCK_SIZE];
925 int large_request = (nbytes > 256);
926
927 while (nbytes) {
928 if (large_request && need_resched()) {
929 if (signal_pending(current)) {
930 if (ret == 0)
931 ret = -ERESTARTSYS;
932 break;
933 }
934 schedule();
935 }
936
937 extract_crng(tmp);
938 i = min_t(int, nbytes, CHACHA20_BLOCK_SIZE);
939 if (copy_to_user(buf, tmp, i)) {
940 ret = -EFAULT;
941 break;
942 }
943
944 nbytes -= i;
945 buf += i;
946 ret += i;
947 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400948 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400949
950 /* Wipe data just written to memory */
951 memzero_explicit(tmp, sizeof(tmp));
952
953 return ret;
954}
955
956
957/*********************************************************************
958 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 * Entropy input management
960 *
961 *********************************************************************/
962
963/* There is one of these per entropy source */
964struct timer_rand_state {
965 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -0700966 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 unsigned dont_count_entropy:1;
968};
969
Theodore Ts'o644008d2013-11-03 16:40:53 -0500970#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
971
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400972/*
Theodore Ts'oe192be92016-06-12 18:13:36 -0400973 * Add device- or boot-specific data to the input pool to help
974 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400975 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400976 * None of this adds any entropy; it is meant to avoid the problem of
977 * the entropy pool having similar initial state across largely
978 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400979 */
980void add_device_randomness(const void *buf, unsigned int size)
981{
Theodore Ts'o61875f32013-09-21 13:58:22 -0400982 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400983 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400984
Theodore Ts'o59108952013-09-12 14:10:25 -0400985 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400986 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400987 _mix_pool_bytes(&input_pool, buf, size);
988 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -0400989 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400990}
991EXPORT_SYMBOL(add_device_randomness);
992
Theodore Ts'o644008d2013-11-03 16:40:53 -0500993static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700994
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995/*
996 * This function adds entropy to the entropy "pool" by using timing
997 * delays. It uses the timer_rand_state structure to make an estimate
998 * of how many bits of entropy this call has added to the pool.
999 *
1000 * The number "num" is also added to the pool - it should somehow describe
1001 * the type of event which just happened. This is currently 0-255 for
1002 * keyboard scan codes, and 256 upwards for interrupts.
1003 *
1004 */
1005static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1006{
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001007 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -08001010 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 unsigned num;
1012 } sample;
1013 long delta, delta2, delta3;
1014
1015 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
1017 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001018 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 sample.num = num;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001020 r = &input_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001021 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
1023 /*
1024 * Calculate number of bits of randomness we probably added.
1025 * We take into account the first, second and third-order deltas
1026 * in order to make our estimate.
1027 */
1028
1029 if (!state->dont_count_entropy) {
1030 delta = sample.jiffies - state->last_time;
1031 state->last_time = sample.jiffies;
1032
1033 delta2 = delta - state->last_delta;
1034 state->last_delta = delta;
1035
1036 delta3 = delta2 - state->last_delta2;
1037 state->last_delta2 = delta2;
1038
1039 if (delta < 0)
1040 delta = -delta;
1041 if (delta2 < 0)
1042 delta2 = -delta2;
1043 if (delta3 < 0)
1044 delta3 = -delta3;
1045 if (delta > delta2)
1046 delta = delta2;
1047 if (delta > delta3)
1048 delta = delta3;
1049
1050 /*
1051 * delta is now minimum absolute delta.
1052 * Round down by 1 bit on general principles,
1053 * and limit entropy entimate to 12 bits.
1054 */
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001055 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 preempt_enable();
1058}
1059
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001060void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 unsigned int value)
1062{
1063 static unsigned char last_value;
1064
1065 /* ignore autorepeat and the like */
1066 if (value == last_value)
1067 return;
1068
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 last_value = value;
1070 add_timer_randomness(&input_timer_state,
1071 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001072 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001074EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001076static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1077
Theodore Ts'o43759d42014-06-14 21:43:13 -04001078#ifdef ADD_INTERRUPT_BENCH
1079static unsigned long avg_cycles, avg_deviation;
1080
1081#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1082#define FIXED_1_2 (1 << (AVG_SHIFT-1))
1083
1084static void add_interrupt_bench(cycles_t start)
1085{
1086 long delta = random_get_entropy() - start;
1087
1088 /* Use a weighted moving average */
1089 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1090 avg_cycles += delta;
1091 /* And average deviation */
1092 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1093 avg_deviation += delta;
1094}
1095#else
1096#define add_interrupt_bench(x)
1097#endif
1098
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001099static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
1100{
1101 __u32 *ptr = (__u32 *) regs;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001102 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001103
1104 if (regs == NULL)
1105 return 0;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001106 idx = READ_ONCE(f->reg_idx);
1107 if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
1108 idx = 0;
1109 ptr += idx++;
1110 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitz9dfa7bb2017-04-30 19:49:21 +12001111 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001112}
1113
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001114void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115{
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001116 struct entropy_store *r;
Christoph Lameter1b2a1a72014-08-17 12:30:29 -05001117 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001118 struct pt_regs *regs = get_irq_regs();
1119 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001120 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -04001121 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001122 __u64 ip;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001123 unsigned long seed;
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001124 int credit = 0;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001125
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001126 if (cycles == 0)
1127 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001128 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1129 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001130 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1131 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001132 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001133 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001134 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
1135 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001136
Theodore Ts'o43759d42014-06-14 21:43:13 -04001137 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001138 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001139
Theodore Ts'oe192be92016-06-12 18:13:36 -04001140 if (!crng_ready()) {
1141 if ((fast_pool->count >= 64) &&
1142 crng_fast_load((char *) fast_pool->pool,
1143 sizeof(fast_pool->pool))) {
1144 fast_pool->count = 0;
1145 fast_pool->last = now;
1146 }
1147 return;
1148 }
1149
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001150 if ((fast_pool->count < 64) &&
1151 !time_after(now, fast_pool->last + HZ))
1152 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153
Theodore Ts'oe192be92016-06-12 18:13:36 -04001154 r = &input_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001155 if (!spin_trylock(&r->lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 return;
1157
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001158 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001159 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
H. Peter Anvin83664a62014-03-17 16:36:28 -07001160
1161 /*
1162 * If we have architectural seed generator, produce a seed and
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001163 * add it to the pool. For the sake of paranoia don't let the
1164 * architectural seed generator dominate the input from the
1165 * interrupt noise.
H. Peter Anvin83664a62014-03-17 16:36:28 -07001166 */
1167 if (arch_get_random_seed_long(&seed)) {
Theodore Ts'o85608f82014-06-10 23:09:20 -04001168 __mix_pool_bytes(r, &seed, sizeof(seed));
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001169 credit = 1;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001170 }
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001171 spin_unlock(&r->lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001172
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001173 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001174
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001175 /* award one bit for the contents of the fast pool */
1176 credit_entropy_bits(r, credit + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001178EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179
David Howells93614012006-09-30 20:45:40 +02001180#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181void add_disk_randomness(struct gendisk *disk)
1182{
1183 if (!disk || !disk->random)
1184 return;
1185 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001186 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001187 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001189EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001190#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192/*********************************************************************
1193 *
1194 * Entropy extraction routines
1195 *
1196 *********************************************************************/
1197
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001199 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 * from the primary pool to the secondary extraction pool. We make
1201 * sure we pull enough for a 'catastrophic reseed'.
1202 */
Theodore Ts'o6265e162013-10-03 01:08:15 -04001203static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1205{
Theodore Ts'ocff85032014-06-10 23:18:16 -04001206 if (!r->pull ||
1207 r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
1208 r->entropy_count > r->poolinfo->poolfracbits)
1209 return;
1210
Theodore Ts'ocff85032014-06-10 23:18:16 -04001211 _xfer_secondary_pool(r, nbytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001212}
Matt Mackall5a021e92007-07-19 11:30:14 -07001213
Theodore Ts'o6265e162013-10-03 01:08:15 -04001214static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1215{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 __u32 tmp[OUTPUT_POOL_WORDS];
1217
Theodore Ts'o6265e162013-10-03 01:08:15 -04001218 int bytes = nbytes;
Matt Mackall5a021e92007-07-19 11:30:14 -07001219
Greg Price2132a962013-12-06 21:28:03 -05001220 /* pull at least as much as a wakeup */
1221 bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001222 /* but never more than the buffer size */
1223 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001225 trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
1226 ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
Theodore Ts'o6265e162013-10-03 01:08:15 -04001227 bytes = extract_entropy(r->pull, tmp, bytes,
Stephan Müller43d8a722016-12-27 23:40:59 +01001228 random_read_wakeup_bits / 8, 0);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001229 mix_pool_bytes(r, tmp, bytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001230 credit_entropy_bits(r, bytes*8);
1231}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232
Theodore Ts'o6265e162013-10-03 01:08:15 -04001233/*
1234 * Used as a workqueue function so that when the input pool is getting
1235 * full, we can "spill over" some entropy to the output pools. That
1236 * way the output pools can store some of the excess entropy instead
1237 * of letting it go to waste.
1238 */
1239static void push_to_pool(struct work_struct *work)
1240{
1241 struct entropy_store *r = container_of(work, struct entropy_store,
1242 push_work);
1243 BUG_ON(!r);
Greg Price2132a962013-12-06 21:28:03 -05001244 _xfer_secondary_pool(r, random_read_wakeup_bits/8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001245 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
1246 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247}
1248
1249/*
Greg Price19fa5be12013-11-29 15:50:06 -05001250 * This function decides how many bytes to actually take from the
1251 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253static size_t account(struct entropy_store *r, size_t nbytes, int min,
1254 int reserved)
1255{
Stephan Müller43d8a722016-12-27 23:40:59 +01001256 int entropy_count, orig, have_bytes;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001257 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001259 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
1261 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001262retry:
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001263 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001264 ibytes = nbytes;
Stephan Müller43d8a722016-12-27 23:40:59 +01001265 /* never pull more than available */
1266 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001267
Stephan Müller43d8a722016-12-27 23:40:59 +01001268 if ((have_bytes -= reserved) < 0)
1269 have_bytes = 0;
1270 ibytes = min_t(size_t, ibytes, have_bytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001271 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001272 ibytes = 0;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001273
1274 if (unlikely(entropy_count < 0)) {
1275 pr_warn("random: negative entropy count: pool %s count %d\n",
1276 r->name, entropy_count);
1277 WARN_ON(1);
1278 entropy_count = 0;
1279 }
1280 nfrac = ibytes << (ENTROPY_SHIFT + 3);
1281 if ((size_t) entropy_count > nfrac)
1282 entropy_count -= nfrac;
1283 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001284 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001285
Greg Price0fb7a012013-12-05 19:32:19 -05001286 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1287 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001289 trace_debit_entropy(r->name, 8 * ibytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001290 if (ibytes &&
Greg Price2132a962013-12-06 21:28:03 -05001291 (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
Theodore Ts'ob9809552013-03-04 11:59:12 -05001292 wake_up_interruptible(&random_write_wait);
1293 kill_fasync(&fasync, SIGIO, POLL_OUT);
1294 }
1295
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001296 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297}
1298
Greg Price19fa5be12013-11-29 15:50:06 -05001299/*
1300 * This function does the actual extraction for extract_entropy and
1301 * extract_entropy_user.
1302 *
1303 * Note: we assume that .poolwords is a multiple of 16 words.
1304 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305static void extract_buf(struct entropy_store *r, __u8 *out)
1306{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001307 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001308 union {
1309 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001310 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001311 } hash;
1312 __u32 workspace[SHA_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001313 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001316 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001317 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001318 */
Theodore Ts'o46884442013-12-17 21:16:39 -05001319 sha_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001320 for (i = 0; i < LONGS(20); i++) {
1321 unsigned long v;
1322 if (!arch_get_random_long(&v))
1323 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001324 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001325 }
1326
Theodore Ts'o46884442013-12-17 21:16:39 -05001327 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1328 spin_lock_irqsave(&r->lock, flags);
1329 for (i = 0; i < r->poolinfo->poolwords; i += 16)
1330 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1331
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001332 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001333 * We mix the hash back into the pool to prevent backtracking
1334 * attacks (where the attacker knows the state of the pool
1335 * plus the current outputs, and attempts to find previous
1336 * ouputs), unless the hash function can be inverted. By
1337 * mixing at least a SHA1 worth of hash data back, we make
1338 * brute-forcing the feedback as hard as brute-forcing the
1339 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001341 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001342 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001343
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001344 memzero_explicit(workspace, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
1346 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001347 * In case the hash function has some recognizable output
1348 * pattern, we fold it in half. Thus, we always feed back
1349 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001351 hash.w[0] ^= hash.w[3];
1352 hash.w[1] ^= hash.w[4];
1353 hash.w[2] ^= rol32(hash.w[2], 16);
1354
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001355 memcpy(out, &hash, EXTRACT_SIZE);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001356 memzero_explicit(&hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357}
1358
Theodore Ts'oe192be92016-06-12 18:13:36 -04001359static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
1360 size_t nbytes, int fips)
1361{
1362 ssize_t ret = 0, i;
1363 __u8 tmp[EXTRACT_SIZE];
1364 unsigned long flags;
1365
1366 while (nbytes) {
1367 extract_buf(r, tmp);
1368
1369 if (fips) {
1370 spin_lock_irqsave(&r->lock, flags);
1371 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1372 panic("Hardware RNG duplicated output!\n");
1373 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1374 spin_unlock_irqrestore(&r->lock, flags);
1375 }
1376 i = min_t(int, nbytes, EXTRACT_SIZE);
1377 memcpy(buf, tmp, i);
1378 nbytes -= i;
1379 buf += i;
1380 ret += i;
1381 }
1382
1383 /* Wipe data just returned from memory */
1384 memzero_explicit(tmp, sizeof(tmp));
1385
1386 return ret;
1387}
1388
Greg Price19fa5be12013-11-29 15:50:06 -05001389/*
1390 * This function extracts randomness from the "entropy pool", and
1391 * returns it in a buffer.
1392 *
1393 * The min parameter specifies the minimum amount we can pull before
1394 * failing to avoid races that defeat catastrophic reseeding while the
1395 * reserved parameter indicates how much entropy we must leave in the
1396 * pool after each pull to avoid starving other readers.
1397 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001398static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001399 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001402 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001404 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001405 if (fips_enabled) {
1406 spin_lock_irqsave(&r->lock, flags);
1407 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001408 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001409 spin_unlock_irqrestore(&r->lock, flags);
1410 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001411 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001412 xfer_secondary_pool(r, EXTRACT_SIZE);
1413 extract_buf(r, tmp);
1414 spin_lock_irqsave(&r->lock, flags);
1415 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1416 }
1417 spin_unlock_irqrestore(&r->lock, flags);
1418 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001419
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001420 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 xfer_secondary_pool(r, nbytes);
1422 nbytes = account(r, nbytes, min, reserved);
1423
Theodore Ts'oe192be92016-06-12 18:13:36 -04001424 return _extract_entropy(r, buf, nbytes, fips_enabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425}
1426
Greg Price19fa5be12013-11-29 15:50:06 -05001427/*
1428 * This function extracts randomness from the "entropy pool", and
1429 * returns it in a userspace buffer.
1430 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1432 size_t nbytes)
1433{
1434 ssize_t ret = 0, i;
1435 __u8 tmp[EXTRACT_SIZE];
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001436 int large_request = (nbytes > 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001438 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 xfer_secondary_pool(r, nbytes);
1440 nbytes = account(r, nbytes, 0, 0);
1441
1442 while (nbytes) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001443 if (large_request && need_resched()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 if (signal_pending(current)) {
1445 if (ret == 0)
1446 ret = -ERESTARTSYS;
1447 break;
1448 }
1449 schedule();
1450 }
1451
1452 extract_buf(r, tmp);
1453 i = min_t(int, nbytes, EXTRACT_SIZE);
1454 if (copy_to_user(buf, tmp, i)) {
1455 ret = -EFAULT;
1456 break;
1457 }
1458
1459 nbytes -= i;
1460 buf += i;
1461 ret += i;
1462 }
1463
1464 /* Wipe data just returned from memory */
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001465 memzero_explicit(tmp, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
1467 return ret;
1468}
1469
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001470#define warn_unseeded_randomness(previous) \
1471 _warn_unseeded_randomness(__func__, (void *) _RET_IP_, (previous))
1472
1473static void _warn_unseeded_randomness(const char *func_name, void *caller,
1474 void **previous)
1475{
1476#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1477 const bool print_once = false;
1478#else
1479 static bool print_once __read_mostly;
1480#endif
1481
1482 if (print_once ||
1483 crng_ready() ||
1484 (previous && (caller == READ_ONCE(*previous))))
1485 return;
1486 WRITE_ONCE(*previous, caller);
1487#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1488 print_once = true;
1489#endif
1490 pr_notice("random: %s called from %pF with crng_init=%d\n",
1491 func_name, caller, crng_init);
1492}
1493
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494/*
1495 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001496 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001497 * TCP sequence numbers, etc. It does not rely on the hardware random
1498 * number generator. For random bytes direct from the hardware RNG
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001499 * (when available), use get_random_bytes_arch(). In order to ensure
1500 * that the randomness provided by this function is okay, the function
1501 * wait_for_random_bytes() should be called and return 0 at least once
1502 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 */
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001504static void _get_random_bytes(void *buf, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001506 __u8 tmp[CHACHA20_BLOCK_SIZE];
1507
Theodore Ts'o59108952013-09-12 14:10:25 -04001508 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001509
1510 while (nbytes >= CHACHA20_BLOCK_SIZE) {
1511 extract_crng(buf);
1512 buf += CHACHA20_BLOCK_SIZE;
1513 nbytes -= CHACHA20_BLOCK_SIZE;
1514 }
1515
1516 if (nbytes > 0) {
1517 extract_crng(tmp);
1518 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001519 crng_backtrack_protect(tmp, nbytes);
1520 } else
1521 crng_backtrack_protect(tmp, CHACHA20_BLOCK_SIZE);
1522 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001523}
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001524
1525void get_random_bytes(void *buf, int nbytes)
1526{
1527 static void *previous;
1528
1529 warn_unseeded_randomness(&previous);
1530 _get_random_bytes(buf, nbytes);
1531}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001532EXPORT_SYMBOL(get_random_bytes);
1533
1534/*
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001535 * Wait for the urandom pool to be seeded and thus guaranteed to supply
1536 * cryptographically secure random numbers. This applies to: the /dev/urandom
1537 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
1538 * family of functions. Using any of these functions without first calling
1539 * this function forfeits the guarantee of security.
1540 *
1541 * Returns: 0 if the urandom pool has been seeded.
1542 * -ERESTARTSYS if the function was interrupted by a signal.
1543 */
1544int wait_for_random_bytes(void)
1545{
1546 if (likely(crng_ready()))
1547 return 0;
1548 return wait_event_interruptible(crng_init_wait, crng_ready());
1549}
1550EXPORT_SYMBOL(wait_for_random_bytes);
1551
1552/*
Herbert Xu205a5252015-06-09 18:19:39 +08001553 * Add a callback function that will be invoked when the nonblocking
1554 * pool is initialised.
1555 *
1556 * returns: 0 if callback is successfully added
1557 * -EALREADY if pool is already initialised (callback not called)
1558 * -ENOENT if module for callback is not alive
1559 */
1560int add_random_ready_callback(struct random_ready_callback *rdy)
1561{
1562 struct module *owner;
1563 unsigned long flags;
1564 int err = -EALREADY;
1565
Theodore Ts'oe192be92016-06-12 18:13:36 -04001566 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001567 return err;
1568
1569 owner = rdy->owner;
1570 if (!try_module_get(owner))
1571 return -ENOENT;
1572
1573 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001574 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001575 goto out;
1576
1577 owner = NULL;
1578
1579 list_add(&rdy->list, &random_ready_list);
1580 err = 0;
1581
1582out:
1583 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1584
1585 module_put(owner);
1586
1587 return err;
1588}
1589EXPORT_SYMBOL(add_random_ready_callback);
1590
1591/*
1592 * Delete a previously registered readiness callback function.
1593 */
1594void del_random_ready_callback(struct random_ready_callback *rdy)
1595{
1596 unsigned long flags;
1597 struct module *owner = NULL;
1598
1599 spin_lock_irqsave(&random_ready_list_lock, flags);
1600 if (!list_empty(&rdy->list)) {
1601 list_del_init(&rdy->list);
1602 owner = rdy->owner;
1603 }
1604 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1605
1606 module_put(owner);
1607}
1608EXPORT_SYMBOL(del_random_ready_callback);
1609
1610/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001611 * This function will use the architecture-specific hardware random
1612 * number generator if it is available. The arch-specific hw RNG will
1613 * almost certainly be faster than what we can do in software, but it
1614 * is impossible to verify that it is implemented securely (as
1615 * opposed, to, say, the AES encryption of a sequence number using a
1616 * key known by the NSA). So it's useful if we need the speed, but
1617 * only if we're willing to trust the hardware manufacturer not to
1618 * have put in a back door.
1619 */
1620void get_random_bytes_arch(void *buf, int nbytes)
1621{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001622 char *p = buf;
1623
Theodore Ts'o59108952013-09-12 14:10:25 -04001624 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001625 while (nbytes) {
1626 unsigned long v;
1627 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001628
H. Peter Anvin63d77172011-07-31 13:54:50 -07001629 if (!arch_get_random_long(&v))
1630 break;
1631
Luck, Tonybd29e562011-11-16 10:50:56 -08001632 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001633 p += chunk;
1634 nbytes -= chunk;
1635 }
1636
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001637 if (nbytes)
Theodore Ts'oe192be92016-06-12 18:13:36 -04001638 get_random_bytes(p, nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001640EXPORT_SYMBOL(get_random_bytes_arch);
1641
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
1643/*
1644 * init_std_data - initialize pool with system data
1645 *
1646 * @r: pool to initialize
1647 *
1648 * This function clears the pool's entropy count and mixes some system
1649 * data into the pool to prepare it for use. The pool is not cleared
1650 * as that can only decrease the entropy in the pool.
1651 */
1652static void init_std_data(struct entropy_store *r)
1653{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001654 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001655 ktime_t now = ktime_get_real();
1656 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Theodore Ts'of5c27422013-09-22 15:14:32 -04001658 r->last_pulled = jiffies;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001659 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001660 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001661 if (!arch_get_random_seed_long(&rv) &&
1662 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001663 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001664 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001665 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001666 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667}
1668
Tony Luckcbc96b72012-07-23 09:47:57 -07001669/*
1670 * Note that setup_arch() may call add_device_randomness()
1671 * long before we get here. This allows seeding of the pools
1672 * with some platform dependent data very early in the boot
1673 * process. But it limits our options here. We must use
1674 * statically allocated structures that already have all
1675 * initializations complete at compile time. We should also
1676 * take care not to overwrite the precious per platform data
1677 * we were given.
1678 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001679static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680{
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001681#ifdef CONFIG_NUMA
1682 int i;
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001683 struct crng_state *crng;
1684 struct crng_state **pool;
1685#endif
1686
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 init_std_data(&input_pool);
1688 init_std_data(&blocking_pool);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001689 crng_initialize(&primary_crng);
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001690
1691#ifdef CONFIG_NUMA
Michael Ellermandd0f0cf2016-07-31 00:23:08 +10001692 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
Theodore Ts'o59b8d4f2016-07-27 23:30:25 -04001693 for_each_online_node(i) {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001694 crng = kmalloc_node(sizeof(struct crng_state),
1695 GFP_KERNEL | __GFP_NOFAIL, i);
1696 spin_lock_init(&crng->lock);
1697 crng_initialize(crng);
1698 pool[i] = crng;
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001699 }
1700 mb();
1701 crng_node_pool = pool;
1702#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 return 0;
1704}
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001705early_initcall(rand_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706
David Howells93614012006-09-30 20:45:40 +02001707#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708void rand_initialize_disk(struct gendisk *disk)
1709{
1710 struct timer_rand_state *state;
1711
1712 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001713 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 * source.
1715 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001716 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001717 if (state) {
1718 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001720 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721}
David Howells93614012006-09-30 20:45:40 +02001722#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723
1724static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001725_random_read(int nonblock, char __user *buf, size_t nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726{
Greg Price12ff3a52013-11-29 15:02:33 -05001727 ssize_t n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728
1729 if (nbytes == 0)
1730 return 0;
1731
Greg Price12ff3a52013-11-29 15:02:33 -05001732 nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1733 while (1) {
1734 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1735 if (n < 0)
1736 return n;
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001737 trace_random_read(n*8, (nbytes-n)*8,
1738 ENTROPY_BITS(&blocking_pool),
1739 ENTROPY_BITS(&input_pool));
Greg Price12ff3a52013-11-29 15:02:33 -05001740 if (n > 0)
1741 return n;
H. Peter Anvin331c6492014-03-17 16:36:29 -07001742
Greg Price12ff3a52013-11-29 15:02:33 -05001743 /* Pool is (near) empty. Maybe wait and retry. */
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001744 if (nonblock)
Greg Price12ff3a52013-11-29 15:02:33 -05001745 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
Greg Price12ff3a52013-11-29 15:02:33 -05001747 wait_event_interruptible(random_read_wait,
1748 ENTROPY_BITS(&input_pool) >=
Greg Price2132a962013-12-06 21:28:03 -05001749 random_read_wakeup_bits);
Greg Price12ff3a52013-11-29 15:02:33 -05001750 if (signal_pending(current))
1751 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753}
1754
1755static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001756random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1757{
1758 return _random_read(file->f_flags & O_NONBLOCK, buf, nbytes);
1759}
1760
1761static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001762urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001764 unsigned long flags;
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001765 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05001766 int ret;
1767
Theodore Ts'oe192be92016-06-12 18:13:36 -04001768 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001769 maxwarn--;
1770 printk(KERN_NOTICE "random: %s: uninitialized urandom read "
Theodore Ts'oe192be92016-06-12 18:13:36 -04001771 "(%zd bytes read)\n",
1772 current->comm, nbytes);
1773 spin_lock_irqsave(&primary_crng.lock, flags);
1774 crng_init_cnt = 0;
1775 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001776 }
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001777 nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
Theodore Ts'oe192be92016-06-12 18:13:36 -04001778 ret = extract_crng_user(buf, nbytes);
1779 trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001780 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781}
1782
1783static unsigned int
1784random_poll(struct file *file, poll_table * wait)
1785{
1786 unsigned int mask;
1787
1788 poll_wait(file, &random_read_wait, wait);
1789 poll_wait(file, &random_write_wait, wait);
1790 mask = 0;
Greg Price2132a962013-12-06 21:28:03 -05001791 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 mask |= POLLIN | POLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05001793 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 mask |= POLLOUT | POLLWRNORM;
1795 return mask;
1796}
1797
Matt Mackall7f397dc2007-05-29 21:58:10 -05001798static int
1799write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1800{
1801 size_t bytes;
1802 __u32 buf[16];
1803 const char __user *p = buffer;
1804
1805 while (count > 0) {
1806 bytes = min(count, sizeof(buf));
1807 if (copy_from_user(&buf, p, bytes))
1808 return -EFAULT;
1809
1810 count -= bytes;
1811 p += bytes;
1812
Theodore Ts'o85608f82014-06-10 23:09:20 -04001813 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001814 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001815 }
1816
1817 return 0;
1818}
1819
Matt Mackall90b75ee2008-04-29 01:02:55 -07001820static ssize_t random_write(struct file *file, const char __user *buffer,
1821 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001823 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
Theodore Ts'oe192be92016-06-12 18:13:36 -04001825 ret = write_pool(&input_pool, buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05001826 if (ret)
1827 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828
Matt Mackall7f397dc2007-05-29 21:58:10 -05001829 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830}
1831
Matt Mackall43ae4862008-04-29 01:02:58 -07001832static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833{
1834 int size, ent_count;
1835 int __user *p = (int __user *)arg;
1836 int retval;
1837
1838 switch (cmd) {
1839 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001840 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001841 ent_count = ENTROPY_BITS(&input_pool);
1842 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 return -EFAULT;
1844 return 0;
1845 case RNDADDTOENTCNT:
1846 if (!capable(CAP_SYS_ADMIN))
1847 return -EPERM;
1848 if (get_user(ent_count, p))
1849 return -EFAULT;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001850 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 case RNDADDENTROPY:
1852 if (!capable(CAP_SYS_ADMIN))
1853 return -EPERM;
1854 if (get_user(ent_count, p++))
1855 return -EFAULT;
1856 if (ent_count < 0)
1857 return -EINVAL;
1858 if (get_user(size, p++))
1859 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001860 retval = write_pool(&input_pool, (const char __user *)p,
1861 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 if (retval < 0)
1863 return retval;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001864 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 case RNDZAPENTCNT:
1866 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001867 /*
1868 * Clear the entropy pool counters. We no longer clear
1869 * the entropy pool, as that's silly.
1870 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 if (!capable(CAP_SYS_ADMIN))
1872 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001873 input_pool.entropy_count = 0;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001874 blocking_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 return 0;
1876 default:
1877 return -EINVAL;
1878 }
1879}
1880
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001881static int random_fasync(int fd, struct file *filp, int on)
1882{
1883 return fasync_helper(fd, filp, on, &fasync);
1884}
1885
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001886const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 .read = random_read,
1888 .write = random_write,
1889 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001890 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001891 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001892 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893};
1894
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001895const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 .read = urandom_read,
1897 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001898 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001899 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001900 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901};
1902
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001903SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
1904 unsigned int, flags)
1905{
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001906 int ret;
1907
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001908 if (flags & ~(GRND_NONBLOCK|GRND_RANDOM))
1909 return -EINVAL;
1910
1911 if (count > INT_MAX)
1912 count = INT_MAX;
1913
1914 if (flags & GRND_RANDOM)
1915 return _random_read(flags & GRND_NONBLOCK, buf, count);
1916
Theodore Ts'oe192be92016-06-12 18:13:36 -04001917 if (!crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001918 if (flags & GRND_NONBLOCK)
1919 return -EAGAIN;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001920 ret = wait_for_random_bytes();
1921 if (unlikely(ret))
1922 return ret;
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001923 }
1924 return urandom_read(NULL, buf, count, NULL);
1925}
1926
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927/********************************************************************
1928 *
1929 * Sysctl interface
1930 *
1931 ********************************************************************/
1932
1933#ifdef CONFIG_SYSCTL
1934
1935#include <linux/sysctl.h>
1936
1937static int min_read_thresh = 8, min_write_thresh;
Greg Price8c2aa332013-12-05 19:19:29 -05001938static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939static int max_write_thresh = INPUT_POOL_WORDS * 32;
Fabio Estevamdb61ffe2017-01-31 14:36:07 -02001940static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941static char sysctl_bootid[16];
1942
1943/*
Greg Pricef22052b2013-11-29 14:58:16 -05001944 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 * UUID. The difference is in whether table->data is NULL; if it is,
1946 * then a new UUID is generated and returned to the user.
1947 *
Greg Pricef22052b2013-11-29 14:58:16 -05001948 * If the user accesses this via the proc interface, the UUID will be
1949 * returned as an ASCII string in the standard UUID format; if via the
1950 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 */
Joe Perchesa1514272013-06-13 19:37:35 -07001952static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 void __user *buffer, size_t *lenp, loff_t *ppos)
1954{
Joe Perchesa1514272013-06-13 19:37:35 -07001955 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 unsigned char buf[64], tmp_uuid[16], *uuid;
1957
1958 uuid = table->data;
1959 if (!uuid) {
1960 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001962 } else {
1963 static DEFINE_SPINLOCK(bootid_spinlock);
1964
1965 spin_lock(&bootid_spinlock);
1966 if (!uuid[8])
1967 generate_random_uuid(uuid);
1968 spin_unlock(&bootid_spinlock);
1969 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
Joe Perches35900772009-12-14 18:01:11 -08001971 sprintf(buf, "%pU", uuid);
1972
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 fake_table.data = buf;
1974 fake_table.maxlen = sizeof(buf);
1975
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001976 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977}
1978
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001979/*
1980 * Return entropy available scaled to integral bits
1981 */
Joe Perches5eb10d92014-06-06 14:37:58 -07001982static int proc_do_entropy(struct ctl_table *table, int write,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001983 void __user *buffer, size_t *lenp, loff_t *ppos)
1984{
Joe Perches5eb10d92014-06-06 14:37:58 -07001985 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001986 int entropy_count;
1987
1988 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
1989
1990 fake_table.data = &entropy_count;
1991 fake_table.maxlen = sizeof(entropy_count);
1992
1993 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1994}
1995
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07001997extern struct ctl_table random_table[];
1998struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 .procname = "poolsize",
2001 .data = &sysctl_poolsize,
2002 .maxlen = sizeof(int),
2003 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002004 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 },
2006 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 .procname = "entropy_avail",
2008 .maxlen = sizeof(int),
2009 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002010 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 .data = &input_pool.entropy_count,
2012 },
2013 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 .procname = "read_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002015 .data = &random_read_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 .maxlen = sizeof(int),
2017 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002018 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 .extra1 = &min_read_thresh,
2020 .extra2 = &max_read_thresh,
2021 },
2022 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002024 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 .maxlen = sizeof(int),
2026 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002027 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 .extra1 = &min_write_thresh,
2029 .extra2 = &max_write_thresh,
2030 },
2031 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002032 .procname = "urandom_min_reseed_secs",
2033 .data = &random_min_urandom_seed,
2034 .maxlen = sizeof(int),
2035 .mode = 0644,
2036 .proc_handler = proc_dointvec,
2037 },
2038 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 .procname = "boot_id",
2040 .data = &sysctl_bootid,
2041 .maxlen = 16,
2042 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002043 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 },
2045 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 .procname = "uuid",
2047 .maxlen = 16,
2048 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002049 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002051#ifdef ADD_INTERRUPT_BENCH
2052 {
2053 .procname = "add_interrupt_avg_cycles",
2054 .data = &avg_cycles,
2055 .maxlen = sizeof(avg_cycles),
2056 .mode = 0444,
2057 .proc_handler = proc_doulongvec_minmax,
2058 },
2059 {
2060 .procname = "add_interrupt_avg_deviation",
2061 .data = &avg_deviation,
2062 .maxlen = sizeof(avg_deviation),
2063 .mode = 0444,
2064 .proc_handler = proc_doulongvec_minmax,
2065 },
2066#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002067 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068};
2069#endif /* CONFIG_SYSCTL */
2070
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002071struct batched_entropy {
2072 union {
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002073 u64 entropy_u64[CHACHA20_BLOCK_SIZE / sizeof(u64)];
2074 u32 entropy_u32[CHACHA20_BLOCK_SIZE / sizeof(u32)];
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002075 };
2076 unsigned int position;
2077};
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002078static rwlock_t batched_entropy_reset_lock = __RW_LOCK_UNLOCKED(batched_entropy_reset_lock);
Eric Biggersb1132de2016-05-04 21:08:39 -04002079
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080/*
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002081 * Get a random word for internal kernel use only. The quality of the random
2082 * number is either as good as RDRAND or as good as /dev/urandom, with the
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002083 * goal of being quite fast and not depleting entropy. In order to ensure
2084 * that the randomness provided by this function is okay, the function
2085 * wait_for_random_bytes() should be called and return 0 at least once
2086 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 */
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002088static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64);
2089u64 get_random_u64(void)
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002090{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002091 u64 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002092 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002093 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002094 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002095 static void *previous;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002096
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002097#if BITS_PER_LONG == 64
2098 if (arch_get_random_long((unsigned long *)&ret))
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002099 return ret;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002100#else
2101 if (arch_get_random_long((unsigned long *)&ret) &&
2102 arch_get_random_long((unsigned long *)&ret + 1))
2103 return ret;
2104#endif
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002105
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002106 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002107
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002108 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002109 batch = &get_cpu_var(batched_entropy_u64);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002110 if (use_lock)
2111 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002112 if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
2113 extract_crng((u8 *)batch->entropy_u64);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002114 batch->position = 0;
2115 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002116 ret = batch->entropy_u64[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002117 if (use_lock)
2118 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002119 put_cpu_var(batched_entropy_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002120 return ret;
2121}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002122EXPORT_SYMBOL(get_random_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002123
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002124static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32);
2125u32 get_random_u32(void)
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002126{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002127 u32 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002128 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002129 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002130 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002131 static void *previous;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002132
2133 if (arch_get_random_int(&ret))
2134 return ret;
2135
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002136 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002137
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002138 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002139 batch = &get_cpu_var(batched_entropy_u32);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002140 if (use_lock)
2141 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002142 if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
2143 extract_crng((u8 *)batch->entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002144 batch->position = 0;
2145 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002146 ret = batch->entropy_u32[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002147 if (use_lock)
2148 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002149 put_cpu_var(batched_entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002150 return ret;
2151}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002152EXPORT_SYMBOL(get_random_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002153
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002154/* It's important to invalidate all potential batched entropy that might
2155 * be stored before the crng is initialized, which we can do lazily by
2156 * simply resetting the counter to zero so that it's re-extracted on the
2157 * next usage. */
2158static void invalidate_batched_entropy(void)
2159{
2160 int cpu;
2161 unsigned long flags;
2162
2163 write_lock_irqsave(&batched_entropy_reset_lock, flags);
2164 for_each_possible_cpu (cpu) {
2165 per_cpu_ptr(&batched_entropy_u32, cpu)->position = 0;
2166 per_cpu_ptr(&batched_entropy_u64, cpu)->position = 0;
2167 }
2168 write_unlock_irqrestore(&batched_entropy_reset_lock, flags);
2169}
2170
Jason Cooper99fdafd2016-10-11 13:53:52 -07002171/**
2172 * randomize_page - Generate a random, page aligned address
2173 * @start: The smallest acceptable address the caller will take.
2174 * @range: The size of the area, starting at @start, within which the
2175 * random address must fall.
2176 *
2177 * If @start + @range would overflow, @range is capped.
2178 *
2179 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2180 * @start was already page aligned. We now align it regardless.
2181 *
2182 * Return: A page aligned address within [start, start + range). On error,
2183 * @start is returned.
2184 */
2185unsigned long
2186randomize_page(unsigned long start, unsigned long range)
2187{
2188 if (!PAGE_ALIGNED(start)) {
2189 range -= PAGE_ALIGN(start) - start;
2190 start = PAGE_ALIGN(start);
2191 }
2192
2193 if (start > ULONG_MAX - range)
2194 range = ULONG_MAX - start;
2195
2196 range >>= PAGE_SHIFT;
2197
2198 if (range == 0)
2199 return start;
2200
2201 return start + (get_random_long() % range << PAGE_SHIFT);
2202}
2203
Torsten Duwec84dbf62014-06-14 23:38:36 -04002204/* Interface for in-kernel drivers of true hardware RNGs.
2205 * Those devices may produce endless random bits and will be throttled
2206 * when our pool is full.
2207 */
2208void add_hwgenerator_randomness(const char *buffer, size_t count,
2209 size_t entropy)
2210{
2211 struct entropy_store *poolp = &input_pool;
2212
Theodore Ts'oe192be92016-06-12 18:13:36 -04002213 if (!crng_ready()) {
2214 crng_fast_load(buffer, count);
2215 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002216 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002217
2218 /* Suspend writing if we're above the trickle threshold.
2219 * We'll be woken up again once below random_write_wakeup_thresh,
2220 * or when the calling thread is about to terminate.
2221 */
2222 wait_event_interruptible(random_write_wait, kthread_should_stop() ||
2223 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002224 mix_pool_bytes(poolp, buffer, count);
2225 credit_entropy_bits(poolp, entropy);
2226}
2227EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);