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