random: use symbolic constants for crng_init states
[linux-2.6-microblaze.git] / drivers / char / random.c
1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2 /*
3  * Copyright (C) 2017-2022 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
4  * Copyright Matt Mackall <mpm@selenic.com>, 2003, 2004, 2005
5  * Copyright Theodore Ts'o, 1994, 1995, 1996, 1997, 1998, 1999. All rights reserved.
6  *
7  * This driver produces cryptographically secure pseudorandom data. It is divided
8  * into roughly six sections, each with a section header:
9  *
10  *   - Initialization and readiness waiting.
11  *   - Fast key erasure RNG, the "crng".
12  *   - Entropy accumulation and extraction routines.
13  *   - Entropy collection routines.
14  *   - Userspace reader/writer interfaces.
15  *   - Sysctl interface.
16  *
17  * The high level overview is that there is one input pool, into which
18  * various pieces of data are hashed. Prior to initialization, some of that
19  * data is then "credited" as having a certain number of bits of entropy.
20  * When enough bits of entropy are available, the hash is finalized and
21  * handed as a key to a stream cipher that expands it indefinitely for
22  * various consumers. This key is periodically refreshed as the various
23  * entropy collectors, described below, add data to the input pool.
24  */
25
26 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
27
28 #include <linux/utsname.h>
29 #include <linux/module.h>
30 #include <linux/kernel.h>
31 #include <linux/major.h>
32 #include <linux/string.h>
33 #include <linux/fcntl.h>
34 #include <linux/slab.h>
35 #include <linux/random.h>
36 #include <linux/poll.h>
37 #include <linux/init.h>
38 #include <linux/fs.h>
39 #include <linux/blkdev.h>
40 #include <linux/interrupt.h>
41 #include <linux/mm.h>
42 #include <linux/nodemask.h>
43 #include <linux/spinlock.h>
44 #include <linux/kthread.h>
45 #include <linux/percpu.h>
46 #include <linux/ptrace.h>
47 #include <linux/workqueue.h>
48 #include <linux/irq.h>
49 #include <linux/ratelimit.h>
50 #include <linux/syscalls.h>
51 #include <linux/completion.h>
52 #include <linux/uuid.h>
53 #include <linux/uaccess.h>
54 #include <linux/suspend.h>
55 #include <linux/siphash.h>
56 #include <crypto/chacha.h>
57 #include <crypto/blake2s.h>
58 #include <asm/processor.h>
59 #include <asm/irq.h>
60 #include <asm/irq_regs.h>
61 #include <asm/io.h>
62
63 /*********************************************************************
64  *
65  * Initialization and readiness waiting.
66  *
67  * Much of the RNG infrastructure is devoted to various dependencies
68  * being able to wait until the RNG has collected enough entropy and
69  * is ready for safe consumption.
70  *
71  *********************************************************************/
72
73 /*
74  * crng_init is protected by base_crng->lock, and only increases
75  * its value (from empty->early->ready).
76  */
77 static enum {
78         CRNG_EMPTY = 0, /* Little to no entropy collected */
79         CRNG_EARLY = 1, /* At least POOL_EARLY_BITS collected */
80         CRNG_READY = 2  /* Fully initialized with POOL_READY_BITS collected */
81 } crng_init = CRNG_EMPTY;
82 #define crng_ready() (likely(crng_init >= CRNG_READY))
83 /* Various types of waiters for crng_init->CRNG_READY transition. */
84 static DECLARE_WAIT_QUEUE_HEAD(crng_init_wait);
85 static struct fasync_struct *fasync;
86 static DEFINE_SPINLOCK(random_ready_chain_lock);
87 static RAW_NOTIFIER_HEAD(random_ready_chain);
88
89 /* Control how we warn userspace. */
90 static struct ratelimit_state unseeded_warning =
91         RATELIMIT_STATE_INIT("warn_unseeded_randomness", HZ, 3);
92 static struct ratelimit_state urandom_warning =
93         RATELIMIT_STATE_INIT("warn_urandom_randomness", HZ, 3);
94 static int ratelimit_disable __read_mostly;
95 module_param_named(ratelimit_disable, ratelimit_disable, int, 0644);
96 MODULE_PARM_DESC(ratelimit_disable, "Disable random ratelimit suppression");
97
98 /*
99  * Returns whether or not the input pool has been seeded and thus guaranteed
100  * to supply cryptographically secure random numbers. This applies to: the
101  * /dev/urandom device, the get_random_bytes function, and the get_random_{u32,
102  * ,u64,int,long} family of functions.
103  *
104  * Returns: true if the input pool has been seeded.
105  *          false if the input pool has not been seeded.
106  */
107 bool rng_is_initialized(void)
108 {
109         return crng_ready();
110 }
111 EXPORT_SYMBOL(rng_is_initialized);
112
113 /* Used by wait_for_random_bytes(), and considered an entropy collector, below. */
114 static void try_to_generate_entropy(void);
115
116 /*
117  * Wait for the input pool to be seeded and thus guaranteed to supply
118  * cryptographically secure random numbers. This applies to: the /dev/urandom
119  * device, the get_random_bytes function, and the get_random_{u32,u64,int,long}
120  * family of functions. Using any of these functions without first calling
121  * this function forfeits the guarantee of security.
122  *
123  * Returns: 0 if the input pool has been seeded.
124  *          -ERESTARTSYS if the function was interrupted by a signal.
125  */
126 int wait_for_random_bytes(void)
127 {
128         while (!crng_ready()) {
129                 int ret;
130
131                 try_to_generate_entropy();
132                 ret = wait_event_interruptible_timeout(crng_init_wait, crng_ready(), HZ);
133                 if (ret)
134                         return ret > 0 ? 0 : ret;
135         }
136         return 0;
137 }
138 EXPORT_SYMBOL(wait_for_random_bytes);
139
140 /*
141  * Add a callback function that will be invoked when the input
142  * pool is initialised.
143  *
144  * returns: 0 if callback is successfully added
145  *          -EALREADY if pool is already initialised (callback not called)
146  */
147 int register_random_ready_notifier(struct notifier_block *nb)
148 {
149         unsigned long flags;
150         int ret = -EALREADY;
151
152         if (crng_ready())
153                 return ret;
154
155         spin_lock_irqsave(&random_ready_chain_lock, flags);
156         if (!crng_ready())
157                 ret = raw_notifier_chain_register(&random_ready_chain, nb);
158         spin_unlock_irqrestore(&random_ready_chain_lock, flags);
159         return ret;
160 }
161
162 /*
163  * Delete a previously registered readiness callback function.
164  */
165 int unregister_random_ready_notifier(struct notifier_block *nb)
166 {
167         unsigned long flags;
168         int ret;
169
170         spin_lock_irqsave(&random_ready_chain_lock, flags);
171         ret = raw_notifier_chain_unregister(&random_ready_chain, nb);
172         spin_unlock_irqrestore(&random_ready_chain_lock, flags);
173         return ret;
174 }
175
176 static void process_random_ready_list(void)
177 {
178         unsigned long flags;
179
180         spin_lock_irqsave(&random_ready_chain_lock, flags);
181         raw_notifier_call_chain(&random_ready_chain, 0, NULL);
182         spin_unlock_irqrestore(&random_ready_chain_lock, flags);
183 }
184
185 #define warn_unseeded_randomness(previous) \
186         _warn_unseeded_randomness(__func__, (void *)_RET_IP_, (previous))
187
188 static void _warn_unseeded_randomness(const char *func_name, void *caller, void **previous)
189 {
190 #ifdef CONFIG_WARN_ALL_UNSEEDED_RANDOM
191         const bool print_once = false;
192 #else
193         static bool print_once __read_mostly;
194 #endif
195
196         if (print_once || crng_ready() ||
197             (previous && (caller == READ_ONCE(*previous))))
198                 return;
199         WRITE_ONCE(*previous, caller);
200 #ifndef CONFIG_WARN_ALL_UNSEEDED_RANDOM
201         print_once = true;
202 #endif
203         if (__ratelimit(&unseeded_warning))
204                 printk_deferred(KERN_NOTICE "random: %s called from %pS with crng_init=%d\n",
205                                 func_name, caller, crng_init);
206 }
207
208
209 /*********************************************************************
210  *
211  * Fast key erasure RNG, the "crng".
212  *
213  * These functions expand entropy from the entropy extractor into
214  * long streams for external consumption using the "fast key erasure"
215  * RNG described at <https://blog.cr.yp.to/20170723-random.html>.
216  *
217  * There are a few exported interfaces for use by other drivers:
218  *
219  *      void get_random_bytes(void *buf, size_t nbytes)
220  *      u32 get_random_u32()
221  *      u64 get_random_u64()
222  *      unsigned int get_random_int()
223  *      unsigned long get_random_long()
224  *
225  * These interfaces will return the requested number of random bytes
226  * into the given buffer or as a return value. This is equivalent to
227  * a read from /dev/urandom. The u32, u64, int, and long family of
228  * functions may be higher performance for one-off random integers,
229  * because they do a bit of buffering and do not invoke reseeding
230  * until the buffer is emptied.
231  *
232  *********************************************************************/
233
234 enum {
235         CRNG_RESEED_START_INTERVAL = HZ,
236         CRNG_RESEED_INTERVAL = 60 * HZ
237 };
238
239 static struct {
240         u8 key[CHACHA_KEY_SIZE] __aligned(__alignof__(long));
241         unsigned long birth;
242         unsigned long generation;
243         spinlock_t lock;
244 } base_crng = {
245         .lock = __SPIN_LOCK_UNLOCKED(base_crng.lock)
246 };
247
248 struct crng {
249         u8 key[CHACHA_KEY_SIZE];
250         unsigned long generation;
251         local_lock_t lock;
252 };
253
254 static DEFINE_PER_CPU(struct crng, crngs) = {
255         .generation = ULONG_MAX,
256         .lock = INIT_LOCAL_LOCK(crngs.lock),
257 };
258
259 /* Used by crng_reseed() and crng_make_state() to extract a new seed from the input pool. */
260 static void extract_entropy(void *buf, size_t nbytes);
261
262 /* This extracts a new crng key from the input pool. */
263 static void crng_reseed(void)
264 {
265         unsigned long flags;
266         unsigned long next_gen;
267         u8 key[CHACHA_KEY_SIZE];
268         bool finalize_init = false;
269
270         extract_entropy(key, sizeof(key));
271
272         /*
273          * We copy the new key into the base_crng, overwriting the old one,
274          * and update the generation counter. We avoid hitting ULONG_MAX,
275          * because the per-cpu crngs are initialized to ULONG_MAX, so this
276          * forces new CPUs that come online to always initialize.
277          */
278         spin_lock_irqsave(&base_crng.lock, flags);
279         memcpy(base_crng.key, key, sizeof(base_crng.key));
280         next_gen = base_crng.generation + 1;
281         if (next_gen == ULONG_MAX)
282                 ++next_gen;
283         WRITE_ONCE(base_crng.generation, next_gen);
284         WRITE_ONCE(base_crng.birth, jiffies);
285         if (!crng_ready()) {
286                 crng_init = CRNG_READY;
287                 finalize_init = true;
288         }
289         spin_unlock_irqrestore(&base_crng.lock, flags);
290         memzero_explicit(key, sizeof(key));
291         if (finalize_init) {
292                 process_random_ready_list();
293                 wake_up_interruptible(&crng_init_wait);
294                 kill_fasync(&fasync, SIGIO, POLL_IN);
295                 pr_notice("crng init done\n");
296                 if (unseeded_warning.missed) {
297                         pr_notice("%d get_random_xx warning(s) missed due to ratelimiting\n",
298                                   unseeded_warning.missed);
299                         unseeded_warning.missed = 0;
300                 }
301                 if (urandom_warning.missed) {
302                         pr_notice("%d urandom warning(s) missed due to ratelimiting\n",
303                                   urandom_warning.missed);
304                         urandom_warning.missed = 0;
305                 }
306         }
307 }
308
309 /*
310  * This generates a ChaCha block using the provided key, and then
311  * immediately overwites that key with half the block. It returns
312  * the resultant ChaCha state to the user, along with the second
313  * half of the block containing 32 bytes of random data that may
314  * be used; random_data_len may not be greater than 32.
315  *
316  * The returned ChaCha state contains within it a copy of the old
317  * key value, at index 4, so the state should always be zeroed out
318  * immediately after using in order to maintain forward secrecy.
319  * If the state cannot be erased in a timely manner, then it is
320  * safer to set the random_data parameter to &chacha_state[4] so
321  * that this function overwrites it before returning.
322  */
323 static void crng_fast_key_erasure(u8 key[CHACHA_KEY_SIZE],
324                                   u32 chacha_state[CHACHA_STATE_WORDS],
325                                   u8 *random_data, size_t random_data_len)
326 {
327         u8 first_block[CHACHA_BLOCK_SIZE];
328
329         BUG_ON(random_data_len > 32);
330
331         chacha_init_consts(chacha_state);
332         memcpy(&chacha_state[4], key, CHACHA_KEY_SIZE);
333         memset(&chacha_state[12], 0, sizeof(u32) * 4);
334         chacha20_block(chacha_state, first_block);
335
336         memcpy(key, first_block, CHACHA_KEY_SIZE);
337         memcpy(random_data, first_block + CHACHA_KEY_SIZE, random_data_len);
338         memzero_explicit(first_block, sizeof(first_block));
339 }
340
341 /*
342  * Return whether the crng seed is considered to be sufficiently old
343  * that a reseeding is needed. This happens if the last reseeding
344  * was CRNG_RESEED_INTERVAL ago, or during early boot, at an interval
345  * proportional to the uptime.
346  */
347 static bool crng_has_old_seed(void)
348 {
349         static bool early_boot = true;
350         unsigned long interval = CRNG_RESEED_INTERVAL;
351
352         if (unlikely(READ_ONCE(early_boot))) {
353                 time64_t uptime = ktime_get_seconds();
354                 if (uptime >= CRNG_RESEED_INTERVAL / HZ * 2)
355                         WRITE_ONCE(early_boot, false);
356                 else
357                         interval = max_t(unsigned int, CRNG_RESEED_START_INTERVAL,
358                                          (unsigned int)uptime / 2 * HZ);
359         }
360         return time_after(jiffies, READ_ONCE(base_crng.birth) + interval);
361 }
362
363 /*
364  * This function returns a ChaCha state that you may use for generating
365  * random data. It also returns up to 32 bytes on its own of random data
366  * that may be used; random_data_len may not be greater than 32.
367  */
368 static void crng_make_state(u32 chacha_state[CHACHA_STATE_WORDS],
369                             u8 *random_data, size_t random_data_len)
370 {
371         unsigned long flags;
372         struct crng *crng;
373
374         BUG_ON(random_data_len > 32);
375
376         /*
377          * For the fast path, we check whether we're ready, unlocked first, and
378          * then re-check once locked later. In the case where we're really not
379          * ready, we do fast key erasure with the base_crng directly, extracting
380          * when crng_init is CRNG_EMPTY.
381          */
382         if (!crng_ready()) {
383                 bool ready;
384
385                 spin_lock_irqsave(&base_crng.lock, flags);
386                 ready = crng_ready();
387                 if (!ready) {
388                         if (crng_init == CRNG_EMPTY)
389                                 extract_entropy(base_crng.key, sizeof(base_crng.key));
390                         crng_fast_key_erasure(base_crng.key, chacha_state,
391                                               random_data, random_data_len);
392                 }
393                 spin_unlock_irqrestore(&base_crng.lock, flags);
394                 if (!ready)
395                         return;
396         }
397
398         /*
399          * If the base_crng is old enough, we reseed, which in turn bumps the
400          * generation counter that we check below.
401          */
402         if (unlikely(crng_has_old_seed()))
403                 crng_reseed();
404
405         local_lock_irqsave(&crngs.lock, flags);
406         crng = raw_cpu_ptr(&crngs);
407
408         /*
409          * If our per-cpu crng is older than the base_crng, then it means
410          * somebody reseeded the base_crng. In that case, we do fast key
411          * erasure on the base_crng, and use its output as the new key
412          * for our per-cpu crng. This brings us up to date with base_crng.
413          */
414         if (unlikely(crng->generation != READ_ONCE(base_crng.generation))) {
415                 spin_lock(&base_crng.lock);
416                 crng_fast_key_erasure(base_crng.key, chacha_state,
417                                       crng->key, sizeof(crng->key));
418                 crng->generation = base_crng.generation;
419                 spin_unlock(&base_crng.lock);
420         }
421
422         /*
423          * Finally, when we've made it this far, our per-cpu crng has an up
424          * to date key, and we can do fast key erasure with it to produce
425          * some random data and a ChaCha state for the caller. All other
426          * branches of this function are "unlikely", so most of the time we
427          * should wind up here immediately.
428          */
429         crng_fast_key_erasure(crng->key, chacha_state, random_data, random_data_len);
430         local_unlock_irqrestore(&crngs.lock, flags);
431 }
432
433 static void _get_random_bytes(void *buf, size_t nbytes)
434 {
435         u32 chacha_state[CHACHA_STATE_WORDS];
436         u8 tmp[CHACHA_BLOCK_SIZE];
437         size_t len;
438
439         if (!nbytes)
440                 return;
441
442         len = min_t(size_t, 32, nbytes);
443         crng_make_state(chacha_state, buf, len);
444         nbytes -= len;
445         buf += len;
446
447         while (nbytes) {
448                 if (nbytes < CHACHA_BLOCK_SIZE) {
449                         chacha20_block(chacha_state, tmp);
450                         memcpy(buf, tmp, nbytes);
451                         memzero_explicit(tmp, sizeof(tmp));
452                         break;
453                 }
454
455                 chacha20_block(chacha_state, buf);
456                 if (unlikely(chacha_state[12] == 0))
457                         ++chacha_state[13];
458                 nbytes -= CHACHA_BLOCK_SIZE;
459                 buf += CHACHA_BLOCK_SIZE;
460         }
461
462         memzero_explicit(chacha_state, sizeof(chacha_state));
463 }
464
465 /*
466  * This function is the exported kernel interface.  It returns some
467  * number of good random numbers, suitable for key generation, seeding
468  * TCP sequence numbers, etc.  It does not rely on the hardware random
469  * number generator.  For random bytes direct from the hardware RNG
470  * (when available), use get_random_bytes_arch(). In order to ensure
471  * that the randomness provided by this function is okay, the function
472  * wait_for_random_bytes() should be called and return 0 at least once
473  * at any point prior.
474  */
475 void get_random_bytes(void *buf, size_t nbytes)
476 {
477         static void *previous;
478
479         warn_unseeded_randomness(&previous);
480         _get_random_bytes(buf, nbytes);
481 }
482 EXPORT_SYMBOL(get_random_bytes);
483
484 static ssize_t get_random_bytes_user(void __user *buf, size_t nbytes)
485 {
486         size_t len, left, ret = 0;
487         u32 chacha_state[CHACHA_STATE_WORDS];
488         u8 output[CHACHA_BLOCK_SIZE];
489
490         if (!nbytes)
491                 return 0;
492
493         /*
494          * Immediately overwrite the ChaCha key at index 4 with random
495          * bytes, in case userspace causes copy_to_user() below to sleep
496          * forever, so that we still retain forward secrecy in that case.
497          */
498         crng_make_state(chacha_state, (u8 *)&chacha_state[4], CHACHA_KEY_SIZE);
499         /*
500          * However, if we're doing a read of len <= 32, we don't need to
501          * use chacha_state after, so we can simply return those bytes to
502          * the user directly.
503          */
504         if (nbytes <= CHACHA_KEY_SIZE) {
505                 ret = nbytes - copy_to_user(buf, &chacha_state[4], nbytes);
506                 goto out_zero_chacha;
507         }
508
509         for (;;) {
510                 chacha20_block(chacha_state, output);
511                 if (unlikely(chacha_state[12] == 0))
512                         ++chacha_state[13];
513
514                 len = min_t(size_t, nbytes, CHACHA_BLOCK_SIZE);
515                 left = copy_to_user(buf, output, len);
516                 if (left) {
517                         ret += len - left;
518                         break;
519                 }
520
521                 buf += len;
522                 ret += len;
523                 nbytes -= len;
524                 if (!nbytes)
525                         break;
526
527                 BUILD_BUG_ON(PAGE_SIZE % CHACHA_BLOCK_SIZE != 0);
528                 if (ret % PAGE_SIZE == 0) {
529                         if (signal_pending(current))
530                                 break;
531                         cond_resched();
532                 }
533         }
534
535         memzero_explicit(output, sizeof(output));
536 out_zero_chacha:
537         memzero_explicit(chacha_state, sizeof(chacha_state));
538         return ret ? ret : -EFAULT;
539 }
540
541 /*
542  * Batched entropy returns random integers. The quality of the random
543  * number is good as /dev/urandom. In order to ensure that the randomness
544  * provided by this function is okay, the function wait_for_random_bytes()
545  * should be called and return 0 at least once at any point prior.
546  */
547 struct batched_entropy {
548         union {
549                 /*
550                  * We make this 1.5x a ChaCha block, so that we get the
551                  * remaining 32 bytes from fast key erasure, plus one full
552                  * block from the detached ChaCha state. We can increase
553                  * the size of this later if needed so long as we keep the
554                  * formula of (integer_blocks + 0.5) * CHACHA_BLOCK_SIZE.
555                  */
556                 u64 entropy_u64[CHACHA_BLOCK_SIZE * 3 / (2 * sizeof(u64))];
557                 u32 entropy_u32[CHACHA_BLOCK_SIZE * 3 / (2 * sizeof(u32))];
558         };
559         local_lock_t lock;
560         unsigned long generation;
561         unsigned int position;
562 };
563
564
565 static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u64) = {
566         .lock = INIT_LOCAL_LOCK(batched_entropy_u64.lock),
567         .position = UINT_MAX
568 };
569
570 u64 get_random_u64(void)
571 {
572         u64 ret;
573         unsigned long flags;
574         struct batched_entropy *batch;
575         static void *previous;
576         unsigned long next_gen;
577
578         warn_unseeded_randomness(&previous);
579
580         if  (!crng_ready()) {
581                 _get_random_bytes(&ret, sizeof(ret));
582                 return ret;
583         }
584
585         local_lock_irqsave(&batched_entropy_u64.lock, flags);
586         batch = raw_cpu_ptr(&batched_entropy_u64);
587
588         next_gen = READ_ONCE(base_crng.generation);
589         if (batch->position >= ARRAY_SIZE(batch->entropy_u64) ||
590             next_gen != batch->generation) {
591                 _get_random_bytes(batch->entropy_u64, sizeof(batch->entropy_u64));
592                 batch->position = 0;
593                 batch->generation = next_gen;
594         }
595
596         ret = batch->entropy_u64[batch->position];
597         batch->entropy_u64[batch->position] = 0;
598         ++batch->position;
599         local_unlock_irqrestore(&batched_entropy_u64.lock, flags);
600         return ret;
601 }
602 EXPORT_SYMBOL(get_random_u64);
603
604 static DEFINE_PER_CPU(struct batched_entropy, batched_entropy_u32) = {
605         .lock = INIT_LOCAL_LOCK(batched_entropy_u32.lock),
606         .position = UINT_MAX
607 };
608
609 u32 get_random_u32(void)
610 {
611         u32 ret;
612         unsigned long flags;
613         struct batched_entropy *batch;
614         static void *previous;
615         unsigned long next_gen;
616
617         warn_unseeded_randomness(&previous);
618
619         if  (!crng_ready()) {
620                 _get_random_bytes(&ret, sizeof(ret));
621                 return ret;
622         }
623
624         local_lock_irqsave(&batched_entropy_u32.lock, flags);
625         batch = raw_cpu_ptr(&batched_entropy_u32);
626
627         next_gen = READ_ONCE(base_crng.generation);
628         if (batch->position >= ARRAY_SIZE(batch->entropy_u32) ||
629             next_gen != batch->generation) {
630                 _get_random_bytes(batch->entropy_u32, sizeof(batch->entropy_u32));
631                 batch->position = 0;
632                 batch->generation = next_gen;
633         }
634
635         ret = batch->entropy_u32[batch->position];
636         batch->entropy_u32[batch->position] = 0;
637         ++batch->position;
638         local_unlock_irqrestore(&batched_entropy_u32.lock, flags);
639         return ret;
640 }
641 EXPORT_SYMBOL(get_random_u32);
642
643 #ifdef CONFIG_SMP
644 /*
645  * This function is called when the CPU is coming up, with entry
646  * CPUHP_RANDOM_PREPARE, which comes before CPUHP_WORKQUEUE_PREP.
647  */
648 int random_prepare_cpu(unsigned int cpu)
649 {
650         /*
651          * When the cpu comes back online, immediately invalidate both
652          * the per-cpu crng and all batches, so that we serve fresh
653          * randomness.
654          */
655         per_cpu_ptr(&crngs, cpu)->generation = ULONG_MAX;
656         per_cpu_ptr(&batched_entropy_u32, cpu)->position = UINT_MAX;
657         per_cpu_ptr(&batched_entropy_u64, cpu)->position = UINT_MAX;
658         return 0;
659 }
660 #endif
661
662 /**
663  * randomize_page - Generate a random, page aligned address
664  * @start:      The smallest acceptable address the caller will take.
665  * @range:      The size of the area, starting at @start, within which the
666  *              random address must fall.
667  *
668  * If @start + @range would overflow, @range is capped.
669  *
670  * NOTE: Historical use of randomize_range, which this replaces, presumed that
671  * @start was already page aligned.  We now align it regardless.
672  *
673  * Return: A page aligned address within [start, start + range).  On error,
674  * @start is returned.
675  */
676 unsigned long randomize_page(unsigned long start, unsigned long range)
677 {
678         if (!PAGE_ALIGNED(start)) {
679                 range -= PAGE_ALIGN(start) - start;
680                 start = PAGE_ALIGN(start);
681         }
682
683         if (start > ULONG_MAX - range)
684                 range = ULONG_MAX - start;
685
686         range >>= PAGE_SHIFT;
687
688         if (range == 0)
689                 return start;
690
691         return start + (get_random_long() % range << PAGE_SHIFT);
692 }
693
694 /*
695  * This function will use the architecture-specific hardware random
696  * number generator if it is available. It is not recommended for
697  * use. Use get_random_bytes() instead. It returns the number of
698  * bytes filled in.
699  */
700 size_t __must_check get_random_bytes_arch(void *buf, size_t nbytes)
701 {
702         size_t left = nbytes;
703         u8 *p = buf;
704
705         while (left) {
706                 unsigned long v;
707                 size_t chunk = min_t(size_t, left, sizeof(unsigned long));
708
709                 if (!arch_get_random_long(&v))
710                         break;
711
712                 memcpy(p, &v, chunk);
713                 p += chunk;
714                 left -= chunk;
715         }
716
717         return nbytes - left;
718 }
719 EXPORT_SYMBOL(get_random_bytes_arch);
720
721
722 /**********************************************************************
723  *
724  * Entropy accumulation and extraction routines.
725  *
726  * Callers may add entropy via:
727  *
728  *     static void mix_pool_bytes(const void *in, size_t nbytes)
729  *
730  * After which, if added entropy should be credited:
731  *
732  *     static void credit_init_bits(size_t nbits)
733  *
734  * Finally, extract entropy via:
735  *
736  *     static void extract_entropy(void *buf, size_t nbytes)
737  *
738  **********************************************************************/
739
740 enum {
741         POOL_BITS = BLAKE2S_HASH_SIZE * 8,
742         POOL_READY_BITS = POOL_BITS, /* When crng_init->CRNG_READY */
743         POOL_EARLY_BITS = POOL_READY_BITS / 2 /* When crng_init->CRNG_EARLY */
744 };
745
746 static struct {
747         struct blake2s_state hash;
748         spinlock_t lock;
749         unsigned int init_bits;
750 } input_pool = {
751         .hash.h = { BLAKE2S_IV0 ^ (0x01010000 | BLAKE2S_HASH_SIZE),
752                     BLAKE2S_IV1, BLAKE2S_IV2, BLAKE2S_IV3, BLAKE2S_IV4,
753                     BLAKE2S_IV5, BLAKE2S_IV6, BLAKE2S_IV7 },
754         .hash.outlen = BLAKE2S_HASH_SIZE,
755         .lock = __SPIN_LOCK_UNLOCKED(input_pool.lock),
756 };
757
758 static void _mix_pool_bytes(const void *in, size_t nbytes)
759 {
760         blake2s_update(&input_pool.hash, in, nbytes);
761 }
762
763 /*
764  * This function adds bytes into the input pool. It does not
765  * update the initialization bit counter; the caller should call
766  * credit_init_bits if this is appropriate.
767  */
768 static void mix_pool_bytes(const void *in, size_t nbytes)
769 {
770         unsigned long flags;
771
772         spin_lock_irqsave(&input_pool.lock, flags);
773         _mix_pool_bytes(in, nbytes);
774         spin_unlock_irqrestore(&input_pool.lock, flags);
775 }
776
777 /*
778  * This is an HKDF-like construction for using the hashed collected entropy
779  * as a PRF key, that's then expanded block-by-block.
780  */
781 static void extract_entropy(void *buf, size_t nbytes)
782 {
783         unsigned long flags;
784         u8 seed[BLAKE2S_HASH_SIZE], next_key[BLAKE2S_HASH_SIZE];
785         struct {
786                 unsigned long rdseed[32 / sizeof(long)];
787                 size_t counter;
788         } block;
789         size_t i;
790
791         for (i = 0; i < ARRAY_SIZE(block.rdseed); ++i) {
792                 if (!arch_get_random_seed_long(&block.rdseed[i]) &&
793                     !arch_get_random_long(&block.rdseed[i]))
794                         block.rdseed[i] = random_get_entropy();
795         }
796
797         spin_lock_irqsave(&input_pool.lock, flags);
798
799         /* seed = HASHPRF(last_key, entropy_input) */
800         blake2s_final(&input_pool.hash, seed);
801
802         /* next_key = HASHPRF(seed, RDSEED || 0) */
803         block.counter = 0;
804         blake2s(next_key, (u8 *)&block, seed, sizeof(next_key), sizeof(block), sizeof(seed));
805         blake2s_init_key(&input_pool.hash, BLAKE2S_HASH_SIZE, next_key, sizeof(next_key));
806
807         spin_unlock_irqrestore(&input_pool.lock, flags);
808         memzero_explicit(next_key, sizeof(next_key));
809
810         while (nbytes) {
811                 i = min_t(size_t, nbytes, BLAKE2S_HASH_SIZE);
812                 /* output = HASHPRF(seed, RDSEED || ++counter) */
813                 ++block.counter;
814                 blake2s(buf, (u8 *)&block, seed, i, sizeof(block), sizeof(seed));
815                 nbytes -= i;
816                 buf += i;
817         }
818
819         memzero_explicit(seed, sizeof(seed));
820         memzero_explicit(&block, sizeof(block));
821 }
822
823 static void credit_init_bits(size_t nbits)
824 {
825         unsigned int init_bits, orig, add;
826         unsigned long flags;
827
828         if (crng_ready() || !nbits)
829                 return;
830
831         add = min_t(size_t, nbits, POOL_BITS);
832
833         do {
834                 orig = READ_ONCE(input_pool.init_bits);
835                 init_bits = min_t(unsigned int, POOL_BITS, orig + add);
836         } while (cmpxchg(&input_pool.init_bits, orig, init_bits) != orig);
837
838         if (!crng_ready() && init_bits >= POOL_READY_BITS)
839                 crng_reseed();
840         else if (unlikely(crng_init == CRNG_EMPTY && init_bits >= POOL_EARLY_BITS)) {
841                 spin_lock_irqsave(&base_crng.lock, flags);
842                 if (crng_init == CRNG_EMPTY) {
843                         extract_entropy(base_crng.key, sizeof(base_crng.key));
844                         crng_init = CRNG_EARLY;
845                 }
846                 spin_unlock_irqrestore(&base_crng.lock, flags);
847         }
848 }
849
850
851 /**********************************************************************
852  *
853  * Entropy collection routines.
854  *
855  * The following exported functions are used for pushing entropy into
856  * the above entropy accumulation routines:
857  *
858  *      void add_device_randomness(const void *buf, size_t size);
859  *      void add_hwgenerator_randomness(const void *buffer, size_t count,
860  *                                      size_t entropy);
861  *      void add_bootloader_randomness(const void *buf, size_t size);
862  *      void add_vmfork_randomness(const void *unique_vm_id, size_t size);
863  *      void add_interrupt_randomness(int irq);
864  *      void add_input_randomness(unsigned int type, unsigned int code,
865  *                                unsigned int value);
866  *      void add_disk_randomness(struct gendisk *disk);
867  *
868  * add_device_randomness() adds data to the input pool that
869  * is likely to differ between two devices (or possibly even per boot).
870  * This would be things like MAC addresses or serial numbers, or the
871  * read-out of the RTC. This does *not* credit any actual entropy to
872  * the pool, but it initializes the pool to different values for devices
873  * that might otherwise be identical and have very little entropy
874  * available to them (particularly common in the embedded world).
875  *
876  * add_hwgenerator_randomness() is for true hardware RNGs, and will credit
877  * entropy as specified by the caller. If the entropy pool is full it will
878  * block until more entropy is needed.
879  *
880  * add_bootloader_randomness() is called by bootloader drivers, such as EFI
881  * and device tree, and credits its input depending on whether or not the
882  * configuration option CONFIG_RANDOM_TRUST_BOOTLOADER is set.
883  *
884  * add_vmfork_randomness() adds a unique (but not necessarily secret) ID
885  * representing the current instance of a VM to the pool, without crediting,
886  * and then force-reseeds the crng so that it takes effect immediately.
887  *
888  * add_interrupt_randomness() uses the interrupt timing as random
889  * inputs to the entropy pool. Using the cycle counters and the irq source
890  * as inputs, it feeds the input pool roughly once a second or after 64
891  * interrupts, crediting 1 bit of entropy for whichever comes first.
892  *
893  * add_input_randomness() uses the input layer interrupt timing, as well
894  * as the event type information from the hardware.
895  *
896  * add_disk_randomness() uses what amounts to the seek time of block
897  * layer request events, on a per-disk_devt basis, as input to the
898  * entropy pool. Note that high-speed solid state drives with very low
899  * seek times do not make for good sources of entropy, as their seek
900  * times are usually fairly consistent.
901  *
902  * The last two routines try to estimate how many bits of entropy
903  * to credit. They do this by keeping track of the first and second
904  * order deltas of the event timings.
905  *
906  **********************************************************************/
907
908 static bool trust_cpu __ro_after_init = IS_ENABLED(CONFIG_RANDOM_TRUST_CPU);
909 static bool trust_bootloader __ro_after_init = IS_ENABLED(CONFIG_RANDOM_TRUST_BOOTLOADER);
910 static int __init parse_trust_cpu(char *arg)
911 {
912         return kstrtobool(arg, &trust_cpu);
913 }
914 static int __init parse_trust_bootloader(char *arg)
915 {
916         return kstrtobool(arg, &trust_bootloader);
917 }
918 early_param("random.trust_cpu", parse_trust_cpu);
919 early_param("random.trust_bootloader", parse_trust_bootloader);
920
921 static int random_pm_notification(struct notifier_block *nb, unsigned long action, void *data)
922 {
923         unsigned long flags, entropy = random_get_entropy();
924
925         /*
926          * Encode a representation of how long the system has been suspended,
927          * in a way that is distinct from prior system suspends.
928          */
929         ktime_t stamps[] = { ktime_get(), ktime_get_boottime(), ktime_get_real() };
930
931         spin_lock_irqsave(&input_pool.lock, flags);
932         _mix_pool_bytes(&action, sizeof(action));
933         _mix_pool_bytes(stamps, sizeof(stamps));
934         _mix_pool_bytes(&entropy, sizeof(entropy));
935         spin_unlock_irqrestore(&input_pool.lock, flags);
936
937         if (crng_ready() && (action == PM_RESTORE_PREPARE ||
938             (action == PM_POST_SUSPEND &&
939              !IS_ENABLED(CONFIG_PM_AUTOSLEEP) && !IS_ENABLED(CONFIG_ANDROID)))) {
940                 crng_reseed();
941                 pr_notice("crng reseeded on system resumption\n");
942         }
943         return 0;
944 }
945
946 static struct notifier_block pm_notifier = { .notifier_call = random_pm_notification };
947
948 /*
949  * The first collection of entropy occurs at system boot while interrupts
950  * are still turned off. Here we push in RDSEED, a timestamp, and utsname().
951  * Depending on the above configuration knob, RDSEED may be considered
952  * sufficient for initialization. Note that much earlier setup may already
953  * have pushed entropy into the input pool by the time we get here.
954  */
955 int __init rand_initialize(void)
956 {
957         size_t i;
958         ktime_t now = ktime_get_real();
959         bool arch_init = true;
960         unsigned long rv;
961
962 #if defined(LATENT_ENTROPY_PLUGIN)
963         static const u8 compiletime_seed[BLAKE2S_BLOCK_SIZE] __initconst __latent_entropy;
964         _mix_pool_bytes(compiletime_seed, sizeof(compiletime_seed));
965 #endif
966
967         for (i = 0; i < BLAKE2S_BLOCK_SIZE; i += sizeof(rv)) {
968                 if (!arch_get_random_seed_long_early(&rv) &&
969                     !arch_get_random_long_early(&rv)) {
970                         rv = random_get_entropy();
971                         arch_init = false;
972                 }
973                 _mix_pool_bytes(&rv, sizeof(rv));
974         }
975         _mix_pool_bytes(&now, sizeof(now));
976         _mix_pool_bytes(utsname(), sizeof(*(utsname())));
977
978         if (crng_ready())
979                 crng_reseed();
980         else if (arch_init && trust_cpu)
981                 credit_init_bits(BLAKE2S_BLOCK_SIZE * 8);
982
983         if (ratelimit_disable) {
984                 urandom_warning.interval = 0;
985                 unseeded_warning.interval = 0;
986         }
987
988         WARN_ON(register_pm_notifier(&pm_notifier));
989
990         WARN(!random_get_entropy(), "Missing cycle counter and fallback timer; RNG "
991                                     "entropy collection will consequently suffer.");
992         return 0;
993 }
994
995 /*
996  * Add device- or boot-specific data to the input pool to help
997  * initialize it.
998  *
999  * None of this adds any entropy; it is meant to avoid the problem of
1000  * the entropy pool having similar initial state across largely
1001  * identical devices.
1002  */
1003 void add_device_randomness(const void *buf, size_t size)
1004 {
1005         unsigned long entropy = random_get_entropy();
1006         unsigned long flags;
1007
1008         spin_lock_irqsave(&input_pool.lock, flags);
1009         _mix_pool_bytes(&entropy, sizeof(entropy));
1010         _mix_pool_bytes(buf, size);
1011         spin_unlock_irqrestore(&input_pool.lock, flags);
1012 }
1013 EXPORT_SYMBOL(add_device_randomness);
1014
1015 /*
1016  * Interface for in-kernel drivers of true hardware RNGs.
1017  * Those devices may produce endless random bits and will be throttled
1018  * when our pool is full.
1019  */
1020 void add_hwgenerator_randomness(const void *buffer, size_t count,
1021                                 size_t entropy)
1022 {
1023         mix_pool_bytes(buffer, count);
1024         credit_init_bits(entropy);
1025
1026         /*
1027          * Throttle writing to once every CRNG_RESEED_INTERVAL, unless
1028          * we're not yet initialized.
1029          */
1030         if (!kthread_should_stop() && crng_ready())
1031                 schedule_timeout_interruptible(CRNG_RESEED_INTERVAL);
1032 }
1033 EXPORT_SYMBOL_GPL(add_hwgenerator_randomness);
1034
1035 /*
1036  * Handle random seed passed by bootloader, and credit it if
1037  * CONFIG_RANDOM_TRUST_BOOTLOADER is set.
1038  */
1039 void add_bootloader_randomness(const void *buf, size_t size)
1040 {
1041         mix_pool_bytes(buf, size);
1042         if (trust_bootloader)
1043                 credit_init_bits(size * 8);
1044 }
1045 EXPORT_SYMBOL_GPL(add_bootloader_randomness);
1046
1047 #if IS_ENABLED(CONFIG_VMGENID)
1048 static BLOCKING_NOTIFIER_HEAD(vmfork_chain);
1049
1050 /*
1051  * Handle a new unique VM ID, which is unique, not secret, so we
1052  * don't credit it, but we do immediately force a reseed after so
1053  * that it's used by the crng posthaste.
1054  */
1055 void add_vmfork_randomness(const void *unique_vm_id, size_t size)
1056 {
1057         add_device_randomness(unique_vm_id, size);
1058         if (crng_ready()) {
1059                 crng_reseed();
1060                 pr_notice("crng reseeded due to virtual machine fork\n");
1061         }
1062         blocking_notifier_call_chain(&vmfork_chain, 0, NULL);
1063 }
1064 #if IS_MODULE(CONFIG_VMGENID)
1065 EXPORT_SYMBOL_GPL(add_vmfork_randomness);
1066 #endif
1067
1068 int register_random_vmfork_notifier(struct notifier_block *nb)
1069 {
1070         return blocking_notifier_chain_register(&vmfork_chain, nb);
1071 }
1072 EXPORT_SYMBOL_GPL(register_random_vmfork_notifier);
1073
1074 int unregister_random_vmfork_notifier(struct notifier_block *nb)
1075 {
1076         return blocking_notifier_chain_unregister(&vmfork_chain, nb);
1077 }
1078 EXPORT_SYMBOL_GPL(unregister_random_vmfork_notifier);
1079 #endif
1080
1081 struct fast_pool {
1082         struct work_struct mix;
1083         unsigned long pool[4];
1084         unsigned long last;
1085         unsigned int count;
1086 };
1087
1088 static DEFINE_PER_CPU(struct fast_pool, irq_randomness) = {
1089 #ifdef CONFIG_64BIT
1090 #define FASTMIX_PERM SIPHASH_PERMUTATION
1091         .pool = { SIPHASH_CONST_0, SIPHASH_CONST_1, SIPHASH_CONST_2, SIPHASH_CONST_3 }
1092 #else
1093 #define FASTMIX_PERM HSIPHASH_PERMUTATION
1094         .pool = { HSIPHASH_CONST_0, HSIPHASH_CONST_1, HSIPHASH_CONST_2, HSIPHASH_CONST_3 }
1095 #endif
1096 };
1097
1098 /*
1099  * This is [Half]SipHash-1-x, starting from an empty key. Because
1100  * the key is fixed, it assumes that its inputs are non-malicious,
1101  * and therefore this has no security on its own. s represents the
1102  * four-word SipHash state, while v represents a two-word input.
1103  */
1104 static void fast_mix(unsigned long s[4], unsigned long v1, unsigned long v2)
1105 {
1106         s[3] ^= v1;
1107         FASTMIX_PERM(s[0], s[1], s[2], s[3]);
1108         s[0] ^= v1;
1109         s[3] ^= v2;
1110         FASTMIX_PERM(s[0], s[1], s[2], s[3]);
1111         s[0] ^= v2;
1112 }
1113
1114 #ifdef CONFIG_SMP
1115 /*
1116  * This function is called when the CPU has just come online, with
1117  * entry CPUHP_AP_RANDOM_ONLINE, just after CPUHP_AP_WORKQUEUE_ONLINE.
1118  */
1119 int random_online_cpu(unsigned int cpu)
1120 {
1121         /*
1122          * During CPU shutdown and before CPU onlining, add_interrupt_
1123          * randomness() may schedule mix_interrupt_randomness(), and
1124          * set the MIX_INFLIGHT flag. However, because the worker can
1125          * be scheduled on a different CPU during this period, that
1126          * flag will never be cleared. For that reason, we zero out
1127          * the flag here, which runs just after workqueues are onlined
1128          * for the CPU again. This also has the effect of setting the
1129          * irq randomness count to zero so that new accumulated irqs
1130          * are fresh.
1131          */
1132         per_cpu_ptr(&irq_randomness, cpu)->count = 0;
1133         return 0;
1134 }
1135 #endif
1136
1137 static void mix_interrupt_randomness(struct work_struct *work)
1138 {
1139         struct fast_pool *fast_pool = container_of(work, struct fast_pool, mix);
1140         /*
1141          * The size of the copied stack pool is explicitly 2 longs so that we
1142          * only ever ingest half of the siphash output each time, retaining
1143          * the other half as the next "key" that carries over. The entropy is
1144          * supposed to be sufficiently dispersed between bits so on average
1145          * we don't wind up "losing" some.
1146          */
1147         unsigned long pool[2];
1148         unsigned int count;
1149
1150         /* Check to see if we're running on the wrong CPU due to hotplug. */
1151         local_irq_disable();
1152         if (fast_pool != this_cpu_ptr(&irq_randomness)) {
1153                 local_irq_enable();
1154                 return;
1155         }
1156
1157         /*
1158          * Copy the pool to the stack so that the mixer always has a
1159          * consistent view, before we reenable irqs again.
1160          */
1161         memcpy(pool, fast_pool->pool, sizeof(pool));
1162         count = fast_pool->count;
1163         fast_pool->count = 0;
1164         fast_pool->last = jiffies;
1165         local_irq_enable();
1166
1167         mix_pool_bytes(pool, sizeof(pool));
1168         credit_init_bits(max(1u, (count & U16_MAX) / 64));
1169
1170         memzero_explicit(pool, sizeof(pool));
1171 }
1172
1173 void add_interrupt_randomness(int irq)
1174 {
1175         enum { MIX_INFLIGHT = 1U << 31 };
1176         unsigned long entropy = random_get_entropy();
1177         struct fast_pool *fast_pool = this_cpu_ptr(&irq_randomness);
1178         struct pt_regs *regs = get_irq_regs();
1179         unsigned int new_count;
1180
1181         fast_mix(fast_pool->pool, entropy,
1182                  (regs ? instruction_pointer(regs) : _RET_IP_) ^ swab(irq));
1183         new_count = ++fast_pool->count;
1184
1185         if (new_count & MIX_INFLIGHT)
1186                 return;
1187
1188         if (new_count < 64 && !time_is_before_jiffies(fast_pool->last + HZ))
1189                 return;
1190
1191         if (unlikely(!fast_pool->mix.func))
1192                 INIT_WORK(&fast_pool->mix, mix_interrupt_randomness);
1193         fast_pool->count |= MIX_INFLIGHT;
1194         queue_work_on(raw_smp_processor_id(), system_highpri_wq, &fast_pool->mix);
1195 }
1196 EXPORT_SYMBOL_GPL(add_interrupt_randomness);
1197
1198 /* There is one of these per entropy source */
1199 struct timer_rand_state {
1200         unsigned long last_time;
1201         long last_delta, last_delta2;
1202 };
1203
1204 /*
1205  * This function adds entropy to the entropy "pool" by using timing
1206  * delays. It uses the timer_rand_state structure to make an estimate
1207  * of how many bits of entropy this call has added to the pool. The
1208  * value "num" is also added to the pool; it should somehow describe
1209  * the type of event that just happened.
1210  */
1211 static void add_timer_randomness(struct timer_rand_state *state, unsigned int num)
1212 {
1213         unsigned long entropy = random_get_entropy(), now = jiffies, flags;
1214         long delta, delta2, delta3;
1215         unsigned int bits;
1216
1217         /*
1218          * If we're in a hard IRQ, add_interrupt_randomness() will be called
1219          * sometime after, so mix into the fast pool.
1220          */
1221         if (in_hardirq()) {
1222                 fast_mix(this_cpu_ptr(&irq_randomness)->pool, entropy, num);
1223         } else {
1224                 spin_lock_irqsave(&input_pool.lock, flags);
1225                 _mix_pool_bytes(&entropy, sizeof(entropy));
1226                 _mix_pool_bytes(&num, sizeof(num));
1227                 spin_unlock_irqrestore(&input_pool.lock, flags);
1228         }
1229
1230         if (crng_ready())
1231                 return;
1232
1233         /*
1234          * Calculate number of bits of randomness we probably added.
1235          * We take into account the first, second and third-order deltas
1236          * in order to make our estimate.
1237          */
1238         delta = now - READ_ONCE(state->last_time);
1239         WRITE_ONCE(state->last_time, now);
1240
1241         delta2 = delta - READ_ONCE(state->last_delta);
1242         WRITE_ONCE(state->last_delta, delta);
1243
1244         delta3 = delta2 - READ_ONCE(state->last_delta2);
1245         WRITE_ONCE(state->last_delta2, delta2);
1246
1247         if (delta < 0)
1248                 delta = -delta;
1249         if (delta2 < 0)
1250                 delta2 = -delta2;
1251         if (delta3 < 0)
1252                 delta3 = -delta3;
1253         if (delta > delta2)
1254                 delta = delta2;
1255         if (delta > delta3)
1256                 delta = delta3;
1257
1258         /*
1259          * delta is now minimum absolute delta. Round down by 1 bit
1260          * on general principles, and limit entropy estimate to 11 bits.
1261          */
1262         bits = min(fls(delta >> 1), 11);
1263
1264         /*
1265          * As mentioned above, if we're in a hard IRQ, add_interrupt_randomness()
1266          * will run after this, which uses a different crediting scheme of 1 bit
1267          * per every 64 interrupts. In order to let that function do accounting
1268          * close to the one in this function, we credit a full 64/64 bit per bit,
1269          * and then subtract one to account for the extra one added.
1270          */
1271         if (in_hardirq())
1272                 this_cpu_ptr(&irq_randomness)->count += max(1u, bits * 64) - 1;
1273         else
1274                 credit_init_bits(bits);
1275 }
1276
1277 void add_input_randomness(unsigned int type, unsigned int code,
1278                           unsigned int value)
1279 {
1280         static unsigned char last_value;
1281         static struct timer_rand_state input_timer_state = { INITIAL_JIFFIES };
1282
1283         /* Ignore autorepeat and the like. */
1284         if (value == last_value)
1285                 return;
1286
1287         last_value = value;
1288         add_timer_randomness(&input_timer_state,
1289                              (type << 4) ^ code ^ (code >> 4) ^ value);
1290 }
1291 EXPORT_SYMBOL_GPL(add_input_randomness);
1292
1293 #ifdef CONFIG_BLOCK
1294 void add_disk_randomness(struct gendisk *disk)
1295 {
1296         if (!disk || !disk->random)
1297                 return;
1298         /* First major is 1, so we get >= 0x200 here. */
1299         add_timer_randomness(disk->random, 0x100 + disk_devt(disk));
1300 }
1301 EXPORT_SYMBOL_GPL(add_disk_randomness);
1302
1303 void rand_initialize_disk(struct gendisk *disk)
1304 {
1305         struct timer_rand_state *state;
1306
1307         /*
1308          * If kzalloc returns null, we just won't use that entropy
1309          * source.
1310          */
1311         state = kzalloc(sizeof(struct timer_rand_state), GFP_KERNEL);
1312         if (state) {
1313                 state->last_time = INITIAL_JIFFIES;
1314                 disk->random = state;
1315         }
1316 }
1317 #endif
1318
1319 struct entropy_timer_state {
1320         unsigned long entropy;
1321         struct timer_list timer;
1322         unsigned int samples, samples_per_bit;
1323 };
1324
1325 /*
1326  * Each time the timer fires, we expect that we got an unpredictable
1327  * jump in the cycle counter. Even if the timer is running on another
1328  * CPU, the timer activity will be touching the stack of the CPU that is
1329  * generating entropy..
1330  *
1331  * Note that we don't re-arm the timer in the timer itself - we are
1332  * happy to be scheduled away, since that just makes the load more
1333  * complex, but we do not want the timer to keep ticking unless the
1334  * entropy loop is running.
1335  *
1336  * So the re-arming always happens in the entropy loop itself.
1337  */
1338 static void entropy_timer(struct timer_list *timer)
1339 {
1340         struct entropy_timer_state *state = container_of(timer, struct entropy_timer_state, timer);
1341
1342         if (++state->samples == state->samples_per_bit) {
1343                 credit_init_bits(1);
1344                 state->samples = 0;
1345         }
1346 }
1347
1348 /*
1349  * If we have an actual cycle counter, see if we can
1350  * generate enough entropy with timing noise
1351  */
1352 static void try_to_generate_entropy(void)
1353 {
1354         enum { NUM_TRIAL_SAMPLES = 8192, MAX_SAMPLES_PER_BIT = 32 };
1355         struct entropy_timer_state stack;
1356         unsigned int i, num_different = 0;
1357         unsigned long last = random_get_entropy();
1358
1359         for (i = 0; i < NUM_TRIAL_SAMPLES - 1; ++i) {
1360                 stack.entropy = random_get_entropy();
1361                 if (stack.entropy != last)
1362                         ++num_different;
1363                 last = stack.entropy;
1364         }
1365         stack.samples_per_bit = DIV_ROUND_UP(NUM_TRIAL_SAMPLES, num_different + 1);
1366         if (stack.samples_per_bit > MAX_SAMPLES_PER_BIT)
1367                 return;
1368
1369         stack.samples = 0;
1370         timer_setup_on_stack(&stack.timer, entropy_timer, 0);
1371         while (!crng_ready() && !signal_pending(current)) {
1372                 if (!timer_pending(&stack.timer))
1373                         mod_timer(&stack.timer, jiffies + 1);
1374                 mix_pool_bytes(&stack.entropy, sizeof(stack.entropy));
1375                 schedule();
1376                 stack.entropy = random_get_entropy();
1377         }
1378
1379         del_timer_sync(&stack.timer);
1380         destroy_timer_on_stack(&stack.timer);
1381         mix_pool_bytes(&stack.entropy, sizeof(stack.entropy));
1382 }
1383
1384
1385 /**********************************************************************
1386  *
1387  * Userspace reader/writer interfaces.
1388  *
1389  * getrandom(2) is the primary modern interface into the RNG and should
1390  * be used in preference to anything else.
1391  *
1392  * Reading from /dev/random has the same functionality as calling
1393  * getrandom(2) with flags=0. In earlier versions, however, it had
1394  * vastly different semantics and should therefore be avoided, to
1395  * prevent backwards compatibility issues.
1396  *
1397  * Reading from /dev/urandom has the same functionality as calling
1398  * getrandom(2) with flags=GRND_INSECURE. Because it does not block
1399  * waiting for the RNG to be ready, it should not be used.
1400  *
1401  * Writing to either /dev/random or /dev/urandom adds entropy to
1402  * the input pool but does not credit it.
1403  *
1404  * Polling on /dev/random indicates when the RNG is initialized, on
1405  * the read side, and when it wants new entropy, on the write side.
1406  *
1407  * Both /dev/random and /dev/urandom have the same set of ioctls for
1408  * adding entropy, getting the entropy count, zeroing the count, and
1409  * reseeding the crng.
1410  *
1411  **********************************************************************/
1412
1413 SYSCALL_DEFINE3(getrandom, char __user *, buf, size_t, count, unsigned int,
1414                 flags)
1415 {
1416         if (flags & ~(GRND_NONBLOCK | GRND_RANDOM | GRND_INSECURE))
1417                 return -EINVAL;
1418
1419         /*
1420          * Requesting insecure and blocking randomness at the same time makes
1421          * no sense.
1422          */
1423         if ((flags & (GRND_INSECURE | GRND_RANDOM)) == (GRND_INSECURE | GRND_RANDOM))
1424                 return -EINVAL;
1425
1426         if (count > INT_MAX)
1427                 count = INT_MAX;
1428
1429         if (!(flags & GRND_INSECURE) && !crng_ready()) {
1430                 int ret;
1431
1432                 if (flags & GRND_NONBLOCK)
1433                         return -EAGAIN;
1434                 ret = wait_for_random_bytes();
1435                 if (unlikely(ret))
1436                         return ret;
1437         }
1438         return get_random_bytes_user(buf, count);
1439 }
1440
1441 static __poll_t random_poll(struct file *file, poll_table *wait)
1442 {
1443         poll_wait(file, &crng_init_wait, wait);
1444         return crng_ready() ? EPOLLIN | EPOLLRDNORM : EPOLLOUT | EPOLLWRNORM;
1445 }
1446
1447 static int write_pool(const char __user *ubuf, size_t count)
1448 {
1449         size_t len;
1450         int ret = 0;
1451         u8 block[BLAKE2S_BLOCK_SIZE];
1452
1453         while (count) {
1454                 len = min(count, sizeof(block));
1455                 if (copy_from_user(block, ubuf, len)) {
1456                         ret = -EFAULT;
1457                         goto out;
1458                 }
1459                 count -= len;
1460                 ubuf += len;
1461                 mix_pool_bytes(block, len);
1462                 cond_resched();
1463         }
1464
1465 out:
1466         memzero_explicit(block, sizeof(block));
1467         return ret;
1468 }
1469
1470 static ssize_t random_write(struct file *file, const char __user *buffer,
1471                             size_t count, loff_t *ppos)
1472 {
1473         int ret;
1474
1475         ret = write_pool(buffer, count);
1476         if (ret)
1477                 return ret;
1478
1479         return (ssize_t)count;
1480 }
1481
1482 static ssize_t urandom_read(struct file *file, char __user *buf, size_t nbytes,
1483                             loff_t *ppos)
1484 {
1485         static int maxwarn = 10;
1486
1487         /*
1488          * Opportunistically attempt to initialize the RNG on platforms that
1489          * have fast cycle counters, but don't (for now) require it to succeed.
1490          */
1491         if (!crng_ready())
1492                 try_to_generate_entropy();
1493
1494         if (!crng_ready() && maxwarn > 0) {
1495                 maxwarn--;
1496                 if (__ratelimit(&urandom_warning))
1497                         pr_notice("%s: uninitialized urandom read (%zd bytes read)\n",
1498                                   current->comm, nbytes);
1499         }
1500
1501         return get_random_bytes_user(buf, nbytes);
1502 }
1503
1504 static ssize_t random_read(struct file *file, char __user *buf, size_t nbytes,
1505                            loff_t *ppos)
1506 {
1507         int ret;
1508
1509         ret = wait_for_random_bytes();
1510         if (ret != 0)
1511                 return ret;
1512         return get_random_bytes_user(buf, nbytes);
1513 }
1514
1515 static long random_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
1516 {
1517         int size, ent_count;
1518         int __user *p = (int __user *)arg;
1519         int retval;
1520
1521         switch (cmd) {
1522         case RNDGETENTCNT:
1523                 /* Inherently racy, no point locking. */
1524                 if (put_user(input_pool.init_bits, p))
1525                         return -EFAULT;
1526                 return 0;
1527         case RNDADDTOENTCNT:
1528                 if (!capable(CAP_SYS_ADMIN))
1529                         return -EPERM;
1530                 if (get_user(ent_count, p))
1531                         return -EFAULT;
1532                 if (ent_count < 0)
1533                         return -EINVAL;
1534                 credit_init_bits(ent_count);
1535                 return 0;
1536         case RNDADDENTROPY:
1537                 if (!capable(CAP_SYS_ADMIN))
1538                         return -EPERM;
1539                 if (get_user(ent_count, p++))
1540                         return -EFAULT;
1541                 if (ent_count < 0)
1542                         return -EINVAL;
1543                 if (get_user(size, p++))
1544                         return -EFAULT;
1545                 retval = write_pool((const char __user *)p, size);
1546                 if (retval < 0)
1547                         return retval;
1548                 credit_init_bits(ent_count);
1549                 return 0;
1550         case RNDZAPENTCNT:
1551         case RNDCLEARPOOL:
1552                 /* No longer has any effect. */
1553                 if (!capable(CAP_SYS_ADMIN))
1554                         return -EPERM;
1555                 return 0;
1556         case RNDRESEEDCRNG:
1557                 if (!capable(CAP_SYS_ADMIN))
1558                         return -EPERM;
1559                 if (!crng_ready())
1560                         return -ENODATA;
1561                 crng_reseed();
1562                 return 0;
1563         default:
1564                 return -EINVAL;
1565         }
1566 }
1567
1568 static int random_fasync(int fd, struct file *filp, int on)
1569 {
1570         return fasync_helper(fd, filp, on, &fasync);
1571 }
1572
1573 const struct file_operations random_fops = {
1574         .read = random_read,
1575         .write = random_write,
1576         .poll = random_poll,
1577         .unlocked_ioctl = random_ioctl,
1578         .compat_ioctl = compat_ptr_ioctl,
1579         .fasync = random_fasync,
1580         .llseek = noop_llseek,
1581 };
1582
1583 const struct file_operations urandom_fops = {
1584         .read = urandom_read,
1585         .write = random_write,
1586         .unlocked_ioctl = random_ioctl,
1587         .compat_ioctl = compat_ptr_ioctl,
1588         .fasync = random_fasync,
1589         .llseek = noop_llseek,
1590 };
1591
1592
1593 /********************************************************************
1594  *
1595  * Sysctl interface.
1596  *
1597  * These are partly unused legacy knobs with dummy values to not break
1598  * userspace and partly still useful things. They are usually accessible
1599  * in /proc/sys/kernel/random/ and are as follows:
1600  *
1601  * - boot_id - a UUID representing the current boot.
1602  *
1603  * - uuid - a random UUID, different each time the file is read.
1604  *
1605  * - poolsize - the number of bits of entropy that the input pool can
1606  *   hold, tied to the POOL_BITS constant.
1607  *
1608  * - entropy_avail - the number of bits of entropy currently in the
1609  *   input pool. Always <= poolsize.
1610  *
1611  * - write_wakeup_threshold - the amount of entropy in the input pool
1612  *   below which write polls to /dev/random will unblock, requesting
1613  *   more entropy, tied to the POOL_READY_BITS constant. It is writable
1614  *   to avoid breaking old userspaces, but writing to it does not
1615  *   change any behavior of the RNG.
1616  *
1617  * - urandom_min_reseed_secs - fixed to the value CRNG_RESEED_INTERVAL.
1618  *   It is writable to avoid breaking old userspaces, but writing
1619  *   to it does not change any behavior of the RNG.
1620  *
1621  ********************************************************************/
1622
1623 #ifdef CONFIG_SYSCTL
1624
1625 #include <linux/sysctl.h>
1626
1627 static int sysctl_random_min_urandom_seed = CRNG_RESEED_INTERVAL / HZ;
1628 static int sysctl_random_write_wakeup_bits = POOL_READY_BITS;
1629 static int sysctl_poolsize = POOL_BITS;
1630 static u8 sysctl_bootid[UUID_SIZE];
1631
1632 /*
1633  * This function is used to return both the bootid UUID, and random
1634  * UUID. The difference is in whether table->data is NULL; if it is,
1635  * then a new UUID is generated and returned to the user.
1636  */
1637 static int proc_do_uuid(struct ctl_table *table, int write, void *buffer,
1638                         size_t *lenp, loff_t *ppos)
1639 {
1640         u8 tmp_uuid[UUID_SIZE], *uuid;
1641         char uuid_string[UUID_STRING_LEN + 1];
1642         struct ctl_table fake_table = {
1643                 .data = uuid_string,
1644                 .maxlen = UUID_STRING_LEN
1645         };
1646
1647         if (write)
1648                 return -EPERM;
1649
1650         uuid = table->data;
1651         if (!uuid) {
1652                 uuid = tmp_uuid;
1653                 generate_random_uuid(uuid);
1654         } else {
1655                 static DEFINE_SPINLOCK(bootid_spinlock);
1656
1657                 spin_lock(&bootid_spinlock);
1658                 if (!uuid[8])
1659                         generate_random_uuid(uuid);
1660                 spin_unlock(&bootid_spinlock);
1661         }
1662
1663         snprintf(uuid_string, sizeof(uuid_string), "%pU", uuid);
1664         return proc_dostring(&fake_table, 0, buffer, lenp, ppos);
1665 }
1666
1667 /* The same as proc_dointvec, but writes don't change anything. */
1668 static int proc_do_rointvec(struct ctl_table *table, int write, void *buffer,
1669                             size_t *lenp, loff_t *ppos)
1670 {
1671         return write ? 0 : proc_dointvec(table, 0, buffer, lenp, ppos);
1672 }
1673
1674 static struct ctl_table random_table[] = {
1675         {
1676                 .procname       = "poolsize",
1677                 .data           = &sysctl_poolsize,
1678                 .maxlen         = sizeof(int),
1679                 .mode           = 0444,
1680                 .proc_handler   = proc_dointvec,
1681         },
1682         {
1683                 .procname       = "entropy_avail",
1684                 .data           = &input_pool.init_bits,
1685                 .maxlen         = sizeof(int),
1686                 .mode           = 0444,
1687                 .proc_handler   = proc_dointvec,
1688         },
1689         {
1690                 .procname       = "write_wakeup_threshold",
1691                 .data           = &sysctl_random_write_wakeup_bits,
1692                 .maxlen         = sizeof(int),
1693                 .mode           = 0644,
1694                 .proc_handler   = proc_do_rointvec,
1695         },
1696         {
1697                 .procname       = "urandom_min_reseed_secs",
1698                 .data           = &sysctl_random_min_urandom_seed,
1699                 .maxlen         = sizeof(int),
1700                 .mode           = 0644,
1701                 .proc_handler   = proc_do_rointvec,
1702         },
1703         {
1704                 .procname       = "boot_id",
1705                 .data           = &sysctl_bootid,
1706                 .mode           = 0444,
1707                 .proc_handler   = proc_do_uuid,
1708         },
1709         {
1710                 .procname       = "uuid",
1711                 .mode           = 0444,
1712                 .proc_handler   = proc_do_uuid,
1713         },
1714         { }
1715 };
1716
1717 /*
1718  * rand_initialize() is called before sysctl_init(),
1719  * so we cannot call register_sysctl_init() in rand_initialize()
1720  */
1721 static int __init random_sysctls_init(void)
1722 {
1723         register_sysctl_init("kernel/random", random_table);
1724         return 0;
1725 }
1726 device_initcall(random_sysctls_init);
1727 #endif