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