blob: a8fb0020ba5ccfb9f4b72b689544299815fab60a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * random.c -- A strong random number generator
3 *
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04004 * Copyright (C) 2017 Jason A. Donenfeld <Jason@zx2c4.com>. All
5 * Rights Reserved.
6 *
Matt Mackall9e95ce22005-04-16 15:25:56 -07007 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
10 * rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, and the entire permission notice in its entirety,
17 * including the disclaimer of warranties.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. The name of the author may not be used to endorse or promote
22 * products derived from this software without specific prior
23 * written permission.
24 *
25 * ALTERNATIVELY, this product may be distributed under the terms of
26 * the GNU General Public License, in which case the provisions of the GPL are
27 * required INSTEAD OF the above restrictions. (This clause is
28 * necessary due to a potential bad interaction between the GPL and
29 * the restrictions contained in a BSD-style copyright.)
30 *
31 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
32 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
34 * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
35 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
37 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
38 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
41 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
42 * DAMAGE.
43 */
44
45/*
46 * (now, with legal B.S. out of the way.....)
47 *
48 * This routine gathers environmental noise from device drivers, etc.,
49 * and returns good random numbers, suitable for cryptographic use.
50 * Besides the obvious cryptographic uses, these numbers are also good
51 * for seeding TCP sequence numbers, and other places where it is
52 * desirable to have numbers which are not only random, but hard to
53 * predict by an attacker.
54 *
55 * Theory of operation
56 * ===================
57 *
58 * Computers are very predictable devices. Hence it is extremely hard
59 * to produce truly random numbers on a computer --- as opposed to
60 * pseudo-random numbers, which can easily generated by using a
61 * algorithm. Unfortunately, it is very easy for attackers to guess
62 * the sequence of pseudo-random number generators, and for some
63 * applications this is not acceptable. So instead, we must try to
64 * gather "environmental noise" from the computer's environment, which
65 * must be hard for outside attackers to observe, and use that to
66 * generate random numbers. In a Unix environment, this is best done
67 * from inside the kernel.
68 *
69 * Sources of randomness from the environment include inter-keyboard
70 * timings, inter-interrupt timings from some interrupts, and other
71 * events which are both (a) non-deterministic and (b) hard for an
72 * outside observer to measure. Randomness from these sources are
73 * added to an "entropy pool", which is mixed using a CRC-like function.
74 * This is not cryptographically strong, but it is adequate assuming
75 * the randomness is not chosen maliciously, and it is fast enough that
76 * the overhead of doing it on every interrupt is very reasonable.
77 * As random bytes are mixed into the entropy pool, the routines keep
78 * an *estimate* of how many bits of randomness have been stored into
79 * the random number generator's internal state.
80 *
81 * When random bytes are desired, they are obtained by taking the SHA
82 * hash of the contents of the "entropy pool". The SHA hash avoids
83 * exposing the internal state of the entropy pool. It is believed to
84 * be computationally infeasible to derive any useful information
85 * about the input of SHA from its output. Even if it is possible to
86 * analyze SHA in some clever way, as long as the amount of data
87 * returned from the generator is less than the inherent entropy in
88 * the pool, the output data is totally unpredictable. For this
89 * reason, the routine decreases its internal estimate of how many
90 * bits of "true randomness" are contained in the entropy pool as it
91 * outputs random numbers.
92 *
93 * If this estimate goes to zero, the routine can still generate
94 * random numbers; however, an attacker may (at least in theory) be
95 * able to infer the future output of the generator from prior
96 * outputs. This requires successful cryptanalysis of SHA, which is
97 * not believed to be feasible, but there is a remote possibility.
98 * Nonetheless, these numbers should be useful for the vast majority
99 * of purposes.
100 *
101 * Exported interfaces ---- output
102 * ===============================
103 *
104 * There are three exported interfaces; the first is one designed to
105 * be used from within the kernel:
106 *
107 * void get_random_bytes(void *buf, int nbytes);
108 *
109 * This interface will return the requested number of random bytes,
110 * and place it in the requested buffer.
111 *
112 * The two other interfaces are two character devices /dev/random and
113 * /dev/urandom. /dev/random is suitable for use when very high
114 * quality randomness is desired (for example, for key generation or
115 * one-time pads), as it will only return a maximum of the number of
116 * bits of randomness (as estimated by the random number generator)
117 * contained in the entropy pool.
118 *
119 * The /dev/urandom device does not have this limit, and will return
120 * as many bytes as are requested. As more and more random bytes are
121 * requested without giving time for the entropy pool to recharge,
122 * this will result in random numbers that are merely cryptographically
123 * strong. For many applications, however, this is acceptable.
124 *
125 * Exported interfaces ---- input
126 * ==============================
127 *
128 * The current exported interfaces for gathering environmental noise
129 * from the devices are:
130 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400131 * void add_device_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * void add_input_randomness(unsigned int type, unsigned int code,
133 * unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400134 * void add_interrupt_randomness(int irq, int irq_flags);
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100135 * void add_disk_randomness(struct gendisk *disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400137 * add_device_randomness() is for adding data to the random pool that
138 * is likely to differ between two devices (or possibly even per boot).
139 * This would be things like MAC addresses or serial numbers, or the
140 * read-out of the RTC. This does *not* add any actual entropy to the
141 * pool, but it initializes the pool to different values for devices
142 * that might otherwise be identical and have very little entropy
143 * available to them (particularly common in the embedded world).
144 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 * add_input_randomness() uses the input layer interrupt timing, as well as
146 * the event type information from the hardware.
147 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400148 * add_interrupt_randomness() uses the interrupt timing as random
149 * inputs to the entropy pool. Using the cycle counters and the irq source
150 * as inputs, it feeds the randomness roughly once a second.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100151 *
152 * add_disk_randomness() uses what amounts to the seek time of block
153 * layer request events, on a per-disk_devt basis, as input to the
154 * entropy pool. Note that high-speed solid state drives with very low
155 * seek times do not make for good sources of entropy, as their seek
156 * times are usually fairly consistent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 *
158 * All of these routines try to estimate how many bits of randomness a
159 * particular randomness source. They do this by keeping track of the
160 * first and second order deltas of the event timings.
161 *
162 * Ensuring unpredictability at system startup
163 * ============================================
164 *
165 * When any operating system starts up, it will go through a sequence
166 * of actions that are fairly predictable by an adversary, especially
167 * if the start-up does not involve interaction with a human operator.
168 * This reduces the actual number of bits of unpredictability in the
169 * entropy pool below the value in entropy_count. In order to
170 * counteract this effect, it helps to carry information in the
171 * entropy pool across shut-downs and start-ups. To do this, put the
172 * following lines an appropriate script which is run during the boot
173 * sequence:
174 *
175 * echo "Initializing random number generator..."
176 * random_seed=/var/run/random-seed
177 * # Carry a random seed from start-up to start-up
178 * # Load and then save the whole entropy pool
179 * if [ -f $random_seed ]; then
180 * cat $random_seed >/dev/urandom
181 * else
182 * touch $random_seed
183 * fi
184 * chmod 600 $random_seed
185 * dd if=/dev/urandom of=$random_seed count=1 bs=512
186 *
187 * and the following lines in an appropriate script which is run as
188 * the system is shutdown:
189 *
190 * # Carry a random seed from shut-down to start-up
191 * # Save the whole entropy pool
192 * echo "Saving random seed..."
193 * random_seed=/var/run/random-seed
194 * touch $random_seed
195 * chmod 600 $random_seed
196 * dd if=/dev/urandom of=$random_seed count=1 bs=512
197 *
198 * For example, on most modern systems using the System V init
199 * scripts, such code fragments would be found in
200 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
201 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
202 *
203 * Effectively, these commands cause the contents of the entropy pool
204 * to be saved at shut-down time and reloaded into the entropy pool at
205 * start-up. (The 'dd' in the addition to the bootup script is to
206 * make sure that /etc/random-seed is different for every start-up,
207 * even if the system crashes without executing rc.0.) Even with
208 * complete knowledge of the start-up activities, predicting the state
209 * of the entropy pool requires knowledge of the previous history of
210 * the system.
211 *
212 * Configuring the /dev/random driver under Linux
213 * ==============================================
214 *
215 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
216 * the /dev/mem major number (#1). So if your system does not have
217 * /dev/random and /dev/urandom created already, they can be created
218 * by using the commands:
219 *
220 * mknod /dev/random c 1 8
221 * mknod /dev/urandom c 1 9
222 *
223 * Acknowledgements:
224 * =================
225 *
226 * Ideas for constructing this random number generator were derived
227 * from Pretty Good Privacy's random number generator, and from private
228 * discussions with Phil Karn. Colin Plumb provided a faster random
229 * number generator, which speed up the mixing function of the entropy
230 * pool, taken from PGPfone. Dale Worley has also contributed many
231 * useful ideas and suggestions to improve this driver.
232 *
233 * Any flaws in the design are solely my responsibility, and should
234 * not be attributed to the Phil, Colin, or any of authors of PGP.
235 *
236 * Further background information on this topic may be obtained from
237 * RFC 1750, "Randomness Recommendations for Security", by Donald
238 * Eastlake, Steve Crocker, and Jeff Schiller.
239 */
240
241#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242#include <linux/module.h>
243#include <linux/kernel.h>
244#include <linux/major.h>
245#include <linux/string.h>
246#include <linux/fcntl.h>
247#include <linux/slab.h>
248#include <linux/random.h>
249#include <linux/poll.h>
250#include <linux/init.h>
251#include <linux/fs.h>
252#include <linux/genhd.h>
253#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700254#include <linux/mm.h>
Michael Ellermandd0f0cf2016-07-31 00:23:08 +1000255#include <linux/nodemask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256#include <linux/spinlock.h>
Torsten Duwec84dbf62014-06-14 23:38:36 -0400257#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#include <linux/percpu.h>
259#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800260#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400261#include <linux/ptrace.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400262#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200263#include <linux/irq.h>
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400264#include <linux/ratelimit.h>
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400265#include <linux/syscalls.h>
266#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700267#include <linux/uuid.h>
Theodore Ts'oe192be92016-06-12 18:13:36 -0400268#include <crypto/chacha20.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800269
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270#include <asm/processor.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800271#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400273#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#include <asm/io.h>
275
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400276#define CREATE_TRACE_POINTS
277#include <trace/events/random.h>
278
Theodore Ts'o43759d42014-06-14 21:43:13 -0400279/* #define ADD_INTERRUPT_BENCH */
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281/*
282 * Configuration information
283 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400284#define INPUT_POOL_SHIFT 12
285#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
286#define OUTPUT_POOL_SHIFT 10
287#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
288#define SEC_XFER_SIZE 512
289#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400292#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400295 * To allow fractional bits to be tracked, the entropy_count field is
296 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400297 *
298 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
299 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400300 */
301#define ENTROPY_SHIFT 3
302#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
303
304/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 * The minimum number of bits of entropy before we wake up a read on
306 * /dev/random. Should be enough to do a significant reseed.
307 */
Greg Price2132a962013-12-06 21:28:03 -0500308static int random_read_wakeup_bits = 64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310/*
311 * If the entropy count falls under this number of bits, then we
312 * should wake up processes which are selecting or polling on write
313 * access to /dev/random.
314 */
Greg Price2132a962013-12-06 21:28:03 -0500315static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400318 * Originally, we used a primitive polynomial of degree .poolwords
319 * over GF(2). The taps for various sizes are defined below. They
320 * were chosen to be evenly spaced except for the last tap, which is 1
321 * to get the twisting happening as fast as possible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400323 * For the purposes of better mixing, we use the CRC-32 polynomial as
324 * well to make a (modified) twisted Generalized Feedback Shift
325 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
326 * generators. ACM Transactions on Modeling and Computer Simulation
327 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
Greg Pricedfd38752013-11-29 14:58:06 -0500328 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400329 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 *
331 * Thanks to Colin Plumb for suggesting this.
332 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400333 * The mixing operation is much less sensitive than the output hash,
334 * where we use SHA-1. All that we want of mixing operation is that
335 * it be a good non-cryptographic hash; i.e. it not produce collisions
336 * when fed "random" data of the sort we expect to see. As long as
337 * the pool state differs for different inputs, we have preserved the
338 * input entropy and done a good job. The fact that an intelligent
339 * attacker can construct inputs that will produce controlled
340 * alterations to the pool's state is not important because we don't
341 * consider such inputs to contribute any randomness. The only
342 * property we need with respect to them is that the attacker can't
343 * increase his/her knowledge of the pool's state. Since all
344 * additions are reversible (knowing the final state and the input,
345 * you can reconstruct the initial state), if an attacker has any
346 * uncertainty about the initial state, he/she can only shuffle that
347 * uncertainty about, but never cause any collisions (which would
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 * decrease the uncertainty).
349 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400350 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
351 * Videau in their paper, "The Linux Pseudorandom Number Generator
352 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
353 * paper, they point out that we are not using a true Twisted GFSR,
354 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
355 * is, with only three taps, instead of the six that we are using).
356 * As a result, the resulting polynomial is neither primitive nor
357 * irreducible, and hence does not have a maximal period over
358 * GF(2**32). They suggest a slight change to the generator
359 * polynomial which improves the resulting TGFSR polynomial to be
360 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400363 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
364#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 int tap1, tap2, tap3, tap4, tap5;
366} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400367 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
368 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
369 { S(128), 104, 76, 51, 25, 1 },
370 /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
371 /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
372 { S(32), 26, 19, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373#if 0
374 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400375 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400378 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400381 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400384 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
386 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400387 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400389 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400392 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400395 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400398 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399#endif
400};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402/*
403 * Static global variables
404 */
Christoph Hellwig89b310a2018-04-09 15:29:32 +0200405static DECLARE_WAIT_QUEUE_HEAD(random_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700406static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Herbert Xu205a5252015-06-09 18:19:39 +0800408static DEFINE_SPINLOCK(random_ready_list_lock);
409static LIST_HEAD(random_ready_list);
410
Theodore Ts'oe192be92016-06-12 18:13:36 -0400411struct crng_state {
412 __u32 state[16];
413 unsigned long init_time;
414 spinlock_t lock;
415};
416
417struct crng_state primary_crng = {
418 .lock = __SPIN_LOCK_UNLOCKED(primary_crng.lock),
419};
420
421/*
422 * crng_init = 0 --> Uninitialized
423 * 1 --> Initialized
424 * 2 --> Initialized from input_pool
425 *
426 * crng_init is protected by primary_crng->lock, and only increases
427 * its value (from 0->1->2).
428 */
429static int crng_init = 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400430#define crng_ready() (likely(crng_init > 1))
Theodore Ts'oe192be92016-06-12 18:13:36 -0400431static int crng_init_cnt = 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400432static unsigned long crng_global_init_time = 0;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400433#define CRNG_INIT_CNT_THRESH (2*CHACHA20_KEY_SIZE)
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400434static void _extract_crng(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800435 __u32 out[CHACHA20_BLOCK_WORDS]);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400436static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800437 __u32 tmp[CHACHA20_BLOCK_WORDS], int used);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400438static void process_random_ready_list(void);
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400439static void _get_random_bytes(void *buf, int nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400440
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400441static struct ratelimit_state unseeded_warning =
442 RATELIMIT_STATE_INIT("warn_unseeded_randomness", HZ, 3);
443static struct ratelimit_state urandom_warning =
444 RATELIMIT_STATE_INIT("warn_urandom_randomness", HZ, 3);
445
446static int ratelimit_disable __read_mostly;
447
448module_param_named(ratelimit_disable, ratelimit_disable, int, 0644);
449MODULE_PARM_DESC(ratelimit_disable, "Disable random ratelimit suppression");
450
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451/**********************************************************************
452 *
453 * OS independent entropy store. Here are the functions which handle
454 * storing entropy in an entropy pool.
455 *
456 **********************************************************************/
457
458struct entropy_store;
459struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700460 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400461 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 __u32 *pool;
463 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400465 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
467 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400468 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700469 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400470 unsigned short add_ptr;
471 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800472 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400473 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400474 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400475 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000476 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477};
478
Theodore Ts'oe192be92016-06-12 18:13:36 -0400479static ssize_t extract_entropy(struct entropy_store *r, void *buf,
480 size_t nbytes, int min, int rsvd);
481static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
482 size_t nbytes, int fips);
483
484static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400485static void push_to_pool(struct work_struct *work);
Emese Revfy0766f782016-06-20 20:42:34 +0200486static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
487static __u32 blocking_pool_data[OUTPUT_POOL_WORDS] __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
489static struct entropy_store input_pool = {
490 .poolinfo = &poolinfo_table[0],
491 .name = "input",
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200492 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 .pool = input_pool_data
494};
495
496static struct entropy_store blocking_pool = {
497 .poolinfo = &poolinfo_table[1],
498 .name = "blocking",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200500 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400501 .pool = blocking_pool_data,
502 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
503 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504};
505
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400506static __u32 const twist_table[8] = {
507 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
508 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700511 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700513 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 *
515 * The pool is stirred with a primitive polynomial of the appropriate
516 * degree, and then twisted. We twist by three bits at a time because
517 * it's cheap to do so and helps slightly in the expected case where
518 * the entropy is concentrated in the low-order bits.
519 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400520static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400521 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400523 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700524 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700526 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700527 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 tap1 = r->poolinfo->tap1;
530 tap2 = r->poolinfo->tap2;
531 tap3 = r->poolinfo->tap3;
532 tap4 = r->poolinfo->tap4;
533 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400535 input_rotate = r->input_rotate;
536 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Matt Mackalle68e5b62008-04-29 01:03:05 -0700538 /* mix one byte at a time to simplify size handling and churn faster */
539 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400540 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700541 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
543 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700544 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 w ^= r->pool[(i + tap1) & wordmask];
546 w ^= r->pool[(i + tap2) & wordmask];
547 w ^= r->pool[(i + tap3) & wordmask];
548 w ^= r->pool[(i + tap4) & wordmask];
549 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700550
551 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700553
554 /*
555 * Normally, we add 7 bits of rotation to the pool.
556 * At the beginning of the pool, add an extra 7 bits
557 * rotation, so that successive passes spread the
558 * input bits across the pool evenly.
559 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400560 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 }
562
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400563 r->input_rotate = input_rotate;
564 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
566
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400567static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400568 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400570 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400571 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400572}
573
574static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400575 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400576{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400577 unsigned long flags;
578
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400579 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400580 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400581 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400582 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583}
584
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400585struct fast_pool {
586 __u32 pool[4];
587 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400588 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400589 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400590};
591
592/*
593 * This is a fast mixing routine used by the interrupt randomness
594 * collector. It's hardcoded for an 128 bit pool and assumes that any
595 * locks that might be needed are taken by the caller.
596 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400597static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400598{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400599 __u32 a = f->pool[0], b = f->pool[1];
600 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400601
Theodore Ts'o43759d42014-06-14 21:43:13 -0400602 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500603 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400604 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400605
Theodore Ts'o43759d42014-06-14 21:43:13 -0400606 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500607 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400608 d ^= a; b ^= c;
609
610 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500611 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400612 d ^= a; b ^= c;
613
614 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500615 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400616 d ^= a; b ^= c;
617
618 f->pool[0] = a; f->pool[1] = b;
619 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400620 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400621}
622
Herbert Xu205a5252015-06-09 18:19:39 +0800623static void process_random_ready_list(void)
624{
625 unsigned long flags;
626 struct random_ready_callback *rdy, *tmp;
627
628 spin_lock_irqsave(&random_ready_list_lock, flags);
629 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
630 struct module *owner = rdy->owner;
631
632 list_del_init(&rdy->list);
633 rdy->func(rdy);
634 module_put(owner);
635 }
636 spin_unlock_irqrestore(&random_ready_list_lock, flags);
637}
638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400640 * Credit (or debit) the entropy store with n bits of entropy.
641 * Use credit_entropy_bits_safe() if the value comes from userspace
642 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700644static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400646 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400647 const int pool_size = r->poolinfo->poolfracbits;
648 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
Matt Mackalladc782d2008-04-29 01:03:07 -0700650 if (!nbits)
651 return;
652
Theodore Ts'o902c0982012-07-04 10:38:30 -0400653retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -0700654 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400655 if (nfrac < 0) {
656 /* Debit */
657 entropy_count += nfrac;
658 } else {
659 /*
660 * Credit: we have to account for the possibility of
661 * overwriting already present entropy. Even in the
662 * ideal case of pure Shannon entropy, new contributions
663 * approach the full value asymptotically:
664 *
665 * entropy <- entropy + (pool_size - entropy) *
666 * (1 - exp(-add_entropy/pool_size))
667 *
668 * For add_entropy <= pool_size/2 then
669 * (1 - exp(-add_entropy/pool_size)) >=
670 * (add_entropy/pool_size)*0.7869...
671 * so we can approximate the exponential with
672 * 3/4*add_entropy/pool_size and still be on the
673 * safe side by adding at most pool_size/2 at a time.
674 *
675 * The use of pool_size-2 in the while statement is to
676 * prevent rounding artifacts from making the loop
677 * arbitrarily long; this limits the loop to log2(pool_size)*2
678 * turns no matter how large nbits is.
679 */
680 int pnfrac = nfrac;
681 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
682 /* The +2 corresponds to the /4 in the denominator */
683
684 do {
685 unsigned int anfrac = min(pnfrac, pool_size/2);
686 unsigned int add =
687 ((pool_size - entropy_count)*anfrac*3) >> s;
688
689 entropy_count += add;
690 pnfrac -= anfrac;
691 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
692 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400693
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -0400694 if (unlikely(entropy_count < 0)) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400695 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
696 r->name, entropy_count);
697 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700698 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400699 } else if (entropy_count > pool_size)
700 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400701 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
702 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Theodore Ts'o6265e162013-10-03 01:08:15 -0400704 r->entropy_total += nbits;
Linus Torvalds0891ad82013-11-16 10:19:15 -0800705 if (!r->initialized && r->entropy_total > 128) {
706 r->initialized = 1;
707 r->entropy_total = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400708 }
709
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400710 trace_credit_entropy_bits(r->name, nbits,
711 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400712 r->entropy_total, _RET_IP_);
713
Theodore Ts'o6265e162013-10-03 01:08:15 -0400714 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500715 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400716
Theodore Ts'oe192be92016-06-12 18:13:36 -0400717 if (crng_init < 2 && entropy_bits >= 128) {
718 crng_reseed(&primary_crng, r);
719 entropy_bits = r->entropy_count >> ENTROPY_SHIFT;
720 }
721
Theodore Ts'o6265e162013-10-03 01:08:15 -0400722 /* should we wake readers? */
Andi Kleene8e8a2e2018-02-28 13:43:28 -0800723 if (entropy_bits >= random_read_wakeup_bits &&
Christoph Hellwig89b310a2018-04-09 15:29:32 +0200724 wq_has_sleeper(&random_wait)) {
725 wake_up_interruptible_poll(&random_wait, POLLIN);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400726 kill_fasync(&fasync, SIGIO, POLL_IN);
727 }
728 /* If the input pool is getting full, send some
Theodore Ts'oe192be92016-06-12 18:13:36 -0400729 * entropy to the blocking pool until it is 75% full.
Theodore Ts'o6265e162013-10-03 01:08:15 -0400730 */
Greg Price2132a962013-12-06 21:28:03 -0500731 if (entropy_bits > random_write_wakeup_bits &&
Theodore Ts'o6265e162013-10-03 01:08:15 -0400732 r->initialized &&
Greg Price2132a962013-12-06 21:28:03 -0500733 r->entropy_total >= 2*random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400734 struct entropy_store *other = &blocking_pool;
735
Theodore Ts'o6265e162013-10-03 01:08:15 -0400736 if (other->entropy_count <=
Theodore Ts'oe192be92016-06-12 18:13:36 -0400737 3 * other->poolinfo->poolfracbits / 4) {
738 schedule_work(&other->push_work);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400739 r->entropy_total = 0;
740 }
741 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700742 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743}
744
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400745static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400746{
Theodore Ts'o9f886f42017-02-25 18:21:33 -0400747 const int nbits_max = r->poolinfo->poolwords * 32;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400748
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400749 if (nbits < 0)
750 return -EINVAL;
751
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400752 /* Cap the value to avoid overflows */
753 nbits = min(nbits, nbits_max);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400754
755 credit_entropy_bits(r, nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400756 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400757}
758
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759/*********************************************************************
760 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400761 * CRNG using CHACHA20
762 *
763 *********************************************************************/
764
765#define CRNG_RESEED_INTERVAL (300*HZ)
766
767static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
768
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400769#ifdef CONFIG_NUMA
770/*
771 * Hack to deal with crazy userspace progams when they are all trying
772 * to access /dev/urandom in parallel. The programs are almost
773 * certainly doing something terribly wrong, but we'll work around
774 * their brain damage.
775 */
776static struct crng_state **crng_node_pool __read_mostly;
777#endif
778
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400779static void invalidate_batched_entropy(void);
780
Theodore Ts'oe192be92016-06-12 18:13:36 -0400781static void crng_initialize(struct crng_state *crng)
782{
783 int i;
784 unsigned long rv;
785
786 memcpy(&crng->state[0], "expand 32-byte k", 16);
787 if (crng == &primary_crng)
788 _extract_entropy(&input_pool, &crng->state[4],
789 sizeof(__u32) * 12, 0);
790 else
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400791 _get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400792 for (i = 4; i < 16; i++) {
793 if (!arch_get_random_seed_long(&rv) &&
794 !arch_get_random_long(&rv))
795 rv = random_get_entropy();
796 crng->state[i] ^= rv;
797 }
798 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
799}
800
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400801#ifdef CONFIG_NUMA
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400802static void do_numa_crng_init(struct work_struct *work)
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400803{
804 int i;
805 struct crng_state *crng;
806 struct crng_state **pool;
807
808 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
809 for_each_online_node(i) {
810 crng = kmalloc_node(sizeof(struct crng_state),
811 GFP_KERNEL | __GFP_NOFAIL, i);
812 spin_lock_init(&crng->lock);
813 crng_initialize(crng);
814 pool[i] = crng;
815 }
816 mb();
817 if (cmpxchg(&crng_node_pool, NULL, pool)) {
818 for_each_node(i)
819 kfree(pool[i]);
820 kfree(pool);
821 }
822}
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400823
824static DECLARE_WORK(numa_crng_init_work, do_numa_crng_init);
825
826static void numa_crng_init(void)
827{
828 schedule_work(&numa_crng_init_work);
829}
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400830#else
831static void numa_crng_init(void) {}
832#endif
833
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400834/*
835 * crng_fast_load() can be called by code in the interrupt service
836 * path. So we can't afford to dilly-dally.
837 */
Theodore Ts'oe192be92016-06-12 18:13:36 -0400838static int crng_fast_load(const char *cp, size_t len)
839{
840 unsigned long flags;
841 char *p;
842
843 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
844 return 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400845 if (crng_init != 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400846 spin_unlock_irqrestore(&primary_crng.lock, flags);
847 return 0;
848 }
849 p = (unsigned char *) &primary_crng.state[4];
850 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
851 p[crng_init_cnt % CHACHA20_KEY_SIZE] ^= *cp;
852 cp++; crng_init_cnt++; len--;
853 }
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200854 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400855 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400856 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400857 crng_init = 1;
858 wake_up_interruptible(&crng_init_wait);
859 pr_notice("random: fast init done\n");
860 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400861 return 1;
862}
863
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400864/*
865 * crng_slow_load() is called by add_device_randomness, which has two
866 * attributes. (1) We can't trust the buffer passed to it is
867 * guaranteed to be unpredictable (so it might not have any entropy at
868 * all), and (2) it doesn't have the performance constraints of
869 * crng_fast_load().
870 *
871 * So we do something more comprehensive which is guaranteed to touch
872 * all of the primary_crng's state, and which uses a LFSR with a
873 * period of 255 as part of the mixing algorithm. Finally, we do
874 * *not* advance crng_init_cnt since buffer we may get may be something
875 * like a fixed DMI table (for example), which might very well be
876 * unique to the machine, but is otherwise unvarying.
877 */
878static int crng_slow_load(const char *cp, size_t len)
879{
880 unsigned long flags;
881 static unsigned char lfsr = 1;
882 unsigned char tmp;
883 unsigned i, max = CHACHA20_KEY_SIZE;
884 const char * src_buf = cp;
885 char * dest_buf = (char *) &primary_crng.state[4];
886
887 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
888 return 0;
889 if (crng_init != 0) {
890 spin_unlock_irqrestore(&primary_crng.lock, flags);
891 return 0;
892 }
893 if (len > max)
894 max = len;
895
896 for (i = 0; i < max ; i++) {
897 tmp = lfsr;
898 lfsr >>= 1;
899 if (tmp & 1)
900 lfsr ^= 0xE1;
901 tmp = dest_buf[i % CHACHA20_KEY_SIZE];
902 dest_buf[i % CHACHA20_KEY_SIZE] ^= src_buf[i % len] ^ lfsr;
903 lfsr += (tmp << 3) | (tmp >> 5);
904 }
905 spin_unlock_irqrestore(&primary_crng.lock, flags);
906 return 1;
907}
908
Theodore Ts'oe192be92016-06-12 18:13:36 -0400909static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
910{
911 unsigned long flags;
912 int i, num;
913 union {
Eric Biggers9f480fa2017-11-22 11:51:39 -0800914 __u32 block[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -0400915 __u32 key[8];
916 } buf;
917
918 if (r) {
919 num = extract_entropy(r, &buf, 32, 16, 0);
920 if (num == 0)
921 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400922 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400923 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400924 _crng_backtrack_protect(&primary_crng, buf.block,
925 CHACHA20_KEY_SIZE);
926 }
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400927 spin_lock_irqsave(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400928 for (i = 0; i < 8; i++) {
929 unsigned long rv;
930 if (!arch_get_random_seed_long(&rv) &&
931 !arch_get_random_long(&rv))
932 rv = random_get_entropy();
933 crng->state[i+4] ^= buf.key[i] ^ rv;
934 }
935 memzero_explicit(&buf, sizeof(buf));
936 crng->init_time = jiffies;
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400937 spin_unlock_irqrestore(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400938 if (crng == &primary_crng && crng_init < 2) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400939 invalidate_batched_entropy();
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400940 numa_crng_init();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400941 crng_init = 2;
942 process_random_ready_list();
943 wake_up_interruptible(&crng_init_wait);
944 pr_notice("random: crng init done\n");
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400945 if (unseeded_warning.missed) {
946 pr_notice("random: %d get_random_xx warning(s) missed "
947 "due to ratelimiting\n",
948 unseeded_warning.missed);
949 unseeded_warning.missed = 0;
950 }
951 if (urandom_warning.missed) {
952 pr_notice("random: %d urandom warning(s) missed "
953 "due to ratelimiting\n",
954 urandom_warning.missed);
955 urandom_warning.missed = 0;
956 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400957 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400958}
959
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400960static void _extract_crng(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800961 __u32 out[CHACHA20_BLOCK_WORDS])
Theodore Ts'oe192be92016-06-12 18:13:36 -0400962{
963 unsigned long v, flags;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400964
Theodore Ts'o43838a22018-04-11 13:27:52 -0400965 if (crng_ready() &&
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400966 (time_after(crng_global_init_time, crng->init_time) ||
967 time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL)))
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400968 crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400969 spin_lock_irqsave(&crng->lock, flags);
970 if (arch_get_random_long(&v))
971 crng->state[14] ^= v;
972 chacha20_block(&crng->state[0], out);
973 if (crng->state[12] == 0)
974 crng->state[13]++;
975 spin_unlock_irqrestore(&crng->lock, flags);
976}
977
Eric Biggers9f480fa2017-11-22 11:51:39 -0800978static void extract_crng(__u32 out[CHACHA20_BLOCK_WORDS])
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400979{
980 struct crng_state *crng = NULL;
981
982#ifdef CONFIG_NUMA
983 if (crng_node_pool)
984 crng = crng_node_pool[numa_node_id()];
985 if (crng == NULL)
986#endif
987 crng = &primary_crng;
988 _extract_crng(crng, out);
989}
990
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400991/*
992 * Use the leftover bytes from the CRNG block output (if there is
993 * enough) to mutate the CRNG key to provide backtracking protection.
994 */
995static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800996 __u32 tmp[CHACHA20_BLOCK_WORDS], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400997{
998 unsigned long flags;
999 __u32 *s, *d;
1000 int i;
1001
1002 used = round_up(used, sizeof(__u32));
1003 if (used + CHACHA20_KEY_SIZE > CHACHA20_BLOCK_SIZE) {
1004 extract_crng(tmp);
1005 used = 0;
1006 }
1007 spin_lock_irqsave(&crng->lock, flags);
Eric Biggers9f480fa2017-11-22 11:51:39 -08001008 s = &tmp[used / sizeof(__u32)];
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001009 d = &crng->state[4];
1010 for (i=0; i < 8; i++)
1011 *d++ ^= *s++;
1012 spin_unlock_irqrestore(&crng->lock, flags);
1013}
1014
Eric Biggers9f480fa2017-11-22 11:51:39 -08001015static void crng_backtrack_protect(__u32 tmp[CHACHA20_BLOCK_WORDS], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001016{
1017 struct crng_state *crng = NULL;
1018
1019#ifdef CONFIG_NUMA
1020 if (crng_node_pool)
1021 crng = crng_node_pool[numa_node_id()];
1022 if (crng == NULL)
1023#endif
1024 crng = &primary_crng;
1025 _crng_backtrack_protect(crng, tmp, used);
1026}
1027
Theodore Ts'oe192be92016-06-12 18:13:36 -04001028static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
1029{
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001030 ssize_t ret = 0, i = CHACHA20_BLOCK_SIZE;
Eric Biggers9f480fa2017-11-22 11:51:39 -08001031 __u32 tmp[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001032 int large_request = (nbytes > 256);
1033
1034 while (nbytes) {
1035 if (large_request && need_resched()) {
1036 if (signal_pending(current)) {
1037 if (ret == 0)
1038 ret = -ERESTARTSYS;
1039 break;
1040 }
1041 schedule();
1042 }
1043
1044 extract_crng(tmp);
1045 i = min_t(int, nbytes, CHACHA20_BLOCK_SIZE);
1046 if (copy_to_user(buf, tmp, i)) {
1047 ret = -EFAULT;
1048 break;
1049 }
1050
1051 nbytes -= i;
1052 buf += i;
1053 ret += i;
1054 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001055 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001056
1057 /* Wipe data just written to memory */
1058 memzero_explicit(tmp, sizeof(tmp));
1059
1060 return ret;
1061}
1062
1063
1064/*********************************************************************
1065 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 * Entropy input management
1067 *
1068 *********************************************************************/
1069
1070/* There is one of these per entropy source */
1071struct timer_rand_state {
1072 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001073 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074};
1075
Theodore Ts'o644008d2013-11-03 16:40:53 -05001076#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
1077
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001078/*
Theodore Ts'oe192be92016-06-12 18:13:36 -04001079 * Add device- or boot-specific data to the input pool to help
1080 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001081 *
Theodore Ts'oe192be92016-06-12 18:13:36 -04001082 * None of this adds any entropy; it is meant to avoid the problem of
1083 * the entropy pool having similar initial state across largely
1084 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001085 */
1086void add_device_randomness(const void *buf, unsigned int size)
1087{
Theodore Ts'o61875f32013-09-21 13:58:22 -04001088 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001089 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001090
Theodore Ts'odc12baa2018-04-11 14:58:27 -04001091 if (!crng_ready() && size)
1092 crng_slow_load(buf, size);
Kees Cookee7998c2017-07-12 14:34:04 -07001093
Theodore Ts'o59108952013-09-12 14:10:25 -04001094 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001095 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001096 _mix_pool_bytes(&input_pool, buf, size);
1097 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001098 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001099}
1100EXPORT_SYMBOL(add_device_randomness);
1101
Theodore Ts'o644008d2013-11-03 16:40:53 -05001102static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001103
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104/*
1105 * This function adds entropy to the entropy "pool" by using timing
1106 * delays. It uses the timer_rand_state structure to make an estimate
1107 * of how many bits of entropy this call has added to the pool.
1108 *
1109 * The number "num" is also added to the pool - it should somehow describe
1110 * the type of event which just happened. This is currently 0-255 for
1111 * keyboard scan codes, and 256 upwards for interrupts.
1112 *
1113 */
1114static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1115{
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001116 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -08001119 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 unsigned num;
1121 } sample;
1122 long delta, delta2, delta3;
1123
1124 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125
1126 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001127 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 sample.num = num;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001129 r = &input_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001130 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131
1132 /*
1133 * Calculate number of bits of randomness we probably added.
1134 * We take into account the first, second and third-order deltas
1135 * in order to make our estimate.
1136 */
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001137 delta = sample.jiffies - state->last_time;
1138 state->last_time = sample.jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001140 delta2 = delta - state->last_delta;
1141 state->last_delta = delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001143 delta3 = delta2 - state->last_delta2;
1144 state->last_delta2 = delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001146 if (delta < 0)
1147 delta = -delta;
1148 if (delta2 < 0)
1149 delta2 = -delta2;
1150 if (delta3 < 0)
1151 delta3 = -delta3;
1152 if (delta > delta2)
1153 delta = delta2;
1154 if (delta > delta3)
1155 delta = delta3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001157 /*
1158 * delta is now minimum absolute delta.
1159 * Round down by 1 bit on general principles,
1160 * and limit entropy entimate to 12 bits.
1161 */
1162 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 preempt_enable();
1165}
1166
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001167void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 unsigned int value)
1169{
1170 static unsigned char last_value;
1171
1172 /* ignore autorepeat and the like */
1173 if (value == last_value)
1174 return;
1175
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 last_value = value;
1177 add_timer_randomness(&input_timer_state,
1178 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001179 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001181EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001183static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1184
Theodore Ts'o43759d42014-06-14 21:43:13 -04001185#ifdef ADD_INTERRUPT_BENCH
1186static unsigned long avg_cycles, avg_deviation;
1187
1188#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1189#define FIXED_1_2 (1 << (AVG_SHIFT-1))
1190
1191static void add_interrupt_bench(cycles_t start)
1192{
1193 long delta = random_get_entropy() - start;
1194
1195 /* Use a weighted moving average */
1196 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1197 avg_cycles += delta;
1198 /* And average deviation */
1199 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1200 avg_deviation += delta;
1201}
1202#else
1203#define add_interrupt_bench(x)
1204#endif
1205
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001206static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
1207{
1208 __u32 *ptr = (__u32 *) regs;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001209 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001210
1211 if (regs == NULL)
1212 return 0;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001213 idx = READ_ONCE(f->reg_idx);
1214 if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
1215 idx = 0;
1216 ptr += idx++;
1217 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitz9dfa7bb2017-04-30 19:49:21 +12001218 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001219}
1220
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001221void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222{
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001223 struct entropy_store *r;
Christoph Lameter1b2a1a72014-08-17 12:30:29 -05001224 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001225 struct pt_regs *regs = get_irq_regs();
1226 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001227 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -04001228 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001229 __u64 ip;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001230 unsigned long seed;
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001231 int credit = 0;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001232
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001233 if (cycles == 0)
1234 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001235 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1236 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001237 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1238 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001239 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001240 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001241 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
1242 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001243
Theodore Ts'o43759d42014-06-14 21:43:13 -04001244 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001245 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001246
Theodore Ts'o43838a22018-04-11 13:27:52 -04001247 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001248 if ((fast_pool->count >= 64) &&
1249 crng_fast_load((char *) fast_pool->pool,
1250 sizeof(fast_pool->pool))) {
1251 fast_pool->count = 0;
1252 fast_pool->last = now;
1253 }
1254 return;
1255 }
1256
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001257 if ((fast_pool->count < 64) &&
1258 !time_after(now, fast_pool->last + HZ))
1259 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
Theodore Ts'oe192be92016-06-12 18:13:36 -04001261 r = &input_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001262 if (!spin_trylock(&r->lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 return;
1264
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001265 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001266 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
H. Peter Anvin83664a62014-03-17 16:36:28 -07001267
1268 /*
1269 * If we have architectural seed generator, produce a seed and
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001270 * add it to the pool. For the sake of paranoia don't let the
1271 * architectural seed generator dominate the input from the
1272 * interrupt noise.
H. Peter Anvin83664a62014-03-17 16:36:28 -07001273 */
1274 if (arch_get_random_seed_long(&seed)) {
Theodore Ts'o85608f82014-06-10 23:09:20 -04001275 __mix_pool_bytes(r, &seed, sizeof(seed));
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001276 credit = 1;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001277 }
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001278 spin_unlock(&r->lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001279
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001280 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001281
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001282 /* award one bit for the contents of the fast pool */
1283 credit_entropy_bits(r, credit + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001285EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
David Howells93614012006-09-30 20:45:40 +02001287#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288void add_disk_randomness(struct gendisk *disk)
1289{
1290 if (!disk || !disk->random)
1291 return;
1292 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001293 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001294 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001296EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001297#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299/*********************************************************************
1300 *
1301 * Entropy extraction routines
1302 *
1303 *********************************************************************/
1304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001306 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 * from the primary pool to the secondary extraction pool. We make
1308 * sure we pull enough for a 'catastrophic reseed'.
1309 */
Theodore Ts'o6265e162013-10-03 01:08:15 -04001310static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1312{
Theodore Ts'ocff85032014-06-10 23:18:16 -04001313 if (!r->pull ||
1314 r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
1315 r->entropy_count > r->poolinfo->poolfracbits)
1316 return;
1317
Theodore Ts'ocff85032014-06-10 23:18:16 -04001318 _xfer_secondary_pool(r, nbytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001319}
Matt Mackall5a021e92007-07-19 11:30:14 -07001320
Theodore Ts'o6265e162013-10-03 01:08:15 -04001321static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1322{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 __u32 tmp[OUTPUT_POOL_WORDS];
1324
Theodore Ts'o6265e162013-10-03 01:08:15 -04001325 int bytes = nbytes;
Matt Mackall5a021e92007-07-19 11:30:14 -07001326
Greg Price2132a962013-12-06 21:28:03 -05001327 /* pull at least as much as a wakeup */
1328 bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001329 /* but never more than the buffer size */
1330 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001332 trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
1333 ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
Theodore Ts'o6265e162013-10-03 01:08:15 -04001334 bytes = extract_entropy(r->pull, tmp, bytes,
Stephan Müller43d8a722016-12-27 23:40:59 +01001335 random_read_wakeup_bits / 8, 0);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001336 mix_pool_bytes(r, tmp, bytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001337 credit_entropy_bits(r, bytes*8);
1338}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Theodore Ts'o6265e162013-10-03 01:08:15 -04001340/*
1341 * Used as a workqueue function so that when the input pool is getting
1342 * full, we can "spill over" some entropy to the output pools. That
1343 * way the output pools can store some of the excess entropy instead
1344 * of letting it go to waste.
1345 */
1346static void push_to_pool(struct work_struct *work)
1347{
1348 struct entropy_store *r = container_of(work, struct entropy_store,
1349 push_work);
1350 BUG_ON(!r);
Greg Price2132a962013-12-06 21:28:03 -05001351 _xfer_secondary_pool(r, random_read_wakeup_bits/8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001352 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
1353 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354}
1355
1356/*
Greg Price19fa5be12013-11-29 15:50:06 -05001357 * This function decides how many bytes to actually take from the
1358 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360static size_t account(struct entropy_store *r, size_t nbytes, int min,
1361 int reserved)
1362{
Stephan Müller43d8a722016-12-27 23:40:59 +01001363 int entropy_count, orig, have_bytes;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001364 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001366 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367
1368 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001369retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -07001370 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001371 ibytes = nbytes;
Stephan Müller43d8a722016-12-27 23:40:59 +01001372 /* never pull more than available */
1373 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001374
Stephan Müller43d8a722016-12-27 23:40:59 +01001375 if ((have_bytes -= reserved) < 0)
1376 have_bytes = 0;
1377 ibytes = min_t(size_t, ibytes, have_bytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001378 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001379 ibytes = 0;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001380
1381 if (unlikely(entropy_count < 0)) {
1382 pr_warn("random: negative entropy count: pool %s count %d\n",
1383 r->name, entropy_count);
1384 WARN_ON(1);
1385 entropy_count = 0;
1386 }
1387 nfrac = ibytes << (ENTROPY_SHIFT + 3);
1388 if ((size_t) entropy_count > nfrac)
1389 entropy_count -= nfrac;
1390 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001391 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001392
Greg Price0fb7a012013-12-05 19:32:19 -05001393 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1394 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001396 trace_debit_entropy(r->name, 8 * ibytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001397 if (ibytes &&
Greg Price2132a962013-12-06 21:28:03 -05001398 (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001399 wake_up_interruptible_poll(&random_wait, POLLOUT);
Theodore Ts'ob9809552013-03-04 11:59:12 -05001400 kill_fasync(&fasync, SIGIO, POLL_OUT);
1401 }
1402
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001403 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404}
1405
Greg Price19fa5be12013-11-29 15:50:06 -05001406/*
1407 * This function does the actual extraction for extract_entropy and
1408 * extract_entropy_user.
1409 *
1410 * Note: we assume that .poolwords is a multiple of 16 words.
1411 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412static void extract_buf(struct entropy_store *r, __u8 *out)
1413{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001414 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001415 union {
1416 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001417 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001418 } hash;
1419 __u32 workspace[SHA_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001420 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001423 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001424 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001425 */
Theodore Ts'o46884442013-12-17 21:16:39 -05001426 sha_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001427 for (i = 0; i < LONGS(20); i++) {
1428 unsigned long v;
1429 if (!arch_get_random_long(&v))
1430 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001431 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001432 }
1433
Theodore Ts'o46884442013-12-17 21:16:39 -05001434 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1435 spin_lock_irqsave(&r->lock, flags);
1436 for (i = 0; i < r->poolinfo->poolwords; i += 16)
1437 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1438
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001439 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001440 * We mix the hash back into the pool to prevent backtracking
1441 * attacks (where the attacker knows the state of the pool
1442 * plus the current outputs, and attempts to find previous
1443 * ouputs), unless the hash function can be inverted. By
1444 * mixing at least a SHA1 worth of hash data back, we make
1445 * brute-forcing the feedback as hard as brute-forcing the
1446 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001448 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001449 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001450
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001451 memzero_explicit(workspace, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452
1453 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001454 * In case the hash function has some recognizable output
1455 * pattern, we fold it in half. Thus, we always feed back
1456 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001458 hash.w[0] ^= hash.w[3];
1459 hash.w[1] ^= hash.w[4];
1460 hash.w[2] ^= rol32(hash.w[2], 16);
1461
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001462 memcpy(out, &hash, EXTRACT_SIZE);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001463 memzero_explicit(&hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464}
1465
Theodore Ts'oe192be92016-06-12 18:13:36 -04001466static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
1467 size_t nbytes, int fips)
1468{
1469 ssize_t ret = 0, i;
1470 __u8 tmp[EXTRACT_SIZE];
1471 unsigned long flags;
1472
1473 while (nbytes) {
1474 extract_buf(r, tmp);
1475
1476 if (fips) {
1477 spin_lock_irqsave(&r->lock, flags);
1478 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1479 panic("Hardware RNG duplicated output!\n");
1480 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1481 spin_unlock_irqrestore(&r->lock, flags);
1482 }
1483 i = min_t(int, nbytes, EXTRACT_SIZE);
1484 memcpy(buf, tmp, i);
1485 nbytes -= i;
1486 buf += i;
1487 ret += i;
1488 }
1489
1490 /* Wipe data just returned from memory */
1491 memzero_explicit(tmp, sizeof(tmp));
1492
1493 return ret;
1494}
1495
Greg Price19fa5be12013-11-29 15:50:06 -05001496/*
1497 * This function extracts randomness from the "entropy pool", and
1498 * returns it in a buffer.
1499 *
1500 * The min parameter specifies the minimum amount we can pull before
1501 * failing to avoid races that defeat catastrophic reseeding while the
1502 * reserved parameter indicates how much entropy we must leave in the
1503 * pool after each pull to avoid starving other readers.
1504 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001505static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001506 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001509 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001511 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001512 if (fips_enabled) {
1513 spin_lock_irqsave(&r->lock, flags);
1514 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001515 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001516 spin_unlock_irqrestore(&r->lock, flags);
1517 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001518 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001519 xfer_secondary_pool(r, EXTRACT_SIZE);
1520 extract_buf(r, tmp);
1521 spin_lock_irqsave(&r->lock, flags);
1522 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1523 }
1524 spin_unlock_irqrestore(&r->lock, flags);
1525 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001526
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001527 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 xfer_secondary_pool(r, nbytes);
1529 nbytes = account(r, nbytes, min, reserved);
1530
Theodore Ts'oe192be92016-06-12 18:13:36 -04001531 return _extract_entropy(r, buf, nbytes, fips_enabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532}
1533
Greg Price19fa5be12013-11-29 15:50:06 -05001534/*
1535 * This function extracts randomness from the "entropy pool", and
1536 * returns it in a userspace buffer.
1537 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1539 size_t nbytes)
1540{
1541 ssize_t ret = 0, i;
1542 __u8 tmp[EXTRACT_SIZE];
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001543 int large_request = (nbytes > 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001545 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 xfer_secondary_pool(r, nbytes);
1547 nbytes = account(r, nbytes, 0, 0);
1548
1549 while (nbytes) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001550 if (large_request && need_resched()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 if (signal_pending(current)) {
1552 if (ret == 0)
1553 ret = -ERESTARTSYS;
1554 break;
1555 }
1556 schedule();
1557 }
1558
1559 extract_buf(r, tmp);
1560 i = min_t(int, nbytes, EXTRACT_SIZE);
1561 if (copy_to_user(buf, tmp, i)) {
1562 ret = -EFAULT;
1563 break;
1564 }
1565
1566 nbytes -= i;
1567 buf += i;
1568 ret += i;
1569 }
1570
1571 /* Wipe data just returned from memory */
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001572 memzero_explicit(tmp, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
1574 return ret;
1575}
1576
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001577#define warn_unseeded_randomness(previous) \
1578 _warn_unseeded_randomness(__func__, (void *) _RET_IP_, (previous))
1579
1580static void _warn_unseeded_randomness(const char *func_name, void *caller,
1581 void **previous)
1582{
1583#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1584 const bool print_once = false;
1585#else
1586 static bool print_once __read_mostly;
1587#endif
1588
1589 if (print_once ||
1590 crng_ready() ||
1591 (previous && (caller == READ_ONCE(*previous))))
1592 return;
1593 WRITE_ONCE(*previous, caller);
1594#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1595 print_once = true;
1596#endif
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001597 if (__ratelimit(&unseeded_warning))
1598 pr_notice("random: %s called from %pS with crng_init=%d\n",
1599 func_name, caller, crng_init);
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001600}
1601
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602/*
1603 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001604 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001605 * TCP sequence numbers, etc. It does not rely on the hardware random
1606 * number generator. For random bytes direct from the hardware RNG
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001607 * (when available), use get_random_bytes_arch(). In order to ensure
1608 * that the randomness provided by this function is okay, the function
1609 * wait_for_random_bytes() should be called and return 0 at least once
1610 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 */
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001612static void _get_random_bytes(void *buf, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613{
Eric Biggers9f480fa2017-11-22 11:51:39 -08001614 __u32 tmp[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001615
Theodore Ts'o59108952013-09-12 14:10:25 -04001616 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001617
1618 while (nbytes >= CHACHA20_BLOCK_SIZE) {
1619 extract_crng(buf);
1620 buf += CHACHA20_BLOCK_SIZE;
1621 nbytes -= CHACHA20_BLOCK_SIZE;
1622 }
1623
1624 if (nbytes > 0) {
1625 extract_crng(tmp);
1626 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001627 crng_backtrack_protect(tmp, nbytes);
1628 } else
1629 crng_backtrack_protect(tmp, CHACHA20_BLOCK_SIZE);
1630 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001631}
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001632
1633void get_random_bytes(void *buf, int nbytes)
1634{
1635 static void *previous;
1636
1637 warn_unseeded_randomness(&previous);
1638 _get_random_bytes(buf, nbytes);
1639}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001640EXPORT_SYMBOL(get_random_bytes);
1641
1642/*
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001643 * Wait for the urandom pool to be seeded and thus guaranteed to supply
1644 * cryptographically secure random numbers. This applies to: the /dev/urandom
1645 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
1646 * family of functions. Using any of these functions without first calling
1647 * this function forfeits the guarantee of security.
1648 *
1649 * Returns: 0 if the urandom pool has been seeded.
1650 * -ERESTARTSYS if the function was interrupted by a signal.
1651 */
1652int wait_for_random_bytes(void)
1653{
1654 if (likely(crng_ready()))
1655 return 0;
1656 return wait_event_interruptible(crng_init_wait, crng_ready());
1657}
1658EXPORT_SYMBOL(wait_for_random_bytes);
1659
1660/*
Herbert Xu205a5252015-06-09 18:19:39 +08001661 * Add a callback function that will be invoked when the nonblocking
1662 * pool is initialised.
1663 *
1664 * returns: 0 if callback is successfully added
1665 * -EALREADY if pool is already initialised (callback not called)
1666 * -ENOENT if module for callback is not alive
1667 */
1668int add_random_ready_callback(struct random_ready_callback *rdy)
1669{
1670 struct module *owner;
1671 unsigned long flags;
1672 int err = -EALREADY;
1673
Theodore Ts'oe192be92016-06-12 18:13:36 -04001674 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001675 return err;
1676
1677 owner = rdy->owner;
1678 if (!try_module_get(owner))
1679 return -ENOENT;
1680
1681 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001682 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001683 goto out;
1684
1685 owner = NULL;
1686
1687 list_add(&rdy->list, &random_ready_list);
1688 err = 0;
1689
1690out:
1691 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1692
1693 module_put(owner);
1694
1695 return err;
1696}
1697EXPORT_SYMBOL(add_random_ready_callback);
1698
1699/*
1700 * Delete a previously registered readiness callback function.
1701 */
1702void del_random_ready_callback(struct random_ready_callback *rdy)
1703{
1704 unsigned long flags;
1705 struct module *owner = NULL;
1706
1707 spin_lock_irqsave(&random_ready_list_lock, flags);
1708 if (!list_empty(&rdy->list)) {
1709 list_del_init(&rdy->list);
1710 owner = rdy->owner;
1711 }
1712 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1713
1714 module_put(owner);
1715}
1716EXPORT_SYMBOL(del_random_ready_callback);
1717
1718/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001719 * This function will use the architecture-specific hardware random
1720 * number generator if it is available. The arch-specific hw RNG will
1721 * almost certainly be faster than what we can do in software, but it
1722 * is impossible to verify that it is implemented securely (as
1723 * opposed, to, say, the AES encryption of a sequence number using a
1724 * key known by the NSA). So it's useful if we need the speed, but
1725 * only if we're willing to trust the hardware manufacturer not to
1726 * have put in a back door.
1727 */
1728void get_random_bytes_arch(void *buf, int nbytes)
1729{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001730 char *p = buf;
1731
Theodore Ts'o59108952013-09-12 14:10:25 -04001732 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001733 while (nbytes) {
1734 unsigned long v;
1735 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001736
H. Peter Anvin63d77172011-07-31 13:54:50 -07001737 if (!arch_get_random_long(&v))
1738 break;
1739
Luck, Tonybd29e562011-11-16 10:50:56 -08001740 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001741 p += chunk;
1742 nbytes -= chunk;
1743 }
1744
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001745 if (nbytes)
Theodore Ts'oe192be92016-06-12 18:13:36 -04001746 get_random_bytes(p, nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001748EXPORT_SYMBOL(get_random_bytes_arch);
1749
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
1751/*
1752 * init_std_data - initialize pool with system data
1753 *
1754 * @r: pool to initialize
1755 *
1756 * This function clears the pool's entropy count and mixes some system
1757 * data into the pool to prepare it for use. The pool is not cleared
1758 * as that can only decrease the entropy in the pool.
1759 */
1760static void init_std_data(struct entropy_store *r)
1761{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001762 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001763 ktime_t now = ktime_get_real();
1764 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765
Theodore Ts'of5c27422013-09-22 15:14:32 -04001766 r->last_pulled = jiffies;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001767 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001768 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001769 if (!arch_get_random_seed_long(&rv) &&
1770 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001771 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001772 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001773 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001774 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775}
1776
Tony Luckcbc96b72012-07-23 09:47:57 -07001777/*
1778 * Note that setup_arch() may call add_device_randomness()
1779 * long before we get here. This allows seeding of the pools
1780 * with some platform dependent data very early in the boot
1781 * process. But it limits our options here. We must use
1782 * statically allocated structures that already have all
1783 * initializations complete at compile time. We should also
1784 * take care not to overwrite the precious per platform data
1785 * we were given.
1786 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001787static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788{
1789 init_std_data(&input_pool);
1790 init_std_data(&blocking_pool);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001791 crng_initialize(&primary_crng);
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001792 crng_global_init_time = jiffies;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001793 if (ratelimit_disable) {
1794 urandom_warning.interval = 0;
1795 unseeded_warning.interval = 0;
1796 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 return 0;
1798}
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001799early_initcall(rand_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
David Howells93614012006-09-30 20:45:40 +02001801#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802void rand_initialize_disk(struct gendisk *disk)
1803{
1804 struct timer_rand_state *state;
1805
1806 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001807 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 * source.
1809 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001810 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001811 if (state) {
1812 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001814 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815}
David Howells93614012006-09-30 20:45:40 +02001816#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817
1818static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001819_random_read(int nonblock, char __user *buf, size_t nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820{
Greg Price12ff3a52013-11-29 15:02:33 -05001821 ssize_t n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
1823 if (nbytes == 0)
1824 return 0;
1825
Greg Price12ff3a52013-11-29 15:02:33 -05001826 nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1827 while (1) {
1828 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1829 if (n < 0)
1830 return n;
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001831 trace_random_read(n*8, (nbytes-n)*8,
1832 ENTROPY_BITS(&blocking_pool),
1833 ENTROPY_BITS(&input_pool));
Greg Price12ff3a52013-11-29 15:02:33 -05001834 if (n > 0)
1835 return n;
H. Peter Anvin331c6492014-03-17 16:36:29 -07001836
Greg Price12ff3a52013-11-29 15:02:33 -05001837 /* Pool is (near) empty. Maybe wait and retry. */
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001838 if (nonblock)
Greg Price12ff3a52013-11-29 15:02:33 -05001839 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001841 wait_event_interruptible(random_wait,
Greg Price12ff3a52013-11-29 15:02:33 -05001842 ENTROPY_BITS(&input_pool) >=
Greg Price2132a962013-12-06 21:28:03 -05001843 random_read_wakeup_bits);
Greg Price12ff3a52013-11-29 15:02:33 -05001844 if (signal_pending(current))
1845 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847}
1848
1849static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001850random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1851{
1852 return _random_read(file->f_flags & O_NONBLOCK, buf, nbytes);
1853}
1854
1855static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001856urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001858 unsigned long flags;
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001859 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05001860 int ret;
1861
Theodore Ts'oe192be92016-06-12 18:13:36 -04001862 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001863 maxwarn--;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001864 if (__ratelimit(&urandom_warning))
1865 printk(KERN_NOTICE "random: %s: uninitialized "
1866 "urandom read (%zd bytes read)\n",
1867 current->comm, nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001868 spin_lock_irqsave(&primary_crng.lock, flags);
1869 crng_init_cnt = 0;
1870 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001871 }
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001872 nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
Theodore Ts'oe192be92016-06-12 18:13:36 -04001873 ret = extract_crng_user(buf, nbytes);
1874 trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001875 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876}
1877
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001878static struct wait_queue_head *
1879random_get_poll_head(struct file *file, __poll_t events)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880{
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001881 return &random_wait;
1882}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001884static __poll_t
1885random_poll_mask(struct file *file, __poll_t events)
1886{
1887 __poll_t mask = 0;
1888
Greg Price2132a962013-12-06 21:28:03 -05001889 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001890 mask |= EPOLLIN | EPOLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05001891 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001892 mask |= EPOLLOUT | EPOLLWRNORM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 return mask;
1894}
1895
Matt Mackall7f397dc2007-05-29 21:58:10 -05001896static int
1897write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1898{
1899 size_t bytes;
1900 __u32 buf[16];
1901 const char __user *p = buffer;
1902
1903 while (count > 0) {
1904 bytes = min(count, sizeof(buf));
1905 if (copy_from_user(&buf, p, bytes))
1906 return -EFAULT;
1907
1908 count -= bytes;
1909 p += bytes;
1910
Theodore Ts'o85608f82014-06-10 23:09:20 -04001911 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001912 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001913 }
1914
1915 return 0;
1916}
1917
Matt Mackall90b75ee2008-04-29 01:02:55 -07001918static ssize_t random_write(struct file *file, const char __user *buffer,
1919 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001921 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922
Theodore Ts'oe192be92016-06-12 18:13:36 -04001923 ret = write_pool(&input_pool, buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05001924 if (ret)
1925 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926
Matt Mackall7f397dc2007-05-29 21:58:10 -05001927 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928}
1929
Matt Mackall43ae4862008-04-29 01:02:58 -07001930static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931{
1932 int size, ent_count;
1933 int __user *p = (int __user *)arg;
1934 int retval;
1935
1936 switch (cmd) {
1937 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001938 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001939 ent_count = ENTROPY_BITS(&input_pool);
1940 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 return -EFAULT;
1942 return 0;
1943 case RNDADDTOENTCNT:
1944 if (!capable(CAP_SYS_ADMIN))
1945 return -EPERM;
1946 if (get_user(ent_count, p))
1947 return -EFAULT;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001948 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 case RNDADDENTROPY:
1950 if (!capable(CAP_SYS_ADMIN))
1951 return -EPERM;
1952 if (get_user(ent_count, p++))
1953 return -EFAULT;
1954 if (ent_count < 0)
1955 return -EINVAL;
1956 if (get_user(size, p++))
1957 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001958 retval = write_pool(&input_pool, (const char __user *)p,
1959 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 if (retval < 0)
1961 return retval;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001962 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 case RNDZAPENTCNT:
1964 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001965 /*
1966 * Clear the entropy pool counters. We no longer clear
1967 * the entropy pool, as that's silly.
1968 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 if (!capable(CAP_SYS_ADMIN))
1970 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001971 input_pool.entropy_count = 0;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001972 blocking_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 return 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001974 case RNDRESEEDCRNG:
1975 if (!capable(CAP_SYS_ADMIN))
1976 return -EPERM;
1977 if (crng_init < 2)
1978 return -ENODATA;
1979 crng_reseed(&primary_crng, NULL);
1980 crng_global_init_time = jiffies - 1;
1981 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 default:
1983 return -EINVAL;
1984 }
1985}
1986
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001987static int random_fasync(int fd, struct file *filp, int on)
1988{
1989 return fasync_helper(fd, filp, on, &fasync);
1990}
1991
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001992const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 .read = random_read,
1994 .write = random_write,
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001995 .get_poll_head = random_get_poll_head,
1996 .poll_mask = random_poll_mask,
Matt Mackall43ae4862008-04-29 01:02:58 -07001997 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001998 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001999 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000};
2001
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08002002const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 .read = urandom_read,
2004 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07002005 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07002006 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002007 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008};
2009
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002010SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
2011 unsigned int, flags)
2012{
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002013 int ret;
2014
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002015 if (flags & ~(GRND_NONBLOCK|GRND_RANDOM))
2016 return -EINVAL;
2017
2018 if (count > INT_MAX)
2019 count = INT_MAX;
2020
2021 if (flags & GRND_RANDOM)
2022 return _random_read(flags & GRND_NONBLOCK, buf, count);
2023
Theodore Ts'oe192be92016-06-12 18:13:36 -04002024 if (!crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002025 if (flags & GRND_NONBLOCK)
2026 return -EAGAIN;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002027 ret = wait_for_random_bytes();
2028 if (unlikely(ret))
2029 return ret;
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002030 }
2031 return urandom_read(NULL, buf, count, NULL);
2032}
2033
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034/********************************************************************
2035 *
2036 * Sysctl interface
2037 *
2038 ********************************************************************/
2039
2040#ifdef CONFIG_SYSCTL
2041
2042#include <linux/sysctl.h>
2043
2044static int min_read_thresh = 8, min_write_thresh;
Greg Price8c2aa332013-12-05 19:19:29 -05002045static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046static int max_write_thresh = INPUT_POOL_WORDS * 32;
Fabio Estevamdb61ffe2017-01-31 14:36:07 -02002047static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048static char sysctl_bootid[16];
2049
2050/*
Greg Pricef22052b2013-11-29 14:58:16 -05002051 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 * UUID. The difference is in whether table->data is NULL; if it is,
2053 * then a new UUID is generated and returned to the user.
2054 *
Greg Pricef22052b2013-11-29 14:58:16 -05002055 * If the user accesses this via the proc interface, the UUID will be
2056 * returned as an ASCII string in the standard UUID format; if via the
2057 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 */
Joe Perchesa1514272013-06-13 19:37:35 -07002059static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 void __user *buffer, size_t *lenp, loff_t *ppos)
2061{
Joe Perchesa1514272013-06-13 19:37:35 -07002062 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 unsigned char buf[64], tmp_uuid[16], *uuid;
2064
2065 uuid = table->data;
2066 if (!uuid) {
2067 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07002069 } else {
2070 static DEFINE_SPINLOCK(bootid_spinlock);
2071
2072 spin_lock(&bootid_spinlock);
2073 if (!uuid[8])
2074 generate_random_uuid(uuid);
2075 spin_unlock(&bootid_spinlock);
2076 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077
Joe Perches35900772009-12-14 18:01:11 -08002078 sprintf(buf, "%pU", uuid);
2079
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 fake_table.data = buf;
2081 fake_table.maxlen = sizeof(buf);
2082
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002083 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084}
2085
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002086/*
2087 * Return entropy available scaled to integral bits
2088 */
Joe Perches5eb10d92014-06-06 14:37:58 -07002089static int proc_do_entropy(struct ctl_table *table, int write,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002090 void __user *buffer, size_t *lenp, loff_t *ppos)
2091{
Joe Perches5eb10d92014-06-06 14:37:58 -07002092 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002093 int entropy_count;
2094
2095 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
2096
2097 fake_table.data = &entropy_count;
2098 fake_table.maxlen = sizeof(entropy_count);
2099
2100 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
2101}
2102
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07002104extern struct ctl_table random_table[];
2105struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 .procname = "poolsize",
2108 .data = &sysctl_poolsize,
2109 .maxlen = sizeof(int),
2110 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002111 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 },
2113 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 .procname = "entropy_avail",
2115 .maxlen = sizeof(int),
2116 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002117 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 .data = &input_pool.entropy_count,
2119 },
2120 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 .procname = "read_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002122 .data = &random_read_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 .maxlen = sizeof(int),
2124 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002125 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 .extra1 = &min_read_thresh,
2127 .extra2 = &max_read_thresh,
2128 },
2129 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002131 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 .maxlen = sizeof(int),
2133 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002134 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 .extra1 = &min_write_thresh,
2136 .extra2 = &max_write_thresh,
2137 },
2138 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002139 .procname = "urandom_min_reseed_secs",
2140 .data = &random_min_urandom_seed,
2141 .maxlen = sizeof(int),
2142 .mode = 0644,
2143 .proc_handler = proc_dointvec,
2144 },
2145 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 .procname = "boot_id",
2147 .data = &sysctl_bootid,
2148 .maxlen = 16,
2149 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002150 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 },
2152 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 .procname = "uuid",
2154 .maxlen = 16,
2155 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002156 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002158#ifdef ADD_INTERRUPT_BENCH
2159 {
2160 .procname = "add_interrupt_avg_cycles",
2161 .data = &avg_cycles,
2162 .maxlen = sizeof(avg_cycles),
2163 .mode = 0444,
2164 .proc_handler = proc_doulongvec_minmax,
2165 },
2166 {
2167 .procname = "add_interrupt_avg_deviation",
2168 .data = &avg_deviation,
2169 .maxlen = sizeof(avg_deviation),
2170 .mode = 0444,
2171 .proc_handler = proc_doulongvec_minmax,
2172 },
2173#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002174 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175};
2176#endif /* CONFIG_SYSCTL */
2177
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002178struct batched_entropy {
2179 union {
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002180 u64 entropy_u64[CHACHA20_BLOCK_SIZE / sizeof(u64)];
2181 u32 entropy_u32[CHACHA20_BLOCK_SIZE / sizeof(u32)];
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002182 };
2183 unsigned int position;
2184};
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002185static rwlock_t batched_entropy_reset_lock = __RW_LOCK_UNLOCKED(batched_entropy_reset_lock);
Eric Biggersb1132de2016-05-04 21:08:39 -04002186
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187/*
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002188 * Get a random word for internal kernel use only. The quality of the random
2189 * number is either as good as RDRAND or as good as /dev/urandom, with the
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002190 * goal of being quite fast and not depleting entropy. In order to ensure
2191 * that the randomness provided by this function is okay, the function
2192 * wait_for_random_bytes() should be called and return 0 at least once
2193 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 */
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002195static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64);
2196u64 get_random_u64(void)
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002197{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002198 u64 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002199 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002200 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002201 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002202 static void *previous;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002203
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002204#if BITS_PER_LONG == 64
2205 if (arch_get_random_long((unsigned long *)&ret))
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002206 return ret;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002207#else
2208 if (arch_get_random_long((unsigned long *)&ret) &&
2209 arch_get_random_long((unsigned long *)&ret + 1))
2210 return ret;
2211#endif
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002212
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002213 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002214
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002215 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002216 batch = &get_cpu_var(batched_entropy_u64);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002217 if (use_lock)
2218 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002219 if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
Eric Biggers9f480fa2017-11-22 11:51:39 -08002220 extract_crng((__u32 *)batch->entropy_u64);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002221 batch->position = 0;
2222 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002223 ret = batch->entropy_u64[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002224 if (use_lock)
2225 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002226 put_cpu_var(batched_entropy_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002227 return ret;
2228}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002229EXPORT_SYMBOL(get_random_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002230
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002231static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32);
2232u32 get_random_u32(void)
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002233{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002234 u32 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002235 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002236 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002237 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002238 static void *previous;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002239
2240 if (arch_get_random_int(&ret))
2241 return ret;
2242
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002243 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002244
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002245 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002246 batch = &get_cpu_var(batched_entropy_u32);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002247 if (use_lock)
2248 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002249 if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
Eric Biggers9f480fa2017-11-22 11:51:39 -08002250 extract_crng(batch->entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002251 batch->position = 0;
2252 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002253 ret = batch->entropy_u32[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002254 if (use_lock)
2255 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002256 put_cpu_var(batched_entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002257 return ret;
2258}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002259EXPORT_SYMBOL(get_random_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002260
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002261/* It's important to invalidate all potential batched entropy that might
2262 * be stored before the crng is initialized, which we can do lazily by
2263 * simply resetting the counter to zero so that it's re-extracted on the
2264 * next usage. */
2265static void invalidate_batched_entropy(void)
2266{
2267 int cpu;
2268 unsigned long flags;
2269
2270 write_lock_irqsave(&batched_entropy_reset_lock, flags);
2271 for_each_possible_cpu (cpu) {
2272 per_cpu_ptr(&batched_entropy_u32, cpu)->position = 0;
2273 per_cpu_ptr(&batched_entropy_u64, cpu)->position = 0;
2274 }
2275 write_unlock_irqrestore(&batched_entropy_reset_lock, flags);
2276}
2277
Jason Cooper99fdafd2016-10-11 13:53:52 -07002278/**
2279 * randomize_page - Generate a random, page aligned address
2280 * @start: The smallest acceptable address the caller will take.
2281 * @range: The size of the area, starting at @start, within which the
2282 * random address must fall.
2283 *
2284 * If @start + @range would overflow, @range is capped.
2285 *
2286 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2287 * @start was already page aligned. We now align it regardless.
2288 *
2289 * Return: A page aligned address within [start, start + range). On error,
2290 * @start is returned.
2291 */
2292unsigned long
2293randomize_page(unsigned long start, unsigned long range)
2294{
2295 if (!PAGE_ALIGNED(start)) {
2296 range -= PAGE_ALIGN(start) - start;
2297 start = PAGE_ALIGN(start);
2298 }
2299
2300 if (start > ULONG_MAX - range)
2301 range = ULONG_MAX - start;
2302
2303 range >>= PAGE_SHIFT;
2304
2305 if (range == 0)
2306 return start;
2307
2308 return start + (get_random_long() % range << PAGE_SHIFT);
2309}
2310
Torsten Duwec84dbf62014-06-14 23:38:36 -04002311/* Interface for in-kernel drivers of true hardware RNGs.
2312 * Those devices may produce endless random bits and will be throttled
2313 * when our pool is full.
2314 */
2315void add_hwgenerator_randomness(const char *buffer, size_t count,
2316 size_t entropy)
2317{
2318 struct entropy_store *poolp = &input_pool;
2319
Theodore Ts'o43838a22018-04-11 13:27:52 -04002320 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04002321 crng_fast_load(buffer, count);
2322 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002323 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002324
2325 /* Suspend writing if we're above the trickle threshold.
2326 * We'll be woken up again once below random_write_wakeup_thresh,
2327 * or when the calling thread is about to terminate.
2328 */
Christoph Hellwig89b310a2018-04-09 15:29:32 +02002329 wait_event_interruptible(random_wait, kthread_should_stop() ||
Theodore Ts'oe192be92016-06-12 18:13:36 -04002330 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002331 mix_pool_bytes(poolp, buffer, count);
2332 credit_entropy_bits(poolp, entropy);
2333}
2334EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);