Botan::TLS::Protocol_Version Class Reference

#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 60 of file tls_version.h.

: m_version(0) {}

Protocol_Version() [2/4]

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

inlineexplicit

Definition at line 62 of file tls_version.h.

: 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 67 of file tls_version.h.

: Protocol_Version(static_cast<uint16_t>(named_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 73 of file tls_version.h.

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

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 36 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>(), Botan::TLS::Client_Hello_12::random(), Botan::TLS::Supported_Versions::Supported_Versions(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::TLS_CBC_HMAC_AEAD_Mode().

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 40 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::Session_Manager_Hybrid::establish(), Botan::TLS::Channel_Impl::request_downgrade_for_resumption(), Botan::TLS::Session::Session(), Botan::TLS::Session::Session(), Botan::TLS::Session::Session(), 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 45 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 84 of file tls_version.cpp.

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

References BOTAN_HAS_TLS_13.

latest_dtls_version()

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

inlinestatic

Returns the latest version of the DTLS protocol known to the library (currently DTLS v1.2)

Returns

latest known DTLS version

Definition at line 58 of file tls_version.h.

{ return Protocol_Version(DTLS_V12); }

References Botan::TLS::DTLS_V12.

latest_tls_version()

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

inlinestatic

Returns the latest version of the TLS protocol known to the library (currently TLS v1.3)

Returns

latest known TLS version

Definition at line 44 of file tls_version.h.

                                                   {
#if defined(BOTAN_HAS_TLS_13)
         return Protocol_Version(TLS_V13);
#else
         return Protocol_Version(TLS_V12);
#endif
      }

References Botan::TLS::TLS_V12, and Botan::TLS::TLS_V13.

major_version()

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

inline

Returns

major version of the protocol version

Definition at line 89 of file tls_version.h.

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

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Session::DER_encode(), 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 94 of file tls_version.h.

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

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Session::DER_encode(), 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 133 of file tls_version.h.

{ return (m_version != other.m_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 148 of file tls_version.h.

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

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 153 of file tls_version.h.

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

operator==()

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

inline

Returns

if this version is equal to other

Definition at line 128 of file tls_version.h.

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

operator>()

bool Botan::TLS::Protocol_Version::operator>

(

const Protocol_Version &

other

)

const

Returns

if this version is later than other

Definition at line 50 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(), 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 143 of file tls_version.h.

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

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 16 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 62 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 99 of file tls_version.h.

{ 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