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