1/*
2 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
3 *
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
8 */
9
10#ifndef OPENSSL_DSA_H
11#define OPENSSL_DSA_H
12#pragma once
13
14#include <openssl/macros.h>
15#ifndef OPENSSL_NO_DEPRECATED_3_0
16#define HEADER_DSA_H
17#endif
18
19#include <openssl/opensslconf.h>
20#include <openssl/types.h>
21
22#include <stdlib.h>
23
24#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/bn.h>
30#ifndef OPENSSL_NO_DEPRECATED_1_1_0
31#include <openssl/dh.h>
32#endif
33#include <openssl/dsaerr.h>
34#ifndef OPENSSL_NO_STDIO
35#include <stdio.h>
36#endif
37#endif
38
39#ifdef __cplusplus
40extern "C" {
41#endif
42
43int EVP_PKEY_CTX_set_dsa_paramgen_bits(EVP_PKEY_CTX *ctx, int nbits);
44int EVP_PKEY_CTX_set_dsa_paramgen_q_bits(EVP_PKEY_CTX *ctx, int qbits);
45int EVP_PKEY_CTX_set_dsa_paramgen_md_props(EVP_PKEY_CTX *ctx,
46 const char *md_name,
47 const char *md_properties);
48int EVP_PKEY_CTX_set_dsa_paramgen_gindex(EVP_PKEY_CTX *ctx, int gindex);
49int EVP_PKEY_CTX_set_dsa_paramgen_type(EVP_PKEY_CTX *ctx, const char *name);
50int EVP_PKEY_CTX_set_dsa_paramgen_seed(EVP_PKEY_CTX *ctx,
51 const unsigned char *seed,
52 size_t seedlen);
53int EVP_PKEY_CTX_set_dsa_paramgen_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
54
55#define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
56#define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
57#define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
58
59#ifndef OPENSSL_NO_DSA
60#ifndef OPENSSL_DSA_MAX_MODULUS_BITS
61#define OPENSSL_DSA_MAX_MODULUS_BITS 10000
62#endif
63
64#define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
65
66typedef struct DSA_SIG_st DSA_SIG;
67DSA_SIG *DSA_SIG_new(void);
68void DSA_SIG_free(DSA_SIG *a);
69DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA_SIG, DSA_SIG)
70void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
71int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s);
72
73#ifndef OPENSSL_NO_DEPRECATED_1_1_0
74/*
75 * Does nothing. Previously this switched off constant time behaviour.
76 */
77#define DSA_FLAG_NO_EXP_CONSTTIME 0x00
78#endif
79
80#ifndef OPENSSL_NO_DEPRECATED_3_0
81#define DSA_FLAG_CACHE_MONT_P 0x01
82
83/*
84 * If this flag is set the DSA method is FIPS compliant and can be used in
85 * FIPS mode. This is set in the validated module method. If an application
86 * sets this flag in its own methods it is its responsibility to ensure the
87 * result is compliant.
88 */
89
90#define DSA_FLAG_FIPS_METHOD 0x0400
91
92/*
93 * If this flag is set the operations normally disabled in FIPS mode are
94 * permitted it is then the applications responsibility to ensure that the
95 * usage is compliant.
96 */
97
98#define DSA_FLAG_NON_FIPS_ALLOW 0x0400
99#define DSA_FLAG_FIPS_CHECKED 0x0800
100
101/* Already defined in ossl_typ.h */
102/* typedef struct dsa_st DSA; */
103/* typedef struct dsa_method DSA_METHOD; */
104
105#define d2i_DSAparams_fp(fp, x) \
106 (DSA *)ASN1_d2i_fp((void *(*)(void))DSA_new, \
107 (d2i_of_void *)d2i_DSAparams, (fp), \
108 (void **)(x))
109#define i2d_DSAparams_fp(fp, x) \
110 ASN1_i2d_fp(i2d_DSAparams, (fp), (unsigned char *)(x))
111#define d2i_DSAparams_bio(bp, x) \
112 ASN1_d2i_bio_of(DSA, DSA_new, d2i_DSAparams, bp, x)
113#define i2d_DSAparams_bio(bp, x) \
114 ASN1_i2d_bio_of(DSA, i2d_DSAparams, bp, x)
115
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);
121
122OSSL_DEPRECATEDIN_3_0 const DSA_METHOD *DSA_OpenSSL(void);
123
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);
128
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);
132/* "up" the DSA object's reference count */
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);
137/* next 4 return -1 on error */
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
147#define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
148 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
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)
158#endif
159
160#ifndef OPENSSL_NO_DEPRECATED_0_9_8
161/* Deprecated version */
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);
167#endif
168
169#ifndef OPENSSL_NO_DEPRECATED_3_0
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
187#define DSS_prime_checks 64
188/*
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.
193 */
194#define DSA_is_prime(n, callback, cb_arg) \
195 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
196
197#ifndef OPENSSL_NO_DH
198/*
199 * Convert DSA structure (key or just parameters) into DH structure (be
200 * careful to avoid small subgroup attacks when using this!)
201 */
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))(const unsigned char *, int, DSA *);
234OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_sign(DSA_METHOD *dsam,
235 DSA_SIG *(*sign)(const unsigned char *, int, DSA *));
236OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))(DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
237OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
238 int (*sign_setup)(DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
239OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_verify(const DSA_METHOD *dsam))(const unsigned char *, int, DSA_SIG *, DSA *);
240OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_verify(DSA_METHOD *dsam,
241 int (*verify)(const unsigned char *, int, DSA_SIG *, DSA *));
242OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))(DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
243 const BIGNUM *, const BIGNUM *, BN_CTX *, BN_MONT_CTX *);
244OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
245 int (*mod_exp)(DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
246 const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
247 BN_MONT_CTX *));
248OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))(DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
249 BN_CTX *, BN_MONT_CTX *);
250OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
251 int (*bn_mod_exp)(DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
252 const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
253OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
254OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_init(DSA_METHOD *dsam,
255 int (*init)(DSA *));
256OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_finish(const DSA_METHOD *dsam))(DSA *);
257OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_finish(DSA_METHOD *dsam,
258 int (*finish)(DSA *));
259OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))(DSA *, int, const unsigned char *, int, int *, unsigned long *,
260 BN_GENCB *);
261OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_paramgen(DSA_METHOD *dsam,
262 int (*paramgen)(DSA *, int, const unsigned char *, int, int *,
263 unsigned long *, BN_GENCB *));
264OSSL_DEPRECATEDIN_3_0 int (*DSA_meth_get_keygen(const DSA_METHOD *dsam))(DSA *);
265OSSL_DEPRECATEDIN_3_0 int DSA_meth_set_keygen(DSA_METHOD *dsam,
266 int (*keygen)(DSA *));
267
268#endif
269#endif
270#ifdef __cplusplus
271}
272#endif
273#endif
274