]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/dh/dh.h
Initial experimental support for X9.42 DH parameter format to handle
[thirdparty/openssl.git] / crypto / dh / dh.h
CommitLineData
d02b48c6 1/* crypto/dh/dh.h */
58964a49 2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6
RE
3 * All rights reserved.
4 *
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.
8 *
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).
15 *
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.
22 *
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
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)"
40 *
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
51 * SUCH DAMAGE.
52 *
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.]
57 */
58
59#ifndef HEADER_DH_H
60#define HEADER_DH_H
61
d3ae5b1c
RL
62#include <openssl/e_os2.h>
63
cf1b7d96 64#ifdef OPENSSL_NO_DH
f5d7a031
UM
65#error DH is disabled.
66#endif
67
cf1b7d96 68#ifndef OPENSSL_NO_BIO
ef33b970
RL
69#include <openssl/bio.h>
70#endif
2aa9043a 71#include <openssl/ossl_typ.h>
0f814687
GT
72#ifndef OPENSSL_NO_DEPRECATED
73#include <openssl/bn.h>
74#endif
2fb50a29 75
5e3225cc
BM
76#ifndef OPENSSL_DH_MAX_MODULUS_BITS
77# define OPENSSL_DH_MAX_MODULUS_BITS 10000
78#endif
79
83c3410b
DSH
80#define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024
81
46a64376
BM
82#define DH_FLAG_CACHE_MONT_P 0x01
83#define DH_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DH
84 * implementation now uses constant time
85 * modular exponentiation for secret exponents
86 * by default. This flag causes the
87 * faster variable sliding window method to
88 * be used for all exponents.
89 */
dfeab068 90
4960411e
DSH
91/* If this flag is set the DH method is FIPS compliant and can be used
92 * in FIPS mode. This is set in the validated module method. If an
93 * application sets this flag in its own methods it is its reposibility
94 * to ensure the result is compliant.
95 */
96
97#define DH_FLAG_FIPS_METHOD 0x0400
98
99/* If this flag is set the operations normally disabled in FIPS mode are
100 * permitted it is then the applications responsibility to ensure that the
101 * usage is compliant.
102 */
103
104#define DH_FLAG_NON_FIPS_ALLOW 0x0400
105
82271cee
RL
106#ifdef __cplusplus
107extern "C" {
108#endif
109
3a87a9b9
GT
110/* Already defined in ossl_typ.h */
111/* typedef struct dh_st DH; */
112/* typedef struct dh_method DH_METHOD; */
13066cee 113
3a87a9b9
GT
114struct dh_method
115 {
13066cee
DSH
116 const char *name;
117 /* Methods here */
118 int (*generate_key)(DH *dh);
f971ccb2
RL
119 int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh);
120 int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
121 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
13066cee
DSH
122 BN_MONT_CTX *m_ctx); /* Can be null */
123
124 int (*init)(DH *dh);
125 int (*finish)(DH *dh);
126 int flags;
127 char *app_data;
0e4aa0d2
GT
128 /* If this is non-NULL, it will be used to generate parameters */
129 int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb);
3a87a9b9 130 };
13066cee
DSH
131
132struct dh_st
d02b48c6
RE
133 {
134 /* This first argument is used to pick up errors when
135 * a DH is passed instead of a EVP_PKEY */
136 int pad;
137 int version;
138 BIGNUM *p;
139 BIGNUM *g;
2c2f9e2c 140 long length; /* optional */
4486d0cd 141 BIGNUM *pub_key; /* g^x */
d02b48c6 142 BIGNUM *priv_key; /* x */
dfeab068
RE
143
144 int flags;
879b1980 145 BN_MONT_CTX *method_mont_p;
13066cee
DSH
146 /* Place holders if we want to do X9.42 DH */
147 BIGNUM *q;
148 BIGNUM *j;
90644dd7 149 unsigned char *seed;
13066cee
DSH
150 int seedlen;
151 BIGNUM *counter;
152
153 int references;
154 CRYPTO_EX_DATA ex_data;
cb78486d
GT
155 const DH_METHOD *meth;
156 ENGINE *engine;
13066cee 157 };
d02b48c6
RE
158
159#define DH_GENERATOR_2 2
160/* #define DH_GENERATOR_3 3 */
161#define DH_GENERATOR_5 5
162
163/* DH_check error codes */
164#define DH_CHECK_P_NOT_PRIME 0x01
4486d0cd 165#define DH_CHECK_P_NOT_SAFE_PRIME 0x02
d02b48c6
RE
166#define DH_UNABLE_TO_CHECK_GENERATOR 0x04
167#define DH_NOT_SUITABLE_GENERATOR 0x08
07981709
DSH
168#define DH_CHECK_Q_NOT_PRIME 0x10
169#define DH_CHECK_INVALID_Q_VALUE 0x20
170#define DH_CHECK_INVALID_J_VALUE 0x40
d02b48c6 171
bf3d6c0c
BL
172/* DH_check_pub_key error codes */
173#define DH_CHECK_PUBKEY_TOO_SMALL 0x01
174#define DH_CHECK_PUBKEY_TOO_LARGE 0x02
175
4486d0cd
UM
176/* primes p where (p-1)/2 is prime too are called "safe"; we define
177 this for backward compatibility: */
178#define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME
179
d02b48c6
RE
180#define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
181 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
182#define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
183 (unsigned char *)(x))
41a15c4f
BL
184#define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
185#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
d02b48c6 186
f4274da1
DSH
187DH *DHparams_dup(DH *);
188
f971ccb2 189const DH_METHOD *DH_OpenSSL(void);
13066cee 190
83c3410b
DSH
191#ifdef OPENSSL_FIPS
192DH * FIPS_dh_new(void);
193void FIPS_dh_free(DH *dh);
194#endif
195
cb78486d
GT
196void DH_set_default_method(const DH_METHOD *meth);
197const DH_METHOD *DH_get_default_method(void);
198int DH_set_method(DH *dh, const DH_METHOD *meth);
199DH *DH_new_method(ENGINE *engine);
13066cee 200
d02b48c6
RE
201DH * DH_new(void);
202void DH_free(DH *dh);
dc2a33d6 203int DH_up_ref(DH *dh);
f971ccb2 204int DH_size(const DH *dh);
dd9d233e
DSH
205int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
206 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
207int DH_set_ex_data(DH *d, int idx, void *arg);
208void *DH_get_ex_data(DH *d, int idx);
e9224c71
GT
209
210/* Deprecated version */
211#ifndef OPENSSL_NO_DEPRECATED
d02b48c6 212DH * DH_generate_parameters(int prime_len,int generator,
b4f76582 213 void (*callback)(int,int,void *),void *cb_arg);
e9224c71
GT
214#endif /* !defined(OPENSSL_NO_DEPRECATED) */
215
216/* New version */
217int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
218
f971ccb2 219int DH_check(const DH *dh,int *codes);
bf3d6c0c 220int DH_check_pub_key(const DH *dh,const BIGNUM *pub_key, int *codes);
d02b48c6 221int DH_generate_key(DH *dh);
f971ccb2 222int DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
bc91494e 223int DH_compute_key_padded(unsigned char *key,const BIGNUM *pub_key,DH *dh);
6343829a 224DH * d2i_DHparams(DH **a,const unsigned char **pp, long length);
f971ccb2 225int i2d_DHparams(const DH *a,unsigned char **pp);
afb14cda
DSH
226DH * d2i_DHxparams(DH **a,const unsigned char **pp, long length);
227int i2d_DHxparams(const DH *a,unsigned char **pp);
cf1b7d96 228#ifndef OPENSSL_NO_FP_API
f971ccb2 229int DHparams_print_fp(FILE *fp, const DH *x);
d02b48c6 230#endif
cf1b7d96 231#ifndef OPENSSL_NO_BIO
f971ccb2 232int DHparams_print(BIO *bp, const DH *x);
d02b48c6 233#else
f971ccb2 234int DHparams_print(char *bp, const DH *x);
d02b48c6 235#endif
d02b48c6 236
20bee968
DSH
237/* RFC 5114 parameters */
238DH *DH_get_1024_160(void);
239DH *DH_get_2048_224(void);
240DH *DH_get_2048_256(void);
241
3ba0885a
DSH
242#define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
243 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
244 EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
245
246#define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
247 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
248 EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
249
afb14cda
DSH
250#define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
251 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
252 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
253
254#define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
255 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
256 EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
257
3ba0885a
DSH
258#define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1)
259#define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2)
afb14cda 260#define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3)
3ba0885a
DSH
261
262
d02b48c6 263/* BEGIN ERROR CODES */
6d311938
DSH
264/* The following lines are auto generated by the script mkerr.pl. Any changes
265 * made after this point may be overwritten when the script is next run.
266 */
b476df64 267void ERR_load_DH_strings(void);
6d311938 268
d02b48c6
RE
269/* Error codes for the DH functions. */
270
271/* Function codes. */
aa4ce731 272#define DH_F_COMPUTE_KEY 102
d02b48c6 273#define DH_F_DHPARAMS_PRINT_FP 101
aa4ce731 274#define DH_F_DH_BUILTIN_GENPARAMS 106
0c372b94 275#define DH_F_DH_NEW_METHOD 105
3e4585c8 276#define DH_F_DH_PARAM_DECODE 107
4c97a04e
DSH
277#define DH_F_DH_PRIV_DECODE 110
278#define DH_F_DH_PRIV_ENCODE 111
ceb46789
DSH
279#define DH_F_DH_PUB_DECODE 108
280#define DH_F_DH_PUB_ENCODE 109
47a9d527 281#define DH_F_DO_DH_PRINT 100
aa4ce731
BM
282#define DH_F_GENERATE_KEY 103
283#define DH_F_GENERATE_PARAMETERS 104
ffb1ac67 284#define DH_F_PKEY_DH_DERIVE 112
3ba0885a 285#define DH_F_PKEY_DH_KEYGEN 113
d02b48c6
RE
286
287/* Reason codes. */
82652aaf 288#define DH_R_BAD_GENERATOR 101
5e3225cc 289#define DH_R_BN_DECODE_ERROR 109
4c97a04e 290#define DH_R_BN_ERROR 106
ceb46789 291#define DH_R_DECODE_ERROR 104
bf3d6c0c 292#define DH_R_INVALID_PUBKEY 102
ffb1ac67 293#define DH_R_KEYS_NOT_SET 108
83c3410b 294#define DH_R_KEY_SIZE_TOO_SMALL 110
5e3225cc 295#define DH_R_MODULUS_TOO_LARGE 103
52c11dce 296#define DH_R_NO_PARAMETERS_SET 107
3e4585c8 297#define DH_R_NO_PRIVATE_VALUE 100
ceb46789 298#define DH_R_PARAMETER_ENCODING_ERROR 105
6d311938 299
d02b48c6
RE
300#ifdef __cplusplus
301}
302#endif
303#endif