bbe0902a53f07d4bc29f8ef750b16325c54e6c13
[openssl.git] / include / openssl / dsa.h
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 /*
59  * The DSS routines are based on patches supplied by
60  * Steven Schoch <schoch@sheba.arc.nasa.gov>.
61  */
62
63 #ifndef HEADER_DSA_H
64 # define HEADER_DSA_H
65
66 # include <openssl/opensslconf.h>
67
68 # ifndef OPENSSL_NO_DSA
69 # ifdef  __cplusplus
70 extern "C" {
71 # endif
72 # include <openssl/e_os2.h>
73 # include <openssl/bio.h>
74 # include <openssl/crypto.h>
75 # include <openssl/ossl_typ.h>
76 # include <openssl/opensslconf.h>
77 # include <openssl/bn.h>
78 # if OPENSSL_API_COMPAT < 0x10100000L
79 #  include <openssl/dh.h>
80 # endif
81
82 # ifndef OPENSSL_DSA_MAX_MODULUS_BITS
83 #  define OPENSSL_DSA_MAX_MODULUS_BITS   10000
84 # endif
85
86 # define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
87
88 # define DSA_FLAG_CACHE_MONT_P   0x01
89 /*
90  * new with 0.9.7h; the built-in DSA implementation now uses constant time
91  * modular exponentiation for secret exponents by default. This flag causes
92  * the faster variable sliding window method to be used for all exponents.
93  */
94 # define DSA_FLAG_NO_EXP_CONSTTIME       0x02
95
96 /*
97  * If this flag is set the DSA method is FIPS compliant and can be used in
98  * FIPS mode. This is set in the validated module method. If an application
99  * sets this flag in its own methods it is its reposibility to ensure the
100  * result is compliant.
101  */
102
103 # define DSA_FLAG_FIPS_METHOD                    0x0400
104
105 /*
106  * If this flag is set the operations normally disabled in FIPS mode are
107  * permitted it is then the applications responsibility to ensure that the
108  * usage is compliant.
109  */
110
111 # define DSA_FLAG_NON_FIPS_ALLOW                 0x0400
112 # define DSA_FLAG_FIPS_CHECKED                   0x0800
113
114 /* Already defined in ossl_typ.h */
115 /* typedef struct dsa_st DSA; */
116 /* typedef struct dsa_method DSA_METHOD; */
117
118 typedef struct DSA_SIG_st DSA_SIG;
119
120 # define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
121                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
122 # define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
123                 (unsigned char *)(x))
124 # define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
125 # define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
126
127 DSA *DSAparams_dup(DSA *x);
128 DSA_SIG *DSA_SIG_new(void);
129 void DSA_SIG_free(DSA_SIG *a);
130 int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
131 DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
132 void DSA_SIG_get0(BIGNUM **pr, BIGNUM **ps, const DSA_SIG *sig);
133
134 DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
135 int DSA_do_verify(const unsigned char *dgst, int dgst_len,
136                   DSA_SIG *sig, DSA *dsa);
137
138 const DSA_METHOD *DSA_OpenSSL(void);
139
140 void DSA_set_default_method(const DSA_METHOD *);
141 const DSA_METHOD *DSA_get_default_method(void);
142 int DSA_set_method(DSA *dsa, const DSA_METHOD *);
143 const DSA_METHOD *DSA_get_method(DSA *d);
144
145 DSA *DSA_new(void);
146 DSA *DSA_new_method(ENGINE *engine);
147 void DSA_free(DSA *r);
148 /* "up" the DSA object's reference count */
149 int DSA_up_ref(DSA *r);
150 int DSA_size(const DSA *);
151 int DSA_security_bits(const DSA *d);
152         /* next 4 return -1 on error */
153 int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
154 int DSA_sign(int type, const unsigned char *dgst, int dlen,
155              unsigned char *sig, unsigned int *siglen, DSA *dsa);
156 int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
157                const unsigned char *sigbuf, int siglen, DSA *dsa);
158 #define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
159     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
160 int DSA_set_ex_data(DSA *d, int idx, void *arg);
161 void *DSA_get_ex_data(DSA *d, int idx);
162
163 DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
164 DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
165 DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
166
167 /* Deprecated version */
168 DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
169                                                 unsigned char *seed,
170                                                 int seed_len,
171                                                 int *counter_ret,
172                                                 unsigned long *h_ret, void
173                                                  (*callback) (int, int,
174                                                               void *),
175                                                 void *cb_arg))
176
177 /* New version */
178 int DSA_generate_parameters_ex(DSA *dsa, int bits,
179                                const unsigned char *seed, int seed_len,
180                                int *counter_ret, unsigned long *h_ret,
181                                BN_GENCB *cb);
182
183 int DSA_generate_key(DSA *a);
184 int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
185 int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
186 int i2d_DSAparams(const DSA *a, unsigned char **pp);
187
188 int DSAparams_print(BIO *bp, const DSA *x);
189 int DSA_print(BIO *bp, const DSA *x, int off);
190 # ifndef OPENSSL_NO_STDIO
191 int DSAparams_print_fp(FILE *fp, const DSA *x);
192 int DSA_print_fp(FILE *bp, const DSA *x, int off);
193 # endif
194
195 # define DSS_prime_checks 50
196 /*
197  * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of
198  * Rabin-Miller
199  */
200 # define DSA_is_prime(n, callback, cb_arg) \
201         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
202
203 # ifndef OPENSSL_NO_DH
204 /*
205  * Convert DSA structure (key or just parameters) into DH structure (be
206  * careful to avoid small subgroup attacks when using this!)
207  */
208 DH *DSA_dup_DH(const DSA *r);
209 # endif
210
211 # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
212         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
213                                 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
214
215 # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS         (EVP_PKEY_ALG_CTRL + 1)
216 # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS       (EVP_PKEY_ALG_CTRL + 2)
217 # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD           (EVP_PKEY_ALG_CTRL + 3)
218
219 void DSA_get0_pqg(const DSA *d, BIGNUM **p, BIGNUM **q, BIGNUM **g);
220 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
221 void DSA_get0_key(const DSA *d, BIGNUM **pub_key, BIGNUM **priv_key);
222 int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
223 void DSA_clear_flags(DSA *d, int flags);
224 int DSA_test_flags(const DSA *d, int flags);
225 void DSA_set_flags(DSA *d, int flags);
226 ENGINE *DSA_get0_engine(DSA *d);
227
228 DSA_METHOD *DSA_meth_new(const char *name, int flags);
229 void DSA_meth_free(DSA_METHOD *dsam);
230 DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam);
231 const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
232 int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
233 int DSA_meth_get_flags(DSA_METHOD *dsam);
234 int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
235 void *DSA_meth_get_app_data(const DSA_METHOD *dsam);
236 int DSA_meth_set_app_data(DSA_METHOD *dsam, void *app_data);
237 DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
238         (const unsigned char *, int, DSA *);
239 int DSA_meth_set_sign(DSA_METHOD *dsam,
240                        DSA_SIG *(*sign) (const unsigned char *, int, DSA *));
241 int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
242         (DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
243 int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
244         int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
245 int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
246         (const unsigned char *, int , DSA_SIG *, DSA *);
247 int DSA_meth_set_verify(DSA_METHOD *dsam,
248     int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *));
249 int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
250         (DSA *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *,
251          BN_CTX *, BN_MONT_CTX *);
252 int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
253     int (*mod_exp) (DSA *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *,
254                     BIGNUM *, BN_CTX *, BN_MONT_CTX *));
255 int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
256     (DSA *, BIGNUM *, BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
257      BN_MONT_CTX *);
258 int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
259     int (*bn_mod_exp) (DSA *, BIGNUM *, BIGNUM *, const BIGNUM *,
260                        const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
261 int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
262 int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
263 int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *);
264 int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *));
265 int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
266         (DSA *, int, const unsigned char *, int, int *, unsigned long *,
267          BN_GENCB *);
268 int DSA_meth_set_paramgen(DSA_METHOD *dsam,
269         int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
270                          unsigned long *, BN_GENCB *));
271 int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *);
272 int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *));
273
274 /* BEGIN ERROR CODES */
275 /*
276  * The following lines are auto generated by the script mkerr.pl. Any changes
277  * made after this point may be overwritten when the script is next run.
278  */
279 void ERR_load_DSA_strings(void);
280
281 /* Error codes for the DSA functions. */
282
283 /* Function codes. */
284 # define DSA_F_D2I_DSA_SIG                                110
285 # define DSA_F_DO_DSA_PRINT                               104
286 # define DSA_F_DSAPARAMS_PRINT                            100
287 # define DSA_F_DSAPARAMS_PRINT_FP                         101
288 # define DSA_F_DSA_BUILTIN_KEYGEN                         124
289 # define DSA_F_DSA_BUILTIN_PARAMGEN                       125
290 # define DSA_F_DSA_BUILTIN_PARAMGEN2                      126
291 # define DSA_F_DSA_DO_SIGN                                112
292 # define DSA_F_DSA_DO_VERIFY                              113
293 # define DSA_F_DSA_NEW_METHOD                             103
294 # define DSA_F_DSA_PARAM_DECODE                           119
295 # define DSA_F_DSA_PRINT_FP                               105
296 # define DSA_F_DSA_PRIV_DECODE                            115
297 # define DSA_F_DSA_PRIV_ENCODE                            116
298 # define DSA_F_DSA_PUB_DECODE                             117
299 # define DSA_F_DSA_PUB_ENCODE                             118
300 # define DSA_F_DSA_SIGN                                   106
301 # define DSA_F_DSA_SIGN_SETUP                             107
302 # define DSA_F_DSA_SIG_NEW                                109
303 # define DSA_F_DSA_SIG_PRINT                              123
304 # define DSA_F_DSA_VERIFY                                 108
305 # define DSA_F_I2D_DSA_SIG                                111
306 # define DSA_F_OLD_DSA_PRIV_DECODE                        122
307 # define DSA_F_PKEY_DSA_CTRL                              120
308 # define DSA_F_PKEY_DSA_KEYGEN                            121
309 # define DSA_F_SIG_CB                                     114
310
311 /* Reason codes. */
312 # define DSA_R_BAD_Q_VALUE                                102
313 # define DSA_R_BN_DECODE_ERROR                            108
314 # define DSA_R_BN_ERROR                                   109
315 # define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                100
316 # define DSA_R_DECODE_ERROR                               104
317 # define DSA_R_INVALID_DIGEST_TYPE                        106
318 # define DSA_R_INVALID_PARAMETERS                         112
319 # define DSA_R_KEY_SIZE_TOO_SMALL                         111
320 # define DSA_R_MISSING_PARAMETERS                         101
321 # define DSA_R_MODULUS_TOO_LARGE                          103
322 # define DSA_R_NEED_NEW_SETUP_VALUES                      110
323 # define DSA_R_NO_PARAMETERS_SET                          107
324 # define DSA_R_PARAMETER_ENCODING_ERROR                   105
325 # define DSA_R_Q_NOT_PRIME                                113
326
327 # ifdef  __cplusplus
328 }
329 # endif
330 # endif
331
332 #endif