crypto/dsa/dsa_lib.c

   1 /*
   2  * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /*
  11  * DSA low level APIs are deprecated for public use, but still ok for
  12  * internal use.
  13  */
  14 #include "internal/deprecated.h"
  15
  16 #include <openssl/bn.h>
  17 #ifndef FIPS_MODULE
  18 # include <openssl/engine.h>
  19 #endif
  20 #include "internal/cryptlib.h"
  21 #include "internal/refcount.h"
  22 #include "crypto/dsa.h"
  23 #include "crypto/dh.h" /* required by DSA_dup_DH() */
  24 #include "dsa_local.h"
  25
  26 static DSA *dsa_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx);
  27
  28 #ifndef FIPS_MODULE
  29
  30 int DSA_set_ex_data(DSA *d, int idx, void *arg)
  31 {
  32     return CRYPTO_set_ex_data(&d->ex_data, idx, arg);
  33 }
  34
  35 void *DSA_get_ex_data(const DSA *d, int idx)
  36 {
  37     return CRYPTO_get_ex_data(&d->ex_data, idx);
  38 }
  39
  40 # ifndef OPENSSL_NO_DH
  41 DH *DSA_dup_DH(const DSA *r)
  42 {
  43     /*
  44      * DSA has p, q, g, optional pub_key, optional priv_key.
  45      * DH has p, optional length, g, optional pub_key,
  46      * optional priv_key, optional q.
  47      */
  48     DH *ret = NULL;
  49     BIGNUM *pub_key = NULL, *priv_key = NULL;
  50
  51     if (r == NULL)
  52         goto err;
  53     ret = DH_new();
  54     if (ret == NULL)
  55         goto err;
  56
  57     if (!ossl_ffc_params_copy(ossl_dh_get0_params(ret), &r->params))
  58         goto err;
  59
  60     if (r->pub_key != NULL) {
  61         pub_key = BN_dup(r->pub_key);
  62         if (pub_key == NULL)
  63             goto err;
  64         if (r->priv_key != NULL) {
  65             priv_key = BN_dup(r->priv_key);
  66             if (priv_key == NULL)
  67                 goto err;
  68         }
  69         if (!DH_set0_key(ret, pub_key, priv_key))
  70             goto err;
  71     } else if (r->priv_key != NULL) {
  72         /* Shouldn't happen */
  73         goto err;
  74     }
  75
  76     return ret;
  77
  78  err:
  79     BN_free(pub_key);
  80     BN_free(priv_key);
  81     DH_free(ret);
  82     return NULL;
  83 }
  84 # endif /*  OPENSSL_NO_DH */
  85
  86 void DSA_clear_flags(DSA *d, int flags)
  87 {
  88     d->flags &= ~flags;
  89 }
  90
  91 int DSA_test_flags(const DSA *d, int flags)
  92 {
  93     return d->flags & flags;
  94 }
  95
  96 void DSA_set_flags(DSA *d, int flags)
  97 {
  98     d->flags |= flags;
  99 }
 100
 101 ENGINE *DSA_get0_engine(DSA *d)
 102 {
 103     return d->engine;
 104 }
 105
 106 int DSA_set_method(DSA *dsa, const DSA_METHOD *meth)
 107 {
 108     /*
 109      * NB: The caller is specifically setting a method, so it's not up to us
 110      * to deal with which ENGINE it comes from.
 111      */
 112     const DSA_METHOD *mtmp;
 113     mtmp = dsa->meth;
 114     if (mtmp->finish)
 115         mtmp->finish(dsa);
 116 #ifndef OPENSSL_NO_ENGINE
 117     ENGINE_finish(dsa->engine);
 118     dsa->engine = NULL;
 119 #endif
 120     dsa->meth = meth;
 121     if (meth->init)
 122         meth->init(dsa);
 123     return 1;
 124 }
 125 #endif /* FIPS_MODULE */
 126
 127
 128 const DSA_METHOD *DSA_get_method(DSA *d)
 129 {
 130     return d->meth;
 131 }
 132
 133 static DSA *dsa_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx)
 134 {
 135     DSA *ret = OPENSSL_zalloc(sizeof(*ret));
 136
 137     if (ret == NULL)
 138         return NULL;
 139
 140     ret->lock = CRYPTO_THREAD_lock_new();
 141     if (ret->lock == NULL) {
 142         ERR_raise(ERR_LIB_DSA, ERR_R_CRYPTO_LIB);
 143         OPENSSL_free(ret);
 144         return NULL;
 145     }
 146
 147     if (!CRYPTO_NEW_REF(&ret->references, 1)) {
 148         CRYPTO_THREAD_lock_free(ret->lock);
 149         OPENSSL_free(ret);
 150         return NULL;
 151     }
 152
 153     ret->libctx = libctx;
 154     ret->meth = DSA_get_default_method();
 155 #if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
 156     ret->flags = ret->meth->flags & ~DSA_FLAG_NON_FIPS_ALLOW; /* early default init */
 157     if (engine) {
 158         if (!ENGINE_init(engine)) {
 159             ERR_raise(ERR_LIB_DSA, ERR_R_ENGINE_LIB);
 160             goto err;
 161         }
 162         ret->engine = engine;
 163     } else
 164         ret->engine = ENGINE_get_default_DSA();
 165     if (ret->engine) {
 166         ret->meth = ENGINE_get_DSA(ret->engine);
 167         if (ret->meth == NULL) {
 168             ERR_raise(ERR_LIB_DSA, ERR_R_ENGINE_LIB);
 169             goto err;
 170         }
 171     }
 172 #endif
 173
 174     ret->flags = ret->meth->flags & ~DSA_FLAG_NON_FIPS_ALLOW;
 175
 176 #ifndef FIPS_MODULE
 177     if (!ossl_crypto_new_ex_data_ex(libctx, CRYPTO_EX_INDEX_DSA, ret,
 178                                     &ret->ex_data))
 179         goto err;
 180 #endif
 181
 182     ossl_ffc_params_init(&ret->params);
 183
 184     if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
 185         ERR_raise(ERR_LIB_DSA, ERR_R_INIT_FAIL);
 186         goto err;
 187     }
 188
 189     return ret;
 190
 191  err:
 192     DSA_free(ret);
 193     return NULL;
 194 }
 195
 196 DSA *DSA_new_method(ENGINE *engine)
 197 {
 198     return dsa_new_intern(engine, NULL);
 199 }
 200
 201 DSA *ossl_dsa_new(OSSL_LIB_CTX *libctx)
 202 {
 203     return dsa_new_intern(NULL, libctx);
 204 }
 205
 206 #ifndef FIPS_MODULE
 207 DSA *DSA_new(void)
 208 {
 209     return dsa_new_intern(NULL, NULL);
 210 }
 211 #endif
 212
 213 void DSA_free(DSA *r)
 214 {
 215     int i;
 216
 217     if (r == NULL)
 218         return;
 219
 220     CRYPTO_DOWN_REF(&r->references, &i);
 221     REF_PRINT_COUNT("DSA", r);
 222     if (i > 0)
 223         return;
 224     REF_ASSERT_ISNT(i < 0);
 225
 226     if (r->meth != NULL && r->meth->finish != NULL)
 227         r->meth->finish(r);
 228 #if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
 229     ENGINE_finish(r->engine);
 230 #endif
 231
 232 #ifndef FIPS_MODULE
 233     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_DSA, r, &r->ex_data);
 234 #endif
 235
 236     CRYPTO_THREAD_lock_free(r->lock);
 237     CRYPTO_FREE_REF(&r->references);
 238
 239     ossl_ffc_params_cleanup(&r->params);
 240     BN_clear_free(r->pub_key);
 241     BN_clear_free(r->priv_key);
 242     OPENSSL_free(r);
 243 }
 244
 245 int DSA_up_ref(DSA *r)
 246 {
 247     int i;
 248
 249     if (CRYPTO_UP_REF(&r->references, &i) <= 0)
 250         return 0;
 251
 252     REF_PRINT_COUNT("DSA", r);
 253     REF_ASSERT_ISNT(i < 2);
 254     return ((i > 1) ? 1 : 0);
 255 }
 256
 257 void ossl_dsa_set0_libctx(DSA *d, OSSL_LIB_CTX *libctx)
 258 {
 259     d->libctx = libctx;
 260 }
 261
 262 void DSA_get0_pqg(const DSA *d,
 263                   const BIGNUM **p, const BIGNUM **q, const BIGNUM **g)
 264 {
 265     ossl_ffc_params_get0_pqg(&d->params, p, q, g);
 266 }
 267
 268 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g)
 269 {
 270     /* If the fields p, q and g in d are NULL, the corresponding input
 271      * parameters MUST be non-NULL.
 272      */
 273     if ((d->params.p == NULL && p == NULL)
 274         || (d->params.q == NULL && q == NULL)
 275         || (d->params.g == NULL && g == NULL))
 276         return 0;
 277
 278     ossl_ffc_params_set0_pqg(&d->params, p, q, g);
 279     d->dirty_cnt++;
 280
 281     return 1;
 282 }
 283
 284 const BIGNUM *DSA_get0_p(const DSA *d)
 285 {
 286     return d->params.p;
 287 }
 288
 289 const BIGNUM *DSA_get0_q(const DSA *d)
 290 {
 291     return d->params.q;
 292 }
 293
 294 const BIGNUM *DSA_get0_g(const DSA *d)
 295 {
 296     return d->params.g;
 297 }
 298
 299 const BIGNUM *DSA_get0_pub_key(const DSA *d)
 300 {
 301     return d->pub_key;
 302 }
 303
 304 const BIGNUM *DSA_get0_priv_key(const DSA *d)
 305 {
 306     return d->priv_key;
 307 }
 308
 309 void DSA_get0_key(const DSA *d,
 310                   const BIGNUM **pub_key, const BIGNUM **priv_key)
 311 {
 312     if (pub_key != NULL)
 313         *pub_key = d->pub_key;
 314     if (priv_key != NULL)
 315         *priv_key = d->priv_key;
 316 }
 317
 318 int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key)
 319 {
 320     if (pub_key != NULL) {
 321         BN_free(d->pub_key);
 322         d->pub_key = pub_key;
 323     }
 324     if (priv_key != NULL) {
 325         BN_free(d->priv_key);
 326         d->priv_key = priv_key;
 327     }
 328     d->dirty_cnt++;
 329
 330     return 1;
 331 }
 332
 333 int DSA_security_bits(const DSA *d)
 334 {
 335     if (d->params.p != NULL && d->params.q != NULL)
 336         return BN_security_bits(BN_num_bits(d->params.p),
 337                                 BN_num_bits(d->params.q));
 338     return -1;
 339 }
 340
 341 int DSA_bits(const DSA *dsa)
 342 {
 343     if (dsa->params.p != NULL)
 344         return BN_num_bits(dsa->params.p);
 345     return -1;
 346 }
 347
 348 FFC_PARAMS *ossl_dsa_get0_params(DSA *dsa)
 349 {
 350     return &dsa->params;
 351 }
 352
 353 int ossl_dsa_ffc_params_fromdata(DSA *dsa, const OSSL_PARAM params[])
 354 {
 355     int ret;
 356     FFC_PARAMS *ffc = ossl_dsa_get0_params(dsa);
 357
 358     ret = ossl_ffc_params_fromdata(ffc, params);
 359     if (ret)
 360         dsa->dirty_cnt++;
 361     return ret;
 362 }