src/basic/random-util.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2
   3 #if defined(__i386__) || defined(__x86_64__)
   4 #include <cpuid.h>
   5 #endif
   6
   7 #include <elf.h>
   8 #include <errno.h>
   9 #include <fcntl.h>
  10 #include <stdbool.h>
  11 #include <stdint.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <sys/time.h>
  15
  16 #if HAVE_SYS_AUXV_H
  17 #  include <sys/auxv.h>
  18 #endif
  19
  20 #if USE_SYS_RANDOM_H
  21 #  include <sys/random.h>
  22 #else
  23 #  include <linux/random.h>
  24 #endif
  25
  26 #include "fd-util.h"
  27 #include "io-util.h"
  28 #include "missing.h"
  29 #include "random-util.h"
  30 #include "time-util.h"
  31
  32 #if HAS_FEATURE_MEMORY_SANITIZER
  33 #include <sanitizer/msan_interface.h>
  34 #endif
  35
  36 int rdrand(unsigned long *ret) {
  37
  38 #if defined(__i386__) || defined(__x86_64__)
  39         static int have_rdrand = -1;
  40         unsigned char err;
  41
  42         if (have_rdrand < 0) {
  43                 uint32_t eax, ebx, ecx, edx;
  44
  45                 /* Check if RDRAND is supported by the CPU */
  46                 if (__get_cpuid(1, &eax, &ebx, &ecx, &edx) == 0) {
  47                         have_rdrand = false;
  48                         return -EOPNOTSUPP;
  49                 }
  50
  51                 have_rdrand = !!(ecx & (1U << 30));
  52         }
  53
  54         if (have_rdrand == 0)
  55                 return -EOPNOTSUPP;
  56
  57         asm volatile("rdrand %0;"
  58                      "setc %1"
  59                      : "=r" (*ret),
  60                        "=qm" (err));
  61
  62 #if HAS_FEATURE_MEMORY_SANITIZER
  63         __msan_unpoison(&err, sizeof(err));
  64 #endif
  65
  66         if (!err)
  67                 return -EAGAIN;
  68
  69         return 0;
  70 #else
  71         return -EOPNOTSUPP;
  72 #endif
  73 }
  74
  75 int genuine_random_bytes(void *p, size_t n, RandomFlags flags) {
  76         static int have_syscall = -1;
  77         _cleanup_close_ int fd = -1;
  78         bool got_some = false;
  79         int r;
  80
  81         /* Gathers some randomness from the kernel (or the CPU if the RANDOM_ALLOW_RDRAND flag is set). This call won't
  82          * block, unless the RANDOM_BLOCK flag is set. If RANDOM_DONT_DRAIN is set, an error is returned if the random
  83          * pool is not initialized. Otherwise it will always return some data from the kernel, regardless of whether
  84          * the random pool is fully initialized or not. */
  85
  86         if (n == 0)
  87                 return 0;
  88
  89         if (FLAGS_SET(flags, RANDOM_ALLOW_RDRAND))
  90                 /* Try x86-64' RDRAND intrinsic if we have it. We only use it if high quality randomness is not
  91                  * required, as we don't trust it (who does?). Note that we only do a single iteration of RDRAND here,
  92                  * even though the Intel docs suggest calling this in a tight loop of 10 invocations or so. That's
  93                  * because we don't really care about the quality here. We generally prefer using RDRAND if the caller
  94                  * allows us too, since this way we won't drain the kernel randomness pool if we don't need it, as the
  95                  * pool's entropy is scarce. */
  96                 for (;;) {
  97                         unsigned long u;
  98                         size_t m;
  99
 100                         if (rdrand(&u) < 0) {
 101                                 if (got_some && FLAGS_SET(flags, RANDOM_EXTEND_WITH_PSEUDO)) {
 102                                         /* Fill in the remaining bytes using pseudo-random values */
 103                                         pseudo_random_bytes(p, n);
 104                                         return 0;
 105                                 }
 106
 107                                 /* OK, this didn't work, let's go to getrandom() + /dev/urandom instead */
 108                                 break;
 109                         }
 110
 111                         m = MIN(sizeof(u), n);
 112                         memcpy(p, &u, m);
 113
 114                         p = (uint8_t*) p + m;
 115                         n -= m;
 116
 117                         if (n == 0)
 118                                 return 0; /* Yay, success! */
 119
 120                         got_some = true;
 121                 }
 122
 123         /* Use the getrandom() syscall unless we know we don't have it. */
 124         if (have_syscall != 0 && !HAS_FEATURE_MEMORY_SANITIZER) {
 125
 126                 for (;;) {
 127                         r = getrandom(p, n, FLAGS_SET(flags, RANDOM_BLOCK) ? 0 : GRND_NONBLOCK);
 128                         if (r > 0) {
 129                                 have_syscall = true;
 130
 131                                 if ((size_t) r == n)
 132                                         return 0; /* Yay, success! */
 133
 134                                 assert((size_t) r < n);
 135                                 p = (uint8_t*) p + r;
 136                                 n -= r;
 137
 138                                 if (FLAGS_SET(flags, RANDOM_EXTEND_WITH_PSEUDO)) {
 139                                         /* Fill in the remaining bytes using pseudo-random values */
 140                                         pseudo_random_bytes(p, n);
 141                                         return 0;
 142                                 }
 143
 144                                 got_some = true;
 145
 146                                 /* Hmm, we didn't get enough good data but the caller insists on good data? Then try again */
 147                                 if (FLAGS_SET(flags, RANDOM_BLOCK))
 148                                         continue;
 149
 150                                 /* Fill in the rest with /dev/urandom */
 151                                 break;
 152
 153                         } else if (r == 0) {
 154                                 have_syscall = true;
 155                                 return -EIO;
 156
 157                         } else if (errno == ENOSYS) {
 158                                 /* We lack the syscall, continue with reading from /dev/urandom. */
 159                                 have_syscall = false;
 160                                 break;
 161
 162                         } else if (errno == EAGAIN) {
 163                                 /* The kernel has no entropy whatsoever. Let's remember to use the syscall the next
 164                                  * time again though.
 165                                  *
 166                                  * If RANDOM_DONT_DRAIN is set, return an error so that random_bytes() can produce some
 167                                  * pseudo-random bytes instead. Otherwise, fall back to /dev/urandom, which we know is empty,
 168                                  * but the kernel will produce some bytes for us on a best-effort basis. */
 169                                 have_syscall = true;
 170
 171                                 if (got_some && FLAGS_SET(flags, RANDOM_EXTEND_WITH_PSEUDO)) {
 172                                         /* Fill in the remaining bytes using pseudorandom values */
 173                                         pseudo_random_bytes(p, n);
 174                                         return 0;
 175                                 }
 176
 177                                 if (FLAGS_SET(flags, RANDOM_DONT_DRAIN))
 178                                         return -ENODATA;
 179
 180                                 /* Use /dev/urandom instead */
 181                                 break;
 182                         } else
 183                                 return -errno;
 184                 }
 185         }
 186
 187         fd = open("/dev/urandom", O_RDONLY|O_CLOEXEC|O_NOCTTY);
 188         if (fd < 0)
 189                 return errno == ENOENT ? -ENOSYS : -errno;
 190
 191         return loop_read_exact(fd, p, n, true);
 192 }
 193
 194 void initialize_srand(void) {
 195         static bool srand_called = false;
 196         unsigned x;
 197 #if HAVE_SYS_AUXV_H
 198         const void *auxv;
 199 #endif
 200         unsigned long k;
 201
 202         if (srand_called)
 203                 return;
 204
 205 #if HAVE_SYS_AUXV_H
 206         /* The kernel provides us with 16 bytes of entropy in auxv, so let's
 207          * try to make use of that to seed the pseudo-random generator. It's
 208          * better than nothing... */
 209
 210         auxv = (const void*) getauxval(AT_RANDOM);
 211         if (auxv) {
 212                 assert_cc(sizeof(x) <= 16);
 213                 memcpy(&x, auxv, sizeof(x));
 214         } else
 215 #endif
 216                 x = 0;
 217
 218         x ^= (unsigned) now(CLOCK_REALTIME);
 219         x ^= (unsigned) gettid();
 220
 221         if (rdrand(&k) >= 0)
 222                 x ^= (unsigned) k;
 223
 224         srand(x);
 225         srand_called = true;
 226 }
 227
 228 /* INT_MAX gives us only 31 bits, so use 24 out of that. */
 229 #if RAND_MAX >= INT_MAX
 230 #  define RAND_STEP 3
 231 #else
 232 /* SHORT_INT_MAX or lower gives at most 15 bits, we just just 8 out of that. */
 233 #  define RAND_STEP 1
 234 #endif
 235
 236 void pseudo_random_bytes(void *p, size_t n) {
 237         uint8_t *q;
 238
 239         initialize_srand();
 240
 241         for (q = p; q < (uint8_t*) p + n; q += RAND_STEP) {
 242                 unsigned rr;
 243
 244                 rr = (unsigned) rand();
 245
 246 #if RAND_STEP >= 3
 247                 if ((size_t) (q - (uint8_t*) p + 2) < n)
 248                         q[2] = rr >> 16;
 249 #endif
 250 #if RAND_STEP >= 2
 251                 if ((size_t) (q - (uint8_t*) p + 1) < n)
 252                         q[1] = rr >> 8;
 253 #endif
 254                 q[0] = rr;
 255         }
 256 }
 257
 258 void random_bytes(void *p, size_t n) {
 259
 260         if (genuine_random_bytes(p, n, RANDOM_EXTEND_WITH_PSEUDO|RANDOM_DONT_DRAIN|RANDOM_ALLOW_RDRAND) >= 0)
 261                 return;
 262
 263         /* If for some reason some user made /dev/urandom unavailable to us, or the kernel has no entropy, use a PRNG instead. */
 264         pseudo_random_bytes(p, n);
 265 }