Botan 3.14.1
Crypto and TLS for C&
Botan::PK_KEM_Options_Reader Class Referencefinal

#include <pk_options_readers.h>

Public Member Functions

const std::optional< std::string > & kdf () const
PK_KEM_Options_Reader & operator= (const PK_KEM_Options_Reader &)=delete
PK_KEM_Options_Reader & operator= (PK_KEM_Options_Reader &&)=delete
 PK_KEM_Options_Reader (const PK_KEM_Options_Reader &)=delete
 PK_KEM_Options_Reader (PK_KEM_Options_Reader &&)=delete
const std::optional< std::string > & provider () const
std::string to_string () const
 Format the options as a string, for error messages.
bool using_kdf () const
bool using_provider () const
bool using_raw_shared_key () const
 ~PK_KEM_Options_Reader ()=default

Friends

class PK_KEM_Decryptor
class PK_KEM_Encryptor
class PK_Options_Reader_Access

Detailed Description

Read access to a PK_KEM_Options

The library creates one of these when a PK_KEM_Encryptor or PK_KEM_Decryptor is constructed and passes it to the key's _create_kem_encryption_op or _create_kem_decryption_op; applications never create or hold one.

As with PK_Signature_Options_Reader, each getter records that the scheme examined the option, and any option set but never examined is rejected.

Definition at line 264 of file pk_options_readers.h.

Constructor & Destructor Documentation

◆ PK_KEM_Options_Reader() [1/2]

Botan::PK_KEM_Options_Reader::PK_KEM_Options_Reader ( const PK_KEM_Options_Reader & )
delete

◆ PK_KEM_Options_Reader() [2/2]

Botan::PK_KEM_Options_Reader::PK_KEM_Options_Reader ( PK_KEM_Options_Reader && )
delete

◆ ~PK_KEM_Options_Reader()

Botan::PK_KEM_Options_Reader::~PK_KEM_Options_Reader ( )
default

Member Function Documentation

◆ kdf()

const std::optional< std::string > & Botan::PK_KEM_Options_Reader::kdf ( ) const
inline

Definition at line 275 of file pk_options_readers.h.

275 {
276 note_examined(Option::Kdf);
277 return m_options.m_kdf;
278 }

Referenced by using_kdf().

◆ operator=() [1/2]

PK_KEM_Options_Reader & Botan::PK_KEM_Options_Reader::operator= ( const PK_KEM_Options_Reader & )
delete

◆ operator=() [2/2]

PK_KEM_Options_Reader & Botan::PK_KEM_Options_Reader::operator= ( PK_KEM_Options_Reader && )
delete

◆ provider()

const std::optional< std::string > & Botan::PK_KEM_Options_Reader::provider ( ) const
inline

◆ to_string()

std::string Botan::PK_KEM_Options_Reader::to_string ( ) const
inline

Format the options as a string, for error messages.

Definition at line 273 of file pk_options_readers.h.

273{ return m_options.to_string(); }

◆ using_kdf()

bool Botan::PK_KEM_Options_Reader::using_kdf ( ) const
inline

Definition at line 280 of file pk_options_readers.h.

280{ return kdf().has_value(); }
const std::optional< std::string > & kdf() const

References kdf().

Referenced by Botan::TLS::Hybrid_KEM_PrivateKey::_create_kem_decryption_op(), and Botan::TLS::Hybrid_KEM_PublicKey::_create_kem_encryption_op().

◆ using_provider()

bool Botan::PK_KEM_Options_Reader::using_provider ( ) const

Definition at line 425 of file pk_options.cpp.

425 {
426 note_examined(Option::Provider);
427 return provider_is_in_use(m_options.m_provider);
428}

◆ using_raw_shared_key()

bool Botan::PK_KEM_Options_Reader::using_raw_shared_key ( ) const
inline

Definition at line 282 of file pk_options_readers.h.

282 {
283 note_examined(Option::RawSharedKey);
284 return m_options.m_raw_shared_key;
285 }

Referenced by Botan::TLS::Hybrid_KEM_PrivateKey::_create_kem_decryption_op(), and Botan::TLS::Hybrid_KEM_PublicKey::_create_kem_encryption_op().

◆ PK_KEM_Decryptor

friend class PK_KEM_Decryptor
friend

Definition at line 296 of file pk_options_readers.h.

References PK_KEM_Decryptor.

Referenced by PK_KEM_Decryptor.

◆ PK_KEM_Encryptor

friend class PK_KEM_Encryptor
friend

Definition at line 295 of file pk_options_readers.h.

References PK_KEM_Encryptor.

Referenced by PK_KEM_Encryptor.

◆ PK_Options_Reader_Access

friend class PK_Options_Reader_Access
friend

Definition at line 297 of file pk_options_readers.h.

References PK_KEM_Options_Reader(), and PK_Options_Reader_Access.

Referenced by PK_Options_Reader_Access.


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