blob: c7f9584de2c8bbf57753a3eb7f6caf9324749212 [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
Yangtao Li12cd53a2019-06-07 14:25:15 -0400310#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
311
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313#include <linux/module.h>
314#include <linux/kernel.h>
315#include <linux/major.h>
316#include <linux/string.h>
317#include <linux/fcntl.h>
318#include <linux/slab.h>
319#include <linux/random.h>
320#include <linux/poll.h>
321#include <linux/init.h>
322#include <linux/fs.h>
323#include <linux/genhd.h>
324#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700325#include <linux/mm.h>
Michael Ellermandd0f0cf2016-07-31 00:23:08 +1000326#include <linux/nodemask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327#include <linux/spinlock.h>
Torsten Duwec84dbf62014-06-14 23:38:36 -0400328#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329#include <linux/percpu.h>
330#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800331#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400332#include <linux/ptrace.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400333#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200334#include <linux/irq.h>
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400335#include <linux/ratelimit.h>
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400336#include <linux/syscalls.h>
337#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700338#include <linux/uuid.h>
Eric Biggers1ca1b912018-11-16 17:26:21 -0800339#include <crypto/chacha.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341#include <asm/processor.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800342#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400344#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345#include <asm/io.h>
346
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400347#define CREATE_TRACE_POINTS
348#include <trace/events/random.h>
349
Theodore Ts'o43759d42014-06-14 21:43:13 -0400350/* #define ADD_INTERRUPT_BENCH */
351
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352/*
353 * Configuration information
354 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400355#define INPUT_POOL_SHIFT 12
356#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
357#define OUTPUT_POOL_SHIFT 10
358#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400359#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400362#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400365 * To allow fractional bits to be tracked, the entropy_count field is
366 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400367 *
Rasmus Villemoes3bd0b5b2018-11-02 12:04:46 +0100368 * 2*(ENTROPY_SHIFT + poolbitshift) must <= 31, or the multiply in
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400369 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400370 */
371#define ENTROPY_SHIFT 3
372#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
373
374/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 * If the entropy count falls under this number of bits, then we
376 * should wake up processes which are selecting or polling on write
377 * access to /dev/random.
378 */
Greg Price2132a962013-12-06 21:28:03 -0500379static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400382 * Originally, we used a primitive polynomial of degree .poolwords
383 * over GF(2). The taps for various sizes are defined below. They
384 * were chosen to be evenly spaced except for the last tap, which is 1
385 * to get the twisting happening as fast as possible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400387 * For the purposes of better mixing, we use the CRC-32 polynomial as
388 * well to make a (modified) twisted Generalized Feedback Shift
389 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
390 * generators. ACM Transactions on Modeling and Computer Simulation
391 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
Greg Pricedfd38752013-11-29 14:58:06 -0500392 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400393 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 *
395 * Thanks to Colin Plumb for suggesting this.
396 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400397 * The mixing operation is much less sensitive than the output hash,
398 * where we use SHA-1. All that we want of mixing operation is that
399 * it be a good non-cryptographic hash; i.e. it not produce collisions
400 * when fed "random" data of the sort we expect to see. As long as
401 * the pool state differs for different inputs, we have preserved the
402 * input entropy and done a good job. The fact that an intelligent
403 * attacker can construct inputs that will produce controlled
404 * alterations to the pool's state is not important because we don't
405 * consider such inputs to contribute any randomness. The only
406 * property we need with respect to them is that the attacker can't
407 * increase his/her knowledge of the pool's state. Since all
408 * additions are reversible (knowing the final state and the input,
409 * you can reconstruct the initial state), if an attacker has any
410 * uncertainty about the initial state, he/she can only shuffle that
411 * uncertainty about, but never cause any collisions (which would
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 * decrease the uncertainty).
413 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400414 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
415 * Videau in their paper, "The Linux Pseudorandom Number Generator
416 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
417 * paper, they point out that we are not using a true Twisted GFSR,
418 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
419 * is, with only three taps, instead of the six that we are using).
420 * As a result, the resulting polynomial is neither primitive nor
421 * irreducible, and hence does not have a maximal period over
422 * GF(2**32). They suggest a slight change to the generator
423 * polynomial which improves the resulting TGFSR polynomial to be
424 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 */
Rasmus Villemoes26e08542018-11-02 12:04:45 +0100426static const struct poolinfo {
Rasmus Villemoes3bd0b5b2018-11-02 12:04:46 +0100427 int poolbitshift, poolwords, poolbytes, poolfracbits;
428#define S(x) ilog2(x)+5, (x), (x)*4, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 int tap1, tap2, tap3, tap4, tap5;
430} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400431 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
432 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
433 { S(128), 104, 76, 51, 25, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
436/*
437 * Static global variables
438 */
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700439static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700440static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
Herbert Xu205a5252015-06-09 18:19:39 +0800442static DEFINE_SPINLOCK(random_ready_list_lock);
443static LIST_HEAD(random_ready_list);
444
Theodore Ts'oe192be92016-06-12 18:13:36 -0400445struct crng_state {
446 __u32 state[16];
447 unsigned long init_time;
448 spinlock_t lock;
449};
450
Rasmus Villemoes764ed182018-11-02 12:04:47 +0100451static struct crng_state primary_crng = {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400452 .lock = __SPIN_LOCK_UNLOCKED(primary_crng.lock),
453};
454
455/*
456 * crng_init = 0 --> Uninitialized
457 * 1 --> Initialized
458 * 2 --> Initialized from input_pool
459 *
460 * crng_init is protected by primary_crng->lock, and only increases
461 * its value (from 0->1->2).
462 */
463static int crng_init = 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400464#define crng_ready() (likely(crng_init > 1))
Theodore Ts'oe192be92016-06-12 18:13:36 -0400465static int crng_init_cnt = 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400466static unsigned long crng_global_init_time = 0;
Eric Biggers1ca1b912018-11-16 17:26:21 -0800467#define CRNG_INIT_CNT_THRESH (2*CHACHA_KEY_SIZE)
468static void _extract_crng(struct crng_state *crng, __u8 out[CHACHA_BLOCK_SIZE]);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400469static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers1ca1b912018-11-16 17:26:21 -0800470 __u8 tmp[CHACHA_BLOCK_SIZE], int used);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400471static void process_random_ready_list(void);
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400472static void _get_random_bytes(void *buf, int nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400473
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400474static struct ratelimit_state unseeded_warning =
475 RATELIMIT_STATE_INIT("warn_unseeded_randomness", HZ, 3);
476static struct ratelimit_state urandom_warning =
477 RATELIMIT_STATE_INIT("warn_urandom_randomness", HZ, 3);
478
479static int ratelimit_disable __read_mostly;
480
481module_param_named(ratelimit_disable, ratelimit_disable, int, 0644);
482MODULE_PARM_DESC(ratelimit_disable, "Disable random ratelimit suppression");
483
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484/**********************************************************************
485 *
486 * OS independent entropy store. Here are the functions which handle
487 * storing entropy in an entropy pool.
488 *
489 **********************************************************************/
490
491struct entropy_store;
492struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700493 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400494 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 __u32 *pool;
496 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
498 /* read-write data: */
Matt Mackall43358202008-04-29 01:03:01 -0700499 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400500 unsigned short add_ptr;
501 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800502 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400503 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400504 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000505 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506};
507
Theodore Ts'oe192be92016-06-12 18:13:36 -0400508static ssize_t extract_entropy(struct entropy_store *r, void *buf,
509 size_t nbytes, int min, int rsvd);
510static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
511 size_t nbytes, int fips);
512
513static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
Emese Revfy0766f782016-06-20 20:42:34 +0200514static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
516static struct entropy_store input_pool = {
517 .poolinfo = &poolinfo_table[0],
518 .name = "input",
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200519 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 .pool = input_pool_data
521};
522
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400523static __u32 const twist_table[8] = {
524 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
525 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
526
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700528 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700530 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 *
532 * The pool is stirred with a primitive polynomial of the appropriate
533 * degree, and then twisted. We twist by three bits at a time because
534 * it's cheap to do so and helps slightly in the expected case where
535 * the entropy is concentrated in the low-order bits.
536 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400537static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400538 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400540 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700541 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700543 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700544 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 tap1 = r->poolinfo->tap1;
547 tap2 = r->poolinfo->tap2;
548 tap3 = r->poolinfo->tap3;
549 tap4 = r->poolinfo->tap4;
550 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400552 input_rotate = r->input_rotate;
553 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Matt Mackalle68e5b62008-04-29 01:03:05 -0700555 /* mix one byte at a time to simplify size handling and churn faster */
556 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400557 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700558 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
560 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700561 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 w ^= r->pool[(i + tap1) & wordmask];
563 w ^= r->pool[(i + tap2) & wordmask];
564 w ^= r->pool[(i + tap3) & wordmask];
565 w ^= r->pool[(i + tap4) & wordmask];
566 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700567
568 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700570
571 /*
572 * Normally, we add 7 bits of rotation to the pool.
573 * At the beginning of the pool, add an extra 7 bits
574 * rotation, so that successive passes spread the
575 * input bits across the pool evenly.
576 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400577 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 }
579
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400580 r->input_rotate = input_rotate;
581 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582}
583
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400584static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400585 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400587 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400588 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400589}
590
591static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400592 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400593{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400594 unsigned long flags;
595
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400596 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400597 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400598 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400599 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600}
601
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400602struct fast_pool {
603 __u32 pool[4];
604 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400605 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400606 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400607};
608
609/*
610 * This is a fast mixing routine used by the interrupt randomness
611 * collector. It's hardcoded for an 128 bit pool and assumes that any
612 * locks that might be needed are taken by the caller.
613 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400614static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400615{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400616 __u32 a = f->pool[0], b = f->pool[1];
617 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400618
Theodore Ts'o43759d42014-06-14 21:43:13 -0400619 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500620 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400621 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400622
Theodore Ts'o43759d42014-06-14 21:43:13 -0400623 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500624 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400625 d ^= a; b ^= c;
626
627 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500628 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400629 d ^= a; b ^= c;
630
631 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500632 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400633 d ^= a; b ^= c;
634
635 f->pool[0] = a; f->pool[1] = b;
636 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400637 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400638}
639
Herbert Xu205a5252015-06-09 18:19:39 +0800640static void process_random_ready_list(void)
641{
642 unsigned long flags;
643 struct random_ready_callback *rdy, *tmp;
644
645 spin_lock_irqsave(&random_ready_list_lock, flags);
646 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
647 struct module *owner = rdy->owner;
648
649 list_del_init(&rdy->list);
650 rdy->func(rdy);
651 module_put(owner);
652 }
653 spin_unlock_irqrestore(&random_ready_list_lock, flags);
654}
655
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400657 * Credit (or debit) the entropy store with n bits of entropy.
658 * Use credit_entropy_bits_safe() if the value comes from userspace
659 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700661static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662{
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500663 int entropy_count, orig, has_initialized = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400664 const int pool_size = r->poolinfo->poolfracbits;
665 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
Matt Mackalladc782d2008-04-29 01:03:07 -0700667 if (!nbits)
668 return;
669
Theodore Ts'o902c0982012-07-04 10:38:30 -0400670retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -0700671 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400672 if (nfrac < 0) {
673 /* Debit */
674 entropy_count += nfrac;
675 } else {
676 /*
677 * Credit: we have to account for the possibility of
678 * overwriting already present entropy. Even in the
679 * ideal case of pure Shannon entropy, new contributions
680 * approach the full value asymptotically:
681 *
682 * entropy <- entropy + (pool_size - entropy) *
683 * (1 - exp(-add_entropy/pool_size))
684 *
685 * For add_entropy <= pool_size/2 then
686 * (1 - exp(-add_entropy/pool_size)) >=
687 * (add_entropy/pool_size)*0.7869...
688 * so we can approximate the exponential with
689 * 3/4*add_entropy/pool_size and still be on the
690 * safe side by adding at most pool_size/2 at a time.
691 *
692 * The use of pool_size-2 in the while statement is to
693 * prevent rounding artifacts from making the loop
694 * arbitrarily long; this limits the loop to log2(pool_size)*2
695 * turns no matter how large nbits is.
696 */
697 int pnfrac = nfrac;
698 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
699 /* The +2 corresponds to the /4 in the denominator */
700
701 do {
702 unsigned int anfrac = min(pnfrac, pool_size/2);
703 unsigned int add =
704 ((pool_size - entropy_count)*anfrac*3) >> s;
705
706 entropy_count += add;
707 pnfrac -= anfrac;
708 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
709 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400710
Yangtao Li870e05b2020-01-07 16:10:28 -0500711 if (WARN_ON(entropy_count < 0)) {
Yangtao Li12cd53a2019-06-07 14:25:15 -0400712 pr_warn("negative entropy/overflow: pool %s count %d\n",
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400713 r->name, entropy_count);
Andrew Morton8b76f462008-09-02 14:36:14 -0700714 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400715 } else if (entropy_count > pool_size)
716 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400717 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
718 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Theodore Ts'o58be0102019-05-22 12:02:16 -0400720 if (has_initialized) {
Linus Torvalds0891ad82013-11-16 10:19:15 -0800721 r->initialized = 1;
Theodore Ts'o58be0102019-05-22 12:02:16 -0400722 kill_fasync(&fasync, SIGIO, POLL_IN);
723 }
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400724
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400725 trace_credit_entropy_bits(r->name, nbits,
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500726 entropy_count >> ENTROPY_SHIFT, _RET_IP_);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400727
Theodore Ts'o6265e162013-10-03 01:08:15 -0400728 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500729 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400730
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500731 if (crng_init < 2) {
732 if (entropy_bits < 128)
733 return;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400734 crng_reseed(&primary_crng, r);
Yangtao Li12faac32019-06-07 14:25:14 -0400735 entropy_bits = ENTROPY_BITS(r);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400736 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700737 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738}
739
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400740static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400741{
Theodore Ts'o9f886f42017-02-25 18:21:33 -0400742 const int nbits_max = r->poolinfo->poolwords * 32;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400743
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400744 if (nbits < 0)
745 return -EINVAL;
746
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400747 /* Cap the value to avoid overflows */
748 nbits = min(nbits, nbits_max);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400749
750 credit_entropy_bits(r, nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400751 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400752}
753
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754/*********************************************************************
755 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400756 * CRNG using CHACHA20
757 *
758 *********************************************************************/
759
760#define CRNG_RESEED_INTERVAL (300*HZ)
761
762static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
763
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400764#ifdef CONFIG_NUMA
765/*
766 * Hack to deal with crazy userspace progams when they are all trying
767 * to access /dev/urandom in parallel. The programs are almost
768 * certainly doing something terribly wrong, but we'll work around
769 * their brain damage.
770 */
771static struct crng_state **crng_node_pool __read_mostly;
772#endif
773
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400774static void invalidate_batched_entropy(void);
Jon DeVreefe6f1a62019-04-19 23:35:16 -0400775static void numa_crng_init(void);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400776
Kees Cook9b254362018-08-27 14:51:54 -0700777static bool trust_cpu __ro_after_init = IS_ENABLED(CONFIG_RANDOM_TRUST_CPU);
778static int __init parse_trust_cpu(char *arg)
779{
780 return kstrtobool(arg, &trust_cpu);
781}
782early_param("random.trust_cpu", parse_trust_cpu);
783
Theodore Ts'oe192be92016-06-12 18:13:36 -0400784static void crng_initialize(struct crng_state *crng)
785{
786 int i;
Theodore Ts'o39a88832018-07-17 18:24:27 -0400787 int arch_init = 1;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400788 unsigned long rv;
789
790 memcpy(&crng->state[0], "expand 32-byte k", 16);
791 if (crng == &primary_crng)
792 _extract_entropy(&input_pool, &crng->state[4],
793 sizeof(__u32) * 12, 0);
794 else
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400795 _get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400796 for (i = 4; i < 16; i++) {
797 if (!arch_get_random_seed_long(&rv) &&
Theodore Ts'o39a88832018-07-17 18:24:27 -0400798 !arch_get_random_long(&rv)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400799 rv = random_get_entropy();
Theodore Ts'o39a88832018-07-17 18:24:27 -0400800 arch_init = 0;
801 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400802 crng->state[i] ^= rv;
803 }
Jon DeVreefe6f1a62019-04-19 23:35:16 -0400804 if (trust_cpu && arch_init && crng == &primary_crng) {
805 invalidate_batched_entropy();
806 numa_crng_init();
Theodore Ts'o39a88832018-07-17 18:24:27 -0400807 crng_init = 2;
Yangtao Li12cd53a2019-06-07 14:25:15 -0400808 pr_notice("crng done (trusting CPU's manufacturer)\n");
Theodore Ts'o39a88832018-07-17 18:24:27 -0400809 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400810 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
811}
812
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400813#ifdef CONFIG_NUMA
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400814static void do_numa_crng_init(struct work_struct *work)
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400815{
816 int i;
817 struct crng_state *crng;
818 struct crng_state **pool;
819
820 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
821 for_each_online_node(i) {
822 crng = kmalloc_node(sizeof(struct crng_state),
823 GFP_KERNEL | __GFP_NOFAIL, i);
824 spin_lock_init(&crng->lock);
825 crng_initialize(crng);
826 pool[i] = crng;
827 }
828 mb();
829 if (cmpxchg(&crng_node_pool, NULL, pool)) {
830 for_each_node(i)
831 kfree(pool[i]);
832 kfree(pool);
833 }
834}
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400835
836static DECLARE_WORK(numa_crng_init_work, do_numa_crng_init);
837
838static void numa_crng_init(void)
839{
840 schedule_work(&numa_crng_init_work);
841}
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400842#else
843static void numa_crng_init(void) {}
844#endif
845
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400846/*
847 * crng_fast_load() can be called by code in the interrupt service
848 * path. So we can't afford to dilly-dally.
849 */
Theodore Ts'oe192be92016-06-12 18:13:36 -0400850static int crng_fast_load(const char *cp, size_t len)
851{
852 unsigned long flags;
853 char *p;
854
855 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
856 return 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400857 if (crng_init != 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400858 spin_unlock_irqrestore(&primary_crng.lock, flags);
859 return 0;
860 }
861 p = (unsigned char *) &primary_crng.state[4];
862 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
Eric Biggers1ca1b912018-11-16 17:26:21 -0800863 p[crng_init_cnt % CHACHA_KEY_SIZE] ^= *cp;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400864 cp++; crng_init_cnt++; len--;
865 }
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200866 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400867 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400868 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400869 crng_init = 1;
Yangtao Li12cd53a2019-06-07 14:25:15 -0400870 pr_notice("fast init done\n");
Theodore Ts'oe192be92016-06-12 18:13:36 -0400871 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400872 return 1;
873}
874
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400875/*
876 * crng_slow_load() is called by add_device_randomness, which has two
877 * attributes. (1) We can't trust the buffer passed to it is
878 * guaranteed to be unpredictable (so it might not have any entropy at
879 * all), and (2) it doesn't have the performance constraints of
880 * crng_fast_load().
881 *
882 * So we do something more comprehensive which is guaranteed to touch
883 * all of the primary_crng's state, and which uses a LFSR with a
884 * period of 255 as part of the mixing algorithm. Finally, we do
885 * *not* advance crng_init_cnt since buffer we may get may be something
886 * like a fixed DMI table (for example), which might very well be
887 * unique to the machine, but is otherwise unvarying.
888 */
889static int crng_slow_load(const char *cp, size_t len)
890{
891 unsigned long flags;
892 static unsigned char lfsr = 1;
893 unsigned char tmp;
Eric Biggers1ca1b912018-11-16 17:26:21 -0800894 unsigned i, max = CHACHA_KEY_SIZE;
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400895 const char * src_buf = cp;
896 char * dest_buf = (char *) &primary_crng.state[4];
897
898 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
899 return 0;
900 if (crng_init != 0) {
901 spin_unlock_irqrestore(&primary_crng.lock, flags);
902 return 0;
903 }
904 if (len > max)
905 max = len;
906
907 for (i = 0; i < max ; i++) {
908 tmp = lfsr;
909 lfsr >>= 1;
910 if (tmp & 1)
911 lfsr ^= 0xE1;
Eric Biggers1ca1b912018-11-16 17:26:21 -0800912 tmp = dest_buf[i % CHACHA_KEY_SIZE];
913 dest_buf[i % CHACHA_KEY_SIZE] ^= src_buf[i % len] ^ lfsr;
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400914 lfsr += (tmp << 3) | (tmp >> 5);
915 }
916 spin_unlock_irqrestore(&primary_crng.lock, flags);
917 return 1;
918}
919
Theodore Ts'oe192be92016-06-12 18:13:36 -0400920static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
921{
922 unsigned long flags;
923 int i, num;
924 union {
Eric Biggers1ca1b912018-11-16 17:26:21 -0800925 __u8 block[CHACHA_BLOCK_SIZE];
Theodore Ts'oe192be92016-06-12 18:13:36 -0400926 __u32 key[8];
927 } buf;
928
929 if (r) {
930 num = extract_entropy(r, &buf, 32, 16, 0);
931 if (num == 0)
932 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400933 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400934 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400935 _crng_backtrack_protect(&primary_crng, buf.block,
Eric Biggers1ca1b912018-11-16 17:26:21 -0800936 CHACHA_KEY_SIZE);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400937 }
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400938 spin_lock_irqsave(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400939 for (i = 0; i < 8; i++) {
940 unsigned long rv;
941 if (!arch_get_random_seed_long(&rv) &&
942 !arch_get_random_long(&rv))
943 rv = random_get_entropy();
944 crng->state[i+4] ^= buf.key[i] ^ rv;
945 }
946 memzero_explicit(&buf, sizeof(buf));
947 crng->init_time = jiffies;
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400948 spin_unlock_irqrestore(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400949 if (crng == &primary_crng && crng_init < 2) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400950 invalidate_batched_entropy();
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400951 numa_crng_init();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400952 crng_init = 2;
953 process_random_ready_list();
954 wake_up_interruptible(&crng_init_wait);
Andy Lutomirski30c08ef2019-12-23 00:20:48 -0800955 kill_fasync(&fasync, SIGIO, POLL_IN);
Yangtao Li12cd53a2019-06-07 14:25:15 -0400956 pr_notice("crng init done\n");
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400957 if (unseeded_warning.missed) {
Yangtao Li12cd53a2019-06-07 14:25:15 -0400958 pr_notice("%d get_random_xx warning(s) missed due to ratelimiting\n",
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400959 unseeded_warning.missed);
960 unseeded_warning.missed = 0;
961 }
962 if (urandom_warning.missed) {
Yangtao Li12cd53a2019-06-07 14:25:15 -0400963 pr_notice("%d urandom warning(s) missed due to ratelimiting\n",
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400964 urandom_warning.missed);
965 urandom_warning.missed = 0;
966 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400967 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400968}
969
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400970static void _extract_crng(struct crng_state *crng,
Eric Biggers1ca1b912018-11-16 17:26:21 -0800971 __u8 out[CHACHA_BLOCK_SIZE])
Theodore Ts'oe192be92016-06-12 18:13:36 -0400972{
973 unsigned long v, flags;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400974
Theodore Ts'o43838a22018-04-11 13:27:52 -0400975 if (crng_ready() &&
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400976 (time_after(crng_global_init_time, crng->init_time) ||
977 time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL)))
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400978 crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400979 spin_lock_irqsave(&crng->lock, flags);
980 if (arch_get_random_long(&v))
981 crng->state[14] ^= v;
982 chacha20_block(&crng->state[0], out);
983 if (crng->state[12] == 0)
984 crng->state[13]++;
985 spin_unlock_irqrestore(&crng->lock, flags);
986}
987
Eric Biggers1ca1b912018-11-16 17:26:21 -0800988static void extract_crng(__u8 out[CHACHA_BLOCK_SIZE])
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400989{
990 struct crng_state *crng = NULL;
991
992#ifdef CONFIG_NUMA
993 if (crng_node_pool)
994 crng = crng_node_pool[numa_node_id()];
995 if (crng == NULL)
996#endif
997 crng = &primary_crng;
998 _extract_crng(crng, out);
999}
1000
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001001/*
1002 * Use the leftover bytes from the CRNG block output (if there is
1003 * enough) to mutate the CRNG key to provide backtracking protection.
1004 */
1005static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers1ca1b912018-11-16 17:26:21 -08001006 __u8 tmp[CHACHA_BLOCK_SIZE], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001007{
1008 unsigned long flags;
1009 __u32 *s, *d;
1010 int i;
1011
1012 used = round_up(used, sizeof(__u32));
Eric Biggers1ca1b912018-11-16 17:26:21 -08001013 if (used + CHACHA_KEY_SIZE > CHACHA_BLOCK_SIZE) {
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001014 extract_crng(tmp);
1015 used = 0;
1016 }
1017 spin_lock_irqsave(&crng->lock, flags);
Eric Biggersa5e9f552018-09-11 20:05:10 -07001018 s = (__u32 *) &tmp[used];
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001019 d = &crng->state[4];
1020 for (i=0; i < 8; i++)
1021 *d++ ^= *s++;
1022 spin_unlock_irqrestore(&crng->lock, flags);
1023}
1024
Eric Biggers1ca1b912018-11-16 17:26:21 -08001025static void crng_backtrack_protect(__u8 tmp[CHACHA_BLOCK_SIZE], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001026{
1027 struct crng_state *crng = NULL;
1028
1029#ifdef CONFIG_NUMA
1030 if (crng_node_pool)
1031 crng = crng_node_pool[numa_node_id()];
1032 if (crng == NULL)
1033#endif
1034 crng = &primary_crng;
1035 _crng_backtrack_protect(crng, tmp, used);
1036}
1037
Theodore Ts'oe192be92016-06-12 18:13:36 -04001038static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
1039{
Eric Biggers1ca1b912018-11-16 17:26:21 -08001040 ssize_t ret = 0, i = CHACHA_BLOCK_SIZE;
1041 __u8 tmp[CHACHA_BLOCK_SIZE] __aligned(4);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001042 int large_request = (nbytes > 256);
1043
1044 while (nbytes) {
1045 if (large_request && need_resched()) {
1046 if (signal_pending(current)) {
1047 if (ret == 0)
1048 ret = -ERESTARTSYS;
1049 break;
1050 }
1051 schedule();
1052 }
1053
1054 extract_crng(tmp);
Eric Biggers1ca1b912018-11-16 17:26:21 -08001055 i = min_t(int, nbytes, CHACHA_BLOCK_SIZE);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001056 if (copy_to_user(buf, tmp, i)) {
1057 ret = -EFAULT;
1058 break;
1059 }
1060
1061 nbytes -= i;
1062 buf += i;
1063 ret += i;
1064 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001065 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001066
1067 /* Wipe data just written to memory */
1068 memzero_explicit(tmp, sizeof(tmp));
1069
1070 return ret;
1071}
1072
1073
1074/*********************************************************************
1075 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 * Entropy input management
1077 *
1078 *********************************************************************/
1079
1080/* There is one of these per entropy source */
1081struct timer_rand_state {
1082 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001083 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084};
1085
Theodore Ts'o644008d2013-11-03 16:40:53 -05001086#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
1087
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001088/*
Theodore Ts'oe192be92016-06-12 18:13:36 -04001089 * Add device- or boot-specific data to the input pool to help
1090 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001091 *
Theodore Ts'oe192be92016-06-12 18:13:36 -04001092 * None of this adds any entropy; it is meant to avoid the problem of
1093 * the entropy pool having similar initial state across largely
1094 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001095 */
1096void add_device_randomness(const void *buf, unsigned int size)
1097{
Theodore Ts'o61875f32013-09-21 13:58:22 -04001098 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001099 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001100
Theodore Ts'odc12baa2018-04-11 14:58:27 -04001101 if (!crng_ready() && size)
1102 crng_slow_load(buf, size);
Kees Cookee7998c2017-07-12 14:34:04 -07001103
Theodore Ts'o59108952013-09-12 14:10:25 -04001104 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001105 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001106 _mix_pool_bytes(&input_pool, buf, size);
1107 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001108 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001109}
1110EXPORT_SYMBOL(add_device_randomness);
1111
Theodore Ts'o644008d2013-11-03 16:40:53 -05001112static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001113
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114/*
1115 * This function adds entropy to the entropy "pool" by using timing
1116 * delays. It uses the timer_rand_state structure to make an estimate
1117 * of how many bits of entropy this call has added to the pool.
1118 *
1119 * The number "num" is also added to the pool - it should somehow describe
1120 * the type of event which just happened. This is currently 0-255 for
1121 * keyboard scan codes, and 256 upwards for interrupts.
1122 *
1123 */
1124static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1125{
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001126 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -08001129 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 unsigned num;
1131 } sample;
1132 long delta, delta2, delta3;
1133
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001135 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 sample.num = num;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001137 r = &input_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001138 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
1140 /*
1141 * Calculate number of bits of randomness we probably added.
1142 * We take into account the first, second and third-order deltas
1143 * in order to make our estimate.
1144 */
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001145 delta = sample.jiffies - state->last_time;
1146 state->last_time = sample.jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001148 delta2 = delta - state->last_delta;
1149 state->last_delta = delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001151 delta3 = delta2 - state->last_delta2;
1152 state->last_delta2 = delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001154 if (delta < 0)
1155 delta = -delta;
1156 if (delta2 < 0)
1157 delta2 = -delta2;
1158 if (delta3 < 0)
1159 delta3 = -delta3;
1160 if (delta > delta2)
1161 delta = delta2;
1162 if (delta > delta3)
1163 delta = delta3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001165 /*
1166 * delta is now minimum absolute delta.
1167 * Round down by 1 bit on general principles,
Yangtao Li727d4992020-01-07 16:55:34 -05001168 * and limit entropy estimate to 12 bits.
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001169 */
1170 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171}
1172
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001173void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 unsigned int value)
1175{
1176 static unsigned char last_value;
1177
1178 /* ignore autorepeat and the like */
1179 if (value == last_value)
1180 return;
1181
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 last_value = value;
1183 add_timer_randomness(&input_timer_state,
1184 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001185 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001187EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001189static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1190
Theodore Ts'o43759d42014-06-14 21:43:13 -04001191#ifdef ADD_INTERRUPT_BENCH
1192static unsigned long avg_cycles, avg_deviation;
1193
1194#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1195#define FIXED_1_2 (1 << (AVG_SHIFT-1))
1196
1197static void add_interrupt_bench(cycles_t start)
1198{
1199 long delta = random_get_entropy() - start;
1200
1201 /* Use a weighted moving average */
1202 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1203 avg_cycles += delta;
1204 /* And average deviation */
1205 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1206 avg_deviation += delta;
1207}
1208#else
1209#define add_interrupt_bench(x)
1210#endif
1211
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001212static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
1213{
1214 __u32 *ptr = (__u32 *) regs;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001215 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001216
1217 if (regs == NULL)
1218 return 0;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001219 idx = READ_ONCE(f->reg_idx);
1220 if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
1221 idx = 0;
1222 ptr += idx++;
1223 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitz9dfa7bb2017-04-30 19:49:21 +12001224 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001225}
1226
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001227void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228{
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001229 struct entropy_store *r;
Christoph Lameter1b2a1a72014-08-17 12:30:29 -05001230 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001231 struct pt_regs *regs = get_irq_regs();
1232 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001233 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -04001234 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001235 __u64 ip;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001236 unsigned long seed;
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001237 int credit = 0;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001238
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001239 if (cycles == 0)
1240 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001241 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1242 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001243 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1244 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001245 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001246 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001247 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
1248 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001249
Theodore Ts'o43759d42014-06-14 21:43:13 -04001250 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001251 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001252
Theodore Ts'o43838a22018-04-11 13:27:52 -04001253 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001254 if ((fast_pool->count >= 64) &&
1255 crng_fast_load((char *) fast_pool->pool,
1256 sizeof(fast_pool->pool))) {
1257 fast_pool->count = 0;
1258 fast_pool->last = now;
1259 }
1260 return;
1261 }
1262
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001263 if ((fast_pool->count < 64) &&
1264 !time_after(now, fast_pool->last + HZ))
1265 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266
Theodore Ts'oe192be92016-06-12 18:13:36 -04001267 r = &input_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001268 if (!spin_trylock(&r->lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 return;
1270
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001271 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001272 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
H. Peter Anvin83664a62014-03-17 16:36:28 -07001273
1274 /*
1275 * If we have architectural seed generator, produce a seed and
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001276 * add it to the pool. For the sake of paranoia don't let the
1277 * architectural seed generator dominate the input from the
1278 * interrupt noise.
H. Peter Anvin83664a62014-03-17 16:36:28 -07001279 */
1280 if (arch_get_random_seed_long(&seed)) {
Theodore Ts'o85608f82014-06-10 23:09:20 -04001281 __mix_pool_bytes(r, &seed, sizeof(seed));
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001282 credit = 1;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001283 }
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001284 spin_unlock(&r->lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001285
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001286 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001287
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001288 /* award one bit for the contents of the fast pool */
1289 credit_entropy_bits(r, credit + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001291EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
David Howells93614012006-09-30 20:45:40 +02001293#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294void add_disk_randomness(struct gendisk *disk)
1295{
1296 if (!disk || !disk->random)
1297 return;
1298 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001299 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001300 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001302EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001303#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305/*********************************************************************
1306 *
1307 * Entropy extraction routines
1308 *
1309 *********************************************************************/
1310
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311/*
Greg Price19fa5be12013-11-29 15:50:06 -05001312 * This function decides how many bytes to actually take from the
1313 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315static size_t account(struct entropy_store *r, size_t nbytes, int min,
1316 int reserved)
1317{
Stephan Müller43d8a722016-12-27 23:40:59 +01001318 int entropy_count, orig, have_bytes;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001319 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001321 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322
1323 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001324retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -07001325 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001326 ibytes = nbytes;
Stephan Müller43d8a722016-12-27 23:40:59 +01001327 /* never pull more than available */
1328 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001329
Stephan Müller43d8a722016-12-27 23:40:59 +01001330 if ((have_bytes -= reserved) < 0)
1331 have_bytes = 0;
1332 ibytes = min_t(size_t, ibytes, have_bytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001333 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001334 ibytes = 0;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001335
Yangtao Li870e05b2020-01-07 16:10:28 -05001336 if (WARN_ON(entropy_count < 0)) {
Yangtao Li12cd53a2019-06-07 14:25:15 -04001337 pr_warn("negative entropy count: pool %s count %d\n",
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001338 r->name, entropy_count);
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001339 entropy_count = 0;
1340 }
1341 nfrac = ibytes << (ENTROPY_SHIFT + 3);
1342 if ((size_t) entropy_count > nfrac)
1343 entropy_count -= nfrac;
1344 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001345 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001346
Greg Price0fb7a012013-12-05 19:32:19 -05001347 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1348 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001350 trace_debit_entropy(r->name, 8 * ibytes);
Yangtao Li12faac32019-06-07 14:25:14 -04001351 if (ibytes && ENTROPY_BITS(r) < random_write_wakeup_bits) {
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001352 wake_up_interruptible(&random_write_wait);
Theodore Ts'ob9809552013-03-04 11:59:12 -05001353 kill_fasync(&fasync, SIGIO, POLL_OUT);
1354 }
1355
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001356 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357}
1358
Greg Price19fa5be12013-11-29 15:50:06 -05001359/*
1360 * This function does the actual extraction for extract_entropy and
1361 * extract_entropy_user.
1362 *
1363 * Note: we assume that .poolwords is a multiple of 16 words.
1364 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365static void extract_buf(struct entropy_store *r, __u8 *out)
1366{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001367 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001368 union {
1369 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001370 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001371 } hash;
1372 __u32 workspace[SHA_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001373 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001376 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001377 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001378 */
Theodore Ts'o46884442013-12-17 21:16:39 -05001379 sha_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001380 for (i = 0; i < LONGS(20); i++) {
1381 unsigned long v;
1382 if (!arch_get_random_long(&v))
1383 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001384 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001385 }
1386
Theodore Ts'o46884442013-12-17 21:16:39 -05001387 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1388 spin_lock_irqsave(&r->lock, flags);
1389 for (i = 0; i < r->poolinfo->poolwords; i += 16)
1390 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1391
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001392 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001393 * We mix the hash back into the pool to prevent backtracking
1394 * attacks (where the attacker knows the state of the pool
1395 * plus the current outputs, and attempts to find previous
1396 * ouputs), unless the hash function can be inverted. By
1397 * mixing at least a SHA1 worth of hash data back, we make
1398 * brute-forcing the feedback as hard as brute-forcing the
1399 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001401 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001402 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001403
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001404 memzero_explicit(workspace, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
1406 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001407 * In case the hash function has some recognizable output
1408 * pattern, we fold it in half. Thus, we always feed back
1409 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001411 hash.w[0] ^= hash.w[3];
1412 hash.w[1] ^= hash.w[4];
1413 hash.w[2] ^= rol32(hash.w[2], 16);
1414
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001415 memcpy(out, &hash, EXTRACT_SIZE);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001416 memzero_explicit(&hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417}
1418
Theodore Ts'oe192be92016-06-12 18:13:36 -04001419static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
1420 size_t nbytes, int fips)
1421{
1422 ssize_t ret = 0, i;
1423 __u8 tmp[EXTRACT_SIZE];
1424 unsigned long flags;
1425
1426 while (nbytes) {
1427 extract_buf(r, tmp);
1428
1429 if (fips) {
1430 spin_lock_irqsave(&r->lock, flags);
1431 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1432 panic("Hardware RNG duplicated output!\n");
1433 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1434 spin_unlock_irqrestore(&r->lock, flags);
1435 }
1436 i = min_t(int, nbytes, EXTRACT_SIZE);
1437 memcpy(buf, tmp, i);
1438 nbytes -= i;
1439 buf += i;
1440 ret += i;
1441 }
1442
1443 /* Wipe data just returned from memory */
1444 memzero_explicit(tmp, sizeof(tmp));
1445
1446 return ret;
1447}
1448
Greg Price19fa5be12013-11-29 15:50:06 -05001449/*
1450 * This function extracts randomness from the "entropy pool", and
1451 * returns it in a buffer.
1452 *
1453 * The min parameter specifies the minimum amount we can pull before
1454 * failing to avoid races that defeat catastrophic reseeding while the
1455 * reserved parameter indicates how much entropy we must leave in the
1456 * pool after each pull to avoid starving other readers.
1457 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001458static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001459 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001462 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001464 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001465 if (fips_enabled) {
1466 spin_lock_irqsave(&r->lock, flags);
1467 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001468 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001469 spin_unlock_irqrestore(&r->lock, flags);
1470 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001471 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001472 extract_buf(r, tmp);
1473 spin_lock_irqsave(&r->lock, flags);
1474 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1475 }
1476 spin_unlock_irqrestore(&r->lock, flags);
1477 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001478
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001479 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 nbytes = account(r, nbytes, min, reserved);
1481
Theodore Ts'oe192be92016-06-12 18:13:36 -04001482 return _extract_entropy(r, buf, nbytes, fips_enabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483}
1484
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001485#define warn_unseeded_randomness(previous) \
1486 _warn_unseeded_randomness(__func__, (void *) _RET_IP_, (previous))
1487
1488static void _warn_unseeded_randomness(const char *func_name, void *caller,
1489 void **previous)
1490{
1491#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1492 const bool print_once = false;
1493#else
1494 static bool print_once __read_mostly;
1495#endif
1496
1497 if (print_once ||
1498 crng_ready() ||
1499 (previous && (caller == READ_ONCE(*previous))))
1500 return;
1501 WRITE_ONCE(*previous, caller);
1502#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1503 print_once = true;
1504#endif
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001505 if (__ratelimit(&unseeded_warning))
Sergey Senozhatsky1b710b12019-11-13 16:16:25 -05001506 printk_deferred(KERN_NOTICE "random: %s called from %pS "
1507 "with crng_init=%d\n", func_name, caller,
1508 crng_init);
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001509}
1510
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511/*
1512 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001513 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001514 * TCP sequence numbers, etc. It does not rely on the hardware random
1515 * number generator. For random bytes direct from the hardware RNG
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001516 * (when available), use get_random_bytes_arch(). In order to ensure
1517 * that the randomness provided by this function is okay, the function
1518 * wait_for_random_bytes() should be called and return 0 at least once
1519 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 */
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001521static void _get_random_bytes(void *buf, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522{
Eric Biggers1ca1b912018-11-16 17:26:21 -08001523 __u8 tmp[CHACHA_BLOCK_SIZE] __aligned(4);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001524
Theodore Ts'o59108952013-09-12 14:10:25 -04001525 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001526
Eric Biggers1ca1b912018-11-16 17:26:21 -08001527 while (nbytes >= CHACHA_BLOCK_SIZE) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001528 extract_crng(buf);
Eric Biggers1ca1b912018-11-16 17:26:21 -08001529 buf += CHACHA_BLOCK_SIZE;
1530 nbytes -= CHACHA_BLOCK_SIZE;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001531 }
1532
1533 if (nbytes > 0) {
1534 extract_crng(tmp);
1535 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001536 crng_backtrack_protect(tmp, nbytes);
1537 } else
Eric Biggers1ca1b912018-11-16 17:26:21 -08001538 crng_backtrack_protect(tmp, CHACHA_BLOCK_SIZE);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001539 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001540}
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001541
1542void get_random_bytes(void *buf, int nbytes)
1543{
1544 static void *previous;
1545
1546 warn_unseeded_randomness(&previous);
1547 _get_random_bytes(buf, nbytes);
1548}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001549EXPORT_SYMBOL(get_random_bytes);
1550
Linus Torvalds50ee7522019-09-28 16:53:52 -07001551
1552/*
1553 * Each time the timer fires, we expect that we got an unpredictable
1554 * jump in the cycle counter. Even if the timer is running on another
1555 * CPU, the timer activity will be touching the stack of the CPU that is
1556 * generating entropy..
1557 *
1558 * Note that we don't re-arm the timer in the timer itself - we are
1559 * happy to be scheduled away, since that just makes the load more
1560 * complex, but we do not want the timer to keep ticking unless the
1561 * entropy loop is running.
1562 *
1563 * So the re-arming always happens in the entropy loop itself.
1564 */
1565static void entropy_timer(struct timer_list *t)
1566{
1567 credit_entropy_bits(&input_pool, 1);
1568}
1569
1570/*
1571 * If we have an actual cycle counter, see if we can
1572 * generate enough entropy with timing noise
1573 */
1574static void try_to_generate_entropy(void)
1575{
1576 struct {
1577 unsigned long now;
1578 struct timer_list timer;
1579 } stack;
1580
1581 stack.now = random_get_entropy();
1582
1583 /* Slow counter - or none. Don't even bother */
1584 if (stack.now == random_get_entropy())
1585 return;
1586
1587 timer_setup_on_stack(&stack.timer, entropy_timer, 0);
1588 while (!crng_ready()) {
1589 if (!timer_pending(&stack.timer))
1590 mod_timer(&stack.timer, jiffies+1);
1591 mix_pool_bytes(&input_pool, &stack.now, sizeof(stack.now));
1592 schedule();
1593 stack.now = random_get_entropy();
1594 }
1595
1596 del_timer_sync(&stack.timer);
1597 destroy_timer_on_stack(&stack.timer);
1598 mix_pool_bytes(&input_pool, &stack.now, sizeof(stack.now));
1599}
1600
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001601/*
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001602 * Wait for the urandom pool to be seeded and thus guaranteed to supply
1603 * cryptographically secure random numbers. This applies to: the /dev/urandom
1604 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
1605 * family of functions. Using any of these functions without first calling
1606 * this function forfeits the guarantee of security.
1607 *
1608 * Returns: 0 if the urandom pool has been seeded.
1609 * -ERESTARTSYS if the function was interrupted by a signal.
1610 */
1611int wait_for_random_bytes(void)
1612{
1613 if (likely(crng_ready()))
1614 return 0;
Linus Torvalds50ee7522019-09-28 16:53:52 -07001615
1616 do {
1617 int ret;
1618 ret = wait_event_interruptible_timeout(crng_init_wait, crng_ready(), HZ);
1619 if (ret)
1620 return ret > 0 ? 0 : ret;
1621
1622 try_to_generate_entropy();
1623 } while (!crng_ready());
1624
1625 return 0;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001626}
1627EXPORT_SYMBOL(wait_for_random_bytes);
1628
1629/*
Jason A. Donenfeld9a472492018-07-31 21:11:00 +02001630 * Returns whether or not the urandom pool has been seeded and thus guaranteed
1631 * to supply cryptographically secure random numbers. This applies to: the
1632 * /dev/urandom device, the get_random_bytes function, and the get_random_{u32,
1633 * ,u64,int,long} family of functions.
1634 *
1635 * Returns: true if the urandom pool has been seeded.
1636 * false if the urandom pool has not been seeded.
1637 */
1638bool rng_is_initialized(void)
1639{
1640 return crng_ready();
1641}
1642EXPORT_SYMBOL(rng_is_initialized);
1643
1644/*
Herbert Xu205a5252015-06-09 18:19:39 +08001645 * Add a callback function that will be invoked when the nonblocking
1646 * pool is initialised.
1647 *
1648 * returns: 0 if callback is successfully added
1649 * -EALREADY if pool is already initialised (callback not called)
1650 * -ENOENT if module for callback is not alive
1651 */
1652int add_random_ready_callback(struct random_ready_callback *rdy)
1653{
1654 struct module *owner;
1655 unsigned long flags;
1656 int err = -EALREADY;
1657
Theodore Ts'oe192be92016-06-12 18:13:36 -04001658 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001659 return err;
1660
1661 owner = rdy->owner;
1662 if (!try_module_get(owner))
1663 return -ENOENT;
1664
1665 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001666 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001667 goto out;
1668
1669 owner = NULL;
1670
1671 list_add(&rdy->list, &random_ready_list);
1672 err = 0;
1673
1674out:
1675 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1676
1677 module_put(owner);
1678
1679 return err;
1680}
1681EXPORT_SYMBOL(add_random_ready_callback);
1682
1683/*
1684 * Delete a previously registered readiness callback function.
1685 */
1686void del_random_ready_callback(struct random_ready_callback *rdy)
1687{
1688 unsigned long flags;
1689 struct module *owner = NULL;
1690
1691 spin_lock_irqsave(&random_ready_list_lock, flags);
1692 if (!list_empty(&rdy->list)) {
1693 list_del_init(&rdy->list);
1694 owner = rdy->owner;
1695 }
1696 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1697
1698 module_put(owner);
1699}
1700EXPORT_SYMBOL(del_random_ready_callback);
1701
1702/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001703 * This function will use the architecture-specific hardware random
1704 * number generator if it is available. The arch-specific hw RNG will
1705 * almost certainly be faster than what we can do in software, but it
1706 * is impossible to verify that it is implemented securely (as
1707 * opposed, to, say, the AES encryption of a sequence number using a
1708 * key known by the NSA). So it's useful if we need the speed, but
1709 * only if we're willing to trust the hardware manufacturer not to
1710 * have put in a back door.
Tobin C. Harding753d4332018-06-22 09:15:32 +10001711 *
1712 * Return number of bytes filled in.
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001713 */
Tobin C. Harding753d4332018-06-22 09:15:32 +10001714int __must_check get_random_bytes_arch(void *buf, int nbytes)
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001715{
Tobin C. Harding753d4332018-06-22 09:15:32 +10001716 int left = nbytes;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001717 char *p = buf;
1718
Tobin C. Harding753d4332018-06-22 09:15:32 +10001719 trace_get_random_bytes_arch(left, _RET_IP_);
1720 while (left) {
H. Peter Anvin63d77172011-07-31 13:54:50 -07001721 unsigned long v;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001722 int chunk = min_t(int, left, sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001723
H. Peter Anvin63d77172011-07-31 13:54:50 -07001724 if (!arch_get_random_long(&v))
1725 break;
Tobin C. Harding8ddd6ef2018-06-22 09:15:31 +10001726
Luck, Tonybd29e562011-11-16 10:50:56 -08001727 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001728 p += chunk;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001729 left -= chunk;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001730 }
1731
Tobin C. Harding753d4332018-06-22 09:15:32 +10001732 return nbytes - left;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001734EXPORT_SYMBOL(get_random_bytes_arch);
1735
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736/*
1737 * init_std_data - initialize pool with system data
1738 *
1739 * @r: pool to initialize
1740 *
1741 * This function clears the pool's entropy count and mixes some system
1742 * data into the pool to prepare it for use. The pool is not cleared
1743 * as that can only decrease the entropy in the pool.
1744 */
Kees Cookd5553522019-04-19 23:27:05 -04001745static void __init init_std_data(struct entropy_store *r)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001747 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001748 ktime_t now = ktime_get_real();
1749 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
Theodore Ts'o85608f82014-06-10 23:09:20 -04001751 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001752 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001753 if (!arch_get_random_seed_long(&rv) &&
1754 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001755 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001756 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001757 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001758 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759}
1760
Tony Luckcbc96b72012-07-23 09:47:57 -07001761/*
1762 * Note that setup_arch() may call add_device_randomness()
1763 * long before we get here. This allows seeding of the pools
1764 * with some platform dependent data very early in the boot
1765 * process. But it limits our options here. We must use
1766 * statically allocated structures that already have all
1767 * initializations complete at compile time. We should also
1768 * take care not to overwrite the precious per platform data
1769 * we were given.
1770 */
Kees Cookd5553522019-04-19 23:27:05 -04001771int __init rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772{
1773 init_std_data(&input_pool);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001774 crng_initialize(&primary_crng);
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001775 crng_global_init_time = jiffies;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001776 if (ratelimit_disable) {
1777 urandom_warning.interval = 0;
1778 unseeded_warning.interval = 0;
1779 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 return 0;
1781}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782
David Howells93614012006-09-30 20:45:40 +02001783#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784void rand_initialize_disk(struct gendisk *disk)
1785{
1786 struct timer_rand_state *state;
1787
1788 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001789 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 * source.
1791 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001792 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001793 if (state) {
1794 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001796 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797}
David Howells93614012006-09-30 20:45:40 +02001798#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799
1800static ssize_t
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08001801urandom_read_nowarn(struct file *file, char __user *buf, size_t nbytes,
1802 loff_t *ppos)
1803{
1804 int ret;
1805
1806 nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
1807 ret = extract_crng_user(buf, nbytes);
1808 trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
1809 return ret;
1810}
1811
1812static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001813urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001815 unsigned long flags;
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001816 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05001817
Theodore Ts'oe192be92016-06-12 18:13:36 -04001818 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001819 maxwarn--;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001820 if (__ratelimit(&urandom_warning))
Yangtao Li12cd53a2019-06-07 14:25:15 -04001821 pr_notice("%s: uninitialized urandom read (%zd bytes read)\n",
1822 current->comm, nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001823 spin_lock_irqsave(&primary_crng.lock, flags);
1824 crng_init_cnt = 0;
1825 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001826 }
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08001827
1828 return urandom_read_nowarn(file, buf, nbytes, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829}
1830
Andy Lutomirski30c08ef2019-12-23 00:20:48 -08001831static ssize_t
1832random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1833{
1834 int ret;
1835
1836 ret = wait_for_random_bytes();
1837 if (ret != 0)
1838 return ret;
1839 return urandom_read_nowarn(file, buf, nbytes, ppos);
1840}
1841
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001842static __poll_t
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001843random_poll(struct file *file, poll_table * wait)
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001844{
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001845 __poll_t mask;
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001846
Andy Lutomirski30c08ef2019-12-23 00:20:48 -08001847 poll_wait(file, &crng_init_wait, wait);
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001848 poll_wait(file, &random_write_wait, wait);
1849 mask = 0;
Andy Lutomirski30c08ef2019-12-23 00:20:48 -08001850 if (crng_ready())
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001851 mask |= EPOLLIN | EPOLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05001852 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001853 mask |= EPOLLOUT | EPOLLWRNORM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 return mask;
1855}
1856
Matt Mackall7f397dc2007-05-29 21:58:10 -05001857static int
1858write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1859{
1860 size_t bytes;
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001861 __u32 t, buf[16];
Matt Mackall7f397dc2007-05-29 21:58:10 -05001862 const char __user *p = buffer;
1863
1864 while (count > 0) {
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001865 int b, i = 0;
1866
Matt Mackall7f397dc2007-05-29 21:58:10 -05001867 bytes = min(count, sizeof(buf));
1868 if (copy_from_user(&buf, p, bytes))
1869 return -EFAULT;
1870
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001871 for (b = bytes ; b > 0 ; b -= sizeof(__u32), i++) {
1872 if (!arch_get_random_int(&t))
1873 break;
1874 buf[i] ^= t;
1875 }
1876
Matt Mackall7f397dc2007-05-29 21:58:10 -05001877 count -= bytes;
1878 p += bytes;
1879
Theodore Ts'o85608f82014-06-10 23:09:20 -04001880 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001881 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001882 }
1883
1884 return 0;
1885}
1886
Matt Mackall90b75ee2008-04-29 01:02:55 -07001887static ssize_t random_write(struct file *file, const char __user *buffer,
1888 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001890 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891
Theodore Ts'oe192be92016-06-12 18:13:36 -04001892 ret = write_pool(&input_pool, buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05001893 if (ret)
1894 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895
Matt Mackall7f397dc2007-05-29 21:58:10 -05001896 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897}
1898
Matt Mackall43ae4862008-04-29 01:02:58 -07001899static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900{
1901 int size, ent_count;
1902 int __user *p = (int __user *)arg;
1903 int retval;
1904
1905 switch (cmd) {
1906 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001907 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001908 ent_count = ENTROPY_BITS(&input_pool);
1909 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 return -EFAULT;
1911 return 0;
1912 case RNDADDTOENTCNT:
1913 if (!capable(CAP_SYS_ADMIN))
1914 return -EPERM;
1915 if (get_user(ent_count, p))
1916 return -EFAULT;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001917 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 case RNDADDENTROPY:
1919 if (!capable(CAP_SYS_ADMIN))
1920 return -EPERM;
1921 if (get_user(ent_count, p++))
1922 return -EFAULT;
1923 if (ent_count < 0)
1924 return -EINVAL;
1925 if (get_user(size, p++))
1926 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001927 retval = write_pool(&input_pool, (const char __user *)p,
1928 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 if (retval < 0)
1930 return retval;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001931 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 case RNDZAPENTCNT:
1933 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001934 /*
1935 * Clear the entropy pool counters. We no longer clear
1936 * the entropy pool, as that's silly.
1937 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 if (!capable(CAP_SYS_ADMIN))
1939 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001940 input_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 return 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001942 case RNDRESEEDCRNG:
1943 if (!capable(CAP_SYS_ADMIN))
1944 return -EPERM;
1945 if (crng_init < 2)
1946 return -ENODATA;
1947 crng_reseed(&primary_crng, NULL);
1948 crng_global_init_time = jiffies - 1;
1949 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 default:
1951 return -EINVAL;
1952 }
1953}
1954
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001955static int random_fasync(int fd, struct file *filp, int on)
1956{
1957 return fasync_helper(fd, filp, on, &fasync);
1958}
1959
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001960const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 .read = random_read,
1962 .write = random_write,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001963 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001964 .unlocked_ioctl = random_ioctl,
Arnd Bergmann507e4e22018-09-07 11:10:23 +02001965 .compat_ioctl = compat_ptr_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001966 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001967 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968};
1969
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001970const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 .read = urandom_read,
1972 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001973 .unlocked_ioctl = random_ioctl,
Jason A. Donenfeld4aa37c42019-12-17 18:24:55 +01001974 .compat_ioctl = compat_ptr_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001975 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001976 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977};
1978
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001979SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
1980 unsigned int, flags)
1981{
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001982 int ret;
1983
Andy Lutomirski75551db2019-12-23 00:20:46 -08001984 if (flags & ~(GRND_NONBLOCK|GRND_RANDOM|GRND_INSECURE))
1985 return -EINVAL;
1986
1987 /*
1988 * Requesting insecure and blocking randomness at the same time makes
1989 * no sense.
1990 */
1991 if ((flags & (GRND_INSECURE|GRND_RANDOM)) == (GRND_INSECURE|GRND_RANDOM))
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001992 return -EINVAL;
1993
1994 if (count > INT_MAX)
1995 count = INT_MAX;
1996
Andy Lutomirski75551db2019-12-23 00:20:46 -08001997 if (!(flags & GRND_INSECURE) && !crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001998 if (flags & GRND_NONBLOCK)
1999 return -EAGAIN;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002000 ret = wait_for_random_bytes();
2001 if (unlikely(ret))
2002 return ret;
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002003 }
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08002004 return urandom_read_nowarn(NULL, buf, count, NULL);
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002005}
2006
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007/********************************************************************
2008 *
2009 * Sysctl interface
2010 *
2011 ********************************************************************/
2012
2013#ifdef CONFIG_SYSCTL
2014
2015#include <linux/sysctl.h>
2016
Andy Lutomirskic95ea0c2019-12-23 00:20:51 -08002017static int min_write_thresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018static int max_write_thresh = INPUT_POOL_WORDS * 32;
Fabio Estevamdb61ffe2017-01-31 14:36:07 -02002019static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020static char sysctl_bootid[16];
2021
2022/*
Greg Pricef22052b2013-11-29 14:58:16 -05002023 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 * UUID. The difference is in whether table->data is NULL; if it is,
2025 * then a new UUID is generated and returned to the user.
2026 *
Greg Pricef22052b2013-11-29 14:58:16 -05002027 * If the user accesses this via the proc interface, the UUID will be
2028 * returned as an ASCII string in the standard UUID format; if via the
2029 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 */
Joe Perchesa1514272013-06-13 19:37:35 -07002031static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 void __user *buffer, size_t *lenp, loff_t *ppos)
2033{
Joe Perchesa1514272013-06-13 19:37:35 -07002034 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 unsigned char buf[64], tmp_uuid[16], *uuid;
2036
2037 uuid = table->data;
2038 if (!uuid) {
2039 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07002041 } else {
2042 static DEFINE_SPINLOCK(bootid_spinlock);
2043
2044 spin_lock(&bootid_spinlock);
2045 if (!uuid[8])
2046 generate_random_uuid(uuid);
2047 spin_unlock(&bootid_spinlock);
2048 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049
Joe Perches35900772009-12-14 18:01:11 -08002050 sprintf(buf, "%pU", uuid);
2051
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 fake_table.data = buf;
2053 fake_table.maxlen = sizeof(buf);
2054
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002055 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056}
2057
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002058/*
2059 * Return entropy available scaled to integral bits
2060 */
Joe Perches5eb10d92014-06-06 14:37:58 -07002061static int proc_do_entropy(struct ctl_table *table, int write,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002062 void __user *buffer, size_t *lenp, loff_t *ppos)
2063{
Joe Perches5eb10d92014-06-06 14:37:58 -07002064 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002065 int entropy_count;
2066
2067 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
2068
2069 fake_table.data = &entropy_count;
2070 fake_table.maxlen = sizeof(entropy_count);
2071
2072 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
2073}
2074
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07002076extern struct ctl_table random_table[];
2077struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 .procname = "poolsize",
2080 .data = &sysctl_poolsize,
2081 .maxlen = sizeof(int),
2082 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002083 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 },
2085 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 .procname = "entropy_avail",
2087 .maxlen = sizeof(int),
2088 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002089 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 .data = &input_pool.entropy_count,
2091 },
2092 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002094 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 .maxlen = sizeof(int),
2096 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002097 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 .extra1 = &min_write_thresh,
2099 .extra2 = &max_write_thresh,
2100 },
2101 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002102 .procname = "urandom_min_reseed_secs",
2103 .data = &random_min_urandom_seed,
2104 .maxlen = sizeof(int),
2105 .mode = 0644,
2106 .proc_handler = proc_dointvec,
2107 },
2108 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 .procname = "boot_id",
2110 .data = &sysctl_bootid,
2111 .maxlen = 16,
2112 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002113 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 },
2115 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 .procname = "uuid",
2117 .maxlen = 16,
2118 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002119 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002121#ifdef ADD_INTERRUPT_BENCH
2122 {
2123 .procname = "add_interrupt_avg_cycles",
2124 .data = &avg_cycles,
2125 .maxlen = sizeof(avg_cycles),
2126 .mode = 0444,
2127 .proc_handler = proc_doulongvec_minmax,
2128 },
2129 {
2130 .procname = "add_interrupt_avg_deviation",
2131 .data = &avg_deviation,
2132 .maxlen = sizeof(avg_deviation),
2133 .mode = 0444,
2134 .proc_handler = proc_doulongvec_minmax,
2135 },
2136#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002137 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138};
2139#endif /* CONFIG_SYSCTL */
2140
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002141struct batched_entropy {
2142 union {
Eric Biggers1ca1b912018-11-16 17:26:21 -08002143 u64 entropy_u64[CHACHA_BLOCK_SIZE / sizeof(u64)];
2144 u32 entropy_u32[CHACHA_BLOCK_SIZE / sizeof(u32)];
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002145 };
2146 unsigned int position;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002147 spinlock_t batch_lock;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002148};
Eric Biggersb1132de2016-05-04 21:08:39 -04002149
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150/*
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002151 * Get a random word for internal kernel use only. The quality of the random
2152 * number is either as good as RDRAND or as good as /dev/urandom, with the
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002153 * goal of being quite fast and not depleting entropy. In order to ensure
2154 * that the randomness provided by this function is okay, the function
2155 * wait_for_random_bytes() should be called and return 0 at least once
2156 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 */
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002158static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64) = {
2159 .batch_lock = __SPIN_LOCK_UNLOCKED(batched_entropy_u64.lock),
2160};
2161
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002162u64 get_random_u64(void)
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002163{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002164 u64 ret;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002165 unsigned long flags;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002166 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002167 static void *previous;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002168
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002169#if BITS_PER_LONG == 64
2170 if (arch_get_random_long((unsigned long *)&ret))
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002171 return ret;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002172#else
2173 if (arch_get_random_long((unsigned long *)&ret) &&
2174 arch_get_random_long((unsigned long *)&ret + 1))
2175 return ret;
2176#endif
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002177
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002178 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002179
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002180 batch = raw_cpu_ptr(&batched_entropy_u64);
2181 spin_lock_irqsave(&batch->batch_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002182 if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
Eric Biggersa5e9f552018-09-11 20:05:10 -07002183 extract_crng((u8 *)batch->entropy_u64);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002184 batch->position = 0;
2185 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002186 ret = batch->entropy_u64[batch->position++];
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002187 spin_unlock_irqrestore(&batch->batch_lock, flags);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002188 return ret;
2189}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002190EXPORT_SYMBOL(get_random_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002191
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002192static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32) = {
2193 .batch_lock = __SPIN_LOCK_UNLOCKED(batched_entropy_u32.lock),
2194};
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002195u32 get_random_u32(void)
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002196{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002197 u32 ret;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002198 unsigned long flags;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002199 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002200 static void *previous;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002201
2202 if (arch_get_random_int(&ret))
2203 return ret;
2204
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002205 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002206
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002207 batch = raw_cpu_ptr(&batched_entropy_u32);
2208 spin_lock_irqsave(&batch->batch_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002209 if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
Eric Biggersa5e9f552018-09-11 20:05:10 -07002210 extract_crng((u8 *)batch->entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002211 batch->position = 0;
2212 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002213 ret = batch->entropy_u32[batch->position++];
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002214 spin_unlock_irqrestore(&batch->batch_lock, flags);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002215 return ret;
2216}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002217EXPORT_SYMBOL(get_random_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002218
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002219/* It's important to invalidate all potential batched entropy that might
2220 * be stored before the crng is initialized, which we can do lazily by
2221 * simply resetting the counter to zero so that it's re-extracted on the
2222 * next usage. */
2223static void invalidate_batched_entropy(void)
2224{
2225 int cpu;
2226 unsigned long flags;
2227
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002228 for_each_possible_cpu (cpu) {
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002229 struct batched_entropy *batched_entropy;
2230
2231 batched_entropy = per_cpu_ptr(&batched_entropy_u32, cpu);
2232 spin_lock_irqsave(&batched_entropy->batch_lock, flags);
2233 batched_entropy->position = 0;
2234 spin_unlock(&batched_entropy->batch_lock);
2235
2236 batched_entropy = per_cpu_ptr(&batched_entropy_u64, cpu);
2237 spin_lock(&batched_entropy->batch_lock);
2238 batched_entropy->position = 0;
2239 spin_unlock_irqrestore(&batched_entropy->batch_lock, flags);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002240 }
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002241}
2242
Jason Cooper99fdafd2016-10-11 13:53:52 -07002243/**
2244 * randomize_page - Generate a random, page aligned address
2245 * @start: The smallest acceptable address the caller will take.
2246 * @range: The size of the area, starting at @start, within which the
2247 * random address must fall.
2248 *
2249 * If @start + @range would overflow, @range is capped.
2250 *
2251 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2252 * @start was already page aligned. We now align it regardless.
2253 *
2254 * Return: A page aligned address within [start, start + range). On error,
2255 * @start is returned.
2256 */
2257unsigned long
2258randomize_page(unsigned long start, unsigned long range)
2259{
2260 if (!PAGE_ALIGNED(start)) {
2261 range -= PAGE_ALIGN(start) - start;
2262 start = PAGE_ALIGN(start);
2263 }
2264
2265 if (start > ULONG_MAX - range)
2266 range = ULONG_MAX - start;
2267
2268 range >>= PAGE_SHIFT;
2269
2270 if (range == 0)
2271 return start;
2272
2273 return start + (get_random_long() % range << PAGE_SHIFT);
2274}
2275
Torsten Duwec84dbf62014-06-14 23:38:36 -04002276/* Interface for in-kernel drivers of true hardware RNGs.
2277 * Those devices may produce endless random bits and will be throttled
2278 * when our pool is full.
2279 */
2280void add_hwgenerator_randomness(const char *buffer, size_t count,
2281 size_t entropy)
2282{
2283 struct entropy_store *poolp = &input_pool;
2284
Theodore Ts'o43838a22018-04-11 13:27:52 -04002285 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04002286 crng_fast_load(buffer, count);
2287 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002288 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002289
2290 /* Suspend writing if we're above the trickle threshold.
2291 * We'll be woken up again once below random_write_wakeup_thresh,
2292 * or when the calling thread is about to terminate.
2293 */
Herbert Xu08e97ae2019-11-17 08:48:17 +08002294 wait_event_interruptible(random_write_wait, kthread_should_stop() ||
Theodore Ts'oe192be92016-06-12 18:13:36 -04002295 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002296 mix_pool_bytes(poolp, buffer, count);
2297 credit_entropy_bits(poolp, entropy);
2298}
2299EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);
Hsin-Yi Wang428826f2019-08-23 14:24:51 +08002300
2301/* Handle random seed passed by bootloader.
2302 * If the seed is trustworthy, it would be regarded as hardware RNGs. Otherwise
2303 * it would be regarded as device data.
2304 * The decision is controlled by CONFIG_RANDOM_TRUST_BOOTLOADER.
2305 */
2306void add_bootloader_randomness(const void *buf, unsigned int size)
2307{
2308 if (IS_ENABLED(CONFIG_RANDOM_TRUST_BOOTLOADER))
2309 add_hwgenerator_randomness(buf, size, size * 8);
2310 else
2311 add_device_randomness(buf, size);
2312}
Borislav Petkov3fd57e72019-10-01 19:50:23 +02002313EXPORT_SYMBOL_GPL(add_bootloader_randomness);