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.
williamr@2
     1
/* crypto/dh/dh.h */
williamr@2
     2
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
williamr@2
     3
 * All rights reserved.
williamr@2
     4
 *
williamr@2
     5
 * This package is an SSL implementation written
williamr@2
     6
 * by Eric Young (eay@cryptsoft.com).
williamr@2
     7
 * The implementation was written so as to conform with Netscapes SSL.
williamr@2
     8
 * 
williamr@2
     9
 * This library is free for commercial and non-commercial use as long as
williamr@2
    10
 * the following conditions are aheared to.  The following conditions
williamr@2
    11
 * apply to all code found in this distribution, be it the RC4, RSA,
williamr@2
    12
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
williamr@2
    13
 * included with this distribution is covered by the same copyright terms
williamr@2
    14
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
williamr@2
    15
 * 
williamr@2
    16
 * Copyright remains Eric Young's, and as such any Copyright notices in
williamr@2
    17
 * the code are not to be removed.
williamr@2
    18
 * If this package is used in a product, Eric Young should be given attribution
williamr@2
    19
 * as the author of the parts of the library used.
williamr@2
    20
 * This can be in the form of a textual message at program startup or
williamr@2
    21
 * in documentation (online or textual) provided with the package.
williamr@2
    22
 * 
williamr@2
    23
 * Redistribution and use in source and binary forms, with or without
williamr@2
    24
 * modification, are permitted provided that the following conditions
williamr@2
    25
 * are met:
williamr@2
    26
 * 1. Redistributions of source code must retain the copyright
williamr@2
    27
 *    notice, this list of conditions and the following disclaimer.
williamr@2
    28
 * 2. Redistributions in binary form must reproduce the above copyright
williamr@2
    29
 *    notice, this list of conditions and the following disclaimer in the
williamr@2
    30
 *    documentation and/or other materials provided with the distribution.
williamr@2
    31
 * 3. All advertising materials mentioning features or use of this software
williamr@2
    32
 *    must display the following acknowledgement:
williamr@2
    33
 *    "This product includes cryptographic software written by
williamr@2
    34
 *     Eric Young (eay@cryptsoft.com)"
williamr@2
    35
 *    The word 'cryptographic' can be left out if the rouines from the library
williamr@2
    36
 *    being used are not cryptographic related :-).
williamr@2
    37
 * 4. If you include any Windows specific code (or a derivative thereof) from 
williamr@2
    38
 *    the apps directory (application code) you must include an acknowledgement:
williamr@2
    39
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
williamr@2
    40
 * 
williamr@2
    41
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
williamr@2
    42
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
williamr@2
    43
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
williamr@2
    44
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
williamr@2
    45
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
williamr@2
    46
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
williamr@2
    47
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
williamr@2
    48
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
williamr@2
    49
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
williamr@2
    50
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
williamr@2
    51
 * SUCH DAMAGE.
williamr@2
    52
 * 
williamr@2
    53
 * The licence and distribution terms for any publically available version or
williamr@2
    54
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
williamr@2
    55
 * copied and put under another distribution licence
williamr@2
    56
 * [including the GNU Public Licence.]
williamr@2
    57
 */
williamr@2
    58
williamr@2
    59
#ifndef HEADER_DH_H
williamr@2
    60
#define HEADER_DH_H
williamr@2
    61
williamr@2
    62
#if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
williamr@2
    63
#define SYMBIAN
williamr@2
    64
#endif
williamr@2
    65
williamr@2
    66
#include <openssl/e_os2.h>
williamr@2
    67
williamr@2
    68
#ifdef OPENSSL_NO_DH
williamr@2
    69
#error DH is disabled.
williamr@2
    70
#endif
williamr@2
    71
williamr@2
    72
#ifndef OPENSSL_NO_BIO
williamr@2
    73
#include <openssl/bio.h>
williamr@2
    74
#endif
williamr@2
    75
#include <openssl/ossl_typ.h>
williamr@2
    76
#ifndef OPENSSL_NO_DEPRECATED
williamr@2
    77
#include <openssl/bn.h>
williamr@2
    78
#endif
williamr@2
    79
williamr@2
    80
#ifndef OPENSSL_DH_MAX_MODULUS_BITS
williamr@2
    81
# define OPENSSL_DH_MAX_MODULUS_BITS	10000
williamr@2
    82
#endif
williamr@2
    83
williamr@2
    84
	
williamr@2
    85
#define DH_FLAG_CACHE_MONT_P     0x01
williamr@2
    86
#define DH_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DH
williamr@2
    87
                                       * implementation now uses constant time
williamr@2
    88
                                       * modular exponentiation for secret exponents
williamr@2
    89
                                       * by default. This flag causes the
williamr@2
    90
                                       * faster variable sliding window method to
williamr@2
    91
                                       * be used for all exponents.
williamr@2
    92
                                       */
williamr@2
    93
williamr@2
    94
#ifdef  __cplusplus
williamr@2
    95
extern "C" {
williamr@2
    96
#endif
williamr@2
    97
williamr@2
    98
/* Already defined in ossl_typ.h */
williamr@2
    99
/* typedef struct dh_st DH; */
williamr@2
   100
/* typedef struct dh_method DH_METHOD; */
williamr@2
   101
williamr@2
   102
struct dh_method
williamr@2
   103
	{
williamr@2
   104
	const char *name;
williamr@2
   105
	/* Methods here */
williamr@2
   106
	int (*generate_key)(DH *dh);
williamr@2
   107
	int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh);
williamr@2
   108
	int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
williamr@2
   109
				const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
williamr@2
   110
				BN_MONT_CTX *m_ctx); /* Can be null */
williamr@2
   111
williamr@2
   112
	int (*init)(DH *dh);
williamr@2
   113
	int (*finish)(DH *dh);
williamr@2
   114
	int flags;
williamr@2
   115
	char *app_data;
williamr@2
   116
	/* If this is non-NULL, it will be used to generate parameters */
williamr@2
   117
	int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb);
williamr@2
   118
	};
williamr@2
   119
williamr@2
   120
struct dh_st
williamr@2
   121
	{
williamr@2
   122
	/* This first argument is used to pick up errors when
williamr@2
   123
	 * a DH is passed instead of a EVP_PKEY */
williamr@2
   124
	int pad;
williamr@2
   125
	int version;
williamr@2
   126
	BIGNUM *p;
williamr@2
   127
	BIGNUM *g;
williamr@2
   128
	long length; /* optional */
williamr@2
   129
	BIGNUM *pub_key;	/* g^x */
williamr@2
   130
	BIGNUM *priv_key;	/* x */
williamr@2
   131
williamr@2
   132
	int flags;
williamr@2
   133
	BN_MONT_CTX *method_mont_p;
williamr@2
   134
	/* Place holders if we want to do X9.42 DH */
williamr@2
   135
	BIGNUM *q;
williamr@2
   136
	BIGNUM *j;
williamr@2
   137
	unsigned char *seed;
williamr@2
   138
	int seedlen;
williamr@2
   139
	BIGNUM *counter;
williamr@2
   140
williamr@2
   141
	int references;
williamr@2
   142
	CRYPTO_EX_DATA ex_data;
williamr@2
   143
	const DH_METHOD *meth;
williamr@2
   144
	ENGINE *engine;
williamr@2
   145
	};
williamr@2
   146
williamr@2
   147
#define DH_GENERATOR_2		2
williamr@2
   148
/* #define DH_GENERATOR_3	3 */
williamr@2
   149
#define DH_GENERATOR_5		5
williamr@2
   150
williamr@2
   151
/* DH_check error codes */
williamr@2
   152
#define DH_CHECK_P_NOT_PRIME		0x01
williamr@2
   153
#define DH_CHECK_P_NOT_SAFE_PRIME	0x02
williamr@2
   154
#define DH_UNABLE_TO_CHECK_GENERATOR	0x04
williamr@2
   155
#define DH_NOT_SUITABLE_GENERATOR	0x08
williamr@2
   156
williamr@2
   157
/* DH_check_pub_key error codes */
williamr@2
   158
#define DH_CHECK_PUBKEY_TOO_SMALL	0x01
williamr@2
   159
#define DH_CHECK_PUBKEY_TOO_LARGE	0x02
williamr@2
   160
williamr@2
   161
/* primes p where (p-1)/2 is prime too are called "safe"; we define
williamr@2
   162
   this for backward compatibility: */
williamr@2
   163
#define DH_CHECK_P_NOT_STRONG_PRIME	DH_CHECK_P_NOT_SAFE_PRIME
williamr@2
   164
williamr@2
   165
#define DHparams_dup(x) ASN1_dup_of_const(DH,i2d_DHparams,d2i_DHparams,x)
williamr@2
   166
#define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
williamr@2
   167
		(char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
williamr@2
   168
#define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
williamr@2
   169
		(unsigned char *)(x))
williamr@2
   170
#define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
williamr@2
   171
#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
williamr@2
   172
williamr@2
   173
IMPORT_C const DH_METHOD *DH_OpenSSL(void);
williamr@2
   174
williamr@2
   175
IMPORT_C void DH_set_default_method(const DH_METHOD *meth);
williamr@2
   176
IMPORT_C const DH_METHOD *DH_get_default_method(void);
williamr@2
   177
IMPORT_C int DH_set_method(DH *dh, const DH_METHOD *meth);
williamr@2
   178
IMPORT_C DH *DH_new_method(ENGINE *engine);
williamr@2
   179
williamr@2
   180
IMPORT_C DH *	DH_new(void);
williamr@2
   181
IMPORT_C void	DH_free(DH *dh);
williamr@2
   182
IMPORT_C int	DH_up_ref(DH *dh);
williamr@2
   183
IMPORT_C int	DH_size(const DH *dh);
williamr@2
   184
IMPORT_C int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
williamr@2
   185
	     CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
williamr@2
   186
IMPORT_C int DH_set_ex_data(DH *d, int idx, void *arg);
williamr@2
   187
IMPORT_C void *DH_get_ex_data(DH *d, int idx);
williamr@2
   188
williamr@2
   189
/* Deprecated version */
williamr@2
   190
#ifndef OPENSSL_NO_DEPRECATED
williamr@2
   191
IMPORT_C DH *	DH_generate_parameters(int prime_len,int generator,
williamr@2
   192
		void (*callback)(int,int,void *),void *cb_arg);
williamr@2
   193
#endif /* !defined(OPENSSL_NO_DEPRECATED) */
williamr@2
   194
williamr@2
   195
/* New version */
williamr@2
   196
IMPORT_C int	DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
williamr@2
   197
williamr@2
   198
IMPORT_C int	DH_check(const DH *dh,int *codes);
williamr@2
   199
IMPORT_C int	DH_check_pub_key(const DH *dh,const BIGNUM *pub_key, int *codes);
williamr@2
   200
IMPORT_C int	DH_generate_key(DH *dh);
williamr@2
   201
IMPORT_C int	DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
williamr@2
   202
IMPORT_C DH *	d2i_DHparams(DH **a,const unsigned char **pp, long length);
williamr@2
   203
IMPORT_C int	i2d_DHparams(const DH *a,unsigned char **pp);
williamr@2
   204
#ifndef OPENSSL_NO_FP_API
williamr@2
   205
IMPORT_C int	DHparams_print_fp(FILE *fp, const DH *x);
williamr@2
   206
#endif
williamr@2
   207
#ifndef OPENSSL_NO_BIO
williamr@2
   208
IMPORT_C int	DHparams_print(BIO *bp, const DH *x);
williamr@2
   209
#else
williamr@2
   210
IMPORT_C int	DHparams_print(char *bp, const DH *x);
williamr@2
   211
#endif
williamr@2
   212
williamr@2
   213
/* BEGIN ERROR CODES */
williamr@2
   214
/* The following lines are auto generated by the script mkerr.pl. Any changes
williamr@2
   215
 * made after this point may be overwritten when the script is next run.
williamr@2
   216
 */
williamr@2
   217
IMPORT_C void ERR_load_DH_strings(void);
williamr@2
   218
williamr@2
   219
/* Error codes for the DH functions. */
williamr@2
   220
williamr@2
   221
/* Function codes. */
williamr@2
   222
#define DH_F_COMPUTE_KEY				 102
williamr@2
   223
#define DH_F_DHPARAMS_PRINT				 100
williamr@2
   224
#define DH_F_DHPARAMS_PRINT_FP				 101
williamr@2
   225
#define DH_F_DH_BUILTIN_GENPARAMS			 106
williamr@2
   226
#define DH_F_DH_NEW_METHOD				 105
williamr@2
   227
#define DH_F_GENERATE_KEY				 103
williamr@2
   228
#define DH_F_GENERATE_PARAMETERS			 104
williamr@2
   229
williamr@2
   230
/* Reason codes. */
williamr@2
   231
#define DH_R_BAD_GENERATOR				 101
williamr@2
   232
#define DH_R_NO_PRIVATE_VALUE				 100
williamr@2
   233
#define DH_R_MODULUS_TOO_LARGE				 103
williamr@2
   234
#define DH_R_INVALID_PUBKEY				 102
williamr@2
   235
williamr@2
   236
#ifdef  __cplusplus
williamr@2
   237
}
williamr@2
   238
#endif
williamr@2
   239
#endif