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

/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
 *
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
 *
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
 *
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
 *
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */

#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
# define DH_FLAG_NO_EXP_CONSTTIME 0x02

/*
 * 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 reposibility 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_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_GENERATE_PARAMETERS                         104
# 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_KEY_SIZE_TOO_SMALL                          110
# 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
58964a49	1	/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6 RE	2	* All rights reserved.
	3	*
	4	* This package is an SSL implementation written
	5	* by Eric Young (eay@cryptsoft.com).
	6	* The implementation was written so as to conform with Netscapes SSL.
0f113f3e	7	*
d02b48c6 RE	8	* This library is free for commercial and non-commercial use as long as
	9	* the following conditions are aheared to. The following conditions
	10	* apply to all code found in this distribution, be it the RC4, RSA,
	11	* lhash, DES, etc., code; not just the SSL code. The SSL documentation
	12	* included with this distribution is covered by the same copyright terms
	13	* except that the holder is Tim Hudson (tjh@cryptsoft.com).
0f113f3e	14	*
d02b48c6 RE	15	* Copyright remains Eric Young's, and as such any Copyright notices in
	16	* the code are not to be removed.
	17	* If this package is used in a product, Eric Young should be given attribution
	18	* as the author of the parts of the library used.
	19	* This can be in the form of a textual message at program startup or
	20	* in documentation (online or textual) provided with the package.
0f113f3e	21	*
d02b48c6 RE	22	* Redistribution and use in source and binary forms, with or without
	23	* modification, are permitted provided that the following conditions
	24	* are met:
	25	* 1. Redistributions of source code must retain the copyright
	26	* notice, this list of conditions and the following disclaimer.
	27	* 2. Redistributions in binary form must reproduce the above copyright
	28	* notice, this list of conditions and the following disclaimer in the
	29	* documentation and/or other materials provided with the distribution.
	30	* 3. All advertising materials mentioning features or use of this software
	31	* must display the following acknowledgement:
	32	* "This product includes cryptographic software written by
	33	* Eric Young (eay@cryptsoft.com)"
	34	* The word 'cryptographic' can be left out if the rouines from the library
	35	* being used are not cryptographic related :-).
0f113f3e	36	* 4. If you include any Windows specific code (or a derivative thereof) from
d02b48c6 RE	37	* the apps directory (application code) you must include an acknowledgement:
d02b48c6 RE	38	* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
0f113f3e	39	*
d02b48c6 RE	40	* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
	41	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	42	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	43	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	44	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	45	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	46	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	47	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	48	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	49	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	50	* SUCH DAMAGE.
0f113f3e	51	*
d02b48c6 RE	52	* The licence and distribution terms for any publically available version or
	53	* derivative of this code cannot be changed. i.e. this code cannot simply be
	54	* copied and put under another distribution licence
	55	* [including the GNU Public Licence.]
	56	*/
	57
	58	#ifndef HEADER_DH_H
0f113f3e	59	# define HEADER_DH_H
d02b48c6	60
98186eb4	61	# include <openssl/opensslconf.h>
d3ae5b1c	62
3c27208f RS	63	# ifndef OPENSSL_NO_DH
3c27208f RS	64	# include <openssl/e_os2.h>
a00ae6c4	65	# include <openssl/bio.h>
599eccfc	66	# include <openssl/asn1.h>
0f113f3e	67	# include <openssl/ossl_typ.h>
98186eb4	68	# if OPENSSL_API_COMPAT < 0x10100000L
0f113f3e MC	69	# include <openssl/bn.h>
0f113f3e MC	70	# endif
5e3225cc	71
3c27208f RS	72	# ifdef __cplusplus
	73	extern "C" {
	74	# endif
	75
0f113f3e MC	76	# ifndef OPENSSL_DH_MAX_MODULUS_BITS
	77	# define OPENSSL_DH_MAX_MODULUS_BITS 10000
	78	# endif
83c3410b	79
0f113f3e MC	80	# define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024
	81
	82	# define DH_FLAG_CACHE_MONT_P 0x01
0f113f3e	83	# define DH_FLAG_NO_EXP_CONSTTIME 0x02
dfeab068	84
0f113f3e MC	85	/*
	86	* If this flag is set the DH method is FIPS compliant and can be used in
	87	* FIPS mode. This is set in the validated module method. If an application
e771eea6	88	* sets this flag in its own methods it is its reposibility to ensure the
0f113f3e	89	* result is compliant.
4960411e DSH	90	*/
4960411e DSH	91
0f113f3e	92	# define DH_FLAG_FIPS_METHOD 0x0400
4960411e	93
0f113f3e MC	94	/*
0f113f3e MC	95	* If this flag is set the operations normally disabled in FIPS mode are
4960411e DSH	96	* permitted it is then the applications responsibility to ensure that the
	97	* usage is compliant.
	98	*/
	99
0f113f3e	100	# define DH_FLAG_NON_FIPS_ALLOW 0x0400
4960411e	101
3a87a9b9 GT	102	/* Already defined in ossl_typ.h */
	103	/* typedef struct dh_st DH; */
	104	/* typedef struct dh_method DH_METHOD; */
13066cee	105
599eccfc RS	106	DECLARE_ASN1_ITEM(DHparams)
599eccfc RS	107
0f113f3e MC	108	# define DH_GENERATOR_2 2
	109	/* #define DH_GENERATOR_3 3 */
	110	# define DH_GENERATOR_5 5
d02b48c6 RE	111
d02b48c6 RE	112	/* DH_check error codes */
0f113f3e MC	113	# define DH_CHECK_P_NOT_PRIME 0x01
	114	# define DH_CHECK_P_NOT_SAFE_PRIME 0x02
	115	# define DH_UNABLE_TO_CHECK_GENERATOR 0x04
	116	# define DH_NOT_SUITABLE_GENERATOR 0x08
	117	# define DH_CHECK_Q_NOT_PRIME 0x10
	118	# define DH_CHECK_INVALID_Q_VALUE 0x20
	119	# define DH_CHECK_INVALID_J_VALUE 0x40
d02b48c6	120
bf3d6c0c	121	/* DH_check_pub_key error codes */
0f113f3e MC	122	# define DH_CHECK_PUBKEY_TOO_SMALL 0x01
0f113f3e MC	123	# define DH_CHECK_PUBKEY_TOO_LARGE 0x02
cb389fe8	124	# define DH_CHECK_PUBKEY_INVALID 0x04
bf3d6c0c	125
0f113f3e MC	126	/*
	127	* primes p where (p-1)/2 is prime too are called "safe"; we define this for
	128	* backward compatibility:
	129	*/
	130	# define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME
4486d0cd	131
0f113f3e MC	132	# define d2i_DHparams_fp(fp,x) (DH )ASN1_d2i_fp((char (*)())DH_new, \
	133	(char ()())d2i_DHparams,(fp),(unsigned char **)(x))
	134	# define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
	135	(unsigned char *)(x))
	136	# define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
	137	# define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
d02b48c6	138
f4274da1 DSH	139	DH DHparams_dup(DH );
f4274da1 DSH	140
f971ccb2	141	const DH_METHOD *DH_OpenSSL(void);
13066cee	142
cb78486d GT	143	void DH_set_default_method(const DH_METHOD *meth);
	144	const DH_METHOD *DH_get_default_method(void);
	145	int DH_set_method(DH dh, const DH_METHOD meth);
	146	DH DH_new_method(ENGINE engine);
13066cee	147
0f113f3e MC	148	DH *DH_new(void);
	149	void DH_free(DH *dh);
	150	int DH_up_ref(DH *dh);
26c79d56	151	int DH_bits(const DH *dh);
0f113f3e MC	152	int DH_size(const DH *dh);
0f113f3e MC	153	int DH_security_bits(const DH *dh);
e6390aca RS	154	#define DH_get_ex_new_index(l, p, newf, dupf, freef) \
e6390aca RS	155	CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)
dd9d233e DSH	156	int DH_set_ex_data(DH d, int idx, void arg);
dd9d233e DSH	157	void DH_get_ex_data(DH d, int idx);
e9224c71 GT	158
e9224c71 GT	159	/* Deprecated version */
98186eb4	160	DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator,
0f113f3e MC	161	void (*callback) (int, int,
0f113f3e MC	162	void *),
98186eb4	163	void *cb_arg))
e9224c71 GT	164
e9224c71 GT	165	/* New version */
0f113f3e MC	166	int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
	167	BN_GENCB *cb);
	168
	169	int DH_check(const DH dh, int codes);
	170	int DH_check_pub_key(const DH dh, const BIGNUM pub_key, int *codes);
	171	int DH_generate_key(DH *dh);
	172	int DH_compute_key(unsigned char key, const BIGNUM pub_key, DH *dh);
	173	int DH_compute_key_padded(unsigned char key, const BIGNUM pub_key, DH *dh);
	174	DH d2i_DHparams(DH a, const unsigned char *pp, long length);
	175	int i2d_DHparams(const DH a, unsigned char *pp);
	176	DH d2i_DHxparams(DH a, const unsigned char *pp, long length);
	177	int i2d_DHxparams(const DH a, unsigned char *pp);
	178	# ifndef OPENSSL_NO_STDIO
	179	int DHparams_print_fp(FILE fp, const DH x);
	180	# endif
0f113f3e	181	int DHparams_print(BIO bp, const DH x);
d02b48c6	182
20bee968 DSH	183	/* RFC 5114 parameters */
	184	DH *DH_get_1024_160(void);
	185	DH *DH_get_2048_224(void);
	186	DH *DH_get_2048_256(void);
	187
e968561d	188	# ifndef OPENSSL_NO_CMS
dc1ce3bc	189	/* RFC2631 KDF */
0f113f3e MC	190	int DH_KDF_X9_42(unsigned char *out, size_t outlen,
	191	const unsigned char *Z, size_t Zlen,
	192	ASN1_OBJECT *key_oid,
	193	const unsigned char ukm, size_t ukmlen, const EVP_MD md);
e968561d	194	# endif
0f113f3e	195
0aeddcfa MC	196	void DH_get0_pqg(const DH dh, BIGNUM p, BIGNUM q, BIGNUM *g);
	197	int DH_set0_pqg(DH dh, BIGNUM p, BIGNUM q, BIGNUM g);
	198	void DH_get0_key(const DH dh, BIGNUM pub_key, BIGNUM *priv_key);
	199	int DH_set0_key(DH dh, BIGNUM pub_key, BIGNUM *priv_key);
	200	void DH_clear_flags(DH *dh, int flags);
	201	int DH_test_flags(const DH *dh, int flags);
	202	void DH_set_flags(DH *dh, int flags);
	203	ENGINE DH_get0_engine(DH d);
	204	long DH_get_length(const DH *dh);
	205	int DH_set_length(DH *dh, long length);
	206
17e01abb MC	207	DH_METHOD DH_meth_new(const char name, int flags);
	208	void DH_meth_free(DH_METHOD *dhm);
	209	DH_METHOD DH_meth_dup(const DH_METHOD dhm);
	210	const char DH_meth_get0_name(const DH_METHOD dhm);
	211	int DH_meth_set1_name(DH_METHOD dhm, const char name);
	212	int DH_meth_get_flags(DH_METHOD *dhm);
	213	int DH_meth_set_flags(DH_METHOD *dhm, int flags);
	214	void DH_meth_get0_app_data(const DH_METHOD dhm);
	215	int DH_meth_set0_app_data(DH_METHOD dhm, void app_data);
	216	int (DH_meth_get_generate_key(const DH_METHOD dhm)) (DH *);
	217	int DH_meth_set_generate_key(DH_METHOD dhm, int (generate_key) (DH *));
	218	int (DH_meth_get_compute_key(const DH_METHOD dhm))
	219	(unsigned char key, const BIGNUM pub_key, DH *dh);
	220	int DH_meth_set_compute_key(DH_METHOD *dhm,
	221	int (compute_key) (unsigned char key, const BIGNUM pub_key, DH dh));
	222	int (DH_meth_get_bn_mod_exp(const DH_METHOD dhm))
	223	(const DH , BIGNUM , const BIGNUM , const BIGNUM , const BIGNUM *,
	224	BN_CTX , BN_MONT_CTX );
	225	int DH_meth_set_bn_mod_exp(DH_METHOD *dhm,
	226	int (bn_mod_exp) (const DH , BIGNUM , const BIGNUM , const BIGNUM *,
	227	const BIGNUM , BN_CTX , BN_MONT_CTX *));
	228	int (DH_meth_get_init(const DH_METHOD dhm))(DH *);
	229	int DH_meth_set_init(DH_METHOD dhm, int (init)(DH *));
	230	int (DH_meth_get_finish(const DH_METHOD dhm)) (DH *);
	231	int DH_meth_set_finish(DH_METHOD dhm, int (finish) (DH *));
	232	int (DH_meth_get_generate_params(const DH_METHOD dhm))
	233	(DH , int, int, BN_GENCB );
	234	int DH_meth_set_generate_params(DH_METHOD *dhm,
	235	int (generate_params) (DH , int, int, BN_GENCB *));
	236
0aeddcfa	237
0f113f3e MC	238	# define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
	239	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
	240	EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
	241
	242	# define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \
	243	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
	244	EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL)
	245
	246	# define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \
	247	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
	248	EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL)
	249
	250	# define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
	251	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
	252	EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
	253
	254	# define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
	255	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
	256	EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
	257
	258	# define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
	259	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
	260	EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
	261
	262	# define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \
	263	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	264	EVP_PKEY_OP_DERIVE, \
	265	EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL)
	266
	267	# define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \
	268	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	269	EVP_PKEY_OP_DERIVE, \
	270	EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL)
	271
	272	# define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \
	273	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	274	EVP_PKEY_OP_DERIVE, \
	275	EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)oid)
	276
	277	# define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \
	278	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	279	EVP_PKEY_OP_DERIVE, \
	280	EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)poid)
	281
	282	# define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \
	283	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	284	EVP_PKEY_OP_DERIVE, \
	285	EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)md)
	286
	287	# define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \
	288	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	289	EVP_PKEY_OP_DERIVE, \
	290	EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)pmd)
	291
	292	# define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \
	293	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	294	EVP_PKEY_OP_DERIVE, \
	295	EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL)
	296
	297	# define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \
	298	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	299	EVP_PKEY_OP_DERIVE, \
	300	EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)plen)
	301
302	# define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \
303	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
304	EVP_PKEY_OP_DERIVE, \
305	EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)p)
306
307	# define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \
308	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
309	EVP_PKEY_OP_DERIVE, \
310	EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)p)
311
312	# define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1)
313	# define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2)
314	# define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3)
315	# define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN (EVP_PKEY_ALG_CTRL + 4)
316	# define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE (EVP_PKEY_ALG_CTRL + 5)
317	# define EVP_PKEY_CTRL_DH_KDF_TYPE (EVP_PKEY_ALG_CTRL + 6)
318	# define EVP_PKEY_CTRL_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 7)
319	# define EVP_PKEY_CTRL_GET_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 8)
320	# define EVP_PKEY_CTRL_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 9)
321	# define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 10)
322	# define EVP_PKEY_CTRL_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 11)
323	# define EVP_PKEY_CTRL_GET_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 12)
324	# define EVP_PKEY_CTRL_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 13)
325	# define EVP_PKEY_CTRL_GET_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 14)
bd59f2b9 DSH	326
bd59f2b9 DSH	327	/* KDF types */
0f113f3e	328	# define EVP_PKEY_DH_KDF_NONE 1
e968561d	329	# ifndef OPENSSL_NO_CMS
0f113f3e	330	# define EVP_PKEY_DH_KDF_X9_42 2
e968561d	331	# endif
3ba0885a	332
d02b48c6	333	/* BEGIN ERROR CODES */
0f113f3e MC	334	/*
0f113f3e MC	335	* The following lines are auto generated by the script mkerr.pl. Any changes
6d311938 DSH	336	* made after this point may be overwritten when the script is next run.
6d311938 DSH	337	*/
b476df64	338	void ERR_load_DH_strings(void);
6d311938	339
d02b48c6 RE	340	/* Error codes for the DH functions. */
	341
	342	/* Function codes. */
0f113f3e MC	343	# define DH_F_COMPUTE_KEY 102
	344	# define DH_F_DHPARAMS_PRINT_FP 101
	345	# define DH_F_DH_BUILTIN_GENPARAMS 106
	346	# define DH_F_DH_CMS_DECRYPT 114
	347	# define DH_F_DH_CMS_SET_PEERKEY 115
	348	# define DH_F_DH_CMS_SET_SHARED_INFO 116
	349	# define DH_F_DH_NEW_METHOD 105
	350	# define DH_F_DH_PARAM_DECODE 107
	351	# define DH_F_DH_PRIV_DECODE 110
	352	# define DH_F_DH_PRIV_ENCODE 111
	353	# define DH_F_DH_PUB_DECODE 108
	354	# define DH_F_DH_PUB_ENCODE 109
	355	# define DH_F_DO_DH_PRINT 100
	356	# define DH_F_GENERATE_KEY 103
	357	# define DH_F_GENERATE_PARAMETERS 104
	358	# define DH_F_PKEY_DH_DERIVE 112
	359	# define DH_F_PKEY_DH_KEYGEN 113
d02b48c6 RE	360
d02b48c6 RE	361	/* Reason codes. */
0f113f3e MC	362	# define DH_R_BAD_GENERATOR 101
	363	# define DH_R_BN_DECODE_ERROR 109
	364	# define DH_R_BN_ERROR 106
	365	# define DH_R_DECODE_ERROR 104
	366	# define DH_R_INVALID_PUBKEY 102
	367	# define DH_R_KDF_PARAMETER_ERROR 112
	368	# define DH_R_KEYS_NOT_SET 108
	369	# define DH_R_KEY_SIZE_TOO_SMALL 110
	370	# define DH_R_MODULUS_TOO_LARGE 103
	371	# define DH_R_NO_PARAMETERS_SET 107
	372	# define DH_R_NO_PRIVATE_VALUE 100
	373	# define DH_R_PARAMETER_ENCODING_ERROR 105
	374	# define DH_R_PEER_KEY_ERROR 111
	375	# define DH_R_SHARED_INFO_ERROR 113
6d311938	376
3c27208f	377	# ifdef __cplusplus
d02b48c6	378	}
3c27208f RS	379	# endif
	380	# endif
	381
d02b48c6	382	#endif