random.c 50.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
/*
 * random.c -- A strong random number generator
 *
4
 * Copyright (C) 2017-2022 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
5
 *
6
 * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
L
Linus Torvalds 已提交
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
 *
 * 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.
 */

/*
 * Exported interfaces ---- output
 * ===============================
 *
48
 * There are four exported interfaces; two for use within the kernel,
schspa's avatar
schspa 已提交
49
 * and two for use from userspace.
L
Linus Torvalds 已提交
50
 *
51 52
 * Exported interfaces ---- userspace output
 * -----------------------------------------
L
Linus Torvalds 已提交
53
 *
54
 * The userspace interfaces are two character devices /dev/random and
L
Linus Torvalds 已提交
55 56 57 58 59 60 61 62 63 64 65 66
 * /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.
 *
67 68 69
 * Exported interfaces ---- kernel output
 * --------------------------------------
 *
70
 * The primary kernel interfaces are:
71
 *
72
 *	void get_random_bytes(void *buf, size_t nbytes);
73 74 75 76
 *	u32 get_random_u32()
 *	u64 get_random_u64()
 *	unsigned int get_random_int()
 *	unsigned long get_random_long()
77
 *
78 79 80 81 82
 * These interfaces will return the requested number of random bytes
 * into the given buffer or as a return value. This is equivalent to a
 * read from /dev/urandom. The get_random_{u32,u64,int,long}() family
 * of functions may be higher performance for one-off random integers,
 * because they do a bit of buffering.
83 84 85 86 87 88 89 90 91 92 93
 *
 * prandom_u32()
 * -------------
 *
 * For even weaker applications, see the pseudorandom generator
 * prandom_u32(), prandom_max(), and prandom_bytes().  If the random
 * numbers aren't security-critical at all, these are *far* cheaper.
 * Useful for self-tests, random error simulation, randomized backoffs,
 * and any other application where you trust that nobody is trying to
 * maliciously mess with you by guessing the "random" numbers.
 *
L
Linus Torvalds 已提交
94 95 96 97 98 99
 * Exported interfaces ---- input
 * ==============================
 *
 * The current exported interfaces for gathering environmental noise
 * from the devices are:
 *
100
 *	void add_device_randomness(const void *buf, size_t size);
101
 *	void add_input_randomness(unsigned int type, unsigned int code,
L
Linus Torvalds 已提交
102
 *                                unsigned int value);
103
 *	void add_interrupt_randomness(int irq);
104
 *	void add_disk_randomness(struct gendisk *disk);
105
 *	void add_hwgenerator_randomness(const void *buffer, size_t count,
106
 *					size_t entropy);
107
 *	void add_bootloader_randomness(const void *buf, size_t size);
L
Linus Torvalds 已提交
108
 *
109 110 111 112 113 114 115 116
 * 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 已提交
117 118 119
 * add_input_randomness() uses the input layer interrupt timing, as well as
 * the event type information from the hardware.
 *
120 121 122
 * 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.
123 124 125 126 127 128
 *
 * 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 已提交
129 130 131 132 133
 *
 * 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.
 *
134 135 136 137 138 139 140 141
 * add_hwgenerator_randomness() is for true hardware RNGs, and will credit
 * entropy as specified by the caller. If the entropy pool is full it will
 * block until more entropy is needed.
 *
 * add_bootloader_randomness() is the same as add_hwgenerator_randomness() or
 * add_device_randomness(), depending on whether or not the configuration
 * option CONFIG_RANDOM_TRUST_BOOTLOADER is set.
 *
L
Linus Torvalds 已提交
142 143 144 145 146 147 148 149 150 151 152 153 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
 * 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:
 *
200 201
 *	mknod /dev/random c 1 8
 *	mknod /dev/urandom c 1 9
L
Linus Torvalds 已提交
202 203
 */

Y
Yangtao Li 已提交
204 205
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

L
Linus Torvalds 已提交
206 207 208 209 210 211 212 213 214 215 216 217 218
#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>
219
#include <linux/mm.h>
220
#include <linux/nodemask.h>
L
Linus Torvalds 已提交
221
#include <linux/spinlock.h>
222
#include <linux/kthread.h>
L
Linus Torvalds 已提交
223
#include <linux/percpu.h>
224
#include <linux/ptrace.h>
225
#include <linux/workqueue.h>
226
#include <linux/irq.h>
227
#include <linux/ratelimit.h>
228 229
#include <linux/syscalls.h>
#include <linux/completion.h>
230
#include <linux/uuid.h>
231
#include <crypto/chacha.h>
232
#include <crypto/blake2s.h>
233

L
Linus Torvalds 已提交
234
#include <asm/processor.h>
235
#include <linux/uaccess.h>
L
Linus Torvalds 已提交
236
#include <asm/irq.h>
237
#include <asm/irq_regs.h>
L
Linus Torvalds 已提交
238 239
#include <asm/io.h>

240 241 242
#define CREATE_TRACE_POINTS
#include <trace/events/random.h>

243 244
/* #define ADD_INTERRUPT_BENCH */

245
enum {
246
	POOL_BITS = BLAKE2S_HASH_SIZE * 8,
247
	POOL_MIN_BITS = POOL_BITS /* No point in settling for less. */
L
Linus Torvalds 已提交
248 249 250 251 252
};

/*
 * Static global variables
 */
253
static DECLARE_WAIT_QUEUE_HEAD(random_write_wait);
254
static struct fasync_struct *fasync;
L
Linus Torvalds 已提交
255

256 257 258
static DEFINE_SPINLOCK(random_ready_list_lock);
static LIST_HEAD(random_ready_list);

259 260 261 262 263 264 265 266 267
/*
 * 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;
T
Theodore Ts'o 已提交
268
#define crng_ready() (likely(crng_init > 1))
269 270
static int crng_init_cnt = 0;
static void process_random_ready_list(void);
271
static void _get_random_bytes(void *buf, size_t nbytes);
272

273 274 275 276 277 278 279 280 281 282
static struct ratelimit_state unseeded_warning =
	RATELIMIT_STATE_INIT("warn_unseeded_randomness", HZ, 3);
static struct ratelimit_state urandom_warning =
	RATELIMIT_STATE_INIT("warn_urandom_randomness", HZ, 3);

static int ratelimit_disable __read_mostly;

module_param_named(ratelimit_disable, ratelimit_disable, int, 0644);
MODULE_PARM_DESC(ratelimit_disable, "Disable random ratelimit suppression");

L
Linus Torvalds 已提交
283 284 285 286 287 288 289
/**********************************************************************
 *
 * OS independent entropy store.   Here are the functions which handle
 * storing entropy in an entropy pool.
 *
 **********************************************************************/

290
static struct {
291
	struct blake2s_state hash;
292
	spinlock_t lock;
293
	unsigned int entropy_count;
294
} input_pool = {
295 296 297 298
	.hash.h = { BLAKE2S_IV0 ^ (0x01010000 | BLAKE2S_HASH_SIZE),
		    BLAKE2S_IV1, BLAKE2S_IV2, BLAKE2S_IV3, BLAKE2S_IV4,
		    BLAKE2S_IV5, BLAKE2S_IV6, BLAKE2S_IV7 },
	.hash.outlen = BLAKE2S_HASH_SIZE,
299
	.lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
L
Linus Torvalds 已提交
300 301
};

302
static void extract_entropy(void *buf, size_t nbytes);
303

304
static void crng_reseed(void);
305

L
Linus Torvalds 已提交
306
/*
307
 * This function adds bytes into the entropy "pool".  It does not
L
Linus Torvalds 已提交
308
 * update the entropy estimate.  The caller should call
309
 * credit_entropy_bits if this is appropriate.
L
Linus Torvalds 已提交
310
 */
311
static void _mix_pool_bytes(const void *in, size_t nbytes)
L
Linus Torvalds 已提交
312
{
313
	blake2s_update(&input_pool.hash, in, nbytes);
L
Linus Torvalds 已提交
314 315
}

316
static void mix_pool_bytes(const void *in, size_t nbytes)
L
Linus Torvalds 已提交
317
{
318 319
	unsigned long flags;

320 321 322 323
	trace_mix_pool_bytes(nbytes, _RET_IP_);
	spin_lock_irqsave(&input_pool.lock, flags);
	_mix_pool_bytes(in, nbytes);
	spin_unlock_irqrestore(&input_pool.lock, flags);
L
Linus Torvalds 已提交
324 325
}

326
struct fast_pool {
327 328 329 330
	u32 pool[4];
	unsigned long last;
	u16 reg_idx;
	u8 count;
331 332 333 334 335 336 337
};

/*
 * 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.
 */
338
static void fast_mix(struct fast_pool *f)
339
{
340 341
	u32 a = f->pool[0],	b = f->pool[1];
	u32 c = f->pool[2],	d = f->pool[3];
342 343

	a += b;			c += d;
G
George Spelvin 已提交
344
	b = rol32(b, 6);	d = rol32(d, 27);
345 346 347
	d ^= a;			b ^= c;

	a += b;			c += d;
G
George Spelvin 已提交
348
	b = rol32(b, 16);	d = rol32(d, 14);
349 350 351
	d ^= a;			b ^= c;

	a += b;			c += d;
G
George Spelvin 已提交
352
	b = rol32(b, 6);	d = rol32(d, 27);
353 354 355
	d ^= a;			b ^= c;

	a += b;			c += d;
G
George Spelvin 已提交
356
	b = rol32(b, 16);	d = rol32(d, 14);
357 358 359 360
	d ^= a;			b ^= c;

	f->pool[0] = a;  f->pool[1] = b;
	f->pool[2] = c;  f->pool[3] = d;
361
	f->count++;
362 363
}

364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
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);
}

380
static void credit_entropy_bits(size_t nbits)
L
Linus Torvalds 已提交
381
{
382
	unsigned int entropy_count, orig, add;
383

384
	if (!nbits)
385 386
		return;

387
	add = min_t(size_t, nbits, POOL_BITS);
388

389 390
	do {
		orig = READ_ONCE(input_pool.entropy_count);
391
		entropy_count = min_t(unsigned int, POOL_BITS, orig + add);
392
	} while (cmpxchg(&input_pool.entropy_count, orig, entropy_count) != orig);
L
Linus Torvalds 已提交
393

394
	trace_credit_entropy_bits(nbits, entropy_count, _RET_IP_);
395

396
	if (crng_init < 2 && entropy_count >= POOL_MIN_BITS)
397
		crng_reseed();
L
Linus Torvalds 已提交
398 399
}

400 401 402 403 404 405
/*********************************************************************
 *
 * CRNG using CHACHA20
 *
 *********************************************************************/

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
enum {
	CRNG_RESEED_INTERVAL = 300 * HZ,
	CRNG_INIT_CNT_THRESH = 2 * CHACHA_KEY_SIZE
};

static struct {
	u8 key[CHACHA_KEY_SIZE] __aligned(__alignof__(long));
	unsigned long birth;
	unsigned long generation;
	spinlock_t lock;
} base_crng = {
	.lock = __SPIN_LOCK_UNLOCKED(base_crng.lock)
};

struct crng {
	u8 key[CHACHA_KEY_SIZE];
	unsigned long generation;
	local_lock_t lock;
};

static DEFINE_PER_CPU(struct crng, crngs) = {
	.generation = ULONG_MAX,
	.lock = INIT_LOCAL_LOCK(crngs.lock),
};
430 431 432

static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);

433 434
static void invalidate_batched_entropy(void);

435 436
/*
 * crng_fast_load() can be called by code in the interrupt service
437 438
 * path.  So we can't afford to dilly-dally. Returns the number of
 * bytes processed from cp.
439
 */
440
static size_t crng_fast_load(const void *cp, size_t len)
441 442
{
	unsigned long flags;
443
	const u8 *src = (const u8 *)cp;
444
	size_t ret = 0;
445

446
	if (!spin_trylock_irqsave(&base_crng.lock, flags))
447
		return 0;
T
Theodore Ts'o 已提交
448
	if (crng_init != 0) {
449
		spin_unlock_irqrestore(&base_crng.lock, flags);
450 451 452
		return 0;
	}
	while (len > 0 && crng_init_cnt < CRNG_INIT_CNT_THRESH) {
453 454
		base_crng.key[crng_init_cnt % sizeof(base_crng.key)] ^= *src;
		src++; crng_init_cnt++; len--; ret++;
455 456
	}
	if (crng_init_cnt >= CRNG_INIT_CNT_THRESH) {
457
		invalidate_batched_entropy();
458 459
		crng_init = 1;
	}
460
	spin_unlock_irqrestore(&base_crng.lock, flags);
461 462
	if (crng_init == 1)
		pr_notice("fast init done\n");
463
	return ret;
464 465
}

466 467 468 469 470 471 472
/*
 * crng_slow_load() is called by add_device_randomness, which has two
 * attributes.  (1) We can't trust the buffer passed to it is
 * guaranteed to be unpredictable (so it might not have any entropy at
 * all), and (2) it doesn't have the performance constraints of
 * crng_fast_load().
 *
473 474 475 476
 * So, we simply hash the contents in with the current key. Finally,
 * we do *not* advance crng_init_cnt since buffer we may get may be
 * something like a fixed DMI table (for example), which might very
 * well be unique to the machine, but is otherwise unvarying.
477
 */
478
static void crng_slow_load(const void *cp, size_t len)
479
{
480
	unsigned long flags;
481 482 483
	struct blake2s_state hash;

	blake2s_init(&hash, sizeof(base_crng.key));
484

485
	if (!spin_trylock_irqsave(&base_crng.lock, flags))
486
		return;
487
	if (crng_init != 0) {
488
		spin_unlock_irqrestore(&base_crng.lock, flags);
489
		return;
490
	}
491 492 493 494 495

	blake2s_update(&hash, base_crng.key, sizeof(base_crng.key));
	blake2s_update(&hash, cp, len);
	blake2s_final(&hash, base_crng.key);

496
	spin_unlock_irqrestore(&base_crng.lock, flags);
497 498
}

499
static void crng_reseed(void)
500
{
501
	unsigned long flags;
502 503 504
	int entropy_count;
	unsigned long next_gen;
	u8 key[CHACHA_KEY_SIZE];
505
	bool finalize_init = false;
506

507 508 509 510
	/*
	 * First we make sure we have POOL_MIN_BITS of entropy in the pool,
	 * and then we drain all of it. Only then can we extract a new key.
	 */
511 512 513 514 515
	do {
		entropy_count = READ_ONCE(input_pool.entropy_count);
		if (entropy_count < POOL_MIN_BITS)
			return;
	} while (cmpxchg(&input_pool.entropy_count, entropy_count, 0) != entropy_count);
516
	extract_entropy(key, sizeof(key));
517 518 519
	wake_up_interruptible(&random_write_wait);
	kill_fasync(&fasync, SIGIO, POLL_OUT);

520 521 522 523 524 525 526 527 528 529 530 531 532
	/*
	 * We copy the new key into the base_crng, overwriting the old one,
	 * and update the generation counter. We avoid hitting ULONG_MAX,
	 * because the per-cpu crngs are initialized to ULONG_MAX, so this
	 * forces new CPUs that come online to always initialize.
	 */
	spin_lock_irqsave(&base_crng.lock, flags);
	memcpy(base_crng.key, key, sizeof(base_crng.key));
	next_gen = base_crng.generation + 1;
	if (next_gen == ULONG_MAX)
		++next_gen;
	WRITE_ONCE(base_crng.generation, next_gen);
	WRITE_ONCE(base_crng.birth, jiffies);
533 534 535
	if (crng_init < 2) {
		invalidate_batched_entropy();
		crng_init = 2;
536 537 538 539 540
		finalize_init = true;
	}
	spin_unlock_irqrestore(&base_crng.lock, flags);
	memzero_explicit(key, sizeof(key));
	if (finalize_init) {
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
		process_random_ready_list();
		wake_up_interruptible(&crng_init_wait);
		kill_fasync(&fasync, SIGIO, POLL_IN);
		pr_notice("crng init done\n");
		if (unseeded_warning.missed) {
			pr_notice("%d get_random_xx warning(s) missed due to ratelimiting\n",
				  unseeded_warning.missed);
			unseeded_warning.missed = 0;
		}
		if (urandom_warning.missed) {
			pr_notice("%d urandom warning(s) missed due to ratelimiting\n",
				  urandom_warning.missed);
			urandom_warning.missed = 0;
		}
	}
556 557
}

558 559 560 561 562 563 564 565 566 567 568 569
/*
 * The general form here is based on a "fast key erasure RNG" from
 * <https://blog.cr.yp.to/20170723-random.html>. It generates a ChaCha
 * block using the provided key, and then immediately overwites that
 * key with half the block. It returns the resultant ChaCha state to the
 * user, along with the second half of the block containing 32 bytes of
 * random data that may be used; random_data_len may not be greater than
 * 32.
 */
static void crng_fast_key_erasure(u8 key[CHACHA_KEY_SIZE],
				  u32 chacha_state[CHACHA_STATE_WORDS],
				  u8 *random_data, size_t random_data_len)
570
{
571
	u8 first_block[CHACHA_BLOCK_SIZE];
572

573 574 575 576 577 578 579 580 581 582
	BUG_ON(random_data_len > 32);

	chacha_init_consts(chacha_state);
	memcpy(&chacha_state[4], key, CHACHA_KEY_SIZE);
	memset(&chacha_state[12], 0, sizeof(u32) * 4);
	chacha20_block(chacha_state, first_block);

	memcpy(key, first_block, CHACHA_KEY_SIZE);
	memcpy(random_data, first_block + CHACHA_KEY_SIZE, random_data_len);
	memzero_explicit(first_block, sizeof(first_block));
583 584
}

585
/*
586 587 588
 * This function returns a ChaCha state that you may use for generating
 * random data. It also returns up to 32 bytes on its own of random data
 * that may be used; random_data_len may not be greater than 32.
589
 */
590 591
static void crng_make_state(u32 chacha_state[CHACHA_STATE_WORDS],
			    u8 *random_data, size_t random_data_len)
592
{
593
	unsigned long flags;
594
	struct crng *crng;
595

596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
	BUG_ON(random_data_len > 32);

	/*
	 * For the fast path, we check whether we're ready, unlocked first, and
	 * then re-check once locked later. In the case where we're really not
	 * ready, we do fast key erasure with the base_crng directly, because
	 * this is what crng_{fast,slow}_load mutate during early init.
	 */
	if (unlikely(!crng_ready())) {
		bool ready;

		spin_lock_irqsave(&base_crng.lock, flags);
		ready = crng_ready();
		if (!ready)
			crng_fast_key_erasure(base_crng.key, chacha_state,
					      random_data, random_data_len);
		spin_unlock_irqrestore(&base_crng.lock, flags);
		if (!ready)
			return;
615
	}
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649

	/*
	 * If the base_crng is more than 5 minutes old, we reseed, which
	 * in turn bumps the generation counter that we check below.
	 */
	if (unlikely(time_after(jiffies, READ_ONCE(base_crng.birth) + CRNG_RESEED_INTERVAL)))
		crng_reseed();

	local_lock_irqsave(&crngs.lock, flags);
	crng = raw_cpu_ptr(&crngs);

	/*
	 * If our per-cpu crng is older than the base_crng, then it means
	 * somebody reseeded the base_crng. In that case, we do fast key
	 * erasure on the base_crng, and use its output as the new key
	 * for our per-cpu crng. This brings us up to date with base_crng.
	 */
	if (unlikely(crng->generation != READ_ONCE(base_crng.generation))) {
		spin_lock(&base_crng.lock);
		crng_fast_key_erasure(base_crng.key, chacha_state,
				      crng->key, sizeof(crng->key));
		crng->generation = base_crng.generation;
		spin_unlock(&base_crng.lock);
	}

	/*
	 * Finally, when we've made it this far, our per-cpu crng has an up
	 * to date key, and we can do fast key erasure with it to produce
	 * some random data and a ChaCha state for the caller. All other
	 * branches of this function are "unlikely", so most of the time we
	 * should wind up here immediately.
	 */
	crng_fast_key_erasure(crng->key, chacha_state, random_data, random_data_len);
	local_unlock_irqrestore(&crngs.lock, flags);
650 651
}

652
static ssize_t get_random_bytes_user(void __user *buf, size_t nbytes)
653
{
654
	bool large_request = nbytes > 256;
655 656
	ssize_t ret = 0;
	size_t len;
657 658 659 660 661 662
	u32 chacha_state[CHACHA_STATE_WORDS];
	u8 output[CHACHA_BLOCK_SIZE];

	if (!nbytes)
		return 0;

663
	len = min_t(size_t, 32, nbytes);
664 665 666 667 668 669 670
	crng_make_state(chacha_state, output, len);

	if (copy_to_user(buf, output, len))
		return -EFAULT;
	nbytes -= len;
	buf += len;
	ret += len;
671 672 673

	while (nbytes) {
		if (large_request && need_resched()) {
674
			if (signal_pending(current))
675 676 677 678
				break;
			schedule();
		}

679 680 681 682
		chacha20_block(chacha_state, output);
		if (unlikely(chacha_state[12] == 0))
			++chacha_state[13];

683
		len = min_t(size_t, nbytes, CHACHA_BLOCK_SIZE);
684
		if (copy_to_user(buf, output, len)) {
685 686 687 688
			ret = -EFAULT;
			break;
		}

689 690 691
		nbytes -= len;
		buf += len;
		ret += len;
692 693
	}

694 695
	memzero_explicit(chacha_state, sizeof(chacha_state));
	memzero_explicit(output, sizeof(output));
696 697 698
	return ret;
}

L
Linus Torvalds 已提交
699 700 701 702 703 704 705 706 707
/*********************************************************************
 *
 * Entropy input management
 *
 *********************************************************************/

/* There is one of these per entropy source */
struct timer_rand_state {
	cycles_t last_time;
708
	long last_delta, last_delta2;
L
Linus Torvalds 已提交
709 710
};

711 712
#define INIT_TIMER_RAND_STATE { INITIAL_JIFFIES, };

713
/*
714 715
 * Add device- or boot-specific data to the input pool to help
 * initialize it.
716
 *
717 718 719
 * 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.
720
 */
721
void add_device_randomness(const void *buf, size_t size)
722
{
723
	unsigned long time = random_get_entropy() ^ jiffies;
724
	unsigned long flags;
725

726 727
	if (!crng_ready() && size)
		crng_slow_load(buf, size);
728

729
	trace_add_device_randomness(size, _RET_IP_);
730
	spin_lock_irqsave(&input_pool.lock, flags);
731 732
	_mix_pool_bytes(buf, size);
	_mix_pool_bytes(&time, sizeof(time));
733
	spin_unlock_irqrestore(&input_pool.lock, flags);
734 735 736
}
EXPORT_SYMBOL(add_device_randomness);

737
static struct timer_rand_state input_timer_state = INIT_TIMER_RAND_STATE;
738

L
Linus Torvalds 已提交
739 740 741 742 743 744 745 746 747 748
/*
 * 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.
 *
 */
749
static void add_timer_randomness(struct timer_rand_state *state, unsigned int num)
L
Linus Torvalds 已提交
750 751 752
{
	struct {
		long jiffies;
753 754
		unsigned int cycles;
		unsigned int num;
L
Linus Torvalds 已提交
755 756 757 758
	} sample;
	long delta, delta2, delta3;

	sample.jiffies = jiffies;
759
	sample.cycles = random_get_entropy();
L
Linus Torvalds 已提交
760
	sample.num = num;
761
	mix_pool_bytes(&sample, sizeof(sample));
L
Linus Torvalds 已提交
762 763 764 765 766 767

	/*
	 * 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.
	 */
768 769
	delta = sample.jiffies - READ_ONCE(state->last_time);
	WRITE_ONCE(state->last_time, sample.jiffies);
770

771 772
	delta2 = delta - READ_ONCE(state->last_delta);
	WRITE_ONCE(state->last_delta, delta);
773

774 775
	delta3 = delta2 - READ_ONCE(state->last_delta2);
	WRITE_ONCE(state->last_delta2, delta2);
776 777 778 779 780 781 782 783 784 785 786

	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;
L
Linus Torvalds 已提交
787

788 789 790
	/*
	 * delta is now minimum absolute delta.
	 * Round down by 1 bit on general principles,
791
	 * and limit entropy estimate to 12 bits.
792
	 */
793
	credit_entropy_bits(min_t(unsigned int, fls(delta >> 1), 11));
L
Linus Torvalds 已提交
794 795
}

796
void add_input_randomness(unsigned int type, unsigned int code,
797
			  unsigned int value)
L
Linus Torvalds 已提交
798 799 800 801 802 803 804 805 806 807
{
	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);
808
	trace_add_input_randomness(input_pool.entropy_count);
L
Linus Torvalds 已提交
809
}
810
EXPORT_SYMBOL_GPL(add_input_randomness);
L
Linus Torvalds 已提交
811

812 813
static DEFINE_PER_CPU(struct fast_pool, irq_randomness);

814 815 816
#ifdef ADD_INTERRUPT_BENCH
static unsigned long avg_cycles, avg_deviation;

817 818
#define AVG_SHIFT 8 /* Exponential average factor k=1/256 */
#define FIXED_1_2 (1 << (AVG_SHIFT - 1))
819 820 821

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

824 825 826 827 828 829
	/* 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;
830 831 832 833 834
}
#else
#define add_interrupt_bench(x)
#endif

835
static u32 get_reg(struct fast_pool *f, struct pt_regs *regs)
836
{
837
	u32 *ptr = (u32 *)regs;
838
	unsigned int idx;
839 840 841

	if (regs == NULL)
		return 0;
842
	idx = READ_ONCE(f->reg_idx);
843
	if (idx >= sizeof(struct pt_regs) / sizeof(u32))
844 845 846
		idx = 0;
	ptr += idx++;
	WRITE_ONCE(f->reg_idx, idx);
847
	return *ptr;
848 849
}

850
void add_interrupt_randomness(int irq)
L
Linus Torvalds 已提交
851
{
852 853 854 855 856 857
	struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
	struct pt_regs *regs = get_irq_regs();
	unsigned long now = jiffies;
	cycles_t cycles = random_get_entropy();
	u32 c_high, j_high;
	u64 ip;
858

859 860
	if (cycles == 0)
		cycles = get_reg(fast_pool, regs);
861 862
	c_high = (sizeof(cycles) > 4) ? cycles >> 32 : 0;
	j_high = (sizeof(now) > 4) ? now >> 32 : 0;
863 864
	fast_pool->pool[0] ^= cycles ^ j_high ^ irq;
	fast_pool->pool[1] ^= now ^ c_high;
865
	ip = regs ? instruction_pointer(regs) : _RET_IP_;
866
	fast_pool->pool[2] ^= ip;
867 868
	fast_pool->pool[3] ^=
		(sizeof(ip) > 4) ? ip >> 32 : get_reg(fast_pool, regs);
869

870 871
	fast_mix(fast_pool);
	add_interrupt_bench(cycles);
872

T
Theodore Ts'o 已提交
873
	if (unlikely(crng_init == 0)) {
874 875
		if (fast_pool->count >= 64 &&
		    crng_fast_load(fast_pool->pool, sizeof(fast_pool->pool)) > 0) {
876 877
			fast_pool->count = 0;
			fast_pool->last = now;
878 879 880 881
			if (spin_trylock(&input_pool.lock)) {
				_mix_pool_bytes(&fast_pool->pool, sizeof(fast_pool->pool));
				spin_unlock(&input_pool.lock);
			}
882 883 884 885
		}
		return;
	}

886
	if ((fast_pool->count < 64) && !time_after(now, fast_pool->last + HZ))
L
Linus Torvalds 已提交
887 888
		return;

889
	if (!spin_trylock(&input_pool.lock))
890
		return;
891

892
	fast_pool->last = now;
893
	_mix_pool_bytes(&fast_pool->pool, sizeof(fast_pool->pool));
894
	spin_unlock(&input_pool.lock);
895

896
	fast_pool->count = 0;
897

898
	/* award one bit for the contents of the fast pool */
899
	credit_entropy_bits(1);
L
Linus Torvalds 已提交
900
}
901
EXPORT_SYMBOL_GPL(add_interrupt_randomness);
L
Linus Torvalds 已提交
902

903
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
904 905 906 907 908
void add_disk_randomness(struct gendisk *disk)
{
	if (!disk || !disk->random)
		return;
	/* first major is 1, so we get >= 0x200 here */
909
	add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
910
	trace_add_disk_randomness(disk_devt(disk), input_pool.entropy_count);
L
Linus Torvalds 已提交
911
}
912
EXPORT_SYMBOL_GPL(add_disk_randomness);
913
#endif
L
Linus Torvalds 已提交
914 915 916 917 918 919 920

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

G
Greg Price 已提交
921
/*
922 923
 * This is an HKDF-like construction for using the hashed collected entropy
 * as a PRF key, that's then expanded block-by-block.
G
Greg Price 已提交
924
 */
925
static void extract_entropy(void *buf, size_t nbytes)
L
Linus Torvalds 已提交
926
{
927
	unsigned long flags;
928 929
	u8 seed[BLAKE2S_HASH_SIZE], next_key[BLAKE2S_HASH_SIZE];
	struct {
930
		unsigned long rdseed[32 / sizeof(long)];
931 932 933 934
		size_t counter;
	} block;
	size_t i;

935
	trace_extract_entropy(nbytes, input_pool.entropy_count);
936

937 938 939 940
	for (i = 0; i < ARRAY_SIZE(block.rdseed); ++i) {
		if (!arch_get_random_seed_long(&block.rdseed[i]) &&
		    !arch_get_random_long(&block.rdseed[i]))
			block.rdseed[i] = random_get_entropy();
941 942
	}

943
	spin_lock_irqsave(&input_pool.lock, flags);
944

945 946
	/* seed = HASHPRF(last_key, entropy_input) */
	blake2s_final(&input_pool.hash, seed);
L
Linus Torvalds 已提交
947

948
	/* next_key = HASHPRF(seed, RDSEED || 0) */
949 950 951
	block.counter = 0;
	blake2s(next_key, (u8 *)&block, seed, sizeof(next_key), sizeof(block), sizeof(seed));
	blake2s_init_key(&input_pool.hash, BLAKE2S_HASH_SIZE, next_key, sizeof(next_key));
L
Linus Torvalds 已提交
952

953 954
	spin_unlock_irqrestore(&input_pool.lock, flags);
	memzero_explicit(next_key, sizeof(next_key));
955 956

	while (nbytes) {
957
		i = min_t(size_t, nbytes, BLAKE2S_HASH_SIZE);
958
		/* output = HASHPRF(seed, RDSEED || ++counter) */
959 960
		++block.counter;
		blake2s(buf, (u8 *)&block, seed, i, sizeof(block), sizeof(seed));
961 962 963 964
		nbytes -= i;
		buf += i;
	}

965 966
	memzero_explicit(seed, sizeof(seed));
	memzero_explicit(&block, sizeof(block));
967 968
}

969
#define warn_unseeded_randomness(previous) \
970
	_warn_unseeded_randomness(__func__, (void *)_RET_IP_, (previous))
971

972
static void _warn_unseeded_randomness(const char *func_name, void *caller, void **previous)
973 974 975 976 977 978 979
{
#ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
	const bool print_once = false;
#else
	static bool print_once __read_mostly;
#endif

980
	if (print_once || crng_ready() ||
981 982 983 984 985 986
	    (previous && (caller == READ_ONCE(*previous))))
		return;
	WRITE_ONCE(*previous, caller);
#ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
	print_once = true;
#endif
987
	if (__ratelimit(&unseeded_warning))
988 989
		printk_deferred(KERN_NOTICE "random: %s called from %pS with crng_init=%d\n",
				func_name, caller, crng_init);
990 991
}

L
Linus Torvalds 已提交
992 993
/*
 * This function is the exported kernel interface.  It returns some
994
 * number of good random numbers, suitable for key generation, seeding
995 996
 * TCP sequence numbers, etc.  It does not rely on the hardware random
 * number generator.  For random bytes direct from the hardware RNG
997 998 999 1000
 * (when available), use get_random_bytes_arch(). In order to ensure
 * that the randomness provided by this function is okay, the function
 * wait_for_random_bytes() should be called and return 0 at least once
 * at any point prior.
L
Linus Torvalds 已提交
1001
 */
1002
static void _get_random_bytes(void *buf, size_t nbytes)
1003
{
1004 1005
	u32 chacha_state[CHACHA_STATE_WORDS];
	u8 tmp[CHACHA_BLOCK_SIZE];
1006
	size_t len;
1007

1008
	trace_get_random_bytes(nbytes, _RET_IP_);
1009

1010 1011 1012
	if (!nbytes)
		return;

1013
	len = min_t(size_t, 32, nbytes);
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
	crng_make_state(chacha_state, buf, len);
	nbytes -= len;
	buf += len;

	while (nbytes) {
		if (nbytes < CHACHA_BLOCK_SIZE) {
			chacha20_block(chacha_state, tmp);
			memcpy(buf, tmp, nbytes);
			memzero_explicit(tmp, sizeof(tmp));
			break;
		}

		chacha20_block(chacha_state, buf);
		if (unlikely(chacha_state[12] == 0))
			++chacha_state[13];
1029
		nbytes -= CHACHA_BLOCK_SIZE;
1030
		buf += CHACHA_BLOCK_SIZE;
1031 1032
	}

1033
	memzero_explicit(chacha_state, sizeof(chacha_state));
1034
}
1035

1036
void get_random_bytes(void *buf, size_t nbytes)
1037 1038 1039 1040 1041 1042
{
	static void *previous;

	warn_unseeded_randomness(&previous);
	_get_random_bytes(buf, nbytes);
}
1043 1044
EXPORT_SYMBOL(get_random_bytes);

1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
/*
 * Each time the timer fires, we expect that we got an unpredictable
 * jump in the cycle counter. Even if the timer is running on another
 * CPU, the timer activity will be touching the stack of the CPU that is
 * generating entropy..
 *
 * Note that we don't re-arm the timer in the timer itself - we are
 * happy to be scheduled away, since that just makes the load more
 * complex, but we do not want the timer to keep ticking unless the
 * entropy loop is running.
 *
 * So the re-arming always happens in the entropy loop itself.
 */
static void entropy_timer(struct timer_list *t)
{
1060
	credit_entropy_bits(1);
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
}

/*
 * If we have an actual cycle counter, see if we can
 * generate enough entropy with timing noise
 */
static void try_to_generate_entropy(void)
{
	struct {
		unsigned long now;
		struct timer_list timer;
	} stack;

	stack.now = random_get_entropy();

	/* Slow counter - or none. Don't even bother */
	if (stack.now == random_get_entropy())
		return;

	timer_setup_on_stack(&stack.timer, entropy_timer, 0);
	while (!crng_ready()) {
		if (!timer_pending(&stack.timer))
1083
			mod_timer(&stack.timer, jiffies + 1);
1084
		mix_pool_bytes(&stack.now, sizeof(stack.now));
1085 1086 1087 1088 1089 1090
		schedule();
		stack.now = random_get_entropy();
	}

	del_timer_sync(&stack.timer);
	destroy_timer_on_stack(&stack.timer);
1091
	mix_pool_bytes(&stack.now, sizeof(stack.now));
1092 1093
}

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
/*
 * Wait for the urandom pool to be seeded and thus guaranteed to supply
 * cryptographically secure random numbers. This applies to: the /dev/urandom
 * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
 * family of functions. Using any of these functions without first calling
 * this function forfeits the guarantee of security.
 *
 * Returns: 0 if the urandom pool has been seeded.
 *          -ERESTARTSYS if the function was interrupted by a signal.
 */
int wait_for_random_bytes(void)
{
	if (likely(crng_ready()))
		return 0;
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118

	do {
		int ret;
		ret = wait_event_interruptible_timeout(crng_init_wait, crng_ready(), HZ);
		if (ret)
			return ret > 0 ? 0 : ret;

		try_to_generate_entropy();
	} while (!crng_ready());

	return 0;
1119 1120 1121
}
EXPORT_SYMBOL(wait_for_random_bytes);

1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
/*
 * Returns whether or not the urandom pool has been seeded and thus guaranteed
 * to supply cryptographically secure random numbers. This applies to: the
 * /dev/urandom device, the get_random_bytes function, and the get_random_{u32,
 * ,u64,int,long} family of functions.
 *
 * Returns: true if the urandom pool has been seeded.
 *          false if the urandom pool has not been seeded.
 */
bool rng_is_initialized(void)
{
	return crng_ready();
}
EXPORT_SYMBOL(rng_is_initialized);

1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
/*
 * 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;

1151
	if (crng_ready())
1152 1153 1154 1155 1156 1157 1158
		return err;

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

	spin_lock_irqsave(&random_ready_list_lock, flags);
1159
	if (crng_ready())
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
		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);

1195 1196
/*
 * This function will use the architecture-specific hardware random
1197 1198 1199
 * number generator if it is available. It is not recommended for
 * use. Use get_random_bytes() instead. It returns the number of
 * bytes filled in.
1200
 */
1201
size_t __must_check get_random_bytes_arch(void *buf, size_t nbytes)
L
Linus Torvalds 已提交
1202
{
1203
	size_t left = nbytes;
1204
	u8 *p = buf;
1205

1206 1207
	trace_get_random_bytes_arch(left, _RET_IP_);
	while (left) {
1208
		unsigned long v;
1209
		size_t chunk = min_t(size_t, left, sizeof(unsigned long));
1210

1211 1212
		if (!arch_get_random_long(&v))
			break;
1213

L
Luck, Tony 已提交
1214
		memcpy(p, &v, chunk);
1215
		p += chunk;
1216
		left -= chunk;
1217 1218
	}

1219
	return nbytes - left;
L
Linus Torvalds 已提交
1220
}
1221 1222
EXPORT_SYMBOL(get_random_bytes_arch);

1223 1224 1225 1226 1227 1228 1229
static bool trust_cpu __ro_after_init = IS_ENABLED(CONFIG_RANDOM_TRUST_CPU);
static int __init parse_trust_cpu(char *arg)
{
	return kstrtobool(arg, &trust_cpu);
}
early_param("random.trust_cpu", parse_trust_cpu);

L
Linus Torvalds 已提交
1230
/*
1231 1232 1233 1234 1235 1236 1237 1238
 * 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.
L
Linus Torvalds 已提交
1239
 */
1240
int __init rand_initialize(void)
L
Linus Torvalds 已提交
1241
{
1242
	size_t i;
1243
	ktime_t now = ktime_get_real();
1244
	bool arch_init = true;
1245
	unsigned long rv;
L
Linus Torvalds 已提交
1246

1247
	for (i = 0; i < BLAKE2S_BLOCK_SIZE; i += sizeof(rv)) {
1248 1249 1250 1251 1252
		if (!arch_get_random_seed_long_early(&rv) &&
		    !arch_get_random_long_early(&rv)) {
			rv = random_get_entropy();
			arch_init = false;
		}
1253
		mix_pool_bytes(&rv, sizeof(rv));
1254
	}
1255 1256 1257
	mix_pool_bytes(&now, sizeof(now));
	mix_pool_bytes(utsname(), sizeof(*(utsname())));

1258
	extract_entropy(base_crng.key, sizeof(base_crng.key));
1259 1260 1261 1262 1263 1264
	if (arch_init && trust_cpu && crng_init < 2) {
		invalidate_batched_entropy();
		crng_init = 2;
		pr_notice("crng init done (trusting CPU's manufacturer)\n");
	}

1265 1266 1267 1268
	if (ratelimit_disable) {
		urandom_warning.interval = 0;
		unseeded_warning.interval = 0;
	}
L
Linus Torvalds 已提交
1269 1270 1271
	return 0;
}

1272
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
1273 1274 1275 1276 1277
void rand_initialize_disk(struct gendisk *disk)
{
	struct timer_rand_state *state;

	/*
1278
	 * If kzalloc returns null, we just won't use that entropy
L
Linus Torvalds 已提交
1279 1280
	 * source.
	 */
1281
	state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1282 1283
	if (state) {
		state->last_time = INITIAL_JIFFIES;
L
Linus Torvalds 已提交
1284
		disk->random = state;
1285
	}
L
Linus Torvalds 已提交
1286
}
1287
#endif
L
Linus Torvalds 已提交
1288

1289 1290
static ssize_t urandom_read_nowarn(struct file *file, char __user *buf,
				   size_t nbytes, loff_t *ppos)
1291
{
1292
	ssize_t ret;
1293

1294
	ret = get_random_bytes_user(buf, nbytes);
1295
	trace_urandom_read(nbytes, input_pool.entropy_count);
1296 1297 1298
	return ret;
}

1299 1300
static ssize_t urandom_read(struct file *file, char __user *buf, size_t nbytes,
			    loff_t *ppos)
L
Linus Torvalds 已提交
1301
{
1302
	static int maxwarn = 10;
1303

1304
	if (!crng_ready() && maxwarn > 0) {
1305
		maxwarn--;
1306
		if (__ratelimit(&urandom_warning))
Y
Yangtao Li 已提交
1307 1308
			pr_notice("%s: uninitialized urandom read (%zd bytes read)\n",
				  current->comm, nbytes);
1309
	}
1310 1311

	return urandom_read_nowarn(file, buf, nbytes, ppos);
L
Linus Torvalds 已提交
1312 1313
}

1314 1315
static ssize_t random_read(struct file *file, char __user *buf, size_t nbytes,
			   loff_t *ppos)
1316 1317 1318 1319 1320 1321 1322 1323 1324
{
	int ret;

	ret = wait_for_random_bytes();
	if (ret != 0)
		return ret;
	return urandom_read_nowarn(file, buf, nbytes, ppos);
}

1325
static __poll_t random_poll(struct file *file, poll_table *wait)
L
Linus Torvalds 已提交
1326
{
1327
	__poll_t mask;
L
Linus Torvalds 已提交
1328

1329
	poll_wait(file, &crng_init_wait, wait);
1330 1331
	poll_wait(file, &random_write_wait, wait);
	mask = 0;
1332
	if (crng_ready())
1333
		mask |= EPOLLIN | EPOLLRDNORM;
1334
	if (input_pool.entropy_count < POOL_MIN_BITS)
1335
		mask |= EPOLLOUT | EPOLLWRNORM;
L
Linus Torvalds 已提交
1336 1337 1338
	return mask;
}

1339
static int write_pool(const char __user *ubuf, size_t count)
L
Linus Torvalds 已提交
1340
{
1341
	size_t len;
1342
	int ret = 0;
1343
	u8 block[BLAKE2S_BLOCK_SIZE];
L
Linus Torvalds 已提交
1344

1345 1346
	while (count) {
		len = min(count, sizeof(block));
1347 1348 1349 1350
		if (copy_from_user(block, ubuf, len)) {
			ret = -EFAULT;
			goto out;
		}
1351 1352 1353
		count -= len;
		ubuf += len;
		mix_pool_bytes(block, len);
1354
		cond_resched();
L
Linus Torvalds 已提交
1355
	}
1356

1357 1358 1359
out:
	memzero_explicit(block, sizeof(block));
	return ret;
1360 1361
}

1362 1363
static ssize_t random_write(struct file *file, const char __user *buffer,
			    size_t count, loff_t *ppos)
1364
{
1365
	int ret;
1366

1367
	ret = write_pool(buffer, count);
1368 1369 1370 1371
	if (ret)
		return ret;

	return (ssize_t)count;
L
Linus Torvalds 已提交
1372 1373
}

M
Matt Mackall 已提交
1374
static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
L
Linus Torvalds 已提交
1375 1376 1377 1378 1379 1380 1381
{
	int size, ent_count;
	int __user *p = (int __user *)arg;
	int retval;

	switch (cmd) {
	case RNDGETENTCNT:
M
Matt Mackall 已提交
1382
		/* inherently racy, no point locking */
1383
		if (put_user(input_pool.entropy_count, p))
L
Linus Torvalds 已提交
1384 1385 1386 1387 1388 1389 1390
			return -EFAULT;
		return 0;
	case RNDADDTOENTCNT:
		if (!capable(CAP_SYS_ADMIN))
			return -EPERM;
		if (get_user(ent_count, p))
			return -EFAULT;
1391 1392 1393 1394
		if (ent_count < 0)
			return -EINVAL;
		credit_entropy_bits(ent_count);
		return 0;
L
Linus Torvalds 已提交
1395 1396 1397 1398 1399 1400 1401 1402 1403
	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;
1404
		retval = write_pool((const char __user *)p, size);
L
Linus Torvalds 已提交
1405 1406
		if (retval < 0)
			return retval;
1407 1408
		credit_entropy_bits(ent_count);
		return 0;
L
Linus Torvalds 已提交
1409 1410
	case RNDZAPENTCNT:
	case RNDCLEARPOOL:
1411 1412 1413 1414
		/*
		 * Clear the entropy pool counters. We no longer clear
		 * the entropy pool, as that's silly.
		 */
L
Linus Torvalds 已提交
1415 1416
		if (!capable(CAP_SYS_ADMIN))
			return -EPERM;
1417
		if (xchg(&input_pool.entropy_count, 0)) {
1418 1419 1420
			wake_up_interruptible(&random_write_wait);
			kill_fasync(&fasync, SIGIO, POLL_OUT);
		}
L
Linus Torvalds 已提交
1421
		return 0;
1422 1423 1424 1425 1426
	case RNDRESEEDCRNG:
		if (!capable(CAP_SYS_ADMIN))
			return -EPERM;
		if (crng_init < 2)
			return -ENODATA;
1427
		crng_reseed();
1428
		return 0;
L
Linus Torvalds 已提交
1429 1430 1431 1432 1433
	default:
		return -EINVAL;
	}
}

1434 1435 1436 1437 1438
static int random_fasync(int fd, struct file *filp, int on)
{
	return fasync_helper(fd, filp, on, &fasync);
}

1439
const struct file_operations random_fops = {
1440
	.read = random_read,
L
Linus Torvalds 已提交
1441
	.write = random_write,
1442
	.poll = random_poll,
M
Matt Mackall 已提交
1443
	.unlocked_ioctl = random_ioctl,
1444
	.compat_ioctl = compat_ptr_ioctl,
1445
	.fasync = random_fasync,
1446
	.llseek = noop_llseek,
L
Linus Torvalds 已提交
1447 1448
};

1449
const struct file_operations urandom_fops = {
1450
	.read = urandom_read,
L
Linus Torvalds 已提交
1451
	.write = random_write,
M
Matt Mackall 已提交
1452
	.unlocked_ioctl = random_ioctl,
1453
	.compat_ioctl = compat_ptr_ioctl,
1454
	.fasync = random_fasync,
1455
	.llseek = noop_llseek,
L
Linus Torvalds 已提交
1456 1457
};

1458 1459
SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count, unsigned int,
		flags)
1460
{
1461
	if (flags & ~(GRND_NONBLOCK | GRND_RANDOM | GRND_INSECURE))
1462 1463 1464 1465 1466 1467
		return -EINVAL;

	/*
	 * Requesting insecure and blocking randomness at the same time makes
	 * no sense.
	 */
1468
	if ((flags & (GRND_INSECURE | GRND_RANDOM)) == (GRND_INSECURE | GRND_RANDOM))
1469 1470 1471 1472 1473
		return -EINVAL;

	if (count > INT_MAX)
		count = INT_MAX;

1474
	if (!(flags & GRND_INSECURE) && !crng_ready()) {
1475 1476
		int ret;

1477 1478
		if (flags & GRND_NONBLOCK)
			return -EAGAIN;
1479 1480 1481
		ret = wait_for_random_bytes();
		if (unlikely(ret))
			return ret;
1482
	}
1483
	return urandom_read_nowarn(NULL, buf, count, NULL);
1484 1485
}

L
Linus Torvalds 已提交
1486 1487 1488 1489 1490 1491 1492 1493 1494 1495
/********************************************************************
 *
 * Sysctl interface
 *
 ********************************************************************/

#ifdef CONFIG_SYSCTL

#include <linux/sysctl.h>

1496
static int random_min_urandom_seed = 60;
1497 1498
static int random_write_wakeup_bits = POOL_MIN_BITS;
static int sysctl_poolsize = POOL_BITS;
L
Linus Torvalds 已提交
1499 1500 1501
static char sysctl_bootid[16];

/*
G
Greg Price 已提交
1502
 * This function is used to return both the bootid UUID, and random
L
Linus Torvalds 已提交
1503 1504 1505
 * 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 已提交
1506 1507 1508
 * 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 已提交
1509
 */
1510 1511
static int proc_do_uuid(struct ctl_table *table, int write, void *buffer,
			size_t *lenp, loff_t *ppos)
L
Linus Torvalds 已提交
1512
{
1513
	struct ctl_table fake_table;
L
Linus Torvalds 已提交
1514 1515 1516 1517 1518 1519
	unsigned char buf[64], tmp_uuid[16], *uuid;

	uuid = table->data;
	if (!uuid) {
		uuid = tmp_uuid;
		generate_random_uuid(uuid);
1520 1521 1522 1523 1524 1525 1526 1527
	} else {
		static DEFINE_SPINLOCK(bootid_spinlock);

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

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

L
Linus Torvalds 已提交
1531 1532 1533
	fake_table.data = buf;
	fake_table.maxlen = sizeof(buf);

1534
	return proc_dostring(&fake_table, write, buffer, lenp, ppos);
L
Linus Torvalds 已提交
1535 1536
}

1537
static struct ctl_table random_table[] = {
L
Linus Torvalds 已提交
1538 1539 1540 1541 1542
	{
		.procname	= "poolsize",
		.data		= &sysctl_poolsize,
		.maxlen		= sizeof(int),
		.mode		= 0444,
1543
		.proc_handler	= proc_dointvec,
L
Linus Torvalds 已提交
1544 1545 1546
	},
	{
		.procname	= "entropy_avail",
1547
		.data		= &input_pool.entropy_count,
L
Linus Torvalds 已提交
1548 1549
		.maxlen		= sizeof(int),
		.mode		= 0444,
1550
		.proc_handler	= proc_dointvec,
L
Linus Torvalds 已提交
1551 1552 1553
	},
	{
		.procname	= "write_wakeup_threshold",
1554
		.data		= &random_write_wakeup_bits,
L
Linus Torvalds 已提交
1555 1556
		.maxlen		= sizeof(int),
		.mode		= 0644,
1557
		.proc_handler	= proc_dointvec,
L
Linus Torvalds 已提交
1558
	},
1559 1560 1561 1562 1563 1564 1565
	{
		.procname	= "urandom_min_reseed_secs",
		.data		= &random_min_urandom_seed,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= proc_dointvec,
	},
L
Linus Torvalds 已提交
1566 1567 1568 1569 1570
	{
		.procname	= "boot_id",
		.data		= &sysctl_bootid,
		.maxlen		= 16,
		.mode		= 0444,
1571
		.proc_handler	= proc_do_uuid,
L
Linus Torvalds 已提交
1572 1573 1574 1575 1576
	},
	{
		.procname	= "uuid",
		.maxlen		= 16,
		.mode		= 0444,
1577
		.proc_handler	= proc_do_uuid,
L
Linus Torvalds 已提交
1578
	},
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
#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
1595
	{ }
L
Linus Torvalds 已提交
1596
};
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607

/*
 * rand_initialize() is called before sysctl_init(),
 * so we cannot call register_sysctl_init() in rand_initialize()
 */
static int __init random_sysctls_init(void)
{
	register_sysctl_init("kernel/random", random_table);
	return 0;
}
device_initcall(random_sysctls_init);
1608
#endif	/* CONFIG_SYSCTL */
L
Linus Torvalds 已提交
1609

1610 1611
static atomic_t batch_generation = ATOMIC_INIT(0);

1612 1613
struct batched_entropy {
	union {
1614 1615 1616 1617 1618 1619 1620 1621 1622
		/*
		 * We make this 1.5x a ChaCha block, so that we get the
		 * remaining 32 bytes from fast key erasure, plus one full
		 * block from the detached ChaCha state. We can increase
		 * the size of this later if needed so long as we keep the
		 * formula of (integer_blocks + 0.5) * CHACHA_BLOCK_SIZE.
		 */
		u64 entropy_u64[CHACHA_BLOCK_SIZE * 3 / (2 * sizeof(u64))];
		u32 entropy_u32[CHACHA_BLOCK_SIZE * 3 / (2 * sizeof(u32))];
1623
	};
1624
	local_lock_t lock;
1625
	unsigned int position;
1626
	int generation;
1627
};
1628

L
Linus Torvalds 已提交
1629
/*
1630
 * Get a random word for internal kernel use only. The quality of the random
1631 1632 1633
 * number is good as /dev/urandom. In order to ensure that the randomness
 * provided by this function is okay, the function wait_for_random_bytes()
 * should be called and return 0 at least once at any point prior.
L
Linus Torvalds 已提交
1634
 */
1635
static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64) = {
1636 1637
	.lock = INIT_LOCAL_LOCK(batched_entropy_u64.lock),
	.position = UINT_MAX
1638 1639
};

1640
u64 get_random_u64(void)
L
Linus Torvalds 已提交
1641
{
1642
	u64 ret;
1643
	unsigned long flags;
1644
	struct batched_entropy *batch;
1645
	static void *previous;
1646
	int next_gen;
1647

1648
	warn_unseeded_randomness(&previous);
1649

1650
	local_lock_irqsave(&batched_entropy_u64.lock, flags);
1651
	batch = raw_cpu_ptr(&batched_entropy_u64);
1652 1653

	next_gen = atomic_read(&batch_generation);
1654
	if (batch->position >= ARRAY_SIZE(batch->entropy_u64) ||
1655
	    next_gen != batch->generation) {
1656
		_get_random_bytes(batch->entropy_u64, sizeof(batch->entropy_u64));
1657
		batch->position = 0;
1658
		batch->generation = next_gen;
1659
	}
1660

1661 1662 1663
	ret = batch->entropy_u64[batch->position];
	batch->entropy_u64[batch->position] = 0;
	++batch->position;
1664
	local_unlock_irqrestore(&batched_entropy_u64.lock, flags);
1665
	return ret;
L
Linus Torvalds 已提交
1666
}
1667
EXPORT_SYMBOL(get_random_u64);
L
Linus Torvalds 已提交
1668

1669
static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32) = {
1670 1671
	.lock = INIT_LOCAL_LOCK(batched_entropy_u32.lock),
	.position = UINT_MAX
1672
};
1673

1674
u32 get_random_u32(void)
1675
{
1676
	u32 ret;
1677
	unsigned long flags;
1678
	struct batched_entropy *batch;
1679
	static void *previous;
1680
	int next_gen;
1681

1682
	warn_unseeded_randomness(&previous);
1683

1684
	local_lock_irqsave(&batched_entropy_u32.lock, flags);
1685
	batch = raw_cpu_ptr(&batched_entropy_u32);
1686 1687

	next_gen = atomic_read(&batch_generation);
1688
	if (batch->position >= ARRAY_SIZE(batch->entropy_u32) ||
1689
	    next_gen != batch->generation) {
1690
		_get_random_bytes(batch->entropy_u32, sizeof(batch->entropy_u32));
1691
		batch->position = 0;
1692
		batch->generation = next_gen;
1693
	}
1694

1695 1696 1697
	ret = batch->entropy_u32[batch->position];
	batch->entropy_u32[batch->position] = 0;
	++batch->position;
1698
	local_unlock_irqrestore(&batched_entropy_u32.lock, flags);
1699 1700
	return ret;
}
1701
EXPORT_SYMBOL(get_random_u32);
1702

1703 1704
/* It's important to invalidate all potential batched entropy that might
 * be stored before the crng is initialized, which we can do lazily by
1705 1706
 * bumping the generation counter.
 */
1707 1708
static void invalidate_batched_entropy(void)
{
1709
	atomic_inc(&batch_generation);
1710 1711
}

1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
/**
 * randomize_page - Generate a random, page aligned address
 * @start:	The smallest acceptable address the caller will take.
 * @range:	The size of the area, starting at @start, within which the
 *		random address must fall.
 *
 * If @start + @range would overflow, @range is capped.
 *
 * NOTE: Historical use of randomize_range, which this replaces, presumed that
 * @start was already page aligned.  We now align it regardless.
 *
 * Return: A page aligned address within [start, start + range).  On error,
 * @start is returned.
 */
1726
unsigned long randomize_page(unsigned long start, unsigned long range)
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
{
	if (!PAGE_ALIGNED(start)) {
		range -= PAGE_ALIGN(start) - start;
		start = PAGE_ALIGN(start);
	}

	if (start > ULONG_MAX - range)
		range = ULONG_MAX - start;

	range >>= PAGE_SHIFT;

	if (range == 0)
		return start;

	return start + (get_random_long() % range << PAGE_SHIFT);
}

1744 1745 1746 1747
/* 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.
 */
1748
void add_hwgenerator_randomness(const void *buffer, size_t count,
1749 1750
				size_t entropy)
{
T
Theodore Ts'o 已提交
1751
	if (unlikely(crng_init == 0)) {
1752
		size_t ret = crng_fast_load(buffer, count);
1753
		mix_pool_bytes(buffer, ret);
1754 1755 1756 1757
		count -= ret;
		buffer += ret;
		if (!count || crng_init == 0)
			return;
1758
	}
1759

1760
	/* Throttle writing if we're above the trickle threshold.
1761 1762 1763
	 * We'll be woken up again once below POOL_MIN_BITS, when
	 * the calling thread is about to terminate, or once
	 * CRNG_RESEED_INTERVAL has elapsed.
1764
	 */
1765
	wait_event_interruptible_timeout(random_write_wait,
1766
			!system_wq || kthread_should_stop() ||
1767
			input_pool.entropy_count < POOL_MIN_BITS,
1768
			CRNG_RESEED_INTERVAL);
1769 1770
	mix_pool_bytes(buffer, count);
	credit_entropy_bits(entropy);
1771 1772
}
EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);
H
Hsin-Yi Wang 已提交
1773 1774 1775 1776 1777 1778

/* Handle random seed passed by bootloader.
 * If the seed is trustworthy, it would be regarded as hardware RNGs. Otherwise
 * it would be regarded as device data.
 * The decision is controlled by CONFIG_RANDOM_TRUST_BOOTLOADER.
 */
1779
void add_bootloader_randomness(const void *buf, size_t size)
H
Hsin-Yi Wang 已提交
1780 1781 1782 1783 1784 1785
{
	if (IS_ENABLED(CONFIG_RANDOM_TRUST_BOOTLOADER))
		add_hwgenerator_randomness(buf, size, size * 8);
	else
		add_device_randomness(buf, size);
}
1786
EXPORT_SYMBOL_GPL(add_bootloader_randomness);