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 ------------------------------------------------------*/
38 #include <sys/types.h>
49 #include <mLib/bits.h>
50 #include <mLib/mdup.h>
58 /*----- Magical numbers ---------------------------------------------------*/
60 #define NOISE_KIDLIFE 100000 /* @noise_filter@ child lifetime */
61 #define MILLION 1000000 /* One million */
63 /*----- Noise source definition -------------------------------------------*/
65 const rand_source noise_source
= { noise_acquire
, noise_timer
};
67 /*----- Static variables --------------------------------------------------*/
69 /* --- Timer differences --- */
71 static unsigned long noise_last
; /* Last time recorded */
72 static unsigned long noise_diff
; /* Last first order difference */
74 /* --- Setuid program handling --- */
76 static uid_t noise_uid
= NOISE_NOSETUID
; /* Uid to set to spawn processes */
77 static gid_t noise_gid
= NOISE_NOSETGID
; /* Gid to set to spawn processes */
79 /*----- Main code ---------------------------------------------------------*/
81 /* --- @bitcount@ --- *
83 * Arguments: @unsigned long x@ = a word containing bits
85 * Returns: The number of bits set in the word.
88 static int bitcount(unsigned long x
)
90 static const char ctab
[] = { 0, 1, 1, 2, 1, 2, 2, 3,
91 1, 2, 2, 3, 2, 3, 3, 4 };
94 count
+= ctab
[x
& 0xfu
];
102 * Arguments: @rand_pool *r@ = pointer to randomness pool
103 * @struct timeval *tv@ = pointer to time block
105 * Returns: Nonzero if some randomness was contributed.
107 * Use: Low-level timer contributor.
110 static int timer(rand_pool
*r
, struct timeval
*tv
)
112 unsigned long x
, d
, dd
;
116 x
= tv
->tv_usec
+ MILLION
* tv
->tv_sec
;
123 rand_add(r
, tv
, sizeof(*tv
), de
<= dde ? de
: dde
);
125 BURN(tv
); x
= d
= dd
= de
= dde
= 0;
129 /* --- @noise_timer@ --- *
131 * Arguments: @rand_pool *r@ = pointer to a randomness pool
133 * Returns: Nonzero if some randomness was contributed.
135 * Use: Contributes the current time to the randomness pool.
136 * A guess at the number of useful bits contributed is made,
137 * based on first and second order bit differences. This isn't
138 * ever-so reliable, but it's better than nothing.
141 int noise_timer(rand_pool
*r
)
144 gettimeofday(&tv
, 0);
145 return (timer(r
, &tv
));
148 /* --- @noise_devrandom@ --- *
150 * Arguments: @rand_pool *r@ = pointer to a randomness pool
152 * Returns: Nonzero if some randomness was contributed.
154 * Use: Attempts to obtain some randomness from the system entropy
155 * pool. All bits from the device are assumed to be good.
158 int noise_devrandom(rand_pool
*r
)
161 octet buf
[RAND_POOLSZ
];
167 struct timeval tv
= { 0, 0 };
171 /* --- Don't take from `/dev/urandom' if `/dev/random' would block --- */
173 if ((fd
= open("/dev/random", O_RDONLY
| O_NONBLOCK
)) < 0) goto done
;
176 if (select(fd
+ 1, &infd
, 0, 0, &tv
) < 0 || !FD_ISSET(fd
, &infd
))
181 /* --- Be nice to other clients of the random device --- *
183 * Attempt to open the device nonblockingly. If that works, take up to
184 * one bufferful and then close again. If there's no data to be read,
185 * then that's tough and we go away again, on the grounds that the device
186 * needs to get some more entropy from somewhere.
190 (fd
= open("/dev/urandom", O_RDONLY
| O_NONBLOCK
)) >= 0 ||
191 (fd
= open("/dev/arandom", O_RDONLY
| O_NONBLOCK
)) >= 0 ||
192 (fd
= open("/dev/random", O_RDONLY
| O_NONBLOCK
)) >= 0) {
193 while (n
< sizeof(buf
)) {
194 if ((len
= read(fd
, buf
+ n
, sizeof(buf
) - n
)) <= 0) break;
197 if (n
== sizeof(buf
)) goto win
;
204 if (fd
>= 0) close(fd
);
205 rand_add(r
, buf
, n
, 8*n
);
211 /* --- @noise_setid@ --- *
213 * Arguments: @uid_t uid@ = uid to set
214 * @gid_t gid@ = gid to set
218 * Use: Sets the user and group ids to be used by @noise_filter@
219 * when running child processes. This is useful to avoid
220 * giving shell commands (even carefully written ones) undue
221 * privileges. This interface is Unix-specific
224 void noise_setid(uid_t uid
, gid_t gid
)
230 /* --- @noise_filter@ --- *
232 * Arguments: @rand_pool *r@ = pointer to a randomness pool
233 * @int good@ = number of good bits per 1024 bits
234 * @const char *c@ = shell command to run
236 * Returns: Nonzero if some randomness was contributed.
238 * Use: Attempts to execute a shell command, and dump it into the
239 * randomness pool. A very rough estimate of the number of
240 * good bits is made, based on the size of the command's output.
241 * This function calls @waitpid@, so be careful. Before execing
242 * the command, the process uid and gid are set to the values
243 * given to @noise_setid@, and an attempt is made to reset the
244 * list of supplementary groups. The environment passed to
245 * the command has been severly lobotimized. If the command
246 * fails to complete within a short time period, it is killed.
247 * Paranoid use of close-on-exec flags for file descriptors is
250 * This interface is Unix-specific.
261 static void kid_read(int fd
, unsigned mode
, void *p
)
263 struct noisekid
*nk
= p
;
268 if ((sz
= read(fd
, nk
->buf
, sizeof(nk
->buf
))) <= 0)
271 goodbits
= (sz
* nk
->good
) / 128;
272 rand_add(nk
->r
, nk
->buf
, sz
, goodbits
);
277 static void kid_dead(struct timeval
*tv
, void *p
)
278 { struct noisekid
*nk
= p
; nk
->donep
= 1; }
280 int noise_filter(rand_pool
*r
, int good
, const char *c
)
286 struct noisekid nk
= { 0 };
290 const char *env
[] = {
291 "PATH=/bin:/usr/bin:/sbin:/usr/sbin:/etc",
295 /* --- Remember when this business started --- */
297 gettimeofday(&dead
, 0);
300 /* --- Create a pipe --- */
305 /* --- Fork a child off --- */
315 /* --- Handle the child end of the deal --- */
321 /* --- Set the pipe as standard output, close standard input --- */
323 if ((f
= open("/dev/null", O_RDONLY
)) < 0) _exit(127);
324 mfd
[i
].cur
= f
; mfd
[i
].want
= 0; i
++;
325 mfd
[i
].cur
= fd
[1]; mfd
[i
].want
= 1; i
++;
326 mfd
[i
].cur
= f
; mfd
[i
].want
= 2; i
++;
327 if (mdup(mfd
, i
)) _exit(127);
329 /* --- Play games with uids --- */
331 if (noise_gid
!= NOISE_NOSETGID
) {
334 #ifdef HAVE_SETGROUPS
335 setgroups(1, &noise_gid
);
339 if (noise_uid
!= NOISE_NOSETUID
) {
344 /* --- Start the process up --- */
346 execle("/bin/sh", "sh", "-c", c
, (char *)0, env
);
350 /* --- Sort out my end of the deal --- */
354 nk
.r
= r
; nk
.good
= good
;
355 TV_ADDL(&dead
, &dead
, 0, NOISE_KIDLIFE
);
356 sel_initfile(&sel
, &sf
, fd
[0], SEL_READ
, kid_read
, &nk
);
358 sel_addtimer(&sel
, &st
, &dead
, kid_dead
, &nk
);
359 while (!nk
.donep
&& !sel_select(&sel
));
361 /* --- We've finished with it: kill the child process --- *
363 * This is morally questionable. On the other hand, I don't want to be
364 * held up in the @waitpid@ call if I can possibly help it. Maybe a
365 * double-fork is worth doing here.
376 /* --- @noise_freewheel@ --- *
378 * Arguments: @rand_pool *r@ = pointer to a randomness pool
380 * Returns: Nonzero if some randomness was contributed.
382 * Use: Runs a free counter for a short while as a desparate attempt
383 * to get randomness from somewhere. This is actually quite
389 static sigjmp_buf fwjmp
;
391 static void fwalarm(int sig
)
393 siglongjmp(fwjmp
, 1);
396 int noise_freewheel(rand_pool
*r
)
398 void (*sigal
)(int) = 0;
399 struct itimerval oitv
, itv
= { { 0, 0 }, { 0, 5000 } };
401 volatile uint32 fwcount
= 0;
403 if (!sigsetjmp(fwjmp
, 1)) {
404 if ((sigal
= signal(SIGALRM
, fwalarm
)) == SIG_ERR
)
406 if (setitimer(ITIMER_REAL
, &itv
, &oitv
))
412 STORE32(buf
, fwcount
);
413 rand_add(r
, buf
, sizeof(buf
), 16);
418 signal(SIGALRM
, sigal
);
419 if (oitv
.it_value
.tv_sec
|| oitv
.it_value
.tv_usec
)
420 TV_SUB(&oitv
.it_value
, &oitv
.it_value
, &itv
.it_value
);
421 setitimer(ITIMER_REAL
, &oitv
, 0);
427 int noise_freewheel(rand_pool
*r
)
434 /* --- @noise_enquire@ --- *
436 * Arguments: @rand_pool *r@ = pointer to a randomness pool
438 * Returns: Nonzero if some randomness was contributed.
440 * Use: Runs some shell commands to enquire about the prevailing
441 * environment. This can gather quite a lot of low-quality
445 int noise_enquire(rand_pool
*r
)
451 { "ps alxww || ps -elf", 16 },
453 { "ifconfig -a", 8 },
456 { "ls -align /tmp/.", 10 },
461 for (i
= 0; tab
[i
].cmd
; i
++)
462 noise_filter(r
, tab
[i
].rate
, tab
[i
].cmd
);
466 /* --- @noise_acquire@ --- *
468 * Arguments: @rand_pool *r@ = pointer to a randomness pool
472 * Use: Acquires some randomness from somewhere.
475 void noise_acquire(rand_pool
*r
)
478 for (i
= 0; i
< 8; i
++)
480 if (!noise_devrandom(r
) || getenv("CATACOMB_FORCE_ESOTERIC_SOURCES")) {
482 for (i
= 0; i
< 8; i
++)
487 /*----- That's all, folks -------------------------------------------------*/