[thirdparty/openssl.git] / include / openssl / dh.h

/*
 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#ifndef OPENSSL_DH_H
# define OPENSSL_DH_H
# pragma once

# include <openssl/macros.h>
# ifndef OPENSSL_NO_DEPRECATED_3_0
#  define HEADER_DH_H
# endif

# include <openssl/opensslconf.h>
# include <openssl/types.h>

# ifdef  __cplusplus
extern "C" {
# endif

#include <stdlib.h>

/* DH parameter generation types used by EVP_PKEY_CTX_set_dh_paramgen_type() */
# define DH_PARAMGEN_TYPE_GENERATOR     0   /* Use a safe prime generator */
# define DH_PARAMGEN_TYPE_FIPS_186_2    1   /* Use FIPS186-2 standard */
# define DH_PARAMGEN_TYPE_FIPS_186_4    2   /* Use FIPS186-4 standard */
# define DH_PARAMGEN_TYPE_GROUP         3   /* Use a named safe prime group */

int EVP_PKEY_CTX_set_dh_paramgen_type(EVP_PKEY_CTX *ctx, int typ);
int EVP_PKEY_CTX_set_dh_paramgen_gindex(EVP_PKEY_CTX *ctx, int gindex);
int EVP_PKEY_CTX_set_dh_paramgen_seed(EVP_PKEY_CTX *ctx,
                                      const unsigned char *seed,
                                      size_t seedlen);
int EVP_PKEY_CTX_set_dh_paramgen_prime_len(EVP_PKEY_CTX *ctx, int pbits);
int EVP_PKEY_CTX_set_dh_paramgen_subprime_len(EVP_PKEY_CTX *ctx, int qlen);
int EVP_PKEY_CTX_set_dh_paramgen_generator(EVP_PKEY_CTX *ctx, int gen);
int EVP_PKEY_CTX_set_dh_nid(EVP_PKEY_CTX *ctx, int nid);
int EVP_PKEY_CTX_set_dh_rfc5114(EVP_PKEY_CTX *ctx, int gen);
int EVP_PKEY_CTX_set_dhx_rfc5114(EVP_PKEY_CTX *ctx, int gen);
int EVP_PKEY_CTX_set_dh_pad(EVP_PKEY_CTX *ctx, int pad);

int EVP_PKEY_CTX_set_dh_kdf_type(EVP_PKEY_CTX *ctx, int kdf);
int EVP_PKEY_CTX_get_dh_kdf_type(EVP_PKEY_CTX *ctx);
int EVP_PKEY_CTX_set0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT *oid);
int EVP_PKEY_CTX_get0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT **oid);
int EVP_PKEY_CTX_set_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
int EVP_PKEY_CTX_get_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
int EVP_PKEY_CTX_set_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int len);
int EVP_PKEY_CTX_get_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int *len);
int EVP_PKEY_CTX_set0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char *ukm, int len);
# ifndef OPENSSL_NO_DEPRECATED_3_0
OSSL_DEPRECATEDIN_3_0
int EVP_PKEY_CTX_get0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char **ukm);
#endif

# define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN     (EVP_PKEY_ALG_CTRL + 1)
# define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR     (EVP_PKEY_ALG_CTRL + 2)
# define EVP_PKEY_CTRL_DH_RFC5114                (EVP_PKEY_ALG_CTRL + 3)
# define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN  (EVP_PKEY_ALG_CTRL + 4)
# define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE          (EVP_PKEY_ALG_CTRL + 5)
# define EVP_PKEY_CTRL_DH_KDF_TYPE               (EVP_PKEY_ALG_CTRL + 6)
# define EVP_PKEY_CTRL_DH_KDF_MD                 (EVP_PKEY_ALG_CTRL + 7)
# define EVP_PKEY_CTRL_GET_DH_KDF_MD             (EVP_PKEY_ALG_CTRL + 8)
# define EVP_PKEY_CTRL_DH_KDF_OUTLEN             (EVP_PKEY_ALG_CTRL + 9)
# define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN         (EVP_PKEY_ALG_CTRL + 10)
# define EVP_PKEY_CTRL_DH_KDF_UKM                (EVP_PKEY_ALG_CTRL + 11)
# define EVP_PKEY_CTRL_GET_DH_KDF_UKM            (EVP_PKEY_ALG_CTRL + 12)
# define EVP_PKEY_CTRL_DH_KDF_OID                (EVP_PKEY_ALG_CTRL + 13)
# define EVP_PKEY_CTRL_GET_DH_KDF_OID            (EVP_PKEY_ALG_CTRL + 14)
# define EVP_PKEY_CTRL_DH_NID                    (EVP_PKEY_ALG_CTRL + 15)
# define EVP_PKEY_CTRL_DH_PAD                    (EVP_PKEY_ALG_CTRL + 16)

/* KDF types */
# define EVP_PKEY_DH_KDF_NONE                            1
# define EVP_PKEY_DH_KDF_X9_42                           2

# ifndef OPENSSL_NO_STDIO
#  include <stdio.h>
# endif
# ifndef OPENSSL_NO_DH
#  include <openssl/e_os2.h>
#  include <openssl/bio.h>
#  include <openssl/asn1.h>
#  ifndef OPENSSL_NO_DEPRECATED_1_1_0
#   include <openssl/bn.h>
#  endif
#  include <openssl/dherr.h>

#  ifndef OPENSSL_DH_MAX_MODULUS_BITS
#   define OPENSSL_DH_MAX_MODULUS_BITS        10000
#  endif

#  ifndef OPENSSL_DH_CHECK_MAX_MODULUS_BITS
#   define OPENSSL_DH_CHECK_MAX_MODULUS_BITS  32768
#  endif

#  define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024

#  define DH_FLAG_CACHE_MONT_P     0x01

#  define DH_FLAG_TYPE_MASK             0xF000
#  define DH_FLAG_TYPE_DH               0x0000
#  define DH_FLAG_TYPE_DHX              0x1000

#  ifndef OPENSSL_NO_DEPRECATED_1_1_0
/*
 * Does nothing. Previously this switched off constant time behaviour.
 */
#   define DH_FLAG_NO_EXP_CONSTTIME 0x00
#  endif

#  ifndef OPENSSL_NO_DEPRECATED_3_0
/*
 * If this flag is set the DH method is FIPS compliant and can be used in
 * FIPS mode. This is set in the validated module method. If an application
 * sets this flag in its own methods it is its responsibility to ensure the
 * result is compliant.
 */

#   define DH_FLAG_FIPS_METHOD                     0x0400

/*
 * If this flag is set the operations normally disabled in FIPS mode are
 * permitted it is then the applications responsibility to ensure that the
 * usage is compliant.
 */

#   define DH_FLAG_NON_FIPS_ALLOW                  0x0400
#  endif

/* Already defined in ossl_typ.h */
/* typedef struct dh_st DH; */
/* typedef struct dh_method DH_METHOD; */

DECLARE_ASN1_ITEM(DHparams)

#  ifndef OPENSSL_NO_DEPRECATED_3_0
#   define DH_GENERATOR_2          2
#   define DH_GENERATOR_3          3
#   define DH_GENERATOR_5          5

/* DH_check error codes */
/*
 * NB: These values must align with the equivalently named macros in
 * internal/ffc.h.
 */
#   define DH_CHECK_P_NOT_PRIME            0x01
#   define DH_CHECK_P_NOT_SAFE_PRIME       0x02
#   define DH_UNABLE_TO_CHECK_GENERATOR    0x04
#   define DH_NOT_SUITABLE_GENERATOR       0x08
#   define DH_CHECK_Q_NOT_PRIME            0x10
#   define DH_CHECK_INVALID_Q_VALUE        0x20
#   define DH_CHECK_INVALID_J_VALUE        0x40
#   define DH_MODULUS_TOO_SMALL            0x80
#   define DH_MODULUS_TOO_LARGE            0x100

/* DH_check_pub_key error codes */
#   define DH_CHECK_PUBKEY_TOO_SMALL       0x01
#   define DH_CHECK_PUBKEY_TOO_LARGE       0x02
#   define DH_CHECK_PUBKEY_INVALID         0x04

/*
 * primes p where (p-1)/2 is prime too are called "safe"; we define this for
 * backward compatibility:
 */
#   define DH_CHECK_P_NOT_STRONG_PRIME     DH_CHECK_P_NOT_SAFE_PRIME

#   define d2i_DHparams_fp(fp, x) \
        (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
                          (char *(*)())d2i_DHparams, \
                          (fp), \
                          (unsigned char **)(x))
#   define i2d_DHparams_fp(fp, x) \
        ASN1_i2d_fp(i2d_DHparams,(fp), (unsigned char *)(x))
#   define d2i_DHparams_bio(bp, x) \
        ASN1_d2i_bio_of(DH, DH_new, d2i_DHparams, bp, x)
#   define i2d_DHparams_bio(bp, x) \
        ASN1_i2d_bio_of(DH, i2d_DHparams, bp, x)

#   define d2i_DHxparams_fp(fp,x) \
        (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
                          (char *(*)())d2i_DHxparams, \
                          (fp), \
                          (unsigned char **)(x))
#   define i2d_DHxparams_fp(fp, x) \
        ASN1_i2d_fp(i2d_DHxparams,(fp), (unsigned char *)(x))
#   define d2i_DHxparams_bio(bp, x) \
        ASN1_d2i_bio_of(DH, DH_new, d2i_DHxparams, bp, x)
#   define i2d_DHxparams_bio(bp, x) \
        ASN1_i2d_bio_of(DH, i2d_DHxparams, bp, x)

DECLARE_ASN1_DUP_FUNCTION_name_attr(OSSL_DEPRECATEDIN_3_0, DH, DHparams)

OSSL_DEPRECATEDIN_3_0 const DH_METHOD *DH_OpenSSL(void);

OSSL_DEPRECATEDIN_3_0 void DH_set_default_method(const DH_METHOD *meth);
OSSL_DEPRECATEDIN_3_0 const DH_METHOD *DH_get_default_method(void);
OSSL_DEPRECATEDIN_3_0 int DH_set_method(DH *dh, const DH_METHOD *meth);
OSSL_DEPRECATEDIN_3_0 DH *DH_new_method(ENGINE *engine);

OSSL_DEPRECATEDIN_3_0 DH *DH_new(void);
OSSL_DEPRECATEDIN_3_0 void DH_free(DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_up_ref(DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_bits(const DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_size(const DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_security_bits(const DH *dh);

#   define DH_get_ex_new_index(l, p, newf, dupf, freef) \
        CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)

OSSL_DEPRECATEDIN_3_0 int DH_set_ex_data(DH *d, int idx, void *arg);
OSSL_DEPRECATEDIN_3_0 void *DH_get_ex_data(const DH *d, int idx);

OSSL_DEPRECATEDIN_3_0 int DH_generate_parameters_ex(DH *dh, int prime_len,
                                                    int generator,
                                                    BN_GENCB *cb);

OSSL_DEPRECATEDIN_3_0 int DH_check_params_ex(const DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_check_ex(const DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key);
OSSL_DEPRECATEDIN_3_0 int DH_check_params(const DH *dh, int *ret);
OSSL_DEPRECATEDIN_3_0 int DH_check(const DH *dh, int *codes);
OSSL_DEPRECATEDIN_3_0 int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key,
                                           int *codes);
OSSL_DEPRECATEDIN_3_0 int DH_generate_key(DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_compute_key(unsigned char *key,
                                         const BIGNUM *pub_key, DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_compute_key_padded(unsigned char *key,
                                                const BIGNUM *pub_key, DH *dh);

DECLARE_ASN1_ENCODE_FUNCTIONS_only_attr(OSSL_DEPRECATEDIN_3_0, DH, DHparams)
DECLARE_ASN1_ENCODE_FUNCTIONS_only_attr(OSSL_DEPRECATEDIN_3_0, DH, DHxparams)

#   ifndef OPENSSL_NO_STDIO
OSSL_DEPRECATEDIN_3_0 int DHparams_print_fp(FILE *fp, const DH *x);
#   endif
OSSL_DEPRECATEDIN_3_0 int DHparams_print(BIO *bp, const DH *x);

/* RFC 5114 parameters */
OSSL_DEPRECATEDIN_3_0 DH *DH_get_1024_160(void);
OSSL_DEPRECATEDIN_3_0 DH *DH_get_2048_224(void);
OSSL_DEPRECATEDIN_3_0 DH *DH_get_2048_256(void);

/* Named parameters, currently RFC7919 and RFC3526 */
OSSL_DEPRECATEDIN_3_0 DH *DH_new_by_nid(int nid);
OSSL_DEPRECATEDIN_3_0 int DH_get_nid(const DH *dh);

/* RFC2631 KDF */
OSSL_DEPRECATEDIN_3_0 int DH_KDF_X9_42(unsigned char *out, size_t outlen,
                                       const unsigned char *Z, size_t Zlen,
                                       ASN1_OBJECT *key_oid,
                                       const unsigned char *ukm,
                                       size_t ukmlen, const EVP_MD *md);

OSSL_DEPRECATEDIN_3_0 void DH_get0_pqg(const DH *dh, const BIGNUM **p,
                                       const BIGNUM **q, const BIGNUM **g);
OSSL_DEPRECATEDIN_3_0 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);
OSSL_DEPRECATEDIN_3_0 void DH_get0_key(const DH *dh, const BIGNUM **pub_key,
                                       const BIGNUM **priv_key);
OSSL_DEPRECATEDIN_3_0 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);
OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_p(const DH *dh);
OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_q(const DH *dh);
OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_g(const DH *dh);
OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_priv_key(const DH *dh);
OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_pub_key(const DH *dh);
OSSL_DEPRECATEDIN_3_0 void DH_clear_flags(DH *dh, int flags);
OSSL_DEPRECATEDIN_3_0 int DH_test_flags(const DH *dh, int flags);
OSSL_DEPRECATEDIN_3_0 void DH_set_flags(DH *dh, int flags);
OSSL_DEPRECATEDIN_3_0 ENGINE *DH_get0_engine(DH *d);
OSSL_DEPRECATEDIN_3_0 long DH_get_length(const DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_set_length(DH *dh, long length);

OSSL_DEPRECATEDIN_3_0 DH_METHOD *DH_meth_new(const char *name, int flags);
OSSL_DEPRECATEDIN_3_0 void DH_meth_free(DH_METHOD *dhm);
OSSL_DEPRECATEDIN_3_0 DH_METHOD *DH_meth_dup(const DH_METHOD *dhm);
OSSL_DEPRECATEDIN_3_0 const char *DH_meth_get0_name(const DH_METHOD *dhm);
OSSL_DEPRECATEDIN_3_0 int DH_meth_set1_name(DH_METHOD *dhm, const char *name);
OSSL_DEPRECATEDIN_3_0 int DH_meth_get_flags(const DH_METHOD *dhm);
OSSL_DEPRECATEDIN_3_0 int DH_meth_set_flags(DH_METHOD *dhm, int flags);
OSSL_DEPRECATEDIN_3_0 void *DH_meth_get0_app_data(const DH_METHOD *dhm);
OSSL_DEPRECATEDIN_3_0 int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data);
OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_generate_key(const DH_METHOD *dhm)) (DH *);
OSSL_DEPRECATEDIN_3_0 int DH_meth_set_generate_key(DH_METHOD *dhm,
                                                   int (*generate_key) (DH *));
OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_compute_key(const DH_METHOD *dhm))
                                                   (unsigned char *key,
                                                    const BIGNUM *pub_key,
                                                    DH *dh);
OSSL_DEPRECATEDIN_3_0 int DH_meth_set_compute_key(DH_METHOD *dhm,
                                                  int (*compute_key)
                                                  (unsigned char *key,
                                                   const BIGNUM *pub_key,
                                                   DH *dh));
OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm))
                                                   (const DH *, BIGNUM *,
                                                    const BIGNUM *,
                                                    const BIGNUM *,
                                                    const BIGNUM *, BN_CTX *,
                                                    BN_MONT_CTX *);
OSSL_DEPRECATEDIN_3_0 int DH_meth_set_bn_mod_exp(DH_METHOD *dhm,
                                                 int (*bn_mod_exp)
                                                 (const DH *, BIGNUM *,
                                                  const BIGNUM *, const BIGNUM *,
                                                  const BIGNUM *, BN_CTX *,
                                                  BN_MONT_CTX *));
OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *);
OSSL_DEPRECATEDIN_3_0 int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *));
OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_finish(const DH_METHOD *dhm)) (DH *);
OSSL_DEPRECATEDIN_3_0 int DH_meth_set_finish(DH_METHOD *dhm, int (*finish) (DH *));
OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_generate_params(const DH_METHOD *dhm))
                                                        (DH *, int, int,
                                                         BN_GENCB *);
OSSL_DEPRECATEDIN_3_0 int DH_meth_set_generate_params(DH_METHOD *dhm,
                                                      int (*generate_params)
                                                      (DH *, int, int,
                                                       BN_GENCB *));
#  endif /* OPENSSL_NO_DEPRECATED_3_0 */

#  ifndef OPENSSL_NO_DEPRECATED_0_9_8
OSSL_DEPRECATEDIN_0_9_8 DH *DH_generate_parameters(int prime_len, int generator,
                                                   void (*callback) (int, int,
                                                                void *),
                                                   void *cb_arg);
#  endif

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