crypto/dh/dh_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  * DH low level APIs are deprecated for public use, but still ok for
  12  * internal use.
  13  */
  14 #include "internal/deprecated.h"
  15
  16 #include <stdio.h>
  17 #include <openssl/bn.h>
  18 #ifndef FIPS_MODULE
  19 # include <openssl/engine.h>
  20 #endif
  21 #include <openssl/obj_mac.h>
  22 #include <openssl/core_names.h>
  23 #include "internal/cryptlib.h"
  24 #include "internal/refcount.h"
  25 #include "crypto/evp.h"
  26 #include "crypto/dh.h"
  27 #include "dh_local.h"
  28
  29 static DH *dh_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx);
  30
  31 #ifndef FIPS_MODULE
  32 int DH_set_method(DH *dh, const DH_METHOD *meth)
  33 {
  34     /*
  35      * NB: The caller is specifically setting a method, so it's not up to us
  36      * to deal with which ENGINE it comes from.
  37      */
  38     const DH_METHOD *mtmp;
  39     mtmp = dh->meth;
  40     if (mtmp->finish)
  41         mtmp->finish(dh);
  42 #ifndef OPENSSL_NO_ENGINE
  43     ENGINE_finish(dh->engine);
  44     dh->engine = NULL;
  45 #endif
  46     dh->meth = meth;
  47     if (meth->init)
  48         meth->init(dh);
  49     return 1;
  50 }
  51
  52 const DH_METHOD *ossl_dh_get_method(const DH *dh)
  53 {
  54     return dh->meth;
  55 }
  56 # ifndef OPENSSL_NO_DEPRECATED_3_0
  57 DH *DH_new(void)
  58 {
  59     return dh_new_intern(NULL, NULL);
  60 }
  61 # endif
  62
  63 DH *DH_new_method(ENGINE *engine)
  64 {
  65     return dh_new_intern(engine, NULL);
  66 }
  67 #endif /* !FIPS_MODULE */
  68
  69 DH *ossl_dh_new_ex(OSSL_LIB_CTX *libctx)
  70 {
  71     return dh_new_intern(NULL, libctx);
  72 }
  73
  74 static DH *dh_new_intern(ENGINE *engine, OSSL_LIB_CTX *libctx)
  75 {
  76     DH *ret = OPENSSL_zalloc(sizeof(*ret));
  77
  78     if (ret == NULL)
  79         return NULL;
  80
  81     ret->lock = CRYPTO_THREAD_lock_new();
  82     if (ret->lock == NULL) {
  83         ERR_raise(ERR_LIB_DH, ERR_R_CRYPTO_LIB);
  84         OPENSSL_free(ret);
  85         return NULL;
  86     }
  87
  88     if (!CRYPTO_NEW_REF(&ret->references, 1)) {
  89         CRYPTO_THREAD_lock_free(ret->lock);
  90         OPENSSL_free(ret);
  91         return NULL;
  92     }
  93
  94     ret->libctx = libctx;
  95     ret->meth = DH_get_default_method();
  96 #if !defined(FIPS_MODULE) && !defined(OPENSSL_NO_ENGINE)
  97     ret->flags = ret->meth->flags;  /* early default init */
  98     if (engine) {
  99         if (!ENGINE_init(engine)) {
 100             ERR_raise(ERR_LIB_DH, ERR_R_ENGINE_LIB);
 101             goto err;
 102         }
 103         ret->engine = engine;
 104     } else
 105         ret->engine = ENGINE_get_default_DH();
 106     if (ret->engine) {
 107         ret->meth = ENGINE_get_DH(ret->engine);
 108         if (ret->meth == NULL) {
 109             ERR_raise(ERR_LIB_DH, ERR_R_ENGINE_LIB);
 110             goto err;
 111         }
 112     }
 113 #endif
 114
 115     ret->flags = ret->meth->flags;
 116
 117 #ifndef FIPS_MODULE
 118     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_DH, ret, &ret->ex_data))
 119         goto err;
 120 #endif /* FIPS_MODULE */
 121
 122     ossl_ffc_params_init(&ret->params);
 123
 124     if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
 125         ERR_raise(ERR_LIB_DH, ERR_R_INIT_FAIL);
 126         goto err;
 127     }
 128
 129     return ret;
 130
 131  err:
 132     DH_free(ret);
 133     return NULL;
 134 }
 135
 136 void DH_free(DH *r)
 137 {
 138     int i;
 139
 140     if (r == NULL)
 141         return;
 142
 143     CRYPTO_DOWN_REF(&r->references, &i);
 144     REF_PRINT_COUNT("DH", r);
 145     if (i > 0)
 146         return;
 147     REF_ASSERT_ISNT(i < 0);
 148
 149     if (r->meth != NULL && r->meth->finish != NULL)
 150         r->meth->finish(r);
 151 #if !defined(FIPS_MODULE)
 152 # if !defined(OPENSSL_NO_ENGINE)
 153     ENGINE_finish(r->engine);
 154 # endif
 155     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_DH, r, &r->ex_data);
 156 #endif
 157
 158     CRYPTO_THREAD_lock_free(r->lock);
 159     CRYPTO_FREE_REF(&r->references);
 160
 161     ossl_ffc_params_cleanup(&r->params);
 162     BN_clear_free(r->pub_key);
 163     BN_clear_free(r->priv_key);
 164     OPENSSL_free(r);
 165 }
 166
 167 int DH_up_ref(DH *r)
 168 {
 169     int i;
 170
 171     if (CRYPTO_UP_REF(&r->references, &i) <= 0)
 172         return 0;
 173
 174     REF_PRINT_COUNT("DH", r);
 175     REF_ASSERT_ISNT(i < 2);
 176     return ((i > 1) ? 1 : 0);
 177 }
 178
 179 void ossl_dh_set0_libctx(DH *d, OSSL_LIB_CTX *libctx)
 180 {
 181     d->libctx = libctx;
 182 }
 183
 184 #ifndef FIPS_MODULE
 185 int DH_set_ex_data(DH *d, int idx, void *arg)
 186 {
 187     return CRYPTO_set_ex_data(&d->ex_data, idx, arg);
 188 }
 189
 190 void *DH_get_ex_data(const DH *d, int idx)
 191 {
 192     return CRYPTO_get_ex_data(&d->ex_data, idx);
 193 }
 194 #endif
 195
 196 int DH_bits(const DH *dh)
 197 {
 198     if (dh->params.p != NULL)
 199         return BN_num_bits(dh->params.p);
 200     return -1;
 201 }
 202
 203 int DH_size(const DH *dh)
 204 {
 205     if (dh->params.p != NULL)
 206         return BN_num_bytes(dh->params.p);
 207     return -1;
 208 }
 209
 210 int DH_security_bits(const DH *dh)
 211 {
 212     int N;
 213
 214     if (dh->params.q != NULL)
 215         N = BN_num_bits(dh->params.q);
 216     else if (dh->length)
 217         N = dh->length;
 218     else
 219         N = -1;
 220     if (dh->params.p != NULL)
 221         return BN_security_bits(BN_num_bits(dh->params.p), N);
 222     return -1;
 223 }
 224
 225 void DH_get0_pqg(const DH *dh,
 226                  const BIGNUM **p, const BIGNUM **q, const BIGNUM **g)
 227 {
 228     ossl_ffc_params_get0_pqg(&dh->params, p, q, g);
 229 }
 230
 231 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g)
 232 {
 233     /*
 234      * If the fields p and g in dh are NULL, the corresponding input
 235      * parameters MUST be non-NULL.  q may remain NULL.
 236      */
 237     if ((dh->params.p == NULL && p == NULL)
 238         || (dh->params.g == NULL && g == NULL))
 239         return 0;
 240
 241     ossl_ffc_params_set0_pqg(&dh->params, p, q, g);
 242     ossl_dh_cache_named_group(dh);
 243     dh->dirty_cnt++;
 244     return 1;
 245 }
 246
 247 long DH_get_length(const DH *dh)
 248 {
 249     return dh->length;
 250 }
 251
 252 int DH_set_length(DH *dh, long length)
 253 {
 254     dh->length = length;
 255     dh->dirty_cnt++;
 256     return 1;
 257 }
 258
 259 void DH_get0_key(const DH *dh, const BIGNUM **pub_key, const BIGNUM **priv_key)
 260 {
 261     if (pub_key != NULL)
 262         *pub_key = dh->pub_key;
 263     if (priv_key != NULL)
 264         *priv_key = dh->priv_key;
 265 }
 266
 267 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key)
 268 {
 269     if (pub_key != NULL) {
 270         BN_clear_free(dh->pub_key);
 271         dh->pub_key = pub_key;
 272     }
 273     if (priv_key != NULL) {
 274         BN_clear_free(dh->priv_key);
 275         dh->priv_key = priv_key;
 276     }
 277
 278     dh->dirty_cnt++;
 279     return 1;
 280 }
 281
 282 const BIGNUM *DH_get0_p(const DH *dh)
 283 {
 284     return dh->params.p;
 285 }
 286
 287 const BIGNUM *DH_get0_q(const DH *dh)
 288 {
 289     return dh->params.q;
 290 }
 291
 292 const BIGNUM *DH_get0_g(const DH *dh)
 293 {
 294     return dh->params.g;
 295 }
 296
 297 const BIGNUM *DH_get0_priv_key(const DH *dh)
 298 {
 299     return dh->priv_key;
 300 }
 301
 302 const BIGNUM *DH_get0_pub_key(const DH *dh)
 303 {
 304     return dh->pub_key;
 305 }
 306
 307 void DH_clear_flags(DH *dh, int flags)
 308 {
 309     dh->flags &= ~flags;
 310 }
 311
 312 int DH_test_flags(const DH *dh, int flags)
 313 {
 314     return dh->flags & flags;
 315 }
 316
 317 void DH_set_flags(DH *dh, int flags)
 318 {
 319     dh->flags |= flags;
 320 }
 321
 322 #ifndef FIPS_MODULE
 323 ENGINE *DH_get0_engine(DH *dh)
 324 {
 325     return dh->engine;
 326 }
 327 #endif /*FIPS_MODULE */
 328
 329 FFC_PARAMS *ossl_dh_get0_params(DH *dh)
 330 {
 331     return &dh->params;
 332 }
 333 int ossl_dh_get0_nid(const DH *dh)
 334 {
 335     return dh->params.nid;
 336 }