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