Botan::TLS::Server_Hello_12_Shim Class Reference

#include <tls_messages.h>

Inheritance diagram for Botan::TLS::Server_Hello_12_Shim:

Public Member Functions
uint16_t	ciphersuite () const
const Extensions &	extensions () const
std::optional< Protocol_Version >	random_signals_downgrade () const
Protocol_Version	selected_version () const final
std::vector< uint8_t >	serialize () const override
	Server_Hello_12_Shim (const std::vector< uint8_t > &buf)
const Session_ID &	session_id () const
Handshake_Type	type () const override
std::string	type_string () const
virtual Handshake_Type	wire_type () const

Protected Member Functions
uint8_t	compression_method () const
std::set< Extension_Code >	extension_types () const
Protocol_Version	legacy_version () const
const std::vector< uint8_t > &	random () const
	Server_Hello_12_Shim (std::unique_ptr< Server_Hello_Internal > data)

Protected Attributes
std::unique_ptr< Server_Hello_Internal >	m_data

Friends
class	Server_Hello_13

Detailed Description

Basic implementation of Server_Hello from TLS 1.2. The full implementation is in Server_Hello_12 in the tls12 module. This is meant to be used by the TLS 1.3 implementation to parse, validate and understand a downgrade request.

Definition at line 210 of file tls_messages.h.

Constructor & Destructor Documentation

Server_Hello_12_Shim() [1/2]

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

explicit

Definition at line 157 of file msg_server_hello.cpp.

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

References Server_Hello_12_Shim().

Referenced by Server_Hello_12_Shim(), and Server_Hello_13.

Server_Hello_12_Shim() [2/2]

Botan::TLS::Server_Hello_12_Shim::Server_Hello_12_Shim ( std::unique_ptr< Server_Hello_Internal > data )

explicitprotected

Definition at line 160 of file msg_server_hello.cpp.

                                                                                    :
      Server_Hello(std::move(data)) {
   if(!m_data->version().is_pre_tls_13()) {
      throw TLS_Exception(Alert::ProtocolVersion, "Expected server hello of (D)TLS 1.2 or lower");
   }
}

References Botan::TLS::Server_Hello::m_data, and Botan::TLS::Server_Hello::Server_Hello().

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

protectedinherited

Definition at line 137 of file msg_server_hello.cpp.

                                               {
   return m_data->comp_method();
}

References m_data.

Referenced by Botan::TLS::Server_Hello_13::basic_validation(), and selected_version().

extension_types()

std::set< Extension_Code > Botan::TLS::Server_Hello::extension_types ( ) const

protectedinherited

Definition at line 149 of file msg_server_hello.cpp.

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

References m_data.

Referenced by selected_version().

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

protectedinherited

Definition at line 129 of file msg_server_hello.cpp.

                                                    {
   return m_data->legacy_version();
}

References m_data.

Referenced by Botan::TLS::Server_Hello_13::basic_validation(), selected_version(), and Botan::TLS::Server_Hello_12_Shim::selected_version().

random()

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

protectedinherited

Definition at line 133 of file msg_server_hello.cpp.

                                                     {
   return m_data->random();
}

References m_data.

Referenced by selected_version().

random_signals_downgrade()

std::optional< Protocol_Version > Botan::TLS::Server_Hello_12_Shim::random_signals_downgrade

(

)

const

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.

selected_version()

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

finalvirtual

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().

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().

Friends And Related Symbol Documentation

Server_Hello_13

friend class Server_Hello_13

friend

Definition at line 215 of file tls_messages.h.

References random_signals_downgrade(), selected_version(), Server_Hello_12_Shim(), and Server_Hello_13.

Referenced by Server_Hello_13.

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/tls_messages.h
• src/lib/tls/msg_server_hello.cpp