crypto/ec/ec_key.c

   1 /* crypto/ec/ec_key.c */
   2 /*
   3  * Written by Nils Larsch for the OpenSSL project.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    openssl-core@openssl.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58 /* ====================================================================
  59  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  60  * Portions originally developed by SUN MICROSYSTEMS, INC., and
  61  * contributed to the OpenSSL project.
  62  */
  63
  64 #include <internal/cryptlib.h>
  65 #include <string.h>
  66 #include "ec_lcl.h"
  67 #include <openssl/err.h>
  68
  69 EC_KEY *EC_KEY_new(void)
  70 {
  71     EC_KEY *ret = OPENSSL_zalloc(sizeof(*ret));
  72
  73     if (ret == NULL) {
  74         ECerr(EC_F_EC_KEY_NEW, ERR_R_MALLOC_FAILURE);
  75         return (NULL);
  76     }
  77
  78     ret->version = 1;
  79     ret->conv_form = POINT_CONVERSION_UNCOMPRESSED;
  80     ret->references = 1;
  81     return (ret);
  82 }
  83
  84 EC_KEY *EC_KEY_new_by_curve_name(int nid)
  85 {
  86     EC_KEY *ret = EC_KEY_new();
  87     if (ret == NULL)
  88         return NULL;
  89     ret->group = EC_GROUP_new_by_curve_name(nid);
  90     if (ret->group == NULL) {
  91         EC_KEY_free(ret);
  92         return NULL;
  93     }
  94     return ret;
  95 }
  96
  97 void EC_KEY_free(EC_KEY *r)
  98 {
  99     int i;
 100
 101     if (r == NULL)
 102         return;
 103
 104     i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
 105 #ifdef REF_PRINT
 106     REF_PRINT("EC_KEY", r);
 107 #endif
 108     if (i > 0)
 109         return;
 110 #ifdef REF_CHECK
 111     if (i < 0) {
 112         fprintf(stderr, "EC_KEY_free, bad reference count\n");
 113         abort();
 114     }
 115 #endif
 116
 117     EC_GROUP_free(r->group);
 118     EC_POINT_free(r->pub_key);
 119     BN_clear_free(r->priv_key);
 120
 121     EC_EX_DATA_free_all_data(&r->method_data);
 122
 123     OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
 124 }
 125
 126 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
 127 {
 128     EC_EXTRA_DATA *d;
 129
 130     if (dest == NULL || src == NULL) {
 131         ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
 132         return NULL;
 133     }
 134     /* copy the parameters */
 135     if (src->group) {
 136         const EC_METHOD *meth = EC_GROUP_method_of(src->group);
 137         /* clear the old group */
 138         EC_GROUP_free(dest->group);
 139         dest->group = EC_GROUP_new(meth);
 140         if (dest->group == NULL)
 141             return NULL;
 142         if (!EC_GROUP_copy(dest->group, src->group))
 143             return NULL;
 144     }
 145     /*  copy the public key */
 146     if (src->pub_key && src->group) {
 147         EC_POINT_free(dest->pub_key);
 148         dest->pub_key = EC_POINT_new(src->group);
 149         if (dest->pub_key == NULL)
 150             return NULL;
 151         if (!EC_POINT_copy(dest->pub_key, src->pub_key))
 152             return NULL;
 153     }
 154     /* copy the private key */
 155     if (src->priv_key) {
 156         if (dest->priv_key == NULL) {
 157             dest->priv_key = BN_new();
 158             if (dest->priv_key == NULL)
 159                 return NULL;
 160         }
 161         if (!BN_copy(dest->priv_key, src->priv_key))
 162             return NULL;
 163     }
 164     /* copy method/extra data */
 165     EC_EX_DATA_free_all_data(&dest->method_data);
 166
 167     for (d = src->method_data; d != NULL; d = d->next) {
 168         void *t = d->dup_func(d->data);
 169
 170         if (t == NULL)
 171             return 0;
 172         if (!EC_EX_DATA_set_data
 173             (&dest->method_data, t, d->dup_func, d->free_func,
 174              d->clear_free_func))
 175             return 0;
 176     }
 177
 178     /* copy the rest */
 179     dest->enc_flag = src->enc_flag;
 180     dest->conv_form = src->conv_form;
 181     dest->version = src->version;
 182     dest->flags = src->flags;
 183
 184     return dest;
 185 }
 186
 187 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
 188 {
 189     EC_KEY *ret = EC_KEY_new();
 190     if (ret == NULL)
 191         return NULL;
 192     if (EC_KEY_copy(ret, ec_key) == NULL) {
 193         EC_KEY_free(ret);
 194         return NULL;
 195     }
 196     return ret;
 197 }
 198
 199 int EC_KEY_up_ref(EC_KEY *r)
 200 {
 201     int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
 202 #ifdef REF_PRINT
 203     REF_PRINT("EC_KEY", r);
 204 #endif
 205 #ifdef REF_CHECK
 206     if (i < 2) {
 207         fprintf(stderr, "EC_KEY_up, bad reference count\n");
 208         abort();
 209     }
 210 #endif
 211     return ((i > 1) ? 1 : 0);
 212 }
 213
 214 int EC_KEY_generate_key(EC_KEY *eckey)
 215 {
 216     int ok = 0;
 217     BN_CTX *ctx = NULL;
 218     BIGNUM *priv_key = NULL, *order = NULL;
 219     EC_POINT *pub_key = NULL;
 220
 221     if (!eckey || !eckey->group) {
 222         ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
 223         return 0;
 224     }
 225
 226     if ((order = BN_new()) == NULL)
 227         goto err;
 228     if ((ctx = BN_CTX_new()) == NULL)
 229         goto err;
 230
 231     if (eckey->priv_key == NULL) {
 232         priv_key = BN_new();
 233         if (priv_key == NULL)
 234             goto err;
 235     } else
 236         priv_key = eckey->priv_key;
 237
 238     if (!EC_GROUP_get_order(eckey->group, order, ctx))
 239         goto err;
 240
 241     do
 242         if (!BN_rand_range(priv_key, order))
 243             goto err;
 244     while (BN_is_zero(priv_key)) ;
 245
 246     if (eckey->pub_key == NULL) {
 247         pub_key = EC_POINT_new(eckey->group);
 248         if (pub_key == NULL)
 249             goto err;
 250     } else
 251         pub_key = eckey->pub_key;
 252
 253     if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
 254         goto err;
 255
 256     eckey->priv_key = priv_key;
 257     eckey->pub_key = pub_key;
 258
 259     ok = 1;
 260
 261  err:
 262     BN_free(order);
 263     if (eckey->pub_key == NULL)
 264         EC_POINT_free(pub_key);
 265     if (eckey->priv_key != priv_key)
 266         BN_free(priv_key);
 267     BN_CTX_free(ctx);
 268     return (ok);
 269 }
 270
 271 int EC_KEY_check_key(const EC_KEY *eckey)
 272 {
 273     int ok = 0;
 274     BN_CTX *ctx = NULL;
 275     const BIGNUM *order = NULL;
 276     EC_POINT *point = NULL;
 277
 278     if (!eckey || !eckey->group || !eckey->pub_key) {
 279         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
 280         return 0;
 281     }
 282
 283     if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
 284         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
 285         goto err;
 286     }
 287
 288     if ((ctx = BN_CTX_new()) == NULL)
 289         goto err;
 290     if ((point = EC_POINT_new(eckey->group)) == NULL)
 291         goto err;
 292
 293     /* testing whether the pub_key is on the elliptic curve */
 294     if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
 295         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
 296         goto err;
 297     }
 298     /* testing whether pub_key * order is the point at infinity */
 299     order = eckey->group->order;
 300     if (BN_is_zero(order)) {
 301         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
 302         goto err;
 303     }
 304     if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
 305         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
 306         goto err;
 307     }
 308     if (!EC_POINT_is_at_infinity(eckey->group, point)) {
 309         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
 310         goto err;
 311     }
 312     /*
 313      * in case the priv_key is present : check if generator * priv_key ==
 314      * pub_key
 315      */
 316     if (eckey->priv_key) {
 317         if (BN_cmp(eckey->priv_key, order) >= 0) {
 318             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
 319             goto err;
 320         }
 321         if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
 322                           NULL, NULL, ctx)) {
 323             ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
 324             goto err;
 325         }
 326         if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
 327             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
 328             goto err;
 329         }
 330     }
 331     ok = 1;
 332  err:
 333     BN_CTX_free(ctx);
 334     EC_POINT_free(point);
 335     return (ok);
 336 }
 337
 338 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
 339                                              BIGNUM *y)
 340 {
 341     BN_CTX *ctx = NULL;
 342     BIGNUM *tx, *ty;
 343     EC_POINT *point = NULL;
 344     int ok = 0;
 345 #ifndef OPENSSL_NO_EC2M
 346     int tmp_nid, is_char_two = 0;
 347 #endif
 348
 349     if (!key || !key->group || !x || !y) {
 350         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
 351               ERR_R_PASSED_NULL_PARAMETER);
 352         return 0;
 353     }
 354     ctx = BN_CTX_new();
 355     if (!ctx)
 356         goto err;
 357
 358     point = EC_POINT_new(key->group);
 359
 360     if (!point)
 361         goto err;
 362
 363     tx = BN_CTX_get(ctx);
 364     ty = BN_CTX_get(ctx);
 365
 366 #ifndef OPENSSL_NO_EC2M
 367     tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
 368
 369     if (tmp_nid == NID_X9_62_characteristic_two_field)
 370         is_char_two = 1;
 371
 372     if (is_char_two) {
 373         if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
 374                                                   x, y, ctx))
 375             goto err;
 376         if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
 377                                                   tx, ty, ctx))
 378             goto err;
 379     } else
 380 #endif
 381     {
 382         if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
 383                                                  x, y, ctx))
 384             goto err;
 385         if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
 386                                                  tx, ty, ctx))
 387             goto err;
 388     }
 389     /*
 390      * Check if retrieved coordinates match originals and are less than field
 391      * order: if not values are out of range.
 392      */
 393     if (BN_cmp(x, tx) || BN_cmp(y, ty)
 394         || (BN_cmp(x, key->group->field) >= 0)
 395         || (BN_cmp(y, key->group->field) >= 0)) {
 396         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
 397               EC_R_COORDINATES_OUT_OF_RANGE);
 398         goto err;
 399     }
 400
 401     if (!EC_KEY_set_public_key(key, point))
 402         goto err;
 403
 404     if (EC_KEY_check_key(key) == 0)
 405         goto err;
 406
 407     ok = 1;
 408
 409  err:
 410     BN_CTX_free(ctx);
 411     EC_POINT_free(point);
 412     return ok;
 413
 414 }
 415
 416 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
 417 {
 418     return key->group;
 419 }
 420
 421 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
 422 {
 423     EC_GROUP_free(key->group);
 424     key->group = EC_GROUP_dup(group);
 425     return (key->group == NULL) ? 0 : 1;
 426 }
 427
 428 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
 429 {
 430     return key->priv_key;
 431 }
 432
 433 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
 434 {
 435     BN_clear_free(key->priv_key);
 436     key->priv_key = BN_dup(priv_key);
 437     return (key->priv_key == NULL) ? 0 : 1;
 438 }
 439
 440 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
 441 {
 442     return key->pub_key;
 443 }
 444
 445 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
 446 {
 447     EC_POINT_free(key->pub_key);
 448     key->pub_key = EC_POINT_dup(pub_key, key->group);
 449     return (key->pub_key == NULL) ? 0 : 1;
 450 }
 451
 452 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
 453 {
 454     return key->enc_flag;
 455 }
 456
 457 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
 458 {
 459     key->enc_flag = flags;
 460 }
 461
 462 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
 463 {
 464     return key->conv_form;
 465 }
 466
 467 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
 468 {
 469     key->conv_form = cform;
 470     if (key->group != NULL)
 471         EC_GROUP_set_point_conversion_form(key->group, cform);
 472 }
 473
 474 void *EC_KEY_get_key_method_data(EC_KEY *key,
 475                                  void *(*dup_func) (void *),
 476                                  void (*free_func) (void *),
 477                                  void (*clear_free_func) (void *))
 478 {
 479     void *ret;
 480
 481     CRYPTO_r_lock(CRYPTO_LOCK_EC);
 482     ret =
 483         EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
 484                             clear_free_func);
 485     CRYPTO_r_unlock(CRYPTO_LOCK_EC);
 486
 487     return ret;
 488 }
 489
 490 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
 491                                     void *(*dup_func) (void *),
 492                                     void (*free_func) (void *),
 493                                     void (*clear_free_func) (void *))
 494 {
 495     EC_EXTRA_DATA *ex_data;
 496
 497     CRYPTO_w_lock(CRYPTO_LOCK_EC);
 498     ex_data =
 499         EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
 500                             clear_free_func);
 501     if (ex_data == NULL)
 502         EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func,
 503                             clear_free_func);
 504     CRYPTO_w_unlock(CRYPTO_LOCK_EC);
 505
 506     return ex_data;
 507 }
 508
 509 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
 510 {
 511     if (key->group != NULL)
 512         EC_GROUP_set_asn1_flag(key->group, flag);
 513 }
 514
 515 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
 516 {
 517     if (key->group == NULL)
 518         return 0;
 519     return EC_GROUP_precompute_mult(key->group, ctx);
 520 }
 521
 522 int EC_KEY_get_flags(const EC_KEY *key)
 523 {
 524     return key->flags;
 525 }
 526
 527 void EC_KEY_set_flags(EC_KEY *key, int flags)
 528 {
 529     key->flags |= flags;
 530 }
 531
 532 void EC_KEY_clear_flags(EC_KEY *key, int flags)
 533 {
 534     key->flags &= ~flags;
 535 }