Simplify dsa_ossl.c
[openssl.git] / include / openssl / dsa.h
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /*
11  * The DSS routines are based on patches supplied by
12  * Steven Schoch <schoch@sheba.arc.nasa.gov>.
13  */
14
15 #ifndef HEADER_DSA_H
16 # define HEADER_DSA_H
17
18 # include <openssl/opensslconf.h>
19
20 # ifndef OPENSSL_NO_DSA
21 # ifdef  __cplusplus
22 extern "C" {
23 # endif
24 # include <openssl/e_os2.h>
25 # include <openssl/bio.h>
26 # include <openssl/crypto.h>
27 # include <openssl/ossl_typ.h>
28 # include <openssl/opensslconf.h>
29 # include <openssl/bn.h>
30 # if OPENSSL_API_COMPAT < 0x10100000L
31 #  include <openssl/dh.h>
32 # endif
33
34 # ifndef OPENSSL_DSA_MAX_MODULUS_BITS
35 #  define OPENSSL_DSA_MAX_MODULUS_BITS   10000
36 # endif
37
38 # define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
39
40 # define DSA_FLAG_CACHE_MONT_P   0x01
41 /*
42  * new with 0.9.7h; the built-in DSA implementation now uses constant time
43  * modular exponentiation for secret exponents by default. This flag causes
44  * the faster variable sliding window method to be used for all exponents.
45  */
46 # define DSA_FLAG_NO_EXP_CONSTTIME       0x02
47
48 /*
49  * If this flag is set the DSA method is FIPS compliant and can be used in
50  * FIPS mode. This is set in the validated module method. If an application
51  * sets this flag in its own methods it is its responsibility to ensure the
52  * result is compliant.
53  */
54
55 # define DSA_FLAG_FIPS_METHOD                    0x0400
56
57 /*
58  * If this flag is set the operations normally disabled in FIPS mode are
59  * permitted it is then the applications responsibility to ensure that the
60  * usage is compliant.
61  */
62
63 # define DSA_FLAG_NON_FIPS_ALLOW                 0x0400
64 # define DSA_FLAG_FIPS_CHECKED                   0x0800
65
66 /* Already defined in ossl_typ.h */
67 /* typedef struct dsa_st DSA; */
68 /* typedef struct dsa_method DSA_METHOD; */
69
70 typedef struct DSA_SIG_st DSA_SIG;
71
72 # define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
73                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
74 # define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
75                 (unsigned char *)(x))
76 # define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
77 # define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
78
79 DSA *DSAparams_dup(DSA *x);
80 DSA_SIG *DSA_SIG_new(void);
81 void DSA_SIG_free(DSA_SIG *a);
82 int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
83 DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
84 void DSA_SIG_get0(BIGNUM **pr, BIGNUM **ps, const DSA_SIG *sig);
85
86 DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
87 int DSA_do_verify(const unsigned char *dgst, int dgst_len,
88                   DSA_SIG *sig, DSA *dsa);
89
90 const DSA_METHOD *DSA_OpenSSL(void);
91
92 void DSA_set_default_method(const DSA_METHOD *);
93 const DSA_METHOD *DSA_get_default_method(void);
94 int DSA_set_method(DSA *dsa, const DSA_METHOD *);
95 const DSA_METHOD *DSA_get_method(DSA *d);
96
97 DSA *DSA_new(void);
98 DSA *DSA_new_method(ENGINE *engine);
99 void DSA_free(DSA *r);
100 /* "up" the DSA object's reference count */
101 int DSA_up_ref(DSA *r);
102 int DSA_size(const DSA *);
103 int DSA_security_bits(const DSA *d);
104         /* next 4 return -1 on error */
105 int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
106 int DSA_sign(int type, const unsigned char *dgst, int dlen,
107              unsigned char *sig, unsigned int *siglen, DSA *dsa);
108 int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
109                const unsigned char *sigbuf, int siglen, DSA *dsa);
110 #define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
111     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
112 int DSA_set_ex_data(DSA *d, int idx, void *arg);
113 void *DSA_get_ex_data(DSA *d, int idx);
114
115 DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
116 DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
117 DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
118
119 /* Deprecated version */
120 DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
121                                                 unsigned char *seed,
122                                                 int seed_len,
123                                                 int *counter_ret,
124                                                 unsigned long *h_ret, void
125                                                  (*callback) (int, int,
126                                                               void *),
127                                                 void *cb_arg))
128
129 /* New version */
130 int DSA_generate_parameters_ex(DSA *dsa, int bits,
131                                const unsigned char *seed, int seed_len,
132                                int *counter_ret, unsigned long *h_ret,
133                                BN_GENCB *cb);
134
135 int DSA_generate_key(DSA *a);
136 int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
137 int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
138 int i2d_DSAparams(const DSA *a, unsigned char **pp);
139
140 int DSAparams_print(BIO *bp, const DSA *x);
141 int DSA_print(BIO *bp, const DSA *x, int off);
142 # ifndef OPENSSL_NO_STDIO
143 int DSAparams_print_fp(FILE *fp, const DSA *x);
144 int DSA_print_fp(FILE *bp, const DSA *x, int off);
145 # endif
146
147 # define DSS_prime_checks 50
148 /*
149  * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of
150  * Rabin-Miller
151  */
152 # define DSA_is_prime(n, callback, cb_arg) \
153         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
154
155 # ifndef OPENSSL_NO_DH
156 /*
157  * Convert DSA structure (key or just parameters) into DH structure (be
158  * careful to avoid small subgroup attacks when using this!)
159  */
160 DH *DSA_dup_DH(const DSA *r);
161 # endif
162
163 # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
164         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
165                                 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
166
167 # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS         (EVP_PKEY_ALG_CTRL + 1)
168 # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS       (EVP_PKEY_ALG_CTRL + 2)
169 # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD           (EVP_PKEY_ALG_CTRL + 3)
170
171 void DSA_get0_pqg(const DSA *d, BIGNUM **p, BIGNUM **q, BIGNUM **g);
172 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
173 void DSA_get0_key(const DSA *d, BIGNUM **pub_key, BIGNUM **priv_key);
174 int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
175 void DSA_clear_flags(DSA *d, int flags);
176 int DSA_test_flags(const DSA *d, int flags);
177 void DSA_set_flags(DSA *d, int flags);
178 ENGINE *DSA_get0_engine(DSA *d);
179
180 DSA_METHOD *DSA_meth_new(const char *name, int flags);
181 void DSA_meth_free(DSA_METHOD *dsam);
182 DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam);
183 const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
184 int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
185 int DSA_meth_get_flags(DSA_METHOD *dsam);
186 int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
187 void *DSA_meth_get0_app_data(const DSA_METHOD *dsam);
188 int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data);
189 DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
190         (const unsigned char *, int, DSA *);
191 int DSA_meth_set_sign(DSA_METHOD *dsam,
192                        DSA_SIG *(*sign) (const unsigned char *, int, DSA *));
193 int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
194         (DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
195 int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
196         int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
197 int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
198         (const unsigned char *, int , DSA_SIG *, DSA *);
199 int DSA_meth_set_verify(DSA_METHOD *dsam,
200     int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *));
201 int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
202         (DSA *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *,
203          BN_CTX *, BN_MONT_CTX *);
204 int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
205     int (*mod_exp) (DSA *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *,
206                     BIGNUM *, BN_CTX *, BN_MONT_CTX *));
207 int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
208     (DSA *, BIGNUM *, BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
209      BN_MONT_CTX *);
210 int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
211     int (*bn_mod_exp) (DSA *, BIGNUM *, BIGNUM *, const BIGNUM *,
212                        const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
213 int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
214 int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
215 int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *);
216 int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *));
217 int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
218         (DSA *, int, const unsigned char *, int, int *, unsigned long *,
219          BN_GENCB *);
220 int DSA_meth_set_paramgen(DSA_METHOD *dsam,
221         int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
222                          unsigned long *, BN_GENCB *));
223 int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *);
224 int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *));
225
226 /* BEGIN ERROR CODES */
227 /*
228  * The following lines are auto generated by the script mkerr.pl. Any changes
229  * made after this point may be overwritten when the script is next run.
230  */
231
232 void ERR_load_DSA_strings(void);
233
234 /* Error codes for the DSA functions. */
235
236 /* Function codes. */
237 # define DSA_F_DSAPARAMS_PRINT                            100
238 # define DSA_F_DSAPARAMS_PRINT_FP                         101
239 # define DSA_F_DSA_BUILTIN_PARAMGEN                       125
240 # define DSA_F_DSA_BUILTIN_PARAMGEN2                      126
241 # define DSA_F_DSA_DO_SIGN                                112
242 # define DSA_F_DSA_DO_VERIFY                              113
243 # define DSA_F_DSA_METH_DUP                               127
244 # define DSA_F_DSA_METH_NEW                               128
245 # define DSA_F_DSA_METH_SET1_NAME                         129
246 # define DSA_F_DSA_NEW_METHOD                             103
247 # define DSA_F_DSA_PARAM_DECODE                           119
248 # define DSA_F_DSA_PRINT_FP                               105
249 # define DSA_F_DSA_PRIV_DECODE                            115
250 # define DSA_F_DSA_PRIV_ENCODE                            116
251 # define DSA_F_DSA_PUB_DECODE                             117
252 # define DSA_F_DSA_PUB_ENCODE                             118
253 # define DSA_F_DSA_SIGN                                   106
254 # define DSA_F_DSA_SIGN_SETUP                             107
255 # define DSA_F_OLD_DSA_PRIV_DECODE                        122
256 # define DSA_F_PKEY_DSA_CTRL                              120
257 # define DSA_F_PKEY_DSA_KEYGEN                            121
258
259 /* Reason codes. */
260 # define DSA_R_BAD_Q_VALUE                                102
261 # define DSA_R_BN_DECODE_ERROR                            108
262 # define DSA_R_BN_ERROR                                   109
263 # define DSA_R_DECODE_ERROR                               104
264 # define DSA_R_INVALID_DIGEST_TYPE                        106
265 # define DSA_R_INVALID_PARAMETERS                         112
266 # define DSA_R_MISSING_PARAMETERS                         101
267 # define DSA_R_MODULUS_TOO_LARGE                          103
268 # define DSA_R_NO_PARAMETERS_SET                          107
269 # define DSA_R_PARAMETER_ENCODING_ERROR                   105
270 # define DSA_R_Q_NOT_PRIME                                113
271
272 #  ifdef  __cplusplus
273 }
274 #  endif
275 # endif
276 #endif