AppleCSP/open_ssl/openssl/dsa.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18
  19 /* crypto/dsa/dsa.h */
  20 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  21  * All rights reserved.
  22  *
  23  * This package is an SSL implementation written
  24  * by Eric Young (eay@cryptsoft.com).
  25  * The implementation was written so as to conform with Netscapes SSL.
  26  *
  27  * This library is free for commercial and non-commercial use as long as
  28  * the following conditions are aheared to.  The following conditions
  29  * apply to all code found in this distribution, be it the RC4, RSA,
  30  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  31  * included with this distribution is covered by the same copyright terms
  32  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  33  *
  34  * Copyright remains Eric Young's, and as such any Copyright notices in
  35  * the code are not to be removed.
  36  * If this package is used in a product, Eric Young should be given attribution
  37  * as the author of the parts of the library used.
  38  * This can be in the form of a textual message at program startup or
  39  * in documentation (online or textual) provided with the package.
  40  *
  41  * Redistribution and use in source and binary forms, with or without
  42  * modification, are permitted provided that the following conditions
  43  * are met:
  44  * 1. Redistributions of source code must retain the copyright
  45  *    notice, this list of conditions and the following disclaimer.
  46  * 2. Redistributions in binary form must reproduce the above copyright
  47  *    notice, this list of conditions and the following disclaimer in the
  48  *    documentation and/or other materials provided with the distribution.
  49  * 3. All advertising materials mentioning features or use of this software
  50  *    must display the following acknowledgement:
  51  *    "This product includes cryptographic software written by
  52  *     Eric Young (eay@cryptsoft.com)"
  53  *    The word 'cryptographic' can be left out if the rouines from the library
  54  *    being used are not cryptographic related :-).
  55  * 4. If you include any Windows specific code (or a derivative thereof) from
  56  *    the apps directory (application code) you must include an acknowledgement:
  57  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  58  *
  59  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  69  * SUCH DAMAGE.
  70  *
  71  * The licence and distribution terms for any publically available version or
  72  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  73  * copied and put under another distribution licence
  74  * [including the GNU Public Licence.]
  75  */
  76
  77 /*
  78  * The DSS routines are based on patches supplied by
  79  * Steven Schoch <schoch@sheba.arc.nasa.gov>.  He basically did the
  80  * work and I have just tweaked them a little to fit into my
  81  * stylistic vision for SSLeay :-) */
  82
  83 #ifndef HEADER_DSA_H
  84 #define HEADER_DSA_H
  85
  86 #ifdef  __cplusplus
  87 extern "C" {
  88 #endif
  89
  90 #ifdef NO_DSA
  91 #error DSA is disabled.
  92 #endif
  93
  94 #include <openssl/bn.h>
  95 #include <openssl/crypto.h>
  96 #ifndef NO_DH
  97 # include <openssl/dh.h>
  98 #endif
  99
 100 #define DSA_FLAG_CACHE_MONT_P   0x01
 101
 102 typedef struct dsa_st DSA;
 103
 104 typedef struct DSA_SIG_st
 105         {
 106         BIGNUM *r;
 107         BIGNUM *s;
 108         } DSA_SIG;
 109
 110 typedef struct dsa_method {
 111         const char *name;
 112         DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa);
 113         int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
 114                                                                 BIGNUM **rp);
 115         int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
 116                                                         DSA_SIG *sig, DSA *dsa);
 117         int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
 118                         BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
 119                         BN_MONT_CTX *in_mont);
 120         int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
 121                                 const BIGNUM *m, BN_CTX *ctx,
 122                                 BN_MONT_CTX *m_ctx); /* Can be null */
 123         int (*init)(DSA *dsa);
 124         int (*finish)(DSA *dsa);
 125         int flags;
 126         char *app_data;
 127 } DSA_METHOD;
 128
 129 struct dsa_st
 130         {
 131         /* This first variable is used to pick up errors where
 132          * a DSA is passed instead of of a EVP_PKEY */
 133         int pad;
 134         int version;
 135         int write_params;
 136         BIGNUM *p;
 137         BIGNUM *q;      /* == 20 */
 138         BIGNUM *g;
 139
 140         BIGNUM *pub_key;  /* y public key */
 141         BIGNUM *priv_key; /* x private key */
 142
 143         BIGNUM *kinv;   /* Signing pre-calc */
 144         BIGNUM *r;      /* Signing pre-calc */
 145
 146         int flags;
 147         /* Normally used to cache montgomery values */
 148         char *method_mont_p;
 149         int references;
 150         CRYPTO_EX_DATA ex_data;
 151         const DSA_METHOD *meth;
 152         };
 153
 154 #define DSAparams_dup(x) (DSA *)ASN1_dup((int (*)())i2d_DSAparams, \
 155                 (char *(*)())d2i_DSAparams,(char *)(x))
 156 #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
 157                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
 158 #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
 159                 (unsigned char *)(x))
 160 #define d2i_DSAparams_bio(bp,x) (DSA *)ASN1_d2i_bio((char *(*)())DSA_new, \
 161                 (char *(*)())d2i_DSAparams,(bp),(unsigned char **)(x))
 162 #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio(i2d_DSAparams,(bp), \
 163                 (unsigned char *)(x))
 164
 165
 166 DSA_SIG * DSA_SIG_new(void);
 167 void    DSA_SIG_free(DSA_SIG *a);
 168 int     i2d_DSA_SIG(DSA_SIG *a, unsigned char **pp);
 169 DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);
 170
 171 DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
 172 int     DSA_do_verify(const unsigned char *dgst,int dgst_len,
 173                       DSA_SIG *sig,DSA *dsa);
 174
 175 const DSA_METHOD *DSA_OpenSSL(void);
 176
 177 void        DSA_set_default_method(const DSA_METHOD *);
 178 const DSA_METHOD *DSA_get_default_method(void);
 179 const DSA_METHOD *DSA_set_method(DSA *dsa, const DSA_METHOD *);
 180
 181 DSA *   DSA_new(void);
 182 DSA *   DSA_new_method(const DSA_METHOD *meth);
 183 int     DSA_size(DSA *);
 184         /* next 4 return -1 on error */
 185 int     DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
 186 int     DSA_sign(int type,const unsigned char *dgst,int dlen,
 187                 unsigned char *sig, unsigned int *siglen, DSA *dsa);
 188 int     DSA_verify(int type,const unsigned char *dgst,int dgst_len,
 189                 unsigned char *sigbuf, int siglen, DSA *dsa);
 190 void    DSA_free (DSA *r);
 191 int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 192              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
 193 int DSA_set_ex_data(DSA *d, int idx, void *arg);
 194 void *DSA_get_ex_data(DSA *d, int idx);
 195
 196 void    ERR_load_DSA_strings(void );
 197
 198 DSA *   d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
 199 DSA *   d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
 200 DSA *   d2i_DSAparams(DSA **a, unsigned char **pp, long length);
 201 DSA *   DSA_generate_parameters(int bits, unsigned char *seed,int seed_len,
 202                 int *counter_ret, unsigned long *h_ret,void
 203                 (*callback)(int, int, void *),void *cb_arg);
 204 int     DSA_generate_key(DSA *a);
 205 int     i2d_DSAPublicKey(DSA *a, unsigned char **pp);
 206 int     i2d_DSAPrivateKey(DSA *a, unsigned char **pp);
 207 int     i2d_DSAparams(DSA *a,unsigned char **pp);
 208
 209 #ifdef HEADER_BIO_H
 210 int     DSAparams_print(BIO *bp, DSA *x);
 211 int     DSA_print(BIO *bp, DSA *x, int off);
 212 #endif
 213 #ifndef NO_FP_API
 214 int     DSAparams_print_fp(FILE *fp, DSA *x);
 215 int     DSA_print_fp(FILE *bp, DSA *x, int off);
 216 #endif
 217
 218 #define DSS_prime_checks 50
 219 /* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
 220  * 50 rounds of Rabin-Miller */
 221 #define DSA_is_prime(n, callback, cb_arg) \
 222         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
 223
 224 #ifndef NO_DH
 225 /* Convert DSA structure (key or just parameters) into DH structure
 226  * (be careful to avoid small subgroup attacks when using this!) */
 227 DH *DSA_dup_DH(DSA *r);
 228 #endif
 229
 230 /* BEGIN ERROR CODES */
 231 /* The following lines are auto generated by the script mkerr.pl. Any changes
 232  * made after this point may be overwritten when the script is next run.
 233  */
 234
 235 /* Error codes for the DSA functions. */
 236
 237 /* Function codes. */
 238 #define DSA_F_D2I_DSA_SIG                                110
 239 #define DSA_F_DSAPARAMS_PRINT                            100
 240 #define DSA_F_DSAPARAMS_PRINT_FP                         101
 241 #define DSA_F_DSA_DO_SIGN                                112
 242 #define DSA_F_DSA_DO_VERIFY                              113
 243 #define DSA_F_DSA_NEW                                    103
 244 #define DSA_F_DSA_PRINT                                  104
 245 #define DSA_F_DSA_PRINT_FP                               105
 246 #define DSA_F_DSA_SIGN                                   106
 247 #define DSA_F_DSA_SIGN_SETUP                             107
 248 #define DSA_F_DSA_SIG_NEW                                109
 249 #define DSA_F_DSA_VERIFY                                 108
 250 #define DSA_F_I2D_DSA_SIG                                111
 251
 252 /* Reason codes. */
 253 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                100
 254
 255 #ifdef  __cplusplus
 256 }
 257 #endif
 258 #endif
 259