blob: 909e0c3d82ea443bc5a34c3e085fa7835f2df1b5 [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 *
George Spelvin92e507d2019-04-19 23:48:20 -0400104 * There are four exported interfaces; two for use within the kernel,
105 * and two or use from userspace.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 *
George Spelvin92e507d2019-04-19 23:48:20 -0400107 * Exported interfaces ---- userspace output
108 * -----------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 *
George Spelvin92e507d2019-04-19 23:48:20 -0400110 * The userspace interfaces are two character devices /dev/random and
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 * /dev/urandom. /dev/random is suitable for use when very high
112 * quality randomness is desired (for example, for key generation or
113 * one-time pads), as it will only return a maximum of the number of
114 * bits of randomness (as estimated by the random number generator)
115 * contained in the entropy pool.
116 *
117 * The /dev/urandom device does not have this limit, and will return
118 * as many bytes as are requested. As more and more random bytes are
119 * requested without giving time for the entropy pool to recharge,
120 * this will result in random numbers that are merely cryptographically
121 * strong. For many applications, however, this is acceptable.
122 *
George Spelvin92e507d2019-04-19 23:48:20 -0400123 * Exported interfaces ---- kernel output
124 * --------------------------------------
125 *
126 * The primary kernel interface is
127 *
128 * void get_random_bytes(void *buf, int nbytes);
129 *
130 * This interface will return the requested number of random bytes,
131 * and place it in the requested buffer. This is equivalent to a
132 * read from /dev/urandom.
133 *
134 * For less critical applications, there are the functions:
135 *
136 * u32 get_random_u32()
137 * u64 get_random_u64()
138 * unsigned int get_random_int()
139 * unsigned long get_random_long()
140 *
141 * These are produced by a cryptographic RNG seeded from get_random_bytes,
142 * and so do not deplete the entropy pool as much. These are recommended
143 * for most in-kernel operations *if the result is going to be stored in
144 * the kernel*.
145 *
146 * Specifically, the get_random_int() family do not attempt to do
147 * "anti-backtracking". If you capture the state of the kernel (e.g.
148 * by snapshotting the VM), you can figure out previous get_random_int()
149 * return values. But if the value is stored in the kernel anyway,
150 * this is not a problem.
151 *
152 * It *is* safe to expose get_random_int() output to attackers (e.g. as
153 * network cookies); given outputs 1..n, it's not feasible to predict
154 * outputs 0 or n+1. The only concern is an attacker who breaks into
155 * the kernel later; the get_random_int() engine is not reseeded as
156 * often as the get_random_bytes() one.
157 *
158 * get_random_bytes() is needed for keys that need to stay secret after
159 * they are erased from the kernel. For example, any key that will
160 * be wrapped and stored encrypted. And session encryption keys: we'd
161 * like to know that after the session is closed and the keys erased,
162 * the plaintext is unrecoverable to someone who recorded the ciphertext.
163 *
164 * But for network ports/cookies, stack canaries, PRNG seeds, address
165 * space layout randomization, session *authentication* keys, or other
166 * applications where the sensitive data is stored in the kernel in
167 * plaintext for as long as it's sensitive, the get_random_int() family
168 * is just fine.
169 *
170 * Consider ASLR. We want to keep the address space secret from an
171 * outside attacker while the process is running, but once the address
172 * space is torn down, it's of no use to an attacker any more. And it's
173 * stored in kernel data structures as long as it's alive, so worrying
174 * about an attacker's ability to extrapolate it from the get_random_int()
175 * CRNG is silly.
176 *
177 * Even some cryptographic keys are safe to generate with get_random_int().
178 * In particular, keys for SipHash are generally fine. Here, knowledge
179 * of the key authorizes you to do something to a kernel object (inject
180 * packets to a network connection, or flood a hash table), and the
181 * key is stored with the object being protected. Once it goes away,
182 * we no longer care if anyone knows the key.
183 *
184 * prandom_u32()
185 * -------------
186 *
187 * For even weaker applications, see the pseudorandom generator
188 * prandom_u32(), prandom_max(), and prandom_bytes(). If the random
189 * numbers aren't security-critical at all, these are *far* cheaper.
190 * Useful for self-tests, random error simulation, randomized backoffs,
191 * and any other application where you trust that nobody is trying to
192 * maliciously mess with you by guessing the "random" numbers.
193 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 * Exported interfaces ---- input
195 * ==============================
196 *
197 * The current exported interfaces for gathering environmental noise
198 * from the devices are:
199 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400200 * void add_device_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 * void add_input_randomness(unsigned int type, unsigned int code,
202 * unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400203 * void add_interrupt_randomness(int irq, int irq_flags);
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100204 * void add_disk_randomness(struct gendisk *disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400206 * add_device_randomness() is for adding data to the random pool that
207 * is likely to differ between two devices (or possibly even per boot).
208 * This would be things like MAC addresses or serial numbers, or the
209 * read-out of the RTC. This does *not* add any actual entropy to the
210 * pool, but it initializes the pool to different values for devices
211 * that might otherwise be identical and have very little entropy
212 * available to them (particularly common in the embedded world).
213 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 * add_input_randomness() uses the input layer interrupt timing, as well as
215 * the event type information from the hardware.
216 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400217 * add_interrupt_randomness() uses the interrupt timing as random
218 * inputs to the entropy pool. Using the cycle counters and the irq source
219 * as inputs, it feeds the randomness roughly once a second.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100220 *
221 * add_disk_randomness() uses what amounts to the seek time of block
222 * layer request events, on a per-disk_devt basis, as input to the
223 * entropy pool. Note that high-speed solid state drives with very low
224 * seek times do not make for good sources of entropy, as their seek
225 * times are usually fairly consistent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 *
227 * All of these routines try to estimate how many bits of randomness a
228 * particular randomness source. They do this by keeping track of the
229 * first and second order deltas of the event timings.
230 *
231 * Ensuring unpredictability at system startup
232 * ============================================
233 *
234 * When any operating system starts up, it will go through a sequence
235 * of actions that are fairly predictable by an adversary, especially
236 * if the start-up does not involve interaction with a human operator.
237 * This reduces the actual number of bits of unpredictability in the
238 * entropy pool below the value in entropy_count. In order to
239 * counteract this effect, it helps to carry information in the
240 * entropy pool across shut-downs and start-ups. To do this, put the
241 * following lines an appropriate script which is run during the boot
242 * sequence:
243 *
244 * echo "Initializing random number generator..."
245 * random_seed=/var/run/random-seed
246 * # Carry a random seed from start-up to start-up
247 * # Load and then save the whole entropy pool
248 * if [ -f $random_seed ]; then
249 * cat $random_seed >/dev/urandom
250 * else
251 * touch $random_seed
252 * fi
253 * chmod 600 $random_seed
254 * dd if=/dev/urandom of=$random_seed count=1 bs=512
255 *
256 * and the following lines in an appropriate script which is run as
257 * the system is shutdown:
258 *
259 * # Carry a random seed from shut-down to start-up
260 * # Save the whole entropy pool
261 * echo "Saving random seed..."
262 * random_seed=/var/run/random-seed
263 * touch $random_seed
264 * chmod 600 $random_seed
265 * dd if=/dev/urandom of=$random_seed count=1 bs=512
266 *
267 * For example, on most modern systems using the System V init
268 * scripts, such code fragments would be found in
269 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
270 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
271 *
272 * Effectively, these commands cause the contents of the entropy pool
273 * to be saved at shut-down time and reloaded into the entropy pool at
274 * start-up. (The 'dd' in the addition to the bootup script is to
275 * make sure that /etc/random-seed is different for every start-up,
276 * even if the system crashes without executing rc.0.) Even with
277 * complete knowledge of the start-up activities, predicting the state
278 * of the entropy pool requires knowledge of the previous history of
279 * the system.
280 *
281 * Configuring the /dev/random driver under Linux
282 * ==============================================
283 *
284 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
285 * the /dev/mem major number (#1). So if your system does not have
286 * /dev/random and /dev/urandom created already, they can be created
287 * by using the commands:
288 *
289 * mknod /dev/random c 1 8
290 * mknod /dev/urandom c 1 9
291 *
292 * Acknowledgements:
293 * =================
294 *
295 * Ideas for constructing this random number generator were derived
296 * from Pretty Good Privacy's random number generator, and from private
297 * discussions with Phil Karn. Colin Plumb provided a faster random
298 * number generator, which speed up the mixing function of the entropy
299 * pool, taken from PGPfone. Dale Worley has also contributed many
300 * useful ideas and suggestions to improve this driver.
301 *
302 * Any flaws in the design are solely my responsibility, and should
303 * not be attributed to the Phil, Colin, or any of authors of PGP.
304 *
305 * Further background information on this topic may be obtained from
306 * RFC 1750, "Randomness Recommendations for Security", by Donald
307 * Eastlake, Steve Crocker, and Jeff Schiller.
308 */
309
310#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311#include <linux/module.h>
312#include <linux/kernel.h>
313#include <linux/major.h>
314#include <linux/string.h>
315#include <linux/fcntl.h>
316#include <linux/slab.h>
317#include <linux/random.h>
318#include <linux/poll.h>
319#include <linux/init.h>
320#include <linux/fs.h>
321#include <linux/genhd.h>
322#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700323#include <linux/mm.h>
Michael Ellermandd0f0cf2016-07-31 00:23:08 +1000324#include <linux/nodemask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325#include <linux/spinlock.h>
Torsten Duwec84dbf62014-06-14 23:38:36 -0400326#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327#include <linux/percpu.h>
328#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800329#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400330#include <linux/ptrace.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400331#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200332#include <linux/irq.h>
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400333#include <linux/ratelimit.h>
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400334#include <linux/syscalls.h>
335#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700336#include <linux/uuid.h>
Eric Biggers1ca1b912018-11-16 17:26:21 -0800337#include <crypto/chacha.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800338
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339#include <asm/processor.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800340#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400342#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343#include <asm/io.h>
344
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400345#define CREATE_TRACE_POINTS
346#include <trace/events/random.h>
347
Theodore Ts'o43759d42014-06-14 21:43:13 -0400348/* #define ADD_INTERRUPT_BENCH */
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350/*
351 * Configuration information
352 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400353#define INPUT_POOL_SHIFT 12
354#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
355#define OUTPUT_POOL_SHIFT 10
356#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
357#define SEC_XFER_SIZE 512
358#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400361#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
362
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400364 * To allow fractional bits to be tracked, the entropy_count field is
365 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400366 *
Rasmus Villemoes3bd0b5b2018-11-02 12:04:46 +0100367 * 2*(ENTROPY_SHIFT + poolbitshift) must <= 31, or the multiply in
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400368 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400369 */
370#define ENTROPY_SHIFT 3
371#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
372
373/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 * The minimum number of bits of entropy before we wake up a read on
375 * /dev/random. Should be enough to do a significant reseed.
376 */
Greg Price2132a962013-12-06 21:28:03 -0500377static int random_read_wakeup_bits = 64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
379/*
380 * If the entropy count falls under this number of bits, then we
381 * should wake up processes which are selecting or polling on write
382 * access to /dev/random.
383 */
Greg Price2132a962013-12-06 21:28:03 -0500384static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
386/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400387 * Originally, we used a primitive polynomial of degree .poolwords
388 * over GF(2). The taps for various sizes are defined below. They
389 * were chosen to be evenly spaced except for the last tap, which is 1
390 * to get the twisting happening as fast as possible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400392 * For the purposes of better mixing, we use the CRC-32 polynomial as
393 * well to make a (modified) twisted Generalized Feedback Shift
394 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
395 * generators. ACM Transactions on Modeling and Computer Simulation
396 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
Greg Pricedfd38752013-11-29 14:58:06 -0500397 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400398 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 *
400 * Thanks to Colin Plumb for suggesting this.
401 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400402 * The mixing operation is much less sensitive than the output hash,
403 * where we use SHA-1. All that we want of mixing operation is that
404 * it be a good non-cryptographic hash; i.e. it not produce collisions
405 * when fed "random" data of the sort we expect to see. As long as
406 * the pool state differs for different inputs, we have preserved the
407 * input entropy and done a good job. The fact that an intelligent
408 * attacker can construct inputs that will produce controlled
409 * alterations to the pool's state is not important because we don't
410 * consider such inputs to contribute any randomness. The only
411 * property we need with respect to them is that the attacker can't
412 * increase his/her knowledge of the pool's state. Since all
413 * additions are reversible (knowing the final state and the input,
414 * you can reconstruct the initial state), if an attacker has any
415 * uncertainty about the initial state, he/she can only shuffle that
416 * uncertainty about, but never cause any collisions (which would
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 * decrease the uncertainty).
418 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400419 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
420 * Videau in their paper, "The Linux Pseudorandom Number Generator
421 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
422 * paper, they point out that we are not using a true Twisted GFSR,
423 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
424 * is, with only three taps, instead of the six that we are using).
425 * As a result, the resulting polynomial is neither primitive nor
426 * irreducible, and hence does not have a maximal period over
427 * GF(2**32). They suggest a slight change to the generator
428 * polynomial which improves the resulting TGFSR polynomial to be
429 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 */
Rasmus Villemoes26e08542018-11-02 12:04:45 +0100431static const struct poolinfo {
Rasmus Villemoes3bd0b5b2018-11-02 12:04:46 +0100432 int poolbitshift, poolwords, poolbytes, poolfracbits;
433#define S(x) ilog2(x)+5, (x), (x)*4, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 int tap1, tap2, tap3, tap4, tap5;
435} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400436 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
437 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
438 { S(128), 104, 76, 51, 25, 1 },
439 /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
440 /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
441 { S(32), 26, 19, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442#if 0
443 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400444 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
446 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400447 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400450 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400453 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400456 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400458 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400461 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
463 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400464 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400467 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468#endif
469};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
471/*
472 * Static global variables
473 */
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700474static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
475static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700476static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Herbert Xu205a5252015-06-09 18:19:39 +0800478static DEFINE_SPINLOCK(random_ready_list_lock);
479static LIST_HEAD(random_ready_list);
480
Theodore Ts'oe192be92016-06-12 18:13:36 -0400481struct crng_state {
482 __u32 state[16];
483 unsigned long init_time;
484 spinlock_t lock;
485};
486
Rasmus Villemoes764ed182018-11-02 12:04:47 +0100487static struct crng_state primary_crng = {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400488 .lock = __SPIN_LOCK_UNLOCKED(primary_crng.lock),
489};
490
491/*
492 * crng_init = 0 --> Uninitialized
493 * 1 --> Initialized
494 * 2 --> Initialized from input_pool
495 *
496 * crng_init is protected by primary_crng->lock, and only increases
497 * its value (from 0->1->2).
498 */
499static int crng_init = 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400500#define crng_ready() (likely(crng_init > 1))
Theodore Ts'oe192be92016-06-12 18:13:36 -0400501static int crng_init_cnt = 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400502static unsigned long crng_global_init_time = 0;
Eric Biggers1ca1b912018-11-16 17:26:21 -0800503#define CRNG_INIT_CNT_THRESH (2*CHACHA_KEY_SIZE)
504static void _extract_crng(struct crng_state *crng, __u8 out[CHACHA_BLOCK_SIZE]);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400505static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers1ca1b912018-11-16 17:26:21 -0800506 __u8 tmp[CHACHA_BLOCK_SIZE], int used);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400507static void process_random_ready_list(void);
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400508static void _get_random_bytes(void *buf, int nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400509
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400510static struct ratelimit_state unseeded_warning =
511 RATELIMIT_STATE_INIT("warn_unseeded_randomness", HZ, 3);
512static struct ratelimit_state urandom_warning =
513 RATELIMIT_STATE_INIT("warn_urandom_randomness", HZ, 3);
514
515static int ratelimit_disable __read_mostly;
516
517module_param_named(ratelimit_disable, ratelimit_disable, int, 0644);
518MODULE_PARM_DESC(ratelimit_disable, "Disable random ratelimit suppression");
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520/**********************************************************************
521 *
522 * OS independent entropy store. Here are the functions which handle
523 * storing entropy in an entropy pool.
524 *
525 **********************************************************************/
526
527struct entropy_store;
528struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700529 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400530 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 __u32 *pool;
532 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400534 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
536 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400537 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700538 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400539 unsigned short add_ptr;
540 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800541 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400542 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400543 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000544 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545};
546
Theodore Ts'oe192be92016-06-12 18:13:36 -0400547static ssize_t extract_entropy(struct entropy_store *r, void *buf,
548 size_t nbytes, int min, int rsvd);
549static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
550 size_t nbytes, int fips);
551
552static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400553static void push_to_pool(struct work_struct *work);
Emese Revfy0766f782016-06-20 20:42:34 +0200554static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
555static __u32 blocking_pool_data[OUTPUT_POOL_WORDS] __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
557static struct entropy_store input_pool = {
558 .poolinfo = &poolinfo_table[0],
559 .name = "input",
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200560 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 .pool = input_pool_data
562};
563
564static struct entropy_store blocking_pool = {
565 .poolinfo = &poolinfo_table[1],
566 .name = "blocking",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200568 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400569 .pool = blocking_pool_data,
570 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
571 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572};
573
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400574static __u32 const twist_table[8] = {
575 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
576 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700579 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700581 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 *
583 * The pool is stirred with a primitive polynomial of the appropriate
584 * degree, and then twisted. We twist by three bits at a time because
585 * it's cheap to do so and helps slightly in the expected case where
586 * the entropy is concentrated in the low-order bits.
587 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400588static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400589 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400591 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700592 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700594 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700595 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 tap1 = r->poolinfo->tap1;
598 tap2 = r->poolinfo->tap2;
599 tap3 = r->poolinfo->tap3;
600 tap4 = r->poolinfo->tap4;
601 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400603 input_rotate = r->input_rotate;
604 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
Matt Mackalle68e5b62008-04-29 01:03:05 -0700606 /* mix one byte at a time to simplify size handling and churn faster */
607 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400608 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700609 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
611 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700612 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 w ^= r->pool[(i + tap1) & wordmask];
614 w ^= r->pool[(i + tap2) & wordmask];
615 w ^= r->pool[(i + tap3) & wordmask];
616 w ^= r->pool[(i + tap4) & wordmask];
617 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700618
619 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700621
622 /*
623 * Normally, we add 7 bits of rotation to the pool.
624 * At the beginning of the pool, add an extra 7 bits
625 * rotation, so that successive passes spread the
626 * input bits across the pool evenly.
627 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400628 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 }
630
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400631 r->input_rotate = input_rotate;
632 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
634
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400635static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400636 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400638 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400639 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400640}
641
642static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400643 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400644{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400645 unsigned long flags;
646
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400647 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400648 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400649 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400650 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651}
652
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400653struct fast_pool {
654 __u32 pool[4];
655 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400656 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400657 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400658};
659
660/*
661 * This is a fast mixing routine used by the interrupt randomness
662 * collector. It's hardcoded for an 128 bit pool and assumes that any
663 * locks that might be needed are taken by the caller.
664 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400665static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400666{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400667 __u32 a = f->pool[0], b = f->pool[1];
668 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400669
Theodore Ts'o43759d42014-06-14 21:43:13 -0400670 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500671 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400672 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400673
Theodore Ts'o43759d42014-06-14 21:43:13 -0400674 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500675 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400676 d ^= a; b ^= c;
677
678 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500679 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400680 d ^= a; b ^= c;
681
682 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500683 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400684 d ^= a; b ^= c;
685
686 f->pool[0] = a; f->pool[1] = b;
687 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400688 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400689}
690
Herbert Xu205a5252015-06-09 18:19:39 +0800691static void process_random_ready_list(void)
692{
693 unsigned long flags;
694 struct random_ready_callback *rdy, *tmp;
695
696 spin_lock_irqsave(&random_ready_list_lock, flags);
697 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
698 struct module *owner = rdy->owner;
699
700 list_del_init(&rdy->list);
701 rdy->func(rdy);
702 module_put(owner);
703 }
704 spin_unlock_irqrestore(&random_ready_list_lock, flags);
705}
706
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400708 * Credit (or debit) the entropy store with n bits of entropy.
709 * Use credit_entropy_bits_safe() if the value comes from userspace
710 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700712static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713{
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500714 int entropy_count, orig, has_initialized = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400715 const int pool_size = r->poolinfo->poolfracbits;
716 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
Matt Mackalladc782d2008-04-29 01:03:07 -0700718 if (!nbits)
719 return;
720
Theodore Ts'o902c0982012-07-04 10:38:30 -0400721retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -0700722 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400723 if (nfrac < 0) {
724 /* Debit */
725 entropy_count += nfrac;
726 } else {
727 /*
728 * Credit: we have to account for the possibility of
729 * overwriting already present entropy. Even in the
730 * ideal case of pure Shannon entropy, new contributions
731 * approach the full value asymptotically:
732 *
733 * entropy <- entropy + (pool_size - entropy) *
734 * (1 - exp(-add_entropy/pool_size))
735 *
736 * For add_entropy <= pool_size/2 then
737 * (1 - exp(-add_entropy/pool_size)) >=
738 * (add_entropy/pool_size)*0.7869...
739 * so we can approximate the exponential with
740 * 3/4*add_entropy/pool_size and still be on the
741 * safe side by adding at most pool_size/2 at a time.
742 *
743 * The use of pool_size-2 in the while statement is to
744 * prevent rounding artifacts from making the loop
745 * arbitrarily long; this limits the loop to log2(pool_size)*2
746 * turns no matter how large nbits is.
747 */
748 int pnfrac = nfrac;
749 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
750 /* The +2 corresponds to the /4 in the denominator */
751
752 do {
753 unsigned int anfrac = min(pnfrac, pool_size/2);
754 unsigned int add =
755 ((pool_size - entropy_count)*anfrac*3) >> s;
756
757 entropy_count += add;
758 pnfrac -= anfrac;
759 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
760 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400761
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -0400762 if (unlikely(entropy_count < 0)) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400763 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
764 r->name, entropy_count);
765 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700766 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400767 } else if (entropy_count > pool_size)
768 entropy_count = pool_size;
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500769 if ((r == &blocking_pool) && !r->initialized &&
770 (entropy_count >> ENTROPY_SHIFT) > 128)
771 has_initialized = 1;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400772 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
773 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
Theodore Ts'o58be0102019-05-22 12:02:16 -0400775 if (has_initialized) {
Linus Torvalds0891ad82013-11-16 10:19:15 -0800776 r->initialized = 1;
Theodore Ts'o58be0102019-05-22 12:02:16 -0400777 wake_up_interruptible(&random_read_wait);
778 kill_fasync(&fasync, SIGIO, POLL_IN);
779 }
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400780
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400781 trace_credit_entropy_bits(r->name, nbits,
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500782 entropy_count >> ENTROPY_SHIFT, _RET_IP_);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400783
Theodore Ts'o6265e162013-10-03 01:08:15 -0400784 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500785 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500786 struct entropy_store *other = &blocking_pool;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400787
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500788 if (crng_init < 2) {
789 if (entropy_bits < 128)
790 return;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400791 crng_reseed(&primary_crng, r);
792 entropy_bits = r->entropy_count >> ENTROPY_SHIFT;
793 }
794
Theodore Ts'o58be0102019-05-22 12:02:16 -0400795 /* initialize the blocking pool if necessary */
796 if (entropy_bits >= random_read_wakeup_bits &&
797 !other->initialized) {
798 schedule_work(&other->push_work);
799 return;
800 }
801
Theodore Ts'o6265e162013-10-03 01:08:15 -0400802 /* should we wake readers? */
Andi Kleene8e8a2e2018-02-28 13:43:28 -0800803 if (entropy_bits >= random_read_wakeup_bits &&
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700804 wq_has_sleeper(&random_read_wait)) {
805 wake_up_interruptible(&random_read_wait);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400806 kill_fasync(&fasync, SIGIO, POLL_IN);
807 }
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500808 /* If the input pool is getting full, and the blocking
809 * pool has room, send some entropy to the blocking
810 * pool.
Theodore Ts'o6265e162013-10-03 01:08:15 -0400811 */
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500812 if (!work_pending(&other->push_work) &&
813 (ENTROPY_BITS(r) > 6 * r->poolinfo->poolbytes) &&
814 (ENTROPY_BITS(other) <= 6 * other->poolinfo->poolbytes))
815 schedule_work(&other->push_work);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700816 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817}
818
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400819static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400820{
Theodore Ts'o9f886f42017-02-25 18:21:33 -0400821 const int nbits_max = r->poolinfo->poolwords * 32;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400822
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400823 if (nbits < 0)
824 return -EINVAL;
825
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400826 /* Cap the value to avoid overflows */
827 nbits = min(nbits, nbits_max);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400828
829 credit_entropy_bits(r, nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400830 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400831}
832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833/*********************************************************************
834 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400835 * CRNG using CHACHA20
836 *
837 *********************************************************************/
838
839#define CRNG_RESEED_INTERVAL (300*HZ)
840
841static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
842
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400843#ifdef CONFIG_NUMA
844/*
845 * Hack to deal with crazy userspace progams when they are all trying
846 * to access /dev/urandom in parallel. The programs are almost
847 * certainly doing something terribly wrong, but we'll work around
848 * their brain damage.
849 */
850static struct crng_state **crng_node_pool __read_mostly;
851#endif
852
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400853static void invalidate_batched_entropy(void);
Jon DeVreefe6f1a62019-04-19 23:35:16 -0400854static void numa_crng_init(void);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400855
Kees Cook9b254362018-08-27 14:51:54 -0700856static bool trust_cpu __ro_after_init = IS_ENABLED(CONFIG_RANDOM_TRUST_CPU);
857static int __init parse_trust_cpu(char *arg)
858{
859 return kstrtobool(arg, &trust_cpu);
860}
861early_param("random.trust_cpu", parse_trust_cpu);
862
Theodore Ts'oe192be92016-06-12 18:13:36 -0400863static void crng_initialize(struct crng_state *crng)
864{
865 int i;
Theodore Ts'o39a88832018-07-17 18:24:27 -0400866 int arch_init = 1;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400867 unsigned long rv;
868
869 memcpy(&crng->state[0], "expand 32-byte k", 16);
870 if (crng == &primary_crng)
871 _extract_entropy(&input_pool, &crng->state[4],
872 sizeof(__u32) * 12, 0);
873 else
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400874 _get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400875 for (i = 4; i < 16; i++) {
876 if (!arch_get_random_seed_long(&rv) &&
Theodore Ts'o39a88832018-07-17 18:24:27 -0400877 !arch_get_random_long(&rv)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400878 rv = random_get_entropy();
Theodore Ts'o39a88832018-07-17 18:24:27 -0400879 arch_init = 0;
880 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400881 crng->state[i] ^= rv;
882 }
Jon DeVreefe6f1a62019-04-19 23:35:16 -0400883 if (trust_cpu && arch_init && crng == &primary_crng) {
884 invalidate_batched_entropy();
885 numa_crng_init();
Theodore Ts'o39a88832018-07-17 18:24:27 -0400886 crng_init = 2;
887 pr_notice("random: crng done (trusting CPU's manufacturer)\n");
888 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400889 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
890}
891
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400892#ifdef CONFIG_NUMA
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400893static void do_numa_crng_init(struct work_struct *work)
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400894{
895 int i;
896 struct crng_state *crng;
897 struct crng_state **pool;
898
899 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
900 for_each_online_node(i) {
901 crng = kmalloc_node(sizeof(struct crng_state),
902 GFP_KERNEL | __GFP_NOFAIL, i);
903 spin_lock_init(&crng->lock);
904 crng_initialize(crng);
905 pool[i] = crng;
906 }
907 mb();
908 if (cmpxchg(&crng_node_pool, NULL, pool)) {
909 for_each_node(i)
910 kfree(pool[i]);
911 kfree(pool);
912 }
913}
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400914
915static DECLARE_WORK(numa_crng_init_work, do_numa_crng_init);
916
917static void numa_crng_init(void)
918{
919 schedule_work(&numa_crng_init_work);
920}
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400921#else
922static void numa_crng_init(void) {}
923#endif
924
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400925/*
926 * crng_fast_load() can be called by code in the interrupt service
927 * path. So we can't afford to dilly-dally.
928 */
Theodore Ts'oe192be92016-06-12 18:13:36 -0400929static int crng_fast_load(const char *cp, size_t len)
930{
931 unsigned long flags;
932 char *p;
933
934 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
935 return 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400936 if (crng_init != 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400937 spin_unlock_irqrestore(&primary_crng.lock, flags);
938 return 0;
939 }
940 p = (unsigned char *) &primary_crng.state[4];
941 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
Eric Biggers1ca1b912018-11-16 17:26:21 -0800942 p[crng_init_cnt % CHACHA_KEY_SIZE] ^= *cp;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400943 cp++; crng_init_cnt++; len--;
944 }
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200945 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400946 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400947 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400948 crng_init = 1;
949 wake_up_interruptible(&crng_init_wait);
950 pr_notice("random: fast init done\n");
951 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400952 return 1;
953}
954
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400955/*
956 * crng_slow_load() is called by add_device_randomness, which has two
957 * attributes. (1) We can't trust the buffer passed to it is
958 * guaranteed to be unpredictable (so it might not have any entropy at
959 * all), and (2) it doesn't have the performance constraints of
960 * crng_fast_load().
961 *
962 * So we do something more comprehensive which is guaranteed to touch
963 * all of the primary_crng's state, and which uses a LFSR with a
964 * period of 255 as part of the mixing algorithm. Finally, we do
965 * *not* advance crng_init_cnt since buffer we may get may be something
966 * like a fixed DMI table (for example), which might very well be
967 * unique to the machine, but is otherwise unvarying.
968 */
969static int crng_slow_load(const char *cp, size_t len)
970{
971 unsigned long flags;
972 static unsigned char lfsr = 1;
973 unsigned char tmp;
Eric Biggers1ca1b912018-11-16 17:26:21 -0800974 unsigned i, max = CHACHA_KEY_SIZE;
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400975 const char * src_buf = cp;
976 char * dest_buf = (char *) &primary_crng.state[4];
977
978 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
979 return 0;
980 if (crng_init != 0) {
981 spin_unlock_irqrestore(&primary_crng.lock, flags);
982 return 0;
983 }
984 if (len > max)
985 max = len;
986
987 for (i = 0; i < max ; i++) {
988 tmp = lfsr;
989 lfsr >>= 1;
990 if (tmp & 1)
991 lfsr ^= 0xE1;
Eric Biggers1ca1b912018-11-16 17:26:21 -0800992 tmp = dest_buf[i % CHACHA_KEY_SIZE];
993 dest_buf[i % CHACHA_KEY_SIZE] ^= src_buf[i % len] ^ lfsr;
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400994 lfsr += (tmp << 3) | (tmp >> 5);
995 }
996 spin_unlock_irqrestore(&primary_crng.lock, flags);
997 return 1;
998}
999
Theodore Ts'oe192be92016-06-12 18:13:36 -04001000static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
1001{
1002 unsigned long flags;
1003 int i, num;
1004 union {
Eric Biggers1ca1b912018-11-16 17:26:21 -08001005 __u8 block[CHACHA_BLOCK_SIZE];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001006 __u32 key[8];
1007 } buf;
1008
1009 if (r) {
1010 num = extract_entropy(r, &buf, 32, 16, 0);
1011 if (num == 0)
1012 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001013 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001014 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001015 _crng_backtrack_protect(&primary_crng, buf.block,
Eric Biggers1ca1b912018-11-16 17:26:21 -08001016 CHACHA_KEY_SIZE);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001017 }
Theodore Ts'o0bb29a82018-04-12 00:50:45 -04001018 spin_lock_irqsave(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001019 for (i = 0; i < 8; i++) {
1020 unsigned long rv;
1021 if (!arch_get_random_seed_long(&rv) &&
1022 !arch_get_random_long(&rv))
1023 rv = random_get_entropy();
1024 crng->state[i+4] ^= buf.key[i] ^ rv;
1025 }
1026 memzero_explicit(&buf, sizeof(buf));
1027 crng->init_time = jiffies;
Theodore Ts'o0bb29a82018-04-12 00:50:45 -04001028 spin_unlock_irqrestore(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001029 if (crng == &primary_crng && crng_init < 2) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04001030 invalidate_batched_entropy();
Theodore Ts'o8ef35c82018-04-11 15:23:56 -04001031 numa_crng_init();
Theodore Ts'oe192be92016-06-12 18:13:36 -04001032 crng_init = 2;
1033 process_random_ready_list();
1034 wake_up_interruptible(&crng_init_wait);
1035 pr_notice("random: crng init done\n");
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001036 if (unseeded_warning.missed) {
1037 pr_notice("random: %d get_random_xx warning(s) missed "
1038 "due to ratelimiting\n",
1039 unseeded_warning.missed);
1040 unseeded_warning.missed = 0;
1041 }
1042 if (urandom_warning.missed) {
1043 pr_notice("random: %d urandom warning(s) missed "
1044 "due to ratelimiting\n",
1045 urandom_warning.missed);
1046 urandom_warning.missed = 0;
1047 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04001048 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04001049}
1050
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001051static void _extract_crng(struct crng_state *crng,
Eric Biggers1ca1b912018-11-16 17:26:21 -08001052 __u8 out[CHACHA_BLOCK_SIZE])
Theodore Ts'oe192be92016-06-12 18:13:36 -04001053{
1054 unsigned long v, flags;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001055
Theodore Ts'o43838a22018-04-11 13:27:52 -04001056 if (crng_ready() &&
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001057 (time_after(crng_global_init_time, crng->init_time) ||
1058 time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL)))
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001059 crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001060 spin_lock_irqsave(&crng->lock, flags);
1061 if (arch_get_random_long(&v))
1062 crng->state[14] ^= v;
1063 chacha20_block(&crng->state[0], out);
1064 if (crng->state[12] == 0)
1065 crng->state[13]++;
1066 spin_unlock_irqrestore(&crng->lock, flags);
1067}
1068
Eric Biggers1ca1b912018-11-16 17:26:21 -08001069static void extract_crng(__u8 out[CHACHA_BLOCK_SIZE])
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001070{
1071 struct crng_state *crng = NULL;
1072
1073#ifdef CONFIG_NUMA
1074 if (crng_node_pool)
1075 crng = crng_node_pool[numa_node_id()];
1076 if (crng == NULL)
1077#endif
1078 crng = &primary_crng;
1079 _extract_crng(crng, out);
1080}
1081
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001082/*
1083 * Use the leftover bytes from the CRNG block output (if there is
1084 * enough) to mutate the CRNG key to provide backtracking protection.
1085 */
1086static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers1ca1b912018-11-16 17:26:21 -08001087 __u8 tmp[CHACHA_BLOCK_SIZE], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001088{
1089 unsigned long flags;
1090 __u32 *s, *d;
1091 int i;
1092
1093 used = round_up(used, sizeof(__u32));
Eric Biggers1ca1b912018-11-16 17:26:21 -08001094 if (used + CHACHA_KEY_SIZE > CHACHA_BLOCK_SIZE) {
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001095 extract_crng(tmp);
1096 used = 0;
1097 }
1098 spin_lock_irqsave(&crng->lock, flags);
Eric Biggersa5e9f552018-09-11 20:05:10 -07001099 s = (__u32 *) &tmp[used];
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001100 d = &crng->state[4];
1101 for (i=0; i < 8; i++)
1102 *d++ ^= *s++;
1103 spin_unlock_irqrestore(&crng->lock, flags);
1104}
1105
Eric Biggers1ca1b912018-11-16 17:26:21 -08001106static void crng_backtrack_protect(__u8 tmp[CHACHA_BLOCK_SIZE], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001107{
1108 struct crng_state *crng = NULL;
1109
1110#ifdef CONFIG_NUMA
1111 if (crng_node_pool)
1112 crng = crng_node_pool[numa_node_id()];
1113 if (crng == NULL)
1114#endif
1115 crng = &primary_crng;
1116 _crng_backtrack_protect(crng, tmp, used);
1117}
1118
Theodore Ts'oe192be92016-06-12 18:13:36 -04001119static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
1120{
Eric Biggers1ca1b912018-11-16 17:26:21 -08001121 ssize_t ret = 0, i = CHACHA_BLOCK_SIZE;
1122 __u8 tmp[CHACHA_BLOCK_SIZE] __aligned(4);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001123 int large_request = (nbytes > 256);
1124
1125 while (nbytes) {
1126 if (large_request && need_resched()) {
1127 if (signal_pending(current)) {
1128 if (ret == 0)
1129 ret = -ERESTARTSYS;
1130 break;
1131 }
1132 schedule();
1133 }
1134
1135 extract_crng(tmp);
Eric Biggers1ca1b912018-11-16 17:26:21 -08001136 i = min_t(int, nbytes, CHACHA_BLOCK_SIZE);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001137 if (copy_to_user(buf, tmp, i)) {
1138 ret = -EFAULT;
1139 break;
1140 }
1141
1142 nbytes -= i;
1143 buf += i;
1144 ret += i;
1145 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001146 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001147
1148 /* Wipe data just written to memory */
1149 memzero_explicit(tmp, sizeof(tmp));
1150
1151 return ret;
1152}
1153
1154
1155/*********************************************************************
1156 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 * Entropy input management
1158 *
1159 *********************************************************************/
1160
1161/* There is one of these per entropy source */
1162struct timer_rand_state {
1163 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001164 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165};
1166
Theodore Ts'o644008d2013-11-03 16:40:53 -05001167#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
1168
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001169/*
Theodore Ts'oe192be92016-06-12 18:13:36 -04001170 * Add device- or boot-specific data to the input pool to help
1171 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001172 *
Theodore Ts'oe192be92016-06-12 18:13:36 -04001173 * None of this adds any entropy; it is meant to avoid the problem of
1174 * the entropy pool having similar initial state across largely
1175 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001176 */
1177void add_device_randomness(const void *buf, unsigned int size)
1178{
Theodore Ts'o61875f32013-09-21 13:58:22 -04001179 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001180 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001181
Theodore Ts'odc12baa2018-04-11 14:58:27 -04001182 if (!crng_ready() && size)
1183 crng_slow_load(buf, size);
Kees Cookee7998c2017-07-12 14:34:04 -07001184
Theodore Ts'o59108952013-09-12 14:10:25 -04001185 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001186 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001187 _mix_pool_bytes(&input_pool, buf, size);
1188 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001189 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001190}
1191EXPORT_SYMBOL(add_device_randomness);
1192
Theodore Ts'o644008d2013-11-03 16:40:53 -05001193static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001194
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195/*
1196 * This function adds entropy to the entropy "pool" by using timing
1197 * delays. It uses the timer_rand_state structure to make an estimate
1198 * of how many bits of entropy this call has added to the pool.
1199 *
1200 * The number "num" is also added to the pool - it should somehow describe
1201 * the type of event which just happened. This is currently 0-255 for
1202 * keyboard scan codes, and 256 upwards for interrupts.
1203 *
1204 */
1205static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1206{
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001207 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -08001210 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 unsigned num;
1212 } sample;
1213 long delta, delta2, delta3;
1214
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001216 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 sample.num = num;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001218 r = &input_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001219 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
1221 /*
1222 * Calculate number of bits of randomness we probably added.
1223 * We take into account the first, second and third-order deltas
1224 * in order to make our estimate.
1225 */
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001226 delta = sample.jiffies - state->last_time;
1227 state->last_time = sample.jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001229 delta2 = delta - state->last_delta;
1230 state->last_delta = delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001232 delta3 = delta2 - state->last_delta2;
1233 state->last_delta2 = delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001235 if (delta < 0)
1236 delta = -delta;
1237 if (delta2 < 0)
1238 delta2 = -delta2;
1239 if (delta3 < 0)
1240 delta3 = -delta3;
1241 if (delta > delta2)
1242 delta = delta2;
1243 if (delta > delta3)
1244 delta = delta3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001246 /*
1247 * delta is now minimum absolute delta.
1248 * Round down by 1 bit on general principles,
1249 * and limit entropy entimate to 12 bits.
1250 */
1251 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252}
1253
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001254void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 unsigned int value)
1256{
1257 static unsigned char last_value;
1258
1259 /* ignore autorepeat and the like */
1260 if (value == last_value)
1261 return;
1262
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 last_value = value;
1264 add_timer_randomness(&input_timer_state,
1265 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001266 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001268EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001270static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1271
Theodore Ts'o43759d42014-06-14 21:43:13 -04001272#ifdef ADD_INTERRUPT_BENCH
1273static unsigned long avg_cycles, avg_deviation;
1274
1275#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1276#define FIXED_1_2 (1 << (AVG_SHIFT-1))
1277
1278static void add_interrupt_bench(cycles_t start)
1279{
1280 long delta = random_get_entropy() - start;
1281
1282 /* Use a weighted moving average */
1283 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1284 avg_cycles += delta;
1285 /* And average deviation */
1286 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1287 avg_deviation += delta;
1288}
1289#else
1290#define add_interrupt_bench(x)
1291#endif
1292
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001293static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
1294{
1295 __u32 *ptr = (__u32 *) regs;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001296 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001297
1298 if (regs == NULL)
1299 return 0;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001300 idx = READ_ONCE(f->reg_idx);
1301 if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
1302 idx = 0;
1303 ptr += idx++;
1304 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitz9dfa7bb2017-04-30 19:49:21 +12001305 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001306}
1307
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001308void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309{
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001310 struct entropy_store *r;
Christoph Lameter1b2a1a72014-08-17 12:30:29 -05001311 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001312 struct pt_regs *regs = get_irq_regs();
1313 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001314 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -04001315 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001316 __u64 ip;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001317 unsigned long seed;
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001318 int credit = 0;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001319
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001320 if (cycles == 0)
1321 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001322 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1323 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001324 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1325 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001326 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001327 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001328 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
1329 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001330
Theodore Ts'o43759d42014-06-14 21:43:13 -04001331 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001332 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001333
Theodore Ts'o43838a22018-04-11 13:27:52 -04001334 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001335 if ((fast_pool->count >= 64) &&
1336 crng_fast_load((char *) fast_pool->pool,
1337 sizeof(fast_pool->pool))) {
1338 fast_pool->count = 0;
1339 fast_pool->last = now;
1340 }
1341 return;
1342 }
1343
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001344 if ((fast_pool->count < 64) &&
1345 !time_after(now, fast_pool->last + HZ))
1346 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347
Theodore Ts'oe192be92016-06-12 18:13:36 -04001348 r = &input_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001349 if (!spin_trylock(&r->lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 return;
1351
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001352 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001353 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
H. Peter Anvin83664a62014-03-17 16:36:28 -07001354
1355 /*
1356 * If we have architectural seed generator, produce a seed and
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001357 * add it to the pool. For the sake of paranoia don't let the
1358 * architectural seed generator dominate the input from the
1359 * interrupt noise.
H. Peter Anvin83664a62014-03-17 16:36:28 -07001360 */
1361 if (arch_get_random_seed_long(&seed)) {
Theodore Ts'o85608f82014-06-10 23:09:20 -04001362 __mix_pool_bytes(r, &seed, sizeof(seed));
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001363 credit = 1;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001364 }
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001365 spin_unlock(&r->lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001366
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001367 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001368
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001369 /* award one bit for the contents of the fast pool */
1370 credit_entropy_bits(r, credit + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001372EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
David Howells93614012006-09-30 20:45:40 +02001374#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375void add_disk_randomness(struct gendisk *disk)
1376{
1377 if (!disk || !disk->random)
1378 return;
1379 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001380 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001381 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001383EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001384#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386/*********************************************************************
1387 *
1388 * Entropy extraction routines
1389 *
1390 *********************************************************************/
1391
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001393 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 * from the primary pool to the secondary extraction pool. We make
1395 * sure we pull enough for a 'catastrophic reseed'.
1396 */
Theodore Ts'o6265e162013-10-03 01:08:15 -04001397static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1399{
Theodore Ts'ocff85032014-06-10 23:18:16 -04001400 if (!r->pull ||
1401 r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
1402 r->entropy_count > r->poolinfo->poolfracbits)
1403 return;
1404
Theodore Ts'ocff85032014-06-10 23:18:16 -04001405 _xfer_secondary_pool(r, nbytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001406}
Matt Mackall5a021e92007-07-19 11:30:14 -07001407
Theodore Ts'o6265e162013-10-03 01:08:15 -04001408static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1409{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 __u32 tmp[OUTPUT_POOL_WORDS];
1411
Theodore Ts'o6265e162013-10-03 01:08:15 -04001412 int bytes = nbytes;
Matt Mackall5a021e92007-07-19 11:30:14 -07001413
Greg Price2132a962013-12-06 21:28:03 -05001414 /* pull at least as much as a wakeup */
1415 bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001416 /* but never more than the buffer size */
1417 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001419 trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
1420 ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
Theodore Ts'o6265e162013-10-03 01:08:15 -04001421 bytes = extract_entropy(r->pull, tmp, bytes,
Stephan Müller43d8a722016-12-27 23:40:59 +01001422 random_read_wakeup_bits / 8, 0);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001423 mix_pool_bytes(r, tmp, bytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001424 credit_entropy_bits(r, bytes*8);
1425}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
Theodore Ts'o6265e162013-10-03 01:08:15 -04001427/*
1428 * Used as a workqueue function so that when the input pool is getting
1429 * full, we can "spill over" some entropy to the output pools. That
1430 * way the output pools can store some of the excess entropy instead
1431 * of letting it go to waste.
1432 */
1433static void push_to_pool(struct work_struct *work)
1434{
1435 struct entropy_store *r = container_of(work, struct entropy_store,
1436 push_work);
1437 BUG_ON(!r);
Greg Price2132a962013-12-06 21:28:03 -05001438 _xfer_secondary_pool(r, random_read_wakeup_bits/8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001439 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
1440 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441}
1442
1443/*
Greg Price19fa5be12013-11-29 15:50:06 -05001444 * This function decides how many bytes to actually take from the
1445 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447static size_t account(struct entropy_store *r, size_t nbytes, int min,
1448 int reserved)
1449{
Stephan Müller43d8a722016-12-27 23:40:59 +01001450 int entropy_count, orig, have_bytes;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001451 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001453 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454
1455 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001456retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -07001457 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001458 ibytes = nbytes;
Stephan Müller43d8a722016-12-27 23:40:59 +01001459 /* never pull more than available */
1460 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001461
Stephan Müller43d8a722016-12-27 23:40:59 +01001462 if ((have_bytes -= reserved) < 0)
1463 have_bytes = 0;
1464 ibytes = min_t(size_t, ibytes, have_bytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001465 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001466 ibytes = 0;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001467
1468 if (unlikely(entropy_count < 0)) {
1469 pr_warn("random: negative entropy count: pool %s count %d\n",
1470 r->name, entropy_count);
1471 WARN_ON(1);
1472 entropy_count = 0;
1473 }
1474 nfrac = ibytes << (ENTROPY_SHIFT + 3);
1475 if ((size_t) entropy_count > nfrac)
1476 entropy_count -= nfrac;
1477 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001478 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001479
Greg Price0fb7a012013-12-05 19:32:19 -05001480 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1481 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001483 trace_debit_entropy(r->name, 8 * ibytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001484 if (ibytes &&
Greg Price2132a962013-12-06 21:28:03 -05001485 (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001486 wake_up_interruptible(&random_write_wait);
Theodore Ts'ob9809552013-03-04 11:59:12 -05001487 kill_fasync(&fasync, SIGIO, POLL_OUT);
1488 }
1489
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001490 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491}
1492
Greg Price19fa5be12013-11-29 15:50:06 -05001493/*
1494 * This function does the actual extraction for extract_entropy and
1495 * extract_entropy_user.
1496 *
1497 * Note: we assume that .poolwords is a multiple of 16 words.
1498 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499static void extract_buf(struct entropy_store *r, __u8 *out)
1500{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001501 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001502 union {
1503 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001504 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001505 } hash;
1506 __u32 workspace[SHA_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001507 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001510 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001511 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001512 */
Theodore Ts'o46884442013-12-17 21:16:39 -05001513 sha_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001514 for (i = 0; i < LONGS(20); i++) {
1515 unsigned long v;
1516 if (!arch_get_random_long(&v))
1517 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001518 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001519 }
1520
Theodore Ts'o46884442013-12-17 21:16:39 -05001521 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1522 spin_lock_irqsave(&r->lock, flags);
1523 for (i = 0; i < r->poolinfo->poolwords; i += 16)
1524 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1525
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001526 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001527 * We mix the hash back into the pool to prevent backtracking
1528 * attacks (where the attacker knows the state of the pool
1529 * plus the current outputs, and attempts to find previous
1530 * ouputs), unless the hash function can be inverted. By
1531 * mixing at least a SHA1 worth of hash data back, we make
1532 * brute-forcing the feedback as hard as brute-forcing the
1533 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001535 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001536 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001537
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001538 memzero_explicit(workspace, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
1540 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001541 * In case the hash function has some recognizable output
1542 * pattern, we fold it in half. Thus, we always feed back
1543 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001545 hash.w[0] ^= hash.w[3];
1546 hash.w[1] ^= hash.w[4];
1547 hash.w[2] ^= rol32(hash.w[2], 16);
1548
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001549 memcpy(out, &hash, EXTRACT_SIZE);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001550 memzero_explicit(&hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551}
1552
Theodore Ts'oe192be92016-06-12 18:13:36 -04001553static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
1554 size_t nbytes, int fips)
1555{
1556 ssize_t ret = 0, i;
1557 __u8 tmp[EXTRACT_SIZE];
1558 unsigned long flags;
1559
1560 while (nbytes) {
1561 extract_buf(r, tmp);
1562
1563 if (fips) {
1564 spin_lock_irqsave(&r->lock, flags);
1565 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1566 panic("Hardware RNG duplicated output!\n");
1567 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1568 spin_unlock_irqrestore(&r->lock, flags);
1569 }
1570 i = min_t(int, nbytes, EXTRACT_SIZE);
1571 memcpy(buf, tmp, i);
1572 nbytes -= i;
1573 buf += i;
1574 ret += i;
1575 }
1576
1577 /* Wipe data just returned from memory */
1578 memzero_explicit(tmp, sizeof(tmp));
1579
1580 return ret;
1581}
1582
Greg Price19fa5be12013-11-29 15:50:06 -05001583/*
1584 * This function extracts randomness from the "entropy pool", and
1585 * returns it in a buffer.
1586 *
1587 * The min parameter specifies the minimum amount we can pull before
1588 * failing to avoid races that defeat catastrophic reseeding while the
1589 * reserved parameter indicates how much entropy we must leave in the
1590 * pool after each pull to avoid starving other readers.
1591 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001592static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001593 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001596 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001598 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001599 if (fips_enabled) {
1600 spin_lock_irqsave(&r->lock, flags);
1601 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001602 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001603 spin_unlock_irqrestore(&r->lock, flags);
1604 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001605 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001606 xfer_secondary_pool(r, EXTRACT_SIZE);
1607 extract_buf(r, tmp);
1608 spin_lock_irqsave(&r->lock, flags);
1609 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1610 }
1611 spin_unlock_irqrestore(&r->lock, flags);
1612 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001613
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001614 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 xfer_secondary_pool(r, nbytes);
1616 nbytes = account(r, nbytes, min, reserved);
1617
Theodore Ts'oe192be92016-06-12 18:13:36 -04001618 return _extract_entropy(r, buf, nbytes, fips_enabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619}
1620
Greg Price19fa5be12013-11-29 15:50:06 -05001621/*
1622 * This function extracts randomness from the "entropy pool", and
1623 * returns it in a userspace buffer.
1624 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1626 size_t nbytes)
1627{
1628 ssize_t ret = 0, i;
1629 __u8 tmp[EXTRACT_SIZE];
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001630 int large_request = (nbytes > 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001632 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -05001633 if (!r->initialized && r->pull) {
1634 xfer_secondary_pool(r, ENTROPY_BITS(r->pull)/8);
1635 if (!r->initialized)
1636 return 0;
1637 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 xfer_secondary_pool(r, nbytes);
1639 nbytes = account(r, nbytes, 0, 0);
1640
1641 while (nbytes) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001642 if (large_request && need_resched()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 if (signal_pending(current)) {
1644 if (ret == 0)
1645 ret = -ERESTARTSYS;
1646 break;
1647 }
1648 schedule();
1649 }
1650
1651 extract_buf(r, tmp);
1652 i = min_t(int, nbytes, EXTRACT_SIZE);
1653 if (copy_to_user(buf, tmp, i)) {
1654 ret = -EFAULT;
1655 break;
1656 }
1657
1658 nbytes -= i;
1659 buf += i;
1660 ret += i;
1661 }
1662
1663 /* Wipe data just returned from memory */
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001664 memzero_explicit(tmp, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
1666 return ret;
1667}
1668
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001669#define warn_unseeded_randomness(previous) \
1670 _warn_unseeded_randomness(__func__, (void *) _RET_IP_, (previous))
1671
1672static void _warn_unseeded_randomness(const char *func_name, void *caller,
1673 void **previous)
1674{
1675#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1676 const bool print_once = false;
1677#else
1678 static bool print_once __read_mostly;
1679#endif
1680
1681 if (print_once ||
1682 crng_ready() ||
1683 (previous && (caller == READ_ONCE(*previous))))
1684 return;
1685 WRITE_ONCE(*previous, caller);
1686#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1687 print_once = true;
1688#endif
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001689 if (__ratelimit(&unseeded_warning))
1690 pr_notice("random: %s called from %pS with crng_init=%d\n",
1691 func_name, caller, crng_init);
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001692}
1693
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694/*
1695 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001696 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001697 * TCP sequence numbers, etc. It does not rely on the hardware random
1698 * number generator. For random bytes direct from the hardware RNG
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001699 * (when available), use get_random_bytes_arch(). In order to ensure
1700 * that the randomness provided by this function is okay, the function
1701 * wait_for_random_bytes() should be called and return 0 at least once
1702 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 */
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001704static void _get_random_bytes(void *buf, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705{
Eric Biggers1ca1b912018-11-16 17:26:21 -08001706 __u8 tmp[CHACHA_BLOCK_SIZE] __aligned(4);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001707
Theodore Ts'o59108952013-09-12 14:10:25 -04001708 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001709
Eric Biggers1ca1b912018-11-16 17:26:21 -08001710 while (nbytes >= CHACHA_BLOCK_SIZE) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001711 extract_crng(buf);
Eric Biggers1ca1b912018-11-16 17:26:21 -08001712 buf += CHACHA_BLOCK_SIZE;
1713 nbytes -= CHACHA_BLOCK_SIZE;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001714 }
1715
1716 if (nbytes > 0) {
1717 extract_crng(tmp);
1718 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001719 crng_backtrack_protect(tmp, nbytes);
1720 } else
Eric Biggers1ca1b912018-11-16 17:26:21 -08001721 crng_backtrack_protect(tmp, CHACHA_BLOCK_SIZE);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001722 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001723}
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001724
1725void get_random_bytes(void *buf, int nbytes)
1726{
1727 static void *previous;
1728
1729 warn_unseeded_randomness(&previous);
1730 _get_random_bytes(buf, nbytes);
1731}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001732EXPORT_SYMBOL(get_random_bytes);
1733
Linus Torvalds50ee7522019-09-28 16:53:52 -07001734
1735/*
1736 * Each time the timer fires, we expect that we got an unpredictable
1737 * jump in the cycle counter. Even if the timer is running on another
1738 * CPU, the timer activity will be touching the stack of the CPU that is
1739 * generating entropy..
1740 *
1741 * Note that we don't re-arm the timer in the timer itself - we are
1742 * happy to be scheduled away, since that just makes the load more
1743 * complex, but we do not want the timer to keep ticking unless the
1744 * entropy loop is running.
1745 *
1746 * So the re-arming always happens in the entropy loop itself.
1747 */
1748static void entropy_timer(struct timer_list *t)
1749{
1750 credit_entropy_bits(&input_pool, 1);
1751}
1752
1753/*
1754 * If we have an actual cycle counter, see if we can
1755 * generate enough entropy with timing noise
1756 */
1757static void try_to_generate_entropy(void)
1758{
1759 struct {
1760 unsigned long now;
1761 struct timer_list timer;
1762 } stack;
1763
1764 stack.now = random_get_entropy();
1765
1766 /* Slow counter - or none. Don't even bother */
1767 if (stack.now == random_get_entropy())
1768 return;
1769
1770 timer_setup_on_stack(&stack.timer, entropy_timer, 0);
1771 while (!crng_ready()) {
1772 if (!timer_pending(&stack.timer))
1773 mod_timer(&stack.timer, jiffies+1);
1774 mix_pool_bytes(&input_pool, &stack.now, sizeof(stack.now));
1775 schedule();
1776 stack.now = random_get_entropy();
1777 }
1778
1779 del_timer_sync(&stack.timer);
1780 destroy_timer_on_stack(&stack.timer);
1781 mix_pool_bytes(&input_pool, &stack.now, sizeof(stack.now));
1782}
1783
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001784/*
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001785 * Wait for the urandom pool to be seeded and thus guaranteed to supply
1786 * cryptographically secure random numbers. This applies to: the /dev/urandom
1787 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
1788 * family of functions. Using any of these functions without first calling
1789 * this function forfeits the guarantee of security.
1790 *
1791 * Returns: 0 if the urandom pool has been seeded.
1792 * -ERESTARTSYS if the function was interrupted by a signal.
1793 */
1794int wait_for_random_bytes(void)
1795{
1796 if (likely(crng_ready()))
1797 return 0;
Linus Torvalds50ee7522019-09-28 16:53:52 -07001798
1799 do {
1800 int ret;
1801 ret = wait_event_interruptible_timeout(crng_init_wait, crng_ready(), HZ);
1802 if (ret)
1803 return ret > 0 ? 0 : ret;
1804
1805 try_to_generate_entropy();
1806 } while (!crng_ready());
1807
1808 return 0;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001809}
1810EXPORT_SYMBOL(wait_for_random_bytes);
1811
1812/*
Jason A. Donenfeld9a472492018-07-31 21:11:00 +02001813 * Returns whether or not the urandom pool has been seeded and thus guaranteed
1814 * to supply cryptographically secure random numbers. This applies to: the
1815 * /dev/urandom device, the get_random_bytes function, and the get_random_{u32,
1816 * ,u64,int,long} family of functions.
1817 *
1818 * Returns: true if the urandom pool has been seeded.
1819 * false if the urandom pool has not been seeded.
1820 */
1821bool rng_is_initialized(void)
1822{
1823 return crng_ready();
1824}
1825EXPORT_SYMBOL(rng_is_initialized);
1826
1827/*
Herbert Xu205a5252015-06-09 18:19:39 +08001828 * Add a callback function that will be invoked when the nonblocking
1829 * pool is initialised.
1830 *
1831 * returns: 0 if callback is successfully added
1832 * -EALREADY if pool is already initialised (callback not called)
1833 * -ENOENT if module for callback is not alive
1834 */
1835int add_random_ready_callback(struct random_ready_callback *rdy)
1836{
1837 struct module *owner;
1838 unsigned long flags;
1839 int err = -EALREADY;
1840
Theodore Ts'oe192be92016-06-12 18:13:36 -04001841 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001842 return err;
1843
1844 owner = rdy->owner;
1845 if (!try_module_get(owner))
1846 return -ENOENT;
1847
1848 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001849 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001850 goto out;
1851
1852 owner = NULL;
1853
1854 list_add(&rdy->list, &random_ready_list);
1855 err = 0;
1856
1857out:
1858 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1859
1860 module_put(owner);
1861
1862 return err;
1863}
1864EXPORT_SYMBOL(add_random_ready_callback);
1865
1866/*
1867 * Delete a previously registered readiness callback function.
1868 */
1869void del_random_ready_callback(struct random_ready_callback *rdy)
1870{
1871 unsigned long flags;
1872 struct module *owner = NULL;
1873
1874 spin_lock_irqsave(&random_ready_list_lock, flags);
1875 if (!list_empty(&rdy->list)) {
1876 list_del_init(&rdy->list);
1877 owner = rdy->owner;
1878 }
1879 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1880
1881 module_put(owner);
1882}
1883EXPORT_SYMBOL(del_random_ready_callback);
1884
1885/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001886 * This function will use the architecture-specific hardware random
1887 * number generator if it is available. The arch-specific hw RNG will
1888 * almost certainly be faster than what we can do in software, but it
1889 * is impossible to verify that it is implemented securely (as
1890 * opposed, to, say, the AES encryption of a sequence number using a
1891 * key known by the NSA). So it's useful if we need the speed, but
1892 * only if we're willing to trust the hardware manufacturer not to
1893 * have put in a back door.
Tobin C. Harding753d4332018-06-22 09:15:32 +10001894 *
1895 * Return number of bytes filled in.
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001896 */
Tobin C. Harding753d4332018-06-22 09:15:32 +10001897int __must_check get_random_bytes_arch(void *buf, int nbytes)
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001898{
Tobin C. Harding753d4332018-06-22 09:15:32 +10001899 int left = nbytes;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001900 char *p = buf;
1901
Tobin C. Harding753d4332018-06-22 09:15:32 +10001902 trace_get_random_bytes_arch(left, _RET_IP_);
1903 while (left) {
H. Peter Anvin63d77172011-07-31 13:54:50 -07001904 unsigned long v;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001905 int chunk = min_t(int, left, sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001906
H. Peter Anvin63d77172011-07-31 13:54:50 -07001907 if (!arch_get_random_long(&v))
1908 break;
Tobin C. Harding8ddd6ef2018-06-22 09:15:31 +10001909
Luck, Tonybd29e562011-11-16 10:50:56 -08001910 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001911 p += chunk;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001912 left -= chunk;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001913 }
1914
Tobin C. Harding753d4332018-06-22 09:15:32 +10001915 return nbytes - left;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001917EXPORT_SYMBOL(get_random_bytes_arch);
1918
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919/*
1920 * init_std_data - initialize pool with system data
1921 *
1922 * @r: pool to initialize
1923 *
1924 * This function clears the pool's entropy count and mixes some system
1925 * data into the pool to prepare it for use. The pool is not cleared
1926 * as that can only decrease the entropy in the pool.
1927 */
Kees Cookd5553522019-04-19 23:27:05 -04001928static void __init init_std_data(struct entropy_store *r)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001930 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001931 ktime_t now = ktime_get_real();
1932 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933
Theodore Ts'of5c27422013-09-22 15:14:32 -04001934 r->last_pulled = jiffies;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001935 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001936 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001937 if (!arch_get_random_seed_long(&rv) &&
1938 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001939 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001940 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001941 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001942 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943}
1944
Tony Luckcbc96b72012-07-23 09:47:57 -07001945/*
1946 * Note that setup_arch() may call add_device_randomness()
1947 * long before we get here. This allows seeding of the pools
1948 * with some platform dependent data very early in the boot
1949 * process. But it limits our options here. We must use
1950 * statically allocated structures that already have all
1951 * initializations complete at compile time. We should also
1952 * take care not to overwrite the precious per platform data
1953 * we were given.
1954 */
Kees Cookd5553522019-04-19 23:27:05 -04001955int __init rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956{
1957 init_std_data(&input_pool);
1958 init_std_data(&blocking_pool);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001959 crng_initialize(&primary_crng);
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001960 crng_global_init_time = jiffies;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001961 if (ratelimit_disable) {
1962 urandom_warning.interval = 0;
1963 unseeded_warning.interval = 0;
1964 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 return 0;
1966}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967
David Howells93614012006-09-30 20:45:40 +02001968#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969void rand_initialize_disk(struct gendisk *disk)
1970{
1971 struct timer_rand_state *state;
1972
1973 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001974 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 * source.
1976 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001977 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001978 if (state) {
1979 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001981 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982}
David Howells93614012006-09-30 20:45:40 +02001983#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
1985static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001986_random_read(int nonblock, char __user *buf, size_t nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987{
Greg Price12ff3a52013-11-29 15:02:33 -05001988 ssize_t n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989
1990 if (nbytes == 0)
1991 return 0;
1992
Greg Price12ff3a52013-11-29 15:02:33 -05001993 nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1994 while (1) {
1995 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1996 if (n < 0)
1997 return n;
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001998 trace_random_read(n*8, (nbytes-n)*8,
1999 ENTROPY_BITS(&blocking_pool),
2000 ENTROPY_BITS(&input_pool));
Greg Price12ff3a52013-11-29 15:02:33 -05002001 if (n > 0)
2002 return n;
H. Peter Anvin331c6492014-03-17 16:36:29 -07002003
Greg Price12ff3a52013-11-29 15:02:33 -05002004 /* Pool is (near) empty. Maybe wait and retry. */
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002005 if (nonblock)
Greg Price12ff3a52013-11-29 15:02:33 -05002006 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07002008 wait_event_interruptible(random_read_wait,
Theodore Ts'o58be0102019-05-22 12:02:16 -04002009 blocking_pool.initialized &&
2010 (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits));
Greg Price12ff3a52013-11-29 15:02:33 -05002011 if (signal_pending(current))
2012 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014}
2015
2016static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002017random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
2018{
2019 return _random_read(file->f_flags & O_NONBLOCK, buf, nbytes);
2020}
2021
2022static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07002023urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024{
Theodore Ts'oe192be92016-06-12 18:13:36 -04002025 unsigned long flags;
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04002026 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05002027 int ret;
2028
Theodore Ts'oe192be92016-06-12 18:13:36 -04002029 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04002030 maxwarn--;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04002031 if (__ratelimit(&urandom_warning))
2032 printk(KERN_NOTICE "random: %s: uninitialized "
2033 "urandom read (%zd bytes read)\n",
2034 current->comm, nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -04002035 spin_lock_irqsave(&primary_crng.lock, flags);
2036 crng_init_cnt = 0;
2037 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04002038 }
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04002039 nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
Theodore Ts'oe192be92016-06-12 18:13:36 -04002040 ret = extract_crng_user(buf, nbytes);
2041 trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04002042 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043}
2044
Christoph Hellwig89b310a2018-04-09 15:29:32 +02002045static __poll_t
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07002046random_poll(struct file *file, poll_table * wait)
Christoph Hellwig89b310a2018-04-09 15:29:32 +02002047{
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07002048 __poll_t mask;
Christoph Hellwig89b310a2018-04-09 15:29:32 +02002049
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07002050 poll_wait(file, &random_read_wait, wait);
2051 poll_wait(file, &random_write_wait, wait);
2052 mask = 0;
Greg Price2132a962013-12-06 21:28:03 -05002053 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002054 mask |= EPOLLIN | EPOLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05002055 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002056 mask |= EPOLLOUT | EPOLLWRNORM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 return mask;
2058}
2059
Matt Mackall7f397dc2007-05-29 21:58:10 -05002060static int
2061write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
2062{
2063 size_t bytes;
Theodore Ts'o81e69df2018-07-14 23:55:57 -04002064 __u32 t, buf[16];
Matt Mackall7f397dc2007-05-29 21:58:10 -05002065 const char __user *p = buffer;
2066
2067 while (count > 0) {
Theodore Ts'o81e69df2018-07-14 23:55:57 -04002068 int b, i = 0;
2069
Matt Mackall7f397dc2007-05-29 21:58:10 -05002070 bytes = min(count, sizeof(buf));
2071 if (copy_from_user(&buf, p, bytes))
2072 return -EFAULT;
2073
Theodore Ts'o81e69df2018-07-14 23:55:57 -04002074 for (b = bytes ; b > 0 ; b -= sizeof(__u32), i++) {
2075 if (!arch_get_random_int(&t))
2076 break;
2077 buf[i] ^= t;
2078 }
2079
Matt Mackall7f397dc2007-05-29 21:58:10 -05002080 count -= bytes;
2081 p += bytes;
2082
Theodore Ts'o85608f82014-06-10 23:09:20 -04002083 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08002084 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05002085 }
2086
2087 return 0;
2088}
2089
Matt Mackall90b75ee2008-04-29 01:02:55 -07002090static ssize_t random_write(struct file *file, const char __user *buffer,
2091 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092{
Matt Mackall7f397dc2007-05-29 21:58:10 -05002093 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094
Theodore Ts'oe192be92016-06-12 18:13:36 -04002095 ret = write_pool(&input_pool, buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05002096 if (ret)
2097 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098
Matt Mackall7f397dc2007-05-29 21:58:10 -05002099 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100}
2101
Matt Mackall43ae4862008-04-29 01:02:58 -07002102static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103{
2104 int size, ent_count;
2105 int __user *p = (int __user *)arg;
2106 int retval;
2107
2108 switch (cmd) {
2109 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07002110 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002111 ent_count = ENTROPY_BITS(&input_pool);
2112 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 return -EFAULT;
2114 return 0;
2115 case RNDADDTOENTCNT:
2116 if (!capable(CAP_SYS_ADMIN))
2117 return -EPERM;
2118 if (get_user(ent_count, p))
2119 return -EFAULT;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04002120 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 case RNDADDENTROPY:
2122 if (!capable(CAP_SYS_ADMIN))
2123 return -EPERM;
2124 if (get_user(ent_count, p++))
2125 return -EFAULT;
2126 if (ent_count < 0)
2127 return -EINVAL;
2128 if (get_user(size, p++))
2129 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05002130 retval = write_pool(&input_pool, (const char __user *)p,
2131 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 if (retval < 0)
2133 return retval;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04002134 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 case RNDZAPENTCNT:
2136 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05002137 /*
2138 * Clear the entropy pool counters. We no longer clear
2139 * the entropy pool, as that's silly.
2140 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 if (!capable(CAP_SYS_ADMIN))
2142 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05002143 input_pool.entropy_count = 0;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05002144 blocking_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 return 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -04002146 case RNDRESEEDCRNG:
2147 if (!capable(CAP_SYS_ADMIN))
2148 return -EPERM;
2149 if (crng_init < 2)
2150 return -ENODATA;
2151 crng_reseed(&primary_crng, NULL);
2152 crng_global_init_time = jiffies - 1;
2153 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 default:
2155 return -EINVAL;
2156 }
2157}
2158
Jeff Dike9a6f70b2008-04-29 01:03:08 -07002159static int random_fasync(int fd, struct file *filp, int on)
2160{
2161 return fasync_helper(fd, filp, on, &fasync);
2162}
2163
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08002164const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 .read = random_read,
2166 .write = random_write,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07002167 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07002168 .unlocked_ioctl = random_ioctl,
Arnd Bergmann507e4e22018-09-07 11:10:23 +02002169 .compat_ioctl = compat_ptr_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07002170 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002171 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172};
2173
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08002174const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 .read = urandom_read,
2176 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07002177 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07002178 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002179 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180};
2181
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002182SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
2183 unsigned int, flags)
2184{
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002185 int ret;
2186
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002187 if (flags & ~(GRND_NONBLOCK|GRND_RANDOM))
2188 return -EINVAL;
2189
2190 if (count > INT_MAX)
2191 count = INT_MAX;
2192
2193 if (flags & GRND_RANDOM)
2194 return _random_read(flags & GRND_NONBLOCK, buf, count);
2195
Theodore Ts'oe192be92016-06-12 18:13:36 -04002196 if (!crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002197 if (flags & GRND_NONBLOCK)
2198 return -EAGAIN;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002199 ret = wait_for_random_bytes();
2200 if (unlikely(ret))
2201 return ret;
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002202 }
2203 return urandom_read(NULL, buf, count, NULL);
2204}
2205
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206/********************************************************************
2207 *
2208 * Sysctl interface
2209 *
2210 ********************************************************************/
2211
2212#ifdef CONFIG_SYSCTL
2213
2214#include <linux/sysctl.h>
2215
2216static int min_read_thresh = 8, min_write_thresh;
Greg Price8c2aa332013-12-05 19:19:29 -05002217static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218static int max_write_thresh = INPUT_POOL_WORDS * 32;
Fabio Estevamdb61ffe2017-01-31 14:36:07 -02002219static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220static char sysctl_bootid[16];
2221
2222/*
Greg Pricef22052b2013-11-29 14:58:16 -05002223 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 * UUID. The difference is in whether table->data is NULL; if it is,
2225 * then a new UUID is generated and returned to the user.
2226 *
Greg Pricef22052b2013-11-29 14:58:16 -05002227 * If the user accesses this via the proc interface, the UUID will be
2228 * returned as an ASCII string in the standard UUID format; if via the
2229 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 */
Joe Perchesa1514272013-06-13 19:37:35 -07002231static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 void __user *buffer, size_t *lenp, loff_t *ppos)
2233{
Joe Perchesa1514272013-06-13 19:37:35 -07002234 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 unsigned char buf[64], tmp_uuid[16], *uuid;
2236
2237 uuid = table->data;
2238 if (!uuid) {
2239 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07002241 } else {
2242 static DEFINE_SPINLOCK(bootid_spinlock);
2243
2244 spin_lock(&bootid_spinlock);
2245 if (!uuid[8])
2246 generate_random_uuid(uuid);
2247 spin_unlock(&bootid_spinlock);
2248 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249
Joe Perches35900772009-12-14 18:01:11 -08002250 sprintf(buf, "%pU", uuid);
2251
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 fake_table.data = buf;
2253 fake_table.maxlen = sizeof(buf);
2254
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002255 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256}
2257
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002258/*
2259 * Return entropy available scaled to integral bits
2260 */
Joe Perches5eb10d92014-06-06 14:37:58 -07002261static int proc_do_entropy(struct ctl_table *table, int write,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002262 void __user *buffer, size_t *lenp, loff_t *ppos)
2263{
Joe Perches5eb10d92014-06-06 14:37:58 -07002264 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002265 int entropy_count;
2266
2267 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
2268
2269 fake_table.data = &entropy_count;
2270 fake_table.maxlen = sizeof(entropy_count);
2271
2272 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
2273}
2274
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07002276extern struct ctl_table random_table[];
2277struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 .procname = "poolsize",
2280 .data = &sysctl_poolsize,
2281 .maxlen = sizeof(int),
2282 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002283 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 },
2285 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 .procname = "entropy_avail",
2287 .maxlen = sizeof(int),
2288 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002289 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290 .data = &input_pool.entropy_count,
2291 },
2292 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 .procname = "read_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002294 .data = &random_read_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 .maxlen = sizeof(int),
2296 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002297 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 .extra1 = &min_read_thresh,
2299 .extra2 = &max_read_thresh,
2300 },
2301 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002303 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 .maxlen = sizeof(int),
2305 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002306 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 .extra1 = &min_write_thresh,
2308 .extra2 = &max_write_thresh,
2309 },
2310 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002311 .procname = "urandom_min_reseed_secs",
2312 .data = &random_min_urandom_seed,
2313 .maxlen = sizeof(int),
2314 .mode = 0644,
2315 .proc_handler = proc_dointvec,
2316 },
2317 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 .procname = "boot_id",
2319 .data = &sysctl_bootid,
2320 .maxlen = 16,
2321 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002322 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 },
2324 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 .procname = "uuid",
2326 .maxlen = 16,
2327 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002328 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002330#ifdef ADD_INTERRUPT_BENCH
2331 {
2332 .procname = "add_interrupt_avg_cycles",
2333 .data = &avg_cycles,
2334 .maxlen = sizeof(avg_cycles),
2335 .mode = 0444,
2336 .proc_handler = proc_doulongvec_minmax,
2337 },
2338 {
2339 .procname = "add_interrupt_avg_deviation",
2340 .data = &avg_deviation,
2341 .maxlen = sizeof(avg_deviation),
2342 .mode = 0444,
2343 .proc_handler = proc_doulongvec_minmax,
2344 },
2345#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002346 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347};
2348#endif /* CONFIG_SYSCTL */
2349
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002350struct batched_entropy {
2351 union {
Eric Biggers1ca1b912018-11-16 17:26:21 -08002352 u64 entropy_u64[CHACHA_BLOCK_SIZE / sizeof(u64)];
2353 u32 entropy_u32[CHACHA_BLOCK_SIZE / sizeof(u32)];
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002354 };
2355 unsigned int position;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002356 spinlock_t batch_lock;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002357};
Eric Biggersb1132de2016-05-04 21:08:39 -04002358
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359/*
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002360 * Get a random word for internal kernel use only. The quality of the random
2361 * number is either as good as RDRAND or as good as /dev/urandom, with the
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002362 * goal of being quite fast and not depleting entropy. In order to ensure
2363 * that the randomness provided by this function is okay, the function
2364 * wait_for_random_bytes() should be called and return 0 at least once
2365 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 */
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002367static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64) = {
2368 .batch_lock = __SPIN_LOCK_UNLOCKED(batched_entropy_u64.lock),
2369};
2370
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002371u64 get_random_u64(void)
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002372{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002373 u64 ret;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002374 unsigned long flags;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002375 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002376 static void *previous;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002377
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002378#if BITS_PER_LONG == 64
2379 if (arch_get_random_long((unsigned long *)&ret))
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002380 return ret;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002381#else
2382 if (arch_get_random_long((unsigned long *)&ret) &&
2383 arch_get_random_long((unsigned long *)&ret + 1))
2384 return ret;
2385#endif
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002386
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002387 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002388
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002389 batch = raw_cpu_ptr(&batched_entropy_u64);
2390 spin_lock_irqsave(&batch->batch_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002391 if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
Eric Biggersa5e9f552018-09-11 20:05:10 -07002392 extract_crng((u8 *)batch->entropy_u64);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002393 batch->position = 0;
2394 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002395 ret = batch->entropy_u64[batch->position++];
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002396 spin_unlock_irqrestore(&batch->batch_lock, flags);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002397 return ret;
2398}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002399EXPORT_SYMBOL(get_random_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002400
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002401static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32) = {
2402 .batch_lock = __SPIN_LOCK_UNLOCKED(batched_entropy_u32.lock),
2403};
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002404u32 get_random_u32(void)
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002405{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002406 u32 ret;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002407 unsigned long flags;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002408 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002409 static void *previous;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002410
2411 if (arch_get_random_int(&ret))
2412 return ret;
2413
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002414 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002415
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002416 batch = raw_cpu_ptr(&batched_entropy_u32);
2417 spin_lock_irqsave(&batch->batch_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002418 if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
Eric Biggersa5e9f552018-09-11 20:05:10 -07002419 extract_crng((u8 *)batch->entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002420 batch->position = 0;
2421 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002422 ret = batch->entropy_u32[batch->position++];
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002423 spin_unlock_irqrestore(&batch->batch_lock, flags);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002424 return ret;
2425}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002426EXPORT_SYMBOL(get_random_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002427
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002428/* It's important to invalidate all potential batched entropy that might
2429 * be stored before the crng is initialized, which we can do lazily by
2430 * simply resetting the counter to zero so that it's re-extracted on the
2431 * next usage. */
2432static void invalidate_batched_entropy(void)
2433{
2434 int cpu;
2435 unsigned long flags;
2436
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002437 for_each_possible_cpu (cpu) {
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002438 struct batched_entropy *batched_entropy;
2439
2440 batched_entropy = per_cpu_ptr(&batched_entropy_u32, cpu);
2441 spin_lock_irqsave(&batched_entropy->batch_lock, flags);
2442 batched_entropy->position = 0;
2443 spin_unlock(&batched_entropy->batch_lock);
2444
2445 batched_entropy = per_cpu_ptr(&batched_entropy_u64, cpu);
2446 spin_lock(&batched_entropy->batch_lock);
2447 batched_entropy->position = 0;
2448 spin_unlock_irqrestore(&batched_entropy->batch_lock, flags);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002449 }
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002450}
2451
Jason Cooper99fdafd2016-10-11 13:53:52 -07002452/**
2453 * randomize_page - Generate a random, page aligned address
2454 * @start: The smallest acceptable address the caller will take.
2455 * @range: The size of the area, starting at @start, within which the
2456 * random address must fall.
2457 *
2458 * If @start + @range would overflow, @range is capped.
2459 *
2460 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2461 * @start was already page aligned. We now align it regardless.
2462 *
2463 * Return: A page aligned address within [start, start + range). On error,
2464 * @start is returned.
2465 */
2466unsigned long
2467randomize_page(unsigned long start, unsigned long range)
2468{
2469 if (!PAGE_ALIGNED(start)) {
2470 range -= PAGE_ALIGN(start) - start;
2471 start = PAGE_ALIGN(start);
2472 }
2473
2474 if (start > ULONG_MAX - range)
2475 range = ULONG_MAX - start;
2476
2477 range >>= PAGE_SHIFT;
2478
2479 if (range == 0)
2480 return start;
2481
2482 return start + (get_random_long() % range << PAGE_SHIFT);
2483}
2484
Torsten Duwec84dbf62014-06-14 23:38:36 -04002485/* Interface for in-kernel drivers of true hardware RNGs.
2486 * Those devices may produce endless random bits and will be throttled
2487 * when our pool is full.
2488 */
2489void add_hwgenerator_randomness(const char *buffer, size_t count,
2490 size_t entropy)
2491{
2492 struct entropy_store *poolp = &input_pool;
2493
Theodore Ts'o43838a22018-04-11 13:27:52 -04002494 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04002495 crng_fast_load(buffer, count);
2496 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002497 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002498
2499 /* Suspend writing if we're above the trickle threshold.
2500 * We'll be woken up again once below random_write_wakeup_thresh,
2501 * or when the calling thread is about to terminate.
2502 */
Herbert Xu08e97ae2019-11-17 08:48:17 +08002503 wait_event_interruptible(random_write_wait, kthread_should_stop() ||
Theodore Ts'oe192be92016-06-12 18:13:36 -04002504 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002505 mix_pool_bytes(poolp, buffer, count);
2506 credit_entropy_bits(poolp, entropy);
2507}
2508EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);
Hsin-Yi Wang428826f2019-08-23 14:24:51 +08002509
2510/* Handle random seed passed by bootloader.
2511 * If the seed is trustworthy, it would be regarded as hardware RNGs. Otherwise
2512 * it would be regarded as device data.
2513 * The decision is controlled by CONFIG_RANDOM_TRUST_BOOTLOADER.
2514 */
2515void add_bootloader_randomness(const void *buf, unsigned int size)
2516{
2517 if (IS_ENABLED(CONFIG_RANDOM_TRUST_BOOTLOADER))
2518 add_hwgenerator_randomness(buf, size, size * 8);
2519 else
2520 add_device_randomness(buf, size);
2521}
Borislav Petkov3fd57e72019-10-01 19:50:23 +02002522EXPORT_SYMBOL_GPL(add_bootloader_randomness);