blob: f4013b8a711b9b2354ed0d5c192098a838070047 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * random.c -- A strong random number generator
3 *
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04004 * Copyright (C) 2017 Jason A. Donenfeld <Jason@zx2c4.com>. All
5 * Rights Reserved.
6 *
Matt Mackall9e95ce22005-04-16 15:25:56 -07007 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
10 * rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, and the entire permission notice in its entirety,
17 * including the disclaimer of warranties.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. The name of the author may not be used to endorse or promote
22 * products derived from this software without specific prior
23 * written permission.
24 *
25 * ALTERNATIVELY, this product may be distributed under the terms of
26 * the GNU General Public License, in which case the provisions of the GPL are
27 * required INSTEAD OF the above restrictions. (This clause is
28 * necessary due to a potential bad interaction between the GPL and
29 * the restrictions contained in a BSD-style copyright.)
30 *
31 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
32 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
34 * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
35 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
37 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
38 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
41 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
42 * DAMAGE.
43 */
44
45/*
46 * (now, with legal B.S. out of the way.....)
47 *
48 * This routine gathers environmental noise from device drivers, etc.,
49 * and returns good random numbers, suitable for cryptographic use.
50 * Besides the obvious cryptographic uses, these numbers are also good
51 * for seeding TCP sequence numbers, and other places where it is
52 * desirable to have numbers which are not only random, but hard to
53 * predict by an attacker.
54 *
55 * Theory of operation
56 * ===================
57 *
58 * Computers are very predictable devices. Hence it is extremely hard
59 * to produce truly random numbers on a computer --- as opposed to
60 * pseudo-random numbers, which can easily generated by using a
61 * algorithm. Unfortunately, it is very easy for attackers to guess
62 * the sequence of pseudo-random number generators, and for some
63 * applications this is not acceptable. So instead, we must try to
64 * gather "environmental noise" from the computer's environment, which
65 * must be hard for outside attackers to observe, and use that to
66 * generate random numbers. In a Unix environment, this is best done
67 * from inside the kernel.
68 *
69 * Sources of randomness from the environment include inter-keyboard
70 * timings, inter-interrupt timings from some interrupts, and other
71 * events which are both (a) non-deterministic and (b) hard for an
72 * outside observer to measure. Randomness from these sources are
73 * added to an "entropy pool", which is mixed using a CRC-like function.
74 * This is not cryptographically strong, but it is adequate assuming
75 * the randomness is not chosen maliciously, and it is fast enough that
76 * the overhead of doing it on every interrupt is very reasonable.
77 * As random bytes are mixed into the entropy pool, the routines keep
78 * an *estimate* of how many bits of randomness have been stored into
79 * the random number generator's internal state.
80 *
81 * When random bytes are desired, they are obtained by taking the SHA
82 * hash of the contents of the "entropy pool". The SHA hash avoids
83 * exposing the internal state of the entropy pool. It is believed to
84 * be computationally infeasible to derive any useful information
85 * about the input of SHA from its output. Even if it is possible to
86 * analyze SHA in some clever way, as long as the amount of data
87 * returned from the generator is less than the inherent entropy in
88 * the pool, the output data is totally unpredictable. For this
89 * reason, the routine decreases its internal estimate of how many
90 * bits of "true randomness" are contained in the entropy pool as it
91 * outputs random numbers.
92 *
93 * If this estimate goes to zero, the routine can still generate
94 * random numbers; however, an attacker may (at least in theory) be
95 * able to infer the future output of the generator from prior
96 * outputs. This requires successful cryptanalysis of SHA, which is
97 * not believed to be feasible, but there is a remote possibility.
98 * Nonetheless, these numbers should be useful for the vast majority
99 * of purposes.
100 *
101 * Exported interfaces ---- output
102 * ===============================
103 *
104 * There are three exported interfaces; the first is one designed to
105 * be used from within the kernel:
106 *
107 * void get_random_bytes(void *buf, int nbytes);
108 *
109 * This interface will return the requested number of random bytes,
110 * and place it in the requested buffer.
111 *
112 * The two other interfaces are two character devices /dev/random and
113 * /dev/urandom. /dev/random is suitable for use when very high
114 * quality randomness is desired (for example, for key generation or
115 * one-time pads), as it will only return a maximum of the number of
116 * bits of randomness (as estimated by the random number generator)
117 * contained in the entropy pool.
118 *
119 * The /dev/urandom device does not have this limit, and will return
120 * as many bytes as are requested. As more and more random bytes are
121 * requested without giving time for the entropy pool to recharge,
122 * this will result in random numbers that are merely cryptographically
123 * strong. For many applications, however, this is acceptable.
124 *
125 * Exported interfaces ---- input
126 * ==============================
127 *
128 * The current exported interfaces for gathering environmental noise
129 * from the devices are:
130 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400131 * void add_device_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * void add_input_randomness(unsigned int type, unsigned int code,
133 * unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400134 * void add_interrupt_randomness(int irq, int irq_flags);
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100135 * void add_disk_randomness(struct gendisk *disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400137 * add_device_randomness() is for adding data to the random pool that
138 * is likely to differ between two devices (or possibly even per boot).
139 * This would be things like MAC addresses or serial numbers, or the
140 * read-out of the RTC. This does *not* add any actual entropy to the
141 * pool, but it initializes the pool to different values for devices
142 * that might otherwise be identical and have very little entropy
143 * available to them (particularly common in the embedded world).
144 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 * add_input_randomness() uses the input layer interrupt timing, as well as
146 * the event type information from the hardware.
147 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400148 * add_interrupt_randomness() uses the interrupt timing as random
149 * inputs to the entropy pool. Using the cycle counters and the irq source
150 * as inputs, it feeds the randomness roughly once a second.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100151 *
152 * add_disk_randomness() uses what amounts to the seek time of block
153 * layer request events, on a per-disk_devt basis, as input to the
154 * entropy pool. Note that high-speed solid state drives with very low
155 * seek times do not make for good sources of entropy, as their seek
156 * times are usually fairly consistent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 *
158 * All of these routines try to estimate how many bits of randomness a
159 * particular randomness source. They do this by keeping track of the
160 * first and second order deltas of the event timings.
161 *
162 * Ensuring unpredictability at system startup
163 * ============================================
164 *
165 * When any operating system starts up, it will go through a sequence
166 * of actions that are fairly predictable by an adversary, especially
167 * if the start-up does not involve interaction with a human operator.
168 * This reduces the actual number of bits of unpredictability in the
169 * entropy pool below the value in entropy_count. In order to
170 * counteract this effect, it helps to carry information in the
171 * entropy pool across shut-downs and start-ups. To do this, put the
172 * following lines an appropriate script which is run during the boot
173 * sequence:
174 *
175 * echo "Initializing random number generator..."
176 * random_seed=/var/run/random-seed
177 * # Carry a random seed from start-up to start-up
178 * # Load and then save the whole entropy pool
179 * if [ -f $random_seed ]; then
180 * cat $random_seed >/dev/urandom
181 * else
182 * touch $random_seed
183 * fi
184 * chmod 600 $random_seed
185 * dd if=/dev/urandom of=$random_seed count=1 bs=512
186 *
187 * and the following lines in an appropriate script which is run as
188 * the system is shutdown:
189 *
190 * # Carry a random seed from shut-down to start-up
191 * # Save the whole entropy pool
192 * echo "Saving random seed..."
193 * random_seed=/var/run/random-seed
194 * touch $random_seed
195 * chmod 600 $random_seed
196 * dd if=/dev/urandom of=$random_seed count=1 bs=512
197 *
198 * For example, on most modern systems using the System V init
199 * scripts, such code fragments would be found in
200 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
201 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
202 *
203 * Effectively, these commands cause the contents of the entropy pool
204 * to be saved at shut-down time and reloaded into the entropy pool at
205 * start-up. (The 'dd' in the addition to the bootup script is to
206 * make sure that /etc/random-seed is different for every start-up,
207 * even if the system crashes without executing rc.0.) Even with
208 * complete knowledge of the start-up activities, predicting the state
209 * of the entropy pool requires knowledge of the previous history of
210 * the system.
211 *
212 * Configuring the /dev/random driver under Linux
213 * ==============================================
214 *
215 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
216 * the /dev/mem major number (#1). So if your system does not have
217 * /dev/random and /dev/urandom created already, they can be created
218 * by using the commands:
219 *
220 * mknod /dev/random c 1 8
221 * mknod /dev/urandom c 1 9
222 *
223 * Acknowledgements:
224 * =================
225 *
226 * Ideas for constructing this random number generator were derived
227 * from Pretty Good Privacy's random number generator, and from private
228 * discussions with Phil Karn. Colin Plumb provided a faster random
229 * number generator, which speed up the mixing function of the entropy
230 * pool, taken from PGPfone. Dale Worley has also contributed many
231 * useful ideas and suggestions to improve this driver.
232 *
233 * Any flaws in the design are solely my responsibility, and should
234 * not be attributed to the Phil, Colin, or any of authors of PGP.
235 *
236 * Further background information on this topic may be obtained from
237 * RFC 1750, "Randomness Recommendations for Security", by Donald
238 * Eastlake, Steve Crocker, and Jeff Schiller.
239 */
240
241#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242#include <linux/module.h>
243#include <linux/kernel.h>
244#include <linux/major.h>
245#include <linux/string.h>
246#include <linux/fcntl.h>
247#include <linux/slab.h>
248#include <linux/random.h>
249#include <linux/poll.h>
250#include <linux/init.h>
251#include <linux/fs.h>
252#include <linux/genhd.h>
253#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700254#include <linux/mm.h>
Michael Ellermandd0f0cf2016-07-31 00:23:08 +1000255#include <linux/nodemask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256#include <linux/spinlock.h>
Torsten Duwec84dbf62014-06-14 23:38:36 -0400257#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#include <linux/percpu.h>
259#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800260#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400261#include <linux/ptrace.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400262#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200263#include <linux/irq.h>
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400264#include <linux/ratelimit.h>
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400265#include <linux/syscalls.h>
266#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700267#include <linux/uuid.h>
Theodore Ts'oe192be92016-06-12 18:13:36 -0400268#include <crypto/chacha20.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800269
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270#include <asm/processor.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800271#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400273#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#include <asm/io.h>
275
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400276#define CREATE_TRACE_POINTS
277#include <trace/events/random.h>
278
Theodore Ts'o43759d42014-06-14 21:43:13 -0400279/* #define ADD_INTERRUPT_BENCH */
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281/*
282 * Configuration information
283 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400284#define INPUT_POOL_SHIFT 12
285#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
286#define OUTPUT_POOL_SHIFT 10
287#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
288#define SEC_XFER_SIZE 512
289#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400292#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400295 * To allow fractional bits to be tracked, the entropy_count field is
296 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400297 *
298 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
299 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400300 */
301#define ENTROPY_SHIFT 3
302#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
303
304/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 * The minimum number of bits of entropy before we wake up a read on
306 * /dev/random. Should be enough to do a significant reseed.
307 */
Greg Price2132a962013-12-06 21:28:03 -0500308static int random_read_wakeup_bits = 64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310/*
311 * If the entropy count falls under this number of bits, then we
312 * should wake up processes which are selecting or polling on write
313 * access to /dev/random.
314 */
Greg Price2132a962013-12-06 21:28:03 -0500315static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400318 * Originally, we used a primitive polynomial of degree .poolwords
319 * over GF(2). The taps for various sizes are defined below. They
320 * were chosen to be evenly spaced except for the last tap, which is 1
321 * to get the twisting happening as fast as possible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400323 * For the purposes of better mixing, we use the CRC-32 polynomial as
324 * well to make a (modified) twisted Generalized Feedback Shift
325 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
326 * generators. ACM Transactions on Modeling and Computer Simulation
327 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
Greg Pricedfd38752013-11-29 14:58:06 -0500328 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400329 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 *
331 * Thanks to Colin Plumb for suggesting this.
332 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400333 * The mixing operation is much less sensitive than the output hash,
334 * where we use SHA-1. All that we want of mixing operation is that
335 * it be a good non-cryptographic hash; i.e. it not produce collisions
336 * when fed "random" data of the sort we expect to see. As long as
337 * the pool state differs for different inputs, we have preserved the
338 * input entropy and done a good job. The fact that an intelligent
339 * attacker can construct inputs that will produce controlled
340 * alterations to the pool's state is not important because we don't
341 * consider such inputs to contribute any randomness. The only
342 * property we need with respect to them is that the attacker can't
343 * increase his/her knowledge of the pool's state. Since all
344 * additions are reversible (knowing the final state and the input,
345 * you can reconstruct the initial state), if an attacker has any
346 * uncertainty about the initial state, he/she can only shuffle that
347 * uncertainty about, but never cause any collisions (which would
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 * decrease the uncertainty).
349 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400350 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
351 * Videau in their paper, "The Linux Pseudorandom Number Generator
352 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
353 * paper, they point out that we are not using a true Twisted GFSR,
354 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
355 * is, with only three taps, instead of the six that we are using).
356 * As a result, the resulting polynomial is neither primitive nor
357 * irreducible, and hence does not have a maximal period over
358 * GF(2**32). They suggest a slight change to the generator
359 * polynomial which improves the resulting TGFSR polynomial to be
360 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400363 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
364#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 int tap1, tap2, tap3, tap4, tap5;
366} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400367 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
368 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
369 { S(128), 104, 76, 51, 25, 1 },
370 /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
371 /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
372 { S(32), 26, 19, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373#if 0
374 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400375 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400378 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400381 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400384 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
386 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400387 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400389 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400392 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400395 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400398 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399#endif
400};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402/*
403 * Static global variables
404 */
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700405static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
406static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700407static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Herbert Xu205a5252015-06-09 18:19:39 +0800409static DEFINE_SPINLOCK(random_ready_list_lock);
410static LIST_HEAD(random_ready_list);
411
Theodore Ts'oe192be92016-06-12 18:13:36 -0400412struct crng_state {
413 __u32 state[16];
414 unsigned long init_time;
415 spinlock_t lock;
416};
417
418struct crng_state primary_crng = {
419 .lock = __SPIN_LOCK_UNLOCKED(primary_crng.lock),
420};
421
422/*
423 * crng_init = 0 --> Uninitialized
424 * 1 --> Initialized
425 * 2 --> Initialized from input_pool
426 *
427 * crng_init is protected by primary_crng->lock, and only increases
428 * its value (from 0->1->2).
429 */
430static int crng_init = 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400431#define crng_ready() (likely(crng_init > 1))
Theodore Ts'oe192be92016-06-12 18:13:36 -0400432static int crng_init_cnt = 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400433static unsigned long crng_global_init_time = 0;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400434#define CRNG_INIT_CNT_THRESH (2*CHACHA20_KEY_SIZE)
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400435static void _extract_crng(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800436 __u32 out[CHACHA20_BLOCK_WORDS]);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400437static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800438 __u32 tmp[CHACHA20_BLOCK_WORDS], int used);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400439static void process_random_ready_list(void);
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400440static void _get_random_bytes(void *buf, int nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400441
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400442static struct ratelimit_state unseeded_warning =
443 RATELIMIT_STATE_INIT("warn_unseeded_randomness", HZ, 3);
444static struct ratelimit_state urandom_warning =
445 RATELIMIT_STATE_INIT("warn_urandom_randomness", HZ, 3);
446
447static int ratelimit_disable __read_mostly;
448
449module_param_named(ratelimit_disable, ratelimit_disable, int, 0644);
450MODULE_PARM_DESC(ratelimit_disable, "Disable random ratelimit suppression");
451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452/**********************************************************************
453 *
454 * OS independent entropy store. Here are the functions which handle
455 * storing entropy in an entropy pool.
456 *
457 **********************************************************************/
458
459struct entropy_store;
460struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700461 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400462 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 __u32 *pool;
464 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400466 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400469 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700470 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400471 unsigned short add_ptr;
472 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800473 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400474 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400475 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400476 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000477 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478};
479
Theodore Ts'oe192be92016-06-12 18:13:36 -0400480static ssize_t extract_entropy(struct entropy_store *r, void *buf,
481 size_t nbytes, int min, int rsvd);
482static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
483 size_t nbytes, int fips);
484
485static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400486static void push_to_pool(struct work_struct *work);
Emese Revfy0766f782016-06-20 20:42:34 +0200487static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
488static __u32 blocking_pool_data[OUTPUT_POOL_WORDS] __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490static struct entropy_store input_pool = {
491 .poolinfo = &poolinfo_table[0],
492 .name = "input",
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200493 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 .pool = input_pool_data
495};
496
497static struct entropy_store blocking_pool = {
498 .poolinfo = &poolinfo_table[1],
499 .name = "blocking",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200501 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400502 .pool = blocking_pool_data,
503 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
504 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505};
506
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400507static __u32 const twist_table[8] = {
508 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
509 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
510
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700512 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700514 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 *
516 * The pool is stirred with a primitive polynomial of the appropriate
517 * degree, and then twisted. We twist by three bits at a time because
518 * it's cheap to do so and helps slightly in the expected case where
519 * the entropy is concentrated in the low-order bits.
520 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400521static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400522 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400524 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700525 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700527 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700528 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 tap1 = r->poolinfo->tap1;
531 tap2 = r->poolinfo->tap2;
532 tap3 = r->poolinfo->tap3;
533 tap4 = r->poolinfo->tap4;
534 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400536 input_rotate = r->input_rotate;
537 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Matt Mackalle68e5b62008-04-29 01:03:05 -0700539 /* mix one byte at a time to simplify size handling and churn faster */
540 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400541 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700542 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
544 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700545 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 w ^= r->pool[(i + tap1) & wordmask];
547 w ^= r->pool[(i + tap2) & wordmask];
548 w ^= r->pool[(i + tap3) & wordmask];
549 w ^= r->pool[(i + tap4) & wordmask];
550 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700551
552 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700554
555 /*
556 * Normally, we add 7 bits of rotation to the pool.
557 * At the beginning of the pool, add an extra 7 bits
558 * rotation, so that successive passes spread the
559 * input bits across the pool evenly.
560 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400561 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 }
563
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400564 r->input_rotate = input_rotate;
565 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566}
567
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400568static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400569 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400571 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400572 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400573}
574
575static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400576 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400577{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400578 unsigned long flags;
579
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400580 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400581 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400582 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400583 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584}
585
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400586struct fast_pool {
587 __u32 pool[4];
588 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400589 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400590 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400591};
592
593/*
594 * This is a fast mixing routine used by the interrupt randomness
595 * collector. It's hardcoded for an 128 bit pool and assumes that any
596 * locks that might be needed are taken by the caller.
597 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400598static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400599{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400600 __u32 a = f->pool[0], b = f->pool[1];
601 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400602
Theodore Ts'o43759d42014-06-14 21:43:13 -0400603 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500604 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400605 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400606
Theodore Ts'o43759d42014-06-14 21:43:13 -0400607 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500608 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400609 d ^= a; b ^= c;
610
611 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500612 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400613 d ^= a; b ^= c;
614
615 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500616 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400617 d ^= a; b ^= c;
618
619 f->pool[0] = a; f->pool[1] = b;
620 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400621 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400622}
623
Herbert Xu205a5252015-06-09 18:19:39 +0800624static void process_random_ready_list(void)
625{
626 unsigned long flags;
627 struct random_ready_callback *rdy, *tmp;
628
629 spin_lock_irqsave(&random_ready_list_lock, flags);
630 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
631 struct module *owner = rdy->owner;
632
633 list_del_init(&rdy->list);
634 rdy->func(rdy);
635 module_put(owner);
636 }
637 spin_unlock_irqrestore(&random_ready_list_lock, flags);
638}
639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400641 * Credit (or debit) the entropy store with n bits of entropy.
642 * Use credit_entropy_bits_safe() if the value comes from userspace
643 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700645static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400647 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400648 const int pool_size = r->poolinfo->poolfracbits;
649 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Matt Mackalladc782d2008-04-29 01:03:07 -0700651 if (!nbits)
652 return;
653
Theodore Ts'o902c0982012-07-04 10:38:30 -0400654retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -0700655 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400656 if (nfrac < 0) {
657 /* Debit */
658 entropy_count += nfrac;
659 } else {
660 /*
661 * Credit: we have to account for the possibility of
662 * overwriting already present entropy. Even in the
663 * ideal case of pure Shannon entropy, new contributions
664 * approach the full value asymptotically:
665 *
666 * entropy <- entropy + (pool_size - entropy) *
667 * (1 - exp(-add_entropy/pool_size))
668 *
669 * For add_entropy <= pool_size/2 then
670 * (1 - exp(-add_entropy/pool_size)) >=
671 * (add_entropy/pool_size)*0.7869...
672 * so we can approximate the exponential with
673 * 3/4*add_entropy/pool_size and still be on the
674 * safe side by adding at most pool_size/2 at a time.
675 *
676 * The use of pool_size-2 in the while statement is to
677 * prevent rounding artifacts from making the loop
678 * arbitrarily long; this limits the loop to log2(pool_size)*2
679 * turns no matter how large nbits is.
680 */
681 int pnfrac = nfrac;
682 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
683 /* The +2 corresponds to the /4 in the denominator */
684
685 do {
686 unsigned int anfrac = min(pnfrac, pool_size/2);
687 unsigned int add =
688 ((pool_size - entropy_count)*anfrac*3) >> s;
689
690 entropy_count += add;
691 pnfrac -= anfrac;
692 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
693 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400694
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -0400695 if (unlikely(entropy_count < 0)) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400696 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
697 r->name, entropy_count);
698 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700699 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400700 } else if (entropy_count > pool_size)
701 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400702 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
703 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
Theodore Ts'o6265e162013-10-03 01:08:15 -0400705 r->entropy_total += nbits;
Linus Torvalds0891ad82013-11-16 10:19:15 -0800706 if (!r->initialized && r->entropy_total > 128) {
707 r->initialized = 1;
708 r->entropy_total = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400709 }
710
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400711 trace_credit_entropy_bits(r->name, nbits,
712 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400713 r->entropy_total, _RET_IP_);
714
Theodore Ts'o6265e162013-10-03 01:08:15 -0400715 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500716 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400717
Theodore Ts'oe192be92016-06-12 18:13:36 -0400718 if (crng_init < 2 && entropy_bits >= 128) {
719 crng_reseed(&primary_crng, r);
720 entropy_bits = r->entropy_count >> ENTROPY_SHIFT;
721 }
722
Theodore Ts'o6265e162013-10-03 01:08:15 -0400723 /* should we wake readers? */
Andi Kleene8e8a2e2018-02-28 13:43:28 -0800724 if (entropy_bits >= random_read_wakeup_bits &&
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700725 wq_has_sleeper(&random_read_wait)) {
726 wake_up_interruptible(&random_read_wait);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400727 kill_fasync(&fasync, SIGIO, POLL_IN);
728 }
729 /* If the input pool is getting full, send some
Theodore Ts'oe192be92016-06-12 18:13:36 -0400730 * entropy to the blocking pool until it is 75% full.
Theodore Ts'o6265e162013-10-03 01:08:15 -0400731 */
Greg Price2132a962013-12-06 21:28:03 -0500732 if (entropy_bits > random_write_wakeup_bits &&
Theodore Ts'o6265e162013-10-03 01:08:15 -0400733 r->initialized &&
Greg Price2132a962013-12-06 21:28:03 -0500734 r->entropy_total >= 2*random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400735 struct entropy_store *other = &blocking_pool;
736
Theodore Ts'o6265e162013-10-03 01:08:15 -0400737 if (other->entropy_count <=
Theodore Ts'oe192be92016-06-12 18:13:36 -0400738 3 * other->poolinfo->poolfracbits / 4) {
739 schedule_work(&other->push_work);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400740 r->entropy_total = 0;
741 }
742 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700743 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744}
745
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400746static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400747{
Theodore Ts'o9f886f42017-02-25 18:21:33 -0400748 const int nbits_max = r->poolinfo->poolwords * 32;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400749
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400750 if (nbits < 0)
751 return -EINVAL;
752
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400753 /* Cap the value to avoid overflows */
754 nbits = min(nbits, nbits_max);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400755
756 credit_entropy_bits(r, nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400757 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400758}
759
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760/*********************************************************************
761 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400762 * CRNG using CHACHA20
763 *
764 *********************************************************************/
765
766#define CRNG_RESEED_INTERVAL (300*HZ)
767
768static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
769
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400770#ifdef CONFIG_NUMA
771/*
772 * Hack to deal with crazy userspace progams when they are all trying
773 * to access /dev/urandom in parallel. The programs are almost
774 * certainly doing something terribly wrong, but we'll work around
775 * their brain damage.
776 */
777static struct crng_state **crng_node_pool __read_mostly;
778#endif
779
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400780static void invalidate_batched_entropy(void);
781
Theodore Ts'oe192be92016-06-12 18:13:36 -0400782static void crng_initialize(struct crng_state *crng)
783{
784 int i;
Theodore Ts'o39a88832018-07-17 18:24:27 -0400785 int arch_init = 1;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400786 unsigned long rv;
787
788 memcpy(&crng->state[0], "expand 32-byte k", 16);
789 if (crng == &primary_crng)
790 _extract_entropy(&input_pool, &crng->state[4],
791 sizeof(__u32) * 12, 0);
792 else
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400793 _get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400794 for (i = 4; i < 16; i++) {
795 if (!arch_get_random_seed_long(&rv) &&
Theodore Ts'o39a88832018-07-17 18:24:27 -0400796 !arch_get_random_long(&rv)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400797 rv = random_get_entropy();
Theodore Ts'o39a88832018-07-17 18:24:27 -0400798 arch_init = 0;
799 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400800 crng->state[i] ^= rv;
801 }
Theodore Ts'o39a88832018-07-17 18:24:27 -0400802#ifdef CONFIG_RANDOM_TRUST_CPU
803 if (arch_init) {
804 crng_init = 2;
805 pr_notice("random: crng done (trusting CPU's manufacturer)\n");
806 }
807#endif
Theodore Ts'oe192be92016-06-12 18:13:36 -0400808 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
809}
810
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400811#ifdef CONFIG_NUMA
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400812static void do_numa_crng_init(struct work_struct *work)
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400813{
814 int i;
815 struct crng_state *crng;
816 struct crng_state **pool;
817
818 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
819 for_each_online_node(i) {
820 crng = kmalloc_node(sizeof(struct crng_state),
821 GFP_KERNEL | __GFP_NOFAIL, i);
822 spin_lock_init(&crng->lock);
823 crng_initialize(crng);
824 pool[i] = crng;
825 }
826 mb();
827 if (cmpxchg(&crng_node_pool, NULL, pool)) {
828 for_each_node(i)
829 kfree(pool[i]);
830 kfree(pool);
831 }
832}
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400833
834static DECLARE_WORK(numa_crng_init_work, do_numa_crng_init);
835
836static void numa_crng_init(void)
837{
838 schedule_work(&numa_crng_init_work);
839}
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400840#else
841static void numa_crng_init(void) {}
842#endif
843
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400844/*
845 * crng_fast_load() can be called by code in the interrupt service
846 * path. So we can't afford to dilly-dally.
847 */
Theodore Ts'oe192be92016-06-12 18:13:36 -0400848static int crng_fast_load(const char *cp, size_t len)
849{
850 unsigned long flags;
851 char *p;
852
853 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
854 return 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400855 if (crng_init != 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400856 spin_unlock_irqrestore(&primary_crng.lock, flags);
857 return 0;
858 }
859 p = (unsigned char *) &primary_crng.state[4];
860 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
861 p[crng_init_cnt % CHACHA20_KEY_SIZE] ^= *cp;
862 cp++; crng_init_cnt++; len--;
863 }
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200864 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400865 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400866 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400867 crng_init = 1;
868 wake_up_interruptible(&crng_init_wait);
869 pr_notice("random: fast init done\n");
870 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400871 return 1;
872}
873
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400874/*
875 * crng_slow_load() is called by add_device_randomness, which has two
876 * attributes. (1) We can't trust the buffer passed to it is
877 * guaranteed to be unpredictable (so it might not have any entropy at
878 * all), and (2) it doesn't have the performance constraints of
879 * crng_fast_load().
880 *
881 * So we do something more comprehensive which is guaranteed to touch
882 * all of the primary_crng's state, and which uses a LFSR with a
883 * period of 255 as part of the mixing algorithm. Finally, we do
884 * *not* advance crng_init_cnt since buffer we may get may be something
885 * like a fixed DMI table (for example), which might very well be
886 * unique to the machine, but is otherwise unvarying.
887 */
888static int crng_slow_load(const char *cp, size_t len)
889{
890 unsigned long flags;
891 static unsigned char lfsr = 1;
892 unsigned char tmp;
893 unsigned i, max = CHACHA20_KEY_SIZE;
894 const char * src_buf = cp;
895 char * dest_buf = (char *) &primary_crng.state[4];
896
897 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
898 return 0;
899 if (crng_init != 0) {
900 spin_unlock_irqrestore(&primary_crng.lock, flags);
901 return 0;
902 }
903 if (len > max)
904 max = len;
905
906 for (i = 0; i < max ; i++) {
907 tmp = lfsr;
908 lfsr >>= 1;
909 if (tmp & 1)
910 lfsr ^= 0xE1;
911 tmp = dest_buf[i % CHACHA20_KEY_SIZE];
912 dest_buf[i % CHACHA20_KEY_SIZE] ^= src_buf[i % len] ^ lfsr;
913 lfsr += (tmp << 3) | (tmp >> 5);
914 }
915 spin_unlock_irqrestore(&primary_crng.lock, flags);
916 return 1;
917}
918
Theodore Ts'oe192be92016-06-12 18:13:36 -0400919static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
920{
921 unsigned long flags;
922 int i, num;
923 union {
Eric Biggers9f480fa2017-11-22 11:51:39 -0800924 __u32 block[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -0400925 __u32 key[8];
926 } buf;
927
928 if (r) {
929 num = extract_entropy(r, &buf, 32, 16, 0);
930 if (num == 0)
931 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400932 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400933 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400934 _crng_backtrack_protect(&primary_crng, buf.block,
935 CHACHA20_KEY_SIZE);
936 }
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400937 spin_lock_irqsave(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400938 for (i = 0; i < 8; i++) {
939 unsigned long rv;
940 if (!arch_get_random_seed_long(&rv) &&
941 !arch_get_random_long(&rv))
942 rv = random_get_entropy();
943 crng->state[i+4] ^= buf.key[i] ^ rv;
944 }
945 memzero_explicit(&buf, sizeof(buf));
946 crng->init_time = jiffies;
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400947 spin_unlock_irqrestore(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400948 if (crng == &primary_crng && crng_init < 2) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400949 invalidate_batched_entropy();
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400950 numa_crng_init();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400951 crng_init = 2;
952 process_random_ready_list();
953 wake_up_interruptible(&crng_init_wait);
954 pr_notice("random: crng init done\n");
Theodore Ts'o4e00b332018-04-25 01:12:32 -0400955 if (unseeded_warning.missed) {
956 pr_notice("random: %d get_random_xx warning(s) missed "
957 "due to ratelimiting\n",
958 unseeded_warning.missed);
959 unseeded_warning.missed = 0;
960 }
961 if (urandom_warning.missed) {
962 pr_notice("random: %d urandom warning(s) missed "
963 "due to ratelimiting\n",
964 urandom_warning.missed);
965 urandom_warning.missed = 0;
966 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400967 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400968}
969
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400970static void _extract_crng(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800971 __u32 out[CHACHA20_BLOCK_WORDS])
Theodore Ts'oe192be92016-06-12 18:13:36 -0400972{
973 unsigned long v, flags;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400974
Theodore Ts'o43838a22018-04-11 13:27:52 -0400975 if (crng_ready() &&
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400976 (time_after(crng_global_init_time, crng->init_time) ||
977 time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL)))
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400978 crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400979 spin_lock_irqsave(&crng->lock, flags);
980 if (arch_get_random_long(&v))
981 crng->state[14] ^= v;
982 chacha20_block(&crng->state[0], out);
983 if (crng->state[12] == 0)
984 crng->state[13]++;
985 spin_unlock_irqrestore(&crng->lock, flags);
986}
987
Eric Biggers9f480fa2017-11-22 11:51:39 -0800988static void extract_crng(__u32 out[CHACHA20_BLOCK_WORDS])
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400989{
990 struct crng_state *crng = NULL;
991
992#ifdef CONFIG_NUMA
993 if (crng_node_pool)
994 crng = crng_node_pool[numa_node_id()];
995 if (crng == NULL)
996#endif
997 crng = &primary_crng;
998 _extract_crng(crng, out);
999}
1000
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001001/*
1002 * Use the leftover bytes from the CRNG block output (if there is
1003 * enough) to mutate the CRNG key to provide backtracking protection.
1004 */
1005static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -08001006 __u32 tmp[CHACHA20_BLOCK_WORDS], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001007{
1008 unsigned long flags;
1009 __u32 *s, *d;
1010 int i;
1011
1012 used = round_up(used, sizeof(__u32));
1013 if (used + CHACHA20_KEY_SIZE > CHACHA20_BLOCK_SIZE) {
1014 extract_crng(tmp);
1015 used = 0;
1016 }
1017 spin_lock_irqsave(&crng->lock, flags);
Eric Biggers9f480fa2017-11-22 11:51:39 -08001018 s = &tmp[used / sizeof(__u32)];
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001019 d = &crng->state[4];
1020 for (i=0; i < 8; i++)
1021 *d++ ^= *s++;
1022 spin_unlock_irqrestore(&crng->lock, flags);
1023}
1024
Eric Biggers9f480fa2017-11-22 11:51:39 -08001025static void crng_backtrack_protect(__u32 tmp[CHACHA20_BLOCK_WORDS], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001026{
1027 struct crng_state *crng = NULL;
1028
1029#ifdef CONFIG_NUMA
1030 if (crng_node_pool)
1031 crng = crng_node_pool[numa_node_id()];
1032 if (crng == NULL)
1033#endif
1034 crng = &primary_crng;
1035 _crng_backtrack_protect(crng, tmp, used);
1036}
1037
Theodore Ts'oe192be92016-06-12 18:13:36 -04001038static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
1039{
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001040 ssize_t ret = 0, i = CHACHA20_BLOCK_SIZE;
Eric Biggers9f480fa2017-11-22 11:51:39 -08001041 __u32 tmp[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001042 int large_request = (nbytes > 256);
1043
1044 while (nbytes) {
1045 if (large_request && need_resched()) {
1046 if (signal_pending(current)) {
1047 if (ret == 0)
1048 ret = -ERESTARTSYS;
1049 break;
1050 }
1051 schedule();
1052 }
1053
1054 extract_crng(tmp);
1055 i = min_t(int, nbytes, CHACHA20_BLOCK_SIZE);
1056 if (copy_to_user(buf, tmp, i)) {
1057 ret = -EFAULT;
1058 break;
1059 }
1060
1061 nbytes -= i;
1062 buf += i;
1063 ret += i;
1064 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001065 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001066
1067 /* Wipe data just written to memory */
1068 memzero_explicit(tmp, sizeof(tmp));
1069
1070 return ret;
1071}
1072
1073
1074/*********************************************************************
1075 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 * Entropy input management
1077 *
1078 *********************************************************************/
1079
1080/* There is one of these per entropy source */
1081struct timer_rand_state {
1082 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001083 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084};
1085
Theodore Ts'o644008d2013-11-03 16:40:53 -05001086#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
1087
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001088/*
Theodore Ts'oe192be92016-06-12 18:13:36 -04001089 * Add device- or boot-specific data to the input pool to help
1090 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001091 *
Theodore Ts'oe192be92016-06-12 18:13:36 -04001092 * None of this adds any entropy; it is meant to avoid the problem of
1093 * the entropy pool having similar initial state across largely
1094 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001095 */
1096void add_device_randomness(const void *buf, unsigned int size)
1097{
Theodore Ts'o61875f32013-09-21 13:58:22 -04001098 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001099 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001100
Theodore Ts'odc12baa2018-04-11 14:58:27 -04001101 if (!crng_ready() && size)
1102 crng_slow_load(buf, size);
Kees Cookee7998c2017-07-12 14:34:04 -07001103
Theodore Ts'o59108952013-09-12 14:10:25 -04001104 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001105 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001106 _mix_pool_bytes(&input_pool, buf, size);
1107 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001108 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001109}
1110EXPORT_SYMBOL(add_device_randomness);
1111
Theodore Ts'o644008d2013-11-03 16:40:53 -05001112static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001113
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114/*
1115 * This function adds entropy to the entropy "pool" by using timing
1116 * delays. It uses the timer_rand_state structure to make an estimate
1117 * of how many bits of entropy this call has added to the pool.
1118 *
1119 * The number "num" is also added to the pool - it should somehow describe
1120 * the type of event which just happened. This is currently 0-255 for
1121 * keyboard scan codes, and 256 upwards for interrupts.
1122 *
1123 */
1124static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1125{
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001126 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -08001129 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 unsigned num;
1131 } sample;
1132 long delta, delta2, delta3;
1133
1134 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
1136 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001137 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 sample.num = num;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001139 r = &input_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001140 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141
1142 /*
1143 * Calculate number of bits of randomness we probably added.
1144 * We take into account the first, second and third-order deltas
1145 * in order to make our estimate.
1146 */
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001147 delta = sample.jiffies - state->last_time;
1148 state->last_time = sample.jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001150 delta2 = delta - state->last_delta;
1151 state->last_delta = delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001153 delta3 = delta2 - state->last_delta2;
1154 state->last_delta2 = delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001156 if (delta < 0)
1157 delta = -delta;
1158 if (delta2 < 0)
1159 delta2 = -delta2;
1160 if (delta3 < 0)
1161 delta3 = -delta3;
1162 if (delta > delta2)
1163 delta = delta2;
1164 if (delta > delta3)
1165 delta = delta3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001167 /*
1168 * delta is now minimum absolute delta.
1169 * Round down by 1 bit on general principles,
1170 * and limit entropy entimate to 12 bits.
1171 */
1172 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 preempt_enable();
1175}
1176
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001177void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 unsigned int value)
1179{
1180 static unsigned char last_value;
1181
1182 /* ignore autorepeat and the like */
1183 if (value == last_value)
1184 return;
1185
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 last_value = value;
1187 add_timer_randomness(&input_timer_state,
1188 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001189 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001191EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001193static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1194
Theodore Ts'o43759d42014-06-14 21:43:13 -04001195#ifdef ADD_INTERRUPT_BENCH
1196static unsigned long avg_cycles, avg_deviation;
1197
1198#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1199#define FIXED_1_2 (1 << (AVG_SHIFT-1))
1200
1201static void add_interrupt_bench(cycles_t start)
1202{
1203 long delta = random_get_entropy() - start;
1204
1205 /* Use a weighted moving average */
1206 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1207 avg_cycles += delta;
1208 /* And average deviation */
1209 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1210 avg_deviation += delta;
1211}
1212#else
1213#define add_interrupt_bench(x)
1214#endif
1215
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001216static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
1217{
1218 __u32 *ptr = (__u32 *) regs;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001219 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001220
1221 if (regs == NULL)
1222 return 0;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001223 idx = READ_ONCE(f->reg_idx);
1224 if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
1225 idx = 0;
1226 ptr += idx++;
1227 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitz9dfa7bb2017-04-30 19:49:21 +12001228 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001229}
1230
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001231void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232{
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001233 struct entropy_store *r;
Christoph Lameter1b2a1a72014-08-17 12:30:29 -05001234 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001235 struct pt_regs *regs = get_irq_regs();
1236 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001237 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -04001238 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001239 __u64 ip;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001240 unsigned long seed;
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001241 int credit = 0;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001242
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001243 if (cycles == 0)
1244 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001245 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1246 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001247 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1248 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001249 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001250 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001251 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
1252 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001253
Theodore Ts'o43759d42014-06-14 21:43:13 -04001254 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001255 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001256
Theodore Ts'o43838a22018-04-11 13:27:52 -04001257 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001258 if ((fast_pool->count >= 64) &&
1259 crng_fast_load((char *) fast_pool->pool,
1260 sizeof(fast_pool->pool))) {
1261 fast_pool->count = 0;
1262 fast_pool->last = now;
1263 }
1264 return;
1265 }
1266
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001267 if ((fast_pool->count < 64) &&
1268 !time_after(now, fast_pool->last + HZ))
1269 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270
Theodore Ts'oe192be92016-06-12 18:13:36 -04001271 r = &input_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001272 if (!spin_trylock(&r->lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 return;
1274
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001275 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001276 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
H. Peter Anvin83664a62014-03-17 16:36:28 -07001277
1278 /*
1279 * If we have architectural seed generator, produce a seed and
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001280 * add it to the pool. For the sake of paranoia don't let the
1281 * architectural seed generator dominate the input from the
1282 * interrupt noise.
H. Peter Anvin83664a62014-03-17 16:36:28 -07001283 */
1284 if (arch_get_random_seed_long(&seed)) {
Theodore Ts'o85608f82014-06-10 23:09:20 -04001285 __mix_pool_bytes(r, &seed, sizeof(seed));
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001286 credit = 1;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001287 }
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001288 spin_unlock(&r->lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001289
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001290 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001291
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001292 /* award one bit for the contents of the fast pool */
1293 credit_entropy_bits(r, credit + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001295EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296
David Howells93614012006-09-30 20:45:40 +02001297#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298void add_disk_randomness(struct gendisk *disk)
1299{
1300 if (!disk || !disk->random)
1301 return;
1302 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001303 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001304 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001306EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001307#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309/*********************************************************************
1310 *
1311 * Entropy extraction routines
1312 *
1313 *********************************************************************/
1314
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001316 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 * from the primary pool to the secondary extraction pool. We make
1318 * sure we pull enough for a 'catastrophic reseed'.
1319 */
Theodore Ts'o6265e162013-10-03 01:08:15 -04001320static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1322{
Theodore Ts'ocff85032014-06-10 23:18:16 -04001323 if (!r->pull ||
1324 r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
1325 r->entropy_count > r->poolinfo->poolfracbits)
1326 return;
1327
Theodore Ts'ocff85032014-06-10 23:18:16 -04001328 _xfer_secondary_pool(r, nbytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001329}
Matt Mackall5a021e92007-07-19 11:30:14 -07001330
Theodore Ts'o6265e162013-10-03 01:08:15 -04001331static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1332{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 __u32 tmp[OUTPUT_POOL_WORDS];
1334
Theodore Ts'o6265e162013-10-03 01:08:15 -04001335 int bytes = nbytes;
Matt Mackall5a021e92007-07-19 11:30:14 -07001336
Greg Price2132a962013-12-06 21:28:03 -05001337 /* pull at least as much as a wakeup */
1338 bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001339 /* but never more than the buffer size */
1340 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001342 trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
1343 ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
Theodore Ts'o6265e162013-10-03 01:08:15 -04001344 bytes = extract_entropy(r->pull, tmp, bytes,
Stephan Müller43d8a722016-12-27 23:40:59 +01001345 random_read_wakeup_bits / 8, 0);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001346 mix_pool_bytes(r, tmp, bytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001347 credit_entropy_bits(r, bytes*8);
1348}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
Theodore Ts'o6265e162013-10-03 01:08:15 -04001350/*
1351 * Used as a workqueue function so that when the input pool is getting
1352 * full, we can "spill over" some entropy to the output pools. That
1353 * way the output pools can store some of the excess entropy instead
1354 * of letting it go to waste.
1355 */
1356static void push_to_pool(struct work_struct *work)
1357{
1358 struct entropy_store *r = container_of(work, struct entropy_store,
1359 push_work);
1360 BUG_ON(!r);
Greg Price2132a962013-12-06 21:28:03 -05001361 _xfer_secondary_pool(r, random_read_wakeup_bits/8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001362 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
1363 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364}
1365
1366/*
Greg Price19fa5be12013-11-29 15:50:06 -05001367 * This function decides how many bytes to actually take from the
1368 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370static size_t account(struct entropy_store *r, size_t nbytes, int min,
1371 int reserved)
1372{
Stephan Müller43d8a722016-12-27 23:40:59 +01001373 int entropy_count, orig, have_bytes;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001374 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001376 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377
1378 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001379retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -07001380 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001381 ibytes = nbytes;
Stephan Müller43d8a722016-12-27 23:40:59 +01001382 /* never pull more than available */
1383 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001384
Stephan Müller43d8a722016-12-27 23:40:59 +01001385 if ((have_bytes -= reserved) < 0)
1386 have_bytes = 0;
1387 ibytes = min_t(size_t, ibytes, have_bytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001388 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001389 ibytes = 0;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001390
1391 if (unlikely(entropy_count < 0)) {
1392 pr_warn("random: negative entropy count: pool %s count %d\n",
1393 r->name, entropy_count);
1394 WARN_ON(1);
1395 entropy_count = 0;
1396 }
1397 nfrac = ibytes << (ENTROPY_SHIFT + 3);
1398 if ((size_t) entropy_count > nfrac)
1399 entropy_count -= nfrac;
1400 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001401 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001402
Greg Price0fb7a012013-12-05 19:32:19 -05001403 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1404 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001406 trace_debit_entropy(r->name, 8 * ibytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001407 if (ibytes &&
Greg Price2132a962013-12-06 21:28:03 -05001408 (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001409 wake_up_interruptible(&random_write_wait);
Theodore Ts'ob9809552013-03-04 11:59:12 -05001410 kill_fasync(&fasync, SIGIO, POLL_OUT);
1411 }
1412
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001413 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414}
1415
Greg Price19fa5be12013-11-29 15:50:06 -05001416/*
1417 * This function does the actual extraction for extract_entropy and
1418 * extract_entropy_user.
1419 *
1420 * Note: we assume that .poolwords is a multiple of 16 words.
1421 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422static void extract_buf(struct entropy_store *r, __u8 *out)
1423{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001424 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001425 union {
1426 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001427 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001428 } hash;
1429 __u32 workspace[SHA_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001430 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001433 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001434 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001435 */
Theodore Ts'o46884442013-12-17 21:16:39 -05001436 sha_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001437 for (i = 0; i < LONGS(20); i++) {
1438 unsigned long v;
1439 if (!arch_get_random_long(&v))
1440 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001441 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001442 }
1443
Theodore Ts'o46884442013-12-17 21:16:39 -05001444 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1445 spin_lock_irqsave(&r->lock, flags);
1446 for (i = 0; i < r->poolinfo->poolwords; i += 16)
1447 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1448
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001449 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001450 * We mix the hash back into the pool to prevent backtracking
1451 * attacks (where the attacker knows the state of the pool
1452 * plus the current outputs, and attempts to find previous
1453 * ouputs), unless the hash function can be inverted. By
1454 * mixing at least a SHA1 worth of hash data back, we make
1455 * brute-forcing the feedback as hard as brute-forcing the
1456 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001458 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001459 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001460
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001461 memzero_explicit(workspace, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
1463 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001464 * In case the hash function has some recognizable output
1465 * pattern, we fold it in half. Thus, we always feed back
1466 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001468 hash.w[0] ^= hash.w[3];
1469 hash.w[1] ^= hash.w[4];
1470 hash.w[2] ^= rol32(hash.w[2], 16);
1471
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001472 memcpy(out, &hash, EXTRACT_SIZE);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001473 memzero_explicit(&hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474}
1475
Theodore Ts'oe192be92016-06-12 18:13:36 -04001476static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
1477 size_t nbytes, int fips)
1478{
1479 ssize_t ret = 0, i;
1480 __u8 tmp[EXTRACT_SIZE];
1481 unsigned long flags;
1482
1483 while (nbytes) {
1484 extract_buf(r, tmp);
1485
1486 if (fips) {
1487 spin_lock_irqsave(&r->lock, flags);
1488 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1489 panic("Hardware RNG duplicated output!\n");
1490 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1491 spin_unlock_irqrestore(&r->lock, flags);
1492 }
1493 i = min_t(int, nbytes, EXTRACT_SIZE);
1494 memcpy(buf, tmp, i);
1495 nbytes -= i;
1496 buf += i;
1497 ret += i;
1498 }
1499
1500 /* Wipe data just returned from memory */
1501 memzero_explicit(tmp, sizeof(tmp));
1502
1503 return ret;
1504}
1505
Greg Price19fa5be12013-11-29 15:50:06 -05001506/*
1507 * This function extracts randomness from the "entropy pool", and
1508 * returns it in a buffer.
1509 *
1510 * The min parameter specifies the minimum amount we can pull before
1511 * failing to avoid races that defeat catastrophic reseeding while the
1512 * reserved parameter indicates how much entropy we must leave in the
1513 * pool after each pull to avoid starving other readers.
1514 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001515static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001516 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001519 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001521 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001522 if (fips_enabled) {
1523 spin_lock_irqsave(&r->lock, flags);
1524 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001525 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001526 spin_unlock_irqrestore(&r->lock, flags);
1527 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001528 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001529 xfer_secondary_pool(r, EXTRACT_SIZE);
1530 extract_buf(r, tmp);
1531 spin_lock_irqsave(&r->lock, flags);
1532 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1533 }
1534 spin_unlock_irqrestore(&r->lock, flags);
1535 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001536
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001537 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 xfer_secondary_pool(r, nbytes);
1539 nbytes = account(r, nbytes, min, reserved);
1540
Theodore Ts'oe192be92016-06-12 18:13:36 -04001541 return _extract_entropy(r, buf, nbytes, fips_enabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542}
1543
Greg Price19fa5be12013-11-29 15:50:06 -05001544/*
1545 * This function extracts randomness from the "entropy pool", and
1546 * returns it in a userspace buffer.
1547 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1549 size_t nbytes)
1550{
1551 ssize_t ret = 0, i;
1552 __u8 tmp[EXTRACT_SIZE];
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001553 int large_request = (nbytes > 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001555 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 xfer_secondary_pool(r, nbytes);
1557 nbytes = account(r, nbytes, 0, 0);
1558
1559 while (nbytes) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001560 if (large_request && need_resched()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 if (signal_pending(current)) {
1562 if (ret == 0)
1563 ret = -ERESTARTSYS;
1564 break;
1565 }
1566 schedule();
1567 }
1568
1569 extract_buf(r, tmp);
1570 i = min_t(int, nbytes, EXTRACT_SIZE);
1571 if (copy_to_user(buf, tmp, i)) {
1572 ret = -EFAULT;
1573 break;
1574 }
1575
1576 nbytes -= i;
1577 buf += i;
1578 ret += i;
1579 }
1580
1581 /* Wipe data just returned from memory */
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001582 memzero_explicit(tmp, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
1584 return ret;
1585}
1586
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001587#define warn_unseeded_randomness(previous) \
1588 _warn_unseeded_randomness(__func__, (void *) _RET_IP_, (previous))
1589
1590static void _warn_unseeded_randomness(const char *func_name, void *caller,
1591 void **previous)
1592{
1593#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1594 const bool print_once = false;
1595#else
1596 static bool print_once __read_mostly;
1597#endif
1598
1599 if (print_once ||
1600 crng_ready() ||
1601 (previous && (caller == READ_ONCE(*previous))))
1602 return;
1603 WRITE_ONCE(*previous, caller);
1604#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1605 print_once = true;
1606#endif
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001607 if (__ratelimit(&unseeded_warning))
1608 pr_notice("random: %s called from %pS with crng_init=%d\n",
1609 func_name, caller, crng_init);
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001610}
1611
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612/*
1613 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001614 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001615 * TCP sequence numbers, etc. It does not rely on the hardware random
1616 * number generator. For random bytes direct from the hardware RNG
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001617 * (when available), use get_random_bytes_arch(). In order to ensure
1618 * that the randomness provided by this function is okay, the function
1619 * wait_for_random_bytes() should be called and return 0 at least once
1620 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 */
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001622static void _get_random_bytes(void *buf, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623{
Eric Biggers9f480fa2017-11-22 11:51:39 -08001624 __u32 tmp[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001625
Theodore Ts'o59108952013-09-12 14:10:25 -04001626 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001627
1628 while (nbytes >= CHACHA20_BLOCK_SIZE) {
1629 extract_crng(buf);
1630 buf += CHACHA20_BLOCK_SIZE;
1631 nbytes -= CHACHA20_BLOCK_SIZE;
1632 }
1633
1634 if (nbytes > 0) {
1635 extract_crng(tmp);
1636 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001637 crng_backtrack_protect(tmp, nbytes);
1638 } else
1639 crng_backtrack_protect(tmp, CHACHA20_BLOCK_SIZE);
1640 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001641}
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001642
1643void get_random_bytes(void *buf, int nbytes)
1644{
1645 static void *previous;
1646
1647 warn_unseeded_randomness(&previous);
1648 _get_random_bytes(buf, nbytes);
1649}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001650EXPORT_SYMBOL(get_random_bytes);
1651
1652/*
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001653 * Wait for the urandom pool to be seeded and thus guaranteed to supply
1654 * cryptographically secure random numbers. This applies to: the /dev/urandom
1655 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
1656 * family of functions. Using any of these functions without first calling
1657 * this function forfeits the guarantee of security.
1658 *
1659 * Returns: 0 if the urandom pool has been seeded.
1660 * -ERESTARTSYS if the function was interrupted by a signal.
1661 */
1662int wait_for_random_bytes(void)
1663{
1664 if (likely(crng_ready()))
1665 return 0;
1666 return wait_event_interruptible(crng_init_wait, crng_ready());
1667}
1668EXPORT_SYMBOL(wait_for_random_bytes);
1669
1670/*
Herbert Xu205a5252015-06-09 18:19:39 +08001671 * Add a callback function that will be invoked when the nonblocking
1672 * pool is initialised.
1673 *
1674 * returns: 0 if callback is successfully added
1675 * -EALREADY if pool is already initialised (callback not called)
1676 * -ENOENT if module for callback is not alive
1677 */
1678int add_random_ready_callback(struct random_ready_callback *rdy)
1679{
1680 struct module *owner;
1681 unsigned long flags;
1682 int err = -EALREADY;
1683
Theodore Ts'oe192be92016-06-12 18:13:36 -04001684 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001685 return err;
1686
1687 owner = rdy->owner;
1688 if (!try_module_get(owner))
1689 return -ENOENT;
1690
1691 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001692 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001693 goto out;
1694
1695 owner = NULL;
1696
1697 list_add(&rdy->list, &random_ready_list);
1698 err = 0;
1699
1700out:
1701 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1702
1703 module_put(owner);
1704
1705 return err;
1706}
1707EXPORT_SYMBOL(add_random_ready_callback);
1708
1709/*
1710 * Delete a previously registered readiness callback function.
1711 */
1712void del_random_ready_callback(struct random_ready_callback *rdy)
1713{
1714 unsigned long flags;
1715 struct module *owner = NULL;
1716
1717 spin_lock_irqsave(&random_ready_list_lock, flags);
1718 if (!list_empty(&rdy->list)) {
1719 list_del_init(&rdy->list);
1720 owner = rdy->owner;
1721 }
1722 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1723
1724 module_put(owner);
1725}
1726EXPORT_SYMBOL(del_random_ready_callback);
1727
1728/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001729 * This function will use the architecture-specific hardware random
1730 * number generator if it is available. The arch-specific hw RNG will
1731 * almost certainly be faster than what we can do in software, but it
1732 * is impossible to verify that it is implemented securely (as
1733 * opposed, to, say, the AES encryption of a sequence number using a
1734 * key known by the NSA). So it's useful if we need the speed, but
1735 * only if we're willing to trust the hardware manufacturer not to
1736 * have put in a back door.
Tobin C. Harding753d4332018-06-22 09:15:32 +10001737 *
1738 * Return number of bytes filled in.
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001739 */
Tobin C. Harding753d4332018-06-22 09:15:32 +10001740int __must_check get_random_bytes_arch(void *buf, int nbytes)
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001741{
Tobin C. Harding753d4332018-06-22 09:15:32 +10001742 int left = nbytes;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001743 char *p = buf;
1744
Tobin C. Harding753d4332018-06-22 09:15:32 +10001745 trace_get_random_bytes_arch(left, _RET_IP_);
1746 while (left) {
H. Peter Anvin63d77172011-07-31 13:54:50 -07001747 unsigned long v;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001748 int chunk = min_t(int, left, sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001749
H. Peter Anvin63d77172011-07-31 13:54:50 -07001750 if (!arch_get_random_long(&v))
1751 break;
Tobin C. Harding8ddd6ef2018-06-22 09:15:31 +10001752
Luck, Tonybd29e562011-11-16 10:50:56 -08001753 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001754 p += chunk;
Tobin C. Harding753d4332018-06-22 09:15:32 +10001755 left -= chunk;
H. Peter Anvin63d77172011-07-31 13:54:50 -07001756 }
1757
Tobin C. Harding753d4332018-06-22 09:15:32 +10001758 return nbytes - left;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001760EXPORT_SYMBOL(get_random_bytes_arch);
1761
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762/*
1763 * init_std_data - initialize pool with system data
1764 *
1765 * @r: pool to initialize
1766 *
1767 * This function clears the pool's entropy count and mixes some system
1768 * data into the pool to prepare it for use. The pool is not cleared
1769 * as that can only decrease the entropy in the pool.
1770 */
1771static void init_std_data(struct entropy_store *r)
1772{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001773 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001774 ktime_t now = ktime_get_real();
1775 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Theodore Ts'of5c27422013-09-22 15:14:32 -04001777 r->last_pulled = jiffies;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001778 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001779 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001780 if (!arch_get_random_seed_long(&rv) &&
1781 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001782 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001783 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001784 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001785 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786}
1787
Tony Luckcbc96b72012-07-23 09:47:57 -07001788/*
1789 * Note that setup_arch() may call add_device_randomness()
1790 * long before we get here. This allows seeding of the pools
1791 * with some platform dependent data very early in the boot
1792 * process. But it limits our options here. We must use
1793 * statically allocated structures that already have all
1794 * initializations complete at compile time. We should also
1795 * take care not to overwrite the precious per platform data
1796 * we were given.
1797 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001798static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799{
1800 init_std_data(&input_pool);
1801 init_std_data(&blocking_pool);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001802 crng_initialize(&primary_crng);
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001803 crng_global_init_time = jiffies;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001804 if (ratelimit_disable) {
1805 urandom_warning.interval = 0;
1806 unseeded_warning.interval = 0;
1807 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 return 0;
1809}
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001810early_initcall(rand_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
David Howells93614012006-09-30 20:45:40 +02001812#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813void rand_initialize_disk(struct gendisk *disk)
1814{
1815 struct timer_rand_state *state;
1816
1817 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001818 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 * source.
1820 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001821 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001822 if (state) {
1823 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001825 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826}
David Howells93614012006-09-30 20:45:40 +02001827#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828
1829static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001830_random_read(int nonblock, char __user *buf, size_t nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831{
Greg Price12ff3a52013-11-29 15:02:33 -05001832 ssize_t n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833
1834 if (nbytes == 0)
1835 return 0;
1836
Greg Price12ff3a52013-11-29 15:02:33 -05001837 nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1838 while (1) {
1839 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1840 if (n < 0)
1841 return n;
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001842 trace_random_read(n*8, (nbytes-n)*8,
1843 ENTROPY_BITS(&blocking_pool),
1844 ENTROPY_BITS(&input_pool));
Greg Price12ff3a52013-11-29 15:02:33 -05001845 if (n > 0)
1846 return n;
H. Peter Anvin331c6492014-03-17 16:36:29 -07001847
Greg Price12ff3a52013-11-29 15:02:33 -05001848 /* Pool is (near) empty. Maybe wait and retry. */
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001849 if (nonblock)
Greg Price12ff3a52013-11-29 15:02:33 -05001850 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001852 wait_event_interruptible(random_read_wait,
Greg Price12ff3a52013-11-29 15:02:33 -05001853 ENTROPY_BITS(&input_pool) >=
Greg Price2132a962013-12-06 21:28:03 -05001854 random_read_wakeup_bits);
Greg Price12ff3a52013-11-29 15:02:33 -05001855 if (signal_pending(current))
1856 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858}
1859
1860static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001861random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1862{
1863 return _random_read(file->f_flags & O_NONBLOCK, buf, nbytes);
1864}
1865
1866static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001867urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001869 unsigned long flags;
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001870 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05001871 int ret;
1872
Theodore Ts'oe192be92016-06-12 18:13:36 -04001873 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001874 maxwarn--;
Theodore Ts'o4e00b332018-04-25 01:12:32 -04001875 if (__ratelimit(&urandom_warning))
1876 printk(KERN_NOTICE "random: %s: uninitialized "
1877 "urandom read (%zd bytes read)\n",
1878 current->comm, nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001879 spin_lock_irqsave(&primary_crng.lock, flags);
1880 crng_init_cnt = 0;
1881 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001882 }
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001883 nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
Theodore Ts'oe192be92016-06-12 18:13:36 -04001884 ret = extract_crng_user(buf, nbytes);
1885 trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001886 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887}
1888
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001889static __poll_t
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001890random_poll(struct file *file, poll_table * wait)
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001891{
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001892 __poll_t mask;
Christoph Hellwig89b310a2018-04-09 15:29:32 +02001893
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001894 poll_wait(file, &random_read_wait, wait);
1895 poll_wait(file, &random_write_wait, wait);
1896 mask = 0;
Greg Price2132a962013-12-06 21:28:03 -05001897 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001898 mask |= EPOLLIN | EPOLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05001899 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001900 mask |= EPOLLOUT | EPOLLWRNORM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 return mask;
1902}
1903
Matt Mackall7f397dc2007-05-29 21:58:10 -05001904static int
1905write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1906{
1907 size_t bytes;
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001908 __u32 t, buf[16];
Matt Mackall7f397dc2007-05-29 21:58:10 -05001909 const char __user *p = buffer;
1910
1911 while (count > 0) {
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001912 int b, i = 0;
1913
Matt Mackall7f397dc2007-05-29 21:58:10 -05001914 bytes = min(count, sizeof(buf));
1915 if (copy_from_user(&buf, p, bytes))
1916 return -EFAULT;
1917
Theodore Ts'o81e69df2018-07-14 23:55:57 -04001918 for (b = bytes ; b > 0 ; b -= sizeof(__u32), i++) {
1919 if (!arch_get_random_int(&t))
1920 break;
1921 buf[i] ^= t;
1922 }
1923
Matt Mackall7f397dc2007-05-29 21:58:10 -05001924 count -= bytes;
1925 p += bytes;
1926
Theodore Ts'o85608f82014-06-10 23:09:20 -04001927 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001928 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001929 }
1930
1931 return 0;
1932}
1933
Matt Mackall90b75ee2008-04-29 01:02:55 -07001934static ssize_t random_write(struct file *file, const char __user *buffer,
1935 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001937 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938
Theodore Ts'oe192be92016-06-12 18:13:36 -04001939 ret = write_pool(&input_pool, buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05001940 if (ret)
1941 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942
Matt Mackall7f397dc2007-05-29 21:58:10 -05001943 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944}
1945
Matt Mackall43ae4862008-04-29 01:02:58 -07001946static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947{
1948 int size, ent_count;
1949 int __user *p = (int __user *)arg;
1950 int retval;
1951
1952 switch (cmd) {
1953 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001954 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001955 ent_count = ENTROPY_BITS(&input_pool);
1956 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 return -EFAULT;
1958 return 0;
1959 case RNDADDTOENTCNT:
1960 if (!capable(CAP_SYS_ADMIN))
1961 return -EPERM;
1962 if (get_user(ent_count, p))
1963 return -EFAULT;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001964 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 case RNDADDENTROPY:
1966 if (!capable(CAP_SYS_ADMIN))
1967 return -EPERM;
1968 if (get_user(ent_count, p++))
1969 return -EFAULT;
1970 if (ent_count < 0)
1971 return -EINVAL;
1972 if (get_user(size, p++))
1973 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001974 retval = write_pool(&input_pool, (const char __user *)p,
1975 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976 if (retval < 0)
1977 return retval;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001978 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 case RNDZAPENTCNT:
1980 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001981 /*
1982 * Clear the entropy pool counters. We no longer clear
1983 * the entropy pool, as that's silly.
1984 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 if (!capable(CAP_SYS_ADMIN))
1986 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001987 input_pool.entropy_count = 0;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001988 blocking_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 return 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001990 case RNDRESEEDCRNG:
1991 if (!capable(CAP_SYS_ADMIN))
1992 return -EPERM;
1993 if (crng_init < 2)
1994 return -ENODATA;
1995 crng_reseed(&primary_crng, NULL);
1996 crng_global_init_time = jiffies - 1;
1997 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998 default:
1999 return -EINVAL;
2000 }
2001}
2002
Jeff Dike9a6f70b2008-04-29 01:03:08 -07002003static int random_fasync(int fd, struct file *filp, int on)
2004{
2005 return fasync_helper(fd, filp, on, &fasync);
2006}
2007
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08002008const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 .read = random_read,
2010 .write = random_write,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07002011 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07002012 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07002013 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002014 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015};
2016
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08002017const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 .read = urandom_read,
2019 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07002020 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07002021 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002022 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023};
2024
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002025SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
2026 unsigned int, flags)
2027{
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002028 int ret;
2029
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002030 if (flags & ~(GRND_NONBLOCK|GRND_RANDOM))
2031 return -EINVAL;
2032
2033 if (count > INT_MAX)
2034 count = INT_MAX;
2035
2036 if (flags & GRND_RANDOM)
2037 return _random_read(flags & GRND_NONBLOCK, buf, count);
2038
Theodore Ts'oe192be92016-06-12 18:13:36 -04002039 if (!crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002040 if (flags & GRND_NONBLOCK)
2041 return -EAGAIN;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002042 ret = wait_for_random_bytes();
2043 if (unlikely(ret))
2044 return ret;
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04002045 }
2046 return urandom_read(NULL, buf, count, NULL);
2047}
2048
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049/********************************************************************
2050 *
2051 * Sysctl interface
2052 *
2053 ********************************************************************/
2054
2055#ifdef CONFIG_SYSCTL
2056
2057#include <linux/sysctl.h>
2058
2059static int min_read_thresh = 8, min_write_thresh;
Greg Price8c2aa332013-12-05 19:19:29 -05002060static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061static int max_write_thresh = INPUT_POOL_WORDS * 32;
Fabio Estevamdb61ffe2017-01-31 14:36:07 -02002062static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063static char sysctl_bootid[16];
2064
2065/*
Greg Pricef22052b2013-11-29 14:58:16 -05002066 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 * UUID. The difference is in whether table->data is NULL; if it is,
2068 * then a new UUID is generated and returned to the user.
2069 *
Greg Pricef22052b2013-11-29 14:58:16 -05002070 * If the user accesses this via the proc interface, the UUID will be
2071 * returned as an ASCII string in the standard UUID format; if via the
2072 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 */
Joe Perchesa1514272013-06-13 19:37:35 -07002074static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 void __user *buffer, size_t *lenp, loff_t *ppos)
2076{
Joe Perchesa1514272013-06-13 19:37:35 -07002077 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 unsigned char buf[64], tmp_uuid[16], *uuid;
2079
2080 uuid = table->data;
2081 if (!uuid) {
2082 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07002084 } else {
2085 static DEFINE_SPINLOCK(bootid_spinlock);
2086
2087 spin_lock(&bootid_spinlock);
2088 if (!uuid[8])
2089 generate_random_uuid(uuid);
2090 spin_unlock(&bootid_spinlock);
2091 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092
Joe Perches35900772009-12-14 18:01:11 -08002093 sprintf(buf, "%pU", uuid);
2094
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 fake_table.data = buf;
2096 fake_table.maxlen = sizeof(buf);
2097
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002098 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099}
2100
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002101/*
2102 * Return entropy available scaled to integral bits
2103 */
Joe Perches5eb10d92014-06-06 14:37:58 -07002104static int proc_do_entropy(struct ctl_table *table, int write,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002105 void __user *buffer, size_t *lenp, loff_t *ppos)
2106{
Joe Perches5eb10d92014-06-06 14:37:58 -07002107 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002108 int entropy_count;
2109
2110 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
2111
2112 fake_table.data = &entropy_count;
2113 fake_table.maxlen = sizeof(entropy_count);
2114
2115 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
2116}
2117
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07002119extern struct ctl_table random_table[];
2120struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 .procname = "poolsize",
2123 .data = &sysctl_poolsize,
2124 .maxlen = sizeof(int),
2125 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002126 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 },
2128 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 .procname = "entropy_avail",
2130 .maxlen = sizeof(int),
2131 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002132 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 .data = &input_pool.entropy_count,
2134 },
2135 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 .procname = "read_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002137 .data = &random_read_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 .maxlen = sizeof(int),
2139 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002140 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 .extra1 = &min_read_thresh,
2142 .extra2 = &max_read_thresh,
2143 },
2144 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002146 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 .maxlen = sizeof(int),
2148 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002149 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 .extra1 = &min_write_thresh,
2151 .extra2 = &max_write_thresh,
2152 },
2153 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002154 .procname = "urandom_min_reseed_secs",
2155 .data = &random_min_urandom_seed,
2156 .maxlen = sizeof(int),
2157 .mode = 0644,
2158 .proc_handler = proc_dointvec,
2159 },
2160 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 .procname = "boot_id",
2162 .data = &sysctl_bootid,
2163 .maxlen = 16,
2164 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002165 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 },
2167 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 .procname = "uuid",
2169 .maxlen = 16,
2170 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002171 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002173#ifdef ADD_INTERRUPT_BENCH
2174 {
2175 .procname = "add_interrupt_avg_cycles",
2176 .data = &avg_cycles,
2177 .maxlen = sizeof(avg_cycles),
2178 .mode = 0444,
2179 .proc_handler = proc_doulongvec_minmax,
2180 },
2181 {
2182 .procname = "add_interrupt_avg_deviation",
2183 .data = &avg_deviation,
2184 .maxlen = sizeof(avg_deviation),
2185 .mode = 0444,
2186 .proc_handler = proc_doulongvec_minmax,
2187 },
2188#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002189 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190};
2191#endif /* CONFIG_SYSCTL */
2192
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002193struct batched_entropy {
2194 union {
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002195 u64 entropy_u64[CHACHA20_BLOCK_SIZE / sizeof(u64)];
2196 u32 entropy_u32[CHACHA20_BLOCK_SIZE / sizeof(u32)];
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002197 };
2198 unsigned int position;
2199};
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002200static rwlock_t batched_entropy_reset_lock = __RW_LOCK_UNLOCKED(batched_entropy_reset_lock);
Eric Biggersb1132de2016-05-04 21:08:39 -04002201
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202/*
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002203 * Get a random word for internal kernel use only. The quality of the random
2204 * number is either as good as RDRAND or as good as /dev/urandom, with the
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002205 * goal of being quite fast and not depleting entropy. In order to ensure
2206 * that the randomness provided by this function is okay, the function
2207 * wait_for_random_bytes() should be called and return 0 at least once
2208 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 */
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002210static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64);
2211u64 get_random_u64(void)
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002212{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002213 u64 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002214 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002215 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002216 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002217 static void *previous;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002218
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002219#if BITS_PER_LONG == 64
2220 if (arch_get_random_long((unsigned long *)&ret))
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002221 return ret;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002222#else
2223 if (arch_get_random_long((unsigned long *)&ret) &&
2224 arch_get_random_long((unsigned long *)&ret + 1))
2225 return ret;
2226#endif
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002227
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002228 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002229
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002230 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002231 batch = &get_cpu_var(batched_entropy_u64);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002232 if (use_lock)
2233 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002234 if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
Eric Biggers9f480fa2017-11-22 11:51:39 -08002235 extract_crng((__u32 *)batch->entropy_u64);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002236 batch->position = 0;
2237 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002238 ret = batch->entropy_u64[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002239 if (use_lock)
2240 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002241 put_cpu_var(batched_entropy_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002242 return ret;
2243}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002244EXPORT_SYMBOL(get_random_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002245
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002246static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32);
2247u32 get_random_u32(void)
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002248{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002249 u32 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002250 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002251 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002252 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002253 static void *previous;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002254
2255 if (arch_get_random_int(&ret))
2256 return ret;
2257
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002258 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002259
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002260 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002261 batch = &get_cpu_var(batched_entropy_u32);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002262 if (use_lock)
2263 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002264 if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
Eric Biggers9f480fa2017-11-22 11:51:39 -08002265 extract_crng(batch->entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002266 batch->position = 0;
2267 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002268 ret = batch->entropy_u32[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002269 if (use_lock)
2270 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002271 put_cpu_var(batched_entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002272 return ret;
2273}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002274EXPORT_SYMBOL(get_random_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002275
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002276/* It's important to invalidate all potential batched entropy that might
2277 * be stored before the crng is initialized, which we can do lazily by
2278 * simply resetting the counter to zero so that it's re-extracted on the
2279 * next usage. */
2280static void invalidate_batched_entropy(void)
2281{
2282 int cpu;
2283 unsigned long flags;
2284
2285 write_lock_irqsave(&batched_entropy_reset_lock, flags);
2286 for_each_possible_cpu (cpu) {
2287 per_cpu_ptr(&batched_entropy_u32, cpu)->position = 0;
2288 per_cpu_ptr(&batched_entropy_u64, cpu)->position = 0;
2289 }
2290 write_unlock_irqrestore(&batched_entropy_reset_lock, flags);
2291}
2292
Jason Cooper99fdafd2016-10-11 13:53:52 -07002293/**
2294 * randomize_page - Generate a random, page aligned address
2295 * @start: The smallest acceptable address the caller will take.
2296 * @range: The size of the area, starting at @start, within which the
2297 * random address must fall.
2298 *
2299 * If @start + @range would overflow, @range is capped.
2300 *
2301 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2302 * @start was already page aligned. We now align it regardless.
2303 *
2304 * Return: A page aligned address within [start, start + range). On error,
2305 * @start is returned.
2306 */
2307unsigned long
2308randomize_page(unsigned long start, unsigned long range)
2309{
2310 if (!PAGE_ALIGNED(start)) {
2311 range -= PAGE_ALIGN(start) - start;
2312 start = PAGE_ALIGN(start);
2313 }
2314
2315 if (start > ULONG_MAX - range)
2316 range = ULONG_MAX - start;
2317
2318 range >>= PAGE_SHIFT;
2319
2320 if (range == 0)
2321 return start;
2322
2323 return start + (get_random_long() % range << PAGE_SHIFT);
2324}
2325
Torsten Duwec84dbf62014-06-14 23:38:36 -04002326/* Interface for in-kernel drivers of true hardware RNGs.
2327 * Those devices may produce endless random bits and will be throttled
2328 * when our pool is full.
2329 */
2330void add_hwgenerator_randomness(const char *buffer, size_t count,
2331 size_t entropy)
2332{
2333 struct entropy_store *poolp = &input_pool;
2334
Theodore Ts'o43838a22018-04-11 13:27:52 -04002335 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04002336 crng_fast_load(buffer, count);
2337 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002338 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002339
2340 /* Suspend writing if we're above the trickle threshold.
2341 * We'll be woken up again once below random_write_wakeup_thresh,
2342 * or when the calling thread is about to terminate.
2343 */
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07002344 wait_event_interruptible(random_write_wait, kthread_should_stop() ||
Theodore Ts'oe192be92016-06-12 18:13:36 -04002345 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002346 mix_pool_bytes(poolp, buffer, count);
2347 credit_entropy_bits(poolp, entropy);
2348}
2349EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);