]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/dsa.h
DH: add CHANGES entry listing the deprecated DH functions.
[thirdparty/openssl.git] / include / openssl / dsa.h
CommitLineData
21dcbebc 1/*
6738bf14 2 * Copyright 1995-2018 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>
751ff1d3 20
3c27208f 21# ifndef OPENSSL_NO_DSA
7f6deaf6 22# ifdef __cplusplus
3c27208f 23extern "C" {
7f6deaf6
P
24# endif
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>
33# endif
34# include <openssl/dsaerr.h>
d02b48c6 35
7f6deaf6
P
36# ifndef OPENSSL_DSA_MAX_MODULUS_BITS
37# define OPENSSL_DSA_MAX_MODULUS_BITS 10000
38# endif
0f113f3e 39
7f6deaf6 40# define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
5e3225cc 41
7f6deaf6 42# ifndef OPENSSL_NO_DEPRECATED_1_1_0
0f113f3e 43/*
5584f65a 44 * Does nothing. Previously this switched off constant time behaviour.
68d39f3c 45 */
7f6deaf6
P
46# define DSA_FLAG_NO_EXP_CONSTTIME 0x00
47# endif
dfeab068 48
f41ac0ee
P
49# ifndef OPENSSL_NO_DEPRECATED_3_0
50# define DSA_FLAG_CACHE_MONT_P 0x01
51
0f113f3e
MC
52/*
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
8483a003 55 * sets this flag in its own methods it is its responsibility to ensure the
0f113f3e 56 * result is compliant.
20818e00
DSH
57 */
58
f41ac0ee 59# define DSA_FLAG_FIPS_METHOD 0x0400
20818e00 60
0f113f3e
MC
61/*
62 * If this flag is set the operations normally disabled in FIPS mode are
20818e00
DSH
63 * permitted it is then the applications responsibility to ensure that the
64 * usage is compliant.
65 */
66
f41ac0ee
P
67# define DSA_FLAG_NON_FIPS_ALLOW 0x0400
68# define DSA_FLAG_FIPS_CHECKED 0x0800
69# endif /* OPENSSL_NO_DEPRECATED_3_0 */
20818e00 70
3a87a9b9
GT
71/* Already defined in ossl_typ.h */
72/* typedef struct dsa_st DSA; */
73/* typedef struct dsa_method DSA_METHOD; */
c0711f7f 74
706a13f1 75typedef struct DSA_SIG_st DSA_SIG;
0f113f3e 76
f41ac0ee
P
77/*
78 * TODO(3.0): consider removing the ASN.1 encoding and decoding when
79 * deserialisation is completed elsewhere.
80 */
7f6deaf6
P
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) \
f41ac0ee 86 ASN1_i2d_fp(i2d_DSAparams, (fp), (unsigned char *)(x))
7f6deaf6
P
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)
d02b48c6 91
9fdcc21f 92DECLARE_ASN1_DUP_FUNCTION_name(DSA, DSAparams)
0f113f3e
MC
93DSA_SIG *DSA_SIG_new(void);
94void DSA_SIG_free(DSA_SIG *a);
9fdcc21f 95DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA_SIG, DSA_SIG)
9267c11b 96void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
1d454d58 97int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s);
a8da8918 98
f41ac0ee
P
99DEPRECATEDIN_3_0(DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen,
100 DSA *dsa))
101DEPRECATEDIN_3_0(int DSA_do_verify(const unsigned char *dgst, int dgst_len,
102 DSA_SIG *sig, DSA *dsa))
a8da8918 103
f41ac0ee 104DEPRECATEDIN_3_0(const DSA_METHOD *DSA_OpenSSL(void))
c0711f7f 105
f41ac0ee
P
106DEPRECATEDIN_3_0(void DSA_set_default_method(const DSA_METHOD *))
107DEPRECATEDIN_3_0(const DSA_METHOD *DSA_get_default_method(void))
108DEPRECATEDIN_3_0(int DSA_set_method(DSA *dsa, const DSA_METHOD *))
109DEPRECATEDIN_3_0(const DSA_METHOD *DSA_get_method(DSA *d))
f8463356 110
0f113f3e 111DSA *DSA_new(void);
f41ac0ee 112DEPRECATEDIN_3_0(DSA *DSA_new_method(ENGINE *engine))
0f113f3e 113void DSA_free(DSA *r);
5cbc2e8b 114/* "up" the DSA object's reference count */
0f113f3e 115int DSA_up_ref(DSA *r);
f41ac0ee
P
116DEPRECATEDIN_3_0(int DSA_size(const DSA *))
117DEPRECATEDIN_3_0(int DSA_bits(const DSA *d))
118DEPRECATEDIN_3_0(int DSA_security_bits(const DSA *d))
0f113f3e 119 /* next 4 return -1 on error */
f41ac0ee
P
120DEPRECATEDIN_3_0(int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
121 BIGNUM **rp))
122DEPRECATEDIN_3_0(int DSA_sign(int type, const unsigned char *dgst, int dlen,
123 unsigned char *sig, unsigned int *siglen,
124 DSA *dsa))
125DEPRECATEDIN_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) \
7f6deaf6 130 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
f41ac0ee
P
131# endif
132DEPRECATEDIN_3_0(int DSA_set_ex_data(DSA *d, int idx, void *arg))
133DEPRECATEDIN_3_0(void *DSA_get_ex_data(DSA *d, int idx))
d02b48c6 134
9fdcc21f
DO
135DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAPublicKey)
136DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAPrivateKey)
137DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAparams)
e9224c71
GT
138
139/* Deprecated version */
98186eb4 140DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
0f113f3e
MC
141 unsigned char *seed,
142 int seed_len,
143 int *counter_ret,
144 unsigned long *h_ret, void
145 (*callback) (int, int,
146 void *),
98186eb4 147 void *cb_arg))
e9224c71
GT
148
149/* New version */
f41ac0ee
P
150DEPRECATEDIN_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,
154 BN_GENCB *cb))
0f113f3e 155
f41ac0ee 156DEPRECATEDIN_3_0(int DSA_generate_key(DSA *a))
0f113f3e 157
f41ac0ee
P
158DEPRECATEDIN_3_0(int DSAparams_print(BIO *bp, const DSA *x))
159DEPRECATEDIN_3_0(int DSA_print(BIO *bp, const DSA *x, int off))
7f6deaf6 160# ifndef OPENSSL_NO_STDIO
f41ac0ee
P
161DEPRECATEDIN_3_0(int DSAparams_print_fp(FILE *fp, const DSA *x))
162DEPRECATEDIN_3_0(int DSA_print_fp(FILE *bp, const DSA *x, int off))
7f6deaf6 163# endif
0f113f3e 164
7f6deaf6
P
165# ifndef OPENSSL_NO_DEPRECATED_3_0
166# define DSS_prime_checks 64
0f113f3e 167/*
74ee3796
KR
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
171 * DSA key.
0f113f3e 172 */
7f6deaf6
P
173# define DSA_is_prime(n, callback, cb_arg) \
174 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
175# endif
d02b48c6 176
7f6deaf6 177# ifndef OPENSSL_NO_DH
0f113f3e
MC
178/*
179 * Convert DSA structure (key or just parameters) into DH structure (be
180 * careful to avoid small subgroup attacks when using this!)
f41ac0ee
P
181 *
182 * TODO(3.0): figure out how to remove this monstrosity
0f113f3e 183 */
a4aba800 184DH *DSA_dup_DH(const DSA *r);
7f6deaf6 185# endif
48c843c3 186
7f6deaf6
P
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))
c927df3f 196
7f6deaf6
P
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)
c927df3f 200
fd809cfd
RL
201void DSA_get0_pqg(const DSA *d,
202 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
1258396d 203int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
fd809cfd
RL
204void DSA_get0_key(const DSA *d,
205 const BIGNUM **pub_key, const BIGNUM **priv_key);
1258396d 206int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
e6f35b57
DMSP
207const BIGNUM *DSA_get0_p(const DSA *d);
208const BIGNUM *DSA_get0_q(const DSA *d);
209const BIGNUM *DSA_get0_g(const DSA *d);
210const BIGNUM *DSA_get0_pub_key(const DSA *d);
211const BIGNUM *DSA_get0_priv_key(const DSA *d);
1258396d
MC
212void DSA_clear_flags(DSA *d, int flags);
213int DSA_test_flags(const DSA *d, int flags);
214void DSA_set_flags(DSA *d, int flags);
f41ac0ee
P
215DEPRECATEDIN_3_0(ENGINE *DSA_get0_engine(DSA *d))
216
217DEPRECATEDIN_3_0(DSA_METHOD *DSA_meth_new(const char *name, int flags))
218DEPRECATEDIN_3_0(void DSA_meth_free(DSA_METHOD *dsam))
219DEPRECATEDIN_3_0(DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam))
220DEPRECATEDIN_3_0(const char *DSA_meth_get0_name(const DSA_METHOD *dsam))
221DEPRECATEDIN_3_0(int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name))
222DEPRECATEDIN_3_0(int DSA_meth_get_flags(const DSA_METHOD *dsam))
223DEPRECATEDIN_3_0(int DSA_meth_set_flags(DSA_METHOD *dsam, int flags))
224DEPRECATEDIN_3_0(void *DSA_meth_get0_app_data(const DSA_METHOD *dsam))
225DEPRECATEDIN_3_0(int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data))
226DEPRECATEDIN_3_0(DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
227 (const unsigned char *, int, DSA *))
228DEPRECATEDIN_3_0(int DSA_meth_set_sign(DSA_METHOD *dsam,
229 DSA_SIG *(*sign) (const unsigned char *, int, DSA *)))
230DEPRECATEDIN_3_0(int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
231 (DSA *, BN_CTX *, BIGNUM **, BIGNUM **))
232DEPRECATEDIN_3_0(int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
233 int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **)))
234DEPRECATEDIN_3_0(int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
235 (const unsigned char *, int, DSA_SIG *, DSA *))
236DEPRECATEDIN_3_0(int DSA_meth_set_verify(DSA_METHOD *dsam,
237 int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *)))
238DEPRECATEDIN_3_0(int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
24bf6f3c 239 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
f41ac0ee
P
240 const BIGNUM *, const BIGNUM *, BN_CTX *, BN_MONT_CTX *))
241DEPRECATEDIN_3_0(int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
24bf6f3c
BL
242 int (*mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
243 const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
f41ac0ee
P
244 BN_MONT_CTX *)))
245DEPRECATEDIN_3_0(int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
24bf6f3c 246 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
f41ac0ee
P
247 BN_CTX *, BN_MONT_CTX *))
248DEPRECATEDIN_3_0(int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
24bf6f3c 249 int (*bn_mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
f41ac0ee
P
250 const BIGNUM *, BN_CTX *, BN_MONT_CTX *)))
251DEPRECATEDIN_3_0(int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *))
252DEPRECATEDIN_3_0(int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *)))
253DEPRECATEDIN_3_0(int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *))
254DEPRECATEDIN_3_0(int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *)))
255DEPRECATEDIN_3_0(int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
6e9fa57c 256 (DSA *, int, const unsigned char *, int, int *, unsigned long *,
f41ac0ee
P
257 BN_GENCB *))
258DEPRECATEDIN_3_0(int DSA_meth_set_paramgen(DSA_METHOD *dsam,
6e9fa57c 259 int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
f41ac0ee
P
260 unsigned long *, BN_GENCB *)))
261DEPRECATEDIN_3_0(int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *))
262DEPRECATEDIN_3_0(int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *)))
6e9fa57c 263
0cd0a820 264# ifdef __cplusplus
d02b48c6 265}
0cd0a820 266# endif
3c27208f 267# endif
d02b48c6 268#endif