epoc32/include/stdapis/openssl/dsa.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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  © Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
    60  */
    61 
    62 /*
    63  * The DSS routines are based on patches supplied by
    64  * Steven Schoch <schoch@sheba.arc.nasa.gov>.  He basically did the
    65  * work and I have just tweaked them a little to fit into my
    66  * stylistic vision for SSLeay :-) */
    67 
    68 #ifndef HEADER_DSA_H
    69 #define HEADER_DSA_H
    70 
    71 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
    72 #define SYMBIAN
    73 #endif
    74 
    75 #ifdef SYMBIAN
    76 #include <e32def.h>
    77 #endif
    78 #include <openssl/e_os2.h>
    79 
    80 #ifdef OPENSSL_NO_DSA
    81 #error DSA is disabled.
    82 #endif
    83 
    84 #ifndef OPENSSL_NO_BIO
    85 #include <openssl/bio.h>
    86 #endif
    87 #include <openssl/crypto.h>
    88 #include <openssl/ossl_typ.h>
    89 
    90 #ifndef OPENSSL_NO_DEPRECATED
    91 #include <openssl/bn.h>
    92 #ifndef OPENSSL_NO_DH
    93 # include <openssl/dh.h>
    94 #endif
    95 #endif
    96 #ifndef OPENSSL_DSA_MAX_MODULUS_BITS
    97 # define OPENSSL_DSA_MAX_MODULUS_BITS	10000
    98 #endif
    99 
   100 #define DSA_FLAG_CACHE_MONT_P	0x01
   101 #define DSA_FLAG_NO_EXP_CONSTTIME       0x02 /* new with 0.9.7h; the built-in DSA
   102                                               * implementation now uses constant time
   103                                               * modular exponentiation for secret exponents
   104                                               * by default. This flag causes the
   105                                               * faster variable sliding window method to
   106                                               * be used for all exponents.
   107                                               */
   108 
   109 #ifdef  __cplusplus
   110 extern "C" {
   111 #endif
   112 
   113 /* Already defined in ossl_typ.h */
   114 /* typedef struct dsa_st DSA; */
   115 /* typedef struct dsa_method DSA_METHOD; */
   116 
   117 typedef struct DSA_SIG_st
   118 	{
   119 	BIGNUM *r;
   120 	BIGNUM *s;
   121 	} DSA_SIG;
   122 
   123 struct dsa_method
   124 	{
   125 	const char *name;
   126 	DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa);
   127 	int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
   128 								BIGNUM **rp);
   129 	int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
   130 							DSA_SIG *sig, DSA *dsa);
   131 	int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
   132 			BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
   133 			BN_MONT_CTX *in_mont);
   134 	int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
   135 				const BIGNUM *m, BN_CTX *ctx,
   136 				BN_MONT_CTX *m_ctx); /* Can be null */
   137 	int (*init)(DSA *dsa);
   138 	int (*finish)(DSA *dsa);
   139 	int flags;
   140 	char *app_data;
   141 	/* If this is non-NULL, it is used to generate DSA parameters */
   142 	int (*dsa_paramgen)(DSA *dsa, int bits,
   143 			unsigned char *seed, int seed_len,
   144 			int *counter_ret, unsigned long *h_ret,
   145 			BN_GENCB *cb);
   146 	/* If this is non-NULL, it is used to generate DSA keys */
   147 	int (*dsa_keygen)(DSA *dsa);
   148 	};
   149 
   150 struct dsa_st
   151 	{
   152 	/* This first variable is used to pick up errors where
   153 	 * a DSA is passed instead of of a EVP_PKEY */
   154 	int pad;
   155 	long version;
   156 	int write_params;
   157 	BIGNUM *p;
   158 	BIGNUM *q;	/* == 20 */
   159 	BIGNUM *g;
   160 
   161 	BIGNUM *pub_key;  /* y public key */
   162 	BIGNUM *priv_key; /* x private key */
   163 
   164 	BIGNUM *kinv;	/* Signing pre-calc */
   165 	BIGNUM *r;	/* Signing pre-calc */
   166 
   167 	int flags;
   168 	/* Normally used to cache montgomery values */
   169 	BN_MONT_CTX *method_mont_p;
   170 	int references;
   171 	CRYPTO_EX_DATA ex_data;
   172 	const DSA_METHOD *meth;
   173 	/* functional reference if 'meth' is ENGINE-provided */
   174 	ENGINE *engine;
   175 	};
   176 
   177 #define DSAparams_dup(x) ASN1_dup_of_const(DSA,i2d_DSAparams,d2i_DSAparams,x)
   178 #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
   179 		(char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
   180 #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
   181 		(unsigned char *)(x))
   182 #define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
   183 #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
   184 
   185 
   186 IMPORT_C DSA_SIG * DSA_SIG_new(void);
   187 IMPORT_C void	DSA_SIG_free(DSA_SIG *a);
   188 IMPORT_C int	i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
   189 IMPORT_C DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
   190 
   191 IMPORT_C DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
   192 IMPORT_C int	DSA_do_verify(const unsigned char *dgst,int dgst_len,
   193 		      DSA_SIG *sig,DSA *dsa);
   194 
   195 IMPORT_C const DSA_METHOD *DSA_OpenSSL(void);
   196 
   197 IMPORT_C void	DSA_set_default_method(const DSA_METHOD *);
   198 IMPORT_C const DSA_METHOD *DSA_get_default_method(void);
   199 IMPORT_C int	DSA_set_method(DSA *dsa, const DSA_METHOD *);
   200 
   201 IMPORT_C DSA *	DSA_new(void);
   202 IMPORT_C DSA *	DSA_new_method(ENGINE *engine);
   203 IMPORT_C void	DSA_free (DSA *r);
   204 /* "up" the DSA object's reference count */
   205 IMPORT_C int	DSA_up_ref(DSA *r);
   206 IMPORT_C int	DSA_size(const DSA *);
   207 	/* next 4 return -1 on error */
   208 IMPORT_C int	DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
   209 IMPORT_C int	DSA_sign(int type,const unsigned char *dgst,int dlen,
   210 		unsigned char *sig, unsigned int *siglen, DSA *dsa);
   211 IMPORT_C int	DSA_verify(int type,const unsigned char *dgst,int dgst_len,
   212 		const unsigned char *sigbuf, int siglen, DSA *dsa);
   213 IMPORT_C int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
   214 	     CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
   215 IMPORT_C int DSA_set_ex_data(DSA *d, int idx, void *arg);
   216 IMPORT_C void *DSA_get_ex_data(DSA *d, int idx);
   217 
   218 IMPORT_C DSA *	d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
   219 IMPORT_C DSA *	d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
   220 IMPORT_C DSA * 	d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
   221 
   222 /* Deprecated version */
   223 #ifndef OPENSSL_NO_DEPRECATED
   224 IMPORT_C DSA *	DSA_generate_parameters(int bits,
   225 		unsigned char *seed,int seed_len,
   226 		int *counter_ret, unsigned long *h_ret,void
   227 		(*callback)(int, int, void *),void *cb_arg);
   228 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
   229 
   230 /* New version */
   231 IMPORT_C int	DSA_generate_parameters_ex(DSA *dsa, int bits,
   232 		unsigned char *seed,int seed_len,
   233 		int *counter_ret, unsigned long *h_ret, BN_GENCB *cb);
   234 
   235 IMPORT_C int	DSA_generate_key(DSA *a);
   236 IMPORT_C int	i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
   237 IMPORT_C int 	i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
   238 IMPORT_C int	i2d_DSAparams(const DSA *a,unsigned char **pp);
   239 
   240 #ifndef OPENSSL_NO_BIO
   241 IMPORT_C int	DSAparams_print(BIO *bp, const DSA *x);
   242 IMPORT_C int	DSA_print(BIO *bp, const DSA *x, int off);
   243 #endif
   244 #ifndef OPENSSL_NO_FP_API
   245 IMPORT_C int	DSAparams_print_fp(FILE *fp, const DSA *x);
   246 IMPORT_C int	DSA_print_fp(FILE *bp, const DSA *x, int off);
   247 #endif
   248 
   249 #define DSS_prime_checks 50
   250 /* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
   251  * 50 rounds of Rabin-Miller */
   252 #define DSA_is_prime(n, callback, cb_arg) \
   253 	BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
   254 
   255 #ifndef OPENSSL_NO_DH
   256 /* Convert DSA structure (key or just parameters) into DH structure
   257  * (be careful to avoid small subgroup attacks when using this!) */
   258 IMPORT_C DH *DSA_dup_DH(const DSA *r);
   259 #endif
   260 
   261 /* BEGIN ERROR CODES */
   262 /* The following lines are auto generated by the script mkerr.pl. Any changes
   263  * made after this point may be overwritten when the script is next run.
   264  */
   265 IMPORT_C void ERR_load_DSA_strings(void);
   266 
   267 /* Error codes for the DSA functions. */
   268 
   269 /* Function codes. */
   270 #define DSA_F_D2I_DSA_SIG				 110
   271 #define DSA_F_DSAPARAMS_PRINT				 100
   272 #define DSA_F_DSAPARAMS_PRINT_FP			 101
   273 #define DSA_F_DSA_DO_SIGN				 112
   274 #define DSA_F_DSA_DO_VERIFY				 113
   275 #define DSA_F_DSA_NEW_METHOD				 103
   276 #define DSA_F_DSA_PRINT					 104
   277 #define DSA_F_DSA_PRINT_FP				 105
   278 #define DSA_F_DSA_SIGN					 106
   279 #define DSA_F_DSA_SIGN_SETUP				 107
   280 #define DSA_F_DSA_SIG_NEW				 109
   281 #define DSA_F_DSA_VERIFY				 108
   282 #define DSA_F_I2D_DSA_SIG				 111
   283 #define DSA_F_SIG_CB					 114
   284 
   285 /* Reason codes. */
   286 #define DSA_R_BAD_Q_VALUE				 102
   287 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE		 100
   288 #define DSA_R_MISSING_PARAMETERS			 101
   289 #define DSA_R_MODULUS_TOO_LARGE				 103
   290 #ifdef  __cplusplus
   291 }
   292 #endif
   293 #endif