#include <tls_session.h>

Inheritance diagram for Botan::TLS::Session_Base:

Public Member Functions
Ciphersuite	ciphersuite () const
uint16_t	ciphersuite_code () const
uint16_t	dtls_srtp_profile () const
Session_Base &	operator= (const Session_Base &other)
Session_Base &	operator= (Session_Base &&other) noexcept
const std::vector< X509_Certificate > &	peer_certs () const
std::shared_ptr< const Public_Key >	peer_raw_public_key () const
const Server_Information &	server_info () const
	Session_Base (const Session_Base &other)
	Session_Base (Session_Base &&other) noexcept
	Session_Base (std::chrono::system_clock::time_point start_time, Protocol_Version version, uint16_t ciphersuite, Connection_Side connection_side, uint16_t srtp_profile, bool extended_master_secret, bool encrypt_then_mac, const std::vector< X509_Certificate > &peer_certs, std::shared_ptr< const Public_Key > peer_raw_public_key, Server_Information server_info)
Connection_Side	side () const
std::chrono::system_clock::time_point	start_time () const
bool	supports_encrypt_then_mac () const
bool	supports_extended_master_secret () const
Protocol_Version	version () const
	~Session_Base ()

Protected Member Functions
	Session_Base ()

Protected Attributes
uint16_t	m_ciphersuite = 0
Connection_Side	m_connection_side = Connection_Side::Client
bool	m_encrypt_then_mac = false
bool	m_extended_master_secret = false
std::vector< X509_Certificate >	m_peer_certs
std::shared_ptr< const Public_Key >	m_peer_raw_public_key
Server_Information	m_server_info
uint16_t	m_srtp_profile = 0
std::chrono::system_clock::time_point	m_start_time
Protocol_Version	m_version

Detailed Description

Represents basic information about a session that can be both persisted for resumption and presented to the application as a summary of a specific just-established TLS session.

Definition at line 41 of file tls_session.h.

Constructor & Destructor Documentation

◆ Session_Base() [1/4]

Botan::TLS::Session_Base::Session_Base	(	std::chrono::system_clock::time_point	start_time,
		Protocol_Version	version,
		uint16_t	ciphersuite,
		Connection_Side	connection_side,
		uint16_t	srtp_profile,
		bool	extended_master_secret,
		bool	encrypt_then_mac,
		const std::vector< X509_Certificate > &	peer_certs,
		std::shared_ptr< const Public_Key >	peer_raw_public_key,
		Server_Information	server_info )

Definition at line 102 of file tls_session.cpp.

                                                           :
      m_start_time(start_time),
      m_version(version),
      m_ciphersuite(ciphersuite),
      m_connection_side(connection_side),
      m_srtp_profile(srtp_profile),
      m_extended_master_secret(extended_master_secret),
      m_encrypt_then_mac(encrypt_then_mac),
      m_peer_certs(peer_certs),
      m_peer_raw_public_key(std::move(peer_raw_public_key)),
      m_server_info(std::move(server_info)) {}

References ciphersuite(), m_ciphersuite, m_connection_side, m_encrypt_then_mac, m_extended_master_secret, m_peer_certs, m_peer_raw_public_key, m_server_info, m_srtp_profile, m_start_time, m_version, peer_certs(), peer_raw_public_key(), server_info(), start_time(), and version().

Referenced by Botan::TLS::Session_Summary::Client_Impl_13, operator=(), operator=(), Botan::TLS::Session::Session(), Botan::TLS::Session::Session(), Session_Base(), and Session_Base().

◆ Session_Base() [2/4]

Botan::TLS::Session_Base::Session_Base ( const Session_Base & other )

default

References Session_Base().

◆ Session_Base() [3/4]

Botan::TLS::Session_Base::Session_Base ( Session_Base && other )

defaultnoexcept

References Session_Base().

◆ ~Session_Base()

Botan::TLS::Session_Base::~Session_Base ( )

default

◆ Session_Base() [4/4]

Botan::TLS::Session_Base::Session_Base ( )

protecteddefault

Member Function Documentation

◆ ciphersuite()

Ciphersuite Botan::TLS::Session_Base::ciphersuite ( ) const

Get the ciphersuite info of the negotiated TLS session

Definition at line 123 of file tls_session.cpp.

                                            {
   auto suite = Ciphersuite::by_id(m_ciphersuite);
   if(!suite.has_value()) {
      throw Decoding_Error("Failed to find cipher suite for ID " + std::to_string(m_ciphersuite));
   }
   return suite.value();
}

References Botan::TLS::Ciphersuite::by_id(), and m_ciphersuite.

Referenced by Botan::TLS::Session_Summary::cipher_algo(), Botan::TLS::Session_Summary::mac_algo(), Botan::TLS::Session_Summary::prf_algo(), Botan::TLS::Session::Session(), Botan::TLS::Session::Session(), and Session_Base().

◆ ciphersuite_code()

uint16_t Botan::TLS::Session_Base::ciphersuite_code ( ) const

inline

Get the ciphersuite code of the negotiated TLS session

Definition at line 79 of file tls_session.h.

79{ return m_ciphersuite; }

References m_ciphersuite.

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

◆ dtls_srtp_profile()

uint16_t Botan::TLS::Session_Base::dtls_srtp_profile ( ) const

inline

Get the negotiated DTLS-SRTP algorithm (RFC 5764)

Definition at line 94 of file tls_session.h.

94{ return m_srtp_profile; }

References m_srtp_profile.

◆ operator=() [1/2]

Session_Base & Botan::TLS::Session_Base::operator= ( const Session_Base & other )

default

References Session_Base().

◆ operator=() [2/2]

Session_Base & Botan::TLS::Session_Base::operator= ( Session_Base && other )

defaultnoexcept

References Session_Base().

◆ peer_certs()

const std::vector< X509_Certificate > & Botan::TLS::Session_Base::peer_certs ( ) const

inline

Return the certificate chain of the peer (possibly empty)

Definition at line 111 of file tls_session.h.

111{ return m_peer_certs; }

References m_peer_certs.

Referenced by Botan::TLS::Session_Summary::Client_Impl_13, Botan::TLS::Session::Session(), and Session_Base().

◆ peer_raw_public_key()

std::shared_ptr< const Public_Key > Botan::TLS::Session_Base::peer_raw_public_key ( ) const

inline

Return the raw public key of the peer (possibly empty)

Definition at line 116 of file tls_session.h.

116{ return m_peer_raw_public_key; }

References m_peer_raw_public_key.

Referenced by Botan::TLS::Session_Summary::Client_Impl_13, Botan::TLS::Session::Session(), and Session_Base().

◆ server_info()

const Server_Information & Botan::TLS::Session_Base::server_info ( ) const

inline

Get information about the TLS server

Returns information that identifies the server side of the connection. This is useful for the client in that it identifies what was originally passed to the constructor. For the server, it includes the name the client specified in the server name indicator extension.

Definition at line 126 of file tls_session.h.

126{ return m_server_info; }

References m_server_info.

Referenced by Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Session_Summary::Client_Impl_13, Botan::TLS::Session::Session(), Botan::TLS::Session::Session(), Session_Base(), and Botan::TLS::Session_Manager_SQL::store().