include/openssl/dh.h

0001 /*
0002  * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
0003  *
0004  * Licensed under the Apache License 2.0 (the "License").  You may not use
0005  * this file except in compliance with the License.  You can obtain a copy
0006  * in the file LICENSE in the source distribution or at
0007  * https://www.openssl.org/source/license.html
0008  */
0009
0010 #ifndef OPENSSL_DH_H
0011 # define OPENSSL_DH_H
0012 # pragma once
0013
0014 # include <openssl/macros.h>
0015 # ifndef OPENSSL_NO_DEPRECATED_3_0
0016 #  define HEADER_DH_H
0017 # endif
0018
0019 # include <openssl/opensslconf.h>
0020 # include <openssl/types.h>
0021
0022 # ifdef  __cplusplus
0023 extern "C" {
0024 # endif
0025
0026 #include <stdlib.h>
0027
0028 /*
0029  * DH parameter generation types used by EVP_PKEY_CTX_set_dh_paramgen_type()
0030  * Note that additions/changes to this set of values requires corresponding
0031  * adjustments to range checks in dh_gen()
0032  */
0033 # define DH_PARAMGEN_TYPE_GENERATOR     0   /* Use a safe prime generator */
0034 # define DH_PARAMGEN_TYPE_FIPS_186_2    1   /* Use FIPS186-2 standard */
0035 # define DH_PARAMGEN_TYPE_FIPS_186_4    2   /* Use FIPS186-4 standard */
0036 # define DH_PARAMGEN_TYPE_GROUP         3   /* Use a named safe prime group */
0037
0038 int EVP_PKEY_CTX_set_dh_paramgen_type(EVP_PKEY_CTX *ctx, int typ);
0039 int EVP_PKEY_CTX_set_dh_paramgen_gindex(EVP_PKEY_CTX *ctx, int gindex);
0040 int EVP_PKEY_CTX_set_dh_paramgen_seed(EVP_PKEY_CTX *ctx,
0041                                       const unsigned char *seed,
0042                                       size_t seedlen);
0043 int EVP_PKEY_CTX_set_dh_paramgen_prime_len(EVP_PKEY_CTX *ctx, int pbits);
0044 int EVP_PKEY_CTX_set_dh_paramgen_subprime_len(EVP_PKEY_CTX *ctx, int qlen);
0045 int EVP_PKEY_CTX_set_dh_paramgen_generator(EVP_PKEY_CTX *ctx, int gen);
0046 int EVP_PKEY_CTX_set_dh_nid(EVP_PKEY_CTX *ctx, int nid);
0047 int EVP_PKEY_CTX_set_dh_rfc5114(EVP_PKEY_CTX *ctx, int gen);
0048 int EVP_PKEY_CTX_set_dhx_rfc5114(EVP_PKEY_CTX *ctx, int gen);
0049 int EVP_PKEY_CTX_set_dh_pad(EVP_PKEY_CTX *ctx, int pad);
0050
0051 int EVP_PKEY_CTX_set_dh_kdf_type(EVP_PKEY_CTX *ctx, int kdf);
0052 int EVP_PKEY_CTX_get_dh_kdf_type(EVP_PKEY_CTX *ctx);
0053 int EVP_PKEY_CTX_set0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT *oid);
0054 int EVP_PKEY_CTX_get0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT **oid);
0055 int EVP_PKEY_CTX_set_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
0056 int EVP_PKEY_CTX_get_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
0057 int EVP_PKEY_CTX_set_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int len);
0058 int EVP_PKEY_CTX_get_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int *len);
0059 int EVP_PKEY_CTX_set0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char *ukm, int len);
0060 # ifndef OPENSSL_NO_DEPRECATED_3_0
0061 OSSL_DEPRECATEDIN_3_0
0062 int EVP_PKEY_CTX_get0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char **ukm);
0063 #endif
0064
0065 # define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN     (EVP_PKEY_ALG_CTRL + 1)
0066 # define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR     (EVP_PKEY_ALG_CTRL + 2)
0067 # define EVP_PKEY_CTRL_DH_RFC5114                (EVP_PKEY_ALG_CTRL + 3)
0068 # define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN  (EVP_PKEY_ALG_CTRL + 4)
0069 # define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE          (EVP_PKEY_ALG_CTRL + 5)
0070 # define EVP_PKEY_CTRL_DH_KDF_TYPE               (EVP_PKEY_ALG_CTRL + 6)
0071 # define EVP_PKEY_CTRL_DH_KDF_MD                 (EVP_PKEY_ALG_CTRL + 7)
0072 # define EVP_PKEY_CTRL_GET_DH_KDF_MD             (EVP_PKEY_ALG_CTRL + 8)
0073 # define EVP_PKEY_CTRL_DH_KDF_OUTLEN             (EVP_PKEY_ALG_CTRL + 9)
0074 # define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN         (EVP_PKEY_ALG_CTRL + 10)
0075 # define EVP_PKEY_CTRL_DH_KDF_UKM                (EVP_PKEY_ALG_CTRL + 11)
0076 # define EVP_PKEY_CTRL_GET_DH_KDF_UKM            (EVP_PKEY_ALG_CTRL + 12)
0077 # define EVP_PKEY_CTRL_DH_KDF_OID                (EVP_PKEY_ALG_CTRL + 13)
0078 # define EVP_PKEY_CTRL_GET_DH_KDF_OID            (EVP_PKEY_ALG_CTRL + 14)
0079 # define EVP_PKEY_CTRL_DH_NID                    (EVP_PKEY_ALG_CTRL + 15)
0080 # define EVP_PKEY_CTRL_DH_PAD                    (EVP_PKEY_ALG_CTRL + 16)
0081
0082 /* KDF types */
0083 # define EVP_PKEY_DH_KDF_NONE                            1
0084 # define EVP_PKEY_DH_KDF_X9_42                           2
0085
0086 # ifndef OPENSSL_NO_STDIO
0087 #  include <stdio.h>
0088 # endif
0089 # ifndef OPENSSL_NO_DH
0090 #  include <openssl/e_os2.h>
0091 #  include <openssl/bio.h>
0092 #  include <openssl/asn1.h>
0093 #  ifndef OPENSSL_NO_DEPRECATED_1_1_0
0094 #   include <openssl/bn.h>
0095 #  endif
0096 #  include <openssl/dherr.h>
0097
0098 #  ifndef OPENSSL_DH_MAX_MODULUS_BITS
0099 #   define OPENSSL_DH_MAX_MODULUS_BITS        10000
0100 #  endif
0101
0102 #  ifndef OPENSSL_DH_CHECK_MAX_MODULUS_BITS
0103 #   define OPENSSL_DH_CHECK_MAX_MODULUS_BITS  32768
0104 #  endif
0105
0106 #  define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024
0107
0108 #  define DH_FLAG_CACHE_MONT_P     0x01
0109
0110 #  define DH_FLAG_TYPE_MASK             0xF000
0111 #  define DH_FLAG_TYPE_DH               0x0000
0112 #  define DH_FLAG_TYPE_DHX              0x1000
0113
0114 #  ifndef OPENSSL_NO_DEPRECATED_1_1_0
0115 /*
0116  * Does nothing. Previously this switched off constant time behaviour.
0117  */
0118 #   define DH_FLAG_NO_EXP_CONSTTIME 0x00
0119 #  endif
0120
0121 #  ifndef OPENSSL_NO_DEPRECATED_3_0
0122 /*
0123  * If this flag is set the DH method is FIPS compliant and can be used in
0124  * FIPS mode. This is set in the validated module method. If an application
0125  * sets this flag in its own methods it is its responsibility to ensure the
0126  * result is compliant.
0127  */
0128
0129 #   define DH_FLAG_FIPS_METHOD                     0x0400
0130
0131 /*
0132  * If this flag is set the operations normally disabled in FIPS mode are
0133  * permitted it is then the applications responsibility to ensure that the
0134  * usage is compliant.
0135  */
0136
0137 #   define DH_FLAG_NON_FIPS_ALLOW                  0x0400
0138 #  endif
0139
0140 /* Already defined in ossl_typ.h */
0141 /* typedef struct dh_st DH; */
0142 /* typedef struct dh_method DH_METHOD; */
0143
0144 DECLARE_ASN1_ITEM(DHparams)
0145
0146 #  ifndef OPENSSL_NO_DEPRECATED_3_0
0147 #   define DH_GENERATOR_2          2
0148 #   define DH_GENERATOR_3          3
0149 #   define DH_GENERATOR_5          5
0150
0151 /* DH_check error codes, some of them shared with DH_check_pub_key */
0152 /*
0153  * NB: These values must align with the equivalently named macros in
0154  * internal/ffc.h.
0155  */
0156 #   define DH_CHECK_P_NOT_PRIME            0x01
0157 #   define DH_CHECK_P_NOT_SAFE_PRIME       0x02
0158 #   define DH_UNABLE_TO_CHECK_GENERATOR    0x04
0159 #   define DH_NOT_SUITABLE_GENERATOR       0x08
0160 #   define DH_CHECK_Q_NOT_PRIME            0x10
0161 #   define DH_CHECK_INVALID_Q_VALUE        0x20 /* +DH_check_pub_key */
0162 #   define DH_CHECK_INVALID_J_VALUE        0x40
0163 #   define DH_MODULUS_TOO_SMALL            0x80
0164 #   define DH_MODULUS_TOO_LARGE            0x100 /* +DH_check_pub_key */
0165
0166 /* DH_check_pub_key error codes */
0167 #   define DH_CHECK_PUBKEY_TOO_SMALL       0x01
0168 #   define DH_CHECK_PUBKEY_TOO_LARGE       0x02
0169 #   define DH_CHECK_PUBKEY_INVALID         0x04
0170
0171 /*
0172  * primes p where (p-1)/2 is prime too are called "safe"; we define this for
0173  * backward compatibility:
0174  */
0175 #   define DH_CHECK_P_NOT_STRONG_PRIME     DH_CHECK_P_NOT_SAFE_PRIME
0176
0177 #   define d2i_DHparams_fp(fp, x) \
0178         (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
0179                           (char *(*)())d2i_DHparams, \
0180                           (fp), \
0181                           (unsigned char **)(x))
0182 #   define i2d_DHparams_fp(fp, x) \
0183         ASN1_i2d_fp(i2d_DHparams,(fp), (unsigned char *)(x))
0184 #   define d2i_DHparams_bio(bp, x) \
0185         ASN1_d2i_bio_of(DH, DH_new, d2i_DHparams, bp, x)
0186 #   define i2d_DHparams_bio(bp, x) \
0187         ASN1_i2d_bio_of(DH, i2d_DHparams, bp, x)
0188
0189 #   define d2i_DHxparams_fp(fp,x) \
0190         (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
0191                           (char *(*)())d2i_DHxparams, \
0192                           (fp), \
0193                           (unsigned char **)(x))
0194 #   define i2d_DHxparams_fp(fp, x) \
0195         ASN1_i2d_fp(i2d_DHxparams,(fp), (unsigned char *)(x))
0196 #   define d2i_DHxparams_bio(bp, x) \
0197         ASN1_d2i_bio_of(DH, DH_new, d2i_DHxparams, bp, x)
0198 #   define i2d_DHxparams_bio(bp, x) \
0199         ASN1_i2d_bio_of(DH, i2d_DHxparams, bp, x)
0200
0201 DECLARE_ASN1_DUP_FUNCTION_name_attr(OSSL_DEPRECATEDIN_3_0, DH, DHparams)
0202
0203 OSSL_DEPRECATEDIN_3_0 const DH_METHOD *DH_OpenSSL(void);
0204
0205 OSSL_DEPRECATEDIN_3_0 void DH_set_default_method(const DH_METHOD *meth);
0206 OSSL_DEPRECATEDIN_3_0 const DH_METHOD *DH_get_default_method(void);
0207 OSSL_DEPRECATEDIN_3_0 int DH_set_method(DH *dh, const DH_METHOD *meth);
0208 OSSL_DEPRECATEDIN_3_0 DH *DH_new_method(ENGINE *engine);
0209
0210 OSSL_DEPRECATEDIN_3_0 DH *DH_new(void);
0211 OSSL_DEPRECATEDIN_3_0 void DH_free(DH *dh);
0212 OSSL_DEPRECATEDIN_3_0 int DH_up_ref(DH *dh);
0213 OSSL_DEPRECATEDIN_3_0 int DH_bits(const DH *dh);
0214 OSSL_DEPRECATEDIN_3_0 int DH_size(const DH *dh);
0215 OSSL_DEPRECATEDIN_3_0 int DH_security_bits(const DH *dh);
0216
0217 #   define DH_get_ex_new_index(l, p, newf, dupf, freef) \
0218         CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)
0219
0220 OSSL_DEPRECATEDIN_3_0 int DH_set_ex_data(DH *d, int idx, void *arg);
0221 OSSL_DEPRECATEDIN_3_0 void *DH_get_ex_data(const DH *d, int idx);
0222
0223 OSSL_DEPRECATEDIN_3_0 int DH_generate_parameters_ex(DH *dh, int prime_len,
0224                                                     int generator,
0225                                                     BN_GENCB *cb);
0226
0227 OSSL_DEPRECATEDIN_3_0 int DH_check_params_ex(const DH *dh);
0228 OSSL_DEPRECATEDIN_3_0 int DH_check_ex(const DH *dh);
0229 OSSL_DEPRECATEDIN_3_0 int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key);
0230 OSSL_DEPRECATEDIN_3_0 int DH_check_params(const DH *dh, int *ret);
0231 OSSL_DEPRECATEDIN_3_0 int DH_check(const DH *dh, int *codes);
0232 OSSL_DEPRECATEDIN_3_0 int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key,
0233                                            int *codes);
0234 OSSL_DEPRECATEDIN_3_0 int DH_generate_key(DH *dh);
0235 OSSL_DEPRECATEDIN_3_0 int DH_compute_key(unsigned char *key,
0236                                          const BIGNUM *pub_key, DH *dh);
0237 OSSL_DEPRECATEDIN_3_0 int DH_compute_key_padded(unsigned char *key,
0238                                                 const BIGNUM *pub_key, DH *dh);
0239
0240 DECLARE_ASN1_ENCODE_FUNCTIONS_only_attr(OSSL_DEPRECATEDIN_3_0, DH, DHparams)
0241 DECLARE_ASN1_ENCODE_FUNCTIONS_only_attr(OSSL_DEPRECATEDIN_3_0, DH, DHxparams)
0242
0243 #   ifndef OPENSSL_NO_STDIO
0244 OSSL_DEPRECATEDIN_3_0 int DHparams_print_fp(FILE *fp, const DH *x);
0245 #   endif
0246 OSSL_DEPRECATEDIN_3_0 int DHparams_print(BIO *bp, const DH *x);
0247
0248 /* RFC 5114 parameters */
0249 OSSL_DEPRECATEDIN_3_0 DH *DH_get_1024_160(void);
0250 OSSL_DEPRECATEDIN_3_0 DH *DH_get_2048_224(void);
0251 OSSL_DEPRECATEDIN_3_0 DH *DH_get_2048_256(void);
0252
0253 /* Named parameters, currently RFC7919 and RFC3526 */
0254 OSSL_DEPRECATEDIN_3_0 DH *DH_new_by_nid(int nid);
0255 OSSL_DEPRECATEDIN_3_0 int DH_get_nid(const DH *dh);
0256
0257 /* RFC2631 KDF */
0258 OSSL_DEPRECATEDIN_3_0 int DH_KDF_X9_42(unsigned char *out, size_t outlen,
0259                                        const unsigned char *Z, size_t Zlen,
0260                                        ASN1_OBJECT *key_oid,
0261                                        const unsigned char *ukm,
0262                                        size_t ukmlen, const EVP_MD *md);
0263
0264 OSSL_DEPRECATEDIN_3_0 void DH_get0_pqg(const DH *dh, const BIGNUM **p,
0265                                        const BIGNUM **q, const BIGNUM **g);
0266 OSSL_DEPRECATEDIN_3_0 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);
0267 OSSL_DEPRECATEDIN_3_0 void DH_get0_key(const DH *dh, const BIGNUM **pub_key,
0268                                        const BIGNUM **priv_key);
0269 OSSL_DEPRECATEDIN_3_0 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);
0270 OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_p(const DH *dh);
0271 OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_q(const DH *dh);
0272 OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_g(const DH *dh);
0273 OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_priv_key(const DH *dh);
0274 OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_pub_key(const DH *dh);
0275 OSSL_DEPRECATEDIN_3_0 void DH_clear_flags(DH *dh, int flags);
0276 OSSL_DEPRECATEDIN_3_0 int DH_test_flags(const DH *dh, int flags);
0277 OSSL_DEPRECATEDIN_3_0 void DH_set_flags(DH *dh, int flags);
0278 OSSL_DEPRECATEDIN_3_0 ENGINE *DH_get0_engine(DH *d);
0279 OSSL_DEPRECATEDIN_3_0 long DH_get_length(const DH *dh);
0280 OSSL_DEPRECATEDIN_3_0 int DH_set_length(DH *dh, long length);
0281
0282 OSSL_DEPRECATEDIN_3_0 DH_METHOD *DH_meth_new(const char *name, int flags);
0283 OSSL_DEPRECATEDIN_3_0 void DH_meth_free(DH_METHOD *dhm);
0284 OSSL_DEPRECATEDIN_3_0 DH_METHOD *DH_meth_dup(const DH_METHOD *dhm);
0285 OSSL_DEPRECATEDIN_3_0 const char *DH_meth_get0_name(const DH_METHOD *dhm);
0286 OSSL_DEPRECATEDIN_3_0 int DH_meth_set1_name(DH_METHOD *dhm, const char *name);
0287 OSSL_DEPRECATEDIN_3_0 int DH_meth_get_flags(const DH_METHOD *dhm);
0288 OSSL_DEPRECATEDIN_3_0 int DH_meth_set_flags(DH_METHOD *dhm, int flags);
0289 OSSL_DEPRECATEDIN_3_0 void *DH_meth_get0_app_data(const DH_METHOD *dhm);
0290 OSSL_DEPRECATEDIN_3_0 int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data);
0291 OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_generate_key(const DH_METHOD *dhm)) (DH *);
0292 OSSL_DEPRECATEDIN_3_0 int DH_meth_set_generate_key(DH_METHOD *dhm,
0293                                                    int (*generate_key) (DH *));
0294 OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_compute_key(const DH_METHOD *dhm))
0295                                                    (unsigned char *key,
0296                                                     const BIGNUM *pub_key,
0297                                                     DH *dh);
0298 OSSL_DEPRECATEDIN_3_0 int DH_meth_set_compute_key(DH_METHOD *dhm,
0299                                                   int (*compute_key)
0300                                                   (unsigned char *key,
0301                                                    const BIGNUM *pub_key,
0302                                                    DH *dh));
0303 OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm))
0304                                                    (const DH *, BIGNUM *,
0305                                                     const BIGNUM *,
0306                                                     const BIGNUM *,
0307                                                     const BIGNUM *, BN_CTX *,
0308                                                     BN_MONT_CTX *);
0309 OSSL_DEPRECATEDIN_3_0 int DH_meth_set_bn_mod_exp(DH_METHOD *dhm,
0310                                                  int (*bn_mod_exp)
0311                                                  (const DH *, BIGNUM *,
0312                                                   const BIGNUM *, const BIGNUM *,
0313                                                   const BIGNUM *, BN_CTX *,
0314                                                   BN_MONT_CTX *));
0315 OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *);
0316 OSSL_DEPRECATEDIN_3_0 int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *));
0317 OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_finish(const DH_METHOD *dhm)) (DH *);
0318 OSSL_DEPRECATEDIN_3_0 int DH_meth_set_finish(DH_METHOD *dhm, int (*finish) (DH *));
0319 OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_generate_params(const DH_METHOD *dhm))
0320                                                         (DH *, int, int,
0321                                                          BN_GENCB *);
0322 OSSL_DEPRECATEDIN_3_0 int DH_meth_set_generate_params(DH_METHOD *dhm,
0323                                                       int (*generate_params)
0324                                                       (DH *, int, int,
0325                                                        BN_GENCB *));
0326 #  endif /* OPENSSL_NO_DEPRECATED_3_0 */
0327
0328 #  ifndef OPENSSL_NO_DEPRECATED_0_9_8
0329 OSSL_DEPRECATEDIN_0_9_8 DH *DH_generate_parameters(int prime_len, int generator,
0330                                                    void (*callback) (int, int,
0331                                                                 void *),
0332                                                    void *cb_arg);
0333 #  endif
0334
0335 # endif
0336 # ifdef  __cplusplus
0337 }
0338 # endif
0339 #endif