blob: 721dca8db9cfe823ff611c4e2a8445c4ff2b8f46 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * random.c -- A strong random number generator
3 *
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04004 * Copyright (C) 2017 Jason A. Donenfeld <Jason@zx2c4.com>. All
5 * Rights Reserved.
6 *
Matt Mackall9e95ce22005-04-16 15:25:56 -07007 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
10 * rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, and the entire permission notice in its entirety,
17 * including the disclaimer of warranties.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. The name of the author may not be used to endorse or promote
22 * products derived from this software without specific prior
23 * written permission.
24 *
25 * ALTERNATIVELY, this product may be distributed under the terms of
26 * the GNU General Public License, in which case the provisions of the GPL are
27 * required INSTEAD OF the above restrictions. (This clause is
28 * necessary due to a potential bad interaction between the GPL and
29 * the restrictions contained in a BSD-style copyright.)
30 *
31 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
32 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
34 * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
35 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
37 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
38 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
41 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
42 * DAMAGE.
43 */
44
45/*
46 * (now, with legal B.S. out of the way.....)
47 *
48 * This routine gathers environmental noise from device drivers, etc.,
49 * and returns good random numbers, suitable for cryptographic use.
50 * Besides the obvious cryptographic uses, these numbers are also good
51 * for seeding TCP sequence numbers, and other places where it is
52 * desirable to have numbers which are not only random, but hard to
53 * predict by an attacker.
54 *
55 * Theory of operation
56 * ===================
57 *
58 * Computers are very predictable devices. Hence it is extremely hard
59 * to produce truly random numbers on a computer --- as opposed to
60 * pseudo-random numbers, which can easily generated by using a
61 * algorithm. Unfortunately, it is very easy for attackers to guess
62 * the sequence of pseudo-random number generators, and for some
63 * applications this is not acceptable. So instead, we must try to
64 * gather "environmental noise" from the computer's environment, which
65 * must be hard for outside attackers to observe, and use that to
66 * generate random numbers. In a Unix environment, this is best done
67 * from inside the kernel.
68 *
69 * Sources of randomness from the environment include inter-keyboard
70 * timings, inter-interrupt timings from some interrupts, and other
71 * events which are both (a) non-deterministic and (b) hard for an
72 * outside observer to measure. Randomness from these sources are
73 * added to an "entropy pool", which is mixed using a CRC-like function.
74 * This is not cryptographically strong, but it is adequate assuming
75 * the randomness is not chosen maliciously, and it is fast enough that
76 * the overhead of doing it on every interrupt is very reasonable.
77 * As random bytes are mixed into the entropy pool, the routines keep
78 * an *estimate* of how many bits of randomness have been stored into
79 * the random number generator's internal state.
80 *
81 * When random bytes are desired, they are obtained by taking the SHA
82 * hash of the contents of the "entropy pool". The SHA hash avoids
83 * exposing the internal state of the entropy pool. It is believed to
84 * be computationally infeasible to derive any useful information
85 * about the input of SHA from its output. Even if it is possible to
86 * analyze SHA in some clever way, as long as the amount of data
87 * returned from the generator is less than the inherent entropy in
88 * the pool, the output data is totally unpredictable. For this
89 * reason, the routine decreases its internal estimate of how many
90 * bits of "true randomness" are contained in the entropy pool as it
91 * outputs random numbers.
92 *
93 * If this estimate goes to zero, the routine can still generate
94 * random numbers; however, an attacker may (at least in theory) be
95 * able to infer the future output of the generator from prior
96 * outputs. This requires successful cryptanalysis of SHA, which is
97 * not believed to be feasible, but there is a remote possibility.
98 * Nonetheless, these numbers should be useful for the vast majority
99 * of purposes.
100 *
101 * Exported interfaces ---- output
102 * ===============================
103 *
104 * There are three exported interfaces; the first is one designed to
105 * be used from within the kernel:
106 *
107 * void get_random_bytes(void *buf, int nbytes);
108 *
109 * This interface will return the requested number of random bytes,
110 * and place it in the requested buffer.
111 *
112 * The two other interfaces are two character devices /dev/random and
113 * /dev/urandom. /dev/random is suitable for use when very high
114 * quality randomness is desired (for example, for key generation or
115 * one-time pads), as it will only return a maximum of the number of
116 * bits of randomness (as estimated by the random number generator)
117 * contained in the entropy pool.
118 *
119 * The /dev/urandom device does not have this limit, and will return
120 * as many bytes as are requested. As more and more random bytes are
121 * requested without giving time for the entropy pool to recharge,
122 * this will result in random numbers that are merely cryptographically
123 * strong. For many applications, however, this is acceptable.
124 *
125 * Exported interfaces ---- input
126 * ==============================
127 *
128 * The current exported interfaces for gathering environmental noise
129 * from the devices are:
130 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400131 * void add_device_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * void add_input_randomness(unsigned int type, unsigned int code,
133 * unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400134 * void add_interrupt_randomness(int irq, int irq_flags);
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100135 * void add_disk_randomness(struct gendisk *disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400137 * add_device_randomness() is for adding data to the random pool that
138 * is likely to differ between two devices (or possibly even per boot).
139 * This would be things like MAC addresses or serial numbers, or the
140 * read-out of the RTC. This does *not* add any actual entropy to the
141 * pool, but it initializes the pool to different values for devices
142 * that might otherwise be identical and have very little entropy
143 * available to them (particularly common in the embedded world).
144 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 * add_input_randomness() uses the input layer interrupt timing, as well as
146 * the event type information from the hardware.
147 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400148 * add_interrupt_randomness() uses the interrupt timing as random
149 * inputs to the entropy pool. Using the cycle counters and the irq source
150 * as inputs, it feeds the randomness roughly once a second.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100151 *
152 * add_disk_randomness() uses what amounts to the seek time of block
153 * layer request events, on a per-disk_devt basis, as input to the
154 * entropy pool. Note that high-speed solid state drives with very low
155 * seek times do not make for good sources of entropy, as their seek
156 * times are usually fairly consistent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 *
158 * All of these routines try to estimate how many bits of randomness a
159 * particular randomness source. They do this by keeping track of the
160 * first and second order deltas of the event timings.
161 *
162 * Ensuring unpredictability at system startup
163 * ============================================
164 *
165 * When any operating system starts up, it will go through a sequence
166 * of actions that are fairly predictable by an adversary, especially
167 * if the start-up does not involve interaction with a human operator.
168 * This reduces the actual number of bits of unpredictability in the
169 * entropy pool below the value in entropy_count. In order to
170 * counteract this effect, it helps to carry information in the
171 * entropy pool across shut-downs and start-ups. To do this, put the
172 * following lines an appropriate script which is run during the boot
173 * sequence:
174 *
175 * echo "Initializing random number generator..."
176 * random_seed=/var/run/random-seed
177 * # Carry a random seed from start-up to start-up
178 * # Load and then save the whole entropy pool
179 * if [ -f $random_seed ]; then
180 * cat $random_seed >/dev/urandom
181 * else
182 * touch $random_seed
183 * fi
184 * chmod 600 $random_seed
185 * dd if=/dev/urandom of=$random_seed count=1 bs=512
186 *
187 * and the following lines in an appropriate script which is run as
188 * the system is shutdown:
189 *
190 * # Carry a random seed from shut-down to start-up
191 * # Save the whole entropy pool
192 * echo "Saving random seed..."
193 * random_seed=/var/run/random-seed
194 * touch $random_seed
195 * chmod 600 $random_seed
196 * dd if=/dev/urandom of=$random_seed count=1 bs=512
197 *
198 * For example, on most modern systems using the System V init
199 * scripts, such code fragments would be found in
200 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
201 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
202 *
203 * Effectively, these commands cause the contents of the entropy pool
204 * to be saved at shut-down time and reloaded into the entropy pool at
205 * start-up. (The 'dd' in the addition to the bootup script is to
206 * make sure that /etc/random-seed is different for every start-up,
207 * even if the system crashes without executing rc.0.) Even with
208 * complete knowledge of the start-up activities, predicting the state
209 * of the entropy pool requires knowledge of the previous history of
210 * the system.
211 *
212 * Configuring the /dev/random driver under Linux
213 * ==============================================
214 *
215 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
216 * the /dev/mem major number (#1). So if your system does not have
217 * /dev/random and /dev/urandom created already, they can be created
218 * by using the commands:
219 *
220 * mknod /dev/random c 1 8
221 * mknod /dev/urandom c 1 9
222 *
223 * Acknowledgements:
224 * =================
225 *
226 * Ideas for constructing this random number generator were derived
227 * from Pretty Good Privacy's random number generator, and from private
228 * discussions with Phil Karn. Colin Plumb provided a faster random
229 * number generator, which speed up the mixing function of the entropy
230 * pool, taken from PGPfone. Dale Worley has also contributed many
231 * useful ideas and suggestions to improve this driver.
232 *
233 * Any flaws in the design are solely my responsibility, and should
234 * not be attributed to the Phil, Colin, or any of authors of PGP.
235 *
236 * Further background information on this topic may be obtained from
237 * RFC 1750, "Randomness Recommendations for Security", by Donald
238 * Eastlake, Steve Crocker, and Jeff Schiller.
239 */
240
241#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242#include <linux/module.h>
243#include <linux/kernel.h>
244#include <linux/major.h>
245#include <linux/string.h>
246#include <linux/fcntl.h>
247#include <linux/slab.h>
248#include <linux/random.h>
249#include <linux/poll.h>
250#include <linux/init.h>
251#include <linux/fs.h>
252#include <linux/genhd.h>
253#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700254#include <linux/mm.h>
Michael Ellermandd0f0cf2016-07-31 00:23:08 +1000255#include <linux/nodemask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256#include <linux/spinlock.h>
Torsten Duwec84dbf62014-06-14 23:38:36 -0400257#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#include <linux/percpu.h>
259#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800260#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400261#include <linux/ptrace.h>
Theodore Ts'o6265e162013-10-03 01:08:15 -0400262#include <linux/workqueue.h>
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200263#include <linux/irq.h>
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -0400264#include <linux/syscalls.h>
265#include <linux/completion.h>
Andy Shevchenko8da4b8c2016-05-20 17:01:00 -0700266#include <linux/uuid.h>
Theodore Ts'oe192be92016-06-12 18:13:36 -0400267#include <crypto/chacha20.h>
Yinghai Lud178a1e2009-01-11 00:35:42 -0800268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269#include <asm/processor.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800270#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400272#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273#include <asm/io.h>
274
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400275#define CREATE_TRACE_POINTS
276#include <trace/events/random.h>
277
Theodore Ts'o43759d42014-06-14 21:43:13 -0400278/* #define ADD_INTERRUPT_BENCH */
279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280/*
281 * Configuration information
282 */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400283#define INPUT_POOL_SHIFT 12
284#define INPUT_POOL_WORDS (1 << (INPUT_POOL_SHIFT-5))
285#define OUTPUT_POOL_SHIFT 10
286#define OUTPUT_POOL_WORDS (1 << (OUTPUT_POOL_SHIFT-5))
287#define SEC_XFER_SIZE 512
288#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400291#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293/*
Theodore Ts'o95b709b2013-10-02 21:10:35 -0400294 * To allow fractional bits to be tracked, the entropy_count field is
295 * denominated in units of 1/8th bits.
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400296 *
297 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
298 * credit_entropy_bits() needs to be 64 bits wide.
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400299 */
300#define ENTROPY_SHIFT 3
301#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)
302
303/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 * The minimum number of bits of entropy before we wake up a read on
305 * /dev/random. Should be enough to do a significant reseed.
306 */
Greg Price2132a962013-12-06 21:28:03 -0500307static int random_read_wakeup_bits = 64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309/*
310 * If the entropy count falls under this number of bits, then we
311 * should wake up processes which are selecting or polling on write
312 * access to /dev/random.
313 */
Greg Price2132a962013-12-06 21:28:03 -0500314static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
316/*
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400317 * Originally, we used a primitive polynomial of degree .poolwords
318 * over GF(2). The taps for various sizes are defined below. They
319 * were chosen to be evenly spaced except for the last tap, which is 1
320 * to get the twisting happening as fast as possible.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400322 * For the purposes of better mixing, we use the CRC-32 polynomial as
323 * well to make a (modified) twisted Generalized Feedback Shift
324 * Register. (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR
325 * generators. ACM Transactions on Modeling and Computer Simulation
326 * 2(3):179-194. Also see M. Matsumoto & Y. Kurita, 1994. Twisted
Greg Pricedfd38752013-11-29 14:58:06 -0500327 * GFSR generators II. ACM Transactions on Modeling and Computer
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400328 * Simulation 4:254-266)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 *
330 * Thanks to Colin Plumb for suggesting this.
331 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400332 * The mixing operation is much less sensitive than the output hash,
333 * where we use SHA-1. All that we want of mixing operation is that
334 * it be a good non-cryptographic hash; i.e. it not produce collisions
335 * when fed "random" data of the sort we expect to see. As long as
336 * the pool state differs for different inputs, we have preserved the
337 * input entropy and done a good job. The fact that an intelligent
338 * attacker can construct inputs that will produce controlled
339 * alterations to the pool's state is not important because we don't
340 * consider such inputs to contribute any randomness. The only
341 * property we need with respect to them is that the attacker can't
342 * increase his/her knowledge of the pool's state. Since all
343 * additions are reversible (knowing the final state and the input,
344 * you can reconstruct the initial state), if an attacker has any
345 * uncertainty about the initial state, he/she can only shuffle that
346 * uncertainty about, but never cause any collisions (which would
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 * decrease the uncertainty).
348 *
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400349 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
350 * Videau in their paper, "The Linux Pseudorandom Number Generator
351 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf). In their
352 * paper, they point out that we are not using a true Twisted GFSR,
353 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
354 * is, with only three taps, instead of the six that we are using).
355 * As a result, the resulting polynomial is neither primitive nor
356 * irreducible, and hence does not have a maximal period over
357 * GF(2**32). They suggest a slight change to the generator
358 * polynomial which improves the resulting TGFSR polynomial to be
359 * irreducible, which we have made here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361static struct poolinfo {
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400362 int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
363#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 int tap1, tap2, tap3, tap4, tap5;
365} poolinfo_table[] = {
Theodore Ts'o6e9fa2c2013-09-22 16:04:19 -0400366 /* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
367 /* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
368 { S(128), 104, 76, 51, 25, 1 },
369 /* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
370 /* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
371 { S(32), 26, 19, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372#if 0
373 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400374 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400377 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
379 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400380 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
382 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400383 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
385 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400386 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400388 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400391 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400394 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
396 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400397 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398#endif
399};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401/*
402 * Static global variables
403 */
404static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
405static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700406static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Herbert Xu205a5252015-06-09 18:19:39 +0800408static DEFINE_SPINLOCK(random_ready_list_lock);
409static LIST_HEAD(random_ready_list);
410
Theodore Ts'oe192be92016-06-12 18:13:36 -0400411struct crng_state {
412 __u32 state[16];
413 unsigned long init_time;
414 spinlock_t lock;
415};
416
417struct crng_state primary_crng = {
418 .lock = __SPIN_LOCK_UNLOCKED(primary_crng.lock),
419};
420
421/*
422 * crng_init = 0 --> Uninitialized
423 * 1 --> Initialized
424 * 2 --> Initialized from input_pool
425 *
426 * crng_init is protected by primary_crng->lock, and only increases
427 * its value (from 0->1->2).
428 */
429static int crng_init = 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400430#define crng_ready() (likely(crng_init > 1))
Theodore Ts'oe192be92016-06-12 18:13:36 -0400431static int crng_init_cnt = 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400432static unsigned long crng_global_init_time = 0;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400433#define CRNG_INIT_CNT_THRESH (2*CHACHA20_KEY_SIZE)
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400434static void _extract_crng(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800435 __u32 out[CHACHA20_BLOCK_WORDS]);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400436static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800437 __u32 tmp[CHACHA20_BLOCK_WORDS], int used);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400438static void process_random_ready_list(void);
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400439static void _get_random_bytes(void *buf, int nbytes);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400440
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441/**********************************************************************
442 *
443 * OS independent entropy store. Here are the functions which handle
444 * storing entropy in an entropy pool.
445 *
446 **********************************************************************/
447
448struct entropy_store;
449struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700450 /* read-only data: */
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400451 const struct poolinfo *poolinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 __u32 *pool;
453 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 struct entropy_store *pull;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400455 struct work_struct push_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457 /* read-write data: */
Theodore Ts'of5c27422013-09-22 15:14:32 -0400458 unsigned long last_pulled;
Matt Mackall43358202008-04-29 01:03:01 -0700459 spinlock_t lock;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400460 unsigned short add_ptr;
461 unsigned short input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800462 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400463 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400464 unsigned int initialized:1;
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400465 unsigned int last_data_init:1;
Matt Mackalle954bc92010-05-20 19:55:01 +1000466 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467};
468
Theodore Ts'oe192be92016-06-12 18:13:36 -0400469static ssize_t extract_entropy(struct entropy_store *r, void *buf,
470 size_t nbytes, int min, int rsvd);
471static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
472 size_t nbytes, int fips);
473
474static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400475static void push_to_pool(struct work_struct *work);
Emese Revfy0766f782016-06-20 20:42:34 +0200476static __u32 input_pool_data[INPUT_POOL_WORDS] __latent_entropy;
477static __u32 blocking_pool_data[OUTPUT_POOL_WORDS] __latent_entropy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
479static struct entropy_store input_pool = {
480 .poolinfo = &poolinfo_table[0],
481 .name = "input",
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200482 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 .pool = input_pool_data
484};
485
486static struct entropy_store blocking_pool = {
487 .poolinfo = &poolinfo_table[1],
488 .name = "blocking",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200490 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Theodore Ts'o6265e162013-10-03 01:08:15 -0400491 .pool = blocking_pool_data,
492 .push_work = __WORK_INITIALIZER(blocking_pool.push_work,
493 push_to_pool),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494};
495
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400496static __u32 const twist_table[8] = {
497 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
498 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700501 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700503 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 *
505 * The pool is stirred with a primitive polynomial of the appropriate
506 * degree, and then twisted. We twist by three bits at a time because
507 * it's cheap to do so and helps slightly in the expected case where
508 * the entropy is concentrated in the low-order bits.
509 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400510static void _mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400511 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
Theodore Ts'o85608f82014-06-10 23:09:20 -0400513 unsigned long i, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700514 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700516 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700517 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 tap1 = r->poolinfo->tap1;
520 tap2 = r->poolinfo->tap2;
521 tap3 = r->poolinfo->tap3;
522 tap4 = r->poolinfo->tap4;
523 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400525 input_rotate = r->input_rotate;
526 i = r->add_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Matt Mackalle68e5b62008-04-29 01:03:05 -0700528 /* mix one byte at a time to simplify size handling and churn faster */
529 while (nbytes--) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400530 w = rol32(*bytes++, input_rotate);
Matt Mackall993ba212008-04-29 01:03:04 -0700531 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
533 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700534 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 w ^= r->pool[(i + tap1) & wordmask];
536 w ^= r->pool[(i + tap2) & wordmask];
537 w ^= r->pool[(i + tap3) & wordmask];
538 w ^= r->pool[(i + tap4) & wordmask];
539 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700540
541 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700543
544 /*
545 * Normally, we add 7 bits of rotation to the pool.
546 * At the beginning of the pool, add an extra 7 bits
547 * rotation, so that successive passes spread the
548 * input bits across the pool evenly.
549 */
Theodore Ts'oc59974a2013-09-21 19:42:41 -0400550 input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
552
Theodore Ts'o91fcb532014-06-10 22:46:37 -0400553 r->input_rotate = input_rotate;
554 r->add_ptr = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555}
556
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400557static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400558 int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400560 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400561 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400562}
563
564static void mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o85608f82014-06-10 23:09:20 -0400565 int nbytes)
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400566{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400567 unsigned long flags;
568
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400569 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400570 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -0400571 _mix_pool_bytes(r, in, nbytes);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400572 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573}
574
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400575struct fast_pool {
576 __u32 pool[4];
577 unsigned long last;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -0400578 unsigned short reg_idx;
Theodore Ts'o840f9502014-06-14 03:06:57 -0400579 unsigned char count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400580};
581
582/*
583 * This is a fast mixing routine used by the interrupt randomness
584 * collector. It's hardcoded for an 128 bit pool and assumes that any
585 * locks that might be needed are taken by the caller.
586 */
Theodore Ts'o43759d42014-06-14 21:43:13 -0400587static void fast_mix(struct fast_pool *f)
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400588{
Theodore Ts'o43759d42014-06-14 21:43:13 -0400589 __u32 a = f->pool[0], b = f->pool[1];
590 __u32 c = f->pool[2], d = f->pool[3];
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400591
Theodore Ts'o43759d42014-06-14 21:43:13 -0400592 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500593 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400594 d ^= a; b ^= c;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400595
Theodore Ts'o43759d42014-06-14 21:43:13 -0400596 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500597 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400598 d ^= a; b ^= c;
599
600 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500601 b = rol32(b, 6); d = rol32(d, 27);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400602 d ^= a; b ^= c;
603
604 a += b; c += d;
George Spelvin19acc772015-02-07 00:32:06 -0500605 b = rol32(b, 16); d = rol32(d, 14);
Theodore Ts'o43759d42014-06-14 21:43:13 -0400606 d ^= a; b ^= c;
607
608 f->pool[0] = a; f->pool[1] = b;
609 f->pool[2] = c; f->pool[3] = d;
Theodore Ts'o655b2262013-09-22 15:24:02 -0400610 f->count++;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400611}
612
Herbert Xu205a5252015-06-09 18:19:39 +0800613static void process_random_ready_list(void)
614{
615 unsigned long flags;
616 struct random_ready_callback *rdy, *tmp;
617
618 spin_lock_irqsave(&random_ready_list_lock, flags);
619 list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
620 struct module *owner = rdy->owner;
621
622 list_del_init(&rdy->list);
623 rdy->func(rdy);
624 module_put(owner);
625 }
626 spin_unlock_irqrestore(&random_ready_list_lock, flags);
627}
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629/*
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400630 * Credit (or debit) the entropy store with n bits of entropy.
631 * Use credit_entropy_bits_safe() if the value comes from userspace
632 * or otherwise should be checked for extreme values.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700634static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400636 int entropy_count, orig;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400637 const int pool_size = r->poolinfo->poolfracbits;
638 int nfrac = nbits << ENTROPY_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Matt Mackalladc782d2008-04-29 01:03:07 -0700640 if (!nbits)
641 return;
642
Theodore Ts'o902c0982012-07-04 10:38:30 -0400643retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -0700644 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400645 if (nfrac < 0) {
646 /* Debit */
647 entropy_count += nfrac;
648 } else {
649 /*
650 * Credit: we have to account for the possibility of
651 * overwriting already present entropy. Even in the
652 * ideal case of pure Shannon entropy, new contributions
653 * approach the full value asymptotically:
654 *
655 * entropy <- entropy + (pool_size - entropy) *
656 * (1 - exp(-add_entropy/pool_size))
657 *
658 * For add_entropy <= pool_size/2 then
659 * (1 - exp(-add_entropy/pool_size)) >=
660 * (add_entropy/pool_size)*0.7869...
661 * so we can approximate the exponential with
662 * 3/4*add_entropy/pool_size and still be on the
663 * safe side by adding at most pool_size/2 at a time.
664 *
665 * The use of pool_size-2 in the while statement is to
666 * prevent rounding artifacts from making the loop
667 * arbitrarily long; this limits the loop to log2(pool_size)*2
668 * turns no matter how large nbits is.
669 */
670 int pnfrac = nfrac;
671 const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
672 /* The +2 corresponds to the /4 in the denominator */
673
674 do {
675 unsigned int anfrac = min(pnfrac, pool_size/2);
676 unsigned int add =
677 ((pool_size - entropy_count)*anfrac*3) >> s;
678
679 entropy_count += add;
680 pnfrac -= anfrac;
681 } while (unlikely(entropy_count < pool_size-2 && pnfrac));
682 }
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400683
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -0400684 if (unlikely(entropy_count < 0)) {
Theodore Ts'of80bbd82013-10-03 12:02:37 -0400685 pr_warn("random: negative entropy/overflow: pool %s count %d\n",
686 r->name, entropy_count);
687 WARN_ON(1);
Andrew Morton8b76f462008-09-02 14:36:14 -0700688 entropy_count = 0;
H. Peter Anvin30e37ec2013-09-10 23:16:17 -0400689 } else if (entropy_count > pool_size)
690 entropy_count = pool_size;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400691 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
692 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Theodore Ts'o6265e162013-10-03 01:08:15 -0400694 r->entropy_total += nbits;
Linus Torvalds0891ad82013-11-16 10:19:15 -0800695 if (!r->initialized && r->entropy_total > 128) {
696 r->initialized = 1;
697 r->entropy_total = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400698 }
699
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400700 trace_credit_entropy_bits(r->name, nbits,
701 entropy_count >> ENTROPY_SHIFT,
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400702 r->entropy_total, _RET_IP_);
703
Theodore Ts'o6265e162013-10-03 01:08:15 -0400704 if (r == &input_pool) {
Greg Price7d1b08c2013-12-07 09:49:55 -0500705 int entropy_bits = entropy_count >> ENTROPY_SHIFT;
Theodore Ts'o6265e162013-10-03 01:08:15 -0400706
Theodore Ts'oe192be92016-06-12 18:13:36 -0400707 if (crng_init < 2 && entropy_bits >= 128) {
708 crng_reseed(&primary_crng, r);
709 entropy_bits = r->entropy_count >> ENTROPY_SHIFT;
710 }
711
Theodore Ts'o6265e162013-10-03 01:08:15 -0400712 /* should we wake readers? */
Andi Kleene8e8a2e2018-02-28 13:43:28 -0800713 if (entropy_bits >= random_read_wakeup_bits &&
714 wq_has_sleeper(&random_read_wait)) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400715 wake_up_interruptible(&random_read_wait);
716 kill_fasync(&fasync, SIGIO, POLL_IN);
717 }
718 /* If the input pool is getting full, send some
Theodore Ts'oe192be92016-06-12 18:13:36 -0400719 * entropy to the blocking pool until it is 75% full.
Theodore Ts'o6265e162013-10-03 01:08:15 -0400720 */
Greg Price2132a962013-12-06 21:28:03 -0500721 if (entropy_bits > random_write_wakeup_bits &&
Theodore Ts'o6265e162013-10-03 01:08:15 -0400722 r->initialized &&
Greg Price2132a962013-12-06 21:28:03 -0500723 r->entropy_total >= 2*random_read_wakeup_bits) {
Theodore Ts'o6265e162013-10-03 01:08:15 -0400724 struct entropy_store *other = &blocking_pool;
725
Theodore Ts'o6265e162013-10-03 01:08:15 -0400726 if (other->entropy_count <=
Theodore Ts'oe192be92016-06-12 18:13:36 -0400727 3 * other->poolinfo->poolfracbits / 4) {
728 schedule_work(&other->push_work);
Theodore Ts'o6265e162013-10-03 01:08:15 -0400729 r->entropy_total = 0;
730 }
731 }
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700732 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733}
734
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400735static int credit_entropy_bits_safe(struct entropy_store *r, int nbits)
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400736{
Theodore Ts'o9f886f42017-02-25 18:21:33 -0400737 const int nbits_max = r->poolinfo->poolwords * 32;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400738
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400739 if (nbits < 0)
740 return -EINVAL;
741
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400742 /* Cap the value to avoid overflows */
743 nbits = min(nbits, nbits_max);
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400744
745 credit_entropy_bits(r, nbits);
Theodore Ts'o86a574d2016-07-03 17:01:26 -0400746 return 0;
H. Peter Anvina283b5c2013-09-10 23:16:17 -0400747}
748
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749/*********************************************************************
750 *
Theodore Ts'oe192be92016-06-12 18:13:36 -0400751 * CRNG using CHACHA20
752 *
753 *********************************************************************/
754
755#define CRNG_RESEED_INTERVAL (300*HZ)
756
757static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
758
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400759#ifdef CONFIG_NUMA
760/*
761 * Hack to deal with crazy userspace progams when they are all trying
762 * to access /dev/urandom in parallel. The programs are almost
763 * certainly doing something terribly wrong, but we'll work around
764 * their brain damage.
765 */
766static struct crng_state **crng_node_pool __read_mostly;
767#endif
768
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400769static void invalidate_batched_entropy(void);
770
Theodore Ts'oe192be92016-06-12 18:13:36 -0400771static void crng_initialize(struct crng_state *crng)
772{
773 int i;
774 unsigned long rv;
775
776 memcpy(&crng->state[0], "expand 32-byte k", 16);
777 if (crng == &primary_crng)
778 _extract_entropy(&input_pool, &crng->state[4],
779 sizeof(__u32) * 12, 0);
780 else
Theodore Ts'oeecabf52017-06-08 04:16:59 -0400781 _get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400782 for (i = 4; i < 16; i++) {
783 if (!arch_get_random_seed_long(&rv) &&
784 !arch_get_random_long(&rv))
785 rv = random_get_entropy();
786 crng->state[i] ^= rv;
787 }
788 crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
789}
790
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400791#ifdef CONFIG_NUMA
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400792static void do_numa_crng_init(struct work_struct *work)
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400793{
794 int i;
795 struct crng_state *crng;
796 struct crng_state **pool;
797
798 pool = kcalloc(nr_node_ids, sizeof(*pool), GFP_KERNEL|__GFP_NOFAIL);
799 for_each_online_node(i) {
800 crng = kmalloc_node(sizeof(struct crng_state),
801 GFP_KERNEL | __GFP_NOFAIL, i);
802 spin_lock_init(&crng->lock);
803 crng_initialize(crng);
804 pool[i] = crng;
805 }
806 mb();
807 if (cmpxchg(&crng_node_pool, NULL, pool)) {
808 for_each_node(i)
809 kfree(pool[i]);
810 kfree(pool);
811 }
812}
Theodore Ts'o6c1e8512018-04-23 18:51:28 -0400813
814static DECLARE_WORK(numa_crng_init_work, do_numa_crng_init);
815
816static void numa_crng_init(void)
817{
818 schedule_work(&numa_crng_init_work);
819}
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400820#else
821static void numa_crng_init(void) {}
822#endif
823
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400824/*
825 * crng_fast_load() can be called by code in the interrupt service
826 * path. So we can't afford to dilly-dally.
827 */
Theodore Ts'oe192be92016-06-12 18:13:36 -0400828static int crng_fast_load(const char *cp, size_t len)
829{
830 unsigned long flags;
831 char *p;
832
833 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
834 return 0;
Theodore Ts'o43838a22018-04-11 13:27:52 -0400835 if (crng_init != 0) {
Theodore Ts'oe192be92016-06-12 18:13:36 -0400836 spin_unlock_irqrestore(&primary_crng.lock, flags);
837 return 0;
838 }
839 p = (unsigned char *) &primary_crng.state[4];
840 while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
841 p[crng_init_cnt % CHACHA20_KEY_SIZE] ^= *cp;
842 cp++; crng_init_cnt++; len--;
843 }
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +0200844 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400845 if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400846 invalidate_batched_entropy();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400847 crng_init = 1;
848 wake_up_interruptible(&crng_init_wait);
849 pr_notice("random: fast init done\n");
850 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400851 return 1;
852}
853
Theodore Ts'odc12baa2018-04-11 14:58:27 -0400854/*
855 * crng_slow_load() is called by add_device_randomness, which has two
856 * attributes. (1) We can't trust the buffer passed to it is
857 * guaranteed to be unpredictable (so it might not have any entropy at
858 * all), and (2) it doesn't have the performance constraints of
859 * crng_fast_load().
860 *
861 * So we do something more comprehensive which is guaranteed to touch
862 * all of the primary_crng's state, and which uses a LFSR with a
863 * period of 255 as part of the mixing algorithm. Finally, we do
864 * *not* advance crng_init_cnt since buffer we may get may be something
865 * like a fixed DMI table (for example), which might very well be
866 * unique to the machine, but is otherwise unvarying.
867 */
868static int crng_slow_load(const char *cp, size_t len)
869{
870 unsigned long flags;
871 static unsigned char lfsr = 1;
872 unsigned char tmp;
873 unsigned i, max = CHACHA20_KEY_SIZE;
874 const char * src_buf = cp;
875 char * dest_buf = (char *) &primary_crng.state[4];
876
877 if (!spin_trylock_irqsave(&primary_crng.lock, flags))
878 return 0;
879 if (crng_init != 0) {
880 spin_unlock_irqrestore(&primary_crng.lock, flags);
881 return 0;
882 }
883 if (len > max)
884 max = len;
885
886 for (i = 0; i < max ; i++) {
887 tmp = lfsr;
888 lfsr >>= 1;
889 if (tmp & 1)
890 lfsr ^= 0xE1;
891 tmp = dest_buf[i % CHACHA20_KEY_SIZE];
892 dest_buf[i % CHACHA20_KEY_SIZE] ^= src_buf[i % len] ^ lfsr;
893 lfsr += (tmp << 3) | (tmp >> 5);
894 }
895 spin_unlock_irqrestore(&primary_crng.lock, flags);
896 return 1;
897}
898
Theodore Ts'oe192be92016-06-12 18:13:36 -0400899static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
900{
901 unsigned long flags;
902 int i, num;
903 union {
Eric Biggers9f480fa2017-11-22 11:51:39 -0800904 __u32 block[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -0400905 __u32 key[8];
906 } buf;
907
908 if (r) {
909 num = extract_entropy(r, &buf, 32, 16, 0);
910 if (num == 0)
911 return;
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400912 } else {
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400913 _extract_crng(&primary_crng, buf.block);
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400914 _crng_backtrack_protect(&primary_crng, buf.block,
915 CHACHA20_KEY_SIZE);
916 }
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400917 spin_lock_irqsave(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400918 for (i = 0; i < 8; i++) {
919 unsigned long rv;
920 if (!arch_get_random_seed_long(&rv) &&
921 !arch_get_random_long(&rv))
922 rv = random_get_entropy();
923 crng->state[i+4] ^= buf.key[i] ^ rv;
924 }
925 memzero_explicit(&buf, sizeof(buf));
926 crng->init_time = jiffies;
Theodore Ts'o0bb29a82018-04-12 00:50:45 -0400927 spin_unlock_irqrestore(&crng->lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400928 if (crng == &primary_crng && crng_init < 2) {
Jason A. Donenfeldb169c132017-06-07 19:45:31 -0400929 invalidate_batched_entropy();
Theodore Ts'o8ef35c82018-04-11 15:23:56 -0400930 numa_crng_init();
Theodore Ts'oe192be92016-06-12 18:13:36 -0400931 crng_init = 2;
932 process_random_ready_list();
933 wake_up_interruptible(&crng_init_wait);
934 pr_notice("random: crng init done\n");
935 }
Theodore Ts'oe192be92016-06-12 18:13:36 -0400936}
937
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400938static void _extract_crng(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800939 __u32 out[CHACHA20_BLOCK_WORDS])
Theodore Ts'oe192be92016-06-12 18:13:36 -0400940{
941 unsigned long v, flags;
Theodore Ts'oe192be92016-06-12 18:13:36 -0400942
Theodore Ts'o43838a22018-04-11 13:27:52 -0400943 if (crng_ready() &&
Theodore Ts'od848e5f2018-04-11 16:32:17 -0400944 (time_after(crng_global_init_time, crng->init_time) ||
945 time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL)))
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400946 crng_reseed(crng, crng == &primary_crng ? &input_pool : NULL);
Theodore Ts'oe192be92016-06-12 18:13:36 -0400947 spin_lock_irqsave(&crng->lock, flags);
948 if (arch_get_random_long(&v))
949 crng->state[14] ^= v;
950 chacha20_block(&crng->state[0], out);
951 if (crng->state[12] == 0)
952 crng->state[13]++;
953 spin_unlock_irqrestore(&crng->lock, flags);
954}
955
Eric Biggers9f480fa2017-11-22 11:51:39 -0800956static void extract_crng(__u32 out[CHACHA20_BLOCK_WORDS])
Theodore Ts'o1e7f5832016-05-02 02:04:41 -0400957{
958 struct crng_state *crng = NULL;
959
960#ifdef CONFIG_NUMA
961 if (crng_node_pool)
962 crng = crng_node_pool[numa_node_id()];
963 if (crng == NULL)
964#endif
965 crng = &primary_crng;
966 _extract_crng(crng, out);
967}
968
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400969/*
970 * Use the leftover bytes from the CRNG block output (if there is
971 * enough) to mutate the CRNG key to provide backtracking protection.
972 */
973static void _crng_backtrack_protect(struct crng_state *crng,
Eric Biggers9f480fa2017-11-22 11:51:39 -0800974 __u32 tmp[CHACHA20_BLOCK_WORDS], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400975{
976 unsigned long flags;
977 __u32 *s, *d;
978 int i;
979
980 used = round_up(used, sizeof(__u32));
981 if (used + CHACHA20_KEY_SIZE > CHACHA20_BLOCK_SIZE) {
982 extract_crng(tmp);
983 used = 0;
984 }
985 spin_lock_irqsave(&crng->lock, flags);
Eric Biggers9f480fa2017-11-22 11:51:39 -0800986 s = &tmp[used / sizeof(__u32)];
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400987 d = &crng->state[4];
988 for (i=0; i < 8; i++)
989 *d++ ^= *s++;
990 spin_unlock_irqrestore(&crng->lock, flags);
991}
992
Eric Biggers9f480fa2017-11-22 11:51:39 -0800993static void crng_backtrack_protect(__u32 tmp[CHACHA20_BLOCK_WORDS], int used)
Theodore Ts'oc92e0402016-05-04 13:29:18 -0400994{
995 struct crng_state *crng = NULL;
996
997#ifdef CONFIG_NUMA
998 if (crng_node_pool)
999 crng = crng_node_pool[numa_node_id()];
1000 if (crng == NULL)
1001#endif
1002 crng = &primary_crng;
1003 _crng_backtrack_protect(crng, tmp, used);
1004}
1005
Theodore Ts'oe192be92016-06-12 18:13:36 -04001006static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
1007{
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001008 ssize_t ret = 0, i = CHACHA20_BLOCK_SIZE;
Eric Biggers9f480fa2017-11-22 11:51:39 -08001009 __u32 tmp[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001010 int large_request = (nbytes > 256);
1011
1012 while (nbytes) {
1013 if (large_request && need_resched()) {
1014 if (signal_pending(current)) {
1015 if (ret == 0)
1016 ret = -ERESTARTSYS;
1017 break;
1018 }
1019 schedule();
1020 }
1021
1022 extract_crng(tmp);
1023 i = min_t(int, nbytes, CHACHA20_BLOCK_SIZE);
1024 if (copy_to_user(buf, tmp, i)) {
1025 ret = -EFAULT;
1026 break;
1027 }
1028
1029 nbytes -= i;
1030 buf += i;
1031 ret += i;
1032 }
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001033 crng_backtrack_protect(tmp, i);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001034
1035 /* Wipe data just written to memory */
1036 memzero_explicit(tmp, sizeof(tmp));
1037
1038 return ret;
1039}
1040
1041
1042/*********************************************************************
1043 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 * Entropy input management
1045 *
1046 *********************************************************************/
1047
1048/* There is one of these per entropy source */
1049struct timer_rand_state {
1050 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -07001051 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052};
1053
Theodore Ts'o644008d2013-11-03 16:40:53 -05001054#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };
1055
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001056/*
Theodore Ts'oe192be92016-06-12 18:13:36 -04001057 * Add device- or boot-specific data to the input pool to help
1058 * initialize it.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001059 *
Theodore Ts'oe192be92016-06-12 18:13:36 -04001060 * None of this adds any entropy; it is meant to avoid the problem of
1061 * the entropy pool having similar initial state across largely
1062 * identical devices.
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001063 */
1064void add_device_randomness(const void *buf, unsigned int size)
1065{
Theodore Ts'o61875f32013-09-21 13:58:22 -04001066 unsigned long time = random_get_entropy() ^ jiffies;
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001067 unsigned long flags;
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001068
Theodore Ts'odc12baa2018-04-11 14:58:27 -04001069 if (!crng_ready() && size)
1070 crng_slow_load(buf, size);
Kees Cookee7998c2017-07-12 14:34:04 -07001071
Theodore Ts'o59108952013-09-12 14:10:25 -04001072 trace_add_device_randomness(size, _RET_IP_);
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001073 spin_lock_irqsave(&input_pool.lock, flags);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001074 _mix_pool_bytes(&input_pool, buf, size);
1075 _mix_pool_bytes(&input_pool, &time, sizeof(time));
Theodore Ts'o3ef4cb22013-09-12 14:27:22 -04001076 spin_unlock_irqrestore(&input_pool.lock, flags);
Linus Torvaldsa2080a62012-07-04 11:16:01 -04001077}
1078EXPORT_SYMBOL(add_device_randomness);
1079
Theodore Ts'o644008d2013-11-03 16:40:53 -05001080static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001081
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082/*
1083 * This function adds entropy to the entropy "pool" by using timing
1084 * delays. It uses the timer_rand_state structure to make an estimate
1085 * of how many bits of entropy this call has added to the pool.
1086 *
1087 * The number "num" is also added to the pool - it should somehow describe
1088 * the type of event which just happened. This is currently 0-255 for
1089 * keyboard scan codes, and 256 upwards for interrupts.
1090 *
1091 */
1092static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
1093{
Theodore Ts'o40db23e2013-11-03 00:15:05 -04001094 struct entropy_store *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -08001097 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 unsigned num;
1099 } sample;
1100 long delta, delta2, delta3;
1101
1102 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
1104 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -04001105 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 sample.num = num;
Theodore Ts'oe192be92016-06-12 18:13:36 -04001107 r = &input_pool;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001108 mix_pool_bytes(r, &sample, sizeof(sample));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
1110 /*
1111 * Calculate number of bits of randomness we probably added.
1112 * We take into account the first, second and third-order deltas
1113 * in order to make our estimate.
1114 */
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001115 delta = sample.jiffies - state->last_time;
1116 state->last_time = sample.jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001118 delta2 = delta - state->last_delta;
1119 state->last_delta = delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001121 delta3 = delta2 - state->last_delta2;
1122 state->last_delta2 = delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001124 if (delta < 0)
1125 delta = -delta;
1126 if (delta2 < 0)
1127 delta2 = -delta2;
1128 if (delta3 < 0)
1129 delta3 = -delta3;
1130 if (delta > delta2)
1131 delta = delta2;
1132 if (delta > delta3)
1133 delta = delta3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
Rasmus Villemoes5e747dd2018-03-01 00:22:47 +01001135 /*
1136 * delta is now minimum absolute delta.
1137 * Round down by 1 bit on general principles,
1138 * and limit entropy entimate to 12 bits.
1139 */
1140 credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 preempt_enable();
1143}
1144
Stephen Hemmingerd2515752006-01-11 12:17:38 -08001145void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 unsigned int value)
1147{
1148 static unsigned char last_value;
1149
1150 /* ignore autorepeat and the like */
1151 if (value == last_value)
1152 return;
1153
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 last_value = value;
1155 add_timer_randomness(&input_timer_state,
1156 (type << 4) ^ code ^ (code >> 4) ^ value);
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001157 trace_add_input_randomness(ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -04001159EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001161static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
1162
Theodore Ts'o43759d42014-06-14 21:43:13 -04001163#ifdef ADD_INTERRUPT_BENCH
1164static unsigned long avg_cycles, avg_deviation;
1165
1166#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
1167#define FIXED_1_2 (1 << (AVG_SHIFT-1))
1168
1169static void add_interrupt_bench(cycles_t start)
1170{
1171 long delta = random_get_entropy() - start;
1172
1173 /* Use a weighted moving average */
1174 delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
1175 avg_cycles += delta;
1176 /* And average deviation */
1177 delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
1178 avg_deviation += delta;
1179}
1180#else
1181#define add_interrupt_bench(x)
1182#endif
1183
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001184static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
1185{
1186 __u32 *ptr = (__u32 *) regs;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001187 unsigned int idx;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001188
1189 if (regs == NULL)
1190 return 0;
Theodore Ts'o92e75422017-06-07 19:01:32 -04001191 idx = READ_ONCE(f->reg_idx);
1192 if (idx >= sizeof(struct pt_regs) / sizeof(__u32))
1193 idx = 0;
1194 ptr += idx++;
1195 WRITE_ONCE(f->reg_idx, idx);
Michael Schmitz9dfa7bb2017-04-30 19:49:21 +12001196 return *ptr;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001197}
1198
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001199void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200{
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001201 struct entropy_store *r;
Christoph Lameter1b2a1a72014-08-17 12:30:29 -05001202 struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001203 struct pt_regs *regs = get_irq_regs();
1204 unsigned long now = jiffies;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001205 cycles_t cycles = random_get_entropy();
Theodore Ts'o43759d42014-06-14 21:43:13 -04001206 __u32 c_high, j_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001207 __u64 ip;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001208 unsigned long seed;
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001209 int credit = 0;
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001210
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001211 if (cycles == 0)
1212 cycles = get_reg(fast_pool, regs);
Theodore Ts'o655b2262013-09-22 15:24:02 -04001213 c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
1214 j_high = (sizeof(now) > 4) ? now >> 32 : 0;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001215 fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
1216 fast_pool->pool[1] ^= now ^ c_high;
Theodore Ts'o655b2262013-09-22 15:24:02 -04001217 ip = regs ? instruction_pointer(regs) : _RET_IP_;
Theodore Ts'o43759d42014-06-14 21:43:13 -04001218 fast_pool->pool[2] ^= ip;
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001219 fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
1220 get_reg(fast_pool, regs);
Yinghai Lu3060d6f2008-08-19 20:50:08 -07001221
Theodore Ts'o43759d42014-06-14 21:43:13 -04001222 fast_mix(fast_pool);
Theodore Ts'o43759d42014-06-14 21:43:13 -04001223 add_interrupt_bench(cycles);
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001224
Theodore Ts'o43838a22018-04-11 13:27:52 -04001225 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04001226 if ((fast_pool->count >= 64) &&
1227 crng_fast_load((char *) fast_pool->pool,
1228 sizeof(fast_pool->pool))) {
1229 fast_pool->count = 0;
1230 fast_pool->last = now;
1231 }
1232 return;
1233 }
1234
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001235 if ((fast_pool->count < 64) &&
1236 !time_after(now, fast_pool->last + HZ))
1237 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
Theodore Ts'oe192be92016-06-12 18:13:36 -04001239 r = &input_pool;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001240 if (!spin_trylock(&r->lock))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 return;
1242
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001243 fast_pool->last = now;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001244 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
H. Peter Anvin83664a62014-03-17 16:36:28 -07001245
1246 /*
1247 * If we have architectural seed generator, produce a seed and
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001248 * add it to the pool. For the sake of paranoia don't let the
1249 * architectural seed generator dominate the input from the
1250 * interrupt noise.
H. Peter Anvin83664a62014-03-17 16:36:28 -07001251 */
1252 if (arch_get_random_seed_long(&seed)) {
Theodore Ts'o85608f82014-06-10 23:09:20 -04001253 __mix_pool_bytes(r, &seed, sizeof(seed));
Theodore Ts'o48d6be92014-07-17 05:27:30 -04001254 credit = 1;
H. Peter Anvin83664a62014-03-17 16:36:28 -07001255 }
Theodore Ts'o91fcb532014-06-10 22:46:37 -04001256 spin_unlock(&r->lock);
H. Peter Anvin83664a62014-03-17 16:36:28 -07001257
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001258 fast_pool->count = 0;
Theodore Ts'o840f9502014-06-14 03:06:57 -04001259
Theodore Ts'oee3e00e2014-06-15 16:59:24 -04001260 /* award one bit for the contents of the fast pool */
1261 credit_entropy_bits(r, credit + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262}
Stephan Mueller4b44f2d2016-05-02 02:14:34 -04001263EXPORT_SYMBOL_GPL(add_interrupt_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
David Howells93614012006-09-30 20:45:40 +02001265#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266void add_disk_randomness(struct gendisk *disk)
1267{
1268 if (!disk || !disk->random)
1269 return;
1270 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +02001271 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001272 trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273}
Christoph Hellwigbdcfa3e2014-04-25 00:36:37 -07001274EXPORT_SYMBOL_GPL(add_disk_randomness);
David Howells93614012006-09-30 20:45:40 +02001275#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277/*********************************************************************
1278 *
1279 * Entropy extraction routines
1280 *
1281 *********************************************************************/
1282
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001284 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 * from the primary pool to the secondary extraction pool. We make
1286 * sure we pull enough for a 'catastrophic reseed'.
1287 */
Theodore Ts'o6265e162013-10-03 01:08:15 -04001288static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1290{
Theodore Ts'ocff85032014-06-10 23:18:16 -04001291 if (!r->pull ||
1292 r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
1293 r->entropy_count > r->poolinfo->poolfracbits)
1294 return;
1295
Theodore Ts'ocff85032014-06-10 23:18:16 -04001296 _xfer_secondary_pool(r, nbytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001297}
Matt Mackall5a021e92007-07-19 11:30:14 -07001298
Theodore Ts'o6265e162013-10-03 01:08:15 -04001299static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
1300{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 __u32 tmp[OUTPUT_POOL_WORDS];
1302
Theodore Ts'o6265e162013-10-03 01:08:15 -04001303 int bytes = nbytes;
Matt Mackall5a021e92007-07-19 11:30:14 -07001304
Greg Price2132a962013-12-06 21:28:03 -05001305 /* pull at least as much as a wakeup */
1306 bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001307 /* but never more than the buffer size */
1308 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001310 trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
1311 ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
Theodore Ts'o6265e162013-10-03 01:08:15 -04001312 bytes = extract_entropy(r->pull, tmp, bytes,
Stephan Müller43d8a722016-12-27 23:40:59 +01001313 random_read_wakeup_bits / 8, 0);
Theodore Ts'o85608f82014-06-10 23:09:20 -04001314 mix_pool_bytes(r, tmp, bytes);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001315 credit_entropy_bits(r, bytes*8);
1316}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
Theodore Ts'o6265e162013-10-03 01:08:15 -04001318/*
1319 * Used as a workqueue function so that when the input pool is getting
1320 * full, we can "spill over" some entropy to the output pools. That
1321 * way the output pools can store some of the excess entropy instead
1322 * of letting it go to waste.
1323 */
1324static void push_to_pool(struct work_struct *work)
1325{
1326 struct entropy_store *r = container_of(work, struct entropy_store,
1327 push_work);
1328 BUG_ON(!r);
Greg Price2132a962013-12-06 21:28:03 -05001329 _xfer_secondary_pool(r, random_read_wakeup_bits/8);
Theodore Ts'o6265e162013-10-03 01:08:15 -04001330 trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
1331 r->pull->entropy_count >> ENTROPY_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332}
1333
1334/*
Greg Price19fa5be12013-11-29 15:50:06 -05001335 * This function decides how many bytes to actually take from the
1336 * given pool, and also debits the entropy count accordingly.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338static size_t account(struct entropy_store *r, size_t nbytes, int min,
1339 int reserved)
1340{
Stephan Müller43d8a722016-12-27 23:40:59 +01001341 int entropy_count, orig, have_bytes;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001342 size_t ibytes, nfrac;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001344 BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
1346 /* Can we pull enough? */
Jiri Kosina10b3a322013-05-24 15:55:33 -07001347retry:
Mark Rutland6aa7de02017-10-23 14:07:29 -07001348 entropy_count = orig = READ_ONCE(r->entropy_count);
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001349 ibytes = nbytes;
Stephan Müller43d8a722016-12-27 23:40:59 +01001350 /* never pull more than available */
1351 have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001352
Stephan Müller43d8a722016-12-27 23:40:59 +01001353 if ((have_bytes -= reserved) < 0)
1354 have_bytes = 0;
1355 ibytes = min_t(size_t, ibytes, have_bytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001356 if (ibytes < min)
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001357 ibytes = 0;
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001358
1359 if (unlikely(entropy_count < 0)) {
1360 pr_warn("random: negative entropy count: pool %s count %d\n",
1361 r->name, entropy_count);
1362 WARN_ON(1);
1363 entropy_count = 0;
1364 }
1365 nfrac = ibytes << (ENTROPY_SHIFT + 3);
1366 if ((size_t) entropy_count > nfrac)
1367 entropy_count -= nfrac;
1368 else
Theodore Ts'oe33ba5f2014-06-15 21:04:32 -04001369 entropy_count = 0;
Theodore Ts'of9c6d492014-05-16 21:40:41 -04001370
Greg Price0fb7a012013-12-05 19:32:19 -05001371 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
1372 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001374 trace_debit_entropy(r->name, 8 * ibytes);
Greg Price0fb7a012013-12-05 19:32:19 -05001375 if (ibytes &&
Greg Price2132a962013-12-06 21:28:03 -05001376 (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
Theodore Ts'ob9809552013-03-04 11:59:12 -05001377 wake_up_interruptible(&random_write_wait);
1378 kill_fasync(&fasync, SIGIO, POLL_OUT);
1379 }
1380
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001381 return ibytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382}
1383
Greg Price19fa5be12013-11-29 15:50:06 -05001384/*
1385 * This function does the actual extraction for extract_entropy and
1386 * extract_entropy_user.
1387 *
1388 * Note: we assume that .poolwords is a multiple of 16 words.
1389 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390static void extract_buf(struct entropy_store *r, __u8 *out)
1391{
Matt Mackall602b6ae2007-05-29 21:54:27 -05001392 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001393 union {
1394 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001395 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001396 } hash;
1397 __u32 workspace[SHA_WORKSPACE_WORDS];
Theodore Ts'o902c0982012-07-04 10:38:30 -04001398 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 /*
Greg Pricedfd38752013-11-29 14:58:06 -05001401 * If we have an architectural hardware random number
Theodore Ts'o46884442013-12-17 21:16:39 -05001402 * generator, use it for SHA's initial vector
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001403 */
Theodore Ts'o46884442013-12-17 21:16:39 -05001404 sha_init(hash.w);
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001405 for (i = 0; i < LONGS(20); i++) {
1406 unsigned long v;
1407 if (!arch_get_random_long(&v))
1408 break;
Theodore Ts'o46884442013-12-17 21:16:39 -05001409 hash.l[i] = v;
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001410 }
1411
Theodore Ts'o46884442013-12-17 21:16:39 -05001412 /* Generate a hash across the pool, 16 words (512 bits) at a time */
1413 spin_lock_irqsave(&r->lock, flags);
1414 for (i = 0; i < r->poolinfo->poolwords; i += 16)
1415 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
1416
Theodore Ts'o85a1f772013-09-21 18:06:02 -04001417 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001418 * We mix the hash back into the pool to prevent backtracking
1419 * attacks (where the attacker knows the state of the pool
1420 * plus the current outputs, and attempts to find previous
1421 * ouputs), unless the hash function can be inverted. By
1422 * mixing at least a SHA1 worth of hash data back, we make
1423 * brute-forcing the feedback as hard as brute-forcing the
1424 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 */
Theodore Ts'o85608f82014-06-10 23:09:20 -04001426 __mix_pool_bytes(r, hash.w, sizeof(hash.w));
Theodore Ts'o902c0982012-07-04 10:38:30 -04001427 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001428
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001429 memzero_explicit(workspace, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
1431 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -07001432 * In case the hash function has some recognizable output
1433 * pattern, we fold it in half. Thus, we always feed back
1434 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001436 hash.w[0] ^= hash.w[3];
1437 hash.w[1] ^= hash.w[4];
1438 hash.w[2] ^= rol32(hash.w[2], 16);
1439
H. Peter Anvind2e7c962012-07-27 22:26:08 -04001440 memcpy(out, &hash, EXTRACT_SIZE);
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001441 memzero_explicit(&hash, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442}
1443
Theodore Ts'oe192be92016-06-12 18:13:36 -04001444static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
1445 size_t nbytes, int fips)
1446{
1447 ssize_t ret = 0, i;
1448 __u8 tmp[EXTRACT_SIZE];
1449 unsigned long flags;
1450
1451 while (nbytes) {
1452 extract_buf(r, tmp);
1453
1454 if (fips) {
1455 spin_lock_irqsave(&r->lock, flags);
1456 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
1457 panic("Hardware RNG duplicated output!\n");
1458 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1459 spin_unlock_irqrestore(&r->lock, flags);
1460 }
1461 i = min_t(int, nbytes, EXTRACT_SIZE);
1462 memcpy(buf, tmp, i);
1463 nbytes -= i;
1464 buf += i;
1465 ret += i;
1466 }
1467
1468 /* Wipe data just returned from memory */
1469 memzero_explicit(tmp, sizeof(tmp));
1470
1471 return ret;
1472}
1473
Greg Price19fa5be12013-11-29 15:50:06 -05001474/*
1475 * This function extracts randomness from the "entropy pool", and
1476 * returns it in a buffer.
1477 *
1478 * The min parameter specifies the minimum amount we can pull before
1479 * failing to avoid races that defeat catastrophic reseeding while the
1480 * reserved parameter indicates how much entropy we must leave in the
1481 * pool after each pull to avoid starving other readers.
1482 */
Matt Mackall90b75ee2008-04-29 01:02:55 -07001483static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -04001484 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001487 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001489 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001490 if (fips_enabled) {
1491 spin_lock_irqsave(&r->lock, flags);
1492 if (!r->last_data_init) {
Theodore Ts'oc59974a2013-09-21 19:42:41 -04001493 r->last_data_init = 1;
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001494 spin_unlock_irqrestore(&r->lock, flags);
1495 trace_extract_entropy(r->name, EXTRACT_SIZE,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001496 ENTROPY_BITS(r), _RET_IP_);
Jarod Wilson1e7e2e02013-05-24 15:55:31 -07001497 xfer_secondary_pool(r, EXTRACT_SIZE);
1498 extract_buf(r, tmp);
1499 spin_lock_irqsave(&r->lock, flags);
1500 memcpy(r->last_data, tmp, EXTRACT_SIZE);
1501 }
1502 spin_unlock_irqrestore(&r->lock, flags);
1503 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001504
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001505 trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 xfer_secondary_pool(r, nbytes);
1507 nbytes = account(r, nbytes, min, reserved);
1508
Theodore Ts'oe192be92016-06-12 18:13:36 -04001509 return _extract_entropy(r, buf, nbytes, fips_enabled);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510}
1511
Greg Price19fa5be12013-11-29 15:50:06 -05001512/*
1513 * This function extracts randomness from the "entropy pool", and
1514 * returns it in a userspace buffer.
1515 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1517 size_t nbytes)
1518{
1519 ssize_t ret = 0, i;
1520 __u8 tmp[EXTRACT_SIZE];
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001521 int large_request = (nbytes > 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001523 trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 xfer_secondary_pool(r, nbytes);
1525 nbytes = account(r, nbytes, 0, 0);
1526
1527 while (nbytes) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001528 if (large_request && need_resched()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 if (signal_pending(current)) {
1530 if (ret == 0)
1531 ret = -ERESTARTSYS;
1532 break;
1533 }
1534 schedule();
1535 }
1536
1537 extract_buf(r, tmp);
1538 i = min_t(int, nbytes, EXTRACT_SIZE);
1539 if (copy_to_user(buf, tmp, i)) {
1540 ret = -EFAULT;
1541 break;
1542 }
1543
1544 nbytes -= i;
1545 buf += i;
1546 ret += i;
1547 }
1548
1549 /* Wipe data just returned from memory */
Daniel Borkmannd4c5efd2014-08-26 23:16:35 -04001550 memzero_explicit(tmp, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
1552 return ret;
1553}
1554
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001555#define warn_unseeded_randomness(previous) \
1556 _warn_unseeded_randomness(__func__, (void *) _RET_IP_, (previous))
1557
1558static void _warn_unseeded_randomness(const char *func_name, void *caller,
1559 void **previous)
1560{
1561#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1562 const bool print_once = false;
1563#else
1564 static bool print_once __read_mostly;
1565#endif
1566
1567 if (print_once ||
1568 crng_ready() ||
1569 (previous && (caller == READ_ONCE(*previous))))
1570 return;
1571 WRITE_ONCE(*previous, caller);
1572#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
1573 print_once = true;
1574#endif
Helge Deller51d96dc2017-08-08 18:28:41 +02001575 pr_notice("random: %s called from %pS with crng_init=%d\n",
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001576 func_name, caller, crng_init);
1577}
1578
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579/*
1580 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001581 * number of good random numbers, suitable for key generation, seeding
Greg Price18e9cea2013-11-29 14:59:45 -05001582 * TCP sequence numbers, etc. It does not rely on the hardware random
1583 * number generator. For random bytes direct from the hardware RNG
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001584 * (when available), use get_random_bytes_arch(). In order to ensure
1585 * that the randomness provided by this function is okay, the function
1586 * wait_for_random_bytes() should be called and return 0 at least once
1587 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 */
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001589static void _get_random_bytes(void *buf, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590{
Eric Biggers9f480fa2017-11-22 11:51:39 -08001591 __u32 tmp[CHACHA20_BLOCK_WORDS];
Theodore Ts'oe192be92016-06-12 18:13:36 -04001592
Theodore Ts'o59108952013-09-12 14:10:25 -04001593 trace_get_random_bytes(nbytes, _RET_IP_);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001594
1595 while (nbytes >= CHACHA20_BLOCK_SIZE) {
1596 extract_crng(buf);
1597 buf += CHACHA20_BLOCK_SIZE;
1598 nbytes -= CHACHA20_BLOCK_SIZE;
1599 }
1600
1601 if (nbytes > 0) {
1602 extract_crng(tmp);
1603 memcpy(buf, tmp, nbytes);
Theodore Ts'oc92e0402016-05-04 13:29:18 -04001604 crng_backtrack_protect(tmp, nbytes);
1605 } else
1606 crng_backtrack_protect(tmp, CHACHA20_BLOCK_SIZE);
1607 memzero_explicit(tmp, sizeof(tmp));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001608}
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001609
1610void get_random_bytes(void *buf, int nbytes)
1611{
1612 static void *previous;
1613
1614 warn_unseeded_randomness(&previous);
1615 _get_random_bytes(buf, nbytes);
1616}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001617EXPORT_SYMBOL(get_random_bytes);
1618
1619/*
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001620 * Wait for the urandom pool to be seeded and thus guaranteed to supply
1621 * cryptographically secure random numbers. This applies to: the /dev/urandom
1622 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
1623 * family of functions. Using any of these functions without first calling
1624 * this function forfeits the guarantee of security.
1625 *
1626 * Returns: 0 if the urandom pool has been seeded.
1627 * -ERESTARTSYS if the function was interrupted by a signal.
1628 */
1629int wait_for_random_bytes(void)
1630{
1631 if (likely(crng_ready()))
1632 return 0;
1633 return wait_event_interruptible(crng_init_wait, crng_ready());
1634}
1635EXPORT_SYMBOL(wait_for_random_bytes);
1636
1637/*
Herbert Xu205a5252015-06-09 18:19:39 +08001638 * Add a callback function that will be invoked when the nonblocking
1639 * pool is initialised.
1640 *
1641 * returns: 0 if callback is successfully added
1642 * -EALREADY if pool is already initialised (callback not called)
1643 * -ENOENT if module for callback is not alive
1644 */
1645int add_random_ready_callback(struct random_ready_callback *rdy)
1646{
1647 struct module *owner;
1648 unsigned long flags;
1649 int err = -EALREADY;
1650
Theodore Ts'oe192be92016-06-12 18:13:36 -04001651 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001652 return err;
1653
1654 owner = rdy->owner;
1655 if (!try_module_get(owner))
1656 return -ENOENT;
1657
1658 spin_lock_irqsave(&random_ready_list_lock, flags);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001659 if (crng_ready())
Herbert Xu205a5252015-06-09 18:19:39 +08001660 goto out;
1661
1662 owner = NULL;
1663
1664 list_add(&rdy->list, &random_ready_list);
1665 err = 0;
1666
1667out:
1668 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1669
1670 module_put(owner);
1671
1672 return err;
1673}
1674EXPORT_SYMBOL(add_random_ready_callback);
1675
1676/*
1677 * Delete a previously registered readiness callback function.
1678 */
1679void del_random_ready_callback(struct random_ready_callback *rdy)
1680{
1681 unsigned long flags;
1682 struct module *owner = NULL;
1683
1684 spin_lock_irqsave(&random_ready_list_lock, flags);
1685 if (!list_empty(&rdy->list)) {
1686 list_del_init(&rdy->list);
1687 owner = rdy->owner;
1688 }
1689 spin_unlock_irqrestore(&random_ready_list_lock, flags);
1690
1691 module_put(owner);
1692}
1693EXPORT_SYMBOL(del_random_ready_callback);
1694
1695/*
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001696 * This function will use the architecture-specific hardware random
1697 * number generator if it is available. The arch-specific hw RNG will
1698 * almost certainly be faster than what we can do in software, but it
1699 * is impossible to verify that it is implemented securely (as
1700 * opposed, to, say, the AES encryption of a sequence number using a
1701 * key known by the NSA). So it's useful if we need the speed, but
1702 * only if we're willing to trust the hardware manufacturer not to
1703 * have put in a back door.
1704 */
1705void get_random_bytes_arch(void *buf, int nbytes)
1706{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001707 char *p = buf;
1708
Theodore Ts'o59108952013-09-12 14:10:25 -04001709 trace_get_random_bytes_arch(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001710 while (nbytes) {
1711 unsigned long v;
1712 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001713
H. Peter Anvin63d77172011-07-31 13:54:50 -07001714 if (!arch_get_random_long(&v))
1715 break;
1716
Luck, Tonybd29e562011-11-16 10:50:56 -08001717 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001718 p += chunk;
1719 nbytes -= chunk;
1720 }
1721
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001722 if (nbytes)
Theodore Ts'oe192be92016-06-12 18:13:36 -04001723 get_random_bytes(p, nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001725EXPORT_SYMBOL(get_random_bytes_arch);
1726
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727
1728/*
1729 * init_std_data - initialize pool with system data
1730 *
1731 * @r: pool to initialize
1732 *
1733 * This function clears the pool's entropy count and mixes some system
1734 * data into the pool to prepare it for use. The pool is not cleared
1735 * as that can only decrease the entropy in the pool.
1736 */
1737static void init_std_data(struct entropy_store *r)
1738{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001739 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001740 ktime_t now = ktime_get_real();
1741 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742
Theodore Ts'of5c27422013-09-22 15:14:32 -04001743 r->last_pulled = jiffies;
Theodore Ts'o85608f82014-06-10 23:09:20 -04001744 mix_pool_bytes(r, &now, sizeof(now));
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001745 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
H. Peter Anvin83664a62014-03-17 16:36:28 -07001746 if (!arch_get_random_seed_long(&rv) &&
1747 !arch_get_random_long(&rv))
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001748 rv = random_get_entropy();
Theodore Ts'o85608f82014-06-10 23:09:20 -04001749 mix_pool_bytes(r, &rv, sizeof(rv));
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001750 }
Theodore Ts'o85608f82014-06-10 23:09:20 -04001751 mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752}
1753
Tony Luckcbc96b72012-07-23 09:47:57 -07001754/*
1755 * Note that setup_arch() may call add_device_randomness()
1756 * long before we get here. This allows seeding of the pools
1757 * with some platform dependent data very early in the boot
1758 * process. But it limits our options here. We must use
1759 * statically allocated structures that already have all
1760 * initializations complete at compile time. We should also
1761 * take care not to overwrite the precious per platform data
1762 * we were given.
1763 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001764static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765{
1766 init_std_data(&input_pool);
1767 init_std_data(&blocking_pool);
Theodore Ts'oe192be92016-06-12 18:13:36 -04001768 crng_initialize(&primary_crng);
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001769 crng_global_init_time = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 return 0;
1771}
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001772early_initcall(rand_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
David Howells93614012006-09-30 20:45:40 +02001774#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775void rand_initialize_disk(struct gendisk *disk)
1776{
1777 struct timer_rand_state *state;
1778
1779 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001780 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 * source.
1782 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001783 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
Theodore Ts'o644008d2013-11-03 16:40:53 -05001784 if (state) {
1785 state->last_time = INITIAL_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 disk->random = state;
Theodore Ts'o644008d2013-11-03 16:40:53 -05001787 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788}
David Howells93614012006-09-30 20:45:40 +02001789#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790
1791static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001792_random_read(int nonblock, char __user *buf, size_t nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793{
Greg Price12ff3a52013-11-29 15:02:33 -05001794 ssize_t n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795
1796 if (nbytes == 0)
1797 return 0;
1798
Greg Price12ff3a52013-11-29 15:02:33 -05001799 nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
1800 while (1) {
1801 n = extract_entropy_user(&blocking_pool, buf, nbytes);
1802 if (n < 0)
1803 return n;
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001804 trace_random_read(n*8, (nbytes-n)*8,
1805 ENTROPY_BITS(&blocking_pool),
1806 ENTROPY_BITS(&input_pool));
Greg Price12ff3a52013-11-29 15:02:33 -05001807 if (n > 0)
1808 return n;
H. Peter Anvin331c6492014-03-17 16:36:29 -07001809
Greg Price12ff3a52013-11-29 15:02:33 -05001810 /* Pool is (near) empty. Maybe wait and retry. */
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001811 if (nonblock)
Greg Price12ff3a52013-11-29 15:02:33 -05001812 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813
Greg Price12ff3a52013-11-29 15:02:33 -05001814 wait_event_interruptible(random_read_wait,
1815 ENTROPY_BITS(&input_pool) >=
Greg Price2132a962013-12-06 21:28:03 -05001816 random_read_wakeup_bits);
Greg Price12ff3a52013-11-29 15:02:33 -05001817 if (signal_pending(current))
1818 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820}
1821
1822static ssize_t
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001823random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
1824{
1825 return _random_read(file->f_flags & O_NONBLOCK, buf, nbytes);
1826}
1827
1828static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001829urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830{
Theodore Ts'oe192be92016-06-12 18:13:36 -04001831 unsigned long flags;
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001832 static int maxwarn = 10;
Theodore Ts'o301f0592013-11-03 06:54:51 -05001833 int ret;
1834
Theodore Ts'oe192be92016-06-12 18:13:36 -04001835 if (!crng_ready() && maxwarn > 0) {
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001836 maxwarn--;
1837 printk(KERN_NOTICE "random: %s: uninitialized urandom read "
Theodore Ts'oe192be92016-06-12 18:13:36 -04001838 "(%zd bytes read)\n",
1839 current->comm, nbytes);
1840 spin_lock_irqsave(&primary_crng.lock, flags);
1841 crng_init_cnt = 0;
1842 spin_unlock_irqrestore(&primary_crng.lock, flags);
Theodore Ts'o9b4d0082016-06-13 10:10:51 -04001843 }
Hannes Frederic Sowa79a84682014-07-18 17:26:41 -04001844 nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
Theodore Ts'oe192be92016-06-12 18:13:36 -04001845 ret = extract_crng_user(buf, nbytes);
1846 trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
Theodore Ts'of80bbd82013-10-03 12:02:37 -04001847 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848}
1849
Al Viroafc9a422017-07-03 06:39:46 -04001850static __poll_t
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851random_poll(struct file *file, poll_table * wait)
1852{
Al Viroafc9a422017-07-03 06:39:46 -04001853 __poll_t mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
1855 poll_wait(file, &random_read_wait, wait);
1856 poll_wait(file, &random_write_wait, wait);
1857 mask = 0;
Greg Price2132a962013-12-06 21:28:03 -05001858 if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001859 mask |= EPOLLIN | EPOLLRDNORM;
Greg Price2132a962013-12-06 21:28:03 -05001860 if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001861 mask |= EPOLLOUT | EPOLLWRNORM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 return mask;
1863}
1864
Matt Mackall7f397dc2007-05-29 21:58:10 -05001865static int
1866write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1867{
1868 size_t bytes;
1869 __u32 buf[16];
1870 const char __user *p = buffer;
1871
1872 while (count > 0) {
1873 bytes = min(count, sizeof(buf));
1874 if (copy_from_user(&buf, p, bytes))
1875 return -EFAULT;
1876
1877 count -= bytes;
1878 p += bytes;
1879
Theodore Ts'o85608f82014-06-10 23:09:20 -04001880 mix_pool_bytes(r, buf, bytes);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001881 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001882 }
1883
1884 return 0;
1885}
1886
Matt Mackall90b75ee2008-04-29 01:02:55 -07001887static ssize_t random_write(struct file *file, const char __user *buffer,
1888 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001890 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891
Theodore Ts'oe192be92016-06-12 18:13:36 -04001892 ret = write_pool(&input_pool, buffer, count);
Matt Mackall7f397dc2007-05-29 21:58:10 -05001893 if (ret)
1894 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895
Matt Mackall7f397dc2007-05-29 21:58:10 -05001896 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897}
1898
Matt Mackall43ae4862008-04-29 01:02:58 -07001899static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900{
1901 int size, ent_count;
1902 int __user *p = (int __user *)arg;
1903 int retval;
1904
1905 switch (cmd) {
1906 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001907 /* inherently racy, no point locking */
H. Peter Anvina283b5c2013-09-10 23:16:17 -04001908 ent_count = ENTROPY_BITS(&input_pool);
1909 if (put_user(ent_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 return -EFAULT;
1911 return 0;
1912 case RNDADDTOENTCNT:
1913 if (!capable(CAP_SYS_ADMIN))
1914 return -EPERM;
1915 if (get_user(ent_count, p))
1916 return -EFAULT;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001917 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 case RNDADDENTROPY:
1919 if (!capable(CAP_SYS_ADMIN))
1920 return -EPERM;
1921 if (get_user(ent_count, p++))
1922 return -EFAULT;
1923 if (ent_count < 0)
1924 return -EINVAL;
1925 if (get_user(size, p++))
1926 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001927 retval = write_pool(&input_pool, (const char __user *)p,
1928 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 if (retval < 0)
1930 return retval;
Theodore Ts'o86a574d2016-07-03 17:01:26 -04001931 return credit_entropy_bits_safe(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 case RNDZAPENTCNT:
1933 case RNDCLEARPOOL:
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001934 /*
1935 * Clear the entropy pool counters. We no longer clear
1936 * the entropy pool, as that's silly.
1937 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 if (!capable(CAP_SYS_ADMIN))
1939 return -EPERM;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001940 input_pool.entropy_count = 0;
Theodore Ts'oae9ecd92013-11-03 07:56:17 -05001941 blocking_pool.entropy_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 return 0;
Theodore Ts'od848e5f2018-04-11 16:32:17 -04001943 case RNDRESEEDCRNG:
1944 if (!capable(CAP_SYS_ADMIN))
1945 return -EPERM;
1946 if (crng_init < 2)
1947 return -ENODATA;
1948 crng_reseed(&primary_crng, NULL);
1949 crng_global_init_time = jiffies - 1;
1950 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 default:
1952 return -EINVAL;
1953 }
1954}
1955
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001956static int random_fasync(int fd, struct file *filp, int on)
1957{
1958 return fasync_helper(fd, filp, on, &fasync);
1959}
1960
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001961const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 .read = random_read,
1963 .write = random_write,
1964 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001965 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001966 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001967 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968};
1969
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001970const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 .read = urandom_read,
1972 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001973 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001974 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001975 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976};
1977
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001978SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
1979 unsigned int, flags)
1980{
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001981 int ret;
1982
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001983 if (flags & ~(GRND_NONBLOCK|GRND_RANDOM))
1984 return -EINVAL;
1985
1986 if (count > INT_MAX)
1987 count = INT_MAX;
1988
1989 if (flags & GRND_RANDOM)
1990 return _random_read(flags & GRND_NONBLOCK, buf, count);
1991
Theodore Ts'oe192be92016-06-12 18:13:36 -04001992 if (!crng_ready()) {
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001993 if (flags & GRND_NONBLOCK)
1994 return -EAGAIN;
Jason A. Donenfelde297a782017-06-07 19:58:56 -04001995 ret = wait_for_random_bytes();
1996 if (unlikely(ret))
1997 return ret;
Theodore Ts'oc6e9d6f2014-07-17 04:13:05 -04001998 }
1999 return urandom_read(NULL, buf, count, NULL);
2000}
2001
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002/********************************************************************
2003 *
2004 * Sysctl interface
2005 *
2006 ********************************************************************/
2007
2008#ifdef CONFIG_SYSCTL
2009
2010#include <linux/sysctl.h>
2011
2012static int min_read_thresh = 8, min_write_thresh;
Greg Price8c2aa332013-12-05 19:19:29 -05002013static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014static int max_write_thresh = INPUT_POOL_WORDS * 32;
Fabio Estevamdb61ffe2017-01-31 14:36:07 -02002015static int random_min_urandom_seed = 60;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016static char sysctl_bootid[16];
2017
2018/*
Greg Pricef22052b2013-11-29 14:58:16 -05002019 * This function is used to return both the bootid UUID, and random
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 * UUID. The difference is in whether table->data is NULL; if it is,
2021 * then a new UUID is generated and returned to the user.
2022 *
Greg Pricef22052b2013-11-29 14:58:16 -05002023 * If the user accesses this via the proc interface, the UUID will be
2024 * returned as an ASCII string in the standard UUID format; if via the
2025 * sysctl system call, as 16 bytes of binary data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026 */
Joe Perchesa1514272013-06-13 19:37:35 -07002027static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 void __user *buffer, size_t *lenp, loff_t *ppos)
2029{
Joe Perchesa1514272013-06-13 19:37:35 -07002030 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031 unsigned char buf[64], tmp_uuid[16], *uuid;
2032
2033 uuid = table->data;
2034 if (!uuid) {
2035 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07002037 } else {
2038 static DEFINE_SPINLOCK(bootid_spinlock);
2039
2040 spin_lock(&bootid_spinlock);
2041 if (!uuid[8])
2042 generate_random_uuid(uuid);
2043 spin_unlock(&bootid_spinlock);
2044 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045
Joe Perches35900772009-12-14 18:01:11 -08002046 sprintf(buf, "%pU", uuid);
2047
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 fake_table.data = buf;
2049 fake_table.maxlen = sizeof(buf);
2050
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002051 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052}
2053
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002054/*
2055 * Return entropy available scaled to integral bits
2056 */
Joe Perches5eb10d92014-06-06 14:37:58 -07002057static int proc_do_entropy(struct ctl_table *table, int write,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002058 void __user *buffer, size_t *lenp, loff_t *ppos)
2059{
Joe Perches5eb10d92014-06-06 14:37:58 -07002060 struct ctl_table fake_table;
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002061 int entropy_count;
2062
2063 entropy_count = *(int *)table->data >> ENTROPY_SHIFT;
2064
2065 fake_table.data = &entropy_count;
2066 fake_table.maxlen = sizeof(entropy_count);
2067
2068 return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
2069}
2070
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07002072extern struct ctl_table random_table[];
2073struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 .procname = "poolsize",
2076 .data = &sysctl_poolsize,
2077 .maxlen = sizeof(int),
2078 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002079 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 },
2081 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 .procname = "entropy_avail",
2083 .maxlen = sizeof(int),
2084 .mode = 0444,
H. Peter Anvina283b5c2013-09-10 23:16:17 -04002085 .proc_handler = proc_do_entropy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 .data = &input_pool.entropy_count,
2087 },
2088 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 .procname = "read_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002090 .data = &random_read_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 .maxlen = sizeof(int),
2092 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002093 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 .extra1 = &min_read_thresh,
2095 .extra2 = &max_read_thresh,
2096 },
2097 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 .procname = "write_wakeup_threshold",
Greg Price2132a962013-12-06 21:28:03 -05002099 .data = &random_write_wakeup_bits,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 .maxlen = sizeof(int),
2101 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002102 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 .extra1 = &min_write_thresh,
2104 .extra2 = &max_write_thresh,
2105 },
2106 {
Theodore Ts'of5c27422013-09-22 15:14:32 -04002107 .procname = "urandom_min_reseed_secs",
2108 .data = &random_min_urandom_seed,
2109 .maxlen = sizeof(int),
2110 .mode = 0644,
2111 .proc_handler = proc_dointvec,
2112 },
2113 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 .procname = "boot_id",
2115 .data = &sysctl_bootid,
2116 .maxlen = 16,
2117 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002118 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 },
2120 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 .procname = "uuid",
2122 .maxlen = 16,
2123 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08002124 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 },
Theodore Ts'o43759d42014-06-14 21:43:13 -04002126#ifdef ADD_INTERRUPT_BENCH
2127 {
2128 .procname = "add_interrupt_avg_cycles",
2129 .data = &avg_cycles,
2130 .maxlen = sizeof(avg_cycles),
2131 .mode = 0444,
2132 .proc_handler = proc_doulongvec_minmax,
2133 },
2134 {
2135 .procname = "add_interrupt_avg_deviation",
2136 .data = &avg_deviation,
2137 .maxlen = sizeof(avg_deviation),
2138 .mode = 0444,
2139 .proc_handler = proc_doulongvec_minmax,
2140 },
2141#endif
Eric W. Biederman894d2492009-11-05 14:34:02 -08002142 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143};
2144#endif /* CONFIG_SYSCTL */
2145
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002146struct batched_entropy {
2147 union {
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002148 u64 entropy_u64[CHACHA20_BLOCK_SIZE / sizeof(u64)];
2149 u32 entropy_u32[CHACHA20_BLOCK_SIZE / sizeof(u32)];
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002150 };
2151 unsigned int position;
2152};
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002153static rwlock_t batched_entropy_reset_lock = __RW_LOCK_UNLOCKED(batched_entropy_reset_lock);
Eric Biggersb1132de2016-05-04 21:08:39 -04002154
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155/*
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002156 * Get a random word for internal kernel use only. The quality of the random
2157 * number is either as good as RDRAND or as good as /dev/urandom, with the
Jason A. Donenfelde297a782017-06-07 19:58:56 -04002158 * goal of being quite fast and not depleting entropy. In order to ensure
2159 * that the randomness provided by this function is okay, the function
2160 * wait_for_random_bytes() should be called and return 0 at least once
2161 * at any point prior.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 */
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002163static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64);
2164u64 get_random_u64(void)
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002165{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002166 u64 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002167 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002168 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002169 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002170 static void *previous;
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002171
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002172#if BITS_PER_LONG == 64
2173 if (arch_get_random_long((unsigned long *)&ret))
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002174 return ret;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002175#else
2176 if (arch_get_random_long((unsigned long *)&ret) &&
2177 arch_get_random_long((unsigned long *)&ret + 1))
2178 return ret;
2179#endif
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002180
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002181 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002182
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002183 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002184 batch = &get_cpu_var(batched_entropy_u64);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002185 if (use_lock)
2186 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002187 if (batch->position % ARRAY_SIZE(batch->entropy_u64) == 0) {
Eric Biggers9f480fa2017-11-22 11:51:39 -08002188 extract_crng((__u32 *)batch->entropy_u64);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002189 batch->position = 0;
2190 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002191 ret = batch->entropy_u64[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002192 if (use_lock)
2193 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002194 put_cpu_var(batched_entropy_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002195 return ret;
2196}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002197EXPORT_SYMBOL(get_random_u64);
Daniel Cashmanec9ee4a2016-02-26 15:19:34 -08002198
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002199static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32);
2200u32 get_random_u32(void)
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002201{
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002202 u32 ret;
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002203 bool use_lock;
Jason A. Donenfeld4a072c72017-06-15 00:45:26 +02002204 unsigned long flags = 0;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002205 struct batched_entropy *batch;
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002206 static void *previous;
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002207
2208 if (arch_get_random_int(&ret))
2209 return ret;
2210
Theodore Ts'oeecabf52017-06-08 04:16:59 -04002211 warn_unseeded_randomness(&previous);
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04002212
Sebastian Andrzej Siewior72e5c742017-06-30 16:37:13 +02002213 use_lock = READ_ONCE(crng_init) < 2;
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002214 batch = &get_cpu_var(batched_entropy_u32);
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002215 if (use_lock)
2216 read_lock_irqsave(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002217 if (batch->position % ARRAY_SIZE(batch->entropy_u32) == 0) {
Eric Biggers9f480fa2017-11-22 11:51:39 -08002218 extract_crng(batch->entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002219 batch->position = 0;
2220 }
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002221 ret = batch->entropy_u32[batch->position++];
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002222 if (use_lock)
2223 read_unlock_irqrestore(&batched_entropy_reset_lock, flags);
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002224 put_cpu_var(batched_entropy_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002225 return ret;
2226}
Jason A. Donenfeldc4404082017-01-22 16:34:08 +01002227EXPORT_SYMBOL(get_random_u32);
Jason A. Donenfeldf5b98462017-01-06 19:32:01 +01002228
Jason A. Donenfeldb169c132017-06-07 19:45:31 -04002229/* It's important to invalidate all potential batched entropy that might
2230 * be stored before the crng is initialized, which we can do lazily by
2231 * simply resetting the counter to zero so that it's re-extracted on the
2232 * next usage. */
2233static void invalidate_batched_entropy(void)
2234{
2235 int cpu;
2236 unsigned long flags;
2237
2238 write_lock_irqsave(&batched_entropy_reset_lock, flags);
2239 for_each_possible_cpu (cpu) {
2240 per_cpu_ptr(&batched_entropy_u32, cpu)->position = 0;
2241 per_cpu_ptr(&batched_entropy_u64, cpu)->position = 0;
2242 }
2243 write_unlock_irqrestore(&batched_entropy_reset_lock, flags);
2244}
2245
Jason Cooper99fdafd2016-10-11 13:53:52 -07002246/**
2247 * randomize_page - Generate a random, page aligned address
2248 * @start: The smallest acceptable address the caller will take.
2249 * @range: The size of the area, starting at @start, within which the
2250 * random address must fall.
2251 *
2252 * If @start + @range would overflow, @range is capped.
2253 *
2254 * NOTE: Historical use of randomize_range, which this replaces, presumed that
2255 * @start was already page aligned. We now align it regardless.
2256 *
2257 * Return: A page aligned address within [start, start + range). On error,
2258 * @start is returned.
2259 */
2260unsigned long
2261randomize_page(unsigned long start, unsigned long range)
2262{
2263 if (!PAGE_ALIGNED(start)) {
2264 range -= PAGE_ALIGN(start) - start;
2265 start = PAGE_ALIGN(start);
2266 }
2267
2268 if (start > ULONG_MAX - range)
2269 range = ULONG_MAX - start;
2270
2271 range >>= PAGE_SHIFT;
2272
2273 if (range == 0)
2274 return start;
2275
2276 return start + (get_random_long() % range << PAGE_SHIFT);
2277}
2278
Torsten Duwec84dbf62014-06-14 23:38:36 -04002279/* Interface for in-kernel drivers of true hardware RNGs.
2280 * Those devices may produce endless random bits and will be throttled
2281 * when our pool is full.
2282 */
2283void add_hwgenerator_randomness(const char *buffer, size_t count,
2284 size_t entropy)
2285{
2286 struct entropy_store *poolp = &input_pool;
2287
Theodore Ts'o43838a22018-04-11 13:27:52 -04002288 if (unlikely(crng_init == 0)) {
Theodore Ts'oe192be92016-06-12 18:13:36 -04002289 crng_fast_load(buffer, count);
2290 return;
Theodore Ts'o3371f3d2016-06-12 18:11:51 -04002291 }
Theodore Ts'oe192be92016-06-12 18:13:36 -04002292
2293 /* Suspend writing if we're above the trickle threshold.
2294 * We'll be woken up again once below random_write_wakeup_thresh,
2295 * or when the calling thread is about to terminate.
2296 */
2297 wait_event_interruptible(random_write_wait, kthread_should_stop() ||
2298 ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
Torsten Duwec84dbf62014-06-14 23:38:36 -04002299 mix_pool_bytes(poolp, buffer, count);
2300 credit_entropy_bits(poolp, entropy);
2301}
2302EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);