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