granicus.if.org Git - sudo/blob - lib/util/getentropy.c

   1 /*
   2  * Copyright (c) 2014 Theo de Raadt <deraadt@openbsd.org>
   3  * Copyright (c) 2014 Bob Beck <beck@obtuse.com>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  *
  17  * Emulation of getentropy(2) as documented at:
  18  * http://man.openbsd.org/getentropy.2
  19  */
  20
  21 #include <config.h>
  22
  23 #ifndef HAVE_GETENTROPY
  24
  25 #include <sys/param.h>
  26 #include <sys/mman.h>
  27 #include <sys/resource.h>
  28 #include <sys/socket.h>
  29 #include <sys/stat.h>
  30 #ifdef HAVE_SYSCTL
  31 # include <sys/sysctl.h>
  32 #endif
  33 #ifdef HAVE_SYS_STATVFS_H
  34 # include <sys/statvfs.h>
  35 #endif
  36 #include <sys/stat.h>
  37 #include <sys/time.h>
  38 #ifdef HAVE_SYS_SYSCALL_H
  39 # include <sys/syscall.h>
  40 #endif
  41 #ifdef HAVE_LINUX_RANDOM_H
  42 # include <linux/types.h>
  43 # include <linux/random.h>
  44 #endif
  45 #include <errno.h>
  46 #include <fcntl.h>
  47 #include <signal.h>
  48 #include <stdio.h>
  49 #include <stdlib.h>
  50 #include <string.h>
  51 #include <termios.h>
  52 #include <time.h>
  53 #include <unistd.h>
  54 #if defined(HAVE_STDINT_H)
  55 # include <stdint.h>
  56 #elif defined(HAVE_INTTYPES_H)
  57 # include <inttypes.h>
  58 #endif
  59 #ifdef HAVE_GETAUXVAL
  60 # include <sys/auxv.h>
  61 #endif
  62 #ifdef HAVE_DL_ITERATE_PHDR
  63 # include <link.h>
  64 #endif
  65
  66 #include "sudo_compat.h"
  67 #include "sudo_digest.h"
  68 #include "sudo_rand.h"
  69
  70 #if !defined(MAP_ANON) && defined(MAP_ANONYMOUS)
  71 # define MAP_ANON MAP_ANONYMOUS
  72 #endif
  73
  74 #define REPEAT 5
  75 #define min(a, b) (((a) < (b)) ? (a) : (b))
  76
  77 #define HX(a, b) \
  78         do { \
  79                 if ((a)) \
  80                         HD(errno); \
  81                 else \
  82                         HD(b); \
  83         } while (0)
  84
  85 #define HR(x, l) (sudo_digest_update(ctx, (char *)(x), (l)))
  86 #define HD(x)    (sudo_digest_update(ctx, (char *)&(x), sizeof (x)))
  87 #define HF(x)    (sudo_digest_update(ctx, (char *)&(x), sizeof (void*)))
  88
  89 int     sudo_getentropy(void *buf, size_t len);
  90
  91 static int getentropy_getrandom(void *buf, size_t len);
  92 static int getentropy_sysctl(void *buf, size_t len);
  93 static int getentropy_urandom(void *buf, size_t len, const char *path,
  94     int devfscheck);
  95 static int getentropy_fallback(void *buf, size_t len);
  96 static int gotdata(char *buf, size_t len);
  97 #ifdef HAVE_DL_ITERATE_PHDR
  98 static int getentropy_phdr(struct dl_phdr_info *info, size_t size, void *data);
  99 #endif
 100
 101 int
 102 sudo_getentropy(void *buf, size_t len)
 103 {
 104         int ret = -1;
 105
 106         if (len > 256) {
 107                 errno = EIO;
 108                 return (-1);
 109         }
 110
 111         ret = getentropy_getrandom(buf, len);
 112         if (ret != -1)
 113                 return (ret);
 114
 115         ret = getentropy_sysctl(buf, len);
 116         if (ret != -1)
 117                 return (ret);
 118
 119         /*
 120          * Try to get entropy with /dev/urandom
 121          */
 122         ret = getentropy_urandom(buf, len, "/dev/urandom", 0);
 123         if (ret != -1)
 124                 return (ret);
 125
 126         /*
 127          * Entropy collection via /dev/urandom has failed.
 128          *
 129          * No other API exists for collecting entropy, and we have no
 130          * failsafe way to get it that is not sensitive to resource exhaustion.
 131          *
 132          * We have very few options:
 133          *     - Even syslog_r is unsafe to call at this low level, so
 134          *       there is no way to alert the user or program.
 135          *     - Cannot call abort() because some systems have unsafe
 136          *       corefiles.
 137          *     - Could raise(SIGKILL) resulting in silent program termination.
 138          *     - Return EIO, to hint that arc4random's stir function
 139          *       should raise(SIGKILL)
 140          *     - Do the best under the circumstances....
 141          *
 142          * This code path exists to bring light to the issue that the OS
 143          * does not provide a failsafe API for entropy collection.
 144          *
 145          * We hope this demonstrates that the OS should consider
 146          * providing a new failsafe API which works in a chroot or
 147          * when file descriptors are exhausted.
 148          */
 149 #undef FAIL_INSTEAD_OF_TRYING_FALLBACK
 150 #ifdef FAIL_INSTEAD_OF_TRYING_FALLBACK
 151         raise(SIGKILL);
 152 #endif
 153         ret = getentropy_fallback(buf, len);
 154         if (ret != -1)
 155                 return (ret);
 156
 157         errno = EIO;
 158         return (ret);
 159 }
 160
 161 /*
 162  * This is an open source non-commercial project. Dear PVS-Studio, please check it.
 163  * PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com
 164  */
 165
 166 /*
 167  * Basic sanity checking; wish we could do better.
 168  */
 169 static int
 170 gotdata(char *buf, size_t len)
 171 {
 172         char    any_set = 0;
 173         size_t  i;
 174
 175         for (i = 0; i < len; ++i)
 176                 any_set |= buf[i];
 177         if (any_set == 0)
 178                 return (-1);
 179         return (0);
 180 }
 181
 182 static int
 183 getentropy_urandom(void *buf, size_t len, const char *path, int devfscheck)
 184 {
 185         struct stat st;
 186         size_t i;
 187         int fd, flags;
 188         int save_errno = errno;
 189
 190 start:
 191
 192         /* We do not use O_NOFOLLOW since /dev/urandom is a link on Solaris. */
 193         flags = O_RDONLY;
 194 #ifdef O_CLOEXEC
 195         flags |= O_CLOEXEC;
 196 #endif
 197         fd = open(path, flags, 0);
 198         if (fd == -1) {
 199                 if (errno == EINTR)
 200                         goto start;
 201                 goto nodevrandom;
 202         }
 203 #ifndef O_CLOEXEC
 204         fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
 205 #endif
 206
 207         /* Lightly verify that the device node looks sane */
 208         if (fstat(fd, &st) == -1 || !S_ISCHR(st.st_mode)) {
 209                 close(fd);
 210                 goto nodevrandom;
 211         }
 212         for (i = 0; i < len; ) {
 213                 size_t wanted = len - i;
 214                 ssize_t ret = read(fd, (char *)buf + i, wanted);
 215
 216                 if (ret == -1) {
 217                         if (errno == EAGAIN || errno == EINTR)
 218                                 continue;
 219                         close(fd);
 220                         goto nodevrandom;
 221                 }
 222                 i += ret;
 223         }
 224         close(fd);
 225         if (gotdata(buf, len) == 0) {
 226                 errno = save_errno;
 227                 return (0);             /* satisfied */
 228         }
 229 nodevrandom:
 230         errno = EIO;
 231         return (-1);
 232 }
 233
 234 #if defined(HAVE_SYSCTL) && defined(KERN_ARND)
 235 static int
 236 getentropy_sysctl(void *buf, size_t len)
 237 {
 238         int save_errno = errno;
 239         int mib[2];
 240         size_t i;
 241
 242         mib[0] = CTL_KERN;
 243         mib[1] = KERN_ARND;
 244
 245         for (i = 0; i < len; ) {
 246                 size_t chunk = len - i;
 247
 248                 if (sysctl(mib, 2, (char *)buf + i, &chunk, NULL, 0) == -1)
 249                         goto sysctlfailed;
 250                 i += chunk;
 251         }
 252         if (gotdata(buf, len) == 0) {
 253                 errno = save_errno;
 254                 return (0);                     /* satisfied */
 255         }
 256 sysctlfailed:
 257         errno = EIO;
 258         return (-1);
 259 }
 260 #elif defined(SYS__sysctl) && defined(RANDOM_UUID)
 261 static int
 262 getentropy_sysctl(void *buf, size_t len)
 263 {
 264         static int mib[3];
 265         size_t i;
 266         int save_errno = errno;
 267
 268         mib[0] = CTL_KERN;
 269         mib[1] = KERN_RANDOM;
 270         mib[2] = RANDOM_UUID;
 271
 272         for (i = 0; i < len; ) {
 273                 size_t chunk = min(len - i, 16);
 274
 275                 /* SYS__sysctl because some systems already removed sysctl() */
 276                 struct __sysctl_args args = {
 277                         .name = mib,
 278                         .nlen = 3,
 279                         .oldval = (char *)buf + i,
 280                         .oldlenp = &chunk,
 281                 };
 282                 if (syscall(SYS__sysctl, &args) != 0)
 283                         goto sysctlfailed;
 284                 i += chunk;
 285         }
 286         if (gotdata(buf, len) == 0) {
 287                 errno = save_errno;
 288                 return (0);                     /* satisfied */
 289         }
 290 sysctlfailed:
 291         errno = EIO;
 292         return (-1);
 293 }
 294 #else
 295 static int
 296 getentropy_sysctl(void *buf, size_t len)
 297 {
 298         errno = ENOTSUP;
 299         return (-1);
 300 }
 301 #endif
 302
 303 #if defined(SYS_getrandom) && defined(GRND_NONBLOCK)
 304 static int
 305 getentropy_getrandom(void *buf, size_t len)
 306 {
 307         int pre_errno = errno;
 308         int ret;
 309
 310         /*
 311          * Try descriptor-less getrandom(), in non-blocking mode.
 312          *
 313          * The design of Linux getrandom is broken.  It has an
 314          * uninitialized phase coupled with blocking behaviour, which
 315          * is unacceptable from within a library at boot time without
 316          * possible recovery. See http://bugs.python.org/issue26839#msg267745
 317          */
 318         do {
 319                 ret = syscall(SYS_getrandom, buf, len, GRND_NONBLOCK);
 320         } while (ret == -1 && errno == EINTR);
 321
 322         if (ret < 0 || (size_t)ret != len)
 323                 return (-1);
 324         errno = pre_errno;
 325         return (0);
 326 }
 327 #else
 328 static int
 329 getentropy_getrandom(void *buf, size_t len)
 330 {
 331         errno = ENOTSUP;
 332         return (-1);
 333 }
 334 #endif
 335
 336 #ifdef HAVE_CLOCK_GETTIME
 337 static const int cl[] = {
 338         CLOCK_REALTIME,
 339 #ifdef CLOCK_MONOTONIC
 340         CLOCK_MONOTONIC,
 341 #endif
 342 #ifdef CLOCK_MONOTONIC_RAW
 343         CLOCK_MONOTONIC_RAW,
 344 #endif
 345 #ifdef CLOCK_TAI
 346         CLOCK_TAI,
 347 #endif
 348 #ifdef CLOCK_VIRTUAL
 349         CLOCK_VIRTUAL,
 350 #endif
 351 #ifdef CLOCK_UPTIME
 352         CLOCK_UPTIME,
 353 #endif
 354 #ifdef CLOCK_PROCESS_CPUTIME_ID
 355         CLOCK_PROCESS_CPUTIME_ID,
 356 #endif
 357 #ifdef CLOCK_THREAD_CPUTIME_ID
 358         CLOCK_THREAD_CPUTIME_ID,
 359 #endif
 360 };
 361 #endif /* HAVE_CLOCK_GETTIME */
 362
 363 #ifdef HAVE_DL_ITERATE_PHDR
 364 static int
 365 getentropy_phdr(struct dl_phdr_info *info, size_t size, void *data)
 366 {
 367         struct sudo_digest *ctx = data;
 368
 369         sudo_digest_update(ctx, &info->dlpi_addr, sizeof (info->dlpi_addr));
 370         return (0);
 371 }
 372 #endif
 373
 374 static int
 375 getentropy_fallback(void *buf, size_t len)
 376 {
 377         unsigned char *results = NULL;
 378         int save_errno = errno, e, pgs = sysconf(_SC_PAGESIZE), faster = 0, repeat;
 379         int ret = -1;
 380         static int cnt;
 381         struct timespec ts;
 382         struct timeval tv;
 383         struct rusage ru;
 384         sigset_t sigset;
 385         struct stat st;
 386         struct sudo_digest *ctx;
 387         static pid_t lastpid;
 388         pid_t pid;
 389         size_t i, ii, m, digest_len;
 390         char *p;
 391
 392         if ((ctx = sudo_digest_alloc(SUDO_DIGEST_SHA512)) == NULL)
 393                 goto done;
 394         digest_len = sudo_digest_getlen(SUDO_DIGEST_SHA512);
 395         if (digest_len == (size_t)-1 || (results = malloc(digest_len)) == NULL)
 396                 goto done;
 397
 398         pid = getpid();
 399         if (lastpid == pid) {
 400                 faster = 1;
 401                 repeat = 2;
 402         } else {
 403                 faster = 0;
 404                 lastpid = pid;
 405                 repeat = REPEAT;
 406         }
 407         for (i = 0; i < len; ) {
 408                 int j;
 409                 for (j = 0; j < repeat; j++) {
 410                         HX((e = gettimeofday(&tv, NULL)) == -1, tv);
 411                         if (e != -1) {
 412                                 cnt += (int)tv.tv_sec;
 413                                 cnt += (int)tv.tv_usec;
 414                         }
 415 #ifdef HAVE_DL_ITERATE_PHDR
 416                         dl_iterate_phdr(getentropy_phdr, ctx);
 417 #endif
 418
 419 #ifdef HAVE_CLOCK_GETTIME
 420                         for (ii = 0; ii < sizeof(cl)/sizeof(cl[0]); ii++)
 421                                 HX(clock_gettime(cl[ii], &ts) == -1, ts);
 422 #endif /* HAVE_CLOCK_GETTIME */
 423
 424                         HX((pid = getpid()) == -1, pid);
 425                         HX((pid = getsid(pid)) == -1, pid);
 426                         HX((pid = getppid()) == -1, pid);
 427                         HX((pid = getpgid(0)) == -1, pid);
 428                         HX((e = getpriority(0, 0)) == -1, e);
 429
 430                         if (!faster) {
 431                                 ts.tv_sec = 0;
 432                                 ts.tv_nsec = 1;
 433                                 (void) nanosleep(&ts, NULL);
 434                         }
 435
 436                         HX(sigpending(&sigset) == -1, sigset);
 437                         HX(sigprocmask(SIG_BLOCK, NULL, &sigset) == -1,
 438                             sigset);
 439
 440                         HF(sudo_getentropy);    /* an addr in this library */
 441                         HF(printf);             /* an addr in libc */
 442                         p = (char *)&p;
 443                         HD(p);          /* an addr on stack */
 444                         p = (char *)&errno;
 445                         HD(p);          /* the addr of errno */
 446
 447                         if (i == 0) {
 448 #ifdef HAVE_SYS_STATVFS_H
 449                                 struct statvfs stvfs;
 450 #endif
 451                                 struct termios tios;
 452                                 off_t off;
 453
 454                                 /*
 455                                  * Prime-sized mappings encourage fragmentation;
 456                                  * thus exposing some address entropy.
 457                                  */
 458                                 struct mm {
 459                                         size_t  npg;
 460                                         void    *p;
 461                                 } mm[] =         {
 462                                         { 17, MAP_FAILED }, { 3, MAP_FAILED },
 463                                         { 11, MAP_FAILED }, { 2, MAP_FAILED },
 464                                         { 5, MAP_FAILED }, { 3, MAP_FAILED },
 465                                         { 7, MAP_FAILED }, { 1, MAP_FAILED },
 466                                         { 57, MAP_FAILED }, { 3, MAP_FAILED },
 467                                         { 131, MAP_FAILED }, { 1, MAP_FAILED },
 468                                 };
 469
 470                                 for (m = 0; m < sizeof mm/sizeof(mm[0]); m++) {
 471                                         HX(mm[m].p = mmap(NULL,
 472                                             mm[m].npg * pgs,
 473                                             PROT_READ|PROT_WRITE,
 474                                             MAP_PRIVATE|MAP_ANON, -1,
 475                                             (off_t)0), mm[m].p);
 476                                         if (mm[m].p != MAP_FAILED) {
 477                                                 size_t mo;
 478
 479                                                 /* Touch some memory... */
 480                                                 p = mm[m].p;
 481                                                 mo = cnt %
 482                                                     (mm[m].npg * pgs - 1);
 483                                                 p[mo] = 1;
 484                                                 cnt += (int)((long)(mm[m].p)
 485                                                     / pgs);
 486                                         }
 487
 488                                         /* Check cnts and times... */
 489                                         for (ii = 0; ii < sizeof(cl)/sizeof(cl[0]);
 490                                             ii++) {
 491                                                 HX((e = clock_gettime(cl[ii],
 492                                                     &ts)) == -1, ts);
 493                                                 if (e != -1)
 494                                                         cnt += (int)ts.tv_nsec;
 495                                         }
 496
 497                                         HX((e = getrusage(RUSAGE_SELF,
 498                                             &ru)) == -1, ru);
 499                                         if (e != -1) {
 500                                                 cnt += (int)ru.ru_utime.tv_sec;
 501                                                 cnt += (int)ru.ru_utime.tv_usec;
 502                                         }
 503                                 }
 504
 505                                 for (m = 0; m < sizeof mm/sizeof(mm[0]); m++) {
 506                                         if (mm[m].p != MAP_FAILED)
 507                                                 munmap(mm[m].p, mm[m].npg * pgs);
 508                                         mm[m].p = MAP_FAILED;
 509                                 }
 510
 511                                 HX(stat(".", &st) == -1, st);
 512                                 HX(stat("/", &st) == -1, st);
 513
 514 #ifdef HAVE_SYS_STATVFS_H
 515                                 HX(statvfs(".", &stvfs) == -1, stvfs);
 516                                 HX(statvfs("/", &stvfs) == -1, stvfs);
 517 #endif
 518                                 HX((e = fstat(0, &st)) == -1, st);
 519                                 if (e == -1) {
 520                                         if (S_ISREG(st.st_mode) ||
 521                                             S_ISFIFO(st.st_mode) ||
 522                                             S_ISSOCK(st.st_mode)) {
 523 #ifdef HAVE_SYS_STATVFS_H
 524                                                 HX(fstatvfs(0, &stvfs) == -1,
 525                                                     stvfs);
 526 #endif
 527                                                 HX((off = lseek(0, (off_t)0,
 528                                                     SEEK_CUR)) < 0, off);
 529                                         }
 530                                         if (S_ISCHR(st.st_mode)) {
 531                                                 HX(tcgetattr(0, &tios) == -1,
 532                                                     tios);
 533 #if 0
 534                                         } else if (S_ISSOCK(st.st_mode)) {
 535                                                 struct sockaddr_storage ss;
 536                                                 socklen_t ssl;
 537                                                 memset(&ss, 0, sizeof ss);
 538                                                 ssl = sizeof(ss);
 539                                                 HX(getpeername(0,
 540                                                     (void *)&ss, &ssl) == -1,
 541                                                     ss);
 542 #endif
 543                                         }
 544                                 }
 545
 546                                 HX((e = getrusage(RUSAGE_CHILDREN,
 547                                     &ru)) == -1, ru);
 548                                 if (e != -1) {
 549                                         cnt += (int)ru.ru_utime.tv_sec;
 550                                         cnt += (int)ru.ru_utime.tv_usec;
 551                                 }
 552                         } else {
 553                                 /* Subsequent hashes absorb previous result */
 554                                 HR(results, digest_len);
 555                         }
 556
 557                         HX((e = gettimeofday(&tv, NULL)) == -1, tv);
 558                         if (e != -1) {
 559                                 cnt += (int)tv.tv_sec;
 560                                 cnt += (int)tv.tv_usec;
 561                         }
 562
 563                         HD(cnt);
 564                 }
 565
 566 #ifdef HAVE_GETAUXVAL
 567 #ifdef AT_RANDOM
 568                 /* Not as random as you think but we take what we are given */
 569                 p = (char *) getauxval(AT_RANDOM);
 570                 if (p)
 571                         HR(p, 16);
 572 #endif
 573 #ifdef AT_SYSINFO_EHDR
 574                 p = (char *) getauxval(AT_SYSINFO_EHDR);
 575                 if (p)
 576                         HR(p, pgs);
 577 #endif
 578 #ifdef AT_BASE
 579                 p = (char *) getauxval(AT_BASE);
 580                 if (p)
 581                         HD(p);
 582 #endif
 583 #endif /* HAVE_GETAUXVAL  */
 584
 585                 sudo_digest_final(ctx, results);
 586                 sudo_digest_reset(ctx);
 587                 memcpy((char *)buf + i, results, min(digest_len, len - i));
 588                 i += min(digest_len, len - i);
 589         }
 590         if (gotdata(buf, len) == 0) {
 591                 errno = save_errno;
 592                 ret = 0;                /* satisfied */
 593         } else {
 594                 errno = EIO;
 595         }
 596 done:
 597         sudo_digest_free(ctx);
 598         if (results != NULL) {
 599                 memset_s(results, sizeof(results), 0, sizeof(results));
 600                 free(results);
 601         }
 602         return (ret);
 603 }
 604
 605 #endif /* HAVE_GETENTROPY */