dsa.h revision 68651
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#ifdef NO_DSA 69#error DSA is disabled. 70#endif 71 72#ifndef NO_BIO 73#include <openssl/bio.h> 74#endif 75#include <openssl/bn.h> 76#include <openssl/crypto.h> 77#ifndef NO_DH 78# include <openssl/dh.h> 79#endif 80 81#define DSA_FLAG_CACHE_MONT_P 0x01 82 83#ifdef __cplusplus 84extern "C" { 85#endif 86 87typedef struct dsa_st DSA; 88 89typedef struct DSA_SIG_st 90 { 91 BIGNUM *r; 92 BIGNUM *s; 93 } DSA_SIG; 94 95typedef struct dsa_method { 96 const char *name; 97 DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa); 98 int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, 99 BIGNUM **rp); 100 int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len, 101 DSA_SIG *sig, DSA *dsa); 102 int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1, 103 BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx, 104 BN_MONT_CTX *in_mont); 105 int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p, 106 const BIGNUM *m, BN_CTX *ctx, 107 BN_MONT_CTX *m_ctx); /* Can be null */ 108 int (*init)(DSA *dsa); 109 int (*finish)(DSA *dsa); 110 int flags; 111 char *app_data; 112} DSA_METHOD; 113 114struct dsa_st 115 { 116 /* This first variable is used to pick up errors where 117 * a DSA is passed instead of of a EVP_PKEY */ 118 int pad; 119 int version; 120 int write_params; 121 BIGNUM *p; 122 BIGNUM *q; /* == 20 */ 123 BIGNUM *g; 124 125 BIGNUM *pub_key; /* y public key */ 126 BIGNUM *priv_key; /* x private key */ 127 128 BIGNUM *kinv; /* Signing pre-calc */ 129 BIGNUM *r; /* Signing pre-calc */ 130 131 int flags; 132 /* Normally used to cache montgomery values */ 133 char *method_mont_p; 134 int references; 135 CRYPTO_EX_DATA ex_data; 136 DSA_METHOD *meth; 137 }; 138 139#define DSAparams_dup(x) (DSA *)ASN1_dup((int (*)())i2d_DSAparams, \ 140 (char *(*)())d2i_DSAparams,(char *)(x)) 141#define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \ 142 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x)) 143#define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \ 144 (unsigned char *)(x)) 145#define d2i_DSAparams_bio(bp,x) (DSA *)ASN1_d2i_bio((char *(*)())DSA_new, \ 146 (char *(*)())d2i_DSAparams,(bp),(unsigned char **)(x)) 147#define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio(i2d_DSAparams,(bp), \ 148 (unsigned char *)(x)) 149 150 151DSA_SIG * DSA_SIG_new(void); 152void DSA_SIG_free(DSA_SIG *a); 153int i2d_DSA_SIG(DSA_SIG *a, unsigned char **pp); 154DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length); 155 156DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa); 157int DSA_do_verify(const unsigned char *dgst,int dgst_len, 158 DSA_SIG *sig,DSA *dsa); 159 160DSA_METHOD *DSA_OpenSSL(void); 161 162void DSA_set_default_method(DSA_METHOD *); 163DSA_METHOD *DSA_get_default_method(void); 164DSA_METHOD *DSA_set_method(DSA *dsa, DSA_METHOD *); 165 166DSA * DSA_new(void); 167DSA * DSA_new_method(DSA_METHOD *meth); 168int DSA_size(DSA *); 169 /* next 4 return -1 on error */ 170int DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp); 171int DSA_sign(int type,const unsigned char *dgst,int dlen, 172 unsigned char *sig, unsigned int *siglen, DSA *dsa); 173int DSA_verify(int type,const unsigned char *dgst,int dgst_len, 174 unsigned char *sigbuf, int siglen, DSA *dsa); 175void DSA_free (DSA *r); 176int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 177 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 178int DSA_set_ex_data(DSA *d, int idx, void *arg); 179void *DSA_get_ex_data(DSA *d, int idx); 180 181void ERR_load_DSA_strings(void ); 182 183DSA * d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length); 184DSA * d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length); 185DSA * d2i_DSAparams(DSA **a, unsigned char **pp, long length); 186DSA * DSA_generate_parameters(int bits, unsigned char *seed,int seed_len, 187 int *counter_ret, unsigned long *h_ret,void 188 (*callback)(int, int, void *),void *cb_arg); 189int DSA_generate_key(DSA *a); 190int i2d_DSAPublicKey(DSA *a, unsigned char **pp); 191int i2d_DSAPrivateKey(DSA *a, unsigned char **pp); 192int i2d_DSAparams(DSA *a,unsigned char **pp); 193 194#ifndef NO_BIO 195int DSAparams_print(BIO *bp, DSA *x); 196int DSA_print(BIO *bp, DSA *x, int off); 197#endif 198#ifndef NO_FP_API 199int DSAparams_print_fp(FILE *fp, DSA *x); 200int DSA_print_fp(FILE *bp, DSA *x, int off); 201#endif 202 203#define DSS_prime_checks 50 204/* Primality test according to FIPS PUB 186[-1], Appendix 2.1: 205 * 50 rounds of Rabin-Miller */ 206#define DSA_is_prime(n, callback, cb_arg) \ 207 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg) 208 209#ifndef NO_DH 210/* Convert DSA structure (key or just parameters) into DH structure 211 * (be careful to avoid small subgroup attacks when using this!) */ 212DH *DSA_dup_DH(DSA *r); 213#endif 214 215/* BEGIN ERROR CODES */ 216/* The following lines are auto generated by the script mkerr.pl. Any changes 217 * made after this point may be overwritten when the script is next run. 218 */ 219 220/* Error codes for the DSA functions. */ 221 222/* Function codes. */ 223#define DSA_F_D2I_DSA_SIG 110 224#define DSA_F_DSAPARAMS_PRINT 100 225#define DSA_F_DSAPARAMS_PRINT_FP 101 226#define DSA_F_DSA_DO_SIGN 112 227#define DSA_F_DSA_DO_VERIFY 113 228#define DSA_F_DSA_NEW 103 229#define DSA_F_DSA_PRINT 104 230#define DSA_F_DSA_PRINT_FP 105 231#define DSA_F_DSA_SIGN 106 232#define DSA_F_DSA_SIGN_SETUP 107 233#define DSA_F_DSA_SIG_NEW 109 234#define DSA_F_DSA_VERIFY 108 235#define DSA_F_I2D_DSA_SIG 111 236 237/* Reason codes. */ 238#define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100 239 240#ifdef __cplusplus 241} 242#endif 243#endif 244 245