9#include <botan/internal/tls_server_impl_13.h>
11#include <botan/credentials_manager.h>
13#include <botan/tls_callbacks.h>
14#include <botan/tls_extensions_13.h>
15#include <botan/tls_policy.h>
16#include <botan/x509cert.h>
17#include <botan/internal/loadstor.h>
18#include <botan/internal/stl_util.h>
19#include <botan/internal/tls_cipher_state.h>
26 const std::shared_ptr<const Policy>&
policy,
27 const std::shared_ptr<RandomNumberGenerator>&
rng) :
29 m_handshake(std::make_unique<Pending_Handshake>()) {
30#if defined(BOTAN_HAS_TLS_12)
31 if(
policy->allow_tls12()) {
32 expect_downgrade({}, {});
53 if(m_handshake->state.has_client_certificate_msg() &&
54 m_handshake->state.client_certificate().has_certificate_chain()) {
55 return m_handshake->state.client_certificate().cert_chain();
58 if(m_handshake->resumed_session.has_value()) {
59 return m_handshake->resumed_session->peer_certs();
72 if(m_handshake->state.has_client_certificate_msg() &&
73 m_handshake->state.client_certificate().is_raw_public_key()) {
74 return m_handshake->state.client_certificate().public_key();
77 if(m_handshake->resumed_session.has_value()) {
78 return m_handshake->resumed_session->peer_raw_public_key();
88 }
else if(m_handshake) {
89 return m_handshake->psk_identity;
118 size_t tickets_created = 0;
122 for(
size_t i = 0; i < tickets; ++i) {
124 const uint32_t ticket_age_add =
load_be(
rng().random_array<4>());
128 policy().session_ticket_lifetime(),
137 if(
callbacks().tls_should_persist_resumption_information(session)) {
145 if(flight.contains_messages()) {
149 return tickets_created;
158 m_handshake->transitions.confirm_transition_to(msg.get().type());
161 callbacks().tls_inspect_handshake_msg(msg.get());
166 m_handshake->state.received(std::move(message)));
169void Server_Impl_13::process_post_handshake_msg(Post_Handshake_Message_13 message) {
174 throw TLS_Exception(Alert::UnexpectedMessage,
"Received an unexpected post-handshake message");
177 std::visit([&](
auto&& m) { handle(m); }, *msg);
180void Server_Impl_13::process_dummy_change_cipher_spec() {
185 if(!m_handshake || !m_handshake->state.has_client_hello() || m_handshake->state.has_client_finished()) {
186 throw TLS_Exception(Alert::UnexpectedMessage,
"Received an unexpected dummy Change Cipher Spec");
199 return m_active_state.has_value() || (m_handshake !=
nullptr && m_handshake->state.has_client_finished());
202void Server_Impl_13::maybe_log_secret(std::string_view label, std::span<const uint8_t> secret)
const {
203 if(policy().allow_ssl_key_log_file()) {
204 if(m_active_state.has_value()) {
205 callbacks().tls_ssl_key_log_data(label, m_active_state->client_random(), secret);
207 callbacks().tls_ssl_key_log_data(label, m_handshake->state.client_hello().random(), secret);
212void Server_Impl_13::downgrade() {
219 m_handshake->transitions.set_expected_next({});
222void Server_Impl_13::maybe_handle_compatibility_mode() {
224 BOTAN_ASSERT_NOMSG(m_handshake->state.has_hello_retry_request() || m_handshake->state.has_server_hello());
246 const bool just_after_first_handshake_message =
247 m_handshake->state.has_hello_retry_request() ^ m_handshake->state.has_server_hello();
248 const bool client_requested_compatibility_mode = !m_handshake->state.client_hello().session_id().empty();
250 if(just_after_first_handshake_message &&
251 (policy().tls_13_middlebox_compatibility_mode() || client_requested_compatibility_mode)) {
252 send_dummy_change_cipher_spec();
256void Server_Impl_13::handle_reply_to_client_hello(Server_Hello_13 server_hello) {
257 const auto& client_hello = m_handshake->state.client_hello();
258 const auto& exts = client_hello.extensions();
260 const bool uses_psk = server_hello.extensions().has<
PSK>();
262 const auto cipher_opt = Ciphersuite::by_id(server_hello.ciphersuite());
264 const auto& cipher = cipher_opt.value();
265 m_transcript_hash.set_algorithm(cipher.prf_algo());
267 std::unique_ptr<Cipher_State> psk_cipher_state;
269 auto* psk_extension = server_hello.extensions().get<
PSK>();
271 psk_cipher_state = std::visit(
273 m_handshake->resumed_session = std::move(session);
274 return Cipher_State::init_with_psk(Connection_Side::Server,
275 Cipher_State::PSK_Type::Resumption,
276 m_handshake->resumed_session->extract_master_secret(),
279 [&,
this](ExternalPSK psk) {
280 m_handshake->psk_identity = psk.identity();
281 const auto psk_type =
282 psk.is_imported() ? Cipher_State::PSK_Type::Imported : Cipher_State::PSK_Type::External;
283 return Cipher_State::init_with_psk(
284 Connection_Side::Server, psk_type, psk.extract_master_secret(), cipher.prf_algo());
286 psk_extension->take_session_to_resume_or_psk());
299 if(!exts.get<PSK>()->validate_binder(*psk_extension,
300 psk_cipher_state->psk_binder_mac(m_transcript_hash.truncated()))) {
301 throw TLS_Exception(Alert::DecryptError,
"PSK binder does not check out");
321 send_handshake_message(m_handshake->state.sending(std::move(server_hello)));
322 maybe_handle_compatibility_mode();
325 m_cipher_state = [&] {
327 auto*
const my_keyshare = m_handshake->state.server_hello().extensions().get<Key_Share>();
332 psk_cipher_state->advance_with_client_hello(m_transcript_hash.previous(), *
this);
333 psk_cipher_state->advance_with_server_hello(
334 cipher, my_keyshare->take_shared_secret(), m_transcript_hash.current(), *
this);
336 return std::move(psk_cipher_state);
338 return Cipher_State::init_with_server_hello(
339 m_side, my_keyshare->take_shared_secret(), cipher, m_transcript_hash.current(), *
this);
346 auto certificate_request =
347 uses_psk ? std::nullopt
348 : Certificate_Request_13::maybe_create(client_hello, credentials_manager(), callbacks(), policy());
350 auto flight = aggregate_handshake_messages();
351 const bool is_resumption = m_handshake->resumed_session.has_value();
352 const bool requesting_client_auth = certificate_request.has_value();
354 flight.add(m_handshake->state.sending(
355 Encrypted_Extensions(client_hello, policy(), callbacks(), is_resumption, requesting_client_auth)));
362 if(certificate_request.has_value()) {
363 flight.add(m_handshake->state.sending(std::move(certificate_request.value())));
366 const auto& enc_exts = m_handshake->state.encrypted_extensions().extensions();
375 if(
auto* client_cert_type = enc_exts.get<Client_Certificate_Type>()) {
376 set_selected_certificate_type(client_cert_type->selected_certificate_type());
384 const auto cert_type = [&] {
385 if(
auto* server_cert_type = enc_exts.get<Server_Certificate_Type>()) {
386 return server_cert_type->selected_certificate_type();
388 return Certificate_Type::X509;
393 .add(m_handshake->state.sending(Certificate_13(client_hello, credentials_manager(), callbacks(), cert_type)))
394 .add(m_handshake->state.sending(Certificate_Verify_13(m_handshake->state.server_certificate(),
395 client_hello.signature_schemes(),
396 client_hello.sni_hostname(),
397 m_transcript_hash.current(),
398 Connection_Side::Server,
399 credentials_manager(),
405 flight.add(m_handshake->state.sending(Finished_13(m_cipher_state.get(), m_transcript_hash.current())));
407 if(client_hello.extensions().has<Record_Size_Limit>() &&
408 m_handshake->state.encrypted_extensions().extensions().has<Record_Size_Limit>()) {
424 auto*
const outgoing_limit = client_hello.extensions().get<Record_Size_Limit>();
425 auto*
const incoming_limit = m_handshake->state.encrypted_extensions().extensions().get<Record_Size_Limit>();
426 set_record_size_limits(outgoing_limit->limit(), incoming_limit->limit());
431 m_cipher_state->advance_with_server_finished(m_transcript_hash.current(), *
this);
433 if(m_handshake->state.has_certificate_request()) {
440 m_handshake->transitions.set_expected_next(Handshake_Type::Certificate);
442 m_handshake->transitions.set_expected_next(Handshake_Type::Finished);
446void Server_Impl_13::handle_reply_to_client_hello(Hello_Retry_Request hello_retry_request) {
447 auto cipher = Ciphersuite::by_id(hello_retry_request.ciphersuite());
450 send_handshake_message(m_handshake->state.sending(std::move(hello_retry_request)));
451 maybe_handle_compatibility_mode();
453 m_transcript_hash = Transcript_Hash_State::recreate_after_hello_retry_request(cipher->prf_algo(), m_transcript_hash);
455 m_handshake->transitions.set_expected_next(Handshake_Type::ClientHello);
458void Server_Impl_13::handle(
const Client_Hello_12_Shim& ch) {
465 if(m_handshake->state.has_hello_retry_request()) {
466 throw TLS_Exception(Alert::UnexpectedMessage,
"Received a TLS 1.2 Client Hello after Hello Retry Request");
475 if(!expects_downgrade()) {
476 throw TLS_Exception(Alert::ProtocolVersion,
"Received a legacy Client Hello");
482void Server_Impl_13::handle(
const Client_Hello_13& client_hello) {
485 const auto& exts = client_hello.extensions();
487 const bool is_initial_client_hello = !m_handshake->state.has_hello_retry_request();
489 if(is_initial_client_hello) {
490 const auto preferred_version = client_hello.highest_supported_version(policy());
491 if(!preferred_version) {
492 throw TLS_Exception(Alert::ProtocolVersion,
"No shared TLS version");
498 if(exts.has<Cookie>()) {
499 throw TLS_Exception(Alert::IllegalParameter,
"Received a Cookie in the initial client hello");
505 if(!exts.has<Supported_Groups>()) {
516 if(!is_initial_client_hello) {
517 const auto& hrr_exts = m_handshake->state.hello_retry_request().extensions();
518 const auto offered_groups = exts.get<Key_Share>()->offered_groups();
519 const auto* hrr_key_share = hrr_exts.get<Key_Share>();
521 const auto selected_group = hrr_key_share->selected_group();
522 if(offered_groups.size() != 1 || offered_groups.at(0) != selected_group) {
523 throw TLS_Exception(Alert::IllegalParameter,
"Client did not comply with the requested key exchange group");
527 callbacks().tls_examine_extensions(exts, Connection_Side::Client, client_hello.type());
528 std::visit([
this](
auto msg) { handle_reply_to_client_hello(std::move(msg)); },
529 Server_Hello_13::create(client_hello,
530 is_initial_client_hello,
532 credentials_manager(),
538void Server_Impl_13::handle(
const Certificate_13& certificate_msg) {
544 if(!is_handshake_complete() && !certificate_msg.request_context().empty()) {
545 throw TLS_Exception(Alert::DecodeError,
"Received a client certificate message with non-empty request context");
551 certificate_msg.validate_extensions(m_handshake->state.certificate_request().extensions().extension_types(),
559 if(certificate_msg.empty()) {
560 if(policy().require_client_certificate_authentication()) {
561 throw TLS_Exception(Alert::CertificateRequired,
"Policy requires client send a certificate, but it did not");
567 m_handshake->transitions.set_expected_next(Handshake_Type::Finished);
579 const bool use_ocsp = m_handshake->state.certificate_request().extensions().has<Certificate_Status_Request>();
580 certificate_msg.verify(
581 callbacks(), policy(), credentials_manager(), m_handshake->state.client_hello().sni_hostname(), use_ocsp);
588 m_handshake->transitions.set_expected_next(Handshake_Type::CertificateVerify);
592void Server_Impl_13::handle(
const Certificate_Verify_13& certificate_verify_msg) {
600 const auto offered = m_handshake->state.certificate_request().signature_schemes();
601 if(!
value_exists(offered, certificate_verify_msg.signature_scheme())) {
602 throw TLS_Exception(Alert::IllegalParameter,
603 "We did not offer the usage of " + certificate_verify_msg.signature_scheme().to_string() +
604 " as a signature scheme");
608 !m_handshake->state.client_certificate().empty());
609 const bool sig_valid = certificate_verify_msg.verify(
610 *m_handshake->state.client_certificate().public_key(), callbacks(), m_transcript_hash.previous());
616 throw TLS_Exception(Alert::DecryptError,
"Client certificate verification failed");
619 m_handshake->transitions.set_expected_next(Handshake_Type::Finished);
622void Server_Impl_13::handle(
const Finished_13& finished_msg) {
629 if(!finished_msg.verify(m_cipher_state.get(), m_transcript_hash.previous())) {
630 throw TLS_Exception(Alert::DecryptError,
"Finished message didn't verify");
633 m_handshake->state.confirm_peer_finished_verified();
637 callbacks().tls_session_established(
638 Session_Summary(m_handshake->state.server_hello(),
639 Connection_Side::Server,
641 peer_raw_public_key(),
642 m_handshake->psk_identity,
643 m_handshake->resumed_session.has_value(),
644 Server_Information(m_handshake->state.client_hello().sni_hostname()),
645 callbacks().tls_current_timestamp()));
647 m_cipher_state->advance_with_client_finished(m_transcript_hash.current());
650 m_handshake->transitions.set_expected_next({});
654 auto extract_certs = [&]() -> std::vector<X509_Certificate> {
655 if(m_handshake->state.has_client_certificate_msg() &&
656 m_handshake->state.client_certificate().has_certificate_chain()) {
657 return m_handshake->state.client_certificate().cert_chain();
659 if(m_handshake->resumed_session.has_value()) {
660 return m_handshake->resumed_session->peer_certs();
665 auto extract_raw_pk = [&]() -> std::shared_ptr<const Public_Key> {
666 if(m_handshake->state.has_client_certificate_msg() &&
667 m_handshake->state.client_certificate().is_raw_public_key()) {
668 return m_handshake->state.client_certificate().public_key();
670 if(m_handshake->resumed_session.has_value()) {
671 return m_handshake->resumed_session->peer_raw_public_key();
676 const bool supports_psk_dhe =
677 m_handshake->state.client_hello().extensions().has<PSK_Key_Exchange_Modes>() &&
678 value_exists(m_handshake->state.client_hello().extensions().get<PSK_Key_Exchange_Modes>()->modes(),
679 PSK_Key_Exchange_Mode::PSK_DHE_KE);
681 m_active_state = Active_Connection_State_13(m_handshake->state,
684 m_handshake->psk_identity,
685 m_handshake->state.client_hello().sni_hostname(),
690 m_transcript_hash = Transcript_Hash_State();
691 callbacks().tls_session_activated();
693 if(new_session_ticket_supported()) {
694 send_new_session_tickets(policy().new_session_tickets_upon_handshake_success());
#define BOTAN_ASSERT_NOMSG(expr)
#define BOTAN_STATE_CHECK(expr)
#define BOTAN_ASSERT_NONNULL(ptr)
const Policy & policy() const
AggregatedPostHandshakeMessages aggregate_post_handshake_messages()
Credentials_Manager & credentials_manager()
RandomNumberGenerator & rng()
std::optional< Active_Connection_State_13 > m_active_state
Channel_Impl_13(const std::shared_ptr< Callbacks > &callbacks, const std::shared_ptr< Session_Manager > &session_manager, const std::shared_ptr< Credentials_Manager > &credentials_manager, const std::shared_ptr< RandomNumberGenerator > &rng, const std::shared_ptr< const Policy > &policy, bool is_server)
Session_Manager & session_manager()
std::unique_ptr< Cipher_State > m_cipher_state
Callbacks & callbacks() const
std::vector< X509_Certificate > peer_cert_chain() const override
size_t send_new_session_tickets(size_t tickets) override
std::optional< std::string > external_psk_identity() const override
std::shared_ptr< const Public_Key > peer_raw_public_key() const override
bool is_handshake_complete() const override
std::string application_protocol() const override
bool new_session_ticket_supported() const override
Server_Impl_13(const std::shared_ptr< Callbacks > &callbacks, const std::shared_ptr< Session_Manager > &session_manager, const std::shared_ptr< Credentials_Manager > &credentials_manager, const std::shared_ptr< const Policy > &policy, const std::shared_ptr< RandomNumberGenerator > &rng)
std::variant< Client_Hello_13, Client_Hello_12_Shim, Server_Hello_13, Server_Hello_12_Shim, Hello_Retry_Request, Encrypted_Extensions, Certificate_13, Certificate_Request_13, Certificate_Verify_13, Finished_13 > Handshake_Message_13
constexpr std::optional< SpecificVariantT > specialize_to(GeneralVariantT &&v)
Converts a given variant into another variant whose type states are a subset of the given variant.
bool value_exists(const std::vector< T > &vec, const V &val)
constexpr auto load_be(ParamTs &&... params)