random.c 58.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
/*
 * random.c -- A strong random number generator
 *
4
 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
L
Linus Torvalds 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
 *
 * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999.  All
 * rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, and the entire permission notice in its entirety,
 *    including the disclaimer of warranties.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote
 *    products derived from this software without specific prior
 *    written permission.
 *
 * ALTERNATIVELY, this product may be distributed under the terms of
 * the GNU General Public License, in which case the provisions of the GPL are
 * required INSTEAD OF the above restrictions.  (This clause is
 * necessary due to a potential bad interaction between the GPL and
 * the restrictions contained in a BSD-style copyright.)
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
 * WHICH ARE HEREBY DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */

/*
 * (now, with legal B.S. out of the way.....)
 *
 * This routine gathers environmental noise from device drivers, etc.,
 * and returns good random numbers, suitable for cryptographic use.
 * Besides the obvious cryptographic uses, these numbers are also good
 * for seeding TCP sequence numbers, and other places where it is
 * desirable to have numbers which are not only random, but hard to
 * predict by an attacker.
 *
 * Theory of operation
 * ===================
 *
 * Computers are very predictable devices.  Hence it is extremely hard
 * to produce truly random numbers on a computer --- as opposed to
 * pseudo-random numbers, which can easily generated by using a
 * algorithm.  Unfortunately, it is very easy for attackers to guess
 * the sequence of pseudo-random number generators, and for some
 * applications this is not acceptable.  So instead, we must try to
 * gather "environmental noise" from the computer's environment, which
 * must be hard for outside attackers to observe, and use that to
 * generate random numbers.  In a Unix environment, this is best done
 * from inside the kernel.
 *
 * Sources of randomness from the environment include inter-keyboard
 * timings, inter-interrupt timings from some interrupts, and other
 * events which are both (a) non-deterministic and (b) hard for an
 * outside observer to measure.  Randomness from these sources are
 * added to an "entropy pool", which is mixed using a CRC-like function.
 * This is not cryptographically strong, but it is adequate assuming
 * the randomness is not chosen maliciously, and it is fast enough that
 * the overhead of doing it on every interrupt is very reasonable.
 * As random bytes are mixed into the entropy pool, the routines keep
 * an *estimate* of how many bits of randomness have been stored into
 * the random number generator's internal state.
 *
 * When random bytes are desired, they are obtained by taking the SHA
 * hash of the contents of the "entropy pool".  The SHA hash avoids
 * exposing the internal state of the entropy pool.  It is believed to
 * be computationally infeasible to derive any useful information
 * about the input of SHA from its output.  Even if it is possible to
 * analyze SHA in some clever way, as long as the amount of data
 * returned from the generator is less than the inherent entropy in
 * the pool, the output data is totally unpredictable.  For this
 * reason, the routine decreases its internal estimate of how many
 * bits of "true randomness" are contained in the entropy pool as it
 * outputs random numbers.
 *
 * If this estimate goes to zero, the routine can still generate
 * random numbers; however, an attacker may (at least in theory) be
 * able to infer the future output of the generator from prior
 * outputs.  This requires successful cryptanalysis of SHA, which is
 * not believed to be feasible, but there is a remote possibility.
 * Nonetheless, these numbers should be useful for the vast majority
 * of purposes.
 *
 * Exported interfaces ---- output
 * ===============================
 *
 * There are three exported interfaces; the first is one designed to
 * be used from within the kernel:
 *
 * 	void get_random_bytes(void *buf, int nbytes);
 *
 * This interface will return the requested number of random bytes,
 * and place it in the requested buffer.
 *
 * The two other interfaces are two character devices /dev/random and
 * /dev/urandom.  /dev/random is suitable for use when very high
 * quality randomness is desired (for example, for key generation or
 * one-time pads), as it will only return a maximum of the number of
 * bits of randomness (as estimated by the random number generator)
 * contained in the entropy pool.
 *
 * The /dev/urandom device does not have this limit, and will return
 * as many bytes as are requested.  As more and more random bytes are
 * requested without giving time for the entropy pool to recharge,
 * this will result in random numbers that are merely cryptographically
 * strong.  For many applications, however, this is acceptable.
 *
 * Exported interfaces ---- input
 * ==============================
 *
 * The current exported interfaces for gathering environmental noise
 * from the devices are:
 *
128
 *	void add_device_randomness(const void *buf, unsigned int size);
L
Linus Torvalds 已提交
129 130
 * 	void add_input_randomness(unsigned int type, unsigned int code,
 *                                unsigned int value);
131
 *	void add_interrupt_randomness(int irq, int irq_flags);
132
 * 	void add_disk_randomness(struct gendisk *disk);
L
Linus Torvalds 已提交
133
 *
134 135 136 137 138 139 140 141
 * add_device_randomness() is for adding data to the random pool that
 * is likely to differ between two devices (or possibly even per boot).
 * This would be things like MAC addresses or serial numbers, or the
 * read-out of the RTC. This does *not* add any actual entropy to the
 * pool, but it initializes the pool to different values for devices
 * that might otherwise be identical and have very little entropy
 * available to them (particularly common in the embedded world).
 *
L
Linus Torvalds 已提交
142 143 144
 * add_input_randomness() uses the input layer interrupt timing, as well as
 * the event type information from the hardware.
 *
145 146 147
 * add_interrupt_randomness() uses the interrupt timing as random
 * inputs to the entropy pool. Using the cycle counters and the irq source
 * as inputs, it feeds the randomness roughly once a second.
148 149 150 151 152 153
 *
 * add_disk_randomness() uses what amounts to the seek time of block
 * layer request events, on a per-disk_devt basis, as input to the
 * entropy pool. Note that high-speed solid state drives with very low
 * seek times do not make for good sources of entropy, as their seek
 * times are usually fairly consistent.
L
Linus Torvalds 已提交
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
 *
 * All of these routines try to estimate how many bits of randomness a
 * particular randomness source.  They do this by keeping track of the
 * first and second order deltas of the event timings.
 *
 * Ensuring unpredictability at system startup
 * ============================================
 *
 * When any operating system starts up, it will go through a sequence
 * of actions that are fairly predictable by an adversary, especially
 * if the start-up does not involve interaction with a human operator.
 * This reduces the actual number of bits of unpredictability in the
 * entropy pool below the value in entropy_count.  In order to
 * counteract this effect, it helps to carry information in the
 * entropy pool across shut-downs and start-ups.  To do this, put the
 * following lines an appropriate script which is run during the boot
 * sequence:
 *
 *	echo "Initializing random number generator..."
 *	random_seed=/var/run/random-seed
 *	# Carry a random seed from start-up to start-up
 *	# Load and then save the whole entropy pool
 *	if [ -f $random_seed ]; then
 *		cat $random_seed >/dev/urandom
 *	else
 *		touch $random_seed
 *	fi
 *	chmod 600 $random_seed
 *	dd if=/dev/urandom of=$random_seed count=1 bs=512
 *
 * and the following lines in an appropriate script which is run as
 * the system is shutdown:
 *
 *	# Carry a random seed from shut-down to start-up
 *	# Save the whole entropy pool
 *	echo "Saving random seed..."
 *	random_seed=/var/run/random-seed
 *	touch $random_seed
 *	chmod 600 $random_seed
 *	dd if=/dev/urandom of=$random_seed count=1 bs=512
 *
 * For example, on most modern systems using the System V init
 * scripts, such code fragments would be found in
 * /etc/rc.d/init.d/random.  On older Linux systems, the correct script
 * location might be in /etc/rcb.d/rc.local or /etc/rc.d/rc.0.
 *
 * Effectively, these commands cause the contents of the entropy pool
 * to be saved at shut-down time and reloaded into the entropy pool at
 * start-up.  (The 'dd' in the addition to the bootup script is to
 * make sure that /etc/random-seed is different for every start-up,
 * even if the system crashes without executing rc.0.)  Even with
 * complete knowledge of the start-up activities, predicting the state
 * of the entropy pool requires knowledge of the previous history of
 * the system.
 *
 * Configuring the /dev/random driver under Linux
 * ==============================================
 *
 * The /dev/random driver under Linux uses minor numbers 8 and 9 of
 * the /dev/mem major number (#1).  So if your system does not have
 * /dev/random and /dev/urandom created already, they can be created
 * by using the commands:
 *
 * 	mknod /dev/random c 1 8
 * 	mknod /dev/urandom c 1 9
 *
 * Acknowledgements:
 * =================
 *
 * Ideas for constructing this random number generator were derived
 * from Pretty Good Privacy's random number generator, and from private
 * discussions with Phil Karn.  Colin Plumb provided a faster random
 * number generator, which speed up the mixing function of the entropy
 * pool, taken from PGPfone.  Dale Worley has also contributed many
 * useful ideas and suggestions to improve this driver.
 *
 * Any flaws in the design are solely my responsibility, and should
 * not be attributed to the Phil, Colin, or any of authors of PGP.
 *
 * Further background information on this topic may be obtained from
 * RFC 1750, "Randomness Recommendations for Security", by Donald
 * Eastlake, Steve Crocker, and Jeff Schiller.
 */

#include <linux/utsname.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/major.h>
#include <linux/string.h>
#include <linux/fcntl.h>
#include <linux/slab.h>
#include <linux/random.h>
#include <linux/poll.h>
#include <linux/init.h>
#include <linux/fs.h>
#include <linux/genhd.h>
#include <linux/interrupt.h>
251
#include <linux/mm.h>
L
Linus Torvalds 已提交
252
#include <linux/spinlock.h>
253
#include <linux/kthread.h>
L
Linus Torvalds 已提交
254 255
#include <linux/percpu.h>
#include <linux/cryptohash.h>
256
#include <linux/fips.h>
257
#include <linux/ptrace.h>
258
#include <linux/kmemcheck.h>
259
#include <linux/workqueue.h>
260
#include <linux/irq.h>
261 262
#include <linux/syscalls.h>
#include <linux/completion.h>
263
#include <linux/uuid.h>
264
#include <crypto/chacha20.h>
265

L
Linus Torvalds 已提交
266 267 268
#include <asm/processor.h>
#include <asm/uaccess.h>
#include <asm/irq.h>
269
#include <asm/irq_regs.h>
L
Linus Torvalds 已提交
270 271
#include <asm/io.h>

272 273 274
#define CREATE_TRACE_POINTS
#include <trace/events/random.h>

275 276
/* #define ADD_INTERRUPT_BENCH */

L
Linus Torvalds 已提交
277 278 279
/*
 * Configuration information
 */
280 281 282 283 284 285
#define INPUT_POOL_SHIFT	12
#define INPUT_POOL_WORDS	(1 << (INPUT_POOL_SHIFT-5))
#define OUTPUT_POOL_SHIFT	10
#define OUTPUT_POOL_WORDS	(1 << (OUTPUT_POOL_SHIFT-5))
#define SEC_XFER_SIZE		512
#define EXTRACT_SIZE		10
L
Linus Torvalds 已提交
286

287
#define DEBUG_RANDOM_BOOT 0
L
Linus Torvalds 已提交
288

289 290
#define LONGS(x) (((x) + sizeof(unsigned long) - 1)/sizeof(unsigned long))

291
/*
T
Theodore Ts'o 已提交
292 293
 * To allow fractional bits to be tracked, the entropy_count field is
 * denominated in units of 1/8th bits.
294 295 296
 *
 * 2*(ENTROPY_SHIFT + log2(poolbits)) must <= 31, or the multiply in
 * credit_entropy_bits() needs to be 64 bits wide.
297 298 299 300
 */
#define ENTROPY_SHIFT 3
#define ENTROPY_BITS(r) ((r)->entropy_count >> ENTROPY_SHIFT)

L
Linus Torvalds 已提交
301 302 303 304
/*
 * The minimum number of bits of entropy before we wake up a read on
 * /dev/random.  Should be enough to do a significant reseed.
 */
305
static int random_read_wakeup_bits = 64;
L
Linus Torvalds 已提交
306 307 308 309 310 311

/*
 * If the entropy count falls under this number of bits, then we
 * should wake up processes which are selecting or polling on write
 * access to /dev/random.
 */
312
static int random_write_wakeup_bits = 28 * OUTPUT_POOL_WORDS;
L
Linus Torvalds 已提交
313 314

/*
315
 * The minimum number of seconds between urandom pool reseeding.  We
316 317
 * do this to limit the amount of entropy that can be drained from the
 * input pool even if there are heavy demands on /dev/urandom.
L
Linus Torvalds 已提交
318
 */
319
static int random_min_urandom_seed = 60;
L
Linus Torvalds 已提交
320 321

/*
322 323 324 325 326 327 328 329 330 331
 * Originally, we used a primitive polynomial of degree .poolwords
 * over GF(2).  The taps for various sizes are defined below.  They
 * were chosen to be evenly spaced except for the last tap, which is 1
 * to get the twisting happening as fast as possible.
 *
 * For the purposes of better mixing, we use the CRC-32 polynomial as
 * well to make a (modified) twisted Generalized Feedback Shift
 * Register.  (See M. Matsumoto & Y. Kurita, 1992.  Twisted GFSR
 * generators.  ACM Transactions on Modeling and Computer Simulation
 * 2(3):179-194.  Also see M. Matsumoto & Y. Kurita, 1994.  Twisted
332
 * GFSR generators II.  ACM Transactions on Modeling and Computer
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
 * Simulation 4:254-266)
 *
 * Thanks to Colin Plumb for suggesting this.
 *
 * The mixing operation is much less sensitive than the output hash,
 * where we use SHA-1.  All that we want of mixing operation is that
 * it be a good non-cryptographic hash; i.e. it not produce collisions
 * when fed "random" data of the sort we expect to see.  As long as
 * the pool state differs for different inputs, we have preserved the
 * input entropy and done a good job.  The fact that an intelligent
 * attacker can construct inputs that will produce controlled
 * alterations to the pool's state is not important because we don't
 * consider such inputs to contribute any randomness.  The only
 * property we need with respect to them is that the attacker can't
 * increase his/her knowledge of the pool's state.  Since all
 * additions are reversible (knowing the final state and the input,
 * you can reconstruct the initial state), if an attacker has any
 * uncertainty about the initial state, he/she can only shuffle that
 * uncertainty about, but never cause any collisions (which would
 * decrease the uncertainty).
 *
 * Our mixing functions were analyzed by Lacharme, Roeck, Strubel, and
 * Videau in their paper, "The Linux Pseudorandom Number Generator
 * Revisited" (see: http://eprint.iacr.org/2012/251.pdf).  In their
 * paper, they point out that we are not using a true Twisted GFSR,
 * since Matsumoto & Kurita used a trinomial feedback polynomial (that
 * is, with only three taps, instead of the six that we are using).
 * As a result, the resulting polynomial is neither primitive nor
 * irreducible, and hence does not have a maximal period over
 * GF(2**32).  They suggest a slight change to the generator
 * polynomial which improves the resulting TGFSR polynomial to be
 * irreducible, which we have made here.
L
Linus Torvalds 已提交
365 366
 */
static struct poolinfo {
367 368
	int poolbitshift, poolwords, poolbytes, poolbits, poolfracbits;
#define S(x) ilog2(x)+5, (x), (x)*4, (x)*32, (x) << (ENTROPY_SHIFT+5)
L
Linus Torvalds 已提交
369 370
	int tap1, tap2, tap3, tap4, tap5;
} poolinfo_table[] = {
371 372 373 374 375 376
	/* was: x^128 + x^103 + x^76 + x^51 +x^25 + x + 1 */
	/* x^128 + x^104 + x^76 + x^51 +x^25 + x + 1 */
	{ S(128),	104,	76,	51,	25,	1 },
	/* was: x^32 + x^26 + x^20 + x^14 + x^7 + x + 1 */
	/* x^32 + x^26 + x^19 + x^14 + x^7 + x + 1 */
	{ S(32),	26,	19,	14,	7,	1 },
L
Linus Torvalds 已提交
377 378
#if 0
	/* x^2048 + x^1638 + x^1231 + x^819 + x^411 + x + 1  -- 115 */
379
	{ S(2048),	1638,	1231,	819,	411,	1 },
L
Linus Torvalds 已提交
380 381

	/* x^1024 + x^817 + x^615 + x^412 + x^204 + x + 1 -- 290 */
382
	{ S(1024),	817,	615,	412,	204,	1 },
L
Linus Torvalds 已提交
383 384

	/* x^1024 + x^819 + x^616 + x^410 + x^207 + x^2 + 1 -- 115 */
385
	{ S(1024),	819,	616,	410,	207,	2 },
L
Linus Torvalds 已提交
386 387

	/* x^512 + x^411 + x^308 + x^208 + x^104 + x + 1 -- 225 */
388
	{ S(512),	411,	308,	208,	104,	1 },
L
Linus Torvalds 已提交
389 390

	/* x^512 + x^409 + x^307 + x^206 + x^102 + x^2 + 1 -- 95 */
391
	{ S(512),	409,	307,	206,	102,	2 },
L
Linus Torvalds 已提交
392
	/* x^512 + x^409 + x^309 + x^205 + x^103 + x^2 + 1 -- 95 */
393
	{ S(512),	409,	309,	205,	103,	2 },
L
Linus Torvalds 已提交
394 395

	/* x^256 + x^205 + x^155 + x^101 + x^52 + x + 1 -- 125 */
396
	{ S(256),	205,	155,	101,	52,	1 },
L
Linus Torvalds 已提交
397 398

	/* x^128 + x^103 + x^78 + x^51 + x^27 + x^2 + 1 -- 70 */
399
	{ S(128),	103,	78,	51,	27,	2 },
L
Linus Torvalds 已提交
400 401

	/* x^64 + x^52 + x^39 + x^26 + x^14 + x + 1 -- 15 */
402
	{ S(64),	52,	39,	26,	14,	1 },
L
Linus Torvalds 已提交
403 404 405 406 407 408 409 410
#endif
};

/*
 * Static global variables
 */
static DECLARE_WAIT_QUEUE_HEAD(random_read_wait);
static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
411
static DECLARE_WAIT_QUEUE_HEAD(urandom_init_wait);
412
static struct fasync_struct *fasync;
L
Linus Torvalds 已提交
413

414 415 416
static DEFINE_SPINLOCK(random_ready_list_lock);
static LIST_HEAD(random_ready_list);

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
struct crng_state {
	__u32		state[16];
	unsigned long	init_time;
	spinlock_t	lock;
};

struct crng_state primary_crng = {
	.lock = __SPIN_LOCK_UNLOCKED(primary_crng.lock),
};

/*
 * crng_init =  0 --> Uninitialized
 *		1 --> Initialized
 *		2 --> Initialized from input_pool
 *
 * crng_init is protected by primary_crng->lock, and only increases
 * its value (from 0->1->2).
 */
static int crng_init = 0;
#define crng_ready() (likely(crng_init > 0))
static int crng_init_cnt = 0;
#define CRNG_INIT_CNT_THRESH (2*CHACHA20_KEY_SIZE)
static void extract_crng(__u8 out[CHACHA20_BLOCK_SIZE]);
static void process_random_ready_list(void);

L
Linus Torvalds 已提交
442 443 444 445 446 447 448 449 450
/**********************************************************************
 *
 * OS independent entropy store.   Here are the functions which handle
 * storing entropy in an entropy pool.
 *
 **********************************************************************/

struct entropy_store;
struct entropy_store {
451
	/* read-only data: */
452
	const struct poolinfo *poolinfo;
L
Linus Torvalds 已提交
453 454 455
	__u32 *pool;
	const char *name;
	struct entropy_store *pull;
456
	struct work_struct push_work;
L
Linus Torvalds 已提交
457 458

	/* read-write data: */
459
	unsigned long last_pulled;
460
	spinlock_t lock;
461 462
	unsigned short add_ptr;
	unsigned short input_rotate;
463
	int entropy_count;
464 465
	int entropy_total;
	unsigned int initialized:1;
466 467
	unsigned int limit:1;
	unsigned int last_data_init:1;
M
Matt Mackall 已提交
468
	__u8 last_data[EXTRACT_SIZE];
L
Linus Torvalds 已提交
469 470
};

471 472 473 474 475 476
static ssize_t extract_entropy(struct entropy_store *r, void *buf,
			       size_t nbytes, int min, int rsvd);
static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
				size_t nbytes, int fips);

static void crng_reseed(struct crng_state *crng, struct entropy_store *r);
477
static void push_to_pool(struct work_struct *work);
L
Linus Torvalds 已提交
478 479 480 481 482 483 484
static __u32 input_pool_data[INPUT_POOL_WORDS];
static __u32 blocking_pool_data[OUTPUT_POOL_WORDS];

static struct entropy_store input_pool = {
	.poolinfo = &poolinfo_table[0],
	.name = "input",
	.limit = 1,
485
	.lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
L
Linus Torvalds 已提交
486 487 488 489 490 491 492 493
	.pool = input_pool_data
};

static struct entropy_store blocking_pool = {
	.poolinfo = &poolinfo_table[1],
	.name = "blocking",
	.limit = 1,
	.pull = &input_pool,
494
	.lock = __SPIN_LOCK_UNLOCKED(blocking_pool.lock),
495 496 497
	.pool = blocking_pool_data,
	.push_work = __WORK_INITIALIZER(blocking_pool.push_work,
					push_to_pool),
L
Linus Torvalds 已提交
498 499
};

500 501 502 503
static __u32 const twist_table[8] = {
	0x00000000, 0x3b6e20c8, 0x76dc4190, 0x4db26158,
	0xedb88320, 0xd6d6a3e8, 0x9b64c2b0, 0xa00ae278 };

L
Linus Torvalds 已提交
504
/*
505
 * This function adds bytes into the entropy "pool".  It does not
L
Linus Torvalds 已提交
506
 * update the entropy estimate.  The caller should call
507
 * credit_entropy_bits if this is appropriate.
L
Linus Torvalds 已提交
508 509 510 511 512 513
 *
 * The pool is stirred with a primitive polynomial of the appropriate
 * degree, and then twisted.  We twist by three bits at a time because
 * it's cheap to do so and helps slightly in the expected case where
 * the entropy is concentrated in the low-order bits.
 */
514
static void _mix_pool_bytes(struct entropy_store *r, const void *in,
515
			    int nbytes)
L
Linus Torvalds 已提交
516
{
517
	unsigned long i, tap1, tap2, tap3, tap4, tap5;
518
	int input_rotate;
L
Linus Torvalds 已提交
519
	int wordmask = r->poolinfo->poolwords - 1;
520
	const char *bytes = in;
521
	__u32 w;
L
Linus Torvalds 已提交
522 523 524 525 526 527 528

	tap1 = r->poolinfo->tap1;
	tap2 = r->poolinfo->tap2;
	tap3 = r->poolinfo->tap3;
	tap4 = r->poolinfo->tap4;
	tap5 = r->poolinfo->tap5;

529 530
	input_rotate = r->input_rotate;
	i = r->add_ptr;
L
Linus Torvalds 已提交
531

532 533
	/* mix one byte at a time to simplify size handling and churn faster */
	while (nbytes--) {
534
		w = rol32(*bytes++, input_rotate);
M
Matt Mackall 已提交
535
		i = (i - 1) & wordmask;
L
Linus Torvalds 已提交
536 537

		/* XOR in the various taps */
M
Matt Mackall 已提交
538
		w ^= r->pool[i];
L
Linus Torvalds 已提交
539 540 541 542 543
		w ^= r->pool[(i + tap1) & wordmask];
		w ^= r->pool[(i + tap2) & wordmask];
		w ^= r->pool[(i + tap3) & wordmask];
		w ^= r->pool[(i + tap4) & wordmask];
		w ^= r->pool[(i + tap5) & wordmask];
M
Matt Mackall 已提交
544 545

		/* Mix the result back in with a twist */
L
Linus Torvalds 已提交
546
		r->pool[i] = (w >> 3) ^ twist_table[w & 7];
547 548 549 550 551 552 553

		/*
		 * Normally, we add 7 bits of rotation to the pool.
		 * At the beginning of the pool, add an extra 7 bits
		 * rotation, so that successive passes spread the
		 * input bits across the pool evenly.
		 */
554
		input_rotate = (input_rotate + (i ? 7 : 14)) & 31;
L
Linus Torvalds 已提交
555 556
	}

557 558
	r->input_rotate = input_rotate;
	r->add_ptr = i;
L
Linus Torvalds 已提交
559 560
}

561
static void __mix_pool_bytes(struct entropy_store *r, const void *in,
562
			     int nbytes)
563 564
{
	trace_mix_pool_bytes_nolock(r->name, nbytes, _RET_IP_);
565
	_mix_pool_bytes(r, in, nbytes);
566 567 568
}

static void mix_pool_bytes(struct entropy_store *r, const void *in,
569
			   int nbytes)
L
Linus Torvalds 已提交
570
{
571 572
	unsigned long flags;

573
	trace_mix_pool_bytes(r->name, nbytes, _RET_IP_);
574
	spin_lock_irqsave(&r->lock, flags);
575
	_mix_pool_bytes(r, in, nbytes);
576
	spin_unlock_irqrestore(&r->lock, flags);
L
Linus Torvalds 已提交
577 578
}

579 580 581
struct fast_pool {
	__u32		pool[4];
	unsigned long	last;
582
	unsigned short	reg_idx;
583
	unsigned char	count;
584 585 586 587 588 589 590
};

/*
 * This is a fast mixing routine used by the interrupt randomness
 * collector.  It's hardcoded for an 128 bit pool and assumes that any
 * locks that might be needed are taken by the caller.
 */
591
static void fast_mix(struct fast_pool *f)
592
{
593 594 595 596
	__u32 a = f->pool[0],	b = f->pool[1];
	__u32 c = f->pool[2],	d = f->pool[3];

	a += b;			c += d;
G
George Spelvin 已提交
597
	b = rol32(b, 6);	d = rol32(d, 27);
598 599 600
	d ^= a;			b ^= c;

	a += b;			c += d;
G
George Spelvin 已提交
601
	b = rol32(b, 16);	d = rol32(d, 14);
602 603 604
	d ^= a;			b ^= c;

	a += b;			c += d;
G
George Spelvin 已提交
605
	b = rol32(b, 6);	d = rol32(d, 27);
606 607 608
	d ^= a;			b ^= c;

	a += b;			c += d;
G
George Spelvin 已提交
609
	b = rol32(b, 16);	d = rol32(d, 14);
610 611 612 613
	d ^= a;			b ^= c;

	f->pool[0] = a;  f->pool[1] = b;
	f->pool[2] = c;  f->pool[3] = d;
614
	f->count++;
615 616
}

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
static void process_random_ready_list(void)
{
	unsigned long flags;
	struct random_ready_callback *rdy, *tmp;

	spin_lock_irqsave(&random_ready_list_lock, flags);
	list_for_each_entry_safe(rdy, tmp, &random_ready_list, list) {
		struct module *owner = rdy->owner;

		list_del_init(&rdy->list);
		rdy->func(rdy);
		module_put(owner);
	}
	spin_unlock_irqrestore(&random_ready_list_lock, flags);
}

L
Linus Torvalds 已提交
633
/*
634 635 636
 * Credit (or debit) the entropy store with n bits of entropy.
 * Use credit_entropy_bits_safe() if the value comes from userspace
 * or otherwise should be checked for extreme values.
L
Linus Torvalds 已提交
637
 */
638
static void credit_entropy_bits(struct entropy_store *r, int nbits)
L
Linus Torvalds 已提交
639
{
640
	int entropy_count, orig;
641 642
	const int pool_size = r->poolinfo->poolfracbits;
	int nfrac = nbits << ENTROPY_SHIFT;
L
Linus Torvalds 已提交
643

644 645 646
	if (!nbits)
		return;

647 648
retry:
	entropy_count = orig = ACCESS_ONCE(r->entropy_count);
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
	if (nfrac < 0) {
		/* Debit */
		entropy_count += nfrac;
	} else {
		/*
		 * Credit: we have to account for the possibility of
		 * overwriting already present entropy.	 Even in the
		 * ideal case of pure Shannon entropy, new contributions
		 * approach the full value asymptotically:
		 *
		 * entropy <- entropy + (pool_size - entropy) *
		 *	(1 - exp(-add_entropy/pool_size))
		 *
		 * For add_entropy <= pool_size/2 then
		 * (1 - exp(-add_entropy/pool_size)) >=
		 *    (add_entropy/pool_size)*0.7869...
		 * so we can approximate the exponential with
		 * 3/4*add_entropy/pool_size and still be on the
		 * safe side by adding at most pool_size/2 at a time.
		 *
		 * The use of pool_size-2 in the while statement is to
		 * prevent rounding artifacts from making the loop
		 * arbitrarily long; this limits the loop to log2(pool_size)*2
		 * turns no matter how large nbits is.
		 */
		int pnfrac = nfrac;
		const int s = r->poolinfo->poolbitshift + ENTROPY_SHIFT + 2;
		/* The +2 corresponds to the /4 in the denominator */

		do {
			unsigned int anfrac = min(pnfrac, pool_size/2);
			unsigned int add =
				((pool_size - entropy_count)*anfrac*3) >> s;

			entropy_count += add;
			pnfrac -= anfrac;
		} while (unlikely(entropy_count < pool_size-2 && pnfrac));
	}
687

688
	if (unlikely(entropy_count < 0)) {
689 690 691
		pr_warn("random: negative entropy/overflow: pool %s count %d\n",
			r->name, entropy_count);
		WARN_ON(1);
692
		entropy_count = 0;
693 694
	} else if (entropy_count > pool_size)
		entropy_count = pool_size;
695 696
	if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
		goto retry;
L
Linus Torvalds 已提交
697

698
	r->entropy_total += nbits;
699 700 701
	if (!r->initialized && r->entropy_total > 128) {
		r->initialized = 1;
		r->entropy_total = 0;
702 703
	}

704 705
	trace_credit_entropy_bits(r->name, nbits,
				  entropy_count >> ENTROPY_SHIFT,
706 707
				  r->entropy_total, _RET_IP_);

708
	if (r == &input_pool) {
709
		int entropy_bits = entropy_count >> ENTROPY_SHIFT;
710

711 712 713 714 715
		if (crng_init < 2 && entropy_bits >= 128) {
			crng_reseed(&primary_crng, r);
			entropy_bits = r->entropy_count >> ENTROPY_SHIFT;
		}

716
		/* should we wake readers? */
717
		if (entropy_bits >= random_read_wakeup_bits) {
718 719 720 721
			wake_up_interruptible(&random_read_wait);
			kill_fasync(&fasync, SIGIO, POLL_IN);
		}
		/* If the input pool is getting full, send some
722
		 * entropy to the blocking pool until it is 75% full.
723
		 */
724
		if (entropy_bits > random_write_wakeup_bits &&
725
		    r->initialized &&
726
		    r->entropy_total >= 2*random_read_wakeup_bits) {
727 728 729
			struct entropy_store *other = &blocking_pool;

			if (other->entropy_count <=
730 731
			    3 * other->poolinfo->poolfracbits / 4) {
				schedule_work(&other->push_work);
732 733 734
				r->entropy_total = 0;
			}
		}
735
	}
L
Linus Torvalds 已提交
736 737
}

738 739 740 741 742 743 744 745 746 747 748
static void credit_entropy_bits_safe(struct entropy_store *r, int nbits)
{
	const int nbits_max = (int)(~0U >> (ENTROPY_SHIFT + 1));

	/* Cap the value to avoid overflows */
	nbits = min(nbits,  nbits_max);
	nbits = max(nbits, -nbits_max);

	credit_entropy_bits(r, nbits);
}

749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
/*********************************************************************
 *
 * CRNG using CHACHA20
 *
 *********************************************************************/

#define CRNG_RESEED_INTERVAL (300*HZ)

static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);

static void crng_initialize(struct crng_state *crng)
{
	int		i;
	unsigned long	rv;

	memcpy(&crng->state[0], "expand 32-byte k", 16);
	if (crng == &primary_crng)
		_extract_entropy(&input_pool, &crng->state[4],
				 sizeof(__u32) * 12, 0);
	else
		get_random_bytes(&crng->state[4], sizeof(__u32) * 12);
	for (i = 4; i < 16; i++) {
		if (!arch_get_random_seed_long(&rv) &&
		    !arch_get_random_long(&rv))
			rv = random_get_entropy();
		crng->state[i] ^= rv;
	}
	crng->init_time = jiffies - CRNG_RESEED_INTERVAL - 1;
}

static int crng_fast_load(const char *cp, size_t len)
{
	unsigned long flags;
	char *p;

	if (!spin_trylock_irqsave(&primary_crng.lock, flags))
		return 0;
	if (crng_ready()) {
		spin_unlock_irqrestore(&primary_crng.lock, flags);
		return 0;
	}
	p = (unsigned char *) &primary_crng.state[4];
	while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
		p[crng_init_cnt % CHACHA20_KEY_SIZE] ^= *cp;
		cp++; crng_init_cnt++; len--;
	}
	if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
		crng_init = 1;
		wake_up_interruptible(&crng_init_wait);
		pr_notice("random: fast init done\n");
	}
	spin_unlock_irqrestore(&primary_crng.lock, flags);
	return 1;
}

static void crng_reseed(struct crng_state *crng, struct entropy_store *r)
{
	unsigned long	flags;
	int		i, num;
	union {
		__u8	block[CHACHA20_BLOCK_SIZE];
		__u32	key[8];
	} buf;

	if (r) {
		num = extract_entropy(r, &buf, 32, 16, 0);
		if (num == 0)
			return;
	} else
		extract_crng(buf.block);
	spin_lock_irqsave(&primary_crng.lock, flags);
	for (i = 0; i < 8; i++) {
		unsigned long	rv;
		if (!arch_get_random_seed_long(&rv) &&
		    !arch_get_random_long(&rv))
			rv = random_get_entropy();
		crng->state[i+4] ^= buf.key[i] ^ rv;
	}
	memzero_explicit(&buf, sizeof(buf));
	crng->init_time = jiffies;
	if (crng == &primary_crng && crng_init < 2) {
		crng_init = 2;
		process_random_ready_list();
		wake_up_interruptible(&crng_init_wait);
		pr_notice("random: crng init done\n");
	}
	spin_unlock_irqrestore(&primary_crng.lock, flags);
}

static inline void crng_wait_ready(void)
{
	wait_event_interruptible(crng_init_wait, crng_ready());
}

static void extract_crng(__u8 out[CHACHA20_BLOCK_SIZE])
{
	unsigned long v, flags;
	struct crng_state *crng = &primary_crng;

	if (crng_init > 1 &&
	    time_after(jiffies, crng->init_time + CRNG_RESEED_INTERVAL))
		crng_reseed(crng, &input_pool);
	spin_lock_irqsave(&crng->lock, flags);
	if (arch_get_random_long(&v))
		crng->state[14] ^= v;
	chacha20_block(&crng->state[0], out);
	if (crng->state[12] == 0)
		crng->state[13]++;
	spin_unlock_irqrestore(&crng->lock, flags);
}

static ssize_t extract_crng_user(void __user *buf, size_t nbytes)
{
	ssize_t ret = 0, i;
	__u8 tmp[CHACHA20_BLOCK_SIZE];
	int large_request = (nbytes > 256);

	while (nbytes) {
		if (large_request && need_resched()) {
			if (signal_pending(current)) {
				if (ret == 0)
					ret = -ERESTARTSYS;
				break;
			}
			schedule();
		}

		extract_crng(tmp);
		i = min_t(int, nbytes, CHACHA20_BLOCK_SIZE);
		if (copy_to_user(buf, tmp, i)) {
			ret = -EFAULT;
			break;
		}

		nbytes -= i;
		buf += i;
		ret += i;
	}

	/* Wipe data just written to memory */
	memzero_explicit(tmp, sizeof(tmp));

	return ret;
}


L
Linus Torvalds 已提交
895 896 897 898 899 900 901 902 903
/*********************************************************************
 *
 * Entropy input management
 *
 *********************************************************************/

/* There is one of these per entropy source */
struct timer_rand_state {
	cycles_t last_time;
904
	long last_delta, last_delta2;
L
Linus Torvalds 已提交
905 906 907
	unsigned dont_count_entropy:1;
};

908 909
#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };

910
/*
911 912
 * Add device- or boot-specific data to the input pool to help
 * initialize it.
913
 *
914 915 916
 * None of this adds any entropy; it is meant to avoid the problem of
 * the entropy pool having similar initial state across largely
 * identical devices.
917 918 919
 */
void add_device_randomness(const void *buf, unsigned int size)
{
920
	unsigned long time = random_get_entropy() ^ jiffies;
921
	unsigned long flags;
922

923
	trace_add_device_randomness(size, _RET_IP_);
924
	spin_lock_irqsave(&input_pool.lock, flags);
925 926
	_mix_pool_bytes(&input_pool, buf, size);
	_mix_pool_bytes(&input_pool, &time, sizeof(time));
927
	spin_unlock_irqrestore(&input_pool.lock, flags);
928 929 930
}
EXPORT_SYMBOL(add_device_randomness);

931
static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
932

L
Linus Torvalds 已提交
933 934 935 936 937 938 939 940 941 942 943 944
/*
 * This function adds entropy to the entropy "pool" by using timing
 * delays.  It uses the timer_rand_state structure to make an estimate
 * of how many bits of entropy this call has added to the pool.
 *
 * The number "num" is also added to the pool - it should somehow describe
 * the type of event which just happened.  This is currently 0-255 for
 * keyboard scan codes, and 256 upwards for interrupts.
 *
 */
static void add_timer_randomness(struct timer_rand_state *state, unsigned num)
{
945
	struct entropy_store	*r;
L
Linus Torvalds 已提交
946 947
	struct {
		long jiffies;
948
		unsigned cycles;
L
Linus Torvalds 已提交
949 950 951 952 953 954 955
		unsigned num;
	} sample;
	long delta, delta2, delta3;

	preempt_disable();

	sample.jiffies = jiffies;
956
	sample.cycles = random_get_entropy();
L
Linus Torvalds 已提交
957
	sample.num = num;
958
	r = &input_pool;
959
	mix_pool_bytes(r, &sample, sizeof(sample));
L
Linus Torvalds 已提交
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992

	/*
	 * Calculate number of bits of randomness we probably added.
	 * We take into account the first, second and third-order deltas
	 * in order to make our estimate.
	 */

	if (!state->dont_count_entropy) {
		delta = sample.jiffies - state->last_time;
		state->last_time = sample.jiffies;

		delta2 = delta - state->last_delta;
		state->last_delta = delta;

		delta3 = delta2 - state->last_delta2;
		state->last_delta2 = delta2;

		if (delta < 0)
			delta = -delta;
		if (delta2 < 0)
			delta2 = -delta2;
		if (delta3 < 0)
			delta3 = -delta3;
		if (delta > delta2)
			delta = delta2;
		if (delta > delta3)
			delta = delta3;

		/*
		 * delta is now minimum absolute delta.
		 * Round down by 1 bit on general principles,
		 * and limit entropy entimate to 12 bits.
		 */
993
		credit_entropy_bits(r, min_t(int, fls(delta>>1), 11));
L
Linus Torvalds 已提交
994 995 996 997
	}
	preempt_enable();
}

998
void add_input_randomness(unsigned int type, unsigned int code,
L
Linus Torvalds 已提交
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
				 unsigned int value)
{
	static unsigned char last_value;

	/* ignore autorepeat and the like */
	if (value == last_value)
		return;

	last_value = value;
	add_timer_randomness(&input_timer_state,
			     (type << 4) ^ code ^ (code >> 4) ^ value);
1010
	trace_add_input_randomness(ENTROPY_BITS(&input_pool));
L
Linus Torvalds 已提交
1011
}
1012
EXPORT_SYMBOL_GPL(add_input_randomness);
L
Linus Torvalds 已提交
1013

1014 1015
static DEFINE_PER_CPU(struct fast_pool, irq_randomness);

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
#ifdef ADD_INTERRUPT_BENCH
static unsigned long avg_cycles, avg_deviation;

#define AVG_SHIFT 8     /* Exponential average factor k=1/256 */
#define FIXED_1_2 (1 << (AVG_SHIFT-1))

static void add_interrupt_bench(cycles_t start)
{
        long delta = random_get_entropy() - start;

        /* Use a weighted moving average */
        delta = delta - ((avg_cycles + FIXED_1_2) >> AVG_SHIFT);
        avg_cycles += delta;
        /* And average deviation */
        delta = abs(delta) - ((avg_deviation + FIXED_1_2) >> AVG_SHIFT);
        avg_deviation += delta;
}
#else
#define add_interrupt_bench(x)
#endif

1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
static __u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
{
	__u32 *ptr = (__u32 *) regs;

	if (regs == NULL)
		return 0;
	if (f->reg_idx >= sizeof(struct pt_regs) / sizeof(__u32))
		f->reg_idx = 0;
	return *(ptr + f->reg_idx++);
}

1048
void add_interrupt_randomness(int irq, int irq_flags)
L
Linus Torvalds 已提交
1049
{
1050
	struct entropy_store	*r;
1051
	struct fast_pool	*fast_pool = this_cpu_ptr(&irq_randomness);
1052 1053
	struct pt_regs		*regs = get_irq_regs();
	unsigned long		now = jiffies;
1054
	cycles_t		cycles = random_get_entropy();
1055
	__u32			c_high, j_high;
1056
	__u64			ip;
1057
	unsigned long		seed;
1058
	int			credit = 0;
1059

1060 1061
	if (cycles == 0)
		cycles = get_reg(fast_pool, regs);
1062 1063
	c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
	j_high = (sizeof(now) > 4) ? now >> 32 : 0;
1064 1065
	fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
	fast_pool->pool[1] ^= now ^ c_high;
1066
	ip = regs ? instruction_pointer(regs) : _RET_IP_;
1067
	fast_pool->pool[2] ^= ip;
1068 1069
	fast_pool->pool[3] ^= (sizeof(ip) > 4) ? ip >> 32 :
		get_reg(fast_pool, regs);
1070

1071 1072
	fast_mix(fast_pool);
	add_interrupt_bench(cycles);
1073

1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
	if (!crng_ready()) {
		if ((fast_pool->count >= 64) &&
		    crng_fast_load((char *) fast_pool->pool,
				   sizeof(fast_pool->pool))) {
			fast_pool->count = 0;
			fast_pool->last = now;
		}
		return;
	}

1084 1085
	if ((fast_pool->count < 64) &&
	    !time_after(now, fast_pool->last + HZ))
L
Linus Torvalds 已提交
1086 1087
		return;

1088
	r = &input_pool;
1089
	if (!spin_trylock(&r->lock))
1090
		return;
1091

1092
	fast_pool->last = now;
1093
	__mix_pool_bytes(r, &fast_pool->pool, sizeof(fast_pool->pool));
1094 1095 1096

	/*
	 * If we have architectural seed generator, produce a seed and
1097 1098 1099
	 * add it to the pool.  For the sake of paranoia don't let the
	 * architectural seed generator dominate the input from the
	 * interrupt noise.
1100 1101
	 */
	if (arch_get_random_seed_long(&seed)) {
1102
		__mix_pool_bytes(r, &seed, sizeof(seed));
1103
		credit = 1;
1104
	}
1105
	spin_unlock(&r->lock);
1106

1107
	fast_pool->count = 0;
1108

1109 1110
	/* award one bit for the contents of the fast pool */
	credit_entropy_bits(r, credit + 1);
L
Linus Torvalds 已提交
1111
}
1112
EXPORT_SYMBOL_GPL(add_interrupt_randomness);
L
Linus Torvalds 已提交
1113

1114
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
1115 1116 1117 1118 1119
void add_disk_randomness(struct gendisk *disk)
{
	if (!disk || !disk->random)
		return;
	/* first major is 1, so we get >= 0x200 here */
1120
	add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
1121
	trace_add_disk_randomness(disk_devt(disk), ENTROPY_BITS(&input_pool));
L
Linus Torvalds 已提交
1122
}
1123
EXPORT_SYMBOL_GPL(add_disk_randomness);
1124
#endif
L
Linus Torvalds 已提交
1125 1126 1127 1128 1129 1130 1131 1132

/*********************************************************************
 *
 * Entropy extraction routines
 *
 *********************************************************************/

/*
L
Lucas De Marchi 已提交
1133
 * This utility inline function is responsible for transferring entropy
L
Linus Torvalds 已提交
1134 1135 1136
 * from the primary pool to the secondary extraction pool. We make
 * sure we pull enough for a 'catastrophic reseed'.
 */
1137
static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes);
L
Linus Torvalds 已提交
1138 1139
static void xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
{
1140 1141 1142 1143 1144
	if (!r->pull ||
	    r->entropy_count >= (nbytes << (ENTROPY_SHIFT + 3)) ||
	    r->entropy_count > r->poolinfo->poolfracbits)
		return;

1145 1146
	if (r->limit == 0 && random_min_urandom_seed) {
		unsigned long now = jiffies;
L
Linus Torvalds 已提交
1147

1148 1149 1150 1151
		if (time_before(now,
				r->last_pulled + random_min_urandom_seed * HZ))
			return;
		r->last_pulled = now;
L
Linus Torvalds 已提交
1152
	}
1153 1154

	_xfer_secondary_pool(r, nbytes);
1155 1156 1157 1158 1159 1160
}

static void _xfer_secondary_pool(struct entropy_store *r, size_t nbytes)
{
	__u32	tmp[OUTPUT_POOL_WORDS];

1161 1162
	/* For /dev/random's pool, always leave two wakeups' worth */
	int rsvd_bytes = r->limit ? 0 : random_read_wakeup_bits / 4;
1163 1164
	int bytes = nbytes;

1165 1166
	/* pull at least as much as a wakeup */
	bytes = max_t(int, bytes, random_read_wakeup_bits / 8);
1167 1168 1169
	/* but never more than the buffer size */
	bytes = min_t(int, bytes, sizeof(tmp));

1170 1171
	trace_xfer_secondary_pool(r->name, bytes * 8, nbytes * 8,
				  ENTROPY_BITS(r), ENTROPY_BITS(r->pull));
1172
	bytes = extract_entropy(r->pull, tmp, bytes,
1173
				random_read_wakeup_bits / 8, rsvd_bytes);
1174
	mix_pool_bytes(r, tmp, bytes);
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
	credit_entropy_bits(r, bytes*8);
}

/*
 * Used as a workqueue function so that when the input pool is getting
 * full, we can "spill over" some entropy to the output pools.  That
 * way the output pools can store some of the excess entropy instead
 * of letting it go to waste.
 */
static void push_to_pool(struct work_struct *work)
{
	struct entropy_store *r = container_of(work, struct entropy_store,
					      push_work);
	BUG_ON(!r);
1189
	_xfer_secondary_pool(r, random_read_wakeup_bits/8);
1190 1191
	trace_push_to_pool(r->name, r->entropy_count >> ENTROPY_SHIFT,
			   r->pull->entropy_count >> ENTROPY_SHIFT);
L
Linus Torvalds 已提交
1192 1193 1194
}

/*
G
Greg Price 已提交
1195 1196
 * This function decides how many bytes to actually take from the
 * given pool, and also debits the entropy count accordingly.
L
Linus Torvalds 已提交
1197 1198 1199 1200
 */
static size_t account(struct entropy_store *r, size_t nbytes, int min,
		      int reserved)
{
1201
	int entropy_count, orig;
1202
	size_t ibytes, nfrac;
L
Linus Torvalds 已提交
1203

1204
	BUG_ON(r->entropy_count > r->poolinfo->poolfracbits);
L
Linus Torvalds 已提交
1205 1206

	/* Can we pull enough? */
1207
retry:
1208 1209
	entropy_count = orig = ACCESS_ONCE(r->entropy_count);
	ibytes = nbytes;
G
Greg Price 已提交
1210
	/* If limited, never pull more than available */
1211 1212 1213 1214 1215 1216 1217
	if (r->limit) {
		int have_bytes = entropy_count >> (ENTROPY_SHIFT + 3);

		if ((have_bytes -= reserved) < 0)
			have_bytes = 0;
		ibytes = min_t(size_t, ibytes, have_bytes);
	}
G
Greg Price 已提交
1218
	if (ibytes < min)
1219
		ibytes = 0;
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230

	if (unlikely(entropy_count < 0)) {
		pr_warn("random: negative entropy count: pool %s count %d\n",
			r->name, entropy_count);
		WARN_ON(1);
		entropy_count = 0;
	}
	nfrac = ibytes << (ENTROPY_SHIFT + 3);
	if ((size_t) entropy_count > nfrac)
		entropy_count -= nfrac;
	else
1231
		entropy_count = 0;
1232

G
Greg Price 已提交
1233 1234
	if (cmpxchg(&r->entropy_count, orig, entropy_count) != orig)
		goto retry;
L
Linus Torvalds 已提交
1235

1236
	trace_debit_entropy(r->name, 8 * ibytes);
G
Greg Price 已提交
1237
	if (ibytes &&
1238
	    (r->entropy_count >> ENTROPY_SHIFT) < random_write_wakeup_bits) {
1239 1240 1241 1242
		wake_up_interruptible(&random_write_wait);
		kill_fasync(&fasync, SIGIO, POLL_OUT);
	}

1243
	return ibytes;
L
Linus Torvalds 已提交
1244 1245
}

G
Greg Price 已提交
1246 1247 1248 1249 1250 1251
/*
 * This function does the actual extraction for extract_entropy and
 * extract_entropy_user.
 *
 * Note: we assume that .poolwords is a multiple of 16 words.
 */
L
Linus Torvalds 已提交
1252 1253
static void extract_buf(struct entropy_store *r, __u8 *out)
{
1254
	int i;
1255 1256
	union {
		__u32 w[5];
1257
		unsigned long l[LONGS(20)];
1258 1259
	} hash;
	__u32 workspace[SHA_WORKSPACE_WORDS];
1260
	unsigned long flags;
L
Linus Torvalds 已提交
1261

1262
	/*
1263
	 * If we have an architectural hardware random number
1264
	 * generator, use it for SHA's initial vector
1265
	 */
1266
	sha_init(hash.w);
1267 1268 1269 1270
	for (i = 0; i < LONGS(20); i++) {
		unsigned long v;
		if (!arch_get_random_long(&v))
			break;
1271
		hash.l[i] = v;
1272 1273
	}

1274 1275 1276 1277 1278
	/* Generate a hash across the pool, 16 words (512 bits) at a time */
	spin_lock_irqsave(&r->lock, flags);
	for (i = 0; i < r->poolinfo->poolwords; i += 16)
		sha_transform(hash.w, (__u8 *)(r->pool + i), workspace);

L
Linus Torvalds 已提交
1279
	/*
1280 1281 1282 1283 1284 1285 1286
	 * We mix the hash back into the pool to prevent backtracking
	 * attacks (where the attacker knows the state of the pool
	 * plus the current outputs, and attempts to find previous
	 * ouputs), unless the hash function can be inverted. By
	 * mixing at least a SHA1 worth of hash data back, we make
	 * brute-forcing the feedback as hard as brute-forcing the
	 * hash.
L
Linus Torvalds 已提交
1287
	 */
1288
	__mix_pool_bytes(r, hash.w, sizeof(hash.w));
1289
	spin_unlock_irqrestore(&r->lock, flags);
L
Linus Torvalds 已提交
1290

1291
	memzero_explicit(workspace, sizeof(workspace));
L
Linus Torvalds 已提交
1292 1293

	/*
1294 1295 1296
	 * In case the hash function has some recognizable output
	 * pattern, we fold it in half. Thus, we always feed back
	 * twice as much data as we output.
L
Linus Torvalds 已提交
1297
	 */
1298 1299 1300 1301 1302
	hash.w[0] ^= hash.w[3];
	hash.w[1] ^= hash.w[4];
	hash.w[2] ^= rol32(hash.w[2], 16);

	memcpy(out, &hash, EXTRACT_SIZE);
1303
	memzero_explicit(&hash, sizeof(hash));
L
Linus Torvalds 已提交
1304 1305
}

1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
static ssize_t _extract_entropy(struct entropy_store *r, void *buf,
				size_t nbytes, int fips)
{
	ssize_t ret = 0, i;
	__u8 tmp[EXTRACT_SIZE];
	unsigned long flags;

	while (nbytes) {
		extract_buf(r, tmp);

		if (fips) {
			spin_lock_irqsave(&r->lock, flags);
			if (!memcmp(tmp, r->last_data, EXTRACT_SIZE))
				panic("Hardware RNG duplicated output!\n");
			memcpy(r->last_data, tmp, EXTRACT_SIZE);
			spin_unlock_irqrestore(&r->lock, flags);
		}
		i = min_t(int, nbytes, EXTRACT_SIZE);
		memcpy(buf, tmp, i);
		nbytes -= i;
		buf += i;
		ret += i;
	}

	/* Wipe data just returned from memory */
	memzero_explicit(tmp, sizeof(tmp));

	return ret;
}

G
Greg Price 已提交
1336 1337 1338 1339 1340 1341 1342 1343 1344
/*
 * This function extracts randomness from the "entropy pool", and
 * returns it in a buffer.
 *
 * The min parameter specifies the minimum amount we can pull before
 * failing to avoid races that defeat catastrophic reseeding while the
 * reserved parameter indicates how much entropy we must leave in the
 * pool after each pull to avoid starving other readers.
 */
1345
static ssize_t extract_entropy(struct entropy_store *r, void *buf,
1346
				 size_t nbytes, int min, int reserved)
L
Linus Torvalds 已提交
1347 1348
{
	__u8 tmp[EXTRACT_SIZE];
1349
	unsigned long flags;
L
Linus Torvalds 已提交
1350

1351
	/* if last_data isn't primed, we need EXTRACT_SIZE extra bytes */
1352 1353 1354
	if (fips_enabled) {
		spin_lock_irqsave(&r->lock, flags);
		if (!r->last_data_init) {
1355
			r->last_data_init = 1;
1356 1357
			spin_unlock_irqrestore(&r->lock, flags);
			trace_extract_entropy(r->name, EXTRACT_SIZE,
1358
					      ENTROPY_BITS(r), _RET_IP_);
1359 1360 1361 1362 1363 1364 1365
			xfer_secondary_pool(r, EXTRACT_SIZE);
			extract_buf(r, tmp);
			spin_lock_irqsave(&r->lock, flags);
			memcpy(r->last_data, tmp, EXTRACT_SIZE);
		}
		spin_unlock_irqrestore(&r->lock, flags);
	}
1366

1367
	trace_extract_entropy(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
L
Linus Torvalds 已提交
1368 1369 1370
	xfer_secondary_pool(r, nbytes);
	nbytes = account(r, nbytes, min, reserved);

1371
	return _extract_entropy(r, buf, nbytes, fips_enabled);
L
Linus Torvalds 已提交
1372 1373
}

G
Greg Price 已提交
1374 1375 1376 1377
/*
 * This function extracts randomness from the "entropy pool", and
 * returns it in a userspace buffer.
 */
L
Linus Torvalds 已提交
1378 1379 1380 1381 1382
static ssize_t extract_entropy_user(struct entropy_store *r, void __user *buf,
				    size_t nbytes)
{
	ssize_t ret = 0, i;
	__u8 tmp[EXTRACT_SIZE];
1383
	int large_request = (nbytes > 256);
L
Linus Torvalds 已提交
1384

1385
	trace_extract_entropy_user(r->name, nbytes, ENTROPY_BITS(r), _RET_IP_);
L
Linus Torvalds 已提交
1386 1387 1388 1389
	xfer_secondary_pool(r, nbytes);
	nbytes = account(r, nbytes, 0, 0);

	while (nbytes) {
1390
		if (large_request && need_resched()) {
L
Linus Torvalds 已提交
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
			if (signal_pending(current)) {
				if (ret == 0)
					ret = -ERESTARTSYS;
				break;
			}
			schedule();
		}

		extract_buf(r, tmp);
		i = min_t(int, nbytes, EXTRACT_SIZE);
		if (copy_to_user(buf, tmp, i)) {
			ret = -EFAULT;
			break;
		}

		nbytes -= i;
		buf += i;
		ret += i;
	}

	/* Wipe data just returned from memory */
1412
	memzero_explicit(tmp, sizeof(tmp));
L
Linus Torvalds 已提交
1413 1414 1415 1416 1417 1418

	return ret;
}

/*
 * This function is the exported kernel interface.  It returns some
1419
 * number of good random numbers, suitable for key generation, seeding
1420 1421 1422
 * TCP sequence numbers, etc.  It does not rely on the hardware random
 * number generator.  For random bytes direct from the hardware RNG
 * (when available), use get_random_bytes_arch().
L
Linus Torvalds 已提交
1423 1424
 */
void get_random_bytes(void *buf, int nbytes)
1425
{
1426 1427
	__u8 tmp[CHACHA20_BLOCK_SIZE];

1428
#if DEBUG_RANDOM_BOOT > 0
1429
	if (!crng_ready())
1430
		printk(KERN_NOTICE "random: %pF get_random_bytes called "
1431
		       "with crng_init = %d\n", (void *) _RET_IP_, crng_init);
1432
#endif
1433
	trace_get_random_bytes(nbytes, _RET_IP_);
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445

	while (nbytes >= CHACHA20_BLOCK_SIZE) {
		extract_crng(buf);
		buf += CHACHA20_BLOCK_SIZE;
		nbytes -= CHACHA20_BLOCK_SIZE;
	}

	if (nbytes > 0) {
		extract_crng(tmp);
		memcpy(buf, tmp, nbytes);
		memzero_explicit(tmp, nbytes);
	}
1446 1447 1448
}
EXPORT_SYMBOL(get_random_bytes);

1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
/*
 * Add a callback function that will be invoked when the nonblocking
 * pool is initialised.
 *
 * returns: 0 if callback is successfully added
 *	    -EALREADY if pool is already initialised (callback not called)
 *	    -ENOENT if module for callback is not alive
 */
int add_random_ready_callback(struct random_ready_callback *rdy)
{
	struct module *owner;
	unsigned long flags;
	int err = -EALREADY;

1463
	if (crng_ready())
1464 1465 1466 1467 1468 1469 1470
		return err;

	owner = rdy->owner;
	if (!try_module_get(owner))
		return -ENOENT;

	spin_lock_irqsave(&random_ready_list_lock, flags);
1471
	if (crng_ready())
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506
		goto out;

	owner = NULL;

	list_add(&rdy->list, &random_ready_list);
	err = 0;

out:
	spin_unlock_irqrestore(&random_ready_list_lock, flags);

	module_put(owner);

	return err;
}
EXPORT_SYMBOL(add_random_ready_callback);

/*
 * Delete a previously registered readiness callback function.
 */
void del_random_ready_callback(struct random_ready_callback *rdy)
{
	unsigned long flags;
	struct module *owner = NULL;

	spin_lock_irqsave(&random_ready_list_lock, flags);
	if (!list_empty(&rdy->list)) {
		list_del_init(&rdy->list);
		owner = rdy->owner;
	}
	spin_unlock_irqrestore(&random_ready_list_lock, flags);

	module_put(owner);
}
EXPORT_SYMBOL(del_random_ready_callback);

1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
/*
 * This function will use the architecture-specific hardware random
 * number generator if it is available.  The arch-specific hw RNG will
 * almost certainly be faster than what we can do in software, but it
 * is impossible to verify that it is implemented securely (as
 * opposed, to, say, the AES encryption of a sequence number using a
 * key known by the NSA).  So it's useful if we need the speed, but
 * only if we're willing to trust the hardware manufacturer not to
 * have put in a back door.
 */
void get_random_bytes_arch(void *buf, int nbytes)
L
Linus Torvalds 已提交
1518
{
1519 1520
	char *p = buf;

1521
	trace_get_random_bytes_arch(nbytes, _RET_IP_);
1522 1523 1524
	while (nbytes) {
		unsigned long v;
		int chunk = min(nbytes, (int)sizeof(unsigned long));
1525

1526 1527 1528
		if (!arch_get_random_long(&v))
			break;
		
L
Luck, Tony 已提交
1529
		memcpy(p, &v, chunk);
1530 1531 1532 1533
		p += chunk;
		nbytes -= chunk;
	}

1534
	if (nbytes)
1535
		get_random_bytes(p, nbytes);
L
Linus Torvalds 已提交
1536
}
1537 1538
EXPORT_SYMBOL(get_random_bytes_arch);

L
Linus Torvalds 已提交
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550

/*
 * init_std_data - initialize pool with system data
 *
 * @r: pool to initialize
 *
 * This function clears the pool's entropy count and mixes some system
 * data into the pool to prepare it for use. The pool is not cleared
 * as that can only decrease the entropy in the pool.
 */
static void init_std_data(struct entropy_store *r)
{
1551
	int i;
1552 1553
	ktime_t now = ktime_get_real();
	unsigned long rv;
L
Linus Torvalds 已提交
1554

1555
	r->last_pulled = jiffies;
1556
	mix_pool_bytes(r, &now, sizeof(now));
1557
	for (i = r->poolinfo->poolbytes; i > 0; i -= sizeof(rv)) {
1558 1559
		if (!arch_get_random_seed_long(&rv) &&
		    !arch_get_random_long(&rv))
1560
			rv = random_get_entropy();
1561
		mix_pool_bytes(r, &rv, sizeof(rv));
1562
	}
1563
	mix_pool_bytes(r, utsname(), sizeof(*(utsname())));
L
Linus Torvalds 已提交
1564 1565
}

1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
/*
 * Note that setup_arch() may call add_device_randomness()
 * long before we get here. This allows seeding of the pools
 * with some platform dependent data very early in the boot
 * process. But it limits our options here. We must use
 * statically allocated structures that already have all
 * initializations complete at compile time. We should also
 * take care not to overwrite the precious per platform data
 * we were given.
 */
M
Matt Mackall 已提交
1576
static int rand_initialize(void)
L
Linus Torvalds 已提交
1577 1578 1579
{
	init_std_data(&input_pool);
	init_std_data(&blocking_pool);
1580
	crng_initialize(&primary_crng);
L
Linus Torvalds 已提交
1581 1582
	return 0;
}
1583
early_initcall(rand_initialize);
L
Linus Torvalds 已提交
1584

1585
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
1586 1587 1588 1589 1590
void rand_initialize_disk(struct gendisk *disk)
{
	struct timer_rand_state *state;

	/*
1591
	 * If kzalloc returns null, we just won't use that entropy
L
Linus Torvalds 已提交
1592 1593
	 * source.
	 */
1594
	state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1595 1596
	if (state) {
		state->last_time = INITIAL_JIFFIES;
L
Linus Torvalds 已提交
1597
		disk->random = state;
1598
	}
L
Linus Torvalds 已提交
1599
}
1600
#endif
L
Linus Torvalds 已提交
1601 1602

static ssize_t
1603
_random_read(int nonblock, char __user *buf, size_t nbytes)
L
Linus Torvalds 已提交
1604
{
1605
	ssize_t n;
L
Linus Torvalds 已提交
1606 1607 1608 1609

	if (nbytes == 0)
		return 0;

1610 1611 1612 1613 1614
	nbytes = min_t(size_t, nbytes, SEC_XFER_SIZE);
	while (1) {
		n = extract_entropy_user(&blocking_pool, buf, nbytes);
		if (n < 0)
			return n;
1615 1616 1617
		trace_random_read(n*8, (nbytes-n)*8,
				  ENTROPY_BITS(&blocking_pool),
				  ENTROPY_BITS(&input_pool));
1618 1619
		if (n > 0)
			return n;
1620

1621
		/* Pool is (near) empty.  Maybe wait and retry. */
1622
		if (nonblock)
1623 1624 1625 1626
			return -EAGAIN;

		wait_event_interruptible(random_read_wait,
			ENTROPY_BITS(&input_pool) >=
1627
			random_read_wakeup_bits);
1628 1629
		if (signal_pending(current))
			return -ERESTARTSYS;
L
Linus Torvalds 已提交
1630 1631 1632
	}
}

1633 1634 1635 1636 1637 1638
static ssize_t
random_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
{
	return _random_read(file->f_flags & O_NONBLOCK, buf, nbytes);
}

L
Linus Torvalds 已提交
1639
static ssize_t
1640
urandom_read(struct file *file, char __user *buf, size_t nbytes, loff_t *ppos)
L
Linus Torvalds 已提交
1641
{
1642
	unsigned long flags;
1643
	static int maxwarn = 10;
1644 1645
	int ret;

1646
	if (!crng_ready() && maxwarn > 0) {
1647 1648
		maxwarn--;
		printk(KERN_NOTICE "random: %s: uninitialized urandom read "
1649 1650 1651 1652 1653
		       "(%zd bytes read)\n",
		       current->comm, nbytes);
		spin_lock_irqsave(&primary_crng.lock, flags);
		crng_init_cnt = 0;
		spin_unlock_irqrestore(&primary_crng.lock, flags);
1654
	}
1655
	nbytes = min_t(size_t, nbytes, INT_MAX >> (ENTROPY_SHIFT + 3));
1656 1657
	ret = extract_crng_user(buf, nbytes);
	trace_urandom_read(8 * nbytes, 0, ENTROPY_BITS(&input_pool));
1658
	return ret;
L
Linus Torvalds 已提交
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668
}

static unsigned int
random_poll(struct file *file, poll_table * wait)
{
	unsigned int mask;

	poll_wait(file, &random_read_wait, wait);
	poll_wait(file, &random_write_wait, wait);
	mask = 0;
1669
	if (ENTROPY_BITS(&input_pool) >= random_read_wakeup_bits)
L
Linus Torvalds 已提交
1670
		mask |= POLLIN | POLLRDNORM;
1671
	if (ENTROPY_BITS(&input_pool) < random_write_wakeup_bits)
L
Linus Torvalds 已提交
1672 1673 1674 1675
		mask |= POLLOUT | POLLWRNORM;
	return mask;
}

1676 1677
static int
write_pool(struct entropy_store *r, const char __user *buffer, size_t count)
L
Linus Torvalds 已提交
1678 1679 1680 1681 1682
{
	size_t bytes;
	__u32 buf[16];
	const char __user *p = buffer;

1683 1684 1685 1686
	while (count > 0) {
		bytes = min(count, sizeof(buf));
		if (copy_from_user(&buf, p, bytes))
			return -EFAULT;
L
Linus Torvalds 已提交
1687

1688
		count -= bytes;
L
Linus Torvalds 已提交
1689 1690
		p += bytes;

1691
		mix_pool_bytes(r, buf, bytes);
1692
		cond_resched();
L
Linus Torvalds 已提交
1693
	}
1694 1695 1696 1697

	return 0;
}

1698 1699
static ssize_t random_write(struct file *file, const char __user *buffer,
			    size_t count, loff_t *ppos)
1700 1701 1702
{
	size_t ret;

1703
	ret = write_pool(&input_pool, buffer, count);
1704 1705 1706 1707
	if (ret)
		return ret;

	return (ssize_t)count;
L
Linus Torvalds 已提交
1708 1709
}

M
Matt Mackall 已提交
1710
static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
L
Linus Torvalds 已提交
1711 1712 1713 1714 1715 1716 1717
{
	int size, ent_count;
	int __user *p = (int __user *)arg;
	int retval;

	switch (cmd) {
	case RNDGETENTCNT:
M
Matt Mackall 已提交
1718
		/* inherently racy, no point locking */
1719 1720
		ent_count = ENTROPY_BITS(&input_pool);
		if (put_user(ent_count, p))
L
Linus Torvalds 已提交
1721 1722 1723 1724 1725 1726 1727
			return -EFAULT;
		return 0;
	case RNDADDTOENTCNT:
		if (!capable(CAP_SYS_ADMIN))
			return -EPERM;
		if (get_user(ent_count, p))
			return -EFAULT;
1728
		credit_entropy_bits_safe(&input_pool, ent_count);
L
Linus Torvalds 已提交
1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
		return 0;
	case RNDADDENTROPY:
		if (!capable(CAP_SYS_ADMIN))
			return -EPERM;
		if (get_user(ent_count, p++))
			return -EFAULT;
		if (ent_count < 0)
			return -EINVAL;
		if (get_user(size, p++))
			return -EFAULT;
1739 1740
		retval = write_pool(&input_pool, (const char __user *)p,
				    size);
L
Linus Torvalds 已提交
1741 1742
		if (retval < 0)
			return retval;
1743
		credit_entropy_bits_safe(&input_pool, ent_count);
L
Linus Torvalds 已提交
1744 1745 1746
		return 0;
	case RNDZAPENTCNT:
	case RNDCLEARPOOL:
1747 1748 1749 1750
		/*
		 * Clear the entropy pool counters. We no longer clear
		 * the entropy pool, as that's silly.
		 */
L
Linus Torvalds 已提交
1751 1752
		if (!capable(CAP_SYS_ADMIN))
			return -EPERM;
1753 1754
		input_pool.entropy_count = 0;
		blocking_pool.entropy_count = 0;
L
Linus Torvalds 已提交
1755 1756 1757 1758 1759 1760
		return 0;
	default:
		return -EINVAL;
	}
}

1761 1762 1763 1764 1765
static int random_fasync(int fd, struct file *filp, int on)
{
	return fasync_helper(fd, filp, on, &fasync);
}

1766
const struct file_operations random_fops = {
L
Linus Torvalds 已提交
1767 1768 1769
	.read  = random_read,
	.write = random_write,
	.poll  = random_poll,
M
Matt Mackall 已提交
1770
	.unlocked_ioctl = random_ioctl,
1771
	.fasync = random_fasync,
1772
	.llseek = noop_llseek,
L
Linus Torvalds 已提交
1773 1774
};

1775
const struct file_operations urandom_fops = {
L
Linus Torvalds 已提交
1776 1777
	.read  = urandom_read,
	.write = random_write,
M
Matt Mackall 已提交
1778
	.unlocked_ioctl = random_ioctl,
1779
	.fasync = random_fasync,
1780
	.llseek = noop_llseek,
L
Linus Torvalds 已提交
1781 1782
};

1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794
SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count,
		unsigned int, flags)
{
	if (flags & ~(GRND_NONBLOCK|GRND_RANDOM))
		return -EINVAL;

	if (count > INT_MAX)
		count = INT_MAX;

	if (flags & GRND_RANDOM)
		return _random_read(flags & GRND_NONBLOCK, buf, count);

1795
	if (!crng_ready()) {
1796 1797
		if (flags & GRND_NONBLOCK)
			return -EAGAIN;
1798
		crng_wait_ready();
1799 1800 1801 1802 1803 1804
		if (signal_pending(current))
			return -ERESTARTSYS;
	}
	return urandom_read(NULL, buf, count, NULL);
}

L
Linus Torvalds 已提交
1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815
/********************************************************************
 *
 * Sysctl interface
 *
 ********************************************************************/

#ifdef CONFIG_SYSCTL

#include <linux/sysctl.h>

static int min_read_thresh = 8, min_write_thresh;
1816
static int max_read_thresh = OUTPUT_POOL_WORDS * 32;
L
Linus Torvalds 已提交
1817 1818 1819 1820
static int max_write_thresh = INPUT_POOL_WORDS * 32;
static char sysctl_bootid[16];

/*
G
Greg Price 已提交
1821
 * This function is used to return both the bootid UUID, and random
L
Linus Torvalds 已提交
1822 1823 1824
 * UUID.  The difference is in whether table->data is NULL; if it is,
 * then a new UUID is generated and returned to the user.
 *
G
Greg Price 已提交
1825 1826 1827
 * If the user accesses this via the proc interface, the UUID will be
 * returned as an ASCII string in the standard UUID format; if via the
 * sysctl system call, as 16 bytes of binary data.
L
Linus Torvalds 已提交
1828
 */
1829
static int proc_do_uuid(struct ctl_table *table, int write,
L
Linus Torvalds 已提交
1830 1831
			void __user *buffer, size_t *lenp, loff_t *ppos)
{
1832
	struct ctl_table fake_table;
L
Linus Torvalds 已提交
1833 1834 1835 1836 1837 1838
	unsigned char buf[64], tmp_uuid[16], *uuid;

	uuid = table->data;
	if (!uuid) {
		uuid = tmp_uuid;
		generate_random_uuid(uuid);
1839 1840 1841 1842 1843 1844 1845 1846
	} else {
		static DEFINE_SPINLOCK(bootid_spinlock);

		spin_lock(&bootid_spinlock);
		if (!uuid[8])
			generate_random_uuid(uuid);
		spin_unlock(&bootid_spinlock);
	}
L
Linus Torvalds 已提交
1847

J
Joe Perches 已提交
1848 1849
	sprintf(buf, "%pU", uuid);

L
Linus Torvalds 已提交
1850 1851 1852
	fake_table.data = buf;
	fake_table.maxlen = sizeof(buf);

1853
	return proc_dostring(&fake_table, write, buffer, lenp, ppos);
L
Linus Torvalds 已提交
1854 1855
}

1856 1857 1858
/*
 * Return entropy available scaled to integral bits
 */
1859
static int proc_do_entropy(struct ctl_table *table, int write,
1860 1861
			   void __user *buffer, size_t *lenp, loff_t *ppos)
{
1862
	struct ctl_table fake_table;
1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
	int entropy_count;

	entropy_count = *(int *)table->data >> ENTROPY_SHIFT;

	fake_table.data = &entropy_count;
	fake_table.maxlen = sizeof(entropy_count);

	return proc_dointvec(&fake_table, write, buffer, lenp, ppos);
}

L
Linus Torvalds 已提交
1873
static int sysctl_poolsize = INPUT_POOL_WORDS * 32;
1874 1875
extern struct ctl_table random_table[];
struct ctl_table random_table[] = {
L
Linus Torvalds 已提交
1876 1877 1878 1879 1880
	{
		.procname	= "poolsize",
		.data		= &sysctl_poolsize,
		.maxlen		= sizeof(int),
		.mode		= 0444,
1881
		.proc_handler	= proc_dointvec,
L
Linus Torvalds 已提交
1882 1883 1884 1885 1886
	},
	{
		.procname	= "entropy_avail",
		.maxlen		= sizeof(int),
		.mode		= 0444,
1887
		.proc_handler	= proc_do_entropy,
L
Linus Torvalds 已提交
1888 1889 1890 1891
		.data		= &input_pool.entropy_count,
	},
	{
		.procname	= "read_wakeup_threshold",
1892
		.data		= &random_read_wakeup_bits,
L
Linus Torvalds 已提交
1893 1894
		.maxlen		= sizeof(int),
		.mode		= 0644,
1895
		.proc_handler	= proc_dointvec_minmax,
L
Linus Torvalds 已提交
1896 1897 1898 1899 1900
		.extra1		= &min_read_thresh,
		.extra2		= &max_read_thresh,
	},
	{
		.procname	= "write_wakeup_threshold",
1901
		.data		= &random_write_wakeup_bits,
L
Linus Torvalds 已提交
1902 1903
		.maxlen		= sizeof(int),
		.mode		= 0644,
1904
		.proc_handler	= proc_dointvec_minmax,
L
Linus Torvalds 已提交
1905 1906 1907
		.extra1		= &min_write_thresh,
		.extra2		= &max_write_thresh,
	},
1908 1909 1910 1911 1912 1913 1914
	{
		.procname	= "urandom_min_reseed_secs",
		.data		= &random_min_urandom_seed,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= proc_dointvec,
	},
L
Linus Torvalds 已提交
1915 1916 1917 1918 1919
	{
		.procname	= "boot_id",
		.data		= &sysctl_bootid,
		.maxlen		= 16,
		.mode		= 0444,
1920
		.proc_handler	= proc_do_uuid,
L
Linus Torvalds 已提交
1921 1922 1923 1924 1925
	},
	{
		.procname	= "uuid",
		.maxlen		= 16,
		.mode		= 0444,
1926
		.proc_handler	= proc_do_uuid,
L
Linus Torvalds 已提交
1927
	},
1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
#ifdef ADD_INTERRUPT_BENCH
	{
		.procname	= "add_interrupt_avg_cycles",
		.data		= &avg_cycles,
		.maxlen		= sizeof(avg_cycles),
		.mode		= 0444,
		.proc_handler	= proc_doulongvec_minmax,
	},
	{
		.procname	= "add_interrupt_avg_deviation",
		.data		= &avg_deviation,
		.maxlen		= sizeof(avg_deviation),
		.mode		= 0444,
		.proc_handler	= proc_doulongvec_minmax,
	},
#endif
1944
	{ }
L
Linus Torvalds 已提交
1945 1946 1947
};
#endif 	/* CONFIG_SYSCTL */

1948
static u32 random_int_secret[MD5_MESSAGE_BYTES / 4] ____cacheline_aligned;
L
Linus Torvalds 已提交
1949

1950
int random_int_secret_init(void)
L
Linus Torvalds 已提交
1951
{
1952
	get_random_bytes(random_int_secret, sizeof(random_int_secret));
L
Linus Torvalds 已提交
1953 1954 1955
	return 0;
}

1956 1957 1958
static DEFINE_PER_CPU(__u32 [MD5_DIGEST_WORDS], get_random_int_hash)
		__aligned(sizeof(unsigned long));

L
Linus Torvalds 已提交
1959 1960 1961 1962 1963 1964 1965 1966
/*
 * Get a random word for internal kernel use only. Similar to urandom but
 * with the goal of minimal entropy pool depletion. As a result, the random
 * value is not cryptographically secure but for several uses the cost of
 * depleting entropy is too high
 */
unsigned int get_random_int(void)
{
1967
	__u32 *hash;
1968
	unsigned int ret;
1969

1970 1971 1972 1973
	if (arch_get_random_int(&ret))
		return ret;

	hash = get_cpu_var(get_random_int_hash);
1974

1975
	hash[0] += current->pid + jiffies + random_get_entropy();
1976 1977
	md5_transform(hash, random_int_secret);
	ret = hash[0];
1978 1979 1980
	put_cpu_var(get_random_int_hash);

	return ret;
L
Linus Torvalds 已提交
1981
}
1982
EXPORT_SYMBOL(get_random_int);
L
Linus Torvalds 已提交
1983

1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
/*
 * Same as get_random_int(), but returns unsigned long.
 */
unsigned long get_random_long(void)
{
	__u32 *hash;
	unsigned long ret;

	if (arch_get_random_long(&ret))
		return ret;

	hash = get_cpu_var(get_random_int_hash);

	hash[0] += current->pid + jiffies + random_get_entropy();
	md5_transform(hash, random_int_secret);
	ret = *(unsigned long *)hash;
	put_cpu_var(get_random_int_hash);

	return ret;
}
EXPORT_SYMBOL(get_random_long);

L
Linus Torvalds 已提交
2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
/*
 * randomize_range() returns a start address such that
 *
 *    [...... <range> .....]
 *  start                  end
 *
 * a <range> with size "len" starting at the return value is inside in the
 * area defined by [start, end], but is otherwise randomized.
 */
unsigned long
randomize_range(unsigned long start, unsigned long end, unsigned long len)
{
	unsigned long range = end - len - start;

	if (end <= start + len)
		return 0;
	return PAGE_ALIGN(get_random_int() % range + start);
}
2024 2025 2026 2027 2028 2029 2030 2031 2032 2033

/* Interface for in-kernel drivers of true hardware RNGs.
 * Those devices may produce endless random bits and will be throttled
 * when our pool is full.
 */
void add_hwgenerator_randomness(const char *buffer, size_t count,
				size_t entropy)
{
	struct entropy_store *poolp = &input_pool;

2034 2035 2036
	if (!crng_ready()) {
		crng_fast_load(buffer, count);
		return;
2037
	}
2038 2039 2040 2041 2042 2043 2044

	/* Suspend writing if we're above the trickle threshold.
	 * We'll be woken up again once below random_write_wakeup_thresh,
	 * or when the calling thread is about to terminate.
	 */
	wait_event_interruptible(random_write_wait, kthread_should_stop() ||
			ENTROPY_BITS(&input_pool) <= random_write_wakeup_bits);
2045 2046 2047 2048
	mix_pool_bytes(poolp, buffer, count);
	credit_entropy_bits(poolp, entropy);
}
EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);