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