]>
Commit | Line | Data |
---|---|---|
d02b48c6 | 1 | /* crypto/dsa/dsa.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. | |
0f113f3e | 8 | * |
d02b48c6 RE |
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). | |
0f113f3e | 15 | * |
d02b48c6 RE |
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. | |
0f113f3e | 22 | * |
d02b48c6 RE |
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 :-). | |
0f113f3e | 37 | * 4. If you include any Windows specific code (or a derivative thereof) from |
d02b48c6 RE |
38 | * the apps directory (application code) you must include an acknowledgement: |
39 | * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" | |
0f113f3e | 40 | * |
d02b48c6 RE |
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. | |
0f113f3e | 52 | * |
d02b48c6 RE |
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 | /* | |
60 | * The DSS routines are based on patches supplied by | |
b0700d2c RS |
61 | * Steven Schoch <schoch@sheba.arc.nasa.gov>. |
62 | */ | |
d02b48c6 RE |
63 | |
64 | #ifndef HEADER_DSA_H | |
0f113f3e | 65 | # define HEADER_DSA_H |
d02b48c6 | 66 | |
0f113f3e | 67 | # include <openssl/e_os2.h> |
751ff1d3 | 68 | |
0f113f3e MC |
69 | # ifdef OPENSSL_NO_DSA |
70 | # error DSA is disabled. | |
71 | # endif | |
f5d7a031 | 72 | |
a00ae6c4 | 73 | # include <openssl/bio.h> |
0f113f3e MC |
74 | # include <openssl/crypto.h> |
75 | # include <openssl/ossl_typ.h> | |
60a938c6 | 76 | |
0f113f3e MC |
77 | # ifdef OPENSSL_USE_DEPRECATED |
78 | # include <openssl/bn.h> | |
79 | # ifndef OPENSSL_NO_DH | |
80 | # include <openssl/dh.h> | |
81 | # endif | |
82 | # endif | |
d02b48c6 | 83 | |
0f113f3e MC |
84 | # ifndef OPENSSL_DSA_MAX_MODULUS_BITS |
85 | # define OPENSSL_DSA_MAX_MODULUS_BITS 10000 | |
86 | # endif | |
87 | ||
88 | # define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024 | |
5e3225cc | 89 | |
0f113f3e MC |
90 | # define DSA_FLAG_CACHE_MONT_P 0x01 |
91 | /* | |
92 | * new with 0.9.7h; the built-in DSA implementation now uses constant time | |
93 | * modular exponentiation for secret exponents by default. This flag causes | |
94 | * the faster variable sliding window method to be used for all exponents. | |
68d39f3c | 95 | */ |
0f113f3e | 96 | # define DSA_FLAG_NO_EXP_CONSTTIME 0x02 |
dfeab068 | 97 | |
0f113f3e MC |
98 | /* |
99 | * If this flag is set the DSA method is FIPS compliant and can be used in | |
100 | * FIPS mode. This is set in the validated module method. If an application | |
101 | * sets this flag in its own methods it is its reposibility to ensure the | |
102 | * result is compliant. | |
20818e00 DSH |
103 | */ |
104 | ||
0f113f3e | 105 | # define DSA_FLAG_FIPS_METHOD 0x0400 |
20818e00 | 106 | |
0f113f3e MC |
107 | /* |
108 | * If this flag is set the operations normally disabled in FIPS mode are | |
20818e00 DSH |
109 | * permitted it is then the applications responsibility to ensure that the |
110 | * usage is compliant. | |
111 | */ | |
112 | ||
0f113f3e MC |
113 | # define DSA_FLAG_NON_FIPS_ALLOW 0x0400 |
114 | # define DSA_FLAG_FIPS_CHECKED 0x0800 | |
20818e00 | 115 | |
82271cee RL |
116 | #ifdef __cplusplus |
117 | extern "C" { | |
118 | #endif | |
119 | ||
3a87a9b9 GT |
120 | /* Already defined in ossl_typ.h */ |
121 | /* typedef struct dsa_st DSA; */ | |
122 | /* typedef struct dsa_method DSA_METHOD; */ | |
c0711f7f | 123 | |
0f113f3e MC |
124 | typedef struct DSA_SIG_st { |
125 | BIGNUM *r; | |
126 | BIGNUM *s; | |
127 | } DSA_SIG; | |
128 | ||
129 | struct dsa_method { | |
130 | const char *name; | |
131 | DSA_SIG *(*dsa_do_sign) (const unsigned char *dgst, int dlen, DSA *dsa); | |
132 | int (*dsa_sign_setup) (DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, | |
133 | BIGNUM **rp); | |
134 | int (*dsa_do_verify) (const unsigned char *dgst, int dgst_len, | |
135 | DSA_SIG *sig, DSA *dsa); | |
136 | int (*dsa_mod_exp) (DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1, | |
137 | BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx, | |
138 | BN_MONT_CTX *in_mont); | |
139 | /* Can be null */ | |
140 | int (*bn_mod_exp) (DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p, | |
141 | const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); | |
142 | int (*init) (DSA *dsa); | |
143 | int (*finish) (DSA *dsa); | |
144 | int flags; | |
145 | char *app_data; | |
146 | /* If this is non-NULL, it is used to generate DSA parameters */ | |
147 | int (*dsa_paramgen) (DSA *dsa, int bits, | |
148 | const unsigned char *seed, int seed_len, | |
149 | int *counter_ret, unsigned long *h_ret, | |
150 | BN_GENCB *cb); | |
151 | /* If this is non-NULL, it is used to generate DSA keys */ | |
152 | int (*dsa_keygen) (DSA *dsa); | |
153 | }; | |
154 | ||
155 | struct dsa_st { | |
156 | /* | |
157 | * This first variable is used to pick up errors where a DSA is passed | |
158 | * instead of of a EVP_PKEY | |
159 | */ | |
160 | int pad; | |
161 | long version; | |
0f113f3e MC |
162 | BIGNUM *p; |
163 | BIGNUM *q; /* == 20 */ | |
164 | BIGNUM *g; | |
165 | BIGNUM *pub_key; /* y public key */ | |
166 | BIGNUM *priv_key; /* x private key */ | |
167 | BIGNUM *kinv; /* Signing pre-calc */ | |
168 | BIGNUM *r; /* Signing pre-calc */ | |
169 | int flags; | |
170 | /* Normally used to cache montgomery values */ | |
171 | BN_MONT_CTX *method_mont_p; | |
172 | int references; | |
173 | CRYPTO_EX_DATA ex_data; | |
174 | const DSA_METHOD *meth; | |
175 | /* functional reference if 'meth' is ENGINE-provided */ | |
176 | ENGINE *engine; | |
177 | }; | |
178 | ||
179 | # define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \ | |
180 | (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x)) | |
181 | # define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \ | |
182 | (unsigned char *)(x)) | |
183 | # define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x) | |
184 | # define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x) | |
d02b48c6 | 185 | |
f4274da1 | 186 | DSA *DSAparams_dup(DSA *x); |
0f113f3e MC |
187 | DSA_SIG *DSA_SIG_new(void); |
188 | void DSA_SIG_free(DSA_SIG *a); | |
189 | int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp); | |
190 | DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length); | |
a8da8918 | 191 | |
0f113f3e MC |
192 | DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa); |
193 | int DSA_do_verify(const unsigned char *dgst, int dgst_len, | |
194 | DSA_SIG *sig, DSA *dsa); | |
a8da8918 | 195 | |
a4aba800 | 196 | const DSA_METHOD *DSA_OpenSSL(void); |
c0711f7f | 197 | |
0f113f3e | 198 | void DSA_set_default_method(const DSA_METHOD *); |
cb78486d | 199 | const DSA_METHOD *DSA_get_default_method(void); |
0f113f3e | 200 | int DSA_set_method(DSA *dsa, const DSA_METHOD *); |
f8463356 | 201 | |
0f113f3e MC |
202 | DSA *DSA_new(void); |
203 | DSA *DSA_new_method(ENGINE *engine); | |
204 | void DSA_free(DSA *r); | |
5cbc2e8b | 205 | /* "up" the DSA object's reference count */ |
0f113f3e MC |
206 | int DSA_up_ref(DSA *r); |
207 | int DSA_size(const DSA *); | |
208 | int DSA_security_bits(const DSA *d); | |
209 | /* next 4 return -1 on error */ | |
210 | int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp); | |
211 | int DSA_sign(int type, const unsigned char *dgst, int dlen, | |
212 | unsigned char *sig, unsigned int *siglen, DSA *dsa); | |
213 | int DSA_verify(int type, const unsigned char *dgst, int dgst_len, | |
214 | const unsigned char *sigbuf, int siglen, DSA *dsa); | |
e6390aca RS |
215 | #define DSA_get_ex_new_index(l, p, newf, dupf, freef) \ |
216 | CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef) | |
dd9d233e DSH |
217 | int DSA_set_ex_data(DSA *d, int idx, void *arg); |
218 | void *DSA_get_ex_data(DSA *d, int idx); | |
d02b48c6 | 219 | |
0f113f3e MC |
220 | DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length); |
221 | DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length); | |
222 | DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length); | |
e9224c71 GT |
223 | |
224 | /* Deprecated version */ | |
0f113f3e MC |
225 | # ifdef OPENSSL_USE_DEPRECATED |
226 | DECLARE_DEPRECATED(DSA *DSA_generate_parameters(int bits, | |
227 | unsigned char *seed, | |
228 | int seed_len, | |
229 | int *counter_ret, | |
230 | unsigned long *h_ret, void | |
231 | (*callback) (int, int, | |
232 | void *), | |
233 | void *cb_arg)); | |
234 | # endif /* defined(OPENSSL_USE_DEPRECATED) */ | |
e9224c71 GT |
235 | |
236 | /* New version */ | |
0f113f3e MC |
237 | int DSA_generate_parameters_ex(DSA *dsa, int bits, |
238 | const unsigned char *seed, int seed_len, | |
239 | int *counter_ret, unsigned long *h_ret, | |
240 | BN_GENCB *cb); | |
241 | ||
242 | int DSA_generate_key(DSA *a); | |
243 | int i2d_DSAPublicKey(const DSA *a, unsigned char **pp); | |
244 | int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp); | |
245 | int i2d_DSAparams(const DSA *a, unsigned char **pp); | |
246 | ||
0f113f3e MC |
247 | int DSAparams_print(BIO *bp, const DSA *x); |
248 | int DSA_print(BIO *bp, const DSA *x, int off); | |
0f113f3e MC |
249 | # ifndef OPENSSL_NO_STDIO |
250 | int DSAparams_print_fp(FILE *fp, const DSA *x); | |
251 | int DSA_print_fp(FILE *bp, const DSA *x, int off); | |
252 | # endif | |
253 | ||
254 | # define DSS_prime_checks 50 | |
255 | /* | |
256 | * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of | |
257 | * Rabin-Miller | |
258 | */ | |
259 | # define DSA_is_prime(n, callback, cb_arg) \ | |
260 | BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg) | |
d02b48c6 | 261 | |
0f113f3e MC |
262 | # ifndef OPENSSL_NO_DH |
263 | /* | |
264 | * Convert DSA structure (key or just parameters) into DH structure (be | |
265 | * careful to avoid small subgroup attacks when using this!) | |
266 | */ | |
a4aba800 | 267 | DH *DSA_dup_DH(const DSA *r); |
0f113f3e | 268 | # endif |
48c843c3 | 269 | |
0f113f3e MC |
270 | # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \ |
271 | EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ | |
272 | EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL) | |
c927df3f | 273 | |
0f113f3e MC |
274 | # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1) |
275 | # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2) | |
276 | # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3) | |
c927df3f | 277 | |
d02b48c6 | 278 | /* BEGIN ERROR CODES */ |
0f113f3e MC |
279 | /* |
280 | * The following lines are auto generated by the script mkerr.pl. Any changes | |
6d311938 DSH |
281 | * made after this point may be overwritten when the script is next run. |
282 | */ | |
c962479b | 283 | void ERR_load_DSA_strings(void); |
6d311938 | 284 | |
d02b48c6 RE |
285 | /* Error codes for the DSA functions. */ |
286 | ||
287 | /* Function codes. */ | |
0f113f3e MC |
288 | # define DSA_F_D2I_DSA_SIG 110 |
289 | # define DSA_F_DO_DSA_PRINT 104 | |
290 | # define DSA_F_DSAPARAMS_PRINT 100 | |
291 | # define DSA_F_DSAPARAMS_PRINT_FP 101 | |
292 | # define DSA_F_DSA_BUILTIN_KEYGEN 124 | |
293 | # define DSA_F_DSA_BUILTIN_PARAMGEN 125 | |
294 | # define DSA_F_DSA_BUILTIN_PARAMGEN2 126 | |
295 | # define DSA_F_DSA_DO_SIGN 112 | |
296 | # define DSA_F_DSA_DO_VERIFY 113 | |
297 | # define DSA_F_DSA_NEW_METHOD 103 | |
298 | # define DSA_F_DSA_PARAM_DECODE 119 | |
299 | # define DSA_F_DSA_PRINT_FP 105 | |
300 | # define DSA_F_DSA_PRIV_DECODE 115 | |
301 | # define DSA_F_DSA_PRIV_ENCODE 116 | |
302 | # define DSA_F_DSA_PUB_DECODE 117 | |
303 | # define DSA_F_DSA_PUB_ENCODE 118 | |
304 | # define DSA_F_DSA_SIGN 106 | |
305 | # define DSA_F_DSA_SIGN_SETUP 107 | |
306 | # define DSA_F_DSA_SIG_NEW 109 | |
307 | # define DSA_F_DSA_SIG_PRINT 123 | |
308 | # define DSA_F_DSA_VERIFY 108 | |
309 | # define DSA_F_I2D_DSA_SIG 111 | |
310 | # define DSA_F_OLD_DSA_PRIV_DECODE 122 | |
311 | # define DSA_F_PKEY_DSA_CTRL 120 | |
312 | # define DSA_F_PKEY_DSA_KEYGEN 121 | |
313 | # define DSA_F_SIG_CB 114 | |
d02b48c6 RE |
314 | |
315 | /* Reason codes. */ | |
0f113f3e MC |
316 | # define DSA_R_BAD_Q_VALUE 102 |
317 | # define DSA_R_BN_DECODE_ERROR 108 | |
318 | # define DSA_R_BN_ERROR 109 | |
319 | # define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100 | |
320 | # define DSA_R_DECODE_ERROR 104 | |
321 | # define DSA_R_INVALID_DIGEST_TYPE 106 | |
322 | # define DSA_R_INVALID_PARAMETERS 112 | |
323 | # define DSA_R_KEY_SIZE_TOO_SMALL 111 | |
324 | # define DSA_R_MISSING_PARAMETERS 101 | |
325 | # define DSA_R_MODULUS_TOO_LARGE 103 | |
326 | # define DSA_R_NEED_NEW_SETUP_VALUES 110 | |
327 | # define DSA_R_NO_PARAMETERS_SET 107 | |
328 | # define DSA_R_PARAMETER_ENCODING_ERROR 105 | |
329 | # define DSA_R_Q_NOT_PRIME 113 | |
6d311938 | 330 | |
d02b48c6 RE |
331 | #ifdef __cplusplus |
332 | } | |
333 | #endif | |
334 | #endif |