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 <string.h>
  65 #include "ec_lcl.h"
  66 #include <openssl/err.h>
  67
  68 EC_KEY *EC_KEY_new(void)
  69 {
  70     EC_KEY *ret;
  71
  72     ret = OPENSSL_malloc(sizeof(EC_KEY));
  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->flags = 0;
  80     ret->group = NULL;
  81     ret->pub_key = NULL;
  82     ret->priv_key = NULL;
  83     ret->enc_flag = 0;
  84     ret->conv_form = POINT_CONVERSION_UNCOMPRESSED;
  85     ret->references = 1;
  86     ret->method_data = NULL;
  87     return (ret);
  88 }
  89
  90 EC_KEY *EC_KEY_new_by_curve_name(int nid)
  91 {
  92     EC_KEY *ret = EC_KEY_new();
  93     if (ret == NULL)
  94         return NULL;
  95     ret->group = EC_GROUP_new_by_curve_name(nid);
  96     if (ret->group == NULL) {
  97         EC_KEY_free(ret);
  98         return NULL;
  99     }
 100     return ret;
 101 }
 102
 103 void EC_KEY_free(EC_KEY *r)
 104 {
 105     int i;
 106
 107     if (r == NULL)
 108         return;
 109
 110     i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
 111 #ifdef REF_PRINT
 112     REF_PRINT("EC_KEY", r);
 113 #endif
 114     if (i > 0)
 115         return;
 116 #ifdef REF_CHECK
 117     if (i < 0) {
 118         fprintf(stderr, "EC_KEY_free, bad reference count\n");
 119         abort();
 120     }
 121 #endif
 122
 123     EC_GROUP_free(r->group);
 124     EC_POINT_free(r->pub_key);
 125     if (r->priv_key != NULL)
 126         BN_clear_free(r->priv_key);
 127
 128     EC_EX_DATA_free_all_data(&r->method_data);
 129
 130     OPENSSL_cleanse((void *)r, sizeof(EC_KEY));
 131
 132     OPENSSL_free(r);
 133 }
 134
 135 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
 136 {
 137     EC_EXTRA_DATA *d;
 138
 139     if (dest == NULL || src == NULL) {
 140         ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
 141         return NULL;
 142     }
 143     /* copy the parameters */
 144     if (src->group) {
 145         const EC_METHOD *meth = EC_GROUP_method_of(src->group);
 146         /* clear the old group */
 147         EC_GROUP_free(dest->group);
 148         dest->group = EC_GROUP_new(meth);
 149         if (dest->group == NULL)
 150             return NULL;
 151         if (!EC_GROUP_copy(dest->group, src->group))
 152             return NULL;
 153     }
 154     /*  copy the public key */
 155     if (src->pub_key && src->group) {
 156         EC_POINT_free(dest->pub_key);
 157         dest->pub_key = EC_POINT_new(src->group);
 158         if (dest->pub_key == NULL)
 159             return NULL;
 160         if (!EC_POINT_copy(dest->pub_key, src->pub_key))
 161             return NULL;
 162     }
 163     /* copy the private key */
 164     if (src->priv_key) {
 165         if (dest->priv_key == NULL) {
 166             dest->priv_key = BN_new();
 167             if (dest->priv_key == NULL)
 168                 return NULL;
 169         }
 170         if (!BN_copy(dest->priv_key, src->priv_key))
 171             return NULL;
 172     }
 173     /* copy method/extra data */
 174     EC_EX_DATA_free_all_data(&dest->method_data);
 175
 176     for (d = src->method_data; d != NULL; d = d->next) {
 177         void *t = d->dup_func(d->data);
 178
 179         if (t == NULL)
 180             return 0;
 181         if (!EC_EX_DATA_set_data
 182             (&dest->method_data, t, d->dup_func, d->free_func,
 183              d->clear_free_func))
 184             return 0;
 185     }
 186
 187     /* copy the rest */
 188     dest->enc_flag = src->enc_flag;
 189     dest->conv_form = src->conv_form;
 190     dest->version = src->version;
 191     dest->flags = src->flags;
 192
 193     return dest;
 194 }
 195
 196 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
 197 {
 198     EC_KEY *ret = EC_KEY_new();
 199     if (ret == NULL)
 200         return NULL;
 201     if (EC_KEY_copy(ret, ec_key) == NULL) {
 202         EC_KEY_free(ret);
 203         return NULL;
 204     }
 205     return ret;
 206 }
 207
 208 int EC_KEY_up_ref(EC_KEY *r)
 209 {
 210     int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
 211 #ifdef REF_PRINT
 212     REF_PRINT("EC_KEY", r);
 213 #endif
 214 #ifdef REF_CHECK
 215     if (i < 2) {
 216         fprintf(stderr, "EC_KEY_up, bad reference count\n");
 217         abort();
 218     }
 219 #endif
 220     return ((i > 1) ? 1 : 0);
 221 }
 222
 223 int EC_KEY_generate_key(EC_KEY *eckey)
 224 {
 225     int ok = 0;
 226     BN_CTX *ctx = NULL;
 227     BIGNUM *priv_key = NULL, *order = NULL;
 228     EC_POINT *pub_key = NULL;
 229
 230     if (!eckey || !eckey->group) {
 231         ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
 232         return 0;
 233     }
 234
 235     if ((order = BN_new()) == NULL)
 236         goto err;
 237     if ((ctx = BN_CTX_new()) == NULL)
 238         goto err;
 239
 240     if (eckey->priv_key == NULL) {
 241         priv_key = BN_new();
 242         if (priv_key == NULL)
 243             goto err;
 244     } else
 245         priv_key = eckey->priv_key;
 246
 247     if (!EC_GROUP_get_order(eckey->group, order, ctx))
 248         goto err;
 249
 250     do
 251         if (!BN_rand_range(priv_key, order))
 252             goto err;
 253     while (BN_is_zero(priv_key)) ;
 254
 255     if (eckey->pub_key == NULL) {
 256         pub_key = EC_POINT_new(eckey->group);
 257         if (pub_key == NULL)
 258             goto err;
 259     } else
 260         pub_key = eckey->pub_key;
 261
 262     if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
 263         goto err;
 264
 265     eckey->priv_key = priv_key;
 266     eckey->pub_key = pub_key;
 267
 268     ok = 1;
 269
 270  err:
 271     if (order)
 272         BN_free(order);
 273     if (eckey->pub_key == NULL)
 274         EC_POINT_free(pub_key);
 275     if (priv_key != NULL && eckey->priv_key == NULL)
 276         BN_free(priv_key);
 277     if (ctx != NULL)
 278         BN_CTX_free(ctx);
 279     return (ok);
 280 }
 281
 282 int EC_KEY_check_key(const EC_KEY *eckey)
 283 {
 284     int ok = 0;
 285     BN_CTX *ctx = NULL;
 286     const BIGNUM *order = NULL;
 287     EC_POINT *point = NULL;
 288
 289     if (!eckey || !eckey->group || !eckey->pub_key) {
 290         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
 291         return 0;
 292     }
 293
 294     if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
 295         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
 296         goto err;
 297     }
 298
 299     if ((ctx = BN_CTX_new()) == NULL)
 300         goto err;
 301     if ((point = EC_POINT_new(eckey->group)) == NULL)
 302         goto err;
 303
 304     /* testing whether the pub_key is on the elliptic curve */
 305     if (!EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx)) {
 306         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
 307         goto err;
 308     }
 309     /* testing whether pub_key * order is the point at infinity */
 310     order = eckey->group->order;
 311     if (BN_is_zero(order)) {
 312         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
 313         goto err;
 314     }
 315     if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
 316         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
 317         goto err;
 318     }
 319     if (!EC_POINT_is_at_infinity(eckey->group, point)) {
 320         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
 321         goto err;
 322     }
 323     /*
 324      * in case the priv_key is present : check if generator * priv_key ==
 325      * pub_key
 326      */
 327     if (eckey->priv_key) {
 328         if (BN_cmp(eckey->priv_key, order) >= 0) {
 329             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
 330             goto err;
 331         }
 332         if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
 333                           NULL, NULL, ctx)) {
 334             ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
 335             goto err;
 336         }
 337         if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
 338             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
 339             goto err;
 340         }
 341     }
 342     ok = 1;
 343  err:
 344     if (ctx != NULL)
 345         BN_CTX_free(ctx);
 346     EC_POINT_free(point);
 347     return (ok);
 348 }
 349
 350 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
 351                                              BIGNUM *y)
 352 {
 353     BN_CTX *ctx = NULL;
 354     BIGNUM *tx, *ty;
 355     EC_POINT *point = NULL;
 356     int ok = 0, tmp_nid, is_char_two = 0;
 357
 358     if (!key || !key->group || !x || !y) {
 359         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
 360               ERR_R_PASSED_NULL_PARAMETER);
 361         return 0;
 362     }
 363     ctx = BN_CTX_new();
 364     if (!ctx)
 365         goto err;
 366
 367     point = EC_POINT_new(key->group);
 368
 369     if (!point)
 370         goto err;
 371
 372     tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
 373
 374     if (tmp_nid == NID_X9_62_characteristic_two_field)
 375         is_char_two = 1;
 376
 377     tx = BN_CTX_get(ctx);
 378     ty = BN_CTX_get(ctx);
 379 #ifndef OPENSSL_NO_EC2M
 380     if (is_char_two) {
 381         if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
 382                                                   x, y, ctx))
 383             goto err;
 384         if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
 385                                                   tx, ty, ctx))
 386             goto err;
 387     } else
 388 #endif
 389     {
 390         if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
 391                                                  x, y, ctx))
 392             goto err;
 393         if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
 394                                                  tx, ty, ctx))
 395             goto err;
 396     }
 397     /*
 398      * Check if retrieved coordinates match originals and are less than field
 399      * order: if not values are out of range.
 400      */
 401     if (BN_cmp(x, tx) || BN_cmp(y, ty)
 402         || (BN_cmp(x, key->group->field) >= 0)
 403         || (BN_cmp(y, key->group->field) >= 0)) {
 404         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
 405               EC_R_COORDINATES_OUT_OF_RANGE);
 406         goto err;
 407     }
 408
 409     if (!EC_KEY_set_public_key(key, point))
 410         goto err;
 411
 412     if (EC_KEY_check_key(key) == 0)
 413         goto err;
 414
 415     ok = 1;
 416
 417  err:
 418     if (ctx)
 419         BN_CTX_free(ctx);
 420     EC_POINT_free(point);
 421     return ok;
 422
 423 }
 424
 425 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
 426 {
 427     return key->group;
 428 }
 429
 430 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
 431 {
 432     EC_GROUP_free(key->group);
 433     key->group = EC_GROUP_dup(group);
 434     return (key->group == NULL) ? 0 : 1;
 435 }
 436
 437 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
 438 {
 439     return key->priv_key;
 440 }
 441
 442 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
 443 {
 444     if (key->priv_key)
 445         BN_clear_free(key->priv_key);
 446     key->priv_key = BN_dup(priv_key);
 447     return (key->priv_key == NULL) ? 0 : 1;
 448 }
 449
 450 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
 451 {
 452     return key->pub_key;
 453 }
 454
 455 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
 456 {
 457     EC_POINT_free(key->pub_key);
 458     key->pub_key = EC_POINT_dup(pub_key, key->group);
 459     return (key->pub_key == NULL) ? 0 : 1;
 460 }
 461
 462 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
 463 {
 464     return key->enc_flag;
 465 }
 466
 467 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
 468 {
 469     key->enc_flag = flags;
 470 }
 471
 472 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
 473 {
 474     return key->conv_form;
 475 }
 476
 477 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
 478 {
 479     key->conv_form = cform;
 480     if (key->group != NULL)
 481         EC_GROUP_set_point_conversion_form(key->group, cform);
 482 }
 483
 484 void *EC_KEY_get_key_method_data(EC_KEY *key,
 485                                  void *(*dup_func) (void *),
 486                                  void (*free_func) (void *),
 487                                  void (*clear_free_func) (void *))
 488 {
 489     void *ret;
 490
 491     CRYPTO_r_lock(CRYPTO_LOCK_EC);
 492     ret =
 493         EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
 494                             clear_free_func);
 495     CRYPTO_r_unlock(CRYPTO_LOCK_EC);
 496
 497     return ret;
 498 }
 499
 500 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
 501                                     void *(*dup_func) (void *),
 502                                     void (*free_func) (void *),
 503                                     void (*clear_free_func) (void *))
 504 {
 505     EC_EXTRA_DATA *ex_data;
 506
 507     CRYPTO_w_lock(CRYPTO_LOCK_EC);
 508     ex_data =
 509         EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
 510                             clear_free_func);
 511     if (ex_data == NULL)
 512         EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func,
 513                             clear_free_func);
 514     CRYPTO_w_unlock(CRYPTO_LOCK_EC);
 515
 516     return ex_data;
 517 }
 518
 519 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
 520 {
 521     if (key->group != NULL)
 522         EC_GROUP_set_asn1_flag(key->group, flag);
 523 }
 524
 525 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
 526 {
 527     if (key->group == NULL)
 528         return 0;
 529     return EC_GROUP_precompute_mult(key->group, ctx);
 530 }
 531
 532 int EC_KEY_get_flags(const EC_KEY *key)
 533 {
 534     return key->flags;
 535 }
 536
 537 void EC_KEY_set_flags(EC_KEY *key, int flags)
 538 {
 539     key->flags |= flags;
 540 }
 541
 542 void EC_KEY_clear_flags(EC_KEY *key, int flags)
 543 {
 544     key->flags &= ~flags;
 545 }