Make sure memcpy() is properly declared by including string.h.
[openssl.git] / crypto / ec / ec_lib.c
index 5cbc6874d2f7c4e7f39de8e818360343514628e7..5e3fb5c20b8dec6c13fe5ef616c39caf959cdfe9 100644 (file)
@@ -1,6 +1,9 @@
 /* crypto/ec/ec_lib.c */
+/*
+ * Originally written by Bodo Moeller for the OpenSSL project.
+ */
 /* ====================================================================
- * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
+ * Copyright (c) 1998-2003 The OpenSSL Project.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * Hudson (tjh@cryptsoft.com).
  *
  */
+/* ====================================================================
+ * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
+ * Binary polynomial ECC support in OpenSSL originally developed by 
+ * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
+ */
 
 #include <string.h>
 
@@ -94,9 +102,16 @@ EC_GROUP *EC_GROUP_new(const EC_METHOD *meth)
        ret->extra_data_free_func = 0;
        ret->extra_data_clear_free_func = 0;
 
-       ret->nid = 0;   
+       ret->generator = NULL;
+       BN_init(&ret->order);
+       BN_init(&ret->cofactor);
+
+       ret->curve_name = 0;    
+       ret->asn1_flag  = 0;
+       ret->asn1_form  = POINT_CONVERSION_UNCOMPRESSED;
 
-       ret->references = 1;
+       ret->seed = NULL;
+       ret->seed_len = 0;
 
        if (!meth->group_init(ret))
                {
@@ -110,28 +125,28 @@ EC_GROUP *EC_GROUP_new(const EC_METHOD *meth)
 
 void EC_GROUP_free(EC_GROUP *group)
        {
-       int i;
+       if (!group) return;
 
-       i = CRYPTO_add(&group->references, -1, CRYPTO_LOCK_EC);
-       if (i > 0)
-               return;
-       
        if (group->meth->group_finish != 0)
                group->meth->group_finish(group);
 
        EC_GROUP_free_extra_data(group);
 
+       if (group->generator != NULL)
+               EC_POINT_free(group->generator);
+       BN_free(&group->order);
+       BN_free(&group->cofactor);
+
+       if (group->seed)
+               OPENSSL_free(group->seed);
+
        OPENSSL_free(group);
        }
  
 
 void EC_GROUP_clear_free(EC_GROUP *group)
        {
-       int i;
-
-       i = CRYPTO_add(&group->references, -1, CRYPTO_LOCK_EC);
-       if (i > 0)
-               return;
+       if (!group) return;
 
        if (group->meth->group_clear_finish != 0)
                group->meth->group_clear_finish(group);
@@ -140,7 +155,18 @@ void EC_GROUP_clear_free(EC_GROUP *group)
 
        EC_GROUP_clear_free_extra_data(group);
 
-       memset(group, 0, sizeof *group);
+       if (group->generator != NULL)
+               EC_POINT_clear_free(group->generator);
+       BN_clear_free(&group->order);
+       BN_clear_free(&group->cofactor);
+
+       if (group->seed)
+               {
+               OPENSSL_cleanse(group->seed, group->seed_len);
+               OPENSSL_free(group->seed);
+               }
+
+       OPENSSL_cleanse(group, sizeof *group);
        OPENSSL_free(group);
        }
 
@@ -175,79 +201,276 @@ int EC_GROUP_copy(EC_GROUP *dest, const EC_GROUP *src)
                dest->extra_data_clear_free_func = src->extra_data_clear_free_func;
                }
 
+       if (src->generator != NULL)
+               {
+               if (dest->generator == NULL)
+                       {
+                       dest->generator = EC_POINT_new(dest);
+                       if (dest->generator == NULL) return 0;
+                       }
+               if (!EC_POINT_copy(dest->generator, src->generator)) return 0;
+               }
+       else
+               {
+               /* src->generator == NULL */
+               if (dest->generator != NULL)
+                       {
+                       EC_POINT_clear_free(dest->generator);
+                       dest->generator = NULL;
+                       }
+               }
+
+       if (!BN_copy(&dest->order, &src->order)) return 0;
+       if (!BN_copy(&dest->cofactor, &src->cofactor)) return 0;
+
+       dest->curve_name = src->curve_name;
+       dest->asn1_flag  = src->asn1_flag;
+       dest->asn1_form  = src->asn1_form;
+
+       if (src->seed)
+               {
+               if (dest->seed)
+                       OPENSSL_free(dest->seed);
+               dest->seed = OPENSSL_malloc(src->seed_len);
+               if (dest->seed == NULL)
+                       return 0;
+               if (!memcpy(dest->seed, src->seed, src->seed_len))
+                       return 0;
+               dest->seed_len = src->seed_len;
+               }
+       else
+               {
+               if (dest->seed)
+                       OPENSSL_free(dest->seed);
+               dest->seed = NULL;
+               dest->seed_len = 0;
+               }
+       
+
        return dest->meth->group_copy(dest, src);
        }
 
 
+EC_GROUP *EC_GROUP_dup(const EC_GROUP *a)
+       {
+       EC_GROUP *t = NULL;
+       int ok = 0;
+
+       if (a == NULL) return NULL;
+
+       if ((t = EC_GROUP_new(a->meth)) == NULL) return(NULL);
+       if (!EC_GROUP_copy(t, a)) goto err;
+
+       ok = 1;
+
+  err: 
+       if (!ok)
+               {
+               if (t) EC_GROUP_free(t);
+               return NULL;
+               }
+       else return t;
+       }
+
+
 const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group)
        {
        return group->meth;
        }
 
 
+int EC_METHOD_get_field_type(const EC_METHOD *meth)
+        {
+        return meth->field_type;
+        }
+
+
+int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor)
+       {
+       if (generator == NULL)
+               {
+               ECerr(EC_F_EC_GROUP_SET_GENERATOR, ERR_R_PASSED_NULL_PARAMETER);
+               return 0   ;
+               }
+
+       if (group->generator == NULL)
+               {
+               group->generator = EC_POINT_new(group);
+               if (group->generator == NULL) return 0;
+               }
+       if (!EC_POINT_copy(group->generator, generator)) return 0;
+
+       if (order != NULL)
+               { if (!BN_copy(&group->order, order)) return 0; }       
+       else
+               { if (!BN_zero(&group->order)) return 0; }      
+
+       if (cofactor != NULL)
+               { if (!BN_copy(&group->cofactor, cofactor)) return 0; } 
+       else
+               { if (!BN_zero(&group->cofactor)) return 0; }   
+
+       return 1;
+       }
+
+
+EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group)
+       {
+       return group->generator;
+       }
+
+
+int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx)
+       {
+       if (!BN_copy(order, &group->order))
+               return 0;
+
+       return !BN_is_zero(order);
+       }
+
+
+int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx)
+       {
+       if (!BN_copy(cofactor, &group->cofactor))
+               return 0;
+
+       return !BN_is_zero(&group->cofactor);
+       }
+
+
+void EC_GROUP_set_nid(EC_GROUP *group, int nid)
+       {
+       group->curve_name = nid;
+       }
+
+
+int EC_GROUP_get_nid(const EC_GROUP *group)
+       {
+       return group->curve_name;
+       }
+
+
+void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag)
+       {
+       group->asn1_flag = flag;
+       }
+
+
+int EC_GROUP_get_asn1_flag(const EC_GROUP *group)
+       {
+       return group->asn1_flag;
+       }
+
+
+void EC_GROUP_set_point_conversion_form(EC_GROUP *group, 
+                                        point_conversion_form_t form)
+       {
+       group->asn1_form = form;
+       }
+
+
+point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *group)
+       {
+       return group->asn1_form;
+       }
+
+
+size_t EC_GROUP_set_seed(EC_GROUP *group, const unsigned char *p, size_t len)
+       {
+       if (group->seed)
+               {
+               OPENSSL_free(group->seed);
+               group->seed = NULL;
+               group->seed_len = 0;
+               }
+
+       if (!len || !p)
+               return 1;
+
+       if ((group->seed = OPENSSL_malloc(len)) == NULL)
+               return 0;
+       memcpy(group->seed, p, len);
+       group->seed_len = len;
+
+       return len;
+       }
+
+
+unsigned char *EC_GROUP_get0_seed(const EC_GROUP *group)
+       {
+       return group->seed;
+       }
+
+
+size_t EC_GROUP_get_seed_len(const EC_GROUP *group)
+       {
+       return group->seed_len;
+       }
+
+
 int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
        {
-       if (group->meth->group_set_curve_GFp == 0)
+       if (group->meth->group_set_curve == 0)
                {
                ECerr(EC_F_EC_GROUP_SET_CURVE_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
                return 0;
                }
-       return group->meth->group_set_curve_GFp(group, p, a, b, ctx);
+       return group->meth->group_set_curve(group, p, a, b, ctx);
        }
 
 
 int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx)
        {
-       if (group->meth->group_get_curve_GFp == 0)
+       if (group->meth->group_get_curve == 0)
                {
                ECerr(EC_F_EC_GROUP_GET_CURVE_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
                return 0;
                }
-       return group->meth->group_get_curve_GFp(group, p, a, b, ctx);
+       return group->meth->group_get_curve(group, p, a, b, ctx);
        }
 
 
-int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor)
+int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx)
        {
-       if (group->meth->group_set_generator == 0)
+       if (group->meth->group_set_curve == 0)
                {
-               ECerr(EC_F_EC_GROUP_SET_GENERATOR, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
+               ECerr(EC_F_EC_GROUP_SET_CURVE_GF2M, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
                return 0;
                }
-       return group->meth->group_set_generator(group, generator, order, cofactor);
+       return group->meth->group_set_curve(group, p, a, b, ctx);
        }
 
 
-EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group)
+int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx)
        {
-       if (group->meth->group_get0_generator == 0)
+       if (group->meth->group_get_curve == 0)
                {
-               ECerr(EC_F_EC_GROUP_GET0_GENERATOR, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
+               ECerr(EC_F_EC_GROUP_GET_CURVE_GF2M, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
                return 0;
                }
-       return group->meth->group_get0_generator(group);
+       return group->meth->group_get_curve(group, p, a, b, ctx);
        }
 
 
-int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx)
+int EC_GROUP_get_degree(const EC_GROUP *group)
        {
-       if (group->meth->group_get_order == 0)
+       if (group->meth->group_get_degree == 0)
                {
-               ECerr(EC_F_EC_GROUP_GET_ORDER, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
+               ECerr(EC_F_EC_GROUP_GET_DEGREE, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
                return 0;
                }
-       return group->meth->group_get_order(group, order, ctx);
+       return group->meth->group_get_degree(group);
        }
 
 
-int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx)
+int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx)
        {
-       if (group->meth->group_get_cofactor == 0)
+       if (group->meth->group_check_discriminant == 0)
                {
-               ECerr(EC_F_EC_GROUP_GET_COFACTOR, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
+               ECerr(EC_F_EC_GROUP_CHECK_DISCRIMINANT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
                return 0;
                }
-       return group->meth->group_get_cofactor(group, cofactor, ctx);
+       return group->meth->group_check_discriminant(group, ctx);
        }
 
 
@@ -280,7 +503,9 @@ void *EC_GROUP_get_extra_data(const EC_GROUP *group, void *(*extra_data_dup_func
                || (group->extra_data_free_func != extra_data_free_func)
                || (group->extra_data_clear_free_func != extra_data_clear_free_func))
                {
+#if 0 /* this was an error in 0.9.7, but that does not make a lot of sense */
                ECerr(EC_F_EC_GROUP_GET_EXTRA_DATA, EC_R_NO_SUCH_EXTRA_DATA);
+#endif
                return NULL;
                }
 
@@ -313,17 +538,6 @@ void EC_GROUP_clear_free_extra_data(EC_GROUP *group)
        group->extra_data_clear_free_func = 0;
        }
 
-void EC_GROUP_set_nid(EC_GROUP *group, int nid)
-{
-       group->nid = nid;
-}
-
-int EC_GROUP_get_nid(const EC_GROUP *group)
-{
-       return group->nid;
-}
-
-
 
 /* functions for EC_POINT objects */
 
@@ -363,6 +577,8 @@ EC_POINT *EC_POINT_new(const EC_GROUP *group)
 
 void EC_POINT_free(EC_POINT *point)
        {
+       if (!point) return;
+
        if (point->meth->point_finish != 0)
                point->meth->point_finish(point);
        OPENSSL_free(point);
@@ -371,11 +587,13 @@ void EC_POINT_free(EC_POINT *point)
 
 void EC_POINT_clear_free(EC_POINT *point)
        {
+       if (!point) return;
+
        if (point->meth->point_clear_finish != 0)
                point->meth->point_clear_finish(point);
        else if (point->meth != NULL && point->meth->point_finish != 0)
                point->meth->point_finish(point);
-       memset(point, 0, sizeof *point);
+       OPENSSL_cleanse(point, sizeof *point);
        OPENSSL_free(point);
        }
 
@@ -398,6 +616,25 @@ int EC_POINT_copy(EC_POINT *dest, const EC_POINT *src)
        }
 
 
+EC_POINT *EC_POINT_dup(const EC_POINT *a, const EC_GROUP *group)
+       {
+       EC_POINT *t;
+       int r;
+
+       if (a == NULL) return NULL;
+
+       t = EC_POINT_new(group);
+       if (t == NULL) return(NULL);
+       r = EC_POINT_copy(t, a);
+       if (!r)
+               {
+               EC_POINT_free(t);
+               return NULL;
+               }
+       else return t;
+       }
+
+
 const EC_METHOD *EC_POINT_method_of(const EC_POINT *point)
        {
        return point->meth;
@@ -457,7 +694,7 @@ int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group, const EC_POI
 int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
        const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx)
        {
-       if (group->meth->point_set_affine_coordinates_GFp == 0)
+       if (group->meth->point_set_affine_coordinates == 0)
                {
                ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
                return 0;
@@ -467,14 +704,31 @@ int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
                ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
                return 0;
                }
-       return group->meth->point_set_affine_coordinates_GFp(group, point, x, y, ctx);
+       return group->meth->point_set_affine_coordinates(group, point, x, y, ctx);
+       }
+
+
+int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *point,
+       const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx)
+       {
+       if (group->meth->point_set_affine_coordinates == 0)
+               {
+               ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GF2M, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
+               return 0;
+               }
+       if (group->meth != point->meth)
+               {
+               ECerr(EC_F_EC_POINT_SET_AFFINE_COORDINATES_GF2M, EC_R_INCOMPATIBLE_OBJECTS);
+               return 0;
+               }
+       return group->meth->point_set_affine_coordinates(group, point, x, y, ctx);
        }
 
 
 int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group, const EC_POINT *point,
        BIGNUM *x, BIGNUM *y, BN_CTX *ctx)
        {
-       if (group->meth->point_get_affine_coordinates_GFp == 0)
+       if (group->meth->point_get_affine_coordinates == 0)
                {
                ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
                return 0;
@@ -484,14 +738,31 @@ int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group, const EC_POINT *p
                ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
                return 0;
                }
-       return group->meth->point_get_affine_coordinates_GFp(group, point, x, y, ctx);
+       return group->meth->point_get_affine_coordinates(group, point, x, y, ctx);
+       }
+
+
+int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group, const EC_POINT *point,
+       BIGNUM *x, BIGNUM *y, BN_CTX *ctx)
+       {
+       if (group->meth->point_get_affine_coordinates == 0)
+               {
+               ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GF2M, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
+               return 0;
+               }
+       if (group->meth != point->meth)
+               {
+               ECerr(EC_F_EC_POINT_GET_AFFINE_COORDINATES_GF2M, EC_R_INCOMPATIBLE_OBJECTS);
+               return 0;
+               }
+       return group->meth->point_get_affine_coordinates(group, point, x, y, ctx);
        }
 
 
 int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *point,
        const BIGNUM *x, int y_bit, BN_CTX *ctx)
        {
-       if (group->meth->point_set_compressed_coordinates_GFp == 0)
+       if (group->meth->point_set_compressed_coordinates == 0)
                {
                ECerr(EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
                return 0;
@@ -501,7 +772,24 @@ int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *poi
                ECerr(EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP, EC_R_INCOMPATIBLE_OBJECTS);
                return 0;
                }
-       return group->meth->point_set_compressed_coordinates_GFp(group, point, x, y_bit, ctx);
+       return group->meth->point_set_compressed_coordinates(group, point, x, y_bit, ctx);
+       }
+
+
+int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group, EC_POINT *point,
+       const BIGNUM *x, int y_bit, BN_CTX *ctx)
+       {
+       if (group->meth->point_set_compressed_coordinates == 0)
+               {
+               ECerr(EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GF2M, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
+               return 0;
+               }
+       if (group->meth != point->meth)
+               {
+               ECerr(EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GF2M, EC_R_INCOMPATIBLE_OBJECTS);
+               return 0;
+               }
+       return group->meth->point_set_compressed_coordinates(group, point, x, y_bit, ctx);
        }
 
 
@@ -670,3 +958,58 @@ int EC_POINTs_make_affine(const EC_GROUP *group, size_t num, EC_POINT *points[],
                }
        return group->meth->points_make_affine(group, num, points, ctx);
        }
+
+
+/* Functions for point multiplication.
+ *
+ * If group->meth->mul is 0, we use the wNAF-based implementations in ec_mult.c;
+ * otherwise we dispatch through methods.
+ */
+
+int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *scalar,
+       size_t num, const EC_POINT *points[], const BIGNUM *scalars[], BN_CTX *ctx)
+       {
+       if (group->meth->mul == 0)
+               /* use default */
+               return ec_wNAF_mul(group, r, scalar, num, points, scalars, ctx);
+
+       return group->meth->mul(group, r, scalar, num, points, scalars, ctx);
+       }
+
+int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *g_scalar,
+       const EC_POINT *point, const BIGNUM *p_scalar, BN_CTX *ctx)
+       {
+       /* just a convenient interface to EC_POINTs_mul() */
+
+       const EC_POINT *points[1];
+       const BIGNUM *scalars[1];
+
+       points[0] = point;
+       scalars[0] = p_scalar;
+
+       return EC_POINTs_mul(group, r, g_scalar, (point != NULL && p_scalar != NULL), points, scalars, ctx);
+       }
+
+int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx)
+       {
+       if (group->meth->mul == 0)
+               /* use default */
+               return ec_wNAF_precompute_mult(group, ctx);
+
+       if (group->meth->precompute_mult != 0)
+               return group->meth->precompute_mult(group, ctx);
+       else
+               return 1; /* nothing to do, so report success */
+       }
+
+int EC_GROUP_have_precompute_mult(const EC_GROUP *group)
+       {
+       if (group->meth->mul == 0)
+               /* use default */
+               return ec_wNAF_have_precompute_mult(group);
+
+       if (group->meth->have_precompute_mult != 0)
+               return group->meth->have_precompute_mult(group);
+       else
+               return 0; /* cannot tell whether precomputation has been performed */
+       }