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     if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
 123         ERR_raise(ERR_LIB_DH, ERR_R_INIT_FAIL);
 124         goto err;
 125     }
 126
 127     return ret;
 128
 129  err:
 130     DH_free(ret);
 131     return NULL;
 132 }
 133
 134 void DH_free(DH *r)
 135 {
 136     int i;
 137
 138     if (r == NULL)
 139         return;
 140
 141     CRYPTO_DOWN_REF(&r->references, &i);
 142     REF_PRINT_COUNT("DH", r);
 143     if (i > 0)
 144         return;
 145     REF_ASSERT_ISNT(i < 0);
 146
 147     if (r->meth != NULL && r->meth->finish != NULL)
 148         r->meth->finish(r);
 149 #if !defined(FIPS_MODULE)
 150 # if !defined(OPENSSL_NO_ENGINE)
 151     ENGINE_finish(r->engine);
 152 # endif
 153     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_DH, r, &r->ex_data);
 154 #endif
 155
 156     CRYPTO_THREAD_lock_free(r->lock);
 157     CRYPTO_FREE_REF(&r->references);
 158
 159     ossl_ffc_params_cleanup(&r->params);
 160     BN_clear_free(r->pub_key);
 161     BN_clear_free(r->priv_key);
 162     OPENSSL_free(r);
 163 }
 164
 165 int DH_up_ref(DH *r)
 166 {
 167     int i;
 168
 169     if (CRYPTO_UP_REF(&r->references, &i) <= 0)
 170         return 0;
 171
 172     REF_PRINT_COUNT("DH", r);
 173     REF_ASSERT_ISNT(i < 2);
 174     return ((i > 1) ? 1 : 0);
 175 }
 176
 177 void ossl_dh_set0_libctx(DH *d, OSSL_LIB_CTX *libctx)
 178 {
 179     d->libctx = libctx;
 180 }
 181
 182 #ifndef FIPS_MODULE
 183 int DH_set_ex_data(DH *d, int idx, void *arg)
 184 {
 185     return CRYPTO_set_ex_data(&d->ex_data, idx, arg);
 186 }
 187
 188 void *DH_get_ex_data(const DH *d, int idx)
 189 {
 190     return CRYPTO_get_ex_data(&d->ex_data, idx);
 191 }
 192 #endif
 193
 194 int DH_bits(const DH *dh)
 195 {
 196     if (dh->params.p != NULL)
 197         return BN_num_bits(dh->params.p);
 198     return -1;
 199 }
 200
 201 int DH_size(const DH *dh)
 202 {
 203     if (dh->params.p != NULL)
 204         return BN_num_bytes(dh->params.p);
 205     return -1;
 206 }
 207
 208 int DH_security_bits(const DH *dh)
 209 {
 210     int N;
 211
 212     if (dh->params.q != NULL)
 213         N = BN_num_bits(dh->params.q);
 214     else if (dh->length)
 215         N = dh->length;
 216     else
 217         N = -1;
 218     if (dh->params.p != NULL)
 219         return BN_security_bits(BN_num_bits(dh->params.p), N);
 220     return -1;
 221 }
 222
 223 void DH_get0_pqg(const DH *dh,
 224                  const BIGNUM **p, const BIGNUM **q, const BIGNUM **g)
 225 {
 226     ossl_ffc_params_get0_pqg(&dh->params, p, q, g);
 227 }
 228
 229 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g)
 230 {
 231     /*
 232      * If the fields p and g in dh are NULL, the corresponding input
 233      * parameters MUST be non-NULL.  q may remain NULL.
 234      */
 235     if ((dh->params.p == NULL && p == NULL)
 236         || (dh->params.g == NULL && g == NULL))
 237         return 0;
 238
 239     ossl_ffc_params_set0_pqg(&dh->params, p, q, g);
 240     ossl_dh_cache_named_group(dh);
 241     dh->dirty_cnt++;
 242     return 1;
 243 }
 244
 245 long DH_get_length(const DH *dh)
 246 {
 247     return dh->length;
 248 }
 249
 250 int DH_set_length(DH *dh, long length)
 251 {
 252     dh->length = length;
 253     dh->dirty_cnt++;
 254     return 1;
 255 }
 256
 257 void DH_get0_key(const DH *dh, const BIGNUM **pub_key, const BIGNUM **priv_key)
 258 {
 259     if (pub_key != NULL)
 260         *pub_key = dh->pub_key;
 261     if (priv_key != NULL)
 262         *priv_key = dh->priv_key;
 263 }
 264
 265 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key)
 266 {
 267     if (pub_key != NULL) {
 268         BN_clear_free(dh->pub_key);
 269         dh->pub_key = pub_key;
 270     }
 271     if (priv_key != NULL) {
 272         BN_clear_free(dh->priv_key);
 273         dh->priv_key = priv_key;
 274     }
 275
 276     dh->dirty_cnt++;
 277     return 1;
 278 }
 279
 280 const BIGNUM *DH_get0_p(const DH *dh)
 281 {
 282     return dh->params.p;
 283 }
 284
 285 const BIGNUM *DH_get0_q(const DH *dh)
 286 {
 287     return dh->params.q;
 288 }
 289
 290 const BIGNUM *DH_get0_g(const DH *dh)
 291 {
 292     return dh->params.g;
 293 }
 294
 295 const BIGNUM *DH_get0_priv_key(const DH *dh)
 296 {
 297     return dh->priv_key;
 298 }
 299
 300 const BIGNUM *DH_get0_pub_key(const DH *dh)
 301 {
 302     return dh->pub_key;
 303 }
 304
 305 void DH_clear_flags(DH *dh, int flags)
 306 {
 307     dh->flags &= ~flags;
 308 }
 309
 310 int DH_test_flags(const DH *dh, int flags)
 311 {
 312     return dh->flags & flags;
 313 }
 314
 315 void DH_set_flags(DH *dh, int flags)
 316 {
 317     dh->flags |= flags;
 318 }
 319
 320 #ifndef FIPS_MODULE
 321 ENGINE *DH_get0_engine(DH *dh)
 322 {
 323     return dh->engine;
 324 }
 325 #endif /*FIPS_MODULE */
 326
 327 FFC_PARAMS *ossl_dh_get0_params(DH *dh)
 328 {
 329     return &dh->params;
 330 }
 331 int ossl_dh_get0_nid(const DH *dh)
 332 {
 333     return dh->params.nid;
 334 }