General utilities cleanup. Add signature support to catcrypt. Throw in
[u/mdw/catacomb] / bbs.h
diff --git a/bbs.h b/bbs.h
index 2098745..7c9cbda 100644 (file)
--- a/bbs.h
+++ b/bbs.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: bbs.h,v 1.4 2000/06/17 10:45:48 mdw Exp $
+ * $Id: bbs.h,v 1.7 2004/04/08 01:36:15 mdw Exp $
  *
  * The Blum-Blum-Shub random bit generator
  *
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: bbs.h,v $
- * Revision 1.4  2000/06/17 10:45:48  mdw
- * Minor changes for key fetching.  Typesetting fixes.
- *
- * Revision 1.3  2000/02/12 18:21:02  mdw
- * Overhaul of key management (again).
- *
- * Revision 1.2  1999/12/22 15:52:08  mdw
- * Rename `bbs_params' to `bbs_param' for consistency.
- *
- * Revision 1.1  1999/12/10 23:14:59  mdw
- * Blum-Blum-Shub generator, and Blum-Goldwasser encryption.
- *
- */
-
 /*----- Notes on the BBS generator ----------------------------------------*
  *
  * The Blum-Blum-Shub generator takes the least significant bits from the
@@ -109,10 +92,10 @@ typedef struct bbs_pub {
   mp *n;
 } bbs_pub;
 
-typedef struct bbs_param {
+typedef struct bbs_priv {
   mp *p, *q;                           /* Prime factors (3 mod 4) */
   mp *n;                               /* Product @pq@ -- a Blum integer */
-} bbs_param, bbs_priv;
+} bbs_priv;
 
 /*----- Key fetching ------------------------------------------------------*/
 
@@ -122,6 +105,18 @@ extern const key_fetchdef bbs_pubfetch[];
 extern const key_fetchdef bbs_privfetch[];
 #define BBS_PRIVFETCHSZ 7
 
+/* --- @bbs_pubfree@, @bbs_privfree@ --- *
+ *
+ * Arguments:  @bbs_pub *bp@, @bbs_priv *bp@ = pointer to key block
+ *
+ * Returns:    ---
+ *
+ * Use:                Frees a BBS key block.
+ */
+
+extern void bbs_pubfree(bbs_pub */*bp*/);
+extern void bbs_privfree(bbs_priv */*bp*/);
+
 /*----- The basic generator -----------------------------------------------*/
 
 /* --- @bbs_create@ --- *
@@ -221,7 +216,7 @@ extern void bbs_wrap(bbs */*b*/);
 /* --- @bbs_ff@ --- *
  *
  * Arguments:  @bbs *b@ = pointer to a BBS generator state
- *             @bbs_param *bp@ = pointer to BBS modulus factors
+ *             @bbs_priv *bp@ = pointer to BBS modulus factors
  *             @unsigned long n@ = number of steps to make
  *
  * Returns:    ---
@@ -231,12 +226,12 @@ extern void bbs_wrap(bbs */*b*/);
  *             efficiently.
  */
 
-extern void bbs_ff(bbs */*b*/, bbs_param */*bp*/, unsigned long /*n*/);
+extern void bbs_ff(bbs */*b*/, bbs_priv */*bp*/, unsigned long /*n*/);
 
 /* --- @bbs_rew@ --- *
  *
  * Arguments:  @bbs *b@ = pointer to a BBS generator state
- *             @bbs_param *bp@ = pointer to BBS modulus factors
+ *             @bbs_priv *bp@ = pointer to BBS modulus factors
  *             @unsigned long n@ = number of steps to make
  *
  * Returns:    ---
@@ -246,13 +241,13 @@ extern void bbs_ff(bbs */*b*/, bbs_param */*bp*/, unsigned long /*n*/);
  *             at all.
  */
 
-extern void bbs_rew(bbs */*b*/, bbs_param */*bp*/, unsigned long /*n*/);
+extern void bbs_rew(bbs */*b*/, bbs_priv */*bp*/, unsigned long /*n*/);
 
 /*----- Parameter generation ----------------------------------------------*/
 
 /* --- @bbs_gen@ --- *
  *
- * Arguments:  @bbs_param *bp@ = pointer to parameter block
+ * Arguments:  @bbs_priv *bp@ = pointer to parameter block
  *             @unsigned nbits@ = number of bits in the modulus
  *             @grand *r@ = pointer to random number source
  *             @unsigned n@ = number of attempts to make
@@ -268,7 +263,7 @@ extern void bbs_rew(bbs */*b*/, bbs_param */*bp*/, unsigned long /*n*/);
  *             Shub pseudorandom bit generator.
  */
 
-extern int bbs_gen(bbs_param */*bp*/, unsigned /*nbits*/, grand */*r*/,
+extern int bbs_gen(bbs_priv */*bp*/, unsigned /*nbits*/, grand */*r*/,
                   unsigned /*n*/, pgen_proc */*event*/, void */*ectx*/);
 
 /*----- Generic random number generator interface -------------------------*/
@@ -289,7 +284,7 @@ extern grand *bbs_rand(mp */*m*/, mp */*x*/);
 /* --- Blum-Blum-Shub-specific misc op codes --- */
 
 enum {
-  BBS_SET = GRAND_SPECIFIC             /* @mp *x@ */
+  BBS_SET = GRAND_SPECIFIC('B')                /* @mp *x@ */
 };
 
 /*----- That's all, folks -------------------------------------------------*/