accept NULL in 'free' functions
[openssl.git] / crypto / ec / ec_lcl.h
index ad62beb29cf302c9b0dac1b0e6b09e5ce3ac1454..79655e3d3acb98154bb7be8a4f19651df912a55a 100644 (file)
@@ -71,16 +71,10 @@ struct ec_method_st {
 
        /* used by EC_GROUP_set_curve_GFp and EC_GROUP_get_curve_GFp: */
        int (*group_set_curve_GFp)(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
-       int (*group_get_curve_GFp)(EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
+       int (*group_get_curve_GFp)(const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
 
-       /* used by EC_GROUP_set_generator, EC_group_get0_generator,
-        * EC_GROUP_get_order, EC_GROUP_get_cofactor:
-        */
-       int (*group_set_generator)(EC_GROUP *, const EC_POINT *generator,
-               const BIGNUM *order, const BIGNUM *cofactor);
-       EC_POINT *(*group_get0_generator)(EC_GROUP *);
-       int (*group_get_order)(EC_GROUP *, BIGNUM *order, BN_CTX *);
-       int (*group_get_cofactor)(EC_GROUP *, BIGNUM *cofactor, BN_CTX *);
+       /* used by EC_GROUP_check: */
+       int (*group_check_discriminant)(const EC_GROUP *, BN_CTX *);
 
        /* used by EC_POINT_new, EC_POINT_free, EC_POINT_clear_free, EC_POINT_copy: */
        int (*point_init)(EC_POINT *);
@@ -121,8 +115,9 @@ struct ec_method_st {
        int (*is_on_curve)(const EC_GROUP *, const EC_POINT *, BN_CTX *);
        int (*point_cmp)(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
 
-       /* used by EC_POINT_make_affine: */
+       /* used by EC_POINT_make_affine, EC_POINTs_make_affine: */
        int (*make_affine)(const EC_GROUP *, EC_POINT *, BN_CTX *);
+       int (*points_make_affine)(const EC_GROUP *, size_t num, EC_POINT *[], BN_CTX *);
 
 
        /* internal functions */
@@ -135,22 +130,31 @@ struct ec_method_st {
 
        int (*field_encode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *); /* e.g. to Montgomery */
        int (*field_decode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *); /* e.g. from Montgomery */
+       int (*field_set_to_one)(const EC_GROUP *, BIGNUM *r, BN_CTX *);
 } /* EC_METHOD */;
 
 
 struct ec_group_st {
        const EC_METHOD *meth;
 
+       EC_POINT *generator; /* optional */
+       BIGNUM order, cofactor;
+
+       int nid; /* optional NID for named curve */
+
        void *extra_data;
        void *(*extra_data_dup_func)(void *);
        void (*extra_data_free_func)(void *);
        void (*extra_data_clear_free_func)(void *);
 
-       /* All members except 'meth' and 'extra_data...' are handled by
-        * the method functions, even if they appear generic */
+       /* The following members are handled by the method functions,
+        * even if they appear generic */
        
        BIGNUM field; /* Field specification.
-                      * For curves over GF(p), this is the modulus. */
+                      * For curves over GF(p), this is the modulus;
+                      * for curves over GF(2^m), this is the 
+                      * irreducible polynomial defining the field.
+                      */
 
        BIGNUM a, b; /* Curve coefficients.
                      * (Here the assumption is that BIGNUMs can be used
@@ -158,13 +162,15 @@ struct ec_group_st {
                      * For characteristic  > 3,  the curve is defined
                      * by a Weierstrass equation of the form
                      *     y^2 = x^3 + a*x + b.
+                     * For characteristic  2,  the curve is defined by
+                     * an equation of the form
+                     *     y^2 + x*y = x^3 + a*x^2 + b.
                      */
-       int a_is_minus3; /* enable optimized point arithmetics for special case */
 
-       EC_POINT *generator; /* optional */
-       BIGNUM order, cofactor;
+       int a_is_minus3; /* enable optimized point arithmetics for special case */
 
-       void *field_data; /* method-specific (e.g., Montgomery structure) */
+       void *field_data1; /* method-specific (e.g., Montgomery structure) */
+       void *field_data2; /* method-specific */
 } /* EC_GROUP */;
 
 
@@ -176,7 +182,7 @@ struct ec_group_st {
  * if necessary.) */
 int EC_GROUP_set_extra_data(EC_GROUP *, void *extra_data, void *(*extra_data_dup_func)(void *),
        void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *));
-void *EC_GROUP_get_extra_data(EC_GROUP *, void *(*extra_data_dup_func)(void *),
+void *EC_GROUP_get_extra_data(const EC_GROUP *, void *(*extra_data_dup_func)(void *),
        void (*extra_data_free_func)(void *), void (*extra_data_clear_free_func)(void *));
 void EC_GROUP_free_extra_data(EC_GROUP *);
 void EC_GROUP_clear_free_extra_data(EC_GROUP *);
@@ -204,12 +210,8 @@ void ec_GFp_simple_group_finish(EC_GROUP *);
 void ec_GFp_simple_group_clear_finish(EC_GROUP *);
 int ec_GFp_simple_group_copy(EC_GROUP *, const EC_GROUP *);
 int ec_GFp_simple_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
-int ec_GFp_simple_group_get_curve_GFp(EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
-int ec_GFp_simple_group_set_generator(EC_GROUP *, const EC_POINT *generator,
-       const BIGNUM *order, const BIGNUM *cofactor);
-EC_POINT *ec_GFp_simple_group_get0_generator(EC_GROUP *);
-int ec_GFp_simple_group_get_order(EC_GROUP *, BIGNUM *order, BN_CTX *);
-int ec_GFp_simple_group_get_cofactor(EC_GROUP *, BIGNUM *cofactor, BN_CTX *);
+int ec_GFp_simple_group_get_curve_GFp(const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
+int ec_GFp_simple_group_check_discriminant(const EC_GROUP *, BN_CTX *);
 int ec_GFp_simple_point_init(EC_POINT *);
 void ec_GFp_simple_point_finish(EC_POINT *);
 void ec_GFp_simple_point_clear_finish(EC_POINT *);
@@ -236,6 +238,7 @@ int ec_GFp_simple_is_at_infinity(const EC_GROUP *, const EC_POINT *);
 int ec_GFp_simple_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);
 int ec_GFp_simple_cmp(const EC_GROUP *, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
 int ec_GFp_simple_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);
+int ec_GFp_simple_points_make_affine(const EC_GROUP *, size_t num, EC_POINT *[], BN_CTX *);
 int ec_GFp_simple_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 int ec_GFp_simple_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
 
@@ -250,6 +253,7 @@ int ec_GFp_mont_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BI
 int ec_GFp_mont_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
 int ec_GFp_mont_field_encode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
 int ec_GFp_mont_field_decode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
+int ec_GFp_mont_field_set_to_one(const EC_GROUP *, BIGNUM *r, BN_CTX *);
 
 
 /* method functions in ecp_recp.c */
@@ -260,8 +264,6 @@ void ec_GFp_recp_group_clear_finish(EC_GROUP *);
 int ec_GFp_recp_group_copy(EC_GROUP *, const EC_GROUP *);
 int ec_GFp_recp_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 int ec_GFp_recp_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
-int ec_GFp_recp_field_encode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
-int ec_GFp_recp_field_decode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
 
 
 /* method functions in ecp_nist.c */
@@ -272,5 +274,3 @@ void ec_GFp_nist_group_clear_finish(EC_GROUP *);
 int ec_GFp_nist_group_copy(EC_GROUP *, const EC_GROUP *);
 int ec_GFp_nist_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
 int ec_GFp_nist_field_sqr(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
-int ec_GFp_nist_field_encode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
-int ec_GFp_nist_field_decode(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);