Botan::TLS::New_Session_Ticket_13 Class Reference

#include <tls_messages.h>

Inheritance diagram for Botan::TLS::New_Session_Ticket_13:

Public Member Functions
std::optional< uint32_t >	early_data_byte_limit () const
const Extensions &	extensions () const
const Opaque_Session_Handle &	handle () const
std::chrono::seconds	lifetime_hint () const
	New_Session_Ticket_13 (const std::vector< uint8_t > &buf, Connection_Side from)
	New_Session_Ticket_13 (Ticket_Nonce nonce, const Session &session, const Session_Handle &handle, Callbacks &callbacks)
const Ticket_Nonce &	nonce () const
std::vector< uint8_t >	serialize () const override
uint32_t	ticket_age_add () const
Handshake_Type	type () const override
std::string	type_string () const
virtual Handshake_Type	wire_type () const

Detailed Description

Definition at line 968 of file tls_messages.h.

Constructor & Destructor Documentation

New_Session_Ticket_13() [1/2]

Botan::TLS::New_Session_Ticket_13::New_Session_Ticket_13	(	Ticket_Nonce	nonce,
		const Session &	session,
		const Session_Handle &	handle,
		Callbacks &	callbacks )

Definition at line 69 of file msg_session_ticket.cpp.

                                                                   :
      m_ticket_lifetime_hint(session.lifetime_hint()),
      m_ticket_age_add(session.session_age_add()),
      m_ticket_nonce(std::move(nonce)),
      m_handle(handle.opaque_handle()) {
   callbacks.tls_modify_extensions(m_extensions, Connection_Side::Server, type());
}

References Botan::TLS::Server, Botan::TLS::Callbacks::tls_modify_extensions(), and type().

New_Session_Ticket_13() [2/2]

Botan::TLS::New_Session_Ticket_13::New_Session_Ticket_13	(	const std::vector< uint8_t > &	buf,
		Connection_Side	from )

Definition at line 80 of file msg_session_ticket.cpp.

                                                                                                {
   TLS_Data_Reader reader("New_Session_Ticket_13", buf);
 
   m_ticket_lifetime_hint = std::chrono::seconds(reader.get_uint32_t());
 
   // RFC 8446 4.6.1
   //    Servers MUST NOT use any value [of ticket_lifetime] greater than 604800
   //    seconds (7 days).
   if(m_ticket_lifetime_hint > std::chrono::days(7)) {
      throw TLS_Exception(Alert::IllegalParameter, "Received a session ticket with lifetime longer than one week.");
   }
 
   m_ticket_age_add = reader.get_uint32_t();
   m_ticket_nonce = Ticket_Nonce(reader.get_tls_length_value(1));
   m_handle = Opaque_Session_Handle(reader.get_tls_length_value(2));
 
   m_extensions.deserialize(reader, from, type());
 
   // RFC 8446 4.6.1
   //    The sole extension currently defined for NewSessionTicket is
   //    "early_data", indicating that the ticket may be used to send 0-RTT
   //    data [...]. Clients MUST ignore unrecognized extensions.
   if(m_extensions.contains_implemented_extensions_other_than({Extension_Code::EarlyData})) {
      throw TLS_Exception(Alert::IllegalParameter, "NewSessionTicket message contained unexpected extension");
   }
 
   reader.assert_done();
}

References Botan::TLS::TLS_Data_Reader::assert_done(), Botan::TLS::Extensions::contains_implemented_extensions_other_than(), Botan::TLS::Extensions::deserialize(), Botan::TLS::TLS_Data_Reader::get_tls_length_value(), Botan::TLS::TLS_Data_Reader::get_uint32_t(), and type().

Member Function Documentation

early_data_byte_limit()

std::optional< uint32_t > Botan::TLS::New_Session_Ticket_13::early_data_byte_limit

(

)

const

Returns

the number of bytes allowed for early data or std::nullopt when early data is not allowed at all

Definition at line 109 of file msg_session_ticket.cpp.

                                                                         {
   if(!m_extensions.has<EarlyDataIndication>()) {
      return std::nullopt;
   }
 
   const EarlyDataIndication* ext = m_extensions.get<EarlyDataIndication>();
   BOTAN_ASSERT_NOMSG(ext->max_early_data_size().has_value());
   return ext->max_early_data_size().value();
}

References BOTAN_ASSERT_NOMSG, Botan::TLS::Extensions::get(), Botan::TLS::Extensions::has(), and Botan::TLS::EarlyDataIndication::max_early_data_size().

extensions()

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

inline

Definition at line 981 of file tls_messages.h.

{ return m_extensions; }

handle()

const Opaque_Session_Handle & Botan::TLS::New_Session_Ticket_13::handle ( ) const

inline

Definition at line 983 of file tls_messages.h.

{ return m_handle; }

lifetime_hint()

std::chrono::seconds Botan::TLS::New_Session_Ticket_13::lifetime_hint ( ) const

inline

Definition at line 989 of file tls_messages.h.

{ return m_ticket_lifetime_hint; }

nonce()

const Ticket_Nonce & Botan::TLS::New_Session_Ticket_13::nonce ( ) const

inline

Definition at line 985 of file tls_messages.h.

{ return m_ticket_nonce; }

serialize()

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

overridevirtual

Returns

DER representation of this message

Implements Botan::TLS::Handshake_Message.

Definition at line 119 of file msg_session_ticket.cpp.

                                                          {
   std::vector<uint8_t> result(8);
 
   store_lifetime(std::span(result.data(), 4), m_ticket_lifetime_hint);
   store_be(m_ticket_age_add, result.data() + 4);
   append_tls_length_value(result, m_ticket_nonce.get(), 1);
   append_tls_length_value(result, m_handle.get(), 2);
 
   // TODO: re-evaluate this construction when reworking message marshalling
   if(m_extensions.empty()) {
      result.push_back(0x00);
      result.push_back(0x00);
   } else {
      result += m_extensions.serialize(Connection_Side::Server);
   }
 
   return result;
}

References Botan::TLS::append_tls_length_value(), Botan::TLS::Extensions::empty(), Botan::detail::Strong_Base< T >::get(), Botan::TLS::Extensions::serialize(), Botan::TLS::Server, and Botan::store_be().

ticket_age_add()

uint32_t Botan::TLS::New_Session_Ticket_13::ticket_age_add ( ) const

inline

Definition at line 987 of file tls_messages.h.

{ return m_ticket_age_add; }

type()

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

inlineoverridevirtual

Returns

the message type

Implements Botan::TLS::Handshake_Message.

Definition at line 970 of file tls_messages.h.

{ return Handshake_Type::NewSessionTicket; }

Referenced by New_Session_Ticket_13(), and New_Session_Ticket_13().

type_string()

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

inherited

Returns

string representation of this message type

Definition at line 19 of file tls_handshake_state.cpp.

                                               {
   return handshake_type_to_string(type());
}

References Botan::TLS::handshake_type_to_string(), and Botan::TLS::Handshake_Message::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();
      }

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

---

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

• src/lib/tls/tls_messages.h
• src/lib/tls/msg_session_ticket.cpp