1 /* $OpenBSD: dh.h,v 1.38 2025/01/25 17:59:44 tb 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 #ifndef OPENSSL_NO_BIO 65 #include <openssl/bio.h> 66 #endif 67 #include <openssl/ossl_typ.h> 68 #include <openssl/bn.h> 69 70 #ifndef OPENSSL_DH_MAX_MODULUS_BITS 71 # define OPENSSL_DH_MAX_MODULUS_BITS 10000 72 #endif 73 74 #define DH_FLAG_CACHE_MONT_P 0x01 75 76 /* If this flag is set the DH method is FIPS compliant and can be used 77 * in FIPS mode. This is set in the validated module method. If an 78 * application sets this flag in its own methods it is its reposibility 79 * to ensure the result is compliant. 80 */ 81 82 #define DH_FLAG_FIPS_METHOD 0x0400 83 84 /* If this flag is set the operations normally disabled in FIPS mode are 85 * permitted it is then the applications responsibility to ensure that the 86 * usage is compliant. 87 */ 88 89 #define DH_FLAG_NON_FIPS_ALLOW 0x0400 90 91 #ifdef __cplusplus 92 extern "C" { 93 #endif 94 95 #define DH_GENERATOR_2 2 96 /* #define DH_GENERATOR_3 3 */ 97 #define DH_GENERATOR_5 5 98 99 /* DH_check error codes */ 100 #define DH_CHECK_P_NOT_PRIME 0x01 101 #define DH_CHECK_P_NOT_SAFE_PRIME 0x02 102 #define DH_UNABLE_TO_CHECK_GENERATOR 0x04 103 #define DH_NOT_SUITABLE_GENERATOR 0x08 104 #define DH_CHECK_Q_NOT_PRIME 0x10 105 #define DH_CHECK_INVALID_Q_VALUE 0x20 106 #define DH_CHECK_INVALID_J_VALUE 0x40 107 108 /* DH_check_pub_key error codes */ 109 #define DH_CHECK_PUBKEY_TOO_SMALL 0x01 110 #define DH_CHECK_PUBKEY_TOO_LARGE 0x02 111 #define DH_CHECK_PUBKEY_INVALID 0x04 112 113 /* primes p where (p-1)/2 is prime too are called "safe"; we define 114 this for backward compatibility: */ 115 #define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME 116 117 DH *d2i_DHparams_bio(BIO *bp, DH **a); 118 int i2d_DHparams_bio(BIO *bp, DH *a); 119 DH *d2i_DHparams_fp(FILE *fp, DH **a); 120 int i2d_DHparams_fp(FILE *fp, DH *a); 121 122 DH *DHparams_dup(DH *); 123 124 const DH_METHOD *DH_OpenSSL(void); 125 126 void DH_set_default_method(const DH_METHOD *meth); 127 const DH_METHOD *DH_get_default_method(void); 128 int DH_set_method(DH *dh, const DH_METHOD *meth); 129 DH *DH_new_method(ENGINE *engine); 130 131 DH * DH_new(void); 132 void DH_free(DH *dh); 133 int DH_up_ref(DH *dh); 134 int DH_size(const DH *dh); 135 int DH_bits(const DH *dh); 136 int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 137 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 138 int DH_set_ex_data(DH *d, int idx, void *arg); 139 void *DH_get_ex_data(DH *d, int idx); 140 int DH_security_bits(const DH *dh); 141 142 ENGINE *DH_get0_engine(DH *d); 143 void DH_get0_pqg(const DH *dh, const BIGNUM **p, const BIGNUM **q, 144 const BIGNUM **g); 145 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g); 146 void DH_get0_key(const DH *dh, const BIGNUM **pub_key, const BIGNUM **priv_key); 147 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key); 148 const BIGNUM *DH_get0_p(const DH *dh); 149 const BIGNUM *DH_get0_q(const DH *dh); 150 const BIGNUM *DH_get0_g(const DH *dh); 151 const BIGNUM *DH_get0_priv_key(const DH *dh); 152 const BIGNUM *DH_get0_pub_key(const DH *dh); 153 void DH_clear_flags(DH *dh, int flags); 154 int DH_test_flags(const DH *dh, int flags); 155 void DH_set_flags(DH *dh, int flags); 156 long DH_get_length(const DH *dh); 157 int DH_set_length(DH *dh, long length); 158 159 /* 160 * Wrapped in OPENSSL_NO_DEPRECATED in 0.9.8, added to rust-openssl in 2020, 161 * for "advanced DH support". 162 */ 163 DH * DH_generate_parameters(int prime_len,int generator, 164 void (*callback)(int,int,void *),void *cb_arg); 165 166 /* New version */ 167 int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb); 168 169 int DH_check(const DH *dh,int *codes); 170 int DH_check_pub_key(const DH *dh,const BIGNUM *pub_key, int *codes); 171 int DH_generate_key(DH *dh); 172 int DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh); 173 DH * d2i_DHparams(DH **a,const unsigned char **pp, long length); 174 int i2d_DHparams(const DH *a,unsigned char **pp); 175 int DHparams_print_fp(FILE *fp, const DH *x); 176 #ifndef OPENSSL_NO_BIO 177 int DHparams_print(BIO *bp, const DH *x); 178 #else 179 int DHparams_print(char *bp, const DH *x); 180 #endif 181 182 #define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \ 183 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ 184 EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL) 185 186 #define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \ 187 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ 188 EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL) 189 190 #define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1) 191 #define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2) 192 193 194 void ERR_load_DH_strings(void); 195 196 /* Error codes for the DH functions. */ 197 198 /* Function codes. */ 199 #define DH_F_COMPUTE_KEY 102 200 #define DH_F_DHPARAMS_PRINT_FP 101 201 #define DH_F_DH_BUILTIN_GENPARAMS 106 202 #define DH_F_DH_COMPUTE_KEY 114 203 #define DH_F_DH_GENERATE_KEY 115 204 #define DH_F_DH_GENERATE_PARAMETERS_EX 116 205 #define DH_F_DH_NEW_METHOD 105 206 #define DH_F_DH_PARAM_DECODE 107 207 #define DH_F_DH_PRIV_DECODE 110 208 #define DH_F_DH_PRIV_ENCODE 111 209 #define DH_F_DH_PUB_DECODE 108 210 #define DH_F_DH_PUB_ENCODE 109 211 #define DH_F_DO_DH_PRINT 100 212 #define DH_F_GENERATE_KEY 103 213 #define DH_F_GENERATE_PARAMETERS 104 214 #define DH_F_PKEY_DH_DERIVE 112 215 #define DH_F_PKEY_DH_KEYGEN 113 216 217 /* Reason codes. */ 218 #define DH_R_BAD_GENERATOR 101 219 #define DH_R_BN_DECODE_ERROR 109 220 #define DH_R_BN_ERROR 106 221 #define DH_R_DECODE_ERROR 104 222 #define DH_R_INVALID_PUBKEY 102 223 #define DH_R_KEYS_NOT_SET 108 224 #define DH_R_KEY_SIZE_TOO_SMALL 110 225 #define DH_R_MODULUS_TOO_LARGE 103 226 #define DH_R_NON_FIPS_METHOD 111 227 #define DH_R_NO_PARAMETERS_SET 107 228 #define DH_R_NO_PRIVATE_VALUE 100 229 #define DH_R_PARAMETER_ENCODING_ERROR 105 230 #define DH_R_CHECK_INVALID_J_VALUE 115 231 #define DH_R_CHECK_INVALID_Q_VALUE 116 232 #define DH_R_CHECK_PUBKEY_INVALID 122 233 #define DH_R_CHECK_PUBKEY_TOO_LARGE 123 234 #define DH_R_CHECK_PUBKEY_TOO_SMALL 124 235 #define DH_R_CHECK_P_NOT_PRIME 117 236 #define DH_R_CHECK_P_NOT_SAFE_PRIME 118 237 #define DH_R_CHECK_Q_NOT_PRIME 119 238 #define DH_R_MISSING_PUBKEY 125 239 #define DH_R_NOT_SUITABLE_GENERATOR 120 240 #define DH_R_UNABLE_TO_CHECK_GENERATOR 121 241 242 #ifdef __cplusplus 243 } 244 #endif 245 #endif 246