xref: /onnv-gate/usr/src/common/openssl/crypto/dsa/dsa.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /* crypto/dsa/dsa.h */
2*0Sstevel@tonic-gate /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3*0Sstevel@tonic-gate  * All rights reserved.
4*0Sstevel@tonic-gate  *
5*0Sstevel@tonic-gate  * This package is an SSL implementation written
6*0Sstevel@tonic-gate  * by Eric Young (eay@cryptsoft.com).
7*0Sstevel@tonic-gate  * The implementation was written so as to conform with Netscapes SSL.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * This library is free for commercial and non-commercial use as long as
10*0Sstevel@tonic-gate  * the following conditions are aheared to.  The following conditions
11*0Sstevel@tonic-gate  * apply to all code found in this distribution, be it the RC4, RSA,
12*0Sstevel@tonic-gate  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13*0Sstevel@tonic-gate  * included with this distribution is covered by the same copyright terms
14*0Sstevel@tonic-gate  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15*0Sstevel@tonic-gate  *
16*0Sstevel@tonic-gate  * Copyright remains Eric Young's, and as such any Copyright notices in
17*0Sstevel@tonic-gate  * the code are not to be removed.
18*0Sstevel@tonic-gate  * If this package is used in a product, Eric Young should be given attribution
19*0Sstevel@tonic-gate  * as the author of the parts of the library used.
20*0Sstevel@tonic-gate  * This can be in the form of a textual message at program startup or
21*0Sstevel@tonic-gate  * in documentation (online or textual) provided with the package.
22*0Sstevel@tonic-gate  *
23*0Sstevel@tonic-gate  * Redistribution and use in source and binary forms, with or without
24*0Sstevel@tonic-gate  * modification, are permitted provided that the following conditions
25*0Sstevel@tonic-gate  * are met:
26*0Sstevel@tonic-gate  * 1. Redistributions of source code must retain the copyright
27*0Sstevel@tonic-gate  *    notice, this list of conditions and the following disclaimer.
28*0Sstevel@tonic-gate  * 2. Redistributions in binary form must reproduce the above copyright
29*0Sstevel@tonic-gate  *    notice, this list of conditions and the following disclaimer in the
30*0Sstevel@tonic-gate  *    documentation and/or other materials provided with the distribution.
31*0Sstevel@tonic-gate  * 3. All advertising materials mentioning features or use of this software
32*0Sstevel@tonic-gate  *    must display the following acknowledgement:
33*0Sstevel@tonic-gate  *    "This product includes cryptographic software written by
34*0Sstevel@tonic-gate  *     Eric Young (eay@cryptsoft.com)"
35*0Sstevel@tonic-gate  *    The word 'cryptographic' can be left out if the rouines from the library
36*0Sstevel@tonic-gate  *    being used are not cryptographic related :-).
37*0Sstevel@tonic-gate  * 4. If you include any Windows specific code (or a derivative thereof) from
38*0Sstevel@tonic-gate  *    the apps directory (application code) you must include an acknowledgement:
39*0Sstevel@tonic-gate  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40*0Sstevel@tonic-gate  *
41*0Sstevel@tonic-gate  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42*0Sstevel@tonic-gate  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43*0Sstevel@tonic-gate  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44*0Sstevel@tonic-gate  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45*0Sstevel@tonic-gate  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46*0Sstevel@tonic-gate  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47*0Sstevel@tonic-gate  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48*0Sstevel@tonic-gate  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49*0Sstevel@tonic-gate  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50*0Sstevel@tonic-gate  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51*0Sstevel@tonic-gate  * SUCH DAMAGE.
52*0Sstevel@tonic-gate  *
53*0Sstevel@tonic-gate  * The licence and distribution terms for any publically available version or
54*0Sstevel@tonic-gate  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55*0Sstevel@tonic-gate  * copied and put under another distribution licence
56*0Sstevel@tonic-gate  * [including the GNU Public Licence.]
57*0Sstevel@tonic-gate  */
58*0Sstevel@tonic-gate 
59*0Sstevel@tonic-gate /*
60*0Sstevel@tonic-gate  * The DSS routines are based on patches supplied by
61*0Sstevel@tonic-gate  * Steven Schoch <schoch@sheba.arc.nasa.gov>.  He basically did the
62*0Sstevel@tonic-gate  * work and I have just tweaked them a little to fit into my
63*0Sstevel@tonic-gate  * stylistic vision for SSLeay :-) */
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate #ifndef HEADER_DSA_H
66*0Sstevel@tonic-gate #define HEADER_DSA_H
67*0Sstevel@tonic-gate 
68*0Sstevel@tonic-gate #ifdef OPENSSL_NO_DSA
69*0Sstevel@tonic-gate #error DSA is disabled.
70*0Sstevel@tonic-gate #endif
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate #ifndef OPENSSL_NO_BIO
73*0Sstevel@tonic-gate #include <openssl/bio.h>
74*0Sstevel@tonic-gate #endif
75*0Sstevel@tonic-gate #include <openssl/bn.h>
76*0Sstevel@tonic-gate #include <openssl/crypto.h>
77*0Sstevel@tonic-gate #include <openssl/ossl_typ.h>
78*0Sstevel@tonic-gate #ifndef OPENSSL_NO_DH
79*0Sstevel@tonic-gate # include <openssl/dh.h>
80*0Sstevel@tonic-gate #endif
81*0Sstevel@tonic-gate 
82*0Sstevel@tonic-gate #define DSA_FLAG_CACHE_MONT_P	0x01
83*0Sstevel@tonic-gate 
84*0Sstevel@tonic-gate #ifdef  __cplusplus
85*0Sstevel@tonic-gate extern "C" {
86*0Sstevel@tonic-gate #endif
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate typedef struct dsa_st DSA;
89*0Sstevel@tonic-gate 
90*0Sstevel@tonic-gate typedef struct DSA_SIG_st
91*0Sstevel@tonic-gate 	{
92*0Sstevel@tonic-gate 	BIGNUM *r;
93*0Sstevel@tonic-gate 	BIGNUM *s;
94*0Sstevel@tonic-gate 	} DSA_SIG;
95*0Sstevel@tonic-gate 
96*0Sstevel@tonic-gate typedef struct dsa_method {
97*0Sstevel@tonic-gate 	const char *name;
98*0Sstevel@tonic-gate 	DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa);
99*0Sstevel@tonic-gate 	int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
100*0Sstevel@tonic-gate 								BIGNUM **rp);
101*0Sstevel@tonic-gate 	int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
102*0Sstevel@tonic-gate 							DSA_SIG *sig, DSA *dsa);
103*0Sstevel@tonic-gate 	int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
104*0Sstevel@tonic-gate 			BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
105*0Sstevel@tonic-gate 			BN_MONT_CTX *in_mont);
106*0Sstevel@tonic-gate 	int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
107*0Sstevel@tonic-gate 				const BIGNUM *m, BN_CTX *ctx,
108*0Sstevel@tonic-gate 				BN_MONT_CTX *m_ctx); /* Can be null */
109*0Sstevel@tonic-gate 	int (*init)(DSA *dsa);
110*0Sstevel@tonic-gate 	int (*finish)(DSA *dsa);
111*0Sstevel@tonic-gate 	int flags;
112*0Sstevel@tonic-gate 	char *app_data;
113*0Sstevel@tonic-gate } DSA_METHOD;
114*0Sstevel@tonic-gate 
115*0Sstevel@tonic-gate struct dsa_st
116*0Sstevel@tonic-gate 	{
117*0Sstevel@tonic-gate 	/* This first variable is used to pick up errors where
118*0Sstevel@tonic-gate 	 * a DSA is passed instead of of a EVP_PKEY */
119*0Sstevel@tonic-gate 	int pad;
120*0Sstevel@tonic-gate 	long version;
121*0Sstevel@tonic-gate 	int write_params;
122*0Sstevel@tonic-gate 	BIGNUM *p;
123*0Sstevel@tonic-gate 	BIGNUM *q;	/* == 20 */
124*0Sstevel@tonic-gate 	BIGNUM *g;
125*0Sstevel@tonic-gate 
126*0Sstevel@tonic-gate 	BIGNUM *pub_key;  /* y public key */
127*0Sstevel@tonic-gate 	BIGNUM *priv_key; /* x private key */
128*0Sstevel@tonic-gate 
129*0Sstevel@tonic-gate 	BIGNUM *kinv;	/* Signing pre-calc */
130*0Sstevel@tonic-gate 	BIGNUM *r;	/* Signing pre-calc */
131*0Sstevel@tonic-gate 
132*0Sstevel@tonic-gate 	int flags;
133*0Sstevel@tonic-gate 	/* Normally used to cache montgomery values */
134*0Sstevel@tonic-gate 	char *method_mont_p;
135*0Sstevel@tonic-gate 	int references;
136*0Sstevel@tonic-gate 	CRYPTO_EX_DATA ex_data;
137*0Sstevel@tonic-gate 	const DSA_METHOD *meth;
138*0Sstevel@tonic-gate 	/* functional reference if 'meth' is ENGINE-provided */
139*0Sstevel@tonic-gate 	ENGINE *engine;
140*0Sstevel@tonic-gate 	};
141*0Sstevel@tonic-gate 
142*0Sstevel@tonic-gate #define DSAparams_dup(x) (DSA *)ASN1_dup((int (*)())i2d_DSAparams, \
143*0Sstevel@tonic-gate 		(char *(*)())d2i_DSAparams,(char *)(x))
144*0Sstevel@tonic-gate #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
145*0Sstevel@tonic-gate 		(char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
146*0Sstevel@tonic-gate #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
147*0Sstevel@tonic-gate 		(unsigned char *)(x))
148*0Sstevel@tonic-gate #define d2i_DSAparams_bio(bp,x) (DSA *)ASN1_d2i_bio((char *(*)())DSA_new, \
149*0Sstevel@tonic-gate 		(char *(*)())d2i_DSAparams,(bp),(unsigned char **)(x))
150*0Sstevel@tonic-gate #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio(i2d_DSAparams,(bp), \
151*0Sstevel@tonic-gate 		(unsigned char *)(x))
152*0Sstevel@tonic-gate 
153*0Sstevel@tonic-gate 
154*0Sstevel@tonic-gate DSA_SIG * DSA_SIG_new(void);
155*0Sstevel@tonic-gate void	DSA_SIG_free(DSA_SIG *a);
156*0Sstevel@tonic-gate int	i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
157*0Sstevel@tonic-gate DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
158*0Sstevel@tonic-gate 
159*0Sstevel@tonic-gate DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
160*0Sstevel@tonic-gate int	DSA_do_verify(const unsigned char *dgst,int dgst_len,
161*0Sstevel@tonic-gate 		      DSA_SIG *sig,DSA *dsa);
162*0Sstevel@tonic-gate 
163*0Sstevel@tonic-gate const DSA_METHOD *DSA_OpenSSL(void);
164*0Sstevel@tonic-gate 
165*0Sstevel@tonic-gate void	DSA_set_default_method(const DSA_METHOD *);
166*0Sstevel@tonic-gate const DSA_METHOD *DSA_get_default_method(void);
167*0Sstevel@tonic-gate int	DSA_set_method(DSA *dsa, const DSA_METHOD *);
168*0Sstevel@tonic-gate 
169*0Sstevel@tonic-gate DSA *	DSA_new(void);
170*0Sstevel@tonic-gate DSA *	DSA_new_method(ENGINE *engine);
171*0Sstevel@tonic-gate void	DSA_free (DSA *r);
172*0Sstevel@tonic-gate /* "up" the DSA object's reference count */
173*0Sstevel@tonic-gate int	DSA_up_ref(DSA *r);
174*0Sstevel@tonic-gate int	DSA_size(const DSA *);
175*0Sstevel@tonic-gate 	/* next 4 return -1 on error */
176*0Sstevel@tonic-gate int	DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
177*0Sstevel@tonic-gate int	DSA_sign(int type,const unsigned char *dgst,int dlen,
178*0Sstevel@tonic-gate 		unsigned char *sig, unsigned int *siglen, DSA *dsa);
179*0Sstevel@tonic-gate int	DSA_verify(int type,const unsigned char *dgst,int dgst_len,
180*0Sstevel@tonic-gate 		const unsigned char *sigbuf, int siglen, DSA *dsa);
181*0Sstevel@tonic-gate int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
182*0Sstevel@tonic-gate 	     CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
183*0Sstevel@tonic-gate int DSA_set_ex_data(DSA *d, int idx, void *arg);
184*0Sstevel@tonic-gate void *DSA_get_ex_data(DSA *d, int idx);
185*0Sstevel@tonic-gate 
186*0Sstevel@tonic-gate DSA *	d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
187*0Sstevel@tonic-gate DSA *	d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
188*0Sstevel@tonic-gate DSA * 	d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
189*0Sstevel@tonic-gate DSA *	DSA_generate_parameters(int bits,
190*0Sstevel@tonic-gate 		unsigned char *seed,int seed_len,
191*0Sstevel@tonic-gate 		int *counter_ret, unsigned long *h_ret,void
192*0Sstevel@tonic-gate 		(*callback)(int, int, void *),void *cb_arg);
193*0Sstevel@tonic-gate int	DSA_generate_key(DSA *a);
194*0Sstevel@tonic-gate int	i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
195*0Sstevel@tonic-gate int 	i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
196*0Sstevel@tonic-gate int	i2d_DSAparams(const DSA *a,unsigned char **pp);
197*0Sstevel@tonic-gate 
198*0Sstevel@tonic-gate #ifndef OPENSSL_NO_BIO
199*0Sstevel@tonic-gate int	DSAparams_print(BIO *bp, const DSA *x);
200*0Sstevel@tonic-gate int	DSA_print(BIO *bp, const DSA *x, int off);
201*0Sstevel@tonic-gate #endif
202*0Sstevel@tonic-gate #ifndef OPENSSL_NO_FP_API
203*0Sstevel@tonic-gate int	DSAparams_print_fp(FILE *fp, const DSA *x);
204*0Sstevel@tonic-gate int	DSA_print_fp(FILE *bp, const DSA *x, int off);
205*0Sstevel@tonic-gate #endif
206*0Sstevel@tonic-gate 
207*0Sstevel@tonic-gate #define DSS_prime_checks 50
208*0Sstevel@tonic-gate /* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
209*0Sstevel@tonic-gate  * 50 rounds of Rabin-Miller */
210*0Sstevel@tonic-gate #define DSA_is_prime(n, callback, cb_arg) \
211*0Sstevel@tonic-gate 	BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
212*0Sstevel@tonic-gate 
213*0Sstevel@tonic-gate #ifndef OPENSSL_NO_DH
214*0Sstevel@tonic-gate /* Convert DSA structure (key or just parameters) into DH structure
215*0Sstevel@tonic-gate  * (be careful to avoid small subgroup attacks when using this!) */
216*0Sstevel@tonic-gate DH *DSA_dup_DH(const DSA *r);
217*0Sstevel@tonic-gate #endif
218*0Sstevel@tonic-gate 
219*0Sstevel@tonic-gate /* BEGIN ERROR CODES */
220*0Sstevel@tonic-gate /* The following lines are auto generated by the script mkerr.pl. Any changes
221*0Sstevel@tonic-gate  * made after this point may be overwritten when the script is next run.
222*0Sstevel@tonic-gate  */
223*0Sstevel@tonic-gate void ERR_load_DSA_strings(void);
224*0Sstevel@tonic-gate 
225*0Sstevel@tonic-gate /* Error codes for the DSA functions. */
226*0Sstevel@tonic-gate 
227*0Sstevel@tonic-gate /* Function codes. */
228*0Sstevel@tonic-gate #define DSA_F_D2I_DSA_SIG				 110
229*0Sstevel@tonic-gate #define DSA_F_DSAPARAMS_PRINT				 100
230*0Sstevel@tonic-gate #define DSA_F_DSAPARAMS_PRINT_FP			 101
231*0Sstevel@tonic-gate #define DSA_F_DSA_DO_SIGN				 112
232*0Sstevel@tonic-gate #define DSA_F_DSA_DO_VERIFY				 113
233*0Sstevel@tonic-gate #define DSA_F_DSA_NEW_METHOD				 103
234*0Sstevel@tonic-gate #define DSA_F_DSA_PRINT					 104
235*0Sstevel@tonic-gate #define DSA_F_DSA_PRINT_FP				 105
236*0Sstevel@tonic-gate #define DSA_F_DSA_SIGN					 106
237*0Sstevel@tonic-gate #define DSA_F_DSA_SIGN_SETUP				 107
238*0Sstevel@tonic-gate #define DSA_F_DSA_SIG_NEW				 109
239*0Sstevel@tonic-gate #define DSA_F_DSA_VERIFY				 108
240*0Sstevel@tonic-gate #define DSA_F_I2D_DSA_SIG				 111
241*0Sstevel@tonic-gate #define DSA_F_SIG_CB					 114
242*0Sstevel@tonic-gate 
243*0Sstevel@tonic-gate /* Reason codes. */
244*0Sstevel@tonic-gate #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE		 100
245*0Sstevel@tonic-gate #define DSA_R_MISSING_PARAMETERS			 101
246*0Sstevel@tonic-gate 
247*0Sstevel@tonic-gate #ifdef  __cplusplus
248*0Sstevel@tonic-gate }
249*0Sstevel@tonic-gate #endif
250*0Sstevel@tonic-gate #endif
251