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_clear_free((void *)r, sizeof(EC_KEY));
 131 }
 132
 133 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
 134 {
 135     EC_EXTRA_DATA *d;
 136
 137     if (dest == NULL || src == NULL) {
 138         ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
 139         return NULL;
 140     }
 141     /* copy the parameters */
 142     if (src->group) {
 143         const EC_METHOD *meth = EC_GROUP_method_of(src->group);
 144         /* clear the old group */
 145         EC_GROUP_free(dest->group);
 146         dest->group = EC_GROUP_new(meth);
 147         if (dest->group == NULL)
 148             return NULL;
 149         if (!EC_GROUP_copy(dest->group, src->group))
 150             return NULL;
 151     }
 152     /*  copy the public key */
 153     if (src->pub_key && src->group) {
 154         EC_POINT_free(dest->pub_key);
 155         dest->pub_key = EC_POINT_new(src->group);
 156         if (dest->pub_key == NULL)
 157             return NULL;
 158         if (!EC_POINT_copy(dest->pub_key, src->pub_key))
 159             return NULL;
 160     }
 161     /* copy the private key */
 162     if (src->priv_key) {
 163         if (dest->priv_key == NULL) {
 164             dest->priv_key = BN_new();
 165             if (dest->priv_key == NULL)
 166                 return NULL;
 167         }
 168         if (!BN_copy(dest->priv_key, src->priv_key))
 169             return NULL;
 170     }
 171     /* copy method/extra data */
 172     EC_EX_DATA_free_all_data(&dest->method_data);
 173
 174     for (d = src->method_data; d != NULL; d = d->next) {
 175         void *t = d->dup_func(d->data);
 176
 177         if (t == NULL)
 178             return 0;
 179         if (!EC_EX_DATA_set_data
 180             (&dest->method_data, t, d->dup_func, d->free_func,
 181              d->clear_free_func))
 182             return 0;
 183     }
 184
 185     /* copy the rest */
 186     dest->enc_flag = src->enc_flag;
 187     dest->conv_form = src->conv_form;
 188     dest->version = src->version;
 189     dest->flags = src->flags;
 190
 191     return dest;
 192 }
 193
 194 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
 195 {
 196     EC_KEY *ret = EC_KEY_new();
 197     if (ret == NULL)
 198         return NULL;
 199     if (EC_KEY_copy(ret, ec_key) == NULL) {
 200         EC_KEY_free(ret);
 201         return NULL;
 202     }
 203     return ret;
 204 }
 205
 206 int EC_KEY_up_ref(EC_KEY *r)
 207 {
 208     int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
 209 #ifdef REF_PRINT
 210     REF_PRINT("EC_KEY", r);
 211 #endif
 212 #ifdef REF_CHECK
 213     if (i < 2) {
 214         fprintf(stderr, "EC_KEY_up, bad reference count\n");
 215         abort();
 216     }
 217 #endif
 218     return ((i > 1) ? 1 : 0);
 219 }
 220
 221 int EC_KEY_generate_key(EC_KEY *eckey)
 222 {
 223     int ok = 0;
 224     BN_CTX *ctx = NULL;
 225     BIGNUM *priv_key = NULL, *order = NULL;
 226     EC_POINT *pub_key = NULL;
 227
 228     if (!eckey || !eckey->group) {
 229         ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
 230         return 0;
 231     }
 232
 233     if ((order = BN_new()) == NULL)
 234         goto err;
 235     if ((ctx = BN_CTX_new()) == NULL)
 236         goto err;
 237
 238     if (eckey->priv_key == NULL) {
 239         priv_key = BN_new();
 240         if (priv_key == NULL)
 241             goto err;
 242     } else
 243         priv_key = eckey->priv_key;
 244
 245     if (!EC_GROUP_get_order(eckey->group, order, ctx))
 246         goto err;
 247
 248     do
 249         if (!BN_rand_range(priv_key, order))
 250             goto err;
 251     while (BN_is_zero(priv_key)) ;
 252
 253     if (eckey->pub_key == NULL) {
 254         pub_key = EC_POINT_new(eckey->group);
 255         if (pub_key == NULL)
 256             goto err;
 257     } else
 258         pub_key = eckey->pub_key;
 259
 260     if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
 261         goto err;
 262
 263     eckey->priv_key = priv_key;
 264     eckey->pub_key = pub_key;
 265
 266     ok = 1;
 267
 268  err:
 269     if (order)
 270         BN_free(order);
 271     if (eckey->pub_key == NULL)
 272         EC_POINT_free(pub_key);
 273     if (priv_key != NULL && eckey->priv_key == NULL)
 274         BN_free(priv_key);
 275     if (ctx != NULL)
 276         BN_CTX_free(ctx);
 277     return (ok);
 278 }
 279
 280 int EC_KEY_check_key(const EC_KEY *eckey)
 281 {
 282     int ok = 0;
 283     BN_CTX *ctx = NULL;
 284     const BIGNUM *order = NULL;
 285     EC_POINT *point = NULL;
 286
 287     if (!eckey || !eckey->group || !eckey->pub_key) {
 288         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
 289         return 0;
 290     }
 291
 292     if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
 293         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
 294         goto err;
 295     }
 296
 297     if ((ctx = BN_CTX_new()) == NULL)
 298         goto err;
 299     if ((point = EC_POINT_new(eckey->group)) == NULL)
 300         goto err;
 301
 302     /* testing whether the pub_key is on the elliptic curve */
 303     if (!EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx)) {
 304         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
 305         goto err;
 306     }
 307     /* testing whether pub_key * order is the point at infinity */
 308     order = eckey->group->order;
 309     if (BN_is_zero(order)) {
 310         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
 311         goto err;
 312     }
 313     if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
 314         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
 315         goto err;
 316     }
 317     if (!EC_POINT_is_at_infinity(eckey->group, point)) {
 318         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
 319         goto err;
 320     }
 321     /*
 322      * in case the priv_key is present : check if generator * priv_key ==
 323      * pub_key
 324      */
 325     if (eckey->priv_key) {
 326         if (BN_cmp(eckey->priv_key, order) >= 0) {
 327             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
 328             goto err;
 329         }
 330         if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
 331                           NULL, NULL, ctx)) {
 332             ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
 333             goto err;
 334         }
 335         if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
 336             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
 337             goto err;
 338         }
 339     }
 340     ok = 1;
 341  err:
 342     if (ctx != NULL)
 343         BN_CTX_free(ctx);
 344     EC_POINT_free(point);
 345     return (ok);
 346 }
 347
 348 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
 349                                              BIGNUM *y)
 350 {
 351     BN_CTX *ctx = NULL;
 352     BIGNUM *tx, *ty;
 353     EC_POINT *point = NULL;
 354     int ok = 0, tmp_nid, is_char_two = 0;
 355
 356     if (!key || !key->group || !x || !y) {
 357         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
 358               ERR_R_PASSED_NULL_PARAMETER);
 359         return 0;
 360     }
 361     ctx = BN_CTX_new();
 362     if (!ctx)
 363         goto err;
 364
 365     point = EC_POINT_new(key->group);
 366
 367     if (!point)
 368         goto err;
 369
 370     tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
 371
 372     if (tmp_nid == NID_X9_62_characteristic_two_field)
 373         is_char_two = 1;
 374
 375     tx = BN_CTX_get(ctx);
 376     ty = BN_CTX_get(ctx);
 377 #ifndef OPENSSL_NO_EC2M
 378     if (is_char_two) {
 379         if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
 380                                                   x, y, ctx))
 381             goto err;
 382         if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
 383                                                   tx, ty, ctx))
 384             goto err;
 385     } else
 386 #endif
 387     {
 388         if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
 389                                                  x, y, ctx))
 390             goto err;
 391         if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
 392                                                  tx, ty, ctx))
 393             goto err;
 394     }
 395     /*
 396      * Check if retrieved coordinates match originals and are less than field
 397      * order: if not values are out of range.
 398      */
 399     if (BN_cmp(x, tx) || BN_cmp(y, ty)
 400         || (BN_cmp(x, key->group->field) >= 0)
 401         || (BN_cmp(y, key->group->field) >= 0)) {
 402         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
 403               EC_R_COORDINATES_OUT_OF_RANGE);
 404         goto err;
 405     }
 406
 407     if (!EC_KEY_set_public_key(key, point))
 408         goto err;
 409
 410     if (EC_KEY_check_key(key) == 0)
 411         goto err;
 412
 413     ok = 1;
 414
 415  err:
 416     if (ctx)
 417         BN_CTX_free(ctx);
 418     EC_POINT_free(point);
 419     return ok;
 420
 421 }
 422
 423 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
 424 {
 425     return key->group;
 426 }
 427
 428 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
 429 {
 430     EC_GROUP_free(key->group);
 431     key->group = EC_GROUP_dup(group);
 432     return (key->group == NULL) ? 0 : 1;
 433 }
 434
 435 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
 436 {
 437     return key->priv_key;
 438 }
 439
 440 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
 441 {
 442     if (key->priv_key)
 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 }