blob: 605969ed0f965c224b3d562ce9dd976a56aab717 [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>
Neil Horman5b739ef2009-06-18 19:50:21 +0800330#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400331#include <linux/ptrace.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400332#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200333#include <linux/irq.h>
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400334#include <linux/ratelimit.h>
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400335#include <linux/syscalls.h>
336#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700337#include <linux/uuid.h>
Eric Biggers1ca1b912018-11-16 17:26:21 -0800338#include <crypto/chacha.h>
Eric Biggersa24d22b2020-11-12 21:20:21 -0800339#include <crypto/sha1.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'oc59974a2013-09-21 19:42:41 -0400503 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000504 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505};
506
Theodore Ts'oe192be92016-06-12 18:13:36 -0400507static ssize_t extract_entropy(struct entropy_store *r, void *buf,
508 size_t nbytes, int min, int rsvd);
509static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
510 size_t nbytes, int fips);
511
512static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
Emese Revfy0766f782016-06-20 20:42:34 +0200513static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
515static struct entropy_store input_pool = {
516 .poolinfo = &poolinfo_table[0],
517 .name = "input",
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200518 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 .pool = input_pool_data
520};
521
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400522static __u32 const twist_table[8] = {
523 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
524 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700527 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700529 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 *
531 * The pool is stirred with a primitive polynomial of the appropriate
532 * degree, and then twisted. We twist by three bits at a time because
533 * it's cheap to do so and helps slightly in the expected case where
534 * the entropy is concentrated in the low-order bits.
535 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400536static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400537 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400539 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700540 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700542 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700543 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 tap1 = r->poolinfo->tap1;
546 tap2 = r->poolinfo->tap2;
547 tap3 = r->poolinfo->tap3;
548 tap4 = r->poolinfo->tap4;
549 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400551 input_rotate = r->input_rotate;
552 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
Matt Mackalle68e5b62008-04-29 01:03:05 -0700554 /* mix one byte at a time to simplify size handling and churn faster */
555 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400556 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700557 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
559 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700560 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 w ^= r->pool[(i + tap1) & wordmask];
562 w ^= r->pool[(i + tap2) & wordmask];
563 w ^= r->pool[(i + tap3) & wordmask];
564 w ^= r->pool[(i + tap4) & wordmask];
565 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700566
567 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700569
570 /*
571 * Normally, we add 7 bits of rotation to the pool.
572 * At the beginning of the pool, add an extra 7 bits
573 * rotation, so that successive passes spread the
574 * input bits across the pool evenly.
575 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400576 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 }
578
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400579 r->input_rotate = input_rotate;
580 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581}
582
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400583static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400584 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400586 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400587 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400588}
589
590static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400591 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400592{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400593 unsigned long flags;
594
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400595 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400596 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400597 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400598 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599}
600
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400601struct fast_pool {
602 __u32 pool[4];
603 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400604 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400605 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400606};
607
608/*
609 * This is a fast mixing routine used by the interrupt randomness
610 * collector. It's hardcoded for an 128 bit pool and assumes that any
611 * locks that might be needed are taken by the caller.
612 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400613static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400614{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400615 __u32 a = f->pool[0], b = f->pool[1];
616 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400617
Theodore Ts'o43759d42014-06-14 21:43:13 -0400618 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500619 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400620 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400621
Theodore Ts'o43759d42014-06-14 21:43:13 -0400622 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500623 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400624 d ^= a; b ^= c;
625
626 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500627 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400628 d ^= a; b ^= c;
629
630 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500631 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400632 d ^= a; b ^= c;
633
634 f->pool[0] = a; f->pool[1] = b;
635 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400636 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400637}
638
Herbert Xu205a5252015-06-09 18:19:39 +0800639static void process_random_ready_list(void)
640{
641 unsigned long flags;
642 struct random_ready_callback *rdy, *tmp;
643
644 spin_lock_irqsave(&random_ready_list_lock, flags);
645 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
646 struct module *owner = rdy->owner;
647
648 list_del_init(&rdy->list);
649 rdy->func(rdy);
650 module_put(owner);
651 }
652 spin_unlock_irqrestore(&random_ready_list_lock, flags);
653}
654
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400656 * Credit (or debit) the entropy store with n bits of entropy.
657 * Use credit_entropy_bits_safe() if the value comes from userspace
658 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700660static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
Eric Biggers118a4412021-03-21 22:14:00 -0700662 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400663 const int pool_size = r->poolinfo->poolfracbits;
664 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Matt Mackalladc782d2008-04-29 01:03:07 -0700666 if (!nbits)
667 return;
668
Theodore Ts'o902c0982012-07-04 10:38:30 -0400669retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -0700670 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400671 if (nfrac < 0) {
672 /* Debit */
673 entropy_count += nfrac;
674 } else {
675 /*
676 * Credit: we have to account for the possibility of
677 * overwriting already present entropy. Even in the
678 * ideal case of pure Shannon entropy, new contributions
679 * approach the full value asymptotically:
680 *
681 * entropy <- entropy + (pool_size - entropy) *
682 * (1 - exp(-add_entropy/pool_size))
683 *
684 * For add_entropy <= pool_size/2 then
685 * (1 - exp(-add_entropy/pool_size)) >=
686 * (add_entropy/pool_size)*0.7869...
687 * so we can approximate the exponential with
688 * 3/4*add_entropy/pool_size and still be on the
689 * safe side by adding at most pool_size/2 at a time.
690 *
691 * The use of pool_size-2 in the while statement is to
692 * prevent rounding artifacts from making the loop
693 * arbitrarily long; this limits the loop to log2(pool_size)*2
694 * turns no matter how large nbits is.
695 */
696 int pnfrac = nfrac;
697 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
698 /* The +2 corresponds to the /4 in the denominator */
699
700 do {
701 unsigned int anfrac = min(pnfrac, pool_size/2);
702 unsigned int add =
703 ((pool_size - entropy_count)*anfrac*3) >> s;
704
705 entropy_count += add;
706 pnfrac -= anfrac;
707 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
708 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400709
Yangtao Li870e05b2020-01-07 16:10:28 -0500710 if (WARN_ON(entropy_count < 0)) {
Yangtao Li12cd53a2019-06-07 14:25:15 -0400711 pr_warn("negative entropy/overflow: pool %s count %d\n",
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400712 r->name, entropy_count);
Andrew Morton8b76f462008-09-02 14:36:14 -0700713 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400714 } else if (entropy_count > pool_size)
715 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400716 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
717 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400719 trace_credit_entropy_bits(r->name, nbits,
Theodore Ts'oeb9d1bf2019-02-20 16:06:38 -0500720 entropy_count >> ENTROPY_SHIFT, _RET_IP_);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400721
Theodore Ts'o6265e162013-10-03 01:08:15 -0400722 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500723 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400724
Eric Biggers118a4412021-03-21 22:14:00 -0700725 if (crng_init < 2 && entropy_bits >= 128)
Theodore Ts'oe192be92016-06-12 18:13:36 -0400726 crng_reseed(&primary_crng, r);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700727 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728}
729
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400730static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400731{
Theodore Ts'o9f886f42017-02-25 18:21:33 -0400732 const int nbits_max = r->poolinfo->poolwords * 32;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400733
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400734 if (nbits < 0)
735 return -EINVAL;
736
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400737 /* Cap the value to avoid overflows */
738 nbits = min(nbits, nbits_max);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400739
740 credit_entropy_bits(r, nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400741 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400742}
743
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744/*********************************************************************
745 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400746 * CRNG using CHACHA20
747 *
748 *********************************************************************/
749
750#define CRNG_RESEED_INTERVAL (300*HZ)
751
752static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
753
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400754#ifdef CONFIG_NUMA
755/*
756 * Hack to deal with crazy userspace progams when they are all trying
757 * to access /dev/urandom in parallel. The programs are almost
758 * certainly doing something terribly wrong, but we'll work around
759 * their brain damage.
760 */
761static struct crng_state **crng_node_pool __read_mostly;
762#endif
763
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400764static void invalidate_batched_entropy(void);
Jon DeVreefe6f1a62019-04-19 23:35:16 -0400765static void numa_crng_init(void);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400766
Kees Cook9b254362018-08-27 14:51:54 -0700767static bool trust_cpu __ro_after_init = IS_ENABLED(CONFIG_RANDOM_TRUST_CPU);
768static int __init parse_trust_cpu(char *arg)
769{
770 return kstrtobool(arg, &trust_cpu);
771}
772early_param("random.trust_cpu", parse_trust_cpu);
773
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000774static bool crng_init_try_arch(struct crng_state *crng)
Theodore Ts'oe192be92016-06-12 18:13:36 -0400775{
776 int i;
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000777 bool arch_init = true;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400778 unsigned long rv;
779
Theodore Ts'oe192be92016-06-12 18:13:36 -0400780 for (i = 4; i < 16; i++) {
781 if (!arch_get_random_seed_long(&rv) &&
Theodore Ts'o39a88832018-07-17 18:24:27 -0400782 !arch_get_random_long(&rv)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400783 rv = random_get_entropy();
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000784 arch_init = false;
Theodore Ts'o39a88832018-07-17 18:24:27 -0400785 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400786 crng->state[i] ^= rv;
787 }
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000788
789 return arch_init;
790}
791
Mark Rutland253d3192020-02-10 13:00:13 +0000792static bool __init crng_init_try_arch_early(struct crng_state *crng)
793{
794 int i;
795 bool arch_init = true;
796 unsigned long rv;
797
798 for (i = 4; i < 16; i++) {
799 if (!arch_get_random_seed_long_early(&rv) &&
800 !arch_get_random_long_early(&rv)) {
801 rv = random_get_entropy();
802 arch_init = false;
803 }
804 crng->state[i] ^= rv;
805 }
806
807 return arch_init;
808}
809
Mark Rutlandab9a7e22020-03-10 12:09:12 +0000810static void __maybe_unused crng_initialize_secondary(struct crng_state *crng)
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000811{
Eric Biggersa181e0f2021-03-21 22:13:47 -0700812 chacha_init_consts(crng->state);
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000813 _get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
814 crng_init_try_arch(crng);
815 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
816}
817
818static void __init crng_initialize_primary(struct crng_state *crng)
819{
Eric Biggersa181e0f2021-03-21 22:13:47 -0700820 chacha_init_consts(crng->state);
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000821 _extract_entropy(&input_pool, &crng->state[4], sizeof(__u32) * 12, 0);
Mark Rutland253d3192020-02-10 13:00:13 +0000822 if (crng_init_try_arch_early(crng) && trust_cpu) {
Jon DeVreefe6f1a62019-04-19 23:35:16 -0400823 invalidate_batched_entropy();
824 numa_crng_init();
Theodore Ts'o39a88832018-07-17 18:24:27 -0400825 crng_init = 2;
Yangtao Li12cd53a2019-06-07 14:25:15 -0400826 pr_notice("crng done (trusting CPU's manufacturer)\n");
Theodore Ts'o39a88832018-07-17 18:24:27 -0400827 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400828 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
829}
830
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400831#ifdef CONFIG_NUMA
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400832static void do_numa_crng_init(struct work_struct *work)
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400833{
834 int i;
835 struct crng_state *crng;
836 struct crng_state **pool;
837
838 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
839 for_each_online_node(i) {
840 crng = kmalloc_node(sizeof(struct crng_state),
841 GFP_KERNEL | __GFP_NOFAIL, i);
842 spin_lock_init(&crng->lock);
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000843 crng_initialize_secondary(crng);
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400844 pool[i] = crng;
845 }
846 mb();
847 if (cmpxchg(&crng_node_pool, NULL, pool)) {
848 for_each_node(i)
849 kfree(pool[i]);
850 kfree(pool);
851 }
852}
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400853
854static DECLARE_WORK(numa_crng_init_work, do_numa_crng_init);
855
856static void numa_crng_init(void)
857{
858 schedule_work(&numa_crng_init_work);
859}
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400860#else
861static void numa_crng_init(void) {}
862#endif
863
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400864/*
865 * crng_fast_load() can be called by code in the interrupt service
866 * path. So we can't afford to dilly-dally.
867 */
Theodore Ts'oe192be92016-06-12 18:13:36 -0400868static int crng_fast_load(const char *cp, size_t len)
869{
870 unsigned long flags;
871 char *p;
872
873 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
874 return 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400875 if (crng_init != 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400876 spin_unlock_irqrestore(&primary_crng.lock, flags);
877 return 0;
878 }
879 p = (unsigned char *) &primary_crng.state[4];
880 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
Eric Biggers1ca1b912018-11-16 17:26:21 -0800881 p[crng_init_cnt % CHACHA_KEY_SIZE] ^= *cp;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400882 cp++; crng_init_cnt++; len--;
883 }
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200884 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400885 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400886 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400887 crng_init = 1;
Yangtao Li12cd53a2019-06-07 14:25:15 -0400888 pr_notice("fast init done\n");
Theodore Ts'oe192be92016-06-12 18:13:36 -0400889 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400890 return 1;
891}
892
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400893/*
894 * crng_slow_load() is called by add_device_randomness, which has two
895 * attributes. (1) We can't trust the buffer passed to it is
896 * guaranteed to be unpredictable (so it might not have any entropy at
897 * all), and (2) it doesn't have the performance constraints of
898 * crng_fast_load().
899 *
900 * So we do something more comprehensive which is guaranteed to touch
901 * all of the primary_crng's state, and which uses a LFSR with a
902 * period of 255 as part of the mixing algorithm. Finally, we do
903 * *not* advance crng_init_cnt since buffer we may get may be something
904 * like a fixed DMI table (for example), which might very well be
905 * unique to the machine, but is otherwise unvarying.
906 */
907static int crng_slow_load(const char *cp, size_t len)
908{
909 unsigned long flags;
910 static unsigned char lfsr = 1;
911 unsigned char tmp;
Eric Biggers1ca1b912018-11-16 17:26:21 -0800912 unsigned i, max = CHACHA_KEY_SIZE;
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400913 const char * src_buf = cp;
914 char * dest_buf = (char *) &primary_crng.state[4];
915
916 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
917 return 0;
918 if (crng_init != 0) {
919 spin_unlock_irqrestore(&primary_crng.lock, flags);
920 return 0;
921 }
922 if (len > max)
923 max = len;
924
925 for (i = 0; i < max ; i++) {
926 tmp = lfsr;
927 lfsr >>= 1;
928 if (tmp & 1)
929 lfsr ^= 0xE1;
Eric Biggers1ca1b912018-11-16 17:26:21 -0800930 tmp = dest_buf[i % CHACHA_KEY_SIZE];
931 dest_buf[i % CHACHA_KEY_SIZE] ^= src_buf[i % len] ^ lfsr;
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400932 lfsr += (tmp << 3) | (tmp >> 5);
933 }
934 spin_unlock_irqrestore(&primary_crng.lock, flags);
935 return 1;
936}
937
Theodore Ts'oe192be92016-06-12 18:13:36 -0400938static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
939{
940 unsigned long flags;
941 int i, num;
942 union {
Eric Biggers1ca1b912018-11-16 17:26:21 -0800943 __u8 block[CHACHA_BLOCK_SIZE];
Theodore Ts'oe192be92016-06-12 18:13:36 -0400944 __u32 key[8];
945 } buf;
946
947 if (r) {
948 num = extract_entropy(r, &buf, 32, 16, 0);
949 if (num == 0)
950 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400951 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400952 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400953 _crng_backtrack_protect(&primary_crng, buf.block,
Eric Biggers1ca1b912018-11-16 17:26:21 -0800954 CHACHA_KEY_SIZE);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400955 }
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400956 spin_lock_irqsave(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400957 for (i = 0; i < 8; i++) {
958 unsigned long rv;
959 if (!arch_get_random_seed_long(&rv) &&
960 !arch_get_random_long(&rv))
961 rv = random_get_entropy();
962 crng->state[i+4] ^= buf.key[i] ^ rv;
963 }
964 memzero_explicit(&buf, sizeof(buf));
965 crng->init_time = jiffies;
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400966 spin_unlock_irqrestore(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400967 if (crng == &primary_crng && crng_init < 2) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400968 invalidate_batched_entropy();
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400969 numa_crng_init();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400970 crng_init = 2;
971 process_random_ready_list();
972 wake_up_interruptible(&crng_init_wait);
Andy Lutomirski30c08ef2019-12-23 00:20:48 -0800973 kill_fasync(&fasync, SIGIO, POLL_IN);
Yangtao Li12cd53a2019-06-07 14:25:15 -0400974 pr_notice("crng init done\n");
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400975 if (unseeded_warning.missed) {
Yangtao Li12cd53a2019-06-07 14:25:15 -0400976 pr_notice("%d get_random_xx warning(s) missed due to ratelimiting\n",
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400977 unseeded_warning.missed);
978 unseeded_warning.missed = 0;
979 }
980 if (urandom_warning.missed) {
Yangtao Li12cd53a2019-06-07 14:25:15 -0400981 pr_notice("%d urandom warning(s) missed due to ratelimiting\n",
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400982 urandom_warning.missed);
983 urandom_warning.missed = 0;
984 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400985 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400986}
987
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400988static void _extract_crng(struct crng_state *crng,
Eric Biggers1ca1b912018-11-16 17:26:21 -0800989 __u8 out[CHACHA_BLOCK_SIZE])
Theodore Ts'oe192be92016-06-12 18:13:36 -0400990{
991 unsigned long v, flags;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400992
Theodore Ts'o43838a22018-04-11 13:27:52 -0400993 if (crng_ready() &&
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400994 (time_after(crng_global_init_time, crng->init_time) ||
995 time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL)))
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400996 crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400997 spin_lock_irqsave(&crng->lock, flags);
998 if (arch_get_random_long(&v))
999 crng->state[14] ^= v;
1000 chacha20_block(&crng->state[0], out);
1001 if (crng->state[12] == 0)
1002 crng->state[13]++;
1003 spin_unlock_irqrestore(&crng->lock, flags);
1004}
1005
Eric Biggers1ca1b912018-11-16 17:26:21 -08001006static void extract_crng(__u8 out[CHACHA_BLOCK_SIZE])
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001007{
1008 struct crng_state *crng = NULL;
1009
1010#ifdef CONFIG_NUMA
1011 if (crng_node_pool)
1012 crng = crng_node_pool[numa_node_id()];
1013 if (crng == NULL)
1014#endif
1015 crng = &primary_crng;
1016 _extract_crng(crng, out);
1017}
1018
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001019/*
1020 * Use the leftover bytes from the CRNG block output (if there is
1021 * enough) to mutate the CRNG key to provide backtracking protection.
1022 */
1023static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers1ca1b912018-11-16 17:26:21 -08001024 __u8 tmp[CHACHA_BLOCK_SIZE], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001025{
1026 unsigned long flags;
1027 __u32 *s, *d;
1028 int i;
1029
1030 used = round_up(used, sizeof(__u32));
Eric Biggers1ca1b912018-11-16 17:26:21 -08001031 if (used + CHACHA_KEY_SIZE > CHACHA_BLOCK_SIZE) {
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001032 extract_crng(tmp);
1033 used = 0;
1034 }
1035 spin_lock_irqsave(&crng->lock, flags);
Eric Biggersa5e9f552018-09-11 20:05:10 -07001036 s = (__u32 *) &tmp[used];
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001037 d = &crng->state[4];
1038 for (i=0; i < 8; i++)
1039 *d++ ^= *s++;
1040 spin_unlock_irqrestore(&crng->lock, flags);
1041}
1042
Eric Biggers1ca1b912018-11-16 17:26:21 -08001043static void crng_backtrack_protect(__u8 tmp[CHACHA_BLOCK_SIZE], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001044{
1045 struct crng_state *crng = NULL;
1046
1047#ifdef CONFIG_NUMA
1048 if (crng_node_pool)
1049 crng = crng_node_pool[numa_node_id()];
1050 if (crng == NULL)
1051#endif
1052 crng = &primary_crng;
1053 _crng_backtrack_protect(crng, tmp, used);
1054}
1055
Theodore Ts'oe192be92016-06-12 18:13:36 -04001056static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
1057{
Eric Biggers1ca1b912018-11-16 17:26:21 -08001058 ssize_t ret = 0, i = CHACHA_BLOCK_SIZE;
1059 __u8 tmp[CHACHA_BLOCK_SIZE] __aligned(4);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001060 int large_request = (nbytes > 256);
1061
1062 while (nbytes) {
1063 if (large_request && need_resched()) {
1064 if (signal_pending(current)) {
1065 if (ret == 0)
1066 ret = -ERESTARTSYS;
1067 break;
1068 }
1069 schedule();
1070 }
1071
1072 extract_crng(tmp);
Eric Biggers1ca1b912018-11-16 17:26:21 -08001073 i = min_t(int, nbytes, CHACHA_BLOCK_SIZE);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001074 if (copy_to_user(buf, tmp, i)) {
1075 ret = -EFAULT;
1076 break;
1077 }
1078
1079 nbytes -= i;
1080 buf += i;
1081 ret += i;
1082 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001083 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001084
1085 /* Wipe data just written to memory */
1086 memzero_explicit(tmp, sizeof(tmp));
1087
1088 return ret;
1089}
1090
1091
1092/*********************************************************************
1093 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 * Entropy input management
1095 *
1096 *********************************************************************/
1097
1098/* There is one of these per entropy source */
1099struct timer_rand_state {
1100 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001101 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102};
1103
Theodore Ts'o644008d2013-11-03 16:40:53 -05001104#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
1105
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001106/*
Theodore Ts'oe192be92016-06-12 18:13:36 -04001107 * Add device- or boot-specific data to the input pool to help
1108 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001109 *
Theodore Ts'oe192be92016-06-12 18:13:36 -04001110 * None of this adds any entropy; it is meant to avoid the problem of
1111 * the entropy pool having similar initial state across largely
1112 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001113 */
1114void add_device_randomness(const void *buf, unsigned int size)
1115{
Theodore Ts'o61875f32013-09-21 13:58:22 -04001116 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001117 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001118
Theodore Ts'odc12baa2018-04-11 14:58:27 -04001119 if (!crng_ready() && size)
1120 crng_slow_load(buf, size);
Kees Cookee7998c2017-07-12 14:34:04 -07001121
Theodore Ts'o59108952013-09-12 14:10:25 -04001122 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001123 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001124 _mix_pool_bytes(&input_pool, buf, size);
1125 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001126 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001127}
1128EXPORT_SYMBOL(add_device_randomness);
1129
Theodore Ts'o644008d2013-11-03 16:40:53 -05001130static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001131
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132/*
1133 * This function adds entropy to the entropy "pool" by using timing
1134 * delays. It uses the timer_rand_state structure to make an estimate
1135 * of how many bits of entropy this call has added to the pool.
1136 *
1137 * The number "num" is also added to the pool - it should somehow describe
1138 * the type of event which just happened. This is currently 0-255 for
1139 * keyboard scan codes, and 256 upwards for interrupts.
1140 *
1141 */
1142static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1143{
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001144 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -08001147 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 unsigned num;
1149 } sample;
1150 long delta, delta2, delta3;
1151
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001153 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 sample.num = num;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001155 r = &input_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001156 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
1158 /*
1159 * Calculate number of bits of randomness we probably added.
1160 * We take into account the first, second and third-order deltas
1161 * in order to make our estimate.
1162 */
Qian Caie00d996a2020-02-25 11:27:04 -05001163 delta = sample.jiffies - READ_ONCE(state->last_time);
1164 WRITE_ONCE(state->last_time, sample.jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
Qian Caie00d996a2020-02-25 11:27:04 -05001166 delta2 = delta - READ_ONCE(state->last_delta);
1167 WRITE_ONCE(state->last_delta, delta);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168
Qian Caie00d996a2020-02-25 11:27:04 -05001169 delta3 = delta2 - READ_ONCE(state->last_delta2);
1170 WRITE_ONCE(state->last_delta2, delta2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001172 if (delta < 0)
1173 delta = -delta;
1174 if (delta2 < 0)
1175 delta2 = -delta2;
1176 if (delta3 < 0)
1177 delta3 = -delta3;
1178 if (delta > delta2)
1179 delta = delta2;
1180 if (delta > delta3)
1181 delta = delta3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001183 /*
1184 * delta is now minimum absolute delta.
1185 * Round down by 1 bit on general principles,
Yangtao Li727d4992020-01-07 16:55:34 -05001186 * and limit entropy estimate to 12 bits.
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001187 */
1188 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189}
1190
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001191void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 unsigned int value)
1193{
1194 static unsigned char last_value;
1195
1196 /* ignore autorepeat and the like */
1197 if (value == last_value)
1198 return;
1199
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 last_value = value;
1201 add_timer_randomness(&input_timer_state,
1202 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001203 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001205EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001207static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1208
Theodore Ts'o43759d42014-06-14 21:43:13 -04001209#ifdef ADD_INTERRUPT_BENCH
1210static unsigned long avg_cycles, avg_deviation;
1211
1212#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1213#define FIXED_1_2 (1 << (AVG_SHIFT-1))
1214
1215static void add_interrupt_bench(cycles_t start)
1216{
1217 long delta = random_get_entropy() - start;
1218
1219 /* Use a weighted moving average */
1220 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1221 avg_cycles += delta;
1222 /* And average deviation */
1223 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1224 avg_deviation += delta;
1225}
1226#else
1227#define add_interrupt_bench(x)
1228#endif
1229
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001230static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
1231{
1232 __u32 *ptr = (__u32 *) regs;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001233 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001234
1235 if (regs == NULL)
1236 return 0;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001237 idx = READ_ONCE(f->reg_idx);
1238 if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
1239 idx = 0;
1240 ptr += idx++;
1241 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitz9dfa7bb2017-04-30 19:49:21 +12001242 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001243}
1244
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001245void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246{
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001247 struct entropy_store *r;
Christoph Lameter1b2a1a72014-08-17 12:30:29 -05001248 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001249 struct pt_regs *regs = get_irq_regs();
1250 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001251 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -04001252 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001253 __u64 ip;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001254
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001255 if (cycles == 0)
1256 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001257 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1258 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001259 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1260 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001261 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001262 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001263 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
1264 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001265
Theodore Ts'o43759d42014-06-14 21:43:13 -04001266 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001267 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001268
Theodore Ts'o43838a22018-04-11 13:27:52 -04001269 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001270 if ((fast_pool->count >= 64) &&
1271 crng_fast_load((char *) fast_pool->pool,
1272 sizeof(fast_pool->pool))) {
1273 fast_pool->count = 0;
1274 fast_pool->last = now;
1275 }
1276 return;
1277 }
1278
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001279 if ((fast_pool->count < 64) &&
1280 !time_after(now, fast_pool->last + HZ))
1281 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Theodore Ts'oe192be92016-06-12 18:13:36 -04001283 r = &input_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001284 if (!spin_trylock(&r->lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 return;
1286
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001287 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001288 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001289 spin_unlock(&r->lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001290
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001291 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001292
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001293 /* award one bit for the contents of the fast pool */
Ard Biesheuvel390596c2020-11-05 16:29:44 +01001294 credit_entropy_bits(r, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001296EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297
David Howells93614012006-09-30 20:45:40 +02001298#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299void add_disk_randomness(struct gendisk *disk)
1300{
1301 if (!disk || !disk->random)
1302 return;
1303 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001304 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001305 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001307EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001308#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310/*********************************************************************
1311 *
1312 * Entropy extraction routines
1313 *
1314 *********************************************************************/
1315
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316/*
Greg Price19fa5be12013-11-29 15:50:06 -05001317 * This function decides how many bytes to actually take from the
1318 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320static size_t account(struct entropy_store *r, size_t nbytes, int min,
1321 int reserved)
1322{
Stephan Müller43d8a722016-12-27 23:40:59 +01001323 int entropy_count, orig, have_bytes;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001324 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001326 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327
1328 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001329retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -07001330 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001331 ibytes = nbytes;
Stephan Müller43d8a722016-12-27 23:40:59 +01001332 /* never pull more than available */
1333 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001334
Stephan Müller43d8a722016-12-27 23:40:59 +01001335 if ((have_bytes -= reserved) < 0)
1336 have_bytes = 0;
1337 ibytes = min_t(size_t, ibytes, have_bytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001338 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001339 ibytes = 0;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001340
Yangtao Li870e05b2020-01-07 16:10:28 -05001341 if (WARN_ON(entropy_count < 0)) {
Yangtao Li12cd53a2019-06-07 14:25:15 -04001342 pr_warn("negative entropy count: pool %s count %d\n",
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001343 r->name, entropy_count);
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001344 entropy_count = 0;
1345 }
1346 nfrac = ibytes << (ENTROPY_SHIFT + 3);
1347 if ((size_t) entropy_count > nfrac)
1348 entropy_count -= nfrac;
1349 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001350 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001351
Greg Price0fb7a012013-12-05 19:32:19 -05001352 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1353 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001355 trace_debit_entropy(r->name, 8 * ibytes);
Yangtao Li12faac32019-06-07 14:25:14 -04001356 if (ibytes && ENTROPY_BITS(r) < random_write_wakeup_bits) {
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001357 wake_up_interruptible(&random_write_wait);
Theodore Ts'ob9809552013-03-04 11:59:12 -05001358 kill_fasync(&fasync, SIGIO, POLL_OUT);
1359 }
1360
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001361 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
1363
Greg Price19fa5be12013-11-29 15:50:06 -05001364/*
Eric Biggers118a4412021-03-21 22:14:00 -07001365 * This function does the actual extraction for extract_entropy.
Greg Price19fa5be12013-11-29 15:50:06 -05001366 *
1367 * Note: we assume that .poolwords is a multiple of 16 words.
1368 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369static void extract_buf(struct entropy_store *r, __u8 *out)
1370{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001371 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001372 union {
1373 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001374 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001375 } hash;
Eric Biggers6b0b0fa2020-05-02 11:24:25 -07001376 __u32 workspace[SHA1_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001377 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001380 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001381 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001382 */
Eric Biggers6b0b0fa2020-05-02 11:24:25 -07001383 sha1_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001384 for (i = 0; i < LONGS(20); i++) {
1385 unsigned long v;
1386 if (!arch_get_random_long(&v))
1387 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001388 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001389 }
1390
Theodore Ts'o46884442013-12-17 21:16:39 -05001391 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1392 spin_lock_irqsave(&r->lock, flags);
1393 for (i = 0; i < r->poolinfo->poolwords; i += 16)
Eric Biggers6b0b0fa2020-05-02 11:24:25 -07001394 sha1_transform(hash.w, (__u8 *)(r->pool + i), workspace);
Theodore Ts'o46884442013-12-17 21:16:39 -05001395
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001396 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001397 * We mix the hash back into the pool to prevent backtracking
1398 * attacks (where the attacker knows the state of the pool
1399 * plus the current outputs, and attempts to find previous
1400 * ouputs), unless the hash function can be inverted. By
1401 * mixing at least a SHA1 worth of hash data back, we make
1402 * brute-forcing the feedback as hard as brute-forcing the
1403 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001405 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001406 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001407
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001408 memzero_explicit(workspace, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409
1410 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001411 * In case the hash function has some recognizable output
1412 * pattern, we fold it in half. Thus, we always feed back
1413 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001415 hash.w[0] ^= hash.w[3];
1416 hash.w[1] ^= hash.w[4];
1417 hash.w[2] ^= rol32(hash.w[2], 16);
1418
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001419 memcpy(out, &hash, EXTRACT_SIZE);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001420 memzero_explicit(&hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421}
1422
Theodore Ts'oe192be92016-06-12 18:13:36 -04001423static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
1424 size_t nbytes, int fips)
1425{
1426 ssize_t ret = 0, i;
1427 __u8 tmp[EXTRACT_SIZE];
1428 unsigned long flags;
1429
1430 while (nbytes) {
1431 extract_buf(r, tmp);
1432
1433 if (fips) {
1434 spin_lock_irqsave(&r->lock, flags);
1435 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1436 panic("Hardware RNG duplicated output!\n");
1437 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1438 spin_unlock_irqrestore(&r->lock, flags);
1439 }
1440 i = min_t(int, nbytes, EXTRACT_SIZE);
1441 memcpy(buf, tmp, i);
1442 nbytes -= i;
1443 buf += i;
1444 ret += i;
1445 }
1446
1447 /* Wipe data just returned from memory */
1448 memzero_explicit(tmp, sizeof(tmp));
1449
1450 return ret;
1451}
1452
Greg Price19fa5be12013-11-29 15:50:06 -05001453/*
1454 * This function extracts randomness from the "entropy pool", and
1455 * returns it in a buffer.
1456 *
1457 * The min parameter specifies the minimum amount we can pull before
1458 * failing to avoid races that defeat catastrophic reseeding while the
1459 * reserved parameter indicates how much entropy we must leave in the
1460 * pool after each pull to avoid starving other readers.
1461 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001462static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001463 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001466 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001468 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001469 if (fips_enabled) {
1470 spin_lock_irqsave(&r->lock, flags);
1471 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001472 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001473 spin_unlock_irqrestore(&r->lock, flags);
1474 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001475 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001476 extract_buf(r, tmp);
1477 spin_lock_irqsave(&r->lock, flags);
1478 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1479 }
1480 spin_unlock_irqrestore(&r->lock, flags);
1481 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001482
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001483 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 nbytes = account(r, nbytes, min, reserved);
1485
Theodore Ts'oe192be92016-06-12 18:13:36 -04001486 return _extract_entropy(r, buf, nbytes, fips_enabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487}
1488
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001489#define warn_unseeded_randomness(previous) \
1490 _warn_unseeded_randomness(__func__, (void *) _RET_IP_, (previous))
1491
1492static void _warn_unseeded_randomness(const char *func_name, void *caller,
1493 void **previous)
1494{
1495#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1496 const bool print_once = false;
1497#else
1498 static bool print_once __read_mostly;
1499#endif
1500
1501 if (print_once ||
1502 crng_ready() ||
1503 (previous && (caller == READ_ONCE(*previous))))
1504 return;
1505 WRITE_ONCE(*previous, caller);
1506#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1507 print_once = true;
1508#endif
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001509 if (__ratelimit(&unseeded_warning))
Sergey Senozhatsky1b710b12019-11-13 16:16:25 -05001510 printk_deferred(KERN_NOTICE "random: %s called from %pS "
1511 "with crng_init=%d\n", func_name, caller,
1512 crng_init);
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001513}
1514
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515/*
1516 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001517 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001518 * TCP sequence numbers, etc. It does not rely on the hardware random
1519 * number generator. For random bytes direct from the hardware RNG
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001520 * (when available), use get_random_bytes_arch(). In order to ensure
1521 * that the randomness provided by this function is okay, the function
1522 * wait_for_random_bytes() should be called and return 0 at least once
1523 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 */
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001525static void _get_random_bytes(void *buf, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526{
Eric Biggers1ca1b912018-11-16 17:26:21 -08001527 __u8 tmp[CHACHA_BLOCK_SIZE] __aligned(4);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001528
Theodore Ts'o59108952013-09-12 14:10:25 -04001529 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001530
Eric Biggers1ca1b912018-11-16 17:26:21 -08001531 while (nbytes >= CHACHA_BLOCK_SIZE) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001532 extract_crng(buf);
Eric Biggers1ca1b912018-11-16 17:26:21 -08001533 buf += CHACHA_BLOCK_SIZE;
1534 nbytes -= CHACHA_BLOCK_SIZE;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001535 }
1536
1537 if (nbytes > 0) {
1538 extract_crng(tmp);
1539 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001540 crng_backtrack_protect(tmp, nbytes);
1541 } else
Eric Biggers1ca1b912018-11-16 17:26:21 -08001542 crng_backtrack_protect(tmp, CHACHA_BLOCK_SIZE);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001543 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001544}
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001545
1546void get_random_bytes(void *buf, int nbytes)
1547{
1548 static void *previous;
1549
1550 warn_unseeded_randomness(&previous);
1551 _get_random_bytes(buf, nbytes);
1552}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001553EXPORT_SYMBOL(get_random_bytes);
1554
Linus Torvalds50ee7522019-09-28 16:53:52 -07001555
1556/*
1557 * Each time the timer fires, we expect that we got an unpredictable
1558 * jump in the cycle counter. Even if the timer is running on another
1559 * CPU, the timer activity will be touching the stack of the CPU that is
1560 * generating entropy..
1561 *
1562 * Note that we don't re-arm the timer in the timer itself - we are
1563 * happy to be scheduled away, since that just makes the load more
1564 * complex, but we do not want the timer to keep ticking unless the
1565 * entropy loop is running.
1566 *
1567 * So the re-arming always happens in the entropy loop itself.
1568 */
1569static void entropy_timer(struct timer_list *t)
1570{
1571 credit_entropy_bits(&input_pool, 1);
1572}
1573
1574/*
1575 * If we have an actual cycle counter, see if we can
1576 * generate enough entropy with timing noise
1577 */
1578static void try_to_generate_entropy(void)
1579{
1580 struct {
1581 unsigned long now;
1582 struct timer_list timer;
1583 } stack;
1584
1585 stack.now = random_get_entropy();
1586
1587 /* Slow counter - or none. Don't even bother */
1588 if (stack.now == random_get_entropy())
1589 return;
1590
1591 timer_setup_on_stack(&stack.timer, entropy_timer, 0);
1592 while (!crng_ready()) {
1593 if (!timer_pending(&stack.timer))
1594 mod_timer(&stack.timer, jiffies+1);
1595 mix_pool_bytes(&input_pool, &stack.now, sizeof(stack.now));
1596 schedule();
1597 stack.now = random_get_entropy();
1598 }
1599
1600 del_timer_sync(&stack.timer);
1601 destroy_timer_on_stack(&stack.timer);
1602 mix_pool_bytes(&input_pool, &stack.now, sizeof(stack.now));
1603}
1604
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001605/*
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001606 * Wait for the urandom pool to be seeded and thus guaranteed to supply
1607 * cryptographically secure random numbers. This applies to: the /dev/urandom
1608 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
1609 * family of functions. Using any of these functions without first calling
1610 * this function forfeits the guarantee of security.
1611 *
1612 * Returns: 0 if the urandom pool has been seeded.
1613 * -ERESTARTSYS if the function was interrupted by a signal.
1614 */
1615int wait_for_random_bytes(void)
1616{
1617 if (likely(crng_ready()))
1618 return 0;
Linus Torvalds50ee7522019-09-28 16:53:52 -07001619
1620 do {
1621 int ret;
1622 ret = wait_event_interruptible_timeout(crng_init_wait, crng_ready(), HZ);
1623 if (ret)
1624 return ret > 0 ? 0 : ret;
1625
1626 try_to_generate_entropy();
1627 } while (!crng_ready());
1628
1629 return 0;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001630}
1631EXPORT_SYMBOL(wait_for_random_bytes);
1632
1633/*
Jason A. Donenfeld9a472492018-07-31 21:11:00 +02001634 * Returns whether or not the urandom pool has been seeded and thus guaranteed
1635 * to supply cryptographically secure random numbers. This applies to: the
1636 * /dev/urandom device, the get_random_bytes function, and the get_random_{u32,
1637 * ,u64,int,long} family of functions.
1638 *
1639 * Returns: true if the urandom pool has been seeded.
1640 * false if the urandom pool has not been seeded.
1641 */
1642bool rng_is_initialized(void)
1643{
1644 return crng_ready();
1645}
1646EXPORT_SYMBOL(rng_is_initialized);
1647
1648/*
Herbert Xu205a5252015-06-09 18:19:39 +08001649 * Add a callback function that will be invoked when the nonblocking
1650 * pool is initialised.
1651 *
1652 * returns: 0 if callback is successfully added
1653 * -EALREADY if pool is already initialised (callback not called)
1654 * -ENOENT if module for callback is not alive
1655 */
1656int add_random_ready_callback(struct random_ready_callback *rdy)
1657{
1658 struct module *owner;
1659 unsigned long flags;
1660 int err = -EALREADY;
1661
Theodore Ts'oe192be92016-06-12 18:13:36 -04001662 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001663 return err;
1664
1665 owner = rdy->owner;
1666 if (!try_module_get(owner))
1667 return -ENOENT;
1668
1669 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001670 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001671 goto out;
1672
1673 owner = NULL;
1674
1675 list_add(&rdy->list, &random_ready_list);
1676 err = 0;
1677
1678out:
1679 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1680
1681 module_put(owner);
1682
1683 return err;
1684}
1685EXPORT_SYMBOL(add_random_ready_callback);
1686
1687/*
1688 * Delete a previously registered readiness callback function.
1689 */
1690void del_random_ready_callback(struct random_ready_callback *rdy)
1691{
1692 unsigned long flags;
1693 struct module *owner = NULL;
1694
1695 spin_lock_irqsave(&random_ready_list_lock, flags);
1696 if (!list_empty(&rdy->list)) {
1697 list_del_init(&rdy->list);
1698 owner = rdy->owner;
1699 }
1700 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1701
1702 module_put(owner);
1703}
1704EXPORT_SYMBOL(del_random_ready_callback);
1705
1706/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001707 * This function will use the architecture-specific hardware random
1708 * number generator if it is available. The arch-specific hw RNG will
1709 * almost certainly be faster than what we can do in software, but it
1710 * is impossible to verify that it is implemented securely (as
1711 * opposed, to, say, the AES encryption of a sequence number using a
1712 * key known by the NSA). So it's useful if we need the speed, but
1713 * only if we're willing to trust the hardware manufacturer not to
1714 * have put in a back door.
Tobin C. Harding753d4332018-06-22 09:15:32 +10001715 *
1716 * Return number of bytes filled in.
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001717 */
Tobin C. Harding753d4332018-06-22 09:15:32 +10001718int __must_check get_random_bytes_arch(void *buf, int nbytes)
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001719{
Tobin C. Harding753d4332018-06-22 09:15:32 +10001720 int left = nbytes;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001721 char *p = buf;
1722
Tobin C. Harding753d4332018-06-22 09:15:32 +10001723 trace_get_random_bytes_arch(left, _RET_IP_);
1724 while (left) {
H. Peter Anvin63d77172011-07-31 13:54:50 -07001725 unsigned long v;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001726 int chunk = min_t(int, left, sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001727
H. Peter Anvin63d77172011-07-31 13:54:50 -07001728 if (!arch_get_random_long(&v))
1729 break;
Tobin C. Harding8ddd6ef2018-06-22 09:15:31 +10001730
Luck, Tonybd29e562011-11-16 10:50:56 -08001731 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001732 p += chunk;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001733 left -= chunk;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001734 }
1735
Tobin C. Harding753d4332018-06-22 09:15:32 +10001736 return nbytes - left;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001738EXPORT_SYMBOL(get_random_bytes_arch);
1739
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740/*
1741 * init_std_data - initialize pool with system data
1742 *
1743 * @r: pool to initialize
1744 *
1745 * This function clears the pool's entropy count and mixes some system
1746 * data into the pool to prepare it for use. The pool is not cleared
1747 * as that can only decrease the entropy in the pool.
1748 */
Kees Cookd5553522019-04-19 23:27:05 -04001749static void __init init_std_data(struct entropy_store *r)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001751 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001752 ktime_t now = ktime_get_real();
1753 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754
Theodore Ts'o85608f82014-06-10 23:09:20 -04001755 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001756 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001757 if (!arch_get_random_seed_long(&rv) &&
1758 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001759 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001760 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001761 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001762 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763}
1764
Tony Luckcbc96b72012-07-23 09:47:57 -07001765/*
1766 * Note that setup_arch() may call add_device_randomness()
1767 * long before we get here. This allows seeding of the pools
1768 * with some platform dependent data very early in the boot
1769 * process. But it limits our options here. We must use
1770 * statically allocated structures that already have all
1771 * initializations complete at compile time. We should also
1772 * take care not to overwrite the precious per platform data
1773 * we were given.
1774 */
Kees Cookd5553522019-04-19 23:27:05 -04001775int __init rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776{
1777 init_std_data(&input_pool);
Mark Rutland5cbe0f12020-02-10 13:00:12 +00001778 crng_initialize_primary(&primary_crng);
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001779 crng_global_init_time = jiffies;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001780 if (ratelimit_disable) {
1781 urandom_warning.interval = 0;
1782 unseeded_warning.interval = 0;
1783 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 return 0;
1785}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
David Howells93614012006-09-30 20:45:40 +02001787#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788void rand_initialize_disk(struct gendisk *disk)
1789{
1790 struct timer_rand_state *state;
1791
1792 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001793 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 * source.
1795 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001796 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001797 if (state) {
1798 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001800 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801}
David Howells93614012006-09-30 20:45:40 +02001802#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803
1804static ssize_t
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08001805urandom_read_nowarn(struct file *file, char __user *buf, size_t nbytes,
1806 loff_t *ppos)
1807{
1808 int ret;
1809
1810 nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
1811 ret = extract_crng_user(buf, nbytes);
1812 trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
1813 return ret;
1814}
1815
1816static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001817urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001819 unsigned long flags;
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001820 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05001821
Theodore Ts'oe192be92016-06-12 18:13:36 -04001822 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001823 maxwarn--;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001824 if (__ratelimit(&urandom_warning))
Yangtao Li12cd53a2019-06-07 14:25:15 -04001825 pr_notice("%s: uninitialized urandom read (%zd bytes read)\n",
1826 current->comm, nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001827 spin_lock_irqsave(&primary_crng.lock, flags);
1828 crng_init_cnt = 0;
1829 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001830 }
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08001831
1832 return urandom_read_nowarn(file, buf, nbytes, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833}
1834
Andy Lutomirski30c08ef2019-12-23 00:20:48 -08001835static ssize_t
1836random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1837{
1838 int ret;
1839
1840 ret = wait_for_random_bytes();
1841 if (ret != 0)
1842 return ret;
1843 return urandom_read_nowarn(file, buf, nbytes, ppos);
1844}
1845
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001846static __poll_t
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001847random_poll(struct file *file, poll_table * wait)
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001848{
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001849 __poll_t mask;
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001850
Andy Lutomirski30c08ef2019-12-23 00:20:48 -08001851 poll_wait(file, &crng_init_wait, wait);
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001852 poll_wait(file, &random_write_wait, wait);
1853 mask = 0;
Andy Lutomirski30c08ef2019-12-23 00:20:48 -08001854 if (crng_ready())
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001855 mask |= EPOLLIN | EPOLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05001856 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001857 mask |= EPOLLOUT | EPOLLWRNORM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 return mask;
1859}
1860
Matt Mackall7f397dc2007-05-29 21:58:10 -05001861static int
1862write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1863{
1864 size_t bytes;
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001865 __u32 t, buf[16];
Matt Mackall7f397dc2007-05-29 21:58:10 -05001866 const char __user *p = buffer;
1867
1868 while (count > 0) {
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001869 int b, i = 0;
1870
Matt Mackall7f397dc2007-05-29 21:58:10 -05001871 bytes = min(count, sizeof(buf));
1872 if (copy_from_user(&buf, p, bytes))
1873 return -EFAULT;
1874
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001875 for (b = bytes ; b > 0 ; b -= sizeof(__u32), i++) {
1876 if (!arch_get_random_int(&t))
1877 break;
1878 buf[i] ^= t;
1879 }
1880
Matt Mackall7f397dc2007-05-29 21:58:10 -05001881 count -= bytes;
1882 p += bytes;
1883
Theodore Ts'o85608f82014-06-10 23:09:20 -04001884 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001885 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001886 }
1887
1888 return 0;
1889}
1890
Matt Mackall90b75ee2008-04-29 01:02:55 -07001891static ssize_t random_write(struct file *file, const char __user *buffer,
1892 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001894 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895
Theodore Ts'oe192be92016-06-12 18:13:36 -04001896 ret = write_pool(&input_pool, buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05001897 if (ret)
1898 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899
Matt Mackall7f397dc2007-05-29 21:58:10 -05001900 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901}
1902
Matt Mackall43ae4862008-04-29 01:02:58 -07001903static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904{
1905 int size, ent_count;
1906 int __user *p = (int __user *)arg;
1907 int retval;
1908
1909 switch (cmd) {
1910 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001911 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001912 ent_count = ENTROPY_BITS(&input_pool);
1913 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 return -EFAULT;
1915 return 0;
1916 case RNDADDTOENTCNT:
1917 if (!capable(CAP_SYS_ADMIN))
1918 return -EPERM;
1919 if (get_user(ent_count, p))
1920 return -EFAULT;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001921 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 case RNDADDENTROPY:
1923 if (!capable(CAP_SYS_ADMIN))
1924 return -EPERM;
1925 if (get_user(ent_count, p++))
1926 return -EFAULT;
1927 if (ent_count < 0)
1928 return -EINVAL;
1929 if (get_user(size, p++))
1930 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001931 retval = write_pool(&input_pool, (const char __user *)p,
1932 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 if (retval < 0)
1934 return retval;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001935 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 case RNDZAPENTCNT:
1937 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001938 /*
1939 * Clear the entropy pool counters. We no longer clear
1940 * the entropy pool, as that's silly.
1941 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 if (!capable(CAP_SYS_ADMIN))
1943 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001944 input_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 return 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001946 case RNDRESEEDCRNG:
1947 if (!capable(CAP_SYS_ADMIN))
1948 return -EPERM;
1949 if (crng_init < 2)
1950 return -ENODATA;
Eric Biggers11a0b5e2021-01-12 11:28:18 -08001951 crng_reseed(&primary_crng, &input_pool);
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001952 crng_global_init_time = jiffies - 1;
1953 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 default:
1955 return -EINVAL;
1956 }
1957}
1958
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001959static int random_fasync(int fd, struct file *filp, int on)
1960{
1961 return fasync_helper(fd, filp, on, &fasync);
1962}
1963
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001964const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 .read = random_read,
1966 .write = random_write,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001967 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001968 .unlocked_ioctl = random_ioctl,
Arnd Bergmann507e4e22018-09-07 11:10:23 +02001969 .compat_ioctl = compat_ptr_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001970 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001971 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972};
1973
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001974const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 .read = urandom_read,
1976 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001977 .unlocked_ioctl = random_ioctl,
Jason A. Donenfeld4aa37c42019-12-17 18:24:55 +01001978 .compat_ioctl = compat_ptr_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001979 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001980 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981};
1982
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001983SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
1984 unsigned int, flags)
1985{
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001986 int ret;
1987
Andy Lutomirski75551db2019-12-23 00:20:46 -08001988 if (flags & ~(GRND_NONBLOCK|GRND_RANDOM|GRND_INSECURE))
1989 return -EINVAL;
1990
1991 /*
1992 * Requesting insecure and blocking randomness at the same time makes
1993 * no sense.
1994 */
1995 if ((flags & (GRND_INSECURE|GRND_RANDOM)) == (GRND_INSECURE|GRND_RANDOM))
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001996 return -EINVAL;
1997
1998 if (count > INT_MAX)
1999 count = INT_MAX;
2000
Andy Lutomirski75551db2019-12-23 00:20:46 -08002001 if (!(flags & GRND_INSECURE) && !crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002002 if (flags & GRND_NONBLOCK)
2003 return -EAGAIN;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002004 ret = wait_for_random_bytes();
2005 if (unlikely(ret))
2006 return ret;
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002007 }
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08002008 return urandom_read_nowarn(NULL, buf, count, NULL);
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002009}
2010
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011/********************************************************************
2012 *
2013 * Sysctl interface
2014 *
2015 ********************************************************************/
2016
2017#ifdef CONFIG_SYSCTL
2018
2019#include <linux/sysctl.h>
2020
Andy Lutomirskic95ea0c2019-12-23 00:20:51 -08002021static int min_write_thresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022static int max_write_thresh = INPUT_POOL_WORDS * 32;
Fabio Estevamdb61ffe2017-01-31 14:36:07 -02002023static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024static char sysctl_bootid[16];
2025
2026/*
Greg Pricef22052b2013-11-29 14:58:16 -05002027 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 * UUID. The difference is in whether table->data is NULL; if it is,
2029 * then a new UUID is generated and returned to the user.
2030 *
Greg Pricef22052b2013-11-29 14:58:16 -05002031 * If the user accesses this via the proc interface, the UUID will be
2032 * returned as an ASCII string in the standard UUID format; if via the
2033 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 */
Joe Perchesa1514272013-06-13 19:37:35 -07002035static int proc_do_uuid(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +02002036 void *buffer, size_t *lenp, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037{
Joe Perchesa1514272013-06-13 19:37:35 -07002038 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 unsigned char buf[64], tmp_uuid[16], *uuid;
2040
2041 uuid = table->data;
2042 if (!uuid) {
2043 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07002045 } else {
2046 static DEFINE_SPINLOCK(bootid_spinlock);
2047
2048 spin_lock(&bootid_spinlock);
2049 if (!uuid[8])
2050 generate_random_uuid(uuid);
2051 spin_unlock(&bootid_spinlock);
2052 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053
Joe Perches35900772009-12-14 18:01:11 -08002054 sprintf(buf, "%pU", uuid);
2055
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 fake_table.data = buf;
2057 fake_table.maxlen = sizeof(buf);
2058
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002059 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060}
2061
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002062/*
2063 * Return entropy available scaled to integral bits
2064 */
Joe Perches5eb10d92014-06-06 14:37:58 -07002065static int proc_do_entropy(struct ctl_table *table, int write,
Christoph Hellwiga2541dc2020-06-03 07:52:36 +02002066 void *buffer, size_t *lenp, loff_t *ppos)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002067{
Joe Perches5eb10d92014-06-06 14:37:58 -07002068 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002069 int entropy_count;
2070
2071 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
2072
2073 fake_table.data = &entropy_count;
2074 fake_table.maxlen = sizeof(entropy_count);
2075
2076 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
2077}
2078
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07002080extern struct ctl_table random_table[];
2081struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 .procname = "poolsize",
2084 .data = &sysctl_poolsize,
2085 .maxlen = sizeof(int),
2086 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002087 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 },
2089 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 .procname = "entropy_avail",
2091 .maxlen = sizeof(int),
2092 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002093 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 .data = &input_pool.entropy_count,
2095 },
2096 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002098 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 .maxlen = sizeof(int),
2100 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002101 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 .extra1 = &min_write_thresh,
2103 .extra2 = &max_write_thresh,
2104 },
2105 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002106 .procname = "urandom_min_reseed_secs",
2107 .data = &random_min_urandom_seed,
2108 .maxlen = sizeof(int),
2109 .mode = 0644,
2110 .proc_handler = proc_dointvec,
2111 },
2112 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 .procname = "boot_id",
2114 .data = &sysctl_bootid,
2115 .maxlen = 16,
2116 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002117 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 },
2119 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 .procname = "uuid",
2121 .maxlen = 16,
2122 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002123 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002125#ifdef ADD_INTERRUPT_BENCH
2126 {
2127 .procname = "add_interrupt_avg_cycles",
2128 .data = &avg_cycles,
2129 .maxlen = sizeof(avg_cycles),
2130 .mode = 0444,
2131 .proc_handler = proc_doulongvec_minmax,
2132 },
2133 {
2134 .procname = "add_interrupt_avg_deviation",
2135 .data = &avg_deviation,
2136 .maxlen = sizeof(avg_deviation),
2137 .mode = 0444,
2138 .proc_handler = proc_doulongvec_minmax,
2139 },
2140#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002141 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142};
2143#endif /* CONFIG_SYSCTL */
2144
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002145struct batched_entropy {
2146 union {
Eric Biggers1ca1b912018-11-16 17:26:21 -08002147 u64 entropy_u64[CHACHA_BLOCK_SIZE / sizeof(u64)];
2148 u32 entropy_u32[CHACHA_BLOCK_SIZE / sizeof(u32)];
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002149 };
2150 unsigned int position;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002151 spinlock_t batch_lock;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002152};
Eric Biggersb1132de2016-05-04 21:08:39 -04002153
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154/*
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002155 * Get a random word for internal kernel use only. The quality of the random
Jason A. Donenfeld69efea72020-02-21 21:10:37 +01002156 * number is good as /dev/urandom, but there is no backtrack protection, with
2157 * the goal of being quite fast and not depleting entropy. In order to ensure
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002158 * that the randomness provided by this function is okay, the function
Jason A. Donenfeld69efea72020-02-21 21:10:37 +01002159 * wait_for_random_bytes() should be called and return 0 at least once at any
2160 * point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 */
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002162static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64) = {
2163 .batch_lock = __SPIN_LOCK_UNLOCKED(batched_entropy_u64.lock),
2164};
2165
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002166u64 get_random_u64(void)
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002167{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002168 u64 ret;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002169 unsigned long flags;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002170 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002171 static void *previous;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002172
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002173 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002174
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002175 batch = raw_cpu_ptr(&batched_entropy_u64);
2176 spin_lock_irqsave(&batch->batch_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002177 if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
Eric Biggersa5e9f552018-09-11 20:05:10 -07002178 extract_crng((u8 *)batch->entropy_u64);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002179 batch->position = 0;
2180 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002181 ret = batch->entropy_u64[batch->position++];
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002182 spin_unlock_irqrestore(&batch->batch_lock, flags);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002183 return ret;
2184}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002185EXPORT_SYMBOL(get_random_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002186
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002187static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32) = {
2188 .batch_lock = __SPIN_LOCK_UNLOCKED(batched_entropy_u32.lock),
2189};
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002190u32 get_random_u32(void)
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002191{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002192 u32 ret;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002193 unsigned long flags;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002194 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002195 static void *previous;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002196
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002197 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002198
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002199 batch = raw_cpu_ptr(&batched_entropy_u32);
2200 spin_lock_irqsave(&batch->batch_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002201 if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
Eric Biggersa5e9f552018-09-11 20:05:10 -07002202 extract_crng((u8 *)batch->entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002203 batch->position = 0;
2204 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002205 ret = batch->entropy_u32[batch->position++];
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002206 spin_unlock_irqrestore(&batch->batch_lock, flags);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002207 return ret;
2208}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002209EXPORT_SYMBOL(get_random_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002210
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002211/* It's important to invalidate all potential batched entropy that might
2212 * be stored before the crng is initialized, which we can do lazily by
2213 * simply resetting the counter to zero so that it's re-extracted on the
2214 * next usage. */
2215static void invalidate_batched_entropy(void)
2216{
2217 int cpu;
2218 unsigned long flags;
2219
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002220 for_each_possible_cpu (cpu) {
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002221 struct batched_entropy *batched_entropy;
2222
2223 batched_entropy = per_cpu_ptr(&batched_entropy_u32, cpu);
2224 spin_lock_irqsave(&batched_entropy->batch_lock, flags);
2225 batched_entropy->position = 0;
2226 spin_unlock(&batched_entropy->batch_lock);
2227
2228 batched_entropy = per_cpu_ptr(&batched_entropy_u64, cpu);
2229 spin_lock(&batched_entropy->batch_lock);
2230 batched_entropy->position = 0;
2231 spin_unlock_irqrestore(&batched_entropy->batch_lock, flags);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002232 }
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002233}
2234
Jason Cooper99fdafd2016-10-11 13:53:52 -07002235/**
2236 * randomize_page - Generate a random, page aligned address
2237 * @start: The smallest acceptable address the caller will take.
2238 * @range: The size of the area, starting at @start, within which the
2239 * random address must fall.
2240 *
2241 * If @start + @range would overflow, @range is capped.
2242 *
2243 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2244 * @start was already page aligned. We now align it regardless.
2245 *
2246 * Return: A page aligned address within [start, start + range). On error,
2247 * @start is returned.
2248 */
2249unsigned long
2250randomize_page(unsigned long start, unsigned long range)
2251{
2252 if (!PAGE_ALIGNED(start)) {
2253 range -= PAGE_ALIGN(start) - start;
2254 start = PAGE_ALIGN(start);
2255 }
2256
2257 if (start > ULONG_MAX - range)
2258 range = ULONG_MAX - start;
2259
2260 range >>= PAGE_SHIFT;
2261
2262 if (range == 0)
2263 return start;
2264
2265 return start + (get_random_long() % range << PAGE_SHIFT);
2266}
2267
Torsten Duwec84dbf62014-06-14 23:38:36 -04002268/* Interface for in-kernel drivers of true hardware RNGs.
2269 * Those devices may produce endless random bits and will be throttled
2270 * when our pool is full.
2271 */
2272void add_hwgenerator_randomness(const char *buffer, size_t count,
2273 size_t entropy)
2274{
2275 struct entropy_store *poolp = &input_pool;
2276
Theodore Ts'o43838a22018-04-11 13:27:52 -04002277 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04002278 crng_fast_load(buffer, count);
2279 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002280 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002281
2282 /* Suspend writing if we're above the trickle threshold.
2283 * We'll be woken up again once below random_write_wakeup_thresh,
2284 * or when the calling thread is about to terminate.
2285 */
Herbert Xu08e97ae2019-11-17 08:48:17 +08002286 wait_event_interruptible(random_write_wait, kthread_should_stop() ||
Theodore Ts'oe192be92016-06-12 18:13:36 -04002287 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002288 mix_pool_bytes(poolp, buffer, count);
2289 credit_entropy_bits(poolp, entropy);
2290}
2291EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);
Hsin-Yi Wang428826f2019-08-23 14:24:51 +08002292
2293/* Handle random seed passed by bootloader.
2294 * If the seed is trustworthy, it would be regarded as hardware RNGs. Otherwise
2295 * it would be regarded as device data.
2296 * The decision is controlled by CONFIG_RANDOM_TRUST_BOOTLOADER.
2297 */
2298void add_bootloader_randomness(const void *buf, unsigned int size)
2299{
2300 if (IS_ENABLED(CONFIG_RANDOM_TRUST_BOOTLOADER))
2301 add_hwgenerator_randomness(buf, size, size * 8);
2302 else
2303 add_device_randomness(buf, size);
2304}
Borislav Petkov3fd57e72019-10-01 19:50:23 +02002305EXPORT_SYMBOL_GPL(add_bootloader_randomness);