#include <tls_version.h>

Public Member Functions
bool	is_datagram_protocol () const
bool	is_pre_tls_13 () const
bool	is_tls_13_or_later () const
bool	known_version () const
uint8_t	major_version () const
uint8_t	minor_version () const
bool	operator!= (const Protocol_Version &other) const
bool	operator< (const Protocol_Version &other) const
bool	operator<= (const Protocol_Version &other) const
bool	operator== (const Protocol_Version &other) const
bool	operator> (const Protocol_Version &other) const
bool	operator>= (const Protocol_Version &other) const
	Protocol_Version ()
	Protocol_Version (uint16_t code)
	Protocol_Version (uint8_t major, uint8_t minor)
	Protocol_Version (Version_Code named_version)
std::string	to_string () const
bool	valid () const
uint16_t	version_code () const

Static Public Member Functions
static Protocol_Version	latest_dtls_version ()
static Protocol_Version	latest_tls_version ()

Detailed Description

TLS Protocol Version

Definition at line 34 of file tls_version.h.

Constructor & Destructor Documentation

◆ Protocol_Version() [1/4]

Botan::TLS::Protocol_Version::Protocol_Version ( )

inline

Definition at line 54 of file tls_version.h.

54: m_version(0) {}

Referenced by latest_dtls_version(), latest_tls_version(), operator!=(), operator<(), operator<=(), operator==(), operator>(), operator>=(), Protocol_Version(), and Protocol_Version().

◆ Protocol_Version() [2/4]

Botan::TLS::Protocol_Version::Protocol_Version ( uint16_t code )

inlineexplicit

Definition at line 56 of file tls_version.h.

56: m_version(code) {}

◆ Protocol_Version() [3/4]

Botan::TLS::Protocol_Version::Protocol_Version ( Version_Code named_version )

inline

Parameters

named_version a specific named version of the protocol

Definition at line 61 of file tls_version.h.

61 : // NOLINT(*-explicit-conversions)

62 Protocol_Version(static_cast<uint16_t>(named_version)) {}

Botan::TLS::Protocol_Version::Protocol_Version

Protocol_Version()

Definition tls_version.h:54

References Protocol_Version().

◆ Protocol_Version() [4/4]

Botan::TLS::Protocol_Version::Protocol_Version	(	uint8_t	major,
		uint8_t	minor )

inline

Parameters

major	the major version
minor	the minor version

Definition at line 68 of file tls_version.h.

68 :

69 Protocol_Version(static_cast<uint16_t>((static_cast<uint16_t>(major) << 8) | minor)) {}

References Protocol_Version().

Member Function Documentation

◆ is_datagram_protocol()

bool Botan::TLS::Protocol_Version::is_datagram_protocol ( ) const

Returns: true iff this is a DTLS version

Definition at line 54 of file tls_version.cpp.

                                                  {
   return major_version() > 250;
}

References major_version().

Referenced by Botan::TLS::Client::Client(), Botan::TLS::Channel_Impl_12::create_handshake_state(), Botan::TLS::Hello_Verify_Request::Hello_Verify_Request(), is_pre_tls_13(), is_tls_13_or_later(), operator>(), and Botan::TLS::Supported_Versions::Supported_Versions().

◆ is_pre_tls_13()

bool Botan::TLS::Protocol_Version::is_pre_tls_13 ( ) const

Returns: true if this version indicates (D)TLS 1.2 or older

Definition at line 58 of file tls_version.cpp.

                                           {
   return (!is_datagram_protocol() && *this <= Protocol_Version::TLS_V12) ||
          (is_datagram_protocol() && *this <= Protocol_Version::DTLS_V12);
}

References is_datagram_protocol().

Referenced by Botan::TLS::Policy::ciphersuite_list(), Botan::TLS::Client::Client(), Botan::TLS::Session_Manager_Hybrid::establish(), Botan::TLS::make_server_hello_random(), Botan::TLS::Channel_Impl::request_downgrade_for_resumption(), Botan::TLS::Callbacks::tls_should_persist_resumption_information(), and Botan::TLS::Ciphersuite::usable_in_version().

◆ is_tls_13_or_later()

bool Botan::TLS::Protocol_Version::is_tls_13_or_later ( ) const

Returns: true if this version indicates a (D)TLS newer than 1.3

Definition at line 63 of file tls_version.cpp.

                                                {
   return (!is_datagram_protocol() && *this >= Protocol_Version::TLS_V13) ||
          (is_datagram_protocol() && *this >= Protocol_Version::DTLS_V13);
}

References is_datagram_protocol().

◆ known_version()

bool Botan::TLS::Protocol_Version::known_version ( ) const

Returns: true if this is a protocol version we know about

Definition at line 102 of file tls_version.cpp.

                                           {
#if defined(BOTAN_HAS_TLS_13)
   if(m_version == static_cast<uint16_t>(Protocol_Version::TLS_V13)) {
      return true;
   }
#endif
 
#if defined(BOTAN_HAS_TLS_12)
   if(m_version == static_cast<uint16_t>(Protocol_Version::TLS_V12)) {
      return true;
   }
   if(m_version == static_cast<uint16_t>(Protocol_Version::DTLS_V12)) {
      return true;
   }
#endif
 
   return false;
}

◆ latest_dtls_version()

Protocol_Version Botan::TLS::Protocol_Version::latest_dtls_version ( )

static

Returns the latest version of the DTLS protocol known to the library and available in the current build.

Returns: latest known DTLS version

Definition at line 26 of file tls_version.cpp.

                                                       {
#if defined(BOTAN_HAS_TLS_12)
   return Protocol_Version::DTLS_V12;
#else
   throw Not_Implemented("This build contains no usable DTLS version");
#endif
}

References Protocol_Version().

◆ latest_tls_version()

Protocol_Version Botan::TLS::Protocol_Version::latest_tls_version ( )

static

Returns the latest version of the TLS protocol known to the library and available in the current build.

Returns: latest known TLS version

Definition at line 16 of file tls_version.cpp.

                                                      {
#if defined(BOTAN_HAS_TLS_13)
   return Protocol_Version::TLS_V13;
#elif defined(BOTAN_HAS_TLS_12)
   return Protocol_Version::TLS_V12;
#else
   throw Not_Implemented("This build contains no usable TLS version");
#endif
}

References Protocol_Version().

◆ major_version()

uint8_t Botan::TLS::Protocol_Version::major_version ( ) const

inline

Returns: major version of the protocol version

Definition at line 84 of file tls_version.h.

84{ return static_cast<uint8_t>(m_version >> 8); }

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Connection_Cipher_State::format_ad(), Botan::TLS::Channel_Impl_12::from_peer(), is_datagram_protocol(), Botan::TLS::Hello_Verify_Request::serialize(), to_string(), and valid().

◆ minor_version()

uint8_t Botan::TLS::Protocol_Version::minor_version ( ) const

inline

Returns: minor version of the protocol version

Definition at line 89 of file tls_version.h.

89{ return static_cast<uint8_t>(m_version & 0xFF); }

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Connection_Cipher_State::format_ad(), Botan::TLS::Hello_Verify_Request::serialize(), to_string(), and valid().

◆ operator!=()

bool Botan::TLS::Protocol_Version::operator!= ( const Protocol_Version & other ) const

inline

Returns: if this version is not equal to other

Definition at line 128 of file tls_version.h.

128{ return (m_version != other.m_version); }

References Protocol_Version().

◆ operator<()

bool Botan::TLS::Protocol_Version::operator< ( const Protocol_Version & other ) const

inline

Returns: if this version is earlier to other

Definition at line 143 of file tls_version.h.

143{ return !(*this >= other); }

References Protocol_Version().

◆ operator<=()

bool Botan::TLS::Protocol_Version::operator<= ( const Protocol_Version & other ) const

inline

Returns: if this version is earlier than or equal to other

Definition at line 148 of file tls_version.h.

148{ return (*this == other || *this < other); }

References Protocol_Version().

◆ operator==()

bool Botan::TLS::Protocol_Version::operator== ( const Protocol_Version & other ) const

inline

Returns: if this version is equal to other

Definition at line 123 of file tls_version.h.

123{ return (m_version == other.m_version); }

References Protocol_Version().

◆ operator>()

bool Botan::TLS::Protocol_Version::operator> ( const Protocol_Version & other ) const

Returns: if this version is later than other

Definition at line 68 of file tls_version.cpp.

                                                                    {
   if(this->is_datagram_protocol() != other.is_datagram_protocol()) {
      throw TLS_Exception(Alert::ProtocolVersion, "Version comparing " + to_string() + " with " + other.to_string());
   }
 
   if(this->is_datagram_protocol()) {
      return m_version < other.m_version;  // goes backwards
   }
 
   return m_version > other.m_version;
}

References is_datagram_protocol(), Protocol_Version(), and to_string().

◆ operator>=()

bool Botan::TLS::Protocol_Version::operator>= ( const Protocol_Version & other ) const

inline

Returns: if this version is later than or equal to other

Definition at line 138 of file tls_version.h.

138{ return (*this == other || *this > other); }

References Protocol_Version().

◆ to_string()

std::string Botan::TLS::Protocol_Version::to_string ( ) const

Generate a human readable version string.

for instance "TLS v1.1" or "DTLS v1.0".

Returns: human-readable description of this version

Definition at line 34 of file tls_version.cpp.

                                            {
   const uint8_t maj = major_version();
   const uint8_t min = minor_version();
 
   if(maj == 3 && min == 0) {
      return "SSL v3";
   }
 
   if(maj == 3 && min >= 1) {  // TLS v1.x
      return "TLS v1." + std::to_string(min - 1);
   }
 
   if(maj == 254) {  // DTLS 1.x
      return "DTLS v1." + std::to_string(255 - min);
   }
 
   // Some very new or very old protocol (or bogus data)
   return "Unknown " + std::to_string(maj) + "." + std::to_string(min);
}

References major_version(), and minor_version().

Referenced by Botan::TLS::Channel_Impl_12::create_handshake_state(), and operator>().

◆ valid()

bool Botan::TLS::Protocol_Version::valid ( ) const

Returns: true if this is a valid protocol version

Definition at line 80 of file tls_version.cpp.

                                   {
   const uint8_t maj = major_version();
   const uint8_t min = minor_version();
 
   if(maj == 3 && min <= 4) {
      // 3.0: SSLv3
      // 3.1: TLS 1.0
      // 3.2: TLS 1.1
      // 3.3: TLS 1.2
      // 3.4: TLS 1.3
      return true;
   }
 
   if(maj == 254 && (min == 253 || min == 255)) {
      // 254.253: DTLS 1.2
      // 254.255: DTLS 1.0
      return true;
   }
 
   return false;
}

References major_version(), and minor_version().

◆ version_code()

uint16_t Botan::TLS::Protocol_Version::version_code ( ) const

inline

Returns: the version code

Definition at line 94 of file tls_version.h.

94{ return m_version; }

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

src/lib/tls/tls_version.h
src/lib/tls/tls_version.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Protocol_Version() [1/4]

◆ Protocol_Version() [2/4]

◆ Protocol_Version() [3/4]

◆ Protocol_Version() [4/4]

Member Function Documentation

◆ is_datagram_protocol()

◆ is_pre_tls_13()

◆ is_tls_13_or_later()

◆ known_version()

◆ latest_dtls_version()

◆ latest_tls_version()

◆ major_version()

◆ minor_version()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ to_string()

◆ valid()

◆ version_code()