3 * Secure random number generator
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 ------------------------------------------------------*/
36 #include <mLib/bits.h>
48 #include "twofish-counter.h"
51 #define CIPHER_CTX twofish_counterctx
52 #define CIPHER_INIT twofish_counterinit
53 #define CIPHER_ENCRYPT twofish_counterencrypt
54 #define CIPHER_IVSZ TWOFISH_BLKSZ
55 #define CIPHER_KEYSZ TWOFISH_KEYSZ
57 #define HASH_CTX sha256_ctx
58 #define HASH_INIT sha256_init
59 #define HASH sha256_hash
60 #define HASH_DONE sha256_done
61 #define HASH_SZ SHA256_HASHSZ
63 /*----- Static variables --------------------------------------------------*/
65 static const grand_ops gops
;
67 typedef struct rand__gctx
{
76 { "Catacomb global random byte pool" },
80 /*----- Macros ------------------------------------------------------------*/
82 #define RAND_RESOLVE(r) \
83 do { if ((r) == RAND_GLOBAL) r = &rand_global.p; } while (0)
85 #define GENCHECK(r) do { \
86 unsigned gen = rand_generation(); \
87 if (r->gen != gen) { r->gen = gen; rand_gate(r); } \
90 static int quick(rand_pool
*);
91 #define QUICK(r) do { \
93 if ((r)->s && (r)->s->timer) (r)->s->timer(r); \
96 /*----- Main code ---------------------------------------------------------*/
98 /* --- @rand_init@ --- *
100 * Arguments: @rand_pool *r@ = pointer to a randomness pool
104 * Use: Initializes a randomness pool. The pool doesn't start out
105 * very random: that's your job to sort out. A good suggestion
106 * would be to attach an appropriate noise source and call
110 void rand_init(rand_pool
*r
)
113 memset(r
->pool
, 0, sizeof(r
->pool
));
114 memset(r
->buf
, 0, sizeof(r
->buf
));
115 r
->gen
= rand_generation();
118 r
->ibits
= r
->obits
= 0;
120 r
->s
= &noise_source
;
125 /* --- @rand_noisesrc@ --- *
127 * Arguments: @rand_pool *r@ = pointer to a randomness pool
128 * @const rand_source *s@ = pointer to source definition
132 * Use: Sets a noise source for a randomness pool. When the pool's
133 * estimate of good random bits falls to zero, the @getnoise@
134 * function is called, passing the pool handle as an argument.
135 * It is expected to increase the number of good bits by at
136 * least one, because it'll be called over and over again until
137 * there are enough bits to satisfy the caller. The @timer@
138 * function is called frequently throughout the generator's
142 void rand_noisesrc(rand_pool
*r
, const rand_source
*s
)
148 /* --- @rand_quick@ --- *
150 * Arguments: @rand_pool *r@ = pointer to a randomness pool
152 * Returns: Zero on success; @-1@ on failure.
154 * Use Attempts to use some machine-specific `quick' source of
155 * entropy to top up @r@. This may not do anything at all on
159 CPU_DISPATCH(static, return, int, quick
, (rand_pool
*r
), (r
),
160 pick_quick
, trivial_quick
);
162 static int trivial_quick(rand_pool
*r
) { return (-1); }
164 static quick__functype
*pick_quick(void)
166 DISPATCH_PICK_FALLBACK(rand_quick
, trivial_quick
);
169 int rand_quick(rand_pool
*r
) { RAND_RESOLVE(r
); return (quick(r
)); }
171 /* --- @rand_seed@ --- *
173 * Arguments: @rand_pool *r@ = pointer to a randomness pool
174 * @unsigned bits@ = number of bits to ensure
178 * Use: Ensures that there are at least @bits@ good bits of entropy
179 * in the pool. It is recommended that you call this after
180 * initializing a new pool. Requesting @bits > RAND_IBITS@ is
181 * doomed to failure (and is an error).
184 void rand_seed(rand_pool
*r
, unsigned bits
)
188 assert(((void)"bits pointlessly large in rand_seed", bits
<= RAND_IBITS
));
189 assert(((void)"no noise source in rand_seed", r
->s
));
191 while (r
->ibits
< bits
)
196 /* --- @rand_key@ --- *
198 * Arguments: @rand_pool *r@ = pointer to a randomness pool
199 * @const void *k@ = pointer to key data
200 * @size_t sz@ = size of key data
204 * Use: Sets the secret key for a randomness pool. The key is used
205 * when mixing in new random bits.
208 void rand_key(rand_pool
*r
, const void *k
, size_t sz
)
212 static const char label
[] = "Catacomb random pool key";
216 assert(HASH_SZ
>= RAND_KEYSZ
);
218 HASH(&hc
, label
, sizeof(label
));
219 if (sz
) HASH(&hc
, k
, sz
);
221 memcpy(r
->k
.k
, h
, RAND_KEYSZ
);
224 /* --- @rand_add@ --- *
226 * Arguments: @rand_pool *r@ = pointer to a randomness pool
227 * @const void *p@ = pointer a buffer of data to add
228 * @size_t sz@ = size of the data buffer
229 * @unsigned goodbits@ = number of good bits estimated in buffer
233 * Use: Mixes the data in the buffer with the contents of the
234 * pool. The estimate of the number of good bits is added to
235 * the pool's own count. The mixing operation is not
236 * cryptographically strong. However, data in the input pool
237 * isn't output directly, only through the one-way gating
238 * operation, so that shouldn't matter.
241 void rand_add(rand_pool
*r
, const void *p
, size_t sz
, unsigned goodbits
)
246 #if RAND_POOLSZ != 128
247 # error Polynomial in rand_add is out of date. Fix it.
252 i
= r
->i
; rot
= r
->irot
;
256 r
->pool
[i
] ^= (ROL8(o
, rot
) ^
257 r
->pool
[(i
+ 1) % RAND_POOLSZ
] ^
258 r
->pool
[(i
+ 2) % RAND_POOLSZ
] ^
259 r
->pool
[(i
+ 7) % RAND_POOLSZ
]);
261 i
++; if (i
>= RAND_POOLSZ
) i
-= RAND_POOLSZ
;
267 r
->ibits
+= goodbits
;
268 if (r
->ibits
> RAND_IBITS
)
269 r
->ibits
= RAND_IBITS
;
272 /* --- @rand_goodbits@ --- *
274 * Arguments: @rand_pool *r@ = pointer to a randomness pool
276 * Returns: Estimate of the number of good bits remaining in the pool.
279 unsigned rand_goodbits(rand_pool
*r
)
282 return (r
->ibits
+ r
->obits
);
285 /* --- @rand_gate@ --- *
287 * Arguments: @rand_pool *r@ = pointer to a randomness pool
291 * Use: Mixes up the entire state of the generator in a nonreversible
295 void rand_gate(rand_pool
*r
)
297 octet h
[HASH_SZ
], g
[4];
304 /* --- Hash up all the data in the pool --- */
307 STORE32(g
, r
->gen
); HASH(&hc
, g
, sizeof(g
));
308 HASH(&hc
, r
->pool
, RAND_POOLSZ
);
309 HASH(&hc
, r
->buf
, RAND_BUFSZ
);
313 /* --- Now mangle all of the data based on the hash --- */
315 assert(CIPHER_KEYSZ
<= HASH_SZ
);
316 CIPHER_INIT(&cc
, h
, CIPHER_KEYSZ
, 0);
317 CIPHER_ENCRYPT(&cc
, r
->pool
, r
->pool
, RAND_POOLSZ
);
318 CIPHER_ENCRYPT(&cc
, r
->buf
, r
->buf
, RAND_BUFSZ
);
321 /* --- Reset the various state variables --- */
324 r
->obits
+= r
->ibits
;
325 if (r
->obits
> RAND_OBITS
) {
326 r
->ibits
= r
->obits
- r
->ibits
;
327 r
->obits
= RAND_OBITS
;
333 /* --- @rand_stretch@ --- *
335 * Arguments: @rand_pool *r@ = pointer to a randomness pool
339 * Use: Stretches the contents of the output buffer by transforming
340 * it in a nonreversible way. This doesn't add any entropy
341 * worth speaking about, but it works well enough when the
342 * caller doesn't care about that sort of thing.
345 void rand_stretch(rand_pool
*r
)
347 octet h
[HASH_SZ
], g
[4];
354 /* --- Hash up all the data in the buffer --- */
357 STORE32(g
, r
->gen
); HASH(&hc
, g
, sizeof(g
));
358 HASH(&hc
, r
->pool
, RAND_POOLSZ
);
359 HASH(&hc
, r
->buf
, RAND_BUFSZ
);
363 /* --- Now mangle the buffer based on the hash --- */
365 assert(CIPHER_KEYSZ
<= HASH_SZ
);
366 CIPHER_INIT(&cc
, h
, CIPHER_KEYSZ
, 0);
367 CIPHER_ENCRYPT(&cc
, r
->buf
, r
->buf
, RAND_BUFSZ
);
370 /* --- Reset the various state variables --- */
376 /* --- @rand_get@ --- *
378 * Arguments: @rand_pool *r@ = pointer to a randomness pool
379 * @void *p@ = pointer to output buffer
380 * @size_t sz@ = size of output buffer
384 * Use: Gets random data from the pool. The pool's contents can't be
385 * determined from the output of this function; nor can the
386 * output data be determined from a knowledge of the data input
387 * to the pool wihtout also having knowledge of the secret key.
388 * The good bits counter is decremented, although no special
389 * action is taken if it reaches zero.
392 void rand_get(rand_pool
*r
, void *p
, size_t sz
)
403 if (r
->o
+ sz
<= RAND_BUFSZ
) {
404 memcpy(o
, r
->buf
+ r
->o
, sz
);
408 size_t chunk
= RAND_BUFSZ
- r
->o
;
410 memcpy(o
, r
->buf
+ r
->o
, chunk
);
418 if (r
->obits
> sz
* 8)
424 /* --- @rand_getgood@ --- *
426 * Arguments: @rand_pool *r@ = pointer to a randomness pool
427 * @void *p@ = pointer to output buffer
428 * @size_t sz@ = size of output buffer
432 * Use: Gets random data from the pool, ensuring that there are
433 * enough good bits. This interface isn't recommended: it makes
434 * the generator slow, and doesn't provide much more security
435 * than @rand_get@, assuming you've previously done a
439 void rand_getgood(rand_pool
*r
, void *p
, size_t sz
)
447 if (!r
->s
|| !r
->s
->getnoise
) {
457 if (chunk
* 8 > r
->obits
) {
458 if (chunk
* 8 > r
->ibits
+ r
->obits
)
459 do r
->s
->getnoise(r
); while (r
->ibits
+ r
->obits
< 256);
461 if (chunk
* 8 > r
->obits
)
462 chunk
= r
->obits
/ 8;
465 if (chunk
+ r
->o
> RAND_BUFSZ
)
466 chunk
= RAND_BUFSZ
- r
->o
;
468 memcpy(o
, r
->buf
+ r
->o
, chunk
);
470 r
->obits
-= chunk
* 8;
476 /*----- Generic random number generator interface -------------------------*/
478 static void gdestroy(grand
*r
)
481 if (g
!= &rand_global
) {
487 static int gmisc(grand
*r
, unsigned op
, ...)
496 switch (va_arg(ap
, unsigned)) {
499 case GRAND_SEEDUINT32
:
500 case GRAND_SEEDBLOCK
:
517 case GRAND_SEEDINT
: {
518 unsigned u
= va_arg(ap
, unsigned);
519 rand_add(&g
->p
, &u
, sizeof(u
), sizeof(u
));
521 case GRAND_SEEDUINT32
: {
522 uint32 i
= va_arg(ap
, uint32
);
523 rand_add(&g
->p
, &i
, sizeof(i
), 4);
525 case GRAND_SEEDBLOCK
: {
526 const void *p
= va_arg(ap
, const void *);
527 size_t sz
= va_arg(ap
, size_t);
528 rand_add(&g
->p
, p
, sz
, sz
);
530 case GRAND_SEEDRAND
: {
531 grand
*rr
= va_arg(ap
, grand
*);
533 rr
->ops
->fill(rr
, buf
, sizeof(buf
));
534 rand_add(&g
->p
, buf
, sizeof(buf
), 8);
543 const void *k
= va_arg(ap
, const void *);
544 size_t sz
= va_arg(ap
, size_t);
545 rand_key(&g
->p
, k
, sz
);
548 rand_noisesrc(&g
->p
, va_arg(ap
, const rand_source
*));
551 rand_seed(&g
->p
, va_arg(ap
, unsigned));
557 rc
= rand_goodbits(&g
->p
);
560 const void *p
= va_arg(ap
, const void *);
561 size_t sz
= va_arg(ap
, size_t);
562 unsigned goodbits
= va_arg(ap
, unsigned);
563 rand_add(&g
->p
, p
, sz
, goodbits
);
574 static octet
gbyte(grand
*r
)
578 rand_getgood(&g
->p
, &o
, 1);
582 static uint32
gword(grand
*r
)
586 rand_getgood(&g
->p
, &b
, sizeof(b
));
590 static void gfill(grand
*r
, void *p
, size_t sz
)
593 rand_get(&g
->p
, p
, sz
);
596 static const grand_ops gops
= {
600 gword
, gbyte
, gword
, grand_defaultrange
, gfill
603 /* --- @rand_create@ --- *
607 * Returns: Pointer to a generic generator.
609 * Use: Constructs a generic generator interface over a Catacomb
610 * entropy pool generator.
613 grand
*rand_create(void)
615 gctx
*g
= S_CREATE(gctx
);
621 /*----- That's all, folks -------------------------------------------------*/