]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/dh.h
Add objects for RFC7919 parameters
[thirdparty/openssl.git] / include / openssl / dh.h
CommitLineData
21dcbebc
RS
1/*
2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
d02b48c6 3 *
21dcbebc
RS
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
d02b48c6
RE
8 */
9
10#ifndef HEADER_DH_H
0f113f3e 11# define HEADER_DH_H
d02b48c6 12
98186eb4 13# include <openssl/opensslconf.h>
d3ae5b1c 14
3c27208f
RS
15# ifndef OPENSSL_NO_DH
16# include <openssl/e_os2.h>
a00ae6c4 17# include <openssl/bio.h>
599eccfc 18# include <openssl/asn1.h>
0f113f3e 19# include <openssl/ossl_typ.h>
98186eb4 20# if OPENSSL_API_COMPAT < 0x10100000L
0f113f3e
MC
21# include <openssl/bn.h>
22# endif
52df25cf 23# include <openssl/dherr.h>
5e3225cc 24
3c27208f
RS
25# ifdef __cplusplus
26extern "C" {
27# endif
28
0f113f3e
MC
29# ifndef OPENSSL_DH_MAX_MODULUS_BITS
30# define OPENSSL_DH_MAX_MODULUS_BITS 10000
31# endif
83c3410b 32
0f113f3e
MC
33# define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024
34
35# define DH_FLAG_CACHE_MONT_P 0x01
5584f65a
MC
36
37# if OPENSSL_API_COMPAT < 0x10100000L
38/*
39 * Does nothing. Previously this switched off constant time behaviour.
40 */
41# define DH_FLAG_NO_EXP_CONSTTIME 0x00
42# endif
dfeab068 43
0f113f3e
MC
44/*
45 * If this flag is set the DH method is FIPS compliant and can be used in
46 * FIPS mode. This is set in the validated module method. If an application
8483a003 47 * sets this flag in its own methods it is its responsibility to ensure the
0f113f3e 48 * result is compliant.
4960411e
DSH
49 */
50
0f113f3e 51# define DH_FLAG_FIPS_METHOD 0x0400
4960411e 52
0f113f3e
MC
53/*
54 * If this flag is set the operations normally disabled in FIPS mode are
4960411e
DSH
55 * permitted it is then the applications responsibility to ensure that the
56 * usage is compliant.
57 */
58
0f113f3e 59# define DH_FLAG_NON_FIPS_ALLOW 0x0400
4960411e 60
3a87a9b9
GT
61/* Already defined in ossl_typ.h */
62/* typedef struct dh_st DH; */
63/* typedef struct dh_method DH_METHOD; */
13066cee 64
599eccfc
RS
65DECLARE_ASN1_ITEM(DHparams)
66
0f113f3e
MC
67# define DH_GENERATOR_2 2
68/* #define DH_GENERATOR_3 3 */
69# define DH_GENERATOR_5 5
d02b48c6
RE
70
71/* DH_check error codes */
0f113f3e
MC
72# define DH_CHECK_P_NOT_PRIME 0x01
73# define DH_CHECK_P_NOT_SAFE_PRIME 0x02
74# define DH_UNABLE_TO_CHECK_GENERATOR 0x04
75# define DH_NOT_SUITABLE_GENERATOR 0x08
76# define DH_CHECK_Q_NOT_PRIME 0x10
77# define DH_CHECK_INVALID_Q_VALUE 0x20
78# define DH_CHECK_INVALID_J_VALUE 0x40
d02b48c6 79
bf3d6c0c 80/* DH_check_pub_key error codes */
0f113f3e
MC
81# define DH_CHECK_PUBKEY_TOO_SMALL 0x01
82# define DH_CHECK_PUBKEY_TOO_LARGE 0x02
cb389fe8 83# define DH_CHECK_PUBKEY_INVALID 0x04
bf3d6c0c 84
0f113f3e
MC
85/*
86 * primes p where (p-1)/2 is prime too are called "safe"; we define this for
87 * backward compatibility:
88 */
89# define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME
4486d0cd 90
ff79a244
MC
91# define d2i_DHparams_fp(fp,x) \
92 (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
93 (char *(*)())d2i_DHparams, \
94 (fp), \
95 (unsigned char **)(x))
96# define i2d_DHparams_fp(fp,x) \
97 ASN1_i2d_fp(i2d_DHparams,(fp), (unsigned char *)(x))
98# define d2i_DHparams_bio(bp,x) \
99 ASN1_d2i_bio_of(DH, DH_new, d2i_DHparams, bp, x)
100# define i2d_DHparams_bio(bp,x) \
101 ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
102
103# define d2i_DHxparams_fp(fp,x) \
104 (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
105 (char *(*)())d2i_DHxparams, \
106 (fp), \
107 (unsigned char **)(x))
108# define i2d_DHxparams_fp(fp,x) \
109 ASN1_i2d_fp(i2d_DHxparams,(fp), (unsigned char *)(x))
110# define d2i_DHxparams_bio(bp,x) \
111 ASN1_d2i_bio_of(DH, DH_new, d2i_DHxparams, bp, x)
112# define i2d_DHxparams_bio(bp,x) \
113 ASN1_i2d_bio_of_const(DH, i2d_DHxparams, bp, x)
d02b48c6 114
f4274da1
DSH
115DH *DHparams_dup(DH *);
116
f971ccb2 117const DH_METHOD *DH_OpenSSL(void);
13066cee 118
cb78486d
GT
119void DH_set_default_method(const DH_METHOD *meth);
120const DH_METHOD *DH_get_default_method(void);
121int DH_set_method(DH *dh, const DH_METHOD *meth);
122DH *DH_new_method(ENGINE *engine);
13066cee 123
0f113f3e
MC
124DH *DH_new(void);
125void DH_free(DH *dh);
126int DH_up_ref(DH *dh);
26c79d56 127int DH_bits(const DH *dh);
0f113f3e
MC
128int DH_size(const DH *dh);
129int DH_security_bits(const DH *dh);
e6390aca
RS
130#define DH_get_ex_new_index(l, p, newf, dupf, freef) \
131 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)
dd9d233e
DSH
132int DH_set_ex_data(DH *d, int idx, void *arg);
133void *DH_get_ex_data(DH *d, int idx);
e9224c71
GT
134
135/* Deprecated version */
98186eb4 136DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator,
0f113f3e
MC
137 void (*callback) (int, int,
138 void *),
98186eb4 139 void *cb_arg))
e9224c71
GT
140
141/* New version */
0f113f3e
MC
142int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
143 BN_GENCB *cb);
144
26505153 145int DH_check_params(const DH *dh, int *ret);
0f113f3e
MC
146int DH_check(const DH *dh, int *codes);
147int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes);
148int DH_generate_key(DH *dh);
149int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
150int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh);
151DH *d2i_DHparams(DH **a, const unsigned char **pp, long length);
152int i2d_DHparams(const DH *a, unsigned char **pp);
153DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length);
154int i2d_DHxparams(const DH *a, unsigned char **pp);
155# ifndef OPENSSL_NO_STDIO
156int DHparams_print_fp(FILE *fp, const DH *x);
157# endif
0f113f3e 158int DHparams_print(BIO *bp, const DH *x);
d02b48c6 159
20bee968
DSH
160/* RFC 5114 parameters */
161DH *DH_get_1024_160(void);
162DH *DH_get_2048_224(void);
163DH *DH_get_2048_256(void);
164
7806a782
DSH
165/* Named parameters, currently RFC7919 */
166DH *DH_new_by_nid(int nid);
167int DH_get_nid(const DH *dh);
168
e968561d 169# ifndef OPENSSL_NO_CMS
dc1ce3bc 170/* RFC2631 KDF */
0f113f3e
MC
171int DH_KDF_X9_42(unsigned char *out, size_t outlen,
172 const unsigned char *Z, size_t Zlen,
173 ASN1_OBJECT *key_oid,
174 const unsigned char *ukm, size_t ukmlen, const EVP_MD *md);
e968561d 175# endif
0f113f3e 176
fd809cfd
RL
177void DH_get0_pqg(const DH *dh,
178 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
0aeddcfa 179int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);
fd809cfd
RL
180void DH_get0_key(const DH *dh,
181 const BIGNUM **pub_key, const BIGNUM **priv_key);
0aeddcfa
MC
182int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);
183void DH_clear_flags(DH *dh, int flags);
184int DH_test_flags(const DH *dh, int flags);
185void DH_set_flags(DH *dh, int flags);
186ENGINE *DH_get0_engine(DH *d);
187long DH_get_length(const DH *dh);
188int DH_set_length(DH *dh, long length);
189
17e01abb
MC
190DH_METHOD *DH_meth_new(const char *name, int flags);
191void DH_meth_free(DH_METHOD *dhm);
192DH_METHOD *DH_meth_dup(const DH_METHOD *dhm);
193const char *DH_meth_get0_name(const DH_METHOD *dhm);
194int DH_meth_set1_name(DH_METHOD *dhm, const char *name);
195int DH_meth_get_flags(DH_METHOD *dhm);
196int DH_meth_set_flags(DH_METHOD *dhm, int flags);
197void *DH_meth_get0_app_data(const DH_METHOD *dhm);
198int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data);
199int (*DH_meth_get_generate_key(const DH_METHOD *dhm)) (DH *);
200int DH_meth_set_generate_key(DH_METHOD *dhm, int (*generate_key) (DH *));
201int (*DH_meth_get_compute_key(const DH_METHOD *dhm))
202 (unsigned char *key, const BIGNUM *pub_key, DH *dh);
203int DH_meth_set_compute_key(DH_METHOD *dhm,
204 int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh));
205int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm))
206 (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
207 BN_CTX *, BN_MONT_CTX *);
208int DH_meth_set_bn_mod_exp(DH_METHOD *dhm,
209 int (*bn_mod_exp) (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *,
210 const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
211int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *);
212int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *));
213int (*DH_meth_get_finish(const DH_METHOD *dhm)) (DH *);
214int DH_meth_set_finish(DH_METHOD *dhm, int (*finish) (DH *));
215int (*DH_meth_get_generate_params(const DH_METHOD *dhm))
216 (DH *, int, int, BN_GENCB *);
217int DH_meth_set_generate_params(DH_METHOD *dhm,
218 int (*generate_params) (DH *, int, int, BN_GENCB *));
219
0aeddcfa 220
0f113f3e
MC
221# define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
222 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
223 EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
224
225# define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \
226 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
227 EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL)
228
229# define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \
230 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
231 EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL)
232
233# define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
234 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
235 EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
236
237# define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
238 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
239 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
240
241# define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
242 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
243 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
244
245# define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \
246 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
247 EVP_PKEY_OP_DERIVE, \
248 EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL)
249
250# define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \
251 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
252 EVP_PKEY_OP_DERIVE, \
253 EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL)
254
255# define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \
256 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
257 EVP_PKEY_OP_DERIVE, \
37659ea4 258 EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)(oid))
0f113f3e
MC
259
260# define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \
261 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
262 EVP_PKEY_OP_DERIVE, \
37659ea4 263 EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)(poid))
0f113f3e
MC
264
265# define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \
266 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
267 EVP_PKEY_OP_DERIVE, \
37659ea4 268 EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)(md))
0f113f3e
MC
269
270# define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \
271 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
272 EVP_PKEY_OP_DERIVE, \
37659ea4 273 EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)(pmd))
0f113f3e
MC
274
275# define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \
276 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
277 EVP_PKEY_OP_DERIVE, \
278 EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL)
279
280# define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \
281 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
282 EVP_PKEY_OP_DERIVE, \
37659ea4 283 EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)(plen))
0f113f3e
MC
284
285# define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \
286 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
287 EVP_PKEY_OP_DERIVE, \
37659ea4 288 EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)(p))
0f113f3e
MC
289
290# define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \
291 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
292 EVP_PKEY_OP_DERIVE, \
37659ea4 293 EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)(p))
0f113f3e
MC
294
295# define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1)
296# define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2)
297# define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3)
298# define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN (EVP_PKEY_ALG_CTRL + 4)
299# define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE (EVP_PKEY_ALG_CTRL + 5)
300# define EVP_PKEY_CTRL_DH_KDF_TYPE (EVP_PKEY_ALG_CTRL + 6)
301# define EVP_PKEY_CTRL_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 7)
302# define EVP_PKEY_CTRL_GET_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 8)
303# define EVP_PKEY_CTRL_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 9)
304# define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 10)
305# define EVP_PKEY_CTRL_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 11)
306# define EVP_PKEY_CTRL_GET_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 12)
307# define EVP_PKEY_CTRL_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 13)
308# define EVP_PKEY_CTRL_GET_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 14)
bd59f2b9
DSH
309
310/* KDF types */
0f113f3e 311# define EVP_PKEY_DH_KDF_NONE 1
e968561d 312# ifndef OPENSSL_NO_CMS
0f113f3e 313# define EVP_PKEY_DH_KDF_X9_42 2
e968561d 314# endif
3ba0885a 315
69588edb 316int ERR_load_DH_strings(void);
6d311938 317
0cd0a820 318# ifdef __cplusplus
d02b48c6 319}
0cd0a820 320# endif
3c27208f 321# endif
d02b48c6 322#endif