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