Botan 3.6.1
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::TLS::TLS_Data_Reader Class Referencefinal

#include <tls_reader.h>

Public Member Functions

void assert_done () const
 
void discard_next (size_t bytes)
 
uint8_t get_byte ()
 
std::vector< uint8_t > get_data_read_so_far ()
 
template<typename T , typename Container >
Container get_elem (size_t num_elems)
 
template<typename T >
std::vector< T > get_fixed (size_t size)
 
template<typename T >
std::vector< T > get_range (size_t len_bytes, size_t min_elems, size_t max_elems)
 
template<typename T >
std::vector< T > get_range_vector (size_t len_bytes, size_t min_elems, size_t max_elems)
 
std::vector< uint8_t > get_remaining ()
 
std::string get_string (size_t len_bytes, size_t min_bytes, size_t max_bytes)
 
std::vector< uint8_t > get_tls_length_value (size_t len_bytes)
 
uint16_t get_uint16_t ()
 
uint32_t get_uint24_t ()
 
uint32_t get_uint32_t ()
 
bool has_remaining () const
 
uint16_t peek_uint16_t () const
 
size_t read_so_far () const
 
size_t remaining_bytes () const
 
 TLS_Data_Reader (const char *type, std::span< const uint8_t > buf_in)
 

Detailed Description

Helper class for decoding TLS protocol messages

Definition at line 24 of file tls_reader.h.

Constructor & Destructor Documentation

◆ TLS_Data_Reader()

Botan::TLS::TLS_Data_Reader::TLS_Data_Reader ( const char * type,
std::span< const uint8_t > buf_in )
inline

Definition at line 26 of file tls_reader.h.

26 :
27 m_typename(type), m_buf(buf_in), m_offset(0) {}

Member Function Documentation

◆ assert_done()

void Botan::TLS::TLS_Data_Reader::assert_done ( ) const
inline

Definition at line 29 of file tls_reader.h.

29 {
30 if(has_remaining()) {
31 throw_decode_error("Extra bytes at end of message");
32 }
33 }
Botan::TLS::TLS_Data_Reader::has_remaining
bool has_remaining() const
Definition tls_reader.h:39

References has_remaining().

Referenced by Botan::TLS::Certificate_Verify::Certificate_Verify(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::New_Session_Ticket_12::New_Session_Ticket_12(), Botan::TLS::New_Session_Ticket_13::New_Session_Ticket_13(), and Botan::TLS::Server_Key_Exchange::Server_Key_Exchange().

◆ discard_next()

void Botan::TLS::TLS_Data_Reader::discard_next ( size_t bytes)
inline

Definition at line 47 of file tls_reader.h.

47 {
48 assert_at_least(bytes);
49 m_offset += bytes;
50 }

Referenced by Botan::TLS::Server_Name_Indicator::Server_Name_Indicator(), and Botan::TLS::Supported_Point_Formats::Supported_Point_Formats().

◆ get_byte()

uint8_t Botan::TLS::TLS_Data_Reader::get_byte ( )
inline

Definition at line 78 of file tls_reader.h.

78 {
79 assert_at_least(1);
80 uint8_t result = m_buf[m_offset];
81 m_offset += 1;
82 return result;
83 }

Referenced by Botan::TLS::Certificate_Type_Base::Certificate_Type_Base(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Cookie::Cookie(), Botan::TLS::PSK_Key_Exchange_Modes::PSK_Key_Exchange_Modes(), Botan::TLS::Server_Key_Exchange::Server_Key_Exchange(), Botan::TLS::Server_Name_Indicator::Server_Name_Indicator(), and Botan::TLS::Supported_Point_Formats::Supported_Point_Formats().

◆ get_data_read_so_far()

std::vector< uint8_t > Botan::TLS::TLS_Data_Reader::get_data_read_so_far ( )
inline

Definition at line 43 of file tls_reader.h.

43 {
44 return std::vector<uint8_t>(m_buf.begin(), m_buf.begin() + m_offset);
45 }

◆ get_elem()

template<typename T , typename Container >
Container Botan::TLS::TLS_Data_Reader::get_elem ( size_t num_elems)
inline

Definition at line 86 of file tls_reader.h.

86 {
87 assert_at_least(num_elems * sizeof(T));
88
89 Container result(num_elems);
90
91 for(size_t i = 0; i != num_elems; ++i) {
92 result[i] = load_be<T>(&m_buf[m_offset], i);
93 }
94
95 m_offset += num_elems * sizeof(T);
96
97 return result;
98 }
T
FE_25519 T
Definition ge.cpp:34
Botan::load_be
constexpr auto load_be(ParamTs &&... params)
Definition loadstor.h:530

References Botan::load_be(), and T.

Referenced by get_fixed(), get_range(), and get_range_vector().

◆ get_fixed()

template<typename T >
std::vector< T > Botan::TLS::TLS_Data_Reader::get_fixed ( size_t size)
inline

Definition at line 125 of file tls_reader.h.

125 {
126 return get_elem<T, std::vector<T>>(size);
127 }
Botan::TLS::TLS_Data_Reader::get_elem
Container get_elem(size_t num_elems)
Definition tls_reader.h:86

References get_elem().

Referenced by Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry(), Botan::TLS::Certificate_Status_Request::Certificate_Status_Request(), Botan::TLS::Extensions::deserialize(), get_tls_length_value(), and Botan::TLS::Supported_Point_Formats::Supported_Point_Formats().

◆ get_range()

template<typename T >
std::vector< T > Botan::TLS::TLS_Data_Reader::get_range ( size_t len_bytes,
size_t min_elems,
size_t max_elems )
inline

Definition at line 105 of file tls_reader.h.

105 {
106 const size_t num_elems = get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
107
108 return get_elem<T, std::vector<T>>(num_elems);
109 }

References get_elem(), and T.

Referenced by Botan::TLS::Certificate_13::Certificate_13(), Botan::TLS::Certificate_Verify::Certificate_Verify(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::New_Session_Ticket_12::New_Session_Ticket_12(), Botan::TLS::Server_Key_Exchange::Server_Key_Exchange(), Botan::TLS::SRTP_Protection_Profiles::SRTP_Protection_Profiles(), and Botan::TLS::Supported_Versions::Supported_Versions().

◆ get_range_vector()

template<typename T >
std::vector< T > Botan::TLS::TLS_Data_Reader::get_range_vector ( size_t len_bytes,
size_t min_elems,
size_t max_elems )
inline

Definition at line 112 of file tls_reader.h.

112 {
113 const size_t num_elems = get_num_elems(len_bytes, sizeof(T), min_elems, max_elems);
114
115 return get_elem<T, std::vector<T>>(num_elems);
116 }

References get_elem(), and T.

Referenced by Botan::TLS::Certificate_Request_12::Certificate_Request_12(), and get_string().

◆ get_remaining()

std::vector< uint8_t > Botan::TLS::TLS_Data_Reader::get_remaining ( )
inline

Definition at line 41 of file tls_reader.h.

41{ return std::vector<uint8_t>(m_buf.begin() + m_offset, m_buf.end()); }

◆ get_string()

std::string Botan::TLS::TLS_Data_Reader::get_string ( size_t len_bytes,
size_t min_bytes,
size_t max_bytes )
inline

Definition at line 118 of file tls_reader.h.

118 {
119 std::vector<uint8_t> v = get_range_vector<uint8_t>(len_bytes, min_bytes, max_bytes);
120
121 return std::string(cast_uint8_ptr_to_char(v.data()), v.size());
122 }
Botan::TLS::TLS_Data_Reader::get_range_vector
std::vector< T > get_range_vector(size_t len_bytes, size_t min_elems, size_t max_elems)
Definition tls_reader.h:112
Botan::cast_uint8_ptr_to_char
const char * cast_uint8_ptr_to_char(const uint8_t *b)
Definition mem_ops.h:277

References Botan::cast_uint8_ptr_to_char(), and get_range_vector().

Referenced by Botan::TLS::Application_Layer_Protocol_Notification::Application_Layer_Protocol_Notification(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Server_Key_Exchange::Server_Key_Exchange(), and Botan::TLS::Server_Name_Indicator::Server_Name_Indicator().

◆ get_tls_length_value()

std::vector< uint8_t > Botan::TLS::TLS_Data_Reader::get_tls_length_value ( size_t len_bytes)
inline

Definition at line 100 of file tls_reader.h.

100 {
101 return get_fixed<uint8_t>(get_length_field(len_bytes));
102 }
Botan::TLS::TLS_Data_Reader::get_fixed
std::vector< T > get_fixed(size_t size)
Definition tls_reader.h:125

References get_fixed().

Referenced by Botan::TLS::Certificate_Authorities::Certificate_Authorities(), Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry(), Botan::TLS::Certificate_Request_13::Certificate_Request_13(), Botan::TLS::Certificate_Type_Base::Certificate_Type_Base(), Botan::TLS::New_Session_Ticket_13::New_Session_Ticket_13(), and Botan::TLS::PSK::PSK().

◆ get_uint16_t()

uint16_t Botan::TLS::TLS_Data_Reader::get_uint16_t ( )
inline

Definition at line 66 of file tls_reader.h.

66 {
67 assert_at_least(2);
68 uint16_t result = make_uint16(m_buf[m_offset], m_buf[m_offset + 1]);
69 m_offset += 2;
70 return result;
71 }
Botan::make_uint16
constexpr uint16_t make_uint16(uint8_t i0, uint8_t i1)
Definition loadstor.h:88

References Botan::make_uint16().

Referenced by Botan::TLS::Application_Layer_Protocol_Notification::Application_Layer_Protocol_Notification(), Botan::TLS::Certificate_Authorities::Certificate_Authorities(), Botan::TLS::Certificate_Request_12::Certificate_Request_12(), Botan::TLS::Certificate_Verify::Certificate_Verify(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Cookie::Cookie(), Botan::TLS::Extensions::deserialize(), Botan::TLS::PSK::PSK(), Botan::TLS::Record_Size_Limit::Record_Size_Limit(), Botan::TLS::Server_Key_Exchange::Server_Key_Exchange(), Botan::TLS::Server_Name_Indicator::Server_Name_Indicator(), Botan::TLS::Supported_Groups::Supported_Groups(), and Botan::TLS::Supported_Versions::Supported_Versions().

◆ get_uint24_t()

uint32_t Botan::TLS::TLS_Data_Reader::get_uint24_t ( )
inline

Definition at line 59 of file tls_reader.h.

59 {
60 assert_at_least(3);
61 uint32_t result = make_uint32(0, m_buf[m_offset], m_buf[m_offset + 1], m_buf[m_offset + 2]);
62 m_offset += 3;
63 return result;
64 }
Botan::make_uint32
constexpr uint32_t make_uint32(uint8_t i0, uint8_t i1, uint8_t i2, uint8_t i3)
Definition loadstor.h:100

References Botan::make_uint32().

Referenced by Botan::TLS::Certificate_13::Certificate_13().

◆ get_uint32_t()

uint32_t Botan::TLS::TLS_Data_Reader::get_uint32_t ( )
inline

Definition at line 52 of file tls_reader.h.

52 {
53 assert_at_least(4);
54 uint32_t result = make_uint32(m_buf[m_offset], m_buf[m_offset + 1], m_buf[m_offset + 2], m_buf[m_offset + 3]);
55 m_offset += 4;
56 return result;
57 }

References Botan::make_uint32().

Referenced by Botan::TLS::EarlyDataIndication::EarlyDataIndication(), Botan::TLS::New_Session_Ticket_12::New_Session_Ticket_12(), Botan::TLS::New_Session_Ticket_13::New_Session_Ticket_13(), and Botan::TLS::PSK::PSK().

◆ has_remaining()

bool Botan::TLS::TLS_Data_Reader::has_remaining ( ) const
inline

Definition at line 39 of file tls_reader.h.

39{ return (remaining_bytes() > 0); }
Botan::TLS::TLS_Data_Reader::remaining_bytes
size_t remaining_bytes() const
Definition tls_reader.h:37

References remaining_bytes().

Referenced by assert_done(), Botan::TLS::Certificate_13::Certificate_13(), Botan::TLS::Certificate_Authorities::Certificate_Authorities(), Botan::TLS::Certificate_Request_12::Certificate_Request_12(), Botan::TLS::Extensions::deserialize(), and Botan::TLS::PSK::PSK().

◆ peek_uint16_t()

uint16_t Botan::TLS::TLS_Data_Reader::peek_uint16_t ( ) const
inline

Definition at line 73 of file tls_reader.h.

73 {
74 assert_at_least(2);
75 return make_uint16(m_buf[m_offset], m_buf[m_offset + 1]);
76 }

References Botan::make_uint16().

Referenced by Botan::TLS::Certificate_13::Certificate_Entry::Certificate_Entry().

◆ read_so_far()

size_t Botan::TLS::TLS_Data_Reader::read_so_far ( ) const
inline

Definition at line 35 of file tls_reader.h.

35{ return m_offset; }

Referenced by Botan::TLS::Handshake_Layer::next_message(), Botan::TLS::Handshake_Layer::next_post_handshake_message(), Botan::TLS::PSK::PSK(), and Botan::TLS::Server_Key_Exchange::Server_Key_Exchange().

◆ remaining_bytes()

size_t Botan::TLS::TLS_Data_Reader::remaining_bytes ( ) const
inline

Definition at line 37 of file tls_reader.h.

37{ return m_buf.size() - m_offset; }

Referenced by Botan::TLS::Certificate_13::Certificate_13(), Botan::TLS::Certificate_Authorities::Certificate_Authorities(), Botan::TLS::Certificate_Request_12::Certificate_Request_12(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Cookie::Cookie(), Botan::TLS::Extensions::deserialize(), and has_remaining().

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0