Botan 3.11.0
Crypto and TLS for C&
Botan::TLS::Supported_Versions Class Referencefinal

#include <tls_extensions.h>

Inheritance diagram for Botan::TLS::Supported_Versions:
Botan::TLS::Extension

Public Member Functions

bool empty () const override
virtual bool is_implemented () const
std::vector< uint8_t > serialize (Connection_Side whoami) const override
 Supported_Versions (Protocol_Version version)
 Supported_Versions (Protocol_Version version, const Policy &policy)
 Supported_Versions (TLS_Data_Reader &reader, uint16_t extension_size, Connection_Side from)
bool supports (Protocol_Version version) const
Extension_Code type () const override
const std::vector< Protocol_Version > & versions () const

Static Public Member Functions

static Extension_Code static_type ()

Detailed Description

Supported Versions from RFC 8446

Definition at line 381 of file tls_extensions.h.

Constructor & Destructor Documentation

◆ Supported_Versions() [1/3]

Botan::TLS::Supported_Versions::Supported_Versions ( Protocol_Version version,
const Policy & policy )

Definition at line 675 of file tls_extensions.cpp.

675 {
676 // RFC 8446 4.2.1
677 // The extension contains a list of supported versions in preference order,
678 // with the most preferred version first. Implementations [...] MUST send
679 // this extension in the ClientHello containing all versions of TLS which
680 // they are prepared to negotiate.
681 //
682 // We simply assume that we always want the newest available TLS version.
683#if defined(BOTAN_HAS_TLS_13)
684 if(!offer.is_datagram_protocol()) {
685 if(offer >= Protocol_Version::TLS_V13 && policy.allow_tls13()) {
686 m_versions.push_back(Protocol_Version::TLS_V13);
687 }
688 }
689#endif
690
691#if defined(BOTAN_HAS_TLS_12)
692 if(offer.is_datagram_protocol()) {
693 if(offer >= Protocol_Version::DTLS_V12 && policy.allow_dtls12()) {
694 m_versions.push_back(Protocol_Version::DTLS_V12);
695 }
696 } else {
697 if(offer >= Protocol_Version::TLS_V12 && policy.allow_tls12()) {
698 m_versions.push_back(Protocol_Version::TLS_V12);
699 }
700 }
701#endif
702
703 // if no versions are supported, the input variables are not used
704 BOTAN_UNUSED(offer, policy);
705}
#define BOTAN_UNUSED
Definition assert.h:144

References Botan::TLS::Policy::allow_dtls12(), Botan::TLS::Policy::allow_tls12(), Botan::TLS::Policy::allow_tls13(), BOTAN_UNUSED, and Botan::TLS::Protocol_Version::is_datagram_protocol().

◆ Supported_Versions() [2/3]

Botan::TLS::Supported_Versions::Supported_Versions ( Protocol_Version version)
inlineexplicit

Definition at line 393 of file tls_extensions.h.

393{ m_versions.push_back(version); }

◆ Supported_Versions() [3/3]

Botan::TLS::Supported_Versions::Supported_Versions ( TLS_Data_Reader & reader,
uint16_t extension_size,
Connection_Side from )

Definition at line 707 of file tls_extensions.cpp.

707 {
708 if(from == Connection_Side::Server) {
709 if(extension_size != 2) {
710 throw Decoding_Error("Server sent invalid supported_versions extension");
711 }
712 m_versions.push_back(Protocol_Version(reader.get_uint16_t()));
713 } else {
714 auto versions = reader.get_range<uint16_t>(1, 1, 127);
715
716 for(auto v : versions) {
717 m_versions.push_back(Protocol_Version(v));
718 }
719
720 if(extension_size != 1 + 2 * versions.size()) {
721 throw Decoding_Error("Client sent invalid supported_versions extension");
722 }
723 }
724}
const std::vector< Protocol_Version > & versions() const

References Botan::TLS::TLS_Data_Reader::get_range(), Botan::TLS::TLS_Data_Reader::get_uint16_t(), Botan::TLS::Server, and versions().

Member Function Documentation

◆ empty()

bool Botan::TLS::Supported_Versions::empty ( ) const
inlineoverridevirtual
Returns
if we should encode this extension or not

Implements Botan::TLS::Extension.

Definition at line 389 of file tls_extensions.h.

389{ return m_versions.empty(); }

◆ is_implemented()

virtual bool Botan::TLS::Extension::is_implemented ( ) const
inlinevirtualinherited
Returns
true if this extension is known and implemented by Botan

Reimplemented in Botan::TLS::Unknown_Extension.

Definition at line 95 of file tls_extensions.h.

95{ return true; }

◆ serialize()

std::vector< uint8_t > Botan::TLS::Supported_Versions::serialize ( Connection_Side whoami) const
overridevirtual
Returns
serialized binary for the extension

Implements Botan::TLS::Extension.

Definition at line 653 of file tls_extensions.cpp.

653 {
654 std::vector<uint8_t> buf;
655
656 if(whoami == Connection_Side::Server) {
657 BOTAN_ASSERT_NOMSG(m_versions.size() == 1);
658 buf.push_back(m_versions[0].major_version());
659 buf.push_back(m_versions[0].minor_version());
660 } else {
661 BOTAN_ASSERT_NOMSG(!m_versions.empty());
662 const uint8_t len = static_cast<uint8_t>(m_versions.size() * 2);
663
664 buf.push_back(len);
665
666 for(const Protocol_Version version : m_versions) {
667 buf.push_back(version.major_version());
668 buf.push_back(version.minor_version());
669 }
670 }
671
672 return buf;
673}
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:75

References BOTAN_ASSERT_NOMSG, and Botan::TLS::Server.

◆ static_type()

Extension_Code Botan::TLS::Supported_Versions::static_type ( )
inlinestatic

Definition at line 383 of file tls_extensions.h.

References Botan::TLS::SupportedVersions.

Referenced by type().

◆ supports()

bool Botan::TLS::Supported_Versions::supports ( Protocol_Version version) const

Definition at line 726 of file tls_extensions.cpp.

726 {
727 for(auto v : m_versions) {
728 if(version == v) {
729 return true;
730 }
731 }
732 return false;
733}

◆ type()

Extension_Code Botan::TLS::Supported_Versions::type ( ) const
inlineoverridevirtual
Returns
code number of the extension

Implements Botan::TLS::Extension.

Definition at line 385 of file tls_extensions.h.

385{ return static_type(); }
static Extension_Code static_type()

References static_type().

◆ versions()

const std::vector< Protocol_Version > & Botan::TLS::Supported_Versions::versions ( ) const
inline

Definition at line 399 of file tls_extensions.h.

399{ return m_versions; }

Referenced by Supported_Versions().


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