1 /* crypto/dsa/dsa.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *   notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *   notice, this list of conditions and the following disclaimer in the
30  *   documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *   must display the following acknowledgement:
33  *   "This product includes cryptographic software written by
34  *    Eric Young (eay@cryptsoft.com)"
35  *   The word 'cryptographic' can be left out if the rouines from the library
36  *   being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *   the apps directory (application code) you must include an acknowledgement:
39  *   "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 
59 /*
60  * The DSS routines are based on patches supplied by
61  * Steven Schoch <schoch@sheba.arc.nasa.gov>.  He basically did the
62  * work and I have just tweaked them a little to fit into my
63  * stylistic vision for SSLeay :-) */
64 
65 module deimos.openssl.dsa;
66 
67 import deimos.openssl._d_util;
68 
69 import deimos.openssl.evp; // Needed for EVP_PKEY_ALG_CTRL.
70 
71 public import deimos.openssl.e_os2;
72 
73 version (OPENSSL_NO_DSA) {
74   static assert(false, "DSA is disabled.");
75 }
76 
77 version(OPENSSL_NO_BIO) {} else {
78 public import deimos.openssl.bio;
79 }
80 public import deimos.openssl.crypto;
81 public import deimos.openssl.ossl_typ;
82 
83 version(OPENSSL_NO_DEPRECATED) {} else {
84 public import deimos.openssl.bn;
85 version(OPENSSL_NO_DH) {} else {
86 public import deimos.openssl.dh;
87 }
88 }
89 
90 // #ifndef OPENSSL_DSA_MAX_MODULUS_BITS
91 enum OPENSSL_DSA_MAX_MODULUS_BITS = 10000;
92 // #endif
93 
94 enum DSA_FLAG_CACHE_MONT_P = 0x01;
95 enum DSA_FLAG_NO_EXP_CONSTTIME = 0x02; /* new with 0.9.7h; the built-in DSA
96                                               * implementation now uses constant time
97                                               * modular exponentiation for secret exponents
98                                               * by default. This flag causes the
99                                               * faster variable sliding window method to
100                                               * be used for all exponents.
101                                               */
102 
103 /* If this flag is set the DSA method is FIPS compliant and can be used
104  * in FIPS mode. This is set in the validated module method. If an
105  * application sets this flag in its own methods it is its reposibility
106  * to ensure the result is compliant.
107  */
108 
109 enum DSA_FLAG_FIPS_METHOD = 0x0400;
110 
111 /* If this flag is set the operations normally disabled in FIPS mode are
112  * permitted it is then the applications responsibility to ensure that the
113  * usage is compliant.
114  */
115 
116 enum DSA_FLAG_NON_FIPS_ALLOW = 0x0400;
117 
118 extern (C):
119 nothrow:
120 
121 /* Already defined in ossl_typ.h */
122 /* typedef dsa_st DSA; */
123 /* typedef dsa_method DSA_METHOD; */
124 
125 struct DSA_SIG_st {
126 	BIGNUM* r;
127 	BIGNUM* s;
128 	}
129 alias DSA_SIG_st DSA_SIG;
130 
131 struct dsa_method
132 	{
133 	const(char)* name;
134 	ExternC!(DSA_SIG* function(const(ubyte)* dgst, int dlen, DSA* dsa)) dsa_do_sign;
135 	ExternC!(int function(DSA* dsa, BN_CTX* ctx_in, BIGNUM** kinvp,
136 								BIGNUM** rp)) dsa_sign_setup;
137 	ExternC!(int function(const(ubyte)* dgst, int dgst_len,
138 			     DSA_SIG* sig, DSA* dsa)) dsa_do_verify;
139 	ExternC!(int function(DSA* dsa, BIGNUM* rr, BIGNUM* a1, BIGNUM* p1,
140 			BIGNUM* a2, BIGNUM* p2, BIGNUM* m, BN_CTX* ctx,
141 			BN_MONT_CTX* in_mont)) dsa_mod_exp;
142 	ExternC!(int function(DSA* dsa, BIGNUM* r, BIGNUM* a, const(BIGNUM)* p,
143 				const(BIGNUM)* m, BN_CTX* ctx,
144 				BN_MONT_CTX* m_ctx)) bn_mod_exp; /* Can be null */
145 	ExternC!(int function(DSA* dsa)) init_;
146 	ExternC!(int function(DSA* dsa)) finish;
147 	int flags;
148 	char* app_data;
149 	/* If this is non-NULL, it is used to generate DSA parameters */
150 	ExternC!(int function(DSA* dsa, int bits,
151 			const(ubyte)* seed, int seed_len,
152 			int* counter_ret, c_ulong* h_ret,
153 			BN_GENCB* cb)) dsa_paramgen;
154 	/* If this is non-NULL, it is used to generate DSA keys */
155 	ExternC!(int function(DSA* dsa)) dsa_keygen;
156 	};
157 
158 struct dsa_st
159 	{
160 	/* This first variable is used to pick up errors where
161 	 * a DSA is passed instead of of a EVP_PKEY */
162 	int pad;
163 	c_long version_;
164 	int write_params;
165 	BIGNUM* p;
166 	BIGNUM* q;	/* == 20 */
167 	BIGNUM* g;
168 
169 	BIGNUM* pub_key;  /* y public key */
170 	BIGNUM* priv_key; /* x private key */
171 
172 	BIGNUM* kinv;	/* Signing pre-calc */
173 	BIGNUM* r;	/* Signing pre-calc */
174 
175 	int flags;
176 	/* Normally used to cache montgomery values */
177 	BN_MONT_CTX* method_mont_p;
178 	int references;
179 	CRYPTO_EX_DATA ex_data;
180 	const(DSA_METHOD)* meth;
181 	/* functional reference if 'meth' is ENGINE-provided */
182 	ENGINE* engine;
183 	};
184 
185 auto d2i_DSAparams_fp()(FILE* fp, void** x) {
186 	return cast(DSA*)ASN1_d2i_fp(cast(ExternC!(void* function()))&DSA_new,
187 		cast(d2i_of_void*)&d2i_DSAparams,fp,x);
188 }
189 auto i2d_DSAparams_fp()(FILE* fp, void* x) { return ASN1_i2d_fp(cast(d2i_of_void*)&i2d_DSAparams,fp, x); }
190 auto d2i_DSAparams_bio()(BIO* bp, void** x) { return ASN1_d2i_bio_of!DSA(&DSA_new,&d2i_DSAparams,bp,x); }
191 auto i2d_DSAparams_bio()(BIO* bp, void** x) { return ASN1_i2d_bio_of_const!DSA(&i2d_DSAparams,bp,x); }
192 
193 DSA* DSAparams_dup(DSA* x);
194 DSA_SIG* DSA_SIG_new();
195 void	DSA_SIG_free(DSA_SIG* a);
196 int	i2d_DSA_SIG(const(DSA_SIG)* a, ubyte** pp);
197 DSA_SIG* d2i_DSA_SIG(DSA_SIG** v, const(ubyte)** pp, c_long length);
198 
199 DSA_SIG* DSA_do_sign(const(ubyte)* dgst,int dlen,DSA* dsa);
200 int	DSA_do_verify(const(ubyte)* dgst,int dgst_len,
201 		      DSA_SIG* sig,DSA* dsa);
202 
203 const(DSA_METHOD)* DSA_OpenSSL();
204 
205 void	DSA_set_default_method(const(DSA_METHOD)*);
206 const(DSA_METHOD)* DSA_get_default_method();
207 int	DSA_set_method(DSA* dsa, const(DSA_METHOD)*);
208 
209 DSA* 	DSA_new();
210 DSA* 	DSA_new_method(ENGINE* engine);
211 void	DSA_free (DSA* r);
212 /* "up" the DSA object's reference count */
213 int	DSA_up_ref(DSA* r);
214 int	DSA_size(const(DSA)*);
215 	/* next 4 return -1 on error */
216 int	DSA_sign_setup( DSA* dsa,BN_CTX* ctx_in,BIGNUM** kinvp,BIGNUM** rp);
217 int	DSA_sign(int type,const(ubyte)* dgst,int dlen,
218 		ubyte* sig, uint* siglen, DSA* dsa);
219 int	DSA_verify(int type,const(ubyte)* dgst,int dgst_len,
220 		const(ubyte)* sigbuf, int siglen, DSA* dsa);
221 int DSA_get_ex_new_index(c_long argl, void* argp, CRYPTO_EX_new* new_func,
222 	     CRYPTO_EX_dup* dup_func, CRYPTO_EX_free* free_func);
223 int DSA_set_ex_data(DSA* d, int idx, void* arg);
224 void* DSA_get_ex_data(DSA* d, int idx);
225 
226 DSA* 	d2i_DSAPublicKey(DSA** a, const(ubyte)** pp, c_long length);
227 DSA* 	d2i_DSAPrivateKey(DSA** a, const(ubyte)** pp, c_long length);
228 DSA* 	d2i_DSAparams(DSA** a, const(ubyte)** pp, c_long length);
229 
230 /* Deprecated version */
231 version(OPENSSL_NO_DEPRECATED) {} else {
232 DSA* 	DSA_generate_parameters(int bits,
233 		ubyte* seed,int seed_len,
234 		int* counter_ret, c_ulong* h_ret,ExternC!(void
235 	 function(int, int, void*)) callback,void* cb_arg);
236 } /* !defined(OPENSSL_NO_DEPRECATED) */
237 
238 /* New version */
239 int	DSA_generate_parameters_ex(DSA* dsa, int bits,
240 		const(ubyte)* seed,int seed_len,
241 		int* counter_ret, c_ulong* h_ret, BN_GENCB* cb);
242 
243 int	DSA_generate_key(DSA* a);
244 int	i2d_DSAPublicKey(const(DSA)* a, ubyte** pp);
245 int 	i2d_DSAPrivateKey(const(DSA)* a, ubyte** pp);
246 int	i2d_DSAparams(const(DSA)* a,ubyte** pp);
247 
248 version(OPENSSL_NO_BIO) {} else {
249 int	DSAparams_print(BIO* bp, const(DSA)* x);
250 int	DSA_print(BIO* bp, const(DSA)* x, int off);
251 }
252 version(OPENSSL_NO_FP_API) {} else {
253 int	DSAparams_print_fp(FILE* fp, const(DSA)* x);
254 int	DSA_print_fp(FILE* bp, const(DSA)* x, int off);
255 }
256 
257 enum DSS_prime_checks = 50;
258 /* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
259  * 50 rounds of Rabin-Miller */
260 int	DSA_is_prime()(const(BIGNUM)* n, ExternC!(void function(int,int,void*)) callback, void* cb_arg) {
261 	return BN_is_prime(n, DSS_prime_checks, callback, null, cb_arg);
262 }
263 
264 
265 version(OPENSSL_NO_DH) {} else {
266 /* Convert DSA structure (key or just parameters) into DH structure
267  * (be careful to avoid small subgroup attacks when using this!) */
268 DH* DSA_dup_DH(const(DSA)* r);
269 }
270 
271 auto EVP_PKEY_CTX_set_dsa_paramgen_bits()(EVP_PKEY_CTX* ctx, int nbits) {
272 	return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN,
273 				EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, null);
274 }
275 
276 enum EVP_PKEY_CTRL_DSA_PARAMGEN_BITS = (EVP_PKEY_ALG_CTRL + 1);
277 enum EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS = (EVP_PKEY_ALG_CTRL + 2);
278 enum EVP_PKEY_CTRL_DSA_PARAMGEN_MD = (EVP_PKEY_ALG_CTRL + 3);
279 
280 /* BEGIN ERROR CODES */
281 /* The following lines are auto generated by the script mkerr.pl. Any changes
282  * made after this point may be overwritten when the script is next run.
283  */
284 void ERR_load_DSA_strings();
285 
286 /* Error codes for the DSA functions. */
287 
288 /* Function codes. */
289 enum DSA_F_D2I_DSA_SIG = 110;
290 enum DSA_F_DO_DSA_PRINT = 104;
291 enum DSA_F_DSAPARAMS_PRINT = 100;
292 enum DSA_F_DSAPARAMS_PRINT_FP = 101;
293 enum DSA_F_DSA_DO_SIGN = 112;
294 enum DSA_F_DSA_DO_VERIFY = 113;
295 enum DSA_F_DSA_GENERATE_KEY = 124;
296 enum DSA_F_DSA_GENERATE_PARAMETERS_EX = 123;
297 enum DSA_F_DSA_NEW_METHOD = 103;
298 enum DSA_F_DSA_PARAM_DECODE = 119;
299 enum DSA_F_DSA_PRINT_FP = 105;
300 enum DSA_F_DSA_PRIV_DECODE = 115;
301 enum DSA_F_DSA_PRIV_ENCODE = 116;
302 enum DSA_F_DSA_PUB_DECODE = 117;
303 enum DSA_F_DSA_PUB_ENCODE = 118;
304 enum DSA_F_DSA_SIGN = 106;
305 enum DSA_F_DSA_SIGN_SETUP = 107;
306 enum DSA_F_DSA_SIG_NEW = 109;
307 enum DSA_F_DSA_SIG_PRINT = 125;
308 enum DSA_F_DSA_VERIFY = 108;
309 enum DSA_F_I2D_DSA_SIG = 111;
310 enum DSA_F_OLD_DSA_PRIV_DECODE = 122;
311 enum DSA_F_PKEY_DSA_CTRL = 120;
312 enum DSA_F_PKEY_DSA_KEYGEN = 121;
313 enum DSA_F_SIG_CB = 114;
314 
315 /* Reason codes. */
316 enum DSA_R_BAD_Q_VALUE = 102;
317 enum DSA_R_BN_DECODE_ERROR = 108;
318 enum DSA_R_BN_ERROR = 109;
319 enum DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE = 100;
320 enum DSA_R_DECODE_ERROR = 104;
321 enum DSA_R_INVALID_DIGEST_TYPE = 106;
322 enum DSA_R_MISSING_PARAMETERS = 101;
323 enum DSA_R_MODULUS_TOO_LARGE = 103;
324 enum DSA_R_NEED_NEW_SETUP_VALUES = 110;
325 enum DSA_R_NON_FIPS_DSA_METHOD = 111;
326 enum DSA_R_NO_PARAMETERS_SET = 107;
327 enum DSA_R_PARAMETER_ENCODING_ERROR = 105;