1 /* $OpenBSD: dh.h,v 1.25 2018/02/22 16:41:04 jsing Exp $ */ 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/opensslconf.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 #ifndef OPENSSL_DH_MAX_MODULUS_BITS 77 # define OPENSSL_DH_MAX_MODULUS_BITS 10000 78 #endif 79 80 #define DH_FLAG_CACHE_MONT_P 0x01 81 82 /* If this flag is set the DH method is FIPS compliant and can be used 83 * in FIPS mode. This is set in the validated module method. If an 84 * application sets this flag in its own methods it is its reposibility 85 * to ensure the result is compliant. 86 */ 87 88 #define DH_FLAG_FIPS_METHOD 0x0400 89 90 /* If this flag is set the operations normally disabled in FIPS mode are 91 * permitted it is then the applications responsibility to ensure that the 92 * usage is compliant. 93 */ 94 95 #define DH_FLAG_NON_FIPS_ALLOW 0x0400 96 97 #ifdef __cplusplus 98 extern "C" { 99 #endif 100 101 /* Already defined in ossl_typ.h */ 102 /* typedef struct dh_st DH; */ 103 /* typedef struct dh_method DH_METHOD; */ 104 105 struct dh_method 106 { 107 const char *name; 108 /* Methods here */ 109 int (*generate_key)(DH *dh); 110 int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh); 111 int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a, 112 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx, 113 BN_MONT_CTX *m_ctx); /* Can be null */ 114 115 int (*init)(DH *dh); 116 int (*finish)(DH *dh); 117 int flags; 118 char *app_data; 119 /* If this is non-NULL, it will be used to generate parameters */ 120 int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb); 121 }; 122 123 struct dh_st 124 { 125 /* This first argument is used to pick up errors when 126 * a DH is passed instead of a EVP_PKEY */ 127 int pad; 128 int version; 129 BIGNUM *p; 130 BIGNUM *g; 131 long length; /* optional */ 132 BIGNUM *pub_key; /* g^x */ 133 BIGNUM *priv_key; /* x */ 134 135 int flags; 136 BN_MONT_CTX *method_mont_p; 137 /* Place holders if we want to do X9.42 DH */ 138 BIGNUM *q; 139 BIGNUM *j; 140 unsigned char *seed; 141 int seedlen; 142 BIGNUM *counter; 143 144 int references; 145 CRYPTO_EX_DATA ex_data; 146 const DH_METHOD *meth; 147 ENGINE *engine; 148 }; 149 150 #define DH_GENERATOR_2 2 151 /* #define DH_GENERATOR_3 3 */ 152 #define DH_GENERATOR_5 5 153 154 /* DH_check error codes */ 155 #define DH_CHECK_P_NOT_PRIME 0x01 156 #define DH_CHECK_P_NOT_SAFE_PRIME 0x02 157 #define DH_UNABLE_TO_CHECK_GENERATOR 0x04 158 #define DH_NOT_SUITABLE_GENERATOR 0x08 159 160 /* DH_check_pub_key error codes */ 161 #define DH_CHECK_PUBKEY_TOO_SMALL 0x01 162 #define DH_CHECK_PUBKEY_TOO_LARGE 0x02 163 164 /* primes p where (p-1)/2 is prime too are called "safe"; we define 165 this for backward compatibility: */ 166 #define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME 167 168 DH *d2i_DHparams_bio(BIO *bp, DH **a); 169 int i2d_DHparams_bio(BIO *bp, DH *a); 170 DH *d2i_DHparams_fp(FILE *fp, DH **a); 171 int i2d_DHparams_fp(FILE *fp, DH *a); 172 173 DH *DHparams_dup(DH *); 174 175 const DH_METHOD *DH_OpenSSL(void); 176 177 void DH_set_default_method(const DH_METHOD *meth); 178 const DH_METHOD *DH_get_default_method(void); 179 int DH_set_method(DH *dh, const DH_METHOD *meth); 180 DH *DH_new_method(ENGINE *engine); 181 182 DH * DH_new(void); 183 void DH_free(DH *dh); 184 int DH_up_ref(DH *dh); 185 int DH_size(const DH *dh); 186 int DH_bits(const DH *dh); 187 int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 188 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 189 int DH_set_ex_data(DH *d, int idx, void *arg); 190 void *DH_get_ex_data(DH *d, int idx); 191 192 ENGINE *DH_get0_engine(DH *d); 193 void DH_get0_pqg(const DH *dh, const BIGNUM **p, const BIGNUM **q, 194 const BIGNUM **g); 195 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g); 196 void DH_get0_key(const DH *dh, const BIGNUM **pub_key, const BIGNUM **priv_key); 197 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key); 198 void DH_clear_flags(DH *dh, int flags); 199 int DH_test_flags(const DH *dh, int flags); 200 void DH_set_flags(DH *dh, int flags); 201 int DH_set_length(DH *dh, long length); 202 203 /* Deprecated version */ 204 #ifndef OPENSSL_NO_DEPRECATED 205 DH * DH_generate_parameters(int prime_len,int generator, 206 void (*callback)(int,int,void *),void *cb_arg); 207 #endif /* !defined(OPENSSL_NO_DEPRECATED) */ 208 209 /* New version */ 210 int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb); 211 212 int DH_check(const DH *dh,int *codes); 213 int DH_check_pub_key(const DH *dh,const BIGNUM *pub_key, int *codes); 214 int DH_generate_key(DH *dh); 215 int DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh); 216 DH * d2i_DHparams(DH **a,const unsigned char **pp, long length); 217 int i2d_DHparams(const DH *a,unsigned char **pp); 218 int DHparams_print_fp(FILE *fp, const DH *x); 219 #ifndef OPENSSL_NO_BIO 220 int DHparams_print(BIO *bp, const DH *x); 221 #else 222 int DHparams_print(char *bp, const DH *x); 223 #endif 224 225 #define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \ 226 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ 227 EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL) 228 229 #define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \ 230 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ 231 EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL) 232 233 #define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1) 234 #define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2) 235 236 237 /* BEGIN ERROR CODES */ 238 /* The following lines are auto generated by the script mkerr.pl. Any changes 239 * made after this point may be overwritten when the script is next run. 240 */ 241 void ERR_load_DH_strings(void); 242 243 /* Error codes for the DH functions. */ 244 245 /* Function codes. */ 246 #define DH_F_COMPUTE_KEY 102 247 #define DH_F_DHPARAMS_PRINT_FP 101 248 #define DH_F_DH_BUILTIN_GENPARAMS 106 249 #define DH_F_DH_COMPUTE_KEY 114 250 #define DH_F_DH_GENERATE_KEY 115 251 #define DH_F_DH_GENERATE_PARAMETERS_EX 116 252 #define DH_F_DH_NEW_METHOD 105 253 #define DH_F_DH_PARAM_DECODE 107 254 #define DH_F_DH_PRIV_DECODE 110 255 #define DH_F_DH_PRIV_ENCODE 111 256 #define DH_F_DH_PUB_DECODE 108 257 #define DH_F_DH_PUB_ENCODE 109 258 #define DH_F_DO_DH_PRINT 100 259 #define DH_F_GENERATE_KEY 103 260 #define DH_F_GENERATE_PARAMETERS 104 261 #define DH_F_PKEY_DH_DERIVE 112 262 #define DH_F_PKEY_DH_KEYGEN 113 263 264 /* Reason codes. */ 265 #define DH_R_BAD_GENERATOR 101 266 #define DH_R_BN_DECODE_ERROR 109 267 #define DH_R_BN_ERROR 106 268 #define DH_R_DECODE_ERROR 104 269 #define DH_R_INVALID_PUBKEY 102 270 #define DH_R_KEYS_NOT_SET 108 271 #define DH_R_KEY_SIZE_TOO_SMALL 110 272 #define DH_R_MODULUS_TOO_LARGE 103 273 #define DH_R_NON_FIPS_METHOD 111 274 #define DH_R_NO_PARAMETERS_SET 107 275 #define DH_R_NO_PRIVATE_VALUE 100 276 #define DH_R_PARAMETER_ENCODING_ERROR 105 277 278 #ifdef __cplusplus 279 } 280 #endif 281 #endif 282