]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/dsa.h
Fix typo of BN_zero()
[thirdparty/openssl.git] / include / openssl / dsa.h
CommitLineData
21dcbebc
RS
1/*
2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
0f113f3e 3 *
21dcbebc
RS
4 * Licensed under the OpenSSL license (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
d02b48c6
RE
8 */
9
10/*
11 * The DSS routines are based on patches supplied by
b0700d2c
RS
12 * Steven Schoch <schoch@sheba.arc.nasa.gov>.
13 */
d02b48c6
RE
14
15#ifndef HEADER_DSA_H
0f113f3e 16# define HEADER_DSA_H
d02b48c6 17
3c27208f 18# include <openssl/opensslconf.h>
751ff1d3 19
3c27208f
RS
20# ifndef OPENSSL_NO_DSA
21# ifdef __cplusplus
22extern "C" {
0f113f3e 23# endif
3c27208f 24# include <openssl/e_os2.h>
a00ae6c4 25# include <openssl/bio.h>
0f113f3e
MC
26# include <openssl/crypto.h>
27# include <openssl/ossl_typ.h>
98186eb4 28# include <openssl/opensslconf.h>
6e9fa57c 29# include <openssl/bn.h>
98186eb4 30# if OPENSSL_API_COMPAT < 0x10100000L
3c27208f 31# include <openssl/dh.h>
0f113f3e 32# endif
d02b48c6 33
0f113f3e
MC
34# ifndef OPENSSL_DSA_MAX_MODULUS_BITS
35# define OPENSSL_DSA_MAX_MODULUS_BITS 10000
36# endif
37
38# define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
5e3225cc 39
0f113f3e 40# define DSA_FLAG_CACHE_MONT_P 0x01
5584f65a 41# if OPENSSL_API_COMPAT < 0x10100000L
0f113f3e 42/*
5584f65a 43 * Does nothing. Previously this switched off constant time behaviour.
68d39f3c 44 */
5584f65a
MC
45# define DSA_FLAG_NO_EXP_CONSTTIME 0x00
46# endif
dfeab068 47
0f113f3e
MC
48/*
49 * If this flag is set the DSA method is FIPS compliant and can be used in
50 * FIPS mode. This is set in the validated module method. If an application
8483a003 51 * sets this flag in its own methods it is its responsibility to ensure the
0f113f3e 52 * result is compliant.
20818e00
DSH
53 */
54
0f113f3e 55# define DSA_FLAG_FIPS_METHOD 0x0400
20818e00 56
0f113f3e
MC
57/*
58 * If this flag is set the operations normally disabled in FIPS mode are
20818e00
DSH
59 * permitted it is then the applications responsibility to ensure that the
60 * usage is compliant.
61 */
62
0f113f3e
MC
63# define DSA_FLAG_NON_FIPS_ALLOW 0x0400
64# define DSA_FLAG_FIPS_CHECKED 0x0800
20818e00 65
3a87a9b9
GT
66/* Already defined in ossl_typ.h */
67/* typedef struct dsa_st DSA; */
68/* typedef struct dsa_method DSA_METHOD; */
c0711f7f 69
706a13f1 70typedef struct DSA_SIG_st DSA_SIG;
0f113f3e 71
0f113f3e
MC
72# define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
73 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
74# define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
75 (unsigned char *)(x))
76# define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
77# define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
d02b48c6 78
f4274da1 79DSA *DSAparams_dup(DSA *x);
0f113f3e
MC
80DSA_SIG *DSA_SIG_new(void);
81void DSA_SIG_free(DSA_SIG *a);
82int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
83DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
9267c11b 84void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
1d454d58 85int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s);
a8da8918 86
0f113f3e
MC
87DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
88int DSA_do_verify(const unsigned char *dgst, int dgst_len,
89 DSA_SIG *sig, DSA *dsa);
a8da8918 90
a4aba800 91const DSA_METHOD *DSA_OpenSSL(void);
c0711f7f 92
0f113f3e 93void DSA_set_default_method(const DSA_METHOD *);
cb78486d 94const DSA_METHOD *DSA_get_default_method(void);
0f113f3e 95int DSA_set_method(DSA *dsa, const DSA_METHOD *);
6e9fa57c 96const DSA_METHOD *DSA_get_method(DSA *d);
f8463356 97
0f113f3e
MC
98DSA *DSA_new(void);
99DSA *DSA_new_method(ENGINE *engine);
100void DSA_free(DSA *r);
5cbc2e8b 101/* "up" the DSA object's reference count */
0f113f3e
MC
102int DSA_up_ref(DSA *r);
103int DSA_size(const DSA *);
104int DSA_security_bits(const DSA *d);
105 /* next 4 return -1 on error */
106int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
107int DSA_sign(int type, const unsigned char *dgst, int dlen,
108 unsigned char *sig, unsigned int *siglen, DSA *dsa);
109int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
110 const unsigned char *sigbuf, int siglen, DSA *dsa);
e6390aca
RS
111#define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
112 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
dd9d233e
DSH
113int DSA_set_ex_data(DSA *d, int idx, void *arg);
114void *DSA_get_ex_data(DSA *d, int idx);
d02b48c6 115
0f113f3e
MC
116DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
117DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
118DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
e9224c71
GT
119
120/* Deprecated version */
98186eb4 121DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
0f113f3e
MC
122 unsigned char *seed,
123 int seed_len,
124 int *counter_ret,
125 unsigned long *h_ret, void
126 (*callback) (int, int,
127 void *),
98186eb4 128 void *cb_arg))
e9224c71
GT
129
130/* New version */
0f113f3e
MC
131int DSA_generate_parameters_ex(DSA *dsa, int bits,
132 const unsigned char *seed, int seed_len,
133 int *counter_ret, unsigned long *h_ret,
134 BN_GENCB *cb);
135
136int DSA_generate_key(DSA *a);
137int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
138int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
139int i2d_DSAparams(const DSA *a, unsigned char **pp);
140
0f113f3e
MC
141int DSAparams_print(BIO *bp, const DSA *x);
142int DSA_print(BIO *bp, const DSA *x, int off);
0f113f3e
MC
143# ifndef OPENSSL_NO_STDIO
144int DSAparams_print_fp(FILE *fp, const DSA *x);
145int DSA_print_fp(FILE *bp, const DSA *x, int off);
146# endif
147
148# define DSS_prime_checks 50
149/*
150 * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of
151 * Rabin-Miller
152 */
153# define DSA_is_prime(n, callback, cb_arg) \
154 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
d02b48c6 155
0f113f3e
MC
156# ifndef OPENSSL_NO_DH
157/*
158 * Convert DSA structure (key or just parameters) into DH structure (be
159 * careful to avoid small subgroup attacks when using this!)
160 */
a4aba800 161DH *DSA_dup_DH(const DSA *r);
0f113f3e 162# endif
48c843c3 163
0f113f3e
MC
164# define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
165 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
166 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
c927df3f 167
0f113f3e
MC
168# define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
169# define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
170# define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
c927df3f 171
fd809cfd
RL
172void DSA_get0_pqg(const DSA *d,
173 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
1258396d 174int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
fd809cfd
RL
175void DSA_get0_key(const DSA *d,
176 const BIGNUM **pub_key, const BIGNUM **priv_key);
1258396d
MC
177int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
178void DSA_clear_flags(DSA *d, int flags);
179int DSA_test_flags(const DSA *d, int flags);
180void DSA_set_flags(DSA *d, int flags);
181ENGINE *DSA_get0_engine(DSA *d);
182
6e9fa57c
MC
183DSA_METHOD *DSA_meth_new(const char *name, int flags);
184void DSA_meth_free(DSA_METHOD *dsam);
a517f7fc
MC
185DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam);
186const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
187int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
6e9fa57c
MC
188int DSA_meth_get_flags(DSA_METHOD *dsam);
189int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
aa05e7ca
MC
190void *DSA_meth_get0_app_data(const DSA_METHOD *dsam);
191int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data);
6e9fa57c
MC
192DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
193 (const unsigned char *, int, DSA *);
194int DSA_meth_set_sign(DSA_METHOD *dsam,
195 DSA_SIG *(*sign) (const unsigned char *, int, DSA *));
196int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
197 (DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
198int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
199 int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
200int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
201 (const unsigned char *, int , DSA_SIG *, DSA *);
202int DSA_meth_set_verify(DSA_METHOD *dsam,
203 int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *));
204int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
24bf6f3c
BL
205 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
206 const BIGNUM *, const BIGNUM *, BN_CTX *, BN_MONT_CTX *);
6e9fa57c 207int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
24bf6f3c
BL
208 int (*mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
209 const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
210 BN_MONT_CTX *));
6e9fa57c 211int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
24bf6f3c
BL
212 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
213 BN_CTX *, BN_MONT_CTX *);
6e9fa57c 214int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
24bf6f3c 215 int (*bn_mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
6e9fa57c
MC
216 const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
217int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
218int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
219int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *);
220int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *));
221int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
222 (DSA *, int, const unsigned char *, int, int *, unsigned long *,
223 BN_GENCB *);
224int DSA_meth_set_paramgen(DSA_METHOD *dsam,
225 int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
226 unsigned long *, BN_GENCB *));
227int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *);
228int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *));
229
d02b48c6 230/* BEGIN ERROR CODES */
0f113f3e
MC
231/*
232 * The following lines are auto generated by the script mkerr.pl. Any changes
6d311938
DSH
233 * made after this point may be overwritten when the script is next run.
234 */
0cd0a820 235
69588edb 236int ERR_load_DSA_strings(void);
6d311938 237
d02b48c6
RE
238/* Error codes for the DSA functions. */
239
240/* Function codes. */
0f113f3e
MC
241# define DSA_F_DSAPARAMS_PRINT 100
242# define DSA_F_DSAPARAMS_PRINT_FP 101
0f113f3e
MC
243# define DSA_F_DSA_BUILTIN_PARAMGEN 125
244# define DSA_F_DSA_BUILTIN_PARAMGEN2 126
245# define DSA_F_DSA_DO_SIGN 112
246# define DSA_F_DSA_DO_VERIFY 113
569d0646
MC
247# define DSA_F_DSA_METH_DUP 127
248# define DSA_F_DSA_METH_NEW 128
249# define DSA_F_DSA_METH_SET1_NAME 129
0f113f3e
MC
250# define DSA_F_DSA_NEW_METHOD 103
251# define DSA_F_DSA_PARAM_DECODE 119
252# define DSA_F_DSA_PRINT_FP 105
253# define DSA_F_DSA_PRIV_DECODE 115
254# define DSA_F_DSA_PRIV_ENCODE 116
255# define DSA_F_DSA_PUB_DECODE 117
256# define DSA_F_DSA_PUB_ENCODE 118
257# define DSA_F_DSA_SIGN 106
258# define DSA_F_DSA_SIGN_SETUP 107
8cc44d97 259# define DSA_F_DSA_SIG_NEW 102
0f113f3e
MC
260# define DSA_F_OLD_DSA_PRIV_DECODE 122
261# define DSA_F_PKEY_DSA_CTRL 120
262# define DSA_F_PKEY_DSA_KEYGEN 121
d02b48c6
RE
263
264/* Reason codes. */
0f113f3e
MC
265# define DSA_R_BAD_Q_VALUE 102
266# define DSA_R_BN_DECODE_ERROR 108
267# define DSA_R_BN_ERROR 109
0f113f3e
MC
268# define DSA_R_DECODE_ERROR 104
269# define DSA_R_INVALID_DIGEST_TYPE 106
270# define DSA_R_INVALID_PARAMETERS 112
0f113f3e
MC
271# define DSA_R_MISSING_PARAMETERS 101
272# define DSA_R_MODULUS_TOO_LARGE 103
0f113f3e
MC
273# define DSA_R_NO_PARAMETERS_SET 107
274# define DSA_R_PARAMETER_ENCODING_ERROR 105
275# define DSA_R_Q_NOT_PRIME 113
6d311938 276
0cd0a820 277# ifdef __cplusplus
d02b48c6 278}
0cd0a820 279# endif
3c27208f 280# endif
d02b48c6 281#endif