#include <sym_algo.h>

Inheritance diagram for Botan::SymmetricAlgorithm:

Public Member Functions
virtual void	clear ()=0
virtual bool	has_keying_material () const =0
virtual Key_Length_Specification	key_spec () const =0
size_t	maximum_keylength () const
size_t	minimum_keylength () const
virtual std::string	name () const =0
SymmetricAlgorithm &	operator= (const SymmetricAlgorithm &other)=default
SymmetricAlgorithm &	operator= (SymmetricAlgorithm &&other)=default
void	set_key (const OctetString &key)
void	set_key (const uint8_t key[], size_t length)
void	set_key (std::span< const uint8_t > key)
	SymmetricAlgorithm ()=default
	SymmetricAlgorithm (const SymmetricAlgorithm &other)=default
	SymmetricAlgorithm (SymmetricAlgorithm &&other)=default
bool	valid_keylength (size_t length) const
virtual	~SymmetricAlgorithm ()=default

Protected Member Functions
void	assert_key_material_set () const
void	assert_key_material_set (bool predicate) const

Detailed Description

This class represents a symmetric algorithm object.

Definition at line 83 of file sym_algo.h.

Constructor & Destructor Documentation

◆ SymmetricAlgorithm() [1/3]

Botan::SymmetricAlgorithm::SymmetricAlgorithm ( )

default

Default constructor

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

◆ ~SymmetricAlgorithm()

virtual Botan::SymmetricAlgorithm::~SymmetricAlgorithm ( )

virtualdefault

◆ SymmetricAlgorithm() [2/3]

Botan::SymmetricAlgorithm::SymmetricAlgorithm ( const SymmetricAlgorithm & other )

default

Copy constructor

References SymmetricAlgorithm().

◆ SymmetricAlgorithm() [3/3]

Botan::SymmetricAlgorithm::SymmetricAlgorithm ( SymmetricAlgorithm && other )

default

Move constructor

References SymmetricAlgorithm().

Member Function Documentation

◆ assert_key_material_set() [1/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( ) const

inlineprotected

Throw Key_Not_Set unless a key has been set on this object

Definition at line 180 of file sym_algo.h.

180{ assert_key_material_set(has_keying_material()); }

Botan::SymmetricAlgorithm::has_keying_material

virtual bool has_keying_material() const =0

Botan::SymmetricAlgorithm::assert_key_material_set

void assert_key_material_set() const

Definition sym_algo.h:180

References assert_key_material_set(), and has_keying_material().

Referenced by assert_key_material_set(), Botan::Salsa20::cipher_bytes(), Botan::Lion::decrypt_n(), Botan::Lion::encrypt_n(), Botan::GHASH::final(), Botan::Polyval::final(), Botan::Salsa20::generate_keystream(), Botan::GHASH::nonce_hash(), Botan::GHASH::reset_associated_data(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::GHASH::set_associated_data(), Botan::OCB_Mode::set_associated_data_n(), Botan::Salsa20::set_iv_bytes(), Botan::GHASH::update(), Botan::Polyval::update(), Botan::GHASH::update_associated_data(), and Botan::Polyval::zero_pad().

◆ assert_key_material_set() [2/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( bool predicate ) const

inlineprotected

Throw Key_Not_Set unless the predicate holds

Parameters

predicate if false, a Key_Not_Set exception is thrown

Definition at line 186 of file sym_algo.h.

                                                         {
         if(!predicate) {
            throw_key_not_set_error();
         }
      }

◆ clear()

virtual void Botan::SymmetricAlgorithm::clear ( )

pure virtual

Reset the internal state. This includes not just the key, but any partial message that may have been in process.

Implemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::ANSI_X919_MAC, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Ascon_AEAD128_Mode, Botan::BLAKE2b, Botan::BLAKE2bMAC, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CBC_Mode, Botan::CCM_Mode, Botan::CFB_Mode, Botan::ChaCha20Poly1305_Mode, Botan::ChaCha, Botan::CMAC, Botan::CTR_BE, Botan::DES, Botan::EAX_Mode, Botan::FPE_FE1, Botan::GCM_Mode, Botan::GCM_SIV_Mode, Botan::GHASH, Botan::GMAC, Botan::GOST_28147_89, Botan::HMAC, Botan::IDEA, Botan::KMAC, Botan::Kuznyechik, Botan::Lion, Botan::Noekeon, Botan::OCB_Mode, Botan::OFB, Botan::Poly1305, Botan::Polyval, Botan::RC4, Botan::Salsa20, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SHAKE_Cipher, Botan::SipHash, Botan::SIV_Mode, Botan::SM4, Botan::Threefish_512, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::TLS::TLS_NULL_HMAC_AEAD_Mode, Botan::TripleDES, Botan::Twofish, and Botan::XTS_Mode.

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::clear(), and Botan::TLS::TLS_NULL_HMAC_AEAD_Mode::clear().

◆ has_keying_material()

virtual bool Botan::SymmetricAlgorithm::has_keying_material ( ) const

pure virtual

Test whether a key has been set on this object

Returns: true if a key has been set on this object

Implemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::ANSI_X919_MAC, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Ascon_AEAD128_Mode, Botan::BLAKE2b, Botan::BLAKE2bMAC, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CBC_Mode, Botan::CCM_Mode, Botan::CFB_Mode, Botan::ChaCha20Poly1305_Mode, Botan::ChaCha, Botan::CMAC, Botan::CTR_BE, Botan::DES, Botan::EAX_Mode, Botan::FPE_FE1, Botan::GCM_Mode, Botan::GCM_SIV_Mode, Botan::GHASH, Botan::GMAC, Botan::GOST_28147_89, Botan::HMAC, Botan::IDEA, Botan::KMAC, Botan::Kuznyechik, Botan::Lion, Botan::Noekeon, Botan::OCB_Mode, Botan::OFB, Botan::Poly1305, Botan::Polyval, Botan::RC4, Botan::Salsa20, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SHAKE_Cipher, Botan::SipHash, Botan::SIV_Mode, Botan::SM4, Botan::Threefish_512, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::TLS::TLS_NULL_HMAC_AEAD_Mode, Botan::TripleDES, Botan::Twofish, and Botan::XTS_Mode.

Referenced by assert_key_material_set(), Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::has_keying_material(), and Botan::TLS::TLS_NULL_HMAC_AEAD_Mode::has_keying_material().

◆ key_spec()

virtual Key_Length_Specification Botan::SymmetricAlgorithm::key_spec ( ) const

pure virtual

Return the key lengths supported by this algorithm

Returns: object describing limits on key size

Referenced by Botan::CBC_Mode::key_spec(), Botan::CFB_Mode::key_spec(), Botan::XTS_Mode::key_spec(), maximum_keylength(), minimum_keylength(), and valid_keylength().

◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inline

Return the largest acceptable key length

Returns: maximum allowed key length

Definition at line 130 of file sym_algo.h.

130{ return key_spec().maximum_keylength(); }

Botan::Key_Length_Specification::maximum_keylength

size_t maximum_keylength() const

Definition sym_algo.h:58

Botan::SymmetricAlgorithm::key_spec

virtual Key_Length_Specification key_spec() const =0

References key_spec().

◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const

inline

Return the smallest acceptable key length

Returns: minimum allowed key length

Definition at line 136 of file sym_algo.h.

136{ return key_spec().minimum_keylength(); }

Botan::Key_Length_Specification::minimum_keylength

size_t minimum_keylength() const

Definition sym_algo.h:52

References key_spec().

◆ name()

virtual std::string Botan::SymmetricAlgorithm::name ( ) const

pure virtual

Return the name of this algorithm

Returns: the algorithm name

Implemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::ANSI_X919_MAC, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Ascon_AEAD128_Mode, Botan::BLAKE2b, Botan::BLAKE2bMAC, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CBC_Mode, Botan::CCM_Mode, Botan::CFB_Mode, Botan::ChaCha20Poly1305_Mode, Botan::ChaCha, Botan::CMAC, Botan::CTR_BE, Botan::DES, Botan::EAX_Mode, Botan::FPE_FE1, Botan::GCM_Mode, Botan::GCM_SIV_Mode, Botan::GHASH, Botan::GMAC, Botan::GOST_28147_89, Botan::HMAC, Botan::IDEA, Botan::KMAC128, Botan::KMAC256, Botan::Kuznyechik, Botan::Lion, Botan::Noekeon, Botan::OCB_Mode, Botan::OFB, Botan::Poly1305, Botan::Polyval, Botan::RC4, Botan::Salsa20, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SHAKE_128_Cipher, Botan::SHAKE_256_Cipher, Botan::SipHash, Botan::SIV_Mode, Botan::SM4, Botan::Threefish_512, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::TLS::TLS_NULL_HMAC_AEAD_Mode, Botan::TripleDES, Botan::Twofish, and Botan::XTS_Mode.

Referenced by Botan::XTS_Mode::name(), and set_key().

◆ operator=() [1/2]

SymmetricAlgorithm & Botan::SymmetricAlgorithm::operator= ( const SymmetricAlgorithm & other )

default

Copy assignment

Returns: reference to this

References SymmetricAlgorithm().

◆ operator=() [2/2]

SymmetricAlgorithm & Botan::SymmetricAlgorithm::operator= ( SymmetricAlgorithm && other )

default

Move assignment

Returns: reference to this

References SymmetricAlgorithm().

◆ set_key() [1/3]

void Botan::SymmetricAlgorithm::set_key ( const OctetString & key )

Set the symmetric key of this object.

Parameters

key	the SymmetricKey to be set.

Definition at line 14 of file sym_algo.cpp.

                                                       {
   set_key(std::span{key.begin(), key.length()});
}

References Botan::OctetString::begin(), Botan::OctetString::length(), and set_key().

Referenced by Botan::create_aes_row_generator(), Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), Botan::Sodium::randombytes_buf_deterministic(), Botan::TLS::TLS_NULL_HMAC_AEAD_Mode::reset(), and set_key().

◆ set_key() [2/3]

void Botan::SymmetricAlgorithm::set_key	(	const uint8_t	key[],
		size_t	length )

inline

Set the symmetric key of this object.

Parameters

key	the to be set as a byte array.
length	in bytes of key param

Definition at line 162 of file sym_algo.h.

162{ set_key(std::span{key, length}); }

References set_key().

Referenced by set_key().

◆ set_key() [3/3]

void Botan::SymmetricAlgorithm::set_key ( std::span< const uint8_t > key )

Set the symmetric key of this object.

Parameters

key	the contiguous byte range to be set.

Definition at line 22 of file sym_algo.cpp.

                                                           {
   if(!valid_keylength(key.size())) {
      throw Invalid_Key_Length(name(), key.size());
   }
   key_schedule(key);
}

References name(), and valid_keylength().

◆ valid_keylength()

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t length ) const

inline

Check whether a given key length is valid for this algorithm.

Parameters

length the key length to be checked.

Returns: true if the key length is valid.

Definition at line 143 of file sym_algo.h.

143{ return key_spec().valid_keylength(length); }

Botan::Key_Length_Specification::valid_keylength

bool valid_keylength(size_t length) const

Definition sym_algo.h:44

References key_spec().

Referenced by set_key().

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

src/lib/base/sym_algo.h
src/lib/base/sym_algo.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SymmetricAlgorithm() [1/3]

◆ ~SymmetricAlgorithm()

◆ SymmetricAlgorithm() [2/3]

◆ SymmetricAlgorithm() [3/3]

Member Function Documentation

◆ assert_key_material_set() [1/2]

◆ assert_key_material_set() [2/2]

◆ clear()

◆ has_keying_material()

◆ key_spec()

◆ maximum_keylength()

◆ minimum_keylength()

◆ name()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_key() [1/3]

◆ set_key() [2/3]

◆ set_key() [3/3]

◆ valid_keylength()