Botan 3.6.1
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 Botan::TLS::Client_Hello_13

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 76 of file tls_messages.h.

Constructor & Destructor Documentation

◆ Client_Hello() [1/4]

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

◆ Client_Hello() [2/4]

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

◆ ~Client_Hello()

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

◆ Client_Hello() [3/4]

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

Definition at line 171 of file msg_client_hello.cpp.

171: 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:144

◆ Client_Hello() [4/4]

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

Definition at line 176 of file msg_client_hello.cpp.

176 : m_data(std::move(data)) {
177 BOTAN_ASSERT_NONNULL(m_data);
178}
BOTAN_ASSERT_NONNULL
#define BOTAN_ASSERT_NONNULL(ptr)
Definition assert.h:86

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 270 of file msg_client_hello.cpp.

270 {
271 // RFC 8446 4.2.3
272 // If no "signature_algorithms_cert" extension is present, then the
273 // "signature_algorithms" extension also applies to signatures appearing
274 // in certificates.
275 if(Signature_Algorithms_Cert* sigs = m_data->extensions().get<Signature_Algorithms_Cert>()) {
276 return sigs->supported_schemes();
277 } else {
278 return signature_schemes();
279 }
280}
Botan::TLS::Client_Hello::signature_schemes
std::vector< Signature_Scheme > signature_schemes() const
Definition msg_client_hello.cpp:263

References m_data, and signature_schemes().

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

◆ ciphersuites()

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

Definition at line 200 of file msg_client_hello.cpp.

200 {
201 return m_data->ciphersuites();
202}

References m_data.

◆ compression_methods()

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

Definition at line 196 of file msg_client_hello.cpp.

196 {
197 return m_data->comp_methods();
198}

References m_data.

◆ cookie()

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

Definition at line 387 of file msg_client_hello.cpp.

387 {
388 return m_data->hello_cookie();
389}

References m_data.

◆ cookie_input_data()

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

Definition at line 249 of file msg_client_hello.cpp.

249 {
250 BOTAN_STATE_CHECK(!m_data->hello_cookie_input_bits().empty());
251
252 return m_data->hello_cookie_input_bits();
253}
BOTAN_STATE_CHECK
#define BOTAN_STATE_CHECK(expr)
Definition assert.h:41

References BOTAN_STATE_CHECK, and m_data.

◆ extension_types()

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

Definition at line 204 of file msg_client_hello.cpp.

204 {
205 return m_data->extensions().extension_types();
206}

References m_data.

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

◆ extensions()

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

Definition at line 208 of file msg_client_hello.cpp.

208 {
209 return m_data->extensions();
210}

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(), and Botan::TLS::Client_Hello_13::validate_updates().

◆ 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 184 of file msg_client_hello.cpp.

184 {
185 return m_data->legacy_version();
186}

References m_data.

◆ next_protocols()

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

Definition at line 373 of file msg_client_hello.cpp.

373 {
374 if(auto alpn = m_data->extensions().get<Application_Layer_Protocol_Notification>()) {
375 return alpn->protocols();
376 }
377 return {};
378}

References m_data.

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

◆ offered_suite()

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

Definition at line 258 of file msg_client_hello.cpp.

258 {
259 return std::find(m_data->ciphersuites().cbegin(), m_data->ciphersuites().cend(), ciphersuite) !=
260 m_data->ciphersuites().cend();
261}

References m_data.

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ random()

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

Definition at line 188 of file msg_client_hello.cpp.

188 {
189 return m_data->random();
190}

References m_data.

◆ sent_signature_algorithms()

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

Definition at line 369 of file msg_client_hello.cpp.

369 {
370 return m_data->extensions().has<Signature_Algorithms>();
371}

References m_data.

◆ 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 221 of file msg_client_hello.cpp.

221 {
222 std::vector<uint8_t> buf;
223 buf.reserve(1024); // working around GCC warning
224
225 buf.push_back(m_data->legacy_version().major_version());
226 buf.push_back(m_data->legacy_version().minor_version());
227 buf += m_data->random();
228
229 append_tls_length_value(buf, m_data->session_id().get(), 1);
230
231 if(m_data->legacy_version().is_datagram_protocol()) {
232 append_tls_length_value(buf, m_data->hello_cookie(), 1);
233 }
234
235 append_tls_length_value(buf, m_data->ciphersuites(), 2);
236 append_tls_length_value(buf, m_data->comp_methods(), 1);
237
238 /*
239 * May not want to send extensions at all in some cases. If so,
240 * should include SCSV value (if reneg info is empty, if not we are
241 * renegotiating with a modern server)
242 */
243
244 buf += m_data->extensions().serialize(Connection_Side::Client);
245
246 return buf;
247}
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:180

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

◆ session_id()

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

Definition at line 192 of file msg_client_hello.cpp.

192 {
193 return m_data->session_id();
194}

References m_data.

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

◆ signature_schemes()

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

Definition at line 263 of file msg_client_hello.cpp.

263 {
264 if(Signature_Algorithms* sigs = m_data->extensions().get<Signature_Algorithms>()) {
265 return sigs->supported_schemes();
266 }
267 return {};
268}

References m_data.

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

◆ sni_hostname()

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

Definition at line 303 of file msg_client_hello.cpp.

303 {
304 if(Server_Name_Indicator* sni = m_data->extensions().get<Server_Name_Indicator>()) {
305 return sni->host_name();
306 }
307 return "";
308}

References m_data.

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

◆ srtp_profiles()

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

Definition at line 380 of file msg_client_hello.cpp.

380 {
381 if(SRTP_Protection_Profiles* srtp = m_data->extensions().get<SRTP_Protection_Profiles>()) {
382 return srtp->profiles();
383 }
384 return {};
385}

References m_data.

◆ supported_dh_groups()

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

Definition at line 289 of file msg_client_hello.cpp.

289 {
290 if(Supported_Groups* groups = m_data->extensions().get<Supported_Groups>()) {
291 return groups->dh_groups();
292 }
293 return std::vector<Group_Params>();
294}

References m_data.

◆ supported_ecc_curves()

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

Definition at line 282 of file msg_client_hello.cpp.

282 {
283 if(Supported_Groups* groups = m_data->extensions().get<Supported_Groups>()) {
284 return groups->ec_groups();
285 }
286 return {};
287}

References m_data.

◆ supported_versions()

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

Definition at line 321 of file msg_client_hello.cpp.

321 {
322 if(Supported_Versions* versions = m_data->extensions().get<Supported_Versions>()) {
323 return versions->versions();
324 }
325 return {};
326}

References m_data.

◆ supports_alpn()

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

Definition at line 353 of file msg_client_hello.cpp.

353 {
354 return m_data->extensions().has<Application_Layer_Protocol_Notification>();
355}

References m_data.

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

◆ type()

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

Implements Botan::TLS::Handshake_Message.

Definition at line 180 of file msg_client_hello.cpp.

180 {
181 return Handshake_Type::ClientHello;
182}

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(), and Botan::TLS::Client_Hello_13::retry().

◆ 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.

19 {
20 return handshake_type_to_string(type());
21}
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_handshake_state.cpp:23

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.

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 }

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 144 of file tls_messages.h.

Referenced by certificate_signature_schemes(), ciphersuites(), Client_Hello(), Botan::TLS::Client_Hello_12::Client_Hello_12(), 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(), cookie(), cookie_input_data(), extension_types(), extensions(), Botan::TLS::Client_Hello_13::highest_supported_version(), legacy_version(), next_protocols(), offered_suite(), Botan::TLS::Client_Hello_12::prefers_compressed_ec_points(), random(), 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.12.0