]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/dsa.h
DSA: fix the DSA parameter logic in test.
[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
RS
21# ifndef OPENSSL_NO_DSA
22# ifdef __cplusplus
23extern "C" {
0f113f3e 24# endif
3c27208f 25# include <openssl/e_os2.h>
9fdcc21f 26# include <openssl/asn1.h>
a00ae6c4 27# include <openssl/bio.h>
0f113f3e 28# include <openssl/crypto.h>
50cd4768 29# include <openssl/types.h>
6e9fa57c 30# include <openssl/bn.h>
00db8c60 31# ifndef OPENSSL_NO_DEPRECATED_1_1_0
3c27208f 32# include <openssl/dh.h>
0f113f3e 33# endif
52df25cf 34# include <openssl/dsaerr.h>
d02b48c6 35
0f113f3e
MC
36# ifndef OPENSSL_DSA_MAX_MODULUS_BITS
37# define OPENSSL_DSA_MAX_MODULUS_BITS 10000
38# endif
39
40# define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
5e3225cc 41
0f113f3e 42# define DSA_FLAG_CACHE_MONT_P 0x01
00db8c60 43# ifndef OPENSSL_NO_DEPRECATED_1_1_0
0f113f3e 44/*
5584f65a 45 * Does nothing. Previously this switched off constant time behaviour.
68d39f3c 46 */
5584f65a
MC
47# define DSA_FLAG_NO_EXP_CONSTTIME 0x00
48# endif
dfeab068 49
0f113f3e
MC
50/*
51 * If this flag is set the DSA method is FIPS compliant and can be used in
52 * FIPS mode. This is set in the validated module method. If an application
8483a003 53 * sets this flag in its own methods it is its responsibility to ensure the
0f113f3e 54 * result is compliant.
20818e00
DSH
55 */
56
0f113f3e 57# define DSA_FLAG_FIPS_METHOD 0x0400
20818e00 58
0f113f3e
MC
59/*
60 * If this flag is set the operations normally disabled in FIPS mode are
20818e00
DSH
61 * permitted it is then the applications responsibility to ensure that the
62 * usage is compliant.
63 */
64
0f113f3e
MC
65# define DSA_FLAG_NON_FIPS_ALLOW 0x0400
66# define DSA_FLAG_FIPS_CHECKED 0x0800
20818e00 67
3a87a9b9
GT
68/* Already defined in ossl_typ.h */
69/* typedef struct dsa_st DSA; */
70/* typedef struct dsa_method DSA_METHOD; */
c0711f7f 71
706a13f1 72typedef struct DSA_SIG_st DSA_SIG;
0f113f3e 73
0f113f3e
MC
74# define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
75 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
76# define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
77 (unsigned char *)(x))
78# define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
9fdcc21f 79# define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of(DSA,i2d_DSAparams,bp,x)
d02b48c6 80
9fdcc21f 81DECLARE_ASN1_DUP_FUNCTION_name(DSA, DSAparams)
0f113f3e
MC
82DSA_SIG *DSA_SIG_new(void);
83void DSA_SIG_free(DSA_SIG *a);
9fdcc21f 84DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA_SIG, DSA_SIG)
9267c11b 85void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
1d454d58 86int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s);
a8da8918 87
0f113f3e
MC
88DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
89int DSA_do_verify(const unsigned char *dgst, int dgst_len,
90 DSA_SIG *sig, DSA *dsa);
a8da8918 91
a4aba800 92const DSA_METHOD *DSA_OpenSSL(void);
c0711f7f 93
0f113f3e 94void DSA_set_default_method(const DSA_METHOD *);
cb78486d 95const DSA_METHOD *DSA_get_default_method(void);
0f113f3e 96int DSA_set_method(DSA *dsa, const DSA_METHOD *);
6e9fa57c 97const DSA_METHOD *DSA_get_method(DSA *d);
f8463356 98
0f113f3e
MC
99DSA *DSA_new(void);
100DSA *DSA_new_method(ENGINE *engine);
101void DSA_free(DSA *r);
5cbc2e8b 102/* "up" the DSA object's reference count */
0f113f3e
MC
103int DSA_up_ref(DSA *r);
104int DSA_size(const DSA *);
5d8d9a8e 105int DSA_bits(const DSA *d);
0f113f3e
MC
106int DSA_security_bits(const DSA *d);
107 /* next 4 return -1 on error */
936c2b9e 108DEPRECATEDIN_3_0(int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp))
0f113f3e
MC
109int DSA_sign(int type, const unsigned char *dgst, int dlen,
110 unsigned char *sig, unsigned int *siglen, DSA *dsa);
111int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
112 const unsigned char *sigbuf, int siglen, DSA *dsa);
e6390aca
RS
113#define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
114 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
dd9d233e
DSH
115int DSA_set_ex_data(DSA *d, int idx, void *arg);
116void *DSA_get_ex_data(DSA *d, int idx);
d02b48c6 117
9fdcc21f
DO
118DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAPublicKey)
119DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAPrivateKey)
120DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAparams)
e9224c71
GT
121
122/* Deprecated version */
98186eb4 123DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
0f113f3e
MC
124 unsigned char *seed,
125 int seed_len,
126 int *counter_ret,
127 unsigned long *h_ret, void
128 (*callback) (int, int,
129 void *),
98186eb4 130 void *cb_arg))
e9224c71
GT
131
132/* New version */
0f113f3e
MC
133int DSA_generate_parameters_ex(DSA *dsa, int bits,
134 const unsigned char *seed, int seed_len,
135 int *counter_ret, unsigned long *h_ret,
136 BN_GENCB *cb);
137
138int DSA_generate_key(DSA *a);
0f113f3e 139
0f113f3e
MC
140int DSAparams_print(BIO *bp, const DSA *x);
141int DSA_print(BIO *bp, const DSA *x, int off);
0f113f3e
MC
142# ifndef OPENSSL_NO_STDIO
143int DSAparams_print_fp(FILE *fp, const DSA *x);
144int DSA_print_fp(FILE *bp, const DSA *x, int off);
145# endif
146
936c2b9e 147# ifndef OPENSSL_NO_DEPRECATED_3_0
42619397 148# define DSS_prime_checks 64
0f113f3e 149/*
74ee3796
KR
150 * Primality test according to FIPS PUB 186-4, Appendix C.3. Since we only
151 * have one value here we set the number of checks to 64 which is the 128 bit
152 * security level that is the highest level and valid for creating a 3072 bit
153 * DSA key.
0f113f3e 154 */
42619397
KR
155# define DSA_is_prime(n, callback, cb_arg) \
156 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
157# endif
d02b48c6 158
0f113f3e
MC
159# ifndef OPENSSL_NO_DH
160/*
161 * Convert DSA structure (key or just parameters) into DH structure (be
162 * careful to avoid small subgroup attacks when using this!)
163 */
a4aba800 164DH *DSA_dup_DH(const DSA *r);
0f113f3e 165# endif
48c843c3 166
0f113f3e
MC
167# define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
168 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
169 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
a97faad7
DB
170# define EVP_PKEY_CTX_set_dsa_paramgen_q_bits(ctx, qbits) \
171 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
172 EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS, qbits, NULL)
173# define EVP_PKEY_CTX_set_dsa_paramgen_md(ctx, md) \
174 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
175 EVP_PKEY_CTRL_DSA_PARAMGEN_MD, 0, (void *)(md))
c927df3f 176
0f113f3e
MC
177# define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
178# define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
179# define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
c927df3f 180
fd809cfd
RL
181void DSA_get0_pqg(const DSA *d,
182 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
1258396d 183int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
fd809cfd
RL
184void DSA_get0_key(const DSA *d,
185 const BIGNUM **pub_key, const BIGNUM **priv_key);
1258396d 186int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
e6f35b57
DMSP
187const BIGNUM *DSA_get0_p(const DSA *d);
188const BIGNUM *DSA_get0_q(const DSA *d);
189const BIGNUM *DSA_get0_g(const DSA *d);
190const BIGNUM *DSA_get0_pub_key(const DSA *d);
191const BIGNUM *DSA_get0_priv_key(const DSA *d);
1258396d
MC
192void DSA_clear_flags(DSA *d, int flags);
193int DSA_test_flags(const DSA *d, int flags);
194void DSA_set_flags(DSA *d, int flags);
195ENGINE *DSA_get0_engine(DSA *d);
196
6e9fa57c
MC
197DSA_METHOD *DSA_meth_new(const char *name, int flags);
198void DSA_meth_free(DSA_METHOD *dsam);
a517f7fc
MC
199DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam);
200const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
201int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
693be9a2 202int DSA_meth_get_flags(const DSA_METHOD *dsam);
6e9fa57c 203int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
aa05e7ca
MC
204void *DSA_meth_get0_app_data(const DSA_METHOD *dsam);
205int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data);
6e9fa57c
MC
206DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
207 (const unsigned char *, int, DSA *);
208int DSA_meth_set_sign(DSA_METHOD *dsam,
209 DSA_SIG *(*sign) (const unsigned char *, int, DSA *));
210int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
211 (DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
212int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
213 int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
214int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
28b86f31 215 (const unsigned char *, int, DSA_SIG *, DSA *);
6e9fa57c
MC
216int DSA_meth_set_verify(DSA_METHOD *dsam,
217 int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *));
218int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
24bf6f3c
BL
219 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
220 const BIGNUM *, const BIGNUM *, BN_CTX *, BN_MONT_CTX *);
6e9fa57c 221int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
24bf6f3c
BL
222 int (*mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
223 const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
224 BN_MONT_CTX *));
6e9fa57c 225int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
24bf6f3c
BL
226 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
227 BN_CTX *, BN_MONT_CTX *);
6e9fa57c 228int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
24bf6f3c 229 int (*bn_mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
6e9fa57c
MC
230 const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
231int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
232int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
233int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *);
234int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *));
235int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
236 (DSA *, int, const unsigned char *, int, int *, unsigned long *,
237 BN_GENCB *);
238int DSA_meth_set_paramgen(DSA_METHOD *dsam,
239 int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
240 unsigned long *, BN_GENCB *));
241int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *);
242int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *));
243
6d311938 244
0cd0a820 245# ifdef __cplusplus
d02b48c6 246}
0cd0a820 247# endif
3c27208f 248# endif
d02b48c6 249#endif