(oops) Apologies all, that last header-cleanup commit was from the wrong
[openssl.git] / crypto / dsa / dsa.h
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/bn.h>
78 #include <openssl/crypto.h>
79 #include <openssl/ossl_typ.h>
80
81 #ifndef OPENSSL_NO_DEPRECATED
82 #ifndef OPENSSL_NO_DH
83 # include <openssl/dh.h>
84 #endif
85 #endif
86
87 #define DSA_FLAG_CACHE_MONT_P   0x01
88
89 #ifdef  __cplusplus
90 extern "C" {
91 #endif
92
93 /* Already defined in ossl_typ.h */
94 /* typedef struct dsa_st DSA; */
95 /* typedef struct dsa_method DSA_METHOD; */
96
97 typedef struct DSA_SIG_st
98         {
99         BIGNUM *r;
100         BIGNUM *s;
101         } DSA_SIG;
102
103 struct dsa_method
104         {
105         const char *name;
106         DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa);
107         int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
108                                                                 BIGNUM **rp);
109         int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
110                                                         DSA_SIG *sig, DSA *dsa);
111         int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
112                         BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
113                         BN_MONT_CTX *in_mont);
114         int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
115                                 const BIGNUM *m, BN_CTX *ctx,
116                                 BN_MONT_CTX *m_ctx); /* Can be null */
117         int (*init)(DSA *dsa);
118         int (*finish)(DSA *dsa);
119         int flags;
120         char *app_data;
121         /* If this is non-NULL, it is used to generate DSA parameters */
122         int (*dsa_paramgen)(DSA *dsa, int bits,
123                         unsigned char *seed, int seed_len,
124                         int *counter_ret, unsigned long *h_ret,
125                         BN_GENCB *cb);
126         /* If this is non-NULL, it is used to generate DSA keys */
127         int (*dsa_keygen)(DSA *dsa);
128         };
129
130 struct dsa_st
131         {
132         /* This first variable is used to pick up errors where
133          * a DSA is passed instead of of a EVP_PKEY */
134         int pad;
135         long version;
136         int write_params;
137         BIGNUM *p;
138         BIGNUM *q;      /* == 20 */
139         BIGNUM *g;
140
141         BIGNUM *pub_key;  /* y public key */
142         BIGNUM *priv_key; /* x private key */
143
144         BIGNUM *kinv;   /* Signing pre-calc */
145         BIGNUM *r;      /* Signing pre-calc */
146
147         int flags;
148         /* Normally used to cache montgomery values */
149         char *method_mont_p;
150         int references;
151         CRYPTO_EX_DATA ex_data;
152         const DSA_METHOD *meth;
153         /* functional reference if 'meth' is ENGINE-provided */
154         ENGINE *engine;
155         };
156
157 #define DSAparams_dup(x) (DSA *)ASN1_dup((int (*)())i2d_DSAparams, \
158                 (char *(*)())d2i_DSAparams,(char *)(x))
159 #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
160                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
161 #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
162                 (unsigned char *)(x))
163 #define d2i_DSAparams_bio(bp,x) (DSA *)ASN1_d2i_bio((char *(*)())DSA_new, \
164                 (char *(*)())d2i_DSAparams,(bp),(unsigned char **)(x))
165 #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio(i2d_DSAparams,(bp), \
166                 (unsigned char *)(x))
167
168
169 DSA_SIG * DSA_SIG_new(void);
170 void    DSA_SIG_free(DSA_SIG *a);
171 int     i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
172 DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
173
174 DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
175 int     DSA_do_verify(const unsigned char *dgst,int dgst_len,
176                       DSA_SIG *sig,DSA *dsa);
177
178 const DSA_METHOD *DSA_OpenSSL(void);
179
180 void    DSA_set_default_method(const DSA_METHOD *);
181 const DSA_METHOD *DSA_get_default_method(void);
182 int     DSA_set_method(DSA *dsa, const DSA_METHOD *);
183
184 DSA *   DSA_new(void);
185 DSA *   DSA_new_method(ENGINE *engine);
186 void    DSA_free (DSA *r);
187 /* "up" the DSA object's reference count */
188 int     DSA_up_ref(DSA *r);
189 int     DSA_size(const DSA *);
190         /* next 4 return -1 on error */
191 int     DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
192 int     DSA_sign(int type,const unsigned char *dgst,int dlen,
193                 unsigned char *sig, unsigned int *siglen, DSA *dsa);
194 int     DSA_verify(int type,const unsigned char *dgst,int dgst_len,
195                 const unsigned char *sigbuf, int siglen, DSA *dsa);
196 int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
197              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
198 int DSA_set_ex_data(DSA *d, int idx, void *arg);
199 void *DSA_get_ex_data(DSA *d, int idx);
200
201 DSA *   d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
202 DSA *   d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
203 DSA *   d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
204
205 /* Deprecated version */
206 #ifndef OPENSSL_NO_DEPRECATED
207 DSA *   DSA_generate_parameters(int bits,
208                 unsigned char *seed,int seed_len,
209                 int *counter_ret, unsigned long *h_ret,void
210                 (*callback)(int, int, void *),void *cb_arg);
211 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
212
213 /* New version */
214 int     DSA_generate_parameters_ex(DSA *dsa, int bits,
215                 unsigned char *seed,int seed_len,
216                 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb);
217
218 int     DSA_generate_key(DSA *a);
219 int     i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
220 int     i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
221 int     i2d_DSAparams(const DSA *a,unsigned char **pp);
222
223 #ifndef OPENSSL_NO_BIO
224 int     DSAparams_print(BIO *bp, const DSA *x);
225 int     DSA_print(BIO *bp, const DSA *x, int off);
226 #endif
227 #ifndef OPENSSL_NO_FP_API
228 int     DSAparams_print_fp(FILE *fp, const DSA *x);
229 int     DSA_print_fp(FILE *bp, const DSA *x, int off);
230 #endif
231
232 #define DSS_prime_checks 50
233 /* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
234  * 50 rounds of Rabin-Miller */
235 #define DSA_is_prime(n, callback, cb_arg) \
236         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
237
238 #ifndef OPENSSL_NO_DH
239 /* Convert DSA structure (key or just parameters) into DH structure
240  * (be careful to avoid small subgroup attacks when using this!) */
241 DH *DSA_dup_DH(const DSA *r);
242 #endif
243
244 /* BEGIN ERROR CODES */
245 /* The following lines are auto generated by the script mkerr.pl. Any changes
246  * made after this point may be overwritten when the script is next run.
247  */
248 void ERR_load_DSA_strings(void);
249
250 /* Error codes for the DSA functions. */
251
252 /* Function codes. */
253 #define DSA_F_D2I_DSA_SIG                                110
254 #define DSA_F_DSAPARAMS_PRINT                            100
255 #define DSA_F_DSAPARAMS_PRINT_FP                         101
256 #define DSA_F_DSA_DO_SIGN                                112
257 #define DSA_F_DSA_DO_VERIFY                              113
258 #define DSA_F_DSA_NEW_METHOD                             103
259 #define DSA_F_DSA_PRINT                                  104
260 #define DSA_F_DSA_PRINT_FP                               105
261 #define DSA_F_DSA_SIGN                                   106
262 #define DSA_F_DSA_SIGN_SETUP                             107
263 #define DSA_F_DSA_SIG_NEW                                109
264 #define DSA_F_DSA_VERIFY                                 108
265 #define DSA_F_I2D_DSA_SIG                                111
266 #define DSA_F_SIG_CB                                     114
267
268 /* Reason codes. */
269 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                100
270 #define DSA_R_MISSING_PARAMETERS                         101
271
272 #ifdef  __cplusplus
273 }
274 #endif
275 #endif