key-data.[ch] (key_copydata): New function copies filtered key data.
[u/mdw/catacomb] / ec.h
diff --git a/ec.h b/ec.h
index 79e3654..ac0b8fc 100644 (file)
--- a/ec.h
+++ b/ec.h
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: ec.h,v 1.8 2004/03/27 17:54:11 mdw Exp $
+ * $Id$
  *
  * Elliptic curve definitions
  *
  * (c) 2001 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of Catacomb.
  *
  * 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: ec.h,v $
- * Revision 1.8  2004/03/27 17:54:11  mdw
- * Standard curves and curve checking.
- *
- * Revision 1.7  2004/03/23 15:19:32  mdw
- * Test elliptic curves more thoroughly.
- *
- * Revision 1.6  2004/03/22 02:19:10  mdw
- * Rationalise the sliding-window threshold.  Drop guarantee that right
- * arguments to EC @add@ are canonical, and fix up projective implementations
- * to cope.
- *
- * Revision 1.5  2004/03/21 22:52:06  mdw
- * Merge and close elliptic curve branch.
- *
- * Revision 1.4.4.3  2004/03/21 22:39:46  mdw
- * Elliptic curves on binary fields work.
- *
- * Revision 1.4.4.2  2004/03/20 00:13:31  mdw
- * Projective coordinates for prime curves
- *
- * Revision 1.4.4.1  2003/06/10 13:43:53  mdw
- * Simple (non-projective) curves over prime fields now seem to work.
- *
- * Revision 1.4  2003/05/15 23:25:59  mdw
- * Make elliptic curve stuff build.
- *
- * Revision 1.3  2002/01/13 13:48:44  mdw
- * Further progress.
- *
- * Revision 1.2  2001/05/07 17:29:44  mdw
- * Treat projective coordinates as an internal representation.  Various
- * minor interface changes.
- *
- * Revision 1.1  2001/04/29 18:12:33  mdw
- * Prototype version.
- *
- */
-
 #ifndef CATACOMB_EC_H
 #define CATACOMB_EC_H
 
@@ -125,7 +84,9 @@ typedef struct ec_mulfactor {
  */
 
 typedef struct ec_ops {
+  const char *name;
   void (*destroy)(ec_curve */*c*/);
+  int (*samep)(ec_curve */*c*/, ec_curve */*d*/);
   ec *(*in)(ec_curve */*c*/, ec */*d*/, const ec */*p*/);
   ec *(*out)(ec_curve */*c*/, ec */*d*/, const ec */*p*/);
   ec *(*fix)(ec_curve */*c*/, ec */*d*/, const ec */*p*/);
@@ -137,6 +98,9 @@ typedef struct ec_ops {
   int (*check)(ec_curve */*c*/, const ec */*p*/);
 } ec_ops;
 
+#define EC_NAME(c)             (c)->ops->name
+
+#define EC_SAMEP(c, d)         (c)->ops->samep((c), (d))
 #define EC_IN(c, d, p)         (c)->ops->in((c), (d), (p))
 #define EC_OUT(c, d, p)                (c)->ops->out((c), (d), (p))
 #define EC_FIX(c, d, p)                (c)->ops->fix((c), (d), (p))
@@ -278,6 +242,19 @@ extern int ec_eq(const ec *p, const ec *q);
 
 /*----- Interesting arithmetic --------------------------------------------*/
 
+/* --- @ec_samep@ --- *
+ *
+ * Arguments:  @ec_curve *c, *d@ = two elliptic curves
+ *
+ * Returns:    Nonzero if the curves are identical (not just isomorphic).
+ *
+ * Use:                Checks for sameness of curves.  This function does the full
+ *             check, not just the curve-type-specific check done by the
+ *             @sampep@ field operation.
+ */
+
+extern int ec_samep(ec_curve */*c*/, ec_curve */*d*/);
+
 /* --- @ec_find@ --- *
  *
  * Arguments:  @ec_curve *c@ = pointer to an elliptic curve
@@ -410,6 +387,17 @@ extern ec *ec_immul(ec_curve */*c*/, ec */*d*/,
 
 /*----- Standard curve operations -----------------------------------------*/
 
+/* --- @ec_stdsamep@ --- *
+ *
+ * Arguments:  @ec_curve *c, *d@ = two elliptic curves
+ *
+ * Returns:    Nonzero if the curves are identical (not just isomorphic).
+ *
+ * Use:                Simple sameness check on @a@ and @b@ curve members.
+ */
+
+extern int ec_stdsamep(ec_curve */*c*/, ec_curve */*d*/);
+
 /* --- @ec_idin@, @ec_idout@, @ec_idfix@ --- *
  *
  * Arguments:  @ec_curve *c@ = pointer to an elliptic curve
@@ -477,7 +465,7 @@ extern void ec_destroycurve(ec_curve */*c*/);
  * Arguments:  @field *f@ = the underlying field for this elliptic curve
  *             @mp *a, *b@ = the coefficients for this curve
  *
- * Returns:    A pointer to the curve.
+ * Returns:    A pointer to the curve, or null.
  *
  * Use:                Creates a curve structure for an elliptic curve defined over
  *             a prime field.  The @primeproj@ variant uses projective
@@ -492,7 +480,7 @@ extern ec_curve *ec_primeproj(field */*f*/, mp */*a*/, mp */*b*/);
  * Arguments:  @field *f@ = the underlying field for this elliptic curve
  *             @mp *a, *b@ = the coefficients for this curve
  *
- * Returns:    A pointer to the curve.
+ * Returns:    A pointer to the curve, or null.
  *
  * Use:                Creates a curve structure for an elliptic curve defined over
  *             a binary field.  The @binproj@ variant uses projective
@@ -513,7 +501,7 @@ extern ec_curve *ec_binproj(field */*f*/, mp */*a*/, mp */*b*/);
  * Use:                Parses an elliptic curve description, which has the form
  *
  *               * a field description
- *               * an optional `/'
+ *               * an optional `;'
  *               * `prime', `primeproj', `bin', or `binproj'
  *               * an optional `:'
  *               * the %$a$% parameter
@@ -551,7 +539,7 @@ extern ec *ec_ptparse(qd_parse */*qd*/, ec */*p*/);
  *             information in @ei@.  This has the form
  *
  *               * elliptic curve description
- *               * optional `/'
+ *               * optional `;'
  *               * common point
  *               * optional `:'
  *               * group order
@@ -561,6 +549,20 @@ extern ec *ec_ptparse(qd_parse */*qd*/, ec */*p*/);
 
 extern int ec_infoparse(qd_parse */*qd*/, ec_info */*ei*/);
 
+/* --- @ec_infofromdata@ --- *
+ *
+ * Arguments:  @ec_info *ei@ = where to write the information
+ *             @ecdata *ed@ = raw data
+ *
+ * Returns:    ---
+ *
+ * Use:                Loads elliptic curve information about one of the standard
+ *             curves.
+ */
+
+struct ecdata;
+extern void ec_infofromdata(ec_info */*ei*/, struct ecdata */*ed*/);
+
 /* --- @ec_getinfo@ --- *
  *
  * Arguments:  @ec_info *ei@ = where to write the information
@@ -574,6 +576,17 @@ extern int ec_infoparse(qd_parse */*qd*/, ec_info */*ei*/);
 
 extern const char *ec_getinfo(ec_info */*ei*/, const char */*p*/);
 
+/* --- @ec_sameinfop@ --- *
+ *
+ * Arguments:  @ec_info *ei, *ej@ = two elliptic curve parameter sets
+ *
+ * Returns:    Nonzero if the curves are identical (not just isomorphic).
+ *
+ * Use:                Checks for sameness of curve parameters.
+ */
+
+extern int ec_sameinfop(ec_info */*ei*/, ec_info */*ej*/);
+
 /* --- @ec_freeinfo@ --- *
  *
  * Arguments:  @ec_info *ei@ = elliptic curve information block to free