blob: feb1bfb1834de675888e625f73b6ecc27f7eefb5 [file] [log] [blame]
Damien Miller62116dc2001-12-24 01:41:47 +11001/*
Damien Miller7b10ef42002-01-21 23:44:12 +11002 * Copyright (c) 2001-2002 Damien Miller. All rights reserved.
Damien Miller62116dc2001-12-24 01:41:47 +11003 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
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.
12 *
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.
23 */
24
25#include "includes.h"
26
Damien Miller3717cda2006-03-15 14:02:36 +110027#include <sys/types.h>
28#include <sys/resource.h>
29#include <sys/stat.h>
30#include <sys/wait.h>
Damien Miller8ec8c3e2006-07-10 20:35:38 +100031#include <sys/socket.h>
32
33#include <netinet/in.h>
Damien Miller3717cda2006-03-15 14:02:36 +110034
35#ifdef HAVE_SYS_UN_H
36# include <sys/un.h>
37#endif
38
Damien Miller9f2abc42006-07-10 20:53:08 +100039#include <pwd.h>
Damien Miller3717cda2006-03-15 14:02:36 +110040#include <signal.h>
41
Damien Miller62116dc2001-12-24 01:41:47 +110042#include <openssl/rand.h>
43#include <openssl/sha.h>
44#include <openssl/crypto.h>
45
46/* SunOS 4.4.4 needs this */
47#ifdef HAVE_FLOATINGPOINT_H
48# include <floatingpoint.h>
49#endif /* HAVE_FLOATINGPOINT_H */
50
51#include "misc.h"
52#include "xmalloc.h"
53#include "atomicio.h"
54#include "pathnames.h"
55#include "log.h"
56
Damien Miller7b10ef42002-01-21 23:44:12 +110057/* Number of bytes we write out */
58#define OUTPUT_SEED_SIZE 48
59
60/* Length of on-disk seedfiles */
61#define SEED_FILE_SIZE 1024
62
63/* Maximum number of command-line arguments to read from file */
64#define NUM_ARGS 10
65
66/* Minimum number of usable commands to be considered sufficient */
67#define MIN_ENTROPY_SOURCES 16
68
69/* Path to on-disk seed file (relative to user's home directory */
70#ifndef SSH_PRNG_SEED_FILE
71# define SSH_PRNG_SEED_FILE _PATH_SSH_USER_DIR"/prng_seed"
72#endif
73
74/* Path to PRNG commands list */
75#ifndef SSH_PRNG_COMMAND_FILE
Damien Miller05eda432002-02-10 18:32:28 +110076# define SSH_PRNG_COMMAND_FILE SSHDIR "/ssh_prng_cmds"
Damien Miller7b10ef42002-01-21 23:44:12 +110077#endif
78
Kevin Steves94435082001-12-25 04:32:58 +000079extern char *__progname;
Kevin Steves94435082001-12-25 04:32:58 +000080
Damien Miller62116dc2001-12-24 01:41:47 +110081#define WHITESPACE " \t\n"
82
83#ifndef RUSAGE_SELF
84# define RUSAGE_SELF 0
85#endif
86#ifndef RUSAGE_CHILDREN
87# define RUSAGE_CHILDREN 0
88#endif
89
Damien Millerc46cc542002-01-22 21:58:27 +110090#if !defined(PRNGD_SOCKET) && !defined(PRNGD_PORT)
Damien Miller7b10ef42002-01-21 23:44:12 +110091# define USE_SEED_FILES
Damien Miller62116dc2001-12-24 01:41:47 +110092#endif
93
Damien Miller7b10ef42002-01-21 23:44:12 +110094typedef struct {
95 /* Proportion of data that is entropy */
96 double rate;
97 /* Counter goes positive if this command times out */
98 unsigned int badness;
99 /* Increases by factor of two each timeout */
100 unsigned int sticky_badness;
101 /* Path to executable */
102 char *path;
103 /* argv to pass to executable */
104 char *args[NUM_ARGS]; /* XXX: arbitrary limit */
105 /* full command string (debug) */
106 char *cmdstring;
107} entropy_cmd_t;
108
109/* slow command timeouts (all in milliseconds) */
110/* static int entropy_timeout_default = ENTROPY_TIMEOUT_MSEC; */
111static int entropy_timeout_current = ENTROPY_TIMEOUT_MSEC;
112
113/* this is initialised from a file, by prng_read_commands() */
114static entropy_cmd_t *entropy_cmds = NULL;
115
116/* Prototypes */
117double stir_from_system(void);
118double stir_from_programs(void);
119double stir_gettimeofday(double entropy_estimate);
120double stir_clock(double entropy_estimate);
121double stir_rusage(int who, double entropy_estimate);
Kevin Steves4bdb5472002-07-28 20:42:23 +0000122double hash_command_output(entropy_cmd_t *src, unsigned char *hash);
Damien Millera8e06ce2003-11-21 23:48:55 +1100123int get_random_bytes_prngd(unsigned char *buf, int len,
Damien Miller7b10ef42002-01-21 23:44:12 +1100124 unsigned short tcp_port, char *socket_path);
125
126/*
127 * Collect 'len' bytes of entropy into 'buf' from PRNGD/EGD daemon
128 * listening either on 'tcp_port', or via Unix domain socket at *
129 * 'socket_path'.
Damien Millera8e06ce2003-11-21 23:48:55 +1100130 * Either a non-zero tcp_port or a non-null socket_path must be
Damien Miller7b10ef42002-01-21 23:44:12 +1100131 * supplied.
132 * Returns 0 on success, -1 on error
133 */
Damien Miller62116dc2001-12-24 01:41:47 +1100134int
Damien Millera8e06ce2003-11-21 23:48:55 +1100135get_random_bytes_prngd(unsigned char *buf, int len,
Damien Miller7b10ef42002-01-21 23:44:12 +1100136 unsigned short tcp_port, char *socket_path)
Damien Miller62116dc2001-12-24 01:41:47 +1100137{
Damien Miller7b10ef42002-01-21 23:44:12 +1100138 int fd, addr_len, rval, errors;
Damien Miller52c8afe2005-06-19 10:19:43 +1000139 u_char msg[2];
Damien Miller7b10ef42002-01-21 23:44:12 +1100140 struct sockaddr_storage addr;
141 struct sockaddr_in *addr_in = (struct sockaddr_in *)&addr;
142 struct sockaddr_un *addr_un = (struct sockaddr_un *)&addr;
Damien Miller62116dc2001-12-24 01:41:47 +1100143 mysig_t old_sigpipe;
144
Damien Miller7b10ef42002-01-21 23:44:12 +1100145 /* Sanity checks */
146 if (socket_path == NULL && tcp_port == 0)
147 fatal("You must specify a port or a socket");
148 if (socket_path != NULL &&
149 strlen(socket_path) >= sizeof(addr_un->sun_path))
150 fatal("Random pool path is too long");
Damien Miller52c8afe2005-06-19 10:19:43 +1000151 if (len <= 0 || len > 255)
152 fatal("Too many bytes (%d) to read from PRNGD", len);
Damien Miller62116dc2001-12-24 01:41:47 +1100153
154 memset(&addr, '\0', sizeof(addr));
155
Damien Miller7b10ef42002-01-21 23:44:12 +1100156 if (tcp_port != 0) {
157 addr_in->sin_family = AF_INET;
158 addr_in->sin_addr.s_addr = htonl(INADDR_LOOPBACK);
159 addr_in->sin_port = htons(tcp_port);
160 addr_len = sizeof(*addr_in);
161 } else {
162 addr_un->sun_family = AF_UNIX;
163 strlcpy(addr_un->sun_path, socket_path,
164 sizeof(addr_un->sun_path));
165 addr_len = offsetof(struct sockaddr_un, sun_path) +
166 strlen(socket_path) + 1;
167 }
Damien Miller62116dc2001-12-24 01:41:47 +1100168
169 old_sigpipe = mysignal(SIGPIPE, SIG_IGN);
170
Damien Miller7b10ef42002-01-21 23:44:12 +1100171 errors = 0;
172 rval = -1;
Damien Miller62116dc2001-12-24 01:41:47 +1100173reopen:
Damien Miller7b10ef42002-01-21 23:44:12 +1100174 fd = socket(addr.ss_family, SOCK_STREAM, 0);
Damien Miller62116dc2001-12-24 01:41:47 +1100175 if (fd == -1) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100176 error("Couldn't create socket: %s", strerror(errno));
Damien Miller62116dc2001-12-24 01:41:47 +1100177 goto done;
178 }
Damien Miller62116dc2001-12-24 01:41:47 +1100179
180 if (connect(fd, (struct sockaddr*)&addr, addr_len) == -1) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100181 if (tcp_port != 0) {
182 error("Couldn't connect to PRNGD port %d: %s",
183 tcp_port, strerror(errno));
184 } else {
185 error("Couldn't connect to PRNGD socket \"%s\": %s",
186 addr_un->sun_path, strerror(errno));
187 }
Damien Miller62116dc2001-12-24 01:41:47 +1100188 goto done;
189 }
190
191 /* Send blocking read request to PRNGD */
192 msg[0] = 0x02;
193 msg[1] = len;
194
Darren Tucker8661b562003-07-06 15:20:46 +1000195 if (atomicio(vwrite, fd, msg, sizeof(msg)) != sizeof(msg)) {
Damien Miller62116dc2001-12-24 01:41:47 +1100196 if (errno == EPIPE && errors < 10) {
197 close(fd);
198 errors++;
199 goto reopen;
200 }
201 error("Couldn't write to PRNGD socket: %s",
202 strerror(errno));
203 goto done;
204 }
205
Damien Miller52c8afe2005-06-19 10:19:43 +1000206 if (atomicio(read, fd, buf, len) != (size_t)len) {
Damien Miller62116dc2001-12-24 01:41:47 +1100207 if (errno == EPIPE && errors < 10) {
208 close(fd);
209 errors++;
210 goto reopen;
211 }
212 error("Couldn't read from PRNGD socket: %s",
213 strerror(errno));
214 goto done;
215 }
216
Damien Miller7b10ef42002-01-21 23:44:12 +1100217 rval = 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100218done:
219 mysignal(SIGPIPE, old_sigpipe);
220 if (fd != -1)
221 close(fd);
Damien Miller7b10ef42002-01-21 23:44:12 +1100222 return rval;
Damien Miller62116dc2001-12-24 01:41:47 +1100223}
224
Darren Tucker8686ed72004-12-20 12:05:08 +1100225static int
226seed_from_prngd(unsigned char *buf, size_t bytes)
227{
228#ifdef PRNGD_PORT
229 debug("trying egd/prngd port %d", PRNGD_PORT);
230 if (get_random_bytes_prngd(buf, bytes, PRNGD_PORT, NULL) == 0)
231 return 0;
232#endif
233#ifdef PRNGD_SOCKET
234 debug("trying egd/prngd socket %s", PRNGD_SOCKET);
235 if (get_random_bytes_prngd(buf, bytes, 0, PRNGD_SOCKET) == 0)
236 return 0;
237#endif
238 return -1;
239}
240
Damien Miller62116dc2001-12-24 01:41:47 +1100241double
242stir_gettimeofday(double entropy_estimate)
243{
244 struct timeval tv;
245
246 if (gettimeofday(&tv, NULL) == -1)
247 fatal("Couldn't gettimeofday: %s", strerror(errno));
248
249 RAND_add(&tv, sizeof(tv), entropy_estimate);
250
Damien Miller7b10ef42002-01-21 23:44:12 +1100251 return entropy_estimate;
Damien Miller62116dc2001-12-24 01:41:47 +1100252}
253
254double
255stir_clock(double entropy_estimate)
256{
257#ifdef HAVE_CLOCK
258 clock_t c;
259
260 c = clock();
261 RAND_add(&c, sizeof(c), entropy_estimate);
262
Damien Miller7b10ef42002-01-21 23:44:12 +1100263 return entropy_estimate;
Damien Miller62116dc2001-12-24 01:41:47 +1100264#else /* _HAVE_CLOCK */
Damien Miller7b10ef42002-01-21 23:44:12 +1100265 return 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100266#endif /* _HAVE_CLOCK */
267}
268
269double
270stir_rusage(int who, double entropy_estimate)
271{
272#ifdef HAVE_GETRUSAGE
273 struct rusage ru;
274
275 if (getrusage(who, &ru) == -1)
Damien Miller7b10ef42002-01-21 23:44:12 +1100276 return 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100277
278 RAND_add(&ru, sizeof(ru), entropy_estimate);
279
Damien Miller7b10ef42002-01-21 23:44:12 +1100280 return entropy_estimate;
Damien Miller62116dc2001-12-24 01:41:47 +1100281#else /* _HAVE_GETRUSAGE */
Damien Miller7b10ef42002-01-21 23:44:12 +1100282 return 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100283#endif /* _HAVE_GETRUSAGE */
284}
285
Damien Miller62116dc2001-12-24 01:41:47 +1100286static int
Damien Miller7b10ef42002-01-21 23:44:12 +1100287timeval_diff(struct timeval *t1, struct timeval *t2)
288{
Damien Miller62116dc2001-12-24 01:41:47 +1100289 int secdiff, usecdiff;
290
291 secdiff = t2->tv_sec - t1->tv_sec;
292 usecdiff = (secdiff*1000000) + (t2->tv_usec - t1->tv_usec);
293 return (int)(usecdiff / 1000);
294}
295
296double
Kevin Steves4bdb5472002-07-28 20:42:23 +0000297hash_command_output(entropy_cmd_t *src, unsigned char *hash)
Damien Miller62116dc2001-12-24 01:41:47 +1100298{
Damien Miller7b10ef42002-01-21 23:44:12 +1100299 char buf[8192];
Damien Miller62116dc2001-12-24 01:41:47 +1100300 fd_set rdset;
Damien Miller7b10ef42002-01-21 23:44:12 +1100301 int bytes_read, cmd_eof, error_abort, msec_elapsed, p[2];
302 int status, total_bytes_read;
303 static int devnull = -1;
Damien Miller62116dc2001-12-24 01:41:47 +1100304 pid_t pid;
Damien Miller62116dc2001-12-24 01:41:47 +1100305 SHA_CTX sha;
Damien Miller7b10ef42002-01-21 23:44:12 +1100306 struct timeval tv_start, tv_current;
Damien Miller62116dc2001-12-24 01:41:47 +1100307
308 debug3("Reading output from \'%s\'", src->cmdstring);
309
310 if (devnull == -1) {
311 devnull = open("/dev/null", O_RDWR);
312 if (devnull == -1)
Damien Millera8e06ce2003-11-21 23:48:55 +1100313 fatal("Couldn't open /dev/null: %s",
Damien Miller7b10ef42002-01-21 23:44:12 +1100314 strerror(errno));
Damien Miller62116dc2001-12-24 01:41:47 +1100315 }
316
317 if (pipe(p) == -1)
318 fatal("Couldn't open pipe: %s", strerror(errno));
319
320 (void)gettimeofday(&tv_start, NULL); /* record start time */
321
322 switch (pid = fork()) {
323 case -1: /* Error */
324 close(p[0]);
325 close(p[1]);
326 fatal("Couldn't fork: %s", strerror(errno));
327 /* NOTREACHED */
328 case 0: /* Child */
329 dup2(devnull, STDIN_FILENO);
330 dup2(p[1], STDOUT_FILENO);
331 dup2(p[1], STDERR_FILENO);
332 close(p[0]);
333 close(p[1]);
334 close(devnull);
335
336 execv(src->path, (char**)(src->args));
Damien Miller7b10ef42002-01-21 23:44:12 +1100337
Damien Millera8e06ce2003-11-21 23:48:55 +1100338 debug("(child) Couldn't exec '%s': %s",
Damien Miller7b10ef42002-01-21 23:44:12 +1100339 src->cmdstring, strerror(errno));
Damien Miller62116dc2001-12-24 01:41:47 +1100340 _exit(-1);
341 default: /* Parent */
342 break;
343 }
344
345 RAND_add(&pid, sizeof(&pid), 0.0);
346
347 close(p[1]);
348
349 /* Hash output from child */
350 SHA1_Init(&sha);
Damien Miller62116dc2001-12-24 01:41:47 +1100351
Damien Miller7b10ef42002-01-21 23:44:12 +1100352 cmd_eof = error_abort = msec_elapsed = total_bytes_read = 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100353 while (!error_abort && !cmd_eof) {
354 int ret;
355 struct timeval tv;
356 int msec_remaining;
357
358 (void) gettimeofday(&tv_current, 0);
Damien Miller7b10ef42002-01-21 23:44:12 +1100359 msec_elapsed = timeval_diff(&tv_start, &tv_current);
Damien Miller62116dc2001-12-24 01:41:47 +1100360 if (msec_elapsed >= entropy_timeout_current) {
361 error_abort=1;
362 continue;
363 }
364 msec_remaining = entropy_timeout_current - msec_elapsed;
365
366 FD_ZERO(&rdset);
367 FD_SET(p[0], &rdset);
Damien Miller7b10ef42002-01-21 23:44:12 +1100368 tv.tv_sec = msec_remaining / 1000;
Damien Miller62116dc2001-12-24 01:41:47 +1100369 tv.tv_usec = (msec_remaining % 1000) * 1000;
370
Damien Miller7b10ef42002-01-21 23:44:12 +1100371 ret = select(p[0] + 1, &rdset, NULL, NULL, &tv);
Damien Miller62116dc2001-12-24 01:41:47 +1100372
373 RAND_add(&tv, sizeof(tv), 0.0);
374
375 switch (ret) {
376 case 0:
377 /* timer expired */
378 error_abort = 1;
Damien Miller5a5da882002-10-21 10:13:35 +1000379 kill(pid, SIGINT);
Damien Miller62116dc2001-12-24 01:41:47 +1100380 break;
381 case 1:
382 /* command input */
383 do {
384 bytes_read = read(p[0], buf, sizeof(buf));
385 } while (bytes_read == -1 && errno == EINTR);
386 RAND_add(&bytes_read, sizeof(&bytes_read), 0.0);
387 if (bytes_read == -1) {
388 error_abort = 1;
389 break;
390 } else if (bytes_read) {
391 SHA1_Update(&sha, buf, bytes_read);
392 total_bytes_read += bytes_read;
393 } else {
394 cmd_eof = 1;
395 }
396 break;
397 case -1:
398 default:
399 /* error */
Damien Millera8e06ce2003-11-21 23:48:55 +1100400 debug("Command '%s': select() failed: %s",
Damien Miller7b10ef42002-01-21 23:44:12 +1100401 src->cmdstring, strerror(errno));
Damien Miller62116dc2001-12-24 01:41:47 +1100402 error_abort = 1;
403 break;
404 }
405 }
406
407 SHA1_Final(hash, &sha);
408
409 close(p[0]);
410
411 debug3("Time elapsed: %d msec", msec_elapsed);
412
413 if (waitpid(pid, &status, 0) == -1) {
Damien Millerb6f72f52005-07-17 17:26:43 +1000414 error("Couldn't wait for child '%s' completion: %s",
415 src->cmdstring, strerror(errno));
Damien Miller7b10ef42002-01-21 23:44:12 +1100416 return 0.0;
Damien Miller62116dc2001-12-24 01:41:47 +1100417 }
418
419 RAND_add(&status, sizeof(&status), 0.0);
420
421 if (error_abort) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100422 /*
423 * Closing p[0] on timeout causes the entropy command to
Damien Millera8e06ce2003-11-21 23:48:55 +1100424 * SIGPIPE. Take whatever output we got, and mark this
425 * command as slow
Damien Miller7b10ef42002-01-21 23:44:12 +1100426 */
Damien Miller62116dc2001-12-24 01:41:47 +1100427 debug2("Command '%s' timed out", src->cmdstring);
428 src->sticky_badness *= 2;
429 src->badness = src->sticky_badness;
Damien Miller7b10ef42002-01-21 23:44:12 +1100430 return total_bytes_read;
Damien Miller62116dc2001-12-24 01:41:47 +1100431 }
432
433 if (WIFEXITED(status)) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100434 if (WEXITSTATUS(status) == 0) {
435 return total_bytes_read;
Damien Miller62116dc2001-12-24 01:41:47 +1100436 } else {
Damien Miller7b10ef42002-01-21 23:44:12 +1100437 debug2("Command '%s' exit status was %d",
438 src->cmdstring, WEXITSTATUS(status));
Damien Miller62116dc2001-12-24 01:41:47 +1100439 src->badness = src->sticky_badness = 128;
Damien Miller7b10ef42002-01-21 23:44:12 +1100440 return 0.0;
Damien Miller62116dc2001-12-24 01:41:47 +1100441 }
442 } else if (WIFSIGNALED(status)) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100443 debug2("Command '%s' returned on uncaught signal %d !",
444 src->cmdstring, status);
Damien Miller62116dc2001-12-24 01:41:47 +1100445 src->badness = src->sticky_badness = 128;
Damien Miller7b10ef42002-01-21 23:44:12 +1100446 return 0.0;
Damien Miller62116dc2001-12-24 01:41:47 +1100447 } else
Damien Miller7b10ef42002-01-21 23:44:12 +1100448 return 0.0;
449}
450
451double
452stir_from_system(void)
453{
454 double total_entropy_estimate;
455 long int i;
456
457 total_entropy_estimate = 0;
458
459 i = getpid();
460 RAND_add(&i, sizeof(i), 0.5);
461 total_entropy_estimate += 0.1;
462
463 i = getppid();
464 RAND_add(&i, sizeof(i), 0.5);
465 total_entropy_estimate += 0.1;
466
467 i = getuid();
468 RAND_add(&i, sizeof(i), 0.0);
469 i = getgid();
470 RAND_add(&i, sizeof(i), 0.0);
471
472 total_entropy_estimate += stir_gettimeofday(1.0);
473 total_entropy_estimate += stir_clock(0.5);
474 total_entropy_estimate += stir_rusage(RUSAGE_SELF, 2.0);
475
476 return total_entropy_estimate;
477}
478
479double
480stir_from_programs(void)
481{
482 int c;
483 double entropy, total_entropy;
Kevin Steves4bdb5472002-07-28 20:42:23 +0000484 unsigned char hash[SHA_DIGEST_LENGTH];
Damien Miller7b10ef42002-01-21 23:44:12 +1100485
486 total_entropy = 0;
487 for(c = 0; entropy_cmds[c].path != NULL; c++) {
488 if (!entropy_cmds[c].badness) {
489 /* Hash output from command */
490 entropy = hash_command_output(&entropy_cmds[c],
491 hash);
492
493 /* Scale back estimate by command's rate */
494 entropy *= entropy_cmds[c].rate;
495
496 /* Upper bound of entropy is SHA_DIGEST_LENGTH */
497 if (entropy > SHA_DIGEST_LENGTH)
498 entropy = SHA_DIGEST_LENGTH;
499
500 /* Stir it in */
501 RAND_add(hash, sizeof(hash), entropy);
502
Damien Millera8e06ce2003-11-21 23:48:55 +1100503 debug3("Got %0.2f bytes of entropy from '%s'",
Damien Miller7b10ef42002-01-21 23:44:12 +1100504 entropy, entropy_cmds[c].cmdstring);
505
506 total_entropy += entropy;
507
508 /* Execution time should be a bit unpredictable */
509 total_entropy += stir_gettimeofday(0.05);
510 total_entropy += stir_clock(0.05);
511 total_entropy += stir_rusage(RUSAGE_SELF, 0.1);
512 total_entropy += stir_rusage(RUSAGE_CHILDREN, 0.1);
513 } else {
514 debug2("Command '%s' disabled (badness %d)",
Damien Millera8e06ce2003-11-21 23:48:55 +1100515 entropy_cmds[c].cmdstring,
Damien Miller7b10ef42002-01-21 23:44:12 +1100516 entropy_cmds[c].badness);
517
518 if (entropy_cmds[c].badness > 0)
519 entropy_cmds[c].badness--;
520 }
521 }
522
523 return total_entropy;
Damien Miller62116dc2001-12-24 01:41:47 +1100524}
525
526/*
527 * prng seedfile functions
528 */
529int
Damien Miller7b10ef42002-01-21 23:44:12 +1100530prng_check_seedfile(char *filename)
531{
Damien Miller62116dc2001-12-24 01:41:47 +1100532 struct stat st;
533
Damien Miller7b10ef42002-01-21 23:44:12 +1100534 /*
Damien Millera8e06ce2003-11-21 23:48:55 +1100535 * XXX raceable: eg replace seed between this stat and subsequent
536 * open. Not such a problem because we don't really trust the
Damien Miller7b10ef42002-01-21 23:44:12 +1100537 * seed file anyway.
538 * XXX: use secure path checking as elsewhere in OpenSSH
539 */
Damien Miller62116dc2001-12-24 01:41:47 +1100540 if (lstat(filename, &st) == -1) {
541 /* Give up on hard errors */
542 if (errno != ENOENT)
Damien Miller7b10ef42002-01-21 23:44:12 +1100543 debug("WARNING: Couldn't stat random seed file "
544 "\"%.100s\": %s", filename, strerror(errno));
545 return 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100546 }
547
548 /* regular file? */
549 if (!S_ISREG(st.st_mode))
Damien Miller7b10ef42002-01-21 23:44:12 +1100550 fatal("PRNG seedfile %.100s is not a regular file",
551 filename);
Damien Miller62116dc2001-12-24 01:41:47 +1100552
553 /* mode 0600, owned by root or the current user? */
554 if (((st.st_mode & 0177) != 0) || !(st.st_uid == getuid())) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100555 debug("WARNING: PRNG seedfile %.100s must be mode 0600, "
Damien Millerc46b6bc2003-05-16 15:51:44 +1000556 "owned by uid %li", filename, (long int)getuid());
Damien Miller7b10ef42002-01-21 23:44:12 +1100557 return 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100558 }
559
Damien Miller7b10ef42002-01-21 23:44:12 +1100560 return 1;
Damien Miller62116dc2001-12-24 01:41:47 +1100561}
562
563void
Damien Miller7b10ef42002-01-21 23:44:12 +1100564prng_write_seedfile(void)
565{
Damien Millered462d92005-02-16 13:02:45 +1100566 int fd, save_errno;
Kevin Steves4bdb5472002-07-28 20:42:23 +0000567 unsigned char seed[SEED_FILE_SIZE];
Damien Millered462d92005-02-16 13:02:45 +1100568 char filename[MAXPATHLEN], tmpseed[MAXPATHLEN];
Damien Miller62116dc2001-12-24 01:41:47 +1100569 struct passwd *pw;
Damien Millered462d92005-02-16 13:02:45 +1100570 mode_t old_umask;
Damien Miller62116dc2001-12-24 01:41:47 +1100571
572 pw = getpwuid(getuid());
573 if (pw == NULL)
Damien Miller7b10ef42002-01-21 23:44:12 +1100574 fatal("Couldn't get password entry for current user "
Damien Millerc46b6bc2003-05-16 15:51:44 +1000575 "(%li): %s", (long int)getuid(), strerror(errno));
Damien Miller62116dc2001-12-24 01:41:47 +1100576
577 /* Try to ensure that the parent directory is there */
578 snprintf(filename, sizeof(filename), "%.512s/%s", pw->pw_dir,
Damien Miller7b10ef42002-01-21 23:44:12 +1100579 _PATH_SSH_USER_DIR);
Darren Tuckerdaf6ff42006-07-05 21:35:48 +1000580 if (mkdir(filename, 0700) < 0 && errno != EEXIST)
581 fatal("mkdir %.200s: %s", filename, strerror(errno));
Damien Miller62116dc2001-12-24 01:41:47 +1100582
583 snprintf(filename, sizeof(filename), "%.512s/%s", pw->pw_dir,
Damien Miller7b10ef42002-01-21 23:44:12 +1100584 SSH_PRNG_SEED_FILE);
Damien Miller62116dc2001-12-24 01:41:47 +1100585
Damien Millered462d92005-02-16 13:02:45 +1100586 strlcpy(tmpseed, filename, sizeof(tmpseed));
587 if (strlcat(tmpseed, ".XXXXXXXXXX", sizeof(tmpseed)) >=
588 sizeof(tmpseed))
589 fatal("PRNG seed filename too long");
Damien Miller62116dc2001-12-24 01:41:47 +1100590
Damien Millercafbcc72003-03-17 16:13:53 +1100591 if (RAND_bytes(seed, sizeof(seed)) <= 0)
Ben Lindstromda4d9cf2003-09-22 15:36:15 +0000592 fatal("PRNG seed extraction failed");
Damien Miller62116dc2001-12-24 01:41:47 +1100593
594 /* Don't care if the seed doesn't exist */
595 prng_check_seedfile(filename);
596
Damien Millered462d92005-02-16 13:02:45 +1100597 old_umask = umask(0177);
598
599 if ((fd = mkstemp(tmpseed)) == -1) {
600 debug("WARNING: couldn't make temporary PRNG seedfile %.100s "
601 "(%.100s)", tmpseed, strerror(errno));
Damien Miller62116dc2001-12-24 01:41:47 +1100602 } else {
Damien Millered462d92005-02-16 13:02:45 +1100603 debug("writing PRNG seed to file %.100s", tmpseed);
604 if (atomicio(vwrite, fd, &seed, sizeof(seed)) < sizeof(seed)) {
605 save_errno = errno;
606 close(fd);
607 unlink(tmpseed);
Damien Miller7b10ef42002-01-21 23:44:12 +1100608 fatal("problem writing PRNG seedfile %.100s "
Damien Millered462d92005-02-16 13:02:45 +1100609 "(%.100s)", filename, strerror(save_errno));
610 }
Damien Miller62116dc2001-12-24 01:41:47 +1100611 close(fd);
Damien Millered462d92005-02-16 13:02:45 +1100612 debug("moving temporary PRNG seed to file %.100s", filename);
613 if (rename(tmpseed, filename) == -1) {
614 save_errno = errno;
615 unlink(tmpseed);
616 fatal("problem renaming PRNG seedfile from %.100s "
Damien Miller94cf4c82005-07-17 17:04:47 +1000617 "to %.100s (%.100s)", tmpseed, filename,
Damien Millered462d92005-02-16 13:02:45 +1100618 strerror(save_errno));
619 }
Damien Miller62116dc2001-12-24 01:41:47 +1100620 }
Damien Millered462d92005-02-16 13:02:45 +1100621 umask(old_umask);
Damien Miller62116dc2001-12-24 01:41:47 +1100622}
623
624void
Damien Miller7b10ef42002-01-21 23:44:12 +1100625prng_read_seedfile(void)
626{
Damien Miller62116dc2001-12-24 01:41:47 +1100627 int fd;
Damien Miller7b10ef42002-01-21 23:44:12 +1100628 char seed[SEED_FILE_SIZE], filename[MAXPATHLEN];
Damien Miller62116dc2001-12-24 01:41:47 +1100629 struct passwd *pw;
630
631 pw = getpwuid(getuid());
632 if (pw == NULL)
Damien Miller7b10ef42002-01-21 23:44:12 +1100633 fatal("Couldn't get password entry for current user "
Damien Millerc46b6bc2003-05-16 15:51:44 +1000634 "(%li): %s", (long int)getuid(), strerror(errno));
Damien Miller62116dc2001-12-24 01:41:47 +1100635
636 snprintf(filename, sizeof(filename), "%.512s/%s", pw->pw_dir,
637 SSH_PRNG_SEED_FILE);
638
639 debug("loading PRNG seed from file %.100s", filename);
640
641 if (!prng_check_seedfile(filename)) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100642 verbose("Random seed file not found or invalid, ignoring.");
Damien Miller62116dc2001-12-24 01:41:47 +1100643 return;
644 }
645
646 /* open the file and read in the seed */
647 fd = open(filename, O_RDONLY);
648 if (fd == -1)
Damien Miller7b10ef42002-01-21 23:44:12 +1100649 fatal("could not open PRNG seedfile %.100s (%.100s)",
650 filename, strerror(errno));
Damien Miller62116dc2001-12-24 01:41:47 +1100651
Damien Miller7b10ef42002-01-21 23:44:12 +1100652 if (atomicio(read, fd, &seed, sizeof(seed)) < sizeof(seed)) {
653 verbose("invalid or short read from PRNG seedfile "
654 "%.100s - ignoring", filename);
Damien Miller62116dc2001-12-24 01:41:47 +1100655 memset(seed, '\0', sizeof(seed));
656 }
657 close(fd);
658
659 /* stir in the seed, with estimated entropy zero */
660 RAND_add(&seed, sizeof(seed), 0.0);
661}
662
663
664/*
665 * entropy command initialisation functions
666 */
667int
668prng_read_commands(char *cmdfilename)
669{
Damien Miller7b10ef42002-01-21 23:44:12 +1100670 char cmd[SEED_FILE_SIZE], *cp, line[1024], path[SEED_FILE_SIZE];
Damien Miller62116dc2001-12-24 01:41:47 +1100671 double est;
Damien Miller7b10ef42002-01-21 23:44:12 +1100672 entropy_cmd_t *entcmd;
673 FILE *f;
674 int cur_cmd, linenum, num_cmds, arg;
Damien Miller62116dc2001-12-24 01:41:47 +1100675
Damien Miller7b10ef42002-01-21 23:44:12 +1100676 if ((f = fopen(cmdfilename, "r")) == NULL) {
Damien Miller62116dc2001-12-24 01:41:47 +1100677 fatal("couldn't read entropy commands file %.100s: %.100s",
678 cmdfilename, strerror(errno));
679 }
680
Damien Miller7b10ef42002-01-21 23:44:12 +1100681 num_cmds = 64;
Darren Tuckerd8093e42006-05-04 16:24:34 +1000682 entcmd = xcalloc(num_cmds, sizeof(entropy_cmd_t));
Damien Miller62116dc2001-12-24 01:41:47 +1100683
684 /* Read in file */
Damien Miller7b10ef42002-01-21 23:44:12 +1100685 cur_cmd = linenum = 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100686 while (fgets(line, sizeof(line), f)) {
Damien Miller62116dc2001-12-24 01:41:47 +1100687 linenum++;
688
Damien Miller7b10ef42002-01-21 23:44:12 +1100689 /* Skip leading whitespace, blank lines and comments */
Damien Miller62116dc2001-12-24 01:41:47 +1100690 cp = line + strspn(line, WHITESPACE);
691 if ((*cp == 0) || (*cp == '#'))
692 continue; /* done with this line */
693
Damien Miller7b10ef42002-01-21 23:44:12 +1100694 /*
Damien Millera8e06ce2003-11-21 23:48:55 +1100695 * The first non-whitespace char should be a double quote
Damien Miller7b10ef42002-01-21 23:44:12 +1100696 * delimiting the commandline
697 */
Damien Miller62116dc2001-12-24 01:41:47 +1100698 if (*cp != '"') {
Damien Miller7b10ef42002-01-21 23:44:12 +1100699 error("bad entropy command, %.100s line %d",
700 cmdfilename, linenum);
Damien Miller62116dc2001-12-24 01:41:47 +1100701 continue;
702 }
703
Damien Miller7b10ef42002-01-21 23:44:12 +1100704 /*
705 * First token, command args (incl. argv[0]) in double
706 * quotes
707 */
Damien Miller62116dc2001-12-24 01:41:47 +1100708 cp = strtok(cp, "\"");
709 if (cp == NULL) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100710 error("missing or bad command string, %.100s "
711 "line %d -- ignored", cmdfilename, linenum);
Damien Miller62116dc2001-12-24 01:41:47 +1100712 continue;
713 }
714 strlcpy(cmd, cp, sizeof(cmd));
715
Damien Miller7b10ef42002-01-21 23:44:12 +1100716 /* Second token, full command path */
Damien Miller62116dc2001-12-24 01:41:47 +1100717 if ((cp = strtok(NULL, WHITESPACE)) == NULL) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100718 error("missing command path, %.100s "
719 "line %d -- ignored", cmdfilename, linenum);
Damien Miller62116dc2001-12-24 01:41:47 +1100720 continue;
721 }
722
Damien Miller7b10ef42002-01-21 23:44:12 +1100723 /* Did configure mark this as dead? */
Damien Miller62116dc2001-12-24 01:41:47 +1100724 if (strncmp("undef", cp, 5) == 0)
725 continue;
726
727 strlcpy(path, cp, sizeof(path));
728
Damien Miller7b10ef42002-01-21 23:44:12 +1100729 /* Third token, entropy rate estimate for this command */
Damien Miller62116dc2001-12-24 01:41:47 +1100730 if ((cp = strtok(NULL, WHITESPACE)) == NULL) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100731 error("missing entropy estimate, %.100s "
732 "line %d -- ignored", cmdfilename, linenum);
Damien Miller62116dc2001-12-24 01:41:47 +1100733 continue;
734 }
Damien Miller7b10ef42002-01-21 23:44:12 +1100735 est = strtod(cp, NULL);
Damien Miller62116dc2001-12-24 01:41:47 +1100736
737 /* end of line */
738 if ((cp = strtok(NULL, WHITESPACE)) != NULL) {
Damien Miller7b10ef42002-01-21 23:44:12 +1100739 error("garbage at end of line %d in %.100s "
740 "-- ignored", linenum, cmdfilename);
Damien Miller62116dc2001-12-24 01:41:47 +1100741 continue;
742 }
743
744 /* save the command for debug messages */
745 entcmd[cur_cmd].cmdstring = xstrdup(cmd);
746
747 /* split the command args */
748 cp = strtok(cmd, WHITESPACE);
749 arg = 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100750 do {
Damien Miller7b10ef42002-01-21 23:44:12 +1100751 entcmd[cur_cmd].args[arg] = xstrdup(cp);
Damien Miller62116dc2001-12-24 01:41:47 +1100752 arg++;
Damien Miller7b10ef42002-01-21 23:44:12 +1100753 } while(arg < NUM_ARGS && (cp = strtok(NULL, WHITESPACE)));
Damien Miller62116dc2001-12-24 01:41:47 +1100754
755 if (strtok(NULL, WHITESPACE))
Damien Miller7b10ef42002-01-21 23:44:12 +1100756 error("ignored extra commands (max %d), %.100s "
757 "line %d", NUM_ARGS, cmdfilename, linenum);
Damien Miller62116dc2001-12-24 01:41:47 +1100758
759 /* Copy the command path and rate estimate */
760 entcmd[cur_cmd].path = xstrdup(path);
761 entcmd[cur_cmd].rate = est;
762
763 /* Initialise other values */
764 entcmd[cur_cmd].sticky_badness = 1;
765
766 cur_cmd++;
767
Damien Miller7b10ef42002-01-21 23:44:12 +1100768 /*
769 * If we've filled the array, reallocate it twice the size
Damien Millera8e06ce2003-11-21 23:48:55 +1100770 * Do this now because even if this we're on the last
Damien Miller7b10ef42002-01-21 23:44:12 +1100771 * command we need another slot to mark the last entry
772 */
Damien Miller62116dc2001-12-24 01:41:47 +1100773 if (cur_cmd == num_cmds) {
774 num_cmds *= 2;
Damien Miller36812092006-03-26 14:22:47 +1100775 entcmd = xrealloc(entcmd, num_cmds,
Damien Miller7b10ef42002-01-21 23:44:12 +1100776 sizeof(entropy_cmd_t));
Damien Miller62116dc2001-12-24 01:41:47 +1100777 }
778 }
779
780 /* zero the last entry */
Damien Miller7b10ef42002-01-21 23:44:12 +1100781 memset(&entcmd[cur_cmd], '\0', sizeof(entropy_cmd_t));
Damien Miller62116dc2001-12-24 01:41:47 +1100782
783 /* trim to size */
Damien Miller36812092006-03-26 14:22:47 +1100784 entropy_cmds = xrealloc(entcmd, (cur_cmd + 1),
Damien Miller7b10ef42002-01-21 23:44:12 +1100785 sizeof(entropy_cmd_t));
Damien Miller62116dc2001-12-24 01:41:47 +1100786
Damien Miller7b10ef42002-01-21 23:44:12 +1100787 debug("Loaded %d entropy commands from %.100s", cur_cmd,
788 cmdfilename);
Damien Miller62116dc2001-12-24 01:41:47 +1100789
Darren Tuckerf58b29d2006-05-17 22:24:56 +1000790 fclose(f);
Damien Miller7b10ef42002-01-21 23:44:12 +1100791 return cur_cmd < MIN_ENTROPY_SOURCES ? -1 : 0;
Damien Miller62116dc2001-12-24 01:41:47 +1100792}
793
Damien Miller32e48182002-04-14 19:27:12 +1000794void
795usage(void)
796{
797 fprintf(stderr, "Usage: %s [options]\n", __progname);
798 fprintf(stderr, " -v Verbose; display verbose debugging messages.\n");
799 fprintf(stderr, " Multiple -v increases verbosity.\n");
Damien Miller7daf0442004-08-23 21:52:08 +1000800 fprintf(stderr, " -x Force output in hexadecimal (for debugging)\n");
Damien Miller32e48182002-04-14 19:27:12 +1000801 fprintf(stderr, " -X Force output in binary\n");
802 fprintf(stderr, " -b bytes Number of bytes to output (default %d)\n",
803 OUTPUT_SEED_SIZE);
804}
805
Damien Millera8e06ce2003-11-21 23:48:55 +1100806int
Damien Miller62116dc2001-12-24 01:41:47 +1100807main(int argc, char **argv)
808{
Damien Miller32e48182002-04-14 19:27:12 +1000809 unsigned char *buf;
810 int ret, ch, debug_level, output_hex, bytes;
811 extern char *optarg;
812 LogLevel ll;
Damien Miller62116dc2001-12-24 01:41:47 +1100813
Damien Miller59d3d5b2003-08-22 09:34:41 +1000814 __progname = ssh_get_progname(argv[0]);
Damien Miller62116dc2001-12-24 01:41:47 +1100815 log_init(argv[0], SYSLOG_LEVEL_INFO, SYSLOG_FACILITY_USER, 1);
816
Damien Miller32e48182002-04-14 19:27:12 +1000817 ll = SYSLOG_LEVEL_INFO;
818 debug_level = output_hex = 0;
819 bytes = OUTPUT_SEED_SIZE;
820
821 /* Don't write binary data to a tty, unless we are forced to */
822 if (isatty(STDOUT_FILENO))
823 output_hex = 1;
Damien Miller787b2ec2003-11-21 23:56:47 +1100824
Damien Miller32e48182002-04-14 19:27:12 +1000825 while ((ch = getopt(argc, argv, "vxXhb:")) != -1) {
826 switch (ch) {
827 case 'v':
828 if (debug_level < 3)
829 ll = SYSLOG_LEVEL_DEBUG1 + debug_level++;
830 break;
831 case 'x':
832 output_hex = 1;
833 break;
834 case 'X':
835 output_hex = 0;
836 break;
837 case 'b':
838 if ((bytes = atoi(optarg)) <= 0)
839 fatal("Invalid number of output bytes");
840 break;
841 case 'h':
842 usage();
843 exit(0);
844 default:
845 error("Invalid commandline option");
846 usage();
847 }
848 }
849
850 log_init(argv[0], ll, SYSLOG_FACILITY_USER, 1);
Damien Miller787b2ec2003-11-21 23:56:47 +1100851
Damien Miller7b10ef42002-01-21 23:44:12 +1100852#ifdef USE_SEED_FILES
853 prng_read_seedfile();
854#endif
855
Damien Miller32e48182002-04-14 19:27:12 +1000856 buf = xmalloc(bytes);
857
Damien Miller7b10ef42002-01-21 23:44:12 +1100858 /*
859 * Seed the RNG from wherever we can
860 */
Damien Miller787b2ec2003-11-21 23:56:47 +1100861
Damien Miller7b10ef42002-01-21 23:44:12 +1100862 /* Take whatever is on the stack, but don't credit it */
Damien Miller32e48182002-04-14 19:27:12 +1000863 RAND_add(buf, bytes, 0);
Damien Miller7b10ef42002-01-21 23:44:12 +1100864
Damien Millera8e06ce2003-11-21 23:48:55 +1100865 debug("Seeded RNG with %i bytes from system calls",
Damien Miller7b10ef42002-01-21 23:44:12 +1100866 (int)stir_from_system());
867
Darren Tucker8686ed72004-12-20 12:05:08 +1100868 /* try prngd, fall back to commands if prngd fails or not configured */
869 if (seed_from_prngd(buf, bytes) == 0) {
870 RAND_add(buf, bytes, bytes);
871 } else {
872 /* Read in collection commands */
873 if (prng_read_commands(SSH_PRNG_COMMAND_FILE) == -1)
874 fatal("PRNG initialisation failed -- exiting.");
875 debug("Seeded RNG with %i bytes from programs",
876 (int)stir_from_programs());
877 }
Damien Miller7b10ef42002-01-21 23:44:12 +1100878
879#ifdef USE_SEED_FILES
880 prng_write_seedfile();
881#endif
882
883 /*
884 * Write the seed to stdout
885 */
Damien Miller62116dc2001-12-24 01:41:47 +1100886
887 if (!RAND_status())
888 fatal("Not enough entropy in RNG");
889
Damien Millercafbcc72003-03-17 16:13:53 +1100890 if (RAND_bytes(buf, bytes) <= 0)
891 fatal("Couldn't extract entropy from PRNG");
Damien Miller62116dc2001-12-24 01:41:47 +1100892
Damien Miller32e48182002-04-14 19:27:12 +1000893 if (output_hex) {
894 for(ret = 0; ret < bytes; ret++)
895 printf("%02x", (unsigned char)(buf[ret]));
896 printf("\n");
897 } else
Darren Tucker8661b562003-07-06 15:20:46 +1000898 ret = atomicio(vwrite, STDOUT_FILENO, buf, bytes);
Damien Miller787b2ec2003-11-21 23:56:47 +1100899
Damien Miller32e48182002-04-14 19:27:12 +1000900 memset(buf, '\0', bytes);
901 xfree(buf);
Damien Miller787b2ec2003-11-21 23:56:47 +1100902
Damien Miller32e48182002-04-14 19:27:12 +1000903 return ret == bytes ? 0 : 1;
Damien Miller62116dc2001-12-24 01:41:47 +1100904}
Darren Tucker7b48d252005-02-16 13:20:07 +1100905
906/*
907 * We may attempt to re-seed during mkstemp if we are using the one in the
Darren Tucker7a8619a2005-02-16 13:32:30 +1100908 * compat library (via mkstemp -> _gettemp -> arc4random -> seed_rng) so we
909 * need our own seed_rng(). We must also check that we have enough entropy.
Darren Tucker7b48d252005-02-16 13:20:07 +1100910 */
911void
912seed_rng(void)
913{
914 if (!RAND_status())
915 fatal("Not enough entropy in RNG");
916}