dsa.h

00001 /* crypto/dsa/dsa.h */
00002 /* Copyright (C) 1995-1998 Eric Young ([email protected])
00003  * All rights reserved.
00004  *
00005  * This package is an SSL implementation written
00006  * by Eric Young ([email protected]).
00007  * The implementation was written so as to conform with Netscapes SSL.
00008  * 
00009  * This library is free for commercial and non-commercial use as long as
00010  * the following conditions are aheared to.  The following conditions
00011  * apply to all code found in this distribution, be it the RC4, RSA,
00012  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
00013  * included with this distribution is covered by the same copyright terms
00014  * except that the holder is Tim Hudson ([email protected]).
00015  * 
00016  * Copyright remains Eric Young's, and as such any Copyright notices in
00017  * the code are not to be removed.
00018  * If this package is used in a product, Eric Young should be given attribution
00019  * as the author of the parts of the library used.
00020  * This can be in the form of a textual message at program startup or
00021  * in documentation (online or textual) provided with the package.
00022  * 
00023  * Redistribution and use in source and binary forms, with or without
00024  * modification, are permitted provided that the following conditions
00025  * are met:
00026  * 1. Redistributions of source code must retain the copyright
00027  *    notice, this list of conditions and the following disclaimer.
00028  * 2. Redistributions in binary form must reproduce the above copyright
00029  *    notice, this list of conditions and the following disclaimer in the
00030  *    documentation and/or other materials provided with the distribution.
00031  * 3. All advertising materials mentioning features or use of this software
00032  *    must display the following acknowledgement:
00033  *    "This product includes cryptographic software written by
00034  *     Eric Young ([email protected])"
00035  *    The word 'cryptographic' can be left out if the rouines from the library
00036  *    being used are not cryptographic related :-).
00037  * 4. If you include any Windows specific code (or a derivative thereof) from 
00038  *    the apps directory (application code) you must include an acknowledgement:
00039  *    "This product includes software written by Tim Hudson ([email protected])"
00040  * 
00041  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
00042  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00043  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00044  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
00045  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00046  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00047  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00049  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00050  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00051  * SUCH DAMAGE.
00052  * 
00053  * The licence and distribution terms for any publically available version or
00054  * derivative of this code cannot be changed.  i.e. this code cannot simply be
00055  * copied and put under another distribution licence
00056  * [including the GNU Public Licence.]
00057  */
00058 /*
00059  © Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
00060  */
00061 
00062 /*
00063  * The DSS routines are based on patches supplied by
00064  * Steven Schoch <[email protected]>.  He basically did the
00065  * work and I have just tweaked them a little to fit into my
00066  * stylistic vision for SSLeay :-) */
00067 
00068 #ifndef HEADER_DSA_H
00069 #define HEADER_DSA_H
00070 
00071 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
00072 #define SYMBIAN
00073 #endif
00074 
00075 #ifdef SYMBIAN
00076 #include <e32def.h>
00077 #endif
00078 #include <openssl/e_os2.h>
00079 
00080 #ifdef OPENSSL_NO_DSA
00081 #error DSA is disabled.
00082 #endif
00083 
00084 #ifndef OPENSSL_NO_BIO
00085 #include <openssl/bio.h>
00086 #endif
00087 #include <openssl/crypto.h>
00088 #include <openssl/ossl_typ.h>
00089 
00090 #ifndef OPENSSL_NO_DEPRECATED
00091 #include <openssl/bn.h>
00092 #ifndef OPENSSL_NO_DH
00093 # include <openssl/dh.h>
00094 #endif
00095 #endif
00096 #ifndef OPENSSL_DSA_MAX_MODULUS_BITS
00097 # define OPENSSL_DSA_MAX_MODULUS_BITS   10000
00098 #endif
00099 
00100 #define DSA_FLAG_CACHE_MONT_P   0x01
00101 #define DSA_FLAG_NO_EXP_CONSTTIME       0x02 /* new with 0.9.7h; the built-in DSA
00102                                               * implementation now uses constant time
00103                                               * modular exponentiation for secret exponents
00104                                               * by default. This flag causes the
00105                                               * faster variable sliding window method to
00106                                               * be used for all exponents.
00107                                               */
00108 
00109 #ifdef  __cplusplus
00110 extern "C" {
00111 #endif
00112 
00113 /* Already defined in ossl_typ.h */
00114 /* typedef struct dsa_st DSA; */
00115 /* typedef struct dsa_method DSA_METHOD; */
00116 
00117 typedef struct DSA_SIG_st
00118         {
00119         BIGNUM *r;
00120         BIGNUM *s;
00121         } DSA_SIG;
00122 
00123 struct dsa_method
00124         {
00125         const char *name;
00126         DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa);
00127         int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
00128                                                                 BIGNUM **rp);
00129         int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
00130                                                         DSA_SIG *sig, DSA *dsa);
00131         int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
00132                         BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
00133                         BN_MONT_CTX *in_mont);
00134         int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
00135                                 const BIGNUM *m, BN_CTX *ctx,
00136                                 BN_MONT_CTX *m_ctx); /* Can be null */
00137         int (*init)(DSA *dsa);
00138         int (*finish)(DSA *dsa);
00139         int flags;
00140         char *app_data;
00141         /* If this is non-NULL, it is used to generate DSA parameters */
00142         int (*dsa_paramgen)(DSA *dsa, int bits,
00143                         unsigned char *seed, int seed_len,
00144                         int *counter_ret, unsigned long *h_ret,
00145                         BN_GENCB *cb);
00146         /* If this is non-NULL, it is used to generate DSA keys */
00147         int (*dsa_keygen)(DSA *dsa);
00148         };
00149 
00150 struct dsa_st
00151         {
00152         /* This first variable is used to pick up errors where
00153          * a DSA is passed instead of of a EVP_PKEY */
00154         int pad;
00155         long version;
00156         int write_params;
00157         BIGNUM *p;
00158         BIGNUM *q;      /* == 20 */
00159         BIGNUM *g;
00160 
00161         BIGNUM *pub_key;  /* y public key */
00162         BIGNUM *priv_key; /* x private key */
00163 
00164         BIGNUM *kinv;   /* Signing pre-calc */
00165         BIGNUM *r;      /* Signing pre-calc */
00166 
00167         int flags;
00168         /* Normally used to cache montgomery values */
00169         BN_MONT_CTX *method_mont_p;
00170         int references;
00171         CRYPTO_EX_DATA ex_data;
00172         const DSA_METHOD *meth;
00173         /* functional reference if 'meth' is ENGINE-provided */
00174         ENGINE *engine;
00175         };
00176 
00177 #define DSAparams_dup(x) ASN1_dup_of_const(DSA,i2d_DSAparams,d2i_DSAparams,x)
00178 #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
00179                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
00180 #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
00181                 (unsigned char *)(x))
00182 #define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
00183 #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
00184 
00185 
00186 IMPORT_C DSA_SIG * DSA_SIG_new(void);
00187 IMPORT_C void   DSA_SIG_free(DSA_SIG *a);
00188 IMPORT_C int    i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
00189 IMPORT_C DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
00190 
00191 IMPORT_C DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
00192 IMPORT_C int    DSA_do_verify(const unsigned char *dgst,int dgst_len,
00193                       DSA_SIG *sig,DSA *dsa);
00194 
00195 IMPORT_C const DSA_METHOD *DSA_OpenSSL(void);
00196 
00197 IMPORT_C void   DSA_set_default_method(const DSA_METHOD *);
00198 IMPORT_C const DSA_METHOD *DSA_get_default_method(void);
00199 IMPORT_C int    DSA_set_method(DSA *dsa, const DSA_METHOD *);
00200 
00201 IMPORT_C DSA *  DSA_new(void);
00202 IMPORT_C DSA *  DSA_new_method(ENGINE *engine);
00203 IMPORT_C void   DSA_free (DSA *r);
00204 /* "up" the DSA object's reference count */
00205 IMPORT_C int    DSA_up_ref(DSA *r);
00206 IMPORT_C int    DSA_size(const DSA *);
00207         /* next 4 return -1 on error */
00208 IMPORT_C int    DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
00209 IMPORT_C int    DSA_sign(int type,const unsigned char *dgst,int dlen,
00210                 unsigned char *sig, unsigned int *siglen, DSA *dsa);
00211 IMPORT_C int    DSA_verify(int type,const unsigned char *dgst,int dgst_len,
00212                 const unsigned char *sigbuf, int siglen, DSA *dsa);
00213 IMPORT_C int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
00214              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
00215 IMPORT_C int DSA_set_ex_data(DSA *d, int idx, void *arg);
00216 IMPORT_C void *DSA_get_ex_data(DSA *d, int idx);
00217 
00218 IMPORT_C DSA *  d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
00219 IMPORT_C DSA *  d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
00220 IMPORT_C DSA *  d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
00221 
00222 
00223 /* New version */
00224 IMPORT_C int    DSA_generate_parameters_ex(DSA *dsa, int bits,
00225                 unsigned char *seed,int seed_len,
00226                 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb);
00227 
00228 IMPORT_C int    DSA_generate_key(DSA *a);
00229 IMPORT_C int    i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
00230 IMPORT_C int    i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
00231 IMPORT_C int    i2d_DSAparams(const DSA *a,unsigned char **pp);
00232 
00233 #ifndef OPENSSL_NO_BIO
00234 IMPORT_C int    DSAparams_print(BIO *bp, const DSA *x);
00235 IMPORT_C int    DSA_print(BIO *bp, const DSA *x, int off);
00236 #endif
00237 #ifndef OPENSSL_NO_FP_API
00238 IMPORT_C int    DSAparams_print_fp(FILE *fp, const DSA *x);
00239 IMPORT_C int    DSA_print_fp(FILE *bp, const DSA *x, int off);
00240 #endif
00241 
00242 #define DSS_prime_checks 50
00243 /* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
00244  * 50 rounds of Rabin-Miller */
00245 #define DSA_is_prime(n, callback, cb_arg) \
00246         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
00247 
00248 #ifndef OPENSSL_NO_DH
00249 /* Convert DSA structure (key or just parameters) into DH structure
00250  * (be careful to avoid small subgroup attacks when using this!) */
00251 IMPORT_C DH *DSA_dup_DH(const DSA *r);
00252 #endif
00253 
00254 /* BEGIN ERROR CODES */
00255 /* The following lines are auto generated by the script mkerr.pl. Any changes
00256  * made after this point may be overwritten when the script is next run.
00257  */
00258 IMPORT_C void ERR_load_DSA_strings(void);
00259 
00260 /* Error codes for the DSA functions. */
00261 
00262 /* Function codes. */
00263 #define DSA_F_D2I_DSA_SIG                                110
00264 #define DSA_F_DSAPARAMS_PRINT                            100
00265 #define DSA_F_DSAPARAMS_PRINT_FP                         101
00266 #define DSA_F_DSA_DO_SIGN                                112
00267 #define DSA_F_DSA_DO_VERIFY                              113
00268 #define DSA_F_DSA_NEW_METHOD                             103
00269 #define DSA_F_DSA_PRINT                                  104
00270 #define DSA_F_DSA_PRINT_FP                               105
00271 #define DSA_F_DSA_SIGN                                   106
00272 #define DSA_F_DSA_SIGN_SETUP                             107
00273 #define DSA_F_DSA_SIG_NEW                                109
00274 #define DSA_F_DSA_VERIFY                                 108
00275 #define DSA_F_I2D_DSA_SIG                                111
00276 #define DSA_F_SIG_CB                                     114
00277 
00278 /* Reason codes. */
00279 #define DSA_R_BAD_Q_VALUE                                102
00280 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                100
00281 #define DSA_R_MISSING_PARAMETERS                         101
00282 #define DSA_R_MODULUS_TOO_LARGE                          103
00283 #ifdef  __cplusplus
00284 }
00285 #endif
00286 #endif