File Explorer

1/*2 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.3 *4 * Licensed under the Apache License 2.0 (the "License").  You may not use5 * this file except in compliance with the License.  You can obtain a copy6 * in the file LICENSE in the source distribution or at7 * https://www.openssl.org/source/license.html8 */9 10#ifndef OPENSSL_DH_H11#define OPENSSL_DH_H12#pragma once13 14#include <openssl/macros.h>15#ifndef OPENSSL_NO_DEPRECATED_3_016#define HEADER_DH_H17#endif18 19#include <openssl/opensslconf.h>20#include <openssl/types.h>21 22#ifdef __cplusplus23extern "C" {24#endif25 26#include <stdlib.h>27 28/*29 * DH parameter generation types used by EVP_PKEY_CTX_set_dh_paramgen_type()30 * Note that additions/changes to this set of values requires corresponding31 * adjustments to range checks in dh_gen()32 */33#define DH_PARAMGEN_TYPE_GENERATOR 0 /* Use a safe prime generator */34#define DH_PARAMGEN_TYPE_FIPS_186_2 1 /* Use FIPS186-2 standard */35#define DH_PARAMGEN_TYPE_FIPS_186_4 2 /* Use FIPS186-4 standard */36#define DH_PARAMGEN_TYPE_GROUP 3 /* Use a named safe prime group */37 38int EVP_PKEY_CTX_set_dh_paramgen_type(EVP_PKEY_CTX *ctx, int typ);39int EVP_PKEY_CTX_set_dh_paramgen_gindex(EVP_PKEY_CTX *ctx, int gindex);40int EVP_PKEY_CTX_set_dh_paramgen_seed(EVP_PKEY_CTX *ctx,41    const unsigned char *seed,42    size_t seedlen);43int EVP_PKEY_CTX_set_dh_paramgen_prime_len(EVP_PKEY_CTX *ctx, int pbits);44int EVP_PKEY_CTX_set_dh_paramgen_subprime_len(EVP_PKEY_CTX *ctx, int qlen);45int EVP_PKEY_CTX_set_dh_paramgen_generator(EVP_PKEY_CTX *ctx, int gen);46int EVP_PKEY_CTX_set_dh_nid(EVP_PKEY_CTX *ctx, int nid);47int EVP_PKEY_CTX_set_dh_rfc5114(EVP_PKEY_CTX *ctx, int gen);48int EVP_PKEY_CTX_set_dhx_rfc5114(EVP_PKEY_CTX *ctx, int gen);49int EVP_PKEY_CTX_set_dh_pad(EVP_PKEY_CTX *ctx, int pad);50 51int EVP_PKEY_CTX_set_dh_kdf_type(EVP_PKEY_CTX *ctx, int kdf);52int EVP_PKEY_CTX_get_dh_kdf_type(EVP_PKEY_CTX *ctx);53int EVP_PKEY_CTX_set0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT *oid);54int EVP_PKEY_CTX_get0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT **oid);55int EVP_PKEY_CTX_set_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);56int EVP_PKEY_CTX_get_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);57int EVP_PKEY_CTX_set_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int len);58int EVP_PKEY_CTX_get_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int *len);59int EVP_PKEY_CTX_set0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char *ukm, int len);60#ifndef OPENSSL_NO_DEPRECATED_3_061OSSL_DEPRECATEDIN_3_062int EVP_PKEY_CTX_get0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char **ukm);63#endif64 65#define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1)66#define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2)67#define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3)68#define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN (EVP_PKEY_ALG_CTRL + 4)69#define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE (EVP_PKEY_ALG_CTRL + 5)70#define EVP_PKEY_CTRL_DH_KDF_TYPE (EVP_PKEY_ALG_CTRL + 6)71#define EVP_PKEY_CTRL_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 7)72#define EVP_PKEY_CTRL_GET_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 8)73#define EVP_PKEY_CTRL_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 9)74#define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 10)75#define EVP_PKEY_CTRL_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 11)76#define EVP_PKEY_CTRL_GET_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 12)77#define EVP_PKEY_CTRL_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 13)78#define EVP_PKEY_CTRL_GET_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 14)79#define EVP_PKEY_CTRL_DH_NID (EVP_PKEY_ALG_CTRL + 15)80#define EVP_PKEY_CTRL_DH_PAD (EVP_PKEY_ALG_CTRL + 16)81 82/* KDF types */83#define EVP_PKEY_DH_KDF_NONE 184#define EVP_PKEY_DH_KDF_X9_42 285 86#ifndef OPENSSL_NO_STDIO87#include <stdio.h>88#endif89#ifndef OPENSSL_NO_DH90#include <openssl/e_os2.h>91#include <openssl/bio.h>92#include <openssl/asn1.h>93#ifndef OPENSSL_NO_DEPRECATED_1_1_094#include <openssl/bn.h>95#endif96#include <openssl/dherr.h>97 98#ifndef OPENSSL_DH_MAX_MODULUS_BITS99#define OPENSSL_DH_MAX_MODULUS_BITS 10000100#endif101 102#ifndef OPENSSL_DH_CHECK_MAX_MODULUS_BITS103#define OPENSSL_DH_CHECK_MAX_MODULUS_BITS 32768104#endif105 106#define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024107 108#define DH_FLAG_CACHE_MONT_P 0x01109 110#define DH_FLAG_TYPE_MASK 0xF000111#define DH_FLAG_TYPE_DH 0x0000112#define DH_FLAG_TYPE_DHX 0x1000113 114#ifndef OPENSSL_NO_DEPRECATED_1_1_0115/*116 * Does nothing. Previously this switched off constant time behaviour.117 */118#define DH_FLAG_NO_EXP_CONSTTIME 0x00119#endif120 121#ifndef OPENSSL_NO_DEPRECATED_3_0122/*123 * If this flag is set the DH method is FIPS compliant and can be used in124 * FIPS mode. This is set in the validated module method. If an application125 * sets this flag in its own methods it is its responsibility to ensure the126 * result is compliant.127 */128 129#define DH_FLAG_FIPS_METHOD 0x0400130 131/*132 * If this flag is set the operations normally disabled in FIPS mode are133 * permitted it is then the applications responsibility to ensure that the134 * usage is compliant.135 */136 137#define DH_FLAG_NON_FIPS_ALLOW 0x0400138#endif139 140/* Already defined in ossl_typ.h */141/* typedef struct dh_st DH; */142/* typedef struct dh_method DH_METHOD; */143 144DECLARE_ASN1_ITEM(DHparams)145 146#ifndef OPENSSL_NO_DEPRECATED_3_0147#define DH_GENERATOR_2 2148#define DH_GENERATOR_3 3149#define DH_GENERATOR_5 5150 151/* DH_check error codes, some of them shared with DH_check_pub_key */152/*153 * NB: These values must align with the equivalently named macros in154 * internal/ffc.h.155 */156#define DH_CHECK_P_NOT_PRIME 0x01157#define DH_CHECK_P_NOT_SAFE_PRIME 0x02158#define DH_UNABLE_TO_CHECK_GENERATOR 0x04159#define DH_NOT_SUITABLE_GENERATOR 0x08160#define DH_CHECK_Q_NOT_PRIME 0x10161#define DH_CHECK_INVALID_Q_VALUE 0x20 /* +DH_check_pub_key */162#define DH_CHECK_INVALID_J_VALUE 0x40163#define DH_MODULUS_TOO_SMALL 0x80164#define DH_MODULUS_TOO_LARGE 0x100 /* +DH_check_pub_key */165 166/* DH_check_pub_key error codes */167#define DH_CHECK_PUBKEY_TOO_SMALL 0x01168#define DH_CHECK_PUBKEY_TOO_LARGE 0x02169#define DH_CHECK_PUBKEY_INVALID 0x04170 171/*172 * primes p where (p-1)/2 is prime too are called "safe"; we define this for173 * backward compatibility:174 */175#define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME176 177#define d2i_DHparams_fp(fp, x)                 \178    (DH *)ASN1_d2i_fp((void *(*)(void))DH_new, \179        (d2i_of_void *)d2i_DHparams,           \180        (fp),                                  \181        (void **)(x))182#define i2d_DHparams_fp(fp, x) \183    ASN1_i2d_fp(i2d_DHparams, (fp), (unsigned char *)(x))184#define d2i_DHparams_bio(bp, x) \185    ASN1_d2i_bio_of(DH, DH_new, d2i_DHparams, bp, x)186#define i2d_DHparams_bio(bp, x) \187    ASN1_i2d_bio_of(DH, i2d_DHparams, bp, x)188 189#define d2i_DHxparams_fp(fp, x)                \190    (DH *)ASN1_d2i_fp((void *(*)(void))DH_new, \191        (d2i_of_void *)d2i_DHxparams,          \192        (fp),                                  \193        (void **)(x))194#define i2d_DHxparams_fp(fp, x) \195    ASN1_i2d_fp(i2d_DHxparams, (fp), (unsigned char *)(x))196#define d2i_DHxparams_bio(bp, x) \197    ASN1_d2i_bio_of(DH, DH_new, d2i_DHxparams, bp, x)198#define i2d_DHxparams_bio(bp, x) \199    ASN1_i2d_bio_of(DH, i2d_DHxparams, bp, x)200 201DECLARE_ASN1_DUP_FUNCTION_name_attr(OSSL_DEPRECATEDIN_3_0, DH, DHparams)202 203OSSL_DEPRECATEDIN_3_0 const DH_METHOD *DH_OpenSSL(void);204 205OSSL_DEPRECATEDIN_3_0 void DH_set_default_method(const DH_METHOD *meth);206OSSL_DEPRECATEDIN_3_0 const DH_METHOD *DH_get_default_method(void);207OSSL_DEPRECATEDIN_3_0 int DH_set_method(DH *dh, const DH_METHOD *meth);208OSSL_DEPRECATEDIN_3_0 DH *DH_new_method(ENGINE *engine);209 210OSSL_DEPRECATEDIN_3_0 DH *DH_new(void);211OSSL_DEPRECATEDIN_3_0 void DH_free(DH *dh);212OSSL_DEPRECATEDIN_3_0 int DH_up_ref(DH *dh);213OSSL_DEPRECATEDIN_3_0 int DH_bits(const DH *dh);214OSSL_DEPRECATEDIN_3_0 int DH_size(const DH *dh);215OSSL_DEPRECATEDIN_3_0 int DH_security_bits(const DH *dh);216 217#define DH_get_ex_new_index(l, p, newf, dupf, freef) \218    CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)219 220OSSL_DEPRECATEDIN_3_0 int DH_set_ex_data(DH *d, int idx, void *arg);221OSSL_DEPRECATEDIN_3_0 void *DH_get_ex_data(const DH *d, int idx);222 223OSSL_DEPRECATEDIN_3_0 int DH_generate_parameters_ex(DH *dh, int prime_len,224    int generator,225    BN_GENCB *cb);226 227OSSL_DEPRECATEDIN_3_0 int DH_check_params_ex(const DH *dh);228OSSL_DEPRECATEDIN_3_0 int DH_check_ex(const DH *dh);229OSSL_DEPRECATEDIN_3_0 int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key);230OSSL_DEPRECATEDIN_3_0 int DH_check_params(const DH *dh, int *ret);231OSSL_DEPRECATEDIN_3_0 int DH_check(const DH *dh, int *codes);232OSSL_DEPRECATEDIN_3_0 int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key,233    int *codes);234OSSL_DEPRECATEDIN_3_0 int DH_generate_key(DH *dh);235OSSL_DEPRECATEDIN_3_0 int DH_compute_key(unsigned char *key,236    const BIGNUM *pub_key, DH *dh);237OSSL_DEPRECATEDIN_3_0 int DH_compute_key_padded(unsigned char *key,238    const BIGNUM *pub_key, DH *dh);239 240DECLARE_ASN1_ENCODE_FUNCTIONS_only_attr(OSSL_DEPRECATEDIN_3_0, DH, DHparams)241DECLARE_ASN1_ENCODE_FUNCTIONS_only_attr(OSSL_DEPRECATEDIN_3_0, DH, DHxparams)242 243#ifndef OPENSSL_NO_STDIO244OSSL_DEPRECATEDIN_3_0 int DHparams_print_fp(FILE *fp, const DH *x);245#endif246OSSL_DEPRECATEDIN_3_0 int DHparams_print(BIO *bp, const DH *x);247 248/* RFC 5114 parameters */249OSSL_DEPRECATEDIN_3_0 DH *DH_get_1024_160(void);250OSSL_DEPRECATEDIN_3_0 DH *DH_get_2048_224(void);251OSSL_DEPRECATEDIN_3_0 DH *DH_get_2048_256(void);252 253/* Named parameters, currently RFC7919 and RFC3526 */254OSSL_DEPRECATEDIN_3_0 DH *DH_new_by_nid(int nid);255OSSL_DEPRECATEDIN_3_0 int DH_get_nid(const DH *dh);256 257/* RFC2631 KDF */258OSSL_DEPRECATEDIN_3_0 int DH_KDF_X9_42(unsigned char *out, size_t outlen,259    const unsigned char *Z, size_t Zlen,260    ASN1_OBJECT *key_oid,261    const unsigned char *ukm,262    size_t ukmlen, const EVP_MD *md);263 264OSSL_DEPRECATEDIN_3_0 void DH_get0_pqg(const DH *dh, const BIGNUM **p,265    const BIGNUM **q, const BIGNUM **g);266OSSL_DEPRECATEDIN_3_0 int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);267OSSL_DEPRECATEDIN_3_0 void DH_get0_key(const DH *dh, const BIGNUM **pub_key,268    const BIGNUM **priv_key);269OSSL_DEPRECATEDIN_3_0 int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);270OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_p(const DH *dh);271OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_q(const DH *dh);272OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_g(const DH *dh);273OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_priv_key(const DH *dh);274OSSL_DEPRECATEDIN_3_0 const BIGNUM *DH_get0_pub_key(const DH *dh);275OSSL_DEPRECATEDIN_3_0 void DH_clear_flags(DH *dh, int flags);276OSSL_DEPRECATEDIN_3_0 int DH_test_flags(const DH *dh, int flags);277OSSL_DEPRECATEDIN_3_0 void DH_set_flags(DH *dh, int flags);278OSSL_DEPRECATEDIN_3_0 ENGINE *DH_get0_engine(DH *d);279OSSL_DEPRECATEDIN_3_0 long DH_get_length(const DH *dh);280OSSL_DEPRECATEDIN_3_0 int DH_set_length(DH *dh, long length);281 282OSSL_DEPRECATEDIN_3_0 DH_METHOD *DH_meth_new(const char *name, int flags);283OSSL_DEPRECATEDIN_3_0 void DH_meth_free(DH_METHOD *dhm);284OSSL_DEPRECATEDIN_3_0 DH_METHOD *DH_meth_dup(const DH_METHOD *dhm);285OSSL_DEPRECATEDIN_3_0 const char *DH_meth_get0_name(const DH_METHOD *dhm);286OSSL_DEPRECATEDIN_3_0 int DH_meth_set1_name(DH_METHOD *dhm, const char *name);287OSSL_DEPRECATEDIN_3_0 int DH_meth_get_flags(const DH_METHOD *dhm);288OSSL_DEPRECATEDIN_3_0 int DH_meth_set_flags(DH_METHOD *dhm, int flags);289OSSL_DEPRECATEDIN_3_0 void *DH_meth_get0_app_data(const DH_METHOD *dhm);290OSSL_DEPRECATEDIN_3_0 int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data);291OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_generate_key(const DH_METHOD *dhm))(DH *);292OSSL_DEPRECATEDIN_3_0 int DH_meth_set_generate_key(DH_METHOD *dhm,293    int (*generate_key)(DH *));294OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_compute_key(const DH_METHOD *dhm))(unsigned char *key,295    const BIGNUM *pub_key,296    DH *dh);297OSSL_DEPRECATEDIN_3_0 int DH_meth_set_compute_key(DH_METHOD *dhm,298    int (*compute_key)(unsigned char *key,299        const BIGNUM *pub_key,300        DH *dh));301OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm))(const DH *, BIGNUM *,302    const BIGNUM *,303    const BIGNUM *,304    const BIGNUM *, BN_CTX *,305    BN_MONT_CTX *);306OSSL_DEPRECATEDIN_3_0 int DH_meth_set_bn_mod_exp(DH_METHOD *dhm,307    int (*bn_mod_exp)(const DH *, BIGNUM *,308        const BIGNUM *, const BIGNUM *,309        const BIGNUM *, BN_CTX *,310        BN_MONT_CTX *));311OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *);312OSSL_DEPRECATEDIN_3_0 int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *));313OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_finish(const DH_METHOD *dhm))(DH *);314OSSL_DEPRECATEDIN_3_0 int DH_meth_set_finish(DH_METHOD *dhm, int (*finish)(DH *));315OSSL_DEPRECATEDIN_3_0 int (*DH_meth_get_generate_params(const DH_METHOD *dhm))(DH *, int, int,316    BN_GENCB *);317OSSL_DEPRECATEDIN_3_0 int DH_meth_set_generate_params(DH_METHOD *dhm,318    int (*generate_params)(DH *, int, int,319        BN_GENCB *));320#endif /* OPENSSL_NO_DEPRECATED_3_0 */321 322#ifndef OPENSSL_NO_DEPRECATED_0_9_8323OSSL_DEPRECATEDIN_0_9_8 DH *DH_generate_parameters(int prime_len, int generator,324    void (*callback)(int, int,325        void *),326    void *cb_arg);327#endif328 329#endif330#ifdef __cplusplus331}332#endif333#endif334