]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/dsa.h
dsa: provider and library deprecation changes
[thirdparty/openssl.git] / include / openssl / dsa.h
CommitLineData
21dcbebc 1/*
33388b44 2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
0f113f3e 3 *
48f4ad77 4 * Licensed under the Apache License 2.0 (the "License"). You may not use
21dcbebc
RS
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
d02b48c6
RE
8 */
9
ae4186b0
DMSP
10#ifndef OPENSSL_DSA_H
11# define OPENSSL_DSA_H
d86167ec
DMSP
12# pragma once
13
14# include <openssl/macros.h>
936c2b9e 15# ifndef OPENSSL_NO_DEPRECATED_3_0
d86167ec
DMSP
16# define HEADER_DSA_H
17# endif
d02b48c6 18
3c27208f 19# include <openssl/opensslconf.h>
888bdbfd 20# include <openssl/types.h>
751ff1d3 21
888bdbfd 22# ifdef __cplusplus
3c27208f 23extern "C" {
888bdbfd
RL
24# endif
25
26# include <stdlib.h>
27
28int EVP_PKEY_CTX_set_dsa_paramgen_bits(EVP_PKEY_CTX *ctx, int nbits);
29int EVP_PKEY_CTX_set_dsa_paramgen_q_bits(EVP_PKEY_CTX *ctx, int qbits);
30int EVP_PKEY_CTX_set_dsa_paramgen_md_props(EVP_PKEY_CTX *ctx,
31 const char *md_name,
32 const char *md_properties);
33int EVP_PKEY_CTX_set_dsa_paramgen_gindex(EVP_PKEY_CTX *ctx, int gindex);
34int EVP_PKEY_CTX_set_dsa_paramgen_type(EVP_PKEY_CTX *ctx, const char *name);
35int EVP_PKEY_CTX_set_dsa_paramgen_seed(EVP_PKEY_CTX *ctx,
36 const unsigned char *seed,
37 size_t seedlen);
38int EVP_PKEY_CTX_set_dsa_paramgen_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
39
40# define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
41# define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
42# define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
43
44# ifndef OPENSSL_NO_DSA
7f6deaf6
P
45# include <openssl/e_os2.h>
46# include <openssl/asn1.h>
47# include <openssl/bio.h>
48# include <openssl/crypto.h>
7f6deaf6
P
49# include <openssl/bn.h>
50# ifndef OPENSSL_NO_DEPRECATED_1_1_0
51# include <openssl/dh.h>
52# endif
53# include <openssl/dsaerr.h>
d02b48c6 54
7f6deaf6
P
55# ifndef OPENSSL_DSA_MAX_MODULUS_BITS
56# define OPENSSL_DSA_MAX_MODULUS_BITS 10000
57# endif
0f113f3e 58
7f6deaf6 59# define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
5e3225cc 60
52c8535a
P
61typedef struct DSA_SIG_st DSA_SIG;
62DSA_SIG *DSA_SIG_new(void);
63void DSA_SIG_free(DSA_SIG *a);
64DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA_SIG, DSA_SIG)
65void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
66int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s);
67
68
7f6deaf6 69# ifndef OPENSSL_NO_DEPRECATED_1_1_0
0f113f3e 70/*
5584f65a 71 * Does nothing. Previously this switched off constant time behaviour.
68d39f3c 72 */
7f6deaf6
P
73# define DSA_FLAG_NO_EXP_CONSTTIME 0x00
74# endif
dfeab068 75
f41ac0ee
P
76# ifndef OPENSSL_NO_DEPRECATED_3_0
77# define DSA_FLAG_CACHE_MONT_P 0x01
78
0f113f3e
MC
79/*
80 * If this flag is set the DSA method is FIPS compliant and can be used in
81 * FIPS mode. This is set in the validated module method. If an application
8483a003 82 * sets this flag in its own methods it is its responsibility to ensure the
0f113f3e 83 * result is compliant.
20818e00
DSH
84 */
85
f41ac0ee 86# define DSA_FLAG_FIPS_METHOD 0x0400
20818e00 87
0f113f3e
MC
88/*
89 * If this flag is set the operations normally disabled in FIPS mode are
20818e00
DSH
90 * permitted it is then the applications responsibility to ensure that the
91 * usage is compliant.
92 */
93
f41ac0ee
P
94# define DSA_FLAG_NON_FIPS_ALLOW 0x0400
95# define DSA_FLAG_FIPS_CHECKED 0x0800
20818e00 96
3a87a9b9
GT
97/* Already defined in ossl_typ.h */
98/* typedef struct dsa_st DSA; */
99/* typedef struct dsa_method DSA_METHOD; */
c0711f7f 100
f41ac0ee
P
101/*
102 * TODO(3.0): consider removing the ASN.1 encoding and decoding when
aa97970c 103 * deserialization is completed elsewhere.
f41ac0ee 104 */
52c8535a 105# define d2i_DSAparams_fp(fp, x) \
7f6deaf6
P
106 (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
107 (char *(*)())d2i_DSAparams, (fp), \
108 (unsigned char **)(x))
52c8535a 109# define i2d_DSAparams_fp(fp, x) \
f41ac0ee 110 ASN1_i2d_fp(i2d_DSAparams, (fp), (unsigned char *)(x))
52c8535a 111# define d2i_DSAparams_bio(bp, x) \
7f6deaf6 112 ASN1_d2i_bio_of(DSA, DSA_new, d2i_DSAparams, bp, x)
52c8535a 113# define i2d_DSAparams_bio(bp, x) \
7f6deaf6 114 ASN1_i2d_bio_of(DSA, i2d_DSAparams, bp, x)
d02b48c6 115
52c8535a
P
116DECLARE_ASN1_DUP_FUNCTION_name_attr(OSSL_DEPRECATEDIN_3_0, DSA, DSAparams)
117OSSL_DEPRECATEDIN_3_0 DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen,
118 DSA *dsa);
119OSSL_DEPRECATEDIN_3_0 int DSA_do_verify(const unsigned char *dgst, int dgst_len,
120 DSA_SIG *sig, DSA *dsa);
a8da8918 121
52c8535a 122OSSL_DEPRECATEDIN_3_0 const DSA_METHOD *DSA_OpenSSL(void);
c0711f7f 123
52c8535a
P
124OSSL_DEPRECATEDIN_3_0 void DSA_set_default_method(const DSA_METHOD *);
125OSSL_DEPRECATEDIN_3_0 const DSA_METHOD *DSA_get_default_method(void);
126OSSL_DEPRECATEDIN_3_0 int DSA_set_method(DSA *dsa, const DSA_METHOD *);
127OSSL_DEPRECATEDIN_3_0 const DSA_METHOD *DSA_get_method(DSA *d);
f8463356 128
52c8535a
P
129OSSL_DEPRECATEDIN_3_0 DSA *DSA_new(void);
130OSSL_DEPRECATEDIN_3_0 DSA *DSA_new_method(ENGINE *engine);
131OSSL_DEPRECATEDIN_3_0 void DSA_free(DSA *r);
5cbc2e8b 132/* "up" the DSA object's reference count */
52c8535a
P
133OSSL_DEPRECATEDIN_3_0 int DSA_up_ref(DSA *r);
134OSSL_DEPRECATEDIN_3_0 int DSA_size(const DSA *);
135OSSL_DEPRECATEDIN_3_0 int DSA_bits(const DSA *d);
136OSSL_DEPRECATEDIN_3_0 int DSA_security_bits(const DSA *d);
0f113f3e 137 /* next 4 return -1 on error */
52c8535a
P
138OSSL_DEPRECATEDIN_3_0 int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in,
139 BIGNUM **kinvp, BIGNUM **rp);
140OSSL_DEPRECATEDIN_3_0 int DSA_sign(int type, const unsigned char *dgst,
141 int dlen, unsigned char *sig,
142 unsigned int *siglen, DSA *dsa);
143OSSL_DEPRECATEDIN_3_0 int DSA_verify(int type, const unsigned char *dgst,
144 int dgst_len, const unsigned char *sigbuf,
145 int siglen, DSA *dsa);
146
f41ac0ee 147# define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
7f6deaf6 148 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
52c8535a
P
149OSSL_DEPRECATEDIN_3_0 int DSA_set_ex_data(DSA *d, int idx, void *arg);
150OSSL_DEPRECATEDIN_3_0 void *DSA_get_ex_data(const DSA *d, int idx);
151
152DECLARE_ASN1_ENCODE_FUNCTIONS_only_attr(OSSL_DEPRECATEDIN_3_0,
153 DSA, DSAPublicKey)
154DECLARE_ASN1_ENCODE_FUNCTIONS_only_attr(OSSL_DEPRECATEDIN_3_0,
155 DSA, DSAPrivateKey)
156DECLARE_ASN1_ENCODE_FUNCTIONS_only_attr(OSSL_DEPRECATEDIN_3_0,
157 DSA, DSAparams)
f41ac0ee 158# endif
e9224c71 159
52c8535a 160# ifndef OPENSSL_NO_DEPRECATED_0_9_8
e9224c71 161/* Deprecated version */
52c8535a
P
162OSSL_DEPRECATEDIN_0_9_8
163DSA *DSA_generate_parameters(int bits, unsigned char *seed, int seed_len,
164 int *counter_ret, unsigned long *h_ret,
165 void (*callback) (int, int, void *),
166 void *cb_arg);
7f6deaf6 167# endif
0f113f3e 168
7f6deaf6 169# ifndef OPENSSL_NO_DEPRECATED_3_0
52c8535a
P
170/* New version */
171OSSL_DEPRECATEDIN_3_0 int DSA_generate_parameters_ex(DSA *dsa, int bits,
172 const unsigned char *seed,
173 int seed_len,
174 int *counter_ret,
175 unsigned long *h_ret,
176 BN_GENCB *cb);
177
178OSSL_DEPRECATEDIN_3_0 int DSA_generate_key(DSA *a);
179
180OSSL_DEPRECATEDIN_3_0 int DSAparams_print(BIO *bp, const DSA *x);
181OSSL_DEPRECATEDIN_3_0 int DSA_print(BIO *bp, const DSA *x, int off);
182# ifndef OPENSSL_NO_STDIO
183OSSL_DEPRECATEDIN_3_0 int DSAparams_print_fp(FILE *fp, const DSA *x);
184OSSL_DEPRECATEDIN_3_0 int DSA_print_fp(FILE *bp, const DSA *x, int off);
185# endif
186
7f6deaf6 187# define DSS_prime_checks 64
0f113f3e 188/*
74ee3796
KR
189 * Primality test according to FIPS PUB 186-4, Appendix C.3. Since we only
190 * have one value here we set the number of checks to 64 which is the 128 bit
191 * security level that is the highest level and valid for creating a 3072 bit
192 * DSA key.
0f113f3e 193 */
7f6deaf6
P
194# define DSA_is_prime(n, callback, cb_arg) \
195 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
d02b48c6 196
52c8535a 197# ifndef OPENSSL_NO_DH
0f113f3e
MC
198/*
199 * Convert DSA structure (key or just parameters) into DH structure (be
200 * careful to avoid small subgroup attacks when using this!)
201 */
52c8535a
P
202OSSL_DEPRECATEDIN_3_0 DH *DSA_dup_DH(const DSA *r);
203# endif
204
205OSSL_DEPRECATEDIN_3_0 void DSA_get0_pqg(const DSA *d, const BIGNUM **p,
206 const BIGNUM **q, const BIGNUM **g);
207OSSL_DEPRECATEDIN_3_0 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
208OSSL_DEPRECATEDIN_3_0 void DSA_get0_key(const DSA *d, const BIGNUM **pub_key,
209 const BIGNUM **priv_key);
210OSSL_DEPRECATEDIN_3_0 int DSA_set0_key(DSA *d, BIGNUM *pub_key,
211 BIGNUM *priv_key);
212OSSL_DEPRECATEDIN_3_0 const BIGNUM *DSA_get0_p(const DSA *d);
213OSSL_DEPRECATEDIN_3_0 const BIGNUM *DSA_get0_q(const DSA *d);
214OSSL_DEPRECATEDIN_3_0 const BIGNUM *DSA_get0_g(const DSA *d);
215OSSL_DEPRECATEDIN_3_0 const BIGNUM *DSA_get0_pub_key(const DSA *d);
216OSSL_DEPRECATEDIN_3_0 const BIGNUM *DSA_get0_priv_key(const DSA *d);
217OSSL_DEPRECATEDIN_3_0 void DSA_clear_flags(DSA *d, int flags);
218OSSL_DEPRECATEDIN_3_0 int DSA_test_flags(const DSA *d, int flags);
219OSSL_DEPRECATEDIN_3_0 void DSA_set_flags(DSA *d, int flags);
220OSSL_DEPRECATEDIN_3_0 ENGINE *DSA_get0_engine(DSA *d);
221
222OSSL_DEPRECATEDIN_3_0 DSA_METHOD *DSA_meth_new(const char *name, int flags);
223OSSL_DEPRECATEDIN_3_0 void DSA_meth_free(DSA_METHOD *dsam);
224OSSL_DEPRECATEDIN_3_0 DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam);
225OSSL_DEPRECATEDIN_3_0 const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
226OSSL_DEPRECATEDIN_3_0 int DSA_meth_set1_name(DSA_METHOD *dsam,
227 const char *name);
228OSSL_DEPRECATEDIN_3_0 int DSA_meth_get_flags(const DSA_METHOD *dsam);
229OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
230OSSL_DEPRECATEDIN_3_0 void *DSA_meth_get0_app_data(const DSA_METHOD *dsam);
231OSSL_DEPRECATEDIN_3_0 int DSA_meth_set0_app_data(DSA_METHOD *dsam,
232 void *app_data);
233OSSL_DEPRECATEDIN_3_0 DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
234 (const unsigned char *, int, DSA *);
235OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_sign(DSA_METHOD *dsam,
236 DSA_SIG *(*sign) (const unsigned char *, int, DSA *));
237OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
238 (DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
239OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
240 int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
241OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
242 (const unsigned char *, int, DSA_SIG *, DSA *);
243OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_verify(DSA_METHOD *dsam,
244 int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *));
245OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
24bf6f3c 246 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
52c8535a
P
247 const BIGNUM *, const BIGNUM *, BN_CTX *, BN_MONT_CTX *);
248OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
24bf6f3c
BL
249 int (*mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
250 const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
52c8535a
P
251 BN_MONT_CTX *));
252OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
24bf6f3c 253 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
52c8535a
P
254 BN_CTX *, BN_MONT_CTX *);
255OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
24bf6f3c 256 int (*bn_mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
52c8535a
P
257 const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
258OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
259OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_init(DSA_METHOD *dsam,
260 int (*init)(DSA *));
261OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_finish(const DSA_METHOD *dsam))(DSA *);
262OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_finish(DSA_METHOD *dsam,
263 int (*finish)(DSA *));
264OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
6e9fa57c 265 (DSA *, int, const unsigned char *, int, int *, unsigned long *,
52c8535a
P
266 BN_GENCB *);
267OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_paramgen(DSA_METHOD *dsam,
6e9fa57c 268 int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
52c8535a
P
269 unsigned long *, BN_GENCB *));
270OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_keygen(const DSA_METHOD *dsam))(DSA *);
271OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_keygen(DSA_METHOD *dsam,
272 int (*keygen) (DSA *));
6e9fa57c 273
52c8535a 274# endif
888bdbfd
RL
275# endif
276# ifdef __cplusplus
d02b48c6 277}
3c27208f 278# endif
d02b48c6 279#endif