/src/openssl/include/openssl/dsa.h
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Copyright 1995-2018 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 | | |
21 | | # ifndef OPENSSL_NO_DSA |
22 | | # ifdef __cplusplus |
23 | | extern "C" { |
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> |
35 | | |
36 | | # ifndef OPENSSL_DSA_MAX_MODULUS_BITS |
37 | 0 | # define OPENSSL_DSA_MAX_MODULUS_BITS 10000 |
38 | | # endif |
39 | | |
40 | | # define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024 |
41 | | |
42 | 953 | # define DSA_FLAG_CACHE_MONT_P 0x01 |
43 | | # ifndef OPENSSL_NO_DEPRECATED_1_1_0 |
44 | | /* |
45 | | * Does nothing. Previously this switched off constant time behaviour. |
46 | | */ |
47 | | # define DSA_FLAG_NO_EXP_CONSTTIME 0x00 |
48 | | # endif |
49 | | |
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 |
53 | | * sets this flag in its own methods it is its responsibility to ensure the |
54 | | * result is compliant. |
55 | | */ |
56 | | |
57 | | # define DSA_FLAG_FIPS_METHOD 0x0400 |
58 | | |
59 | | /* |
60 | | * If this flag is set the operations normally disabled in FIPS mode are |
61 | | * permitted it is then the applications responsibility to ensure that the |
62 | | * usage is compliant. |
63 | | */ |
64 | | |
65 | 1.90k | # define DSA_FLAG_NON_FIPS_ALLOW 0x0400 |
66 | | # define DSA_FLAG_FIPS_CHECKED 0x0800 |
67 | | |
68 | | /* Already defined in ossl_typ.h */ |
69 | | /* typedef struct dsa_st DSA; */ |
70 | | /* typedef struct dsa_method DSA_METHOD; */ |
71 | | |
72 | | typedef struct DSA_SIG_st DSA_SIG; |
73 | | |
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) |
79 | 0 | # define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of(DSA,i2d_DSAparams,bp,x) |
80 | | |
81 | | DECLARE_ASN1_DUP_FUNCTION_name(DSA, DSAparams) |
82 | | DSA_SIG *DSA_SIG_new(void); |
83 | | void DSA_SIG_free(DSA_SIG *a); |
84 | | DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA_SIG, DSA_SIG) |
85 | | void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps); |
86 | | int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s); |
87 | | |
88 | | DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa); |
89 | | int DSA_do_verify(const unsigned char *dgst, int dgst_len, |
90 | | DSA_SIG *sig, DSA *dsa); |
91 | | |
92 | | const DSA_METHOD *DSA_OpenSSL(void); |
93 | | |
94 | | void DSA_set_default_method(const DSA_METHOD *); |
95 | | const DSA_METHOD *DSA_get_default_method(void); |
96 | | int DSA_set_method(DSA *dsa, const DSA_METHOD *); |
97 | | const DSA_METHOD *DSA_get_method(DSA *d); |
98 | | |
99 | | DSA *DSA_new(void); |
100 | | DSA *DSA_new_method(ENGINE *engine); |
101 | | void DSA_free(DSA *r); |
102 | | /* "up" the DSA object's reference count */ |
103 | | int DSA_up_ref(DSA *r); |
104 | | int DSA_size(const DSA *); |
105 | | int DSA_bits(const DSA *d); |
106 | | int DSA_security_bits(const DSA *d); |
107 | | /* next 4 return -1 on error */ |
108 | | DEPRECATEDIN_3_0(int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp)) |
109 | | int DSA_sign(int type, const unsigned char *dgst, int dlen, |
110 | | unsigned char *sig, unsigned int *siglen, DSA *dsa); |
111 | | int DSA_verify(int type, const unsigned char *dgst, int dgst_len, |
112 | | const unsigned char *sigbuf, int siglen, DSA *dsa); |
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) |
115 | | int DSA_set_ex_data(DSA *d, int idx, void *arg); |
116 | | void *DSA_get_ex_data(DSA *d, int idx); |
117 | | |
118 | | DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAPublicKey) |
119 | | DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAPrivateKey) |
120 | | DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAparams) |
121 | | |
122 | | /* Deprecated version */ |
123 | | DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits, |
124 | | unsigned char *seed, |
125 | | int seed_len, |
126 | | int *counter_ret, |
127 | | unsigned long *h_ret, void |
128 | | (*callback) (int, int, |
129 | | void *), |
130 | | void *cb_arg)) |
131 | | |
132 | | /* New version */ |
133 | | int 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 | | |
138 | | int DSA_generate_key(DSA *a); |
139 | | |
140 | | int DSAparams_print(BIO *bp, const DSA *x); |
141 | | int DSA_print(BIO *bp, const DSA *x, int off); |
142 | | # ifndef OPENSSL_NO_STDIO |
143 | | int DSAparams_print_fp(FILE *fp, const DSA *x); |
144 | | int DSA_print_fp(FILE *bp, const DSA *x, int off); |
145 | | # endif |
146 | | |
147 | | # ifndef OPENSSL_NO_DEPRECATED_3_0 |
148 | | # define DSS_prime_checks 64 |
149 | | /* |
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. |
154 | | */ |
155 | | # define DSA_is_prime(n, callback, cb_arg) \ |
156 | | BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg) |
157 | | # endif |
158 | | |
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 | | */ |
164 | | DH *DSA_dup_DH(const DSA *r); |
165 | | # endif |
166 | | |
167 | | # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \ |
168 | 0 | EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ |
169 | 0 | EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL) |
170 | | # define EVP_PKEY_CTX_set_dsa_paramgen_q_bits(ctx, qbits) \ |
171 | 0 | EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ |
172 | 0 | EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS, qbits, NULL) |
173 | | # define EVP_PKEY_CTX_set_dsa_paramgen_md(ctx, md) \ |
174 | 0 | EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ |
175 | 0 | EVP_PKEY_CTRL_DSA_PARAMGEN_MD, 0, (void *)(md)) |
176 | | |
177 | 0 | # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1) |
178 | 0 | # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2) |
179 | 0 | # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3) |
180 | | |
181 | | void DSA_get0_pqg(const DSA *d, |
182 | | const BIGNUM **p, const BIGNUM **q, const BIGNUM **g); |
183 | | int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g); |
184 | | void DSA_get0_key(const DSA *d, |
185 | | const BIGNUM **pub_key, const BIGNUM **priv_key); |
186 | | int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key); |
187 | | const BIGNUM *DSA_get0_p(const DSA *d); |
188 | | const BIGNUM *DSA_get0_q(const DSA *d); |
189 | | const BIGNUM *DSA_get0_g(const DSA *d); |
190 | | const BIGNUM *DSA_get0_pub_key(const DSA *d); |
191 | | const BIGNUM *DSA_get0_priv_key(const DSA *d); |
192 | | void DSA_clear_flags(DSA *d, int flags); |
193 | | int DSA_test_flags(const DSA *d, int flags); |
194 | | void DSA_set_flags(DSA *d, int flags); |
195 | | ENGINE *DSA_get0_engine(DSA *d); |
196 | | |
197 | | DSA_METHOD *DSA_meth_new(const char *name, int flags); |
198 | | void DSA_meth_free(DSA_METHOD *dsam); |
199 | | DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam); |
200 | | const char *DSA_meth_get0_name(const DSA_METHOD *dsam); |
201 | | int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name); |
202 | | int DSA_meth_get_flags(const DSA_METHOD *dsam); |
203 | | int DSA_meth_set_flags(DSA_METHOD *dsam, int flags); |
204 | | void *DSA_meth_get0_app_data(const DSA_METHOD *dsam); |
205 | | int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data); |
206 | | DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam)) |
207 | | (const unsigned char *, int, DSA *); |
208 | | int DSA_meth_set_sign(DSA_METHOD *dsam, |
209 | | DSA_SIG *(*sign) (const unsigned char *, int, DSA *)); |
210 | | int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam)) |
211 | | (DSA *, BN_CTX *, BIGNUM **, BIGNUM **); |
212 | | int DSA_meth_set_sign_setup(DSA_METHOD *dsam, |
213 | | int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **)); |
214 | | int (*DSA_meth_get_verify(const DSA_METHOD *dsam)) |
215 | | (const unsigned char *, int, DSA_SIG *, DSA *); |
216 | | int DSA_meth_set_verify(DSA_METHOD *dsam, |
217 | | int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *)); |
218 | | int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam)) |
219 | | (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *, |
220 | | const BIGNUM *, const BIGNUM *, BN_CTX *, BN_MONT_CTX *); |
221 | | int DSA_meth_set_mod_exp(DSA_METHOD *dsam, |
222 | | int (*mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, |
223 | | const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *, |
224 | | BN_MONT_CTX *)); |
225 | | int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam)) |
226 | | (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *, |
227 | | BN_CTX *, BN_MONT_CTX *); |
228 | | int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam, |
229 | | int (*bn_mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, |
230 | | const BIGNUM *, BN_CTX *, BN_MONT_CTX *)); |
231 | | int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *); |
232 | | int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *)); |
233 | | int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *); |
234 | | int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *)); |
235 | | int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam)) |
236 | | (DSA *, int, const unsigned char *, int, int *, unsigned long *, |
237 | | BN_GENCB *); |
238 | | int DSA_meth_set_paramgen(DSA_METHOD *dsam, |
239 | | int (*paramgen) (DSA *, int, const unsigned char *, int, int *, |
240 | | unsigned long *, BN_GENCB *)); |
241 | | int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *); |
242 | | int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *)); |
243 | | |
244 | | |
245 | | # ifdef __cplusplus |
246 | | } |
247 | | # endif |
248 | | # endif |
249 | | #endif |