X-Git-Url: https://git.distorted.org.uk/u/mdw/catacomb/blobdiff_plain/21c9a0ff462ba8cb1769b8ceb4277c8d99f56bf8..1d6d3b01cb40e0cfaeb816c87c513695aea0816a:/rand.h diff --git a/rand.h b/rand.h index 2f23440..5d542b8 100644 --- a/rand.h +++ b/rand.h @@ -1,13 +1,13 @@ /* -*-c-*- * - * $Id: rand.h,v 1.5 1999/12/13 15:34:15 mdw Exp $ + * $Id$ * * Secure random number generator * * (c) 1999 Straylight/Edgeware */ -/*----- Licensing notice --------------------------------------------------* +/*----- Licensing notice --------------------------------------------------* * * This file is part of Catacomb. * @@ -15,38 +15,18 @@ * it under the terms of the GNU Library General Public License as * published by the Free Software Foundation; either version 2 of the * License, or (at your option) any later version. - * + * * Catacomb is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Library General Public License for more details. - * + * * You should have received a copy of the GNU Library General Public * License along with Catacomb; if not, write to the Free * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, * MA 02111-1307, USA. */ -/*----- Revision history --------------------------------------------------* - * - * $Log: rand.h,v $ - * Revision 1.5 1999/12/13 15:34:15 mdw - * Fix a typo. - * - * Revision 1.4 1999/12/10 23:29:48 mdw - * Change header file guard names. - * - * Revision 1.3 1999/10/15 21:04:30 mdw - * Increase output buffer a bit for performance. - * - * Revision 1.2 1999/10/12 21:00:15 mdw - * Make pool and buffer sizes more sensible. - * - * Revision 1.1 1999/09/03 08:41:12 mdw - * Initial import. - * - */ - /*----- Notes on the random number generator ------------------------------* * * The algorithm is one of the author's own devising. It may therefore be @@ -172,6 +152,21 @@ extern void rand_init(rand_pool */*r*/); extern void rand_noisesrc(rand_pool */*r*/, const rand_source */*s*/); +/* --- @rand_seed@ --- * + * + * Arguments: @rand_pool *r@ = pointer to a randomness pool + * @unsigned bits@ = number of bits to ensure + * + * Returns: --- + * + * Use: Ensures that there are at least @bits@ good bits of entropy + * in the pool. It is recommended that you call this after + * initializing a new pool. Requesting @bits > RAND_IBITS@ is + * doomed to failure (and is an error). + */ + +extern void rand_seed(rand_pool */*r*/, unsigned /*bits*/); + /* --- @rand_key@ --- * * * Arguments: @rand_pool *r@ = pointer to a randomness pool @@ -209,9 +204,9 @@ extern void rand_add(rand_pool */*r*/, /* --- @rand_goodbits@ --- * * - * Arguments: @rand_pool *r@ = pointer to a randomness pool + * Arguments: @rand_pool *r@ = pointer to a randomness pool * - * Returns: Estimate of the number of good bits remaining in the pool. + * Returns: Estimate of the number of good bits remaining in the pool. */ extern unsigned rand_goodbits(rand_pool */*r*/); @@ -284,10 +279,15 @@ extern void rand_getgood(rand_pool */*r*/, void */*p*/, size_t /*sz*/); /* --- Miscellaneous operations --- */ enum { - RAND_GATE = GRAND_SPECIFIC, /* No args */ + RAND_GATE = GRAND_SPECIFIC('R'), /* No args */ RAND_STRETCH, /* No args */ RAND_KEY, /* @const void *k, size_t sz@ */ - RAND_NOISESRC /* @const rand_source *s@ */ + RAND_NOISESRC, /* @const rand_source *s@ */ + RAND_SEED, /* @unsigned bits@ */ + RAND_TIMER, /* No args */ + RAND_GOODBITS, /* No args */ + RAND_ADD /* @const void *p, size_t sz,@ + * @unsigned goodbits */ }; /* --- Default random number generator --- */