1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
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)"
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
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.]
61 # include <openssl/e_os2.h>
62 # include <openssl/opensslconf.h>
65 # error DH is disabled.
68 # include <openssl/bio.h>
69 # include <openssl/asn1.h>
70 # include <openssl/ossl_typ.h>
71 # if OPENSSL_API_COMPAT < 0x10100000L
72 # include <openssl/bn.h>
75 # ifndef OPENSSL_DH_MAX_MODULUS_BITS
76 # define OPENSSL_DH_MAX_MODULUS_BITS 10000
79 # define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024
81 # define DH_FLAG_CACHE_MONT_P 0x01
84 * new with 0.9.7h; the built-in DH
85 * implementation now uses constant time
86 * modular exponentiation for secret exponents
87 * by default. This flag causes the
88 * faster variable sliding window method to
89 * be used for all exponents.
91 # define DH_FLAG_NO_EXP_CONSTTIME 0x02
94 * If this flag is set the DH method is FIPS compliant and can be used in
95 * FIPS mode. This is set in the validated module method. If an application
96 * sets this flag in its own methods it is its reposibility to ensure the
97 * result is compliant.
100 # define DH_FLAG_FIPS_METHOD 0x0400
103 * If this flag is set the operations normally disabled in FIPS mode are
104 * permitted it is then the applications responsibility to ensure that the
105 * usage is compliant.
108 # define DH_FLAG_NON_FIPS_ALLOW 0x0400
114 /* Already defined in ossl_typ.h */
115 /* typedef struct dh_st DH; */
116 /* typedef struct dh_method DH_METHOD; */
121 int (*generate_key) (DH *dh);
122 int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh);
124 int (*bn_mod_exp) (const DH *dh, BIGNUM *r, const BIGNUM *a,
125 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
127 int (*init) (DH *dh);
128 int (*finish) (DH *dh);
131 /* If this is non-NULL, it will be used to generate parameters */
132 int (*generate_params) (DH *dh, int prime_len, int generator,
138 * This first argument is used to pick up errors when a DH is passed
139 * instead of a EVP_PKEY
145 long length; /* optional */
146 BIGNUM *pub_key; /* g^x % p */
147 BIGNUM *priv_key; /* x */
149 BN_MONT_CTX *method_mont_p;
150 /* Place holders if we want to do X9.42 DH */
157 CRYPTO_EX_DATA ex_data;
158 const DH_METHOD *meth;
163 DECLARE_ASN1_ITEM(DHparams)
165 # define DH_GENERATOR_2 2
166 /* #define DH_GENERATOR_3 3 */
167 # define DH_GENERATOR_5 5
169 /* DH_check error codes */
170 # define DH_CHECK_P_NOT_PRIME 0x01
171 # define DH_CHECK_P_NOT_SAFE_PRIME 0x02
172 # define DH_UNABLE_TO_CHECK_GENERATOR 0x04
173 # define DH_NOT_SUITABLE_GENERATOR 0x08
174 # define DH_CHECK_Q_NOT_PRIME 0x10
175 # define DH_CHECK_INVALID_Q_VALUE 0x20
176 # define DH_CHECK_INVALID_J_VALUE 0x40
178 /* DH_check_pub_key error codes */
179 # define DH_CHECK_PUBKEY_TOO_SMALL 0x01
180 # define DH_CHECK_PUBKEY_TOO_LARGE 0x02
181 # define DH_CHECK_PUBKEY_INVALID 0x04
184 * primes p where (p-1)/2 is prime too are called "safe"; we define this for
185 * backward compatibility:
187 # define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME
189 # define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
190 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
191 # define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
192 (unsigned char *)(x))
193 # define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
194 # define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
196 DH *DHparams_dup(DH *);
198 const DH_METHOD *DH_OpenSSL(void);
200 void DH_set_default_method(const DH_METHOD *meth);
201 const DH_METHOD *DH_get_default_method(void);
202 int DH_set_method(DH *dh, const DH_METHOD *meth);
203 DH *DH_new_method(ENGINE *engine);
206 void DH_free(DH *dh);
207 int DH_up_ref(DH *dh);
208 int DH_bits(const DH *dh);
209 int DH_size(const DH *dh);
210 int DH_security_bits(const DH *dh);
211 #define DH_get_ex_new_index(l, p, newf, dupf, freef) \
212 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)
213 int DH_set_ex_data(DH *d, int idx, void *arg);
214 void *DH_get_ex_data(DH *d, int idx);
216 /* Deprecated version */
217 DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator,
218 void (*callback) (int, int,
223 int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
226 int DH_check(const DH *dh, int *codes);
227 int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes);
228 int DH_generate_key(DH *dh);
229 int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
230 int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh);
231 DH *d2i_DHparams(DH **a, const unsigned char **pp, long length);
232 int i2d_DHparams(const DH *a, unsigned char **pp);
233 DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length);
234 int i2d_DHxparams(const DH *a, unsigned char **pp);
235 # ifndef OPENSSL_NO_STDIO
236 int DHparams_print_fp(FILE *fp, const DH *x);
238 int DHparams_print(BIO *bp, const DH *x);
240 /* RFC 5114 parameters */
241 DH *DH_get_1024_160(void);
242 DH *DH_get_2048_224(void);
243 DH *DH_get_2048_256(void);
245 # ifndef OPENSSL_NO_CMS
247 int DH_KDF_X9_42(unsigned char *out, size_t outlen,
248 const unsigned char *Z, size_t Zlen,
249 ASN1_OBJECT *key_oid,
250 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 # ifndef OPENSSL_NO_CMS
345 # define EVP_PKEY_DH_KDF_X9_42 2
348 /* BEGIN ERROR CODES */
350 * The following lines are auto generated by the script mkerr.pl. Any changes
351 * made after this point may be overwritten when the script is next run.
353 void ERR_load_DH_strings(void);
355 /* Error codes for the DH functions. */
357 /* Function codes. */
358 # define DH_F_COMPUTE_KEY 102
359 # define DH_F_DHPARAMS_PRINT_FP 101
360 # define DH_F_DH_BUILTIN_GENPARAMS 106
361 # define DH_F_DH_CMS_DECRYPT 114
362 # define DH_F_DH_CMS_SET_PEERKEY 115
363 # define DH_F_DH_CMS_SET_SHARED_INFO 116
364 # define DH_F_DH_NEW_METHOD 105
365 # define DH_F_DH_PARAM_DECODE 107
366 # define DH_F_DH_PRIV_DECODE 110
367 # define DH_F_DH_PRIV_ENCODE 111
368 # define DH_F_DH_PUB_DECODE 108
369 # define DH_F_DH_PUB_ENCODE 109
370 # define DH_F_DO_DH_PRINT 100
371 # define DH_F_GENERATE_KEY 103
372 # define DH_F_GENERATE_PARAMETERS 104
373 # define DH_F_PKEY_DH_DERIVE 112
374 # define DH_F_PKEY_DH_KEYGEN 113
377 # define DH_R_BAD_GENERATOR 101
378 # define DH_R_BN_DECODE_ERROR 109
379 # define DH_R_BN_ERROR 106
380 # define DH_R_DECODE_ERROR 104
381 # define DH_R_INVALID_PUBKEY 102
382 # define DH_R_KDF_PARAMETER_ERROR 112
383 # define DH_R_KEYS_NOT_SET 108
384 # define DH_R_KEY_SIZE_TOO_SMALL 110
385 # define DH_R_MODULUS_TOO_LARGE 103
386 # define DH_R_NO_PARAMETERS_SET 107
387 # define DH_R_NO_PRIVATE_VALUE 100
388 # define DH_R_PARAMETER_ENCODING_ERROR 105
389 # define DH_R_PEER_KEY_ERROR 111
390 # define DH_R_SHARED_INFO_ERROR 113