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