155714Skris/* crypto/dsa/dsa.h */ 255714Skris/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 355714Skris * All rights reserved. 455714Skris * 555714Skris * This package is an SSL implementation written 655714Skris * by Eric Young (eay@cryptsoft.com). 755714Skris * The implementation was written so as to conform with Netscapes SSL. 8280304Sjkim * 955714Skris * This library is free for commercial and non-commercial use as long as 1055714Skris * the following conditions are aheared to. The following conditions 1155714Skris * apply to all code found in this distribution, be it the RC4, RSA, 1255714Skris * lhash, DES, etc., code; not just the SSL code. The SSL documentation 1355714Skris * included with this distribution is covered by the same copyright terms 1455714Skris * except that the holder is Tim Hudson (tjh@cryptsoft.com). 15280304Sjkim * 1655714Skris * Copyright remains Eric Young's, and as such any Copyright notices in 1755714Skris * the code are not to be removed. 1855714Skris * If this package is used in a product, Eric Young should be given attribution 1955714Skris * as the author of the parts of the library used. 2055714Skris * This can be in the form of a textual message at program startup or 2155714Skris * in documentation (online or textual) provided with the package. 22280304Sjkim * 2355714Skris * Redistribution and use in source and binary forms, with or without 2455714Skris * modification, are permitted provided that the following conditions 2555714Skris * are met: 2655714Skris * 1. Redistributions of source code must retain the copyright 2755714Skris * notice, this list of conditions and the following disclaimer. 2855714Skris * 2. Redistributions in binary form must reproduce the above copyright 2955714Skris * notice, this list of conditions and the following disclaimer in the 3055714Skris * documentation and/or other materials provided with the distribution. 3155714Skris * 3. All advertising materials mentioning features or use of this software 3255714Skris * must display the following acknowledgement: 3355714Skris * "This product includes cryptographic software written by 3455714Skris * Eric Young (eay@cryptsoft.com)" 3555714Skris * The word 'cryptographic' can be left out if the rouines from the library 3655714Skris * being used are not cryptographic related :-). 37280304Sjkim * 4. If you include any Windows specific code (or a derivative thereof) from 3855714Skris * the apps directory (application code) you must include an acknowledgement: 3955714Skris * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 40280304Sjkim * 4155714Skris * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 4255714Skris * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 4355714Skris * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 4455714Skris * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 4555714Skris * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 4655714Skris * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 4755714Skris * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 4855714Skris * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 4955714Skris * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 5055714Skris * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 5155714Skris * SUCH DAMAGE. 52280304Sjkim * 5355714Skris * The licence and distribution terms for any publically available version or 5455714Skris * derivative of this code cannot be changed. i.e. this code cannot simply be 5555714Skris * copied and put under another distribution licence 5655714Skris * [including the GNU Public Licence.] 5755714Skris */ 5855714Skris 5955714Skris/* 6055714Skris * The DSS routines are based on patches supplied by 6155714Skris * Steven Schoch <schoch@sheba.arc.nasa.gov>. He basically did the 6255714Skris * work and I have just tweaked them a little to fit into my 6355714Skris * stylistic vision for SSLeay :-) */ 6455714Skris 6555714Skris#ifndef HEADER_DSA_H 66280304Sjkim# define HEADER_DSA_H 6755714Skris 68280304Sjkim# include <openssl/e_os2.h> 69160814Ssimon 70280304Sjkim# ifdef OPENSSL_NO_DSA 71280304Sjkim# error DSA is disabled. 72280304Sjkim# endif 7355714Skris 74280304Sjkim# ifndef OPENSSL_NO_BIO 75280304Sjkim# include <openssl/bio.h> 76280304Sjkim# endif 77280304Sjkim# include <openssl/crypto.h> 78280304Sjkim# include <openssl/ossl_typ.h> 79160814Ssimon 80280304Sjkim# ifndef OPENSSL_NO_DEPRECATED 81280304Sjkim# include <openssl/bn.h> 82280304Sjkim# ifndef OPENSSL_NO_DH 83280304Sjkim# include <openssl/dh.h> 84280304Sjkim# endif 85280304Sjkim# endif 8655714Skris 87280304Sjkim# ifndef OPENSSL_DSA_MAX_MODULUS_BITS 88280304Sjkim# define OPENSSL_DSA_MAX_MODULUS_BITS 10000 89280304Sjkim# endif 90162911Ssimon 91280304Sjkim# define DSA_FLAG_CACHE_MONT_P 0x01 92280304Sjkim/* 93280304Sjkim * new with 0.9.7h; the built-in DSA implementation now uses constant time 94280304Sjkim * modular exponentiation for secret exponents by default. This flag causes 95280304Sjkim * the faster variable sliding window method to be used for all exponents. 96280304Sjkim */ 97280304Sjkim# define DSA_FLAG_NO_EXP_CONSTTIME 0x02 9855714Skris 99280304Sjkim/* 100280304Sjkim * If this flag is set the DSA method is FIPS compliant and can be used in 101280304Sjkim * FIPS mode. This is set in the validated module method. If an application 102280304Sjkim * sets this flag in its own methods it is its reposibility to ensure the 103280304Sjkim * result is compliant. 104194206Ssimon */ 105194206Ssimon 106280304Sjkim# define DSA_FLAG_FIPS_METHOD 0x0400 107194206Ssimon 108280304Sjkim/* 109280304Sjkim * If this flag is set the operations normally disabled in FIPS mode are 110194206Ssimon * permitted it is then the applications responsibility to ensure that the 111194206Ssimon * usage is compliant. 112194206Ssimon */ 113194206Ssimon 114280304Sjkim# define DSA_FLAG_NON_FIPS_ALLOW 0x0400 115194206Ssimon 11668651Skris#ifdef __cplusplus 11768651Skrisextern "C" { 11868651Skris#endif 11968651Skris 120160814Ssimon/* Already defined in ossl_typ.h */ 121160814Ssimon/* typedef struct dsa_st DSA; */ 122160814Ssimon/* typedef struct dsa_method DSA_METHOD; */ 12359191Skris 124280304Sjkimtypedef struct DSA_SIG_st { 125280304Sjkim BIGNUM *r; 126280304Sjkim BIGNUM *s; 127280304Sjkim} DSA_SIG; 12859191Skris 129280304Sjkimstruct dsa_method { 130280304Sjkim const char *name; 131280304Sjkim DSA_SIG *(*dsa_do_sign) (const unsigned char *dgst, int dlen, DSA *dsa); 132280304Sjkim int (*dsa_sign_setup) (DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, 133280304Sjkim BIGNUM **rp); 134280304Sjkim int (*dsa_do_verify) (const unsigned char *dgst, int dgst_len, 135280304Sjkim DSA_SIG *sig, DSA *dsa); 136280304Sjkim int (*dsa_mod_exp) (DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1, 137280304Sjkim BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx, 138280304Sjkim BN_MONT_CTX *in_mont); 139280304Sjkim /* Can be null */ 140280304Sjkim int (*bn_mod_exp) (DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p, 141280304Sjkim const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); 142280304Sjkim int (*init) (DSA *dsa); 143280304Sjkim int (*finish) (DSA *dsa); 144280304Sjkim int flags; 145280304Sjkim char *app_data; 146280304Sjkim /* If this is non-NULL, it is used to generate DSA parameters */ 147280304Sjkim int (*dsa_paramgen) (DSA *dsa, int bits, 148280304Sjkim const unsigned char *seed, int seed_len, 149280304Sjkim int *counter_ret, unsigned long *h_ret, 150280304Sjkim BN_GENCB *cb); 151280304Sjkim /* If this is non-NULL, it is used to generate DSA keys */ 152280304Sjkim int (*dsa_keygen) (DSA *dsa); 153280304Sjkim}; 15459191Skris 155280304Sjkimstruct dsa_st { 156280304Sjkim /* 157280304Sjkim * This first variable is used to pick up errors where a DSA is passed 158280304Sjkim * instead of of a EVP_PKEY 159280304Sjkim */ 160280304Sjkim int pad; 161280304Sjkim long version; 162280304Sjkim int write_params; 163280304Sjkim BIGNUM *p; 164280304Sjkim BIGNUM *q; /* == 20 */ 165280304Sjkim BIGNUM *g; 166280304Sjkim BIGNUM *pub_key; /* y public key */ 167280304Sjkim BIGNUM *priv_key; /* x private key */ 168280304Sjkim BIGNUM *kinv; /* Signing pre-calc */ 169280304Sjkim BIGNUM *r; /* Signing pre-calc */ 170280304Sjkim int flags; 171280304Sjkim /* Normally used to cache montgomery values */ 172280304Sjkim BN_MONT_CTX *method_mont_p; 173280304Sjkim int references; 174280304Sjkim CRYPTO_EX_DATA ex_data; 175280304Sjkim const DSA_METHOD *meth; 176280304Sjkim /* functional reference if 'meth' is ENGINE-provided */ 177280304Sjkim ENGINE *engine; 178280304Sjkim}; 17955714Skris 180280304Sjkim# define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \ 181280304Sjkim (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x)) 182280304Sjkim# define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \ 183280304Sjkim (unsigned char *)(x)) 184280304Sjkim# define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x) 185280304Sjkim# define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x) 18655714Skris 187238405SjkimDSA *DSAparams_dup(DSA *x); 188280304SjkimDSA_SIG *DSA_SIG_new(void); 189280304Sjkimvoid DSA_SIG_free(DSA_SIG *a); 190280304Sjkimint i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp); 191280304SjkimDSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length); 19255714Skris 193280304SjkimDSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa); 194280304Sjkimint DSA_do_verify(const unsigned char *dgst, int dgst_len, 195280304Sjkim DSA_SIG *sig, DSA *dsa); 19655714Skris 197109998Smarkmconst DSA_METHOD *DSA_OpenSSL(void); 19859191Skris 199280304Sjkimvoid DSA_set_default_method(const DSA_METHOD *); 200109998Smarkmconst DSA_METHOD *DSA_get_default_method(void); 201280304Sjkimint DSA_set_method(DSA *dsa, const DSA_METHOD *); 20259191Skris 203280304SjkimDSA *DSA_new(void); 204280304SjkimDSA *DSA_new_method(ENGINE *engine); 205280304Sjkimvoid DSA_free(DSA *r); 206109998Smarkm/* "up" the DSA object's reference count */ 207280304Sjkimint DSA_up_ref(DSA *r); 208280304Sjkimint DSA_size(const DSA *); 209280304Sjkim /* next 4 return -1 on error */ 210280304Sjkimint DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp); 211280304Sjkimint DSA_sign(int type, const unsigned char *dgst, int dlen, 212280304Sjkim unsigned char *sig, unsigned int *siglen, DSA *dsa); 213280304Sjkimint DSA_verify(int type, const unsigned char *dgst, int dgst_len, 214280304Sjkim const unsigned char *sigbuf, int siglen, DSA *dsa); 21559191Skrisint DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 216280304Sjkim CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 21759191Skrisint DSA_set_ex_data(DSA *d, int idx, void *arg); 21859191Skrisvoid *DSA_get_ex_data(DSA *d, int idx); 21955714Skris 220280304SjkimDSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length); 221280304SjkimDSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length); 222280304SjkimDSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length); 223160814Ssimon 224160814Ssimon/* Deprecated version */ 225280304Sjkim# ifndef OPENSSL_NO_DEPRECATED 226280304SjkimDSA *DSA_generate_parameters(int bits, 227280304Sjkim unsigned char *seed, int seed_len, 228280304Sjkim int *counter_ret, unsigned long *h_ret, void 229280304Sjkim (*callback) (int, int, void *), void *cb_arg); 230280304Sjkim# endif /* !defined(OPENSSL_NO_DEPRECATED) */ 231160814Ssimon 232160814Ssimon/* New version */ 233280304Sjkimint DSA_generate_parameters_ex(DSA *dsa, int bits, 234280304Sjkim const unsigned char *seed, int seed_len, 235280304Sjkim int *counter_ret, unsigned long *h_ret, 236280304Sjkim BN_GENCB *cb); 237160814Ssimon 238280304Sjkimint DSA_generate_key(DSA *a); 239280304Sjkimint i2d_DSAPublicKey(const DSA *a, unsigned char **pp); 240280304Sjkimint i2d_DSAPrivateKey(const DSA *a, unsigned char **pp); 241280304Sjkimint i2d_DSAparams(const DSA *a, unsigned char **pp); 24255714Skris 243280304Sjkim# ifndef OPENSSL_NO_BIO 244280304Sjkimint DSAparams_print(BIO *bp, const DSA *x); 245280304Sjkimint DSA_print(BIO *bp, const DSA *x, int off); 246280304Sjkim# endif 247280304Sjkim# ifndef OPENSSL_NO_FP_API 248280304Sjkimint DSAparams_print_fp(FILE *fp, const DSA *x); 249280304Sjkimint DSA_print_fp(FILE *bp, const DSA *x, int off); 250280304Sjkim# endif 25155714Skris 252280304Sjkim# define DSS_prime_checks 50 253280304Sjkim/* 254280304Sjkim * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of 255280304Sjkim * Rabin-Miller 256280304Sjkim */ 257280304Sjkim# define DSA_is_prime(n, callback, cb_arg) \ 258280304Sjkim BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg) 25955714Skris 260280304Sjkim# ifndef OPENSSL_NO_DH 261280304Sjkim/* 262280304Sjkim * Convert DSA structure (key or just parameters) into DH structure (be 263280304Sjkim * careful to avoid small subgroup attacks when using this!) 264280304Sjkim */ 265109998SmarkmDH *DSA_dup_DH(const DSA *r); 266280304Sjkim# endif 26755714Skris 268280304Sjkim# define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \ 269280304Sjkim EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ 270280304Sjkim EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL) 271194206Ssimon 272280304Sjkim# define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1) 273280304Sjkim# define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2) 274280304Sjkim# define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3) 275238405Sjkim 27655714Skris/* BEGIN ERROR CODES */ 277280304Sjkim/* 278280304Sjkim * The following lines are auto generated by the script mkerr.pl. Any changes 27955714Skris * made after this point may be overwritten when the script is next run. 28055714Skris */ 28189837Skrisvoid ERR_load_DSA_strings(void); 28255714Skris 28355714Skris/* Error codes for the DSA functions. */ 28455714Skris 28555714Skris/* Function codes. */ 286280304Sjkim# define DSA_F_D2I_DSA_SIG 110 287280304Sjkim# define DSA_F_DO_DSA_PRINT 104 288280304Sjkim# define DSA_F_DSAPARAMS_PRINT 100 289280304Sjkim# define DSA_F_DSAPARAMS_PRINT_FP 101 290280304Sjkim# define DSA_F_DSA_DO_SIGN 112 291280304Sjkim# define DSA_F_DSA_DO_VERIFY 113 292280304Sjkim# define DSA_F_DSA_GENERATE_KEY 124 293280304Sjkim# define DSA_F_DSA_GENERATE_PARAMETERS_EX 123 294280304Sjkim# define DSA_F_DSA_NEW_METHOD 103 295280304Sjkim# define DSA_F_DSA_PARAM_DECODE 119 296280304Sjkim# define DSA_F_DSA_PRINT_FP 105 297280304Sjkim# define DSA_F_DSA_PRIV_DECODE 115 298280304Sjkim# define DSA_F_DSA_PRIV_ENCODE 116 299280304Sjkim# define DSA_F_DSA_PUB_DECODE 117 300280304Sjkim# define DSA_F_DSA_PUB_ENCODE 118 301280304Sjkim# define DSA_F_DSA_SIGN 106 302280304Sjkim# define DSA_F_DSA_SIGN_SETUP 107 303280304Sjkim# define DSA_F_DSA_SIG_NEW 109 304280304Sjkim# define DSA_F_DSA_SIG_PRINT 125 305280304Sjkim# define DSA_F_DSA_VERIFY 108 306280304Sjkim# define DSA_F_I2D_DSA_SIG 111 307280304Sjkim# define DSA_F_OLD_DSA_PRIV_DECODE 122 308280304Sjkim# define DSA_F_PKEY_DSA_CTRL 120 309280304Sjkim# define DSA_F_PKEY_DSA_KEYGEN 121 310280304Sjkim# define DSA_F_SIG_CB 114 31155714Skris 31255714Skris/* Reason codes. */ 313280304Sjkim# define DSA_R_BAD_Q_VALUE 102 314280304Sjkim# define DSA_R_BN_DECODE_ERROR 108 315280304Sjkim# define DSA_R_BN_ERROR 109 316280304Sjkim# define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100 317280304Sjkim# define DSA_R_DECODE_ERROR 104 318280304Sjkim# define DSA_R_INVALID_DIGEST_TYPE 106 319280304Sjkim# define DSA_R_MISSING_PARAMETERS 101 320280304Sjkim# define DSA_R_MODULUS_TOO_LARGE 103 321280304Sjkim# define DSA_R_NEED_NEW_SETUP_VALUES 110 322280304Sjkim# define DSA_R_NON_FIPS_DSA_METHOD 111 323280304Sjkim# define DSA_R_NO_PARAMETERS_SET 107 324280304Sjkim# define DSA_R_PARAMETER_ENCODING_ERROR 105 32555714Skris 32655714Skris#ifdef __cplusplus 32755714Skris} 32855714Skris#endif 32955714Skris#endif 330