[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/e_os2.h>
# include <openssl/opensslconf.h>

# ifdef OPENSSL_NO_DH
#  error DH is disabled.
# endif

# include <openssl/bio.h>
# include <openssl/asn1.h>
# include <openssl/ossl_typ.h>
# if OPENSSL_API_COMPAT < 0x10100000L
#  include <openssl/bn.h>
# 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

/*
 * new with 0.9.7h; the built-in DH
 * implementation now uses constant time
 * modular exponentiation for secret exponents
 * by default. This flag causes the
 * faster variable sliding window method to
 * be used for all exponents.
 */
# 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

#ifdef  __cplusplus
extern "C" {
#endif

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

struct dh_method {
    const char *name;
    /* Methods here */
    int (*generate_key) (DH *dh);
    int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh);
    /* Can be null */
    int (*bn_mod_exp) (const DH *dh, BIGNUM *r, const BIGNUM *a,
                       const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
                       BN_MONT_CTX *m_ctx);
    int (*init) (DH *dh);
    int (*finish) (DH *dh);
    int flags;
    char *app_data;
    /* If this is non-NULL, it will be used to generate parameters */
    int (*generate_params) (DH *dh, int prime_len, int generator,
                            BN_GENCB *cb);
};

struct dh_st {
    /*
     * This first argument is used to pick up errors when a DH is passed
     * instead of a EVP_PKEY
     */
    int pad;
    int version;
    BIGNUM *p;
    BIGNUM *g;
    long length;                /* optional */
    BIGNUM *pub_key;            /* g^x % p */
    BIGNUM *priv_key;           /* x */
    int flags;
    BN_MONT_CTX *method_mont_p;
    /* Place holders if we want to do X9.42 DH */
    BIGNUM *q;
    BIGNUM *j;
    unsigned char *seed;
    int seedlen;
    BIGNUM *counter;
    int references;
    CRYPTO_EX_DATA ex_data;
    const DH_METHOD *meth;
    ENGINE *engine;
    CRYPTO_RWLOCK *lock;
};

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

# 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
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
0f113f3e	61	# include <openssl/e_os2.h>
98186eb4	62	# include <openssl/opensslconf.h>
d3ae5b1c	63
0f113f3e MC	64	# ifdef OPENSSL_NO_DH
	65	# error DH is disabled.
	66	# endif
f5d7a031	67
a00ae6c4	68	# include <openssl/bio.h>
599eccfc	69	# include <openssl/asn1.h>
0f113f3e	70	# include <openssl/ossl_typ.h>
98186eb4	71	# if OPENSSL_API_COMPAT < 0x10100000L
0f113f3e MC	72	# include <openssl/bn.h>
0f113f3e MC	73	# endif
5e3225cc	74
0f113f3e MC	75	# ifndef OPENSSL_DH_MAX_MODULUS_BITS
	76	# define OPENSSL_DH_MAX_MODULUS_BITS 10000
	77	# endif
83c3410b	78
0f113f3e MC	79	# define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024
	80
	81	# define DH_FLAG_CACHE_MONT_P 0x01
dbd87ffc MC	82
	83	/*
	84	* new with 0.9.7h; the built-in DH
	85	* implementation now uses constant time
	86	* modular exponentiation for secret exponents
	87	* by default. This flag causes the
	88	* faster variable sliding window method to
	89	* be used for all exponents.
	90	*/
0f113f3e	91	# define DH_FLAG_NO_EXP_CONSTTIME 0x02
dfeab068	92
0f113f3e MC	93	/*
	94	* If this flag is set the DH method is FIPS compliant and can be used in
	95	* FIPS mode. This is set in the validated module method. If an application
	96	* sets this flag in its own methods it is its reposibility to ensure the
	97	* result is compliant.
4960411e DSH	98	*/
4960411e DSH	99
0f113f3e	100	# define DH_FLAG_FIPS_METHOD 0x0400
4960411e	101
0f113f3e MC	102	/*
0f113f3e MC	103	* If this flag is set the operations normally disabled in FIPS mode are
4960411e DSH	104	* permitted it is then the applications responsibility to ensure that the
	105	* usage is compliant.
	106	*/
	107
0f113f3e	108	# define DH_FLAG_NON_FIPS_ALLOW 0x0400
4960411e	109
82271cee RL	110	#ifdef __cplusplus
	111	extern "C" {
	112	#endif
	113
3a87a9b9 GT	114	/* Already defined in ossl_typ.h */
	115	/* typedef struct dh_st DH; */
	116	/* typedef struct dh_method DH_METHOD; */
13066cee	117
0f113f3e MC	118	struct dh_method {
	119	const char *name;
	120	/* Methods here */
	121	int (generate_key) (DH dh);
	122	int (compute_key) (unsigned char key, const BIGNUM pub_key, DH dh);
	123	/* Can be null */
	124	int (bn_mod_exp) (const DH dh, BIGNUM r, const BIGNUM a,
	125	const BIGNUM p, const BIGNUM m, BN_CTX *ctx,
	126	BN_MONT_CTX *m_ctx);
	127	int (init) (DH dh);
	128	int (finish) (DH dh);
	129	int flags;
	130	char *app_data;
	131	/* If this is non-NULL, it will be used to generate parameters */
	132	int (generate_params) (DH dh, int prime_len, int generator,
	133	BN_GENCB *cb);
	134	};
	135
	136	struct dh_st {
	137	/*
	138	* This first argument is used to pick up errors when a DH is passed
	139	* instead of a EVP_PKEY
	140	*/
	141	int pad;
	142	int version;
	143	BIGNUM *p;
	144	BIGNUM *g;
	145	long length; /* optional */
119ab03a	146	BIGNUM pub_key; / g^x % p */
0f113f3e MC	147	BIGNUM priv_key; / x */
	148	int flags;
	149	BN_MONT_CTX *method_mont_p;
	150	/* Place holders if we want to do X9.42 DH */
	151	BIGNUM *q;
	152	BIGNUM *j;
	153	unsigned char *seed;
	154	int seedlen;
	155	BIGNUM *counter;
	156	int references;
	157	CRYPTO_EX_DATA ex_data;
	158	const DH_METHOD *meth;
	159	ENGINE *engine;
d188a536	160	CRYPTO_RWLOCK *lock;
0f113f3e MC	161	};
0f113f3e MC	162
599eccfc RS	163	DECLARE_ASN1_ITEM(DHparams)
599eccfc RS	164
0f113f3e MC	165	# define DH_GENERATOR_2 2
	166	/* #define DH_GENERATOR_3 3 */
	167	# define DH_GENERATOR_5 5
d02b48c6 RE	168
d02b48c6 RE	169	/* DH_check error codes */
0f113f3e MC	170	# define DH_CHECK_P_NOT_PRIME 0x01
	171	# define DH_CHECK_P_NOT_SAFE_PRIME 0x02
	172	# define DH_UNABLE_TO_CHECK_GENERATOR 0x04
	173	# define DH_NOT_SUITABLE_GENERATOR 0x08
	174	# define DH_CHECK_Q_NOT_PRIME 0x10
	175	# define DH_CHECK_INVALID_Q_VALUE 0x20
	176	# define DH_CHECK_INVALID_J_VALUE 0x40
d02b48c6	177
bf3d6c0c	178	/* DH_check_pub_key error codes */
0f113f3e MC	179	# define DH_CHECK_PUBKEY_TOO_SMALL 0x01
0f113f3e MC	180	# define DH_CHECK_PUBKEY_TOO_LARGE 0x02
cb389fe8	181	# define DH_CHECK_PUBKEY_INVALID 0x04
bf3d6c0c	182
0f113f3e MC	183	/*
	184	* primes p where (p-1)/2 is prime too are called "safe"; we define this for
	185	* backward compatibility:
	186	*/
	187	# define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME
4486d0cd	188
0f113f3e MC	189	# define d2i_DHparams_fp(fp,x) (DH )ASN1_d2i_fp((char (*)())DH_new, \
	190	(char ()())d2i_DHparams,(fp),(unsigned char **)(x))
	191	# define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
	192	(unsigned char *)(x))
	193	# define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
	194	# define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
d02b48c6	195
f4274da1 DSH	196	DH DHparams_dup(DH );
f4274da1 DSH	197
f971ccb2	198	const DH_METHOD *DH_OpenSSL(void);
13066cee	199
cb78486d GT	200	void DH_set_default_method(const DH_METHOD *meth);
	201	const DH_METHOD *DH_get_default_method(void);
	202	int DH_set_method(DH dh, const DH_METHOD meth);
	203	DH DH_new_method(ENGINE engine);
13066cee	204
0f113f3e MC	205	DH *DH_new(void);
	206	void DH_free(DH *dh);
	207	int DH_up_ref(DH *dh);
26c79d56	208	int DH_bits(const DH *dh);
0f113f3e MC	209	int DH_size(const DH *dh);
0f113f3e MC	210	int DH_security_bits(const DH *dh);
e6390aca RS	211	#define DH_get_ex_new_index(l, p, newf, dupf, freef) \
e6390aca RS	212	CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)
dd9d233e DSH	213	int DH_set_ex_data(DH d, int idx, void arg);
dd9d233e DSH	214	void DH_get_ex_data(DH d, int idx);
e9224c71 GT	215
e9224c71 GT	216	/* Deprecated version */
98186eb4	217	DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator,
0f113f3e MC	218	void (*callback) (int, int,
0f113f3e MC	219	void *),
98186eb4	220	void *cb_arg))
e9224c71 GT	221
e9224c71 GT	222	/* New version */
0f113f3e MC	223	int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
	224	BN_GENCB *cb);
	225
	226	int DH_check(const DH dh, int codes);
	227	int DH_check_pub_key(const DH dh, const BIGNUM pub_key, int *codes);
	228	int DH_generate_key(DH *dh);
	229	int DH_compute_key(unsigned char key, const BIGNUM pub_key, DH *dh);
	230	int DH_compute_key_padded(unsigned char key, const BIGNUM pub_key, DH *dh);
	231	DH d2i_DHparams(DH a, const unsigned char *pp, long length);
	232	int i2d_DHparams(const DH a, unsigned char *pp);
	233	DH d2i_DHxparams(DH a, const unsigned char *pp, long length);
	234	int i2d_DHxparams(const DH a, unsigned char *pp);
	235	# ifndef OPENSSL_NO_STDIO
	236	int DHparams_print_fp(FILE fp, const DH x);
	237	# endif
0f113f3e	238	int DHparams_print(BIO bp, const DH x);
d02b48c6	239
20bee968 DSH	240	/* RFC 5114 parameters */
	241	DH *DH_get_1024_160(void);
	242	DH *DH_get_2048_224(void);
	243	DH *DH_get_2048_256(void);
	244
e968561d	245	# ifndef OPENSSL_NO_CMS
dc1ce3bc	246	/* RFC2631 KDF */
0f113f3e MC	247	int DH_KDF_X9_42(unsigned char *out, size_t outlen,
	248	const unsigned char *Z, size_t Zlen,
	249	ASN1_OBJECT *key_oid,
	250	const unsigned char ukm, size_t ukmlen, const EVP_MD md);
e968561d	251	# endif
0f113f3e MC	252
	253	# define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
	254	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
	255	EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
	256
	257	# define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \
	258	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
	259	EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL)
	260
	261	# define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \
	262	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
	263	EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL)
	264
	265	# define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
	266	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
	267	EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
	268
	269	# define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
	270	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
	271	EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
	272
	273	# define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
	274	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
	275	EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
	276
	277	# define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \
	278	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	279	EVP_PKEY_OP_DERIVE, \
	280	EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL)
	281
	282	# define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \
	283	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	284	EVP_PKEY_OP_DERIVE, \
	285	EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL)
	286
	287	# define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \
	288	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	289	EVP_PKEY_OP_DERIVE, \
	290	EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)oid)
	291
	292	# define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \
	293	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	294	EVP_PKEY_OP_DERIVE, \
	295	EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)poid)
	296
	297	# define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \
	298	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	299	EVP_PKEY_OP_DERIVE, \
	300	EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)md)
	301
	302	# define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \
	303	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	304	EVP_PKEY_OP_DERIVE, \
	305	EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)pmd)
	306
	307	# define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \
	308	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	309	EVP_PKEY_OP_DERIVE, \
	310	EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL)
	311
	312	# define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \
	313	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
	314	EVP_PKEY_OP_DERIVE, \
	315	EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)plen)
316
317	# define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \
318	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
319	EVP_PKEY_OP_DERIVE, \
320	EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)p)
321
322	# define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \
323	EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
324	EVP_PKEY_OP_DERIVE, \
325	EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)p)
326
327	# define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1)
328	# define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2)
329	# define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3)
330	# define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN (EVP_PKEY_ALG_CTRL + 4)
331	# define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE (EVP_PKEY_ALG_CTRL + 5)
332	# define EVP_PKEY_CTRL_DH_KDF_TYPE (EVP_PKEY_ALG_CTRL + 6)
333	# define EVP_PKEY_CTRL_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 7)
334	# define EVP_PKEY_CTRL_GET_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 8)
335	# define EVP_PKEY_CTRL_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 9)
336	# define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 10)
337	# define EVP_PKEY_CTRL_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 11)
338	# define EVP_PKEY_CTRL_GET_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 12)
339	# define EVP_PKEY_CTRL_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 13)
340	# define EVP_PKEY_CTRL_GET_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 14)
bd59f2b9 DSH	341
bd59f2b9 DSH	342	/* KDF types */
0f113f3e	343	# define EVP_PKEY_DH_KDF_NONE 1
e968561d	344	# ifndef OPENSSL_NO_CMS
0f113f3e	345	# define EVP_PKEY_DH_KDF_X9_42 2
e968561d	346	# endif
3ba0885a	347
d02b48c6	348	/* BEGIN ERROR CODES */
0f113f3e MC	349	/*
0f113f3e MC	350	* The following lines are auto generated by the script mkerr.pl. Any changes
6d311938 DSH	351	* made after this point may be overwritten when the script is next run.
6d311938 DSH	352	*/
b476df64	353	void ERR_load_DH_strings(void);
6d311938	354
d02b48c6 RE	355	/* Error codes for the DH functions. */
	356
	357	/* Function codes. */
0f113f3e MC	358	# define DH_F_COMPUTE_KEY 102
	359	# define DH_F_DHPARAMS_PRINT_FP 101
	360	# define DH_F_DH_BUILTIN_GENPARAMS 106
	361	# define DH_F_DH_CMS_DECRYPT 114
	362	# define DH_F_DH_CMS_SET_PEERKEY 115
	363	# define DH_F_DH_CMS_SET_SHARED_INFO 116
	364	# define DH_F_DH_NEW_METHOD 105
	365	# define DH_F_DH_PARAM_DECODE 107
	366	# define DH_F_DH_PRIV_DECODE 110
	367	# define DH_F_DH_PRIV_ENCODE 111
	368	# define DH_F_DH_PUB_DECODE 108
	369	# define DH_F_DH_PUB_ENCODE 109
	370	# define DH_F_DO_DH_PRINT 100
	371	# define DH_F_GENERATE_KEY 103
	372	# define DH_F_GENERATE_PARAMETERS 104
	373	# define DH_F_PKEY_DH_DERIVE 112
	374	# define DH_F_PKEY_DH_KEYGEN 113
d02b48c6 RE	375
d02b48c6 RE	376	/* Reason codes. */
0f113f3e MC	377	# define DH_R_BAD_GENERATOR 101
	378	# define DH_R_BN_DECODE_ERROR 109
	379	# define DH_R_BN_ERROR 106
	380	# define DH_R_DECODE_ERROR 104
	381	# define DH_R_INVALID_PUBKEY 102
	382	# define DH_R_KDF_PARAMETER_ERROR 112
	383	# define DH_R_KEYS_NOT_SET 108
	384	# define DH_R_KEY_SIZE_TOO_SMALL 110
	385	# define DH_R_MODULUS_TOO_LARGE 103
	386	# define DH_R_NO_PARAMETERS_SET 107
	387	# define DH_R_NO_PRIVATE_VALUE 100
	388	# define DH_R_PARAMETER_ENCODING_ERROR 105
	389	# define DH_R_PEER_KEY_ERROR 111
	390	# define DH_R_SHARED_INFO_ERROR 113
6d311938	391
d02b48c6 RE	392	#ifdef __cplusplus
	393	}
	394	#endif
	395	#endif