a758e3c890dbbedea070bd26f995c88661614516
[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 #ifdef  __cplusplus
69 extern "C" {
70 #endif
71
72 #include <openssl/bn.h>
73
74 #define DSA_FLAG_CACHE_MONT_P   0x01
75
76 typedef struct dsa_st
77         {
78         /* This first variable is used to pick up errors where
79          * a DSA is passed instead of of a EVP_PKEY */
80         int pad;
81         int version;
82         int write_params;
83         BIGNUM *p;
84         BIGNUM *q;      /* == 20 */
85         BIGNUM *g;
86
87         BIGNUM *pub_key;  /* y public key */
88         BIGNUM *priv_key; /* x private key */
89
90         BIGNUM *kinv;   /* Signing pre-calc */
91         BIGNUM *r;      /* Signing pre-calc */
92
93         int flags;
94         /* Normally used to cache montgomery values */
95         char *method_mont_p;
96
97         int references;
98         } DSA;
99
100 typedef struct DSA_SIG_st
101         {
102         BIGNUM *r;
103         BIGNUM *s;
104         } DSA_SIG;
105
106 #define DSAparams_dup(x) (DSA *)ASN1_dup((int (*)())i2d_DSAparams, \
107                 (char *(*)())d2i_DSAparams,(char *)(x))
108 #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
109                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
110 #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
111                 (unsigned char *)(x))
112 #define d2i_DSAparams_bio(bp,x) (DSA *)ASN1_d2i_bio((char *(*)())DSA_new, \
113                 (char *(*)())d2i_DSAparams,(bp),(unsigned char **)(x))
114 #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio(i2d_DSAparams,(bp), \
115                 (unsigned char *)(x))
116
117 #ifndef NOPROTO
118
119 DSA_SIG * DSA_SIG_new(void);
120 void    DSA_SIG_free(DSA_SIG *a);
121 int     i2d_DSA_SIG(DSA_SIG *a, unsigned char **pp);
122 DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);
123
124 DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
125 int     DSA_do_verify(const unsigned char *dgst,int dgst_len,
126                       DSA_SIG *sig,DSA *dsa);
127
128 DSA *   DSA_new(void);
129 int     DSA_size(DSA *);
130         /* next 4 return -1 on error */
131 int     DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
132 int     DSA_sign(int type,const unsigned char *dgst,int dlen,
133                 unsigned char *sig, unsigned int *siglen, DSA *dsa);
134 int     DSA_verify(int type,const unsigned char *dgst,int dgst_len,
135                 unsigned char *sigbuf, int siglen, DSA *dsa);
136 void    DSA_free (DSA *r);
137
138 void    ERR_load_DSA_strings(void );
139
140 DSA *   d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
141 DSA *   d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
142 DSA *   d2i_DSAparams(DSA **a, unsigned char **pp, long length);
143 DSA *   DSA_generate_parameters(int bits, unsigned char *seed,int seed_len,
144                 int *counter_ret, unsigned long *h_ret,void
145                 (*callback)(),char *cb_arg);
146 int     DSA_generate_key(DSA *a);
147 int     i2d_DSAPublicKey(DSA *a, unsigned char **pp);
148 int     i2d_DSAPrivateKey(DSA *a, unsigned char **pp);
149 int     i2d_DSAparams(DSA *a,unsigned char **pp);
150
151 #ifdef HEADER_BIO_H
152 int     DSAparams_print(BIO *bp, DSA *x);
153 int     DSA_print(BIO *bp, DSA *x, int off);
154 #endif
155 #ifndef NO_FP_API
156 int     DSAparams_print_fp(FILE *fp, DSA *x);
157 int     DSA_print_fp(FILE *bp, DSA *x, int off);
158 #endif
159
160 int DSA_is_prime(BIGNUM *q,void (*callback)(),char *cb_arg);
161
162 #else
163
164 DSA_SIG * DSA_SIG_new();
165 void    DSA_SIG_free();
166 int     i2d_DSA_SIG();
167 DSA_SIG * d2i_DSA_SIG();
168
169 DSA_SIG * DSA_do_sign();
170 int     DSA_do_verify();
171
172 DSA *   DSA_new();
173 int     DSA_size();
174 int     DSA_sign_setup();
175 int     DSA_sign();
176 int     DSA_verify();
177 void    DSA_free ();
178
179 void    ERR_load_DSA_strings();
180
181 DSA *   d2i_DSAPublicKey();
182 DSA *   d2i_DSAPrivateKey();
183 DSA *   d2i_DSAparams();
184 DSA *   DSA_generate_parameters();
185 int     DSA_generate_key();
186 int     i2d_DSAPublicKey();
187 int     i2d_DSAPrivateKey();
188 int     i2d_DSAparams();
189
190 int     DSA_is_prime();
191
192 int     DSAparams_print();
193 int     DSA_print();
194
195 #ifndef NO_FP_API
196 int     DSAparams_print_fp();
197 int     DSA_print_fp();
198 #endif
199
200 #endif
201
202 /* BEGIN ERROR CODES */
203 /* The following lines are auto generated by the script mkerr.pl. Any changes
204  * made after this point may be overwritten when the script is next run.
205  */
206
207 /* Error codes for the DSA functions. */
208
209 /* Function codes. */
210 #define DSA_F_D2I_DSA_SIG                                110
211 #define DSA_F_DSAPARAMS_PRINT                            100
212 #define DSA_F_DSAPARAMS_PRINT_FP                         101
213 #define DSA_F_DSA_DO_SIGN                                112
214 #define DSA_F_DSA_DO_VERIFY                              113
215 #define DSA_F_DSA_IS_PRIME                               102
216 #define DSA_F_DSA_NEW                                    103
217 #define DSA_F_DSA_PRINT                                  104
218 #define DSA_F_DSA_PRINT_FP                               105
219 #define DSA_F_DSA_SIGN                                   106
220 #define DSA_F_DSA_SIGN_SETUP                             107
221 #define DSA_F_DSA_SIG_NEW                                109
222 #define DSA_F_DSA_VERIFY                                 108
223 #define DSA_F_I2D_DSA_SIG                                111
224
225 /* Reason codes. */
226 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                100
227
228 #ifdef  __cplusplus
229 }
230 #endif
231 #endif
232