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