epoc32/include/stdapis/openssl/dh.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 0 061f57f2323e
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /* crypto/dh/dh.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 #ifndef HEADER_DH_H
    60 #define HEADER_DH_H
    61 
    62 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
    63 #define SYMBIAN
    64 #endif
    65 
    66 #include <openssl/e_os2.h>
    67 
    68 #ifdef OPENSSL_NO_DH
    69 #error DH is disabled.
    70 #endif
    71 
    72 #ifndef OPENSSL_NO_BIO
    73 #include <openssl/bio.h>
    74 #endif
    75 #include <openssl/ossl_typ.h>
    76 #ifndef OPENSSL_NO_DEPRECATED
    77 #include <openssl/bn.h>
    78 #endif
    79 
    80 #ifndef OPENSSL_DH_MAX_MODULUS_BITS
    81 # define OPENSSL_DH_MAX_MODULUS_BITS	10000
    82 #endif
    83 
    84 	
    85 #define DH_FLAG_CACHE_MONT_P     0x01
    86 #define DH_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DH
    87                                        * implementation now uses constant time
    88                                        * modular exponentiation for secret exponents
    89                                        * by default. This flag causes the
    90                                        * faster variable sliding window method to
    91                                        * be used for all exponents.
    92                                        */
    93 
    94 #ifdef  __cplusplus
    95 extern "C" {
    96 #endif
    97 
    98 /* Already defined in ossl_typ.h */
    99 /* typedef struct dh_st DH; */
   100 /* typedef struct dh_method DH_METHOD; */
   101 
   102 struct dh_method
   103 	{
   104 	const char *name;
   105 	/* Methods here */
   106 	int (*generate_key)(DH *dh);
   107 	int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh);
   108 	int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
   109 				const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
   110 				BN_MONT_CTX *m_ctx); /* Can be null */
   111 
   112 	int (*init)(DH *dh);
   113 	int (*finish)(DH *dh);
   114 	int flags;
   115 	char *app_data;
   116 	/* If this is non-NULL, it will be used to generate parameters */
   117 	int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb);
   118 	};
   119 
   120 struct dh_st
   121 	{
   122 	/* This first argument is used to pick up errors when
   123 	 * a DH is passed instead of a EVP_PKEY */
   124 	int pad;
   125 	int version;
   126 	BIGNUM *p;
   127 	BIGNUM *g;
   128 	long length; /* optional */
   129 	BIGNUM *pub_key;	/* g^x */
   130 	BIGNUM *priv_key;	/* x */
   131 
   132 	int flags;
   133 	BN_MONT_CTX *method_mont_p;
   134 	/* Place holders if we want to do X9.42 DH */
   135 	BIGNUM *q;
   136 	BIGNUM *j;
   137 	unsigned char *seed;
   138 	int seedlen;
   139 	BIGNUM *counter;
   140 
   141 	int references;
   142 	CRYPTO_EX_DATA ex_data;
   143 	const DH_METHOD *meth;
   144 	ENGINE *engine;
   145 	};
   146 
   147 #define DH_GENERATOR_2		2
   148 /* #define DH_GENERATOR_3	3 */
   149 #define DH_GENERATOR_5		5
   150 
   151 /* DH_check error codes */
   152 #define DH_CHECK_P_NOT_PRIME		0x01
   153 #define DH_CHECK_P_NOT_SAFE_PRIME	0x02
   154 #define DH_UNABLE_TO_CHECK_GENERATOR	0x04
   155 #define DH_NOT_SUITABLE_GENERATOR	0x08
   156 
   157 /* DH_check_pub_key error codes */
   158 #define DH_CHECK_PUBKEY_TOO_SMALL	0x01
   159 #define DH_CHECK_PUBKEY_TOO_LARGE	0x02
   160 
   161 /* primes p where (p-1)/2 is prime too are called "safe"; we define
   162    this for backward compatibility: */
   163 #define DH_CHECK_P_NOT_STRONG_PRIME	DH_CHECK_P_NOT_SAFE_PRIME
   164 
   165 #define DHparams_dup(x) ASN1_dup_of_const(DH,i2d_DHparams,d2i_DHparams,x)
   166 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
   167 		(char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
   168 #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
   169 		(unsigned char *)(x))
   170 #define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
   171 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
   172 
   173 IMPORT_C const DH_METHOD *DH_OpenSSL(void);
   174 
   175 IMPORT_C void DH_set_default_method(const DH_METHOD *meth);
   176 IMPORT_C const DH_METHOD *DH_get_default_method(void);
   177 IMPORT_C int DH_set_method(DH *dh, const DH_METHOD *meth);
   178 IMPORT_C DH *DH_new_method(ENGINE *engine);
   179 
   180 IMPORT_C DH *	DH_new(void);
   181 IMPORT_C void	DH_free(DH *dh);
   182 IMPORT_C int	DH_up_ref(DH *dh);
   183 IMPORT_C int	DH_size(const DH *dh);
   184 IMPORT_C int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
   185 	     CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
   186 IMPORT_C int DH_set_ex_data(DH *d, int idx, void *arg);
   187 IMPORT_C void *DH_get_ex_data(DH *d, int idx);
   188 
   189 /* Deprecated version */
   190 #ifndef OPENSSL_NO_DEPRECATED
   191 IMPORT_C DH *	DH_generate_parameters(int prime_len,int generator,
   192 		void (*callback)(int,int,void *),void *cb_arg);
   193 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
   194 
   195 /* New version */
   196 IMPORT_C int	DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
   197 
   198 IMPORT_C int	DH_check(const DH *dh,int *codes);
   199 IMPORT_C int	DH_check_pub_key(const DH *dh,const BIGNUM *pub_key, int *codes);
   200 IMPORT_C int	DH_generate_key(DH *dh);
   201 IMPORT_C int	DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
   202 IMPORT_C DH *	d2i_DHparams(DH **a,const unsigned char **pp, long length);
   203 IMPORT_C int	i2d_DHparams(const DH *a,unsigned char **pp);
   204 #ifndef OPENSSL_NO_FP_API
   205 IMPORT_C int	DHparams_print_fp(FILE *fp, const DH *x);
   206 #endif
   207 #ifndef OPENSSL_NO_BIO
   208 IMPORT_C int	DHparams_print(BIO *bp, const DH *x);
   209 #else
   210 IMPORT_C int	DHparams_print(char *bp, const DH *x);
   211 #endif
   212 
   213 /* BEGIN ERROR CODES */
   214 /* The following lines are auto generated by the script mkerr.pl. Any changes
   215  * made after this point may be overwritten when the script is next run.
   216  */
   217 IMPORT_C void ERR_load_DH_strings(void);
   218 
   219 /* Error codes for the DH functions. */
   220 
   221 /* Function codes. */
   222 #define DH_F_COMPUTE_KEY				 102
   223 #define DH_F_DHPARAMS_PRINT				 100
   224 #define DH_F_DHPARAMS_PRINT_FP				 101
   225 #define DH_F_DH_BUILTIN_GENPARAMS			 106
   226 #define DH_F_DH_NEW_METHOD				 105
   227 #define DH_F_GENERATE_KEY				 103
   228 #define DH_F_GENERATE_PARAMETERS			 104
   229 
   230 /* Reason codes. */
   231 #define DH_R_BAD_GENERATOR				 101
   232 #define DH_R_NO_PRIVATE_VALUE				 100
   233 #define DH_R_MODULUS_TOO_LARGE				 103
   234 #define DH_R_INVALID_PUBKEY				 102
   235 
   236 #ifdef  __cplusplus
   237 }
   238 #endif
   239 #endif