Botan::TLS::ExternalPSK Class Reference

#include <tls_external_psk.h>

Public Member Functions
	ExternalPSK (const ExternalPSK &)=delete
	ExternalPSK (ExternalPSK &&)=default
	ExternalPSK (std::string_view identity, std::string_view prf_algo, secure_vector< uint8_t > psk)
	ExternalPSK (std::string_view identity, std::string_view prf_algo, secure_vector< uint8_t > psk, bool imported)
secure_vector< uint8_t >	extract_master_secret ()
const std::string &	identity () const
bool	is_imported () const
ExternalPSK &	operator= (const ExternalPSK &)=delete
ExternalPSK &	operator= (ExternalPSK &&)=default
const std::string &	prf_algo () const
	~ExternalPSK ()=default

Detailed Description

This is an externally provided PreSharedKey along with its identity, master secret and (in case of TLS 1.3) a pre-provisioned Pseudo Random Function.

Definition at line 22 of file tls_external_psk.h.

Constructor & Destructor Documentation

ExternalPSK() [1/4]

Botan::TLS::ExternalPSK::ExternalPSK ( const ExternalPSK & )

delete

References ExternalPSK().

Referenced by ExternalPSK(), ExternalPSK(), operator=(), and operator=().

ExternalPSK() [2/4]

Botan::TLS::ExternalPSK::ExternalPSK ( ExternalPSK && )

default

References ExternalPSK().

~ExternalPSK()

Botan::TLS::ExternalPSK::~ExternalPSK ( )

default

ExternalPSK() [3/4]

Botan::TLS::ExternalPSK::ExternalPSK ( std::string_view identity, std::string_view prf_algo, secure_vector< uint8_t > psk )

inline

Definition at line 30 of file tls_external_psk.h.

                                                                                                :
            m_identity(identity), m_prf_algo(prf_algo), m_master_secret(std::move(psk)), m_is_imported(false) {}

References identity(), and prf_algo().

ExternalPSK() [4/4]

Botan::TLS::ExternalPSK::ExternalPSK ( std::string_view identity, std::string_view prf_algo, secure_vector< uint8_t > psk, bool imported )

inline

Definition at line 33 of file tls_external_psk.h.

                                                                                                               :
            m_identity(identity), m_prf_algo(prf_algo), m_master_secret(std::move(psk)), m_is_imported(imported) {}

References identity(), and prf_algo().

Member Function Documentation

extract_master_secret()

secure_vector< uint8_t > Botan::TLS::ExternalPSK::extract_master_secret

(

)

Returns the master secret by moving it out of this object. Do not call this method more than once.

Definition at line 16 of file tls_external_psk.cpp.

                                                          {
   BOTAN_STATE_CHECK(!m_master_secret.empty());
   return std::exchange(m_master_secret, {});
}

References BOTAN_STATE_CHECK.

identity()

const std::string & Botan::TLS::ExternalPSK::identity ( ) const

inline

Identity (e.g. username of the PSK owner) of the preshared key. Despite the std::string return type, this may or may not be a human-readable/printable string.

Definition at line 41 of file tls_external_psk.h.

{ return m_identity; }

Referenced by ExternalPSK(), and ExternalPSK().

is_imported()

bool Botan::TLS::ExternalPSK::is_imported ( ) const

inline

Returns true if this PSK was derived using the PSK importer mechanism from RFC 9258. Imported PSKs use the "imp binder" label for binder computation instead of "ext binder".

Definition at line 61 of file tls_external_psk.h.

{ return m_is_imported; }

operator=() [1/2]

ExternalPSK & Botan::TLS::ExternalPSK::operator= ( const ExternalPSK & )

delete

References ExternalPSK().

operator=() [2/2]

ExternalPSK & Botan::TLS::ExternalPSK::operator= ( ExternalPSK && )

default

References ExternalPSK().

prf_algo()

const std::string & Botan::TLS::ExternalPSK::prf_algo ( ) const

inline

External preshared keys in TLS 1.3 must be provisioned with a pseudo-random function (typically SHA-256 or the like). This is needed to calculate/verify the PSK binder values in the client hello.

Definition at line 54 of file tls_external_psk.h.

{ return m_prf_algo; }

Referenced by ExternalPSK(), and ExternalPSK().

---

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

• src/lib/tls/tls_external_psk.h
• src/lib/tls/tls_external_psk.cpp