]>
git.ipfire.org Git - thirdparty/openssl.git/blob - include/openssl/dsa.h
2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
11 # define OPENSSL_DSA_H
14 # include <openssl/macros.h>
15 # ifndef OPENSSL_NO_DEPRECATED_3_0
19 # include <openssl/opensslconf.h>
21 # ifndef OPENSSL_NO_DSA
25 # include <openssl/e_os2.h>
26 # include <openssl/asn1.h>
27 # include <openssl/bio.h>
28 # include <openssl/crypto.h>
29 # include <openssl/types.h>
30 # include <openssl/bn.h>
31 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
32 # include <openssl/dh.h>
34 # include <openssl/dsaerr.h>
36 # ifndef OPENSSL_DSA_MAX_MODULUS_BITS
37 # define OPENSSL_DSA_MAX_MODULUS_BITS 10000
40 # define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
42 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
44 * Does nothing. Previously this switched off constant time behaviour.
46 # define DSA_FLAG_NO_EXP_CONSTTIME 0x00
49 # ifndef OPENSSL_NO_DEPRECATED_3_0
50 # define DSA_FLAG_CACHE_MONT_P 0x01
53 * If this flag is set the DSA method is FIPS compliant and can be used in
54 * FIPS mode. This is set in the validated module method. If an application
55 * sets this flag in its own methods it is its responsibility to ensure the
56 * result is compliant.
59 # define DSA_FLAG_FIPS_METHOD 0x0400
62 * If this flag is set the operations normally disabled in FIPS mode are
63 * permitted it is then the applications responsibility to ensure that the
67 # define DSA_FLAG_NON_FIPS_ALLOW 0x0400
68 # define DSA_FLAG_FIPS_CHECKED 0x0800
69 # endif /* OPENSSL_NO_DEPRECATED_3_0 */
71 /* Already defined in ossl_typ.h */
72 /* typedef struct dsa_st DSA; */
73 /* typedef struct dsa_method DSA_METHOD; */
75 typedef struct DSA_SIG_st DSA_SIG
;
78 * TODO(3.0): consider removing the ASN.1 encoding and decoding when
79 * deserialisation is completed elsewhere.
81 # define d2i_DSAparams_fp(fp, x) \
82 (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
83 (char *(*)())d2i_DSAparams, (fp), \
84 (unsigned char **)(x))
85 # define i2d_DSAparams_fp(fp, x) \
86 ASN1_i2d_fp(i2d_DSAparams, (fp), (unsigned char *)(x))
87 # define d2i_DSAparams_bio(bp, x) \
88 ASN1_d2i_bio_of(DSA, DSA_new, d2i_DSAparams, bp, x)
89 # define i2d_DSAparams_bio(bp, x) \
90 ASN1_i2d_bio_of(DSA, i2d_DSAparams, bp, x)
92 DECLARE_ASN1_DUP_FUNCTION_name(DSA
, DSAparams
)
93 DSA_SIG
*DSA_SIG_new(void);
94 void DSA_SIG_free(DSA_SIG
*a
);
95 DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA_SIG
, DSA_SIG
)
96 void DSA_SIG_get0(const DSA_SIG
*sig
, const BIGNUM
**pr
, const BIGNUM
**ps
);
97 int DSA_SIG_set0(DSA_SIG
*sig
, BIGNUM
*r
, BIGNUM
*s
);
99 DEPRECATEDIN_3_0(DSA_SIG
*DSA_do_sign(const unsigned char *dgst
, int dlen
,
101 DEPRECATEDIN_3_0(int DSA_do_verify(const unsigned char *dgst
, int dgst_len
,
102 DSA_SIG
*sig
, DSA
*dsa
))
104 DEPRECATEDIN_3_0(const DSA_METHOD
*DSA_OpenSSL(void))
106 DEPRECATEDIN_3_0(void DSA_set_default_method(const DSA_METHOD
*))
107 DEPRECATEDIN_3_0(const DSA_METHOD
*DSA_get_default_method(void))
108 DEPRECATEDIN_3_0(int DSA_set_method(DSA
*dsa
, const DSA_METHOD
*))
109 DEPRECATEDIN_3_0(const DSA_METHOD
*DSA_get_method(DSA
*d
))
112 DEPRECATEDIN_3_0(DSA
*DSA_new_method(ENGINE
*engine
))
113 void DSA_free(DSA
*r
);
114 /* "up" the DSA object's reference count */
115 int DSA_up_ref(DSA
*r
);
116 DEPRECATEDIN_3_0(int DSA_size(const DSA
*))
117 DEPRECATEDIN_3_0(int DSA_bits(const DSA
*d
))
118 DEPRECATEDIN_3_0(int DSA_security_bits(const DSA
*d
))
119 /* next 4 return -1 on error */
120 DEPRECATEDIN_3_0(int DSA_sign_setup(DSA
*dsa
, BN_CTX
*ctx_in
, BIGNUM
**kinvp
,
122 DEPRECATEDIN_3_0(int DSA_sign(int type
, const unsigned char *dgst
, int dlen
,
123 unsigned char *sig
, unsigned int *siglen
,
125 DEPRECATEDIN_3_0(int DSA_verify(int type
, const unsigned char *dgst
,
126 int dgst_len
, const unsigned char *sigbuf
,
127 int siglen
, DSA
*dsa
))
128 # ifndef OPENSSL_NO_DEPRECATED_3_0
129 # define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
130 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
132 DEPRECATEDIN_3_0(int DSA_set_ex_data(DSA
*d
, int idx
, void *arg
))
133 DEPRECATEDIN_3_0(void *DSA_get_ex_data(DSA
*d
, int idx
))
135 DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA
, DSAPublicKey
)
136 DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA
, DSAPrivateKey
)
137 DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA
, DSAparams
)
139 /* Deprecated version */
140 DEPRECATEDIN_0_9_8(DSA
*DSA_generate_parameters(int bits
,
144 unsigned long *h_ret
, void
145 (*callback
) (int, int,
150 DEPRECATEDIN_3_0(int DSA_generate_parameters_ex(DSA
*dsa
, int bits
,
151 const unsigned char *seed
,
152 int seed_len
, int *counter_ret
,
153 unsigned long *h_ret
,
156 DEPRECATEDIN_3_0(int DSA_generate_key(DSA
*a
))
158 DEPRECATEDIN_3_0(int DSAparams_print(BIO
*bp
, const DSA
*x
))
159 DEPRECATEDIN_3_0(int DSA_print(BIO
*bp
, const DSA
*x
, int off
))
160 # ifndef OPENSSL_NO_STDIO
161 DEPRECATEDIN_3_0(int DSAparams_print_fp(FILE *fp
, const DSA
*x
))
162 DEPRECATEDIN_3_0(int DSA_print_fp(FILE *bp
, const DSA
*x
, int off
))
165 # ifndef OPENSSL_NO_DEPRECATED_3_0
166 # define DSS_prime_checks 64
168 * Primality test according to FIPS PUB 186-4, Appendix C.3. Since we only
169 * have one value here we set the number of checks to 64 which is the 128 bit
170 * security level that is the highest level and valid for creating a 3072 bit
173 # define DSA_is_prime(n, callback, cb_arg) \
174 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
177 # ifndef OPENSSL_NO_DH
179 * Convert DSA structure (key or just parameters) into DH structure (be
180 * careful to avoid small subgroup attacks when using this!)
182 * TODO(3.0): figure out how to remove this monstrosity
184 DH
*DSA_dup_DH(const DSA
*r
);
187 # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
188 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
189 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
190 # define EVP_PKEY_CTX_set_dsa_paramgen_q_bits(ctx, qbits) \
191 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
192 EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS, qbits, NULL)
193 # define EVP_PKEY_CTX_set_dsa_paramgen_md(ctx, md) \
194 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
195 EVP_PKEY_CTRL_DSA_PARAMGEN_MD, 0, (void *)(md))
197 # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
198 # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
199 # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
201 void DSA_get0_pqg(const DSA
*d
,
202 const BIGNUM
**p
, const BIGNUM
**q
, const BIGNUM
**g
);
203 int DSA_set0_pqg(DSA
*d
, BIGNUM
*p
, BIGNUM
*q
, BIGNUM
*g
);
204 void DSA_get0_key(const DSA
*d
,
205 const BIGNUM
**pub_key
, const BIGNUM
**priv_key
);
206 int DSA_set0_key(DSA
*d
, BIGNUM
*pub_key
, BIGNUM
*priv_key
);
207 const BIGNUM
*DSA_get0_p(const DSA
*d
);
208 const BIGNUM
*DSA_get0_q(const DSA
*d
);
209 const BIGNUM
*DSA_get0_g(const DSA
*d
);
210 const BIGNUM
*DSA_get0_pub_key(const DSA
*d
);
211 const BIGNUM
*DSA_get0_priv_key(const DSA
*d
);
212 void DSA_clear_flags(DSA
*d
, int flags
);
213 int DSA_test_flags(const DSA
*d
, int flags
);
214 void DSA_set_flags(DSA
*d
, int flags
);
215 DEPRECATEDIN_3_0(ENGINE
*DSA_get0_engine(DSA
*d
))
217 DEPRECATEDIN_3_0(DSA_METHOD
*DSA_meth_new(const char *name
, int flags
))
218 DEPRECATEDIN_3_0(void DSA_meth_free(DSA_METHOD
*dsam
))
219 DEPRECATEDIN_3_0(DSA_METHOD
*DSA_meth_dup(const DSA_METHOD
*dsam
))
220 DEPRECATEDIN_3_0(const char *DSA_meth_get0_name(const DSA_METHOD
*dsam
))
221 DEPRECATEDIN_3_0(int DSA_meth_set1_name(DSA_METHOD
*dsam
, const char *name
))
222 DEPRECATEDIN_3_0(int DSA_meth_get_flags(const DSA_METHOD
*dsam
))
223 DEPRECATEDIN_3_0(int DSA_meth_set_flags(DSA_METHOD
*dsam
, int flags
))
224 DEPRECATEDIN_3_0(void *DSA_meth_get0_app_data(const DSA_METHOD
*dsam
))
225 DEPRECATEDIN_3_0(int DSA_meth_set0_app_data(DSA_METHOD
*dsam
, void *app_data
))
226 DEPRECATEDIN_3_0(DSA_SIG
*(*DSA_meth_get_sign(const DSA_METHOD
*dsam
))
227 (const unsigned char *, int, DSA
*))
228 DEPRECATEDIN_3_0(int DSA_meth_set_sign(DSA_METHOD
*dsam
,
229 DSA_SIG
*(*sign
) (const unsigned char *, int, DSA
*)))
230 DEPRECATEDIN_3_0(int (*DSA_meth_get_sign_setup(const DSA_METHOD
*dsam
))
231 (DSA
*, BN_CTX
*, BIGNUM
**, BIGNUM
**))
232 DEPRECATEDIN_3_0(int DSA_meth_set_sign_setup(DSA_METHOD
*dsam
,
233 int (*sign_setup
) (DSA
*, BN_CTX
*, BIGNUM
**, BIGNUM
**)))
234 DEPRECATEDIN_3_0(int (*DSA_meth_get_verify(const DSA_METHOD
*dsam
))
235 (const unsigned char *, int, DSA_SIG
*, DSA
*))
236 DEPRECATEDIN_3_0(int DSA_meth_set_verify(DSA_METHOD
*dsam
,
237 int (*verify
) (const unsigned char *, int, DSA_SIG
*, DSA
*)))
238 DEPRECATEDIN_3_0(int (*DSA_meth_get_mod_exp(const DSA_METHOD
*dsam
))
239 (DSA
*, BIGNUM
*, const BIGNUM
*, const BIGNUM
*, const BIGNUM
*,
240 const BIGNUM
*, const BIGNUM
*, BN_CTX
*, BN_MONT_CTX
*))
241 DEPRECATEDIN_3_0(int DSA_meth_set_mod_exp(DSA_METHOD
*dsam
,
242 int (*mod_exp
) (DSA
*, BIGNUM
*, const BIGNUM
*, const BIGNUM
*,
243 const BIGNUM
*, const BIGNUM
*, const BIGNUM
*, BN_CTX
*,
245 DEPRECATEDIN_3_0(int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD
*dsam
))
246 (DSA
*, BIGNUM
*, const BIGNUM
*, const BIGNUM
*, const BIGNUM
*,
247 BN_CTX
*, BN_MONT_CTX
*))
248 DEPRECATEDIN_3_0(int DSA_meth_set_bn_mod_exp(DSA_METHOD
*dsam
,
249 int (*bn_mod_exp
) (DSA
*, BIGNUM
*, const BIGNUM
*, const BIGNUM
*,
250 const BIGNUM
*, BN_CTX
*, BN_MONT_CTX
*)))
251 DEPRECATEDIN_3_0(int (*DSA_meth_get_init(const DSA_METHOD
*dsam
))(DSA
*))
252 DEPRECATEDIN_3_0(int DSA_meth_set_init(DSA_METHOD
*dsam
, int (*init
)(DSA
*)))
253 DEPRECATEDIN_3_0(int (*DSA_meth_get_finish(const DSA_METHOD
*dsam
)) (DSA
*))
254 DEPRECATEDIN_3_0(int DSA_meth_set_finish(DSA_METHOD
*dsam
, int (*finish
) (DSA
*)))
255 DEPRECATEDIN_3_0(int (*DSA_meth_get_paramgen(const DSA_METHOD
*dsam
))
256 (DSA
*, int, const unsigned char *, int, int *, unsigned long *,
258 DEPRECATEDIN_3_0(int DSA_meth_set_paramgen(DSA_METHOD
*dsam
,
259 int (*paramgen
) (DSA
*, int, const unsigned char *, int, int *,
260 unsigned long *, BN_GENCB
*)))
261 DEPRECATEDIN_3_0(int (*DSA_meth_get_keygen(const DSA_METHOD
*dsam
)) (DSA
*))
262 DEPRECATEDIN_3_0(int DSA_meth_set_keygen(DSA_METHOD
*dsam
, int (*keygen
) (DSA
*)))