blob: 02d792f7933febeaec7f90b8324b021045f83802 [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'oc6e9d6f2014-07-17 04:13:05 -0400264#include <linux/syscalls.h>
265#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700266#include <linux/uuid.h>
Theodore Ts'oe192be92016-06-12 18:13:36 -0400267#include <crypto/chacha20.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269#include <asm/processor.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800270#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400272#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273#include <asm/io.h>
274
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400275#define CREATE_TRACE_POINTS
276#include <trace/events/random.h>
277
Theodore Ts'o43759d42014-06-14 21:43:13 -0400278/* #define ADD_INTERRUPT_BENCH */
279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280/*
281 * Configuration information
282 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400283#define INPUT_POOL_SHIFT 12
284#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
285#define OUTPUT_POOL_SHIFT 10
286#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
287#define SEC_XFER_SIZE 512
288#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400291#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400294 * To allow fractional bits to be tracked, the entropy_count field is
295 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400296 *
297 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
298 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400299 */
300#define ENTROPY_SHIFT 3
301#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
302
303/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 * The minimum number of bits of entropy before we wake up a read on
305 * /dev/random. Should be enough to do a significant reseed.
306 */
Greg Price2132a962013-12-06 21:28:03 -0500307static int random_read_wakeup_bits = 64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309/*
310 * If the entropy count falls under this number of bits, then we
311 * should wake up processes which are selecting or polling on write
312 * access to /dev/random.
313 */
Greg Price2132a962013-12-06 21:28:03 -0500314static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
316/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400317 * Originally, we used a primitive polynomial of degree .poolwords
318 * over GF(2). The taps for various sizes are defined below. They
319 * were chosen to be evenly spaced except for the last tap, which is 1
320 * to get the twisting happening as fast as possible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400322 * For the purposes of better mixing, we use the CRC-32 polynomial as
323 * well to make a (modified) twisted Generalized Feedback Shift
324 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
325 * generators. ACM Transactions on Modeling and Computer Simulation
326 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
Greg Pricedfd38752013-11-29 14:58:06 -0500327 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400328 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 *
330 * Thanks to Colin Plumb for suggesting this.
331 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400332 * The mixing operation is much less sensitive than the output hash,
333 * where we use SHA-1. All that we want of mixing operation is that
334 * it be a good non-cryptographic hash; i.e. it not produce collisions
335 * when fed "random" data of the sort we expect to see. As long as
336 * the pool state differs for different inputs, we have preserved the
337 * input entropy and done a good job. The fact that an intelligent
338 * attacker can construct inputs that will produce controlled
339 * alterations to the pool's state is not important because we don't
340 * consider such inputs to contribute any randomness. The only
341 * property we need with respect to them is that the attacker can't
342 * increase his/her knowledge of the pool's state. Since all
343 * additions are reversible (knowing the final state and the input,
344 * you can reconstruct the initial state), if an attacker has any
345 * uncertainty about the initial state, he/she can only shuffle that
346 * uncertainty about, but never cause any collisions (which would
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 * decrease the uncertainty).
348 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400349 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
350 * Videau in their paper, "The Linux Pseudorandom Number Generator
351 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
352 * paper, they point out that we are not using a true Twisted GFSR,
353 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
354 * is, with only three taps, instead of the six that we are using).
355 * As a result, the resulting polynomial is neither primitive nor
356 * irreducible, and hence does not have a maximal period over
357 * GF(2**32). They suggest a slight change to the generator
358 * polynomial which improves the resulting TGFSR polynomial to be
359 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400362 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
363#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 int tap1, tap2, tap3, tap4, tap5;
365} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400366 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
367 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
368 { S(128), 104, 76, 51, 25, 1 },
369 /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
370 /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
371 { S(32), 26, 19, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372#if 0
373 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400374 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400377 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
379 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400380 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
382 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400383 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
385 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400386 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400388 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400391 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400394 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
396 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400397 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398#endif
399};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401/*
402 * Static global variables
403 */
404static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
405static DECLARE_WAIT_QUEUE_HEAD(random_write_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;
432#define CRNG_INIT_CNT_THRESH (2*CHACHA20_KEY_SIZE)
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400433static void _extract_crng(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800434 __u32 out[CHACHA20_BLOCK_WORDS]);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400435static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800436 __u32 tmp[CHACHA20_BLOCK_WORDS], int used);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400437static void process_random_ready_list(void);
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400438static void _get_random_bytes(void *buf, int nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400439
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440/**********************************************************************
441 *
442 * OS independent entropy store. Here are the functions which handle
443 * storing entropy in an entropy pool.
444 *
445 **********************************************************************/
446
447struct entropy_store;
448struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700449 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400450 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 __u32 *pool;
452 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400454 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
456 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400457 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700458 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400459 unsigned short add_ptr;
460 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800461 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400462 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400463 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400464 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000465 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466};
467
Theodore Ts'oe192be92016-06-12 18:13:36 -0400468static ssize_t extract_entropy(struct entropy_store *r, void *buf,
469 size_t nbytes, int min, int rsvd);
470static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
471 size_t nbytes, int fips);
472
473static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400474static void push_to_pool(struct work_struct *work);
Emese Revfy0766f782016-06-20 20:42:34 +0200475static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
476static __u32 blocking_pool_data[OUTPUT_POOL_WORDS] __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
478static struct entropy_store input_pool = {
479 .poolinfo = &poolinfo_table[0],
480 .name = "input",
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200481 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 .pool = input_pool_data
483};
484
485static struct entropy_store blocking_pool = {
486 .poolinfo = &poolinfo_table[1],
487 .name = "blocking",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200489 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400490 .pool = blocking_pool_data,
491 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
492 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493};
494
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400495static __u32 const twist_table[8] = {
496 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
497 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700500 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700502 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 *
504 * The pool is stirred with a primitive polynomial of the appropriate
505 * degree, and then twisted. We twist by three bits at a time because
506 * it's cheap to do so and helps slightly in the expected case where
507 * the entropy is concentrated in the low-order bits.
508 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400509static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400510 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400512 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700513 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700515 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700516 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 tap1 = r->poolinfo->tap1;
519 tap2 = r->poolinfo->tap2;
520 tap3 = r->poolinfo->tap3;
521 tap4 = r->poolinfo->tap4;
522 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400524 input_rotate = r->input_rotate;
525 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
Matt Mackalle68e5b62008-04-29 01:03:05 -0700527 /* mix one byte at a time to simplify size handling and churn faster */
528 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400529 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700530 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
532 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700533 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 w ^= r->pool[(i + tap1) & wordmask];
535 w ^= r->pool[(i + tap2) & wordmask];
536 w ^= r->pool[(i + tap3) & wordmask];
537 w ^= r->pool[(i + tap4) & wordmask];
538 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700539
540 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700542
543 /*
544 * Normally, we add 7 bits of rotation to the pool.
545 * At the beginning of the pool, add an extra 7 bits
546 * rotation, so that successive passes spread the
547 * input bits across the pool evenly.
548 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400549 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 }
551
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400552 r->input_rotate = input_rotate;
553 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554}
555
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400556static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400557 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400559 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400560 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400561}
562
563static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400564 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400565{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400566 unsigned long flags;
567
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400568 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400569 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400570 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400571 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572}
573
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400574struct fast_pool {
575 __u32 pool[4];
576 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400577 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400578 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400579};
580
581/*
582 * This is a fast mixing routine used by the interrupt randomness
583 * collector. It's hardcoded for an 128 bit pool and assumes that any
584 * locks that might be needed are taken by the caller.
585 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400586static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400587{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400588 __u32 a = f->pool[0], b = f->pool[1];
589 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400590
Theodore Ts'o43759d42014-06-14 21:43:13 -0400591 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500592 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400593 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400594
Theodore Ts'o43759d42014-06-14 21:43:13 -0400595 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500596 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400597 d ^= a; b ^= c;
598
599 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500600 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400601 d ^= a; b ^= c;
602
603 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500604 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400605 d ^= a; b ^= c;
606
607 f->pool[0] = a; f->pool[1] = b;
608 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400609 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400610}
611
Herbert Xu205a5252015-06-09 18:19:39 +0800612static void process_random_ready_list(void)
613{
614 unsigned long flags;
615 struct random_ready_callback *rdy, *tmp;
616
617 spin_lock_irqsave(&random_ready_list_lock, flags);
618 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
619 struct module *owner = rdy->owner;
620
621 list_del_init(&rdy->list);
622 rdy->func(rdy);
623 module_put(owner);
624 }
625 spin_unlock_irqrestore(&random_ready_list_lock, flags);
626}
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400629 * Credit (or debit) the entropy store with n bits of entropy.
630 * Use credit_entropy_bits_safe() if the value comes from userspace
631 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700633static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400635 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400636 const int pool_size = r->poolinfo->poolfracbits;
637 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Matt Mackalladc782d2008-04-29 01:03:07 -0700639 if (!nbits)
640 return;
641
Theodore Ts'o902c0982012-07-04 10:38:30 -0400642retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -0700643 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400644 if (nfrac < 0) {
645 /* Debit */
646 entropy_count += nfrac;
647 } else {
648 /*
649 * Credit: we have to account for the possibility of
650 * overwriting already present entropy. Even in the
651 * ideal case of pure Shannon entropy, new contributions
652 * approach the full value asymptotically:
653 *
654 * entropy <- entropy + (pool_size - entropy) *
655 * (1 - exp(-add_entropy/pool_size))
656 *
657 * For add_entropy <= pool_size/2 then
658 * (1 - exp(-add_entropy/pool_size)) >=
659 * (add_entropy/pool_size)*0.7869...
660 * so we can approximate the exponential with
661 * 3/4*add_entropy/pool_size and still be on the
662 * safe side by adding at most pool_size/2 at a time.
663 *
664 * The use of pool_size-2 in the while statement is to
665 * prevent rounding artifacts from making the loop
666 * arbitrarily long; this limits the loop to log2(pool_size)*2
667 * turns no matter how large nbits is.
668 */
669 int pnfrac = nfrac;
670 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
671 /* The +2 corresponds to the /4 in the denominator */
672
673 do {
674 unsigned int anfrac = min(pnfrac, pool_size/2);
675 unsigned int add =
676 ((pool_size - entropy_count)*anfrac*3) >> s;
677
678 entropy_count += add;
679 pnfrac -= anfrac;
680 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
681 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400682
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -0400683 if (unlikely(entropy_count < 0)) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400684 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
685 r->name, entropy_count);
686 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700687 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400688 } else if (entropy_count > pool_size)
689 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400690 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
691 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
Theodore Ts'o6265e162013-10-03 01:08:15 -0400693 r->entropy_total += nbits;
Linus Torvalds0891ad82013-11-16 10:19:15 -0800694 if (!r->initialized && r->entropy_total > 128) {
695 r->initialized = 1;
696 r->entropy_total = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400697 }
698
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400699 trace_credit_entropy_bits(r->name, nbits,
700 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400701 r->entropy_total, _RET_IP_);
702
Theodore Ts'o6265e162013-10-03 01:08:15 -0400703 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500704 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400705
Theodore Ts'oe192be92016-06-12 18:13:36 -0400706 if (crng_init < 2 && entropy_bits >= 128) {
707 crng_reseed(&primary_crng, r);
708 entropy_bits = r->entropy_count >> ENTROPY_SHIFT;
709 }
710
Theodore Ts'o6265e162013-10-03 01:08:15 -0400711 /* should we wake readers? */
Andi Kleene8e8a2e2018-02-28 13:43:28 -0800712 if (entropy_bits >= random_read_wakeup_bits &&
713 wq_has_sleeper(&random_read_wait)) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400714 wake_up_interruptible(&random_read_wait);
715 kill_fasync(&fasync, SIGIO, POLL_IN);
716 }
717 /* If the input pool is getting full, send some
Theodore Ts'oe192be92016-06-12 18:13:36 -0400718 * entropy to the blocking pool until it is 75% full.
Theodore Ts'o6265e162013-10-03 01:08:15 -0400719 */
Greg Price2132a962013-12-06 21:28:03 -0500720 if (entropy_bits > random_write_wakeup_bits &&
Theodore Ts'o6265e162013-10-03 01:08:15 -0400721 r->initialized &&
Greg Price2132a962013-12-06 21:28:03 -0500722 r->entropy_total >= 2*random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400723 struct entropy_store *other = &blocking_pool;
724
Theodore Ts'o6265e162013-10-03 01:08:15 -0400725 if (other->entropy_count <=
Theodore Ts'oe192be92016-06-12 18:13:36 -0400726 3 * other->poolinfo->poolfracbits / 4) {
727 schedule_work(&other->push_work);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400728 r->entropy_total = 0;
729 }
730 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700731 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732}
733
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400734static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400735{
Theodore Ts'o9f886f42017-02-25 18:21:33 -0400736 const int nbits_max = r->poolinfo->poolwords * 32;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400737
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400738 if (nbits < 0)
739 return -EINVAL;
740
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400741 /* Cap the value to avoid overflows */
742 nbits = min(nbits, nbits_max);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400743
744 credit_entropy_bits(r, nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400745 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400746}
747
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748/*********************************************************************
749 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400750 * CRNG using CHACHA20
751 *
752 *********************************************************************/
753
754#define CRNG_RESEED_INTERVAL (300*HZ)
755
756static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
757
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400758#ifdef CONFIG_NUMA
759/*
760 * Hack to deal with crazy userspace progams when they are all trying
761 * to access /dev/urandom in parallel. The programs are almost
762 * certainly doing something terribly wrong, but we'll work around
763 * their brain damage.
764 */
765static struct crng_state **crng_node_pool __read_mostly;
766#endif
767
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400768static void invalidate_batched_entropy(void);
769
Theodore Ts'oe192be92016-06-12 18:13:36 -0400770static void crng_initialize(struct crng_state *crng)
771{
772 int i;
773 unsigned long rv;
774
775 memcpy(&crng->state[0], "expand 32-byte k", 16);
776 if (crng == &primary_crng)
777 _extract_entropy(&input_pool, &crng->state[4],
778 sizeof(__u32) * 12, 0);
779 else
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400780 _get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400781 for (i = 4; i < 16; i++) {
782 if (!arch_get_random_seed_long(&rv) &&
783 !arch_get_random_long(&rv))
784 rv = random_get_entropy();
785 crng->state[i] ^= rv;
786 }
787 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
788}
789
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400790#ifdef CONFIG_NUMA
791static void numa_crng_init(void)
792{
793 int i;
794 struct crng_state *crng;
795 struct crng_state **pool;
796
797 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
798 for_each_online_node(i) {
799 crng = kmalloc_node(sizeof(struct crng_state),
800 GFP_KERNEL | __GFP_NOFAIL, i);
801 spin_lock_init(&crng->lock);
802 crng_initialize(crng);
803 pool[i] = crng;
804 }
805 mb();
806 if (cmpxchg(&crng_node_pool, NULL, pool)) {
807 for_each_node(i)
808 kfree(pool[i]);
809 kfree(pool);
810 }
811}
812#else
813static void numa_crng_init(void) {}
814#endif
815
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400816/*
817 * crng_fast_load() can be called by code in the interrupt service
818 * path. So we can't afford to dilly-dally.
819 */
Theodore Ts'oe192be92016-06-12 18:13:36 -0400820static int crng_fast_load(const char *cp, size_t len)
821{
822 unsigned long flags;
823 char *p;
824
825 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
826 return 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400827 if (crng_init != 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400828 spin_unlock_irqrestore(&primary_crng.lock, flags);
829 return 0;
830 }
831 p = (unsigned char *) &primary_crng.state[4];
832 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
833 p[crng_init_cnt % CHACHA20_KEY_SIZE] ^= *cp;
834 cp++; crng_init_cnt++; len--;
835 }
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200836 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400837 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400838 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400839 crng_init = 1;
840 wake_up_interruptible(&crng_init_wait);
841 pr_notice("random: fast init done\n");
842 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400843 return 1;
844}
845
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400846/*
847 * crng_slow_load() is called by add_device_randomness, which has two
848 * attributes. (1) We can't trust the buffer passed to it is
849 * guaranteed to be unpredictable (so it might not have any entropy at
850 * all), and (2) it doesn't have the performance constraints of
851 * crng_fast_load().
852 *
853 * So we do something more comprehensive which is guaranteed to touch
854 * all of the primary_crng's state, and which uses a LFSR with a
855 * period of 255 as part of the mixing algorithm. Finally, we do
856 * *not* advance crng_init_cnt since buffer we may get may be something
857 * like a fixed DMI table (for example), which might very well be
858 * unique to the machine, but is otherwise unvarying.
859 */
860static int crng_slow_load(const char *cp, size_t len)
861{
862 unsigned long flags;
863 static unsigned char lfsr = 1;
864 unsigned char tmp;
865 unsigned i, max = CHACHA20_KEY_SIZE;
866 const char * src_buf = cp;
867 char * dest_buf = (char *) &primary_crng.state[4];
868
869 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
870 return 0;
871 if (crng_init != 0) {
872 spin_unlock_irqrestore(&primary_crng.lock, flags);
873 return 0;
874 }
875 if (len > max)
876 max = len;
877
878 for (i = 0; i < max ; i++) {
879 tmp = lfsr;
880 lfsr >>= 1;
881 if (tmp & 1)
882 lfsr ^= 0xE1;
883 tmp = dest_buf[i % CHACHA20_KEY_SIZE];
884 dest_buf[i % CHACHA20_KEY_SIZE] ^= src_buf[i % len] ^ lfsr;
885 lfsr += (tmp << 3) | (tmp >> 5);
886 }
887 spin_unlock_irqrestore(&primary_crng.lock, flags);
888 return 1;
889}
890
Theodore Ts'oe192be92016-06-12 18:13:36 -0400891static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
892{
893 unsigned long flags;
894 int i, num;
895 union {
Eric Biggers9f480fa2017-11-22 11:51:39 -0800896 __u32 block[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -0400897 __u32 key[8];
898 } buf;
899
900 if (r) {
901 num = extract_entropy(r, &buf, 32, 16, 0);
902 if (num == 0)
903 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400904 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400905 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400906 _crng_backtrack_protect(&primary_crng, buf.block,
907 CHACHA20_KEY_SIZE);
908 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400909 spin_lock_irqsave(&primary_crng.lock, flags);
910 for (i = 0; i < 8; i++) {
911 unsigned long rv;
912 if (!arch_get_random_seed_long(&rv) &&
913 !arch_get_random_long(&rv))
914 rv = random_get_entropy();
915 crng->state[i+4] ^= buf.key[i] ^ rv;
916 }
917 memzero_explicit(&buf, sizeof(buf));
918 crng->init_time = jiffies;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200919 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400920 if (crng == &primary_crng && crng_init < 2) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400921 invalidate_batched_entropy();
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400922 numa_crng_init();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400923 crng_init = 2;
924 process_random_ready_list();
925 wake_up_interruptible(&crng_init_wait);
926 pr_notice("random: crng init done\n");
927 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400928}
929
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400930static void _extract_crng(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800931 __u32 out[CHACHA20_BLOCK_WORDS])
Theodore Ts'oe192be92016-06-12 18:13:36 -0400932{
933 unsigned long v, flags;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400934
Theodore Ts'o43838a22018-04-11 13:27:52 -0400935 if (crng_ready() &&
Theodore Ts'oe192be92016-06-12 18:13:36 -0400936 time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL))
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400937 crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400938 spin_lock_irqsave(&crng->lock, flags);
939 if (arch_get_random_long(&v))
940 crng->state[14] ^= v;
941 chacha20_block(&crng->state[0], out);
942 if (crng->state[12] == 0)
943 crng->state[13]++;
944 spin_unlock_irqrestore(&crng->lock, flags);
945}
946
Eric Biggers9f480fa2017-11-22 11:51:39 -0800947static void extract_crng(__u32 out[CHACHA20_BLOCK_WORDS])
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400948{
949 struct crng_state *crng = NULL;
950
951#ifdef CONFIG_NUMA
952 if (crng_node_pool)
953 crng = crng_node_pool[numa_node_id()];
954 if (crng == NULL)
955#endif
956 crng = &primary_crng;
957 _extract_crng(crng, out);
958}
959
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400960/*
961 * Use the leftover bytes from the CRNG block output (if there is
962 * enough) to mutate the CRNG key to provide backtracking protection.
963 */
964static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800965 __u32 tmp[CHACHA20_BLOCK_WORDS], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400966{
967 unsigned long flags;
968 __u32 *s, *d;
969 int i;
970
971 used = round_up(used, sizeof(__u32));
972 if (used + CHACHA20_KEY_SIZE > CHACHA20_BLOCK_SIZE) {
973 extract_crng(tmp);
974 used = 0;
975 }
976 spin_lock_irqsave(&crng->lock, flags);
Eric Biggers9f480fa2017-11-22 11:51:39 -0800977 s = &tmp[used / sizeof(__u32)];
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400978 d = &crng->state[4];
979 for (i=0; i < 8; i++)
980 *d++ ^= *s++;
981 spin_unlock_irqrestore(&crng->lock, flags);
982}
983
Eric Biggers9f480fa2017-11-22 11:51:39 -0800984static void crng_backtrack_protect(__u32 tmp[CHACHA20_BLOCK_WORDS], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400985{
986 struct crng_state *crng = NULL;
987
988#ifdef CONFIG_NUMA
989 if (crng_node_pool)
990 crng = crng_node_pool[numa_node_id()];
991 if (crng == NULL)
992#endif
993 crng = &primary_crng;
994 _crng_backtrack_protect(crng, tmp, used);
995}
996
Theodore Ts'oe192be92016-06-12 18:13:36 -0400997static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
998{
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400999 ssize_t ret = 0, i = CHACHA20_BLOCK_SIZE;
Eric Biggers9f480fa2017-11-22 11:51:39 -08001000 __u32 tmp[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001001 int large_request = (nbytes > 256);
1002
1003 while (nbytes) {
1004 if (large_request && need_resched()) {
1005 if (signal_pending(current)) {
1006 if (ret == 0)
1007 ret = -ERESTARTSYS;
1008 break;
1009 }
1010 schedule();
1011 }
1012
1013 extract_crng(tmp);
1014 i = min_t(int, nbytes, CHACHA20_BLOCK_SIZE);
1015 if (copy_to_user(buf, tmp, i)) {
1016 ret = -EFAULT;
1017 break;
1018 }
1019
1020 nbytes -= i;
1021 buf += i;
1022 ret += i;
1023 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001024 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001025
1026 /* Wipe data just written to memory */
1027 memzero_explicit(tmp, sizeof(tmp));
1028
1029 return ret;
1030}
1031
1032
1033/*********************************************************************
1034 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 * Entropy input management
1036 *
1037 *********************************************************************/
1038
1039/* There is one of these per entropy source */
1040struct timer_rand_state {
1041 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001042 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043};
1044
Theodore Ts'o644008d2013-11-03 16:40:53 -05001045#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
1046
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001047/*
Theodore Ts'oe192be92016-06-12 18:13:36 -04001048 * Add device- or boot-specific data to the input pool to help
1049 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001050 *
Theodore Ts'oe192be92016-06-12 18:13:36 -04001051 * None of this adds any entropy; it is meant to avoid the problem of
1052 * the entropy pool having similar initial state across largely
1053 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001054 */
1055void add_device_randomness(const void *buf, unsigned int size)
1056{
Theodore Ts'o61875f32013-09-21 13:58:22 -04001057 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001058 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001059
Theodore Ts'odc12baa2018-04-11 14:58:27 -04001060 if (!crng_ready() && size)
1061 crng_slow_load(buf, size);
Kees Cookee7998c2017-07-12 14:34:04 -07001062
Theodore Ts'o59108952013-09-12 14:10:25 -04001063 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001064 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001065 _mix_pool_bytes(&input_pool, buf, size);
1066 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001067 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001068}
1069EXPORT_SYMBOL(add_device_randomness);
1070
Theodore Ts'o644008d2013-11-03 16:40:53 -05001071static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001072
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073/*
1074 * This function adds entropy to the entropy "pool" by using timing
1075 * delays. It uses the timer_rand_state structure to make an estimate
1076 * of how many bits of entropy this call has added to the pool.
1077 *
1078 * The number "num" is also added to the pool - it should somehow describe
1079 * the type of event which just happened. This is currently 0-255 for
1080 * keyboard scan codes, and 256 upwards for interrupts.
1081 *
1082 */
1083static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1084{
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001085 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -08001088 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 unsigned num;
1090 } sample;
1091 long delta, delta2, delta3;
1092
1093 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
1095 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001096 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 sample.num = num;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001098 r = &input_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001099 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100
1101 /*
1102 * Calculate number of bits of randomness we probably added.
1103 * We take into account the first, second and third-order deltas
1104 * in order to make our estimate.
1105 */
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001106 delta = sample.jiffies - state->last_time;
1107 state->last_time = sample.jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001109 delta2 = delta - state->last_delta;
1110 state->last_delta = delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001112 delta3 = delta2 - state->last_delta2;
1113 state->last_delta2 = delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001115 if (delta < 0)
1116 delta = -delta;
1117 if (delta2 < 0)
1118 delta2 = -delta2;
1119 if (delta3 < 0)
1120 delta3 = -delta3;
1121 if (delta > delta2)
1122 delta = delta2;
1123 if (delta > delta3)
1124 delta = delta3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001126 /*
1127 * delta is now minimum absolute delta.
1128 * Round down by 1 bit on general principles,
1129 * and limit entropy entimate to 12 bits.
1130 */
1131 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 preempt_enable();
1134}
1135
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001136void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 unsigned int value)
1138{
1139 static unsigned char last_value;
1140
1141 /* ignore autorepeat and the like */
1142 if (value == last_value)
1143 return;
1144
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 last_value = value;
1146 add_timer_randomness(&input_timer_state,
1147 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001148 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001150EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001152static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1153
Theodore Ts'o43759d42014-06-14 21:43:13 -04001154#ifdef ADD_INTERRUPT_BENCH
1155static unsigned long avg_cycles, avg_deviation;
1156
1157#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1158#define FIXED_1_2 (1 << (AVG_SHIFT-1))
1159
1160static void add_interrupt_bench(cycles_t start)
1161{
1162 long delta = random_get_entropy() - start;
1163
1164 /* Use a weighted moving average */
1165 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1166 avg_cycles += delta;
1167 /* And average deviation */
1168 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1169 avg_deviation += delta;
1170}
1171#else
1172#define add_interrupt_bench(x)
1173#endif
1174
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001175static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
1176{
1177 __u32 *ptr = (__u32 *) regs;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001178 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001179
1180 if (regs == NULL)
1181 return 0;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001182 idx = READ_ONCE(f->reg_idx);
1183 if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
1184 idx = 0;
1185 ptr += idx++;
1186 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitz9dfa7bb2017-04-30 19:49:21 +12001187 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001188}
1189
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001190void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191{
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001192 struct entropy_store *r;
Christoph Lameter1b2a1a72014-08-17 12:30:29 -05001193 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001194 struct pt_regs *regs = get_irq_regs();
1195 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001196 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -04001197 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001198 __u64 ip;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001199 unsigned long seed;
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001200 int credit = 0;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001201
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001202 if (cycles == 0)
1203 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001204 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1205 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001206 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1207 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001208 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001209 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001210 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
1211 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001212
Theodore Ts'o43759d42014-06-14 21:43:13 -04001213 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001214 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001215
Theodore Ts'o43838a22018-04-11 13:27:52 -04001216 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001217 if ((fast_pool->count >= 64) &&
1218 crng_fast_load((char *) fast_pool->pool,
1219 sizeof(fast_pool->pool))) {
1220 fast_pool->count = 0;
1221 fast_pool->last = now;
1222 }
1223 return;
1224 }
1225
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001226 if ((fast_pool->count < 64) &&
1227 !time_after(now, fast_pool->last + HZ))
1228 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229
Theodore Ts'oe192be92016-06-12 18:13:36 -04001230 r = &input_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001231 if (!spin_trylock(&r->lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 return;
1233
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001234 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001235 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
H. Peter Anvin83664a62014-03-17 16:36:28 -07001236
1237 /*
1238 * If we have architectural seed generator, produce a seed and
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001239 * add it to the pool. For the sake of paranoia don't let the
1240 * architectural seed generator dominate the input from the
1241 * interrupt noise.
H. Peter Anvin83664a62014-03-17 16:36:28 -07001242 */
1243 if (arch_get_random_seed_long(&seed)) {
Theodore Ts'o85608f82014-06-10 23:09:20 -04001244 __mix_pool_bytes(r, &seed, sizeof(seed));
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001245 credit = 1;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001246 }
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001247 spin_unlock(&r->lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001248
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001249 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001250
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001251 /* award one bit for the contents of the fast pool */
1252 credit_entropy_bits(r, credit + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001254EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255
David Howells93614012006-09-30 20:45:40 +02001256#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257void add_disk_randomness(struct gendisk *disk)
1258{
1259 if (!disk || !disk->random)
1260 return;
1261 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001262 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001263 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001265EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001266#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268/*********************************************************************
1269 *
1270 * Entropy extraction routines
1271 *
1272 *********************************************************************/
1273
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001275 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 * from the primary pool to the secondary extraction pool. We make
1277 * sure we pull enough for a 'catastrophic reseed'.
1278 */
Theodore Ts'o6265e162013-10-03 01:08:15 -04001279static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1281{
Theodore Ts'ocff85032014-06-10 23:18:16 -04001282 if (!r->pull ||
1283 r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
1284 r->entropy_count > r->poolinfo->poolfracbits)
1285 return;
1286
Theodore Ts'ocff85032014-06-10 23:18:16 -04001287 _xfer_secondary_pool(r, nbytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001288}
Matt Mackall5a021e92007-07-19 11:30:14 -07001289
Theodore Ts'o6265e162013-10-03 01:08:15 -04001290static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1291{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 __u32 tmp[OUTPUT_POOL_WORDS];
1293
Theodore Ts'o6265e162013-10-03 01:08:15 -04001294 int bytes = nbytes;
Matt Mackall5a021e92007-07-19 11:30:14 -07001295
Greg Price2132a962013-12-06 21:28:03 -05001296 /* pull at least as much as a wakeup */
1297 bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001298 /* but never more than the buffer size */
1299 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001301 trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
1302 ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
Theodore Ts'o6265e162013-10-03 01:08:15 -04001303 bytes = extract_entropy(r->pull, tmp, bytes,
Stephan Müller43d8a722016-12-27 23:40:59 +01001304 random_read_wakeup_bits / 8, 0);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001305 mix_pool_bytes(r, tmp, bytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001306 credit_entropy_bits(r, bytes*8);
1307}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
Theodore Ts'o6265e162013-10-03 01:08:15 -04001309/*
1310 * Used as a workqueue function so that when the input pool is getting
1311 * full, we can "spill over" some entropy to the output pools. That
1312 * way the output pools can store some of the excess entropy instead
1313 * of letting it go to waste.
1314 */
1315static void push_to_pool(struct work_struct *work)
1316{
1317 struct entropy_store *r = container_of(work, struct entropy_store,
1318 push_work);
1319 BUG_ON(!r);
Greg Price2132a962013-12-06 21:28:03 -05001320 _xfer_secondary_pool(r, random_read_wakeup_bits/8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001321 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
1322 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323}
1324
1325/*
Greg Price19fa5be12013-11-29 15:50:06 -05001326 * This function decides how many bytes to actually take from the
1327 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329static size_t account(struct entropy_store *r, size_t nbytes, int min,
1330 int reserved)
1331{
Stephan Müller43d8a722016-12-27 23:40:59 +01001332 int entropy_count, orig, have_bytes;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001333 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001335 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336
1337 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001338retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -07001339 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001340 ibytes = nbytes;
Stephan Müller43d8a722016-12-27 23:40:59 +01001341 /* never pull more than available */
1342 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001343
Stephan Müller43d8a722016-12-27 23:40:59 +01001344 if ((have_bytes -= reserved) < 0)
1345 have_bytes = 0;
1346 ibytes = min_t(size_t, ibytes, have_bytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001347 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001348 ibytes = 0;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001349
1350 if (unlikely(entropy_count < 0)) {
1351 pr_warn("random: negative entropy count: pool %s count %d\n",
1352 r->name, entropy_count);
1353 WARN_ON(1);
1354 entropy_count = 0;
1355 }
1356 nfrac = ibytes << (ENTROPY_SHIFT + 3);
1357 if ((size_t) entropy_count > nfrac)
1358 entropy_count -= nfrac;
1359 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001360 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001361
Greg Price0fb7a012013-12-05 19:32:19 -05001362 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1363 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001365 trace_debit_entropy(r->name, 8 * ibytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001366 if (ibytes &&
Greg Price2132a962013-12-06 21:28:03 -05001367 (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
Theodore Ts'ob9809552013-03-04 11:59:12 -05001368 wake_up_interruptible(&random_write_wait);
1369 kill_fasync(&fasync, SIGIO, POLL_OUT);
1370 }
1371
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001372 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373}
1374
Greg Price19fa5be12013-11-29 15:50:06 -05001375/*
1376 * This function does the actual extraction for extract_entropy and
1377 * extract_entropy_user.
1378 *
1379 * Note: we assume that .poolwords is a multiple of 16 words.
1380 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381static void extract_buf(struct entropy_store *r, __u8 *out)
1382{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001383 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001384 union {
1385 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001386 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001387 } hash;
1388 __u32 workspace[SHA_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001389 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001392 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001393 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001394 */
Theodore Ts'o46884442013-12-17 21:16:39 -05001395 sha_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001396 for (i = 0; i < LONGS(20); i++) {
1397 unsigned long v;
1398 if (!arch_get_random_long(&v))
1399 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001400 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001401 }
1402
Theodore Ts'o46884442013-12-17 21:16:39 -05001403 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1404 spin_lock_irqsave(&r->lock, flags);
1405 for (i = 0; i < r->poolinfo->poolwords; i += 16)
1406 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1407
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001408 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001409 * We mix the hash back into the pool to prevent backtracking
1410 * attacks (where the attacker knows the state of the pool
1411 * plus the current outputs, and attempts to find previous
1412 * ouputs), unless the hash function can be inverted. By
1413 * mixing at least a SHA1 worth of hash data back, we make
1414 * brute-forcing the feedback as hard as brute-forcing the
1415 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001417 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001418 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001419
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001420 memzero_explicit(workspace, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421
1422 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001423 * In case the hash function has some recognizable output
1424 * pattern, we fold it in half. Thus, we always feed back
1425 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001427 hash.w[0] ^= hash.w[3];
1428 hash.w[1] ^= hash.w[4];
1429 hash.w[2] ^= rol32(hash.w[2], 16);
1430
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001431 memcpy(out, &hash, EXTRACT_SIZE);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001432 memzero_explicit(&hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433}
1434
Theodore Ts'oe192be92016-06-12 18:13:36 -04001435static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
1436 size_t nbytes, int fips)
1437{
1438 ssize_t ret = 0, i;
1439 __u8 tmp[EXTRACT_SIZE];
1440 unsigned long flags;
1441
1442 while (nbytes) {
1443 extract_buf(r, tmp);
1444
1445 if (fips) {
1446 spin_lock_irqsave(&r->lock, flags);
1447 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1448 panic("Hardware RNG duplicated output!\n");
1449 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1450 spin_unlock_irqrestore(&r->lock, flags);
1451 }
1452 i = min_t(int, nbytes, EXTRACT_SIZE);
1453 memcpy(buf, tmp, i);
1454 nbytes -= i;
1455 buf += i;
1456 ret += i;
1457 }
1458
1459 /* Wipe data just returned from memory */
1460 memzero_explicit(tmp, sizeof(tmp));
1461
1462 return ret;
1463}
1464
Greg Price19fa5be12013-11-29 15:50:06 -05001465/*
1466 * This function extracts randomness from the "entropy pool", and
1467 * returns it in a buffer.
1468 *
1469 * The min parameter specifies the minimum amount we can pull before
1470 * failing to avoid races that defeat catastrophic reseeding while the
1471 * reserved parameter indicates how much entropy we must leave in the
1472 * pool after each pull to avoid starving other readers.
1473 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001474static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001475 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001478 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001480 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001481 if (fips_enabled) {
1482 spin_lock_irqsave(&r->lock, flags);
1483 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001484 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001485 spin_unlock_irqrestore(&r->lock, flags);
1486 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001487 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001488 xfer_secondary_pool(r, EXTRACT_SIZE);
1489 extract_buf(r, tmp);
1490 spin_lock_irqsave(&r->lock, flags);
1491 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1492 }
1493 spin_unlock_irqrestore(&r->lock, flags);
1494 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001495
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001496 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 xfer_secondary_pool(r, nbytes);
1498 nbytes = account(r, nbytes, min, reserved);
1499
Theodore Ts'oe192be92016-06-12 18:13:36 -04001500 return _extract_entropy(r, buf, nbytes, fips_enabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
1502
Greg Price19fa5be12013-11-29 15:50:06 -05001503/*
1504 * This function extracts randomness from the "entropy pool", and
1505 * returns it in a userspace buffer.
1506 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1508 size_t nbytes)
1509{
1510 ssize_t ret = 0, i;
1511 __u8 tmp[EXTRACT_SIZE];
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001512 int large_request = (nbytes > 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001514 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 xfer_secondary_pool(r, nbytes);
1516 nbytes = account(r, nbytes, 0, 0);
1517
1518 while (nbytes) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001519 if (large_request && need_resched()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 if (signal_pending(current)) {
1521 if (ret == 0)
1522 ret = -ERESTARTSYS;
1523 break;
1524 }
1525 schedule();
1526 }
1527
1528 extract_buf(r, tmp);
1529 i = min_t(int, nbytes, EXTRACT_SIZE);
1530 if (copy_to_user(buf, tmp, i)) {
1531 ret = -EFAULT;
1532 break;
1533 }
1534
1535 nbytes -= i;
1536 buf += i;
1537 ret += i;
1538 }
1539
1540 /* Wipe data just returned from memory */
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001541 memzero_explicit(tmp, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
1543 return ret;
1544}
1545
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001546#define warn_unseeded_randomness(previous) \
1547 _warn_unseeded_randomness(__func__, (void *) _RET_IP_, (previous))
1548
1549static void _warn_unseeded_randomness(const char *func_name, void *caller,
1550 void **previous)
1551{
1552#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1553 const bool print_once = false;
1554#else
1555 static bool print_once __read_mostly;
1556#endif
1557
1558 if (print_once ||
1559 crng_ready() ||
1560 (previous && (caller == READ_ONCE(*previous))))
1561 return;
1562 WRITE_ONCE(*previous, caller);
1563#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1564 print_once = true;
1565#endif
Helge Deller51d96dc2017-08-08 18:28:41 +02001566 pr_notice("random: %s called from %pS with crng_init=%d\n",
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001567 func_name, caller, crng_init);
1568}
1569
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570/*
1571 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001572 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001573 * TCP sequence numbers, etc. It does not rely on the hardware random
1574 * number generator. For random bytes direct from the hardware RNG
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001575 * (when available), use get_random_bytes_arch(). In order to ensure
1576 * that the randomness provided by this function is okay, the function
1577 * wait_for_random_bytes() should be called and return 0 at least once
1578 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 */
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001580static void _get_random_bytes(void *buf, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581{
Eric Biggers9f480fa2017-11-22 11:51:39 -08001582 __u32 tmp[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001583
Theodore Ts'o59108952013-09-12 14:10:25 -04001584 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001585
1586 while (nbytes >= CHACHA20_BLOCK_SIZE) {
1587 extract_crng(buf);
1588 buf += CHACHA20_BLOCK_SIZE;
1589 nbytes -= CHACHA20_BLOCK_SIZE;
1590 }
1591
1592 if (nbytes > 0) {
1593 extract_crng(tmp);
1594 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001595 crng_backtrack_protect(tmp, nbytes);
1596 } else
1597 crng_backtrack_protect(tmp, CHACHA20_BLOCK_SIZE);
1598 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001599}
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001600
1601void get_random_bytes(void *buf, int nbytes)
1602{
1603 static void *previous;
1604
1605 warn_unseeded_randomness(&previous);
1606 _get_random_bytes(buf, nbytes);
1607}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001608EXPORT_SYMBOL(get_random_bytes);
1609
1610/*
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001611 * Wait for the urandom pool to be seeded and thus guaranteed to supply
1612 * cryptographically secure random numbers. This applies to: the /dev/urandom
1613 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
1614 * family of functions. Using any of these functions without first calling
1615 * this function forfeits the guarantee of security.
1616 *
1617 * Returns: 0 if the urandom pool has been seeded.
1618 * -ERESTARTSYS if the function was interrupted by a signal.
1619 */
1620int wait_for_random_bytes(void)
1621{
1622 if (likely(crng_ready()))
1623 return 0;
1624 return wait_event_interruptible(crng_init_wait, crng_ready());
1625}
1626EXPORT_SYMBOL(wait_for_random_bytes);
1627
1628/*
Herbert Xu205a5252015-06-09 18:19:39 +08001629 * Add a callback function that will be invoked when the nonblocking
1630 * pool is initialised.
1631 *
1632 * returns: 0 if callback is successfully added
1633 * -EALREADY if pool is already initialised (callback not called)
1634 * -ENOENT if module for callback is not alive
1635 */
1636int add_random_ready_callback(struct random_ready_callback *rdy)
1637{
1638 struct module *owner;
1639 unsigned long flags;
1640 int err = -EALREADY;
1641
Theodore Ts'oe192be92016-06-12 18:13:36 -04001642 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001643 return err;
1644
1645 owner = rdy->owner;
1646 if (!try_module_get(owner))
1647 return -ENOENT;
1648
1649 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001650 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001651 goto out;
1652
1653 owner = NULL;
1654
1655 list_add(&rdy->list, &random_ready_list);
1656 err = 0;
1657
1658out:
1659 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1660
1661 module_put(owner);
1662
1663 return err;
1664}
1665EXPORT_SYMBOL(add_random_ready_callback);
1666
1667/*
1668 * Delete a previously registered readiness callback function.
1669 */
1670void del_random_ready_callback(struct random_ready_callback *rdy)
1671{
1672 unsigned long flags;
1673 struct module *owner = NULL;
1674
1675 spin_lock_irqsave(&random_ready_list_lock, flags);
1676 if (!list_empty(&rdy->list)) {
1677 list_del_init(&rdy->list);
1678 owner = rdy->owner;
1679 }
1680 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1681
1682 module_put(owner);
1683}
1684EXPORT_SYMBOL(del_random_ready_callback);
1685
1686/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001687 * This function will use the architecture-specific hardware random
1688 * number generator if it is available. The arch-specific hw RNG will
1689 * almost certainly be faster than what we can do in software, but it
1690 * is impossible to verify that it is implemented securely (as
1691 * opposed, to, say, the AES encryption of a sequence number using a
1692 * key known by the NSA). So it's useful if we need the speed, but
1693 * only if we're willing to trust the hardware manufacturer not to
1694 * have put in a back door.
1695 */
1696void get_random_bytes_arch(void *buf, int nbytes)
1697{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001698 char *p = buf;
1699
Theodore Ts'o59108952013-09-12 14:10:25 -04001700 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001701 while (nbytes) {
1702 unsigned long v;
1703 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001704
H. Peter Anvin63d77172011-07-31 13:54:50 -07001705 if (!arch_get_random_long(&v))
1706 break;
1707
Luck, Tonybd29e562011-11-16 10:50:56 -08001708 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001709 p += chunk;
1710 nbytes -= chunk;
1711 }
1712
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001713 if (nbytes)
Theodore Ts'oe192be92016-06-12 18:13:36 -04001714 get_random_bytes(p, nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001716EXPORT_SYMBOL(get_random_bytes_arch);
1717
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718
1719/*
1720 * init_std_data - initialize pool with system data
1721 *
1722 * @r: pool to initialize
1723 *
1724 * This function clears the pool's entropy count and mixes some system
1725 * data into the pool to prepare it for use. The pool is not cleared
1726 * as that can only decrease the entropy in the pool.
1727 */
1728static void init_std_data(struct entropy_store *r)
1729{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001730 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001731 ktime_t now = ktime_get_real();
1732 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733
Theodore Ts'of5c27422013-09-22 15:14:32 -04001734 r->last_pulled = jiffies;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001735 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001736 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001737 if (!arch_get_random_seed_long(&rv) &&
1738 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001739 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001740 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001741 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001742 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743}
1744
Tony Luckcbc96b72012-07-23 09:47:57 -07001745/*
1746 * Note that setup_arch() may call add_device_randomness()
1747 * long before we get here. This allows seeding of the pools
1748 * with some platform dependent data very early in the boot
1749 * process. But it limits our options here. We must use
1750 * statically allocated structures that already have all
1751 * initializations complete at compile time. We should also
1752 * take care not to overwrite the precious per platform data
1753 * we were given.
1754 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001755static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756{
1757 init_std_data(&input_pool);
1758 init_std_data(&blocking_pool);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001759 crng_initialize(&primary_crng);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 return 0;
1761}
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001762early_initcall(rand_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
David Howells93614012006-09-30 20:45:40 +02001764#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765void rand_initialize_disk(struct gendisk *disk)
1766{
1767 struct timer_rand_state *state;
1768
1769 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001770 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 * source.
1772 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001773 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001774 if (state) {
1775 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001777 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778}
David Howells93614012006-09-30 20:45:40 +02001779#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780
1781static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001782_random_read(int nonblock, char __user *buf, size_t nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783{
Greg Price12ff3a52013-11-29 15:02:33 -05001784 ssize_t n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785
1786 if (nbytes == 0)
1787 return 0;
1788
Greg Price12ff3a52013-11-29 15:02:33 -05001789 nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1790 while (1) {
1791 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1792 if (n < 0)
1793 return n;
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001794 trace_random_read(n*8, (nbytes-n)*8,
1795 ENTROPY_BITS(&blocking_pool),
1796 ENTROPY_BITS(&input_pool));
Greg Price12ff3a52013-11-29 15:02:33 -05001797 if (n > 0)
1798 return n;
H. Peter Anvin331c6492014-03-17 16:36:29 -07001799
Greg Price12ff3a52013-11-29 15:02:33 -05001800 /* Pool is (near) empty. Maybe wait and retry. */
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001801 if (nonblock)
Greg Price12ff3a52013-11-29 15:02:33 -05001802 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803
Greg Price12ff3a52013-11-29 15:02:33 -05001804 wait_event_interruptible(random_read_wait,
1805 ENTROPY_BITS(&input_pool) >=
Greg Price2132a962013-12-06 21:28:03 -05001806 random_read_wakeup_bits);
Greg Price12ff3a52013-11-29 15:02:33 -05001807 if (signal_pending(current))
1808 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810}
1811
1812static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001813random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1814{
1815 return _random_read(file->f_flags & O_NONBLOCK, buf, nbytes);
1816}
1817
1818static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001819urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001821 unsigned long flags;
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001822 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05001823 int ret;
1824
Theodore Ts'oe192be92016-06-12 18:13:36 -04001825 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001826 maxwarn--;
1827 printk(KERN_NOTICE "random: %s: uninitialized urandom read "
Theodore Ts'oe192be92016-06-12 18:13:36 -04001828 "(%zd bytes read)\n",
1829 current->comm, nbytes);
1830 spin_lock_irqsave(&primary_crng.lock, flags);
1831 crng_init_cnt = 0;
1832 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001833 }
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001834 nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
Theodore Ts'oe192be92016-06-12 18:13:36 -04001835 ret = extract_crng_user(buf, nbytes);
1836 trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001837 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838}
1839
Al Viroafc9a422017-07-03 06:39:46 -04001840static __poll_t
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841random_poll(struct file *file, poll_table * wait)
1842{
Al Viroafc9a422017-07-03 06:39:46 -04001843 __poll_t mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
1845 poll_wait(file, &random_read_wait, wait);
1846 poll_wait(file, &random_write_wait, wait);
1847 mask = 0;
Greg Price2132a962013-12-06 21:28:03 -05001848 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001849 mask |= EPOLLIN | EPOLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05001850 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001851 mask |= EPOLLOUT | EPOLLWRNORM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 return mask;
1853}
1854
Matt Mackall7f397dc2007-05-29 21:58:10 -05001855static int
1856write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1857{
1858 size_t bytes;
1859 __u32 buf[16];
1860 const char __user *p = buffer;
1861
1862 while (count > 0) {
1863 bytes = min(count, sizeof(buf));
1864 if (copy_from_user(&buf, p, bytes))
1865 return -EFAULT;
1866
1867 count -= bytes;
1868 p += bytes;
1869
Theodore Ts'o85608f82014-06-10 23:09:20 -04001870 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001871 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001872 }
1873
1874 return 0;
1875}
1876
Matt Mackall90b75ee2008-04-29 01:02:55 -07001877static ssize_t random_write(struct file *file, const char __user *buffer,
1878 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001880 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881
Theodore Ts'oe192be92016-06-12 18:13:36 -04001882 ret = write_pool(&input_pool, buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05001883 if (ret)
1884 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885
Matt Mackall7f397dc2007-05-29 21:58:10 -05001886 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887}
1888
Matt Mackall43ae4862008-04-29 01:02:58 -07001889static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890{
1891 int size, ent_count;
1892 int __user *p = (int __user *)arg;
1893 int retval;
1894
1895 switch (cmd) {
1896 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001897 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001898 ent_count = ENTROPY_BITS(&input_pool);
1899 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 return -EFAULT;
1901 return 0;
1902 case RNDADDTOENTCNT:
1903 if (!capable(CAP_SYS_ADMIN))
1904 return -EPERM;
1905 if (get_user(ent_count, p))
1906 return -EFAULT;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001907 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 case RNDADDENTROPY:
1909 if (!capable(CAP_SYS_ADMIN))
1910 return -EPERM;
1911 if (get_user(ent_count, p++))
1912 return -EFAULT;
1913 if (ent_count < 0)
1914 return -EINVAL;
1915 if (get_user(size, p++))
1916 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001917 retval = write_pool(&input_pool, (const char __user *)p,
1918 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 if (retval < 0)
1920 return retval;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001921 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 case RNDZAPENTCNT:
1923 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001924 /*
1925 * Clear the entropy pool counters. We no longer clear
1926 * the entropy pool, as that's silly.
1927 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 if (!capable(CAP_SYS_ADMIN))
1929 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001930 input_pool.entropy_count = 0;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001931 blocking_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 return 0;
1933 default:
1934 return -EINVAL;
1935 }
1936}
1937
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001938static int random_fasync(int fd, struct file *filp, int on)
1939{
1940 return fasync_helper(fd, filp, on, &fasync);
1941}
1942
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001943const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 .read = random_read,
1945 .write = random_write,
1946 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001947 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001948 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001949 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950};
1951
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001952const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 .read = urandom_read,
1954 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001955 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001956 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001957 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958};
1959
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001960SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
1961 unsigned int, flags)
1962{
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001963 int ret;
1964
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001965 if (flags & ~(GRND_NONBLOCK|GRND_RANDOM))
1966 return -EINVAL;
1967
1968 if (count > INT_MAX)
1969 count = INT_MAX;
1970
1971 if (flags & GRND_RANDOM)
1972 return _random_read(flags & GRND_NONBLOCK, buf, count);
1973
Theodore Ts'oe192be92016-06-12 18:13:36 -04001974 if (!crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001975 if (flags & GRND_NONBLOCK)
1976 return -EAGAIN;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001977 ret = wait_for_random_bytes();
1978 if (unlikely(ret))
1979 return ret;
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001980 }
1981 return urandom_read(NULL, buf, count, NULL);
1982}
1983
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984/********************************************************************
1985 *
1986 * Sysctl interface
1987 *
1988 ********************************************************************/
1989
1990#ifdef CONFIG_SYSCTL
1991
1992#include <linux/sysctl.h>
1993
1994static int min_read_thresh = 8, min_write_thresh;
Greg Price8c2aa332013-12-05 19:19:29 -05001995static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996static int max_write_thresh = INPUT_POOL_WORDS * 32;
Fabio Estevamdb61ffe2017-01-31 14:36:07 -02001997static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998static char sysctl_bootid[16];
1999
2000/*
Greg Pricef22052b2013-11-29 14:58:16 -05002001 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 * UUID. The difference is in whether table->data is NULL; if it is,
2003 * then a new UUID is generated and returned to the user.
2004 *
Greg Pricef22052b2013-11-29 14:58:16 -05002005 * If the user accesses this via the proc interface, the UUID will be
2006 * returned as an ASCII string in the standard UUID format; if via the
2007 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 */
Joe Perchesa1514272013-06-13 19:37:35 -07002009static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 void __user *buffer, size_t *lenp, loff_t *ppos)
2011{
Joe Perchesa1514272013-06-13 19:37:35 -07002012 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 unsigned char buf[64], tmp_uuid[16], *uuid;
2014
2015 uuid = table->data;
2016 if (!uuid) {
2017 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07002019 } else {
2020 static DEFINE_SPINLOCK(bootid_spinlock);
2021
2022 spin_lock(&bootid_spinlock);
2023 if (!uuid[8])
2024 generate_random_uuid(uuid);
2025 spin_unlock(&bootid_spinlock);
2026 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027
Joe Perches35900772009-12-14 18:01:11 -08002028 sprintf(buf, "%pU", uuid);
2029
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 fake_table.data = buf;
2031 fake_table.maxlen = sizeof(buf);
2032
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002033 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034}
2035
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002036/*
2037 * Return entropy available scaled to integral bits
2038 */
Joe Perches5eb10d92014-06-06 14:37:58 -07002039static int proc_do_entropy(struct ctl_table *table, int write,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002040 void __user *buffer, size_t *lenp, loff_t *ppos)
2041{
Joe Perches5eb10d92014-06-06 14:37:58 -07002042 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002043 int entropy_count;
2044
2045 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
2046
2047 fake_table.data = &entropy_count;
2048 fake_table.maxlen = sizeof(entropy_count);
2049
2050 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
2051}
2052
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07002054extern struct ctl_table random_table[];
2055struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 .procname = "poolsize",
2058 .data = &sysctl_poolsize,
2059 .maxlen = sizeof(int),
2060 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002061 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 },
2063 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 .procname = "entropy_avail",
2065 .maxlen = sizeof(int),
2066 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002067 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 .data = &input_pool.entropy_count,
2069 },
2070 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 .procname = "read_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002072 .data = &random_read_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 .maxlen = sizeof(int),
2074 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002075 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 .extra1 = &min_read_thresh,
2077 .extra2 = &max_read_thresh,
2078 },
2079 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002081 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 .maxlen = sizeof(int),
2083 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002084 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 .extra1 = &min_write_thresh,
2086 .extra2 = &max_write_thresh,
2087 },
2088 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002089 .procname = "urandom_min_reseed_secs",
2090 .data = &random_min_urandom_seed,
2091 .maxlen = sizeof(int),
2092 .mode = 0644,
2093 .proc_handler = proc_dointvec,
2094 },
2095 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 .procname = "boot_id",
2097 .data = &sysctl_bootid,
2098 .maxlen = 16,
2099 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002100 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 },
2102 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 .procname = "uuid",
2104 .maxlen = 16,
2105 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002106 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002108#ifdef ADD_INTERRUPT_BENCH
2109 {
2110 .procname = "add_interrupt_avg_cycles",
2111 .data = &avg_cycles,
2112 .maxlen = sizeof(avg_cycles),
2113 .mode = 0444,
2114 .proc_handler = proc_doulongvec_minmax,
2115 },
2116 {
2117 .procname = "add_interrupt_avg_deviation",
2118 .data = &avg_deviation,
2119 .maxlen = sizeof(avg_deviation),
2120 .mode = 0444,
2121 .proc_handler = proc_doulongvec_minmax,
2122 },
2123#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002124 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125};
2126#endif /* CONFIG_SYSCTL */
2127
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002128struct batched_entropy {
2129 union {
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002130 u64 entropy_u64[CHACHA20_BLOCK_SIZE / sizeof(u64)];
2131 u32 entropy_u32[CHACHA20_BLOCK_SIZE / sizeof(u32)];
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002132 };
2133 unsigned int position;
2134};
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002135static rwlock_t batched_entropy_reset_lock = __RW_LOCK_UNLOCKED(batched_entropy_reset_lock);
Eric Biggersb1132de2016-05-04 21:08:39 -04002136
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137/*
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002138 * Get a random word for internal kernel use only. The quality of the random
2139 * number is either as good as RDRAND or as good as /dev/urandom, with the
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002140 * goal of being quite fast and not depleting entropy. In order to ensure
2141 * that the randomness provided by this function is okay, the function
2142 * wait_for_random_bytes() should be called and return 0 at least once
2143 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 */
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002145static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64);
2146u64 get_random_u64(void)
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002147{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002148 u64 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002149 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002150 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002151 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002152 static void *previous;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002153
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002154#if BITS_PER_LONG == 64
2155 if (arch_get_random_long((unsigned long *)&ret))
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002156 return ret;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002157#else
2158 if (arch_get_random_long((unsigned long *)&ret) &&
2159 arch_get_random_long((unsigned long *)&ret + 1))
2160 return ret;
2161#endif
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002162
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002163 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002164
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002165 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002166 batch = &get_cpu_var(batched_entropy_u64);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002167 if (use_lock)
2168 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002169 if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
Eric Biggers9f480fa2017-11-22 11:51:39 -08002170 extract_crng((__u32 *)batch->entropy_u64);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002171 batch->position = 0;
2172 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002173 ret = batch->entropy_u64[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002174 if (use_lock)
2175 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002176 put_cpu_var(batched_entropy_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002177 return ret;
2178}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002179EXPORT_SYMBOL(get_random_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002180
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002181static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32);
2182u32 get_random_u32(void)
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002183{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002184 u32 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002185 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002186 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002187 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002188 static void *previous;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002189
2190 if (arch_get_random_int(&ret))
2191 return ret;
2192
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002193 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002194
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002195 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002196 batch = &get_cpu_var(batched_entropy_u32);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002197 if (use_lock)
2198 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002199 if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
Eric Biggers9f480fa2017-11-22 11:51:39 -08002200 extract_crng(batch->entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002201 batch->position = 0;
2202 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002203 ret = batch->entropy_u32[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002204 if (use_lock)
2205 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002206 put_cpu_var(batched_entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002207 return ret;
2208}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002209EXPORT_SYMBOL(get_random_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002210
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002211/* It's important to invalidate all potential batched entropy that might
2212 * be stored before the crng is initialized, which we can do lazily by
2213 * simply resetting the counter to zero so that it's re-extracted on the
2214 * next usage. */
2215static void invalidate_batched_entropy(void)
2216{
2217 int cpu;
2218 unsigned long flags;
2219
2220 write_lock_irqsave(&batched_entropy_reset_lock, flags);
2221 for_each_possible_cpu (cpu) {
2222 per_cpu_ptr(&batched_entropy_u32, cpu)->position = 0;
2223 per_cpu_ptr(&batched_entropy_u64, cpu)->position = 0;
2224 }
2225 write_unlock_irqrestore(&batched_entropy_reset_lock, flags);
2226}
2227
Jason Cooper99fdafd2016-10-11 13:53:52 -07002228/**
2229 * randomize_page - Generate a random, page aligned address
2230 * @start: The smallest acceptable address the caller will take.
2231 * @range: The size of the area, starting at @start, within which the
2232 * random address must fall.
2233 *
2234 * If @start + @range would overflow, @range is capped.
2235 *
2236 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2237 * @start was already page aligned. We now align it regardless.
2238 *
2239 * Return: A page aligned address within [start, start + range). On error,
2240 * @start is returned.
2241 */
2242unsigned long
2243randomize_page(unsigned long start, unsigned long range)
2244{
2245 if (!PAGE_ALIGNED(start)) {
2246 range -= PAGE_ALIGN(start) - start;
2247 start = PAGE_ALIGN(start);
2248 }
2249
2250 if (start > ULONG_MAX - range)
2251 range = ULONG_MAX - start;
2252
2253 range >>= PAGE_SHIFT;
2254
2255 if (range == 0)
2256 return start;
2257
2258 return start + (get_random_long() % range << PAGE_SHIFT);
2259}
2260
Torsten Duwec84dbf62014-06-14 23:38:36 -04002261/* Interface for in-kernel drivers of true hardware RNGs.
2262 * Those devices may produce endless random bits and will be throttled
2263 * when our pool is full.
2264 */
2265void add_hwgenerator_randomness(const char *buffer, size_t count,
2266 size_t entropy)
2267{
2268 struct entropy_store *poolp = &input_pool;
2269
Theodore Ts'o43838a22018-04-11 13:27:52 -04002270 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04002271 crng_fast_load(buffer, count);
2272 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002273 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002274
2275 /* Suspend writing if we're above the trickle threshold.
2276 * We'll be woken up again once below random_write_wakeup_thresh,
2277 * or when the calling thread is about to terminate.
2278 */
2279 wait_event_interruptible(random_write_wait, kthread_should_stop() ||
2280 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002281 mix_pool_bytes(poolp, buffer, count);
2282 credit_entropy_bits(poolp, entropy);
2283}
2284EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);