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