]>
git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/dsa/dsa.h
28aa8a3073aec4d1e7451b60a358b3602a6567d2
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
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 :-) */
68 #include <openssl/e_os2.h>
71 #error DSA is disabled.
74 #ifndef OPENSSL_NO_BIO
75 #include <openssl/bio.h>
77 #include <openssl/crypto.h>
78 #include <openssl/ossl_typ.h>
80 #ifndef OPENSSL_NO_DEPRECATED
81 #include <openssl/bn.h>
83 # include <openssl/dh.h>
87 #ifndef OPENSSL_DSA_MAX_MODULUS_BITS
88 # define OPENSSL_DSA_MAX_MODULUS_BITS 10000
91 #define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
93 #define DSA_FLAG_CACHE_MONT_P 0x01
94 #define DSA_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the
98 * modular exponentiation
99 * for secret exponents
100 * by default. This flag
103 * window method to be
107 #define DSA_FLAG_NONCE_FROM_HASH 0x04 /* Causes the DSA nonce
108 * to be calculated from
109 * SHA512(private_key +
116 /* If this flag is set the DSA method is FIPS compliant and can be used
117 * in FIPS mode. This is set in the validated module method. If an
118 * application sets this flag in its own methods it is its reposibility
119 * to ensure the result is compliant.
122 #define DSA_FLAG_FIPS_METHOD 0x0400
124 /* If this flag is set the operations normally disabled in FIPS mode are
125 * permitted it is then the applications responsibility to ensure that the
126 * usage is compliant.
129 #define DSA_FLAG_NON_FIPS_ALLOW 0x0400
130 #define DSA_FLAG_FIPS_CHECKED 0x0800
136 /* Already defined in ossl_typ.h */
137 /* typedef struct dsa_st DSA; */
138 /* typedef struct dsa_method DSA_METHOD; */
140 typedef struct DSA_SIG_st
149 DSA_SIG
* (*dsa_do_sign
)(const unsigned char *dgst
, int dlen
, DSA
*dsa
);
150 int (*dsa_sign_setup
)(DSA
*dsa
, BN_CTX
*ctx_in
,
151 BIGNUM
**kinvp
, BIGNUM
**rp
,
152 const unsigned char *dgst
, int dlen
);
153 int (*dsa_do_verify
)(const unsigned char *dgst
, int dgst_len
,
154 DSA_SIG
*sig
, DSA
*dsa
);
155 int (*dsa_mod_exp
)(DSA
*dsa
, BIGNUM
*rr
, BIGNUM
*a1
, BIGNUM
*p1
,
156 BIGNUM
*a2
, BIGNUM
*p2
, BIGNUM
*m
, BN_CTX
*ctx
,
157 BN_MONT_CTX
*in_mont
);
158 int (*bn_mod_exp
)(DSA
*dsa
, BIGNUM
*r
, BIGNUM
*a
, const BIGNUM
*p
,
159 const BIGNUM
*m
, BN_CTX
*ctx
,
160 BN_MONT_CTX
*m_ctx
); /* Can be null */
161 int (*init
)(DSA
*dsa
);
162 int (*finish
)(DSA
*dsa
);
165 /* If this is non-NULL, it is used to generate DSA parameters */
166 int (*dsa_paramgen
)(DSA
*dsa
, int bits
,
167 const unsigned char *seed
, int seed_len
,
168 int *counter_ret
, unsigned long *h_ret
,
170 /* If this is non-NULL, it is used to generate DSA keys */
171 int (*dsa_keygen
)(DSA
*dsa
);
176 /* This first variable is used to pick up errors where
177 * a DSA is passed instead of of a EVP_PKEY */
182 BIGNUM
*q
; /* == 20 */
185 BIGNUM
*pub_key
; /* y public key */
186 BIGNUM
*priv_key
; /* x private key */
188 BIGNUM
*kinv
; /* Signing pre-calc */
189 BIGNUM
*r
; /* Signing pre-calc */
192 /* Normally used to cache montgomery values */
193 BN_MONT_CTX
*method_mont_p
;
195 CRYPTO_EX_DATA ex_data
;
196 const DSA_METHOD
*meth
;
197 /* functional reference if 'meth' is ENGINE-provided */
201 #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
202 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
203 #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
204 (unsigned char *)(x))
205 #define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
206 #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
209 DSA
*DSAparams_dup(DSA
*x
);
210 DSA_SIG
* DSA_SIG_new(void);
211 void DSA_SIG_free(DSA_SIG
*a
);
212 int i2d_DSA_SIG(const DSA_SIG
*a
, unsigned char **pp
);
213 DSA_SIG
* d2i_DSA_SIG(DSA_SIG
**v
, const unsigned char **pp
, long length
);
215 DSA_SIG
* DSA_do_sign(const unsigned char *dgst
,int dlen
,DSA
*dsa
);
216 int DSA_do_verify(const unsigned char *dgst
,int dgst_len
,
217 DSA_SIG
*sig
,DSA
*dsa
);
219 const DSA_METHOD
*DSA_OpenSSL(void);
221 void DSA_set_default_method(const DSA_METHOD
*);
222 const DSA_METHOD
*DSA_get_default_method(void);
223 int DSA_set_method(DSA
*dsa
, const DSA_METHOD
*);
226 DSA
* FIPS_dsa_new(void);
227 void FIPS_dsa_free (DSA
*r
);
228 DSA_SIG
* FIPS_dsa_sign_digest(DSA
*dsa
, const unsigned char *dig
, int dlen
);
229 DSA_SIG
* FIPS_dsa_sign_ctx(DSA
*dsa
, EVP_MD_CTX
*ctx
);
230 int FIPS_dsa_verify_digest(DSA
*dsa
,
231 const unsigned char *dig
, int dlen
, DSA_SIG
*s
);
232 int FIPS_dsa_verify_ctx(DSA
*dsa
, EVP_MD_CTX
*ctx
, DSA_SIG
*s
);
233 int FIPS_dsa_verify(DSA
*dsa
, const unsigned char *msg
, size_t msglen
,
234 const EVP_MD
*mhash
, DSA_SIG
*s
);
235 DSA_SIG
* FIPS_dsa_sign(DSA
*dsa
, const unsigned char *msg
, size_t msglen
,
236 const EVP_MD
*mhash
);
241 DSA
* DSA_new_method(ENGINE
*engine
);
242 void DSA_free (DSA
*r
);
243 /* "up" the DSA object's reference count */
244 int DSA_up_ref(DSA
*r
);
245 int DSA_size(const DSA
*);
246 /* next 4 return -1 on error */
247 int DSA_sign_setup( DSA
*dsa
,BN_CTX
*ctx_in
,BIGNUM
**kinvp
,BIGNUM
**rp
);
248 int DSA_sign(int type
,const unsigned char *dgst
,int dlen
,
249 unsigned char *sig
, unsigned int *siglen
, DSA
*dsa
);
250 int DSA_verify(int type
,const unsigned char *dgst
,int dgst_len
,
251 const unsigned char *sigbuf
, int siglen
, DSA
*dsa
);
252 int DSA_get_ex_new_index(long argl
, void *argp
, CRYPTO_EX_new
*new_func
,
253 CRYPTO_EX_dup
*dup_func
, CRYPTO_EX_free
*free_func
);
254 int DSA_set_ex_data(DSA
*d
, int idx
, void *arg
);
255 void *DSA_get_ex_data(DSA
*d
, int idx
);
257 DSA
* d2i_DSAPublicKey(DSA
**a
, const unsigned char **pp
, long length
);
258 DSA
* d2i_DSAPrivateKey(DSA
**a
, const unsigned char **pp
, long length
);
259 DSA
* d2i_DSAparams(DSA
**a
, const unsigned char **pp
, long length
);
261 /* Deprecated version */
262 #ifndef OPENSSL_NO_DEPRECATED
263 DSA
* DSA_generate_parameters(int bits
,
264 unsigned char *seed
,int seed_len
,
265 int *counter_ret
, unsigned long *h_ret
,void
266 (*callback
)(int, int, void *),void *cb_arg
);
267 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
270 int DSA_generate_parameters_ex(DSA
*dsa
, int bits
,
271 const unsigned char *seed
,int seed_len
,
272 int *counter_ret
, unsigned long *h_ret
, BN_GENCB
*cb
);
274 int DSA_generate_key(DSA
*a
);
275 int i2d_DSAPublicKey(const DSA
*a
, unsigned char **pp
);
276 int i2d_DSAPrivateKey(const DSA
*a
, unsigned char **pp
);
277 int i2d_DSAparams(const DSA
*a
,unsigned char **pp
);
279 #ifndef OPENSSL_NO_BIO
280 int DSAparams_print(BIO
*bp
, const DSA
*x
);
281 int DSA_print(BIO
*bp
, const DSA
*x
, int off
);
283 #ifndef OPENSSL_NO_FP_API
284 int DSAparams_print_fp(FILE *fp
, const DSA
*x
);
285 int DSA_print_fp(FILE *bp
, const DSA
*x
, int off
);
288 #define DSS_prime_checks 50
289 /* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
290 * 50 rounds of Rabin-Miller */
291 #define DSA_is_prime(n, callback, cb_arg) \
292 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
294 #ifndef OPENSSL_NO_DH
295 /* Convert DSA structure (key or just parameters) into DH structure
296 * (be careful to avoid small subgroup attacks when using this!) */
297 DH
*DSA_dup_DH(const DSA
*r
);
300 #define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
301 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
302 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
304 #define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
305 #define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
306 #define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
308 /* BEGIN ERROR CODES */
309 /* The following lines are auto generated by the script mkerr.pl. Any changes
310 * made after this point may be overwritten when the script is next run.
312 void ERR_load_DSA_strings(void);
314 /* Error codes for the DSA functions. */
316 /* Function codes. */
317 #define DSA_F_D2I_DSA_SIG 110
318 #define DSA_F_DO_DSA_PRINT 104
319 #define DSA_F_DSAPARAMS_PRINT 100
320 #define DSA_F_DSAPARAMS_PRINT_FP 101
321 #define DSA_F_DSA_BUILTIN_KEYGEN 124
322 #define DSA_F_DSA_BUILTIN_PARAMGEN 125
323 #define DSA_F_DSA_BUILTIN_PARAMGEN2 126
324 #define DSA_F_DSA_DO_SIGN 112
325 #define DSA_F_DSA_DO_VERIFY 113
326 #define DSA_F_DSA_NEW_METHOD 103
327 #define DSA_F_DSA_PARAM_DECODE 119
328 #define DSA_F_DSA_PRINT_FP 105
329 #define DSA_F_DSA_PRIV_DECODE 115
330 #define DSA_F_DSA_PRIV_ENCODE 116
331 #define DSA_F_DSA_PUB_DECODE 117
332 #define DSA_F_DSA_PUB_ENCODE 118
333 #define DSA_F_DSA_SIGN 106
334 #define DSA_F_DSA_SIGN_SETUP 107
335 #define DSA_F_DSA_SIG_NEW 109
336 #define DSA_F_DSA_SIG_PRINT 123
337 #define DSA_F_DSA_VERIFY 108
338 #define DSA_F_I2D_DSA_SIG 111
339 #define DSA_F_OLD_DSA_PRIV_DECODE 122
340 #define DSA_F_PKEY_DSA_CTRL 120
341 #define DSA_F_PKEY_DSA_KEYGEN 121
342 #define DSA_F_SIG_CB 114
345 #define DSA_R_BAD_Q_VALUE 102
346 #define DSA_R_BN_DECODE_ERROR 108
347 #define DSA_R_BN_ERROR 109
348 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100
349 #define DSA_R_DECODE_ERROR 104
350 #define DSA_R_INVALID_DIGEST_TYPE 106
351 #define DSA_R_INVALID_PARAMETERS 112
352 #define DSA_R_KEY_SIZE_TOO_SMALL 111
353 #define DSA_R_MISSING_PARAMETERS 101
354 #define DSA_R_MODULUS_TOO_LARGE 103
355 #define DSA_R_NEED_NEW_SETUP_VALUES 110
356 #define DSA_R_NONCE_CANNOT_BE_PRECOMPUTED 114
357 #define DSA_R_NO_PARAMETERS_SET 107
358 #define DSA_R_PARAMETER_ENCODING_ERROR 105
359 #define DSA_R_Q_NOT_PRIME 113