accept NULL in 'free' functions
[openssl.git] / crypto / ec / ec_lcl.h
index 614d885a003f84c7f7f4c751e2969d4f1701d8d8..79655e3d3acb98154bb7be8a4f19651df912a55a 100644 (file)
@@ -1,4 +1,3 @@
-/* TODO */
 /* crypto/ec/ec_lcl.h */
 /* ====================================================================
  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
  * so all this may change in future versions. */
 
 struct ec_method_st {
-       /* used by EC_GROUP_new, EC_GROUP_set_GFp, EC_GROUP_free, EC_GROUP_copy: */
+       /* used by EC_GROUP_new, EC_GROUP_free, EC_GROUP_clear_free, EC_GROUP_copy: */
        int (*group_init)(EC_GROUP *);
-       /* int (*group_set)(EC_GROUP *, .....); */
-       int (*group_set_GFp)(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
        void (*group_finish)(EC_GROUP *);
+       void (*group_clear_finish)(EC_GROUP *);
        int (*group_copy)(EC_GROUP *, const EC_GROUP *);
 
-       /* used by EC_GROUP_set_generator: */
-       int (*group_set_generator)(EC_GROUP *, const EC_POINT *generator,
-               const BIGNUM *order, const BIGNUM *cofactor);
-       
-       /* TODO: 'set' functions for EC_GROUPs */
+       /* 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)(const EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, 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_copy: */
+       /* used by EC_POINT_new, EC_POINT_free, EC_POINT_clear_free, EC_POINT_copy: */
        int (*point_init)(EC_POINT *);
        void (*point_finish)(EC_POINT *);
+       void (*point_clear_finish)(EC_POINT *);
        int (*point_copy)(EC_POINT *, const EC_POINT *);
 
-       /* TODO: 'set' and 'get' functions for EC_POINTs */
+       /* used by EC_POINT_set_to_infinity,
+        * EC_POINT_set_Jprojective_coordinates_GFp, EC_POINT_get_Jprojective_coordinates_GFp,
+        * EC_POINT_set_affine_coordinates_GFp, EC_POINT_get_affine_coordinates_GFp,
+        * EC_POINT_set_compressed_coordinates_GFp:
+        */
+       int (*point_set_to_infinity)(const EC_GROUP *, EC_POINT *);
+       int (*point_set_Jprojective_coordinates_GFp)(const EC_GROUP *, EC_POINT *,
+               const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *);
+       int (*point_get_Jprojective_coordinates_GFp)(const EC_GROUP *, const EC_POINT *,
+               BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *);
+       int (*point_set_affine_coordinates_GFp)(const EC_GROUP *, EC_POINT *,
+               const BIGNUM *x, const BIGNUM *y, BN_CTX *);
+       int (*point_get_affine_coordinates_GFp)(const EC_GROUP *, const EC_POINT *,
+               BIGNUM *x, BIGNUM *y, BN_CTX *);
+       int (*point_set_compressed_coordinates_GFp)(const EC_GROUP *, EC_POINT *,
+               const BIGNUM *x, int y_bit, BN_CTX *);
 
        /* used by EC_POINT_point2oct, EC_POINT_oct2point: */
        size_t (*point2oct)(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
@@ -91,54 +105,95 @@ struct ec_method_st {
        int (*oct2point)(const EC_GROUP *, EC_POINT *,
                const unsigned char *buf, size_t len, BN_CTX *);
 
-       /* used by EC_POINT_add, EC_POINT_dbl: */
+       /* used by EC_POINT_add, EC_POINT_dbl, ECP_POINT_invert: */
        int (*add)(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
        int (*dbl)(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
+       int (*invert)(const EC_GROUP *, EC_POINT *, BN_CTX *);
 
-       /* used by EC_POINT_is_at_infinity, EC_POINT_is_on_curve, EC_POINT_make_affine */
+       /* used by EC_POINT_is_at_infinity, EC_POINT_is_on_curve, EC_POINT_cmp: */
        int (*is_at_infinity)(const EC_GROUP *, const EC_POINT *);
        int (*is_on_curve)(const EC_GROUP *, const EC_POINT *, BN_CTX *);
-       int (*make_affine)(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, 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 */
 
-       /* 'field_mult' and 'field_sqr' can be used by 'add' and 'dbl' so that
+       /* 'field_mul' and 'field_sqr' can be used by 'add' and 'dbl' so that
         * the same implementations of point operations can be used with different
         * optimized implementations of expensive field operations: */
-       int (*field_mult)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
+       int (*field_mul)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
        int (*field_sqr)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);
 
        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 {
-       EC_METHOD *meth;
+       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 *);
 
+       /* 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. */
-       void *field_data; /* method-specific (e.g., Montgomery structure) */
+                      * 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
                      * or abused for all kinds of fields, not just GF(p).)
                      * For characteristic  > 3,  the curve is defined
                      * by a Weierstrass equation of the form
-                     *     Y^2 = X^3 + a*X + b.
+                     *     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 */
 
-       /* optional Lim/Lee precomputation table */
+       void *field_data1; /* method-specific (e.g., Montgomery structure) */
+       void *field_data2; /* method-specific */
 } /* EC_GROUP */;
 
 
+/* Basically a 'mixin' for extra data, but available for EC_GROUPs only
+ * (with visibility limited to 'package' level for now).
+ * We use the function pointers as index for retrieval; this obviates
+ * global ex_data-style index tables.
+ * (Currently, we have one slot only, but is is possible to extend this
+ * 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(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 *);
+
+
+
 struct ec_point_st {
-       EC_METHOD *meth;
+       const EC_METHOD *meth;
+
+       /* All members except 'meth' are handled by the method functions,
+        * even if they appear generic */
 
        BIGNUM X;
        BIGNUM Y;
@@ -146,3 +201,76 @@ struct ec_point_st {
                   * (X, Y, Z)  represents  (X/Z^2, Y/Z^3)  if  Z != 0 */
        int Z_is_one; /* enable optimized point arithmetics for special case */
 } /* EC_POINT */;
+
+
+
+/* method functions in ecp_smpl.c */
+int ec_GFp_simple_group_init(EC_GROUP *);
+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(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 *);
+int ec_GFp_simple_point_copy(EC_POINT *, const EC_POINT *);
+int ec_GFp_simple_point_set_to_infinity(const EC_GROUP *, EC_POINT *);
+int ec_GFp_simple_set_Jprojective_coordinates_GFp(const EC_GROUP *, EC_POINT *,
+       const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *);
+int ec_GFp_simple_get_Jprojective_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
+       BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *);
+int ec_GFp_simple_point_set_affine_coordinates_GFp(const EC_GROUP *, EC_POINT *,
+       const BIGNUM *x, const BIGNUM *y, BN_CTX *);
+int ec_GFp_simple_point_get_affine_coordinates_GFp(const EC_GROUP *, const EC_POINT *,
+       BIGNUM *x, BIGNUM *y, BN_CTX *);
+int ec_GFp_simple_set_compressed_coordinates_GFp(const EC_GROUP *, EC_POINT *,
+       const BIGNUM *x, int y_bit, BN_CTX *);
+size_t ec_GFp_simple_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
+       unsigned char *buf, size_t len, BN_CTX *);
+int ec_GFp_simple_oct2point(const EC_GROUP *, EC_POINT *,
+       const unsigned char *buf, size_t len, BN_CTX *);
+int ec_GFp_simple_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
+int ec_GFp_simple_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);
+int ec_GFp_simple_invert(const EC_GROUP *, EC_POINT *, BN_CTX *);
+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 *);
+
+
+/* method functions in ecp_mont.c */
+int ec_GFp_mont_group_init(EC_GROUP *);
+int ec_GFp_mont_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
+void ec_GFp_mont_group_finish(EC_GROUP *);
+void ec_GFp_mont_group_clear_finish(EC_GROUP *);
+int ec_GFp_mont_group_copy(EC_GROUP *, const EC_GROUP *);
+int ec_GFp_mont_field_mul(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
+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 */
+int ec_GFp_recp_group_init(EC_GROUP *);
+int ec_GFp_recp_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
+void ec_GFp_recp_group_finish(EC_GROUP *);
+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 *);
+
+
+/* method functions in ecp_nist.c */
+int ec_GFp_nist_group_init(EC_GROUP *);
+int ec_GFp_nist_group_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
+void ec_GFp_nist_group_finish(EC_GROUP *);
+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 *);