crypto/rand/rand_unix.c

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #define _GNU_SOURCE
  11 #include "e_os.h"
  12 #include <stdio.h>
  13 #include "internal/cryptlib.h"
  14 #include <openssl/rand.h>
  15 #include "rand_lcl.h"
  16 #include "internal/rand_int.h"
  17 #include <stdio.h>
  18 #include "internal/dso.h"
  19 #if defined(__linux)
  20 # include <sys/syscall.h>
  21 #endif
  22 #if defined(__FreeBSD__)
  23 # include <sys/types.h>
  24 # include <sys/sysctl.h>
  25 # include <sys/param.h>
  26 #endif
  27 #if defined(__OpenBSD__) || defined(__NetBSD__)
  28 # include <sys/param.h>
  29 #endif
  30 #ifdef OPENSSL_SYS_UNIX
  31 # include <sys/types.h>
  32 # include <unistd.h>
  33 # include <sys/time.h>
  34
  35 static uint64_t get_time_stamp(void);
  36 static uint64_t get_timer_bits(void);
  37
  38 /* Macro to convert two thirty two bit values into a sixty four bit one */
  39 # define TWO32TO64(a, b) ((((uint64_t)(a)) << 32) + (b))
  40
  41 /*
  42  * Check for the existence and support of POSIX timers.  The standard
  43  * says that the _POSIX_TIMERS macro will have a positive value if they
  44  * are available.
  45  *
  46  * However, we want an additional constraint: that the timer support does
  47  * not require an extra library dependency.  Early versions of glibc
  48  * require -lrt to be specified on the link line to access the timers,
  49  * so this needs to be checked for.
  50  *
  51  * It is worse because some libraries define __GLIBC__ but don't
  52  * support the version testing macro (e.g. uClibc).  This means
  53  * an extra check is needed.
  54  *
  55  * The final condition is:
  56  *      "have posix timers and either not glibc or glibc without -lrt"
  57  *
  58  * The nested #if sequences are required to avoid using a parameterised
  59  * macro that might be undefined.
  60  */
  61 # undef OSSL_POSIX_TIMER_OKAY
  62 # if defined(_POSIX_TIMERS) && _POSIX_TIMERS > 0
  63 #  if defined(__GLIBC__)
  64 #   if defined(__GLIBC_PREREQ)
  65 #    if __GLIBC_PREREQ(2, 17)
  66 #     define OSSL_POSIX_TIMER_OKAY
  67 #    endif
  68 #   endif
  69 #  else
  70 #   define OSSL_POSIX_TIMER_OKAY
  71 #  endif
  72 # endif
  73 #endif
  74
  75 int syscall_random(void *buf, size_t buflen);
  76
  77 #if (defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_UEFI)) && \
  78         !defined(OPENSSL_RAND_SEED_NONE)
  79 # error "UEFI and VXWorks only support seeding NONE"
  80 #endif
  81
  82 #if !(defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32) \
  83     || defined(OPENSSL_SYS_VMS) || defined(OPENSSL_SYS_VXWORKS) \
  84     || defined(OPENSSL_SYS_UEFI))
  85
  86 # if defined(OPENSSL_SYS_VOS)
  87
  88 #  ifndef OPENSSL_RAND_SEED_OS
  89 #   error "Unsupported seeding method configured; must be os"
  90 #  endif
  91
  92 #  if defined(OPENSSL_SYS_VOS_HPPA) && defined(OPENSSL_SYS_VOS_IA32)
  93 #   error "Unsupported HP-PA and IA32 at the same time."
  94 #  endif
  95 #  if !defined(OPENSSL_SYS_VOS_HPPA) && !defined(OPENSSL_SYS_VOS_IA32)
  96 #   error "Must have one of HP-PA or IA32"
  97 #  endif
  98
  99 /*
 100  * The following algorithm repeatedly samples the real-time clock (RTC) to
 101  * generate a sequence of unpredictable data.  The algorithm relies upon the
 102  * uneven execution speed of the code (due to factors such as cache misses,
 103  * interrupts, bus activity, and scheduling) and upon the rather large
 104  * relative difference between the speed of the clock and the rate at which
 105  * it can be read.  If it is ported to an environment where execution speed
 106  * is more constant or where the RTC ticks at a much slower rate, or the
 107  * clock can be read with fewer instructions, it is likely that the results
 108  * would be far more predictable.  This should only be used for legacy
 109  * platforms.
 110  *
 111  * As a precaution, we assume only 2 bits of entropy per byte.
 112  */
 113 size_t rand_pool_acquire_entropy(RAND_POOL *pool)
 114 {
 115     short int code;
 116     int i, k;
 117     size_t bytes_needed;
 118     struct timespec ts;
 119     unsigned char v;
 120 #  ifdef OPENSSL_SYS_VOS_HPPA
 121     long duration;
 122     extern void s$sleep(long *_duration, short int *_code);
 123 #  else
 124     long long duration;
 125     extern void s$sleep2(long long *_duration, short int *_code);
 126 #  endif
 127
 128     bytes_needed = rand_pool_bytes_needed(pool, 4 /*entropy_factor*/);
 129
 130     for (i = 0; i < bytes_needed; i++) {
 131         /*
 132          * burn some cpu; hope for interrupts, cache collisions, bus
 133          * interference, etc.
 134          */
 135         for (k = 0; k < 99; k++)
 136             ts.tv_nsec = random();
 137
 138 #  ifdef OPENSSL_SYS_VOS_HPPA
 139         /* sleep for 1/1024 of a second (976 us).  */
 140         duration = 1;
 141         s$sleep(&duration, &code);
 142 #  else
 143         /* sleep for 1/65536 of a second (15 us).  */
 144         duration = 1;
 145         s$sleep2(&duration, &code);
 146 #  endif
 147
 148         /* Get wall clock time, take 8 bits. */
 149         clock_gettime(CLOCK_REALTIME, &ts);
 150         v = (unsigned char)(ts.tv_nsec & 0xFF);
 151         rand_pool_add(pool, arg, &v, sizeof(v) , 2);
 152     }
 153     return rand_pool_entropy_available(pool);
 154 }
 155
 156 # else
 157
 158 #  if defined(OPENSSL_RAND_SEED_EGD) && \
 159         (defined(OPENSSL_NO_EGD) || !defined(DEVRANDOM_EGD))
 160 #   error "Seeding uses EGD but EGD is turned off or no device given"
 161 #  endif
 162
 163 #  if defined(OPENSSL_RAND_SEED_DEVRANDOM) && !defined(DEVRANDOM)
 164 #   error "Seeding uses urandom but DEVRANDOM is not configured"
 165 #  endif
 166
 167 #  if defined(OPENSSL_RAND_SEED_OS)
 168 #   if !defined(DEVRANDOM)
 169 #    error "OS seeding requires DEVRANDOM to be configured"
 170 #   endif
 171 #   define OPENSSL_RAND_SEED_GETRANDOM
 172 #   define OPENSSL_RAND_SEED_DEVRANDOM
 173 #  endif
 174
 175 #  if defined(OPENSSL_RAND_SEED_LIBRANDOM)
 176 #   error "librandom not (yet) supported"
 177 #  endif
 178
 179 #  if (defined(__FreeBSD__) || defined(__NetBSD__)) && defined(KERN_ARND)
 180 /*
 181  * sysctl_random(): Use sysctl() to read a random number from the kernel
 182  * Returns the size on success, 0 on failure.
 183  */
 184 static size_t sysctl_random(char *buf, size_t buflen)
 185 {
 186     int mib[2];
 187     size_t done = 0;
 188     size_t len;
 189
 190     /*
 191      * On FreeBSD old implementations returned longs, newer versions support
 192      * variable sizes up to 256 byte. The code below would not work properly
 193      * when the sysctl returns long and we want to request something not a
 194      * multiple of longs, which should never be the case.
 195      */
 196     if (!ossl_assert(buflen % sizeof(long) == 0))
 197         return 0;
 198
 199     /*
 200      * On NetBSD before 4.0 KERN_ARND was an alias for KERN_URND, and only
 201      * filled in an int, leaving the rest uninitialized. Since NetBSD 4.0
 202      * it returns a variable number of bytes with the current version supporting
 203      * up to 256 bytes.
 204      * Just return an error on older NetBSD versions.
 205      */
 206 #if   defined(__NetBSD__) && __NetBSD_Version__ < 400000000
 207     return 0;
 208 #endif
 209
 210     mib[0] = CTL_KERN;
 211     mib[1] = KERN_ARND;
 212
 213     do {
 214         len = buflen;
 215         if (sysctl(mib, 2, buf, &len, NULL, 0) == -1)
 216             return done;
 217         done += len;
 218         buf += len;
 219         buflen -= len;
 220     } while (buflen > 0);
 221
 222     return done;
 223 }
 224 #  endif
 225
 226 /*
 227  * syscall_random(): Try to get random data using a system call
 228  * returns the number of bytes returned in buf, or <= 0 on error.
 229  */
 230 int syscall_random(void *buf, size_t buflen)
 231 {
 232     /*
 233      * Do runtime detection to find getentropy().
 234      *
 235      * Known OSs that should support this:
 236      * - Darwin since 16 (OSX 10.12, IOS 10.0).
 237      * - Solaris since 11.3
 238      * - OpenBSD since 5.6
 239      * - Linux since 3.17 with glibc 2.25
 240      * - FreeBSD since 12.0 (1200061)
 241      */
 242 #  if defined(__GNUC__) && __GNUC__>=2 && defined(__ELF__)
 243     extern int getentropy(void *bufer, size_t length) __attribute__((weak));
 244
 245     if (getentropy != NULL)
 246         return getentropy(buf, buflen) == 0 ? buflen : 0;
 247 #  else
 248     union {
 249         void *p;
 250         int (*f)(void *buffer, size_t length);
 251     } p_getentropy;
 252
 253     /*
 254      * We could cache the result of the lookup, but we normally don't
 255      * call this function often.
 256      */
 257     ERR_set_mark();
 258     p_getentropy.p = DSO_global_lookup("getentropy");
 259     ERR_pop_to_mark();
 260     if (p_getentropy.p != NULL)
 261         return p_getentropy.f(buf, buflen) == 0 ? buflen : 0;
 262 #  endif
 263
 264     /* Linux supports this since version 3.17 */
 265 #  if defined(__linux) && defined(SYS_getrandom)
 266     return (int)syscall(SYS_getrandom, buf, buflen, 0);
 267 #  endif
 268
 269 #  if (defined(__FreeBSD__) || defined(__NetBSD__)) && defined(KERN_ARND)
 270     return (int)sysctl_random(buf, buflen);
 271 #  endif
 272
 273     return -1;
 274 }
 275
 276 /*
 277  * Try the various seeding methods in turn, exit when successful.
 278  *
 279  * TODO(DRBG): If more than one entropy source is available, is it
 280  * preferable to stop as soon as enough entropy has been collected
 281  * (as favored by @rsalz) or should one rather be defensive and add
 282  * more entropy than requested and/or from different sources?
 283  *
 284  * Currently, the user can select multiple entropy sources in the
 285  * configure step, yet in practice only the first available source
 286  * will be used. A more flexible solution has been requested, but
 287  * currently it is not clear how this can be achieved without
 288  * overengineering the problem. There are many parameters which
 289  * could be taken into account when selecting the order and amount
 290  * of input from the different entropy sources (trust, quality,
 291  * possibility of blocking).
 292  */
 293 size_t rand_pool_acquire_entropy(RAND_POOL *pool)
 294 {
 295 #  ifdef OPENSSL_RAND_SEED_NONE
 296     return rand_pool_entropy_available(pool);
 297 #  else
 298     size_t bytes_needed;
 299     size_t entropy_available = 0;
 300     unsigned char *buffer;
 301
 302 #   ifdef OPENSSL_RAND_SEED_GETRANDOM
 303     bytes_needed = rand_pool_bytes_needed(pool, 1 /*entropy_factor*/);
 304     buffer = rand_pool_add_begin(pool, bytes_needed);
 305     if (buffer != NULL) {
 306         size_t bytes = 0;
 307
 308         if (syscall_random(buffer, bytes_needed) == (int)bytes_needed)
 309             bytes = bytes_needed;
 310
 311         rand_pool_add_end(pool, bytes, 8 * bytes);
 312         entropy_available = rand_pool_entropy_available(pool);
 313     }
 314     if (entropy_available > 0)
 315         return entropy_available;
 316 #   endif
 317
 318 #   if defined(OPENSSL_RAND_SEED_LIBRANDOM)
 319     {
 320         /* Not yet implemented. */
 321     }
 322 #   endif
 323
 324 #   ifdef OPENSSL_RAND_SEED_DEVRANDOM
 325     bytes_needed = rand_pool_bytes_needed(pool, 1 /*entropy_factor*/);
 326     if (bytes_needed > 0) {
 327         static const char *paths[] = { DEVRANDOM, NULL };
 328         FILE *fp;
 329         int i;
 330
 331         for (i = 0; paths[i] != NULL; i++) {
 332             if ((fp = fopen(paths[i], "rb")) == NULL)
 333                 continue;
 334             setbuf(fp, NULL);
 335             buffer = rand_pool_add_begin(pool, bytes_needed);
 336             if (buffer != NULL) {
 337                 size_t bytes = 0;
 338                 if (fread(buffer, 1, bytes_needed, fp) == bytes_needed)
 339                     bytes = bytes_needed;
 340
 341                 rand_pool_add_end(pool, bytes, 8 * bytes);
 342                 entropy_available = rand_pool_entropy_available(pool);
 343             }
 344             fclose(fp);
 345             if (entropy_available > 0)
 346                 return entropy_available;
 347
 348             bytes_needed = rand_pool_bytes_needed(pool, 1 /*entropy_factor*/);
 349         }
 350     }
 351 #   endif
 352
 353 #   ifdef OPENSSL_RAND_SEED_RDTSC
 354     entropy_available = rand_acquire_entropy_from_tsc(pool);
 355     if (entropy_available > 0)
 356         return entropy_available;
 357 #   endif
 358
 359 #   ifdef OPENSSL_RAND_SEED_RDCPU
 360     entropy_available = rand_acquire_entropy_from_cpu(pool);
 361     if (entropy_available > 0)
 362         return entropy_available;
 363 #   endif
 364
 365 #   ifdef OPENSSL_RAND_SEED_EGD
 366     bytes_needed = rand_pool_bytes_needed(pool, 1 /*entropy_factor*/);
 367     if (bytes_needed > 0) {
 368         static const char *paths[] = { DEVRANDOM_EGD, NULL };
 369         int i;
 370
 371         for (i = 0; paths[i] != NULL; i++) {
 372             buffer = rand_pool_add_begin(pool, bytes_needed);
 373             if (buffer != NULL) {
 374                 size_t bytes = 0;
 375                 int num = RAND_query_egd_bytes(paths[i],
 376                                                buffer, (int)bytes_needed);
 377                 if (num == (int)bytes_needed)
 378                     bytes = bytes_needed;
 379
 380                 rand_pool_add_end(pool, bytes, 8 * bytes);
 381                 entropy_available = rand_pool_entropy_available(pool);
 382             }
 383             if (entropy_available > 0)
 384                 return entropy_available;
 385         }
 386     }
 387 #   endif
 388
 389     return rand_pool_entropy_available(pool);
 390 #  endif
 391 }
 392 # endif
 393 #endif
 394
 395 #ifdef OPENSSL_SYS_UNIX
 396 int rand_pool_add_nonce_data(RAND_POOL *pool)
 397 {
 398     struct {
 399         pid_t pid;
 400         CRYPTO_THREAD_ID tid;
 401         uint64_t time;
 402     } data = { 0 };
 403
 404     /*
 405      * Add process id, thread id, and a high resolution timestamp to
 406      * ensure that the nonce is unique whith high probability for
 407      * different process instances.
 408      */
 409     data.pid = getpid();
 410     data.tid = CRYPTO_THREAD_get_current_id();
 411     data.time = get_time_stamp();
 412
 413     return rand_pool_add(pool, (unsigned char *)&data, sizeof(data), 0);
 414 }
 415
 416 int rand_pool_add_additional_data(RAND_POOL *pool)
 417 {
 418     struct {
 419         CRYPTO_THREAD_ID tid;
 420         uint64_t time;
 421     } data = { 0 };
 422
 423     /*
 424      * Add some noise from the thread id and a high resolution timer.
 425      * The thread id adds a little randomness if the drbg is accessed
 426      * concurrently (which is the case for the <master> drbg).
 427      */
 428     data.tid = CRYPTO_THREAD_get_current_id();
 429     data.time = get_timer_bits();
 430
 431     return rand_pool_add(pool, (unsigned char *)&data, sizeof(data), 0);
 432 }
 433
 434
 435
 436 /*
 437  * Get the current time with the highest possible resolution
 438  *
 439  * The time stamp is added to the nonce, so it is optimized for not repeating.
 440  * The current time is ideal for this purpose, provided the computer's clock
 441  * is synchronized.
 442  */
 443 static uint64_t get_time_stamp(void)
 444 {
 445 # if defined(OSSL_POSIX_TIMER_OKAY)
 446     {
 447         struct timespec ts;
 448
 449         if (clock_gettime(CLOCK_REALTIME, &ts) == 0)
 450             return TWO32TO64(ts.tv_sec, ts.tv_nsec);
 451     }
 452 # endif
 453 # if defined(__unix__) \
 454      || (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 200112L)
 455     {
 456         struct timeval tv;
 457
 458         if (gettimeofday(&tv, NULL) == 0)
 459             return TWO32TO64(tv.tv_sec, tv.tv_usec);
 460     }
 461 # endif
 462     return time(NULL);
 463 }
 464
 465 /*
 466  * Get an arbitrary timer value of the highest possible resolution
 467  *
 468  * The timer value is added as random noise to the additional data,
 469  * which is not considered a trusted entropy sourec, so any result
 470  * is acceptable.
 471  */
 472 static uint64_t get_timer_bits(void)
 473 {
 474     uint64_t res = OPENSSL_rdtsc();
 475
 476     if (res != 0)
 477         return res;
 478
 479 # if defined(__sun) || defined(__hpux)
 480     return gethrtime();
 481 # elif defined(_AIX)
 482     {
 483         timebasestruct_t t;
 484
 485         read_wall_time(&t, TIMEBASE_SZ);
 486         return TWO32TO64(t.tb_high, t.tb_low);
 487     }
 488 # elif defined(OSSL_POSIX_TIMER_OKAY)
 489     {
 490         struct timespec ts;
 491
 492 #  ifdef CLOCK_BOOTTIME
 493 #   define CLOCK_TYPE CLOCK_BOOTTIME
 494 #  elif defined(_POSIX_MONOTONIC_CLOCK)
 495 #   define CLOCK_TYPE CLOCK_MONOTONIC
 496 #  else
 497 #   define CLOCK_TYPE CLOCK_REALTIME
 498 #  endif
 499
 500         if (clock_gettime(CLOCK_TYPE, &ts) == 0)
 501             return TWO32TO64(ts.tv_sec, ts.tv_nsec);
 502     }
 503 # endif
 504 # if defined(__unix__) \
 505      || (defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE >= 200112L)
 506     {
 507         struct timeval tv;
 508
 509         if (gettimeofday(&tv, NULL) == 0)
 510             return TWO32TO64(tv.tv_sec, tv.tv_usec);
 511     }
 512 # endif
 513     return time(NULL);
 514 }
 515 #endif