1 /* crypto/dsa/dsa.h */
\r
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
\r
3 * All rights reserved.
\r
5 * This package is an SSL implementation written
\r
6 * by Eric Young (eay@cryptsoft.com).
\r
7 * The implementation was written so as to conform with Netscapes SSL.
\r
9 * This library is free for commercial and non-commercial use as long as
\r
10 * the following conditions are aheared to. The following conditions
\r
11 * apply to all code found in this distribution, be it the RC4, RSA,
\r
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
\r
13 * included with this distribution is covered by the same copyright terms
\r
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
\r
16 * Copyright remains Eric Young's, and as such any Copyright notices in
\r
17 * the code are not to be removed.
\r
18 * If this package is used in a product, Eric Young should be given attribution
\r
19 * as the author of the parts of the library used.
\r
20 * This can be in the form of a textual message at program startup or
\r
21 * in documentation (online or textual) provided with the package.
\r
23 * Redistribution and use in source and binary forms, with or without
\r
24 * modification, are permitted provided that the following conditions
\r
26 * 1. Redistributions of source code must retain the copyright
\r
27 * notice, this list of conditions and the following disclaimer.
\r
28 * 2. Redistributions in binary form must reproduce the above copyright
\r
29 * notice, this list of conditions and the following disclaimer in the
\r
30 * documentation and/or other materials provided with the distribution.
\r
31 * 3. All advertising materials mentioning features or use of this software
\r
32 * must display the following acknowledgement:
\r
33 * "This product includes cryptographic software written by
\r
34 * Eric Young (eay@cryptsoft.com)"
\r
35 * The word 'cryptographic' can be left out if the rouines from the library
\r
36 * being used are not cryptographic related :-).
\r
37 * 4. If you include any Windows specific code (or a derivative thereof) from
\r
38 * the apps directory (application code) you must include an acknowledgement:
\r
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
\r
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
\r
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\r
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
\r
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
\r
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\r
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
\r
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\r
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
\r
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
\r
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
\r
53 * The licence and distribution terms for any publically available version or
\r
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
\r
55 * copied and put under another distribution licence
\r
56 * [including the GNU Public Licence.]
\r
60 * The DSS routines are based on patches supplied by
\r
61 * Steven Schoch <schoch@sheba.arc.nasa.gov>. He basically did the
\r
62 * work and I have just tweaked them a little to fit into my
\r
63 * stylistic vision for SSLeay :-) */
\r
65 #ifndef HEADER_DSA_H
\r
66 #define HEADER_DSA_H
\r
68 #include <openssl/e_os2.h>
\r
70 #ifdef OPENSSL_NO_DSA
\r
71 #error DSA is disabled.
\r
74 #ifndef OPENSSL_NO_BIO
\r
75 #include <openssl/bio.h>
\r
77 #include <openssl/crypto.h>
\r
78 #include <openssl/ossl_typ.h>
\r
80 #ifndef OPENSSL_NO_DEPRECATED
\r
81 #include <openssl/bn.h>
\r
82 #ifndef OPENSSL_NO_DH
\r
83 # include <openssl/dh.h>
\r
87 #ifndef OPENSSL_DSA_MAX_MODULUS_BITS
\r
88 # define OPENSSL_DSA_MAX_MODULUS_BITS 10000
\r
91 #define DSA_FLAG_CACHE_MONT_P 0x01
\r
92 #define DSA_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DSA
\r
93 * implementation now uses constant time
\r
94 * modular exponentiation for secret exponents
\r
95 * by default. This flag causes the
\r
96 * faster variable sliding window method to
\r
97 * be used for all exponents.
\r
104 /* Already defined in ossl_typ.h */
\r
105 /* typedef struct dsa_st DSA; */
\r
106 /* typedef struct dsa_method DSA_METHOD; */
\r
108 typedef struct DSA_SIG_st
\r
117 DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa);
\r
118 int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
\r
120 int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
\r
121 DSA_SIG *sig, DSA *dsa);
\r
122 int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
\r
123 BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
\r
124 BN_MONT_CTX *in_mont);
\r
125 int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
\r
126 const BIGNUM *m, BN_CTX *ctx,
\r
127 BN_MONT_CTX *m_ctx); /* Can be null */
\r
128 int (*init)(DSA *dsa);
\r
129 int (*finish)(DSA *dsa);
\r
132 /* If this is non-NULL, it is used to generate DSA parameters */
\r
133 int (*dsa_paramgen)(DSA *dsa, int bits,
\r
134 const unsigned char *seed, int seed_len,
\r
135 int *counter_ret, unsigned long *h_ret,
\r
137 /* If this is non-NULL, it is used to generate DSA keys */
\r
138 int (*dsa_keygen)(DSA *dsa);
\r
143 /* This first variable is used to pick up errors where
\r
144 * a DSA is passed instead of of a EVP_PKEY */
\r
149 BIGNUM *q; /* == 20 */
\r
152 BIGNUM *pub_key; /* y public key */
\r
153 BIGNUM *priv_key; /* x private key */
\r
155 BIGNUM *kinv; /* Signing pre-calc */
\r
156 BIGNUM *r; /* Signing pre-calc */
\r
159 /* Normally used to cache montgomery values */
\r
160 BN_MONT_CTX *method_mont_p;
\r
162 CRYPTO_EX_DATA ex_data;
\r
163 const DSA_METHOD *meth;
\r
164 /* functional reference if 'meth' is ENGINE-provided */
\r
168 #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
\r
169 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
\r
170 #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
\r
171 (unsigned char *)(x))
\r
172 #define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
\r
173 #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
\r
176 DSA *DSAparams_dup(DSA *x);
\r
177 DSA_SIG * DSA_SIG_new(void);
\r
178 void DSA_SIG_free(DSA_SIG *a);
\r
179 int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
\r
180 DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
\r
182 DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
\r
183 int DSA_do_verify(const unsigned char *dgst,int dgst_len,
\r
184 DSA_SIG *sig,DSA *dsa);
\r
186 const DSA_METHOD *DSA_OpenSSL(void);
\r
188 void DSA_set_default_method(const DSA_METHOD *);
\r
189 const DSA_METHOD *DSA_get_default_method(void);
\r
190 int DSA_set_method(DSA *dsa, const DSA_METHOD *);
\r
192 DSA * DSA_new(void);
\r
193 DSA * DSA_new_method(ENGINE *engine);
\r
194 void DSA_free (DSA *r);
\r
195 /* "up" the DSA object's reference count */
\r
196 int DSA_up_ref(DSA *r);
\r
197 int DSA_size(const DSA *);
\r
198 /* next 4 return -1 on error */
\r
199 int DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
\r
200 int DSA_sign(int type,const unsigned char *dgst,int dlen,
\r
201 unsigned char *sig, unsigned int *siglen, DSA *dsa);
\r
202 int DSA_verify(int type,const unsigned char *dgst,int dgst_len,
\r
203 const unsigned char *sigbuf, int siglen, DSA *dsa);
\r
204 int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
\r
205 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
\r
206 int DSA_set_ex_data(DSA *d, int idx, void *arg);
\r
207 void *DSA_get_ex_data(DSA *d, int idx);
\r
209 DSA * d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
\r
210 DSA * d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
\r
211 DSA * d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
\r
213 /* Deprecated version */
\r
214 #ifndef OPENSSL_NO_DEPRECATED
\r
215 DSA * DSA_generate_parameters(int bits,
\r
216 unsigned char *seed,int seed_len,
\r
217 int *counter_ret, unsigned long *h_ret,void
\r
218 (*callback)(int, int, void *),void *cb_arg);
\r
219 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
\r
222 int DSA_generate_parameters_ex(DSA *dsa, int bits,
\r
223 const unsigned char *seed,int seed_len,
\r
224 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb);
\r
226 int DSA_generate_key(DSA *a);
\r
227 int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
\r
228 int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
\r
229 int i2d_DSAparams(const DSA *a,unsigned char **pp);
\r
231 #ifndef OPENSSL_NO_BIO
\r
232 int DSAparams_print(BIO *bp, const DSA *x);
\r
233 int DSA_print(BIO *bp, const DSA *x, int off);
\r
235 #ifndef OPENSSL_NO_FP_API
\r
236 int DSAparams_print_fp(FILE *fp, const DSA *x);
\r
237 int DSA_print_fp(FILE *bp, const DSA *x, int off);
\r
240 #define DSS_prime_checks 50
\r
241 /* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
\r
242 * 50 rounds of Rabin-Miller */
\r
243 #define DSA_is_prime(n, callback, cb_arg) \
\r
244 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
\r
246 #ifndef OPENSSL_NO_DH
\r
247 /* Convert DSA structure (key or just parameters) into DH structure
\r
248 * (be careful to avoid small subgroup attacks when using this!) */
\r
249 DH *DSA_dup_DH(const DSA *r);
\r
252 #define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
\r
253 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
\r
254 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
\r
256 #define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
\r
257 #define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
\r
258 #define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
\r
260 /* BEGIN ERROR CODES */
\r
261 /* The following lines are auto generated by the script mkerr.pl. Any changes
\r
262 * made after this point may be overwritten when the script is next run.
\r
264 void ERR_load_DSA_strings(void);
\r
266 /* Error codes for the DSA functions. */
\r
268 /* Function codes. */
\r
269 #define DSA_F_D2I_DSA_SIG 110
\r
270 #define DSA_F_DO_DSA_PRINT 104
\r
271 #define DSA_F_DSAPARAMS_PRINT 100
\r
272 #define DSA_F_DSAPARAMS_PRINT_FP 101
\r
273 #define DSA_F_DSA_DO_SIGN 112
\r
274 #define DSA_F_DSA_DO_VERIFY 113
\r
275 #define DSA_F_DSA_NEW_METHOD 103
\r
276 #define DSA_F_DSA_PARAM_DECODE 119
\r
277 #define DSA_F_DSA_PRINT_FP 105
\r
278 #define DSA_F_DSA_PRIV_DECODE 115
\r
279 #define DSA_F_DSA_PRIV_ENCODE 116
\r
280 #define DSA_F_DSA_PUB_DECODE 117
\r
281 #define DSA_F_DSA_PUB_ENCODE 118
\r
282 #define DSA_F_DSA_SIGN 106
\r
283 #define DSA_F_DSA_SIGN_SETUP 107
\r
284 #define DSA_F_DSA_SIG_NEW 109
\r
285 #define DSA_F_DSA_VERIFY 108
\r
286 #define DSA_F_I2D_DSA_SIG 111
\r
287 #define DSA_F_OLD_DSA_PRIV_DECODE 122
\r
288 #define DSA_F_PKEY_DSA_CTRL 120
\r
289 #define DSA_F_PKEY_DSA_KEYGEN 121
\r
290 #define DSA_F_SIG_CB 114
\r
292 /* Reason codes. */
\r
293 #define DSA_R_BAD_Q_VALUE 102
\r
294 #define DSA_R_BN_DECODE_ERROR 108
\r
295 #define DSA_R_BN_ERROR 109
\r
296 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100
\r
297 #define DSA_R_DECODE_ERROR 104
\r
298 #define DSA_R_INVALID_DIGEST_TYPE 106
\r
299 #define DSA_R_MISSING_PARAMETERS 101
\r
300 #define DSA_R_MODULUS_TOO_LARGE 103
\r
301 #define DSA_R_NO_PARAMETERS_SET 107
\r
302 #define DSA_R_PARAMETER_ENCODING_ERROR 105
\r