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