2 * Copyright (c) 2001-2002 Damien Miller. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <openssl/rand.h>
28 #include <openssl/sha.h>
29 #include <openssl/crypto.h>
31 /* SunOS 4.4.4 needs this */
32 #ifdef HAVE_FLOATINGPOINT_H
33 # include <floatingpoint.h>
34 #endif /* HAVE_FLOATINGPOINT_H */
39 #include "pathnames.h"
44 /* Number of bytes we write out */
45 #define OUTPUT_SEED_SIZE 48
47 /* Length of on-disk seedfiles */
48 #define SEED_FILE_SIZE 1024
50 /* Maximum number of command-line arguments to read from file */
53 /* Minimum number of usable commands to be considered sufficient */
54 #define MIN_ENTROPY_SOURCES 16
56 /* Path to on-disk seed file (relative to user's home directory */
57 #ifndef SSH_PRNG_SEED_FILE
58 # define SSH_PRNG_SEED_FILE _PATH_SSH_USER_DIR"/prng_seed"
61 /* Path to PRNG commands list */
62 #ifndef SSH_PRNG_COMMAND_FILE
63 # define SSH_PRNG_COMMAND_FILE SSHDIR "/ssh_prng_cmds"
67 #ifdef HAVE___PROGNAME
68 extern char *__progname;
74 # define offsetof(type, member) ((size_t) &((type *)0)->member)
77 #define WHITESPACE " \t\n"
80 # define RUSAGE_SELF 0
82 #ifndef RUSAGE_CHILDREN
83 # define RUSAGE_CHILDREN 0
86 #if !defined(PRNGD_SOCKET) && !defined(PRNGD_PORT)
87 # define USE_SEED_FILES
91 /* Proportion of data that is entropy */
93 /* Counter goes positive if this command times out */
95 /* Increases by factor of two each timeout */
96 unsigned int sticky_badness;
97 /* Path to executable */
99 /* argv to pass to executable */
100 char *args[NUM_ARGS]; /* XXX: arbitrary limit */
101 /* full command string (debug) */
105 /* slow command timeouts (all in milliseconds) */
106 /* static int entropy_timeout_default = ENTROPY_TIMEOUT_MSEC; */
107 static int entropy_timeout_current = ENTROPY_TIMEOUT_MSEC;
109 /* this is initialised from a file, by prng_read_commands() */
110 static entropy_cmd_t *entropy_cmds = NULL;
113 double stir_from_system(void);
114 double stir_from_programs(void);
115 double stir_gettimeofday(double entropy_estimate);
116 double stir_clock(double entropy_estimate);
117 double stir_rusage(int who, double entropy_estimate);
118 double hash_command_output(entropy_cmd_t *src, char *hash);
119 int get_random_bytes_prngd(unsigned char *buf, int len,
120 unsigned short tcp_port, char *socket_path);
123 * Collect 'len' bytes of entropy into 'buf' from PRNGD/EGD daemon
124 * listening either on 'tcp_port', or via Unix domain socket at *
126 * Either a non-zero tcp_port or a non-null socket_path must be
128 * Returns 0 on success, -1 on error
131 get_random_bytes_prngd(unsigned char *buf, int len,
132 unsigned short tcp_port, char *socket_path)
134 int fd, addr_len, rval, errors;
136 struct sockaddr_storage addr;
137 struct sockaddr_in *addr_in = (struct sockaddr_in *)&addr;
138 struct sockaddr_un *addr_un = (struct sockaddr_un *)&addr;
142 if (socket_path == NULL && tcp_port == 0)
143 fatal("You must specify a port or a socket");
144 if (socket_path != NULL &&
145 strlen(socket_path) >= sizeof(addr_un->sun_path))
146 fatal("Random pool path is too long");
148 fatal("Too many bytes to read from PRNGD");
150 memset(&addr, '\0', sizeof(addr));
153 addr_in->sin_family = AF_INET;
154 addr_in->sin_addr.s_addr = htonl(INADDR_LOOPBACK);
155 addr_in->sin_port = htons(tcp_port);
156 addr_len = sizeof(*addr_in);
158 addr_un->sun_family = AF_UNIX;
159 strlcpy(addr_un->sun_path, socket_path,
160 sizeof(addr_un->sun_path));
161 addr_len = offsetof(struct sockaddr_un, sun_path) +
162 strlen(socket_path) + 1;
165 old_sigpipe = mysignal(SIGPIPE, SIG_IGN);
170 fd = socket(addr.ss_family, SOCK_STREAM, 0);
172 error("Couldn't create socket: %s", strerror(errno));
176 if (connect(fd, (struct sockaddr*)&addr, addr_len) == -1) {
178 error("Couldn't connect to PRNGD port %d: %s",
179 tcp_port, strerror(errno));
181 error("Couldn't connect to PRNGD socket \"%s\": %s",
182 addr_un->sun_path, strerror(errno));
187 /* Send blocking read request to PRNGD */
191 if (atomicio(write, fd, msg, sizeof(msg)) != sizeof(msg)) {
192 if (errno == EPIPE && errors < 10) {
197 error("Couldn't write to PRNGD socket: %s",
202 if (atomicio(read, fd, buf, len) != len) {
203 if (errno == EPIPE && errors < 10) {
208 error("Couldn't read from PRNGD socket: %s",
215 mysignal(SIGPIPE, old_sigpipe);
222 stir_gettimeofday(double entropy_estimate)
226 if (gettimeofday(&tv, NULL) == -1)
227 fatal("Couldn't gettimeofday: %s", strerror(errno));
229 RAND_add(&tv, sizeof(tv), entropy_estimate);
231 return entropy_estimate;
235 stir_clock(double entropy_estimate)
241 RAND_add(&c, sizeof(c), entropy_estimate);
243 return entropy_estimate;
244 #else /* _HAVE_CLOCK */
246 #endif /* _HAVE_CLOCK */
250 stir_rusage(int who, double entropy_estimate)
252 #ifdef HAVE_GETRUSAGE
255 if (getrusage(who, &ru) == -1)
258 RAND_add(&ru, sizeof(ru), entropy_estimate);
260 return entropy_estimate;
261 #else /* _HAVE_GETRUSAGE */
263 #endif /* _HAVE_GETRUSAGE */
267 timeval_diff(struct timeval *t1, struct timeval *t2)
269 int secdiff, usecdiff;
271 secdiff = t2->tv_sec - t1->tv_sec;
272 usecdiff = (secdiff*1000000) + (t2->tv_usec - t1->tv_usec);
273 return (int)(usecdiff / 1000);
277 hash_command_output(entropy_cmd_t *src, char *hash)
281 int bytes_read, cmd_eof, error_abort, msec_elapsed, p[2];
282 int status, total_bytes_read;
283 static int devnull = -1;
286 struct timeval tv_start, tv_current;
288 debug3("Reading output from \'%s\'", src->cmdstring);
291 devnull = open("/dev/null", O_RDWR);
293 fatal("Couldn't open /dev/null: %s",
298 fatal("Couldn't open pipe: %s", strerror(errno));
300 (void)gettimeofday(&tv_start, NULL); /* record start time */
302 switch (pid = fork()) {
306 fatal("Couldn't fork: %s", strerror(errno));
309 dup2(devnull, STDIN_FILENO);
310 dup2(p[1], STDOUT_FILENO);
311 dup2(p[1], STDERR_FILENO);
316 execv(src->path, (char**)(src->args));
318 debug("(child) Couldn't exec '%s': %s",
319 src->cmdstring, strerror(errno));
321 default: /* Parent */
325 RAND_add(&pid, sizeof(&pid), 0.0);
329 /* Hash output from child */
332 cmd_eof = error_abort = msec_elapsed = total_bytes_read = 0;
333 while (!error_abort && !cmd_eof) {
338 (void) gettimeofday(&tv_current, 0);
339 msec_elapsed = timeval_diff(&tv_start, &tv_current);
340 if (msec_elapsed >= entropy_timeout_current) {
344 msec_remaining = entropy_timeout_current - msec_elapsed;
347 FD_SET(p[0], &rdset);
348 tv.tv_sec = msec_remaining / 1000;
349 tv.tv_usec = (msec_remaining % 1000) * 1000;
351 ret = select(p[0] + 1, &rdset, NULL, NULL, &tv);
353 RAND_add(&tv, sizeof(tv), 0.0);
363 bytes_read = read(p[0], buf, sizeof(buf));
364 } while (bytes_read == -1 && errno == EINTR);
365 RAND_add(&bytes_read, sizeof(&bytes_read), 0.0);
366 if (bytes_read == -1) {
369 } else if (bytes_read) {
370 SHA1_Update(&sha, buf, bytes_read);
371 total_bytes_read += bytes_read;
379 debug("Command '%s': select() failed: %s",
380 src->cmdstring, strerror(errno));
386 SHA1_Final(hash, &sha);
390 debug3("Time elapsed: %d msec", msec_elapsed);
392 if (waitpid(pid, &status, 0) == -1) {
393 error("Couldn't wait for child '%s' completion: %s",
394 src->cmdstring, strerror(errno));
398 RAND_add(&status, sizeof(&status), 0.0);
402 * Closing p[0] on timeout causes the entropy command to
403 * SIGPIPE. Take whatever output we got, and mark this
406 debug2("Command '%s' timed out", src->cmdstring);
407 src->sticky_badness *= 2;
408 src->badness = src->sticky_badness;
409 return total_bytes_read;
412 if (WIFEXITED(status)) {
413 if (WEXITSTATUS(status) == 0) {
414 return total_bytes_read;
416 debug2("Command '%s' exit status was %d",
417 src->cmdstring, WEXITSTATUS(status));
418 src->badness = src->sticky_badness = 128;
421 } else if (WIFSIGNALED(status)) {
422 debug2("Command '%s' returned on uncaught signal %d !",
423 src->cmdstring, status);
424 src->badness = src->sticky_badness = 128;
431 stir_from_system(void)
433 double total_entropy_estimate;
436 total_entropy_estimate = 0;
439 RAND_add(&i, sizeof(i), 0.5);
440 total_entropy_estimate += 0.1;
443 RAND_add(&i, sizeof(i), 0.5);
444 total_entropy_estimate += 0.1;
447 RAND_add(&i, sizeof(i), 0.0);
449 RAND_add(&i, sizeof(i), 0.0);
451 total_entropy_estimate += stir_gettimeofday(1.0);
452 total_entropy_estimate += stir_clock(0.5);
453 total_entropy_estimate += stir_rusage(RUSAGE_SELF, 2.0);
455 return total_entropy_estimate;
459 stir_from_programs(void)
462 double entropy, total_entropy;
463 char hash[SHA_DIGEST_LENGTH];
466 for(c = 0; entropy_cmds[c].path != NULL; c++) {
467 if (!entropy_cmds[c].badness) {
468 /* Hash output from command */
469 entropy = hash_command_output(&entropy_cmds[c],
472 /* Scale back estimate by command's rate */
473 entropy *= entropy_cmds[c].rate;
475 /* Upper bound of entropy is SHA_DIGEST_LENGTH */
476 if (entropy > SHA_DIGEST_LENGTH)
477 entropy = SHA_DIGEST_LENGTH;
480 RAND_add(hash, sizeof(hash), entropy);
482 debug3("Got %0.2f bytes of entropy from '%s'",
483 entropy, entropy_cmds[c].cmdstring);
485 total_entropy += entropy;
487 /* Execution time should be a bit unpredictable */
488 total_entropy += stir_gettimeofday(0.05);
489 total_entropy += stir_clock(0.05);
490 total_entropy += stir_rusage(RUSAGE_SELF, 0.1);
491 total_entropy += stir_rusage(RUSAGE_CHILDREN, 0.1);
493 debug2("Command '%s' disabled (badness %d)",
494 entropy_cmds[c].cmdstring,
495 entropy_cmds[c].badness);
497 if (entropy_cmds[c].badness > 0)
498 entropy_cmds[c].badness--;
502 return total_entropy;
506 * prng seedfile functions
509 prng_check_seedfile(char *filename)
514 * XXX raceable: eg replace seed between this stat and subsequent
515 * open. Not such a problem because we don't really trust the
517 * XXX: use secure path checking as elsewhere in OpenSSH
519 if (lstat(filename, &st) == -1) {
520 /* Give up on hard errors */
522 debug("WARNING: Couldn't stat random seed file "
523 "\"%.100s\": %s", filename, strerror(errno));
528 if (!S_ISREG(st.st_mode))
529 fatal("PRNG seedfile %.100s is not a regular file",
532 /* mode 0600, owned by root or the current user? */
533 if (((st.st_mode & 0177) != 0) || !(st.st_uid == getuid())) {
534 debug("WARNING: PRNG seedfile %.100s must be mode 0600, "
535 "owned by uid %d", filename, getuid());
543 prng_write_seedfile(void)
546 char seed[SEED_FILE_SIZE], filename[MAXPATHLEN];
549 pw = getpwuid(getuid());
551 fatal("Couldn't get password entry for current user "
552 "(%i): %s", getuid(), strerror(errno));
554 /* Try to ensure that the parent directory is there */
555 snprintf(filename, sizeof(filename), "%.512s/%s", pw->pw_dir,
557 mkdir(filename, 0700);
559 snprintf(filename, sizeof(filename), "%.512s/%s", pw->pw_dir,
562 debug("writing PRNG seed to file %.100s", filename);
564 RAND_bytes(seed, sizeof(seed));
566 /* Don't care if the seed doesn't exist */
567 prng_check_seedfile(filename);
569 if ((fd = open(filename, O_WRONLY|O_TRUNC|O_CREAT, 0600)) == -1) {
570 debug("WARNING: couldn't access PRNG seedfile %.100s "
571 "(%.100s)", filename, strerror(errno));
573 if (atomicio(write, fd, &seed, sizeof(seed)) < sizeof(seed))
574 fatal("problem writing PRNG seedfile %.100s "
575 "(%.100s)", filename, strerror(errno));
581 prng_read_seedfile(void)
584 char seed[SEED_FILE_SIZE], filename[MAXPATHLEN];
587 pw = getpwuid(getuid());
589 fatal("Couldn't get password entry for current user "
590 "(%i): %s", getuid(), strerror(errno));
592 snprintf(filename, sizeof(filename), "%.512s/%s", pw->pw_dir,
595 debug("loading PRNG seed from file %.100s", filename);
597 if (!prng_check_seedfile(filename)) {
598 verbose("Random seed file not found or invalid, ignoring.");
602 /* open the file and read in the seed */
603 fd = open(filename, O_RDONLY);
605 fatal("could not open PRNG seedfile %.100s (%.100s)",
606 filename, strerror(errno));
608 if (atomicio(read, fd, &seed, sizeof(seed)) < sizeof(seed)) {
609 verbose("invalid or short read from PRNG seedfile "
610 "%.100s - ignoring", filename);
611 memset(seed, '\0', sizeof(seed));
615 /* stir in the seed, with estimated entropy zero */
616 RAND_add(&seed, sizeof(seed), 0.0);
621 * entropy command initialisation functions
624 prng_read_commands(char *cmdfilename)
626 char cmd[SEED_FILE_SIZE], *cp, line[1024], path[SEED_FILE_SIZE];
628 entropy_cmd_t *entcmd;
630 int cur_cmd, linenum, num_cmds, arg;
632 if ((f = fopen(cmdfilename, "r")) == NULL) {
633 fatal("couldn't read entropy commands file %.100s: %.100s",
634 cmdfilename, strerror(errno));
638 entcmd = xmalloc(num_cmds * sizeof(entropy_cmd_t));
639 memset(entcmd, '\0', num_cmds * sizeof(entropy_cmd_t));
642 cur_cmd = linenum = 0;
643 while (fgets(line, sizeof(line), f)) {
646 /* Skip leading whitespace, blank lines and comments */
647 cp = line + strspn(line, WHITESPACE);
648 if ((*cp == 0) || (*cp == '#'))
649 continue; /* done with this line */
652 * The first non-whitespace char should be a double quote
653 * delimiting the commandline
656 error("bad entropy command, %.100s line %d",
657 cmdfilename, linenum);
662 * First token, command args (incl. argv[0]) in double
665 cp = strtok(cp, "\"");
667 error("missing or bad command string, %.100s "
668 "line %d -- ignored", cmdfilename, linenum);
671 strlcpy(cmd, cp, sizeof(cmd));
673 /* Second token, full command path */
674 if ((cp = strtok(NULL, WHITESPACE)) == NULL) {
675 error("missing command path, %.100s "
676 "line %d -- ignored", cmdfilename, linenum);
680 /* Did configure mark this as dead? */
681 if (strncmp("undef", cp, 5) == 0)
684 strlcpy(path, cp, sizeof(path));
686 /* Third token, entropy rate estimate for this command */
687 if ((cp = strtok(NULL, WHITESPACE)) == NULL) {
688 error("missing entropy estimate, %.100s "
689 "line %d -- ignored", cmdfilename, linenum);
692 est = strtod(cp, NULL);
695 if ((cp = strtok(NULL, WHITESPACE)) != NULL) {
696 error("garbage at end of line %d in %.100s "
697 "-- ignored", linenum, cmdfilename);
701 /* save the command for debug messages */
702 entcmd[cur_cmd].cmdstring = xstrdup(cmd);
704 /* split the command args */
705 cp = strtok(cmd, WHITESPACE);
708 entcmd[cur_cmd].args[arg] = xstrdup(cp);
710 } while(arg < NUM_ARGS && (cp = strtok(NULL, WHITESPACE)));
712 if (strtok(NULL, WHITESPACE))
713 error("ignored extra commands (max %d), %.100s "
714 "line %d", NUM_ARGS, cmdfilename, linenum);
716 /* Copy the command path and rate estimate */
717 entcmd[cur_cmd].path = xstrdup(path);
718 entcmd[cur_cmd].rate = est;
720 /* Initialise other values */
721 entcmd[cur_cmd].sticky_badness = 1;
726 * If we've filled the array, reallocate it twice the size
727 * Do this now because even if this we're on the last
728 * command we need another slot to mark the last entry
730 if (cur_cmd == num_cmds) {
732 entcmd = xrealloc(entcmd, num_cmds *
733 sizeof(entropy_cmd_t));
737 /* zero the last entry */
738 memset(&entcmd[cur_cmd], '\0', sizeof(entropy_cmd_t));
741 entropy_cmds = xrealloc(entcmd, (cur_cmd + 1) *
742 sizeof(entropy_cmd_t));
744 debug("Loaded %d entropy commands from %.100s", cur_cmd,
747 return cur_cmd < MIN_ENTROPY_SOURCES ? -1 : 0;
751 main(int argc, char **argv)
753 unsigned char buf[OUTPUT_SEED_SIZE];
756 __progname = get_progname(argv[0]);
757 /* XXX: need some debugging mode */
758 log_init(argv[0], SYSLOG_LEVEL_INFO, SYSLOG_FACILITY_USER, 1);
760 #ifdef USE_SEED_FILES
761 prng_read_seedfile();
765 * Seed the RNG from wherever we can
768 /* Take whatever is on the stack, but don't credit it */
769 RAND_add(buf, sizeof(buf), 0);
771 debug("Seeded RNG with %i bytes from system calls",
772 (int)stir_from_system());
775 if (get_random_bytes_prngd(buf, sizeof(buf), PRNGD_PORT, NULL) == -1)
776 fatal("Entropy collection failed");
777 RAND_add(buf, sizeof(buf), sizeof(buf));
778 #elif defined(PRNGD_SOCKET)
779 if (get_random_bytes_prngd(buf, sizeof(buf), 0, PRNGD_SOCKET) == -1)
780 fatal("Entropy collection failed");
781 RAND_add(buf, sizeof(buf), sizeof(buf));
783 /* Read in collection commands */
784 if (prng_read_commands(SSH_PRNG_COMMAND_FILE) == -1)
785 fatal("PRNG initialisation failed -- exiting.");
786 debug("Seeded RNG with %i bytes from programs",
787 (int)stir_from_programs());
790 #ifdef USE_SEED_FILES
791 prng_write_seedfile();
795 * Write the seed to stdout
799 fatal("Not enough entropy in RNG");
801 RAND_bytes(buf, sizeof(buf));
803 ret = atomicio(write, STDOUT_FILENO, buf, sizeof(buf));
805 memset(buf, '\0', sizeof(buf));
807 return ret == sizeof(buf) ? 0 : 1;