Add DSA_bits() function.
[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 # if OPENSSL_API_COMPAT < 0x10100000L
42 /*
43  * Does nothing. Previously this switched off constant time behaviour.
44  */
45 #  define DSA_FLAG_NO_EXP_CONSTTIME       0x00
46 # endif
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(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
85 int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s);
86
87 DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
88 int DSA_do_verify(const unsigned char *dgst, int dgst_len,
89                   DSA_SIG *sig, DSA *dsa);
90
91 const DSA_METHOD *DSA_OpenSSL(void);
92
93 void DSA_set_default_method(const DSA_METHOD *);
94 const DSA_METHOD *DSA_get_default_method(void);
95 int DSA_set_method(DSA *dsa, const DSA_METHOD *);
96 const DSA_METHOD *DSA_get_method(DSA *d);
97
98 DSA *DSA_new(void);
99 DSA *DSA_new_method(ENGINE *engine);
100 void DSA_free(DSA *r);
101 /* "up" the DSA object's reference count */
102 int DSA_up_ref(DSA *r);
103 int DSA_size(const DSA *);
104 int DSA_bits(const DSA *d);
105 int DSA_security_bits(const DSA *d);
106         /* next 4 return -1 on error */
107 int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
108 int DSA_sign(int type, const unsigned char *dgst, int dlen,
109              unsigned char *sig, unsigned int *siglen, DSA *dsa);
110 int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
111                const unsigned char *sigbuf, int siglen, DSA *dsa);
112 #define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
113     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
114 int DSA_set_ex_data(DSA *d, int idx, void *arg);
115 void *DSA_get_ex_data(DSA *d, int idx);
116
117 DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
118 DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
119 DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
120
121 /* Deprecated version */
122 DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
123                                                 unsigned char *seed,
124                                                 int seed_len,
125                                                 int *counter_ret,
126                                                 unsigned long *h_ret, void
127                                                  (*callback) (int, int,
128                                                               void *),
129                                                 void *cb_arg))
130
131 /* New version */
132 int DSA_generate_parameters_ex(DSA *dsa, int bits,
133                                const unsigned char *seed, int seed_len,
134                                int *counter_ret, unsigned long *h_ret,
135                                BN_GENCB *cb);
136
137 int DSA_generate_key(DSA *a);
138 int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
139 int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
140 int i2d_DSAparams(const DSA *a, unsigned char **pp);
141
142 int DSAparams_print(BIO *bp, const DSA *x);
143 int DSA_print(BIO *bp, const DSA *x, int off);
144 # ifndef OPENSSL_NO_STDIO
145 int DSAparams_print_fp(FILE *fp, const DSA *x);
146 int DSA_print_fp(FILE *bp, const DSA *x, int off);
147 # endif
148
149 # define DSS_prime_checks 50
150 /*
151  * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of
152  * Rabin-Miller
153  */
154 # define DSA_is_prime(n, callback, cb_arg) \
155         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
156
157 # ifndef OPENSSL_NO_DH
158 /*
159  * Convert DSA structure (key or just parameters) into DH structure (be
160  * careful to avoid small subgroup attacks when using this!)
161  */
162 DH *DSA_dup_DH(const DSA *r);
163 # endif
164
165 # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
166         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
167                                 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
168
169 # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS         (EVP_PKEY_ALG_CTRL + 1)
170 # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS       (EVP_PKEY_ALG_CTRL + 2)
171 # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD           (EVP_PKEY_ALG_CTRL + 3)
172
173 void DSA_get0_pqg(const DSA *d,
174                   const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
175 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
176 void DSA_get0_key(const DSA *d,
177                   const BIGNUM **pub_key, const BIGNUM **priv_key);
178 int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
179 void DSA_clear_flags(DSA *d, int flags);
180 int DSA_test_flags(const DSA *d, int flags);
181 void DSA_set_flags(DSA *d, int flags);
182 ENGINE *DSA_get0_engine(DSA *d);
183
184 DSA_METHOD *DSA_meth_new(const char *name, int flags);
185 void DSA_meth_free(DSA_METHOD *dsam);
186 DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam);
187 const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
188 int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
189 int DSA_meth_get_flags(DSA_METHOD *dsam);
190 int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
191 void *DSA_meth_get0_app_data(const DSA_METHOD *dsam);
192 int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data);
193 DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
194         (const unsigned char *, int, DSA *);
195 int DSA_meth_set_sign(DSA_METHOD *dsam,
196                        DSA_SIG *(*sign) (const unsigned char *, int, DSA *));
197 int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
198         (DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
199 int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
200         int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
201 int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
202         (const unsigned char *, int , DSA_SIG *, DSA *);
203 int DSA_meth_set_verify(DSA_METHOD *dsam,
204     int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *));
205 int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
206         (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
207          const BIGNUM *, const BIGNUM *, BN_CTX *, BN_MONT_CTX *);
208 int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
209     int (*mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
210                     const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
211                     BN_MONT_CTX *));
212 int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
213     (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
214      BN_CTX *, BN_MONT_CTX *);
215 int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
216     int (*bn_mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
217                        const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
218 int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
219 int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
220 int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *);
221 int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *));
222 int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
223         (DSA *, int, const unsigned char *, int, int *, unsigned long *,
224          BN_GENCB *);
225 int DSA_meth_set_paramgen(DSA_METHOD *dsam,
226         int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
227                          unsigned long *, BN_GENCB *));
228 int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *);
229 int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *));
230
231 /* BEGIN ERROR CODES */
232 /*
233  * The following lines are auto generated by the script mkerr.pl. Any changes
234  * made after this point may be overwritten when the script is next run.
235  */
236
237 int ERR_load_DSA_strings(void);
238
239 /* Error codes for the DSA functions. */
240
241 /* Function codes. */
242 # define DSA_F_DSAPARAMS_PRINT                            100
243 # define DSA_F_DSAPARAMS_PRINT_FP                         101
244 # define DSA_F_DSA_BUILTIN_PARAMGEN                       125
245 # define DSA_F_DSA_BUILTIN_PARAMGEN2                      126
246 # define DSA_F_DSA_DO_SIGN                                112
247 # define DSA_F_DSA_DO_VERIFY                              113
248 # define DSA_F_DSA_METH_DUP                               127
249 # define DSA_F_DSA_METH_NEW                               128
250 # define DSA_F_DSA_METH_SET1_NAME                         129
251 # define DSA_F_DSA_NEW_METHOD                             103
252 # define DSA_F_DSA_PARAM_DECODE                           119
253 # define DSA_F_DSA_PRINT_FP                               105
254 # define DSA_F_DSA_PRIV_DECODE                            115
255 # define DSA_F_DSA_PRIV_ENCODE                            116
256 # define DSA_F_DSA_PUB_DECODE                             117
257 # define DSA_F_DSA_PUB_ENCODE                             118
258 # define DSA_F_DSA_SIGN                                   106
259 # define DSA_F_DSA_SIGN_SETUP                             107
260 # define DSA_F_DSA_SIG_NEW                                102
261 # define DSA_F_OLD_DSA_PRIV_DECODE                        122
262 # define DSA_F_PKEY_DSA_CTRL                              120
263 # define DSA_F_PKEY_DSA_KEYGEN                            121
264
265 /* Reason codes. */
266 # define DSA_R_BAD_Q_VALUE                                102
267 # define DSA_R_BN_DECODE_ERROR                            108
268 # define DSA_R_BN_ERROR                                   109
269 # define DSA_R_DECODE_ERROR                               104
270 # define DSA_R_INVALID_DIGEST_TYPE                        106
271 # define DSA_R_INVALID_PARAMETERS                         112
272 # define DSA_R_MISSING_PARAMETERS                         101
273 # define DSA_R_MODULUS_TOO_LARGE                          103
274 # define DSA_R_NO_PARAMETERS_SET                          107
275 # define DSA_R_PARAMETER_ENCODING_ERROR                   105
276 # define DSA_R_Q_NOT_PRIME                                113
277
278 #  ifdef  __cplusplus
279 }
280 #  endif
281 # endif
282 #endif