#include <tls_extensions_13.h>

Inheritance diagram for Botan::TLS::Cookie:

Public Member Functions
	Cookie (std::vector< uint8_t > cookie)
	Cookie (TLS_Data_Reader &reader, uint16_t extension_size)
bool	empty () const override
const std::vector< uint8_t > &	get_cookie () const
virtual bool	is_implemented () const
std::vector< uint8_t >	serialize (Connection_Side whoami) const override
Extension_Code	type () const override

Static Public Member Functions
static Extension_Code	static_type ()

Detailed Description

Cookie from RFC 8446 4.2.2

Definition at line 42 of file tls_extensions_13.h.

Constructor & Destructor Documentation

◆ Cookie() [1/2]

Botan::TLS::Cookie::Cookie ( std::vector< uint8_t > cookie )

explicit

Definition at line 24 of file tls_extensions_13.cpp.

24: m_cookie(std::move(cookie)) {}

◆ Cookie() [2/2]

Botan::TLS::Cookie::Cookie	(	TLS_Data_Reader &	reader,
		uint16_t	extension_size )

explicit

Definition at line 26 of file tls_extensions_13.cpp.

                                                               {
   // RFC 8446 4.2.2
   //    struct {
   //       opaque cookie<1..2^16-1>;
   //    } Cookie;
   //
   // The wire form requires a 2-byte length field plus at least one byte of
   // cookie data, so the minimum extension size is 3 bytes.
   if(extension_size < 3) {
      throw Decoding_Error("Empty cookie extension is illegal");
   }
 
   const uint16_t len = reader.get_uint16_t();
 
   if(static_cast<size_t>(len) + 2 != extension_size) {
      throw Decoding_Error("Inconsistent length in cookie extension");
   }
 
   m_cookie = reader.get_fixed<uint8_t>(len);
}

References Botan::TLS::TLS_Data_Reader::get_fixed(), and Botan::TLS::TLS_Data_Reader::get_uint16_t().

Member Function Documentation

◆ empty()

bool Botan::TLS::Cookie::empty ( ) const

inlineoverridevirtual

Predicate if a TLS extension should be included or not

Returns: true if this extension should be encoded, otherwise false

Implements Botan::TLS::Extension.

Definition at line 50 of file tls_extensions_13.h.

50{ return m_cookie.empty(); }

◆ get_cookie()

const std::vector< uint8_t > & Botan::TLS::Cookie::get_cookie ( ) const

inline

Definition at line 52 of file tls_extensions_13.h.

52{ return m_cookie; }

Referenced by Botan::TLS::Client_Hello_13::retry().

◆ is_implemented()

virtual bool Botan::TLS::Extension::is_implemented ( ) const

inlinevirtualinherited

Predicate if the extension is known/implemented

Note: this exists primarily to support unknown extension handling and doesn't need to be overridden even in the custom extension case.

Returns: true if this extension is known

Reimplemented in Botan::TLS::Unknown_Extension.

Definition at line 113 of file tls_extensions.h.

113{ return true; }

◆ serialize()

std::vector< uint8_t > Botan::TLS::Cookie::serialize ( Connection_Side whoami ) const

overridevirtual

Serialize a TLS extension

Parameters

whoami which peer we are acting as in the protocol

Returns: serialized binary for the extension

Implements Botan::TLS::Extension.

Definition at line 47 of file tls_extensions_13.cpp.

                                                            {
   std::vector<uint8_t> buf;
   append_tls_length_value(buf, m_cookie, 2);
   return buf;
}