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