Make all configuration macros available for application by making
[openssl.git] / crypto / dh / dh.h
1 /* crypto/dh/dh.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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
62 #ifdef OPENSSL_NO_DH
63 #error DH is disabled.
64 #endif
65
66 #ifndef OPENSSL_NO_BIO
67 #include <openssl/bio.h>
68 #endif
69 #include <openssl/bn.h>
70 #include <openssl/crypto.h>
71         
72 #define DH_FLAG_CACHE_MONT_P    0x01
73
74 #ifdef  __cplusplus
75 extern "C" {
76 #endif
77
78 typedef struct dh_st DH;
79
80 typedef struct dh_method {
81         const char *name;
82         /* Methods here */
83         int (*generate_key)(DH *dh);
84         int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh);
85         int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
86                                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
87                                 BN_MONT_CTX *m_ctx); /* Can be null */
88
89         int (*init)(DH *dh);
90         int (*finish)(DH *dh);
91         int flags;
92         char *app_data;
93 } DH_METHOD;
94
95 struct dh_st
96         {
97         /* This first argument is used to pick up errors when
98          * a DH is passed instead of a EVP_PKEY */
99         int pad;
100         int version;
101         BIGNUM *p;
102         BIGNUM *g;
103         int length; /* optional */
104         BIGNUM *pub_key;        /* g^x */
105         BIGNUM *priv_key;       /* x */
106
107         int flags;
108         char *method_mont_p;
109         /* Place holders if we want to do X9.42 DH */
110         BIGNUM *q;
111         BIGNUM *j;
112         unsigned char *seed;
113         int seedlen;
114         BIGNUM *counter;
115
116         int references;
117         CRYPTO_EX_DATA ex_data;
118 #if 0
119         DH_METHOD *meth;
120 #else
121         struct engine_st *engine;
122 #endif
123         };
124
125 #define DH_GENERATOR_2          2
126 /* #define DH_GENERATOR_3       3 */
127 #define DH_GENERATOR_5          5
128
129 /* DH_check error codes */
130 #define DH_CHECK_P_NOT_PRIME            0x01
131 #define DH_CHECK_P_NOT_SAFE_PRIME       0x02
132 #define DH_UNABLE_TO_CHECK_GENERATOR    0x04
133 #define DH_NOT_SUITABLE_GENERATOR       0x08
134
135 /* primes p where (p-1)/2 is prime too are called "safe"; we define
136    this for backward compatibility: */
137 #define DH_CHECK_P_NOT_STRONG_PRIME     DH_CHECK_P_NOT_SAFE_PRIME
138
139 #define DHparams_dup(x) (DH *)ASN1_dup((int (*)())i2d_DHparams, \
140                 (char *(*)())d2i_DHparams,(char *)(x))
141 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
142                 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
143 #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
144                 (unsigned char *)(x))
145 #define d2i_DHparams_bio(bp,x) (DH *)ASN1_d2i_bio((char *(*)())DH_new, \
146                 (char *(*)())d2i_DHparams,(bp),(unsigned char **)(x))
147 #ifdef  __cplusplus
148 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio((int (*)())i2d_DHparams,(bp), \
149                 (unsigned char *)(x))
150 #else
151 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio(i2d_DHparams,(bp), \
152                 (unsigned char *)(x))
153 #endif
154
155 const DH_METHOD *DH_OpenSSL(void);
156
157 void DH_set_default_openssl_method(const DH_METHOD *meth);
158 const DH_METHOD *DH_get_default_openssl_method(void);
159 #if 0
160 const DH_METHOD *DH_set_method(DH *dh, const DH_METHOD *meth);
161 DH *DH_new_method(const DH_METHOD *meth);
162 #else
163 int DH_set_method(DH *dh, struct engine_st *engine);
164 DH *DH_new_method(struct engine_st *engine);
165 #endif
166
167 DH *    DH_new(void);
168 void    DH_free(DH *dh);
169 int     DH_size(const DH *dh);
170 int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
171              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
172 int DH_set_ex_data(DH *d, int idx, void *arg);
173 void *DH_get_ex_data(DH *d, int idx);
174 DH *    DH_generate_parameters(int prime_len,int generator,
175                 void (*callback)(int,int,void *),void *cb_arg);
176 int     DH_check(const DH *dh,int *codes);
177 int     DH_generate_key(DH *dh);
178 int     DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
179 DH *    d2i_DHparams(DH **a,const unsigned char **pp, long length);
180 int     i2d_DHparams(const DH *a,unsigned char **pp);
181 #ifndef OPENSSL_NO_FP_API
182 int     DHparams_print_fp(FILE *fp, const DH *x);
183 #endif
184 #ifndef OPENSSL_NO_BIO
185 int     DHparams_print(BIO *bp, const DH *x);
186 #else
187 int     DHparams_print(char *bp, const DH *x);
188 #endif
189 void    ERR_load_DH_strings(void);
190
191 /* BEGIN ERROR CODES */
192 /* The following lines are auto generated by the script mkerr.pl. Any changes
193  * made after this point may be overwritten when the script is next run.
194  */
195
196 /* Error codes for the DH functions. */
197
198 /* Function codes. */
199 #define DH_F_DHPARAMS_PRINT                              100
200 #define DH_F_DHPARAMS_PRINT_FP                           101
201 #define DH_F_DH_COMPUTE_KEY                              102
202 #define DH_F_DH_GENERATE_KEY                             103
203 #define DH_F_DH_GENERATE_PARAMETERS                      104
204 #define DH_F_DH_NEW                                      105
205
206 /* Reason codes. */
207 #define DH_R_NO_PRIVATE_VALUE                            100
208
209 #ifdef  __cplusplus
210 }
211 #endif
212 #endif
213