Botan::TLS::Hello_Verify_Request Class Reference

#include <tls_messages.h>

Inheritance diagram for Botan::TLS::Hello_Verify_Request:

Public Member Functions
const std::vector< uint8_t > &	cookie () const
	Hello_Verify_Request (std::span< const uint8_t > buf)
	Hello_Verify_Request (std::span< const uint8_t > client_hello_bits, std::string_view client_identity, std::span< const uint8_t > cookie_secret)
std::vector< uint8_t >	serialize () const override
Handshake_Type	type () const override
std::string	type_string () const
virtual Handshake_Type	wire_type () const

Detailed Description

DTLS Hello Verify Request

Definition at line 55 of file tls_messages.h.

Constructor & Destructor Documentation

Hello_Verify_Request() [1/2]

Botan::TLS::Hello_Verify_Request::Hello_Verify_Request ( std::span< const uint8_t > buf )

explicit

Definition at line 15 of file msg_hello_verify.cpp.

                                                                     {
   if(buf.size() < 3) {
      throw Decoding_Error("Hello verify request too small");
   }
 
   const Protocol_Version version(buf[0], buf[1]);
 
   if(!version.is_datagram_protocol()) {
      throw Decoding_Error("Unknown version from server in hello verify request");
   }
 
   if(static_cast<size_t>(buf[2]) + 3 != buf.size()) {
      throw Decoding_Error("Bad length in hello verify request");
   }
 
   m_cookie.assign(buf.begin() + 3, buf.end());
}

References Botan::TLS::Protocol_Version::is_datagram_protocol().

Hello_Verify_Request() [2/2]

Botan::TLS::Hello_Verify_Request::Hello_Verify_Request	(	std::span< const uint8_t >	client_hello_bits,
		std::string_view	client_identity,
		std::span< const uint8_t >	cookie_secret )

Definition at line 33 of file msg_hello_verify.cpp.

                                                                                 {
   auto hmac = MessageAuthenticationCode::create_or_throw("HMAC(SHA-256)");
   hmac->set_key(cookie_secret);
 
   hmac->update_be(static_cast<uint64_t>(client_hello_bits.size()));
   hmac->update(client_hello_bits);
   hmac->update_be(static_cast<uint64_t>(client_identity.size()));
   hmac->update(client_identity);
 
   m_cookie.resize(hmac->output_length());
   hmac->final(m_cookie.data());
}

References Botan::MessageAuthenticationCode::create_or_throw().

Member Function Documentation

cookie()

const std::vector< uint8_t > & Botan::TLS::Hello_Verify_Request::cookie ( ) const

inline

Definition at line 61 of file tls_messages.h.

{ return m_cookie; }

Referenced by Botan::TLS::Client_Hello_12::update_hello_cookie().

serialize()

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

overridevirtual

Serialize this handshake message

Implements Botan::TLS::Handshake_Message.

Definition at line 48 of file msg_hello_verify.cpp.

                                                         {
   /* DTLS 1.2 server implementations SHOULD use DTLS version 1.0
      regardless of the version of TLS that is expected to be
      negotiated (RFC 6347, section 4.2.1)
   */
 
   const Protocol_Version format_version(254, 255);  // DTLS 1.0
 
   std::vector<uint8_t> bits;
   bits.push_back(format_version.major_version());
   bits.push_back(format_version.minor_version());
   append_tls_length_value(bits, m_cookie, 1);
   return bits;
}

References Botan::TLS::append_tls_length_value(), Botan::TLS::Protocol_Version::major_version(), and Botan::TLS::Protocol_Version::minor_version().

type()

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

inlineoverridevirtual

Return the TLS handshake type code

Returns

the message type

Implements Botan::TLS::Handshake_Message.

Definition at line 59 of file tls_messages.h.

{ return Handshake_Type::HelloVerifyRequest; }

References Botan::TLS::HelloVerifyRequest.

type_string()

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

inherited

Return a free-form string describing this message type

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

Return the wire encoding of the message type code

Note

This is usually equal to type with the exception of a TLS 1.3 Helloy Retry Request.

Returns

the wire representation of the message's type

Reimplemented in Botan::TLS::Hello_Retry_Request.

Definition at line 47 of file tls_handshake_msg.h.

{ return type(); }

References 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/tls12/msg_hello_verify.cpp