3 * Acquisition of environmental noise (Unix-specific)
5 * (c) 1998 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Catacomb.
12 * Catacomb is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Library General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
17 * Catacomb is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
22 * You should have received a copy of the GNU Library General Public
23 * License along with Catacomb; if not, write to the Free
24 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
28 /*----- Header files ------------------------------------------------------*/
39 #include <sys/types.h>
50 #if defined(HAVE_LINUX_RANDOM_H)
51 # include <linux/random.h>
52 # include <sys/syscall.h>
55 #include <mLib/bits.h>
56 #include <mLib/mdup.h>
64 /*----- Magical numbers ---------------------------------------------------*/
66 #define NOISE_KIDLIFE 100000 /* @noise_filter@ child lifetime */
67 #define MILLION 1000000 /* One million */
69 /*----- Noise source definition -------------------------------------------*/
71 const rand_source noise_source
= { noise_acquire
, noise_timer
};
73 /*----- Static variables --------------------------------------------------*/
75 /* --- Timer differences --- */
77 static unsigned long noise_last
; /* Last time recorded */
78 static unsigned long noise_diff
; /* Last first order difference */
80 /* --- Setuid program handling --- */
82 static uid_t noise_uid
= NOISE_NOSETUID
; /* Uid to set to spawn processes */
83 static gid_t noise_gid
= NOISE_NOSETGID
; /* Gid to set to spawn processes */
85 /*----- Main code ---------------------------------------------------------*/
87 /* --- @bitcount@ --- *
89 * Arguments: @unsigned long x@ = a word containing bits
91 * Returns: The number of bits set in the word.
94 static int bitcount(unsigned long x
)
96 static const char ctab
[] = { 0, 1, 1, 2, 1, 2, 2, 3,
97 1, 2, 2, 3, 2, 3, 3, 4 };
100 count
+= ctab
[x
& 0xfu
];
108 * Arguments: @rand_pool *r@ = pointer to randomness pool
109 * @struct timeval *tv@ = pointer to time block
111 * Returns: Nonzero if some randomness was contributed.
113 * Use: Low-level timer contributor.
116 static int timer(rand_pool
*r
, struct timeval
*tv
)
118 unsigned long x
, d
, dd
;
122 x
= tv
->tv_usec
+ MILLION
* tv
->tv_sec
;
129 rand_add(r
, tv
, sizeof(*tv
), de
<= dde ? de
: dde
);
131 BURN(tv
); x
= d
= dd
= de
= dde
= 0;
135 /* --- @noise_timer@ --- *
137 * Arguments: @rand_pool *r@ = pointer to a randomness pool
139 * Returns: Nonzero if some randomness was contributed.
141 * Use: Contributes the current time to the randomness pool.
142 * A guess at the number of useful bits contributed is made,
143 * based on first and second order bit differences. This isn't
144 * ever-so reliable, but it's better than nothing.
147 int noise_timer(rand_pool
*r
)
150 gettimeofday(&tv
, 0);
151 return (timer(r
, &tv
));
154 /* --- @noise_devrandom@ --- *
156 * Arguments: @rand_pool *r@ = pointer to a randomness pool
158 * Returns: Nonzero if some randomness was contributed.
160 * Use: Attempts to obtain some randomness from the system entropy
161 * pool. All bits from the device are assumed to be good.
164 int noise_devrandom(rand_pool
*r
)
167 octet buf
[RAND_POOLSZ
];
173 struct timeval tv
= { 0, 0 };
176 #if defined(HAVE_LINUX_RANDOM_H) && \
177 defined(GRND_NONBLOCK) && \
178 defined(SYS_getrandom)
179 /* --- Use the new shinies if available --- */
181 while (n
< sizeof(buf
)) {
182 if ((len
= syscall(SYS_getrandom
, buf
+ n
, sizeof(buf
) - n
,
183 GRND_NONBLOCK
)) <= 0) {
184 if (errno
== ENOSYS
) break;
189 if (n
== sizeof(buf
)) goto win
;
193 /* --- Don't take from `/dev/urandom' if `/dev/random' would block --- */
195 if ((fd
= open("/dev/random", O_RDONLY
| O_NONBLOCK
)) < 0) goto done
;
198 if (select(fd
+ 1, &infd
, 0, 0, &tv
) < 0 || !FD_ISSET(fd
, &infd
))
203 /* --- Be nice to other clients of the random device --- *
205 * Attempt to open the device nonblockingly. If that works, take up to
206 * one bufferful and then close again. If there's no data to be read,
207 * then that's tough and we go away again, on the grounds that the device
208 * needs to get some more entropy from somewhere.
212 (fd
= open("/dev/urandom", O_RDONLY
| O_NONBLOCK
)) >= 0 ||
213 (fd
= open("/dev/arandom", O_RDONLY
| O_NONBLOCK
)) >= 0 ||
214 (fd
= open("/dev/random", O_RDONLY
| O_NONBLOCK
)) >= 0) {
215 while (n
< sizeof(buf
)) {
216 if ((len
= read(fd
, buf
+ n
, sizeof(buf
) - n
)) <= 0) break;
219 if (n
== sizeof(buf
)) goto win
;
226 if (fd
>= 0) close(fd
);
227 rand_add(r
, buf
, n
, 8*n
);
233 /* --- @noise_setid@ --- *
235 * Arguments: @uid_t uid@ = uid to set
236 * @gid_t gid@ = gid to set
240 * Use: Sets the user and group ids to be used by @noise_filter@
241 * when running child processes. This is useful to avoid
242 * giving shell commands (even carefully written ones) undue
243 * privileges. This interface is Unix-specific
246 void noise_setid(uid_t uid
, gid_t gid
)
252 /* --- @noise_filter@ --- *
254 * Arguments: @rand_pool *r@ = pointer to a randomness pool
255 * @int good@ = number of good bits per 1024 bits
256 * @const char *c@ = shell command to run
258 * Returns: Nonzero if some randomness was contributed.
260 * Use: Attempts to execute a shell command, and dump it into the
261 * randomness pool. A very rough estimate of the number of
262 * good bits is made, based on the size of the command's output.
263 * This function calls @waitpid@, so be careful. Before execing
264 * the command, the process uid and gid are set to the values
265 * given to @noise_setid@, and an attempt is made to reset the
266 * list of supplementary groups. The environment passed to
267 * the command has been severly lobotimized. If the command
268 * fails to complete within a short time period, it is killed.
269 * Paranoid use of close-on-exec flags for file descriptors is
272 * This interface is Unix-specific.
283 static void kid_read(int fd
, unsigned mode
, void *p
)
285 struct noisekid
*nk
= p
;
290 if ((sz
= read(fd
, nk
->buf
, sizeof(nk
->buf
))) <= 0)
293 goodbits
= (sz
* nk
->good
) / 128;
294 rand_add(nk
->r
, nk
->buf
, sz
, goodbits
);
299 static void kid_dead(struct timeval
*tv
, void *p
)
300 { struct noisekid
*nk
= p
; nk
->donep
= 1; }
302 int noise_filter(rand_pool
*r
, int good
, const char *c
)
308 struct noisekid nk
= { 0 };
312 const char *env
[] = {
313 "PATH=/bin:/usr/bin:/sbin:/usr/sbin:/etc",
317 /* --- Remember when this business started --- */
319 gettimeofday(&dead
, 0);
322 /* --- Create a pipe --- */
327 /* --- Fork a child off --- */
337 /* --- Handle the child end of the deal --- */
343 /* --- Set the pipe as standard output, close standard input --- */
345 if ((f
= open("/dev/null", O_RDONLY
)) < 0) _exit(127);
346 mfd
[i
].cur
= f
; mfd
[i
].want
= 0; i
++;
347 mfd
[i
].cur
= fd
[1]; mfd
[i
].want
= 1; i
++;
348 mfd
[i
].cur
= f
; mfd
[i
].want
= 2; i
++;
349 if (mdup(mfd
, i
)) _exit(127);
351 /* --- Play games with uids --- */
353 if (noise_gid
!= NOISE_NOSETGID
) {
356 #ifdef HAVE_SETGROUPS
357 setgroups(1, &noise_gid
);
361 if (noise_uid
!= NOISE_NOSETUID
) {
366 /* --- Start the process up --- */
368 execle("/bin/sh", "sh", "-c", c
, (char *)0, env
);
372 /* --- Sort out my end of the deal --- */
376 nk
.r
= r
; nk
.good
= good
;
377 TV_ADDL(&dead
, &dead
, 0, NOISE_KIDLIFE
);
378 sel_initfile(&sel
, &sf
, fd
[0], SEL_READ
, kid_read
, &nk
);
380 sel_addtimer(&sel
, &st
, &dead
, kid_dead
, &nk
);
381 while (!nk
.donep
&& !sel_select(&sel
));
383 /* --- We've finished with it: kill the child process --- *
385 * This is morally questionable. On the other hand, I don't want to be
386 * held up in the @waitpid@ call if I can possibly help it. Maybe a
387 * double-fork is worth doing here.
398 /* --- @noise_freewheel@ --- *
400 * Arguments: @rand_pool *r@ = pointer to a randomness pool
402 * Returns: Nonzero if some randomness was contributed.
404 * Use: Runs a free counter for a short while as a desparate attempt
405 * to get randomness from somewhere. This is actually quite
411 static sigjmp_buf fwjmp
;
413 static void fwalarm(int sig
)
415 siglongjmp(fwjmp
, 1);
418 int noise_freewheel(rand_pool
*r
)
420 void (*sigal
)(int) = 0;
421 struct itimerval oitv
, itv
= { { 0, 0 }, { 0, 5000 } };
423 volatile uint32 fwcount
= 0;
425 if (!sigsetjmp(fwjmp
, 1)) {
426 if ((sigal
= signal(SIGALRM
, fwalarm
)) == SIG_ERR
)
428 if (setitimer(ITIMER_REAL
, &itv
, &oitv
))
434 STORE32(buf
, fwcount
);
435 rand_add(r
, buf
, sizeof(buf
), 16);
440 signal(SIGALRM
, sigal
);
441 if (oitv
.it_value
.tv_sec
|| oitv
.it_value
.tv_usec
)
442 TV_SUB(&oitv
.it_value
, &oitv
.it_value
, &itv
.it_value
);
443 setitimer(ITIMER_REAL
, &oitv
, 0);
449 int noise_freewheel(rand_pool
*r
)
456 /* --- @noise_enquire@ --- *
458 * Arguments: @rand_pool *r@ = pointer to a randomness pool
460 * Returns: Nonzero if some randomness was contributed.
462 * Use: Runs some shell commands to enquire about the prevailing
463 * environment. This can gather quite a lot of low-quality
467 int noise_enquire(rand_pool
*r
)
473 { "ps alxww || ps -elf", 16 },
475 { "ifconfig -a", 8 },
478 { "ls -align /tmp/.", 10 },
483 for (i
= 0; tab
[i
].cmd
; i
++)
484 noise_filter(r
, tab
[i
].rate
, tab
[i
].cmd
);
488 /* --- @noise_acquire@ --- *
490 * Arguments: @rand_pool *r@ = pointer to a randomness pool
494 * Use: Acquires some randomness from somewhere.
497 void noise_acquire(rand_pool
*r
)
500 for (i
= 0; i
< 8; i
++)
502 if (!noise_devrandom(r
) || getenv("CATACOMB_FORCE_ESOTERIC_SOURCES")) {
504 for (i
= 0; i
< 8; i
++)
509 /*----- That's all, folks -------------------------------------------------*/