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