1 /* 2 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved. 3 * 4 * Licensed under the OpenSSL license (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 #ifndef HEADER_DH_H 11 # define HEADER_DH_H 12 13 # include <openssl/opensslconf.h> 14 15 # ifndef OPENSSL_NO_DH 16 # include <openssl/e_os2.h> 17 # include <openssl/bio.h> 18 # include <openssl/asn1.h> 19 # include <openssl/ossl_typ.h> 20 # if OPENSSL_API_COMPAT < 0x10100000L 21 # include <openssl/bn.h> 22 # endif 23 # include <openssl/dherr.h> 24 25 # ifdef __cplusplus 26 extern "C" { 27 # endif 28 29 # ifndef OPENSSL_DH_MAX_MODULUS_BITS 30 # define OPENSSL_DH_MAX_MODULUS_BITS 10000 31 # endif 32 # ifndef OPENSSL_DH_CHECK_MAX_MODULUS_BITS 33 # define OPENSSL_DH_CHECK_MAX_MODULUS_BITS 32768 34 # endif 35 36 # define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024 37 38 # define DH_FLAG_CACHE_MONT_P 0x01 39 40 # if OPENSSL_API_COMPAT < 0x10100000L 41 /* 42 * Does nothing. Previously this switched off constant time behaviour. 43 */ 44 # define DH_FLAG_NO_EXP_CONSTTIME 0x00 45 # endif 46 47 /* 48 * If this flag is set the DH method is FIPS compliant and can be used in 49 * FIPS mode. This is set in the validated module method. If an application 50 * sets this flag in its own methods it is its responsibility to ensure the 51 * result is compliant. 52 */ 53 54 # define DH_FLAG_FIPS_METHOD 0x0400 55 56 /* 57 * If this flag is set the operations normally disabled in FIPS mode are 58 * permitted it is then the applications responsibility to ensure that the 59 * usage is compliant. 60 */ 61 62 # define DH_FLAG_NON_FIPS_ALLOW 0x0400 63 64 /* Already defined in ossl_typ.h */ 65 /* typedef struct dh_st DH; */ 66 /* typedef struct dh_method DH_METHOD; */ 67 68 DECLARE_ASN1_ITEM(DHparams) 69 70 # define DH_GENERATOR_2 2 71 /* #define DH_GENERATOR_3 3 */ 72 # define DH_GENERATOR_5 5 73 74 /* DH_check error codes */ 75 # define DH_CHECK_P_NOT_PRIME 0x01 76 # define DH_CHECK_P_NOT_SAFE_PRIME 0x02 77 # define DH_UNABLE_TO_CHECK_GENERATOR 0x04 78 # define DH_NOT_SUITABLE_GENERATOR 0x08 79 # define DH_CHECK_Q_NOT_PRIME 0x10 80 # define DH_CHECK_INVALID_Q_VALUE 0x20 81 # define DH_CHECK_INVALID_J_VALUE 0x40 82 83 /* DH_check_pub_key error codes */ 84 # define DH_CHECK_PUBKEY_TOO_SMALL 0x01 85 # define DH_CHECK_PUBKEY_TOO_LARGE 0x02 86 # define DH_CHECK_PUBKEY_INVALID 0x04 87 88 /* 89 * primes p where (p-1)/2 is prime too are called "safe"; we define this for 90 * backward compatibility: 91 */ 92 # define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME 93 94 # define d2i_DHparams_fp(fp,x) \ 95 (DH *)ASN1_d2i_fp((char *(*)())DH_new, \ 96 (char *(*)())d2i_DHparams, \ 97 (fp), \ 98 (unsigned char **)(x)) 99 # define i2d_DHparams_fp(fp,x) \ 100 ASN1_i2d_fp(i2d_DHparams,(fp), (unsigned char *)(x)) 101 # define d2i_DHparams_bio(bp,x) \ 102 ASN1_d2i_bio_of(DH, DH_new, d2i_DHparams, bp, x) 103 # define i2d_DHparams_bio(bp,x) \ 104 ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x) 105 106 # define d2i_DHxparams_fp(fp,x) \ 107 (DH *)ASN1_d2i_fp((char *(*)())DH_new, \ 108 (char *(*)())d2i_DHxparams, \ 109 (fp), \ 110 (unsigned char **)(x)) 111 # define i2d_DHxparams_fp(fp,x) \ 112 ASN1_i2d_fp(i2d_DHxparams,(fp), (unsigned char *)(x)) 113 # define d2i_DHxparams_bio(bp,x) \ 114 ASN1_d2i_bio_of(DH, DH_new, d2i_DHxparams, bp, x) 115 # define i2d_DHxparams_bio(bp,x) \ 116 ASN1_i2d_bio_of_const(DH, i2d_DHxparams, bp, x) 117 118 DH *DHparams_dup(DH *); 119 120 const DH_METHOD *DH_OpenSSL(void); 121 122 void DH_set_default_method(const DH_METHOD *meth); 123 const DH_METHOD *DH_get_default_method(void); 124 int DH_set_method(DH *dh, const DH_METHOD *meth); 125 DH *DH_new_method(ENGINE *engine); 126 127 DH *DH_new(void); 128 void DH_free(DH *dh); 129 int DH_up_ref(DH *dh); 130 int DH_bits(const DH *dh); 131 int DH_size(const DH *dh); 132 int DH_security_bits(const DH *dh); 133 #define DH_get_ex_new_index(l, p, newf, dupf, freef) \ 134 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef) 135 int DH_set_ex_data(DH *d, int idx, void *arg); 136 void *DH_get_ex_data(DH *d, int idx); 137 138 /* Deprecated version */ 139 DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator, 140 void (*callback) (int, int, 141 void *), 142 void *cb_arg)) 143 144 /* New version */ 145 int DH_generate_parameters_ex(DH *dh, int prime_len, int generator, 146 BN_GENCB *cb); 147 148 int DH_check_params_ex(const DH *dh); 149 int DH_check_ex(const DH *dh); 150 int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key); 151 int DH_check_params(const DH *dh, int *ret); 152 int DH_check(const DH *dh, int *codes); 153 int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes); 154 int DH_generate_key(DH *dh); 155 int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh); 156 int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh); 157 DH *d2i_DHparams(DH **a, const unsigned char **pp, long length); 158 int i2d_DHparams(const DH *a, unsigned char **pp); 159 DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length); 160 int i2d_DHxparams(const DH *a, unsigned char **pp); 161 # ifndef OPENSSL_NO_STDIO 162 int DHparams_print_fp(FILE *fp, const DH *x); 163 # endif 164 int DHparams_print(BIO *bp, const DH *x); 165 166 /* RFC 5114 parameters */ 167 DH *DH_get_1024_160(void); 168 DH *DH_get_2048_224(void); 169 DH *DH_get_2048_256(void); 170 171 /* Named parameters, currently RFC7919 */ 172 DH *DH_new_by_nid(int nid); 173 int DH_get_nid(const DH *dh); 174 175 # ifndef OPENSSL_NO_CMS 176 /* RFC2631 KDF */ 177 int DH_KDF_X9_42(unsigned char *out, size_t outlen, 178 const unsigned char *Z, size_t Zlen, 179 ASN1_OBJECT *key_oid, 180 const unsigned char *ukm, size_t ukmlen, const EVP_MD *md); 181 # endif 182 183 void DH_get0_pqg(const DH *dh, 184 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g); 185 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g); 186 void DH_get0_key(const DH *dh, 187 const BIGNUM **pub_key, const BIGNUM **priv_key); 188 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key); 189 const BIGNUM *DH_get0_p(const DH *dh); 190 const BIGNUM *DH_get0_q(const DH *dh); 191 const BIGNUM *DH_get0_g(const DH *dh); 192 const BIGNUM *DH_get0_priv_key(const DH *dh); 193 const BIGNUM *DH_get0_pub_key(const DH *dh); 194 void DH_clear_flags(DH *dh, int flags); 195 int DH_test_flags(const DH *dh, int flags); 196 void DH_set_flags(DH *dh, int flags); 197 ENGINE *DH_get0_engine(DH *d); 198 long DH_get_length(const DH *dh); 199 int DH_set_length(DH *dh, long length); 200 201 DH_METHOD *DH_meth_new(const char *name, int flags); 202 void DH_meth_free(DH_METHOD *dhm); 203 DH_METHOD *DH_meth_dup(const DH_METHOD *dhm); 204 const char *DH_meth_get0_name(const DH_METHOD *dhm); 205 int DH_meth_set1_name(DH_METHOD *dhm, const char *name); 206 int DH_meth_get_flags(const DH_METHOD *dhm); 207 int DH_meth_set_flags(DH_METHOD *dhm, int flags); 208 void *DH_meth_get0_app_data(const DH_METHOD *dhm); 209 int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data); 210 int (*DH_meth_get_generate_key(const DH_METHOD *dhm)) (DH *); 211 int DH_meth_set_generate_key(DH_METHOD *dhm, int (*generate_key) (DH *)); 212 int (*DH_meth_get_compute_key(const DH_METHOD *dhm)) 213 (unsigned char *key, const BIGNUM *pub_key, DH *dh); 214 int DH_meth_set_compute_key(DH_METHOD *dhm, 215 int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh)); 216 int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm)) 217 (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *, 218 BN_CTX *, BN_MONT_CTX *); 219 int DH_meth_set_bn_mod_exp(DH_METHOD *dhm, 220 int (*bn_mod_exp) (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *, 221 const BIGNUM *, BN_CTX *, BN_MONT_CTX *)); 222 int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *); 223 int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *)); 224 int (*DH_meth_get_finish(const DH_METHOD *dhm)) (DH *); 225 int DH_meth_set_finish(DH_METHOD *dhm, int (*finish) (DH *)); 226 int (*DH_meth_get_generate_params(const DH_METHOD *dhm)) 227 (DH *, int, int, BN_GENCB *); 228 int DH_meth_set_generate_params(DH_METHOD *dhm, 229 int (*generate_params) (DH *, int, int, BN_GENCB *)); 230 231 232 # define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \ 233 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ 234 EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL) 235 236 # define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \ 237 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ 238 EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL) 239 240 # define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \ 241 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ 242 EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL) 243 244 # define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \ 245 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ 246 EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL) 247 248 # define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \ 249 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \ 250 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL) 251 252 # define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \ 253 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \ 254 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL) 255 256 # define EVP_PKEY_CTX_set_dh_nid(ctx, nid) \ 257 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, \ 258 EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN, \ 259 EVP_PKEY_CTRL_DH_NID, nid, NULL) 260 261 # define EVP_PKEY_CTX_set_dh_pad(ctx, pad) \ 262 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_DERIVE, \ 263 EVP_PKEY_CTRL_DH_PAD, pad, NULL) 264 265 # define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \ 266 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 267 EVP_PKEY_OP_DERIVE, \ 268 EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL) 269 270 # define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \ 271 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 272 EVP_PKEY_OP_DERIVE, \ 273 EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL) 274 275 # define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \ 276 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 277 EVP_PKEY_OP_DERIVE, \ 278 EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)(oid)) 279 280 # define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \ 281 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 282 EVP_PKEY_OP_DERIVE, \ 283 EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)(poid)) 284 285 # define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \ 286 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 287 EVP_PKEY_OP_DERIVE, \ 288 EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)(md)) 289 290 # define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \ 291 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 292 EVP_PKEY_OP_DERIVE, \ 293 EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)(pmd)) 294 295 # define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \ 296 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 297 EVP_PKEY_OP_DERIVE, \ 298 EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL) 299 300 # define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \ 301 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 302 EVP_PKEY_OP_DERIVE, \ 303 EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)(plen)) 304 305 # define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \ 306 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 307 EVP_PKEY_OP_DERIVE, \ 308 EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)(p)) 309 310 # define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \ 311 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ 312 EVP_PKEY_OP_DERIVE, \ 313 EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)(p)) 314 315 # define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1) 316 # define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2) 317 # define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3) 318 # define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN (EVP_PKEY_ALG_CTRL + 4) 319 # define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE (EVP_PKEY_ALG_CTRL + 5) 320 # define EVP_PKEY_CTRL_DH_KDF_TYPE (EVP_PKEY_ALG_CTRL + 6) 321 # define EVP_PKEY_CTRL_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 7) 322 # define EVP_PKEY_CTRL_GET_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 8) 323 # define EVP_PKEY_CTRL_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 9) 324 # define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 10) 325 # define EVP_PKEY_CTRL_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 11) 326 # define EVP_PKEY_CTRL_GET_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 12) 327 # define EVP_PKEY_CTRL_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 13) 328 # define EVP_PKEY_CTRL_GET_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 14) 329 # define EVP_PKEY_CTRL_DH_NID (EVP_PKEY_ALG_CTRL + 15) 330 # define EVP_PKEY_CTRL_DH_PAD (EVP_PKEY_ALG_CTRL + 16) 331 332 /* KDF types */ 333 # define EVP_PKEY_DH_KDF_NONE 1 334 # ifndef OPENSSL_NO_CMS 335 # define EVP_PKEY_DH_KDF_X9_42 2 336 # endif 337 338 339 # ifdef __cplusplus 340 } 341 # endif 342 # endif 343 #endif 344