2e021e235b9f04f6132065d1281286fae562f5ed
[openssl.git] / include / openssl / dh.h
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #ifndef HEADER_DH_H
59 # define HEADER_DH_H
60
61 # include <openssl/opensslconf.h>
62
63 # ifndef OPENSSL_NO_DH
64 # include <openssl/e_os2.h>
65 # include <openssl/bio.h>
66 # include <openssl/asn1.h>
67 # include <openssl/ossl_typ.h>
68 # if OPENSSL_API_COMPAT < 0x10100000L
69 #  include <openssl/bn.h>
70 # endif
71
72 # ifdef  __cplusplus
73 extern "C" {
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
84
85 /*
86  * If this flag is set the DH method is FIPS compliant and can be used in
87  * FIPS mode. This is set in the validated module method. If an application
88  * sets this flag in its own methods it is its reposibility to ensure the
89  * result is compliant.
90  */
91
92 # define DH_FLAG_FIPS_METHOD                     0x0400
93
94 /*
95  * If this flag is set the operations normally disabled in FIPS mode are
96  * permitted it is then the applications responsibility to ensure that the
97  * usage is compliant.
98  */
99
100 # define DH_FLAG_NON_FIPS_ALLOW                  0x0400
101
102 /* Already defined in ossl_typ.h */
103 /* typedef struct dh_st DH; */
104 /* typedef struct dh_method DH_METHOD; */
105
106 struct dh_method {
107     const char *name;
108     /* Methods here */
109     int (*generate_key) (DH *dh);
110     int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh);
111     /* Can be null */
112     int (*bn_mod_exp) (const DH *dh, BIGNUM *r, const BIGNUM *a,
113                        const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
114                        BN_MONT_CTX *m_ctx);
115     int (*init) (DH *dh);
116     int (*finish) (DH *dh);
117     int flags;
118     char *app_data;
119     /* If this is non-NULL, it will be used to generate parameters */
120     int (*generate_params) (DH *dh, int prime_len, int generator,
121                             BN_GENCB *cb);
122 };
123
124 struct dh_st {
125     /*
126      * This first argument is used to pick up errors when a DH is passed
127      * instead of a EVP_PKEY
128      */
129     int pad;
130     int version;
131     BIGNUM *p;
132     BIGNUM *g;
133     long length;                /* optional */
134     BIGNUM *pub_key;            /* g^x % p */
135     BIGNUM *priv_key;           /* x */
136     int flags;
137     BN_MONT_CTX *method_mont_p;
138     /* Place holders if we want to do X9.42 DH */
139     BIGNUM *q;
140     BIGNUM *j;
141     unsigned char *seed;
142     int seedlen;
143     BIGNUM *counter;
144     int references;
145     CRYPTO_EX_DATA ex_data;
146     const DH_METHOD *meth;
147     ENGINE *engine;
148     CRYPTO_RWLOCK *lock;
149 };
150
151 DECLARE_ASN1_ITEM(DHparams)
152
153 # define DH_GENERATOR_2          2
154 /* #define DH_GENERATOR_3       3 */
155 # define DH_GENERATOR_5          5
156
157 /* DH_check error codes */
158 # define DH_CHECK_P_NOT_PRIME            0x01
159 # define DH_CHECK_P_NOT_SAFE_PRIME       0x02
160 # define DH_UNABLE_TO_CHECK_GENERATOR    0x04
161 # define DH_NOT_SUITABLE_GENERATOR       0x08
162 # define DH_CHECK_Q_NOT_PRIME            0x10
163 # define DH_CHECK_INVALID_Q_VALUE        0x20
164 # define DH_CHECK_INVALID_J_VALUE        0x40
165
166 /* DH_check_pub_key error codes */
167 # define DH_CHECK_PUBKEY_TOO_SMALL       0x01
168 # define DH_CHECK_PUBKEY_TOO_LARGE       0x02
169 # define DH_CHECK_PUBKEY_INVALID         0x04
170
171 /*
172  * primes p where (p-1)/2 is prime too are called "safe"; we define this for
173  * backward compatibility:
174  */
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 void DH_set_default_method(const DH_METHOD *meth);
189 const DH_METHOD *DH_get_default_method(void);
190 int DH_set_method(DH *dh, const DH_METHOD *meth);
191 DH *DH_new_method(ENGINE *engine);
192
193 DH *DH_new(void);
194 void DH_free(DH *dh);
195 int DH_up_ref(DH *dh);
196 int DH_bits(const DH *dh);
197 int DH_size(const DH *dh);
198 int DH_security_bits(const DH *dh);
199 #define DH_get_ex_new_index(l, p, newf, dupf, freef) \
200     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)
201 int DH_set_ex_data(DH *d, int idx, void *arg);
202 void *DH_get_ex_data(DH *d, int idx);
203
204 /* Deprecated version */
205 DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator,
206                                               void (*callback) (int, int,
207                                                                 void *),
208                                               void *cb_arg))
209
210 /* New version */
211 int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
212                               BN_GENCB *cb);
213
214 int DH_check(const DH *dh, int *codes);
215 int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes);
216 int DH_generate_key(DH *dh);
217 int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
218 int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh);
219 DH *d2i_DHparams(DH **a, const unsigned char **pp, long length);
220 int i2d_DHparams(const DH *a, unsigned char **pp);
221 DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length);
222 int i2d_DHxparams(const DH *a, unsigned char **pp);
223 # ifndef OPENSSL_NO_STDIO
224 int DHparams_print_fp(FILE *fp, const DH *x);
225 # endif
226 int DHparams_print(BIO *bp, const DH *x);
227
228 /* RFC 5114 parameters */
229 DH *DH_get_1024_160(void);
230 DH *DH_get_2048_224(void);
231 DH *DH_get_2048_256(void);
232
233 # ifndef OPENSSL_NO_CMS
234 /* RFC2631 KDF */
235 int DH_KDF_X9_42(unsigned char *out, size_t outlen,
236                  const unsigned char *Z, size_t Zlen,
237                  ASN1_OBJECT *key_oid,
238                  const unsigned char *ukm, size_t ukmlen, const EVP_MD *md);
239 # endif
240
241 # define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
242         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
243                         EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
244
245 # define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \
246         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
247                         EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL)
248
249 # define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \
250         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
251                         EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL)
252
253 # define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
254         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
255                         EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
256
257 # define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
258         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
259                         EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
260
261 # define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
262         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
263                         EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
264
265 # define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \
266         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
267                                 EVP_PKEY_OP_DERIVE, \
268                                 EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL)
269
270 # define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \
271         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
272                                 EVP_PKEY_OP_DERIVE, \
273                                 EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL)
274
275 # define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \
276         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
277                                 EVP_PKEY_OP_DERIVE, \
278                                 EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)oid)
279
280 # define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \
281         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
282                                 EVP_PKEY_OP_DERIVE, \
283                                 EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)poid)
284
285 # define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \
286         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
287                                 EVP_PKEY_OP_DERIVE, \
288                                 EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)md)
289
290 # define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \
291         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
292                                 EVP_PKEY_OP_DERIVE, \
293                                 EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)pmd)
294
295 # define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \
296         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
297                                 EVP_PKEY_OP_DERIVE, \
298                                 EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL)
299
300 # define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \
301         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
302                                 EVP_PKEY_OP_DERIVE, \
303                         EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)plen)
304
305 # define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \
306         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
307                                 EVP_PKEY_OP_DERIVE, \
308                                 EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)p)
309
310 # define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \
311         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
312                                 EVP_PKEY_OP_DERIVE, \
313                                 EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)p)
314
315 # define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN     (EVP_PKEY_ALG_CTRL + 1)
316 # define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR     (EVP_PKEY_ALG_CTRL + 2)
317 # define EVP_PKEY_CTRL_DH_RFC5114                (EVP_PKEY_ALG_CTRL + 3)
318 # define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN  (EVP_PKEY_ALG_CTRL + 4)
319 # define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE          (EVP_PKEY_ALG_CTRL + 5)
320 # define EVP_PKEY_CTRL_DH_KDF_TYPE               (EVP_PKEY_ALG_CTRL + 6)
321 # define EVP_PKEY_CTRL_DH_KDF_MD                 (EVP_PKEY_ALG_CTRL + 7)
322 # define EVP_PKEY_CTRL_GET_DH_KDF_MD             (EVP_PKEY_ALG_CTRL + 8)
323 # define EVP_PKEY_CTRL_DH_KDF_OUTLEN             (EVP_PKEY_ALG_CTRL + 9)
324 # define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN         (EVP_PKEY_ALG_CTRL + 10)
325 # define EVP_PKEY_CTRL_DH_KDF_UKM                (EVP_PKEY_ALG_CTRL + 11)
326 # define EVP_PKEY_CTRL_GET_DH_KDF_UKM            (EVP_PKEY_ALG_CTRL + 12)
327 # define EVP_PKEY_CTRL_DH_KDF_OID                (EVP_PKEY_ALG_CTRL + 13)
328 # define EVP_PKEY_CTRL_GET_DH_KDF_OID            (EVP_PKEY_ALG_CTRL + 14)
329
330 /* KDF types */
331 # define EVP_PKEY_DH_KDF_NONE                            1
332 # ifndef OPENSSL_NO_CMS
333 # define EVP_PKEY_DH_KDF_X9_42                           2
334 # endif
335
336 /* BEGIN ERROR CODES */
337 /*
338  * The following lines are auto generated by the script mkerr.pl. Any changes
339  * made after this point may be overwritten when the script is next run.
340  */
341 void ERR_load_DH_strings(void);
342
343 /* Error codes for the DH functions. */
344
345 /* Function codes. */
346 # define DH_F_COMPUTE_KEY                                 102
347 # define DH_F_DHPARAMS_PRINT_FP                           101
348 # define DH_F_DH_BUILTIN_GENPARAMS                        106
349 # define DH_F_DH_CMS_DECRYPT                              114
350 # define DH_F_DH_CMS_SET_PEERKEY                          115
351 # define DH_F_DH_CMS_SET_SHARED_INFO                      116
352 # define DH_F_DH_NEW_METHOD                               105
353 # define DH_F_DH_PARAM_DECODE                             107
354 # define DH_F_DH_PRIV_DECODE                              110
355 # define DH_F_DH_PRIV_ENCODE                              111
356 # define DH_F_DH_PUB_DECODE                               108
357 # define DH_F_DH_PUB_ENCODE                               109
358 # define DH_F_DO_DH_PRINT                                 100
359 # define DH_F_GENERATE_KEY                                103
360 # define DH_F_GENERATE_PARAMETERS                         104
361 # define DH_F_PKEY_DH_DERIVE                              112
362 # define DH_F_PKEY_DH_KEYGEN                              113
363
364 /* Reason codes. */
365 # define DH_R_BAD_GENERATOR                               101
366 # define DH_R_BN_DECODE_ERROR                             109
367 # define DH_R_BN_ERROR                                    106
368 # define DH_R_DECODE_ERROR                                104
369 # define DH_R_INVALID_PUBKEY                              102
370 # define DH_R_KDF_PARAMETER_ERROR                         112
371 # define DH_R_KEYS_NOT_SET                                108
372 # define DH_R_KEY_SIZE_TOO_SMALL                          110
373 # define DH_R_MODULUS_TOO_LARGE                           103
374 # define DH_R_NO_PARAMETERS_SET                           107
375 # define DH_R_NO_PRIVATE_VALUE                            100
376 # define DH_R_PARAMETER_ENCODING_ERROR                    105
377 # define DH_R_PEER_KEY_ERROR                              111
378 # define DH_R_SHARED_INFO_ERROR                           113
379
380 # ifdef  __cplusplus
381 }
382 # endif
383 # endif
384
385 #endif