2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
62 # include <openssl/e_os2.h>
65 # error DH is disabled.
68 # ifndef OPENSSL_NO_BIO
69 # include <openssl/bio.h>
71 # include <openssl/ossl_typ.h>
72 # ifdef OPENSSL_USE_DEPRECATED
73 # include <openssl/bn.h>
76 # ifndef OPENSSL_DH_MAX_MODULUS_BITS
77 # define OPENSSL_DH_MAX_MODULUS_BITS 10000
80 # define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024
82 # define DH_FLAG_CACHE_MONT_P 0x01
85 * new with 0.9.7h; the built-in DH
86 * implementation now uses constant time
87 * modular exponentiation for secret exponents
88 * by default. This flag causes the
89 * faster variable sliding window method to
90 * be used for all exponents.
92 # define DH_FLAG_NO_EXP_CONSTTIME 0x02
95 * If this flag is set the DH method is FIPS compliant and can be used in
96 * FIPS mode. This is set in the validated module method. If an application
97 * sets this flag in its own methods it is its reposibility to ensure the
98 * result is compliant.
101 # define DH_FLAG_FIPS_METHOD 0x0400
104 * If this flag is set the operations normally disabled in FIPS mode are
105 * permitted it is then the applications responsibility to ensure that the
106 * usage is compliant.
109 # define DH_FLAG_NON_FIPS_ALLOW 0x0400
115 /* Already defined in ossl_typ.h */
116 /* typedef struct dh_st DH; */
117 /* typedef struct dh_method DH_METHOD; */
122 int (*generate_key) (DH *dh);
123 int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh);
125 int (*bn_mod_exp) (const DH *dh, BIGNUM *r, const BIGNUM *a,
126 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
128 int (*init) (DH *dh);
129 int (*finish) (DH *dh);
132 /* If this is non-NULL, it will be used to generate parameters */
133 int (*generate_params) (DH *dh, int prime_len, int generator,
139 * This first argument is used to pick up errors when a DH is passed
140 * instead of a EVP_PKEY
146 long length; /* optional */
147 BIGNUM *pub_key; /* g^x */
148 BIGNUM *priv_key; /* x */
150 BN_MONT_CTX *method_mont_p;
151 /* Place holders if we want to do X9.42 DH */
158 CRYPTO_EX_DATA ex_data;
159 const DH_METHOD *meth;
163 # define DH_GENERATOR_2 2
164 /* #define DH_GENERATOR_3 3 */
165 # define DH_GENERATOR_5 5
167 /* DH_check error codes */
168 # define DH_CHECK_P_NOT_PRIME 0x01
169 # define DH_CHECK_P_NOT_SAFE_PRIME 0x02
170 # define DH_UNABLE_TO_CHECK_GENERATOR 0x04
171 # define DH_NOT_SUITABLE_GENERATOR 0x08
172 # define DH_CHECK_Q_NOT_PRIME 0x10
173 # define DH_CHECK_INVALID_Q_VALUE 0x20
174 # define DH_CHECK_INVALID_J_VALUE 0x40
176 /* DH_check_pub_key error codes */
177 # define DH_CHECK_PUBKEY_TOO_SMALL 0x01
178 # define DH_CHECK_PUBKEY_TOO_LARGE 0x02
181 * primes p where (p-1)/2 is prime too are called "safe"; we define this for
182 * backward compatibility:
184 # define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME
186 # define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
187 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
188 # define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
189 (unsigned char *)(x))
190 # define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
191 # define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
193 DH *DHparams_dup(DH *);
195 const DH_METHOD *DH_OpenSSL(void);
197 void DH_set_default_method(const DH_METHOD *meth);
198 const DH_METHOD *DH_get_default_method(void);
199 int DH_set_method(DH *dh, const DH_METHOD *meth);
200 DH *DH_new_method(ENGINE *engine);
203 void DH_free(DH *dh);
204 int DH_up_ref(DH *dh);
205 int DH_size(const DH *dh);
206 int DH_security_bits(const DH *dh);
207 int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
208 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
209 int DH_set_ex_data(DH *d, int idx, void *arg);
210 void *DH_get_ex_data(DH *d, int idx);
212 /* Deprecated version */
213 # ifdef OPENSSL_USE_DEPRECATED
214 DECLARE_DEPRECATED(DH *DH_generate_parameters(int prime_len, int generator,
215 void (*callback) (int, int,
218 # endif /* defined(OPENSSL_USE_DEPRECATED) */
221 int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
224 int DH_check(const DH *dh, int *codes);
225 int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes);
226 int DH_generate_key(DH *dh);
227 int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
228 int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh);
229 DH *d2i_DHparams(DH **a, const unsigned char **pp, long length);
230 int i2d_DHparams(const DH *a, unsigned char **pp);
231 DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length);
232 int i2d_DHxparams(const DH *a, unsigned char **pp);
233 # ifndef OPENSSL_NO_STDIO
234 int DHparams_print_fp(FILE *fp, const DH *x);
236 # ifndef OPENSSL_NO_BIO
237 int DHparams_print(BIO *bp, const DH *x);
239 int DHparams_print(char *bp, const DH *x);
242 /* RFC 5114 parameters */
243 DH *DH_get_1024_160(void);
244 DH *DH_get_2048_224(void);
245 DH *DH_get_2048_256(void);
248 int DH_KDF_X9_42(unsigned char *out, size_t outlen,
249 const unsigned char *Z, size_t Zlen,
250 ASN1_OBJECT *key_oid,
251 const unsigned char *ukm, size_t ukmlen, const EVP_MD *md);
253 # define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
254 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
255 EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
257 # define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \
258 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
259 EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL)
261 # define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \
262 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
263 EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL)
265 # define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
266 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
267 EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
269 # define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
270 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
271 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
273 # define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
274 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
275 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
277 # define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \
278 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
279 EVP_PKEY_OP_DERIVE, \
280 EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL)
282 # define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \
283 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
284 EVP_PKEY_OP_DERIVE, \
285 EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL)
287 # define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \
288 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
289 EVP_PKEY_OP_DERIVE, \
290 EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)oid)
292 # define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \
293 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
294 EVP_PKEY_OP_DERIVE, \
295 EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)poid)
297 # define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \
298 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
299 EVP_PKEY_OP_DERIVE, \
300 EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)md)
302 # define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \
303 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
304 EVP_PKEY_OP_DERIVE, \
305 EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)pmd)
307 # define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \
308 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
309 EVP_PKEY_OP_DERIVE, \
310 EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL)
312 # define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \
313 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
314 EVP_PKEY_OP_DERIVE, \
315 EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)plen)
317 # define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \
318 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
319 EVP_PKEY_OP_DERIVE, \
320 EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)p)
322 # define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \
323 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
324 EVP_PKEY_OP_DERIVE, \
325 EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)p)
327 # define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1)
328 # define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2)
329 # define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3)
330 # define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN (EVP_PKEY_ALG_CTRL + 4)
331 # define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE (EVP_PKEY_ALG_CTRL + 5)
332 # define EVP_PKEY_CTRL_DH_KDF_TYPE (EVP_PKEY_ALG_CTRL + 6)
333 # define EVP_PKEY_CTRL_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 7)
334 # define EVP_PKEY_CTRL_GET_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 8)
335 # define EVP_PKEY_CTRL_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 9)
336 # define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 10)
337 # define EVP_PKEY_CTRL_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 11)
338 # define EVP_PKEY_CTRL_GET_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 12)
339 # define EVP_PKEY_CTRL_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 13)
340 # define EVP_PKEY_CTRL_GET_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 14)
343 # define EVP_PKEY_DH_KDF_NONE 1
344 # define EVP_PKEY_DH_KDF_X9_42 2
346 /* BEGIN ERROR CODES */
348 * The following lines are auto generated by the script mkerr.pl. Any changes
349 * made after this point may be overwritten when the script is next run.
351 void ERR_load_DH_strings(void);
353 /* Error codes for the DH functions. */
355 /* Function codes. */
356 # define DH_F_COMPUTE_KEY 102
357 # define DH_F_DHPARAMS_PRINT_FP 101
358 # define DH_F_DH_BUILTIN_GENPARAMS 106
359 # define DH_F_DH_CMS_DECRYPT 114
360 # define DH_F_DH_CMS_SET_PEERKEY 115
361 # define DH_F_DH_CMS_SET_SHARED_INFO 116
362 # define DH_F_DH_NEW_METHOD 105
363 # define DH_F_DH_PARAM_DECODE 107
364 # define DH_F_DH_PRIV_DECODE 110
365 # define DH_F_DH_PRIV_ENCODE 111
366 # define DH_F_DH_PUB_DECODE 108
367 # define DH_F_DH_PUB_ENCODE 109
368 # define DH_F_DO_DH_PRINT 100
369 # define DH_F_GENERATE_KEY 103
370 # define DH_F_GENERATE_PARAMETERS 104
371 # define DH_F_PKEY_DH_DERIVE 112
372 # define DH_F_PKEY_DH_KEYGEN 113
375 # define DH_R_BAD_GENERATOR 101
376 # define DH_R_BN_DECODE_ERROR 109
377 # define DH_R_BN_ERROR 106
378 # define DH_R_DECODE_ERROR 104
379 # define DH_R_INVALID_PUBKEY 102
380 # define DH_R_KDF_PARAMETER_ERROR 112
381 # define DH_R_KEYS_NOT_SET 108
382 # define DH_R_KEY_SIZE_TOO_SMALL 110
383 # define DH_R_MODULUS_TOO_LARGE 103
384 # define DH_R_NO_PARAMETERS_SET 107
385 # define DH_R_NO_PRIVATE_VALUE 100
386 # define DH_R_PARAMETER_ENCODING_ERROR 105
387 # define DH_R_PEER_KEY_ERROR 111
388 # define DH_R_SHARED_INFO_ERROR 113