VirtualBox

source: vbox/trunk/src/libs/openssl-1.1.0g/include/openssl/dh.h@ 69890

Last change on this file since 69890 was 69890, checked in by vboxsync, 7 years ago

Added OpenSSL 1.1.0g with unneeded files removed, otherwise unmodified.
bugref:8070: src/libs maintenance
  • Property svn:eol-style set to native
File size: 14.3 KB
Line 
1/*
2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3 *
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
8 */
9
10#ifndef HEADER_DH_H
11# define HEADER_DH_H
12
13# include <openssl/opensslconf.h>
14
15# ifndef OPENSSL_NO_DH
16# include <openssl/e_os2.h>
17# include <openssl/bio.h>
18# include <openssl/asn1.h>
19# include <openssl/ossl_typ.h>
20# if OPENSSL_API_COMPAT < 0x10100000L
21# include <openssl/bn.h>
22# endif
23
24# ifdef __cplusplus
25extern "C" {
26# endif
27
28# ifndef OPENSSL_DH_MAX_MODULUS_BITS
29# define OPENSSL_DH_MAX_MODULUS_BITS 10000
30# endif
31
32# define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024
33
34# define DH_FLAG_CACHE_MONT_P 0x01
35
36# if OPENSSL_API_COMPAT < 0x10100000L
37/*
38 * Does nothing. Previously this switched off constant time behaviour.
39 */
40# define DH_FLAG_NO_EXP_CONSTTIME 0x00
41# endif
42
43/*
44 * If this flag is set the DH method is FIPS compliant and can be used in
45 * FIPS mode. This is set in the validated module method. If an application
46 * sets this flag in its own methods it is its responsibility to ensure the
47 * result is compliant.
48 */
49
50# define DH_FLAG_FIPS_METHOD 0x0400
51
52/*
53 * If this flag is set the operations normally disabled in FIPS mode are
54 * permitted it is then the applications responsibility to ensure that the
55 * usage is compliant.
56 */
57
58# define DH_FLAG_NON_FIPS_ALLOW 0x0400
59
60/* Already defined in ossl_typ.h */
61/* typedef struct dh_st DH; */
62/* typedef struct dh_method DH_METHOD; */
63
64DECLARE_ASN1_ITEM(DHparams)
65
66# define DH_GENERATOR_2 2
67/* #define DH_GENERATOR_3 3 */
68# define DH_GENERATOR_5 5
69
70/* DH_check error codes */
71# define DH_CHECK_P_NOT_PRIME 0x01
72# define DH_CHECK_P_NOT_SAFE_PRIME 0x02
73# define DH_UNABLE_TO_CHECK_GENERATOR 0x04
74# define DH_NOT_SUITABLE_GENERATOR 0x08
75# define DH_CHECK_Q_NOT_PRIME 0x10
76# define DH_CHECK_INVALID_Q_VALUE 0x20
77# define DH_CHECK_INVALID_J_VALUE 0x40
78
79/* DH_check_pub_key error codes */
80# define DH_CHECK_PUBKEY_TOO_SMALL 0x01
81# define DH_CHECK_PUBKEY_TOO_LARGE 0x02
82# define DH_CHECK_PUBKEY_INVALID 0x04
83
84/*
85 * primes p where (p-1)/2 is prime too are called "safe"; we define this for
86 * backward compatibility:
87 */
88# define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME
89
90# define d2i_DHparams_fp(fp,x) \
91 (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
92 (char *(*)())d2i_DHparams, \
93 (fp), \
94 (unsigned char **)(x))
95# define i2d_DHparams_fp(fp,x) \
96 ASN1_i2d_fp(i2d_DHparams,(fp), (unsigned char *)(x))
97# define d2i_DHparams_bio(bp,x) \
98 ASN1_d2i_bio_of(DH, DH_new, d2i_DHparams, bp, x)
99# define i2d_DHparams_bio(bp,x) \
100 ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
101
102# define d2i_DHxparams_fp(fp,x) \
103 (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
104 (char *(*)())d2i_DHxparams, \
105 (fp), \
106 (unsigned char **)(x))
107# define i2d_DHxparams_fp(fp,x) \
108 ASN1_i2d_fp(i2d_DHxparams,(fp), (unsigned char *)(x))
109# define d2i_DHxparams_bio(bp,x) \
110 ASN1_d2i_bio_of(DH, DH_new, d2i_DHxparams, bp, x)
111# define i2d_DHxparams_bio(bp,x) \
112 ASN1_i2d_bio_of_const(DH, i2d_DHxparams, bp, x)
113
114DH *DHparams_dup(DH *);
115
116const DH_METHOD *DH_OpenSSL(void);
117
118void DH_set_default_method(const DH_METHOD *meth);
119const DH_METHOD *DH_get_default_method(void);
120int DH_set_method(DH *dh, const DH_METHOD *meth);
121DH *DH_new_method(ENGINE *engine);
122
123DH *DH_new(void);
124void DH_free(DH *dh);
125int DH_up_ref(DH *dh);
126int DH_bits(const DH *dh);
127int DH_size(const DH *dh);
128int DH_security_bits(const DH *dh);
129#define DH_get_ex_new_index(l, p, newf, dupf, freef) \
130 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)
131int DH_set_ex_data(DH *d, int idx, void *arg);
132void *DH_get_ex_data(DH *d, int idx);
133
134/* Deprecated version */
135DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator,
136 void (*callback) (int, int,
137 void *),
138 void *cb_arg))
139
140/* New version */
141int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
142 BN_GENCB *cb);
143
144int DH_check_params(const DH *dh, int *ret);
145int DH_check(const DH *dh, int *codes);
146int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes);
147int DH_generate_key(DH *dh);
148int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
149int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh);
150DH *d2i_DHparams(DH **a, const unsigned char **pp, long length);
151int i2d_DHparams(const DH *a, unsigned char **pp);
152DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length);
153int i2d_DHxparams(const DH *a, unsigned char **pp);
154# ifndef OPENSSL_NO_STDIO
155int DHparams_print_fp(FILE *fp, const DH *x);
156# endif
157int DHparams_print(BIO *bp, const DH *x);
158
159/* RFC 5114 parameters */
160DH *DH_get_1024_160(void);
161DH *DH_get_2048_224(void);
162DH *DH_get_2048_256(void);
163
164# ifndef OPENSSL_NO_CMS
165/* RFC2631 KDF */
166int DH_KDF_X9_42(unsigned char *out, size_t outlen,
167 const unsigned char *Z, size_t Zlen,
168 ASN1_OBJECT *key_oid,
169 const unsigned char *ukm, size_t ukmlen, const EVP_MD *md);
170# endif
171
172void DH_get0_pqg(const DH *dh,
173 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
174int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);
175void DH_get0_key(const DH *dh,
176 const BIGNUM **pub_key, const BIGNUM **priv_key);
177int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);
178void DH_clear_flags(DH *dh, int flags);
179int DH_test_flags(const DH *dh, int flags);
180void DH_set_flags(DH *dh, int flags);
181ENGINE *DH_get0_engine(DH *d);
182long DH_get_length(const DH *dh);
183int DH_set_length(DH *dh, long length);
184
185DH_METHOD *DH_meth_new(const char *name, int flags);
186void DH_meth_free(DH_METHOD *dhm);
187DH_METHOD *DH_meth_dup(const DH_METHOD *dhm);
188const char *DH_meth_get0_name(const DH_METHOD *dhm);
189int DH_meth_set1_name(DH_METHOD *dhm, const char *name);
190int DH_meth_get_flags(DH_METHOD *dhm);
191int DH_meth_set_flags(DH_METHOD *dhm, int flags);
192void *DH_meth_get0_app_data(const DH_METHOD *dhm);
193int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data);
194int (*DH_meth_get_generate_key(const DH_METHOD *dhm)) (DH *);
195int DH_meth_set_generate_key(DH_METHOD *dhm, int (*generate_key) (DH *));
196int (*DH_meth_get_compute_key(const DH_METHOD *dhm))
197 (unsigned char *key, const BIGNUM *pub_key, DH *dh);
198int DH_meth_set_compute_key(DH_METHOD *dhm,
199 int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh));
200int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm))
201 (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
202 BN_CTX *, BN_MONT_CTX *);
203int DH_meth_set_bn_mod_exp(DH_METHOD *dhm,
204 int (*bn_mod_exp) (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *,
205 const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
206int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *);
207int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *));
208int (*DH_meth_get_finish(const DH_METHOD *dhm)) (DH *);
209int DH_meth_set_finish(DH_METHOD *dhm, int (*finish) (DH *));
210int (*DH_meth_get_generate_params(const DH_METHOD *dhm))
211 (DH *, int, int, BN_GENCB *);
212int DH_meth_set_generate_params(DH_METHOD *dhm,
213 int (*generate_params) (DH *, int, int, BN_GENCB *));
214
215
216# define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
217 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
218 EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
219
220# define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \
221 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
222 EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL)
223
224# define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \
225 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
226 EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL)
227
228# define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
229 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
230 EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
231
232# define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
233 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
234 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
235
236# define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
237 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
238 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
239
240# define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \
241 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
242 EVP_PKEY_OP_DERIVE, \
243 EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL)
244
245# define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \
246 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
247 EVP_PKEY_OP_DERIVE, \
248 EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL)
249
250# define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \
251 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
252 EVP_PKEY_OP_DERIVE, \
253 EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)oid)
254
255# define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \
256 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
257 EVP_PKEY_OP_DERIVE, \
258 EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)poid)
259
260# define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \
261 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
262 EVP_PKEY_OP_DERIVE, \
263 EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)md)
264
265# define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \
266 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
267 EVP_PKEY_OP_DERIVE, \
268 EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)pmd)
269
270# define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \
271 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
272 EVP_PKEY_OP_DERIVE, \
273 EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL)
274
275# define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \
276 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
277 EVP_PKEY_OP_DERIVE, \
278 EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)plen)
279
280# define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \
281 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
282 EVP_PKEY_OP_DERIVE, \
283 EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)p)
284
285# define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \
286 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
287 EVP_PKEY_OP_DERIVE, \
288 EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)p)
289
290# define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1)
291# define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2)
292# define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3)
293# define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN (EVP_PKEY_ALG_CTRL + 4)
294# define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE (EVP_PKEY_ALG_CTRL + 5)
295# define EVP_PKEY_CTRL_DH_KDF_TYPE (EVP_PKEY_ALG_CTRL + 6)
296# define EVP_PKEY_CTRL_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 7)
297# define EVP_PKEY_CTRL_GET_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 8)
298# define EVP_PKEY_CTRL_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 9)
299# define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 10)
300# define EVP_PKEY_CTRL_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 11)
301# define EVP_PKEY_CTRL_GET_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 12)
302# define EVP_PKEY_CTRL_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 13)
303# define EVP_PKEY_CTRL_GET_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 14)
304
305/* KDF types */
306# define EVP_PKEY_DH_KDF_NONE 1
307# ifndef OPENSSL_NO_CMS
308# define EVP_PKEY_DH_KDF_X9_42 2
309# endif
310
311/* BEGIN ERROR CODES */
312/*
313 * The following lines are auto generated by the script mkerr.pl. Any changes
314 * made after this point may be overwritten when the script is next run.
315 */
316
317int ERR_load_DH_strings(void);
318
319/* Error codes for the DH functions. */
320
321/* Function codes. */
322# define DH_F_COMPUTE_KEY 102
323# define DH_F_DHPARAMS_PRINT_FP 101
324# define DH_F_DH_BUILTIN_GENPARAMS 106
325# define DH_F_DH_CMS_DECRYPT 114
326# define DH_F_DH_CMS_SET_PEERKEY 115
327# define DH_F_DH_CMS_SET_SHARED_INFO 116
328# define DH_F_DH_METH_DUP 117
329# define DH_F_DH_METH_NEW 118
330# define DH_F_DH_METH_SET1_NAME 119
331# define DH_F_DH_NEW_METHOD 105
332# define DH_F_DH_PARAM_DECODE 107
333# define DH_F_DH_PRIV_DECODE 110
334# define DH_F_DH_PRIV_ENCODE 111
335# define DH_F_DH_PUB_DECODE 108
336# define DH_F_DH_PUB_ENCODE 109
337# define DH_F_DO_DH_PRINT 100
338# define DH_F_GENERATE_KEY 103
339# define DH_F_PKEY_DH_DERIVE 112
340# define DH_F_PKEY_DH_KEYGEN 113
341
342/* Reason codes. */
343# define DH_R_BAD_GENERATOR 101
344# define DH_R_BN_DECODE_ERROR 109
345# define DH_R_BN_ERROR 106
346# define DH_R_DECODE_ERROR 104
347# define DH_R_INVALID_PUBKEY 102
348# define DH_R_KDF_PARAMETER_ERROR 112
349# define DH_R_KEYS_NOT_SET 108
350# define DH_R_MODULUS_TOO_LARGE 103
351# define DH_R_NO_PARAMETERS_SET 107
352# define DH_R_NO_PRIVATE_VALUE 100
353# define DH_R_PARAMETER_ENCODING_ERROR 105
354# define DH_R_PEER_KEY_ERROR 111
355# define DH_R_SHARED_INFO_ERROR 113
356
357# ifdef __cplusplus
358}
359# endif
360# endif
361#endif
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette