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

/*
 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the OpenSSL license (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 HEADER_DH_H
# define HEADER_DH_H

# include <openssl/opensslconf.h>

# ifndef OPENSSL_NO_DH
# include <openssl/e_os2.h>
# include <openssl/bio.h>
# include <openssl/asn1.h>
# include <openssl/ossl_typ.h>
# if OPENSSL_API_COMPAT < 0x10100000L
#  include <openssl/bn.h>
# endif

# ifdef  __cplusplus
extern "C" {
# endif

# ifndef OPENSSL_DH_MAX_MODULUS_BITS
#  define OPENSSL_DH_MAX_MODULUS_BITS    10000
# endif

# define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024

# define DH_FLAG_CACHE_MONT_P     0x01

# if OPENSSL_API_COMPAT < 0x10100000L
/*
 * Does nothing. Previously this switched off constant time behaviour.
 */
#  define DH_FLAG_NO_EXP_CONSTTIME 0x00
# endif

/*
 * 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

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

DECLARE_ASN1_ITEM(DHparams)

# define DH_GENERATOR_2          2
/* #define DH_GENERATOR_3       3 */
# define DH_GENERATOR_5          5

/* DH_check error codes */
# 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

/* 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_const(DH,i2d_DHparams,bp,x)

DH *DHparams_dup(DH *);

const DH_METHOD *DH_OpenSSL(void);

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

DH *DH_new(void);
void DH_free(DH *dh);
int DH_up_ref(DH *dh);
int DH_bits(const DH *dh);
int DH_size(const DH *dh);
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)
int DH_set_ex_data(DH *d, int idx, void *arg);
void *DH_get_ex_data(DH *d, int idx);

/* Deprecated version */
DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator,
                                              void (*callback) (int, int,
                                                                void *),
                                              void *cb_arg))

/* New version */
int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
                              BN_GENCB *cb);

int DH_check(const DH *dh, int *codes);
int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes);
int DH_generate_key(DH *dh);
int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh);
DH *d2i_DHparams(DH **a, const unsigned char **pp, long length);
int i2d_DHparams(const DH *a, unsigned char **pp);
DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length);
int i2d_DHxparams(const DH *a, unsigned char **pp);
# ifndef OPENSSL_NO_STDIO
int DHparams_print_fp(FILE *fp, const DH *x);
# endif
int DHparams_print(BIO *bp, const DH *x);

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

# ifndef OPENSSL_NO_CMS
/* RFC2631 KDF */
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);
# endif

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

DH_METHOD *DH_meth_new(const char *name, int flags);
void DH_meth_free(DH_METHOD *dhm);
DH_METHOD *DH_meth_dup(const DH_METHOD *dhm);
const char *DH_meth_get0_name(const DH_METHOD *dhm);
int DH_meth_set1_name(DH_METHOD *dhm, const char *name);
int DH_meth_get_flags(DH_METHOD *dhm);
int DH_meth_set_flags(DH_METHOD *dhm, int flags);
void *DH_meth_get0_app_data(const DH_METHOD *dhm);
int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data);
int (*DH_meth_get_generate_key(const DH_METHOD *dhm)) (DH *);
int DH_meth_set_generate_key(DH_METHOD *dhm, int (*generate_key) (DH *));
int (*DH_meth_get_compute_key(const DH_METHOD *dhm))
        (unsigned char *key, const BIGNUM *pub_key, DH *dh);
int DH_meth_set_compute_key(DH_METHOD *dhm,
        int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh));
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 *);
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 *));
int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *);
int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *));
int (*DH_meth_get_finish(const DH_METHOD *dhm)) (DH *);
int DH_meth_set_finish(DH_METHOD *dhm, int (*finish) (DH *));
int (*DH_meth_get_generate_params(const DH_METHOD *dhm))
        (DH *, int, int, BN_GENCB *);
int DH_meth_set_generate_params(DH_METHOD *dhm,
        int (*generate_params) (DH *, int, int, BN_GENCB *));


# define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
                        EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)

# define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
                        EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL)

# define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
                        EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL)

# define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
                        EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)

# define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
                        EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)

# define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
                        EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)

# define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                                EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL)

# define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                                EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL)

# define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                                EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)oid)

# define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                                EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)poid)

# define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                                EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)md)

# define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                                EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)pmd)

# define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                                EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL)

# define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                        EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)plen)

# define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                                EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)p)

# define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \
        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
                                EVP_PKEY_OP_DERIVE, \
                                EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)p)

# 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)

/* KDF types */
# define EVP_PKEY_DH_KDF_NONE                            1
# ifndef OPENSSL_NO_CMS
# define EVP_PKEY_DH_KDF_X9_42                           2
# endif

/* BEGIN ERROR CODES */
/*
 * The following lines are auto generated by the script mkerr.pl. Any changes
 * made after this point may be overwritten when the script is next run.
 */

void ERR_load_DH_strings(void);

/* Error codes for the DH functions. */

/* Function codes. */
# define DH_F_COMPUTE_KEY                                 102
# define DH_F_DHPARAMS_PRINT_FP                           101
# define DH_F_DH_BUILTIN_GENPARAMS                        106
# define DH_F_DH_CMS_DECRYPT                              114
# define DH_F_DH_CMS_SET_PEERKEY                          115
# define DH_F_DH_CMS_SET_SHARED_INFO                      116
# define DH_F_DH_METH_DUP                                 117
# define DH_F_DH_METH_NEW                                 118
# define DH_F_DH_METH_SET1_NAME                           119
# define DH_F_DH_NEW_METHOD                               105
# define DH_F_DH_PARAM_DECODE                             107
# define DH_F_DH_PRIV_DECODE                              110
# define DH_F_DH_PRIV_ENCODE                              111
# define DH_F_DH_PUB_DECODE                               108
# define DH_F_DH_PUB_ENCODE                               109
# define DH_F_DO_DH_PRINT                                 100
# define DH_F_GENERATE_KEY                                103
# define DH_F_PKEY_DH_DERIVE                              112
# define DH_F_PKEY_DH_KEYGEN                              113

/* Reason codes. */
# define DH_R_BAD_GENERATOR                               101
# define DH_R_BN_DECODE_ERROR                             109
# define DH_R_BN_ERROR                                    106
# define DH_R_DECODE_ERROR                                104
# define DH_R_INVALID_PUBKEY                              102
# define DH_R_KDF_PARAMETER_ERROR                         112
# define DH_R_KEYS_NOT_SET                                108
# define DH_R_MODULUS_TOO_LARGE                           103
# define DH_R_NO_PARAMETERS_SET                           107
# define DH_R_NO_PRIVATE_VALUE                            100
# define DH_R_PARAMETER_ENCODING_ERROR                    105
# define DH_R_PEER_KEY_ERROR                              111
# define DH_R_SHARED_INFO_ERROR                           113

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