Botan 3.9.0
Crypto and TLS for C&
Botan::TLS::Server_Hello_12 Class Referencefinal

#include <tls_messages.h>

Inheritance diagram for Botan::TLS::Server_Hello_12:
Botan::TLS::Server_Hello Botan::TLS::Handshake_Message

Classes

class  Settings

Public Member Functions

uint16_t ciphersuite () const
uint8_t compression_method () const
std::set< Extension_Codeextension_types () const
const Extensionsextensions () const
Protocol_Version legacy_version () const
std::string next_protocol () const
bool prefers_compressed_ec_points () const
const std::vector< uint8_t > & random () const
std::optional< Protocol_Versionrandom_signals_downgrade () const
std::vector< uint8_t > renegotiation_info () const
bool secure_renegotiation () const
Protocol_Version selected_version () const override
std::vector< uint8_t > serialize () const override
 Server_Hello_12 (const std::vector< uint8_t > &buf)
 Server_Hello_12 (Handshake_IO &io, Handshake_Hash &hash, const Policy &policy, Callbacks &cb, RandomNumberGenerator &rng, const std::vector< uint8_t > &secure_reneg_info, const Client_Hello_12 &client_hello, const Session &resumed_session, bool offer_session_ticket, std::string_view next_protocol)
 Server_Hello_12 (Handshake_IO &io, Handshake_Hash &hash, const Policy &policy, Callbacks &cb, RandomNumberGenerator &rng, const std::vector< uint8_t > &secure_reneg_info, const Client_Hello_12 &client_hello, const Settings &settings, std::string_view next_protocol)
const Session_IDsession_id () const
uint16_t srtp_profile () const
bool supports_certificate_status_message () const
bool supports_encrypt_then_mac () const
bool supports_extended_master_secret () const
bool supports_session_ticket () const
Handshake_Type type () const override
std::string type_string () const
virtual Handshake_Type wire_type () const

Protected Member Functions

 Server_Hello_12 (std::unique_ptr< Server_Hello_Internal > data)

Protected Attributes

std::unique_ptr< Server_Hello_Internal > m_data

Friends

class Server_Hello_13

Detailed Description

Definition at line 307 of file tls_messages.h.

Constructor & Destructor Documentation

◆ Server_Hello_12() [1/4]

Botan::TLS::Server_Hello_12::Server_Hello_12 ( Handshake_IO & io,
Handshake_Hash & hash,
const Policy & policy,
Callbacks & cb,
RandomNumberGenerator & rng,
const std::vector< uint8_t > & secure_reneg_info,
const Client_Hello_12 & client_hello,
const Settings & settings,
std::string_view next_protocol )

Definition at line 230 of file msg_server_hello.cpp.

238 :
239 Server_Hello(std::make_unique<Server_Hello_Internal>(
240 server_settings.protocol_version(),
241 server_settings.session_id(),
242 make_server_hello_random(rng, server_settings.protocol_version(), cb, policy),
243 server_settings.ciphersuite(),
244 uint8_t(0))) {
245 // NOLINTBEGIN(*-owning-memory)
246 if(client_hello.supports_extended_master_secret()) {
247 m_data->extensions().add(new Extended_Master_Secret);
248 }
249
250 // Sending the extension back does not commit us to sending a stapled response
251 if(client_hello.supports_cert_status_message() && policy.support_cert_status_message()) {
252 m_data->extensions().add(new Certificate_Status_Request);
253 }
254
255 if(!next_protocol.empty() && client_hello.supports_alpn()) {
256 m_data->extensions().add(new Application_Layer_Protocol_Notification(next_protocol));
257 }
258
259 const auto c = Ciphersuite::by_id(m_data->ciphersuite());
260
261 if(c && c->cbc_ciphersuite() && client_hello.supports_encrypt_then_mac() && policy.negotiate_encrypt_then_mac()) {
262 m_data->extensions().add(new Encrypt_then_MAC);
263 }
264
265 if(c && c->ecc_ciphersuite() && client_hello.extension_types().contains(Extension_Code::EcPointFormats)) {
266 m_data->extensions().add(new Supported_Point_Formats(policy.use_ecc_point_compression()));
267 }
268
269 if(client_hello.secure_renegotiation()) {
270 m_data->extensions().add(new Renegotiation_Extension(reneg_info));
271 }
272
273 if(client_hello.supports_session_ticket() && server_settings.offer_session_ticket()) {
274 m_data->extensions().add(new Session_Ticket_Extension());
275 }
276
277 if(m_data->legacy_version().is_datagram_protocol()) {
278 const std::vector<uint16_t> server_srtp = policy.srtp_profiles();
279 const std::vector<uint16_t> client_srtp = client_hello.srtp_profiles();
280
281 if(!server_srtp.empty() && !client_srtp.empty()) {
282 uint16_t shared = 0;
283 // always using server preferences for now
284 for(auto s_srtp : server_srtp) {
285 for(auto c_srtp : client_srtp) {
286 if(shared == 0 && s_srtp == c_srtp) {
287 shared = s_srtp;
288 }
289 }
290 }
291
292 if(shared != 0) {
293 m_data->extensions().add(new SRTP_Protection_Profiles(shared));
294 }
295 }
296 }
297 // NOLINTEND(*-owning-memory)
298
299 cb.tls_modify_extensions(m_data->extensions(), Connection_Side::Server, type());
300
301 hash.update(io.send(*this));
302}
static std::optional< Ciphersuite > by_id(uint16_t suite)
virtual Handshake_Type type() const =0
std::string next_protocol() const
Server_Hello(const Server_Hello &)=delete
std::unique_ptr< Server_Hello_Internal > m_data

References Botan::TLS::Ciphersuite::by_id(), Botan::TLS::Server_Hello::ciphersuite(), Botan::TLS::EcPointFormats, Botan::TLS::Client_Hello::extension_types(), Botan::TLS::Server_Hello::m_data, Botan::TLS::Policy::negotiate_encrypt_then_mac(), next_protocol(), Botan::TLS::Server_Hello_12::Settings::offer_session_ticket(), Botan::TLS::Client_Hello_12::secure_renegotiation(), Botan::TLS::Server_Hello::Server_Hello(), Botan::TLS::Server_Hello::session_id(), Botan::TLS::Policy::support_cert_status_message(), Botan::TLS::Client_Hello::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(), and Botan::TLS::Client_Hello_12::supports_session_ticket().

Referenced by Server_Hello_12(), Server_Hello_12(), and Server_Hello_13.

◆ Server_Hello_12() [2/4]

Botan::TLS::Server_Hello_12::Server_Hello_12 ( Handshake_IO & io,
Handshake_Hash & hash,
const Policy & policy,
Callbacks & cb,
RandomNumberGenerator & rng,
const std::vector< uint8_t > & secure_reneg_info,
const Client_Hello_12 & client_hello,
const Session & resumed_session,
bool offer_session_ticket,
std::string_view next_protocol )

Definition at line 305 of file msg_server_hello.cpp.

314 :
315 Server_Hello(std::make_unique<Server_Hello_Internal>(resumed_session.version(),
316 client_hello.session_id(),
317 make_hello_random(rng, cb, policy),
318 resumed_session.ciphersuite_code(),
319 uint8_t(0))) {
320 // NOLINTBEGIN(*-owning-memory)
321 if(client_hello.supports_extended_master_secret()) {
322 m_data->extensions().add(new Extended_Master_Secret);
323 }
324
325 if(!next_protocol.empty() && client_hello.supports_alpn()) {
326 m_data->extensions().add(new Application_Layer_Protocol_Notification(next_protocol));
327 }
328
329 if(client_hello.supports_encrypt_then_mac() && policy.negotiate_encrypt_then_mac()) {
330 Ciphersuite c = resumed_session.ciphersuite();
331 if(c.cbc_ciphersuite()) {
332 m_data->extensions().add(new Encrypt_then_MAC);
333 }
334 }
335
336 if(resumed_session.ciphersuite().ecc_ciphersuite() &&
337 client_hello.extension_types().contains(Extension_Code::EcPointFormats)) {
338 m_data->extensions().add(new Supported_Point_Formats(policy.use_ecc_point_compression()));
339 }
340
341 if(client_hello.secure_renegotiation()) {
342 m_data->extensions().add(new Renegotiation_Extension(reneg_info));
343 }
344
345 if(client_hello.supports_session_ticket() && offer_session_ticket) {
346 m_data->extensions().add(new Session_Ticket_Extension());
347 }
348 // NOLINTEND(*-owning-memory)
349
350 cb.tls_modify_extensions(m_data->extensions(), Connection_Side::Server, type());
351
352 hash.update(io.send(*this));
353}
std::vector< uint8_t > make_hello_random(RandomNumberGenerator &rng, Callbacks &cb, const Policy &policy)

References Botan::TLS::make_hello_random(), Botan::TLS::Policy::negotiate_encrypt_then_mac(), next_protocol(), Botan::TLS::Server_Hello::Server_Hello(), Server_Hello_12(), Botan::TLS::Server_Hello::session_id(), Botan::TLS::Client_Hello::supports_alpn(), Botan::TLS::Client_Hello_12::supports_encrypt_then_mac(), and Botan::TLS::Client_Hello_12::supports_extended_master_secret().

◆ Server_Hello_12() [3/4]

Botan::TLS::Server_Hello_12::Server_Hello_12 ( const std::vector< uint8_t > & buf)
explicit

Definition at line 355 of file msg_server_hello.cpp.

355 :
356 Server_Hello_12(std::make_unique<Server_Hello_Internal>(buf)) {}
Server_Hello_12(Handshake_IO &io, Handshake_Hash &hash, const Policy &policy, Callbacks &cb, RandomNumberGenerator &rng, const std::vector< uint8_t > &secure_reneg_info, const Client_Hello_12 &client_hello, const Settings &settings, std::string_view next_protocol)

References Server_Hello_12().

◆ Server_Hello_12() [4/4]

Botan::TLS::Server_Hello_12::Server_Hello_12 ( std::unique_ptr< Server_Hello_Internal > data)
explicitprotected

Definition at line 358 of file msg_server_hello.cpp.

358 : Server_Hello(std::move(data)) {
359 if(!m_data->version().is_pre_tls_13()) {
360 throw TLS_Exception(Alert::ProtocolVersion, "Expected server hello of (D)TLS 1.2 or lower");
361 }
362}

References Botan::TLS::Server_Hello::m_data, and Botan::TLS::Server_Hello::Server_Hello().

Member Function Documentation

◆ ciphersuite()

uint16_t Botan::TLS::Server_Hello::ciphersuite ( ) const
inherited

Definition at line 217 of file msg_server_hello.cpp.

217 {
218 return m_data->ciphersuite();
219}

References m_data.

Referenced by Botan::TLS::Client_Hello_13::retry(), Botan::TLS::Server_Hello_12::Server_Hello_12(), and ~Server_Hello().

◆ compression_method()

uint8_t Botan::TLS::Server_Hello::compression_method ( ) const

Definition at line 300 of file msg_server_hello.cpp.

209 {
210 return m_data->comp_method();
211}

◆ extension_types()

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

Definition at line 298 of file msg_server_hello.cpp.

221 {
222 return m_data->extensions().extension_types();
223}

◆ extensions()

const Extensions & Botan::TLS::Server_Hello::extensions ( ) const
inherited

◆ legacy_version()

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

Definition at line 301 of file msg_server_hello.cpp.

201 {
202 return m_data->legacy_version();
203}

Referenced by selected_version().

◆ next_protocol()

std::string Botan::TLS::Server_Hello_12::next_protocol ( ) const

Definition at line 407 of file msg_server_hello.cpp.

407 {
408 if(auto* alpn = m_data->extensions().get<Application_Layer_Protocol_Notification>()) {
409 return alpn->single_protocol();
410 }
411 return "";
412}

References Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_12(), Server_Hello_12(), and Server_Hello_13.

◆ prefers_compressed_ec_points()

bool Botan::TLS::Server_Hello_12::prefers_compressed_ec_points ( ) const

Definition at line 414 of file msg_server_hello.cpp.

414 {
415 if(auto* ecc_formats = m_data->extensions().get<Supported_Point_Formats>()) {
416 return ecc_formats->prefers_compressed();
417 }
418 return false;
419}

References Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_13.

◆ random()

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

Definition at line 299 of file msg_server_hello.cpp.

205 {
206 return m_data->random();
207}

References Botan::TLS::Server_Hello::m_data, Botan::TLS::Server, and Botan::TLS::Server_Hello::type().

◆ random_signals_downgrade()

std::optional< Protocol_Version > Botan::TLS::Server_Hello_12::random_signals_downgrade ( ) const

Return desired downgrade version indicated by hello random, if any.

Definition at line 421 of file msg_server_hello.cpp.

421 {
422 const uint64_t last8 = load_be<uint64_t>(m_data->random().data(), 3);
423 if(last8 == DOWNGRADE_TLS11) {
424 return Protocol_Version::TLS_V11;
425 }
426 if(last8 == DOWNGRADE_TLS12) {
427 return Protocol_Version::TLS_V12;
428 }
429
430 return std::nullopt;
431}
constexpr auto load_be(ParamTs &&... params)
Definition loadstor.h:504

References Botan::load_be(), and Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_13.

◆ renegotiation_info()

std::vector< uint8_t > Botan::TLS::Server_Hello_12::renegotiation_info ( ) const

Definition at line 372 of file msg_server_hello.cpp.

372 {
373 if(Renegotiation_Extension* reneg = m_data->extensions().get<Renegotiation_Extension>()) {
374 return reneg->renegotiation_info();
375 }
376 return std::vector<uint8_t>();
377}

References Botan::TLS::Server_Hello::m_data.

Referenced by Botan::TLS::Channel_Impl_12::secure_renegotiation_check(), and Server_Hello_13.

◆ secure_renegotiation()

bool Botan::TLS::Server_Hello_12::secure_renegotiation ( ) const

Definition at line 368 of file msg_server_hello.cpp.

368 {
369 return m_data->extensions().has<Renegotiation_Extension>();
370}

References Botan::TLS::Server_Hello::m_data.

Referenced by Botan::TLS::Channel_Impl_12::secure_renegotiation_check(), and Server_Hello_13.

◆ selected_version()

Protocol_Version Botan::TLS::Server_Hello_12::selected_version ( ) const
overridevirtual
Returns
the selected version as indicated in the legacy_version field

Implements Botan::TLS::Server_Hello.

Definition at line 364 of file msg_server_hello.cpp.

364 {
365 return legacy_version();
366}
Protocol_Version legacy_version() const

References legacy_version().

Referenced by Server_Hello_13.

◆ serialize()

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

Implements Botan::TLS::Handshake_Message.

Definition at line 177 of file msg_server_hello.cpp.

177 {
178 std::vector<uint8_t> buf;
179 buf.reserve(1024); // working around GCC warning
180
181 buf.push_back(m_data->legacy_version().major_version());
182 buf.push_back(m_data->legacy_version().minor_version());
183 buf += m_data->random();
184
185 append_tls_length_value(buf, m_data->session_id().get(), 1);
186
187 buf.push_back(get_byte<0>(m_data->ciphersuite()));
188 buf.push_back(get_byte<1>(m_data->ciphersuite()));
189
190 buf.push_back(m_data->comp_method());
191
192 buf += m_data->extensions().serialize(Connection_Side::Server);
193
194 return buf;
195}
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:184
constexpr uint8_t get_byte(T input)
Definition loadstor.h:79

References Botan::TLS::append_tls_length_value(), Botan::get_byte(), m_data, serialize(), Botan::TLS::Server, and Server_Hello().

Referenced by serialize(), and ~Server_Hello().

◆ session_id()

const Session_ID & Botan::TLS::Server_Hello::session_id ( ) const
inherited

◆ srtp_profile()

uint16_t Botan::TLS::Server_Hello_12::srtp_profile ( ) const

Definition at line 395 of file msg_server_hello.cpp.

395 {
396 if(auto* srtp = m_data->extensions().get<SRTP_Protection_Profiles>()) {
397 auto prof = srtp->profiles();
398 if(prof.size() != 1 || prof[0] == 0) {
399 throw Decoding_Error("Server sent malformed DTLS-SRTP extension");
400 }
401 return prof[0];
402 }
403
404 return 0;
405}

References Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_13.

◆ supports_certificate_status_message()

bool Botan::TLS::Server_Hello_12::supports_certificate_status_message ( ) const

Definition at line 387 of file msg_server_hello.cpp.

387 {
388 return m_data->extensions().has<Certificate_Status_Request>();
389}

References Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_13.

◆ supports_encrypt_then_mac()

bool Botan::TLS::Server_Hello_12::supports_encrypt_then_mac ( ) const

Definition at line 383 of file msg_server_hello.cpp.

383 {
384 return m_data->extensions().has<Encrypt_then_MAC>();
385}

References Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_13.

◆ supports_extended_master_secret()

bool Botan::TLS::Server_Hello_12::supports_extended_master_secret ( ) const

Definition at line 379 of file msg_server_hello.cpp.

379 {
380 return m_data->extensions().has<Extended_Master_Secret>();
381}

References Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_13.

◆ supports_session_ticket()

bool Botan::TLS::Server_Hello_12::supports_session_ticket ( ) const

Definition at line 391 of file msg_server_hello.cpp.

391 {
392 return m_data->extensions().has<Session_Ticket_Extension>();
393}

References Botan::TLS::Server_Hello::m_data.

Referenced by Server_Hello_13.

◆ type()

Handshake_Type Botan::TLS::Server_Hello::type ( ) const
overridevirtualinherited
Returns
the message type

Implements Botan::TLS::Handshake_Message.

Definition at line 197 of file msg_server_hello.cpp.

References Botan::TLS::ServerHello.

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

◆ 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 {
21}
const char * handshake_type_to_string(Handshake_Type type)

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().

◆ Server_Hello_13

Member Data Documentation

◆ m_data


The documentation for this class was generated from the following files: