d0b631504d98751026c6362b15f896ebd45f6ebc
[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 # if OPENSSL_API_COMPAT < 0x10100000L
78 #  include <openssl/bn.h>
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 struct dsa_method {
121     const char *name;
122     DSA_SIG *(*dsa_do_sign) (const unsigned char *dgst, int dlen, DSA *dsa);
123     int (*dsa_sign_setup) (DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
124                            BIGNUM **rp);
125     int (*dsa_do_verify) (const unsigned char *dgst, int dgst_len,
126                           DSA_SIG *sig, DSA *dsa);
127     int (*dsa_mod_exp) (DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
128                         BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
129                         BN_MONT_CTX *in_mont);
130     /* Can be null */
131     int (*bn_mod_exp) (DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
132                        const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
133     int (*init) (DSA *dsa);
134     int (*finish) (DSA *dsa);
135     int flags;
136     char *app_data;
137     /* If this is non-NULL, it is used to generate DSA parameters */
138     int (*dsa_paramgen) (DSA *dsa, int bits,
139                          const unsigned char *seed, int seed_len,
140                          int *counter_ret, unsigned long *h_ret,
141                          BN_GENCB *cb);
142     /* If this is non-NULL, it is used to generate DSA keys */
143     int (*dsa_keygen) (DSA *dsa);
144 };
145
146 # define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
147                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
148 # define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
149                 (unsigned char *)(x))
150 # define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
151 # define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
152
153 DSA *DSAparams_dup(DSA *x);
154 DSA_SIG *DSA_SIG_new(void);
155 void DSA_SIG_free(DSA_SIG *a);
156 int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
157 DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
158 void DSA_SIG_get0(BIGNUM **pr, BIGNUM **ps, const DSA_SIG *sig);
159
160 DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
161 int DSA_do_verify(const unsigned char *dgst, int dgst_len,
162                   DSA_SIG *sig, DSA *dsa);
163
164 const DSA_METHOD *DSA_OpenSSL(void);
165
166 void DSA_set_default_method(const DSA_METHOD *);
167 const DSA_METHOD *DSA_get_default_method(void);
168 int DSA_set_method(DSA *dsa, const DSA_METHOD *);
169
170 DSA *DSA_new(void);
171 DSA *DSA_new_method(ENGINE *engine);
172 void DSA_free(DSA *r);
173 /* "up" the DSA object's reference count */
174 int DSA_up_ref(DSA *r);
175 int DSA_size(const DSA *);
176 int DSA_security_bits(const DSA *d);
177         /* next 4 return -1 on error */
178 int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
179 int DSA_sign(int type, const unsigned char *dgst, int dlen,
180              unsigned char *sig, unsigned int *siglen, DSA *dsa);
181 int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
182                const unsigned char *sigbuf, int siglen, DSA *dsa);
183 #define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
184     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
185 int DSA_set_ex_data(DSA *d, int idx, void *arg);
186 void *DSA_get_ex_data(DSA *d, int idx);
187
188 DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
189 DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
190 DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
191
192 /* Deprecated version */
193 DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
194                                                 unsigned char *seed,
195                                                 int seed_len,
196                                                 int *counter_ret,
197                                                 unsigned long *h_ret, void
198                                                  (*callback) (int, int,
199                                                               void *),
200                                                 void *cb_arg))
201
202 /* New version */
203 int DSA_generate_parameters_ex(DSA *dsa, int bits,
204                                const unsigned char *seed, int seed_len,
205                                int *counter_ret, unsigned long *h_ret,
206                                BN_GENCB *cb);
207
208 int DSA_generate_key(DSA *a);
209 int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
210 int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
211 int i2d_DSAparams(const DSA *a, unsigned char **pp);
212
213 int DSAparams_print(BIO *bp, const DSA *x);
214 int DSA_print(BIO *bp, const DSA *x, int off);
215 # ifndef OPENSSL_NO_STDIO
216 int DSAparams_print_fp(FILE *fp, const DSA *x);
217 int DSA_print_fp(FILE *bp, const DSA *x, int off);
218 # endif
219
220 # define DSS_prime_checks 50
221 /*
222  * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of
223  * Rabin-Miller
224  */
225 # define DSA_is_prime(n, callback, cb_arg) \
226         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
227
228 # ifndef OPENSSL_NO_DH
229 /*
230  * Convert DSA structure (key or just parameters) into DH structure (be
231  * careful to avoid small subgroup attacks when using this!)
232  */
233 DH *DSA_dup_DH(const DSA *r);
234 # endif
235
236 # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
237         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
238                                 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
239
240 # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS         (EVP_PKEY_ALG_CTRL + 1)
241 # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS       (EVP_PKEY_ALG_CTRL + 2)
242 # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD           (EVP_PKEY_ALG_CTRL + 3)
243
244 BIGNUM *DSA_get0_p(const DSA *d);
245 BIGNUM *DSA_get0_q(const DSA *d);
246 BIGNUM *DSA_get0_g(const DSA *d);
247 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
248 BIGNUM *DSA_get0_priv_key(const DSA *d);
249 BIGNUM *DSA_get0_pub_key(const DSA *d);
250 int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
251 void DSA_clear_flags(DSA *d, int flags);
252 int DSA_test_flags(const DSA *d, int flags);
253 void DSA_set_flags(DSA *d, int flags);
254 ENGINE *DSA_get0_engine(DSA *d);
255
256 /* BEGIN ERROR CODES */
257 /*
258  * The following lines are auto generated by the script mkerr.pl. Any changes
259  * made after this point may be overwritten when the script is next run.
260  */
261 void ERR_load_DSA_strings(void);
262
263 /* Error codes for the DSA functions. */
264
265 /* Function codes. */
266 # define DSA_F_D2I_DSA_SIG                                110
267 # define DSA_F_DO_DSA_PRINT                               104
268 # define DSA_F_DSAPARAMS_PRINT                            100
269 # define DSA_F_DSAPARAMS_PRINT_FP                         101
270 # define DSA_F_DSA_BUILTIN_KEYGEN                         124
271 # define DSA_F_DSA_BUILTIN_PARAMGEN                       125
272 # define DSA_F_DSA_BUILTIN_PARAMGEN2                      126
273 # define DSA_F_DSA_DO_SIGN                                112
274 # define DSA_F_DSA_DO_VERIFY                              113
275 # define DSA_F_DSA_NEW_METHOD                             103
276 # define DSA_F_DSA_PARAM_DECODE                           119
277 # define DSA_F_DSA_PRINT_FP                               105
278 # define DSA_F_DSA_PRIV_DECODE                            115
279 # define DSA_F_DSA_PRIV_ENCODE                            116
280 # define DSA_F_DSA_PUB_DECODE                             117
281 # define DSA_F_DSA_PUB_ENCODE                             118
282 # define DSA_F_DSA_SIGN                                   106
283 # define DSA_F_DSA_SIGN_SETUP                             107
284 # define DSA_F_DSA_SIG_NEW                                109
285 # define DSA_F_DSA_SIG_PRINT                              123
286 # define DSA_F_DSA_VERIFY                                 108
287 # define DSA_F_I2D_DSA_SIG                                111
288 # define DSA_F_OLD_DSA_PRIV_DECODE                        122
289 # define DSA_F_PKEY_DSA_CTRL                              120
290 # define DSA_F_PKEY_DSA_KEYGEN                            121
291 # define DSA_F_SIG_CB                                     114
292
293 /* Reason codes. */
294 # define DSA_R_BAD_Q_VALUE                                102
295 # define DSA_R_BN_DECODE_ERROR                            108
296 # define DSA_R_BN_ERROR                                   109
297 # define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                100
298 # define DSA_R_DECODE_ERROR                               104
299 # define DSA_R_INVALID_DIGEST_TYPE                        106
300 # define DSA_R_INVALID_PARAMETERS                         112
301 # define DSA_R_KEY_SIZE_TOO_SMALL                         111
302 # define DSA_R_MISSING_PARAMETERS                         101
303 # define DSA_R_MODULUS_TOO_LARGE                          103
304 # define DSA_R_NEED_NEW_SETUP_VALUES                      110
305 # define DSA_R_NO_PARAMETERS_SET                          107
306 # define DSA_R_PARAMETER_ENCODING_ERROR                   105
307 # define DSA_R_Q_NOT_PRIME                                113
308
309 # ifdef  __cplusplus
310 }
311 # endif
312 # endif
313
314 #endif