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