]> git.ipfire.org Git - thirdparty/openssl.git/blame_incremental - include/openssl/dsa.h
Adapt some test recipes to the newer cmdstr()
[thirdparty/openssl.git] / include / openssl / dsa.h
... / ...
CommitLineData
1/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
56 */
57
58/*
59 * The DSS routines are based on patches supplied by
60 * Steven Schoch <schoch@sheba.arc.nasa.gov>.
61 */
62
63#ifndef HEADER_DSA_H
64# define HEADER_DSA_H
65
66# include <openssl/opensslconf.h>
67
68# ifndef OPENSSL_NO_DSA
69# ifdef __cplusplus
70extern "C" {
71# endif
72# include <openssl/e_os2.h>
73# include <openssl/bio.h>
74# include <openssl/crypto.h>
75# include <openssl/ossl_typ.h>
76# include <openssl/opensslconf.h>
77# if OPENSSL_API_COMPAT < 0x10100000L
78# include <openssl/bn.h>
79# include <openssl/dh.h>
80# endif
81
82# ifndef OPENSSL_DSA_MAX_MODULUS_BITS
83# define OPENSSL_DSA_MAX_MODULUS_BITS 10000
84# endif
85
86# define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
87
88# define DSA_FLAG_CACHE_MONT_P 0x01
89/*
90 * new with 0.9.7h; the built-in DSA implementation now uses constant time
91 * modular exponentiation for secret exponents by default. This flag causes
92 * the faster variable sliding window method to be used for all exponents.
93 */
94# define DSA_FLAG_NO_EXP_CONSTTIME 0x02
95
96/*
97 * If this flag is set the DSA method is FIPS compliant and can be used in
98 * FIPS mode. This is set in the validated module method. If an application
99 * sets this flag in its own methods it is its reposibility to ensure the
100 * result is compliant.
101 */
102
103# define DSA_FLAG_FIPS_METHOD 0x0400
104
105/*
106 * If this flag is set the operations normally disabled in FIPS mode are
107 * permitted it is then the applications responsibility to ensure that the
108 * usage is compliant.
109 */
110
111# define DSA_FLAG_NON_FIPS_ALLOW 0x0400
112# define DSA_FLAG_FIPS_CHECKED 0x0800
113
114/* Already defined in ossl_typ.h */
115/* typedef struct dsa_st DSA; */
116/* typedef struct dsa_method DSA_METHOD; */
117
118typedef struct DSA_SIG_st DSA_SIG;
119
120struct dsa_method {
121 const char *name;
122 DSA_SIG *(*dsa_do_sign) (const unsigned char *dgst, int dlen, DSA *dsa);
123 int (*dsa_sign_setup) (DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
124 BIGNUM **rp);
125 int (*dsa_do_verify) (const unsigned char *dgst, int dgst_len,
126 DSA_SIG *sig, DSA *dsa);
127 int (*dsa_mod_exp) (DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
128 BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
129 BN_MONT_CTX *in_mont);
130 /* Can be null */
131 int (*bn_mod_exp) (DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
132 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
133 int (*init) (DSA *dsa);
134 int (*finish) (DSA *dsa);
135 int flags;
136 char *app_data;
137 /* If this is non-NULL, it is used to generate DSA parameters */
138 int (*dsa_paramgen) (DSA *dsa, int bits,
139 const unsigned char *seed, int seed_len,
140 int *counter_ret, unsigned long *h_ret,
141 BN_GENCB *cb);
142 /* If this is non-NULL, it is used to generate DSA keys */
143 int (*dsa_keygen) (DSA *dsa);
144};
145
146struct dsa_st {
147 /*
148 * This first variable is used to pick up errors where a DSA is passed
149 * instead of of a EVP_PKEY
150 */
151 int pad;
152 long version;
153 BIGNUM *p;
154 BIGNUM *q; /* == 20 */
155 BIGNUM *g;
156 BIGNUM *pub_key; /* y public key */
157 BIGNUM *priv_key; /* x private key */
158 int flags;
159 /* Normally used to cache montgomery values */
160 BN_MONT_CTX *method_mont_p;
161 int references;
162 CRYPTO_EX_DATA ex_data;
163 const DSA_METHOD *meth;
164 /* functional reference if 'meth' is ENGINE-provided */
165 ENGINE *engine;
166 CRYPTO_RWLOCK *lock;
167};
168
169# define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
170 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
171# define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
172 (unsigned char *)(x))
173# define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
174# define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
175
176DSA *DSAparams_dup(DSA *x);
177DSA_SIG *DSA_SIG_new(void);
178void DSA_SIG_free(DSA_SIG *a);
179int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
180DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
181void DSA_SIG_get0(BIGNUM **pr, BIGNUM **ps, const DSA_SIG *sig);
182
183DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
184int DSA_do_verify(const unsigned char *dgst, int dgst_len,
185 DSA_SIG *sig, DSA *dsa);
186
187const DSA_METHOD *DSA_OpenSSL(void);
188
189void DSA_set_default_method(const DSA_METHOD *);
190const DSA_METHOD *DSA_get_default_method(void);
191int DSA_set_method(DSA *dsa, const DSA_METHOD *);
192
193DSA *DSA_new(void);
194DSA *DSA_new_method(ENGINE *engine);
195void DSA_free(DSA *r);
196/* "up" the DSA object's reference count */
197int DSA_up_ref(DSA *r);
198int DSA_size(const DSA *);
199int DSA_security_bits(const DSA *d);
200 /* next 4 return -1 on error */
201int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
202int DSA_sign(int type, const unsigned char *dgst, int dlen,
203 unsigned char *sig, unsigned int *siglen, DSA *dsa);
204int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
205 const unsigned char *sigbuf, int siglen, DSA *dsa);
206#define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
207 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
208int DSA_set_ex_data(DSA *d, int idx, void *arg);
209void *DSA_get_ex_data(DSA *d, int idx);
210
211DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
212DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
213DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
214
215/* Deprecated version */
216DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
217 unsigned char *seed,
218 int seed_len,
219 int *counter_ret,
220 unsigned long *h_ret, void
221 (*callback) (int, int,
222 void *),
223 void *cb_arg))
224
225/* New version */
226int DSA_generate_parameters_ex(DSA *dsa, int bits,
227 const unsigned char *seed, int seed_len,
228 int *counter_ret, unsigned long *h_ret,
229 BN_GENCB *cb);
230
231int DSA_generate_key(DSA *a);
232int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
233int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
234int i2d_DSAparams(const DSA *a, unsigned char **pp);
235
236int DSAparams_print(BIO *bp, const DSA *x);
237int DSA_print(BIO *bp, const DSA *x, int off);
238# ifndef OPENSSL_NO_STDIO
239int DSAparams_print_fp(FILE *fp, const DSA *x);
240int DSA_print_fp(FILE *bp, const DSA *x, int off);
241# endif
242
243# define DSS_prime_checks 50
244/*
245 * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of
246 * Rabin-Miller
247 */
248# define DSA_is_prime(n, callback, cb_arg) \
249 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
250
251# ifndef OPENSSL_NO_DH
252/*
253 * Convert DSA structure (key or just parameters) into DH structure (be
254 * careful to avoid small subgroup attacks when using this!)
255 */
256DH *DSA_dup_DH(const DSA *r);
257# endif
258
259# define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
260 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
261 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
262
263# define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
264# define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
265# define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
266
267/* BEGIN ERROR CODES */
268/*
269 * The following lines are auto generated by the script mkerr.pl. Any changes
270 * made after this point may be overwritten when the script is next run.
271 */
272void ERR_load_DSA_strings(void);
273
274/* Error codes for the DSA functions. */
275
276/* Function codes. */
277# define DSA_F_D2I_DSA_SIG 110
278# define DSA_F_DO_DSA_PRINT 104
279# define DSA_F_DSAPARAMS_PRINT 100
280# define DSA_F_DSAPARAMS_PRINT_FP 101
281# define DSA_F_DSA_BUILTIN_KEYGEN 124
282# define DSA_F_DSA_BUILTIN_PARAMGEN 125
283# define DSA_F_DSA_BUILTIN_PARAMGEN2 126
284# define DSA_F_DSA_DO_SIGN 112
285# define DSA_F_DSA_DO_VERIFY 113
286# define DSA_F_DSA_NEW_METHOD 103
287# define DSA_F_DSA_PARAM_DECODE 119
288# define DSA_F_DSA_PRINT_FP 105
289# define DSA_F_DSA_PRIV_DECODE 115
290# define DSA_F_DSA_PRIV_ENCODE 116
291# define DSA_F_DSA_PUB_DECODE 117
292# define DSA_F_DSA_PUB_ENCODE 118
293# define DSA_F_DSA_SIGN 106
294# define DSA_F_DSA_SIGN_SETUP 107
295# define DSA_F_DSA_SIG_NEW 109
296# define DSA_F_DSA_SIG_PRINT 123
297# define DSA_F_DSA_VERIFY 108
298# define DSA_F_I2D_DSA_SIG 111
299# define DSA_F_OLD_DSA_PRIV_DECODE 122
300# define DSA_F_PKEY_DSA_CTRL 120
301# define DSA_F_PKEY_DSA_KEYGEN 121
302# define DSA_F_SIG_CB 114
303
304/* Reason codes. */
305# define DSA_R_BAD_Q_VALUE 102
306# define DSA_R_BN_DECODE_ERROR 108
307# define DSA_R_BN_ERROR 109
308# define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100
309# define DSA_R_DECODE_ERROR 104
310# define DSA_R_INVALID_DIGEST_TYPE 106
311# define DSA_R_INVALID_PARAMETERS 112
312# define DSA_R_KEY_SIZE_TOO_SMALL 111
313# define DSA_R_MISSING_PARAMETERS 101
314# define DSA_R_MODULUS_TOO_LARGE 103
315# define DSA_R_NEED_NEW_SETUP_VALUES 110
316# define DSA_R_NO_PARAMETERS_SET 107
317# define DSA_R_PARAMETER_ENCODING_ERROR 105
318# define DSA_R_Q_NOT_PRIME 113
319
320# ifdef __cplusplus
321}
322# endif
323# endif
324
325#endif