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