1/*
2 * Copyright (c) 2000-2002,2011,2014 Apple Inc. All Rights Reserved.
3 *
4 * The contents of this file constitute Original Code as defined in and are
5 * subject to the Apple Public Source License Version 1.2 (the 'License').
6 * You may not use this file except in compliance with the License. Please obtain
7 * a copy of the License at http://www.apple.com/publicsource and read it before
8 * using this file.
9 *
10 * This Original Code and all software distributed under the License are
11 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
12 * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
13 * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
14 * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
15 * specific language governing rights and limitations under the License.
16 */
17
18/* crypto/dh/dh.h */
19/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
20 * All rights reserved.
21 *
22 * This package is an SSL implementation written
23 * by Eric Young (eay@cryptsoft.com).
24 * The implementation was written so as to conform with Netscapes SSL.
25 *
26 * This library is free for commercial and non-commercial use as long as
27 * the following conditions are aheared to.  The following conditions
28 * apply to all code found in this distribution, be it the RC4, RSA,
29 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
30 * included with this distribution is covered by the same copyright terms
31 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
32 *
33 * Copyright remains Eric Young's, and as such any Copyright notices in
34 * the code are not to be removed.
35 * If this package is used in a product, Eric Young should be given attribution
36 * as the author of the parts of the library used.
37 * This can be in the form of a textual message at program startup or
38 * in documentation (online or textual) provided with the package.
39 *
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
42 * are met:
43 * 1. Redistributions of source code must retain the copyright
44 *    notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 *    notice, this list of conditions and the following disclaimer in the
47 *    documentation and/or other materials provided with the distribution.
48 * 3. All advertising materials mentioning features or use of this software
49 *    must display the following acknowledgement:
50 *    "This product includes cryptographic software written by
51 *     Eric Young (eay@cryptsoft.com)"
52 *    The word 'cryptographic' can be left out if the rouines from the library
53 *    being used are not cryptographic related :-).
54 * 4. If you include any Windows specific code (or a derivative thereof) from
55 *    the apps directory (application code) you must include an acknowledgement:
56 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
57 *
58 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
59 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
62 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
68 * SUCH DAMAGE.
69 *
70 * The licence and distribution terms for any publically available version or
71 * derivative of this code cannot be changed.  i.e. this code cannot simply be
72 * copied and put under another distribution licence
73 * [including the GNU Public Licence.]
74 */
75
76#ifndef HEADER_DH_H
77#define HEADER_DH_H
78
79#ifdef NO_DH
80#error DH is disabled.
81#endif
82
83#ifndef NO_BIO
84#include <openssl/bio.h>
85#endif
86#include <openssl/bn.h>
87#include <openssl/crypto.h>
88
89#define DH_FLAG_CACHE_MONT_P	0x01
90
91#ifdef  __cplusplus
92extern "C" {
93#endif
94
95typedef struct dh_st DH;
96
97typedef struct dh_method {
98	const char *name;
99	/* Methods here */
100	int (*generate_key)(DH *dh);
101	int (*compute_key)(unsigned char *key,BIGNUM *pub_key,DH *dh);
102	int (*bn_mod_exp)(DH *dh, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
103				const BIGNUM *m, BN_CTX *ctx,
104				BN_MONT_CTX *m_ctx); /* Can be null */
105
106	int (*init)(DH *dh);
107	int (*finish)(DH *dh);
108	int flags;
109	char *app_data;
110} DH_METHOD;
111
112struct dh_st
113	{
114	/* This first argument is used to pick up errors when
115	 * a DH is passed instead of a EVP_PKEY */
116	int pad;
117	int version;
118	BIGNUM *p;
119	BIGNUM *g;
120	int length; /* optional */
121	BIGNUM *pub_key;	/* g^x */
122	BIGNUM *priv_key;	/* x */
123
124	int flags;
125	char *method_mont_p;
126	/* Place holders if we want to do X9.42 DH */
127	BIGNUM *q;
128	BIGNUM *j;
129	unsigned char *seed;
130	int seedlen;
131	BIGNUM *counter;
132
133	int references;
134	CRYPTO_EX_DATA ex_data;
135	DH_METHOD *meth;
136	};
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
144#define DH_CHECK_P_NOT_SAFE_PRIME	0x02
145#define DH_UNABLE_TO_CHECK_GENERATOR	0x04
146#define DH_NOT_SUITABLE_GENERATOR	0x08
147
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
152#define DHparams_dup(x) (DH *)ASN1_dup((int (*)())i2d_DHparams, \
153		(char *(*)())d2i_DHparams,(char *)(x))
154#define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
155		(char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
156#define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
157		(unsigned char *)(x))
158#define d2i_DHparams_bio(bp,x) (DH *)ASN1_d2i_bio((char *(*)())DH_new, \
159		(char *(*)())d2i_DHparams,(bp),(unsigned char **)(x))
160#ifdef  __cplusplus
161#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio((int (*)())i2d_DHparams,(bp), \
162		(unsigned char *)(x))
163#else
164#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio(i2d_DHparams,(bp), \
165		(unsigned char *)(x))
166#endif
167
168DH_METHOD *DH_OpenSSL(void);
169
170void DH_set_default_method(DH_METHOD *meth);
171DH_METHOD *DH_get_default_method(void);
172DH_METHOD *DH_set_method(DH *dh, DH_METHOD *meth);
173DH *DH_new_method(DH_METHOD *meth);
174
175DH *	DH_new(void);
176void	DH_free(DH *dh);
177int	DH_size(DH *dh);
178int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
179	     CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
180int DH_set_ex_data(DH *d, int idx, void *arg);
181void *DH_get_ex_data(DH *d, int idx);
182DH *	DH_generate_parameters(int prime_len,int generator,
183		void (*callback)(int,int,void *),void *cb_arg);
184int	DH_check(DH *dh,int *codes);
185int	DH_generate_key(DH *dh);
186int	DH_compute_key(unsigned char *key,BIGNUM *pub_key,DH *dh);
187DH *	d2i_DHparams(DH **a,unsigned char **pp, long length);
188int	i2d_DHparams(DH *a,unsigned char **pp);
189#ifndef NO_FP_API
190int	DHparams_print_fp(FILE *fp, DH *x);
191#endif
192#ifndef NO_BIO
193int	DHparams_print(BIO *bp, DH *x);
194#else
195int	DHparams_print(char *bp, DH *x);
196#endif
197void	ERR_load_DH_strings(void );
198
199/* BEGIN ERROR CODES */
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 */
203
204/* Error codes for the DH functions. */
205
206/* Function codes. */
207#define DH_F_DHPARAMS_PRINT				 100
208#define DH_F_DHPARAMS_PRINT_FP				 101
209#define DH_F_DH_COMPUTE_KEY				 102
210#define DH_F_DH_GENERATE_KEY				 103
211#define DH_F_DH_GENERATE_PARAMETERS			 104
212#define DH_F_DH_NEW					 105
213
214/* Reason codes. */
215#define DH_R_NO_PRIVATE_VALUE				 100
216
217#ifdef  __cplusplus
218}
219#endif
220#endif
221
222