Botan::TLS::Server_Hello_12 Class Reference

#include <tls_messages_12.h>

Inheritance diagram for Botan::TLS::Server_Hello_12:

Classes
class	Settings

Public Member Functions
uint16_t	ciphersuite () const
uint8_t	compression_method () const
std::set< Extension_Code >	extension_types () const
const Extensions &	extensions () const
Protocol_Version	legacy_version () const
std::string	next_protocol () const
bool	prefers_compressed_ec_points () const
const std::vector< uint8_t > &	random () const
std::optional< Protocol_Version >	random_signals_downgrade () const
std::vector< uint8_t >	renegotiation_info () const
bool	secure_renegotiation () const
Protocol_Version	selected_version () const final
std::vector< uint8_t >	serialize () const override
	Server_Hello_12 (const std::vector< uint8_t > &buf)
	Server_Hello_12 (Handshake_IO &io, Handshake_Hash &hash, const Policy &policy, Callbacks &cb, RandomNumberGenerator &rng, const std::vector< uint8_t > &secure_reneg_info, const Client_Hello_12 &client_hello, const Session &resumed_session, bool offer_session_ticket, std::string_view next_protocol)
	Server_Hello_12 (Handshake_IO &io, Handshake_Hash &hash, const Policy &policy, Callbacks &cb, RandomNumberGenerator &rng, const std::vector< uint8_t > &secure_reneg_info, const Client_Hello_12 &client_hello, const Settings &settings, std::string_view next_protocol)
const Session_ID &	session_id () const
uint16_t	srtp_profile () const
bool	supports_certificate_status_message () const
bool	supports_encrypt_then_mac () const
bool	supports_extended_master_secret () const
bool	supports_session_ticket () const
Handshake_Type	type () const override
std::string	type_string () const
virtual Handshake_Type	wire_type () const

Protected Attributes
std::unique_ptr< Server_Hello_Internal >	m_data

Detailed Description

Definition at line 89 of file tls_messages_12.h.

Constructor & Destructor Documentation

Server_Hello_12() [1/3]

Botan::TLS::Server_Hello_12::Server_Hello_12	(	Handshake_IO &	io,
		Handshake_Hash &	hash,
		const Policy &	policy,
		Callbacks &	cb,
		RandomNumberGenerator &	rng,
		const std::vector< uint8_t > &	secure_reneg_info,
		const Client_Hello_12 &	client_hello,
		const Settings &	settings,
		std::string_view	next_protocol )

Definition at line 22 of file msg_server_hello_12.cpp.

                                                               :
      Server_Hello_12(std::make_unique<Server_Hello_Internal>(
         server_settings.protocol_version(),
         server_settings.session_id(),
         make_server_hello_random(rng, server_settings.protocol_version(), cb, policy),
         server_settings.ciphersuite(),
         uint8_t(0))) {
   // NOLINTBEGIN(*-owning-memory)
   if(client_hello.supports_extended_master_secret()) {
      m_data->extensions().add(new Extended_Master_Secret);
   }
 
   // Sending the extension back does not commit us to sending a stapled response
   if(client_hello.supports_cert_status_message() && policy.support_cert_status_message()) {
      m_data->extensions().add(new Certificate_Status_Request);
   }
 
   if(!next_protocol.empty() && client_hello.supports_alpn()) {
      m_data->extensions().add(new Application_Layer_Protocol_Notification(next_protocol));
   }
 
   const auto c = Ciphersuite::by_id(m_data->ciphersuite());
 
   if(c && c->cbc_ciphersuite() && client_hello.supports_encrypt_then_mac() && policy.negotiate_encrypt_then_mac()) {
      m_data->extensions().add(new Encrypt_then_MAC);
   }
 
   if(c && c->ecc_ciphersuite() && client_hello.extension_types().contains(Extension_Code::EcPointFormats)) {
      m_data->extensions().add(new Supported_Point_Formats(policy.use_ecc_point_compression()));
   }
 
   if(client_hello.secure_renegotiation()) {
      m_data->extensions().add(new Renegotiation_Extension(reneg_info));
   }
 
   if(client_hello.supports_session_ticket() && server_settings.offer_session_ticket()) {
      m_data->extensions().add(new Session_Ticket_Extension());
   }
 
   if(m_data->legacy_version().is_datagram_protocol()) {
      const std::vector<uint16_t> server_srtp = policy.srtp_profiles();
      const std::vector<uint16_t> client_srtp = client_hello.srtp_profiles();
 
      if(!server_srtp.empty() && !client_srtp.empty()) {
         uint16_t shared = 0;
         // always using server preferences for now
         for(auto s_srtp : server_srtp) {
            for(auto c_srtp : client_srtp) {
               if(shared == 0 && s_srtp == c_srtp) {
                  shared = s_srtp;
               }
            }
         }
 
         if(shared != 0) {
            m_data->extensions().add(new SRTP_Protection_Profiles(shared));
         }
      }
   }
   // NOLINTEND(*-owning-memory)
 
   cb.tls_modify_extensions(m_data->extensions(), Connection_Side::Server, type());
 
   hash.update(io.send(*this));
}

References Botan::TLS::Ciphersuite::by_id(), Botan::TLS::Server_Hello::ciphersuite(), Botan::TLS::EcPointFormats, Botan::TLS::Client_Hello::extension_types(), Botan::TLS::Server_Hello::m_data, Botan::TLS::make_server_hello_random(), Botan::TLS::Policy::negotiate_encrypt_then_mac(), next_protocol(), Botan::TLS::Server_Hello_12::Settings::offer_session_ticket(), Botan::TLS::Client_Hello_12::secure_renegotiation(), Server_Hello_12(), Botan::TLS::Server_Hello::session_id(), Botan::TLS::Policy::support_cert_status_message(), Botan::TLS::Client_Hello::supports_alpn(), Botan::TLS::Client_Hello_12::supports_cert_status_message(), Botan::TLS::Client_Hello_12::supports_encrypt_then_mac(), Botan::TLS::Client_Hello_12::supports_extended_master_secret(), and Botan::TLS::Client_Hello_12::supports_session_ticket().

Referenced by Server_Hello_12(), Server_Hello_12(), and Server_Hello_12().

Server_Hello_12() [2/3]

Botan::TLS::Server_Hello_12::Server_Hello_12	(	Handshake_IO &	io,
		Handshake_Hash &	hash,
		const Policy &	policy,
		Callbacks &	cb,
		RandomNumberGenerator &	rng,
		const std::vector< uint8_t > &	secure_reneg_info,
		const Client_Hello_12 &	client_hello,
		const Session &	resumed_session,
		bool	offer_session_ticket,
		std::string_view	next_protocol )

Definition at line 97 of file msg_server_hello_12.cpp.

                                                               :
      Server_Hello_12(std::make_unique<Server_Hello_Internal>(resumed_session.version(),
                                                              client_hello.session_id(),
                                                              make_hello_random(rng, cb, policy),
                                                              resumed_session.ciphersuite_code(),
                                                              uint8_t(0))) {
   // NOLINTBEGIN(*-owning-memory)
   if(client_hello.supports_extended_master_secret()) {
      m_data->extensions().add(new Extended_Master_Secret);
   }
 
   if(!next_protocol.empty() && client_hello.supports_alpn()) {
      m_data->extensions().add(new Application_Layer_Protocol_Notification(next_protocol));
   }
 
   if(client_hello.supports_encrypt_then_mac() && policy.negotiate_encrypt_then_mac()) {
      const Ciphersuite c = resumed_session.ciphersuite();
      if(c.cbc_ciphersuite()) {
         m_data->extensions().add(new Encrypt_then_MAC);
      }
   }
 
   if(resumed_session.ciphersuite().ecc_ciphersuite() &&
      client_hello.extension_types().contains(Extension_Code::EcPointFormats)) {
      m_data->extensions().add(new Supported_Point_Formats(policy.use_ecc_point_compression()));
   }
 
   if(client_hello.secure_renegotiation()) {
      m_data->extensions().add(new Renegotiation_Extension(reneg_info));
   }
 
   if(client_hello.supports_session_ticket() && offer_session_ticket) {
      m_data->extensions().add(new Session_Ticket_Extension());
   }
   // NOLINTEND(*-owning-memory)
 
   cb.tls_modify_extensions(m_data->extensions(), Connection_Side::Server, type());
 
   hash.update(io.send(*this));
}

References Botan::TLS::make_hello_random(), Botan::TLS::Policy::negotiate_encrypt_then_mac(), next_protocol(), Server_Hello_12(), Botan::TLS::Server_Hello::session_id(), Botan::TLS::Client_Hello::supports_alpn(), Botan::TLS::Client_Hello_12::supports_encrypt_then_mac(), and Botan::TLS::Client_Hello_12::supports_extended_master_secret().

Server_Hello_12() [3/3]

Botan::TLS::Server_Hello_12::Server_Hello_12 ( const std::vector< uint8_t > & buf )

explicit

Definition at line 147 of file msg_server_hello_12.cpp.

                                                              :
      Server_Hello_12(std::make_unique<Server_Hello_Internal>(buf)) {}

References Server_Hello_12().

Member Function Documentation

ciphersuite()

uint16_t Botan::TLS::Server_Hello::ciphersuite ( ) const

inherited

Definition at line 145 of file msg_server_hello.cpp.

                                         {
   return m_data->ciphersuite();
}

References m_data.

Referenced by Botan::TLS::Client_Hello_13::retry(), Botan::TLS::Server_Hello_12::Server_Hello_12(), and ~Server_Hello().

compression_method()

uint8_t Botan::TLS::Server_Hello::compression_method

(

)

const

Definition at line 198 of file msg_server_hello.cpp.

                                               {
   return m_data->comp_method();
}

extension_types()

std::set< Extension_Code > Botan::TLS::Server_Hello::extension_types

(

)

const

Definition at line 196 of file msg_server_hello.cpp.

                                                           {
   return m_data->extensions().extension_types();
}

extensions()

const Extensions & Botan::TLS::Server_Hello::extensions ( ) const

inherited

Definition at line 153 of file msg_server_hello.cpp.

                                                 {
   return m_data->extensions();
}

References m_data.

Referenced by Botan::TLS::Server_Hello_13::basic_validation(), Botan::TLS::Client_Hello_13::retry(), Botan::TLS::Server_Hello_13::Server_Hello_13(), Botan::TLS::Server_Hello_13::Server_Hello_13(), and ~Server_Hello().

legacy_version()

Protocol_Version Botan::TLS::Server_Hello::legacy_version

(

)

const

Definition at line 199 of file msg_server_hello.cpp.

                                                    {
   return m_data->legacy_version();
}

next_protocol()

std::string Botan::TLS::Server_Hello_12::next_protocol

(

)

const

Definition at line 191 of file msg_server_hello_12.cpp.

                                               {
   if(auto* alpn = m_data->extensions().get<Application_Layer_Protocol_Notification>()) {
      return alpn->single_protocol();
   }
   return "";
}

References Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_12(), and Server_Hello_12().

prefers_compressed_ec_points()

bool Botan::TLS::Server_Hello_12::prefers_compressed_ec_points

(

)

const

Definition at line 198 of file msg_server_hello_12.cpp.

                                                         {
   if(auto* ecc_formats = m_data->extensions().get<Supported_Point_Formats>()) {
      return ecc_formats->prefers_compressed();
   }
   return false;
}

References Botan::TLS::Server_Hello::m_data.

random()

const std::vector< uint8_t > & Botan::TLS::Server_Hello::random

(

)

const

Definition at line 197 of file msg_server_hello.cpp.

                                                     {
   return m_data->random();
}

random_signals_downgrade()

std::optional< Protocol_Version > Botan::TLS::Server_Hello_12_Shim::random_signals_downgrade ( ) const

inherited

Return desired downgrade version indicated by hello random, if any.

Definition at line 171 of file msg_server_hello.cpp.

                                                                                   {
   const uint64_t last8 = load_be<uint64_t>(m_data->random().data(), 3);
   if(last8 == DOWNGRADE_TLS11) {
      return Protocol_Version::TLS_V11;
   }
   if(last8 == DOWNGRADE_TLS12) {
      return Protocol_Version::TLS_V12;
   }
 
   return std::nullopt;
}

References Botan::TLS::DOWNGRADE_TLS11, Botan::TLS::DOWNGRADE_TLS12, Botan::load_be(), and Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_13.

renegotiation_info()

std::vector< uint8_t > Botan::TLS::Server_Hello_12::renegotiation_info

(

)

const

Definition at line 156 of file msg_server_hello_12.cpp.

                                                             {
   if(const Renegotiation_Extension* reneg = m_data->extensions().get<Renegotiation_Extension>()) {
      return reneg->renegotiation_info();
   }
   return std::vector<uint8_t>();
}

References Botan::TLS::Server_Hello::m_data.

Referenced by Botan::TLS::Channel_Impl_12::secure_renegotiation_check().

secure_renegotiation()

bool Botan::TLS::Server_Hello_12::secure_renegotiation

(

)

const

Definition at line 152 of file msg_server_hello_12.cpp.

                                                 {
   return m_data->extensions().has<Renegotiation_Extension>();
}

References Botan::TLS::Server_Hello::m_data.

Referenced by Botan::TLS::Channel_Impl_12::secure_renegotiation_check().

selected_version()

Protocol_Version Botan::TLS::Server_Hello_12_Shim::selected_version ( ) const

finalvirtualinherited

Returns

the selected version as indicated in the legacy_version field

Implements Botan::TLS::Server_Hello.

Definition at line 167 of file msg_server_hello.cpp.

                                                              {
   return legacy_version();
}

References Botan::TLS::Server_Hello::legacy_version().

Referenced by Server_Hello_13.

serialize()

std::vector< uint8_t > Botan::TLS::Server_Hello::serialize ( ) const

overridevirtualinherited

Returns

DER representation of this message

Implements Botan::TLS::Handshake_Message.

Definition at line 105 of file msg_server_hello.cpp.

                                                 {
   std::vector<uint8_t> buf;
   buf.reserve(1024);  // working around GCC warning
 
   buf.push_back(m_data->legacy_version().major_version());
   buf.push_back(m_data->legacy_version().minor_version());
   buf += m_data->random();
 
   append_tls_length_value(buf, m_data->session_id().get(), 1);
 
   buf.push_back(get_byte<0>(m_data->ciphersuite()));
   buf.push_back(get_byte<1>(m_data->ciphersuite()));
 
   buf.push_back(m_data->comp_method());
 
   buf += m_data->extensions().serialize(Connection_Side::Server);
 
   return buf;
}

References Botan::TLS::append_tls_length_value(), Botan::get_byte(), m_data, serialize(), Botan::TLS::Server, and Server_Hello().

Referenced by serialize(), and ~Server_Hello().

session_id()

const Session_ID & Botan::TLS::Server_Hello::session_id ( ) const

inherited

Definition at line 141 of file msg_server_hello.cpp.

                                                 {
   return m_data->session_id();
}

References m_data.

Referenced by Botan::TLS::Hello_Retry_Request::Hello_Retry_Request(), Botan::TLS::Server_Hello_12::Server_Hello_12(), Botan::TLS::Server_Hello_12::Server_Hello_12(), Botan::TLS::Server_Hello_13::Server_Hello_13(), and ~Server_Hello().

srtp_profile()

uint16_t Botan::TLS::Server_Hello_12::srtp_profile

(

)

const

Definition at line 179 of file msg_server_hello_12.cpp.

                                             {
   if(auto* srtp = m_data->extensions().get<SRTP_Protection_Profiles>()) {
      auto prof = srtp->profiles();
      if(prof.size() != 1 || prof[0] == 0) {
         throw Decoding_Error("Server sent malformed DTLS-SRTP extension");
      }
      return prof[0];
   }
 
   return 0;
}

References Botan::TLS::Server_Hello::m_data.

supports_certificate_status_message()

bool Botan::TLS::Server_Hello_12::supports_certificate_status_message

(

)

const

Definition at line 171 of file msg_server_hello_12.cpp.

                                                                {
   return m_data->extensions().has<Certificate_Status_Request>();
}

References Botan::TLS::Server_Hello::m_data.

supports_encrypt_then_mac()

bool Botan::TLS::Server_Hello_12::supports_encrypt_then_mac

(

)

const

Definition at line 167 of file msg_server_hello_12.cpp.

                                                      {
   return m_data->extensions().has<Encrypt_then_MAC>();
}

References Botan::TLS::Server_Hello::m_data.

supports_extended_master_secret()

bool Botan::TLS::Server_Hello_12::supports_extended_master_secret

(

)

const

Definition at line 163 of file msg_server_hello_12.cpp.

                                                            {
   return m_data->extensions().has<Extended_Master_Secret>();
}

References Botan::TLS::Server_Hello::m_data.

supports_session_ticket()

bool Botan::TLS::Server_Hello_12::supports_session_ticket

(

)

const

Definition at line 175 of file msg_server_hello_12.cpp.

                                                    {
   return m_data->extensions().has<Session_Ticket_Extension>();
}

References Botan::TLS::Server_Hello::m_data.

type()

Handshake_Type Botan::TLS::Server_Hello::type ( ) const

overridevirtualinherited

Returns

the message type

Implements Botan::TLS::Handshake_Message.

Definition at line 125 of file msg_server_hello.cpp.

                                        {
   return Handshake_Type::ServerHello;
}

References Botan::TLS::ServerHello.

Referenced by ~Server_Hello().

type_string()

std::string Botan::TLS::Handshake_Message::type_string ( ) const

inherited

Returns

string representation of this message type

Definition at line 21 of file tls_handshake_state.cpp.

                                               {
   return handshake_type_to_string(type());
}

References Botan::TLS::handshake_type_to_string(), and type().

wire_type()

virtual Handshake_Type Botan::TLS::Handshake_Message::wire_type ( ) const

inlinevirtualinherited

Returns

the wire representation of the message's type

Reimplemented in Botan::TLS::Hello_Retry_Request.

Definition at line 39 of file tls_handshake_msg.h.

                                               {
         // Usually equal to the Handshake_Type enum value,
         // with the exception of TLS 1.3 Hello Retry Request.
         return type();
      }

References type().

Referenced by Botan::TLS::Stream_Handshake_IO::send().

Member Data Documentation

m_data

std::unique_ptr<Server_Hello_Internal> Botan::TLS::Server_Hello::m_data

protectedinherited

Definition at line 202 of file tls_messages.h.

Referenced by Botan::TLS::Server_Hello_13::basic_validation(), ciphersuite(), compression_method(), extension_types(), extensions(), Botan::TLS::Hello_Retry_Request::Hello_Retry_Request(), legacy_version(), Botan::TLS::Server_Hello_12::next_protocol(), Botan::TLS::Server_Hello_12::prefers_compressed_ec_points(), random(), Botan::TLS::Server_Hello_12_Shim::random_signals_downgrade(), Botan::TLS::Server_Hello_13::random_signals_downgrade(), Botan::TLS::Server_Hello_12::renegotiation_info(), Botan::TLS::Server_Hello_12::secure_renegotiation(), Botan::TLS::Server_Hello_13::selected_version(), serialize(), Server_Hello(), Botan::TLS::Server_Hello_12::Server_Hello_12(), Botan::TLS::Server_Hello_12_Shim::Server_Hello_12_Shim(), Botan::TLS::Server_Hello_13::Server_Hello_13(), Botan::TLS::Server_Hello_13::Server_Hello_13(), Botan::TLS::Server_Hello_13::Server_Hello_13(), session_id(), Botan::TLS::Server_Hello_12::srtp_profile(), Botan::TLS::Server_Hello_12::supports_certificate_status_message(), Botan::TLS::Server_Hello_12::supports_encrypt_then_mac(), Botan::TLS::Server_Hello_12::supports_extended_master_secret(), and Botan::TLS::Server_Hello_12::supports_session_ticket().

---

The documentation for this class was generated from the following files:

• src/lib/tls/tls12/tls_messages_12.h
• src/lib/tls/tls12/msg_server_hello_12.cpp