Revert the size_t modifications from HEAD that had led to more
[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 #include <openssl/e_os2.h>
63
64 #ifdef OPENSSL_NO_DH
65 #error DH is disabled.
66 #endif
67
68 #ifndef OPENSSL_NO_BIO
69 #include <openssl/bio.h>
70 #endif
71 #include <openssl/ossl_typ.h>
72 #ifndef OPENSSL_NO_DEPRECATED
73 #include <openssl/bn.h>
74 #endif
75         
76 #ifndef OPENSSL_DH_MAX_MODULUS_BITS
77 # define OPENSSL_DH_MAX_MODULUS_BITS    10000
78 #endif
79
80 #define DH_FLAG_CACHE_MONT_P     0x01
81 #define DH_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DH
82                                        * implementation now uses constant time
83                                        * modular exponentiation for secret exponents
84                                        * by default. This flag causes the
85                                        * faster variable sliding window method to
86                                        * be used for all exponents.
87                                        */
88
89 #ifdef  __cplusplus
90 extern "C" {
91 #endif
92
93 /* Already defined in ossl_typ.h */
94 /* typedef struct dh_st DH; */
95 /* typedef struct dh_method DH_METHOD; */
96
97 struct dh_method
98         {
99         const char *name;
100         /* Methods here */
101         int (*generate_key)(DH *dh);
102         int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh);
103         int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
104                                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
105                                 BN_MONT_CTX *m_ctx); /* Can be null */
106
107         int (*init)(DH *dh);
108         int (*finish)(DH *dh);
109         int flags;
110         char *app_data;
111         /* If this is non-NULL, it will be used to generate parameters */
112         int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb);
113         };
114
115 struct dh_st
116         {
117         /* This first argument is used to pick up errors when
118          * a DH is passed instead of a EVP_PKEY */
119         int pad;
120         int version;
121         BIGNUM *p;
122         BIGNUM *g;
123         long length; /* optional */
124         BIGNUM *pub_key;        /* g^x */
125         BIGNUM *priv_key;       /* x */
126
127         int flags;
128         BN_MONT_CTX *method_mont_p;
129         /* Place holders if we want to do X9.42 DH */
130         BIGNUM *q;
131         BIGNUM *j;
132         unsigned char *seed;
133         int seedlen;
134         BIGNUM *counter;
135
136         int references;
137         CRYPTO_EX_DATA ex_data;
138         const DH_METHOD *meth;
139         ENGINE *engine;
140         };
141
142 #define DH_GENERATOR_2          2
143 /* #define DH_GENERATOR_3       3 */
144 #define DH_GENERATOR_5          5
145
146 /* DH_check error codes */
147 #define DH_CHECK_P_NOT_PRIME            0x01
148 #define DH_CHECK_P_NOT_SAFE_PRIME       0x02
149 #define DH_UNABLE_TO_CHECK_GENERATOR    0x04
150 #define DH_NOT_SUITABLE_GENERATOR       0x08
151
152 /* DH_check_pub_key error codes */
153 #define DH_CHECK_PUBKEY_TOO_SMALL       0x01
154 #define DH_CHECK_PUBKEY_TOO_LARGE       0x02
155
156 /* primes p where (p-1)/2 is prime too are called "safe"; we define
157    this for backward compatibility: */
158 #define DH_CHECK_P_NOT_STRONG_PRIME     DH_CHECK_P_NOT_SAFE_PRIME
159
160 #define DHparams_dup(x) ASN1_dup_of_const(DH,i2d_DHparams,d2i_DHparams,x)
161 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
162                 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
163 #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
164                 (unsigned char *)(x))
165 #define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
166 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
167
168 const DH_METHOD *DH_OpenSSL(void);
169
170 void DH_set_default_method(const DH_METHOD *meth);
171 const DH_METHOD *DH_get_default_method(void);
172 int DH_set_method(DH *dh, const DH_METHOD *meth);
173 DH *DH_new_method(ENGINE *engine);
174
175 DH *    DH_new(void);
176 void    DH_free(DH *dh);
177 int     DH_up_ref(DH *dh);
178 int     DH_size(const DH *dh);
179 int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
180              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
181 int DH_set_ex_data(DH *d, int idx, void *arg);
182 void *DH_get_ex_data(DH *d, int idx);
183
184 /* Deprecated version */
185 #ifndef OPENSSL_NO_DEPRECATED
186 DH *    DH_generate_parameters(int prime_len,int generator,
187                 void (*callback)(int,int,void *),void *cb_arg);
188 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
189
190 /* New version */
191 int     DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
192
193 int     DH_check(const DH *dh,int *codes);
194 int     DH_check_pub_key(const DH *dh,const BIGNUM *pub_key, int *codes);
195 int     DH_generate_key(DH *dh);
196 int     DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
197 DH *    d2i_DHparams(DH **a,const unsigned char **pp, long length);
198 int     i2d_DHparams(const DH *a,unsigned char **pp);
199 #ifndef OPENSSL_NO_FP_API
200 int     DHparams_print_fp(FILE *fp, const DH *x);
201 #endif
202 #ifndef OPENSSL_NO_BIO
203 int     DHparams_print(BIO *bp, const DH *x);
204 #else
205 int     DHparams_print(char *bp, const DH *x);
206 #endif
207
208 #define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
209         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
210                         EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
211
212 #define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
213         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
214                         EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
215
216 #define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN     (EVP_PKEY_ALG_CTRL + 1)
217 #define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR     (EVP_PKEY_ALG_CTRL + 2)
218                 
219
220 /* BEGIN ERROR CODES */
221 /* The following lines are auto generated by the script mkerr.pl. Any changes
222  * made after this point may be overwritten when the script is next run.
223  */
224 void ERR_load_DH_strings(void);
225
226 /* Error codes for the DH functions. */
227
228 /* Function codes. */
229 #define DH_F_COMPUTE_KEY                                 102
230 #define DH_F_DHPARAMS_PRINT_FP                           101
231 #define DH_F_DH_BUILTIN_GENPARAMS                        106
232 #define DH_F_DH_NEW_METHOD                               105
233 #define DH_F_DH_PARAM_DECODE                             107
234 #define DH_F_DH_PRIV_DECODE                              110
235 #define DH_F_DH_PRIV_ENCODE                              111
236 #define DH_F_DH_PUB_DECODE                               108
237 #define DH_F_DH_PUB_ENCODE                               109
238 #define DH_F_DO_DH_PRINT                                 100
239 #define DH_F_GENERATE_KEY                                103
240 #define DH_F_GENERATE_PARAMETERS                         104
241 #define DH_F_PKEY_DH_DERIVE                              112
242 #define DH_F_PKEY_DH_KEYGEN                              113
243
244 /* Reason codes. */
245 #define DH_R_BAD_GENERATOR                               101
246 #define DH_R_BN_DECODE_ERROR                             109
247 #define DH_R_BN_ERROR                                    106
248 #define DH_R_DECODE_ERROR                                104
249 #define DH_R_INVALID_PUBKEY                              102
250 #define DH_R_KEYS_NOT_SET                                108
251 #define DH_R_MODULUS_TOO_LARGE                           103
252 #define DH_R_NO_PARAMETERS_SET                           107
253 #define DH_R_NO_PRIVATE_VALUE                            100
254 #define DH_R_PARAMETER_ENCODING_ERROR                    105
255
256 #ifdef  __cplusplus
257 }
258 #endif
259 #endif