blob: 3404a91edf29296d53fad711804fd9c82783d017 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * random.c -- A strong random number generator
3 *
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01004 * Copyright (C) 2017-2022 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04005 *
Matt Mackall9e95ce22005-04-16 15:25:56 -07006 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
9 * rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, and the entire permission notice in its entirety,
16 * including the disclaimer of warranties.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. The name of the author may not be used to endorse or promote
21 * products derived from this software without specific prior
22 * written permission.
23 *
24 * ALTERNATIVELY, this product may be distributed under the terms of
25 * the GNU General Public License, in which case the provisions of the GPL are
26 * required INSTEAD OF the above restrictions. (This clause is
27 * necessary due to a potential bad interaction between the GPL and
28 * the restrictions contained in a BSD-style copyright.)
29 *
30 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
31 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
33 * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
34 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
36 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
37 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
38 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
39 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
40 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
41 * DAMAGE.
42 */
43
44/*
45 * (now, with legal B.S. out of the way.....)
46 *
47 * This routine gathers environmental noise from device drivers, etc.,
48 * and returns good random numbers, suitable for cryptographic use.
49 * Besides the obvious cryptographic uses, these numbers are also good
50 * for seeding TCP sequence numbers, and other places where it is
51 * desirable to have numbers which are not only random, but hard to
52 * predict by an attacker.
53 *
54 * Theory of operation
55 * ===================
56 *
57 * Computers are very predictable devices. Hence it is extremely hard
58 * to produce truly random numbers on a computer --- as opposed to
59 * pseudo-random numbers, which can easily generated by using a
60 * algorithm. Unfortunately, it is very easy for attackers to guess
61 * the sequence of pseudo-random number generators, and for some
62 * applications this is not acceptable. So instead, we must try to
63 * gather "environmental noise" from the computer's environment, which
64 * must be hard for outside attackers to observe, and use that to
65 * generate random numbers. In a Unix environment, this is best done
66 * from inside the kernel.
67 *
68 * Sources of randomness from the environment include inter-keyboard
69 * timings, inter-interrupt timings from some interrupts, and other
70 * events which are both (a) non-deterministic and (b) hard for an
71 * outside observer to measure. Randomness from these sources are
72 * added to an "entropy pool", which is mixed using a CRC-like function.
73 * This is not cryptographically strong, but it is adequate assuming
74 * the randomness is not chosen maliciously, and it is fast enough that
75 * the overhead of doing it on every interrupt is very reasonable.
76 * As random bytes are mixed into the entropy pool, the routines keep
77 * an *estimate* of how many bits of randomness have been stored into
78 * the random number generator's internal state.
79 *
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +010080 * When random bytes are desired, they are obtained by taking the BLAKE2s
81 * hash of the contents of the "entropy pool". The BLAKE2s hash avoids
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 * exposing the internal state of the entropy pool. It is believed to
83 * be computationally infeasible to derive any useful information
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +010084 * about the input of BLAKE2s from its output. Even if it is possible to
85 * analyze BLAKE2s in some clever way, as long as the amount of data
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 * returned from the generator is less than the inherent entropy in
87 * the pool, the output data is totally unpredictable. For this
88 * reason, the routine decreases its internal estimate of how many
89 * bits of "true randomness" are contained in the entropy pool as it
90 * outputs random numbers.
91 *
92 * If this estimate goes to zero, the routine can still generate
93 * random numbers; however, an attacker may (at least in theory) be
94 * able to infer the future output of the generator from prior
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +010095 * outputs. This requires successful cryptanalysis of BLAKE2s, which is
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 * not believed to be feasible, but there is a remote possibility.
97 * Nonetheless, these numbers should be useful for the vast majority
98 * of purposes.
99 *
100 * Exported interfaces ---- output
101 * ===============================
102 *
George Spelvin92e507d2019-04-19 23:48:20 -0400103 * There are four exported interfaces; two for use within the kernel,
Schspa Shic0a8a612022-01-14 16:12:16 +0800104 * and two for use from userspace.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 *
George Spelvin92e507d2019-04-19 23:48:20 -0400106 * Exported interfaces ---- userspace output
107 * -----------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 *
George Spelvin92e507d2019-04-19 23:48:20 -0400109 * The userspace interfaces are two character devices /dev/random and
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 * /dev/urandom. /dev/random is suitable for use when very high
111 * quality randomness is desired (for example, for key generation or
112 * one-time pads), as it will only return a maximum of the number of
113 * bits of randomness (as estimated by the random number generator)
114 * contained in the entropy pool.
115 *
116 * The /dev/urandom device does not have this limit, and will return
117 * as many bytes as are requested. As more and more random bytes are
118 * requested without giving time for the entropy pool to recharge,
119 * this will result in random numbers that are merely cryptographically
120 * strong. For many applications, however, this is acceptable.
121 *
George Spelvin92e507d2019-04-19 23:48:20 -0400122 * Exported interfaces ---- kernel output
123 * --------------------------------------
124 *
125 * The primary kernel interface is
126 *
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100127 * void get_random_bytes(void *buf, int nbytes);
George Spelvin92e507d2019-04-19 23:48:20 -0400128 *
129 * This interface will return the requested number of random bytes,
130 * and place it in the requested buffer. This is equivalent to a
131 * read from /dev/urandom.
132 *
133 * For less critical applications, there are the functions:
134 *
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100135 * u32 get_random_u32()
136 * u64 get_random_u64()
137 * unsigned int get_random_int()
138 * unsigned long get_random_long()
George Spelvin92e507d2019-04-19 23:48:20 -0400139 *
140 * These are produced by a cryptographic RNG seeded from get_random_bytes,
141 * and so do not deplete the entropy pool as much. These are recommended
142 * for most in-kernel operations *if the result is going to be stored in
143 * the kernel*.
144 *
145 * Specifically, the get_random_int() family do not attempt to do
146 * "anti-backtracking". If you capture the state of the kernel (e.g.
147 * by snapshotting the VM), you can figure out previous get_random_int()
148 * return values. But if the value is stored in the kernel anyway,
149 * this is not a problem.
150 *
151 * It *is* safe to expose get_random_int() output to attackers (e.g. as
152 * network cookies); given outputs 1..n, it's not feasible to predict
153 * outputs 0 or n+1. The only concern is an attacker who breaks into
154 * the kernel later; the get_random_int() engine is not reseeded as
155 * often as the get_random_bytes() one.
156 *
157 * get_random_bytes() is needed for keys that need to stay secret after
158 * they are erased from the kernel. For example, any key that will
159 * be wrapped and stored encrypted. And session encryption keys: we'd
160 * like to know that after the session is closed and the keys erased,
161 * the plaintext is unrecoverable to someone who recorded the ciphertext.
162 *
163 * But for network ports/cookies, stack canaries, PRNG seeds, address
164 * space layout randomization, session *authentication* keys, or other
165 * applications where the sensitive data is stored in the kernel in
166 * plaintext for as long as it's sensitive, the get_random_int() family
167 * is just fine.
168 *
169 * Consider ASLR. We want to keep the address space secret from an
170 * outside attacker while the process is running, but once the address
171 * space is torn down, it's of no use to an attacker any more. And it's
172 * stored in kernel data structures as long as it's alive, so worrying
173 * about an attacker's ability to extrapolate it from the get_random_int()
174 * CRNG is silly.
175 *
176 * Even some cryptographic keys are safe to generate with get_random_int().
177 * In particular, keys for SipHash are generally fine. Here, knowledge
178 * of the key authorizes you to do something to a kernel object (inject
179 * packets to a network connection, or flood a hash table), and the
180 * key is stored with the object being protected. Once it goes away,
181 * we no longer care if anyone knows the key.
182 *
183 * prandom_u32()
184 * -------------
185 *
186 * For even weaker applications, see the pseudorandom generator
187 * prandom_u32(), prandom_max(), and prandom_bytes(). If the random
188 * numbers aren't security-critical at all, these are *far* cheaper.
189 * Useful for self-tests, random error simulation, randomized backoffs,
190 * and any other application where you trust that nobody is trying to
191 * maliciously mess with you by guessing the "random" numbers.
192 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 * Exported interfaces ---- input
194 * ==============================
195 *
196 * The current exported interfaces for gathering environmental noise
197 * from the devices are:
198 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400199 * void add_device_randomness(const void *buf, unsigned int size);
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100200 * void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 * unsigned int value);
Sebastian Andrzej Siewior703f7062021-12-07 13:17:33 +0100202 * void add_interrupt_randomness(int irq);
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100203 * void add_disk_randomness(struct gendisk *disk);
Mark Brown2b6c6e32021-12-01 17:44:49 +0000204 * void add_hwgenerator_randomness(const char *buffer, size_t count,
205 * size_t entropy);
206 * void add_bootloader_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400208 * add_device_randomness() is for adding data to the random pool that
209 * is likely to differ between two devices (or possibly even per boot).
210 * This would be things like MAC addresses or serial numbers, or the
211 * read-out of the RTC. This does *not* add any actual entropy to the
212 * pool, but it initializes the pool to different values for devices
213 * that might otherwise be identical and have very little entropy
214 * available to them (particularly common in the embedded world).
215 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 * add_input_randomness() uses the input layer interrupt timing, as well as
217 * the event type information from the hardware.
218 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400219 * add_interrupt_randomness() uses the interrupt timing as random
220 * inputs to the entropy pool. Using the cycle counters and the irq source
221 * as inputs, it feeds the randomness roughly once a second.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100222 *
223 * add_disk_randomness() uses what amounts to the seek time of block
224 * layer request events, on a per-disk_devt basis, as input to the
225 * entropy pool. Note that high-speed solid state drives with very low
226 * seek times do not make for good sources of entropy, as their seek
227 * times are usually fairly consistent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 *
229 * All of these routines try to estimate how many bits of randomness a
230 * particular randomness source. They do this by keeping track of the
231 * first and second order deltas of the event timings.
232 *
Mark Brown2b6c6e32021-12-01 17:44:49 +0000233 * add_hwgenerator_randomness() is for true hardware RNGs, and will credit
234 * entropy as specified by the caller. If the entropy pool is full it will
235 * block until more entropy is needed.
236 *
237 * add_bootloader_randomness() is the same as add_hwgenerator_randomness() or
238 * add_device_randomness(), depending on whether or not the configuration
239 * option CONFIG_RANDOM_TRUST_BOOTLOADER is set.
240 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 * Ensuring unpredictability at system startup
242 * ============================================
243 *
244 * When any operating system starts up, it will go through a sequence
245 * of actions that are fairly predictable by an adversary, especially
246 * if the start-up does not involve interaction with a human operator.
247 * This reduces the actual number of bits of unpredictability in the
248 * entropy pool below the value in entropy_count. In order to
249 * counteract this effect, it helps to carry information in the
250 * entropy pool across shut-downs and start-ups. To do this, put the
251 * following lines an appropriate script which is run during the boot
252 * sequence:
253 *
254 * echo "Initializing random number generator..."
255 * random_seed=/var/run/random-seed
256 * # Carry a random seed from start-up to start-up
257 * # Load and then save the whole entropy pool
258 * if [ -f $random_seed ]; then
259 * cat $random_seed >/dev/urandom
260 * else
261 * touch $random_seed
262 * fi
263 * chmod 600 $random_seed
264 * dd if=/dev/urandom of=$random_seed count=1 bs=512
265 *
266 * and the following lines in an appropriate script which is run as
267 * the system is shutdown:
268 *
269 * # Carry a random seed from shut-down to start-up
270 * # Save the whole entropy pool
271 * echo "Saving random seed..."
272 * random_seed=/var/run/random-seed
273 * touch $random_seed
274 * chmod 600 $random_seed
275 * dd if=/dev/urandom of=$random_seed count=1 bs=512
276 *
277 * For example, on most modern systems using the System V init
278 * scripts, such code fragments would be found in
279 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
280 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
281 *
282 * Effectively, these commands cause the contents of the entropy pool
283 * to be saved at shut-down time and reloaded into the entropy pool at
284 * start-up. (The 'dd' in the addition to the bootup script is to
285 * make sure that /etc/random-seed is different for every start-up,
286 * even if the system crashes without executing rc.0.) Even with
287 * complete knowledge of the start-up activities, predicting the state
288 * of the entropy pool requires knowledge of the previous history of
289 * the system.
290 *
291 * Configuring the /dev/random driver under Linux
292 * ==============================================
293 *
294 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
295 * the /dev/mem major number (#1). So if your system does not have
296 * /dev/random and /dev/urandom created already, they can be created
297 * by using the commands:
298 *
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100299 * mknod /dev/random c 1 8
300 * mknod /dev/urandom c 1 9
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 *
302 * Acknowledgements:
303 * =================
304 *
305 * Ideas for constructing this random number generator were derived
306 * from Pretty Good Privacy's random number generator, and from private
307 * discussions with Phil Karn. Colin Plumb provided a faster random
308 * number generator, which speed up the mixing function of the entropy
309 * pool, taken from PGPfone. Dale Worley has also contributed many
310 * useful ideas and suggestions to improve this driver.
311 *
312 * Any flaws in the design are solely my responsibility, and should
313 * not be attributed to the Phil, Colin, or any of authors of PGP.
314 *
315 * Further background information on this topic may be obtained from
316 * RFC 1750, "Randomness Recommendations for Security", by Donald
317 * Eastlake, Steve Crocker, and Jeff Schiller.
318 */
319
Yangtao Li12cd53a2019-06-07 14:25:15 -0400320#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
321
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323#include <linux/module.h>
324#include <linux/kernel.h>
325#include <linux/major.h>
326#include <linux/string.h>
327#include <linux/fcntl.h>
328#include <linux/slab.h>
329#include <linux/random.h>
330#include <linux/poll.h>
331#include <linux/init.h>
332#include <linux/fs.h>
333#include <linux/genhd.h>
334#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700335#include <linux/mm.h>
Michael Ellermandd0f0cf2016-07-31 00:23:08 +1000336#include <linux/nodemask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337#include <linux/spinlock.h>
Torsten Duwec84dbf62014-06-14 23:38:36 -0400338#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339#include <linux/percpu.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400340#include <linux/ptrace.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400341#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200342#include <linux/irq.h>
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400343#include <linux/ratelimit.h>
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400344#include <linux/syscalls.h>
345#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700346#include <linux/uuid.h>
Eric Biggers1ca1b912018-11-16 17:26:21 -0800347#include <crypto/chacha.h>
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +0100348#include <crypto/blake2s.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350#include <asm/processor.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800351#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400353#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354#include <asm/io.h>
355
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400356#define CREATE_TRACE_POINTS
357#include <trace/events/random.h>
358
Theodore Ts'o43759d42014-06-14 21:43:13 -0400359/* #define ADD_INTERRUPT_BENCH */
360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 * If the entropy count falls under this number of bits, then we
363 * should wake up processes which are selecting or polling on write
364 * access to /dev/random.
365 */
Jason A. Donenfeld0f637022022-01-13 15:51:06 +0100366static int random_write_wakeup_bits = 28 * (1 << 5);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
368/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400369 * Originally, we used a primitive polynomial of degree .poolwords
370 * over GF(2). The taps for various sizes are defined below. They
371 * were chosen to be evenly spaced except for the last tap, which is 1
372 * to get the twisting happening as fast as possible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400374 * For the purposes of better mixing, we use the CRC-32 polynomial as
375 * well to make a (modified) twisted Generalized Feedback Shift
376 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
377 * generators. ACM Transactions on Modeling and Computer Simulation
378 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
Greg Pricedfd38752013-11-29 14:58:06 -0500379 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400380 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 *
382 * Thanks to Colin Plumb for suggesting this.
383 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400384 * The mixing operation is much less sensitive than the output hash,
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +0100385 * where we use BLAKE2s. All that we want of mixing operation is that
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400386 * it be a good non-cryptographic hash; i.e. it not produce collisions
387 * when fed "random" data of the sort we expect to see. As long as
388 * the pool state differs for different inputs, we have preserved the
389 * input entropy and done a good job. The fact that an intelligent
390 * attacker can construct inputs that will produce controlled
391 * alterations to the pool's state is not important because we don't
392 * consider such inputs to contribute any randomness. The only
393 * property we need with respect to them is that the attacker can't
394 * increase his/her knowledge of the pool's state. Since all
395 * additions are reversible (knowing the final state and the input,
396 * you can reconstruct the initial state), if an attacker has any
397 * uncertainty about the initial state, he/she can only shuffle that
398 * uncertainty about, but never cause any collisions (which would
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 * decrease the uncertainty).
400 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400401 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
402 * Videau in their paper, "The Linux Pseudorandom Number Generator
403 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
404 * paper, they point out that we are not using a true Twisted GFSR,
405 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
406 * is, with only three taps, instead of the six that we are using).
407 * As a result, the resulting polynomial is neither primitive nor
408 * irreducible, and hence does not have a maximal period over
409 * GF(2**32). They suggest a slight change to the generator
410 * polynomial which improves the resulting TGFSR polynomial to be
411 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 */
Jason A. Donenfeld91ec0fe2022-01-09 17:32:02 +0100413enum poolinfo {
414 POOL_WORDS = 128,
415 POOL_WORDMASK = POOL_WORDS - 1,
416 POOL_BYTES = POOL_WORDS * sizeof(u32),
417 POOL_BITS = POOL_BYTES * 8,
Jason A. Donenfeld18263c42022-01-13 18:18:48 +0100418 POOL_BITSHIFT = ilog2(POOL_BITS),
419
420 /* To allow fractional bits to be tracked, the entropy_count field is
421 * denominated in units of 1/8th bits. */
422 POOL_ENTROPY_SHIFT = 3,
423#define POOL_ENTROPY_BITS() (input_pool.entropy_count >> POOL_ENTROPY_SHIFT)
424 POOL_FRACBITS = POOL_BITS << POOL_ENTROPY_SHIFT,
Jason A. Donenfeld91ec0fe2022-01-09 17:32:02 +0100425
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400426 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
Jason A. Donenfeld91ec0fe2022-01-09 17:32:02 +0100427 POOL_TAP1 = 104,
428 POOL_TAP2 = 76,
429 POOL_TAP3 = 51,
430 POOL_TAP4 = 25,
Jason A. Donenfeld5b87adf2022-01-13 16:11:21 +0100431 POOL_TAP5 = 1,
432
433 EXTRACT_SIZE = BLAKE2S_HASH_SIZE / 2
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 {
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100446 u32 state[16];
447 unsigned long init_time;
448 spinlock_t lock;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400449};
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),
Dominik Brodowski96562f22021-12-31 09:26:08 +0100453 .state[0] = CHACHA_CONSTANT_EXPA,
454 .state[1] = CHACHA_CONSTANT_ND_3,
455 .state[2] = CHACHA_CONSTANT_2_BY,
456 .state[3] = CHACHA_CONSTANT_TE_K,
Theodore Ts'oe192be92016-06-12 18:13:36 -0400457};
458
459/*
460 * crng_init = 0 --> Uninitialized
461 * 1 --> Initialized
462 * 2 --> Initialized from input_pool
463 *
464 * crng_init is protected by primary_crng->lock, and only increases
465 * its value (from 0->1->2).
466 */
467static int crng_init = 0;
Dominik Brodowskif7e67b82021-12-29 22:10:03 +0100468static bool crng_need_final_init = false;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400469#define crng_ready() (likely(crng_init > 1))
Theodore Ts'oe192be92016-06-12 18:13:36 -0400470static int crng_init_cnt = 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400471static unsigned long crng_global_init_time = 0;
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100472#define CRNG_INIT_CNT_THRESH (2 * CHACHA_KEY_SIZE)
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +0100473static void _extract_crng(struct crng_state *crng, u8 out[CHACHA_BLOCK_SIZE]);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400474static void _crng_backtrack_protect(struct crng_state *crng,
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +0100475 u8 tmp[CHACHA_BLOCK_SIZE], int used);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400476static void process_random_ready_list(void);
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400477static void _get_random_bytes(void *buf, int nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400478
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400479static struct ratelimit_state unseeded_warning =
480 RATELIMIT_STATE_INIT("warn_unseeded_randomness", HZ, 3);
481static struct ratelimit_state urandom_warning =
482 RATELIMIT_STATE_INIT("warn_urandom_randomness", HZ, 3);
483
484static int ratelimit_disable __read_mostly;
485
486module_param_named(ratelimit_disable, ratelimit_disable, int, 0644);
487MODULE_PARM_DESC(ratelimit_disable, "Disable random ratelimit suppression");
488
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489/**********************************************************************
490 *
491 * OS independent entropy store. Here are the functions which handle
492 * storing entropy in an entropy pool.
493 *
494 **********************************************************************/
495
Jason A. Donenfeld5b87adf2022-01-13 16:11:21 +0100496static u32 input_pool_data[POOL_WORDS] __latent_entropy;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100497
498static struct {
Matt Mackall43358202008-04-29 01:03:01 -0700499 spinlock_t lock;
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +0100500 u16 add_ptr;
501 u16 input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800502 int entropy_count;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100503} input_pool = {
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200504 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505};
506
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100507static ssize_t extract_entropy(void *buf, size_t nbytes, int min);
508static ssize_t _extract_entropy(void *buf, size_t nbytes);
509
510static void crng_reseed(struct crng_state *crng, bool use_input_pool);
511
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100512static const u32 twist_table[8] = {
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400513 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
514 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
515
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700517 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700519 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 *
521 * The pool is stirred with a primitive polynomial of the appropriate
522 * degree, and then twisted. We twist by three bits at a time because
523 * it's cheap to do so and helps slightly in the expected case where
524 * the entropy is concentrated in the low-order bits.
525 */
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100526static void _mix_pool_bytes(const void *in, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527{
Jason A. Donenfeld91ec0fe2022-01-09 17:32:02 +0100528 unsigned long i;
Matt Mackallfeee7692008-04-29 01:03:02 -0700529 int input_rotate;
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +0100530 const u8 *bytes = in;
531 u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100533 input_rotate = input_pool.input_rotate;
534 i = input_pool.add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Matt Mackalle68e5b62008-04-29 01:03:05 -0700536 /* mix one byte at a time to simplify size handling and churn faster */
537 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400538 w = rol32(*bytes++, input_rotate);
Jason A. Donenfeld91ec0fe2022-01-09 17:32:02 +0100539 i = (i - 1) & POOL_WORDMASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
541 /* XOR in the various taps */
Jason A. Donenfeld6c0eace2022-01-15 14:40:04 +0100542 w ^= input_pool_data[i];
543 w ^= input_pool_data[(i + POOL_TAP1) & POOL_WORDMASK];
544 w ^= input_pool_data[(i + POOL_TAP2) & POOL_WORDMASK];
545 w ^= input_pool_data[(i + POOL_TAP3) & POOL_WORDMASK];
546 w ^= input_pool_data[(i + POOL_TAP4) & POOL_WORDMASK];
547 w ^= input_pool_data[(i + POOL_TAP5) & POOL_WORDMASK];
Matt Mackall993ba212008-04-29 01:03:04 -0700548
549 /* Mix the result back in with a twist */
Jason A. Donenfeld6c0eace2022-01-15 14:40:04 +0100550 input_pool_data[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700551
552 /*
553 * Normally, we add 7 bits of rotation to the pool.
554 * At the beginning of the pool, add an extra 7 bits
555 * rotation, so that successive passes spread the
556 * input bits across the pool evenly.
557 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400558 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 }
560
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100561 input_pool.input_rotate = input_rotate;
562 input_pool.add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563}
564
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100565static void __mix_pool_bytes(const void *in, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100567 trace_mix_pool_bytes_nolock(nbytes, _RET_IP_);
568 _mix_pool_bytes(in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400569}
570
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100571static void mix_pool_bytes(const void *in, int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400572{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400573 unsigned long flags;
574
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100575 trace_mix_pool_bytes(nbytes, _RET_IP_);
576 spin_lock_irqsave(&input_pool.lock, flags);
577 _mix_pool_bytes(in, nbytes);
578 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579}
580
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400581struct fast_pool {
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100582 u32 pool[4];
583 unsigned long last;
584 u16 reg_idx;
585 u8 count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400586};
587
588/*
589 * This is a fast mixing routine used by the interrupt randomness
590 * collector. It's hardcoded for an 128 bit pool and assumes that any
591 * locks that might be needed are taken by the caller.
592 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400593static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400594{
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +0100595 u32 a = f->pool[0], b = f->pool[1];
596 u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400597
Theodore Ts'o43759d42014-06-14 21:43:13 -0400598 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500599 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400600 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400601
Theodore Ts'o43759d42014-06-14 21:43:13 -0400602 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500603 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400604 d ^= a; b ^= c;
605
606 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500607 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400608 d ^= a; b ^= c;
609
610 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500611 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400612 d ^= a; b ^= c;
613
614 f->pool[0] = a; f->pool[1] = b;
615 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400616 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400617}
618
Herbert Xu205a5252015-06-09 18:19:39 +0800619static void process_random_ready_list(void)
620{
621 unsigned long flags;
622 struct random_ready_callback *rdy, *tmp;
623
624 spin_lock_irqsave(&random_ready_list_lock, flags);
625 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
626 struct module *owner = rdy->owner;
627
628 list_del_init(&rdy->list);
629 rdy->func(rdy);
630 module_put(owner);
631 }
632 spin_unlock_irqrestore(&random_ready_list_lock, flags);
633}
634
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400636 * Credit (or debit) the entropy store with n bits of entropy.
637 * Use credit_entropy_bits_safe() if the value comes from userspace
638 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 */
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100640static void credit_entropy_bits(int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641{
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100642 int entropy_count, entropy_bits, orig;
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +0100643 int nfrac = nbits << POOL_ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
Jason A. Donenfeld18263c42022-01-13 18:18:48 +0100645 /* Ensure that the multiplication can avoid being 64 bits wide. */
646 BUILD_BUG_ON(2 * (POOL_ENTROPY_SHIFT + POOL_BITSHIFT) > 31);
647
Matt Mackalladc782d2008-04-29 01:03:07 -0700648 if (!nbits)
649 return;
650
Theodore Ts'o902c0982012-07-04 10:38:30 -0400651retry:
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100652 entropy_count = orig = READ_ONCE(input_pool.entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400653 if (nfrac < 0) {
654 /* Debit */
655 entropy_count += nfrac;
656 } else {
657 /*
658 * Credit: we have to account for the possibility of
659 * overwriting already present entropy. Even in the
660 * ideal case of pure Shannon entropy, new contributions
661 * approach the full value asymptotically:
662 *
663 * entropy <- entropy + (pool_size - entropy) *
664 * (1 - exp(-add_entropy/pool_size))
665 *
666 * For add_entropy <= pool_size/2 then
667 * (1 - exp(-add_entropy/pool_size)) >=
668 * (add_entropy/pool_size)*0.7869...
669 * so we can approximate the exponential with
670 * 3/4*add_entropy/pool_size and still be on the
671 * safe side by adding at most pool_size/2 at a time.
672 *
673 * The use of pool_size-2 in the while statement is to
674 * prevent rounding artifacts from making the loop
675 * arbitrarily long; this limits the loop to log2(pool_size)*2
676 * turns no matter how large nbits is.
677 */
678 int pnfrac = nfrac;
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +0100679 const int s = POOL_BITSHIFT + POOL_ENTROPY_SHIFT + 2;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400680 /* The +2 corresponds to the /4 in the denominator */
681
682 do {
Jason A. Donenfeld18263c42022-01-13 18:18:48 +0100683 unsigned int anfrac = min(pnfrac, POOL_FRACBITS / 2);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400684 unsigned int add =
Jason A. Donenfeld18263c42022-01-13 18:18:48 +0100685 ((POOL_FRACBITS - entropy_count) * anfrac * 3) >> s;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400686
687 entropy_count += add;
688 pnfrac -= anfrac;
Jason A. Donenfeld18263c42022-01-13 18:18:48 +0100689 } while (unlikely(entropy_count < POOL_FRACBITS - 2 && pnfrac));
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400690 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400691
Yangtao Li870e05b2020-01-07 16:10:28 -0500692 if (WARN_ON(entropy_count < 0)) {
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100693 pr_warn("negative entropy/overflow: count %d\n", entropy_count);
Andrew Morton8b76f462008-09-02 14:36:14 -0700694 entropy_count = 0;
Jason A. Donenfeld91ec0fe2022-01-09 17:32:02 +0100695 } else if (entropy_count > POOL_FRACBITS)
696 entropy_count = POOL_FRACBITS;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100697 if (cmpxchg(&input_pool.entropy_count, orig, entropy_count) != orig)
Theodore Ts'o902c0982012-07-04 10:38:30 -0400698 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +0100700 trace_credit_entropy_bits(nbits, entropy_count >> POOL_ENTROPY_SHIFT, _RET_IP_);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400701
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +0100702 entropy_bits = entropy_count >> POOL_ENTROPY_SHIFT;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100703 if (crng_init < 2 && entropy_bits >= 128)
704 crng_reseed(&primary_crng, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705}
706
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100707static int credit_entropy_bits_safe(int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400708{
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400709 if (nbits < 0)
710 return -EINVAL;
711
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400712 /* Cap the value to avoid overflows */
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100713 nbits = min(nbits, POOL_BITS);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400714
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100715 credit_entropy_bits(nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400716 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400717}
718
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719/*********************************************************************
720 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400721 * CRNG using CHACHA20
722 *
723 *********************************************************************/
724
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100725#define CRNG_RESEED_INTERVAL (300 * HZ)
Theodore Ts'oe192be92016-06-12 18:13:36 -0400726
727static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
728
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400729/*
730 * Hack to deal with crazy userspace progams when they are all trying
731 * to access /dev/urandom in parallel. The programs are almost
732 * certainly doing something terribly wrong, but we'll work around
733 * their brain damage.
734 */
735static struct crng_state **crng_node_pool __read_mostly;
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400736
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400737static void invalidate_batched_entropy(void);
Jon DeVreefe6f1a62019-04-19 23:35:16 -0400738static void numa_crng_init(void);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400739
Kees Cook9b254362018-08-27 14:51:54 -0700740static bool trust_cpu __ro_after_init = IS_ENABLED(CONFIG_RANDOM_TRUST_CPU);
741static int __init parse_trust_cpu(char *arg)
742{
743 return kstrtobool(arg, &trust_cpu);
744}
745early_param("random.trust_cpu", parse_trust_cpu);
746
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000747static bool crng_init_try_arch(struct crng_state *crng)
Theodore Ts'oe192be92016-06-12 18:13:36 -0400748{
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100749 int i;
750 bool arch_init = true;
751 unsigned long rv;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400752
Theodore Ts'oe192be92016-06-12 18:13:36 -0400753 for (i = 4; i < 16; i++) {
754 if (!arch_get_random_seed_long(&rv) &&
Theodore Ts'o39a88832018-07-17 18:24:27 -0400755 !arch_get_random_long(&rv)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400756 rv = random_get_entropy();
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000757 arch_init = false;
Theodore Ts'o39a88832018-07-17 18:24:27 -0400758 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400759 crng->state[i] ^= rv;
760 }
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000761
762 return arch_init;
763}
764
Dominik Brodowskiebf76062022-01-30 22:03:19 +0100765static bool __init crng_init_try_arch_early(void)
Mark Rutland253d3192020-02-10 13:00:13 +0000766{
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100767 int i;
768 bool arch_init = true;
769 unsigned long rv;
Mark Rutland253d3192020-02-10 13:00:13 +0000770
771 for (i = 4; i < 16; i++) {
772 if (!arch_get_random_seed_long_early(&rv) &&
773 !arch_get_random_long_early(&rv)) {
774 rv = random_get_entropy();
775 arch_init = false;
776 }
Dominik Brodowskiebf76062022-01-30 22:03:19 +0100777 primary_crng.state[i] ^= rv;
Mark Rutland253d3192020-02-10 13:00:13 +0000778 }
779
780 return arch_init;
781}
782
Jason A. Donenfeld7b873242021-12-30 15:59:26 +0100783static void crng_initialize_secondary(struct crng_state *crng)
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000784{
Eric Biggersa181e0f2021-03-21 22:13:47 -0700785 chacha_init_consts(crng->state);
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +0100786 _get_random_bytes(&crng->state[4], sizeof(u32) * 12);
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000787 crng_init_try_arch(crng);
788 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
789}
790
Dominik Brodowskiebf76062022-01-30 22:03:19 +0100791static void __init crng_initialize_primary(void)
Mark Rutland5cbe0f12020-02-10 13:00:12 +0000792{
Dominik Brodowskiebf76062022-01-30 22:03:19 +0100793 _extract_entropy(&primary_crng.state[4], sizeof(u32) * 12);
794 if (crng_init_try_arch_early() && trust_cpu && crng_init < 2) {
Jon DeVreefe6f1a62019-04-19 23:35:16 -0400795 invalidate_batched_entropy();
796 numa_crng_init();
Theodore Ts'o39a88832018-07-17 18:24:27 -0400797 crng_init = 2;
Dominik Brodowski161212c2021-12-29 22:10:07 +0100798 pr_notice("crng init done (trusting CPU's manufacturer)\n");
Theodore Ts'o39a88832018-07-17 18:24:27 -0400799 }
Dominik Brodowskiebf76062022-01-30 22:03:19 +0100800 primary_crng.init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400801}
802
Dominik Brodowski9d5505f2022-01-30 22:03:20 +0100803static void crng_finalize_init(void)
Dominik Brodowskif7e67b82021-12-29 22:10:03 +0100804{
Dominik Brodowskif7e67b82021-12-29 22:10:03 +0100805 if (!system_wq) {
806 /* We can't call numa_crng_init until we have workqueues,
807 * so mark this for processing later. */
808 crng_need_final_init = true;
809 return;
810 }
811
812 invalidate_batched_entropy();
813 numa_crng_init();
814 crng_init = 2;
Dominik Brodowski9d5505f2022-01-30 22:03:20 +0100815 crng_need_final_init = false;
Dominik Brodowskif7e67b82021-12-29 22:10:03 +0100816 process_random_ready_list();
817 wake_up_interruptible(&crng_init_wait);
818 kill_fasync(&fasync, SIGIO, POLL_IN);
819 pr_notice("crng init done\n");
820 if (unseeded_warning.missed) {
821 pr_notice("%d get_random_xx warning(s) missed due to ratelimiting\n",
822 unseeded_warning.missed);
823 unseeded_warning.missed = 0;
824 }
825 if (urandom_warning.missed) {
826 pr_notice("%d urandom warning(s) missed due to ratelimiting\n",
827 urandom_warning.missed);
828 urandom_warning.missed = 0;
829 }
830}
831
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
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100838 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL | __GFP_NOFAIL);
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400839 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 }
Eric Biggers5d73d1e2021-12-20 16:41:56 -0600846 /* pairs with READ_ONCE() in select_crng() */
847 if (cmpxchg_release(&crng_node_pool, NULL, pool) != NULL) {
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400848 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{
Jason A. Donenfeld7b873242021-12-30 15:59:26 +0100858 if (IS_ENABLED(CONFIG_NUMA))
859 schedule_work(&numa_crng_init_work);
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400860}
Eric Biggers5d73d1e2021-12-20 16:41:56 -0600861
862static struct crng_state *select_crng(void)
863{
Jason A. Donenfeld7b873242021-12-30 15:59:26 +0100864 if (IS_ENABLED(CONFIG_NUMA)) {
865 struct crng_state **pool;
866 int nid = numa_node_id();
Eric Biggers5d73d1e2021-12-20 16:41:56 -0600867
Jason A. Donenfeld7b873242021-12-30 15:59:26 +0100868 /* pairs with cmpxchg_release() in do_numa_crng_init() */
869 pool = READ_ONCE(crng_node_pool);
870 if (pool && pool[nid])
871 return pool[nid];
872 }
Eric Biggers5d73d1e2021-12-20 16:41:56 -0600873
874 return &primary_crng;
875}
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400876
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400877/*
878 * crng_fast_load() can be called by code in the interrupt service
Jason A. Donenfeld73c77332021-12-29 22:10:05 +0100879 * path. So we can't afford to dilly-dally. Returns the number of
880 * bytes processed from cp.
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400881 */
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +0100882static size_t crng_fast_load(const u8 *cp, size_t len)
Theodore Ts'oe192be92016-06-12 18:13:36 -0400883{
884 unsigned long flags;
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +0100885 u8 *p;
Jason A. Donenfeld73c77332021-12-29 22:10:05 +0100886 size_t ret = 0;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400887
888 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
889 return 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400890 if (crng_init != 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400891 spin_unlock_irqrestore(&primary_crng.lock, flags);
892 return 0;
893 }
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100894 p = (u8 *)&primary_crng.state[4];
Theodore Ts'oe192be92016-06-12 18:13:36 -0400895 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
Eric Biggers1ca1b912018-11-16 17:26:21 -0800896 p[crng_init_cnt % CHACHA_KEY_SIZE] ^= *cp;
Jason A. Donenfeld73c77332021-12-29 22:10:05 +0100897 cp++; crng_init_cnt++; len--; ret++;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400898 }
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200899 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400900 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400901 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400902 crng_init = 1;
Yangtao Li12cd53a2019-06-07 14:25:15 -0400903 pr_notice("fast init done\n");
Theodore Ts'oe192be92016-06-12 18:13:36 -0400904 }
Jason A. Donenfeld73c77332021-12-29 22:10:05 +0100905 return ret;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400906}
907
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400908/*
909 * crng_slow_load() is called by add_device_randomness, which has two
910 * attributes. (1) We can't trust the buffer passed to it is
911 * guaranteed to be unpredictable (so it might not have any entropy at
912 * all), and (2) it doesn't have the performance constraints of
913 * crng_fast_load().
914 *
915 * So we do something more comprehensive which is guaranteed to touch
916 * all of the primary_crng's state, and which uses a LFSR with a
917 * period of 255 as part of the mixing algorithm. Finally, we do
918 * *not* advance crng_init_cnt since buffer we may get may be something
919 * like a fixed DMI table (for example), which might very well be
920 * unique to the machine, but is otherwise unvarying.
921 */
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +0100922static int crng_slow_load(const u8 *cp, size_t len)
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400923{
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100924 unsigned long flags;
925 static u8 lfsr = 1;
926 u8 tmp;
927 unsigned int i, max = CHACHA_KEY_SIZE;
928 const u8 *src_buf = cp;
929 u8 *dest_buf = (u8 *)&primary_crng.state[4];
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400930
931 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
932 return 0;
933 if (crng_init != 0) {
934 spin_unlock_irqrestore(&primary_crng.lock, flags);
935 return 0;
936 }
937 if (len > max)
938 max = len;
939
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100940 for (i = 0; i < max; i++) {
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400941 tmp = lfsr;
942 lfsr >>= 1;
943 if (tmp & 1)
944 lfsr ^= 0xE1;
Eric Biggers1ca1b912018-11-16 17:26:21 -0800945 tmp = dest_buf[i % CHACHA_KEY_SIZE];
946 dest_buf[i % CHACHA_KEY_SIZE] ^= src_buf[i % len] ^ lfsr;
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400947 lfsr += (tmp << 3) | (tmp >> 5);
948 }
949 spin_unlock_irqrestore(&primary_crng.lock, flags);
950 return 1;
951}
952
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100953static void crng_reseed(struct crng_state *crng, bool use_input_pool)
Theodore Ts'oe192be92016-06-12 18:13:36 -0400954{
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100955 unsigned long flags;
956 int i, num;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400957 union {
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100958 u8 block[CHACHA_BLOCK_SIZE];
959 u32 key[8];
Theodore Ts'oe192be92016-06-12 18:13:36 -0400960 } buf;
961
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100962 if (use_input_pool) {
963 num = extract_entropy(&buf, 32, 16);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400964 if (num == 0)
965 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400966 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400967 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400968 _crng_backtrack_protect(&primary_crng, buf.block,
Eric Biggers1ca1b912018-11-16 17:26:21 -0800969 CHACHA_KEY_SIZE);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400970 }
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400971 spin_lock_irqsave(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400972 for (i = 0; i < 8; i++) {
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100973 unsigned long rv;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400974 if (!arch_get_random_seed_long(&rv) &&
975 !arch_get_random_long(&rv))
976 rv = random_get_entropy();
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100977 crng->state[i + 4] ^= buf.key[i] ^ rv;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400978 }
979 memzero_explicit(&buf, sizeof(buf));
Eric Biggers009ba852021-12-20 16:41:57 -0600980 WRITE_ONCE(crng->init_time, jiffies);
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400981 spin_unlock_irqrestore(&crng->lock, flags);
Dominik Brodowski9d5505f2022-01-30 22:03:20 +0100982 if (crng == &primary_crng && crng_init < 2)
983 crng_finalize_init();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400984}
985
Jason A. Donenfeld248045b2022-01-15 14:57:22 +0100986static void _extract_crng(struct crng_state *crng, u8 out[CHACHA_BLOCK_SIZE])
Theodore Ts'oe192be92016-06-12 18:13:36 -0400987{
Jason A. Donenfeld2ee25b62021-12-30 17:50:52 +0100988 unsigned long flags, init_time;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400989
Eric Biggers009ba852021-12-20 16:41:57 -0600990 if (crng_ready()) {
991 init_time = READ_ONCE(crng->init_time);
992 if (time_after(READ_ONCE(crng_global_init_time), init_time) ||
993 time_after(jiffies, init_time + CRNG_RESEED_INTERVAL))
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +0100994 crng_reseed(crng, crng == &primary_crng);
Eric Biggers009ba852021-12-20 16:41:57 -0600995 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400996 spin_lock_irqsave(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400997 chacha20_block(&crng->state[0], out);
998 if (crng->state[12] == 0)
999 crng->state[13]++;
1000 spin_unlock_irqrestore(&crng->lock, flags);
1001}
1002
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001003static void extract_crng(u8 out[CHACHA_BLOCK_SIZE])
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001004{
Eric Biggers5d73d1e2021-12-20 16:41:56 -06001005 _extract_crng(select_crng(), out);
Theodore Ts'o1e7f5832016-05-02 02:04:41 -04001006}
1007
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001008/*
1009 * Use the leftover bytes from the CRNG block output (if there is
1010 * enough) to mutate the CRNG key to provide backtracking protection.
1011 */
1012static void _crng_backtrack_protect(struct crng_state *crng,
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001013 u8 tmp[CHACHA_BLOCK_SIZE], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001014{
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001015 unsigned long flags;
1016 u32 *s, *d;
1017 int i;
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001018
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001019 used = round_up(used, sizeof(u32));
Eric Biggers1ca1b912018-11-16 17:26:21 -08001020 if (used + CHACHA_KEY_SIZE > CHACHA_BLOCK_SIZE) {
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001021 extract_crng(tmp);
1022 used = 0;
1023 }
1024 spin_lock_irqsave(&crng->lock, flags);
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001025 s = (u32 *)&tmp[used];
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001026 d = &crng->state[4];
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001027 for (i = 0; i < 8; i++)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001028 *d++ ^= *s++;
1029 spin_unlock_irqrestore(&crng->lock, flags);
1030}
1031
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001032static void crng_backtrack_protect(u8 tmp[CHACHA_BLOCK_SIZE], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001033{
Eric Biggers5d73d1e2021-12-20 16:41:56 -06001034 _crng_backtrack_protect(select_crng(), tmp, used);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001035}
1036
Theodore Ts'oe192be92016-06-12 18:13:36 -04001037static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
1038{
Eric Biggers1ca1b912018-11-16 17:26:21 -08001039 ssize_t ret = 0, i = CHACHA_BLOCK_SIZE;
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001040 u8 tmp[CHACHA_BLOCK_SIZE] __aligned(4);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001041 int large_request = (nbytes > 256);
1042
1043 while (nbytes) {
1044 if (large_request && need_resched()) {
1045 if (signal_pending(current)) {
1046 if (ret == 0)
1047 ret = -ERESTARTSYS;
1048 break;
1049 }
1050 schedule();
1051 }
1052
1053 extract_crng(tmp);
Eric Biggers1ca1b912018-11-16 17:26:21 -08001054 i = min_t(int, nbytes, CHACHA_BLOCK_SIZE);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001055 if (copy_to_user(buf, tmp, i)) {
1056 ret = -EFAULT;
1057 break;
1058 }
1059
1060 nbytes -= i;
1061 buf += i;
1062 ret += i;
1063 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001064 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001065
1066 /* Wipe data just written to memory */
1067 memzero_explicit(tmp, sizeof(tmp));
1068
1069 return ret;
1070}
1071
Theodore Ts'oe192be92016-06-12 18:13:36 -04001072/*********************************************************************
1073 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 * Entropy input management
1075 *
1076 *********************************************************************/
1077
1078/* There is one of these per entropy source */
1079struct timer_rand_state {
1080 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001081 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082};
1083
Theodore Ts'o644008d2013-11-03 16:40:53 -05001084#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
1085
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001086/*
Theodore Ts'oe192be92016-06-12 18:13:36 -04001087 * Add device- or boot-specific data to the input pool to help
1088 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001089 *
Theodore Ts'oe192be92016-06-12 18:13:36 -04001090 * None of this adds any entropy; it is meant to avoid the problem of
1091 * the entropy pool having similar initial state across largely
1092 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001093 */
1094void add_device_randomness(const void *buf, unsigned int size)
1095{
Theodore Ts'o61875f32013-09-21 13:58:22 -04001096 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001097 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001098
Theodore Ts'odc12baa2018-04-11 14:58:27 -04001099 if (!crng_ready() && size)
1100 crng_slow_load(buf, size);
Kees Cookee7998c2017-07-12 14:34:04 -07001101
Theodore Ts'o59108952013-09-12 14:10:25 -04001102 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001103 spin_lock_irqsave(&input_pool.lock, flags);
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001104 _mix_pool_bytes(buf, size);
1105 _mix_pool_bytes(&time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001106 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001107}
1108EXPORT_SYMBOL(add_device_randomness);
1109
Theodore Ts'o644008d2013-11-03 16:40:53 -05001110static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001111
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112/*
1113 * This function adds entropy to the entropy "pool" by using timing
1114 * delays. It uses the timer_rand_state structure to make an estimate
1115 * of how many bits of entropy this call has added to the pool.
1116 *
1117 * The number "num" is also added to the pool - it should somehow describe
1118 * the type of event which just happened. This is currently 0-255 for
1119 * keyboard scan codes, and 256 upwards for interrupts.
1120 *
1121 */
1122static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1123{
1124 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 long jiffies;
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001126 unsigned int cycles;
1127 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 } sample;
1129 long delta, delta2, delta3;
1130
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001132 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 sample.num = num;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001134 mix_pool_bytes(&sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
1136 /*
1137 * Calculate number of bits of randomness we probably added.
1138 * We take into account the first, second and third-order deltas
1139 * in order to make our estimate.
1140 */
Qian Caie00d996a2020-02-25 11:27:04 -05001141 delta = sample.jiffies - READ_ONCE(state->last_time);
1142 WRITE_ONCE(state->last_time, sample.jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143
Qian Caie00d996a2020-02-25 11:27:04 -05001144 delta2 = delta - READ_ONCE(state->last_delta);
1145 WRITE_ONCE(state->last_delta, delta);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146
Qian Caie00d996a2020-02-25 11:27:04 -05001147 delta3 = delta2 - READ_ONCE(state->last_delta2);
1148 WRITE_ONCE(state->last_delta2, delta2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001150 if (delta < 0)
1151 delta = -delta;
1152 if (delta2 < 0)
1153 delta2 = -delta2;
1154 if (delta3 < 0)
1155 delta3 = -delta3;
1156 if (delta > delta2)
1157 delta = delta2;
1158 if (delta > delta3)
1159 delta = delta3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001161 /*
1162 * delta is now minimum absolute delta.
1163 * Round down by 1 bit on general principles,
Yangtao Li727d4992020-01-07 16:55:34 -05001164 * and limit entropy estimate to 12 bits.
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001165 */
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001166 credit_entropy_bits(min_t(int, fls(delta >> 1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167}
1168
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001169void add_input_randomness(unsigned int type, unsigned int code,
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001170 unsigned int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171{
1172 static unsigned char last_value;
1173
1174 /* ignore autorepeat and the like */
1175 if (value == last_value)
1176 return;
1177
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 last_value = value;
1179 add_timer_randomness(&input_timer_state,
1180 (type << 4) ^ code ^ (code >> 4) ^ value);
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001181 trace_add_input_randomness(POOL_ENTROPY_BITS());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001183EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001185static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1186
Theodore Ts'o43759d42014-06-14 21:43:13 -04001187#ifdef ADD_INTERRUPT_BENCH
1188static unsigned long avg_cycles, avg_deviation;
1189
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001190#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1191#define FIXED_1_2 (1 << (AVG_SHIFT - 1))
Theodore Ts'o43759d42014-06-14 21:43:13 -04001192
1193static void add_interrupt_bench(cycles_t start)
1194{
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001195 long delta = random_get_entropy() - start;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001196
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001197 /* Use a weighted moving average */
1198 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1199 avg_cycles += delta;
1200 /* And average deviation */
1201 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1202 avg_deviation += delta;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001203}
1204#else
1205#define add_interrupt_bench(x)
1206#endif
1207
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001208static u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001209{
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001210 u32 *ptr = (u32 *)regs;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001211 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001212
1213 if (regs == NULL)
1214 return 0;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001215 idx = READ_ONCE(f->reg_idx);
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001216 if (idx >= sizeof(struct pt_regs) / sizeof(u32))
Theodore Ts'o92e75422017-06-07 19:01:32 -04001217 idx = 0;
1218 ptr += idx++;
1219 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitz9dfa7bb2017-04-30 19:49:21 +12001220 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001221}
1222
Sebastian Andrzej Siewior703f7062021-12-07 13:17:33 +01001223void add_interrupt_randomness(int irq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224{
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001225 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
1226 struct pt_regs *regs = get_irq_regs();
1227 unsigned long now = jiffies;
1228 cycles_t cycles = random_get_entropy();
1229 u32 c_high, j_high;
1230 u64 ip;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001231
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001232 if (cycles == 0)
1233 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001234 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1235 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001236 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1237 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001238 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001239 fast_pool->pool[2] ^= ip;
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001240 fast_pool->pool[3] ^=
1241 (sizeof(ip) > 4) ? ip >> 32 : get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001242
Theodore Ts'o43759d42014-06-14 21:43:13 -04001243 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001244 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001245
Theodore Ts'o43838a22018-04-11 13:27:52 -04001246 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001247 if ((fast_pool->count >= 64) &&
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001248 crng_fast_load((u8 *)fast_pool->pool, sizeof(fast_pool->pool)) > 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001249 fast_pool->count = 0;
1250 fast_pool->last = now;
1251 }
1252 return;
1253 }
1254
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001255 if ((fast_pool->count < 64) && !time_after(now, fast_pool->last + HZ))
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001256 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001258 if (!spin_trylock(&input_pool.lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 return;
1260
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001261 fast_pool->last = now;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001262 __mix_pool_bytes(&fast_pool->pool, sizeof(fast_pool->pool));
1263 spin_unlock(&input_pool.lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001264
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001265 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001266
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001267 /* award one bit for the contents of the fast pool */
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001268 credit_entropy_bits(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001270EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
David Howells93614012006-09-30 20:45:40 +02001272#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273void add_disk_randomness(struct gendisk *disk)
1274{
1275 if (!disk || !disk->random)
1276 return;
1277 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001278 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001279 trace_add_disk_randomness(disk_devt(disk), POOL_ENTROPY_BITS());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001281EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001282#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284/*********************************************************************
1285 *
1286 * Entropy extraction routines
1287 *
1288 *********************************************************************/
1289
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290/*
Greg Price19fa5be12013-11-29 15:50:06 -05001291 * This function decides how many bytes to actually take from the
1292 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 */
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001294static size_t account(size_t nbytes, int min)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295{
Jason A. Donenfelda254a0e2022-01-17 18:43:02 +01001296 int entropy_count, orig;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001297 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001299 BUG_ON(input_pool.entropy_count > POOL_FRACBITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
1301 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001302retry:
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001303 entropy_count = orig = READ_ONCE(input_pool.entropy_count);
Yangtao Li870e05b2020-01-07 16:10:28 -05001304 if (WARN_ON(entropy_count < 0)) {
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001305 pr_warn("negative entropy count: count %d\n", entropy_count);
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001306 entropy_count = 0;
1307 }
Jason A. Donenfelda254a0e2022-01-17 18:43:02 +01001308
1309 /* never pull more than available */
1310 ibytes = min_t(size_t, nbytes, entropy_count >> (POOL_ENTROPY_SHIFT + 3));
1311 if (ibytes < min)
1312 ibytes = 0;
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001313 nfrac = ibytes << (POOL_ENTROPY_SHIFT + 3);
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001314 if ((size_t)entropy_count > nfrac)
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001315 entropy_count -= nfrac;
1316 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001317 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001318
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001319 if (cmpxchg(&input_pool.entropy_count, orig, entropy_count) != orig)
Greg Price0fb7a012013-12-05 19:32:19 -05001320 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001322 trace_debit_entropy(8 * ibytes);
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001323 if (ibytes && POOL_ENTROPY_BITS() < random_write_wakeup_bits) {
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001324 wake_up_interruptible(&random_write_wait);
Theodore Ts'ob9809552013-03-04 11:59:12 -05001325 kill_fasync(&fasync, SIGIO, POLL_OUT);
1326 }
1327
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001328 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329}
1330
Greg Price19fa5be12013-11-29 15:50:06 -05001331/*
Eric Biggers118a4412021-03-21 22:14:00 -07001332 * This function does the actual extraction for extract_entropy.
Greg Price19fa5be12013-11-29 15:50:06 -05001333 *
1334 * Note: we assume that .poolwords is a multiple of 16 words.
1335 */
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001336static void extract_buf(u8 *out)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337{
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001338 struct blake2s_state state __aligned(__alignof__(unsigned long));
1339 u8 hash[BLAKE2S_HASH_SIZE];
1340 unsigned long *salt;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001341 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001343 blake2s_init(&state, sizeof(hash));
1344
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001346 * If we have an architectural hardware random number
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001347 * generator, use it for BLAKE2's salt & personal fields.
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001348 */
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001349 for (salt = (unsigned long *)&state.h[4];
1350 salt < (unsigned long *)&state.h[8]; ++salt) {
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001351 unsigned long v;
1352 if (!arch_get_random_long(&v))
1353 break;
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001354 *salt ^= v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001355 }
1356
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001357 /* Generate a hash across the pool */
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001358 spin_lock_irqsave(&input_pool.lock, flags);
Jason A. Donenfeld6c0eace2022-01-15 14:40:04 +01001359 blake2s_update(&state, (const u8 *)input_pool_data, POOL_BYTES);
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001360 blake2s_final(&state, hash); /* final zeros out state */
Theodore Ts'o46884442013-12-17 21:16:39 -05001361
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001362 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001363 * We mix the hash back into the pool to prevent backtracking
1364 * attacks (where the attacker knows the state of the pool
1365 * plus the current outputs, and attempts to find previous
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001366 * outputs), unless the hash function can be inverted. By
1367 * mixing at least a hash worth of hash data back, we make
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001368 * brute-forcing the feedback as hard as brute-forcing the
1369 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 */
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001371 __mix_pool_bytes(hash, sizeof(hash));
1372 spin_unlock_irqrestore(&input_pool.lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001373
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001374 /* Note that EXTRACT_SIZE is half of hash size here, because above
1375 * we've dumped the full length back into mixer. By reducing the
1376 * amount that we emit, we retain a level of forward secrecy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 */
Jason A. Donenfeld9f9eff82021-12-21 16:31:27 +01001378 memcpy(out, hash, EXTRACT_SIZE);
1379 memzero_explicit(hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380}
1381
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001382static ssize_t _extract_entropy(void *buf, size_t nbytes)
Theodore Ts'oe192be92016-06-12 18:13:36 -04001383{
1384 ssize_t ret = 0, i;
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001385 u8 tmp[EXTRACT_SIZE];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001386
1387 while (nbytes) {
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001388 extract_buf(tmp);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001389 i = min_t(int, nbytes, EXTRACT_SIZE);
1390 memcpy(buf, tmp, i);
1391 nbytes -= i;
1392 buf += i;
1393 ret += i;
1394 }
1395
1396 /* Wipe data just returned from memory */
1397 memzero_explicit(tmp, sizeof(tmp));
1398
1399 return ret;
1400}
1401
Greg Price19fa5be12013-11-29 15:50:06 -05001402/*
1403 * This function extracts randomness from the "entropy pool", and
1404 * returns it in a buffer.
1405 *
1406 * The min parameter specifies the minimum amount we can pull before
Jason A. Donenfeld8b2d9532022-01-12 15:28:21 +01001407 * failing to avoid races that defeat catastrophic reseeding.
Greg Price19fa5be12013-11-29 15:50:06 -05001408 */
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001409static ssize_t extract_entropy(void *buf, size_t nbytes, int min)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410{
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001411 trace_extract_entropy(nbytes, POOL_ENTROPY_BITS(), _RET_IP_);
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001412 nbytes = account(nbytes, min);
1413 return _extract_entropy(buf, nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414}
1415
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001416#define warn_unseeded_randomness(previous) \
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001417 _warn_unseeded_randomness(__func__, (void *)_RET_IP_, (previous))
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001418
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001419static void _warn_unseeded_randomness(const char *func_name, void *caller, void **previous)
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001420{
1421#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1422 const bool print_once = false;
1423#else
1424 static bool print_once __read_mostly;
1425#endif
1426
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001427 if (print_once || crng_ready() ||
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001428 (previous && (caller == READ_ONCE(*previous))))
1429 return;
1430 WRITE_ONCE(*previous, caller);
1431#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1432 print_once = true;
1433#endif
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001434 if (__ratelimit(&unseeded_warning))
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001435 printk_deferred(KERN_NOTICE "random: %s called from %pS with crng_init=%d\n",
1436 func_name, caller, crng_init);
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001437}
1438
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439/*
1440 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001441 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001442 * TCP sequence numbers, etc. It does not rely on the hardware random
1443 * number generator. For random bytes direct from the hardware RNG
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001444 * (when available), use get_random_bytes_arch(). In order to ensure
1445 * that the randomness provided by this function is okay, the function
1446 * wait_for_random_bytes() should be called and return 0 at least once
1447 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 */
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001449static void _get_random_bytes(void *buf, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450{
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001451 u8 tmp[CHACHA_BLOCK_SIZE] __aligned(4);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001452
Theodore Ts'o59108952013-09-12 14:10:25 -04001453 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001454
Eric Biggers1ca1b912018-11-16 17:26:21 -08001455 while (nbytes >= CHACHA_BLOCK_SIZE) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001456 extract_crng(buf);
Eric Biggers1ca1b912018-11-16 17:26:21 -08001457 buf += CHACHA_BLOCK_SIZE;
1458 nbytes -= CHACHA_BLOCK_SIZE;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001459 }
1460
1461 if (nbytes > 0) {
1462 extract_crng(tmp);
1463 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001464 crng_backtrack_protect(tmp, nbytes);
1465 } else
Eric Biggers1ca1b912018-11-16 17:26:21 -08001466 crng_backtrack_protect(tmp, CHACHA_BLOCK_SIZE);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001467 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001468}
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001469
1470void get_random_bytes(void *buf, int nbytes)
1471{
1472 static void *previous;
1473
1474 warn_unseeded_randomness(&previous);
1475 _get_random_bytes(buf, nbytes);
1476}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001477EXPORT_SYMBOL(get_random_bytes);
1478
Linus Torvalds50ee7522019-09-28 16:53:52 -07001479/*
1480 * Each time the timer fires, we expect that we got an unpredictable
1481 * jump in the cycle counter. Even if the timer is running on another
1482 * CPU, the timer activity will be touching the stack of the CPU that is
1483 * generating entropy..
1484 *
1485 * Note that we don't re-arm the timer in the timer itself - we are
1486 * happy to be scheduled away, since that just makes the load more
1487 * complex, but we do not want the timer to keep ticking unless the
1488 * entropy loop is running.
1489 *
1490 * So the re-arming always happens in the entropy loop itself.
1491 */
1492static void entropy_timer(struct timer_list *t)
1493{
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001494 credit_entropy_bits(1);
Linus Torvalds50ee7522019-09-28 16:53:52 -07001495}
1496
1497/*
1498 * If we have an actual cycle counter, see if we can
1499 * generate enough entropy with timing noise
1500 */
1501static void try_to_generate_entropy(void)
1502{
1503 struct {
1504 unsigned long now;
1505 struct timer_list timer;
1506 } stack;
1507
1508 stack.now = random_get_entropy();
1509
1510 /* Slow counter - or none. Don't even bother */
1511 if (stack.now == random_get_entropy())
1512 return;
1513
1514 timer_setup_on_stack(&stack.timer, entropy_timer, 0);
1515 while (!crng_ready()) {
1516 if (!timer_pending(&stack.timer))
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001517 mod_timer(&stack.timer, jiffies + 1);
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001518 mix_pool_bytes(&stack.now, sizeof(stack.now));
Linus Torvalds50ee7522019-09-28 16:53:52 -07001519 schedule();
1520 stack.now = random_get_entropy();
1521 }
1522
1523 del_timer_sync(&stack.timer);
1524 destroy_timer_on_stack(&stack.timer);
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001525 mix_pool_bytes(&stack.now, sizeof(stack.now));
Linus Torvalds50ee7522019-09-28 16:53:52 -07001526}
1527
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001528/*
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001529 * Wait for the urandom pool to be seeded and thus guaranteed to supply
1530 * cryptographically secure random numbers. This applies to: the /dev/urandom
1531 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
1532 * family of functions. Using any of these functions without first calling
1533 * this function forfeits the guarantee of security.
1534 *
1535 * Returns: 0 if the urandom pool has been seeded.
1536 * -ERESTARTSYS if the function was interrupted by a signal.
1537 */
1538int wait_for_random_bytes(void)
1539{
1540 if (likely(crng_ready()))
1541 return 0;
Linus Torvalds50ee7522019-09-28 16:53:52 -07001542
1543 do {
1544 int ret;
1545 ret = wait_event_interruptible_timeout(crng_init_wait, crng_ready(), HZ);
1546 if (ret)
1547 return ret > 0 ? 0 : ret;
1548
1549 try_to_generate_entropy();
1550 } while (!crng_ready());
1551
1552 return 0;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001553}
1554EXPORT_SYMBOL(wait_for_random_bytes);
1555
1556/*
Jason A. Donenfeld9a472492018-07-31 21:11:00 +02001557 * Returns whether or not the urandom pool has been seeded and thus guaranteed
1558 * to supply cryptographically secure random numbers. This applies to: the
1559 * /dev/urandom device, the get_random_bytes function, and the get_random_{u32,
1560 * ,u64,int,long} family of functions.
1561 *
1562 * Returns: true if the urandom pool has been seeded.
1563 * false if the urandom pool has not been seeded.
1564 */
1565bool rng_is_initialized(void)
1566{
1567 return crng_ready();
1568}
1569EXPORT_SYMBOL(rng_is_initialized);
1570
1571/*
Herbert Xu205a5252015-06-09 18:19:39 +08001572 * Add a callback function that will be invoked when the nonblocking
1573 * pool is initialised.
1574 *
1575 * returns: 0 if callback is successfully added
1576 * -EALREADY if pool is already initialised (callback not called)
1577 * -ENOENT if module for callback is not alive
1578 */
1579int add_random_ready_callback(struct random_ready_callback *rdy)
1580{
1581 struct module *owner;
1582 unsigned long flags;
1583 int err = -EALREADY;
1584
Theodore Ts'oe192be92016-06-12 18:13:36 -04001585 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001586 return err;
1587
1588 owner = rdy->owner;
1589 if (!try_module_get(owner))
1590 return -ENOENT;
1591
1592 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001593 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001594 goto out;
1595
1596 owner = NULL;
1597
1598 list_add(&rdy->list, &random_ready_list);
1599 err = 0;
1600
1601out:
1602 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1603
1604 module_put(owner);
1605
1606 return err;
1607}
1608EXPORT_SYMBOL(add_random_ready_callback);
1609
1610/*
1611 * Delete a previously registered readiness callback function.
1612 */
1613void del_random_ready_callback(struct random_ready_callback *rdy)
1614{
1615 unsigned long flags;
1616 struct module *owner = NULL;
1617
1618 spin_lock_irqsave(&random_ready_list_lock, flags);
1619 if (!list_empty(&rdy->list)) {
1620 list_del_init(&rdy->list);
1621 owner = rdy->owner;
1622 }
1623 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1624
1625 module_put(owner);
1626}
1627EXPORT_SYMBOL(del_random_ready_callback);
1628
1629/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001630 * This function will use the architecture-specific hardware random
1631 * number generator if it is available. The arch-specific hw RNG will
1632 * almost certainly be faster than what we can do in software, but it
1633 * is impossible to verify that it is implemented securely (as
1634 * opposed, to, say, the AES encryption of a sequence number using a
1635 * key known by the NSA). So it's useful if we need the speed, but
1636 * only if we're willing to trust the hardware manufacturer not to
1637 * have put in a back door.
Tobin C. Harding753d4332018-06-22 09:15:32 +10001638 *
1639 * Return number of bytes filled in.
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001640 */
Tobin C. Harding753d4332018-06-22 09:15:32 +10001641int __must_check get_random_bytes_arch(void *buf, int nbytes)
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001642{
Tobin C. Harding753d4332018-06-22 09:15:32 +10001643 int left = nbytes;
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001644 u8 *p = buf;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001645
Tobin C. Harding753d4332018-06-22 09:15:32 +10001646 trace_get_random_bytes_arch(left, _RET_IP_);
1647 while (left) {
H. Peter Anvin63d77172011-07-31 13:54:50 -07001648 unsigned long v;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001649 int chunk = min_t(int, left, sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001650
H. Peter Anvin63d77172011-07-31 13:54:50 -07001651 if (!arch_get_random_long(&v))
1652 break;
Tobin C. Harding8ddd6ef2018-06-22 09:15:31 +10001653
Luck, Tonybd29e562011-11-16 10:50:56 -08001654 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001655 p += chunk;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001656 left -= chunk;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001657 }
1658
Tobin C. Harding753d4332018-06-22 09:15:32 +10001659 return nbytes - left;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001661EXPORT_SYMBOL(get_random_bytes_arch);
1662
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663/*
1664 * init_std_data - initialize pool with system data
1665 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 * This function clears the pool's entropy count and mixes some system
1667 * data into the pool to prepare it for use. The pool is not cleared
1668 * as that can only decrease the entropy in the pool.
1669 */
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001670static void __init init_std_data(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001672 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001673 ktime_t now = ktime_get_real();
1674 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001676 mix_pool_bytes(&now, sizeof(now));
Jason A. Donenfeld91ec0fe2022-01-09 17:32:02 +01001677 for (i = POOL_BYTES; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001678 if (!arch_get_random_seed_long(&rv) &&
1679 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001680 rv = random_get_entropy();
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001681 mix_pool_bytes(&rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001682 }
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001683 mix_pool_bytes(utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684}
1685
Tony Luckcbc96b72012-07-23 09:47:57 -07001686/*
1687 * Note that setup_arch() may call add_device_randomness()
1688 * long before we get here. This allows seeding of the pools
1689 * with some platform dependent data very early in the boot
1690 * process. But it limits our options here. We must use
1691 * statically allocated structures that already have all
1692 * initializations complete at compile time. We should also
1693 * take care not to overwrite the precious per platform data
1694 * we were given.
1695 */
Kees Cookd5553522019-04-19 23:27:05 -04001696int __init rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697{
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001698 init_std_data();
Dominik Brodowskif7e67b82021-12-29 22:10:03 +01001699 if (crng_need_final_init)
Dominik Brodowski9d5505f2022-01-30 22:03:20 +01001700 crng_finalize_init();
Dominik Brodowskiebf76062022-01-30 22:03:19 +01001701 crng_initialize_primary();
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001702 crng_global_init_time = jiffies;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001703 if (ratelimit_disable) {
1704 urandom_warning.interval = 0;
1705 unseeded_warning.interval = 0;
1706 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 return 0;
1708}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709
David Howells93614012006-09-30 20:45:40 +02001710#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711void rand_initialize_disk(struct gendisk *disk)
1712{
1713 struct timer_rand_state *state;
1714
1715 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001716 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 * source.
1718 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001719 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001720 if (state) {
1721 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001723 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724}
David Howells93614012006-09-30 20:45:40 +02001725#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001727static ssize_t urandom_read_nowarn(struct file *file, char __user *buf,
1728 size_t nbytes, loff_t *ppos)
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08001729{
1730 int ret;
1731
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001732 nbytes = min_t(size_t, nbytes, INT_MAX >> (POOL_ENTROPY_SHIFT + 3));
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08001733 ret = extract_crng_user(buf, nbytes);
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001734 trace_urandom_read(8 * nbytes, 0, POOL_ENTROPY_BITS());
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08001735 return ret;
1736}
1737
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001738static ssize_t urandom_read(struct file *file, char __user *buf, size_t nbytes,
1739 loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740{
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001741 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05001742
Theodore Ts'oe192be92016-06-12 18:13:36 -04001743 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001744 maxwarn--;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001745 if (__ratelimit(&urandom_warning))
Yangtao Li12cd53a2019-06-07 14:25:15 -04001746 pr_notice("%s: uninitialized urandom read (%zd bytes read)\n",
1747 current->comm, nbytes);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001748 }
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08001749
1750 return urandom_read_nowarn(file, buf, nbytes, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751}
1752
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001753static ssize_t random_read(struct file *file, char __user *buf, size_t nbytes,
1754 loff_t *ppos)
Andy Lutomirski30c08ef2019-12-23 00:20:48 -08001755{
1756 int ret;
1757
1758 ret = wait_for_random_bytes();
1759 if (ret != 0)
1760 return ret;
1761 return urandom_read_nowarn(file, buf, nbytes, ppos);
1762}
1763
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001764static __poll_t random_poll(struct file *file, poll_table *wait)
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001765{
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001766 __poll_t mask;
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001767
Andy Lutomirski30c08ef2019-12-23 00:20:48 -08001768 poll_wait(file, &crng_init_wait, wait);
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001769 poll_wait(file, &random_write_wait, wait);
1770 mask = 0;
Andy Lutomirski30c08ef2019-12-23 00:20:48 -08001771 if (crng_ready())
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001772 mask |= EPOLLIN | EPOLLRDNORM;
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001773 if (POOL_ENTROPY_BITS() < random_write_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001774 mask |= EPOLLOUT | EPOLLWRNORM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 return mask;
1776}
1777
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001778static int write_pool(const char __user *buffer, size_t count)
Matt Mackall7f397dc2007-05-29 21:58:10 -05001779{
1780 size_t bytes;
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001781 u32 t, buf[16];
Matt Mackall7f397dc2007-05-29 21:58:10 -05001782 const char __user *p = buffer;
1783
1784 while (count > 0) {
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001785 int b, i = 0;
1786
Matt Mackall7f397dc2007-05-29 21:58:10 -05001787 bytes = min(count, sizeof(buf));
1788 if (copy_from_user(&buf, p, bytes))
1789 return -EFAULT;
1790
Jason A. Donenfeldd38bb082022-01-09 17:48:58 +01001791 for (b = bytes; b > 0; b -= sizeof(u32), i++) {
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001792 if (!arch_get_random_int(&t))
1793 break;
1794 buf[i] ^= t;
1795 }
1796
Matt Mackall7f397dc2007-05-29 21:58:10 -05001797 count -= bytes;
1798 p += bytes;
1799
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001800 mix_pool_bytes(buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001801 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001802 }
1803
1804 return 0;
1805}
1806
Matt Mackall90b75ee2008-04-29 01:02:55 -07001807static ssize_t random_write(struct file *file, const char __user *buffer,
1808 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001810 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001812 ret = write_pool(buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05001813 if (ret)
1814 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815
Matt Mackall7f397dc2007-05-29 21:58:10 -05001816 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817}
1818
Matt Mackall43ae4862008-04-29 01:02:58 -07001819static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820{
1821 int size, ent_count;
1822 int __user *p = (int __user *)arg;
1823 int retval;
1824
1825 switch (cmd) {
1826 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001827 /* inherently racy, no point locking */
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001828 ent_count = POOL_ENTROPY_BITS();
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001829 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 return -EFAULT;
1831 return 0;
1832 case RNDADDTOENTCNT:
1833 if (!capable(CAP_SYS_ADMIN))
1834 return -EPERM;
1835 if (get_user(ent_count, p))
1836 return -EFAULT;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001837 return credit_entropy_bits_safe(ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 case RNDADDENTROPY:
1839 if (!capable(CAP_SYS_ADMIN))
1840 return -EPERM;
1841 if (get_user(ent_count, p++))
1842 return -EFAULT;
1843 if (ent_count < 0)
1844 return -EINVAL;
1845 if (get_user(size, p++))
1846 return -EFAULT;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001847 retval = write_pool((const char __user *)p, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 if (retval < 0)
1849 return retval;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001850 return credit_entropy_bits_safe(ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 case RNDZAPENTCNT:
1852 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001853 /*
1854 * Clear the entropy pool counters. We no longer clear
1855 * the entropy pool, as that's silly.
1856 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 if (!capable(CAP_SYS_ADMIN))
1858 return -EPERM;
Jason A. Donenfeld042e2932022-01-28 23:44:03 +01001859 if (xchg(&input_pool.entropy_count, 0) && random_write_wakeup_bits) {
1860 wake_up_interruptible(&random_write_wait);
1861 kill_fasync(&fasync, SIGIO, POLL_OUT);
1862 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 return 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001864 case RNDRESEEDCRNG:
1865 if (!capable(CAP_SYS_ADMIN))
1866 return -EPERM;
1867 if (crng_init < 2)
1868 return -ENODATA;
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01001869 crng_reseed(&primary_crng, true);
Eric Biggers009ba852021-12-20 16:41:57 -06001870 WRITE_ONCE(crng_global_init_time, jiffies - 1);
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001871 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 default:
1873 return -EINVAL;
1874 }
1875}
1876
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001877static int random_fasync(int fd, struct file *filp, int on)
1878{
1879 return fasync_helper(fd, filp, on, &fasync);
1880}
1881
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001882const struct file_operations random_fops = {
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001883 .read = random_read,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 .write = random_write,
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001885 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001886 .unlocked_ioctl = random_ioctl,
Arnd Bergmann507e4e22018-09-07 11:10:23 +02001887 .compat_ioctl = compat_ptr_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001888 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001889 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890};
1891
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001892const struct file_operations urandom_fops = {
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001893 .read = urandom_read,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001895 .unlocked_ioctl = random_ioctl,
Jason A. Donenfeld4aa37c42019-12-17 18:24:55 +01001896 .compat_ioctl = compat_ptr_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001897 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001898 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899};
1900
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001901SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count, unsigned int,
1902 flags)
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001903{
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001904 int ret;
1905
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001906 if (flags & ~(GRND_NONBLOCK | GRND_RANDOM | GRND_INSECURE))
Andy Lutomirski75551db2019-12-23 00:20:46 -08001907 return -EINVAL;
1908
1909 /*
1910 * Requesting insecure and blocking randomness at the same time makes
1911 * no sense.
1912 */
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001913 if ((flags & (GRND_INSECURE | GRND_RANDOM)) == (GRND_INSECURE | GRND_RANDOM))
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001914 return -EINVAL;
1915
1916 if (count > INT_MAX)
1917 count = INT_MAX;
1918
Andy Lutomirski75551db2019-12-23 00:20:46 -08001919 if (!(flags & GRND_INSECURE) && !crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001920 if (flags & GRND_NONBLOCK)
1921 return -EAGAIN;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001922 ret = wait_for_random_bytes();
1923 if (unlikely(ret))
1924 return ret;
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001925 }
Andy Lutomirskic6f1deb2019-12-23 00:20:45 -08001926 return urandom_read_nowarn(NULL, buf, count, NULL);
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001927}
1928
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929/********************************************************************
1930 *
1931 * Sysctl interface
1932 *
1933 ********************************************************************/
1934
1935#ifdef CONFIG_SYSCTL
1936
1937#include <linux/sysctl.h>
1938
Andy Lutomirskic95ea0c2019-12-23 00:20:51 -08001939static int min_write_thresh;
Jason A. Donenfeld5b87adf2022-01-13 16:11:21 +01001940static int max_write_thresh = POOL_BITS;
Fabio Estevamdb61ffe2017-01-31 14:36:07 -02001941static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942static char sysctl_bootid[16];
1943
1944/*
Greg Pricef22052b2013-11-29 14:58:16 -05001945 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 * UUID. The difference is in whether table->data is NULL; if it is,
1947 * then a new UUID is generated and returned to the user.
1948 *
Greg Pricef22052b2013-11-29 14:58:16 -05001949 * If the user accesses this via the proc interface, the UUID will be
1950 * returned as an ASCII string in the standard UUID format; if via the
1951 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 */
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001953static int proc_do_uuid(struct ctl_table *table, int write, void *buffer,
1954 size_t *lenp, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955{
Joe Perchesa1514272013-06-13 19:37:35 -07001956 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 unsigned char buf[64], tmp_uuid[16], *uuid;
1958
1959 uuid = table->data;
1960 if (!uuid) {
1961 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001963 } else {
1964 static DEFINE_SPINLOCK(bootid_spinlock);
1965
1966 spin_lock(&bootid_spinlock);
1967 if (!uuid[8])
1968 generate_random_uuid(uuid);
1969 spin_unlock(&bootid_spinlock);
1970 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971
Joe Perches35900772009-12-14 18:01:11 -08001972 sprintf(buf, "%pU", uuid);
1973
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 fake_table.data = buf;
1975 fake_table.maxlen = sizeof(buf);
1976
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001977 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978}
1979
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001980/*
1981 * Return entropy available scaled to integral bits
1982 */
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01001983static int proc_do_entropy(struct ctl_table *table, int write, void *buffer,
1984 size_t *lenp, loff_t *ppos)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001985{
Joe Perches5eb10d92014-06-06 14:37:58 -07001986 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001987 int entropy_count;
1988
Jason A. Donenfeldb3d51c12022-01-14 16:48:35 +01001989 entropy_count = *(int *)table->data >> POOL_ENTROPY_SHIFT;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001990
1991 fake_table.data = &entropy_count;
1992 fake_table.maxlen = sizeof(entropy_count);
1993
1994 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
1995}
1996
Jason A. Donenfeld5b87adf2022-01-13 16:11:21 +01001997static int sysctl_poolsize = POOL_BITS;
Xiaoming Ni5475e8f2022-01-21 22:12:18 -08001998static struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 .procname = "poolsize",
2001 .data = &sysctl_poolsize,
2002 .maxlen = sizeof(int),
2003 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002004 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 },
2006 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 .procname = "entropy_avail",
2008 .maxlen = sizeof(int),
2009 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002010 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 .data = &input_pool.entropy_count,
2012 },
2013 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002015 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 .maxlen = sizeof(int),
2017 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002018 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 .extra1 = &min_write_thresh,
2020 .extra2 = &max_write_thresh,
2021 },
2022 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002023 .procname = "urandom_min_reseed_secs",
2024 .data = &random_min_urandom_seed,
2025 .maxlen = sizeof(int),
2026 .mode = 0644,
2027 .proc_handler = proc_dointvec,
2028 },
2029 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 .procname = "boot_id",
2031 .data = &sysctl_bootid,
2032 .maxlen = 16,
2033 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002034 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 },
2036 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 .procname = "uuid",
2038 .maxlen = 16,
2039 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002040 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002042#ifdef ADD_INTERRUPT_BENCH
2043 {
2044 .procname = "add_interrupt_avg_cycles",
2045 .data = &avg_cycles,
2046 .maxlen = sizeof(avg_cycles),
2047 .mode = 0444,
2048 .proc_handler = proc_doulongvec_minmax,
2049 },
2050 {
2051 .procname = "add_interrupt_avg_deviation",
2052 .data = &avg_deviation,
2053 .maxlen = sizeof(avg_deviation),
2054 .mode = 0444,
2055 .proc_handler = proc_doulongvec_minmax,
2056 },
2057#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002058 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059};
Xiaoming Ni5475e8f2022-01-21 22:12:18 -08002060
2061/*
2062 * rand_initialize() is called before sysctl_init(),
2063 * so we cannot call register_sysctl_init() in rand_initialize()
2064 */
2065static int __init random_sysctls_init(void)
2066{
2067 register_sysctl_init("kernel/random", random_table);
2068 return 0;
2069}
2070device_initcall(random_sysctls_init);
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01002071#endif /* CONFIG_SYSCTL */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002073struct batched_entropy {
2074 union {
Eric Biggers1ca1b912018-11-16 17:26:21 -08002075 u64 entropy_u64[CHACHA_BLOCK_SIZE / sizeof(u64)];
2076 u32 entropy_u32[CHACHA_BLOCK_SIZE / sizeof(u32)];
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002077 };
2078 unsigned int position;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002079 spinlock_t batch_lock;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002080};
Eric Biggersb1132de2016-05-04 21:08:39 -04002081
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082/*
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002083 * Get a random word for internal kernel use only. The quality of the random
Jason A. Donenfeld69efea72020-02-21 21:10:37 +01002084 * number is good as /dev/urandom, but there is no backtrack protection, with
2085 * the goal of being quite fast and not depleting entropy. In order to ensure
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002086 * that the randomness provided by this function is okay, the function
Jason A. Donenfeld69efea72020-02-21 21:10:37 +01002087 * wait_for_random_bytes() should be called and return 0 at least once at any
2088 * point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 */
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002090static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64) = {
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01002091 .batch_lock = __SPIN_LOCK_UNLOCKED(batched_entropy_u64.lock),
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002092};
2093
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002094u64 get_random_u64(void)
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002095{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002096 u64 ret;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002097 unsigned long flags;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002098 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002099 static void *previous;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002100
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002101 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002102
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002103 batch = raw_cpu_ptr(&batched_entropy_u64);
2104 spin_lock_irqsave(&batch->batch_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002105 if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
Eric Biggersa5e9f552018-09-11 20:05:10 -07002106 extract_crng((u8 *)batch->entropy_u64);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002107 batch->position = 0;
2108 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002109 ret = batch->entropy_u64[batch->position++];
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002110 spin_unlock_irqrestore(&batch->batch_lock, flags);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002111 return ret;
2112}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002113EXPORT_SYMBOL(get_random_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002114
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002115static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32) = {
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01002116 .batch_lock = __SPIN_LOCK_UNLOCKED(batched_entropy_u32.lock),
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002117};
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002118u32 get_random_u32(void)
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002119{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002120 u32 ret;
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002121 unsigned long flags;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002122 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002123 static void *previous;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002124
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002125 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002126
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002127 batch = raw_cpu_ptr(&batched_entropy_u32);
2128 spin_lock_irqsave(&batch->batch_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002129 if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
Eric Biggersa5e9f552018-09-11 20:05:10 -07002130 extract_crng((u8 *)batch->entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002131 batch->position = 0;
2132 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002133 ret = batch->entropy_u32[batch->position++];
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002134 spin_unlock_irqrestore(&batch->batch_lock, flags);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002135 return ret;
2136}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002137EXPORT_SYMBOL(get_random_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002138
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002139/* It's important to invalidate all potential batched entropy that might
2140 * be stored before the crng is initialized, which we can do lazily by
2141 * simply resetting the counter to zero so that it's re-extracted on the
2142 * next usage. */
2143static void invalidate_batched_entropy(void)
2144{
2145 int cpu;
2146 unsigned long flags;
2147
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01002148 for_each_possible_cpu(cpu) {
Sebastian Andrzej Siewiorb7d5dc22019-04-20 00:09:51 -04002149 struct batched_entropy *batched_entropy;
2150
2151 batched_entropy = per_cpu_ptr(&batched_entropy_u32, cpu);
2152 spin_lock_irqsave(&batched_entropy->batch_lock, flags);
2153 batched_entropy->position = 0;
2154 spin_unlock(&batched_entropy->batch_lock);
2155
2156 batched_entropy = per_cpu_ptr(&batched_entropy_u64, cpu);
2157 spin_lock(&batched_entropy->batch_lock);
2158 batched_entropy->position = 0;
2159 spin_unlock_irqrestore(&batched_entropy->batch_lock, flags);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002160 }
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002161}
2162
Jason Cooper99fdafd2016-10-11 13:53:52 -07002163/**
2164 * randomize_page - Generate a random, page aligned address
2165 * @start: The smallest acceptable address the caller will take.
2166 * @range: The size of the area, starting at @start, within which the
2167 * random address must fall.
2168 *
2169 * If @start + @range would overflow, @range is capped.
2170 *
2171 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2172 * @start was already page aligned. We now align it regardless.
2173 *
2174 * Return: A page aligned address within [start, start + range). On error,
2175 * @start is returned.
2176 */
Jason A. Donenfeld248045b2022-01-15 14:57:22 +01002177unsigned long randomize_page(unsigned long start, unsigned long range)
Jason Cooper99fdafd2016-10-11 13:53:52 -07002178{
2179 if (!PAGE_ALIGNED(start)) {
2180 range -= PAGE_ALIGN(start) - start;
2181 start = PAGE_ALIGN(start);
2182 }
2183
2184 if (start > ULONG_MAX - range)
2185 range = ULONG_MAX - start;
2186
2187 range >>= PAGE_SHIFT;
2188
2189 if (range == 0)
2190 return start;
2191
2192 return start + (get_random_long() % range << PAGE_SHIFT);
2193}
2194
Torsten Duwec84dbf62014-06-14 23:38:36 -04002195/* Interface for in-kernel drivers of true hardware RNGs.
2196 * Those devices may produce endless random bits and will be throttled
2197 * when our pool is full.
2198 */
2199void add_hwgenerator_randomness(const char *buffer, size_t count,
2200 size_t entropy)
2201{
Theodore Ts'o43838a22018-04-11 13:27:52 -04002202 if (unlikely(crng_init == 0)) {
Jason A. Donenfeld73c77332021-12-29 22:10:05 +01002203 size_t ret = crng_fast_load(buffer, count);
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01002204 mix_pool_bytes(buffer, ret);
Jason A. Donenfeld73c77332021-12-29 22:10:05 +01002205 count -= ret;
2206 buffer += ret;
2207 if (!count || crng_init == 0)
2208 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002209 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002210
Dominik Brodowskic321e902022-01-25 21:14:57 +01002211 /* Throttle writing if we're above the trickle threshold.
Theodore Ts'oe192be92016-06-12 18:13:36 -04002212 * We'll be woken up again once below random_write_wakeup_thresh,
Dominik Brodowskic321e902022-01-25 21:14:57 +01002213 * when the calling thread is about to terminate, or once
2214 * CRNG_RESEED_INTERVAL has lapsed.
Theodore Ts'oe192be92016-06-12 18:13:36 -04002215 */
Dominik Brodowskic321e902022-01-25 21:14:57 +01002216 wait_event_interruptible_timeout(random_write_wait,
Dominik Brodowskif7e67b82021-12-29 22:10:03 +01002217 !system_wq || kthread_should_stop() ||
Dominik Brodowskic321e902022-01-25 21:14:57 +01002218 POOL_ENTROPY_BITS() <= random_write_wakeup_bits,
2219 CRNG_RESEED_INTERVAL);
Jason A. Donenfeld90ed1e62022-01-12 17:18:08 +01002220 mix_pool_bytes(buffer, count);
2221 credit_entropy_bits(entropy);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002222}
2223EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);
Hsin-Yi Wang428826f2019-08-23 14:24:51 +08002224
2225/* Handle random seed passed by bootloader.
2226 * If the seed is trustworthy, it would be regarded as hardware RNGs. Otherwise
2227 * it would be regarded as device data.
2228 * The decision is controlled by CONFIG_RANDOM_TRUST_BOOTLOADER.
2229 */
2230void add_bootloader_randomness(const void *buf, unsigned int size)
2231{
2232 if (IS_ENABLED(CONFIG_RANDOM_TRUST_BOOTLOADER))
2233 add_hwgenerator_randomness(buf, size, size * 8);
2234 else
2235 add_device_randomness(buf, size);
2236}
Borislav Petkov3fd57e72019-10-01 19:50:23 +02002237EXPORT_SYMBOL_GPL(add_bootloader_randomness);