Add an internal-representation no-op function.

[u/mdw/catacomb] / rand.h

diff --git a/rand.h b/rand.h
index 543af41..05721fc 100644 (file)
--- a/rand.h
+++ b/rand.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: rand.h,v 1.4 1999/12/10 23:29:48 mdw Exp $
+ * $Id: rand.h,v 1.8 2001/02/03 16:07:33 mdw Exp $
  *
  * Secure random number generator
  *
@@ -30,6 +30,20 @@
 /*----- Revision history --------------------------------------------------* 
  *
  * $Log: rand.h,v $
+ * Revision 1.8  2001/02/03 16:07:33  mdw
+ * Give generic random objects separate namespaces for their supported misc
+ * ops.
+ *
+ * Revision 1.7  2000/10/08 12:07:18  mdw
+ * Remove spurious comma in enum.
+ *
+ * Revision 1.6  2000/06/17 11:53:38  mdw
+ * Deprecate `rand_getgood'.  Provide a new interface to ensure that a pool
+ * is well seeded.
+ *
+ * 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.
  *
@@ -169,6 +183,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
@@ -250,7 +279,7 @@ extern void rand_stretch(rand_pool */*r*/);
  * Use:                Gets random data from the pool.  The pool's contents can't be
  *             determined from the output of this function; nor can the
  *             output data be determined from a knowledge of the data input
- *             to the pool wihtout also having knowledge of the secret key.
+ *             to the pool without also having knowledge of the secret key.
  *             The good bits counter is decremented, although no special
  *             action is taken if it reaches zero.
  */
@@ -281,10 +310,11 @@ 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@ */
 };
 
 /* --- Default random number generator --- */