1 /* $OpenBSD: getentropy_linux.c,v 1.41 2015/09/11 11:52:55 deraadt Exp $ */
4 * Copyright (c) 2014 Theo de Raadt <deraadt@openbsd.org>
5 * Copyright (c) 2014 Bob Beck <beck@obtuse.com>
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 * Emulation of getentropy(2) as documented at:
20 * http://www.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man2/getentropy.2
23 #define _POSIX_C_SOURCE 199309L
25 #include <sys/types.h>
26 #include <sys/param.h>
27 #include <sys/ioctl.h>
28 #include <sys/resource.h>
29 #include <sys/syscall.h>
31 #include <linux/sysctl.h>
33 #include <sys/statvfs.h>
34 #include <sys/socket.h>
35 #include <sys/mount.h>
50 #include <openssl/sha.h>
52 #include <linux/types.h>
53 #include <linux/random.h>
60 #define min(a, b) (((a) < (b)) ? (a) : (b))
70 #define HR(x, l) (SHA512_Update(&ctx, (char *)(x), (l)))
71 #define HD(x) (SHA512_Update(&ctx, (char *)&(x), sizeof (x)))
72 #define HF(x) (SHA512_Update(&ctx, (char *)&(x), sizeof (void*)))
74 int getentropy(void *buf, size_t len);
76 static int gotdata(char *buf, size_t len);
78 static int getentropy_getrandom(void *buf, size_t len);
80 static int getentropy_urandom(void *buf, size_t len);
82 static int getentropy_sysctl(void *buf, size_t len);
84 static int getentropy_fallback(void *buf, size_t len);
85 static int getentropy_phdr(struct dl_phdr_info *info, size_t size, void *data);
88 getentropy(void *buf, size_t len)
99 * Try descriptor-less getrandom()
101 ret = getentropy_getrandom(buf, len);
109 * Try to get entropy with /dev/urandom
111 * This can fail if the process is inside a chroot or if file
112 * descriptors are exhausted.
114 ret = getentropy_urandom(buf, len);
120 * Try to use sysctl CTL_KERN, KERN_RANDOM, RANDOM_UUID.
121 * sysctl is a failsafe API, so it guarantees a result. This
122 * should work inside a chroot, or when file descriptors are
125 * However this can fail if the Linux kernel removes support
126 * for sysctl. Starting in 2007, there have been efforts to
127 * deprecate the sysctl API/ABI, and push callers towards use
128 * of the chroot-unavailable fd-using /proc mechanism --
129 * essentially the same problems as /dev/urandom.
131 * Numerous setbacks have been encountered in their deprecation
132 * schedule, so as of June 2014 the kernel ABI still exists on
133 * most Linux architectures. The sysctl() stub in libc is missing
134 * on some systems. There are also reports that some kernels
135 * spew messages to the console.
137 ret = getentropy_sysctl(buf, len);
140 #endif /* SYS__sysctl */
143 * Entropy collection via /dev/urandom and sysctl have failed.
145 * No other API exists for collecting entropy. See the large
146 * comment block above.
148 * We have very few options:
149 * - Even syslog_r is unsafe to call at this low level, so
150 * there is no way to alert the user or program.
151 * - Cannot call abort() because some systems have unsafe
153 * - Could raise(SIGKILL) resulting in silent program termination.
154 * - Return EIO, to hint that arc4random's stir function
155 * should raise(SIGKILL)
156 * - Do the best under the circumstances....
158 * This code path exists to bring light to the issue that Linux
159 * does not provide a failsafe API for entropy collection.
161 * We hope this demonstrates that Linux should either retain their
162 * sysctl ABI, or consider providing a new failsafe API which
163 * works in a chroot or when file descriptors are exhausted.
165 #undef FAIL_INSTEAD_OF_TRYING_FALLBACK
166 #ifdef FAIL_INSTEAD_OF_TRYING_FALLBACK
169 ret = getentropy_fallback(buf, len);
178 * Basic sanity checking; wish we could do better.
181 gotdata(char *buf, size_t len)
186 for (i = 0; i < len; ++i)
195 getentropy_getrandom(void *buf, size_t len)
197 int pre_errno = errno;
202 ret = syscall(SYS_getrandom, buf, len, 0);
203 } while (ret == -1 && errno == EINTR);
213 getentropy_urandom(void *buf, size_t len)
218 int save_errno = errno;
229 fd = open("/dev/urandom", flags, 0);
236 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
239 /* Lightly verify that the device node looks sane */
240 if (fstat(fd, &st) == -1 || !S_ISCHR(st.st_mode)) {
244 if (ioctl(fd, RNDGETENTCNT, &cnt) == -1) {
248 for (i = 0; i < len; ) {
249 size_t wanted = len - i;
250 ssize_t ret = read(fd, (char *)buf + i, wanted);
253 if (errno == EAGAIN || errno == EINTR)
261 if (gotdata(buf, len) == 0) {
263 return (0); /* satisfied */
272 getentropy_sysctl(void *buf, size_t len)
274 static int mib[] = { CTL_KERN, KERN_RANDOM, RANDOM_UUID };
276 int save_errno = errno;
278 for (i = 0; i < len; ) {
279 size_t chunk = min(len - i, 16);
281 /* SYS__sysctl because some systems already removed sysctl() */
282 struct __sysctl_args args = {
285 .oldval = (char *)buf + i,
288 if (syscall(SYS__sysctl, &args) != 0)
292 if (gotdata(buf, len) == 0) {
294 return (0); /* satisfied */
300 #endif /* SYS__sysctl */
302 static const int cl[] = {
304 #ifdef CLOCK_MONOTONIC
307 #ifdef CLOCK_MONOTONIC_RAW
319 #ifdef CLOCK_PROCESS_CPUTIME_ID
320 CLOCK_PROCESS_CPUTIME_ID,
322 #ifdef CLOCK_THREAD_CPUTIME_ID
323 CLOCK_THREAD_CPUTIME_ID,
328 getentropy_phdr(struct dl_phdr_info *info, size_t size, void *data)
330 SHA512_CTX *ctx = data;
332 SHA512_Update(ctx, &info->dlpi_addr, sizeof (info->dlpi_addr));
337 getentropy_fallback(void *buf, size_t len)
339 uint8_t results[SHA512_DIGEST_LENGTH];
340 int save_errno = errno, e, pgs = getpagesize(), faster = 0, repeat;
348 static pid_t lastpid;
354 if (lastpid == pid) {
362 for (i = 0; i < len; ) {
365 for (j = 0; j < repeat; j++) {
366 HX((e = gettimeofday(&tv, NULL)) == -1, tv);
368 cnt += (int)tv.tv_sec;
369 cnt += (int)tv.tv_usec;
372 dl_iterate_phdr(getentropy_phdr, &ctx);
374 for (ii = 0; ii < sizeof(cl)/sizeof(cl[0]); ii++)
375 HX(clock_gettime(cl[ii], &ts) == -1, ts);
377 HX((pid = getpid()) == -1, pid);
378 HX((pid = getsid(pid)) == -1, pid);
379 HX((pid = getppid()) == -1, pid);
380 HX((pid = getpgid(0)) == -1, pid);
381 HX((e = getpriority(0, 0)) == -1, e);
386 (void) nanosleep(&ts, NULL);
389 HX(sigpending(&sigset) == -1, sigset);
390 HX(sigprocmask(SIG_BLOCK, NULL, &sigset) == -1,
393 HF(getentropy); /* an addr in this library */
394 HF(printf); /* an addr in libc */
396 HD(p); /* an addr on stack */
398 HD(p); /* the addr of errno */
401 struct sockaddr_storage ss;
402 struct statvfs stvfs;
409 * Prime-sized mappings encourage fragmentation;
410 * thus exposing some address entropy.
416 { 17, MAP_FAILED }, { 3, MAP_FAILED },
417 { 11, MAP_FAILED }, { 2, MAP_FAILED },
418 { 5, MAP_FAILED }, { 3, MAP_FAILED },
419 { 7, MAP_FAILED }, { 1, MAP_FAILED },
420 { 57, MAP_FAILED }, { 3, MAP_FAILED },
421 { 131, MAP_FAILED }, { 1, MAP_FAILED },
424 for (m = 0; m < sizeof mm/sizeof(mm[0]); m++) {
425 HX(mm[m].p = mmap(NULL,
427 PROT_READ|PROT_WRITE,
428 MAP_PRIVATE|MAP_ANON, -1,
430 if (mm[m].p != MAP_FAILED) {
433 /* Touch some memory... */
436 (mm[m].npg * pgs - 1);
438 cnt += (int)((long)(mm[m].p)
442 /* Check cnts and times... */
443 for (ii = 0; ii < sizeof(cl)/sizeof(cl[0]);
445 HX((e = clock_gettime(cl[ii],
448 cnt += (int)ts.tv_nsec;
451 HX((e = getrusage(RUSAGE_SELF,
454 cnt += (int)ru.ru_utime.tv_sec;
455 cnt += (int)ru.ru_utime.tv_usec;
459 for (m = 0; m < sizeof mm/sizeof(mm[0]); m++) {
460 if (mm[m].p != MAP_FAILED)
461 munmap(mm[m].p, mm[m].npg * pgs);
462 mm[m].p = MAP_FAILED;
465 HX(stat(".", &st) == -1, st);
466 HX(statvfs(".", &stvfs) == -1, stvfs);
467 HX(statfs(".", &stfs) == -1, stfs);
469 HX(stat("/", &st) == -1, st);
470 HX(statvfs("/", &stvfs) == -1, stvfs);
471 HX(statfs("/", &stfs) == -1, stfs);
473 HX((e = fstat(0, &st)) == -1, st);
475 if (S_ISREG(st.st_mode) ||
476 S_ISFIFO(st.st_mode) ||
477 S_ISSOCK(st.st_mode)) {
478 HX(fstatvfs(0, &stvfs) == -1,
480 HX(fstatfs(0, &stfs) == -1,
482 HX((off = lseek(0, (off_t)0,
483 SEEK_CUR)) < 0, off);
485 if (S_ISCHR(st.st_mode)) {
486 HX(tcgetattr(0, &tios) == -1,
488 } else if (S_ISSOCK(st.st_mode)) {
489 memset(&ss, 0, sizeof ss);
492 (void *)&ss, &ssl) == -1,
497 HX((e = getrusage(RUSAGE_CHILDREN,
500 cnt += (int)ru.ru_utime.tv_sec;
501 cnt += (int)ru.ru_utime.tv_usec;
504 /* Subsequent hashes absorb previous result */
508 HX((e = gettimeofday(&tv, NULL)) == -1, tv);
510 cnt += (int)tv.tv_sec;
511 cnt += (int)tv.tv_usec;
516 #ifdef HAVE_GETAUXVAL
518 /* Not as random as you think but we take what we are given */
519 p = (char *) getauxval(AT_RANDOM);
523 #ifdef AT_SYSINFO_EHDR
524 p = (char *) getauxval(AT_SYSINFO_EHDR);
529 p = (char *) getauxval(AT_BASE);
535 SHA512_Final(results, &ctx);
536 memcpy((char *)buf + i, results, min(sizeof(results), len - i));
537 i += min(sizeof(results), len - i);
539 explicit_bzero(&ctx, sizeof ctx);
540 explicit_bzero(results, sizeof results);
541 if (gotdata(buf, len) == 0) {
543 return (0); /* satisfied */