[b32552c] | 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 | /* primes p where (p-1)/2 is prime too are called "safe"; we define |
---|
| 149 | this for backward compatibility: */ |
---|
| 150 | #define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME |
---|
| 151 | |
---|
| 152 | #define DHparams_dup(x) ASN1_dup_of_const(DH,i2d_DHparams,d2i_DHparams,x) |
---|
| 153 | #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \ |
---|
| 154 | (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x)) |
---|
| 155 | #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \ |
---|
| 156 | (unsigned char *)(x)) |
---|
| 157 | #define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x) |
---|
| 158 | #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x) |
---|
| 159 | |
---|
| 160 | const DH_METHOD *DH_OpenSSL(void); |
---|
| 161 | |
---|
| 162 | void DH_set_default_method(const DH_METHOD *meth); |
---|
| 163 | const DH_METHOD *DH_get_default_method(void); |
---|
| 164 | int DH_set_method(DH *dh, const DH_METHOD *meth); |
---|
| 165 | DH *DH_new_method(ENGINE *engine); |
---|
| 166 | |
---|
| 167 | DH * DH_new(void); |
---|
| 168 | void DH_free(DH *dh); |
---|
| 169 | int DH_up_ref(DH *dh); |
---|
| 170 | int DH_size(const DH *dh); |
---|
| 171 | int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, |
---|
| 172 | CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); |
---|
| 173 | int DH_set_ex_data(DH *d, int idx, void *arg); |
---|
| 174 | void *DH_get_ex_data(DH *d, int idx); |
---|
| 175 | |
---|
| 176 | /* Deprecated version */ |
---|
| 177 | #ifndef OPENSSL_NO_DEPRECATED |
---|
| 178 | DH * DH_generate_parameters(int prime_len,int generator, |
---|
| 179 | void (*callback)(int,int,void *),void *cb_arg); |
---|
| 180 | #endif /* !defined(OPENSSL_NO_DEPRECATED) */ |
---|
| 181 | |
---|
| 182 | /* New version */ |
---|
| 183 | int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb); |
---|
| 184 | |
---|
| 185 | int DH_check(const DH *dh,int *codes); |
---|
| 186 | int DH_generate_key(DH *dh); |
---|
| 187 | int DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh); |
---|
| 188 | DH * d2i_DHparams(DH **a,const unsigned char **pp, long length); |
---|
| 189 | int i2d_DHparams(const DH *a,unsigned char **pp); |
---|
| 190 | #ifndef OPENSSL_NO_FP_API |
---|
| 191 | int DHparams_print_fp(FILE *fp, const DH *x); |
---|
| 192 | #endif |
---|
| 193 | #ifndef OPENSSL_NO_BIO |
---|
| 194 | int DHparams_print(BIO *bp, const DH *x); |
---|
| 195 | #else |
---|
| 196 | int DHparams_print(char *bp, const DH *x); |
---|
| 197 | #endif |
---|
| 198 | |
---|
| 199 | /* BEGIN ERROR CODES */ |
---|
| 200 | /* The following lines are auto generated by the script mkerr.pl. Any changes |
---|
| 201 | * made after this point may be overwritten when the script is next run. |
---|
| 202 | */ |
---|
| 203 | void ERR_load_DH_strings(void); |
---|
| 204 | |
---|
| 205 | /* Error codes for the DH functions. */ |
---|
| 206 | |
---|
| 207 | /* Function codes. */ |
---|
| 208 | #define DH_F_COMPUTE_KEY 102 |
---|
| 209 | #define DH_F_DHPARAMS_PRINT 100 |
---|
| 210 | #define DH_F_DHPARAMS_PRINT_FP 101 |
---|
| 211 | #define DH_F_DH_BUILTIN_GENPARAMS 106 |
---|
| 212 | #define DH_F_DH_NEW_METHOD 105 |
---|
| 213 | #define DH_F_GENERATE_KEY 103 |
---|
| 214 | #define DH_F_GENERATE_PARAMETERS 104 |
---|
| 215 | |
---|
| 216 | /* Reason codes. */ |
---|
| 217 | #define DH_R_BAD_GENERATOR 101 |
---|
| 218 | #define DH_R_NO_PRIVATE_VALUE 100 |
---|
| 219 | |
---|
| 220 | #ifdef __cplusplus |
---|
| 221 | } |
---|
| 222 | #endif |
---|
| 223 | #endif |
---|