Botan 3.12.0
Crypto and TLS for C&
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Botan::TLS::Client_Hello Class Reference

#include <tls_messages.h>

Inheritance diagram for Botan::TLS::Client_Hello:
Botan::TLS::Handshake_Message Botan::TLS::Client_Hello_12_Shim Botan::TLS::Client_Hello_13 Botan::TLS::Client_Hello_12

Public Member Functions

std::vector< Signature_Scheme > certificate_signature_schemes () const
const std::vector< uint16_t > & ciphersuites () const
 Client_Hello (Client_Hello &&) noexcept
 Client_Hello (const Client_Hello &)=delete
const std::vector< uint8_t > & cookie () const
std::vector< uint8_t > cookie_input_data () const
std::set< Extension_Code > extension_types () const
const Extensions & extensions () const
Protocol_Version legacy_version () const
std::vector< std::string > next_protocols () const
bool offered_suite (uint16_t ciphersuite) const
Client_Hello & operator= (Client_Hello &&) noexcept
Client_Hello & operator= (const Client_Hello &)=delete
const std::vector< uint8_t > & random () const
bool sent_signature_algorithms () const
std::vector< uint8_t > serialize () const override
const Session_ID & session_id () const
std::vector< Signature_Scheme > signature_schemes () const
std::string sni_hostname () const
std::vector< uint16_t > srtp_profiles () const
std::vector< Group_Params > supported_dh_groups () const
std::vector< Group_Params > supported_ecc_curves () const
std::vector< Protocol_Version > supported_versions () const
bool supports_alpn () const
Handshake_Type type () const override
std::string type_string () const
virtual Handshake_Type wire_type () const
 ~Client_Hello () override

Protected Member Functions

 Client_Hello ()
 Client_Hello (std::unique_ptr< Client_Hello_Internal > data)
const std::vector< uint8_t > & compression_methods () const

Protected Attributes

std::unique_ptr< Client_Hello_Internal > m_data

Detailed Description

Client Hello Message

Definition at line 80 of file tls_messages.h.

Constructor & Destructor Documentation

◆ Client_Hello() [1/4]

Botan::TLS::Client_Hello::Client_Hello ( const Client_Hello & )
delete

References Client_Hello().

Referenced by Client_Hello(), Client_Hello(), Client_Hello(), operator=(), operator=(), and ~Client_Hello().

◆ Client_Hello() [2/4]

Botan::TLS::Client_Hello::Client_Hello ( Client_Hello && )
defaultnoexcept

References Client_Hello().

◆ ~Client_Hello()

Botan::TLS::Client_Hello::~Client_Hello ( )
overridedefault

References certificate_signature_schemes(), ciphersuites(), Client_Hello(), compression_methods(), cookie(), cookie_input_data(), extension_types(), extensions(), legacy_version(), next_protocols(), offered_suite(), random(), sent_signature_algorithms(), serialize(), session_id(), signature_schemes(), sni_hostname(), srtp_profiles(), supported_dh_groups(), supported_ecc_curves(), supported_versions(), supports_alpn(), and type().

◆ Client_Hello() [3/4]

Botan::TLS::Client_Hello::Client_Hello ( )
protected

Definition at line 128 of file msg_client_hello.cpp.

128: m_data(std::make_unique<Client_Hello_Internal>()) {}
Botan::TLS::Client_Hello::m_data
std::unique_ptr< Client_Hello_Internal > m_data
Definition tls_messages.h:148

References Client_Hello(), and m_data.

◆ Client_Hello() [4/4]

Botan::TLS::Client_Hello::Client_Hello ( std::unique_ptr< Client_Hello_Internal > data)
explicitprotected

Definition at line 133 of file msg_client_hello.cpp.

133 : m_data(std::move(data)) {
134 BOTAN_ASSERT_NONNULL(m_data);
135}
BOTAN_ASSERT_NONNULL
#define BOTAN_ASSERT_NONNULL(ptr)
Definition assert.h:114

References BOTAN_ASSERT_NONNULL, and m_data.

Member Function Documentation

◆ certificate_signature_schemes()

std::vector< Signature_Scheme > Botan::TLS::Client_Hello::certificate_signature_schemes ( ) const

Definition at line 221 of file msg_client_hello.cpp.

221 {
222 // RFC 8446 4.2.3
223 // If no "signature_algorithms_cert" extension is present, then the
224 // "signature_algorithms" extension also applies to signatures appearing
225 // in certificates.
226 if(const Signature_Algorithms_Cert* sigs = m_data->extensions().get<Signature_Algorithms_Cert>()) {
227 return sigs->supported_schemes();
228 } else {
229 return signature_schemes();
230 }
231}
Botan::TLS::Client_Hello::signature_schemes
std::vector< Signature_Scheme > signature_schemes() const
Definition msg_client_hello.cpp:214

References m_data, and signature_schemes().

Referenced by ~Client_Hello().

◆ ciphersuites()

const std::vector< uint16_t > & Botan::TLS::Client_Hello::ciphersuites ( ) const

Definition at line 157 of file msg_client_hello.cpp.

157 {
158 return m_data->ciphersuites();
159}

References m_data.

Referenced by ~Client_Hello().

◆ compression_methods()

const std::vector< uint8_t > & Botan::TLS::Client_Hello::compression_methods ( ) const
protected

Definition at line 153 of file msg_client_hello.cpp.

153 {
154 return m_data->comp_methods();
155}

References m_data.

Referenced by ~Client_Hello().

◆ cookie()

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

Definition at line 283 of file msg_client_hello.cpp.

283 {
284 return m_data->hello_cookie();
285}

References m_data.

Referenced by ~Client_Hello().

◆ cookie_input_data()

std::vector< uint8_t > Botan::TLS::Client_Hello::cookie_input_data ( ) const

Definition at line 200 of file msg_client_hello.cpp.

200 {
201 BOTAN_STATE_CHECK(!m_data->hello_cookie_input_bits().empty());
202
203 return m_data->hello_cookie_input_bits();
204}
BOTAN_STATE_CHECK
#define BOTAN_STATE_CHECK(expr)
Definition assert.h:49

References BOTAN_STATE_CHECK, and m_data.

Referenced by ~Client_Hello().

◆ extension_types()

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

Definition at line 161 of file msg_client_hello.cpp.

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

References m_data.

Referenced by Botan::TLS::Server_Hello_12::Server_Hello_12(), Botan::TLS::Client_Hello_13::validate_updates(), and ~Client_Hello().

◆ extensions()

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

Definition at line 165 of file msg_client_hello.cpp.

165 {
166 return m_data->extensions();
167}

References m_data.

Referenced by Botan::TLS::Certificate_13::Certificate_13(), Botan::TLS::Server_Hello_13::create(), Botan::TLS::Encrypted_Extensions::Encrypted_Extensions(), Botan::TLS::Hello_Retry_Request::Hello_Retry_Request(), Botan::TLS::Server_Hello_13::Server_Hello_13(), Botan::TLS::Client_Hello_13::validate_updates(), and ~Client_Hello().

◆ legacy_version()

Protocol_Version Botan::TLS::Client_Hello::legacy_version ( ) const

Return the version indicated in the ClientHello. This may differ from the version indicated in the supported_versions extension.

See RFC 8446 4.1.2: TLS 1.3, the client indicates its version preferences in the "supported_versions" extension (Section 4.2.1) and the legacy_version field MUST be set to 0x0303, which is the version number for TLS 1.2.

Definition at line 141 of file msg_client_hello.cpp.

141 {
142 return m_data->legacy_version();
143}

Referenced by ~Client_Hello().

◆ next_protocols()

std::vector< std::string > Botan::TLS::Client_Hello::next_protocols ( ) const

Definition at line 269 of file msg_client_hello.cpp.

269 {
270 if(auto* alpn = m_data->extensions().get<Application_Layer_Protocol_Notification>()) {
271 return alpn->protocols();
272 }
273 return {};
274}

References m_data.

Referenced by Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_13::Client_Hello_13(), and ~Client_Hello().

◆ offered_suite()

bool Botan::TLS::Client_Hello::offered_suite ( uint16_t ciphersuite) const

Definition at line 209 of file msg_client_hello.cpp.

209 {
210 return std::find(m_data->ciphersuites().cbegin(), m_data->ciphersuites().cend(), ciphersuite) !=
211 m_data->ciphersuites().cend();
212}

References m_data.

Referenced by ~Client_Hello().

◆ operator=() [1/2]

Client_Hello & Botan::TLS::Client_Hello::operator= ( Client_Hello && )
defaultnoexcept

References Client_Hello().

◆ operator=() [2/2]

Client_Hello & Botan::TLS::Client_Hello::operator= ( const Client_Hello & )
delete

References Client_Hello().

◆ random()

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

Definition at line 145 of file msg_client_hello.cpp.

145 {
146 return m_data->random();
147}

Referenced by ~Client_Hello().

◆ sent_signature_algorithms()

bool Botan::TLS::Client_Hello::sent_signature_algorithms ( ) const

Definition at line 265 of file msg_client_hello.cpp.

265 {
266 return m_data->extensions().has<Signature_Algorithms>();
267}

References m_data.

Referenced by ~Client_Hello().

◆ serialize()

std::vector< uint8_t > Botan::TLS::Client_Hello::serialize ( ) const
overridevirtual
Returns
DER representation of this message

Implements Botan::TLS::Handshake_Message.

Definition at line 172 of file msg_client_hello.cpp.

172 {
173 std::vector<uint8_t> buf;
174 buf.reserve(1024); // working around GCC warning
175
176 buf.push_back(m_data->legacy_version().major_version());
177 buf.push_back(m_data->legacy_version().minor_version());
178 buf += m_data->random();
179
180 append_tls_length_value(buf, m_data->session_id().get(), 1);
181
182 if(m_data->legacy_version().is_datagram_protocol()) {
183 append_tls_length_value(buf, m_data->hello_cookie(), 1);
184 }
185
186 append_tls_length_value(buf, m_data->ciphersuites(), 2);
187 append_tls_length_value(buf, m_data->comp_methods(), 1);
188
189 /*
190 * May not want to send extensions at all in some cases. If so,
191 * should include SCSV value (if reneg info is empty, if not we are
192 * renegotiating with a modern server)
193 */
194
195 buf += m_data->extensions().serialize(Connection_Side::Client);
196
197 return buf;
198}
Botan::TLS::append_tls_length_value
void append_tls_length_value(std::vector< uint8_t, Alloc > &buf, const T *vals, size_t vals_size, size_t tag_size)
Definition tls_reader.h:177

References Botan::TLS::append_tls_length_value(), Botan::TLS::Client, and m_data.

Referenced by ~Client_Hello().

◆ session_id()

const Session_ID & Botan::TLS::Client_Hello::session_id ( ) const

Definition at line 149 of file msg_client_hello.cpp.

149 {
150 return m_data->session_id();
151}

References m_data.

Referenced by Botan::TLS::Client_Hello_12::session_handle(), and ~Client_Hello().

◆ signature_schemes()

std::vector< Signature_Scheme > Botan::TLS::Client_Hello::signature_schemes ( ) const

Definition at line 214 of file msg_client_hello.cpp.

214 {
215 if(const Signature_Algorithms* sigs = m_data->extensions().get<Signature_Algorithms>()) {
216 return sigs->supported_schemes();
217 }
218 return {};
219}

References m_data.

Referenced by Botan::TLS::Certificate_13::Certificate_13(), certificate_signature_schemes(), Botan::TLS::Handshake_State::choose_sig_format(), and ~Client_Hello().

◆ sni_hostname()

std::string Botan::TLS::Client_Hello::sni_hostname ( ) const

Definition at line 247 of file msg_client_hello.cpp.

247 {
248 if(const Server_Name_Indicator* sni = m_data->extensions().get<Server_Name_Indicator>()) {
249 return sni->host_name();
250 }
251 return "";
252}

References m_data.

Referenced by Botan::TLS::Certificate_13::Certificate_13(), Botan::TLS::Certificate_Request_13::maybe_create(), and ~Client_Hello().

◆ srtp_profiles()

std::vector< uint16_t > Botan::TLS::Client_Hello::srtp_profiles ( ) const

Definition at line 276 of file msg_client_hello.cpp.

276 {
277 if(const SRTP_Protection_Profiles* srtp = m_data->extensions().get<SRTP_Protection_Profiles>()) {
278 return srtp->profiles();
279 }
280 return {};
281}

References m_data.

Referenced by ~Client_Hello().

◆ supported_dh_groups()

std::vector< Group_Params > Botan::TLS::Client_Hello::supported_dh_groups ( ) const

Definition at line 240 of file msg_client_hello.cpp.

240 {
241 if(const Supported_Groups* groups = m_data->extensions().get<Supported_Groups>()) {
242 return groups->dh_groups();
243 }
244 return std::vector<Group_Params>();
245}

References m_data.

Referenced by ~Client_Hello().

◆ supported_ecc_curves()

std::vector< Group_Params > Botan::TLS::Client_Hello::supported_ecc_curves ( ) const

Definition at line 233 of file msg_client_hello.cpp.

233 {
234 if(const Supported_Groups* groups = m_data->extensions().get<Supported_Groups>()) {
235 return groups->ec_groups();
236 }
237 return {};
238}

References m_data.

Referenced by ~Client_Hello().

◆ supported_versions()

std::vector< Protocol_Version > Botan::TLS::Client_Hello::supported_versions ( ) const

Definition at line 254 of file msg_client_hello.cpp.

254 {
255 if(const Supported_Versions* versions = m_data->extensions().get<Supported_Versions>()) {
256 return versions->versions();
257 }
258 return {};
259}

References m_data.

Referenced by ~Client_Hello().

◆ supports_alpn()

bool Botan::TLS::Client_Hello::supports_alpn ( ) const

Definition at line 261 of file msg_client_hello.cpp.

261 {
262 return m_data->extensions().has<Application_Layer_Protocol_Notification>();
263}

References m_data.

Referenced by Botan::TLS::Server_Hello_12::Server_Hello_12(), Botan::TLS::Server_Hello_12::Server_Hello_12(), and ~Client_Hello().

◆ type()

Handshake_Type Botan::TLS::Client_Hello::type ( ) const
overridevirtual
Returns
the message type

Implements Botan::TLS::Handshake_Message.

Definition at line 137 of file msg_client_hello.cpp.

137 {
138 return Handshake_Type::ClientHello;
139}

References Botan::TLS::ClientHello.

Referenced by Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_13::Client_Hello_13(), Botan::TLS::Client_Hello_13::retry(), and ~Client_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.

21 {
22 return handshake_type_to_string(type());
23}
Botan::TLS::Handshake_Message::type
virtual Handshake_Type type() const =0
Botan::TLS::handshake_type_to_string
const char * handshake_type_to_string(Handshake_Type type)
Definition tls_magic.cpp:15

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.

39 {
40 // Usually equal to the Handshake_Type enum value,
41 // with the exception of TLS 1.3 Hello Retry Request.
42 return type();
43 }

References type().

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

Member Data Documentation

◆ m_data

std::unique_ptr<Client_Hello_Internal> Botan::TLS::Client_Hello::m_data
protected

Definition at line 148 of file tls_messages.h.

Referenced by certificate_signature_schemes(), ciphersuites(), Client_Hello(), Client_Hello(), Botan::TLS::Client_Hello_12_Shim::Client_Hello(), Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_13::Client_Hello_13(), compression_methods(), Botan::TLS::Client_Hello_12::compression_methods(), cookie(), cookie_input_data(), extension_types(), extensions(), Botan::TLS::Client_Hello_13::highest_supported_version(), next_protocols(), offered_suite(), Botan::TLS::Client_Hello_12::prefers_compressed_ec_points(), Botan::TLS::Client_Hello_12::renegotiation_info(), Botan::TLS::Client_Hello_13::retry(), Botan::TLS::Client_Hello_12::secure_renegotiation(), sent_signature_algorithms(), serialize(), session_id(), Botan::TLS::Client_Hello_12::session_ticket(), signature_schemes(), sni_hostname(), srtp_profiles(), supported_dh_groups(), supported_ecc_curves(), supported_versions(), supports_alpn(), Botan::TLS::Client_Hello_12::supports_cert_status_message(), Botan::TLS::Client_Hello_12::supports_encrypt_then_mac(), Botan::TLS::Client_Hello_12::supports_extended_master_secret(), Botan::TLS::Client_Hello_12::supports_session_ticket(), Botan::TLS::Client_Hello_12::update_hello_cookie(), and Botan::TLS::Client_Hello_13::validate_updates().

The documentation for this class was generated from the following files:
Generated by doxygen 1.16.1