1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young (eay (at) cryptsoft.com). 6 * The implementation was written so as to conform with Netscapes SSL. 7 * 8 * This library is free for commercial and non-commercial use as long as 9 * the following conditions are aheared to. The following conditions 10 * apply to all code found in this distribution, be it the RC4, RSA, 11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 12 * included with this distribution is covered by the same copyright terms 13 * except that the holder is Tim Hudson (tjh (at) cryptsoft.com). 14 * 15 * Copyright remains Eric Young's, and as such any Copyright notices in 16 * the code are not to be removed. 17 * If this package is used in a product, Eric Young should be given attribution 18 * as the author of the parts of the library used. 19 * This can be in the form of a textual message at program startup or 20 * in documentation (online or textual) provided with the package. 21 * 22 * Redistribution and use in source and binary forms, with or without 23 * modification, are permitted provided that the following conditions 24 * are met: 25 * 1. Redistributions of source code must retain the copyright 26 * notice, this list of conditions and the following disclaimer. 27 * 2. Redistributions in binary form must reproduce the above copyright 28 * notice, this list of conditions and the following disclaimer in the 29 * documentation and/or other materials provided with the distribution. 30 * 3. All advertising materials mentioning features or use of this software 31 * must display the following acknowledgement: 32 * "This product includes cryptographic software written by 33 * Eric Young (eay (at) cryptsoft.com)" 34 * The word 'cryptographic' can be left out if the rouines from the library 35 * being used are not cryptographic related :-). 36 * 4. If you include any Windows specific code (or a derivative thereof) from 37 * the apps directory (application code) you must include an acknowledgement: 38 * "This product includes software written by Tim Hudson (tjh (at) cryptsoft.com)" 39 * 40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 50 * SUCH DAMAGE. 51 * 52 * The licence and distribution terms for any publically available version or 53 * derivative of this code cannot be changed. i.e. this code cannot simply be 54 * copied and put under another distribution licence 55 * [including the GNU Public Licence.] */ 56 57 #ifndef OPENSSL_HEADER_DH_H 58 #define OPENSSL_HEADER_DH_H 59 60 #include <openssl/base.h> 61 62 #include <openssl/engine.h> 63 #include <openssl/ex_data.h> 64 #include <openssl/thread.h> 65 66 #if defined(__cplusplus) 67 extern "C" { 68 #endif 69 70 71 /* DH contains functions for performing Diffie-Hellman key agreement in 72 * multiplicative groups. */ 73 74 75 /* Allocation and destruction. */ 76 77 /* DH_new returns a new, empty DH object or NULL on error. */ 78 OPENSSL_EXPORT DH *DH_new(void); 79 80 /* DH_free decrements the reference count of |dh| and frees it if the reference 81 * count drops to zero. */ 82 OPENSSL_EXPORT void DH_free(DH *dh); 83 84 /* DH_up_ref increments the reference count of |dh| and returns one. */ 85 OPENSSL_EXPORT int DH_up_ref(DH *dh); 86 87 88 /* Properties. */ 89 90 /* DH_get0_key sets |*out_pub_key| and |*out_priv_key|, if non-NULL, to |dh|'s 91 * public and private key, respectively. If |dh| is a public key, the private 92 * key will be set to NULL. */ 93 OPENSSL_EXPORT void DH_get0_key(const DH *dh, const BIGNUM **out_pub_key, 94 const BIGNUM **out_priv_key); 95 96 /* DH_get0_pqg sets |*out_p|, |*out_q|, and |*out_g|, if non-NULL, to |dh|'s p, 97 * q, and g parameters, respectively. */ 98 OPENSSL_EXPORT void DH_get0_pqg(const DH *dh, const BIGNUM **out_p, 99 const BIGNUM **out_q, const BIGNUM **out_g); 100 101 102 /* Standard parameters. 103 * 104 * These functions return new DH objects with standard parameters. They return 105 * NULL on allocation failure. The |engine| parameter is ignored. */ 106 107 /* These parameters are taken from RFC 5114. */ 108 109 OPENSSL_EXPORT DH *DH_get_1024_160(const ENGINE *engine); 110 OPENSSL_EXPORT DH *DH_get_2048_224(const ENGINE *engine); 111 OPENSSL_EXPORT DH *DH_get_2048_256(const ENGINE *engine); 112 113 /* BN_get_rfc3526_prime_1536 sets |*ret| to the 1536-bit MODP group from RFC 114 * 3526 and returns |ret|. If |ret| is NULL then a fresh |BIGNUM| is allocated 115 * and returned. It returns NULL on allocation failure. */ 116 OPENSSL_EXPORT BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *ret); 117 118 119 /* Parameter generation. */ 120 121 #define DH_GENERATOR_2 2 122 #define DH_GENERATOR_5 5 123 124 /* DH_generate_parameters_ex generates a suitable Diffie-Hellman group with a 125 * prime that is |prime_bits| long and stores it in |dh|. The generator of the 126 * group will be |generator|, which should be |DH_GENERATOR_2| unless there's a 127 * good reason to use a different value. The |cb| argument contains a callback 128 * function that will be called during the generation. See the documentation in 129 * |bn.h| about this. In addition to the callback invocations from |BN|, |cb| 130 * will also be called with |event| equal to three when the generation is 131 * complete. */ 132 OPENSSL_EXPORT int DH_generate_parameters_ex(DH *dh, int prime_bits, 133 int generator, BN_GENCB *cb); 134 135 136 /* Diffie-Hellman operations. */ 137 138 /* DH_generate_key generates a new, random, private key and stores it in 139 * |dh|. It returns one on success and zero on error. */ 140 OPENSSL_EXPORT int DH_generate_key(DH *dh); 141 142 /* DH_compute_key calculates the shared key between |dh| and |peers_key| and 143 * writes it as a big-endian integer into |out|, which must have |DH_size| 144 * bytes of space. It returns the number of bytes written, or a negative number 145 * on error. */ 146 OPENSSL_EXPORT int DH_compute_key(uint8_t *out, const BIGNUM *peers_key, 147 DH *dh); 148 149 150 /* Utility functions. */ 151 152 /* DH_size returns the number of bytes in the DH group's prime. */ 153 OPENSSL_EXPORT int DH_size(const DH *dh); 154 155 /* DH_num_bits returns the minimum number of bits needed to represent the 156 * absolute value of the DH group's prime. */ 157 OPENSSL_EXPORT unsigned DH_num_bits(const DH *dh); 158 159 #define DH_CHECK_P_NOT_PRIME 0x01 160 #define DH_CHECK_P_NOT_SAFE_PRIME 0x02 161 #define DH_CHECK_UNABLE_TO_CHECK_GENERATOR 0x04 162 #define DH_CHECK_NOT_SUITABLE_GENERATOR 0x08 163 #define DH_CHECK_Q_NOT_PRIME 0x10 164 #define DH_CHECK_INVALID_Q_VALUE 0x20 165 #define DH_CHECK_INVALID_J_VALUE 0x40 166 167 /* These are compatibility defines. */ 168 #define DH_NOT_SUITABLE_GENERATOR DH_CHECK_NOT_SUITABLE_GENERATOR 169 #define DH_UNABLE_TO_CHECK_GENERATOR DH_CHECK_UNABLE_TO_CHECK_GENERATOR 170 171 /* DH_check checks the suitability of |dh| as a Diffie-Hellman group. and sets 172 * |DH_CHECK_*| flags in |*out_flags| if it finds any errors. It returns one if 173 * |*out_flags| was successfully set and zero on error. 174 * 175 * Note: these checks may be quite computationally expensive. */ 176 OPENSSL_EXPORT int DH_check(const DH *dh, int *out_flags); 177 178 #define DH_CHECK_PUBKEY_TOO_SMALL 0x1 179 #define DH_CHECK_PUBKEY_TOO_LARGE 0x2 180 #define DH_CHECK_PUBKEY_INVALID 0x4 181 182 /* DH_check_pub_key checks the suitability of |pub_key| as a public key for the 183 * DH group in |dh| and sets |DH_CHECK_PUBKEY_*| flags in |*out_flags| if it 184 * finds any errors. It returns one if |*out_flags| was successfully set and 185 * zero on error. */ 186 OPENSSL_EXPORT int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, 187 int *out_flags); 188 189 /* DHparams_dup allocates a fresh |DH| and copies the parameters from |dh| into 190 * it. It returns the new |DH| or NULL on error. */ 191 OPENSSL_EXPORT DH *DHparams_dup(const DH *dh); 192 193 194 /* ASN.1 functions. */ 195 196 /* DH_parse_parameters decodes a DER-encoded DHParameter structure (PKCS #3) 197 * from |cbs| and advances |cbs|. It returns a newly-allocated |DH| or NULL on 198 * error. */ 199 OPENSSL_EXPORT DH *DH_parse_parameters(CBS *cbs); 200 201 /* DH_marshal_parameters marshals |dh| as a DER-encoded DHParameter structure 202 * (PKCS #3) and appends the result to |cbb|. It returns one on success and zero 203 * on error. */ 204 OPENSSL_EXPORT int DH_marshal_parameters(CBB *cbb, const DH *dh); 205 206 207 /* ex_data functions. 208 * 209 * See |ex_data.h| for details. */ 210 211 OPENSSL_EXPORT int DH_get_ex_new_index(long argl, void *argp, 212 CRYPTO_EX_unused *unused, 213 CRYPTO_EX_dup *dup_unused, 214 CRYPTO_EX_free *free_func); 215 OPENSSL_EXPORT int DH_set_ex_data(DH *d, int idx, void *arg); 216 OPENSSL_EXPORT void *DH_get_ex_data(DH *d, int idx); 217 218 219 /* Deprecated functions. */ 220 221 /* DH_generate_parameters behaves like |DH_generate_parameters_ex|, which is 222 * what you should use instead. It returns NULL on error, or a newly-allocated 223 * |DH| on success. This function is provided for compatibility only. */ 224 OPENSSL_EXPORT DH *DH_generate_parameters(int prime_len, int generator, 225 void (*callback)(int, int, void *), 226 void *cb_arg); 227 228 /* d2i_DHparams parses an ASN.1, DER encoded Diffie-Hellman parameters structure 229 * from |len| bytes at |*inp|. If |ret| is not NULL then, on exit, a pointer to 230 * the result is in |*ret|. Note that, even if |*ret| is already non-NULL on 231 * entry, it will not be written to. Rather, a fresh |DH| is allocated and the 232 * previous one is freed. 233 * 234 * On successful exit, |*inp| is advanced past the DER structure. It 235 * returns the result or NULL on error. 236 * 237 * Use |DH_parse_parameters| instead. */ 238 OPENSSL_EXPORT DH *d2i_DHparams(DH **ret, const unsigned char **inp, long len); 239 240 /* i2d_DHparams marshals |in| to an ASN.1, DER structure. If |outp| is not NULL 241 * then the result is written to |*outp| and |*outp| is advanced just past the 242 * output. It returns the number of bytes in the result, whether written or 243 * not, or a negative value on error. 244 * 245 * Use |DH_marshal_parameters| instead. */ 246 OPENSSL_EXPORT int i2d_DHparams(const DH *in, unsigned char **outp); 247 248 249 struct dh_st { 250 BIGNUM *p; 251 BIGNUM *g; 252 BIGNUM *pub_key; /* g^x mod p */ 253 BIGNUM *priv_key; /* x */ 254 255 /* priv_length contains the length, in bits, of the private value. If zero, 256 * the private value will be the same length as |p|. */ 257 unsigned priv_length; 258 259 CRYPTO_MUTEX method_mont_p_lock; 260 BN_MONT_CTX *method_mont_p; 261 262 /* Place holders if we want to do X9.42 DH */ 263 BIGNUM *q; 264 BIGNUM *j; 265 unsigned char *seed; 266 int seedlen; 267 BIGNUM *counter; 268 269 int flags; 270 CRYPTO_refcount_t references; 271 CRYPTO_EX_DATA ex_data; 272 }; 273 274 275 #if defined(__cplusplus) 276 } /* extern C */ 277 278 extern "C++" { 279 280 namespace bssl { 281 282 BORINGSSL_MAKE_DELETER(DH, DH_free) 283 284 } // namespace bssl 285 286 } /* extern C++ */ 287 288 #endif 289 290 #define DH_R_BAD_GENERATOR 100 291 #define DH_R_INVALID_PUBKEY 101 292 #define DH_R_MODULUS_TOO_LARGE 102 293 #define DH_R_NO_PRIVATE_VALUE 103 294 #define DH_R_DECODE_ERROR 104 295 #define DH_R_ENCODE_ERROR 105 296 297 #endif /* OPENSSL_HEADER_DH_H */ 298
