1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young (eay@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@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@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@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/thread.h> 63 64 #if defined(__cplusplus) 65 extern "C" { 66 #endif 67 68 69 // DH contains functions for performing Diffie-Hellman key agreement in 70 // multiplicative groups. 71 // 72 // This module is deprecated and retained for legacy reasons only. It is not 73 // considered a priority for performance or hardening work. Do not use it in 74 // new code. Use X25519 or ECDH with P-256 instead. 75 76 77 // Allocation and destruction. 78 79 // DH_new returns a new, empty DH object or NULL on error. 80 OPENSSL_EXPORT DH *DH_new(void); 81 82 // DH_free decrements the reference count of |dh| and frees it if the reference 83 // count drops to zero. 84 OPENSSL_EXPORT void DH_free(DH *dh); 85 86 // DH_up_ref increments the reference count of |dh| and returns one. 87 OPENSSL_EXPORT int DH_up_ref(DH *dh); 88 89 90 // Properties. 91 92 // DH_bits returns the size of |dh|'s group modulus, in bits. 93 OPENSSL_EXPORT unsigned DH_bits(const DH *dh); 94 95 // DH_get0_pub_key returns |dh|'s public key. 96 OPENSSL_EXPORT const BIGNUM *DH_get0_pub_key(const DH *dh); 97 98 // DH_get0_priv_key returns |dh|'s private key, or NULL if |dh| is a public key. 99 OPENSSL_EXPORT const BIGNUM *DH_get0_priv_key(const DH *dh); 100 101 // DH_get0_p returns |dh|'s group modulus. 102 OPENSSL_EXPORT const BIGNUM *DH_get0_p(const DH *dh); 103 104 // DH_get0_q returns the size of |dh|'s subgroup, or NULL if it is unset. 105 OPENSSL_EXPORT const BIGNUM *DH_get0_q(const DH *dh); 106 107 // DH_get0_g returns |dh|'s group generator. 108 OPENSSL_EXPORT const BIGNUM *DH_get0_g(const DH *dh); 109 110 // DH_get0_key sets |*out_pub_key| and |*out_priv_key|, if non-NULL, to |dh|'s 111 // public and private key, respectively. If |dh| is a public key, the private 112 // key will be set to NULL. 113 OPENSSL_EXPORT void DH_get0_key(const DH *dh, const BIGNUM **out_pub_key, 114 const BIGNUM **out_priv_key); 115 116 // DH_set0_key sets |dh|'s public and private key to the specified values. If 117 // NULL, the field is left unchanged. On success, it takes ownership of each 118 // argument and returns one. Otherwise, it returns zero. 119 OPENSSL_EXPORT int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key); 120 121 // DH_get0_pqg sets |*out_p|, |*out_q|, and |*out_g|, if non-NULL, to |dh|'s p, 122 // q, and g parameters, respectively. 123 OPENSSL_EXPORT void DH_get0_pqg(const DH *dh, const BIGNUM **out_p, 124 const BIGNUM **out_q, const BIGNUM **out_g); 125 126 // DH_set0_pqg sets |dh|'s p, q, and g parameters to the specified values. If 127 // NULL, the field is left unchanged. On success, it takes ownership of each 128 // argument and returns one. Otherwise, it returns zero. |q| may be NULL, but 129 // |p| and |g| must either be specified or already configured on |dh|. 130 OPENSSL_EXPORT int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g); 131 132 // DH_set_length sets the number of bits to use for the secret exponent when 133 // calling |DH_generate_key| on |dh| and returns one. If unset, 134 // |DH_generate_key| will use the bit length of p. 135 OPENSSL_EXPORT int DH_set_length(DH *dh, unsigned priv_length); 136 137 138 // Standard parameters. 139 140 // DH_get_rfc7919_2048 returns the group `ffdhe2048` from 141 // https://tools.ietf.org/html/rfc7919#appendix-A.1. It returns NULL if out 142 // of memory. 143 OPENSSL_EXPORT DH *DH_get_rfc7919_2048(void); 144 145 // BN_get_rfc3526_prime_1536 sets |*ret| to the 1536-bit MODP group from RFC 146 // 3526 and returns |ret|. If |ret| is NULL then a fresh |BIGNUM| is allocated 147 // and returned. It returns NULL on allocation failure. 148 OPENSSL_EXPORT BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *ret); 149 150 // BN_get_rfc3526_prime_2048 sets |*ret| to the 2048-bit MODP group from RFC 151 // 3526 and returns |ret|. If |ret| is NULL then a fresh |BIGNUM| is allocated 152 // and returned. It returns NULL on allocation failure. 153 OPENSSL_EXPORT BIGNUM *BN_get_rfc3526_prime_2048(BIGNUM *ret); 154 155 // BN_get_rfc3526_prime_3072 sets |*ret| to the 3072-bit MODP group from RFC 156 // 3526 and returns |ret|. If |ret| is NULL then a fresh |BIGNUM| is allocated 157 // and returned. It returns NULL on allocation failure. 158 OPENSSL_EXPORT BIGNUM *BN_get_rfc3526_prime_3072(BIGNUM *ret); 159 160 // BN_get_rfc3526_prime_4096 sets |*ret| to the 4096-bit MODP group from RFC 161 // 3526 and returns |ret|. If |ret| is NULL then a fresh |BIGNUM| is allocated 162 // and returned. It returns NULL on allocation failure. 163 OPENSSL_EXPORT BIGNUM *BN_get_rfc3526_prime_4096(BIGNUM *ret); 164 165 // BN_get_rfc3526_prime_6144 sets |*ret| to the 6144-bit MODP group from RFC 166 // 3526 and returns |ret|. If |ret| is NULL then a fresh |BIGNUM| is allocated 167 // and returned. It returns NULL on allocation failure. 168 OPENSSL_EXPORT BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *ret); 169 170 // BN_get_rfc3526_prime_8192 sets |*ret| to the 8192-bit MODP group from RFC 171 // 3526 and returns |ret|. If |ret| is NULL then a fresh |BIGNUM| is allocated 172 // and returned. It returns NULL on allocation failure. 173 OPENSSL_EXPORT BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *ret); 174 175 176 // Parameter generation. 177 178 #define DH_GENERATOR_2 2 179 #define DH_GENERATOR_5 5 180 181 // DH_generate_parameters_ex generates a suitable Diffie-Hellman group with a 182 // prime that is |prime_bits| long and stores it in |dh|. The generator of the 183 // group will be |generator|, which should be |DH_GENERATOR_2| unless there's a 184 // good reason to use a different value. The |cb| argument contains a callback 185 // function that will be called during the generation. See the documentation in 186 // |bn.h| about this. In addition to the callback invocations from |BN|, |cb| 187 // will also be called with |event| equal to three when the generation is 188 // complete. 189 OPENSSL_EXPORT int DH_generate_parameters_ex(DH *dh, int prime_bits, 190 int generator, BN_GENCB *cb); 191 192 193 // Diffie-Hellman operations. 194 195 // DH_generate_key generates a new, random, private key and stores it in 196 // |dh|. It returns one on success and zero on error. 197 OPENSSL_EXPORT int DH_generate_key(DH *dh); 198 199 // DH_compute_key_padded calculates the shared key between |dh| and |peers_key| 200 // and writes it as a big-endian integer into |out|, padded up to |DH_size| 201 // bytes. It returns the number of bytes written, which is always |DH_size|, or 202 // a negative number on error. |out| must have |DH_size| bytes of space. 203 // 204 // WARNING: this differs from the usual BoringSSL return-value convention. 205 // 206 // Note this function differs from |DH_compute_key| in that it preserves leading 207 // zeros in the secret. This function is the preferred variant. It matches PKCS 208 // #3 and avoids some side channel attacks. However, the two functions are not 209 // drop-in replacements for each other. Using a different variant than the 210 // application expects will result in sporadic key mismatches. 211 // 212 // Callers that expect a fixed-width secret should use this function over 213 // |DH_compute_key|. Callers that use either function should migrate to a modern 214 // primitive such as X25519 or ECDH with P-256 instead. 215 OPENSSL_EXPORT int DH_compute_key_padded(uint8_t *out, const BIGNUM *peers_key, 216 DH *dh); 217 218 // DH_compute_key_hashed calculates the shared key between |dh| and |peers_key| 219 // and hashes it with the given |digest|. If the hash output is less than 220 // |max_out_len| bytes then it writes the hash output to |out| and sets 221 // |*out_len| to the number of bytes written. Otherwise it signals an error. It 222 // returns one on success or zero on error. 223 // 224 // NOTE: this follows the usual BoringSSL return-value convention, but that's 225 // different from |DH_compute_key| and |DH_compute_key_padded|. 226 OPENSSL_EXPORT int DH_compute_key_hashed(DH *dh, uint8_t *out, size_t *out_len, 227 size_t max_out_len, 228 const BIGNUM *peers_key, 229 const EVP_MD *digest); 230 231 232 // Utility functions. 233 234 // DH_size returns the number of bytes in the DH group's prime. 235 OPENSSL_EXPORT int DH_size(const DH *dh); 236 237 // DH_num_bits returns the minimum number of bits needed to represent the 238 // absolute value of the DH group's prime. 239 OPENSSL_EXPORT unsigned DH_num_bits(const DH *dh); 240 241 #define DH_CHECK_P_NOT_PRIME 0x01 242 #define DH_CHECK_P_NOT_SAFE_PRIME 0x02 243 #define DH_CHECK_UNABLE_TO_CHECK_GENERATOR 0x04 244 #define DH_CHECK_NOT_SUITABLE_GENERATOR 0x08 245 #define DH_CHECK_Q_NOT_PRIME 0x10 246 #define DH_CHECK_INVALID_Q_VALUE 0x20 247 248 // These are compatibility defines. 249 #define DH_NOT_SUITABLE_GENERATOR DH_CHECK_NOT_SUITABLE_GENERATOR 250 #define DH_UNABLE_TO_CHECK_GENERATOR DH_CHECK_UNABLE_TO_CHECK_GENERATOR 251 252 // DH_check checks the suitability of |dh| as a Diffie-Hellman group. and sets 253 // |DH_CHECK_*| flags in |*out_flags| if it finds any errors. It returns one if 254 // |*out_flags| was successfully set and zero on error. 255 // 256 // Note: these checks may be quite computationally expensive. 257 OPENSSL_EXPORT int DH_check(const DH *dh, int *out_flags); 258 259 #define DH_CHECK_PUBKEY_TOO_SMALL 0x1 260 #define DH_CHECK_PUBKEY_TOO_LARGE 0x2 261 #define DH_CHECK_PUBKEY_INVALID 0x4 262 263 // DH_check_pub_key checks the suitability of |pub_key| as a public key for the 264 // DH group in |dh| and sets |DH_CHECK_PUBKEY_*| flags in |*out_flags| if it 265 // finds any errors. It returns one if |*out_flags| was successfully set and 266 // zero on error. 267 OPENSSL_EXPORT int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, 268 int *out_flags); 269 270 // DHparams_dup allocates a fresh |DH| and copies the parameters from |dh| into 271 // it. It returns the new |DH| or NULL on error. 272 OPENSSL_EXPORT DH *DHparams_dup(const DH *dh); 273 274 275 // ASN.1 functions. 276 277 // DH_parse_parameters decodes a DER-encoded DHParameter structure (PKCS #3) 278 // from |cbs| and advances |cbs|. It returns a newly-allocated |DH| or NULL on 279 // error. 280 OPENSSL_EXPORT DH *DH_parse_parameters(CBS *cbs); 281 282 // DH_marshal_parameters marshals |dh| as a DER-encoded DHParameter structure 283 // (PKCS #3) and appends the result to |cbb|. It returns one on success and zero 284 // on error. 285 OPENSSL_EXPORT int DH_marshal_parameters(CBB *cbb, const DH *dh); 286 287 288 // Deprecated functions. 289 290 // DH_generate_parameters behaves like |DH_generate_parameters_ex|, which is 291 // what you should use instead. It returns NULL on error, or a newly-allocated 292 // |DH| on success. This function is provided for compatibility only. 293 OPENSSL_EXPORT DH *DH_generate_parameters(int prime_len, int generator, 294 void (*callback)(int, int, void *), 295 void *cb_arg); 296 297 // d2i_DHparams parses a DER-encoded DHParameter structure (PKCS #3) from |len| 298 // bytes at |*inp|, as in |d2i_SAMPLE|. 299 // 300 // Use |DH_parse_parameters| instead. 301 OPENSSL_EXPORT DH *d2i_DHparams(DH **ret, const unsigned char **inp, long len); 302 303 // i2d_DHparams marshals |in| to a DER-encoded DHParameter structure (PKCS #3), 304 // as described in |i2d_SAMPLE|. 305 // 306 // Use |DH_marshal_parameters| instead. 307 OPENSSL_EXPORT int i2d_DHparams(const DH *in, unsigned char **outp); 308 309 // DH_compute_key behaves like |DH_compute_key_padded| but, contrary to PKCS #3, 310 // returns a variable-length shared key with leading zeros. It returns the 311 // number of bytes written, or a negative number on error. |out| must have 312 // |DH_size| bytes of space. 313 // 314 // WARNING: this differs from the usual BoringSSL return-value convention. 315 // 316 // Note this function's running time and memory access pattern leaks information 317 // about the shared secret. Particularly if |dh| is reused, this may result in 318 // side channel attacks such as https://raccoon-attack.com/. 319 // 320 // |DH_compute_key_padded| is the preferred variant and avoids the above 321 // attacks. However, the two functions are not drop-in replacements for each 322 // other. Using a different variant than the application expects will result in 323 // sporadic key mismatches. 324 // 325 // Callers that expect a fixed-width secret should use |DH_compute_key_padded| 326 // instead. Callers that use either function should migrate to a modern 327 // primitive such as X25519 or ECDH with P-256 instead. 328 OPENSSL_EXPORT int DH_compute_key(uint8_t *out, const BIGNUM *peers_key, 329 DH *dh); 330 331 332 #if defined(__cplusplus) 333 } // extern C 334 335 extern "C++" { 336 337 BSSL_NAMESPACE_BEGIN 338 339 BORINGSSL_MAKE_DELETER(DH, DH_free) 340 BORINGSSL_MAKE_UP_REF(DH, DH_up_ref) 341 342 BSSL_NAMESPACE_END 343 344 } // extern C++ 345 346 #endif 347 348 #define DH_R_BAD_GENERATOR 100 349 #define DH_R_INVALID_PUBKEY 101 350 #define DH_R_MODULUS_TOO_LARGE 102 351 #define DH_R_NO_PRIVATE_VALUE 103 352 #define DH_R_DECODE_ERROR 104 353 #define DH_R_ENCODE_ERROR 105 354 355 #endif // OPENSSL_HEADER_DH_H 356