jpayne@69: /* jpayne@69: * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved. jpayne@69: * jpayne@69: * Licensed under the OpenSSL license (the "License"). You may not use jpayne@69: * this file except in compliance with the License. You can obtain a copy jpayne@69: * in the file LICENSE in the source distribution or at jpayne@69: * https://www.openssl.org/source/license.html jpayne@69: */ jpayne@69: jpayne@69: #ifndef HEADER_DH_H jpayne@69: # define HEADER_DH_H jpayne@69: jpayne@69: # include jpayne@69: jpayne@69: # ifndef OPENSSL_NO_DH jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # include jpayne@69: # if OPENSSL_API_COMPAT < 0x10100000L jpayne@69: # include jpayne@69: # endif jpayne@69: # include jpayne@69: jpayne@69: # ifdef __cplusplus jpayne@69: extern "C" { jpayne@69: # endif jpayne@69: jpayne@69: # ifndef OPENSSL_DH_MAX_MODULUS_BITS jpayne@69: # define OPENSSL_DH_MAX_MODULUS_BITS 10000 jpayne@69: # endif jpayne@69: # ifndef OPENSSL_DH_CHECK_MAX_MODULUS_BITS jpayne@69: # define OPENSSL_DH_CHECK_MAX_MODULUS_BITS 32768 jpayne@69: # endif jpayne@69: jpayne@69: # define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024 jpayne@69: jpayne@69: # define DH_FLAG_CACHE_MONT_P 0x01 jpayne@69: jpayne@69: # if OPENSSL_API_COMPAT < 0x10100000L jpayne@69: /* jpayne@69: * Does nothing. Previously this switched off constant time behaviour. jpayne@69: */ jpayne@69: # define DH_FLAG_NO_EXP_CONSTTIME 0x00 jpayne@69: # endif jpayne@69: jpayne@69: /* jpayne@69: * If this flag is set the DH method is FIPS compliant and can be used in jpayne@69: * FIPS mode. This is set in the validated module method. If an application jpayne@69: * sets this flag in its own methods it is its responsibility to ensure the jpayne@69: * result is compliant. jpayne@69: */ jpayne@69: jpayne@69: # define DH_FLAG_FIPS_METHOD 0x0400 jpayne@69: jpayne@69: /* jpayne@69: * If this flag is set the operations normally disabled in FIPS mode are jpayne@69: * permitted it is then the applications responsibility to ensure that the jpayne@69: * usage is compliant. jpayne@69: */ jpayne@69: jpayne@69: # define DH_FLAG_NON_FIPS_ALLOW 0x0400 jpayne@69: jpayne@69: /* Already defined in ossl_typ.h */ jpayne@69: /* typedef struct dh_st DH; */ jpayne@69: /* typedef struct dh_method DH_METHOD; */ jpayne@69: jpayne@69: DECLARE_ASN1_ITEM(DHparams) jpayne@69: jpayne@69: # define DH_GENERATOR_2 2 jpayne@69: /* #define DH_GENERATOR_3 3 */ jpayne@69: # define DH_GENERATOR_5 5 jpayne@69: jpayne@69: /* DH_check error codes */ jpayne@69: # define DH_CHECK_P_NOT_PRIME 0x01 jpayne@69: # define DH_CHECK_P_NOT_SAFE_PRIME 0x02 jpayne@69: # define DH_UNABLE_TO_CHECK_GENERATOR 0x04 jpayne@69: # define DH_NOT_SUITABLE_GENERATOR 0x08 jpayne@69: # define DH_CHECK_Q_NOT_PRIME 0x10 jpayne@69: # define DH_CHECK_INVALID_Q_VALUE 0x20 jpayne@69: # define DH_CHECK_INVALID_J_VALUE 0x40 jpayne@69: jpayne@69: /* DH_check_pub_key error codes */ jpayne@69: # define DH_CHECK_PUBKEY_TOO_SMALL 0x01 jpayne@69: # define DH_CHECK_PUBKEY_TOO_LARGE 0x02 jpayne@69: # define DH_CHECK_PUBKEY_INVALID 0x04 jpayne@69: jpayne@69: /* jpayne@69: * primes p where (p-1)/2 is prime too are called "safe"; we define this for jpayne@69: * backward compatibility: jpayne@69: */ jpayne@69: # define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME jpayne@69: jpayne@69: # define d2i_DHparams_fp(fp,x) \ jpayne@69: (DH *)ASN1_d2i_fp((char *(*)())DH_new, \ jpayne@69: (char *(*)())d2i_DHparams, \ jpayne@69: (fp), \ jpayne@69: (unsigned char **)(x)) jpayne@69: # define i2d_DHparams_fp(fp,x) \ jpayne@69: ASN1_i2d_fp(i2d_DHparams,(fp), (unsigned char *)(x)) jpayne@69: # define d2i_DHparams_bio(bp,x) \ jpayne@69: ASN1_d2i_bio_of(DH, DH_new, d2i_DHparams, bp, x) jpayne@69: # define i2d_DHparams_bio(bp,x) \ jpayne@69: ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x) jpayne@69: jpayne@69: # define d2i_DHxparams_fp(fp,x) \ jpayne@69: (DH *)ASN1_d2i_fp((char *(*)())DH_new, \ jpayne@69: (char *(*)())d2i_DHxparams, \ jpayne@69: (fp), \ jpayne@69: (unsigned char **)(x)) jpayne@69: # define i2d_DHxparams_fp(fp,x) \ jpayne@69: ASN1_i2d_fp(i2d_DHxparams,(fp), (unsigned char *)(x)) jpayne@69: # define d2i_DHxparams_bio(bp,x) \ jpayne@69: ASN1_d2i_bio_of(DH, DH_new, d2i_DHxparams, bp, x) jpayne@69: # define i2d_DHxparams_bio(bp,x) \ jpayne@69: ASN1_i2d_bio_of_const(DH, i2d_DHxparams, bp, x) jpayne@69: jpayne@69: DH *DHparams_dup(DH *); jpayne@69: jpayne@69: const DH_METHOD *DH_OpenSSL(void); jpayne@69: jpayne@69: void DH_set_default_method(const DH_METHOD *meth); jpayne@69: const DH_METHOD *DH_get_default_method(void); jpayne@69: int DH_set_method(DH *dh, const DH_METHOD *meth); jpayne@69: DH *DH_new_method(ENGINE *engine); jpayne@69: jpayne@69: DH *DH_new(void); jpayne@69: void DH_free(DH *dh); jpayne@69: int DH_up_ref(DH *dh); jpayne@69: int DH_bits(const DH *dh); jpayne@69: int DH_size(const DH *dh); jpayne@69: int DH_security_bits(const DH *dh); jpayne@69: #define DH_get_ex_new_index(l, p, newf, dupf, freef) \ jpayne@69: CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef) jpayne@69: int DH_set_ex_data(DH *d, int idx, void *arg); jpayne@69: void *DH_get_ex_data(DH *d, int idx); jpayne@69: jpayne@69: /* Deprecated version */ jpayne@69: DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator, jpayne@69: void (*callback) (int, int, jpayne@69: void *), jpayne@69: void *cb_arg)) jpayne@69: jpayne@69: /* New version */ jpayne@69: int DH_generate_parameters_ex(DH *dh, int prime_len, int generator, jpayne@69: BN_GENCB *cb); jpayne@69: jpayne@69: int DH_check_params_ex(const DH *dh); jpayne@69: int DH_check_ex(const DH *dh); jpayne@69: int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key); jpayne@69: int DH_check_params(const DH *dh, int *ret); jpayne@69: int DH_check(const DH *dh, int *codes); jpayne@69: int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes); jpayne@69: int DH_generate_key(DH *dh); jpayne@69: int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh); jpayne@69: int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh); jpayne@69: DH *d2i_DHparams(DH **a, const unsigned char **pp, long length); jpayne@69: int i2d_DHparams(const DH *a, unsigned char **pp); jpayne@69: DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length); jpayne@69: int i2d_DHxparams(const DH *a, unsigned char **pp); jpayne@69: # ifndef OPENSSL_NO_STDIO jpayne@69: int DHparams_print_fp(FILE *fp, const DH *x); jpayne@69: # endif jpayne@69: int DHparams_print(BIO *bp, const DH *x); jpayne@69: jpayne@69: /* RFC 5114 parameters */ jpayne@69: DH *DH_get_1024_160(void); jpayne@69: DH *DH_get_2048_224(void); jpayne@69: DH *DH_get_2048_256(void); jpayne@69: jpayne@69: /* Named parameters, currently RFC7919 */ jpayne@69: DH *DH_new_by_nid(int nid); jpayne@69: int DH_get_nid(const DH *dh); jpayne@69: jpayne@69: # ifndef OPENSSL_NO_CMS jpayne@69: /* RFC2631 KDF */ jpayne@69: int DH_KDF_X9_42(unsigned char *out, size_t outlen, jpayne@69: const unsigned char *Z, size_t Zlen, jpayne@69: ASN1_OBJECT *key_oid, jpayne@69: const unsigned char *ukm, size_t ukmlen, const EVP_MD *md); jpayne@69: # endif jpayne@69: jpayne@69: void DH_get0_pqg(const DH *dh, jpayne@69: const BIGNUM **p, const BIGNUM **q, const BIGNUM **g); jpayne@69: int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g); jpayne@69: void DH_get0_key(const DH *dh, jpayne@69: const BIGNUM **pub_key, const BIGNUM **priv_key); jpayne@69: int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key); jpayne@69: const BIGNUM *DH_get0_p(const DH *dh); jpayne@69: const BIGNUM *DH_get0_q(const DH *dh); jpayne@69: const BIGNUM *DH_get0_g(const DH *dh); jpayne@69: const BIGNUM *DH_get0_priv_key(const DH *dh); jpayne@69: const BIGNUM *DH_get0_pub_key(const DH *dh); jpayne@69: void DH_clear_flags(DH *dh, int flags); jpayne@69: int DH_test_flags(const DH *dh, int flags); jpayne@69: void DH_set_flags(DH *dh, int flags); jpayne@69: ENGINE *DH_get0_engine(DH *d); jpayne@69: long DH_get_length(const DH *dh); jpayne@69: int DH_set_length(DH *dh, long length); jpayne@69: jpayne@69: DH_METHOD *DH_meth_new(const char *name, int flags); jpayne@69: void DH_meth_free(DH_METHOD *dhm); jpayne@69: DH_METHOD *DH_meth_dup(const DH_METHOD *dhm); jpayne@69: const char *DH_meth_get0_name(const DH_METHOD *dhm); jpayne@69: int DH_meth_set1_name(DH_METHOD *dhm, const char *name); jpayne@69: int DH_meth_get_flags(const DH_METHOD *dhm); jpayne@69: int DH_meth_set_flags(DH_METHOD *dhm, int flags); jpayne@69: void *DH_meth_get0_app_data(const DH_METHOD *dhm); jpayne@69: int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data); jpayne@69: int (*DH_meth_get_generate_key(const DH_METHOD *dhm)) (DH *); jpayne@69: int DH_meth_set_generate_key(DH_METHOD *dhm, int (*generate_key) (DH *)); jpayne@69: int (*DH_meth_get_compute_key(const DH_METHOD *dhm)) jpayne@69: (unsigned char *key, const BIGNUM *pub_key, DH *dh); jpayne@69: int DH_meth_set_compute_key(DH_METHOD *dhm, jpayne@69: int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh)); jpayne@69: int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm)) jpayne@69: (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *, jpayne@69: BN_CTX *, BN_MONT_CTX *); jpayne@69: int DH_meth_set_bn_mod_exp(DH_METHOD *dhm, jpayne@69: int (*bn_mod_exp) (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *, jpayne@69: const BIGNUM *, BN_CTX *, BN_MONT_CTX *)); jpayne@69: int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *); jpayne@69: int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *)); jpayne@69: int (*DH_meth_get_finish(const DH_METHOD *dhm)) (DH *); jpayne@69: int DH_meth_set_finish(DH_METHOD *dhm, int (*finish) (DH *)); jpayne@69: int (*DH_meth_get_generate_params(const DH_METHOD *dhm)) jpayne@69: (DH *, int, int, BN_GENCB *); jpayne@69: int DH_meth_set_generate_params(DH_METHOD *dhm, jpayne@69: int (*generate_params) (DH *, int, int, BN_GENCB *)); jpayne@69: jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ jpayne@69: EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ jpayne@69: EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ jpayne@69: EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ jpayne@69: EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \ jpayne@69: EVP_PKEY_CTRL_DH_RFC5114, gen, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \ jpayne@69: EVP_PKEY_CTRL_DH_RFC5114, gen, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_nid(ctx, nid) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, \ jpayne@69: EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN, \ jpayne@69: EVP_PKEY_CTRL_DH_NID, nid, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_pad(ctx, pad) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_DH_PAD, pad, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)(oid)) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)(poid)) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)(md)) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)(pmd)) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)(plen)) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)(p)) jpayne@69: jpayne@69: # define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \ jpayne@69: EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \ jpayne@69: EVP_PKEY_OP_DERIVE, \ jpayne@69: EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)(p)) jpayne@69: jpayne@69: # define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1) jpayne@69: # define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2) jpayne@69: # define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3) jpayne@69: # define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN (EVP_PKEY_ALG_CTRL + 4) jpayne@69: # define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE (EVP_PKEY_ALG_CTRL + 5) jpayne@69: # define EVP_PKEY_CTRL_DH_KDF_TYPE (EVP_PKEY_ALG_CTRL + 6) jpayne@69: # define EVP_PKEY_CTRL_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 7) jpayne@69: # define EVP_PKEY_CTRL_GET_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 8) jpayne@69: # define EVP_PKEY_CTRL_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 9) jpayne@69: # define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 10) jpayne@69: # define EVP_PKEY_CTRL_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 11) jpayne@69: # define EVP_PKEY_CTRL_GET_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 12) jpayne@69: # define EVP_PKEY_CTRL_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 13) jpayne@69: # define EVP_PKEY_CTRL_GET_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 14) jpayne@69: # define EVP_PKEY_CTRL_DH_NID (EVP_PKEY_ALG_CTRL + 15) jpayne@69: # define EVP_PKEY_CTRL_DH_PAD (EVP_PKEY_ALG_CTRL + 16) jpayne@69: jpayne@69: /* KDF types */ jpayne@69: # define EVP_PKEY_DH_KDF_NONE 1 jpayne@69: # ifndef OPENSSL_NO_CMS jpayne@69: # define EVP_PKEY_DH_KDF_X9_42 2 jpayne@69: # endif jpayne@69: jpayne@69: jpayne@69: # ifdef __cplusplus jpayne@69: } jpayne@69: # endif jpayne@69: # endif jpayne@69: #endif