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