Some actual method functions (not enough yet to use the EC library, though),

[openssl.git] / crypto / ec / ec.h

diff --git a/crypto/ec/ec.h b/crypto/ec/ec.h
index a1e7e574603d75e1de82b88ad2780ae1b7fcf449..cc0dd788bd7b87e4adef39432633b5447d75db60 100644 (file)
--- a/crypto/ec/ec.h
+++ b/crypto/ec/ec.h
@@ -1,4 +1,3 @@
-/* TODO */
 /* crypto/ec/ec.h */
 /* ====================================================================
  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
@@ -65,6 +64,81 @@ extern "C" {
 
 
 
+typedef enum {
+       POINT_CONVERSION_COMPRESSED = 2,
+       POINT_CONVERSION_UNCOMPRESSED = 4,
+       POINT_CONVERSION_HYBRID = 6
+} point_conversion_form_t;
+
+
+typedef struct ec_method_st EC_METHOD;
+
+typedef struct ec_group_st
+       /*
+        EC_METHOD *meth;
+        -- field definition
+        -- curve coefficients
+        -- optional generator with associated information (order, cofactor)
+        -- optional Lim/Lee precomputation table
+       */
+       EC_GROUP;
+
+typedef struct ec_point_st EC_POINT;
+
+
+/* EC_METHODs for curves over GF(p).
+ * EC_GFp_simple_method provides the basis for the optimized methods.
+ */
+ 
+const EC_METHOD *EC_GFp_simple_method(void);
+const EC_METHOD *EC_GFp_mont_method(void);
+const EC_METHOD *EC_GFp_recp_method(void);
+const EC_METHOD *EC_GFp_nist_method(void);
+
+
+EC_GROUP *EC_GROUP_new(const EC_METHOD *);
+/* We don't have types for field specifications and field elements in general.
+ * Otherwise we would declare
+ *     int EC_GROUP_set_curve(EC_GROUP *, .....);
+ */
+int EC_GROUP_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
+void EC_GROUP_free(EC_GROUP *);
+void EC_GROUP_clear_free(EC_GROUP *);
+int EC_GROUP_copy(EC_GROUP *, const EC_GROUP*);
+
+/* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
+ * after choosing an appropriate EC_METHOD */
+EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
+
+int EC_GROUP_set_generator(EC_GROUP *, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
+
+/* TODO: 'set' and 'get' functions for EC_GROUPs */
+
+
+EC_POINT *EC_POINT_new(const EC_GROUP *);
+void EC_POINT_free(EC_POINT *);
+void EC_POINT_clear_free(EC_POINT *);
+int EC_POINT_copy(EC_POINT *, const EC_POINT *);
+ 
+/* TODO: 'set' and 'get' functions for EC_POINTs */
+
+size_t EC_POINT_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
+        unsigned char *buf, size_t len, BN_CTX *);
+int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *,
+        const unsigned char *buf, size_t len, BN_CTX *);
+
+int EC_POINT_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
+int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
+
+int EC_POINT_is_at_infinity(const EC_GROUP *, const EC_POINT *);
+int EC_POINT_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
+
+int EC_POINT_make_affine(const EC_GROUP *, const EC_POINT *, BN_CTX *);
+
+
+
+/* TODO: scalar multiplication */
+
 
 
 /* BEGIN ERROR CODES */
@@ -75,8 +149,29 @@ extern "C" {
 /* Error codes for the EC functions. */
 
 /* Function codes. */
+#define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR          117
+#define EC_F_EC_GROUP_CLEAR_FREE                        103
+#define EC_F_EC_GROUP_COPY                              102
+#define EC_F_EC_GROUP_FREE                              104
+#define EC_F_EC_GROUP_GET_EXTRA_DATA                    115
+#define EC_F_EC_GROUP_NEW                               100
+#define EC_F_EC_GROUP_SET_CURVE_GFP                     101
+#define EC_F_EC_GROUP_SET_EXTRA_DATA                    116
+#define EC_F_EC_GROUP_SET_GENERATOR                     106
+#define EC_F_EC_POINT_ADD                               107
+#define EC_F_EC_POINT_COPY                              108
+#define EC_F_EC_POINT_DBL                               109
+#define EC_F_EC_POINT_IS_AT_INFINITY                    110
+#define EC_F_EC_POINT_IS_ON_CURVE                       111
+#define EC_F_EC_POINT_MAKE_AFFINE                       112
+#define EC_F_EC_POINT_NEW                               105
+#define EC_F_EC_POINT_OCT2POINT                                 113
+#define EC_F_EC_POINT_POINT2OCT                                 114
 
 /* Reason codes. */
+#define EC_R_INCOMPATIBLE_OBJECTS                       100
+#define EC_R_NO_SUCH_EXTRA_DATA                                 101
+#define EC_R_SLOT_FULL                                  102
 
 #ifdef  __cplusplus
 }