dsa.h revision 296465
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#ifndef HEADER_DSA_H 66# define HEADER_DSA_H 67 68# include <openssl/e_os2.h> 69 70# ifdef OPENSSL_NO_DSA 71# error DSA is disabled. 72# endif 73 74# ifndef OPENSSL_NO_BIO 75# include <openssl/bio.h> 76# endif 77# include <openssl/crypto.h> 78# include <openssl/ossl_typ.h> 79 80# ifndef OPENSSL_NO_DEPRECATED 81# include <openssl/bn.h> 82# ifndef OPENSSL_NO_DH 83# include <openssl/dh.h> 84# endif 85# endif 86 87# ifndef OPENSSL_DSA_MAX_MODULUS_BITS 88# define OPENSSL_DSA_MAX_MODULUS_BITS 10000 89# endif 90 91# define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024 92 93# define DSA_FLAG_CACHE_MONT_P 0x01 94/* 95 * new with 0.9.7h; the built-in DSA implementation now uses constant time 96 * modular exponentiation for secret exponents by default. This flag causes 97 * the faster variable sliding window method to be used for all exponents. 98 */ 99# define DSA_FLAG_NO_EXP_CONSTTIME 0x02 100 101/* 102 * If this flag is set the DSA method is FIPS compliant and can be used in 103 * FIPS mode. This is set in the validated module method. If an application 104 * sets this flag in its own methods it is its reposibility to ensure the 105 * result is compliant. 106 */ 107 108# define DSA_FLAG_FIPS_METHOD 0x0400 109 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# define DSA_FLAG_NON_FIPS_ALLOW 0x0400 117 118# ifdef OPENSSL_FIPS 119# define FIPS_DSA_SIZE_T int 120# endif 121 122#ifdef __cplusplus 123extern "C" { 124#endif 125 126/* Already defined in ossl_typ.h */ 127/* typedef struct dsa_st DSA; */ 128/* typedef struct dsa_method DSA_METHOD; */ 129 130typedef struct DSA_SIG_st { 131 BIGNUM *r; 132 BIGNUM *s; 133} DSA_SIG; 134 135struct dsa_method { 136 const char *name; 137 DSA_SIG *(*dsa_do_sign) (const unsigned char *dgst, int dlen, DSA *dsa); 138 int (*dsa_sign_setup) (DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, 139 BIGNUM **rp); 140 int (*dsa_do_verify) (const unsigned char *dgst, int dgst_len, 141 DSA_SIG *sig, DSA *dsa); 142 int (*dsa_mod_exp) (DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1, 143 BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx, 144 BN_MONT_CTX *in_mont); 145 /* Can be null */ 146 int (*bn_mod_exp) (DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p, 147 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); 148 int (*init) (DSA *dsa); 149 int (*finish) (DSA *dsa); 150 int flags; 151 char *app_data; 152 /* If this is non-NULL, it is used to generate DSA parameters */ 153 int (*dsa_paramgen) (DSA *dsa, int bits, 154 unsigned char *seed, int seed_len, 155 int *counter_ret, unsigned long *h_ret, 156 BN_GENCB *cb); 157 /* If this is non-NULL, it is used to generate DSA keys */ 158 int (*dsa_keygen) (DSA *dsa); 159}; 160 161struct dsa_st { 162 /* 163 * This first variable is used to pick up errors where a DSA is passed 164 * instead of of a EVP_PKEY 165 */ 166 int pad; 167 long version; 168 int write_params; 169 BIGNUM *p; 170 BIGNUM *q; /* == 20 */ 171 BIGNUM *g; 172 BIGNUM *pub_key; /* y public key */ 173 BIGNUM *priv_key; /* x private key */ 174 BIGNUM *kinv; /* Signing pre-calc */ 175 BIGNUM *r; /* Signing pre-calc */ 176 int flags; 177 /* Normally used to cache montgomery values */ 178 BN_MONT_CTX *method_mont_p; 179 int references; 180 CRYPTO_EX_DATA ex_data; 181 const DSA_METHOD *meth; 182 /* functional reference if 'meth' is ENGINE-provided */ 183 ENGINE *engine; 184}; 185 186# define DSAparams_dup(x) ASN1_dup_of_const(DSA,i2d_DSAparams,d2i_DSAparams,x) 187# define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \ 188 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x)) 189# define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \ 190 (unsigned char *)(x)) 191# define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x) 192# define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x) 193 194DSA_SIG *DSA_SIG_new(void); 195void DSA_SIG_free(DSA_SIG *a); 196int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp); 197DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length); 198 199DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa); 200int DSA_do_verify(const unsigned char *dgst, int dgst_len, 201 DSA_SIG *sig, DSA *dsa); 202 203const DSA_METHOD *DSA_OpenSSL(void); 204 205void DSA_set_default_method(const DSA_METHOD *); 206const DSA_METHOD *DSA_get_default_method(void); 207int DSA_set_method(DSA *dsa, const DSA_METHOD *); 208 209# ifdef OPENSSL_FIPS 210DSA *FIPS_dsa_new(void); 211void FIPS_dsa_free(DSA *r); 212# endif 213 214DSA *DSA_new(void); 215DSA *DSA_new_method(ENGINE *engine); 216void DSA_free(DSA *r); 217/* "up" the DSA object's reference count */ 218int DSA_up_ref(DSA *r); 219int DSA_size(const DSA *); 220 /* next 4 return -1 on error */ 221int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp); 222int DSA_sign(int type, const unsigned char *dgst, int dlen, 223 unsigned char *sig, unsigned int *siglen, DSA *dsa); 224int DSA_verify(int type, const unsigned char *dgst, int dgst_len, 225 const unsigned char *sigbuf, int siglen, DSA *dsa); 226int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 227 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 228int DSA_set_ex_data(DSA *d, int idx, void *arg); 229void *DSA_get_ex_data(DSA *d, int idx); 230 231DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length); 232DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length); 233DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length); 234 235/* Deprecated version */ 236# ifndef OPENSSL_NO_DEPRECATED 237DSA *DSA_generate_parameters(int bits, 238 unsigned char *seed, int seed_len, 239 int *counter_ret, unsigned long *h_ret, void 240 (*callback) (int, int, void *), void *cb_arg); 241# endif /* !defined(OPENSSL_NO_DEPRECATED) */ 242 243/* New version */ 244int DSA_generate_parameters_ex(DSA *dsa, int bits, 245 unsigned char *seed, int seed_len, 246 int *counter_ret, unsigned long *h_ret, 247 BN_GENCB *cb); 248 249int DSA_generate_key(DSA *a); 250int i2d_DSAPublicKey(const DSA *a, unsigned char **pp); 251int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp); 252int i2d_DSAparams(const DSA *a, unsigned char **pp); 253 254# ifndef OPENSSL_NO_BIO 255int DSAparams_print(BIO *bp, const DSA *x); 256int DSA_print(BIO *bp, const DSA *x, int off); 257# endif 258# ifndef OPENSSL_NO_FP_API 259int DSAparams_print_fp(FILE *fp, const DSA *x); 260int DSA_print_fp(FILE *bp, const DSA *x, int off); 261# endif 262 263# define DSS_prime_checks 50 264/* 265 * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of 266 * Rabin-Miller 267 */ 268# define DSA_is_prime(n, callback, cb_arg) \ 269 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg) 270 271# ifndef OPENSSL_NO_DH 272/* 273 * Convert DSA structure (key or just parameters) into DH structure (be 274 * careful to avoid small subgroup attacks when using this!) 275 */ 276DH *DSA_dup_DH(const DSA *r); 277# endif 278 279# ifdef OPENSSL_FIPS 280int FIPS_dsa_sig_encode(unsigned char *out, DSA_SIG *sig); 281int FIPS_dsa_sig_decode(DSA_SIG *sig, const unsigned char *in, int inlen); 282# endif 283 284/* BEGIN ERROR CODES */ 285/* 286 * The following lines are auto generated by the script mkerr.pl. Any changes 287 * made after this point may be overwritten when the script is next run. 288 */ 289void ERR_load_DSA_strings(void); 290 291/* Error codes for the DSA functions. */ 292 293/* Function codes. */ 294# define DSA_F_D2I_DSA_SIG 110 295# define DSA_F_DSAPARAMS_PRINT 100 296# define DSA_F_DSAPARAMS_PRINT_FP 101 297# define DSA_F_DSA_BUILTIN_KEYGEN 119 298# define DSA_F_DSA_BUILTIN_PARAMGEN 118 299# define DSA_F_DSA_DO_SIGN 112 300# define DSA_F_DSA_DO_VERIFY 113 301# define DSA_F_DSA_GENERATE_PARAMETERS 117 302# define DSA_F_DSA_NEW_METHOD 103 303# define DSA_F_DSA_PRINT 104 304# define DSA_F_DSA_PRINT_FP 105 305# define DSA_F_DSA_SET_DEFAULT_METHOD 115 306# define DSA_F_DSA_SET_METHOD 116 307# define DSA_F_DSA_SIGN 106 308# define DSA_F_DSA_SIGN_SETUP 107 309# define DSA_F_DSA_SIG_NEW 109 310# define DSA_F_DSA_VERIFY 108 311# define DSA_F_I2D_DSA_SIG 111 312# define DSA_F_SIG_CB 114 313 314/* Reason codes. */ 315# define DSA_R_BAD_Q_VALUE 102 316# define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100 317# define DSA_R_KEY_SIZE_TOO_SMALL 106 318# define DSA_R_MISSING_PARAMETERS 101 319# define DSA_R_MODULUS_TOO_LARGE 103 320# define DSA_R_NON_FIPS_METHOD 104 321# define DSA_R_OPERATION_NOT_ALLOWED_IN_FIPS_MODE 105 322 323#ifdef __cplusplus 324} 325#endif 326#endif 327