crypto/dsa/dsa.h

   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  __cplusplus
  69 extern "C" {
  70 #endif
  71
  72 #ifdef NO_DSA
  73 #error DSA is disabled.
  74 #endif
  75
  76 #include <openssl/bn.h>
  77 #ifndef NO_DH
  78 # include <openssl/dh.h>
  79 #endif
  80
  81 #define DSA_FLAG_CACHE_MONT_P   0x01
  82
  83 typedef struct dsa_st
  84         {
  85         /* This first variable is used to pick up errors where
  86          * a DSA is passed instead of of a EVP_PKEY */
  87         int pad;
  88         int version;
  89         int write_params;
  90         BIGNUM *p;
  91         BIGNUM *q;      /* == 20 */
  92         BIGNUM *g;
  93
  94         BIGNUM *pub_key;  /* y public key */
  95         BIGNUM *priv_key; /* x private key */
  96
  97         BIGNUM *kinv;   /* Signing pre-calc */
  98         BIGNUM *r;      /* Signing pre-calc */
  99
 100         int flags;
 101         /* Normally used to cache montgomery values */
 102         char *method_mont_p;
 103
 104         int references;
 105         } DSA;
 106
 107 typedef struct DSA_SIG_st
 108         {
 109         BIGNUM *r;
 110         BIGNUM *s;
 111         } DSA_SIG;
 112
 113 #define DSAparams_dup(x) (DSA *)ASN1_dup((int (*)())i2d_DSAparams, \
 114                 (char *(*)())d2i_DSAparams,(char *)(x))
 115 #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
 116                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
 117 #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
 118                 (unsigned char *)(x))
 119 #define d2i_DSAparams_bio(bp,x) (DSA *)ASN1_d2i_bio((char *(*)())DSA_new, \
 120                 (char *(*)())d2i_DSAparams,(bp),(unsigned char **)(x))
 121 #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio(i2d_DSAparams,(bp), \
 122                 (unsigned char *)(x))
 123
 124
 125 DSA_SIG * DSA_SIG_new(void);
 126 void    DSA_SIG_free(DSA_SIG *a);
 127 int     i2d_DSA_SIG(DSA_SIG *a, unsigned char **pp);
 128 DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);
 129
 130 DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
 131 int     DSA_do_verify(const unsigned char *dgst,int dgst_len,
 132                       DSA_SIG *sig,DSA *dsa);
 133
 134 DSA *   DSA_new(void);
 135 int     DSA_size(DSA *);
 136         /* next 4 return -1 on error */
 137 int     DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
 138 int     DSA_sign(int type,const unsigned char *dgst,int dlen,
 139                 unsigned char *sig, unsigned int *siglen, DSA *dsa);
 140 int     DSA_verify(int type,const unsigned char *dgst,int dgst_len,
 141                 unsigned char *sigbuf, int siglen, DSA *dsa);
 142 void    DSA_free (DSA *r);
 143
 144 void    ERR_load_DSA_strings(void );
 145
 146 DSA *   d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
 147 DSA *   d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
 148 DSA *   d2i_DSAparams(DSA **a, unsigned char **pp, long length);
 149 DSA *   DSA_generate_parameters(int bits, unsigned char *seed,int seed_len,
 150                 int *counter_ret, unsigned long *h_ret,void
 151                 (*callback)(),char *cb_arg);
 152 int     DSA_generate_key(DSA *a);
 153 int     i2d_DSAPublicKey(DSA *a, unsigned char **pp);
 154 int     i2d_DSAPrivateKey(DSA *a, unsigned char **pp);
 155 int     i2d_DSAparams(DSA *a,unsigned char **pp);
 156
 157 #ifdef HEADER_BIO_H
 158 int     DSAparams_print(BIO *bp, DSA *x);
 159 int     DSA_print(BIO *bp, DSA *x, int off);
 160 #endif
 161 #ifndef NO_FP_API
 162 int     DSAparams_print_fp(FILE *fp, DSA *x);
 163 int     DSA_print_fp(FILE *bp, DSA *x, int off);
 164 #endif
 165
 166 int DSA_is_prime(BIGNUM *q,void (*callback)(),char *cb_arg);
 167
 168 #ifndef NO_DH
 169 /* Convert DSA structure (key or just parameters) into DH structure
 170  * (be careful to avoid small subgroup attacks when using this!) */
 171 DH *DSA_dup_DH(DSA *r);
 172 #endif
 173
 174 /* BEGIN ERROR CODES */
 175 /* The following lines are auto generated by the script mkerr.pl. Any changes
 176  * made after this point may be overwritten when the script is next run.
 177  */
 178
 179 /* Error codes for the DSA functions. */
 180
 181 /* Function codes. */
 182 #define DSA_F_D2I_DSA_SIG                                110
 183 #define DSA_F_DSAPARAMS_PRINT                            100
 184 #define DSA_F_DSAPARAMS_PRINT_FP                         101
 185 #define DSA_F_DSA_DO_SIGN                                112
 186 #define DSA_F_DSA_DO_VERIFY                              113
 187 #define DSA_F_DSA_IS_PRIME                               102
 188 #define DSA_F_DSA_NEW                                    103
 189 #define DSA_F_DSA_PRINT                                  104
 190 #define DSA_F_DSA_PRINT_FP                               105
 191 #define DSA_F_DSA_SIGN                                   106
 192 #define DSA_F_DSA_SIGN_SETUP                             107
 193 #define DSA_F_DSA_SIG_NEW                                109
 194 #define DSA_F_DSA_VERIFY                                 108
 195 #define DSA_F_I2D_DSA_SIG                                111
 196
 197 /* Reason codes. */
 198 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                100
 199
 200 #ifdef  __cplusplus
 201 }
 202 #endif
 203 #endif
 204