cc.h: Reorder the declarations.

[u/mdw/catacomb] / group.h

diff --git a/group.h b/group.h
index d099a8f..a144706 100644 (file)
--- a/group.h
+++ b/group.h
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: group.h,v 1.2 2004/04/03 03:32:05 mdw Exp $
+ * $Id$
  *
  * General cyclic group abstraction
  *
  * (c) 2004 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of Catacomb.
  *
@@ -15,33 +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: group.h,v $
- * Revision 1.2  2004/04/03 03:32:05  mdw
- * General robustification.
- *
- * Revision 1.1  2004/04/01 12:50:09  mdw
- * Add cyclic group abstraction, with test code.  Separate off exponentation
- * functions for better static linking.  Fix a buttload of bugs on the way.
- * Generally ensure that negative exponents do inversion correctly.  Add
- * table of standard prime-field subgroups.  (Binary field subgroups are
- * currently unimplemented but easy to add if anyone ever finds a good one.)
- *
- */
-
 #ifndef CATACOMB_GROUP_H
 #define CATACOMB_GROUP_H
 
@@ -82,7 +67,7 @@
 typedef struct group_ {
   const struct group_ops *ops;         /* Operations table */
   size_t nbits;                                /* Size of an element in bits */
-  size_t noctets;                      /* Size of an element in octets */
+  size_t noctets;                      /* Size of raw element in octets */
   ge *i;                               /* Identity element */
   ge *g;                               /* Generator element */
   mp *r;                               /* Order of the generator */
@@ -95,7 +80,11 @@ typedef struct group_expfactor {
 } group_expfactor;
 
 typedef struct group_ops {
+
+  /* --- General information --- */
+
   unsigned ty;                         /* Type of this group */
+  const char *name;                    /* Textual name string */
 
   /* --- Memory management --- */
 
@@ -137,9 +126,11 @@ typedef struct group_ops {
   mp *(*toint)(group */*g*/, mp */*d*/, ge */*x*/);
   int (*fromint)(group */*g*/, ge */*d*/, mp */*x*/);
   int (*toec)(group */*g*/, ec */*d*/, ge */*x*/);
-  int (*fromec)(group */*g*/, ge */*d*/, ec */*p*/);
+  int (*fromec)(group */*g*/, ge */*d*/, const ec */*p*/);
   int (*tobuf)(group */*h*/, buf */*b*/, ge */*x*/);
   int (*frombuf)(group */*h*/, buf */*b*/, ge */*d*/);
+  int (*toraw)(group */*h*/, buf */*b*/, ge */*x*/);
+  int (*fromraw)(group */*h*/, buf */*b*/, ge */*d*/);
 
 } group_ops;
 
@@ -149,6 +140,9 @@ enum {
   GTY_EC                               /* Elliptic curve group */
 };
 
+#define G_NAME(g)              (g)->ops->name
+#define G_TYPE(g)              (g)->ops->ty
+
 #define G_DESTROYGROUP(g)      (g)->ops->destroygroup((g))
 #define G_CREATE(g)            (g)->ops->create((g))
 #define G_COPY(g, d, x)                (g)->ops->copy((g), (d), (x))
@@ -177,6 +171,8 @@ enum {
 #define G_FROMEC(g, d, p)      (g)->ops->fromec((g), (d), (p))
 #define G_TOBUF(g, b, x)       (g)->ops->tobuf((g), (b), (x))
 #define G_FROMBUF(g, b, d)     (g)->ops->frombuf((g), (b), (d))
+#define G_TORAW(g, b, x)       (g)->ops->toraw((g), (b), (x))
+#define G_FROMRAW(g, b, d)     (g)->ops->fromraw((g), (b), (d))
 
 /*----- Handy functions ---------------------------------------------------*/
 
@@ -316,7 +312,7 @@ extern int group_stdtoec(group */*g*/, ec */*d*/, ge */*x*/);
  *
  * Arguments:  @group *g@ = abstract group
  *             @ge *d@ = destination pointer
- *             @ec *p@ = elliptic curve point
+ *             @const ec *p@ = elliptic curve point
  *
  * Returns:    Zero for success, @-1@ on failure.
  *
@@ -324,7 +320,7 @@ extern int group_stdtoec(group */*g*/, ec */*d*/, ge */*x*/);
  *             coordinate.
  */
 
-extern int group_stdfromec(group */*g*/, ge */*d*/, ec */*p*/);
+extern int group_stdfromec(group */*g*/, ge */*d*/, const ec */*p*/);
 
 /*----- Prime field subgroups ---------------------------------------------*/
 
@@ -345,6 +341,22 @@ typedef struct gprime_param {
 
 group *group_prime(const gprime_param */*gp*/);
 
+/*----- Binary field subgroups --------------------------------------------*/
+
+typedef gprime_param gbin_param;
+
+/* --- @group_binary@ --- *
+ *
+ * Arguments:  @const gbin_param *gb@ = group parameters
+ *
+ * Returns:    A pointer to the group, or null.
+ *
+ * Use:                Constructs an abstract group interface for a subgroup of a
+ *             prime field.  Group elements are @mp *@ pointers.
+ */
+
+group *group_binary(const gbin_param */*gp*/);
+
 /*----- Elliptic curve groups ---------------------------------------------*/
 
 /* --- @group_ec@ --- *