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