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