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