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