dh.h

00001 /* crypto/dh/dh.h */
00002 /* Copyright (C) 1995-1998 Eric Young ([email protected])
00003  * All rights reserved.
00004  *
00005  * This package is an SSL implementation written
00006  * by Eric Young ([email protected]).
00007  * The implementation was written so as to conform with Netscapes SSL.
00008  * 
00009  * This library is free for commercial and non-commercial use as long as
00010  * the following conditions are aheared to.  The following conditions
00011  * apply to all code found in this distribution, be it the RC4, RSA,
00012  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
00013  * included with this distribution is covered by the same copyright terms
00014  * except that the holder is Tim Hudson ([email protected]).
00015  * 
00016  * Copyright remains Eric Young's, and as such any Copyright notices in
00017  * the code are not to be removed.
00018  * If this package is used in a product, Eric Young should be given attribution
00019  * as the author of the parts of the library used.
00020  * This can be in the form of a textual message at program startup or
00021  * in documentation (online or textual) provided with the package.
00022  * 
00023  * Redistribution and use in source and binary forms, with or without
00024  * modification, are permitted provided that the following conditions
00025  * are met:
00026  * 1. Redistributions of source code must retain the copyright
00027  *    notice, this list of conditions and the following disclaimer.
00028  * 2. Redistributions in binary form must reproduce the above copyright
00029  *    notice, this list of conditions and the following disclaimer in the
00030  *    documentation and/or other materials provided with the distribution.
00031  * 3. All advertising materials mentioning features or use of this software
00032  *    must display the following acknowledgement:
00033  *    "This product includes cryptographic software written by
00034  *     Eric Young ([email protected])"
00035  *    The word 'cryptographic' can be left out if the rouines from the library
00036  *    being used are not cryptographic related :-).
00037  * 4. If you include any Windows specific code (or a derivative thereof) from 
00038  *    the apps directory (application code) you must include an acknowledgement:
00039  *    "This product includes software written by Tim Hudson ([email protected])"
00040  * 
00041  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
00042  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00043  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00044  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
00045  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00046  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00047  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00049  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00050  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00051  * SUCH DAMAGE.
00052  * 
00053  * The licence and distribution terms for any publically available version or
00054  * derivative of this code cannot be changed.  i.e. this code cannot simply be
00055  * copied and put under another distribution licence
00056  * [including the GNU Public Licence.]
00057  */
00058 
00059 #ifndef HEADER_DH_H
00060 #define HEADER_DH_H
00061 
00062 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
00063 #define SYMBIAN
00064 #endif
00065 
00066 #include <openssl/e_os2.h>
00067 
00068 #ifdef OPENSSL_NO_DH
00069 #error DH is disabled.
00070 #endif
00071 
00072 #ifndef OPENSSL_NO_BIO
00073 #include <openssl/bio.h>
00074 #endif
00075 #include <openssl/ossl_typ.h>
00076 #ifndef OPENSSL_NO_DEPRECATED
00077 #include <openssl/bn.h>
00078 #endif
00079 
00080 #ifndef OPENSSL_DH_MAX_MODULUS_BITS
00081 # define OPENSSL_DH_MAX_MODULUS_BITS    10000
00082 #endif
00083 
00084         
00085 #define DH_FLAG_CACHE_MONT_P     0x01
00086 #define DH_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DH
00087                                        * implementation now uses constant time
00088                                        * modular exponentiation for secret exponents
00089                                        * by default. This flag causes the
00090                                        * faster variable sliding window method to
00091                                        * be used for all exponents.
00092                                        */
00093 
00094 #ifdef  __cplusplus
00095 extern "C" {
00096 #endif
00097 
00098 /* Already defined in ossl_typ.h */
00099 /* typedef struct dh_st DH; */
00100 /* typedef struct dh_method DH_METHOD; */
00101 
00102 struct dh_method
00103         {
00104         const char *name;
00105         /* Methods here */
00106         int (*generate_key)(DH *dh);
00107         int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh);
00108         int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
00109                                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
00110                                 BN_MONT_CTX *m_ctx); /* Can be null */
00111 
00112         int (*init)(DH *dh);
00113         int (*finish)(DH *dh);
00114         int flags;
00115         char *app_data;
00116         /* If this is non-NULL, it will be used to generate parameters */
00117         int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb);
00118         };
00119 
00120 struct dh_st
00121         {
00122         /* This first argument is used to pick up errors when
00123          * a DH is passed instead of a EVP_PKEY */
00124         int pad;
00125         int version;
00126         BIGNUM *p;
00127         BIGNUM *g;
00128         long length; /* optional */
00129         BIGNUM *pub_key;        /* g^x */
00130         BIGNUM *priv_key;       /* x */
00131 
00132         int flags;
00133         BN_MONT_CTX *method_mont_p;
00134         /* Place holders if we want to do X9.42 DH */
00135         BIGNUM *q;
00136         BIGNUM *j;
00137         unsigned char *seed;
00138         int seedlen;
00139         BIGNUM *counter;
00140 
00141         int references;
00142         CRYPTO_EX_DATA ex_data;
00143         const DH_METHOD *meth;
00144         ENGINE *engine;
00145         };
00146 
00147 #define DH_GENERATOR_2          2
00148 /* #define DH_GENERATOR_3       3 */
00149 #define DH_GENERATOR_5          5
00150 
00151 /* DH_check error codes */
00152 #define DH_CHECK_P_NOT_PRIME            0x01
00153 #define DH_CHECK_P_NOT_SAFE_PRIME       0x02
00154 #define DH_UNABLE_TO_CHECK_GENERATOR    0x04
00155 #define DH_NOT_SUITABLE_GENERATOR       0x08
00156 
00157 /* DH_check_pub_key error codes */
00158 #define DH_CHECK_PUBKEY_TOO_SMALL       0x01
00159 #define DH_CHECK_PUBKEY_TOO_LARGE       0x02
00160 
00161 /* primes p where (p-1)/2 is prime too are called "safe"; we define
00162    this for backward compatibility: */
00163 #define DH_CHECK_P_NOT_STRONG_PRIME     DH_CHECK_P_NOT_SAFE_PRIME
00164 
00165 #define DHparams_dup(x) ASN1_dup_of_const(DH,i2d_DHparams,d2i_DHparams,x)
00166 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
00167                 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
00168 #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
00169                 (unsigned char *)(x))
00170 #define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
00171 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
00172 
00173 IMPORT_C const DH_METHOD *DH_OpenSSL(void);
00174 
00175 IMPORT_C void DH_set_default_method(const DH_METHOD *meth);
00176 IMPORT_C const DH_METHOD *DH_get_default_method(void);
00177 IMPORT_C int DH_set_method(DH *dh, const DH_METHOD *meth);
00178 IMPORT_C DH *DH_new_method(ENGINE *engine);
00179 
00180 IMPORT_C DH *   DH_new(void);
00181 IMPORT_C void   DH_free(DH *dh);
00182 IMPORT_C int    DH_up_ref(DH *dh);
00183 IMPORT_C int    DH_size(const DH *dh);
00184 IMPORT_C int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
00185              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
00186 IMPORT_C int DH_set_ex_data(DH *d, int idx, void *arg);
00187 IMPORT_C void *DH_get_ex_data(DH *d, int idx);
00188 
00189 
00190 /* New version */
00191 IMPORT_C int    DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
00192 
00193 IMPORT_C int    DH_check(const DH *dh,int *codes);
00194 IMPORT_C int    DH_check_pub_key(const DH *dh,const BIGNUM *pub_key, int *codes);
00195 IMPORT_C int    DH_generate_key(DH *dh);
00196 IMPORT_C int    DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
00197 IMPORT_C DH *   d2i_DHparams(DH **a,const unsigned char **pp, long length);
00198 IMPORT_C int    i2d_DHparams(const DH *a,unsigned char **pp);
00199 #ifndef OPENSSL_NO_FP_API
00200 IMPORT_C int    DHparams_print_fp(FILE *fp, const DH *x);
00201 #endif
00202 #ifndef OPENSSL_NO_BIO
00203 IMPORT_C int    DHparams_print(BIO *bp, const DH *x);
00204 #else
00205 IMPORT_C int    DHparams_print(char *bp, const DH *x);
00206 #endif
00207 
00208 /* BEGIN ERROR CODES */
00209 /* The following lines are auto generated by the script mkerr.pl. Any changes
00210  * made after this point may be overwritten when the script is next run.
00211  */
00212 IMPORT_C void ERR_load_DH_strings(void);
00213 
00214 /* Error codes for the DH functions. */
00215 
00216 /* Function codes. */
00217 #define DH_F_COMPUTE_KEY                                 102
00218 #define DH_F_DHPARAMS_PRINT                              100
00219 #define DH_F_DHPARAMS_PRINT_FP                           101
00220 #define DH_F_DH_BUILTIN_GENPARAMS                        106
00221 #define DH_F_DH_NEW_METHOD                               105
00222 #define DH_F_GENERATE_KEY                                103
00223 #define DH_F_GENERATE_PARAMETERS                         104
00224 
00225 /* Reason codes. */
00226 #define DH_R_BAD_GENERATOR                               101
00227 #define DH_R_NO_PRIVATE_VALUE                            100
00228 #define DH_R_MODULUS_TOO_LARGE                           103
00229 #define DH_R_INVALID_PUBKEY                              102
00230 
00231 #ifdef  __cplusplus
00232 }
00233 #endif
00234 #endif