#include <stream_cipher.h>

Inheritance diagram for Botan::StreamCipher:

Public Member Functions
virtual size_t	buffer_size () const =0
void	cipher (const uint8_t in[], uint8_t out[], size_t len)
void	cipher (std::span< const uint8_t > in, std::span< uint8_t > out)
void	cipher1 (std::span< uint8_t > buf)
void	cipher1 (uint8_t buf[], size_t len)
virtual void	clear ()=0
StreamCipher *	clone () const
void	decrypt (std::span< uint8_t > inout)
virtual size_t	default_iv_length () const
void	encipher (std::span< uint8_t > inout)
void	encrypt (std::span< uint8_t > inout)
virtual bool	has_keying_material () const =0
virtual Key_Length_Specification	key_spec () const =0
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	keystream_bytes (size_t bytes)
size_t	maximum_keylength () const
size_t	minimum_keylength () const
virtual std::string	name () const =0
virtual std::unique_ptr< StreamCipher >	new_object () const =0
virtual std::string	provider () const
virtual std::optional< uint64_t >	remaining_keystream_bytes () const =0
virtual void	seek (uint64_t offset)=0
void	set_iv (const uint8_t iv[], size_t iv_len)
void	set_iv (std::span< const uint8_t > iv)
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)
virtual bool	supports_seek () const =0
virtual bool	valid_iv_length (size_t iv_len) const
bool	valid_keylength (size_t length) const
void	write_keystream (std::span< uint8_t > out)
void	write_keystream (uint8_t out[], size_t len)

Static Public Member Functions
static std::unique_ptr< StreamCipher >	create (std::string_view algo_spec, std::string_view provider="")
static std::unique_ptr< StreamCipher >	create_or_throw (std::string_view algo_spec, std::string_view provider="")
static std::vector< std::string >	providers (std::string_view algo_spec)

Protected Member Functions
void	assert_key_material_set () const
void	assert_key_material_set (bool predicate) const
virtual void	cipher_bytes (const uint8_t in[], uint8_t out[], size_t len)=0
virtual void	generate_keystream (uint8_t out[], size_t len)
virtual void	set_iv_bytes (const uint8_t iv[], size_t iv_len)=0

Detailed Description

Base class for all stream ciphers

Definition at line 25 of file stream_cipher.h.

Member Function Documentation

◆ assert_key_material_set() [1/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( ) const

inlineprotectedinherited

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

inlineprotectedinherited

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();
         }
      }

◆ buffer_size()

virtual size_t Botan::StreamCipher::buffer_size ( ) const

pure virtual

Return the optimium buffer size to use with this cipher

Most stream ciphers internally produce blocks of bytes. This function returns that block size. Aligning buffer sizes to a multiple of this size may improve performance by reducing internal buffering overhead.

Note the return value of this function may change for any particular algorithm due to changes in the implementation from release to release, or changes in the runtime environment (such as CPUID indicating availability of an optimized implementation). It is not intrinsic to the algorithm; it is just a suggestion for gaining best performance.

Implemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, and Botan::SHAKE_Cipher.

◆ cipher() [1/2]

void Botan::StreamCipher::cipher	(	const uint8_t	in[],
		uint8_t	out[],
		size_t	len )

inline

Encrypt or decrypt a message

Processes all bytes plain/ciphertext from in and writes the result to out.

Parameters

in	the plaintext
out	the byte array to hold the output, i.e. the ciphertext
len	the length of both in and out in bytes

Definition at line 61 of file stream_cipher.h.

61{ cipher_bytes(in, out, len); }

Botan::StreamCipher::cipher_bytes

virtual void cipher_bytes(const uint8_t in[], uint8_t out[], size_t len)=0

References cipher_bytes().

Referenced by cipher1(), cipher1(), create(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::CTR_BE::CTR_BE(), Botan::CTR_BE::CTR_BE(), decrypt(), encipher(), encrypt(), and Botan::OFB::OFB().

◆ cipher() [2/2]

void Botan::StreamCipher::cipher	(	std::span< const uint8_t >	in,
		std::span< uint8_t >	out )

Encrypt or decrypt a message

Parameters

in	the plaintext
out	the byte array to hold the output, i.e. the ciphertext with at least the same size as `in`

Definition at line 133 of file stream_cipher.cpp.

                                                                         {
   BOTAN_ARG_CHECK(in.size() <= out.size(), "Output buffer of stream cipher must be at least as long as input buffer");
   cipher_bytes(in.data(), out.data(), in.size());
}

References BOTAN_ARG_CHECK, and cipher_bytes().

◆ cipher1() [1/2]

void Botan::StreamCipher::cipher1 ( std::span< uint8_t > buf )

inline

Encrypt or decrypt a message The message is encrypted/decrypted in place.

Parameters

buf	the plaintext / ciphertext

Definition at line 117 of file stream_cipher.h.

117{ cipher(buf, buf); }

Botan::StreamCipher::cipher

void cipher(const uint8_t in[], uint8_t out[], size_t len)

Definition stream_cipher.h:61

References cipher().

◆ cipher1() [2/2]

void Botan::StreamCipher::cipher1	(	uint8_t	buf[],
		size_t	len )

inline

Encrypt or decrypt a message The message is encrypted/decrypted in place.

Parameters

buf	the plaintext / ciphertext
len	the length of buf in bytes

Definition at line 110 of file stream_cipher.h.

110{ cipher(buf, buf, len); }

References cipher().

Referenced by generate_keystream().

◆ cipher_bytes()

virtual void Botan::StreamCipher::cipher_bytes	(	const uint8_t	in[],
		uint8_t	out[],
		size_t	len )

protectedpure virtual

Encrypt or decrypt a message

Implemented in Botan::Salsa20.

References generate_keystream().

Referenced by cipher(), and cipher().

◆ clear()

virtual void Botan::SymmetricAlgorithm::clear ( )

pure virtualinherited

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().

◆ clone()

StreamCipher * Botan::StreamCipher::clone ( ) const

inline

Create a new uninitialized object of the same type

Returns: a new object representing the same algorithm as *this

Definition at line 198 of file stream_cipher.h.

198{ return this->new_object().release(); }

Botan::StreamCipher::new_object

virtual std::unique_ptr< StreamCipher > new_object() const =0

References new_object().

◆ create()

std::unique_ptr< StreamCipher > Botan::StreamCipher::create	(	std::string_view	algo_spec,
		std::string_view	provider = "" )

static

Create an instance based on a name If provider is empty then best available is chosen.

Parameters

algo_spec	algorithm name
provider	provider implementation to use

Returns: a null pointer if the algo/provider combination cannot be found

Definition at line 40 of file stream_cipher.cpp.

                                                                                                  {
#if defined(BOTAN_HAS_SHAKE_CIPHER)
   if(algo_spec == "SHAKE-128" || algo_spec == "SHAKE-128-XOF") {
      if(provider.empty() || provider == "base") {
         return std::make_unique<SHAKE_128_Cipher>();
      }
   }
 
   if(algo_spec == "SHAKE-256" || algo_spec == "SHAKE-256-XOF") {
      if(provider.empty() || provider == "base") {
         return std::make_unique<SHAKE_256_Cipher>();
      }
   }
#endif
 
#if defined(BOTAN_HAS_CHACHA)
   if(algo_spec == "ChaCha20") {
      if(provider.empty() || provider == "base") {
         return std::make_unique<ChaCha>(20);
      }
   }
#endif
 
#if defined(BOTAN_HAS_SALSA20)
   if(algo_spec == "Salsa20") {
      if(provider.empty() || provider == "base") {
         return std::make_unique<Salsa20>();
      }
   }
#endif
 
   const SCAN_Name req(algo_spec);
 
#if defined(BOTAN_HAS_CTR_BE)
   if((req.algo_name() == "CTR-BE" || req.algo_name() == "CTR") && req.arg_count_between(1, 2)) {
      if(provider.empty() || provider == "base") {
         auto cipher = BlockCipher::create(req.arg(0));
         if(cipher) {
            const size_t ctr_size = req.arg_as_integer(1, cipher->block_size());
            return std::make_unique<CTR_BE>(std::move(cipher), ctr_size);
         }
      }
   }
#endif
 
#if defined(BOTAN_HAS_CHACHA)
   if(req.algo_name() == "ChaCha") {
      if(provider.empty() || provider == "base") {
         return std::make_unique<ChaCha>(req.arg_as_integer(0, 20));
      }
   }
#endif
 
#if defined(BOTAN_HAS_OFB)
   if(req.algo_name() == "OFB" && req.arg_count() == 1) {
      if(provider.empty() || provider == "base") {
         if(auto cipher = BlockCipher::create(req.arg(0))) {
            return std::make_unique<OFB>(std::move(cipher));
         }
      }
   }
#endif
 
#if defined(BOTAN_HAS_RC4)
 
   if(req.algo_name() == "RC4" || req.algo_name() == "ARC4" || req.algo_name() == "MARK-4") {
      const size_t skip = (req.algo_name() == "MARK-4") ? 256 : req.arg_as_integer(0, 0);
 
      if(provider.empty() || provider == "base") {
         return std::make_unique<RC4>(skip);
      }
   }
 
#endif
 
   BOTAN_UNUSED(req);
   BOTAN_UNUSED(provider);
 
   return nullptr;
}

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::SCAN_Name::arg_count_between(), BOTAN_UNUSED, cipher(), Botan::BlockCipher::create(), and provider().

Referenced by Botan::BlockCipher::create(), Botan::Cipher_Mode::create(), and create_or_throw().

◆ create_or_throw()

std::unique_ptr< StreamCipher > Botan::StreamCipher::create_or_throw	(	std::string_view	algo_spec,
		std::string_view	provider = "" )

static

Create an instance based on a name If provider is empty then best available is chosen.

Parameters

algo_spec	algorithm name
provider	provider implementation to use Throws a Lookup_Error if the algo/provider combination cannot be found

Definition at line 122 of file stream_cipher.cpp.

                                                                                                      {
   if(auto sc = StreamCipher::create(algo, provider)) {
      return sc;
   }
   throw Lookup_Error("Stream cipher", algo, provider);
}

References create(), and provider().

◆ decrypt()

void Botan::StreamCipher::decrypt ( std::span< uint8_t > inout )

inline

Decrypt a message in place The message is decrypted in place.

Parameters

inout the plaintext / ciphertext

Definition at line 138 of file stream_cipher.h.

138{ cipher(inout.data(), inout.data(), inout.size()); }

References cipher().

◆ default_iv_length()

size_t Botan::StreamCipher::default_iv_length ( ) const

virtual

Return the default (preferred) nonce length

If this function returns zero, then this cipher does not support nonces; in this case any call to set_iv with a (non-empty) value will fail.

Default implementation returns 0

Reimplemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, and Botan::Salsa20.

Definition at line 138 of file stream_cipher.cpp.

                                             {
   return 0;
}

◆ encipher()

void Botan::StreamCipher::encipher ( std::span< uint8_t > inout )

inline

Encrypt a message The message is encrypted/decrypted in place.

Parameters

inout the plaintext / ciphertext

Definition at line 124 of file stream_cipher.h.

124{ cipher(inout.data(), inout.data(), inout.size()); }

References cipher().

◆ encrypt()

void Botan::StreamCipher::encrypt ( std::span< uint8_t > inout )

inline

Encrypt a message The message is encrypted in place.

Parameters

inout the plaintext / ciphertext

Definition at line 131 of file stream_cipher.h.

131{ cipher(inout.data(), inout.data(), inout.size()); }

References cipher().

◆ generate_keystream()

void Botan::StreamCipher::generate_keystream	(	uint8_t	out[],
		size_t	len )

protectedvirtual

Write keystream bytes to a buffer

Reimplemented in Botan::Salsa20.

Definition at line 142 of file stream_cipher.cpp.

                                                               {
   clear_mem(out, len);
   cipher1(out, len);
}

References cipher1(), and Botan::clear_mem().

Referenced by cipher_bytes(), write_keystream(), and write_keystream().

◆ has_keying_material()

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

pure virtualinherited

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 virtualinherited

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().

◆ keystream_bytes()

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>

T Botan::StreamCipher::keystream_bytes ( size_t bytes )

inline

Get bytes from the keystream

The bytes are written into a continuous byte buffer of your choosing.

Parameters

bytes The number of bytes to be produced

Definition at line 98 of file stream_cipher.h.

                                      {
         T out(bytes);
         write_keystream(out);
         return out;
      }

References write_keystream().

◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inlineinherited

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

inlineinherited

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 virtualinherited

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().

◆ new_object()

virtual std::unique_ptr< StreamCipher > Botan::StreamCipher::new_object ( ) const

pure virtual

Create a new uninitialized object of the same type

Returns: new object representing the same algorithm as *this

Implemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, Botan::SHAKE_128_Cipher, and Botan::SHAKE_256_Cipher.

Referenced by clone().

◆ provider()

virtual std::string Botan::StreamCipher::provider ( ) const

inlinevirtual

Return the name of the provider implementing this object

Returns: provider information about this implementation. Default is "base", might also return "sse2", "avx2" or some other arbitrary string.

Reimplemented in Botan::ChaCha, and Botan::Salsa20.

Definition at line 252 of file stream_cipher.h.

252{ return "base"; }

Referenced by create(), and create_or_throw().

◆ providers()

std::vector< std::string > Botan::StreamCipher::providers ( std::string_view algo_spec )

static

List the providers available for a given stream cipher

Returns: list of available providers for this algorithm, empty if not available

Definition at line 129 of file stream_cipher.cpp.

                                                                     {
   return probe_providers_of<StreamCipher>(algo_spec);
}

References Botan::probe_providers_of().

◆ remaining_keystream_bytes()

virtual std::optional< uint64_t > Botan::StreamCipher::remaining_keystream_bytes ( ) const

pure virtual

Many stream ciphers are internally based on encrypting a counter of some kind. If the counter wraps around, keystream bytes would be repeated.

This function returns the number of keystream bytes that can still be produced under the current key/nonce settings, if that limit fits in a uint64_t. If there is no specific limit (eg due to being based on permutations rather than a counter), or if the limit is at least 2**64 bytes (where consuming the entire keystream is not practically possible), then this function returns nullopt.

Note this returns nullopt if no key is set (there are no keystream bytes at all available, in that state) or potentially if the nonce is not set (as in some cases, such as ChaCha, the available counter bytes vary depending on the size of the nonce used).

Implemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, and Botan::SHAKE_Cipher.

◆ seek()

virtual void Botan::StreamCipher::seek ( uint64_t offset )

pure virtual

Set the offset and the state used later to generate the keystream

Sets the state of the stream cipher and keystream according to the passed offset, exactly as if offset bytes had first been encrypted. The key and (if required) the IV have to be set before this can be called.

Note: Not all ciphers support seeking; such objects will throw Not_Implemented in this case. Use supports_seek() to query in advance.

Parameters

offset the offset where we begin to generate the keystream

Implemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, and Botan::SHAKE_Cipher.

◆ set_iv() [1/2]

void Botan::StreamCipher::set_iv	(	const uint8_t	iv[],
		size_t	iv_len )

inline

Resync the cipher using the IV

Load IV into the stream cipher state. This should happen after the key is set (set_key()) and before any operation (encrypt(), decrypt() or seek()) is called.

If the cipher does not support IVs, then a call with an empty IV will be accepted and any other length will cause an Invalid_IV_Length exception.

Parameters

iv	the initialization vector
iv_len	the length of the IV in bytes

Definition at line 168 of file stream_cipher.h.

168{ set_iv_bytes(iv, iv_len); }

Botan::StreamCipher::set_iv_bytes

virtual void set_iv_bytes(const uint8_t iv[], size_t iv_len)=0

References set_iv_bytes().

Referenced by 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::Sodium::randombytes_buf_deterministic(), and Botan::SIV_Mode::set_ctr_iv().

◆ set_iv() [2/2]

void Botan::StreamCipher::set_iv ( std::span< const uint8_t > iv )

inline

Resync the cipher using the IV

Parameters

iv	the initialization vector

Exceptions

Invalid_IV_Length if an incompatible IV was passed.

Definition at line 175 of file stream_cipher.h.

175{ set_iv_bytes(iv.data(), iv.size()); }

References set_iv_bytes().

◆ set_iv_bytes()

virtual void Botan::StreamCipher::set_iv_bytes	(	const uint8_t	iv[],
		size_t	iv_len )

protectedpure virtual

Resync the cipher using the IV

Implemented in Botan::Salsa20.

Referenced by set_iv(), and set_iv().

◆ set_key() [1/3]

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

inherited

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 )

inlineinherited

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 )

inherited

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().

◆ supports_seek()

virtual bool Botan::StreamCipher::supports_seek ( ) const

pure virtual

Test whether this cipher supports seeking within the keystream

Returns: true if this cipher implements seek(); false if seek() will throw Not_Implemented for any offset.

Implemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, and Botan::SHAKE_Cipher.

◆ valid_iv_length()

virtual bool Botan::StreamCipher::valid_iv_length ( size_t iv_len ) const

inlinevirtual

Test if a nonce length is valid for this cipher

Parameters

iv_len the length of the IV in bytes

Returns: if the length is valid for this algorithm

Reimplemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, and Botan::Salsa20.

Definition at line 192 of file stream_cipher.h.

192{ return (iv_len == 0); }

◆ valid_keylength()

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

inlineinherited

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().

◆ write_keystream() [1/2]

void Botan::StreamCipher::write_keystream ( std::span< uint8_t > out )

inline

Fill a given buffer with keystream bytes

The contents of out are ignored/overwritten

Parameters

out	the byte array to hold the keystream

Definition at line 88 of file stream_cipher.h.

88{ generate_keystream(out.data(), out.size()); }

Botan::StreamCipher::generate_keystream

virtual void generate_keystream(uint8_t out[], size_t len)

Definition stream_cipher.cpp:142

References generate_keystream().

◆ write_keystream() [2/2]

void Botan::StreamCipher::write_keystream	(	uint8_t	out[],
		size_t	len )

inline

Write keystream bytes to a buffer

The contents of out are ignored/overwritten

Parameters

out	the byte array to hold the keystream
len	the length of out in bytes

Definition at line 79 of file stream_cipher.h.

79{ generate_keystream(out, len); }

References generate_keystream().

Referenced by Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_xsalsa20(), keystream_bytes(), and Botan::Sodium::randombytes_buf_deterministic().

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

src/lib/stream/stream_cipher.h
src/lib/stream/stream_cipher.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ assert_key_material_set() [1/2]

◆ assert_key_material_set() [2/2]

◆ buffer_size()

◆ cipher() [1/2]

◆ cipher() [2/2]

◆ cipher1() [1/2]

◆ cipher1() [2/2]

◆ cipher_bytes()

◆ clear()

◆ clone()

◆ create()

◆ create_or_throw()

◆ decrypt()

◆ default_iv_length()

◆ encipher()

◆ encrypt()

◆ generate_keystream()

◆ has_keying_material()

◆ key_spec()

◆ keystream_bytes()

◆ maximum_keylength()

◆ minimum_keylength()

◆ name()

◆ new_object()

◆ provider()

◆ providers()

◆ remaining_keystream_bytes()

◆ seek()

◆ set_iv() [1/2]

◆ set_iv() [2/2]

◆ set_iv_bytes()

◆ set_key() [1/3]

◆ set_key() [2/3]

◆ set_key() [3/3]

◆ supports_seek()

◆ valid_iv_length()

◆ valid_keylength()

◆ write_keystream() [1/2]

◆ write_keystream() [2/2]