crypto/ecdsa/ecs_ossl.c

   1 /* crypto/ecdsa/ecs_ossl.c */
   2 /*
   3  * Written by Nils Larsch for the OpenSSL project
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1998-2004 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 #define OPENSSL_FIPSAPI
  60
  61 #include "ecs_locl.h"
  62 #include <openssl/err.h>
  63 #include <openssl/obj_mac.h>
  64 #include <openssl/bn.h>
  65
  66 static ECDSA_SIG *ecdsa_do_sign(const unsigned char *dgst, int dlen,
  67                 const BIGNUM *, const BIGNUM *, EC_KEY *eckey);
  68 static int ecdsa_sign_setup(EC_KEY *eckey, BN_CTX *ctx_in, BIGNUM **kinvp,
  69                 BIGNUM **rp);
  70 static int ecdsa_do_verify(const unsigned char *dgst, int dgst_len,
  71                 const ECDSA_SIG *sig, EC_KEY *eckey);
  72
  73 static ECDSA_METHOD openssl_ecdsa_meth = {
  74         "OpenSSL ECDSA method",
  75         ecdsa_do_sign,
  76         ecdsa_sign_setup,
  77         ecdsa_do_verify,
  78 #if 0
  79         NULL, /* init     */
  80         NULL, /* finish   */
  81 #endif
  82         0,    /* flags    */
  83         NULL  /* app_data */
  84 };
  85
  86 const ECDSA_METHOD *ECDSA_OpenSSL(void)
  87 {
  88         return &openssl_ecdsa_meth;
  89 }
  90
  91 static int ecdsa_sign_setup(EC_KEY *eckey, BN_CTX *ctx_in, BIGNUM **kinvp,
  92                 BIGNUM **rp)
  93 {
  94         BN_CTX   *ctx = NULL;
  95         BIGNUM   *k = NULL, *r = NULL, *order = NULL, *X = NULL;
  96         EC_POINT *tmp_point=NULL;
  97         const EC_GROUP *group;
  98         int      ret = 0;
  99
 100         if (eckey == NULL || (group = EC_KEY_get0_group(eckey)) == NULL)
 101         {
 102                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_PASSED_NULL_PARAMETER);
 103                 return 0;
 104         }
 105
 106         if (ctx_in == NULL)
 107         {
 108                 if ((ctx = BN_CTX_new()) == NULL)
 109                 {
 110                         ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP,ERR_R_MALLOC_FAILURE);
 111                         return 0;
 112                 }
 113         }
 114         else
 115                 ctx = ctx_in;
 116
 117         k     = BN_new();       /* this value is later returned in *kinvp */
 118         r     = BN_new();       /* this value is later returned in *rp    */
 119         order = BN_new();
 120         X     = BN_new();
 121         if (!k || !r || !order || !X)
 122         {
 123                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_MALLOC_FAILURE);
 124                 goto err;
 125         }
 126         if ((tmp_point = EC_POINT_new(group)) == NULL)
 127         {
 128                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_EC_LIB);
 129                 goto err;
 130         }
 131         if (!EC_GROUP_get_order(group, order, ctx))
 132         {
 133                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_EC_LIB);
 134                 goto err;
 135         }
 136
 137         do
 138         {
 139                 /* get random k */
 140                 do
 141                         if (!BN_rand_range(k, order))
 142                         {
 143                                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP,
 144                                  ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED);
 145                                 goto err;
 146                         }
 147                 while (BN_is_zero(k));
 148
 149                 /* compute r the x-coordinate of generator * k */
 150                 if (!EC_POINT_mul(group, tmp_point, k, NULL, NULL, ctx))
 151                 {
 152                         ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_EC_LIB);
 153                         goto err;
 154                 }
 155                 if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) == NID_X9_62_prime_field)
 156                 {
 157                         if (!EC_POINT_get_affine_coordinates_GFp(group,
 158                                 tmp_point, X, NULL, ctx))
 159                         {
 160                                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP,ERR_R_EC_LIB);
 161                                 goto err;
 162                         }
 163                 }
 164 #ifndef OPENSSL_NO_EC2M
 165                 else /* NID_X9_62_characteristic_two_field */
 166                 {
 167                         if (!EC_POINT_get_affine_coordinates_GF2m(group,
 168                                 tmp_point, X, NULL, ctx))
 169                         {
 170                                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP,ERR_R_EC_LIB);
 171                                 goto err;
 172                         }
 173                 }
 174 #endif
 175                 if (!BN_nnmod(r, X, order, ctx))
 176                 {
 177                         ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_BN_LIB);
 178                         goto err;
 179                 }
 180         }
 181         while (BN_is_zero(r));
 182
 183         /* compute the inverse of k */
 184         if (!BN_mod_inverse(k, k, order, ctx))
 185         {
 186                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_BN_LIB);
 187                 goto err;
 188         }
 189         /* clear old values if necessary */
 190         if (*rp != NULL)
 191                 BN_clear_free(*rp);
 192         if (*kinvp != NULL)
 193                 BN_clear_free(*kinvp);
 194         /* save the pre-computed values  */
 195         *rp    = r;
 196         *kinvp = k;
 197         ret = 1;
 198 err:
 199         if (!ret)
 200         {
 201                 if (k != NULL) BN_clear_free(k);
 202                 if (r != NULL) BN_clear_free(r);
 203         }
 204         if (ctx_in == NULL)
 205                 BN_CTX_free(ctx);
 206         if (order != NULL)
 207                 BN_free(order);
 208         if (tmp_point != NULL)
 209                 EC_POINT_free(tmp_point);
 210         if (X)
 211                 BN_clear_free(X);
 212         return(ret);
 213 }
 214
 215
 216 static ECDSA_SIG *ecdsa_do_sign(const unsigned char *dgst, int dgst_len,
 217                 const BIGNUM *in_kinv, const BIGNUM *in_r, EC_KEY *eckey)
 218 {
 219         int     ok = 0, i;
 220         BIGNUM *kinv=NULL, *s, *m=NULL,*tmp=NULL,*order=NULL;
 221         const BIGNUM *ckinv;
 222         BN_CTX     *ctx = NULL;
 223         const EC_GROUP   *group;
 224         ECDSA_SIG  *ret;
 225         ECDSA_DATA *ecdsa;
 226         const BIGNUM *priv_key;
 227
 228         ecdsa    = ecdsa_check(eckey);
 229         group    = EC_KEY_get0_group(eckey);
 230         priv_key = EC_KEY_get0_private_key(eckey);
 231
 232         if (group == NULL || priv_key == NULL || ecdsa == NULL)
 233         {
 234                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_PASSED_NULL_PARAMETER);
 235                 return NULL;
 236         }
 237
 238         ret = ECDSA_SIG_new();
 239         if (!ret)
 240         {
 241                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_MALLOC_FAILURE);
 242                 return NULL;
 243         }
 244         s = ret->s;
 245
 246         if ((ctx = BN_CTX_new()) == NULL || (order = BN_new()) == NULL ||
 247                 (tmp = BN_new()) == NULL || (m = BN_new()) == NULL)
 248         {
 249                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_MALLOC_FAILURE);
 250                 goto err;
 251         }
 252
 253         if (!EC_GROUP_get_order(group, order, ctx))
 254         {
 255                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_EC_LIB);
 256                 goto err;
 257         }
 258         i = BN_num_bits(order);
 259         /* Need to truncate digest if it is too long: first truncate whole
 260          * bytes.
 261          */
 262         if (8 * dgst_len > i)
 263                 dgst_len = (i + 7)/8;
 264         if (!BN_bin2bn(dgst, dgst_len, m))
 265         {
 266                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
 267                 goto err;
 268         }
 269         /* If still too long truncate remaining bits with a shift */
 270         if ((8 * dgst_len > i) && !BN_rshift(m, m, 8 - (i & 0x7)))
 271         {
 272                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
 273                 goto err;
 274         }
 275         do
 276         {
 277                 if (in_kinv == NULL || in_r == NULL)
 278                 {
 279                         if (!ecdsa->meth->ecdsa_sign_setup(eckey, ctx,
 280                                                                 &kinv, &ret->r))
 281                         {
 282                                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN,ERR_R_ECDSA_LIB);
 283                                 goto err;
 284                         }
 285                         ckinv = kinv;
 286                 }
 287                 else
 288                 {
 289                         ckinv  = in_kinv;
 290                         if (BN_copy(ret->r, in_r) == NULL)
 291                         {
 292                                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_MALLOC_FAILURE);
 293                                 goto err;
 294                         }
 295                 }
 296
 297                 if (!BN_mod_mul(tmp, priv_key, ret->r, order, ctx))
 298                 {
 299                         ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
 300                         goto err;
 301                 }
 302                 if (!BN_mod_add_quick(s, tmp, m, order))
 303                 {
 304                         ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
 305                         goto err;
 306                 }
 307                 if (!BN_mod_mul(s, s, ckinv, order, ctx))
 308                 {
 309                         ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
 310                         goto err;
 311                 }
 312                 if (BN_is_zero(s))
 313                 {
 314                         /* if kinv and r have been supplied by the caller
 315                          * don't to generate new kinv and r values */
 316                         if (in_kinv != NULL && in_r != NULL)
 317                         {
 318                                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ECDSA_R_NEED_NEW_SETUP_VALUES);
 319                                 goto err;
 320                         }
 321                 }
 322                 else
 323                         /* s != 0 => we have a valid signature */
 324                         break;
 325         }
 326         while (1);
 327
 328         ok = 1;
 329 err:
 330         if (!ok)
 331         {
 332                 ECDSA_SIG_free(ret);
 333                 ret = NULL;
 334         }
 335         if (ctx)
 336                 BN_CTX_free(ctx);
 337         if (m)
 338                 BN_clear_free(m);
 339         if (tmp)
 340                 BN_clear_free(tmp);
 341         if (order)
 342                 BN_free(order);
 343         if (kinv)
 344                 BN_clear_free(kinv);
 345         return ret;
 346 }
 347
 348 static int ecdsa_do_verify(const unsigned char *dgst, int dgst_len,
 349                 const ECDSA_SIG *sig, EC_KEY *eckey)
 350 {
 351         int ret = -1, i;
 352         BN_CTX   *ctx;
 353         BIGNUM   *order, *u1, *u2, *m, *X;
 354         EC_POINT *point = NULL;
 355         const EC_GROUP *group;
 356         const EC_POINT *pub_key;
 357
 358         /* check input values */
 359         if (eckey == NULL || (group = EC_KEY_get0_group(eckey)) == NULL ||
 360             (pub_key = EC_KEY_get0_public_key(eckey)) == NULL || sig == NULL)
 361         {
 362                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ECDSA_R_MISSING_PARAMETERS);
 363                 return -1;
 364         }
 365
 366         ctx = BN_CTX_new();
 367         if (!ctx)
 368         {
 369                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_MALLOC_FAILURE);
 370                 return -1;
 371         }
 372         BN_CTX_start(ctx);
 373         order = BN_CTX_get(ctx);
 374         u1    = BN_CTX_get(ctx);
 375         u2    = BN_CTX_get(ctx);
 376         m     = BN_CTX_get(ctx);
 377         X     = BN_CTX_get(ctx);
 378         if (!X)
 379         {
 380                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
 381                 goto err;
 382         }
 383
 384         if (!EC_GROUP_get_order(group, order, ctx))
 385         {
 386                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
 387                 goto err;
 388         }
 389
 390         if (BN_is_zero(sig->r)          || BN_is_negative(sig->r) ||
 391             BN_ucmp(sig->r, order) >= 0 || BN_is_zero(sig->s)  ||
 392             BN_is_negative(sig->s)      || BN_ucmp(sig->s, order) >= 0)
 393         {
 394                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ECDSA_R_BAD_SIGNATURE);
 395                 ret = 0;        /* signature is invalid */
 396                 goto err;
 397         }
 398         /* calculate tmp1 = inv(S) mod order */
 399         if (!BN_mod_inverse(u2, sig->s, order, ctx))
 400         {
 401                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
 402                 goto err;
 403         }
 404         /* digest -> m */
 405         i = BN_num_bits(order);
 406         /* Need to truncate digest if it is too long: first truncate whole
 407          * bytes.
 408          */
 409         if (8 * dgst_len > i)
 410                 dgst_len = (i + 7)/8;
 411         if (!BN_bin2bn(dgst, dgst_len, m))
 412         {
 413                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
 414                 goto err;
 415         }
 416         /* If still too long truncate remaining bits with a shift */
 417         if ((8 * dgst_len > i) && !BN_rshift(m, m, 8 - (i & 0x7)))
 418         {
 419                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
 420                 goto err;
 421         }
 422         /* u1 = m * tmp mod order */
 423         if (!BN_mod_mul(u1, m, u2, order, ctx))
 424         {
 425                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
 426                 goto err;
 427         }
 428         /* u2 = r * w mod q */
 429         if (!BN_mod_mul(u2, sig->r, u2, order, ctx))
 430         {
 431                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
 432                 goto err;
 433         }
 434
 435         if ((point = EC_POINT_new(group)) == NULL)
 436         {
 437                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_MALLOC_FAILURE);
 438                 goto err;
 439         }
 440         if (!EC_POINT_mul(group, point, u1, pub_key, u2, ctx))
 441         {
 442                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
 443                 goto err;
 444         }
 445         if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) == NID_X9_62_prime_field)
 446         {
 447                 if (!EC_POINT_get_affine_coordinates_GFp(group,
 448                         point, X, NULL, ctx))
 449                 {
 450                         ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
 451                         goto err;
 452                 }
 453         }
 454 #ifndef OPENSSL_NO_EC2M
 455         else /* NID_X9_62_characteristic_two_field */
 456         {
 457                 if (!EC_POINT_get_affine_coordinates_GF2m(group,
 458                         point, X, NULL, ctx))
 459                 {
 460                         ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
 461                         goto err;
 462                 }
 463         }
 464 #endif
 465         if (!BN_nnmod(u1, X, order, ctx))
 466         {
 467                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
 468                 goto err;
 469         }
 470         /*  if the signature is correct u1 is equal to sig->r */
 471         ret = (BN_ucmp(u1, sig->r) == 0);
 472 err:
 473         BN_CTX_end(ctx);
 474         BN_CTX_free(ctx);
 475         if (point)
 476                 EC_POINT_free(point);
 477         return ret;
 478 }
 479
 480 #ifdef OPENSSL_FIPSCANISTER
 481 /* FIPS stanadlone version of ecdsa_check: just return FIPS method */
 482 ECDSA_DATA *fips_ecdsa_check(EC_KEY *key)
 483         {
 484         static ECDSA_DATA rv = {
 485                 0,0,0,
 486                 &openssl_ecdsa_meth
 487                 };
 488         return &rv;
 489         }
 490 /* Standalone digest sign and verify */
 491 int FIPS_ecdsa_verify_digest(EC_KEY *key,
 492                         const unsigned char *dig, int dlen, ECDSA_SIG *s)
 493         {
 494         ECDSA_DATA *ecdsa = ecdsa_check(key);
 495         if (ecdsa == NULL)
 496                 return 0;
 497         return ecdsa->meth->ecdsa_do_verify(dig, dlen, s, key);
 498         }
 499 ECDSA_SIG * FIPS_ecdsa_sign_digest(EC_KEY *key,
 500                                         const unsigned char *dig, int dlen)
 501         {
 502         ECDSA_DATA *ecdsa = ecdsa_check(key);
 503         if (ecdsa == NULL)
 504                 return NULL;
 505         return ecdsa->meth->ecdsa_do_sign(dig, dlen, NULL, NULL, key);
 506         }
 507 #endif