blob: 20651a2fd8a7de63f0c90575eca40c46f9b5d010 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * random.c -- A strong random number generator
3 *
Matt Mackall9e95ce22005-04-16 15:25:56 -07004 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All
7 * rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, and the entire permission notice in its entirety,
14 * including the disclaimer of warranties.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote
19 * products derived from this software without specific prior
20 * written permission.
21 *
22 * ALTERNATIVELY, this product may be distributed under the terms of
23 * the GNU General Public License, in which case the provisions of the GPL are
24 * required INSTEAD OF the above restrictions. (This clause is
25 * necessary due to a potential bad interaction between the GPL and
26 * the restrictions contained in a BSD-style copyright.)
27 *
28 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
31 * WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
32 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
34 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
35 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
38 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
39 * DAMAGE.
40 */
41
42/*
43 * (now, with legal B.S. out of the way.....)
44 *
45 * This routine gathers environmental noise from device drivers, etc.,
46 * and returns good random numbers, suitable for cryptographic use.
47 * Besides the obvious cryptographic uses, these numbers are also good
48 * for seeding TCP sequence numbers, and other places where it is
49 * desirable to have numbers which are not only random, but hard to
50 * predict by an attacker.
51 *
52 * Theory of operation
53 * ===================
54 *
55 * Computers are very predictable devices. Hence it is extremely hard
56 * to produce truly random numbers on a computer --- as opposed to
57 * pseudo-random numbers, which can easily generated by using a
58 * algorithm. Unfortunately, it is very easy for attackers to guess
59 * the sequence of pseudo-random number generators, and for some
60 * applications this is not acceptable. So instead, we must try to
61 * gather "environmental noise" from the computer's environment, which
62 * must be hard for outside attackers to observe, and use that to
63 * generate random numbers. In a Unix environment, this is best done
64 * from inside the kernel.
65 *
66 * Sources of randomness from the environment include inter-keyboard
67 * timings, inter-interrupt timings from some interrupts, and other
68 * events which are both (a) non-deterministic and (b) hard for an
69 * outside observer to measure. Randomness from these sources are
70 * added to an "entropy pool", which is mixed using a CRC-like function.
71 * This is not cryptographically strong, but it is adequate assuming
72 * the randomness is not chosen maliciously, and it is fast enough that
73 * the overhead of doing it on every interrupt is very reasonable.
74 * As random bytes are mixed into the entropy pool, the routines keep
75 * an *estimate* of how many bits of randomness have been stored into
76 * the random number generator's internal state.
77 *
78 * When random bytes are desired, they are obtained by taking the SHA
79 * hash of the contents of the "entropy pool". The SHA hash avoids
80 * exposing the internal state of the entropy pool. It is believed to
81 * be computationally infeasible to derive any useful information
82 * about the input of SHA from its output. Even if it is possible to
83 * analyze SHA in some clever way, as long as the amount of data
84 * returned from the generator is less than the inherent entropy in
85 * the pool, the output data is totally unpredictable. For this
86 * reason, the routine decreases its internal estimate of how many
87 * bits of "true randomness" are contained in the entropy pool as it
88 * outputs random numbers.
89 *
90 * If this estimate goes to zero, the routine can still generate
91 * random numbers; however, an attacker may (at least in theory) be
92 * able to infer the future output of the generator from prior
93 * outputs. This requires successful cryptanalysis of SHA, which is
94 * not believed to be feasible, but there is a remote possibility.
95 * Nonetheless, these numbers should be useful for the vast majority
96 * of purposes.
97 *
98 * Exported interfaces ---- output
99 * ===============================
100 *
101 * There are three exported interfaces; the first is one designed to
102 * be used from within the kernel:
103 *
104 * void get_random_bytes(void *buf, int nbytes);
105 *
106 * This interface will return the requested number of random bytes,
107 * and place it in the requested buffer.
108 *
109 * The two other interfaces are two character devices /dev/random and
110 * /dev/urandom. /dev/random is suitable for use when very high
111 * quality randomness is desired (for example, for key generation or
112 * one-time pads), as it will only return a maximum of the number of
113 * bits of randomness (as estimated by the random number generator)
114 * contained in the entropy pool.
115 *
116 * The /dev/urandom device does not have this limit, and will return
117 * as many bytes as are requested. As more and more random bytes are
118 * requested without giving time for the entropy pool to recharge,
119 * this will result in random numbers that are merely cryptographically
120 * strong. For many applications, however, this is acceptable.
121 *
122 * Exported interfaces ---- input
123 * ==============================
124 *
125 * The current exported interfaces for gathering environmental noise
126 * from the devices are:
127 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400128 * void add_device_randomness(const void *buf, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 * void add_input_randomness(unsigned int type, unsigned int code,
130 * unsigned int value);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400131 * void add_interrupt_randomness(int irq, int irq_flags);
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100132 * void add_disk_randomness(struct gendisk *disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 *
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400134 * add_device_randomness() is for adding data to the random pool that
135 * is likely to differ between two devices (or possibly even per boot).
136 * This would be things like MAC addresses or serial numbers, or the
137 * read-out of the RTC. This does *not* add any actual entropy to the
138 * pool, but it initializes the pool to different values for devices
139 * that might otherwise be identical and have very little entropy
140 * available to them (particularly common in the embedded world).
141 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 * add_input_randomness() uses the input layer interrupt timing, as well as
143 * the event type information from the hardware.
144 *
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400145 * add_interrupt_randomness() uses the interrupt timing as random
146 * inputs to the entropy pool. Using the cycle counters and the irq source
147 * as inputs, it feeds the randomness roughly once a second.
Jarod Wilson442a4ff2011-02-21 21:43:10 +1100148 *
149 * add_disk_randomness() uses what amounts to the seek time of block
150 * layer request events, on a per-disk_devt basis, as input to the
151 * entropy pool. Note that high-speed solid state drives with very low
152 * seek times do not make for good sources of entropy, as their seek
153 * times are usually fairly consistent.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 *
155 * All of these routines try to estimate how many bits of randomness a
156 * particular randomness source. They do this by keeping track of the
157 * first and second order deltas of the event timings.
158 *
159 * Ensuring unpredictability at system startup
160 * ============================================
161 *
162 * When any operating system starts up, it will go through a sequence
163 * of actions that are fairly predictable by an adversary, especially
164 * if the start-up does not involve interaction with a human operator.
165 * This reduces the actual number of bits of unpredictability in the
166 * entropy pool below the value in entropy_count. In order to
167 * counteract this effect, it helps to carry information in the
168 * entropy pool across shut-downs and start-ups. To do this, put the
169 * following lines an appropriate script which is run during the boot
170 * sequence:
171 *
172 * echo "Initializing random number generator..."
173 * random_seed=/var/run/random-seed
174 * # Carry a random seed from start-up to start-up
175 * # Load and then save the whole entropy pool
176 * if [ -f $random_seed ]; then
177 * cat $random_seed >/dev/urandom
178 * else
179 * touch $random_seed
180 * fi
181 * chmod 600 $random_seed
182 * dd if=/dev/urandom of=$random_seed count=1 bs=512
183 *
184 * and the following lines in an appropriate script which is run as
185 * the system is shutdown:
186 *
187 * # Carry a random seed from shut-down to start-up
188 * # Save the whole entropy pool
189 * echo "Saving random seed..."
190 * random_seed=/var/run/random-seed
191 * touch $random_seed
192 * chmod 600 $random_seed
193 * dd if=/dev/urandom of=$random_seed count=1 bs=512
194 *
195 * For example, on most modern systems using the System V init
196 * scripts, such code fragments would be found in
197 * /etc/rc.d/init.d/random. On older Linux systems, the correct script
198 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
199 *
200 * Effectively, these commands cause the contents of the entropy pool
201 * to be saved at shut-down time and reloaded into the entropy pool at
202 * start-up. (The 'dd' in the addition to the bootup script is to
203 * make sure that /etc/random-seed is different for every start-up,
204 * even if the system crashes without executing rc.0.) Even with
205 * complete knowledge of the start-up activities, predicting the state
206 * of the entropy pool requires knowledge of the previous history of
207 * the system.
208 *
209 * Configuring the /dev/random driver under Linux
210 * ==============================================
211 *
212 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
213 * the /dev/mem major number (#1). So if your system does not have
214 * /dev/random and /dev/urandom created already, they can be created
215 * by using the commands:
216 *
217 * mknod /dev/random c 1 8
218 * mknod /dev/urandom c 1 9
219 *
220 * Acknowledgements:
221 * =================
222 *
223 * Ideas for constructing this random number generator were derived
224 * from Pretty Good Privacy's random number generator, and from private
225 * discussions with Phil Karn. Colin Plumb provided a faster random
226 * number generator, which speed up the mixing function of the entropy
227 * pool, taken from PGPfone. Dale Worley has also contributed many
228 * useful ideas and suggestions to improve this driver.
229 *
230 * Any flaws in the design are solely my responsibility, and should
231 * not be attributed to the Phil, Colin, or any of authors of PGP.
232 *
233 * Further background information on this topic may be obtained from
234 * RFC 1750, "Randomness Recommendations for Security", by Donald
235 * Eastlake, Steve Crocker, and Jeff Schiller.
236 */
237
238#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239#include <linux/module.h>
240#include <linux/kernel.h>
241#include <linux/major.h>
242#include <linux/string.h>
243#include <linux/fcntl.h>
244#include <linux/slab.h>
245#include <linux/random.h>
246#include <linux/poll.h>
247#include <linux/init.h>
248#include <linux/fs.h>
249#include <linux/genhd.h>
250#include <linux/interrupt.h>
Andrea Righi27ac7922008-07-23 21:28:13 -0700251#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252#include <linux/spinlock.h>
253#include <linux/percpu.h>
254#include <linux/cryptohash.h>
Neil Horman5b739ef2009-06-18 19:50:21 +0800255#include <linux/fips.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400256#include <linux/ptrace.h>
Theodore Ts'oe6d49472012-07-05 10:21:01 -0400257#include <linux/kmemcheck.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Yinghai Lud178a1e2009-01-11 00:35:42 -0800259#ifdef CONFIG_GENERIC_HARDIRQS
260# include <linux/irq.h>
261#endif
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263#include <asm/processor.h>
264#include <asm/uaccess.h>
265#include <asm/irq.h>
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400266#include <asm/irq_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267#include <asm/io.h>
268
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400269#define CREATE_TRACE_POINTS
270#include <trace/events/random.h>
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272/*
273 * Configuration information
274 */
275#define INPUT_POOL_WORDS 128
276#define OUTPUT_POOL_WORDS 32
277#define SEC_XFER_SIZE 512
Matt Mackalle954bc92010-05-20 19:55:01 +1000278#define EXTRACT_SIZE 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400280#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282/*
283 * The minimum number of bits of entropy before we wake up a read on
284 * /dev/random. Should be enough to do a significant reseed.
285 */
286static int random_read_wakeup_thresh = 64;
287
288/*
289 * If the entropy count falls under this number of bits, then we
290 * should wake up processes which are selecting or polling on write
291 * access to /dev/random.
292 */
293static int random_write_wakeup_thresh = 128;
294
295/*
296 * When the input pool goes over trickle_thresh, start dropping most
297 * samples to avoid wasting CPU time and reduce lock contention.
298 */
299
Christoph Lameter6c036522005-07-07 17:56:59 -0700300static int trickle_thresh __read_mostly = INPUT_POOL_WORDS * 28;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
Matt Mackall90b75ee2008-04-29 01:02:55 -0700302static DEFINE_PER_CPU(int, trickle_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
304/*
305 * A pool of size .poolwords is stirred with a primitive polynomial
306 * of degree .poolwords over GF(2). The taps for various sizes are
307 * defined below. They are chosen to be evenly spaced (minimum RMS
308 * distance from evenly spaced; the numbers in the comments are a
309 * scaled squared error sum) except for the last tap, which is 1 to
310 * get the twisting happening as fast as possible.
311 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400312
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313static struct poolinfo {
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400314 int poolbitshift, poolwords, poolbytes, poolbits;
315#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 int tap1, tap2, tap3, tap4, tap5;
317} poolinfo_table[] = {
318 /* x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 -- 105 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400319 { S(128), 103, 76, 51, 25, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 /* x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400321 { S(32), 26, 20, 14, 7, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322#if 0
323 /* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400324 { S(2048), 1638, 1231, 819, 411, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 /* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400327 { S(1024), 817, 615, 412, 204, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
329 /* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400330 { S(1024), 819, 616, 410, 207, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332 /* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400333 { S(512), 411, 308, 208, 104, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335 /* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400336 { S(512), 409, 307, 206, 102, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 /* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400338 { S(512), 409, 309, 205, 103, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
340 /* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400341 { S(256), 205, 155, 101, 52, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
343 /* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400344 { S(128), 103, 78, 51, 27, 2 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346 /* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400347 { S(64), 52, 39, 26, 14, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348#endif
349};
350
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351/*
352 * For the purposes of better mixing, we use the CRC-32 polynomial as
353 * well to make a twisted Generalized Feedback Shift Reigster
354 *
355 * (See M. Matsumoto & Y. Kurita, 1992. Twisted GFSR generators. ACM
356 * Transactions on Modeling and Computer Simulation 2(3):179-194.
357 * Also see M. Matsumoto & Y. Kurita, 1994. Twisted GFSR generators
358 * II. ACM Transactions on Mdeling and Computer Simulation 4:254-266)
359 *
360 * Thanks to Colin Plumb for suggesting this.
361 *
362 * We have not analyzed the resultant polynomial to prove it primitive;
363 * in fact it almost certainly isn't. Nonetheless, the irreducible factors
364 * of a random large-degree polynomial over GF(2) are more than large enough
365 * that periodicity is not a concern.
366 *
367 * The input hash is much less sensitive than the output hash. All
368 * that we want of it is that it be a good non-cryptographic hash;
369 * i.e. it not produce collisions when fed "random" data of the sort
370 * we expect to see. As long as the pool state differs for different
371 * inputs, we have preserved the input entropy and done a good job.
372 * The fact that an intelligent attacker can construct inputs that
373 * will produce controlled alterations to the pool's state is not
374 * important because we don't consider such inputs to contribute any
375 * randomness. The only property we need with respect to them is that
376 * the attacker can't increase his/her knowledge of the pool's state.
377 * Since all additions are reversible (knowing the final state and the
378 * input, you can reconstruct the initial state), if an attacker has
379 * any uncertainty about the initial state, he/she can only shuffle
380 * that uncertainty about, but never cause any collisions (which would
381 * decrease the uncertainty).
382 *
383 * The chosen system lets the state of the pool be (essentially) the input
384 * modulo the generator polymnomial. Now, for random primitive polynomials,
385 * this is a universal class of hash functions, meaning that the chance
386 * of a collision is limited by the attacker's knowledge of the generator
387 * polynomail, so if it is chosen at random, an attacker can never force
388 * a collision. Here, we use a fixed polynomial, but we *can* assume that
389 * ###--> it is unknown to the processes generating the input entropy. <-###
390 * Because of this important property, this is a good, collision-resistant
391 * hash; hash collisions will occur no more often than chance.
392 */
393
394/*
395 * Static global variables
396 */
397static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
398static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700399static struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030401static bool debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402module_param(debug, bool, 0644);
Matt Mackall90b75ee2008-04-29 01:02:55 -0700403#define DEBUG_ENT(fmt, arg...) do { \
404 if (debug) \
405 printk(KERN_DEBUG "random %04d %04d %04d: " \
406 fmt,\
407 input_pool.entropy_count,\
408 blocking_pool.entropy_count,\
409 nonblocking_pool.entropy_count,\
410 ## arg); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412/**********************************************************************
413 *
414 * OS independent entropy store. Here are the functions which handle
415 * storing entropy in an entropy pool.
416 *
417 **********************************************************************/
418
419struct entropy_store;
420struct entropy_store {
Matt Mackall43358202008-04-29 01:03:01 -0700421 /* read-only data: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 struct poolinfo *poolinfo;
423 __u32 *pool;
424 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 struct entropy_store *pull;
Richard Kennedy4015d9a2010-07-31 19:58:00 +0800426 int limit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
428 /* read-write data: */
Matt Mackall43358202008-04-29 01:03:01 -0700429 spinlock_t lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 unsigned add_ptr;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400431 unsigned input_rotate;
Matt Mackallcda796a2009-01-06 14:42:55 -0800432 int entropy_count;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400433 int entropy_total;
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400434 unsigned int initialized:1;
Jarod Wilsonec8f02da2012-11-06 10:42:42 -0500435 bool last_data_init;
Matt Mackalle954bc92010-05-20 19:55:01 +1000436 __u8 last_data[EXTRACT_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437};
438
439static __u32 input_pool_data[INPUT_POOL_WORDS];
440static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];
441static __u32 nonblocking_pool_data[OUTPUT_POOL_WORDS];
442
443static struct entropy_store input_pool = {
444 .poolinfo = &poolinfo_table[0],
445 .name = "input",
446 .limit = 1,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200447 .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 .pool = input_pool_data
449};
450
451static struct entropy_store blocking_pool = {
452 .poolinfo = &poolinfo_table[1],
453 .name = "blocking",
454 .limit = 1,
455 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200456 .lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 .pool = blocking_pool_data
458};
459
460static struct entropy_store nonblocking_pool = {
461 .poolinfo = &poolinfo_table[1],
462 .name = "nonblocking",
463 .pull = &input_pool,
Thomas Gleixnereece09e2011-07-17 21:25:03 +0200464 .lock = __SPIN_LOCK_UNLOCKED(nonblocking_pool.lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 .pool = nonblocking_pool_data
466};
467
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400468static __u32 const twist_table[8] = {
469 0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
470 0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472/*
Matt Mackalle68e5b62008-04-29 01:03:05 -0700473 * This function adds bytes into the entropy "pool". It does not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 * update the entropy estimate. The caller should call
Matt Mackalladc782d2008-04-29 01:03:07 -0700475 * credit_entropy_bits if this is appropriate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 *
477 * The pool is stirred with a primitive polynomial of the appropriate
478 * degree, and then twisted. We twist by three bits at a time because
479 * it's cheap to do so and helps slightly in the expected case where
480 * the entropy is concentrated in the low-order bits.
481 */
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400482static void _mix_pool_bytes(struct entropy_store *r, const void *in,
483 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484{
Matt Mackall993ba212008-04-29 01:03:04 -0700485 unsigned long i, j, tap1, tap2, tap3, tap4, tap5;
Matt Mackallfeee7692008-04-29 01:03:02 -0700486 int input_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 int wordmask = r->poolinfo->poolwords - 1;
Matt Mackalle68e5b62008-04-29 01:03:05 -0700488 const char *bytes = in;
Matt Mackall6d38b822008-04-29 01:03:03 -0700489 __u32 w;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 tap1 = r->poolinfo->tap1;
492 tap2 = r->poolinfo->tap2;
493 tap3 = r->poolinfo->tap3;
494 tap4 = r->poolinfo->tap4;
495 tap5 = r->poolinfo->tap5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Theodore Ts'o902c0982012-07-04 10:38:30 -0400497 smp_rmb();
498 input_rotate = ACCESS_ONCE(r->input_rotate);
499 i = ACCESS_ONCE(r->add_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Matt Mackalle68e5b62008-04-29 01:03:05 -0700501 /* mix one byte at a time to simplify size handling and churn faster */
502 while (nbytes--) {
503 w = rol32(*bytes++, input_rotate & 31);
Matt Mackall993ba212008-04-29 01:03:04 -0700504 i = (i - 1) & wordmask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
506 /* XOR in the various taps */
Matt Mackall993ba212008-04-29 01:03:04 -0700507 w ^= r->pool[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 w ^= r->pool[(i + tap1) & wordmask];
509 w ^= r->pool[(i + tap2) & wordmask];
510 w ^= r->pool[(i + tap3) & wordmask];
511 w ^= r->pool[(i + tap4) & wordmask];
512 w ^= r->pool[(i + tap5) & wordmask];
Matt Mackall993ba212008-04-29 01:03:04 -0700513
514 /* Mix the result back in with a twist */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 r->pool[i] = (w >> 3) ^ twist_table[w & 7];
Matt Mackallfeee7692008-04-29 01:03:02 -0700516
517 /*
518 * Normally, we add 7 bits of rotation to the pool.
519 * At the beginning of the pool, add an extra 7 bits
520 * rotation, so that successive passes spread the
521 * input bits across the pool evenly.
522 */
523 input_rotate += i ? 7 : 14;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 }
525
Theodore Ts'o902c0982012-07-04 10:38:30 -0400526 ACCESS_ONCE(r->input_rotate) = input_rotate;
527 ACCESS_ONCE(r->add_ptr) = i;
528 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Matt Mackall993ba212008-04-29 01:03:04 -0700530 if (out)
531 for (j = 0; j < 16; j++)
Matt Mackalle68e5b62008-04-29 01:03:05 -0700532 ((__u32 *)out)[j] = r->pool[(i - j) & wordmask];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
534
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400535static void __mix_pool_bytes(struct entropy_store *r, const void *in,
Theodore Ts'o902c0982012-07-04 10:38:30 -0400536 int nbytes, __u8 out[64])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537{
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400538 trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
539 _mix_pool_bytes(r, in, nbytes, out);
540}
541
542static void mix_pool_bytes(struct entropy_store *r, const void *in,
543 int nbytes, __u8 out[64])
544{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400545 unsigned long flags;
546
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400547 trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400548 spin_lock_irqsave(&r->lock, flags);
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400549 _mix_pool_bytes(r, in, nbytes, out);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400550 spin_unlock_irqrestore(&r->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551}
552
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400553struct fast_pool {
554 __u32 pool[4];
555 unsigned long last;
556 unsigned short count;
557 unsigned char rotate;
558 unsigned char last_timer_intr;
559};
560
561/*
562 * This is a fast mixing routine used by the interrupt randomness
563 * collector. It's hardcoded for an 128 bit pool and assumes that any
564 * locks that might be needed are taken by the caller.
565 */
566static void fast_mix(struct fast_pool *f, const void *in, int nbytes)
567{
568 const char *bytes = in;
569 __u32 w;
570 unsigned i = f->count;
571 unsigned input_rotate = f->rotate;
572
573 while (nbytes--) {
574 w = rol32(*bytes++, input_rotate & 31) ^ f->pool[i & 3] ^
575 f->pool[(i + 1) & 3];
576 f->pool[i & 3] = (w >> 3) ^ twist_table[w & 7];
577 input_rotate += (i++ & 3) ? 7 : 14;
578 }
579 f->count = i;
580 f->rotate = input_rotate;
581}
582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583/*
584 * Credit (or debit) the entropy store with n bits of entropy
585 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700586static void credit_entropy_bits(struct entropy_store *r, int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587{
Theodore Ts'o902c0982012-07-04 10:38:30 -0400588 int entropy_count, orig;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Matt Mackalladc782d2008-04-29 01:03:07 -0700590 if (!nbits)
591 return;
592
Matt Mackalladc782d2008-04-29 01:03:07 -0700593 DEBUG_ENT("added %d entropy credits to %s\n", nbits, r->name);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400594retry:
595 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
Andrew Morton8b76f462008-09-02 14:36:14 -0700596 entropy_count += nbits;
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400597
Andrew Morton8b76f462008-09-02 14:36:14 -0700598 if (entropy_count < 0) {
Matt Mackalladc782d2008-04-29 01:03:07 -0700599 DEBUG_ENT("negative entropy/overflow\n");
Andrew Morton8b76f462008-09-02 14:36:14 -0700600 entropy_count = 0;
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400601 } else if (entropy_count > r->poolinfo->poolbits)
602 entropy_count = r->poolinfo->poolbits;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400603 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
604 goto retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400606 if (!r->initialized && nbits > 0) {
607 r->entropy_total += nbits;
608 if (r->entropy_total > 128)
609 r->initialized = 1;
610 }
611
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400612 trace_credit_entropy_bits(r->name, nbits, entropy_count,
613 r->entropy_total, _RET_IP_);
614
Matt Mackall88c730d2008-04-29 01:02:56 -0700615 /* should we wake readers? */
Andrew Morton8b76f462008-09-02 14:36:14 -0700616 if (r == &input_pool && entropy_count >= random_read_wakeup_thresh) {
Matt Mackall88c730d2008-04-29 01:02:56 -0700617 wake_up_interruptible(&random_read_wait);
Jeff Dike9a6f70b2008-04-29 01:03:08 -0700618 kill_fasync(&fasync, SIGIO, POLL_IN);
619 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620}
621
622/*********************************************************************
623 *
624 * Entropy input management
625 *
626 *********************************************************************/
627
628/* There is one of these per entropy source */
629struct timer_rand_state {
630 cycles_t last_time;
Matt Mackall90b75ee2008-04-29 01:02:55 -0700631 long last_delta, last_delta2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 unsigned dont_count_entropy:1;
633};
634
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400635/*
636 * Add device- or boot-specific data to the input and nonblocking
637 * pools to help initialize them to unique values.
638 *
639 * None of this adds any entropy, it is meant to avoid the
640 * problem of the nonblocking pool having similar initial state
641 * across largely identical devices.
642 */
643void add_device_randomness(const void *buf, unsigned int size)
644{
Theodore Ts'o61875f32013-09-21 13:58:22 -0400645 unsigned long time = random_get_entropy() ^ jiffies;
Linus Torvaldsa2080a62012-07-04 11:16:01 -0400646
647 mix_pool_bytes(&input_pool, buf, size, NULL);
648 mix_pool_bytes(&input_pool, &time, sizeof(time), NULL);
649 mix_pool_bytes(&nonblocking_pool, buf, size, NULL);
650 mix_pool_bytes(&nonblocking_pool, &time, sizeof(time), NULL);
651}
652EXPORT_SYMBOL(add_device_randomness);
653
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700654static struct timer_rand_state input_timer_state;
655
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656/*
657 * This function adds entropy to the entropy "pool" by using timing
658 * delays. It uses the timer_rand_state structure to make an estimate
659 * of how many bits of entropy this call has added to the pool.
660 *
661 * The number "num" is also added to the pool - it should somehow describe
662 * the type of event which just happened. This is currently 0-255 for
663 * keyboard scan codes, and 256 upwards for interrupts.
664 *
665 */
666static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
667{
668 struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 long jiffies;
Linus Torvaldscf833d02011-12-22 11:36:22 -0800670 unsigned cycles;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 unsigned num;
672 } sample;
673 long delta, delta2, delta3;
674
675 preempt_disable();
676 /* if over the trickle threshold, use only 1 in 4096 samples */
677 if (input_pool.entropy_count > trickle_thresh &&
Christoph Lameterb29c6172010-12-06 11:40:06 -0600678 ((__this_cpu_inc_return(trickle_count) - 1) & 0xfff))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 goto out;
680
681 sample.jiffies = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -0400682 sample.cycles = random_get_entropy();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 sample.num = num;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400684 mix_pool_bytes(&input_pool, &sample, sizeof(sample), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
686 /*
687 * Calculate number of bits of randomness we probably added.
688 * We take into account the first, second and third-order deltas
689 * in order to make our estimate.
690 */
691
692 if (!state->dont_count_entropy) {
693 delta = sample.jiffies - state->last_time;
694 state->last_time = sample.jiffies;
695
696 delta2 = delta - state->last_delta;
697 state->last_delta = delta;
698
699 delta3 = delta2 - state->last_delta2;
700 state->last_delta2 = delta2;
701
702 if (delta < 0)
703 delta = -delta;
704 if (delta2 < 0)
705 delta2 = -delta2;
706 if (delta3 < 0)
707 delta3 = -delta3;
708 if (delta > delta2)
709 delta = delta2;
710 if (delta > delta3)
711 delta = delta3;
712
713 /*
714 * delta is now minimum absolute delta.
715 * Round down by 1 bit on general principles,
716 * and limit entropy entimate to 12 bits.
717 */
Matt Mackalladc782d2008-04-29 01:03:07 -0700718 credit_entropy_bits(&input_pool,
719 min_t(int, fls(delta>>1), 11));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721out:
722 preempt_enable();
723}
724
Stephen Hemmingerd2515752006-01-11 12:17:38 -0800725void add_input_randomness(unsigned int type, unsigned int code,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 unsigned int value)
727{
728 static unsigned char last_value;
729
730 /* ignore autorepeat and the like */
731 if (value == last_value)
732 return;
733
734 DEBUG_ENT("input event\n");
735 last_value = value;
736 add_timer_randomness(&input_timer_state,
737 (type << 4) ^ code ^ (code >> 4) ^ value);
738}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400739EXPORT_SYMBOL_GPL(add_input_randomness);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400741static DEFINE_PER_CPU(struct fast_pool, irq_randomness);
742
743void add_interrupt_randomness(int irq, int irq_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400745 struct entropy_store *r;
746 struct fast_pool *fast_pool = &__get_cpu_var(irq_randomness);
747 struct pt_regs *regs = get_irq_regs();
748 unsigned long now = jiffies;
Theodore Ts'o61875f32013-09-21 13:58:22 -0400749 __u32 input[4], cycles = random_get_entropy();
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700750
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400751 input[0] = cycles ^ jiffies;
752 input[1] = irq;
753 if (regs) {
754 __u64 ip = instruction_pointer(regs);
755 input[2] = ip;
756 input[3] = ip >> 32;
757 }
Yinghai Lu3060d6f2008-08-19 20:50:08 -0700758
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400759 fast_mix(fast_pool, input, sizeof(input));
760
761 if ((fast_pool->count & 1023) &&
762 !time_after(now, fast_pool->last + HZ))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 return;
764
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400765 fast_pool->last = now;
766
767 r = nonblocking_pool.initialized ? &input_pool : &nonblocking_pool;
Theodore Ts'o902c0982012-07-04 10:38:30 -0400768 __mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool), NULL);
Theodore Ts'o775f4b22012-07-02 07:52:16 -0400769 /*
770 * If we don't have a valid cycle counter, and we see
771 * back-to-back timer interrupts, then skip giving credit for
772 * any entropy.
773 */
774 if (cycles == 0) {
775 if (irq_flags & __IRQF_TIMER) {
776 if (fast_pool->last_timer_intr)
777 return;
778 fast_pool->last_timer_intr = 1;
779 } else
780 fast_pool->last_timer_intr = 0;
781 }
782 credit_entropy_bits(r, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783}
784
David Howells93614012006-09-30 20:45:40 +0200785#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786void add_disk_randomness(struct gendisk *disk)
787{
788 if (!disk || !disk->random)
789 return;
790 /* first major is 1, so we get >= 0x200 here */
Tejun Heof331c022008-09-03 09:01:48 +0200791 DEBUG_ENT("disk event %d:%d\n",
792 MAJOR(disk_devt(disk)), MINOR(disk_devt(disk)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Tejun Heof331c022008-09-03 09:01:48 +0200794 add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795}
David Howells93614012006-09-30 20:45:40 +0200796#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798/*********************************************************************
799 *
800 * Entropy extraction routines
801 *
802 *********************************************************************/
803
Matt Mackall90b75ee2008-04-29 01:02:55 -0700804static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 size_t nbytes, int min, int rsvd);
806
807/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300808 * This utility inline function is responsible for transferring entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 * from the primary pool to the secondary extraction pool. We make
810 * sure we pull enough for a 'catastrophic reseed'.
811 */
812static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
813{
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400814 __u32 tmp[OUTPUT_POOL_WORDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
816 if (r->pull && r->entropy_count < nbytes * 8 &&
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400817 r->entropy_count < r->poolinfo->poolbits) {
Matt Mackall5a021e92007-07-19 11:30:14 -0700818 /* If we're limited, always leave two wakeup worth's BITS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 int rsvd = r->limit ? 0 : random_read_wakeup_thresh/4;
Matt Mackall5a021e92007-07-19 11:30:14 -0700820 int bytes = nbytes;
821
822 /* pull at least as many as BYTES as wakeup BITS */
823 bytes = max_t(int, bytes, random_read_wakeup_thresh / 8);
824 /* but never more than the buffer size */
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400825 bytes = min_t(int, bytes, sizeof(tmp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
827 DEBUG_ENT("going to reseed %s with %d bits "
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200828 "(%zu of %d requested)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 r->name, bytes * 8, nbytes * 8, r->entropy_count);
830
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400831 bytes = extract_entropy(r->pull, tmp, bytes,
Matt Mackall90b75ee2008-04-29 01:02:55 -0700832 random_read_wakeup_thresh / 8, rsvd);
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400833 mix_pool_bytes(r, tmp, bytes, NULL);
Matt Mackalladc782d2008-04-29 01:03:07 -0700834 credit_entropy_bits(r, bytes*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 }
836}
837
838/*
839 * These functions extracts randomness from the "entropy pool", and
840 * returns it in a buffer.
841 *
842 * The min parameter specifies the minimum amount we can pull before
843 * failing to avoid races that defeat catastrophic reseeding while the
844 * reserved parameter indicates how much entropy we must leave in the
845 * pool after each pull to avoid starving other readers.
846 *
847 * Note: extract_entropy() assumes that .poolwords is a multiple of 16 words.
848 */
849
850static size_t account(struct entropy_store *r, size_t nbytes, int min,
851 int reserved)
852{
853 unsigned long flags;
Theodore Ts'ob9809552013-03-04 11:59:12 -0500854 int wakeup_write = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 /* Hold lock while accounting */
857 spin_lock_irqsave(&r->lock, flags);
858
H. Peter Anvin9ed17b72013-09-10 23:16:17 -0400859 BUG_ON(r->entropy_count > r->poolinfo->poolbits);
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200860 DEBUG_ENT("trying to extract %zu bits from %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 nbytes * 8, r->name);
862
863 /* Can we pull enough? */
864 if (r->entropy_count / 8 < min + reserved) {
865 nbytes = 0;
866 } else {
Jiri Kosina10b3a322013-05-24 15:55:33 -0700867 int entropy_count, orig;
868retry:
869 entropy_count = orig = ACCESS_ONCE(r->entropy_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 /* If limited, never pull more than available */
Jiri Kosina10b3a322013-05-24 15:55:33 -0700871 if (r->limit && nbytes + reserved >= entropy_count / 8)
872 nbytes = entropy_count/8 - reserved;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Jiri Kosina10b3a322013-05-24 15:55:33 -0700874 if (entropy_count / 8 >= nbytes + reserved) {
875 entropy_count -= nbytes*8;
876 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
877 goto retry;
878 } else {
879 entropy_count = reserved;
880 if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
881 goto retry;
882 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Jiri Kosina10b3a322013-05-24 15:55:33 -0700884 if (entropy_count < random_write_wakeup_thresh)
Theodore Ts'ob9809552013-03-04 11:59:12 -0500885 wakeup_write = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 }
887
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +0200888 DEBUG_ENT("debiting %zu entropy credits from %s%s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 nbytes * 8, r->name, r->limit ? "" : " (unlimited)");
890
891 spin_unlock_irqrestore(&r->lock, flags);
892
Theodore Ts'ob9809552013-03-04 11:59:12 -0500893 if (wakeup_write) {
894 wake_up_interruptible(&random_write_wait);
895 kill_fasync(&fasync, SIGIO, POLL_OUT);
896 }
897
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 return nbytes;
899}
900
901static void extract_buf(struct entropy_store *r, __u8 *out)
902{
Matt Mackall602b6ae2007-05-29 21:54:27 -0500903 int i;
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400904 union {
905 __u32 w[5];
Theodore Ts'o85a1f772013-09-21 18:06:02 -0400906 unsigned long l[LONGS(20)];
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400907 } hash;
908 __u32 workspace[SHA_WORKSPACE_WORDS];
Matt Mackalle68e5b62008-04-29 01:03:05 -0700909 __u8 extract[64];
Theodore Ts'o902c0982012-07-04 10:38:30 -0400910 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700912 /* Generate a hash across the pool, 16 words (512 bits) at a time */
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400913 sha_init(hash.w);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400914 spin_lock_irqsave(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700915 for (i = 0; i < r->poolinfo->poolwords; i += 16)
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400916 sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
918 /*
Theodore Ts'o85a1f772013-09-21 18:06:02 -0400919 * If we have a architectural hardware random number
920 * generator, mix that in, too.
921 */
922 for (i = 0; i < LONGS(20); i++) {
923 unsigned long v;
924 if (!arch_get_random_long(&v))
925 break;
926 hash.l[i] ^= v;
927 }
928
929 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700930 * We mix the hash back into the pool to prevent backtracking
931 * attacks (where the attacker knows the state of the pool
932 * plus the current outputs, and attempts to find previous
933 * ouputs), unless the hash function can be inverted. By
934 * mixing at least a SHA1 worth of hash data back, we make
935 * brute-forcing the feedback as hard as brute-forcing the
936 * hash.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400938 __mix_pool_bytes(r, hash.w, sizeof(hash.w), extract);
Theodore Ts'o902c0982012-07-04 10:38:30 -0400939 spin_unlock_irqrestore(&r->lock, flags);
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700940
941 /*
942 * To avoid duplicates, we atomically extract a portion of the
943 * pool while mixing, and hash one final time.
944 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400945 sha_transform(hash.w, extract, workspace);
Matt Mackallffd8d3f2008-04-29 01:02:59 -0700946 memset(extract, 0, sizeof(extract));
947 memset(workspace, 0, sizeof(workspace));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948
949 /*
Matt Mackall1c0ad3d2008-04-29 01:03:00 -0700950 * In case the hash function has some recognizable output
951 * pattern, we fold it in half. Thus, we always feed back
952 * twice as much data as we output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 */
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400954 hash.w[0] ^= hash.w[3];
955 hash.w[1] ^= hash.w[4];
956 hash.w[2] ^= rol32(hash.w[2], 16);
957
H. Peter Anvind2e7c962012-07-27 22:26:08 -0400958 memcpy(out, &hash, EXTRACT_SIZE);
959 memset(&hash, 0, sizeof(hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960}
961
Matt Mackall90b75ee2008-04-29 01:02:55 -0700962static ssize_t extract_entropy(struct entropy_store *r, void *buf,
Theodore Ts'o902c0982012-07-04 10:38:30 -0400963 size_t nbytes, int min, int reserved)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964{
965 ssize_t ret = 0, i;
966 __u8 tmp[EXTRACT_SIZE];
Jarod Wilson1e7e2e02013-05-24 15:55:31 -0700967 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968
Jarod Wilsonec8f02da2012-11-06 10:42:42 -0500969 /* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
Jarod Wilson1e7e2e02013-05-24 15:55:31 -0700970 if (fips_enabled) {
971 spin_lock_irqsave(&r->lock, flags);
972 if (!r->last_data_init) {
973 r->last_data_init = true;
974 spin_unlock_irqrestore(&r->lock, flags);
975 trace_extract_entropy(r->name, EXTRACT_SIZE,
976 r->entropy_count, _RET_IP_);
977 xfer_secondary_pool(r, EXTRACT_SIZE);
978 extract_buf(r, tmp);
979 spin_lock_irqsave(&r->lock, flags);
980 memcpy(r->last_data, tmp, EXTRACT_SIZE);
981 }
982 spin_unlock_irqrestore(&r->lock, flags);
983 }
Jarod Wilsonec8f02da2012-11-06 10:42:42 -0500984
Theodore Ts'o00ce1db2012-07-04 16:19:30 -0400985 trace_extract_entropy(r->name, nbytes, r->entropy_count, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 xfer_secondary_pool(r, nbytes);
987 nbytes = account(r, nbytes, min, reserved);
988
989 while (nbytes) {
990 extract_buf(r, tmp);
Neil Horman5b739ef2009-06-18 19:50:21 +0800991
Matt Mackalle954bc92010-05-20 19:55:01 +1000992 if (fips_enabled) {
Neil Horman5b739ef2009-06-18 19:50:21 +0800993 spin_lock_irqsave(&r->lock, flags);
994 if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
995 panic("Hardware RNG duplicated output!\n");
996 memcpy(r->last_data, tmp, EXTRACT_SIZE);
997 spin_unlock_irqrestore(&r->lock, flags);
998 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 i = min_t(int, nbytes, EXTRACT_SIZE);
1000 memcpy(buf, tmp, i);
1001 nbytes -= i;
1002 buf += i;
1003 ret += i;
1004 }
1005
1006 /* Wipe data just returned from memory */
1007 memset(tmp, 0, sizeof(tmp));
1008
1009 return ret;
1010}
1011
1012static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
1013 size_t nbytes)
1014{
1015 ssize_t ret = 0, i;
1016 __u8 tmp[EXTRACT_SIZE];
1017
Theodore Ts'o00ce1db2012-07-04 16:19:30 -04001018 trace_extract_entropy_user(r->name, nbytes, r->entropy_count, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 xfer_secondary_pool(r, nbytes);
1020 nbytes = account(r, nbytes, 0, 0);
1021
1022 while (nbytes) {
1023 if (need_resched()) {
1024 if (signal_pending(current)) {
1025 if (ret == 0)
1026 ret = -ERESTARTSYS;
1027 break;
1028 }
1029 schedule();
1030 }
1031
1032 extract_buf(r, tmp);
1033 i = min_t(int, nbytes, EXTRACT_SIZE);
1034 if (copy_to_user(buf, tmp, i)) {
1035 ret = -EFAULT;
1036 break;
1037 }
1038
1039 nbytes -= i;
1040 buf += i;
1041 ret += i;
1042 }
1043
1044 /* Wipe data just returned from memory */
1045 memset(tmp, 0, sizeof(tmp));
1046
1047 return ret;
1048}
1049
1050/*
1051 * This function is the exported kernel interface. It returns some
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001052 * number of good random numbers, suitable for key generation, seeding
1053 * TCP sequence numbers, etc. It does not use the hw random number
1054 * generator, if available; use get_random_bytes_arch() for that.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 */
1056void get_random_bytes(void *buf, int nbytes)
1057{
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001058 extract_entropy(&nonblocking_pool, buf, nbytes, 0, 0);
1059}
1060EXPORT_SYMBOL(get_random_bytes);
1061
1062/*
1063 * This function will use the architecture-specific hardware random
1064 * number generator if it is available. The arch-specific hw RNG will
1065 * almost certainly be faster than what we can do in software, but it
1066 * is impossible to verify that it is implemented securely (as
1067 * opposed, to, say, the AES encryption of a sequence number using a
1068 * key known by the NSA). So it's useful if we need the speed, but
1069 * only if we're willing to trust the hardware manufacturer not to
1070 * have put in a back door.
1071 */
1072void get_random_bytes_arch(void *buf, int nbytes)
1073{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001074 char *p = buf;
1075
Theodore Ts'o00ce1db2012-07-04 16:19:30 -04001076 trace_get_random_bytes(nbytes, _RET_IP_);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001077 while (nbytes) {
1078 unsigned long v;
1079 int chunk = min(nbytes, (int)sizeof(unsigned long));
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001080
H. Peter Anvin63d77172011-07-31 13:54:50 -07001081 if (!arch_get_random_long(&v))
1082 break;
1083
Luck, Tonybd29e562011-11-16 10:50:56 -08001084 memcpy(p, &v, chunk);
H. Peter Anvin63d77172011-07-31 13:54:50 -07001085 p += chunk;
1086 nbytes -= chunk;
1087 }
1088
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001089 if (nbytes)
1090 extract_entropy(&nonblocking_pool, p, nbytes, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091}
Theodore Ts'oc2557a32012-07-05 10:35:23 -04001092EXPORT_SYMBOL(get_random_bytes_arch);
1093
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
1095/*
1096 * init_std_data - initialize pool with system data
1097 *
1098 * @r: pool to initialize
1099 *
1100 * This function clears the pool's entropy count and mixes some system
1101 * data into the pool to prepare it for use. The pool is not cleared
1102 * as that can only decrease the entropy in the pool.
1103 */
1104static void init_std_data(struct entropy_store *r)
1105{
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001106 int i;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001107 ktime_t now = ktime_get_real();
1108 unsigned long rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 r->entropy_count = 0;
Theodore Ts'o775f4b22012-07-02 07:52:16 -04001111 r->entropy_total = 0;
Jarod Wilsonec8f02da2012-11-06 10:42:42 -05001112 r->last_data_init = false;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001113 mix_pool_bytes(r, &now, sizeof(now), NULL);
H. Peter Anvin9ed17b72013-09-10 23:16:17 -04001114 for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
Theodore Ts'o902c0982012-07-04 10:38:30 -04001115 if (!arch_get_random_long(&rv))
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001116 break;
Theodore Ts'o902c0982012-07-04 10:38:30 -04001117 mix_pool_bytes(r, &rv, sizeof(rv), NULL);
Theodore Ts'o3e88bdf2011-12-22 16:28:01 -05001118 }
Theodore Ts'o902c0982012-07-04 10:38:30 -04001119 mix_pool_bytes(r, utsname(), sizeof(*(utsname())), NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120}
1121
Tony Luckcbc96b72012-07-23 09:47:57 -07001122/*
1123 * Note that setup_arch() may call add_device_randomness()
1124 * long before we get here. This allows seeding of the pools
1125 * with some platform dependent data very early in the boot
1126 * process. But it limits our options here. We must use
1127 * statically allocated structures that already have all
1128 * initializations complete at compile time. We should also
1129 * take care not to overwrite the precious per platform data
1130 * we were given.
1131 */
Matt Mackall53c3f632008-04-29 01:02:58 -07001132static int rand_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133{
1134 init_std_data(&input_pool);
1135 init_std_data(&blocking_pool);
1136 init_std_data(&nonblocking_pool);
1137 return 0;
1138}
1139module_init(rand_initialize);
1140
David Howells93614012006-09-30 20:45:40 +02001141#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142void rand_initialize_disk(struct gendisk *disk)
1143{
1144 struct timer_rand_state *state;
1145
1146 /*
Eric Dumazetf8595812007-03-28 14:22:33 -07001147 * If kzalloc returns null, we just won't use that entropy
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 * source.
1149 */
Eric Dumazetf8595812007-03-28 14:22:33 -07001150 state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1151 if (state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 disk->random = state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153}
David Howells93614012006-09-30 20:45:40 +02001154#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155
1156static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001157random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158{
1159 ssize_t n, retval = 0, count = 0;
1160
1161 if (nbytes == 0)
1162 return 0;
1163
1164 while (nbytes > 0) {
1165 n = nbytes;
1166 if (n > SEC_XFER_SIZE)
1167 n = SEC_XFER_SIZE;
1168
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001169 DEBUG_ENT("reading %zu bits\n", n*8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
1171 n = extract_entropy_user(&blocking_pool, buf, n);
1172
Jiri Kosina8eb2ffb2012-10-15 23:43:29 +02001173 if (n < 0) {
1174 retval = n;
1175 break;
1176 }
1177
1178 DEBUG_ENT("read got %zd bits (%zd still needed)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 n*8, (nbytes-n)*8);
1180
1181 if (n == 0) {
1182 if (file->f_flags & O_NONBLOCK) {
1183 retval = -EAGAIN;
1184 break;
1185 }
1186
1187 DEBUG_ENT("sleeping?\n");
1188
1189 wait_event_interruptible(random_read_wait,
1190 input_pool.entropy_count >=
1191 random_read_wakeup_thresh);
1192
1193 DEBUG_ENT("awake\n");
1194
1195 if (signal_pending(current)) {
1196 retval = -ERESTARTSYS;
1197 break;
1198 }
1199
1200 continue;
1201 }
1202
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 count += n;
1204 buf += n;
1205 nbytes -= n;
1206 break; /* This break makes the device work */
1207 /* like a named pipe */
1208 }
1209
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 return (count ? count : retval);
1211}
1212
1213static ssize_t
Matt Mackall90b75ee2008-04-29 01:02:55 -07001214urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215{
1216 return extract_entropy_user(&nonblocking_pool, buf, nbytes);
1217}
1218
1219static unsigned int
1220random_poll(struct file *file, poll_table * wait)
1221{
1222 unsigned int mask;
1223
1224 poll_wait(file, &random_read_wait, wait);
1225 poll_wait(file, &random_write_wait, wait);
1226 mask = 0;
1227 if (input_pool.entropy_count >= random_read_wakeup_thresh)
1228 mask |= POLLIN | POLLRDNORM;
1229 if (input_pool.entropy_count < random_write_wakeup_thresh)
1230 mask |= POLLOUT | POLLWRNORM;
1231 return mask;
1232}
1233
Matt Mackall7f397dc2007-05-29 21:58:10 -05001234static int
1235write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
1236{
1237 size_t bytes;
1238 __u32 buf[16];
1239 const char __user *p = buffer;
1240
1241 while (count > 0) {
1242 bytes = min(count, sizeof(buf));
1243 if (copy_from_user(&buf, p, bytes))
1244 return -EFAULT;
1245
1246 count -= bytes;
1247 p += bytes;
1248
Theodore Ts'o902c0982012-07-04 10:38:30 -04001249 mix_pool_bytes(r, buf, bytes, NULL);
Matt Mackall91f3f1e2008-02-06 01:37:20 -08001250 cond_resched();
Matt Mackall7f397dc2007-05-29 21:58:10 -05001251 }
1252
1253 return 0;
1254}
1255
Matt Mackall90b75ee2008-04-29 01:02:55 -07001256static ssize_t random_write(struct file *file, const char __user *buffer,
1257 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258{
Matt Mackall7f397dc2007-05-29 21:58:10 -05001259 size_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
Matt Mackall7f397dc2007-05-29 21:58:10 -05001261 ret = write_pool(&blocking_pool, buffer, count);
1262 if (ret)
1263 return ret;
1264 ret = write_pool(&nonblocking_pool, buffer, count);
1265 if (ret)
1266 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Matt Mackall7f397dc2007-05-29 21:58:10 -05001268 return (ssize_t)count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269}
1270
Matt Mackall43ae4862008-04-29 01:02:58 -07001271static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272{
1273 int size, ent_count;
1274 int __user *p = (int __user *)arg;
1275 int retval;
1276
1277 switch (cmd) {
1278 case RNDGETENTCNT:
Matt Mackall43ae4862008-04-29 01:02:58 -07001279 /* inherently racy, no point locking */
1280 if (put_user(input_pool.entropy_count, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 return -EFAULT;
1282 return 0;
1283 case RNDADDTOENTCNT:
1284 if (!capable(CAP_SYS_ADMIN))
1285 return -EPERM;
1286 if (get_user(ent_count, p))
1287 return -EFAULT;
Matt Mackalladc782d2008-04-29 01:03:07 -07001288 credit_entropy_bits(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 return 0;
1290 case RNDADDENTROPY:
1291 if (!capable(CAP_SYS_ADMIN))
1292 return -EPERM;
1293 if (get_user(ent_count, p++))
1294 return -EFAULT;
1295 if (ent_count < 0)
1296 return -EINVAL;
1297 if (get_user(size, p++))
1298 return -EFAULT;
Matt Mackall7f397dc2007-05-29 21:58:10 -05001299 retval = write_pool(&input_pool, (const char __user *)p,
1300 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 if (retval < 0)
1302 return retval;
Matt Mackalladc782d2008-04-29 01:03:07 -07001303 credit_entropy_bits(&input_pool, ent_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 return 0;
1305 case RNDZAPENTCNT:
1306 case RNDCLEARPOOL:
1307 /* Clear the entropy pool counters. */
1308 if (!capable(CAP_SYS_ADMIN))
1309 return -EPERM;
Matt Mackall53c3f632008-04-29 01:02:58 -07001310 rand_initialize();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 return 0;
1312 default:
1313 return -EINVAL;
1314 }
1315}
1316
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001317static int random_fasync(int fd, struct file *filp, int on)
1318{
1319 return fasync_helper(fd, filp, on, &fasync);
1320}
1321
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001322const struct file_operations random_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 .read = random_read,
1324 .write = random_write,
1325 .poll = random_poll,
Matt Mackall43ae4862008-04-29 01:02:58 -07001326 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001327 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001328 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329};
1330
Arjan van de Ven2b8693c2007-02-12 00:55:32 -08001331const struct file_operations urandom_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 .read = urandom_read,
1333 .write = random_write,
Matt Mackall43ae4862008-04-29 01:02:58 -07001334 .unlocked_ioctl = random_ioctl,
Jeff Dike9a6f70b2008-04-29 01:03:08 -07001335 .fasync = random_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001336 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337};
1338
1339/***************************************************************
1340 * Random UUID interface
1341 *
1342 * Used here for a Boot ID, but can be useful for other kernel
1343 * drivers.
1344 ***************************************************************/
1345
1346/*
1347 * Generate random UUID
1348 */
1349void generate_random_uuid(unsigned char uuid_out[16])
1350{
1351 get_random_bytes(uuid_out, 16);
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05001352 /* Set UUID version to 4 --- truly random generation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 uuid_out[6] = (uuid_out[6] & 0x0F) | 0x40;
1354 /* Set the UUID variant to DCE */
1355 uuid_out[8] = (uuid_out[8] & 0x3F) | 0x80;
1356}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357EXPORT_SYMBOL(generate_random_uuid);
1358
1359/********************************************************************
1360 *
1361 * Sysctl interface
1362 *
1363 ********************************************************************/
1364
1365#ifdef CONFIG_SYSCTL
1366
1367#include <linux/sysctl.h>
1368
1369static int min_read_thresh = 8, min_write_thresh;
1370static int max_read_thresh = INPUT_POOL_WORDS * 32;
1371static int max_write_thresh = INPUT_POOL_WORDS * 32;
1372static char sysctl_bootid[16];
1373
1374/*
1375 * These functions is used to return both the bootid UUID, and random
1376 * UUID. The difference is in whether table->data is NULL; if it is,
1377 * then a new UUID is generated and returned to the user.
1378 *
1379 * If the user accesses this via the proc interface, it will be returned
1380 * as an ASCII string in the standard UUID format. If accesses via the
1381 * sysctl system call, it is returned as 16 bytes of binary data.
1382 */
Joe Perchesa1514272013-06-13 19:37:35 -07001383static int proc_do_uuid(struct ctl_table *table, int write,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 void __user *buffer, size_t *lenp, loff_t *ppos)
1385{
Joe Perchesa1514272013-06-13 19:37:35 -07001386 struct ctl_table fake_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 unsigned char buf[64], tmp_uuid[16], *uuid;
1388
1389 uuid = table->data;
1390 if (!uuid) {
1391 uuid = tmp_uuid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 generate_random_uuid(uuid);
Mathieu Desnoyers44e43602012-04-12 12:49:12 -07001393 } else {
1394 static DEFINE_SPINLOCK(bootid_spinlock);
1395
1396 spin_lock(&bootid_spinlock);
1397 if (!uuid[8])
1398 generate_random_uuid(uuid);
1399 spin_unlock(&bootid_spinlock);
1400 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Joe Perches35900772009-12-14 18:01:11 -08001402 sprintf(buf, "%pU", uuid);
1403
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 fake_table.data = buf;
1405 fake_table.maxlen = sizeof(buf);
1406
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07001407 return proc_dostring(&fake_table, write, buffer, lenp, ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408}
1409
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
Joe Perchesa1514272013-06-13 19:37:35 -07001411extern struct ctl_table random_table[];
1412struct ctl_table random_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 .procname = "poolsize",
1415 .data = &sysctl_poolsize,
1416 .maxlen = sizeof(int),
1417 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001418 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 },
1420 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 .procname = "entropy_avail",
1422 .maxlen = sizeof(int),
1423 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001424 .proc_handler = proc_dointvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 .data = &input_pool.entropy_count,
1426 },
1427 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 .procname = "read_wakeup_threshold",
1429 .data = &random_read_wakeup_thresh,
1430 .maxlen = sizeof(int),
1431 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001432 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 .extra1 = &min_read_thresh,
1434 .extra2 = &max_read_thresh,
1435 },
1436 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 .procname = "write_wakeup_threshold",
1438 .data = &random_write_wakeup_thresh,
1439 .maxlen = sizeof(int),
1440 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001441 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 .extra1 = &min_write_thresh,
1443 .extra2 = &max_write_thresh,
1444 },
1445 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 .procname = "boot_id",
1447 .data = &sysctl_bootid,
1448 .maxlen = 16,
1449 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001450 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 },
1452 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 .procname = "uuid",
1454 .maxlen = 16,
1455 .mode = 0444,
Eric W. Biederman6d456112009-11-16 03:11:48 -08001456 .proc_handler = proc_do_uuid,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 },
Eric W. Biederman894d2492009-11-05 14:34:02 -08001458 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459};
1460#endif /* CONFIG_SYSCTL */
1461
David S. Miller6e5714e2011-08-03 20:50:44 -07001462static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
Theodore Ts'o47d06e52013-09-10 10:52:35 -04001464int random_int_secret_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465{
David S. Miller6e5714e2011-08-03 20:50:44 -07001466 get_random_bytes(random_int_secret, sizeof(random_int_secret));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 return 0;
1468}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469
1470/*
1471 * Get a random word for internal kernel use only. Similar to urandom but
1472 * with the goal of minimal entropy pool depletion. As a result, the random
1473 * value is not cryptographically secure but for several uses the cost of
1474 * depleting entropy is too high
1475 */
Theodore Ts'o74feec52012-07-06 14:03:18 -04001476static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477unsigned int get_random_int(void)
1478{
H. Peter Anvin63d77172011-07-31 13:54:50 -07001479 __u32 *hash;
David S. Miller6e5714e2011-08-03 20:50:44 -07001480 unsigned int ret;
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001481
H. Peter Anvin63d77172011-07-31 13:54:50 -07001482 if (arch_get_random_int(&ret))
1483 return ret;
1484
1485 hash = get_cpu_var(get_random_int_hash);
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001486
Theodore Ts'o61875f32013-09-21 13:58:22 -04001487 hash[0] += current->pid + jiffies + random_get_entropy();
David S. Miller6e5714e2011-08-03 20:50:44 -07001488 md5_transform(hash, random_int_secret);
1489 ret = hash[0];
Linus Torvalds8a0a9bd2009-05-05 08:17:43 -07001490 put_cpu_var(get_random_int_hash);
1491
1492 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493}
Andy Shevchenko16c7fa02013-04-30 15:27:30 -07001494EXPORT_SYMBOL(get_random_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
1496/*
1497 * randomize_range() returns a start address such that
1498 *
1499 * [...... <range> .....]
1500 * start end
1501 *
1502 * a <range> with size "len" starting at the return value is inside in the
1503 * area defined by [start, end], but is otherwise randomized.
1504 */
1505unsigned long
1506randomize_range(unsigned long start, unsigned long end, unsigned long len)
1507{
1508 unsigned long range = end - len - start;
1509
1510 if (end <= start + len)
1511 return 0;
1512 return PAGE_ALIGN(get_random_int() % range + start);
1513}