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

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

#ifdef OPENSSL_NO_DH
#error DH is disabled.
#endif

#ifndef OPENSSL_NO_BIO
#include <openssl/bio.h>
#endif
#include <openssl/ossl_typ.h>
#ifndef OPENSSL_NO_DEPRECATED
#include <openssl/bn.h>
#endif
	
#define DH_FLAG_CACHE_MONT_P     0x01
#define DH_FLAG_NO_EXP_CONSTTIME 0x02 /* 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.
                                       */

#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);
	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); /* Can be null */

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

#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

/* 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 DHparams_dup(x) ASN1_dup_of_const(DH,i2d_DHparams,d2i_DHparams,x)
#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)

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_size(const DH *dh);
int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
	     CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
int DH_set_ex_data(DH *d, int idx, void *arg);
void *DH_get_ex_data(DH *d, int idx);

/* Deprecated version */
#ifndef OPENSSL_NO_DEPRECATED
DH *	DH_generate_parameters(int prime_len,int generator,
		void (*callback)(int,int,void *),void *cb_arg);
#endif /* !defined(OPENSSL_NO_DEPRECATED) */

/* 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_generate_key(DH *dh);
int	DH_compute_key(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);
#ifndef OPENSSL_NO_FP_API
int	DHparams_print_fp(FILE *fp, const DH *x);
#endif
#ifndef OPENSSL_NO_BIO
int	DHparams_print(BIO *bp, const DH *x);
#else
int	DHparams_print(char *bp, const DH *x);
#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				 100
#define DH_F_DHPARAMS_PRINT_FP				 101
#define DH_F_DH_BUILTIN_GENPARAMS			 106
#define DH_F_DH_NEW_METHOD				 105
#define DH_F_GENERATE_KEY				 103
#define DH_F_GENERATE_PARAMETERS			 104

/* Reason codes. */
#define DH_R_BAD_GENERATOR				 101
#define DH_R_NO_PRIVATE_VALUE				 100

#ifdef  __cplusplus
}
#endif
#endif
Commit	Line	Data
d02b48c6	1	/* crypto/dh/dh.h */
58964a49	2	/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6 RE	3	* All rights reserved.
	4	*
	5	* This package is an SSL implementation written
	6	* by Eric Young (eay@cryptsoft.com).
	7	* The implementation was written so as to conform with Netscapes SSL.
	8	*
	9	* This library is free for commercial and non-commercial use as long as
	10	* the following conditions are aheared to. The following conditions
	11	* apply to all code found in this distribution, be it the RC4, RSA,
	12	* lhash, DES, etc., code; not just the SSL code. The SSL documentation
	13	* included with this distribution is covered by the same copyright terms
	14	* except that the holder is Tim Hudson (tjh@cryptsoft.com).
	15	*
	16	* Copyright remains Eric Young's, and as such any Copyright notices in
	17	* the code are not to be removed.
	18	* If this package is used in a product, Eric Young should be given attribution
	19	* as the author of the parts of the library used.
	20	* This can be in the form of a textual message at program startup or
	21	* in documentation (online or textual) provided with the package.
	22	*
	23	* Redistribution and use in source and binary forms, with or without
	24	* modification, are permitted provided that the following conditions
	25	* are met:
	26	* 1. Redistributions of source code must retain the copyright
	27	* notice, this list of conditions and the following disclaimer.
	28	* 2. Redistributions in binary form must reproduce the above copyright
	29	* notice, this list of conditions and the following disclaimer in the
	30	* documentation and/or other materials provided with the distribution.
	31	* 3. All advertising materials mentioning features or use of this software
	32	* must display the following acknowledgement:
	33	* "This product includes cryptographic software written by
	34	* Eric Young (eay@cryptsoft.com)"
	35	* The word 'cryptographic' can be left out if the rouines from the library
	36	* being used are not cryptographic related :-).
	37	* 4. If you include any Windows specific code (or a derivative thereof) from
	38	* the apps directory (application code) you must include an acknowledgement:
	39	* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
	40	*
	41	* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
	42	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	43	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	44	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	45	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	46	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	47	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	48	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	49	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	50	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	51	* SUCH DAMAGE.
	52	*
	53	* The licence and distribution terms for any publically available version or
	54	* derivative of this code cannot be changed. i.e. this code cannot simply be
	55	* copied and put under another distribution licence
	56	* [including the GNU Public Licence.]
	57	*/
	58
	59	#ifndef HEADER_DH_H
	60	#define HEADER_DH_H
	61
d3ae5b1c RL	62	#include <openssl/e_os2.h>
d3ae5b1c RL	63
cf1b7d96	64	#ifdef OPENSSL_NO_DH
f5d7a031 UM	65	#error DH is disabled.
	66	#endif
	67
cf1b7d96	68	#ifndef OPENSSL_NO_BIO
ef33b970 RL	69	#include <openssl/bio.h>
ef33b970 RL	70	#endif
2aa9043a	71	#include <openssl/ossl_typ.h>
0f814687 GT	72	#ifndef OPENSSL_NO_DEPRECATED
	73	#include <openssl/bn.h>
	74	#endif
2fb50a29	75
46a64376 BM	76	#define DH_FLAG_CACHE_MONT_P 0x01
	77	#define DH_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DH
	78	* implementation now uses constant time
	79	* modular exponentiation for secret exponents
	80	* by default. This flag causes the
	81	* faster variable sliding window method to
	82	* be used for all exponents.
	83	*/
dfeab068	84
82271cee RL	85	#ifdef __cplusplus
	86	extern "C" {
	87	#endif
	88
3a87a9b9 GT	89	/* Already defined in ossl_typ.h */
	90	/* typedef struct dh_st DH; */
	91	/* typedef struct dh_method DH_METHOD; */
13066cee	92
3a87a9b9 GT	93	struct dh_method
3a87a9b9 GT	94	{
13066cee DSH	95	const char *name;
	96	/* Methods here */
	97	int (generate_key)(DH dh);
f971ccb2 RL	98	int (compute_key)(unsigned char key,const BIGNUM pub_key,DH dh);
	99	int (bn_mod_exp)(const DH dh, BIGNUM r, const BIGNUM a,
	100	const BIGNUM p, const BIGNUM m, BN_CTX *ctx,
13066cee DSH	101	BN_MONT_CTX m_ctx); / Can be null */
	102
	103	int (init)(DH dh);
	104	int (finish)(DH dh);
	105	int flags;
	106	char *app_data;
0e4aa0d2 GT	107	/* If this is non-NULL, it will be used to generate parameters */
0e4aa0d2 GT	108	int (generate_params)(DH dh, int prime_len, int generator, BN_GENCB *cb);
3a87a9b9	109	};
13066cee DSH	110
13066cee DSH	111	struct dh_st
d02b48c6 RE	112	{
	113	/* This first argument is used to pick up errors when
	114	* a DH is passed instead of a EVP_PKEY */
	115	int pad;
	116	int version;
	117	BIGNUM *p;
	118	BIGNUM *g;
2c2f9e2c	119	long length; /* optional */
4486d0cd	120	BIGNUM pub_key; / g^x */
d02b48c6	121	BIGNUM priv_key; / x */
dfeab068 RE	122
dfeab068 RE	123	int flags;
879b1980	124	BN_MONT_CTX *method_mont_p;
13066cee DSH	125	/* Place holders if we want to do X9.42 DH */
	126	BIGNUM *q;
	127	BIGNUM *j;
90644dd7	128	unsigned char *seed;
13066cee DSH	129	int seedlen;
	130	BIGNUM *counter;
	131
	132	int references;
	133	CRYPTO_EX_DATA ex_data;
cb78486d GT	134	const DH_METHOD *meth;
cb78486d GT	135	ENGINE *engine;
13066cee	136	};
d02b48c6 RE	137
	138	#define DH_GENERATOR_2 2
	139	/* #define DH_GENERATOR_3 3 */
	140	#define DH_GENERATOR_5 5
	141
	142	/* DH_check error codes */
	143	#define DH_CHECK_P_NOT_PRIME 0x01
4486d0cd	144	#define DH_CHECK_P_NOT_SAFE_PRIME 0x02
d02b48c6 RE	145	#define DH_UNABLE_TO_CHECK_GENERATOR 0x04
	146	#define DH_NOT_SUITABLE_GENERATOR 0x08
	147
4486d0cd UM	148	/* primes p where (p-1)/2 is prime too are called "safe"; we define
	149	this for backward compatibility: */
	150	#define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME
	151
41a15c4f	152	#define DHparams_dup(x) ASN1_dup_of_const(DH,i2d_DHparams,d2i_DHparams,x)
d02b48c6 RE	153	#define d2i_DHparams_fp(fp,x) (DH )ASN1_d2i_fp((char (*)())DH_new, \
	154	(char ()())d2i_DHparams,(fp),(unsigned char **)(x))
	155	#define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
	156	(unsigned char *)(x))
41a15c4f BL	157	#define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
41a15c4f BL	158	#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
d02b48c6	159
f971ccb2	160	const DH_METHOD *DH_OpenSSL(void);
13066cee	161
cb78486d GT	162	void DH_set_default_method(const DH_METHOD *meth);
	163	const DH_METHOD *DH_get_default_method(void);
	164	int DH_set_method(DH dh, const DH_METHOD meth);
	165	DH DH_new_method(ENGINE engine);
13066cee	166
d02b48c6 RE	167	DH * DH_new(void);
d02b48c6 RE	168	void DH_free(DH *dh);
dc2a33d6	169	int DH_up_ref(DH *dh);
f971ccb2	170	int DH_size(const DH *dh);
dd9d233e DSH	171	int DH_get_ex_new_index(long argl, void argp, CRYPTO_EX_new new_func,
	172	CRYPTO_EX_dup dup_func, CRYPTO_EX_free free_func);
	173	int DH_set_ex_data(DH d, int idx, void arg);
	174	void DH_get_ex_data(DH d, int idx);
e9224c71 GT	175
	176	/* Deprecated version */
	177	#ifndef OPENSSL_NO_DEPRECATED
d02b48c6	178	DH * DH_generate_parameters(int prime_len,int generator,
b4f76582	179	void (callback)(int,int,void ),void *cb_arg);
e9224c71 GT	180	#endif /* !defined(OPENSSL_NO_DEPRECATED) */
	181
	182	/* New version */
	183	int DH_generate_parameters_ex(DH dh, int prime_len,int generator, BN_GENCB cb);
	184
f971ccb2	185	int DH_check(const DH dh,int codes);
d02b48c6	186	int DH_generate_key(DH *dh);
f971ccb2 RL	187	int DH_compute_key(unsigned char key,const BIGNUM pub_key,DH *dh);
	188	DH * d2i_DHparams(DH a,const unsigned char pp, long length);
	189	int i2d_DHparams(const DH a,unsigned char *pp);
cf1b7d96	190	#ifndef OPENSSL_NO_FP_API
f971ccb2	191	int DHparams_print_fp(FILE fp, const DH x);
d02b48c6	192	#endif
cf1b7d96	193	#ifndef OPENSSL_NO_BIO
f971ccb2	194	int DHparams_print(BIO bp, const DH x);
d02b48c6	195	#else
f971ccb2	196	int DHparams_print(char bp, const DH x);
d02b48c6	197	#endif
d02b48c6	198
d02b48c6	199	/* BEGIN ERROR CODES */
6d311938 DSH	200	/* The following lines are auto generated by the script mkerr.pl. Any changes
	201	* made after this point may be overwritten when the script is next run.
	202	*/
b476df64	203	void ERR_load_DH_strings(void);
6d311938	204
d02b48c6 RE	205	/* Error codes for the DH functions. */
	206
	207	/* Function codes. */
aa4ce731	208	#define DH_F_COMPUTE_KEY 102
d02b48c6 RE	209	#define DH_F_DHPARAMS_PRINT 100
d02b48c6 RE	210	#define DH_F_DHPARAMS_PRINT_FP 101
aa4ce731	211	#define DH_F_DH_BUILTIN_GENPARAMS 106
0c372b94	212	#define DH_F_DH_NEW_METHOD 105
aa4ce731 BM	213	#define DH_F_GENERATE_KEY 103
aa4ce731 BM	214	#define DH_F_GENERATE_PARAMETERS 104
d02b48c6 RE	215
d02b48c6 RE	216	/* Reason codes. */
82652aaf	217	#define DH_R_BAD_GENERATOR 101
d02b48c6	218	#define DH_R_NO_PRIVATE_VALUE 100
6d311938	219
d02b48c6 RE	220	#ifdef __cplusplus
	221	}
	222	#endif
	223	#endif