9#include <botan/internal/tls_server_impl_13.h>
11#include <botan/credentials_manager.h>
13#include <botan/internal/stl_util.h>
14#include <botan/internal/tls_cipher_state.h>
21 const std::shared_ptr<const Policy>&
policy,
22 const std::shared_ptr<RandomNumberGenerator>&
rng) :
24#if defined(BOTAN_HAS_TLS_12)
25 if(
policy->allow_tls12()) {
26 expect_downgrade({}, {});
35 const auto& eee = m_handshake_state.encrypted_extensions().extensions();
37 return alpn->single_protocol();
45 if(m_handshake_state.has_client_certificate_msg() &&
46 m_handshake_state.client_certificate().has_certificate_chain()) {
47 return m_handshake_state.client_certificate().cert_chain();
50 if(m_resumed_session.has_value()) {
51 return m_resumed_session->peer_certs();
58 if(m_handshake_state.has_client_certificate_msg() && m_handshake_state.client_certificate().is_raw_public_key()) {
59 return m_handshake_state.client_certificate().public_key();
62 if(m_resumed_session.has_value()) {
63 return m_resumed_session->peer_raw_public_key();
70 return m_psk_identity;
97 size_t tickets_created = 0;
99 for(
size_t i = 0; i < tickets; ++i) {
103 policy().session_ticket_lifetime(),
106 m_handshake_state.client_hello(),
107 m_handshake_state.server_hello(),
111 if(
callbacks().tls_should_persist_resumption_information(session)) {
119 if(flight.contains_messages()) {
123 return tickets_created;
130 m_transitions.confirm_transition_to(msg.get().type());
133 callbacks().tls_inspect_handshake_msg(msg.get());
138 m_handshake_state.received(std::move(message)));
141void Server_Impl_13::process_post_handshake_msg(Post_Handshake_Message_13 message) {
144 std::visit([&](
auto msg) { handle(msg); }, m_handshake_state.received(std::move(message)));
147void Server_Impl_13::process_dummy_change_cipher_spec() {
152 if(!m_handshake_state.has_client_hello() || m_handshake_state.has_client_finished()) {
153 throw TLS_Exception(Alert::UnexpectedMessage,
"Received an unexpected dummy Change Cipher Spec");
166 return m_handshake_state.handshake_finished();
169void Server_Impl_13::maybe_log_secret(std::string_view label, std::span<const uint8_t> secret)
const {
170 if(policy().allow_ssl_key_log_file()) {
171 callbacks().tls_ssl_key_log_data(label, m_handshake_state.client_hello().random(), secret);
175void Server_Impl_13::downgrade() {
182 m_transitions.set_expected_next({});
185void Server_Impl_13::maybe_handle_compatibility_mode() {
187 BOTAN_ASSERT_NOMSG(m_handshake_state.has_hello_retry_request() || m_handshake_state.has_server_hello());
209 const bool just_after_first_handshake_message =
210 m_handshake_state.has_hello_retry_request() ^ m_handshake_state.has_server_hello();
211 const bool client_requested_compatibility_mode = !m_handshake_state.client_hello().session_id().empty();
213 if(just_after_first_handshake_message &&
214 (policy().tls_13_middlebox_compatibility_mode() || client_requested_compatibility_mode)) {
215 send_dummy_change_cipher_spec();
219void Server_Impl_13::handle_reply_to_client_hello(Server_Hello_13 server_hello) {
220 const auto& client_hello = m_handshake_state.client_hello();
221 const auto& exts = client_hello.extensions();
223 const bool uses_psk = server_hello.extensions().has<
PSK>();
225 const auto cipher_opt = Ciphersuite::by_id(server_hello.ciphersuite());
227 const auto& cipher = cipher_opt.value();
228 m_transcript_hash.set_algorithm(cipher.prf_algo());
230 std::unique_ptr<Cipher_State> psk_cipher_state;
232 auto* psk_extension = server_hello.extensions().get<
PSK>();
235 std::visit(
overloaded{[&,
this](Session session) {
236 m_resumed_session = std::move(session);
237 return Cipher_State::init_with_psk(Connection_Side::Server,
238 Cipher_State::PSK_Type::Resumption,
239 m_resumed_session->extract_master_secret(),
242 [&,
this](ExternalPSK psk) {
243 m_psk_identity = psk.identity();
244 return Cipher_State::init_with_psk(Connection_Side::Server,
245 Cipher_State::PSK_Type::External,
246 psk.extract_master_secret(),
249 psk_extension->take_session_to_resume_or_psk());
262 if(!exts.get<PSK>()->validate_binder(*psk_extension,
263 psk_cipher_state->psk_binder_mac(m_transcript_hash.truncated()))) {
264 throw TLS_Exception(Alert::DecryptError,
"PSK binder does not check out");
284 send_handshake_message(m_handshake_state.sending(std::move(server_hello)));
285 maybe_handle_compatibility_mode();
288 m_cipher_state = [&] {
290 auto*
const my_keyshare = m_handshake_state.server_hello().extensions().get<Key_Share>();
295 psk_cipher_state->advance_with_client_hello(m_transcript_hash.previous(), *
this);
296 psk_cipher_state->advance_with_server_hello(
297 cipher, my_keyshare->take_shared_secret(), m_transcript_hash.current(), *
this);
299 return std::move(psk_cipher_state);
301 return Cipher_State::init_with_server_hello(
302 m_side, my_keyshare->take_shared_secret(), cipher, m_transcript_hash.current(), *
this);
306 auto flight = aggregate_handshake_messages();
307 flight.add(m_handshake_state.sending(Encrypted_Extensions(client_hello, policy(), callbacks())));
314 if(
auto certificate_request =
315 Certificate_Request_13::maybe_create(client_hello, credentials_manager(), callbacks(), policy())) {
316 flight.add(m_handshake_state.sending(std::move(certificate_request.value())));
319 const auto& enc_exts = m_handshake_state.encrypted_extensions().extensions();
328 if(
auto* client_cert_type = enc_exts.get<Client_Certificate_Type>()) {
329 set_selected_certificate_type(client_cert_type->selected_certificate_type());
337 const auto cert_type = [&] {
338 if(
auto* server_cert_type = enc_exts.get<Server_Certificate_Type>()) {
339 return server_cert_type->selected_certificate_type();
341 return Certificate_Type::X509;
345 flight.add(m_handshake_state.sending(Certificate_13(client_hello, credentials_manager(), callbacks(), cert_type)))
346 .add(m_handshake_state.sending(Certificate_Verify_13(m_handshake_state.server_certificate(),
347 client_hello.signature_schemes(),
348 client_hello.sni_hostname(),
349 m_transcript_hash.current(),
350 Connection_Side::Server,
351 credentials_manager(),
357 flight.add(m_handshake_state.sending(Finished_13(m_cipher_state.get(), m_transcript_hash.current())));
359 if(client_hello.extensions().has<Record_Size_Limit>() &&
360 m_handshake_state.encrypted_extensions().extensions().has<Record_Size_Limit>()) {
376 auto*
const outgoing_limit = client_hello.extensions().get<Record_Size_Limit>();
377 auto*
const incoming_limit = m_handshake_state.encrypted_extensions().extensions().get<Record_Size_Limit>();
378 set_record_size_limits(outgoing_limit->limit(), incoming_limit->limit());
383 m_cipher_state->advance_with_server_finished(m_transcript_hash.current(), *
this);
385 if(m_handshake_state.has_certificate_request()) {
392 m_transitions.set_expected_next(Handshake_Type::Certificate);
394 m_transitions.set_expected_next(Handshake_Type::Finished);
398void Server_Impl_13::handle_reply_to_client_hello(Hello_Retry_Request hello_retry_request) {
399 auto cipher = Ciphersuite::by_id(hello_retry_request.ciphersuite());
402 send_handshake_message(m_handshake_state.sending(std::move(hello_retry_request)));
403 maybe_handle_compatibility_mode();
405 m_transcript_hash = Transcript_Hash_State::recreate_after_hello_retry_request(cipher->prf_algo(), m_transcript_hash);
407 m_transitions.set_expected_next(Handshake_Type::ClientHello);
410void Server_Impl_13::handle(
const Client_Hello_12& ch) {
416 if(m_handshake_state.has_hello_retry_request()) {
417 throw TLS_Exception(Alert::UnexpectedMessage,
"Received a TLS 1.2 Client Hello after Hello Retry Request");
426 if(!expects_downgrade()) {
427 throw TLS_Exception(Alert::ProtocolVersion,
"Received a legacy Client Hello");
433void Server_Impl_13::handle(
const Client_Hello_13& client_hello) {
434 const auto& exts = client_hello.extensions();
436 const bool is_initial_client_hello = !m_handshake_state.has_hello_retry_request();
438 if(is_initial_client_hello) {
439 const auto preferred_version = client_hello.highest_supported_version(policy());
440 if(!preferred_version) {
441 throw TLS_Exception(Alert::ProtocolVersion,
"No shared TLS version");
447 if(exts.has<Cookie>()) {
448 throw TLS_Exception(Alert::IllegalParameter,
"Received a Cookie in the initial client hello");
454 if(!exts.has<Supported_Groups>()) {
465 if(!is_initial_client_hello) {
466 const auto& hrr_exts = m_handshake_state.hello_retry_request().extensions();
467 const auto offered_groups = exts.get<Key_Share>()->offered_groups();
468 const auto selected_group = hrr_exts.get<Key_Share>()->selected_group();
469 if(offered_groups.size() != 1 || offered_groups.at(0) != selected_group) {
470 throw TLS_Exception(Alert::IllegalParameter,
"Client did not comply with the requested key exchange group");
474 callbacks().tls_examine_extensions(exts, Connection_Side::Client, client_hello.type());
475 std::visit([
this](
auto msg) { handle_reply_to_client_hello(std::move(msg)); },
476 Server_Hello_13::create(client_hello,
477 is_initial_client_hello,
479 credentials_manager(),
485void Server_Impl_13::handle(
const Certificate_13& certificate_msg) {
489 if(!is_handshake_complete() && !certificate_msg.request_context().empty()) {
490 throw TLS_Exception(Alert::DecodeError,
"Received a client certificate message with non-empty request context");
496 certificate_msg.validate_extensions(m_handshake_state.certificate_request().extensions().extension_types(),
504 if(certificate_msg.empty()) {
505 if(policy().require_client_certificate_authentication()) {
506 throw TLS_Exception(Alert::CertificateRequired,
"Policy requires client send a certificate, but it did not");
512 m_transitions.set_expected_next(Handshake_Type::Finished);
523 certificate_msg.verify(callbacks(),
525 credentials_manager(),
526 m_handshake_state.client_hello().sni_hostname(),
527 m_handshake_state.client_hello().extensions().has<Certificate_Status_Request>());
534 m_transitions.set_expected_next(Handshake_Type::CertificateVerify);
538void Server_Impl_13::handle(
const Certificate_Verify_13& certificate_verify_msg) {
544 const auto offered = m_handshake_state.certificate_request().signature_schemes();
545 if(!
value_exists(offered, certificate_verify_msg.signature_scheme())) {
546 throw TLS_Exception(Alert::IllegalParameter,
547 "We did not offer the usage of " + certificate_verify_msg.signature_scheme().to_string() +
548 " as a signature scheme");
552 !m_handshake_state.client_certificate().empty());
553 bool sig_valid = certificate_verify_msg.verify(
554 *m_handshake_state.client_certificate().public_key(), callbacks(), m_transcript_hash.previous());
560 throw TLS_Exception(Alert::DecryptError,
"Client certificate verification failed");
563 m_transitions.set_expected_next(Handshake_Type::Finished);
566void Server_Impl_13::handle(
const Finished_13& finished_msg) {
571 if(!finished_msg.verify(m_cipher_state.get(), m_transcript_hash.previous())) {
572 throw TLS_Exception(Alert::DecryptError,
"Finished message didn't verify");
577 callbacks().tls_session_established(
578 Session_Summary(m_handshake_state.server_hello(),
579 Connection_Side::Server,
581 peer_raw_public_key(),
583 m_resumed_session.has_value(),
584 Server_Information(m_handshake_state.client_hello().sni_hostname()),
585 callbacks().tls_current_timestamp()));
587 m_cipher_state->advance_with_client_finished(m_transcript_hash.current());
590 m_transitions.set_expected_next({});
592 callbacks().tls_session_activated();
594 if(new_session_ticket_supported()) {
595 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()
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
const std::vector< PSK_Key_Exchange_Mode > & modes() 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, Server_Hello_13, Server_Hello_12, Hello_Retry_Request, Encrypted_Extensions, Certificate_13, Certificate_Request_13, Certificate_Verify_13, Finished_13 > Handshake_Message_13
bool value_exists(const std::vector< T > &vec, const V &val)