29471089948

Committed 15 Jul 2026 11:28PM UTC coverage: 89.402% (-2.3%) from 91.656%

Build # 29471089948

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #5724 from randombit/jack/filter-fixes

Fix various bugs in the Pipe/Filter library

Coverage Stats

113560 of 127022 relevant lines covered (89.4%)

10935343.63 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

81.04

/src/lib/tls/tls_callbacks.cpp

/*
* TLS Callbacks
* (C) 2016 Jack Lloyd
*     2017 Harry Reimann, Rohde & Schwarz Cybersecurity
*     2022 René Meusel, Hannes Rantzsch - neXenio GmbH
*     2023 René Meusel - Rohde & Schwarz Cybersecurity
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include <botan/tls_callbacks.h>

#include <botan/dh.h>
#include <botan/dl_group.h>
#include <botan/ec_group.h>
#include <botan/ecdh.h>
#include <botan/ocsp.h>
#include <botan/pk_algs.h>
#include <botan/tls_algos.h>
#include <botan/tls_exceptn.h>
#include <botan/tls_policy.h>
#include <botan/tls_session.h>
#include <botan/x509path.h>
#include <botan/internal/fmt.h>
#include <botan/internal/stl_util.h>

#if defined(BOTAN_HAS_X25519)
   #include <botan/x25519.h>
#endif

#if defined(BOTAN_HAS_X448)
   #include <botan/x448.h>
#endif

#if defined(BOTAN_HAS_ML_KEM)
   #include <botan/ml_kem.h>
#endif

#if defined(BOTAN_HAS_FRODOKEM)
   #include <botan/frodokem.h>
#endif

#if defined(BOTAN_HAS_TLS_13_PQC)
   #include <botan/internal/hybrid_public_key.h>
#endif

namespace Botan {

void TLS::Callbacks::tls_inspect_handshake_msg(const Handshake_Message& /*unused*/) {
   // default is no op
}

std::string TLS::Callbacks::tls_server_choose_app_protocol(const std::vector<std::string>& /*unused*/) {
   return "";
}

std::string TLS::Callbacks::tls_peer_network_identity() {
   return "";
}

std::chrono::system_clock::time_point TLS::Callbacks::tls_current_timestamp() {
   return std::chrono::system_clock::now();
}

void TLS::Callbacks::tls_modify_extensions(Extensions& /*unused*/,
                                           Connection_Side /*unused*/,
                                           Handshake_Type /*unused*/) {}

void TLS::Callbacks::tls_examine_extensions(const Extensions& /*unused*/,
                                            Connection_Side /*unused*/,
                                            Handshake_Type /*unused*/) {}

bool TLS::Callbacks::tls_should_persist_resumption_information(const Session& session) {
   // RFC 5077 3.3
   //    The ticket_lifetime_hint field contains a hint from the server about
   //    how long the ticket should be stored. A value of zero is reserved to
   //    indicate that the lifetime of the ticket is unspecified.
   //
   // RFC 8446 4.6.1
   //    [A ticket_lifetime] of zero indicates that the ticket should be discarded
   //    immediately.
   //
   // By default we opt to keep all sessions, except for TLS 1.3 with a lifetime
   // hint of zero.
   return session.lifetime_hint().count() > 0 || session.version().is_pre_tls_13();
}

void TLS::Callbacks::tls_verify_cert_chain(const std::vector<X509_Certificate>& cert_chain,
                                           const std::vector<std::optional<OCSP::Response>>& ocsp_responses,
                                           const std::vector<Certificate_Store*>& trusted_roots,
                                           Usage_Type usage,
                                           std::string_view hostname,
                                           const TLS::Policy& policy) {
   if(cert_chain.empty()) {
      throw Invalid_Argument("Certificate chain was empty");
   }

   const Path_Validation_Restrictions restrictions(policy.require_cert_revocation_info(),
                                                   policy.minimum_signature_strength());

   /*
   Hostname is always provided in order to allow host-specific logic if required,
   but it should not be passed to x509_path_validate unless we are verifying
   the server.
   */
   const std::string_view name_to_match = (usage == Usage_Type::TLS_CLIENT_AUTH) ? std::string_view{} : hostname;

   const Path_Validation_Result result = x509_path_validate(cert_chain,
                                                            restrictions,
                                                            trusted_roots,
                                                            name_to_match,
                                                            usage,
                                                            tls_current_timestamp(),
                                                            tls_verify_cert_chain_ocsp_timeout(),
                                                            ocsp_responses);

   if(!result.successful_validation()) {
      throw TLS_Exception(Alert::BadCertificate, "Certificate validation failure: " + result.result_string());
   }
}

void TLS::Callbacks::tls_verify_raw_public_key(const Public_Key& raw_public_key,
                                               Usage_Type usage,
                                               std::string_view hostname,
                                               const TLS::Policy& policy) {
   BOTAN_UNUSED(raw_public_key, usage, hostname, policy);
   // There is no good default implementation for authenticating raw public key.
   // Applications that wish to use them for authentication, must override this.
   throw TLS_Exception(Alert::CertificateUnknown, "Application did not provide a means to validate the raw public key");
}

std::optional<OCSP::Response> TLS::Callbacks::tls_parse_ocsp_response(const std::vector<uint8_t>& raw_response) {
   try {
      return OCSP::Response(raw_response);
   } catch(const Decoding_Error&) {
      // ignore parsing errors and just ignore the broken OCSP response
      return std::nullopt;
   }
}

std::vector<std::vector<uint8_t>> TLS::Callbacks::tls_provide_cert_chain_status(
   const std::vector<X509_Certificate>& chain, const Certificate_Status_Request& csr) {
   std::vector<std::vector<uint8_t>> result(chain.size());
   if(!chain.empty()) {
      result[0] = tls_provide_cert_status(chain, csr);
   }
   return result;
}

std::vector<uint8_t> TLS::Callbacks::tls_sign_message(const Private_Key& key,
                                                      RandomNumberGenerator& rng,
                                                      std::string_view padding,
                                                      Signature_Format format,
                                                      const std::vector<uint8_t>& msg) {
   PK_Signer signer(key, rng, padding, format);

   return signer.sign_message(msg, rng);
}

bool TLS::Callbacks::tls_verify_message(const Public_Key& key,
                                        std::string_view padding,
                                        Signature_Format format,
                                        const std::vector<uint8_t>& msg,
                                        const std::vector<uint8_t>& sig) {
   PK_Verifier verifier(key, padding, format);

   return verifier.verify_message(msg, sig);
}

namespace {

bool is_dh_group(const std::variant<TLS::Group_Params, DL_Group>& group) {
   return std::holds_alternative<DL_Group>(group) || std::get<TLS::Group_Params>(group).is_dh_named_group();
}

DL_Group get_dl_group(const std::variant<TLS::Group_Params, DL_Group>& group) {
   BOTAN_ASSERT_NOMSG(is_dh_group(group));

   // TLS 1.2 allows specifying arbitrary DL_Group parameters in-lieu of
   // a standardized DH group identifier. TLS 1.3 just offers pre-defined
   // groups.
   return std::visit(overloaded{[](const DL_Group& dl_group) { return dl_group; },
                                [&](TLS::Group_Params group_param) {
                                   return DL_Group::from_name(group_param.to_algorithm_spec().value());
                                }},
                     group);
}

}  // namespace

std::unique_ptr<Public_Key> TLS::Callbacks::tls_deserialize_peer_public_key(
   const std::variant<TLS::Group_Params, DL_Group>& group, std::span<const uint8_t> key_bits) {
   if(is_dh_group(group)) {
      // TLS 1.2 allows specifying arbitrary DL_Group parameters in-lieu of
      // a standardized DH group identifier.
      const auto dl_group = get_dl_group(group);

      auto Y = BigInt::from_bytes(key_bits);

      /*
       * A basic check for key validity. As we do not know q here we
       * cannot check that Y is in the right subgroup. However since
       * our key is ephemeral there does not seem to be any
       * advantage to bogus keys anyway.
       */
      if(Y <= 1 || Y >= dl_group.get_p() - 1) {
         throw Decoding_Error("Server sent bad DH key for DHE exchange");
      }

      return std::make_unique<DH_PublicKey>(dl_group, Y);
   }

   // The special case for TLS 1.2 with an explicit DH group definition is
   // handled above. All other cases are based on the opaque group definition.
   BOTAN_ASSERT_NOMSG(std::holds_alternative<TLS::Group_Params>(group));
   const auto group_params = std::get<TLS::Group_Params>(group);

   if(group_params.is_ecdh_named_curve()) {
      const auto ec_group = EC_Group::from_name(group_params.to_algorithm_spec().value());
      // TLS 1.3 requires uncompressed points (checked when parsing the key
      // share); TLS 1.2 may negotiate the compressed format. The deprecated
      // hybrid encoding and the identity element are never accepted.

      auto point = [&]() -> EC_AffinePoint {
         if(auto pt_uncompressed = EC_AffinePoint::deserialize_uncompressed(ec_group, key_bits)) {
            return std::move(pt_uncompressed).value();
         } else if(auto pt_compressed = EC_AffinePoint::deserialize_compressed(ec_group, key_bits)) {
            return std::move(pt_compressed).value();
         } else {
            throw Decoding_Error("Invalid ECDH public key encoding");
         }
      }();
      return std::make_unique<ECDH_PublicKey>(ec_group, std::move(point));
   }

#if defined(BOTAN_HAS_X25519)
   if(group_params.is_x25519()) {
      return std::make_unique<X25519_PublicKey>(key_bits);
   }
#endif

#if defined(BOTAN_HAS_X448)
   if(group_params.is_x448()) {
      return std::make_unique<X448_PublicKey>(key_bits);
   }
#endif

#if defined(BOTAN_HAS_TLS_13_PQC)
   if(group_params.is_pqc_hybrid()) {
      return Hybrid_KEM_PublicKey::load_for_group(group_params, key_bits);
   }
#endif

#if defined(BOTAN_HAS_ML_KEM)
   if(group_params.is_pure_ml_kem()) {
      return std::make_unique<ML_KEM_PublicKey>(key_bits, ML_KEM_Mode(group_params.to_algorithm_spec().value()));
   }
#endif

#if defined(BOTAN_HAS_FRODOKEM)
   if(group_params.is_pure_frodokem()) {
      return std::make_unique<FrodoKEM_PublicKey>(key_bits, FrodoKEMMode(group_params.to_algorithm_spec().value()));
   }
#endif

   throw Decoding_Error("cannot create a key offering without a group definition");
}

std::unique_ptr<Private_Key> TLS::Callbacks::tls_kem_generate_key(TLS::Group_Params group, RandomNumberGenerator& rng) {
#if defined(BOTAN_HAS_ML_KEM)
   if(group.is_pure_ml_kem()) {
      return std::make_unique<ML_KEM_PrivateKey>(rng, ML_KEM_Mode(group.to_algorithm_spec().value()));
   }
#endif

#if defined(BOTAN_HAS_FRODOKEM)
   if(group.is_pure_frodokem()) {
      return std::make_unique<FrodoKEM_PrivateKey>(rng, FrodoKEMMode(group.to_algorithm_spec().value()));
   }
#endif

#if defined(BOTAN_HAS_TLS_13_PQC)
   if(group.is_pqc_hybrid()) {
      return Hybrid_KEM_PrivateKey::generate_from_group(group, rng);
   }
#endif

   return tls_generate_ephemeral_key(group, rng);
}

KEM_Encapsulation TLS::Callbacks::tls_kem_encapsulate(TLS::Group_Params group,
                                                      const std::vector<uint8_t>& encoded_public_key,
                                                      RandomNumberGenerator& rng,
                                                      const Policy& policy) {
   if(group.is_kem()) {
      auto kem_pub_key = [&] {
         try {
            return tls_deserialize_peer_public_key(group, encoded_public_key);
         } catch(const Decoding_Error& ex) {
            // This exception means that the public key was invalid. However,
            // TLS' DecodeError would imply that a protocol message was invalid.
            throw TLS_Exception(Alert::IllegalParameter, ex.what());
         } catch(const Invalid_Argument& ex) {
            throw TLS_Exception(Alert::IllegalParameter, ex.what());
         }
      }();

      BOTAN_ASSERT_NONNULL(kem_pub_key);
      policy.check_peer_key_acceptable(*kem_pub_key);

      try {
         return PK_KEM_Encryptor(*kem_pub_key, "Raw").encrypt(rng);
      } catch(const Decoding_Error& ex) {
         throw TLS_Exception(Alert::IllegalParameter, ex.what());
      } catch(const Invalid_Argument& ex) {
         throw TLS_Exception(Alert::IllegalParameter, ex.what());
      }
   } else {
      // TODO: We could use the KEX_to_KEM_Adapter to remove the case distinction
      //       of KEM and KEX. However, the workarounds in this adapter class
      //       should first be addressed.
      auto ephemeral_keypair = tls_generate_ephemeral_key(group, rng);
      BOTAN_ASSERT_NONNULL(ephemeral_keypair);
      return {ephemeral_keypair->public_value(),
              tls_ephemeral_key_agreement(group, *ephemeral_keypair, encoded_public_key, rng, policy)};
   }
}

secure_vector<uint8_t> TLS::Callbacks::tls_kem_decapsulate(TLS::Group_Params group,
                                                           const Private_Key& private_key,
                                                           const std::vector<uint8_t>& encapsulated_bytes,
                                                           RandomNumberGenerator& rng,
                                                           const Policy& policy) {
   if(group.is_kem()) {
      PK_KEM_Decryptor kemdec(private_key, rng, "Raw");
      if(encapsulated_bytes.size() != kemdec.encapsulated_key_length()) {
         throw TLS_Exception(Alert::IllegalParameter, "Invalid encapsulated key length");
      }
      try {
         return kemdec.decrypt(encapsulated_bytes, 0, {});
      } catch(const Decoding_Error& ex) {
         throw TLS_Exception(Alert::IllegalParameter, ex.what());
      } catch(const Invalid_Argument& ex) {
         throw TLS_Exception(Alert::IllegalParameter, ex.what());
      }
   }

   try {
      const auto& key_agreement_key = dynamic_cast<const PK_Key_Agreement_Key&>(private_key);
      return tls_ephemeral_key_agreement(group, key_agreement_key, encapsulated_bytes, rng, policy);
   } catch(const std::bad_cast&) {
      throw Invalid_Argument("provided ephemeral key is not a PK_Key_Agreement_Key");
   }
}

std::unique_ptr<PK_Key_Agreement_Key> TLS::Callbacks::tls_generate_ephemeral_key(
   const std::variant<TLS::Group_Params, DL_Group>& group, RandomNumberGenerator& rng) {
   if(is_dh_group(group)) {
      const DL_Group dl_group = get_dl_group(group);
      return std::make_unique<DH_PrivateKey>(rng, dl_group);
   }

   BOTAN_ASSERT_NOMSG(std::holds_alternative<TLS::Group_Params>(group));
   const auto group_params = std::get<TLS::Group_Params>(group);

   if(group_params.is_ecdh_named_curve()) {
      const auto ec_group = EC_Group::from_name(group_params.to_algorithm_spec().value());
      auto ecdh_key = std::make_unique<ECDH_PrivateKey>(rng, ec_group);

      // RFC 8446 Ch. 4.2.8.2
      //
      //   Note: Versions of TLS prior to 1.3 permitted point format
      //   negotiation; TLS 1.3 removes this feature in favor of a single point
      //   format for each curve.
      //
      // Hence, TLS 1.3 won't take Policy::use_ecc_point_compression() or
      // ClientHello::prefers_compressed_ec_points() into account but always use
      // uncompressed point encoding. Note that TLS 1.2 uses the
      // `tls12_generate_ephemeral_ecdh_key()` callback, which allows to specify
      // the point encoding format.
      ecdh_key->set_point_encoding(EC_Point_Format::Uncompressed);
      return ecdh_key;
   }

#if defined(BOTAN_HAS_X25519)
   if(group_params.is_x25519()) {
      return std::make_unique<X25519_PrivateKey>(rng);
   }
#endif

#if defined(BOTAN_HAS_X448)
   if(group_params.is_x448()) {
      return std::make_unique<X448_PrivateKey>(rng);
   }
#endif

   if(group_params.is_kem()) {
      throw TLS_Exception(Alert::IllegalParameter, "cannot generate an ephemeral KEX key for a KEM");
   }

   throw TLS_Exception(Alert::DecodeError, "cannot create a key offering without a group definition");
}

std::unique_ptr<PK_Key_Agreement_Key> TLS::Callbacks::tls12_generate_ephemeral_ecdh_key(
   TLS::Group_Params group, RandomNumberGenerator& rng, EC_Point_Format tls12_ecc_pubkey_encoding_format) {
   // Delegating to the "universal" callback to obtain an ECDH key pair
   auto key = tls_generate_ephemeral_key(group, rng);

   // For ordinary ECDH key pairs (that are derived from `ECDH_PublicKey`), we
   // set the internal point encoding flag for the key before passing it on into
   // the TLS 1.2 implementation. For user-defined keypair types (e.g. to
   // offload to some crypto hardware) inheriting from Botan's `ECDH_PublicKey`
   // might not be feasible. Such users should consider overriding this
   // ECDH-specific callback and ensure that their custom class handles the
   // public point encoding as requested by `tls12_ecc_pubkey_encoding_format`.
   if(auto* ecc_key = dynamic_cast<ECDH_PublicKey*>(key.get())) {
      ecc_key->set_point_encoding(tls12_ecc_pubkey_encoding_format);
   }

   return key;
}

secure_vector<uint8_t> TLS::Callbacks::tls_ephemeral_key_agreement(
   const std::variant<TLS::Group_Params, DL_Group>& group,
   const PK_Key_Agreement_Key& private_key,
   const std::vector<uint8_t>& public_value,
   RandomNumberGenerator& rng,
   const Policy& policy) {
   const auto kex_pub_key = [&]() {
      try {
         return tls_deserialize_peer_public_key(group, public_value);
      } catch(const Decoding_Error& ex) {
         // This exception means that the public key was invalid. However,
         // TLS' DecodeError would imply that a protocol message was invalid.
         throw TLS_Exception(Alert::IllegalParameter, ex.what());
      } catch(const Invalid_Argument& ex) {
         throw TLS_Exception(Alert::IllegalParameter, ex.what());
      }
   }();

   BOTAN_ASSERT_NONNULL(kex_pub_key);
   policy.check_peer_key_acceptable(*kex_pub_key);

   // RFC 8422 - 5.11.
   //   With X25519 and X448, a receiving party MUST check whether the
   //   computed premaster secret is the all-zero value and abort the
   //   handshake if so, as described in Section 6 of [RFC7748].
   //
   // This is done within the key agreement operation and throws
   // an Invalid_Argument exception if the shared secret is all-zero.
   try {
      const PK_Key_Agreement ka(private_key, rng, "Raw");
      return ka.derive_key(0, kex_pub_key->raw_public_key_bits()).bits_of();
   } catch(const Invalid_Argument& ex) {
      throw TLS_Exception(Alert::IllegalParameter, ex.what());
   }
}

void TLS::Callbacks::tls_session_established(const Session_Summary& session) {
   BOTAN_UNUSED(session);
}

std::vector<uint8_t> TLS::Callbacks::tls_provide_cert_status(const std::vector<X509_Certificate>& chain,
                                                             const Certificate_Status_Request& csr) {
   BOTAN_UNUSED(chain, csr);
   return std::vector<uint8_t>();
}

void TLS::Callbacks::tls_log_error(const char* err) {
   BOTAN_UNUSED(err);
}

void TLS::Callbacks::tls_log_debug(const char* what) {
   BOTAN_UNUSED(what);
}

void TLS::Callbacks::tls_log_debug_bin(const char* descr, const uint8_t val[], size_t val_len) {
   BOTAN_UNUSED(descr, val, val_len);
}

void TLS::Callbacks::tls_ssl_key_log_data(std::string_view label,
                                          std::span<const uint8_t> client_random,
                                          std::span<const uint8_t> secret) const {
   BOTAN_UNUSED(label, client_random, secret);
}

std::unique_ptr<KDF> TLS::Callbacks::tls12_protocol_specific_kdf(std::string_view prf_algo) const {
   if(prf_algo == "MD5" || prf_algo == "SHA-1") {
      return KDF::create_or_throw("TLS-12-PRF(SHA-256)");
   }

   return KDF::create_or_throw(Botan::fmt("TLS-12-PRF({})", prf_algo));
}

}  // namespace Botan

1	/*
2	* TLS Callbacks
3	* (C) 2016 Jack Lloyd
4	* 2017 Harry Reimann, Rohde & Schwarz Cybersecurity
5	* 2022 René Meusel, Hannes Rantzsch - neXenio GmbH
6	* 2023 René Meusel - Rohde & Schwarz Cybersecurity
7	*
8	* Botan is released under the Simplified BSD License (see license.txt)
9	*/
10
11	#include <botan/tls_callbacks.h>
12
13	#include <botan/dh.h>
14	#include <botan/dl_group.h>
15	#include <botan/ec_group.h>
16	#include <botan/ecdh.h>
17	#include <botan/ocsp.h>
18	#include <botan/pk_algs.h>
19	#include <botan/tls_algos.h>
20	#include <botan/tls_exceptn.h>
21	#include <botan/tls_policy.h>
22	#include <botan/tls_session.h>
23	#include <botan/x509path.h>
24	#include <botan/internal/fmt.h>
25	#include <botan/internal/stl_util.h>
26
27	#if defined(BOTAN_HAS_X25519)
28	#include <botan/x25519.h>
29	#endif
30
31	#if defined(BOTAN_HAS_X448)
32	#include <botan/x448.h>
33	#endif
34
35	#if defined(BOTAN_HAS_ML_KEM)
36	#include <botan/ml_kem.h>
37	#endif
38
39	#if defined(BOTAN_HAS_FRODOKEM)
40	#include <botan/frodokem.h>
41	#endif
42
43	#if defined(BOTAN_HAS_TLS_13_PQC)
44	#include <botan/internal/hybrid_public_key.h>
45	#endif
46
47	namespace Botan {
48
49	void TLS::Callbacks::tls_inspect_handshake_msg(const Handshake_Message& /unused/) {	7,039✔
50	// default is no op
51	}	7,039✔
52
53	std::string TLS::Callbacks::tls_server_choose_app_protocol(const std::vector<std::string>& /unused/) {	×
54	return "";	×
55	}
56
57	std::string TLS::Callbacks::tls_peer_network_identity() {	948✔
58	return "";	948✔
59	}
60
61	std::chrono::system_clock::time_point TLS::Callbacks::tls_current_timestamp() {	5,402✔
62	return std::chrono::system_clock::now();	5,402✔
63	}
64
65	void TLS::Callbacks::tls_modify_extensions(Extensions& /unused/,	2,185✔
66	Connection_Side /unused/,
67	Handshake_Type /unused/) {}	2,185✔
68
69	void TLS::Callbacks::tls_examine_extensions(const Extensions& /unused/,	6,511✔
70	Connection_Side /unused/,
71	Handshake_Type /unused/) {}	6,511✔
72
73	bool TLS::Callbacks::tls_should_persist_resumption_information(const Session& session) {	3,031✔
74	// RFC 5077 3.3
75	// The ticket_lifetime_hint field contains a hint from the server about
76	// how long the ticket should be stored. A value of zero is reserved to
77	// indicate that the lifetime of the ticket is unspecified.
78	//
79	// RFC 8446 4.6.1
80	// [A ticket_lifetime] of zero indicates that the ticket should be discarded
81	// immediately.
82	//
83	// By default we opt to keep all sessions, except for TLS 1.3 with a lifetime
84	// hint of zero.
85	return session.lifetime_hint().count() > 0 \|\| session.version().is_pre_tls_13();	3,031✔
86	}
87
88	void TLS::Callbacks::tls_verify_cert_chain(const std::vector<X509_Certificate>& cert_chain,	1,522✔
89	const std::vector<std::optional<OCSP::Response>>& ocsp_responses,
90	const std::vector<Certificate_Store*>& trusted_roots,
91	Usage_Type usage,
92	std::string_view hostname,
93	const TLS::Policy& policy) {
94	if(cert_chain.empty()) {	1,522✔
95	throw Invalid_Argument("Certificate chain was empty");	×
96	}
97
98	const Path_Validation_Restrictions restrictions(policy.require_cert_revocation_info(),	1,522✔
99	policy.minimum_signature_strength());	3,044✔
100
101	/*
102	Hostname is always provided in order to allow host-specific logic if required,
103	but it should not be passed to x509_path_validate unless we are verifying
104	the server.
105	*/
106	const std::string_view name_to_match = (usage == Usage_Type::TLS_CLIENT_AUTH) ? std::string_view{} : hostname;	1,522✔
107
108	const Path_Validation_Result result = x509_path_validate(cert_chain,	1,522✔
109	restrictions,
110	trusted_roots,
111	name_to_match,
112	usage,
113	tls_current_timestamp(),	1,522✔
114	tls_verify_cert_chain_ocsp_timeout(),	1,522✔
115	ocsp_responses);	1,522✔
116
117	if(!result.successful_validation()) {	1,522✔
118	throw TLS_Exception(Alert::BadCertificate, "Certificate validation failure: " + result.result_string());	458✔
119	}
120	}	1,751✔
121
122	void TLS::Callbacks::tls_verify_raw_public_key(const Public_Key& raw_public_key,	×
123	Usage_Type usage,
124	std::string_view hostname,
125	const TLS::Policy& policy) {
126	BOTAN_UNUSED(raw_public_key, usage, hostname, policy);	×
127	// There is no good default implementation for authenticating raw public key.
128	// Applications that wish to use them for authentication, must override this.
129	throw TLS_Exception(Alert::CertificateUnknown, "Application did not provide a means to validate the raw public key");	×
130	}
131
132	std::optional<OCSP::Response> TLS::Callbacks::tls_parse_ocsp_response(const std::vector<uint8_t>& raw_response) {	×
133	try {	×
134	return OCSP::Response(raw_response);	×
135	} catch(const Decoding_Error&) {	×
136	// ignore parsing errors and just ignore the broken OCSP response
137	return std::nullopt;	×
138	}	×
139	}
140
141	std::vector<std::vector<uint8_t>> TLS::Callbacks::tls_provide_cert_chain_status(	290✔
142	const std::vector<X509_Certificate>& chain, const Certificate_Status_Request& csr) {
143	std::vector<std::vector<uint8_t>> result(chain.size());	290✔
144	if(!chain.empty()) {	290✔
145	result[0] = tls_provide_cert_status(chain, csr);	290✔
146	}
147	return result;	282✔
148	}	8✔
149
150	std::vector<uint8_t> TLS::Callbacks::tls_sign_message(const Private_Key& key,	1,102✔
151	RandomNumberGenerator& rng,
152	std::string_view padding,
153	Signature_Format format,
154	const std::vector<uint8_t>& msg) {
155	PK_Signer signer(key, rng, padding, format);	1,102✔
156
157	return signer.sign_message(msg, rng);	2,203✔
158	}	1,102✔
159
160	bool TLS::Callbacks::tls_verify_message(const Public_Key& key,	1,475✔
161	std::string_view padding,
162	Signature_Format format,
163	const std::vector<uint8_t>& msg,
164	const std::vector<uint8_t>& sig) {
165	PK_Verifier verifier(key, padding, format);	1,475✔
166
167	return verifier.verify_message(msg, sig);	2,950✔
168	}	1,475✔
169
170	namespace {
171
172	bool is_dh_group(const std::variant<TLS::Group_Params, DL_Group>& group) {	5,478✔
173	return std::holds_alternative<DL_Group>(group) \|\| std::get<TLS::Group_Params>(group).is_dh_named_group();	10,928✔
174	}
175
176	DL_Group get_dl_group(const std::variant<TLS::Group_Params, DL_Group>& group) {	32✔
177	BOTAN_ASSERT_NOMSG(is_dh_group(group));	32✔
178
179	// TLS 1.2 allows specifying arbitrary DL_Group parameters in-lieu of
180	// a standardized DH group identifier. TLS 1.3 just offers pre-defined
181	// groups.
182	return std::visit(overloaded{[](const DL_Group& dl_group) { return dl_group; },	14✔
183	[&](TLS::Group_Params group_param) {	18✔
184	return DL_Group::from_name(group_param.to_algorithm_spec().value());	54✔
185	}},
186	group);	32✔
187	}
188
189	} // namespace
190
191	std::unique_ptr<Public_Key> TLS::Callbacks::tls_deserialize_peer_public_key(	2,423✔
192	const std::variant<TLS::Group_Params, DL_Group>& group, std::span<const uint8_t> key_bits) {
193	if(is_dh_group(group)) {	2,423✔
194	// TLS 1.2 allows specifying arbitrary DL_Group parameters in-lieu of
195	// a standardized DH group identifier.
196	const auto dl_group = get_dl_group(group);	14✔
197
198	auto Y = BigInt::from_bytes(key_bits);	14✔
199
200	/*
201	* A basic check for key validity. As we do not know q here we
202	* cannot check that Y is in the right subgroup. However since
203	* our key is ephemeral there does not seem to be any
204	* advantage to bogus keys anyway.
205	*/
206	if(Y <= 1 \|\| Y >= dl_group.get_p() - 1) {	28✔
207	throw Decoding_Error("Server sent bad DH key for DHE exchange");	×
208	}
209
210	return std::make_unique<DH_PublicKey>(dl_group, Y);	28✔
211	}	28✔
212
213	// The special case for TLS 1.2 with an explicit DH group definition is
214	// handled above. All other cases are based on the opaque group definition.
215	BOTAN_ASSERT_NOMSG(std::holds_alternative<TLS::Group_Params>(group));	2,409✔
216	const auto group_params = std::get<TLS::Group_Params>(group);	2,409✔
217
218	if(group_params.is_ecdh_named_curve()) {	2,409✔
219	const auto ec_group = EC_Group::from_name(group_params.to_algorithm_spec().value());	198✔
220	// TLS 1.3 requires uncompressed points (checked when parsing the key
221	// share); TLS 1.2 may negotiate the compressed format. The deprecated
222	// hybrid encoding and the identity element are never accepted.
223
224	auto point = [&]() -> EC_AffinePoint {	297✔
225	if(auto pt_uncompressed = EC_AffinePoint::deserialize_uncompressed(ec_group, key_bits)) {	99✔
226	return std::move(pt_uncompressed).value();	63✔
227	} else if(auto pt_compressed = EC_AffinePoint::deserialize_compressed(ec_group, key_bits)) {	36✔
228	return std::move(pt_compressed).value();	×
229	} else {
230	throw Decoding_Error("Invalid ECDH public key encoding");	36✔
231	}	99✔
232	}();	99✔
233	return std::make_unique<ECDH_PublicKey>(ec_group, std::move(point));	126✔
234	}	99✔
235
236	#if defined(BOTAN_HAS_X25519)
237	if(group_params.is_x25519()) {	2,310✔
238	return std::make_unique<X25519_PublicKey>(key_bits);	4,554✔
239	}
240	#endif
241
242	#if defined(BOTAN_HAS_X448)
243	if(group_params.is_x448()) {	29✔
244	return std::make_unique<X448_PublicKey>(key_bits);	8✔
245	}
246	#endif
247
248	#if defined(BOTAN_HAS_TLS_13_PQC)
249	if(group_params.is_pqc_hybrid()) {	25✔
250	return Hybrid_KEM_PublicKey::load_for_group(group_params, key_bits);	37✔
251	}
252	#endif
253
254	#if defined(BOTAN_HAS_ML_KEM)
255	if(group_params.is_pure_ml_kem()) {	5✔
256	return std::make_unique<ML_KEM_PublicKey>(key_bits, ML_KEM_Mode(group_params.to_algorithm_spec().value()));	17✔
257	}
258	#endif
259
260	#if defined(BOTAN_HAS_FRODOKEM)
261	if(group_params.is_pure_frodokem()) {	×
262	return std::make_unique<FrodoKEM_PublicKey>(key_bits, FrodoKEMMode(group_params.to_algorithm_spec().value()));	×
263	}
264	#endif
265
266	throw Decoding_Error("cannot create a key offering without a group definition");	×
267	}
268
269	std::unique_ptr<Private_Key> TLS::Callbacks::tls_kem_generate_key(TLS::Group_Params group, RandomNumberGenerator& rng) {	2,143✔
270	#if defined(BOTAN_HAS_ML_KEM)
271	if(group.is_pure_ml_kem()) {	2,143✔
272	return std::make_unique<ML_KEM_PrivateKey>(rng, ML_KEM_Mode(group.to_algorithm_spec().value()));	33✔
273	}
274	#endif
275
276	#if defined(BOTAN_HAS_FRODOKEM)
277	if(group.is_pure_frodokem()) {	2,132✔
278	return std::make_unique<FrodoKEM_PrivateKey>(rng, FrodoKEMMode(group.to_algorithm_spec().value()));	×
279	}
280	#endif
281
282	#if defined(BOTAN_HAS_TLS_13_PQC)
283	if(group.is_pqc_hybrid()) {	2,132✔
284	return Hybrid_KEM_PrivateKey::generate_from_group(group, rng);	2,010✔
285	}
286	#endif
287
288	return tls_generate_ephemeral_key(group, rng);	3,381✔
289	}
290
291	KEM_Encapsulation TLS::Callbacks::tls_kem_encapsulate(TLS::Group_Params group,	533✔
292	const std::vector<uint8_t>& encoded_public_key,
293	RandomNumberGenerator& rng,
294	const Policy& policy) {
295	if(group.is_kem()) {	533✔
296	auto kem_pub_key = [&] {	69✔
297	try {	25✔
298	return tls_deserialize_peer_public_key(group, encoded_public_key);	50✔
299	} catch(const Decoding_Error& ex) {	6✔
300	// This exception means that the public key was invalid. However,
301	// TLS' DecodeError would imply that a protocol message was invalid.
302	throw TLS_Exception(Alert::IllegalParameter, ex.what());	4✔
303	} catch(const Invalid_Argument& ex) {	6✔
304	throw TLS_Exception(Alert::IllegalParameter, ex.what());	2✔
305	}	2✔
306	}();	25✔
307
308	BOTAN_ASSERT_NONNULL(kem_pub_key);	19✔
309	policy.check_peer_key_acceptable(*kem_pub_key);	19✔
310
311	try {	19✔
312	return PK_KEM_Encryptor(*kem_pub_key, "Raw").encrypt(rng);	19✔
313	} catch(const Decoding_Error& ex) {	1✔
314	throw TLS_Exception(Alert::IllegalParameter, ex.what());	×
315	} catch(const Invalid_Argument& ex) {	1✔
316	throw TLS_Exception(Alert::IllegalParameter, ex.what());	1✔
317	}	1✔
318	} else {	19✔
319	// TODO: We could use the KEX_to_KEM_Adapter to remove the case distinction
320	// of KEM and KEX. However, the workarounds in this adapter class
321	// should first be addressed.
322	auto ephemeral_keypair = tls_generate_ephemeral_key(group, rng);	508✔
323	BOTAN_ASSERT_NONNULL(ephemeral_keypair);	508✔
324	return {ephemeral_keypair->public_value(),	1,016✔
325	tls_ephemeral_key_agreement(group, *ephemeral_keypair, encoded_public_key, rng, policy)};	1,016✔
326	}	496✔
327	}
328
329	secure_vector<uint8_t> TLS::Callbacks::tls_kem_decapsulate(TLS::Group_Params group,	547✔
330	const Private_Key& private_key,
331	const std::vector<uint8_t>& encapsulated_bytes,
332	RandomNumberGenerator& rng,
333	const Policy& policy) {
334	if(group.is_kem()) {	547✔
335	PK_KEM_Decryptor kemdec(private_key, rng, "Raw");	30✔
336	if(encapsulated_bytes.size() != kemdec.encapsulated_key_length()) {	30✔
337	throw TLS_Exception(Alert::IllegalParameter, "Invalid encapsulated key length");	4✔
338	}
339	try {	26✔
340	return kemdec.decrypt(encapsulated_bytes, 0, {});	26✔
341	} catch(const Decoding_Error& ex) {	1✔
342	throw TLS_Exception(Alert::IllegalParameter, ex.what());	×
343	} catch(const Invalid_Argument& ex) {	1✔
344	throw TLS_Exception(Alert::IllegalParameter, ex.what());	1✔
345	}	1✔
346	}	30✔
347
348	try {	517✔
349	const auto& key_agreement_key = dynamic_cast<const PK_Key_Agreement_Key&>(private_key);	517✔
350	return tls_ephemeral_key_agreement(group, key_agreement_key, encapsulated_bytes, rng, policy);	1,034✔
351	} catch(const std::bad_cast&) {	12✔
352	throw Invalid_Argument("provided ephemeral key is not a PK_Key_Agreement_Key");	×
353	}	×
354	}
355
356	std::unique_ptr<PK_Key_Agreement_Key> TLS::Callbacks::tls_generate_ephemeral_key(	3,023✔
357	const std::variant<TLS::Group_Params, DL_Group>& group, RandomNumberGenerator& rng) {
358	if(is_dh_group(group)) {	3,023✔
359	const DL_Group dl_group = get_dl_group(group);	18✔
360	return std::make_unique<DH_PrivateKey>(rng, dl_group);	36✔
361	}	18✔
362
363	BOTAN_ASSERT_NOMSG(std::holds_alternative<TLS::Group_Params>(group));	3,005✔
364	const auto group_params = std::get<TLS::Group_Params>(group);	3,005✔
365
366	if(group_params.is_ecdh_named_curve()) {	3,005✔
367	const auto ec_group = EC_Group::from_name(group_params.to_algorithm_spec().value());	256✔
368	auto ecdh_key = std::make_unique<ECDH_PrivateKey>(rng, ec_group);	128✔
369
370	// RFC 8446 Ch. 4.2.8.2
371	//
372	// Note: Versions of TLS prior to 1.3 permitted point format
373	// negotiation; TLS 1.3 removes this feature in favor of a single point
374	// format for each curve.
375	//
376	// Hence, TLS 1.3 won't take Policy::use_ecc_point_compression() or
377	// ClientHello::prefers_compressed_ec_points() into account but always use
378	// uncompressed point encoding. Note that TLS 1.2 uses the
379	// `tls12_generate_ephemeral_ecdh_key()` callback, which allows to specify
380	// the point encoding format.
381	ecdh_key->set_point_encoding(EC_Point_Format::Uncompressed);	128✔
382	return ecdh_key;	128✔
383	}	128✔
384
385	#if defined(BOTAN_HAS_X25519)
386	if(group_params.is_x25519()) {	2,877✔
387	return std::make_unique<X25519_PrivateKey>(rng);	5,746✔
388	}
389	#endif
390
391	#if defined(BOTAN_HAS_X448)
392	if(group_params.is_x448()) {	4✔
393	return std::make_unique<X448_PrivateKey>(rng);	8✔
394	}
395	#endif
396
397	if(group_params.is_kem()) {	×
398	throw TLS_Exception(Alert::IllegalParameter, "cannot generate an ephemeral KEX key for a KEM");	×
399	}
400
401	throw TLS_Exception(Alert::DecodeError, "cannot create a key offering without a group definition");	×
402	}
403
404	std::unique_ptr<PK_Key_Agreement_Key> TLS::Callbacks::tls12_generate_ephemeral_ecdh_key(	49✔
405	TLS::Group_Params group, RandomNumberGenerator& rng, EC_Point_Format tls12_ecc_pubkey_encoding_format) {
406	// Delegating to the "universal" callback to obtain an ECDH key pair
407	auto key = tls_generate_ephemeral_key(group, rng);	49✔
408
409	// For ordinary ECDH key pairs (that are derived from `ECDH_PublicKey`), we
410	// set the internal point encoding flag for the key before passing it on into
411	// the TLS 1.2 implementation. For user-defined keypair types (e.g. to
412	// offload to some crypto hardware) inheriting from Botan's `ECDH_PublicKey`
413	// might not be feasible. Such users should consider overriding this
414	// ECDH-specific callback and ensure that their custom class handles the
415	// public point encoding as requested by `tls12_ecc_pubkey_encoding_format`.
416	if(auto* ecc_key = dynamic_cast<ECDH_PublicKey*>(key.get())) {	49✔
417	ecc_key->set_point_encoding(tls12_ecc_pubkey_encoding_format);	49✔
418	}
419
420	return key;	49✔
421	}	×
422
423	secure_vector<uint8_t> TLS::Callbacks::tls_ephemeral_key_agreement(	2,398✔
424	const std::variant<TLS::Group_Params, DL_Group>& group,
425	const PK_Key_Agreement_Key& private_key,
426	const std::vector<uint8_t>& public_value,
427	RandomNumberGenerator& rng,
428	const Policy& policy) {
429	const auto kex_pub_key = [&]() {	7,150✔
430	try {	2,398✔
431	return tls_deserialize_peer_public_key(group, public_value);	2,398✔
432	} catch(const Decoding_Error& ex) {	44✔
433	// This exception means that the public key was invalid. However,
434	// TLS' DecodeError would imply that a protocol message was invalid.
435	throw TLS_Exception(Alert::IllegalParameter, ex.what());	44✔
436	} catch(const Invalid_Argument& ex) {	44✔
437	throw TLS_Exception(Alert::IllegalParameter, ex.what());	×
438	}	×
439	}();	2,398✔
440
441	BOTAN_ASSERT_NONNULL(kex_pub_key);	2,354✔
442	policy.check_peer_key_acceptable(*kex_pub_key);	2,354✔
443
444	// RFC 8422 - 5.11.
445	// With X25519 and X448, a receiving party MUST check whether the
446	// computed premaster secret is the all-zero value and abort the
447	// handshake if so, as described in Section 6 of [RFC7748].
448	//
449	// This is done within the key agreement operation and throws
450	// an Invalid_Argument exception if the shared secret is all-zero.
451	try {	2,354✔
452	const PK_Key_Agreement ka(private_key, rng, "Raw");	2,354✔
453	return ka.derive_key(0, kex_pub_key->raw_public_key_bits()).bits_of();	7,058✔
454	} catch(const Invalid_Argument& ex) {	2,358✔
455	throw TLS_Exception(Alert::IllegalParameter, ex.what());	4✔
456	}	4✔
457	}	2,350✔
458
459	void TLS::Callbacks::tls_session_established(const Session_Summary& session) {	72✔
460	BOTAN_UNUSED(session);	72✔
461	}	72✔
462
463	std::vector<uint8_t> TLS::Callbacks::tls_provide_cert_status(const std::vector<X509_Certificate>& chain,	145✔
464	const Certificate_Status_Request& csr) {
465	BOTAN_UNUSED(chain, csr);	145✔
466	return std::vector<uint8_t>();	145✔
467	}
468
469	void TLS::Callbacks::tls_log_error(const char* err) {	×
470	BOTAN_UNUSED(err);	×
471	}	×
472
473	void TLS::Callbacks::tls_log_debug(const char* what) {	×
474	BOTAN_UNUSED(what);	×
475	}	×
476
477	void TLS::Callbacks::tls_log_debug_bin(const char* descr, const uint8_t val[], size_t val_len) {	×
478	BOTAN_UNUSED(descr, val, val_len);	×
479	}	×
480
481	void TLS::Callbacks::tls_ssl_key_log_data(std::string_view label,	×
482	std::span<const uint8_t> client_random,
483	std::span<const uint8_t> secret) const {
484	BOTAN_UNUSED(label, client_random, secret);	×
485	}	×
486
487	std::unique_ptr<KDF> TLS::Callbacks::tls12_protocol_specific_kdf(std::string_view prf_algo) const {	6,343✔
488	if(prf_algo == "MD5" \|\| prf_algo == "SHA-1") {	7,104✔
489	return KDF::create_or_throw("TLS-12-PRF(SHA-256)");	761✔
490	}
491
492	return KDF::create_or_throw(Botan::fmt("TLS-12-PRF({})", prf_algo));	11,164✔
493	}
494
495	} // namespace Botan

randombit / botan / 29471089948

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous