blob: 6de9126de843f6afc03d29a12ae27389b29b9526 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * random.c -- A strong random number generator
3 *
Matt Mackall9e95ce22005-04-16 15:25:56 -07004 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
7 * rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, and the entire permission notice in its entirety,
14 * including the disclaimer of warranties.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote
19 * products derived from this software without specific prior
20 * written permission.
21 *
22 * ALTERNATIVELY, this product may be distributed under the terms of
23 * the GNU General Public License, in which case the provisions of the GPL are
24 * required INSTEAD OF the above restrictions. (This clause is
25 * necessary due to a potential bad interaction between the GPL and
26 * the restrictions contained in a BSD-style copyright.)
27 *
28 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
31 * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
32 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
34 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
35 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
38 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
39 * DAMAGE.
40 */
41
42/*
43 * (now, with legal B.S. out of the way.....)
44 *
45 * This routine gathers environmental noise from device drivers, etc.,
46 * and returns good random numbers, suitable for cryptographic use.
47 * Besides the obvious cryptographic uses, these numbers are also good
48 * for seeding TCP sequence numbers, and other places where it is
49 * desirable to have numbers which are not only random, but hard to
50 * predict by an attacker.
51 *
52 * Theory of operation
53 * ===================
54 *
55 * Computers are very predictable devices. Hence it is extremely hard
56 * to produce truly random numbers on a computer --- as opposed to
57 * pseudo-random numbers, which can easily generated by using a
58 * algorithm. Unfortunately, it is very easy for attackers to guess
59 * the sequence of pseudo-random number generators, and for some
60 * applications this is not acceptable. So instead, we must try to
61 * gather "environmental noise" from the computer's environment, which
62 * must be hard for outside attackers to observe, and use that to
63 * generate random numbers. In a Unix environment, this is best done
64 * from inside the kernel.
65 *
66 * Sources of randomness from the environment include inter-keyboard
67 * timings, inter-interrupt timings from some interrupts, and other
68 * events which are both (a) non-deterministic and (b) hard for an
69 * outside observer to measure. Randomness from these sources are
70 * added to an "entropy pool", which is mixed using a CRC-like function.
71 * This is not cryptographically strong, but it is adequate assuming
72 * the randomness is not chosen maliciously, and it is fast enough that
73 * the overhead of doing it on every interrupt is very reasonable.
74 * As random bytes are mixed into the entropy pool, the routines keep
75 * an *estimate* of how many bits of randomness have been stored into
76 * the random number generator's internal state.
77 *
78 * When random bytes are desired, they are obtained by taking the SHA
79 * hash of the contents of the "entropy pool". The SHA hash avoids
80 * exposing the internal state of the entropy pool. It is believed to
81 * be computationally infeasible to derive any useful information
82 * about the input of SHA from its output. Even if it is possible to
83 * analyze SHA in some clever way, as long as the amount of data
84 * returned from the generator is less than the inherent entropy in
85 * the pool, the output data is totally unpredictable. For this
86 * reason, the routine decreases its internal estimate of how many
87 * bits of "true randomness" are contained in the entropy pool as it
88 * outputs random numbers.
89 *
90 * If this estimate goes to zero, the routine can still generate
91 * random numbers; however, an attacker may (at least in theory) be
92 * able to infer the future output of the generator from prior
93 * outputs. This requires successful cryptanalysis of SHA, which is
94 * not believed to be feasible, but there is a remote possibility.
95 * Nonetheless, these numbers should be useful for the vast majority
96 * of purposes.
97 *
98 * Exported interfaces ---- output
99 * ===============================
100 *
101 * There are three exported interfaces; the first is one designed to
102 * be used from within the kernel:
103 *
104 * void get_random_bytes(void *buf, int nbytes);
105 *
106 * This interface will return the requested number of random bytes,
107 * and place it in the requested buffer.
108 *
109 * The two other interfaces are two character devices /dev/random and
110 * /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 *
122 * Exported interfaces ---- input
123 * ==============================
124 *
125 * The current exported interfaces for gathering environmental noise
126 * from the devices are:
127 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400128 * void add_device_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 * void add_input_randomness(unsigned int type, unsigned int code,
130 * unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400131 * void add_interrupt_randomness(int irq, int irq_flags);
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100132 * void add_disk_randomness(struct gendisk *disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400134 * add_device_randomness() is for adding data to the random pool that
135 * is likely to differ between two devices (or possibly even per boot).
136 * This would be things like MAC addresses or serial numbers, or the
137 * read-out of the RTC. This does *not* add any actual entropy to the
138 * pool, but it initializes the pool to different values for devices
139 * that might otherwise be identical and have very little entropy
140 * available to them (particularly common in the embedded world).
141 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 * add_input_randomness() uses the input layer interrupt timing, as well as
143 * the event type information from the hardware.
144 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400145 * add_interrupt_randomness() uses the interrupt timing as random
146 * inputs to the entropy pool. Using the cycle counters and the irq source
147 * as inputs, it feeds the randomness roughly once a second.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100148 *
149 * add_disk_randomness() uses what amounts to the seek time of block
150 * layer request events, on a per-disk_devt basis, as input to the
151 * entropy pool. Note that high-speed solid state drives with very low
152 * seek times do not make for good sources of entropy, as their seek
153 * times are usually fairly consistent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 *
155 * All of these routines try to estimate how many bits of randomness a
156 * particular randomness source. They do this by keeping track of the
157 * first and second order deltas of the event timings.
158 *
159 * Ensuring unpredictability at system startup
160 * ============================================
161 *
162 * When any operating system starts up, it will go through a sequence
163 * of actions that are fairly predictable by an adversary, especially
164 * if the start-up does not involve interaction with a human operator.
165 * This reduces the actual number of bits of unpredictability in the
166 * entropy pool below the value in entropy_count. In order to
167 * counteract this effect, it helps to carry information in the
168 * entropy pool across shut-downs and start-ups. To do this, put the
169 * following lines an appropriate script which is run during the boot
170 * sequence:
171 *
172 * echo "Initializing random number generator..."
173 * random_seed=/var/run/random-seed
174 * # Carry a random seed from start-up to start-up
175 * # Load and then save the whole entropy pool
176 * if [ -f $random_seed ]; then
177 * cat $random_seed >/dev/urandom
178 * else
179 * touch $random_seed
180 * fi
181 * chmod 600 $random_seed
182 * dd if=/dev/urandom of=$random_seed count=1 bs=512
183 *
184 * and the following lines in an appropriate script which is run as
185 * the system is shutdown:
186 *
187 * # Carry a random seed from shut-down to start-up
188 * # Save the whole entropy pool
189 * echo "Saving random seed..."
190 * random_seed=/var/run/random-seed
191 * touch $random_seed
192 * chmod 600 $random_seed
193 * dd if=/dev/urandom of=$random_seed count=1 bs=512
194 *
195 * For example, on most modern systems using the System V init
196 * scripts, such code fragments would be found in
197 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
198 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
199 *
200 * Effectively, these commands cause the contents of the entropy pool
201 * to be saved at shut-down time and reloaded into the entropy pool at
202 * start-up. (The 'dd' in the addition to the bootup script is to
203 * make sure that /etc/random-seed is different for every start-up,
204 * even if the system crashes without executing rc.0.) Even with
205 * complete knowledge of the start-up activities, predicting the state
206 * of the entropy pool requires knowledge of the previous history of
207 * the system.
208 *
209 * Configuring the /dev/random driver under Linux
210 * ==============================================
211 *
212 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
213 * the /dev/mem major number (#1). So if your system does not have
214 * /dev/random and /dev/urandom created already, they can be created
215 * by using the commands:
216 *
217 * mknod /dev/random c 1 8
218 * mknod /dev/urandom c 1 9
219 *
220 * Acknowledgements:
221 * =================
222 *
223 * Ideas for constructing this random number generator were derived
224 * from Pretty Good Privacy's random number generator, and from private
225 * discussions with Phil Karn. Colin Plumb provided a faster random
226 * number generator, which speed up the mixing function of the entropy
227 * pool, taken from PGPfone. Dale Worley has also contributed many
228 * useful ideas and suggestions to improve this driver.
229 *
230 * Any flaws in the design are solely my responsibility, and should
231 * not be attributed to the Phil, Colin, or any of authors of PGP.
232 *
233 * Further background information on this topic may be obtained from
234 * RFC 1750, "Randomness Recommendations for Security", by Donald
235 * Eastlake, Steve Crocker, and Jeff Schiller.
236 */
237
238#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239#include <linux/module.h>
240#include <linux/kernel.h>
241#include <linux/major.h>
242#include <linux/string.h>
243#include <linux/fcntl.h>
244#include <linux/slab.h>
245#include <linux/random.h>
246#include <linux/poll.h>
247#include <linux/init.h>
248#include <linux/fs.h>
249#include <linux/genhd.h>
250#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700251#include <linux/mm.h>
Michael Ellermandd0f0cf2016-07-31 00:23:08 +1000252#include <linux/nodemask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253#include <linux/spinlock.h>
Torsten Duwec84dbf62014-06-14 23:38:36 -0400254#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255#include <linux/percpu.h>
256#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800257#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400258#include <linux/ptrace.h>
Theodore Ts'oe6d49472012-07-05 10:21:01 -0400259#include <linux/kmemcheck.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400260#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200261#include <linux/irq.h>
Theodore Ts'o17e20c82018-04-25 01:12:32 -0400262#include <linux/ratelimit.h>
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400263#include <linux/syscalls.h>
264#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700265#include <linux/uuid.h>
Theodore Ts'oe192be92016-06-12 18:13:36 -0400266#include <crypto/chacha20.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268#include <asm/processor.h>
269#include <asm/uaccess.h>
270#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400271#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272#include <asm/io.h>
273
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400274#define CREATE_TRACE_POINTS
275#include <trace/events/random.h>
276
Theodore Ts'o43759d42014-06-14 21:43:13 -0400277/* #define ADD_INTERRUPT_BENCH */
278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279/*
280 * Configuration information
281 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400282#define INPUT_POOL_SHIFT 12
283#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
284#define OUTPUT_POOL_SHIFT 10
285#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
286#define SEC_XFER_SIZE 512
287#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Theodore Ts'o392a5462013-11-03 18:24:08 -0500289#define DEBUG_RANDOM_BOOT 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400291#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400294 * To allow fractional bits to be tracked, the entropy_count field is
295 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400296 *
297 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
298 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400299 */
300#define ENTROPY_SHIFT 3
301#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
302
303/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 * The minimum number of bits of entropy before we wake up a read on
305 * /dev/random. Should be enough to do a significant reseed.
306 */
Greg Price2132a962013-12-06 21:28:03 -0500307static int random_read_wakeup_bits = 64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309/*
310 * If the entropy count falls under this number of bits, then we
311 * should wake up processes which are selecting or polling on write
312 * access to /dev/random.
313 */
Greg Price2132a962013-12-06 21:28:03 -0500314static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
316/*
Greg Pricedfd38752013-11-29 14:58:06 -0500317 * The minimum number of seconds between urandom pool reseeding. We
Theodore Ts'of5c27422013-09-22 15:14:32 -0400318 * do this to limit the amount of entropy that can be drained from the
319 * input pool even if there are heavy demands on /dev/urandom.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400321static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400324 * Originally, we used a primitive polynomial of degree .poolwords
325 * over GF(2). The taps for various sizes are defined below. They
326 * were chosen to be evenly spaced except for the last tap, which is 1
327 * to get the twisting happening as fast as possible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400329 * For the purposes of better mixing, we use the CRC-32 polynomial as
330 * well to make a (modified) twisted Generalized Feedback Shift
331 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
332 * generators. ACM Transactions on Modeling and Computer Simulation
333 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
Greg Pricedfd38752013-11-29 14:58:06 -0500334 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400335 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 *
337 * Thanks to Colin Plumb for suggesting this.
338 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400339 * The mixing operation is much less sensitive than the output hash,
340 * where we use SHA-1. All that we want of mixing operation is that
341 * it be a good non-cryptographic hash; i.e. it not produce collisions
342 * when fed "random" data of the sort we expect to see. As long as
343 * the pool state differs for different inputs, we have preserved the
344 * input entropy and done a good job. The fact that an intelligent
345 * attacker can construct inputs that will produce controlled
346 * alterations to the pool's state is not important because we don't
347 * consider such inputs to contribute any randomness. The only
348 * property we need with respect to them is that the attacker can't
349 * increase his/her knowledge of the pool's state. Since all
350 * additions are reversible (knowing the final state and the input,
351 * you can reconstruct the initial state), if an attacker has any
352 * uncertainty about the initial state, he/she can only shuffle that
353 * uncertainty about, but never cause any collisions (which would
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 * decrease the uncertainty).
355 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400356 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
357 * Videau in their paper, "The Linux Pseudorandom Number Generator
358 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
359 * paper, they point out that we are not using a true Twisted GFSR,
360 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
361 * is, with only three taps, instead of the six that we are using).
362 * As a result, the resulting polynomial is neither primitive nor
363 * irreducible, and hence does not have a maximal period over
364 * GF(2**32). They suggest a slight change to the generator
365 * polynomial which improves the resulting TGFSR polynomial to be
366 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400369 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
370#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 int tap1, tap2, tap3, tap4, tap5;
372} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400373 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
374 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
375 { S(128), 104, 76, 51, 25, 1 },
376 /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
377 /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
378 { S(32), 26, 19, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379#if 0
380 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400381 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400384 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
386 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400387 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
389 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400390 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400393 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400395 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400398 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
400 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400401 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
403 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400404 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405#endif
406};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408/*
409 * Static global variables
410 */
411static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
412static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400413static DECLARE_WAIT_QUEUE_HEAD(urandom_init_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700414static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Herbert Xu205a5252015-06-09 18:19:39 +0800416static DEFINE_SPINLOCK(random_ready_list_lock);
417static LIST_HEAD(random_ready_list);
418
Theodore Ts'oe192be92016-06-12 18:13:36 -0400419struct crng_state {
420 __u32 state[16];
421 unsigned long init_time;
422 spinlock_t lock;
423};
424
425struct crng_state primary_crng = {
426 .lock = __SPIN_LOCK_UNLOCKED(primary_crng.lock),
427};
428
429/*
430 * crng_init = 0 --> Uninitialized
431 * 1 --> Initialized
432 * 2 --> Initialized from input_pool
433 *
434 * crng_init is protected by primary_crng->lock, and only increases
435 * its value (from 0->1->2).
436 */
437static int crng_init = 0;
Theodore Ts'o4dfb3442018-04-11 13:27:52 -0400438#define crng_ready() (likely(crng_init > 1))
Theodore Ts'oe192be92016-06-12 18:13:36 -0400439static int crng_init_cnt = 0;
Theodore Ts'o1d49e2a2018-04-11 16:32:17 -0400440static unsigned long crng_global_init_time = 0;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400441#define CRNG_INIT_CNT_THRESH (2*CHACHA20_KEY_SIZE)
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400442static void _extract_crng(struct crng_state *crng,
443 __u8 out[CHACHA20_BLOCK_SIZE]);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400444static void _crng_backtrack_protect(struct crng_state *crng,
445 __u8 tmp[CHACHA20_BLOCK_SIZE], int used);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400446static void process_random_ready_list(void);
447
Theodore Ts'o17e20c82018-04-25 01:12:32 -0400448static struct ratelimit_state unseeded_warning =
449 RATELIMIT_STATE_INIT("warn_unseeded_randomness", HZ, 3);
450static struct ratelimit_state urandom_warning =
451 RATELIMIT_STATE_INIT("warn_urandom_randomness", HZ, 3);
452
453static int ratelimit_disable __read_mostly;
454
455module_param_named(ratelimit_disable, ratelimit_disable, int, 0644);
456MODULE_PARM_DESC(ratelimit_disable, "Disable random ratelimit suppression");
457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458/**********************************************************************
459 *
460 * OS independent entropy store. Here are the functions which handle
461 * storing entropy in an entropy pool.
462 *
463 **********************************************************************/
464
465struct entropy_store;
466struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700467 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400468 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 __u32 *pool;
470 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400472 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
474 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400475 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700476 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400477 unsigned short add_ptr;
478 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800479 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400480 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400481 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400482 unsigned int limit:1;
483 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000484 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485};
486
Theodore Ts'oe192be92016-06-12 18:13:36 -0400487static ssize_t extract_entropy(struct entropy_store *r, void *buf,
488 size_t nbytes, int min, int rsvd);
489static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
490 size_t nbytes, int fips);
491
492static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400493static void push_to_pool(struct work_struct *work);
Emese Revfy0766f782016-06-20 20:42:34 +0200494static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
495static __u32 blocking_pool_data[OUTPUT_POOL_WORDS] __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497static struct entropy_store input_pool = {
498 .poolinfo = &poolinfo_table[0],
499 .name = "input",
500 .limit = 1,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200501 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 .pool = input_pool_data
503};
504
505static struct entropy_store blocking_pool = {
506 .poolinfo = &poolinfo_table[1],
507 .name = "blocking",
508 .limit = 1,
509 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200510 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400511 .pool = blocking_pool_data,
512 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
513 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514};
515
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400516static __u32 const twist_table[8] = {
517 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
518 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700521 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700523 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 *
525 * The pool is stirred with a primitive polynomial of the appropriate
526 * degree, and then twisted. We twist by three bits at a time because
527 * it's cheap to do so and helps slightly in the expected case where
528 * the entropy is concentrated in the low-order bits.
529 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400530static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400531 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400533 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700534 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700536 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700537 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 tap1 = r->poolinfo->tap1;
540 tap2 = r->poolinfo->tap2;
541 tap3 = r->poolinfo->tap3;
542 tap4 = r->poolinfo->tap4;
543 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400545 input_rotate = r->input_rotate;
546 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Matt Mackalle68e5b62008-04-29 01:03:05 -0700548 /* mix one byte at a time to simplify size handling and churn faster */
549 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400550 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700551 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
553 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700554 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 w ^= r->pool[(i + tap1) & wordmask];
556 w ^= r->pool[(i + tap2) & wordmask];
557 w ^= r->pool[(i + tap3) & wordmask];
558 w ^= r->pool[(i + tap4) & wordmask];
559 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700560
561 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700563
564 /*
565 * Normally, we add 7 bits of rotation to the pool.
566 * At the beginning of the pool, add an extra 7 bits
567 * rotation, so that successive passes spread the
568 * input bits across the pool evenly.
569 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400570 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 }
572
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400573 r->input_rotate = input_rotate;
574 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575}
576
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400577static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400578 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400580 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400581 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400582}
583
584static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400585 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400586{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400587 unsigned long flags;
588
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400589 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400590 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400591 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400592 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593}
594
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400595struct fast_pool {
596 __u32 pool[4];
597 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400598 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400599 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400600};
601
602/*
603 * This is a fast mixing routine used by the interrupt randomness
604 * collector. It's hardcoded for an 128 bit pool and assumes that any
605 * locks that might be needed are taken by the caller.
606 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400607static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400608{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400609 __u32 a = f->pool[0], b = f->pool[1];
610 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400611
Theodore Ts'o43759d42014-06-14 21:43:13 -0400612 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500613 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400614 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400615
Theodore Ts'o43759d42014-06-14 21:43:13 -0400616 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500617 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400618 d ^= a; b ^= c;
619
620 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500621 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400622 d ^= a; b ^= c;
623
624 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500625 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400626 d ^= a; b ^= c;
627
628 f->pool[0] = a; f->pool[1] = b;
629 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400630 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400631}
632
Herbert Xu205a5252015-06-09 18:19:39 +0800633static void process_random_ready_list(void)
634{
635 unsigned long flags;
636 struct random_ready_callback *rdy, *tmp;
637
638 spin_lock_irqsave(&random_ready_list_lock, flags);
639 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
640 struct module *owner = rdy->owner;
641
642 list_del_init(&rdy->list);
643 rdy->func(rdy);
644 module_put(owner);
645 }
646 spin_unlock_irqrestore(&random_ready_list_lock, flags);
647}
648
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400650 * Credit (or debit) the entropy store with n bits of entropy.
651 * Use credit_entropy_bits_safe() if the value comes from userspace
652 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700654static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400656 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400657 const int pool_size = r->poolinfo->poolfracbits;
658 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Matt Mackalladc782d2008-04-29 01:03:07 -0700660 if (!nbits)
661 return;
662
Theodore Ts'o902c0982012-07-04 10:38:30 -0400663retry:
664 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400665 if (nfrac < 0) {
666 /* Debit */
667 entropy_count += nfrac;
668 } else {
669 /*
670 * Credit: we have to account for the possibility of
671 * overwriting already present entropy. Even in the
672 * ideal case of pure Shannon entropy, new contributions
673 * approach the full value asymptotically:
674 *
675 * entropy <- entropy + (pool_size - entropy) *
676 * (1 - exp(-add_entropy/pool_size))
677 *
678 * For add_entropy <= pool_size/2 then
679 * (1 - exp(-add_entropy/pool_size)) >=
680 * (add_entropy/pool_size)*0.7869...
681 * so we can approximate the exponential with
682 * 3/4*add_entropy/pool_size and still be on the
683 * safe side by adding at most pool_size/2 at a time.
684 *
685 * The use of pool_size-2 in the while statement is to
686 * prevent rounding artifacts from making the loop
687 * arbitrarily long; this limits the loop to log2(pool_size)*2
688 * turns no matter how large nbits is.
689 */
690 int pnfrac = nfrac;
691 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
692 /* The +2 corresponds to the /4 in the denominator */
693
694 do {
695 unsigned int anfrac = min(pnfrac, pool_size/2);
696 unsigned int add =
697 ((pool_size - entropy_count)*anfrac*3) >> s;
698
699 entropy_count += add;
700 pnfrac -= anfrac;
701 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
702 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400703
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -0400704 if (unlikely(entropy_count < 0)) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400705 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
706 r->name, entropy_count);
707 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700708 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400709 } else if (entropy_count > pool_size)
710 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400711 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
712 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
Theodore Ts'o6265e162013-10-03 01:08:15 -0400714 r->entropy_total += nbits;
Linus Torvalds0891ad82013-11-16 10:19:15 -0800715 if (!r->initialized && r->entropy_total > 128) {
716 r->initialized = 1;
717 r->entropy_total = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400718 }
719
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400720 trace_credit_entropy_bits(r->name, nbits,
721 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400722 r->entropy_total, _RET_IP_);
723
Theodore Ts'o6265e162013-10-03 01:08:15 -0400724 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500725 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400726
Theodore Ts'oe192be92016-06-12 18:13:36 -0400727 if (crng_init < 2 && entropy_bits >= 128) {
728 crng_reseed(&primary_crng, r);
729 entropy_bits = r->entropy_count >> ENTROPY_SHIFT;
730 }
731
Theodore Ts'o6265e162013-10-03 01:08:15 -0400732 /* should we wake readers? */
Greg Price2132a962013-12-06 21:28:03 -0500733 if (entropy_bits >= random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400734 wake_up_interruptible(&random_read_wait);
735 kill_fasync(&fasync, SIGIO, POLL_IN);
736 }
737 /* If the input pool is getting full, send some
Theodore Ts'oe192be92016-06-12 18:13:36 -0400738 * entropy to the blocking pool until it is 75% full.
Theodore Ts'o6265e162013-10-03 01:08:15 -0400739 */
Greg Price2132a962013-12-06 21:28:03 -0500740 if (entropy_bits > random_write_wakeup_bits &&
Theodore Ts'o6265e162013-10-03 01:08:15 -0400741 r->initialized &&
Greg Price2132a962013-12-06 21:28:03 -0500742 r->entropy_total >= 2*random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400743 struct entropy_store *other = &blocking_pool;
744
Theodore Ts'o6265e162013-10-03 01:08:15 -0400745 if (other->entropy_count <=
Theodore Ts'oe192be92016-06-12 18:13:36 -0400746 3 * other->poolinfo->poolfracbits / 4) {
747 schedule_work(&other->push_work);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400748 r->entropy_total = 0;
749 }
750 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700751 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752}
753
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400754static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400755{
Theodore Ts'obb6f26a2017-02-25 18:21:33 -0400756 const int nbits_max = r->poolinfo->poolwords * 32;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400757
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400758 if (nbits < 0)
759 return -EINVAL;
760
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400761 /* Cap the value to avoid overflows */
762 nbits = min(nbits, nbits_max);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400763
764 credit_entropy_bits(r, nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400765 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400766}
767
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768/*********************************************************************
769 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400770 * CRNG using CHACHA20
771 *
772 *********************************************************************/
773
774#define CRNG_RESEED_INTERVAL (300*HZ)
775
776static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
777
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400778#ifdef CONFIG_NUMA
779/*
780 * Hack to deal with crazy userspace progams when they are all trying
781 * to access /dev/urandom in parallel. The programs are almost
782 * certainly doing something terribly wrong, but we'll work around
783 * their brain damage.
784 */
785static struct crng_state **crng_node_pool __read_mostly;
786#endif
787
Theodore Ts'oe192be92016-06-12 18:13:36 -0400788static void crng_initialize(struct crng_state *crng)
789{
790 int i;
791 unsigned long rv;
792
793 memcpy(&crng->state[0], "expand 32-byte k", 16);
794 if (crng == &primary_crng)
795 _extract_entropy(&input_pool, &crng->state[4],
796 sizeof(__u32) * 12, 0);
797 else
798 get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
799 for (i = 4; i < 16; i++) {
800 if (!arch_get_random_seed_long(&rv) &&
801 !arch_get_random_long(&rv))
802 rv = random_get_entropy();
803 crng->state[i] ^= rv;
804 }
805 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
806}
807
808static int crng_fast_load(const char *cp, size_t len)
809{
810 unsigned long flags;
811 char *p;
812
813 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
814 return 0;
Theodore Ts'o4dfb3442018-04-11 13:27:52 -0400815 if (crng_init != 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400816 spin_unlock_irqrestore(&primary_crng.lock, flags);
817 return 0;
818 }
819 p = (unsigned char *) &primary_crng.state[4];
820 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
821 p[crng_init_cnt % CHACHA20_KEY_SIZE] ^= *cp;
822 cp++; crng_init_cnt++; len--;
823 }
824 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
825 crng_init = 1;
826 wake_up_interruptible(&crng_init_wait);
827 pr_notice("random: fast init done\n");
828 }
829 spin_unlock_irqrestore(&primary_crng.lock, flags);
830 return 1;
831}
832
Theodore Ts'o29715852018-04-11 15:23:56 -0400833#ifdef CONFIG_NUMA
Theodore Ts'oc3ff2da2018-04-23 18:51:28 -0400834static void do_numa_crng_init(struct work_struct *work)
Theodore Ts'o29715852018-04-11 15:23:56 -0400835{
836 int i;
837 struct crng_state *crng;
838 struct crng_state **pool;
839
840 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
841 for_each_online_node(i) {
842 crng = kmalloc_node(sizeof(struct crng_state),
843 GFP_KERNEL | __GFP_NOFAIL, i);
844 spin_lock_init(&crng->lock);
845 crng_initialize(crng);
846 pool[i] = crng;
847 }
Eric Biggers23083a12021-12-20 16:41:56 -0600848 /* pairs with READ_ONCE() in select_crng() */
849 if (cmpxchg_release(&crng_node_pool, NULL, pool) != NULL) {
Theodore Ts'o29715852018-04-11 15:23:56 -0400850 for_each_node(i)
851 kfree(pool[i]);
852 kfree(pool);
853 }
854}
Theodore Ts'oc3ff2da2018-04-23 18:51:28 -0400855
856static DECLARE_WORK(numa_crng_init_work, do_numa_crng_init);
857
858static void numa_crng_init(void)
859{
860 schedule_work(&numa_crng_init_work);
861}
Eric Biggers23083a12021-12-20 16:41:56 -0600862
863static struct crng_state *select_crng(void)
864{
865 struct crng_state **pool;
866 int nid = numa_node_id();
867
868 /* 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
873 return &primary_crng;
874}
Theodore Ts'o29715852018-04-11 15:23:56 -0400875#else
876static void numa_crng_init(void) {}
Eric Biggers23083a12021-12-20 16:41:56 -0600877
878static struct crng_state *select_crng(void)
879{
880 return &primary_crng;
881}
Theodore Ts'o29715852018-04-11 15:23:56 -0400882#endif
883
Theodore Ts'oe192be92016-06-12 18:13:36 -0400884static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
885{
886 unsigned long flags;
887 int i, num;
888 union {
889 __u8 block[CHACHA20_BLOCK_SIZE];
890 __u32 key[8];
891 } buf;
892
893 if (r) {
894 num = extract_entropy(r, &buf, 32, 16, 0);
895 if (num == 0)
896 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400897 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400898 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400899 _crng_backtrack_protect(&primary_crng, buf.block,
900 CHACHA20_KEY_SIZE);
901 }
Theodore Ts'obefd00c2018-04-12 00:50:45 -0400902 spin_lock_irqsave(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400903 for (i = 0; i < 8; i++) {
904 unsigned long rv;
905 if (!arch_get_random_seed_long(&rv) &&
906 !arch_get_random_long(&rv))
907 rv = random_get_entropy();
908 crng->state[i+4] ^= buf.key[i] ^ rv;
909 }
910 memzero_explicit(&buf, sizeof(buf));
911 crng->init_time = jiffies;
912 if (crng == &primary_crng && crng_init < 2) {
Theodore Ts'o29715852018-04-11 15:23:56 -0400913 numa_crng_init();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400914 crng_init = 2;
915 process_random_ready_list();
916 wake_up_interruptible(&crng_init_wait);
917 pr_notice("random: crng init done\n");
Theodore Ts'o17e20c82018-04-25 01:12:32 -0400918 if (unseeded_warning.missed) {
919 pr_notice("random: %d get_random_xx warning(s) missed "
920 "due to ratelimiting\n",
921 unseeded_warning.missed);
922 unseeded_warning.missed = 0;
923 }
924 if (urandom_warning.missed) {
925 pr_notice("random: %d urandom warning(s) missed "
926 "due to ratelimiting\n",
927 urandom_warning.missed);
928 urandom_warning.missed = 0;
929 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400930 }
Theodore Ts'obefd00c2018-04-12 00:50:45 -0400931 spin_unlock_irqrestore(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400932}
933
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400934static inline void maybe_reseed_primary_crng(void)
935{
936 if (crng_init > 2 &&
937 time_after(jiffies, primary_crng.init_time + CRNG_RESEED_INTERVAL))
938 crng_reseed(&primary_crng, &input_pool);
939}
940
Theodore Ts'oe192be92016-06-12 18:13:36 -0400941static inline void crng_wait_ready(void)
942{
943 wait_event_interruptible(crng_init_wait, crng_ready());
944}
945
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400946static void _extract_crng(struct crng_state *crng,
947 __u8 out[CHACHA20_BLOCK_SIZE])
Theodore Ts'oe192be92016-06-12 18:13:36 -0400948{
949 unsigned long v, flags;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400950
Theodore Ts'o4dfb3442018-04-11 13:27:52 -0400951 if (crng_ready() &&
Theodore Ts'o1d49e2a2018-04-11 16:32:17 -0400952 (time_after(crng_global_init_time, crng->init_time) ||
953 time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL)))
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400954 crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400955 spin_lock_irqsave(&crng->lock, flags);
956 if (arch_get_random_long(&v))
957 crng->state[14] ^= v;
958 chacha20_block(&crng->state[0], out);
959 if (crng->state[12] == 0)
960 crng->state[13]++;
961 spin_unlock_irqrestore(&crng->lock, flags);
962}
963
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400964static void extract_crng(__u8 out[CHACHA20_BLOCK_SIZE])
965{
Eric Biggers23083a12021-12-20 16:41:56 -0600966 _extract_crng(select_crng(), out);
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400967}
968
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400969/*
970 * Use the leftover bytes from the CRNG block output (if there is
971 * enough) to mutate the CRNG key to provide backtracking protection.
972 */
973static void _crng_backtrack_protect(struct crng_state *crng,
974 __u8 tmp[CHACHA20_BLOCK_SIZE], int used)
975{
976 unsigned long flags;
977 __u32 *s, *d;
978 int i;
979
980 used = round_up(used, sizeof(__u32));
981 if (used + CHACHA20_KEY_SIZE > CHACHA20_BLOCK_SIZE) {
982 extract_crng(tmp);
983 used = 0;
984 }
985 spin_lock_irqsave(&crng->lock, flags);
986 s = (__u32 *) &tmp[used];
987 d = &crng->state[4];
988 for (i=0; i < 8; i++)
989 *d++ ^= *s++;
990 spin_unlock_irqrestore(&crng->lock, flags);
991}
992
993static void crng_backtrack_protect(__u8 tmp[CHACHA20_BLOCK_SIZE], int used)
994{
Eric Biggers23083a12021-12-20 16:41:56 -0600995 _crng_backtrack_protect(select_crng(), tmp, used);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400996}
997
Theodore Ts'oe192be92016-06-12 18:13:36 -0400998static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
999{
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001000 ssize_t ret = 0, i = CHACHA20_BLOCK_SIZE;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001001 __u8 tmp[CHACHA20_BLOCK_SIZE];
1002 int large_request = (nbytes > 256);
1003
1004 while (nbytes) {
1005 if (large_request && need_resched()) {
1006 if (signal_pending(current)) {
1007 if (ret == 0)
1008 ret = -ERESTARTSYS;
1009 break;
1010 }
1011 schedule();
1012 }
1013
1014 extract_crng(tmp);
1015 i = min_t(int, nbytes, CHACHA20_BLOCK_SIZE);
1016 if (copy_to_user(buf, tmp, i)) {
1017 ret = -EFAULT;
1018 break;
1019 }
1020
1021 nbytes -= i;
1022 buf += i;
1023 ret += i;
1024 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001025 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001026
1027 /* Wipe data just written to memory */
1028 memzero_explicit(tmp, sizeof(tmp));
1029
1030 return ret;
1031}
1032
1033
1034/*********************************************************************
1035 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 * Entropy input management
1037 *
1038 *********************************************************************/
1039
1040/* There is one of these per entropy source */
1041struct timer_rand_state {
1042 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001043 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 unsigned dont_count_entropy:1;
1045};
1046
Theodore Ts'o644008d2013-11-03 16:40:53 -05001047#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
1048
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001049/*
Theodore Ts'oe192be92016-06-12 18:13:36 -04001050 * Add device- or boot-specific data to the input pool to help
1051 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001052 *
Theodore Ts'oe192be92016-06-12 18:13:36 -04001053 * None of this adds any entropy; it is meant to avoid the problem of
1054 * the entropy pool having similar initial state across largely
1055 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001056 */
1057void add_device_randomness(const void *buf, unsigned int size)
1058{
Theodore Ts'o61875f32013-09-21 13:58:22 -04001059 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001060 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001061
Theodore Ts'o59108952013-09-12 14:10:25 -04001062 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001063 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001064 _mix_pool_bytes(&input_pool, buf, size);
1065 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001066 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001067}
1068EXPORT_SYMBOL(add_device_randomness);
1069
Theodore Ts'o644008d2013-11-03 16:40:53 -05001070static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001071
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072/*
1073 * This function adds entropy to the entropy "pool" by using timing
1074 * delays. It uses the timer_rand_state structure to make an estimate
1075 * of how many bits of entropy this call has added to the pool.
1076 *
1077 * The number "num" is also added to the pool - it should somehow describe
1078 * the type of event which just happened. This is currently 0-255 for
1079 * keyboard scan codes, and 256 upwards for interrupts.
1080 *
1081 */
1082static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1083{
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001084 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -08001087 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 unsigned num;
1089 } sample;
1090 long delta, delta2, delta3;
1091
1092 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
1094 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001095 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 sample.num = num;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001097 r = &input_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001098 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
1100 /*
1101 * Calculate number of bits of randomness we probably added.
1102 * We take into account the first, second and third-order deltas
1103 * in order to make our estimate.
1104 */
1105
1106 if (!state->dont_count_entropy) {
1107 delta = sample.jiffies - state->last_time;
1108 state->last_time = sample.jiffies;
1109
1110 delta2 = delta - state->last_delta;
1111 state->last_delta = delta;
1112
1113 delta3 = delta2 - state->last_delta2;
1114 state->last_delta2 = delta2;
1115
1116 if (delta < 0)
1117 delta = -delta;
1118 if (delta2 < 0)
1119 delta2 = -delta2;
1120 if (delta3 < 0)
1121 delta3 = -delta3;
1122 if (delta > delta2)
1123 delta = delta2;
1124 if (delta > delta3)
1125 delta = delta3;
1126
1127 /*
1128 * delta is now minimum absolute delta.
1129 * Round down by 1 bit on general principles,
1130 * and limit entropy entimate to 12 bits.
1131 */
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001132 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 preempt_enable();
1135}
1136
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001137void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 unsigned int value)
1139{
1140 static unsigned char last_value;
1141
1142 /* ignore autorepeat and the like */
1143 if (value == last_value)
1144 return;
1145
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 last_value = value;
1147 add_timer_randomness(&input_timer_state,
1148 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001149 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001151EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001153static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1154
Theodore Ts'o43759d42014-06-14 21:43:13 -04001155#ifdef ADD_INTERRUPT_BENCH
1156static unsigned long avg_cycles, avg_deviation;
1157
1158#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1159#define FIXED_1_2 (1 << (AVG_SHIFT-1))
1160
1161static void add_interrupt_bench(cycles_t start)
1162{
1163 long delta = random_get_entropy() - start;
1164
1165 /* Use a weighted moving average */
1166 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1167 avg_cycles += delta;
1168 /* And average deviation */
1169 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1170 avg_deviation += delta;
1171}
1172#else
1173#define add_interrupt_bench(x)
1174#endif
1175
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001176static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
1177{
1178 __u32 *ptr = (__u32 *) regs;
Theodore Ts'ob4d93c62017-06-07 19:01:32 -04001179 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001180
1181 if (regs == NULL)
1182 return 0;
Theodore Ts'ob4d93c62017-06-07 19:01:32 -04001183 idx = READ_ONCE(f->reg_idx);
1184 if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
1185 idx = 0;
1186 ptr += idx++;
1187 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitza1df3752017-04-30 19:49:21 +12001188 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001189}
1190
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001191void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192{
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001193 struct entropy_store *r;
Christoph Lameter1b2a1a72014-08-17 12:30:29 -05001194 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001195 struct pt_regs *regs = get_irq_regs();
1196 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001197 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -04001198 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001199 __u64 ip;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001200 unsigned long seed;
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001201 int credit = 0;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001202
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001203 if (cycles == 0)
1204 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001205 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1206 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001207 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1208 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001209 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001210 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001211 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
1212 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001213
Theodore Ts'o43759d42014-06-14 21:43:13 -04001214 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001215 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001216
Theodore Ts'o4dfb3442018-04-11 13:27:52 -04001217 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001218 if ((fast_pool->count >= 64) &&
1219 crng_fast_load((char *) fast_pool->pool,
1220 sizeof(fast_pool->pool))) {
1221 fast_pool->count = 0;
1222 fast_pool->last = now;
1223 }
1224 return;
1225 }
1226
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001227 if ((fast_pool->count < 64) &&
1228 !time_after(now, fast_pool->last + HZ))
1229 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
Theodore Ts'oe192be92016-06-12 18:13:36 -04001231 r = &input_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001232 if (!spin_trylock(&r->lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 return;
1234
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001235 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001236 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
H. Peter Anvin83664a62014-03-17 16:36:28 -07001237
1238 /*
1239 * If we have architectural seed generator, produce a seed and
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001240 * add it to the pool. For the sake of paranoia don't let the
1241 * architectural seed generator dominate the input from the
1242 * interrupt noise.
H. Peter Anvin83664a62014-03-17 16:36:28 -07001243 */
1244 if (arch_get_random_seed_long(&seed)) {
Theodore Ts'o85608f82014-06-10 23:09:20 -04001245 __mix_pool_bytes(r, &seed, sizeof(seed));
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001246 credit = 1;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001247 }
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001248 spin_unlock(&r->lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001249
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001250 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001251
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001252 /* award one bit for the contents of the fast pool */
1253 credit_entropy_bits(r, credit + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001255EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256
David Howells93614012006-09-30 20:45:40 +02001257#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258void add_disk_randomness(struct gendisk *disk)
1259{
1260 if (!disk || !disk->random)
1261 return;
1262 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001263 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001264 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001266EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001267#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269/*********************************************************************
1270 *
1271 * Entropy extraction routines
1272 *
1273 *********************************************************************/
1274
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001276 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 * from the primary pool to the secondary extraction pool. We make
1278 * sure we pull enough for a 'catastrophic reseed'.
1279 */
Theodore Ts'o6265e162013-10-03 01:08:15 -04001280static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1282{
Theodore Ts'ocff85032014-06-10 23:18:16 -04001283 if (!r->pull ||
1284 r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
1285 r->entropy_count > r->poolinfo->poolfracbits)
1286 return;
1287
Theodore Ts'of5c27422013-09-22 15:14:32 -04001288 if (r->limit == 0 && random_min_urandom_seed) {
1289 unsigned long now = jiffies;
1290
1291 if (time_before(now,
1292 r->last_pulled + random_min_urandom_seed * HZ))
1293 return;
1294 r->last_pulled = now;
1295 }
Theodore Ts'ocff85032014-06-10 23:18:16 -04001296
1297 _xfer_secondary_pool(r, nbytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001298}
Matt Mackall5a021e92007-07-19 11:30:14 -07001299
Theodore Ts'o6265e162013-10-03 01:08:15 -04001300static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1301{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 __u32 tmp[OUTPUT_POOL_WORDS];
1303
Greg Price2132a962013-12-06 21:28:03 -05001304 /* For /dev/random's pool, always leave two wakeups' worth */
1305 int rsvd_bytes = r->limit ? 0 : random_read_wakeup_bits / 4;
Theodore Ts'o6265e162013-10-03 01:08:15 -04001306 int bytes = nbytes;
Matt Mackall5a021e92007-07-19 11:30:14 -07001307
Greg Price2132a962013-12-06 21:28:03 -05001308 /* pull at least as much as a wakeup */
1309 bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001310 /* but never more than the buffer size */
1311 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001313 trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
1314 ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
Theodore Ts'o6265e162013-10-03 01:08:15 -04001315 bytes = extract_entropy(r->pull, tmp, bytes,
Greg Price2132a962013-12-06 21:28:03 -05001316 random_read_wakeup_bits / 8, rsvd_bytes);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001317 mix_pool_bytes(r, tmp, bytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001318 credit_entropy_bits(r, bytes*8);
1319}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
Theodore Ts'o6265e162013-10-03 01:08:15 -04001321/*
1322 * Used as a workqueue function so that when the input pool is getting
1323 * full, we can "spill over" some entropy to the output pools. That
1324 * way the output pools can store some of the excess entropy instead
1325 * of letting it go to waste.
1326 */
1327static void push_to_pool(struct work_struct *work)
1328{
1329 struct entropy_store *r = container_of(work, struct entropy_store,
1330 push_work);
1331 BUG_ON(!r);
Greg Price2132a962013-12-06 21:28:03 -05001332 _xfer_secondary_pool(r, random_read_wakeup_bits/8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001333 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
1334 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335}
1336
1337/*
Greg Price19fa5be2013-11-29 15:50:06 -05001338 * This function decides how many bytes to actually take from the
1339 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341static size_t account(struct entropy_store *r, size_t nbytes, int min,
1342 int reserved)
1343{
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001344 int entropy_count, orig;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001345 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001347 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348
1349 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001350retry:
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001351 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001352 ibytes = nbytes;
Greg Price0fb7a012013-12-05 19:32:19 -05001353 /* If limited, never pull more than available */
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001354 if (r->limit) {
1355 int have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
1356
1357 if ((have_bytes -= reserved) < 0)
1358 have_bytes = 0;
1359 ibytes = min_t(size_t, ibytes, have_bytes);
1360 }
Greg Price0fb7a012013-12-05 19:32:19 -05001361 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001362 ibytes = 0;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001363
1364 if (unlikely(entropy_count < 0)) {
1365 pr_warn("random: negative entropy count: pool %s count %d\n",
1366 r->name, entropy_count);
1367 WARN_ON(1);
1368 entropy_count = 0;
1369 }
1370 nfrac = ibytes << (ENTROPY_SHIFT + 3);
1371 if ((size_t) entropy_count > nfrac)
1372 entropy_count -= nfrac;
1373 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001374 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001375
Greg Price0fb7a012013-12-05 19:32:19 -05001376 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1377 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001379 trace_debit_entropy(r->name, 8 * ibytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001380 if (ibytes &&
Greg Price2132a962013-12-06 21:28:03 -05001381 (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
Theodore Ts'ob9809552013-03-04 11:59:12 -05001382 wake_up_interruptible(&random_write_wait);
1383 kill_fasync(&fasync, SIGIO, POLL_OUT);
1384 }
1385
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001386 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387}
1388
Greg Price19fa5be2013-11-29 15:50:06 -05001389/*
1390 * This function does the actual extraction for extract_entropy and
1391 * extract_entropy_user.
1392 *
1393 * Note: we assume that .poolwords is a multiple of 16 words.
1394 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395static void extract_buf(struct entropy_store *r, __u8 *out)
1396{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001397 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001398 union {
1399 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001400 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001401 } hash;
1402 __u32 workspace[SHA_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001403 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001406 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001407 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001408 */
Theodore Ts'o46884442013-12-17 21:16:39 -05001409 sha_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001410 for (i = 0; i < LONGS(20); i++) {
1411 unsigned long v;
1412 if (!arch_get_random_long(&v))
1413 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001414 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001415 }
1416
Theodore Ts'o46884442013-12-17 21:16:39 -05001417 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1418 spin_lock_irqsave(&r->lock, flags);
1419 for (i = 0; i < r->poolinfo->poolwords; i += 16)
1420 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1421
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001422 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001423 * We mix the hash back into the pool to prevent backtracking
1424 * attacks (where the attacker knows the state of the pool
1425 * plus the current outputs, and attempts to find previous
1426 * ouputs), unless the hash function can be inverted. By
1427 * mixing at least a SHA1 worth of hash data back, we make
1428 * brute-forcing the feedback as hard as brute-forcing the
1429 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001431 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001432 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001433
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001434 memzero_explicit(workspace, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
1436 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001437 * In case the hash function has some recognizable output
1438 * pattern, we fold it in half. Thus, we always feed back
1439 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001441 hash.w[0] ^= hash.w[3];
1442 hash.w[1] ^= hash.w[4];
1443 hash.w[2] ^= rol32(hash.w[2], 16);
1444
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001445 memcpy(out, &hash, EXTRACT_SIZE);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001446 memzero_explicit(&hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447}
1448
Theodore Ts'oe192be92016-06-12 18:13:36 -04001449static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
1450 size_t nbytes, int fips)
1451{
1452 ssize_t ret = 0, i;
1453 __u8 tmp[EXTRACT_SIZE];
1454 unsigned long flags;
1455
1456 while (nbytes) {
1457 extract_buf(r, tmp);
1458
1459 if (fips) {
1460 spin_lock_irqsave(&r->lock, flags);
1461 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1462 panic("Hardware RNG duplicated output!\n");
1463 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1464 spin_unlock_irqrestore(&r->lock, flags);
1465 }
1466 i = min_t(int, nbytes, EXTRACT_SIZE);
1467 memcpy(buf, tmp, i);
1468 nbytes -= i;
1469 buf += i;
1470 ret += i;
1471 }
1472
1473 /* Wipe data just returned from memory */
1474 memzero_explicit(tmp, sizeof(tmp));
1475
1476 return ret;
1477}
1478
Greg Price19fa5be2013-11-29 15:50:06 -05001479/*
1480 * This function extracts randomness from the "entropy pool", and
1481 * returns it in a buffer.
1482 *
1483 * The min parameter specifies the minimum amount we can pull before
1484 * failing to avoid races that defeat catastrophic reseeding while the
1485 * reserved parameter indicates how much entropy we must leave in the
1486 * pool after each pull to avoid starving other readers.
1487 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001488static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001489 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001492 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001494 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001495 if (fips_enabled) {
1496 spin_lock_irqsave(&r->lock, flags);
1497 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001498 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001499 spin_unlock_irqrestore(&r->lock, flags);
1500 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001501 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001502 xfer_secondary_pool(r, EXTRACT_SIZE);
1503 extract_buf(r, tmp);
1504 spin_lock_irqsave(&r->lock, flags);
1505 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1506 }
1507 spin_unlock_irqrestore(&r->lock, flags);
1508 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001509
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001510 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 xfer_secondary_pool(r, nbytes);
1512 nbytes = account(r, nbytes, min, reserved);
1513
Theodore Ts'oe192be92016-06-12 18:13:36 -04001514 return _extract_entropy(r, buf, nbytes, fips_enabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515}
1516
Greg Price19fa5be2013-11-29 15:50:06 -05001517/*
1518 * This function extracts randomness from the "entropy pool", and
1519 * returns it in a userspace buffer.
1520 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1522 size_t nbytes)
1523{
1524 ssize_t ret = 0, i;
1525 __u8 tmp[EXTRACT_SIZE];
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001526 int large_request = (nbytes > 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001528 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 xfer_secondary_pool(r, nbytes);
1530 nbytes = account(r, nbytes, 0, 0);
1531
1532 while (nbytes) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001533 if (large_request && need_resched()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 if (signal_pending(current)) {
1535 if (ret == 0)
1536 ret = -ERESTARTSYS;
1537 break;
1538 }
1539 schedule();
1540 }
1541
1542 extract_buf(r, tmp);
1543 i = min_t(int, nbytes, EXTRACT_SIZE);
1544 if (copy_to_user(buf, tmp, i)) {
1545 ret = -EFAULT;
1546 break;
1547 }
1548
1549 nbytes -= i;
1550 buf += i;
1551 ret += i;
1552 }
1553
1554 /* Wipe data just returned from memory */
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001555 memzero_explicit(tmp, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
1557 return ret;
1558}
1559
1560/*
1561 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001562 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001563 * TCP sequence numbers, etc. It does not rely on the hardware random
1564 * number generator. For random bytes direct from the hardware RNG
1565 * (when available), use get_random_bytes_arch().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 */
1567void get_random_bytes(void *buf, int nbytes)
1568{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001569 __u8 tmp[CHACHA20_BLOCK_SIZE];
1570
Theodore Ts'o392a5462013-11-03 18:24:08 -05001571#if DEBUG_RANDOM_BOOT > 0
Theodore Ts'oe192be92016-06-12 18:13:36 -04001572 if (!crng_ready())
Theodore Ts'o392a5462013-11-03 18:24:08 -05001573 printk(KERN_NOTICE "random: %pF get_random_bytes called "
Theodore Ts'oe192be92016-06-12 18:13:36 -04001574 "with crng_init = %d\n", (void *) _RET_IP_, crng_init);
Theodore Ts'o392a5462013-11-03 18:24:08 -05001575#endif
Theodore Ts'o59108952013-09-12 14:10:25 -04001576 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001577
1578 while (nbytes >= CHACHA20_BLOCK_SIZE) {
1579 extract_crng(buf);
1580 buf += CHACHA20_BLOCK_SIZE;
1581 nbytes -= CHACHA20_BLOCK_SIZE;
1582 }
1583
1584 if (nbytes > 0) {
1585 extract_crng(tmp);
1586 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001587 crng_backtrack_protect(tmp, nbytes);
1588 } else
1589 crng_backtrack_protect(tmp, CHACHA20_BLOCK_SIZE);
1590 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001591}
1592EXPORT_SYMBOL(get_random_bytes);
1593
1594/*
Herbert Xu205a5252015-06-09 18:19:39 +08001595 * Add a callback function that will be invoked when the nonblocking
1596 * pool is initialised.
1597 *
1598 * returns: 0 if callback is successfully added
1599 * -EALREADY if pool is already initialised (callback not called)
1600 * -ENOENT if module for callback is not alive
1601 */
1602int add_random_ready_callback(struct random_ready_callback *rdy)
1603{
1604 struct module *owner;
1605 unsigned long flags;
1606 int err = -EALREADY;
1607
Theodore Ts'oe192be92016-06-12 18:13:36 -04001608 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001609 return err;
1610
1611 owner = rdy->owner;
1612 if (!try_module_get(owner))
1613 return -ENOENT;
1614
1615 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001616 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001617 goto out;
1618
1619 owner = NULL;
1620
1621 list_add(&rdy->list, &random_ready_list);
1622 err = 0;
1623
1624out:
1625 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1626
1627 module_put(owner);
1628
1629 return err;
1630}
1631EXPORT_SYMBOL(add_random_ready_callback);
1632
1633/*
1634 * Delete a previously registered readiness callback function.
1635 */
1636void del_random_ready_callback(struct random_ready_callback *rdy)
1637{
1638 unsigned long flags;
1639 struct module *owner = NULL;
1640
1641 spin_lock_irqsave(&random_ready_list_lock, flags);
1642 if (!list_empty(&rdy->list)) {
1643 list_del_init(&rdy->list);
1644 owner = rdy->owner;
1645 }
1646 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1647
1648 module_put(owner);
1649}
1650EXPORT_SYMBOL(del_random_ready_callback);
1651
1652/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001653 * This function will use the architecture-specific hardware random
1654 * number generator if it is available. The arch-specific hw RNG will
1655 * almost certainly be faster than what we can do in software, but it
1656 * is impossible to verify that it is implemented securely (as
1657 * opposed, to, say, the AES encryption of a sequence number using a
1658 * key known by the NSA). So it's useful if we need the speed, but
1659 * only if we're willing to trust the hardware manufacturer not to
1660 * have put in a back door.
1661 */
1662void get_random_bytes_arch(void *buf, int nbytes)
1663{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001664 char *p = buf;
1665
Theodore Ts'o59108952013-09-12 14:10:25 -04001666 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001667 while (nbytes) {
1668 unsigned long v;
1669 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001670
H. Peter Anvin63d77172011-07-31 13:54:50 -07001671 if (!arch_get_random_long(&v))
1672 break;
1673
Luck, Tonybd29e562011-11-16 10:50:56 -08001674 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001675 p += chunk;
1676 nbytes -= chunk;
1677 }
1678
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001679 if (nbytes)
Theodore Ts'oe192be92016-06-12 18:13:36 -04001680 get_random_bytes(p, nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001682EXPORT_SYMBOL(get_random_bytes_arch);
1683
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684
1685/*
1686 * init_std_data - initialize pool with system data
1687 *
1688 * @r: pool to initialize
1689 *
1690 * This function clears the pool's entropy count and mixes some system
1691 * data into the pool to prepare it for use. The pool is not cleared
1692 * as that can only decrease the entropy in the pool.
1693 */
1694static void init_std_data(struct entropy_store *r)
1695{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001696 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001697 ktime_t now = ktime_get_real();
1698 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
Theodore Ts'of5c27422013-09-22 15:14:32 -04001700 r->last_pulled = jiffies;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001701 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001702 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001703 if (!arch_get_random_seed_long(&rv) &&
1704 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001705 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001706 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001707 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001708 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709}
1710
Tony Luckcbc96b72012-07-23 09:47:57 -07001711/*
1712 * Note that setup_arch() may call add_device_randomness()
1713 * long before we get here. This allows seeding of the pools
1714 * with some platform dependent data very early in the boot
1715 * process. But it limits our options here. We must use
1716 * statically allocated structures that already have all
1717 * initializations complete at compile time. We should also
1718 * take care not to overwrite the precious per platform data
1719 * we were given.
1720 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001721static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722{
1723 init_std_data(&input_pool);
1724 init_std_data(&blocking_pool);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001725 crng_initialize(&primary_crng);
Theodore Ts'o1d49e2a2018-04-11 16:32:17 -04001726 crng_global_init_time = jiffies;
Theodore Ts'o17e20c82018-04-25 01:12:32 -04001727 if (ratelimit_disable) {
1728 urandom_warning.interval = 0;
1729 unseeded_warning.interval = 0;
1730 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 return 0;
1732}
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001733early_initcall(rand_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
David Howells93614012006-09-30 20:45:40 +02001735#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736void rand_initialize_disk(struct gendisk *disk)
1737{
1738 struct timer_rand_state *state;
1739
1740 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001741 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 * source.
1743 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001744 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001745 if (state) {
1746 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001748 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749}
David Howells93614012006-09-30 20:45:40 +02001750#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751
1752static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001753_random_read(int nonblock, char __user *buf, size_t nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754{
Greg Price12ff3a52013-11-29 15:02:33 -05001755 ssize_t n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
1757 if (nbytes == 0)
1758 return 0;
1759
Greg Price12ff3a52013-11-29 15:02:33 -05001760 nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1761 while (1) {
1762 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1763 if (n < 0)
1764 return n;
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001765 trace_random_read(n*8, (nbytes-n)*8,
1766 ENTROPY_BITS(&blocking_pool),
1767 ENTROPY_BITS(&input_pool));
Greg Price12ff3a52013-11-29 15:02:33 -05001768 if (n > 0)
1769 return n;
H. Peter Anvin331c6492014-03-17 16:36:29 -07001770
Greg Price12ff3a52013-11-29 15:02:33 -05001771 /* Pool is (near) empty. Maybe wait and retry. */
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001772 if (nonblock)
Greg Price12ff3a52013-11-29 15:02:33 -05001773 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
Greg Price12ff3a52013-11-29 15:02:33 -05001775 wait_event_interruptible(random_read_wait,
1776 ENTROPY_BITS(&input_pool) >=
Greg Price2132a962013-12-06 21:28:03 -05001777 random_read_wakeup_bits);
Greg Price12ff3a52013-11-29 15:02:33 -05001778 if (signal_pending(current))
1779 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781}
1782
1783static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001784random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1785{
1786 return _random_read(file->f_flags & O_NONBLOCK, buf, nbytes);
1787}
1788
1789static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001790urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001792 unsigned long flags;
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001793 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05001794 int ret;
1795
Theodore Ts'oe192be92016-06-12 18:13:36 -04001796 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001797 maxwarn--;
Theodore Ts'o17e20c82018-04-25 01:12:32 -04001798 if (__ratelimit(&urandom_warning))
1799 printk(KERN_NOTICE "random: %s: uninitialized "
1800 "urandom read (%zd bytes read)\n",
1801 current->comm, nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001802 spin_lock_irqsave(&primary_crng.lock, flags);
1803 crng_init_cnt = 0;
1804 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001805 }
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001806 nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
Theodore Ts'oe192be92016-06-12 18:13:36 -04001807 ret = extract_crng_user(buf, nbytes);
1808 trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001809 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810}
1811
1812static unsigned int
1813random_poll(struct file *file, poll_table * wait)
1814{
1815 unsigned int mask;
1816
1817 poll_wait(file, &random_read_wait, wait);
1818 poll_wait(file, &random_write_wait, wait);
1819 mask = 0;
Greg Price2132a962013-12-06 21:28:03 -05001820 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 mask |= POLLIN | POLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05001822 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 mask |= POLLOUT | POLLWRNORM;
1824 return mask;
1825}
1826
Matt Mackall7f397dc2007-05-29 21:58:10 -05001827static int
1828write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1829{
1830 size_t bytes;
Theodore Ts'o820f2bc2018-07-14 23:55:57 -04001831 __u32 t, buf[16];
Matt Mackall7f397dc2007-05-29 21:58:10 -05001832 const char __user *p = buffer;
1833
1834 while (count > 0) {
Theodore Ts'o820f2bc2018-07-14 23:55:57 -04001835 int b, i = 0;
1836
Matt Mackall7f397dc2007-05-29 21:58:10 -05001837 bytes = min(count, sizeof(buf));
1838 if (copy_from_user(&buf, p, bytes))
1839 return -EFAULT;
1840
Theodore Ts'o820f2bc2018-07-14 23:55:57 -04001841 for (b = bytes ; b > 0 ; b -= sizeof(__u32), i++) {
1842 if (!arch_get_random_int(&t))
1843 break;
1844 buf[i] ^= t;
1845 }
1846
Matt Mackall7f397dc2007-05-29 21:58:10 -05001847 count -= bytes;
1848 p += bytes;
1849
Theodore Ts'o85608f82014-06-10 23:09:20 -04001850 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001851 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001852 }
1853
1854 return 0;
1855}
1856
Matt Mackall90b75ee2008-04-29 01:02:55 -07001857static ssize_t random_write(struct file *file, const char __user *buffer,
1858 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001860 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861
Theodore Ts'oe192be92016-06-12 18:13:36 -04001862 ret = write_pool(&input_pool, buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05001863 if (ret)
1864 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865
Matt Mackall7f397dc2007-05-29 21:58:10 -05001866 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867}
1868
Matt Mackall43ae4862008-04-29 01:02:58 -07001869static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870{
1871 int size, ent_count;
1872 int __user *p = (int __user *)arg;
1873 int retval;
1874
1875 switch (cmd) {
1876 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001877 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001878 ent_count = ENTROPY_BITS(&input_pool);
1879 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 return -EFAULT;
1881 return 0;
1882 case RNDADDTOENTCNT:
1883 if (!capable(CAP_SYS_ADMIN))
1884 return -EPERM;
1885 if (get_user(ent_count, p))
1886 return -EFAULT;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001887 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 case RNDADDENTROPY:
1889 if (!capable(CAP_SYS_ADMIN))
1890 return -EPERM;
1891 if (get_user(ent_count, p++))
1892 return -EFAULT;
1893 if (ent_count < 0)
1894 return -EINVAL;
1895 if (get_user(size, p++))
1896 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001897 retval = write_pool(&input_pool, (const char __user *)p,
1898 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 if (retval < 0)
1900 return retval;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001901 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 case RNDZAPENTCNT:
1903 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001904 /*
1905 * Clear the entropy pool counters. We no longer clear
1906 * the entropy pool, as that's silly.
1907 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 if (!capable(CAP_SYS_ADMIN))
1909 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001910 input_pool.entropy_count = 0;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001911 blocking_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 return 0;
Theodore Ts'o1d49e2a2018-04-11 16:32:17 -04001913 case RNDRESEEDCRNG:
1914 if (!capable(CAP_SYS_ADMIN))
1915 return -EPERM;
1916 if (crng_init < 2)
1917 return -ENODATA;
Eric Biggers776ce242021-01-12 11:28:18 -08001918 crng_reseed(&primary_crng, &input_pool);
Theodore Ts'o1d49e2a2018-04-11 16:32:17 -04001919 crng_global_init_time = jiffies - 1;
1920 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 default:
1922 return -EINVAL;
1923 }
1924}
1925
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001926static int random_fasync(int fd, struct file *filp, int on)
1927{
1928 return fasync_helper(fd, filp, on, &fasync);
1929}
1930
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001931const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 .read = random_read,
1933 .write = random_write,
1934 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001935 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001936 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001937 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938};
1939
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001940const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 .read = urandom_read,
1942 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001943 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001944 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001945 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946};
1947
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001948SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
1949 unsigned int, flags)
1950{
1951 if (flags & ~(GRND_NONBLOCK|GRND_RANDOM))
1952 return -EINVAL;
1953
1954 if (count > INT_MAX)
1955 count = INT_MAX;
1956
1957 if (flags & GRND_RANDOM)
1958 return _random_read(flags & GRND_NONBLOCK, buf, count);
1959
Theodore Ts'oe192be92016-06-12 18:13:36 -04001960 if (!crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001961 if (flags & GRND_NONBLOCK)
1962 return -EAGAIN;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001963 crng_wait_ready();
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001964 if (signal_pending(current))
1965 return -ERESTARTSYS;
1966 }
1967 return urandom_read(NULL, buf, count, NULL);
1968}
1969
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970/********************************************************************
1971 *
1972 * Sysctl interface
1973 *
1974 ********************************************************************/
1975
1976#ifdef CONFIG_SYSCTL
1977
1978#include <linux/sysctl.h>
1979
1980static int min_read_thresh = 8, min_write_thresh;
Greg Price8c2aa332013-12-05 19:19:29 -05001981static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982static int max_write_thresh = INPUT_POOL_WORDS * 32;
1983static char sysctl_bootid[16];
1984
1985/*
Greg Pricef22052b2013-11-29 14:58:16 -05001986 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 * UUID. The difference is in whether table->data is NULL; if it is,
1988 * then a new UUID is generated and returned to the user.
1989 *
Greg Pricef22052b2013-11-29 14:58:16 -05001990 * If the user accesses this via the proc interface, the UUID will be
1991 * returned as an ASCII string in the standard UUID format; if via the
1992 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 */
Joe Perchesa1514272013-06-13 19:37:35 -07001994static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 void __user *buffer, size_t *lenp, loff_t *ppos)
1996{
Joe Perchesa1514272013-06-13 19:37:35 -07001997 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998 unsigned char buf[64], tmp_uuid[16], *uuid;
1999
2000 uuid = table->data;
2001 if (!uuid) {
2002 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07002004 } else {
2005 static DEFINE_SPINLOCK(bootid_spinlock);
2006
2007 spin_lock(&bootid_spinlock);
2008 if (!uuid[8])
2009 generate_random_uuid(uuid);
2010 spin_unlock(&bootid_spinlock);
2011 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
Joe Perches35900772009-12-14 18:01:11 -08002013 sprintf(buf, "%pU", uuid);
2014
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 fake_table.data = buf;
2016 fake_table.maxlen = sizeof(buf);
2017
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002018 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019}
2020
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002021/*
2022 * Return entropy available scaled to integral bits
2023 */
Joe Perches5eb10d92014-06-06 14:37:58 -07002024static int proc_do_entropy(struct ctl_table *table, int write,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002025 void __user *buffer, size_t *lenp, loff_t *ppos)
2026{
Joe Perches5eb10d92014-06-06 14:37:58 -07002027 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002028 int entropy_count;
2029
2030 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
2031
2032 fake_table.data = &entropy_count;
2033 fake_table.maxlen = sizeof(entropy_count);
2034
2035 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
2036}
2037
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07002039extern struct ctl_table random_table[];
2040struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 .procname = "poolsize",
2043 .data = &sysctl_poolsize,
2044 .maxlen = sizeof(int),
2045 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002046 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 },
2048 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 .procname = "entropy_avail",
2050 .maxlen = sizeof(int),
2051 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002052 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 .data = &input_pool.entropy_count,
2054 },
2055 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 .procname = "read_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002057 .data = &random_read_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 .maxlen = sizeof(int),
2059 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002060 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 .extra1 = &min_read_thresh,
2062 .extra2 = &max_read_thresh,
2063 },
2064 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002066 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 .maxlen = sizeof(int),
2068 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002069 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 .extra1 = &min_write_thresh,
2071 .extra2 = &max_write_thresh,
2072 },
2073 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002074 .procname = "urandom_min_reseed_secs",
2075 .data = &random_min_urandom_seed,
2076 .maxlen = sizeof(int),
2077 .mode = 0644,
2078 .proc_handler = proc_dointvec,
2079 },
2080 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 .procname = "boot_id",
2082 .data = &sysctl_bootid,
2083 .maxlen = 16,
2084 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002085 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 },
2087 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 .procname = "uuid",
2089 .maxlen = 16,
2090 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002091 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002093#ifdef ADD_INTERRUPT_BENCH
2094 {
2095 .procname = "add_interrupt_avg_cycles",
2096 .data = &avg_cycles,
2097 .maxlen = sizeof(avg_cycles),
2098 .mode = 0444,
2099 .proc_handler = proc_doulongvec_minmax,
2100 },
2101 {
2102 .procname = "add_interrupt_avg_deviation",
2103 .data = &avg_deviation,
2104 .maxlen = sizeof(avg_deviation),
2105 .mode = 0444,
2106 .proc_handler = proc_doulongvec_minmax,
2107 },
2108#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002109 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110};
2111#endif /* CONFIG_SYSCTL */
2112
Jason A. Donenfeld7c036132017-01-06 19:32:01 +01002113struct batched_entropy {
2114 union {
2115 unsigned long entropy_long[CHACHA20_BLOCK_SIZE / sizeof(unsigned long)];
2116 unsigned int entropy_int[CHACHA20_BLOCK_SIZE / sizeof(unsigned int)];
2117 };
2118 unsigned int position;
2119};
Eric Biggersb1132de2016-05-04 21:08:39 -04002120
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121/*
Jason A. Donenfeld7c036132017-01-06 19:32:01 +01002122 * Get a random word for internal kernel use only. The quality of the random
Jason A. Donenfeld5f27cae2020-02-21 21:10:37 +01002123 * number is good as /dev/urandom, but there is no backtrack protection, with
2124 * the goal of being quite fast and not depleting entropy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 */
Jason A. Donenfeld7c036132017-01-06 19:32:01 +01002126static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_long);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002127unsigned long get_random_long(void)
2128{
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002129 unsigned long ret;
Jason A. Donenfeld7c036132017-01-06 19:32:01 +01002130 struct batched_entropy *batch;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002131
Jason A. Donenfeld7c036132017-01-06 19:32:01 +01002132 batch = &get_cpu_var(batched_entropy_long);
2133 if (batch->position % ARRAY_SIZE(batch->entropy_long) == 0) {
2134 extract_crng((u8 *)batch->entropy_long);
2135 batch->position = 0;
2136 }
2137 ret = batch->entropy_long[batch->position++];
2138 put_cpu_var(batched_entropy_long);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002139 return ret;
2140}
2141EXPORT_SYMBOL(get_random_long);
2142
Jason A. Donenfeld7c036132017-01-06 19:32:01 +01002143#if BITS_PER_LONG == 32
2144unsigned int get_random_int(void)
2145{
2146 return get_random_long();
2147}
2148#else
2149static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_int);
2150unsigned int get_random_int(void)
2151{
2152 unsigned int ret;
2153 struct batched_entropy *batch;
2154
Jason A. Donenfeld7c036132017-01-06 19:32:01 +01002155 batch = &get_cpu_var(batched_entropy_int);
2156 if (batch->position % ARRAY_SIZE(batch->entropy_int) == 0) {
2157 extract_crng((u8 *)batch->entropy_int);
2158 batch->position = 0;
2159 }
2160 ret = batch->entropy_int[batch->position++];
2161 put_cpu_var(batched_entropy_int);
2162 return ret;
2163}
2164#endif
2165EXPORT_SYMBOL(get_random_int);
2166
Jason Cooper99fdafd2016-10-11 13:53:52 -07002167/**
2168 * randomize_page - Generate a random, page aligned address
2169 * @start: The smallest acceptable address the caller will take.
2170 * @range: The size of the area, starting at @start, within which the
2171 * random address must fall.
2172 *
2173 * If @start + @range would overflow, @range is capped.
2174 *
2175 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2176 * @start was already page aligned. We now align it regardless.
2177 *
2178 * Return: A page aligned address within [start, start + range). On error,
2179 * @start is returned.
2180 */
2181unsigned long
2182randomize_page(unsigned long start, unsigned long range)
2183{
2184 if (!PAGE_ALIGNED(start)) {
2185 range -= PAGE_ALIGN(start) - start;
2186 start = PAGE_ALIGN(start);
2187 }
2188
2189 if (start > ULONG_MAX - range)
2190 range = ULONG_MAX - start;
2191
2192 range >>= PAGE_SHIFT;
2193
2194 if (range == 0)
2195 return start;
2196
2197 return start + (get_random_long() % range << PAGE_SHIFT);
2198}
2199
Torsten Duwec84dbf62014-06-14 23:38:36 -04002200/* Interface for in-kernel drivers of true hardware RNGs.
2201 * Those devices may produce endless random bits and will be throttled
2202 * when our pool is full.
2203 */
2204void add_hwgenerator_randomness(const char *buffer, size_t count,
2205 size_t entropy)
2206{
2207 struct entropy_store *poolp = &input_pool;
2208
Theodore Ts'o4dfb3442018-04-11 13:27:52 -04002209 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04002210 crng_fast_load(buffer, count);
2211 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002212 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002213
2214 /* Suspend writing if we're above the trickle threshold.
2215 * We'll be woken up again once below random_write_wakeup_thresh,
2216 * or when the calling thread is about to terminate.
2217 */
2218 wait_event_interruptible(random_write_wait, kthread_should_stop() ||
2219 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002220 mix_pool_bytes(poolp, buffer, count);
2221 credit_entropy_bits(poolp, entropy);
2222}
2223EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);