]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/dsa/dsa.h
Make sure we get the definition of OPENSSL_NO_DH.
[thirdparty/openssl.git] / crypto / dsa / dsa.h
CommitLineData
d02b48c6 1/* crypto/dsa/dsa.h */
58964a49 2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6
RE
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#ifndef HEADER_DSA_H
66#define HEADER_DSA_H
67
cf1b7d96 68#ifdef OPENSSL_NO_DSA
f5d7a031
UM
69#error DSA is disabled.
70#endif
71
cf1b7d96 72#ifndef OPENSSL_NO_BIO
ef33b970
RL
73#include <openssl/bio.h>
74#endif
ec577822 75#include <openssl/bn.h>
c0711f7f 76#include <openssl/crypto.h>
2aa9043a 77#include <openssl/ossl_typ.h>
cf1b7d96 78#ifndef OPENSSL_NO_DH
48c843c3
BM
79# include <openssl/dh.h>
80#endif
d02b48c6 81
dfeab068
RE
82#define DSA_FLAG_CACHE_MONT_P 0x01
83
82271cee
RL
84#ifdef __cplusplus
85extern "C" {
86#endif
87
c0711f7f
DSH
88typedef struct dsa_st DSA;
89
90typedef struct DSA_SIG_st
91 {
92 BIGNUM *r;
93 BIGNUM *s;
94 } DSA_SIG;
95
96typedef struct dsa_method {
97 const char *name;
98 DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa);
99 int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
100 BIGNUM **rp);
101 int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
102 DSA_SIG *sig, DSA *dsa);
103 int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
104 BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
105 BN_MONT_CTX *in_mont);
106 int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
107 const BIGNUM *m, BN_CTX *ctx,
108 BN_MONT_CTX *m_ctx); /* Can be null */
109 int (*init)(DSA *dsa);
110 int (*finish)(DSA *dsa);
111 int flags;
112 char *app_data;
0e4aa0d2
GT
113 /* If this is non-NULL, it is used to generate DSA parameters */
114 int (*dsa_paramgen)(DSA *dsa, int bits,
115 unsigned char *seed, int seed_len,
116 int *counter_ret, unsigned long *h_ret,
117 BN_GENCB *cb);
118 /* If this is non-NULL, it is used to generate DSA keys */
119 int (*dsa_keygen)(DSA *dsa);
c0711f7f
DSH
120} DSA_METHOD;
121
122struct dsa_st
d02b48c6
RE
123 {
124 /* This first variable is used to pick up errors where
125 * a DSA is passed instead of of a EVP_PKEY */
126 int pad;
2c2f9e2c 127 long version;
d02b48c6
RE
128 int write_params;
129 BIGNUM *p;
130 BIGNUM *q; /* == 20 */
131 BIGNUM *g;
132
133 BIGNUM *pub_key; /* y public key */
134 BIGNUM *priv_key; /* x private key */
135
136 BIGNUM *kinv; /* Signing pre-calc */
137 BIGNUM *r; /* Signing pre-calc */
138
dfeab068
RE
139 int flags;
140 /* Normally used to cache montgomery values */
141 char *method_mont_p;
d02b48c6 142 int references;
c0711f7f 143 CRYPTO_EX_DATA ex_data;
cb78486d
GT
144 const DSA_METHOD *meth;
145 /* functional reference if 'meth' is ENGINE-provided */
146 ENGINE *engine;
c0711f7f 147 };
a8da8918 148
d02b48c6
RE
149#define DSAparams_dup(x) (DSA *)ASN1_dup((int (*)())i2d_DSAparams, \
150 (char *(*)())d2i_DSAparams,(char *)(x))
151#define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
152 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
153#define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
154 (unsigned char *)(x))
155#define d2i_DSAparams_bio(bp,x) (DSA *)ASN1_d2i_bio((char *(*)())DSA_new, \
156 (char *(*)())d2i_DSAparams,(bp),(unsigned char **)(x))
157#define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio(i2d_DSAparams,(bp), \
158 (unsigned char *)(x))
159
d02b48c6 160
a8da8918
UM
161DSA_SIG * DSA_SIG_new(void);
162void DSA_SIG_free(DSA_SIG *a);
a4aba800
RL
163int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
164DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
a8da8918 165
61f5b6f3
BL
166DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
167int DSA_do_verify(const unsigned char *dgst,int dgst_len,
168 DSA_SIG *sig,DSA *dsa);
a8da8918 169
a4aba800 170const DSA_METHOD *DSA_OpenSSL(void);
c0711f7f 171
cb78486d
GT
172void DSA_set_default_method(const DSA_METHOD *);
173const DSA_METHOD *DSA_get_default_method(void);
174int DSA_set_method(DSA *dsa, const DSA_METHOD *);
f8463356 175
d02b48c6 176DSA * DSA_new(void);
cb78486d 177DSA * DSA_new_method(ENGINE *engine);
5cbc2e8b
GT
178void DSA_free (DSA *r);
179/* "up" the DSA object's reference count */
6ac4e8bd 180int DSA_up_ref(DSA *r);
a4aba800 181int DSA_size(const DSA *);
d02b48c6
RE
182 /* next 4 return -1 on error */
183int DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
61f5b6f3 184int DSA_sign(int type,const unsigned char *dgst,int dlen,
d02b48c6 185 unsigned char *sig, unsigned int *siglen, DSA *dsa);
61f5b6f3 186int DSA_verify(int type,const unsigned char *dgst,int dgst_len,
a4aba800 187 const unsigned char *sigbuf, int siglen, DSA *dsa);
dd9d233e
DSH
188int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
189 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
190int DSA_set_ex_data(DSA *d, int idx, void *arg);
191void *DSA_get_ex_data(DSA *d, int idx);
d02b48c6 192
a4aba800
RL
193DSA * d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
194DSA * d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
195DSA * d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
e9224c71
GT
196
197/* Deprecated version */
198#ifndef OPENSSL_NO_DEPRECATED
a4aba800
RL
199DSA * DSA_generate_parameters(int bits,
200 unsigned char *seed,int seed_len,
58964a49 201 int *counter_ret, unsigned long *h_ret,void
82fc1d9c 202 (*callback)(int, int, void *),void *cb_arg);
e9224c71
GT
203#endif /* !defined(OPENSSL_NO_DEPRECATED) */
204
205/* New version */
206int DSA_generate_parameters_ex(DSA *dsa, int bits,
207 unsigned char *seed,int seed_len,
208 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb);
209
d02b48c6 210int DSA_generate_key(DSA *a);
a4aba800
RL
211int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
212int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
213int i2d_DSAparams(const DSA *a,unsigned char **pp);
d02b48c6 214
cf1b7d96 215#ifndef OPENSSL_NO_BIO
a4aba800
RL
216int DSAparams_print(BIO *bp, const DSA *x);
217int DSA_print(BIO *bp, const DSA *x, int off);
d02b48c6 218#endif
cf1b7d96 219#ifndef OPENSSL_NO_FP_API
a4aba800
RL
220int DSAparams_print_fp(FILE *fp, const DSA *x);
221int DSA_print_fp(FILE *bp, const DSA *x, int off);
d02b48c6
RE
222#endif
223
a87030a1
BM
224#define DSS_prime_checks 50
225/* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
226 * 50 rounds of Rabin-Miller */
227#define DSA_is_prime(n, callback, cb_arg) \
228 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
d02b48c6 229
cf1b7d96 230#ifndef OPENSSL_NO_DH
48c843c3
BM
231/* Convert DSA structure (key or just parameters) into DH structure
232 * (be careful to avoid small subgroup attacks when using this!) */
a4aba800 233DH *DSA_dup_DH(const DSA *r);
48c843c3
BM
234#endif
235
d02b48c6 236/* BEGIN ERROR CODES */
6d311938
DSH
237/* The following lines are auto generated by the script mkerr.pl. Any changes
238 * made after this point may be overwritten when the script is next run.
239 */
c962479b 240void ERR_load_DSA_strings(void);
6d311938 241
d02b48c6
RE
242/* Error codes for the DSA functions. */
243
244/* Function codes. */
6d311938 245#define DSA_F_D2I_DSA_SIG 110
d02b48c6
RE
246#define DSA_F_DSAPARAMS_PRINT 100
247#define DSA_F_DSAPARAMS_PRINT_FP 101
6d311938
DSH
248#define DSA_F_DSA_DO_SIGN 112
249#define DSA_F_DSA_DO_VERIFY 113
0c372b94 250#define DSA_F_DSA_NEW_METHOD 103
d02b48c6
RE
251#define DSA_F_DSA_PRINT 104
252#define DSA_F_DSA_PRINT_FP 105
253#define DSA_F_DSA_SIGN 106
254#define DSA_F_DSA_SIGN_SETUP 107
a8da8918 255#define DSA_F_DSA_SIG_NEW 109
6d311938 256#define DSA_F_DSA_VERIFY 108
a8da8918 257#define DSA_F_I2D_DSA_SIG 111
9d6b1ce6 258#define DSA_F_SIG_CB 114
d02b48c6
RE
259
260/* Reason codes. */
261#define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100
c962479b 262#define DSA_R_MISSING_PARAMETERS 101
6d311938 263
d02b48c6
RE
264#ifdef __cplusplus
265}
266#endif
267#endif