#include <tls_session.h>

Inheritance diagram for Botan::TLS::Session_Summary:

Public Member Functions
std::string	cipher_algo () const

Ciphersuite	ciphersuite () const

uint16_t	ciphersuite_code () const

uint16_t	dtls_srtp_profile () const

const std::optional< std::string > &	external_psk_identity () const

std::string	kex_algo () const

std::string	mac_algo () const

const std::vector< X509_Certificate > &	peer_certs () const

std::shared_ptr< const Public_Key >	peer_raw_public_key () const

std::string	prf_algo () const

bool	psk_used () const

const Server_Information &	server_info () const

const Session_ID &	session_id () const

const std::optional< Session_Ticket > &	session_ticket () const

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

bool	was_resumption () const

Protected Attributes
uint16_t	m_ciphersuite

Connection_Side	m_connection_side

bool	m_encrypt_then_mac

bool	m_extended_master_secret

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

std::chrono::system_clock::time_point	m_start_time

Protocol_Version	m_version

Friends
class	Client_Impl_12

class	Client_Impl_13

class	Server_Impl_12

class	Server_Impl_13

Detailed Description

Summarizes the negotiated features after a TLS handshake. Applications may query those in Callbacks::tls_session_established().

Definition at line 246 of file tls_session.h.

Member Function Documentation

◆ cipher_algo()

std::string Botan::TLS::Session_Summary::cipher_algo ( ) const

inline

Definition at line 291 of file tls_session.h.

291{ return ciphersuite().cipher_algo(); }

Botan::TLS::Ciphersuite::cipher_algo

std::string cipher_algo() const

Definition tls_ciphersuite.h:103

Botan::TLS::Session_Base::ciphersuite

Ciphersuite ciphersuite() const

Definition tls_session.cpp:86

◆ ciphersuite()

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

inherited

Get the ciphersuite info of the negotiated TLS session

Definition at line 86 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 Botan::TLS::Session_Base::m_ciphersuite.

◆ ciphersuite_code()

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

inlineinherited

Get the ciphersuite code of the negotiated TLS session

Definition at line 177 of file tls_session.h.

177{ return 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

inlineinherited

Get the negotiated DTLS-SRTP algorithm (RFC 5764)

Definition at line 192 of file tls_session.h.

192{ return m_srtp_profile; }

Botan::TLS::Session_Base::m_srtp_profile

uint16_t m_srtp_profile

Definition tls_session.h:232

◆ external_psk_identity()

const std::optional< std::string > & Botan::TLS::Session_Summary::external_psk_identity ( ) const

inline

The negotiated identity of an externally provided preshared key used to establish this session. For TLS 1.3 this may be any of the externally provided PSKs offered by the client. PSK identities used as session tickets for TLS 1.3 session resumption won't be shown here.

Definition at line 268 of file tls_session.h.

268{ return m_external_psk_identity; }

◆ kex_algo()

std::string Botan::TLS::Session_Summary::kex_algo ( ) const

inline

Definition at line 289 of file tls_session.h.

289{ return m_kex_algo; }

◆ mac_algo()

std::string Botan::TLS::Session_Summary::mac_algo ( ) const

inline

Definition at line 293 of file tls_session.h.

293{ return ciphersuite().mac_algo(); }

Botan::TLS::Ciphersuite::mac_algo

std::string mac_algo() const

Definition tls_ciphersuite.h:108

◆ peer_certs()

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

inlineinherited

Return the certificate chain of the peer (possibly empty)

Definition at line 209 of file tls_session.h.

209{ return m_peer_certs; }

Botan::TLS::Session_Base::m_peer_certs

std::vector< X509_Certificate > m_peer_certs

Definition tls_session.h:237

◆ peer_raw_public_key()

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

inlineinherited

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

Definition at line 214 of file tls_session.h.

214{ return m_peer_raw_public_key; }

Botan::TLS::Session_Base::m_peer_raw_public_key

std::shared_ptr< const Public_Key > m_peer_raw_public_key

Definition tls_session.h:238

◆ prf_algo()

std::string Botan::TLS::Session_Summary::prf_algo ( ) const

inline

Definition at line 295 of file tls_session.h.

295{ return ciphersuite().prf_algo(); }

Botan::TLS::Ciphersuite::prf_algo

std::string prf_algo() const

Definition tls_ciphersuite.h:110

◆ psk_used()

bool Botan::TLS::Session_Summary::psk_used ( ) const

inline

Indicates that the session was established using an externally provided PSK. Session resumptions in TLS 1.3 (while technically implemented using a PSK) are not considered here.

See also: was_resumption()

Note: Botan 3.0 and 3.1 did incorrectly report true for session resumption.

Returns: true if the session was established using an externally provided PSK.

Definition at line 280 of file tls_session.h.

280{ return m_external_psk_identity.has_value(); }

◆ server_info()

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

inlineinherited

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 224 of file tls_session.h.

224{ return m_server_info; }

Botan::TLS::Session_Base::m_server_info

Server_Information m_server_info

Definition tls_session.h:239

Referenced by Botan::TLS::Client_Hello_12::Client_Hello_12(), and Botan::TLS::Session_Manager_SQL::store().

◆ session_id()

const Session_ID & Botan::TLS::Session_Summary::session_id ( ) const

inline

The Session_ID negotiated during the handshake. Note that this does not carry any meaning in TLS 1.3 and might even be empty.

Definition at line 253 of file tls_session.h.

253{ return m_session_id; }

◆ session_ticket()

const std::optional< Session_Ticket > & Botan::TLS::Session_Summary::session_ticket ( ) const

inline

The session ticket a TLS 1.2 server issued for this session. Note that this may be set in TLS 1.2 clients only. It is not the ticket used to establish this session.

Definition at line 260 of file tls_session.h.

260{ return m_session_ticket; }