crypto/dsa/dsa_ossl.c

   1 /* crypto/dsa/dsa_ossl.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 /* Original version from Steven Schoch <schoch@sheba.arc.nasa.gov> */
  60
  61 #include <stdio.h>
  62 #include "cryptlib.h"
  63 #include <openssl/bn.h>
  64 #include <openssl/sha.h>
  65 #include <openssl/dsa.h>
  66 #include <openssl/rand.h>
  67 #include <openssl/asn1.h>
  68 #ifdef OPENSSL_FIPS
  69 #include <openssl/fips.h>
  70 #endif
  71
  72 static DSA_SIG *dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
  73 static int dsa_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
  74 static int dsa_do_verify(const unsigned char *dgst, int dgst_len, DSA_SIG *sig,
  75                          DSA *dsa);
  76 static int dsa_init(DSA *dsa);
  77 static int dsa_finish(DSA *dsa);
  78
  79 static DSA_METHOD openssl_dsa_meth = {
  80 "OpenSSL DSA method",
  81 dsa_do_sign,
  82 dsa_sign_setup,
  83 dsa_do_verify,
  84 NULL, /* dsa_mod_exp, */
  85 NULL, /* dsa_bn_mod_exp, */
  86 dsa_init,
  87 dsa_finish,
  88 DSA_FLAG_FIPS_METHOD,
  89 NULL,
  90 NULL,
  91 NULL
  92 };
  93
  94 /* These macro wrappers replace attempts to use the dsa_mod_exp() and
  95  * bn_mod_exp() handlers in the DSA_METHOD structure. We avoid the problem of
  96  * having a the macro work as an expression by bundling an "err_instr". So;
  97  *
  98  *     if (!dsa->meth->bn_mod_exp(dsa, r,dsa->g,&k,dsa->p,ctx,
  99  *                 dsa->method_mont_p)) goto err;
 100  *
 101  * can be replaced by;
 102  *
 103  *     DSA_BN_MOD_EXP(goto err, dsa, r, dsa->g, &k, dsa->p, ctx,
 104  *                 dsa->method_mont_p);
 105  */
 106
 107 #define DSA_MOD_EXP(err_instr,dsa,rr,a1,p1,a2,p2,m,ctx,in_mont) \
 108         do { \
 109         int _tmp_res53; \
 110         if((dsa)->meth->dsa_mod_exp) \
 111                 _tmp_res53 = (dsa)->meth->dsa_mod_exp((dsa), (rr), (a1), (p1), \
 112                                 (a2), (p2), (m), (ctx), (in_mont)); \
 113         else \
 114                 _tmp_res53 = BN_mod_exp2_mont((rr), (a1), (p1), (a2), (p2), \
 115                                 (m), (ctx), (in_mont)); \
 116         if(!_tmp_res53) err_instr; \
 117         } while(0)
 118 #define DSA_BN_MOD_EXP(err_instr,dsa,r,a,p,m,ctx,m_ctx) \
 119         do { \
 120         int _tmp_res53; \
 121         if((dsa)->meth->bn_mod_exp) \
 122                 _tmp_res53 = (dsa)->meth->bn_mod_exp((dsa), (r), (a), (p), \
 123                                 (m), (ctx), (m_ctx)); \
 124         else \
 125                 _tmp_res53 = BN_mod_exp_mont((r), (a), (p), (m), (ctx), (m_ctx)); \
 126         if(!_tmp_res53) err_instr; \
 127         } while(0)
 128
 129 const DSA_METHOD *DSA_OpenSSL(void)
 130 {
 131         return &openssl_dsa_meth;
 132 }
 133
 134 static DSA_SIG *dsa_do_sign(const unsigned char *dgst, int dlen, DSA *dsa)
 135         {
 136         BIGNUM *kinv=NULL,*r=NULL,*s=NULL;
 137         BIGNUM m;
 138         BIGNUM xr;
 139         BN_CTX *ctx=NULL;
 140         int reason=ERR_R_BN_LIB;
 141         DSA_SIG *ret=NULL;
 142         int noredo = 0;
 143
 144 #ifdef OPENSSL_FIPS
 145         if(FIPS_selftest_failed())
 146             {
 147             FIPSerr(FIPS_F_DSA_DO_SIGN,FIPS_R_FIPS_SELFTEST_FAILED);
 148             return NULL;
 149             }
 150
 151         if (FIPS_mode() && (BN_num_bits(dsa->p) < OPENSSL_DSA_FIPS_MIN_MODULUS_BITS))
 152                 {
 153                 DSAerr(DSA_F_DSA_DO_SIGN, DSA_R_KEY_SIZE_TOO_SMALL);
 154                 return NULL;
 155                 }
 156 #endif
 157
 158         BN_init(&m);
 159         BN_init(&xr);
 160
 161         if (!dsa->p || !dsa->q || !dsa->g)
 162                 {
 163                 reason=DSA_R_MISSING_PARAMETERS;
 164                 goto err;
 165                 }
 166
 167         s=BN_new();
 168         if (s == NULL) goto err;
 169
 170         /* reject a excessive digest length (currently at most
 171          * dsa-with-SHA256 is supported) */
 172         if (dlen > SHA256_DIGEST_LENGTH)
 173                 {
 174                 reason=DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE;
 175                 goto err;
 176                 }
 177
 178         ctx=BN_CTX_new();
 179         if (ctx == NULL) goto err;
 180 redo:
 181         if ((dsa->kinv == NULL) || (dsa->r == NULL))
 182                 {
 183                 if (!DSA_sign_setup(dsa,ctx,&kinv,&r)) goto err;
 184                 }
 185         else
 186                 {
 187                 kinv=dsa->kinv;
 188                 dsa->kinv=NULL;
 189                 r=dsa->r;
 190                 dsa->r=NULL;
 191                 noredo = 1;
 192                 }
 193
 194
 195         if (dlen > BN_num_bytes(dsa->q))
 196                 /* if the digest length is greater than the size of q use the
 197                  * BN_num_bits(dsa->q) leftmost bits of the digest, see
 198                  * fips 186-3, 4.2 */
 199                 dlen = BN_num_bytes(dsa->q);
 200         if (BN_bin2bn(dgst,dlen,&m) == NULL)
 201                 goto err;
 202
 203         /* Compute  s = inv(k) (m + xr) mod q */
 204         if (!BN_mod_mul(&xr,dsa->priv_key,r,dsa->q,ctx)) goto err;/* s = xr */
 205         if (!BN_add(s, &xr, &m)) goto err;              /* s = m + xr */
 206         if (BN_cmp(s,dsa->q) > 0)
 207                 if (!BN_sub(s,s,dsa->q)) goto err;
 208         if (!BN_mod_mul(s,s,kinv,dsa->q,ctx)) goto err;
 209
 210         ret=DSA_SIG_new();
 211         if (ret == NULL) goto err;
 212         /* Redo if r or s is zero as required by FIPS 186-3: this is
 213          * very unlikely.
 214          */
 215         if (BN_is_zero(r) || BN_is_zero(s))
 216                 {
 217                 if (noredo)
 218                         {
 219                         reason = DSA_R_NEED_NEW_SETUP_VALUES;
 220                         goto err;
 221                         }
 222                 goto redo;
 223                 }
 224         ret->r = r;
 225         ret->s = s;
 226
 227 err:
 228         if (!ret)
 229                 {
 230                 DSAerr(DSA_F_DSA_DO_SIGN,reason);
 231                 BN_free(r);
 232                 BN_free(s);
 233                 }
 234         if (ctx != NULL) BN_CTX_free(ctx);
 235         BN_clear_free(&m);
 236         BN_clear_free(&xr);
 237         if (kinv != NULL) /* dsa->kinv is NULL now if we used it */
 238             BN_clear_free(kinv);
 239         return(ret);
 240         }
 241
 242 static int dsa_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp)
 243         {
 244         BN_CTX *ctx;
 245         BIGNUM k,kq,*K,*kinv=NULL,*r=NULL;
 246         int ret=0;
 247
 248         if (!dsa->p || !dsa->q || !dsa->g)
 249                 {
 250                 DSAerr(DSA_F_DSA_SIGN_SETUP,DSA_R_MISSING_PARAMETERS);
 251                 return 0;
 252                 }
 253
 254         BN_init(&k);
 255         BN_init(&kq);
 256
 257         if (ctx_in == NULL)
 258                 {
 259                 if ((ctx=BN_CTX_new()) == NULL) goto err;
 260                 }
 261         else
 262                 ctx=ctx_in;
 263
 264         if ((r=BN_new()) == NULL) goto err;
 265
 266         /* Get random k */
 267         do
 268                 if (!BN_rand_range(&k, dsa->q)) goto err;
 269         while (BN_is_zero(&k));
 270         if ((dsa->flags & DSA_FLAG_NO_EXP_CONSTTIME) == 0)
 271                 {
 272                 BN_set_flags(&k, BN_FLG_CONSTTIME);
 273                 }
 274
 275         if (dsa->flags & DSA_FLAG_CACHE_MONT_P)
 276                 {
 277                 if (!BN_MONT_CTX_set_locked(&dsa->method_mont_p,
 278                                                 CRYPTO_LOCK_DSA,
 279                                                 dsa->p, ctx))
 280                         goto err;
 281                 }
 282
 283         /* Compute r = (g^k mod p) mod q */
 284
 285         if ((dsa->flags & DSA_FLAG_NO_EXP_CONSTTIME) == 0)
 286                 {
 287                 if (!BN_copy(&kq, &k)) goto err;
 288
 289                 /* We do not want timing information to leak the length of k,
 290                  * so we compute g^k using an equivalent exponent of fixed length.
 291                  *
 292                  * (This is a kludge that we need because the BN_mod_exp_mont()
 293                  * does not let us specify the desired timing behaviour.) */
 294
 295                 if (!BN_add(&kq, &kq, dsa->q)) goto err;
 296                 if (BN_num_bits(&kq) <= BN_num_bits(dsa->q))
 297                         {
 298                         if (!BN_add(&kq, &kq, dsa->q)) goto err;
 299                         }
 300
 301                 K = &kq;
 302                 }
 303         else
 304                 {
 305                 K = &k;
 306                 }
 307         DSA_BN_MOD_EXP(goto err, dsa, r, dsa->g, K, dsa->p, ctx,
 308                         dsa->method_mont_p);
 309         if (!BN_mod(r,r,dsa->q,ctx)) goto err;
 310
 311         /* Compute  part of 's = inv(k) (m + xr) mod q' */
 312         if ((kinv=BN_mod_inverse(NULL,&k,dsa->q,ctx)) == NULL) goto err;
 313
 314         if (*kinvp != NULL) BN_clear_free(*kinvp);
 315         *kinvp=kinv;
 316         kinv=NULL;
 317         if (*rp != NULL) BN_clear_free(*rp);
 318         *rp=r;
 319         ret=1;
 320 err:
 321         if (!ret)
 322                 {
 323                 DSAerr(DSA_F_DSA_SIGN_SETUP,ERR_R_BN_LIB);
 324                 if (r != NULL)
 325                         BN_clear_free(r);
 326                 }
 327         if (ctx_in == NULL) BN_CTX_free(ctx);
 328         BN_clear_free(&k);
 329         BN_clear_free(&kq);
 330         return(ret);
 331         }
 332
 333 static int dsa_do_verify(const unsigned char *dgst, int dgst_len, DSA_SIG *sig,
 334                          DSA *dsa)
 335         {
 336         BN_CTX *ctx;
 337         BIGNUM u1,u2,t1;
 338         BN_MONT_CTX *mont=NULL;
 339         int ret = -1, i;
 340         if (!dsa->p || !dsa->q || !dsa->g)
 341                 {
 342                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_MISSING_PARAMETERS);
 343                 return -1;
 344                 }
 345
 346         i = BN_num_bits(dsa->q);
 347         /* fips 186-3 allows only different sizes for q */
 348         if (i != 160 && i != 224 && i != 256)
 349                 {
 350                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_BAD_Q_VALUE);
 351                 return -1;
 352                 }
 353
 354 #ifdef OPENSSL_FIPS
 355         if(FIPS_selftest_failed())
 356             {
 357             FIPSerr(FIPS_F_DSA_DO_VERIFY,FIPS_R_FIPS_SELFTEST_FAILED);
 358             return -1;
 359             }
 360
 361         if (FIPS_mode() && (BN_num_bits(dsa->p) < OPENSSL_DSA_FIPS_MIN_MODULUS_BITS))
 362                 {
 363                 DSAerr(DSA_F_DSA_DO_VERIFY, DSA_R_KEY_SIZE_TOO_SMALL);
 364                 return -1;
 365                 }
 366 #endif
 367
 368         if (BN_num_bits(dsa->p) > OPENSSL_DSA_MAX_MODULUS_BITS)
 369                 {
 370                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_MODULUS_TOO_LARGE);
 371                 return -1;
 372                 }
 373
 374         /* reject a excessive digest length (currently at most
 375          * dsa-with-SHA256 is supported) */
 376         if (dgst_len > SHA256_DIGEST_LENGTH)
 377                 {
 378                 DSAerr(DSA_F_DSA_DO_VERIFY,DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE);
 379                 return -1;
 380                 }
 381
 382         BN_init(&u1);
 383         BN_init(&u2);
 384         BN_init(&t1);
 385
 386         if ((ctx=BN_CTX_new()) == NULL) goto err;
 387
 388         if (BN_is_zero(sig->r) || BN_is_negative(sig->r) ||
 389             BN_ucmp(sig->r, dsa->q) >= 0)
 390                 {
 391                 ret = 0;
 392                 goto err;
 393                 }
 394         if (BN_is_zero(sig->s) || BN_is_negative(sig->s) ||
 395             BN_ucmp(sig->s, dsa->q) >= 0)
 396                 {
 397                 ret = 0;
 398                 goto err;
 399                 }
 400
 401         /* Calculate W = inv(S) mod Q
 402          * save W in u2 */
 403         if ((BN_mod_inverse(&u2,sig->s,dsa->q,ctx)) == NULL) goto err;
 404
 405         /* save M in u1 */
 406         if (dgst_len > (i >> 3))
 407                 /* if the digest length is greater than the size of q use the
 408                  * BN_num_bits(dsa->q) leftmost bits of the digest, see
 409                  * fips 186-3, 4.2 */
 410                 dgst_len = (i >> 3);
 411         if (BN_bin2bn(dgst,dgst_len,&u1) == NULL) goto err;
 412
 413         /* u1 = M * w mod q */
 414         if (!BN_mod_mul(&u1,&u1,&u2,dsa->q,ctx)) goto err;
 415
 416         /* u2 = r * w mod q */
 417         if (!BN_mod_mul(&u2,sig->r,&u2,dsa->q,ctx)) goto err;
 418
 419
 420         if (dsa->flags & DSA_FLAG_CACHE_MONT_P)
 421                 {
 422                 mont = BN_MONT_CTX_set_locked(&dsa->method_mont_p,
 423                                         CRYPTO_LOCK_DSA, dsa->p, ctx);
 424                 if (!mont)
 425                         goto err;
 426                 }
 427
 428
 429         DSA_MOD_EXP(goto err, dsa, &t1, dsa->g, &u1, dsa->pub_key, &u2, dsa->p, ctx, mont);
 430         /* BN_copy(&u1,&t1); */
 431         /* let u1 = u1 mod q */
 432         if (!BN_mod(&u1,&t1,dsa->q,ctx)) goto err;
 433
 434         /* V is now in u1.  If the signature is correct, it will be
 435          * equal to R. */
 436         ret=(BN_ucmp(&u1, sig->r) == 0);
 437
 438         err:
 439         /* XXX: surely this is wrong - if ret is 0, it just didn't verify;
 440            there is no error in BN. Test should be ret == -1 (Ben) */
 441         if (ret != 1) DSAerr(DSA_F_DSA_DO_VERIFY,ERR_R_BN_LIB);
 442         if (ctx != NULL) BN_CTX_free(ctx);
 443         BN_free(&u1);
 444         BN_free(&u2);
 445         BN_free(&t1);
 446         return(ret);
 447         }
 448
 449 static int dsa_init(DSA *dsa)
 450 {
 451         dsa->flags|=DSA_FLAG_CACHE_MONT_P;
 452         return(1);
 453 }
 454
 455 static int dsa_finish(DSA *dsa)
 456 {
 457         if(dsa->method_mont_p)
 458                 BN_MONT_CTX_free(dsa->method_mont_p);
 459         return(1);
 460 }
 461