crypto/dh/dh.h

   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 #ifdef OPENSSL_NO_DH
  63 #error DH is disabled.
  64 #endif
  65
  66 #ifndef OPENSSL_NO_BIO
  67 #include <openssl/bio.h>
  68 #endif
  69 #include <openssl/bn.h>
  70 #include <openssl/crypto.h>
  71 #include <openssl/ossl_typ.h>
  72
  73 #define DH_FLAG_CACHE_MONT_P    0x01
  74
  75 #ifdef  __cplusplus
  76 extern "C" {
  77 #endif
  78
  79 typedef struct dh_st DH;
  80
  81 typedef struct dh_method {
  82         const char *name;
  83         /* Methods here */
  84         int (*generate_key)(DH *dh);
  85         int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh);
  86         int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
  87                                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
  88                                 BN_MONT_CTX *m_ctx); /* Can be null */
  89
  90         int (*init)(DH *dh);
  91         int (*finish)(DH *dh);
  92         int flags;
  93         char *app_data;
  94         /* If this is non-NULL, it will be used to generate parameters */
  95         int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb);
  96 } DH_METHOD;
  97
  98 struct dh_st
  99         {
 100         /* This first argument is used to pick up errors when
 101          * a DH is passed instead of a EVP_PKEY */
 102         int pad;
 103         int version;
 104         BIGNUM *p;
 105         BIGNUM *g;
 106         long length; /* optional */
 107         BIGNUM *pub_key;        /* g^x */
 108         BIGNUM *priv_key;       /* x */
 109
 110         int flags;
 111         char *method_mont_p;
 112         /* Place holders if we want to do X9.42 DH */
 113         BIGNUM *q;
 114         BIGNUM *j;
 115         unsigned char *seed;
 116         int seedlen;
 117         BIGNUM *counter;
 118
 119         int references;
 120         CRYPTO_EX_DATA ex_data;
 121         const DH_METHOD *meth;
 122 #ifndef OPENSSL_NO_ENGINE
 123         ENGINE *engine;
 124 #endif
 125         };
 126
 127 #define DH_GENERATOR_2          2
 128 /* #define DH_GENERATOR_3       3 */
 129 #define DH_GENERATOR_5          5
 130
 131 /* DH_check error codes */
 132 #define DH_CHECK_P_NOT_PRIME            0x01
 133 #define DH_CHECK_P_NOT_SAFE_PRIME       0x02
 134 #define DH_UNABLE_TO_CHECK_GENERATOR    0x04
 135 #define DH_NOT_SUITABLE_GENERATOR       0x08
 136
 137 /* primes p where (p-1)/2 is prime too are called "safe"; we define
 138    this for backward compatibility: */
 139 #define DH_CHECK_P_NOT_STRONG_PRIME     DH_CHECK_P_NOT_SAFE_PRIME
 140
 141 #define DHparams_dup(x) (DH *)ASN1_dup((int (*)())i2d_DHparams, \
 142                 (char *(*)())d2i_DHparams,(char *)(x))
 143 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
 144                 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
 145 #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
 146                 (unsigned char *)(x))
 147 #define d2i_DHparams_bio(bp,x) (DH *)ASN1_d2i_bio((char *(*)())DH_new, \
 148                 (char *(*)())d2i_DHparams,(bp),(unsigned char **)(x))
 149 #ifdef  __cplusplus
 150 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio((int (*)())i2d_DHparams,(bp), \
 151                 (unsigned char *)(x))
 152 #else
 153 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio(i2d_DHparams,(bp), \
 154                 (unsigned char *)(x))
 155 #endif
 156
 157 const DH_METHOD *DH_OpenSSL(void);
 158
 159 void DH_set_default_method(const DH_METHOD *meth);
 160 const DH_METHOD *DH_get_default_method(void);
 161 int DH_set_method(DH *dh, const DH_METHOD *meth);
 162 DH *DH_new_method(ENGINE *engine);
 163
 164 DH *    DH_new(void);
 165 void    DH_free(DH *dh);
 166 int     DH_up_ref(DH *dh);
 167 int     DH_size(const DH *dh);
 168 int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 169              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
 170 int DH_set_ex_data(DH *d, int idx, void *arg);
 171 void *DH_get_ex_data(DH *d, int idx);
 172
 173 /* Deprecated version */
 174 #ifndef OPENSSL_NO_DEPRECATED
 175 DH *    DH_generate_parameters(int prime_len,int generator,
 176                 void (*callback)(int,int,void *),void *cb_arg);
 177 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
 178
 179 /* New version */
 180 int     DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
 181
 182 int     DH_check(const DH *dh,int *codes);
 183 int     DH_generate_key(DH *dh);
 184 int     DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
 185 DH *    d2i_DHparams(DH **a,const unsigned char **pp, long length);
 186 int     i2d_DHparams(const DH *a,unsigned char **pp);
 187 #ifndef OPENSSL_NO_FP_API
 188 int     DHparams_print_fp(FILE *fp, const DH *x);
 189 #endif
 190 #ifndef OPENSSL_NO_BIO
 191 int     DHparams_print(BIO *bp, const DH *x);
 192 #else
 193 int     DHparams_print(char *bp, const DH *x);
 194 #endif
 195
 196 /* BEGIN ERROR CODES */
 197 /* The following lines are auto generated by the script mkerr.pl. Any changes
 198  * made after this point may be overwritten when the script is next run.
 199  */
 200 void ERR_load_DH_strings(void);
 201
 202 /* Error codes for the DH functions. */
 203
 204 /* Function codes. */
 205 #define DH_F_DHPARAMS_PRINT                              100
 206 #define DH_F_DHPARAMS_PRINT_FP                           101
 207 #define DH_F_DH_COMPUTE_KEY                              102
 208 #define DH_F_DH_GENERATE_KEY                             103
 209 #define DH_F_DH_GENERATE_PARAMETERS                      104
 210 #define DH_F_DH_NEW_METHOD                               105
 211
 212 /* Reason codes. */
 213 #define DH_R_BAD_GENERATOR                               101
 214 #define DH_R_NO_PRIVATE_VALUE                            100
 215
 216 #ifdef  __cplusplus
 217 }
 218 #endif
 219 #endif