Botan 3.0.0
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::CTR_BE Class Referencefinal

#include <ctr.h>

Inheritance diagram for Botan::CTR_BE:
Botan::StreamCipher Botan::SymmetricAlgorithm

Public Member Functions

size_t buffer_size () const override
 
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)
 
void clear () override
 
StreamCipherclone () const
 
 CTR_BE (std::unique_ptr< BlockCipher > cipher)
 
 CTR_BE (std::unique_ptr< BlockCipher > cipher, size_t ctr_size)
 
void decrypt (std::span< uint8_t > inout)
 
size_t default_iv_length () const override
 
void encipher (std::span< uint8_t > inout)
 
void encrypt (std::span< uint8_t > inout)
 
bool has_keying_material () const override
 
Key_Length_Specification key_spec () const override
 
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
 
std::string name () const override
 
std::unique_ptr< StreamCiphernew_object () const override
 
virtual std::string provider () const
 
void seek (uint64_t offset) override
 
void set_iv (const uint8_t iv[], size_t iv_len)
 
void set_iv (std::span< const uint8_t > iv)
 
void set_key (const SymmetricKey &key)
 
void set_key (const uint8_t key[], size_t length)
 
void set_key (std::span< const uint8_t > key)
 
bool valid_iv_length (size_t iv_len) const override
 
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< StreamCiphercreate (std::string_view algo_spec, std::string_view provider="")
 
static std::unique_ptr< StreamCiphercreate_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
 

Detailed Description

CTR-BE (Counter mode, big-endian)

Definition at line 19 of file ctr.h.

Constructor & Destructor Documentation

◆ CTR_BE() [1/2]

Botan::CTR_BE::CTR_BE ( std::unique_ptr< BlockCipher cipher)
explicit
Parameters
cipherthe block cipher to use

Definition at line 16 of file ctr.cpp.

16 :
17 m_cipher(std::move(cipher)),
18 m_block_size(m_cipher->block_size()),
19 m_ctr_size(m_block_size),
20 m_ctr_blocks(m_cipher->parallel_bytes() / m_block_size),
21 m_counter(m_cipher->parallel_bytes()),
22 m_pad(m_counter.size()),
23 m_pad_pos(0)
24 {
25 }
void cipher(const uint8_t in[], uint8_t out[], size_t len)
Definition: stream_cipher.h:61

◆ CTR_BE() [2/2]

Botan::CTR_BE::CTR_BE ( std::unique_ptr< BlockCipher cipher,
size_t  ctr_size 
)

Definition at line 27 of file ctr.cpp.

27 :
28 m_cipher(std::move(cipher)),
29 m_block_size(m_cipher->block_size()),
30 m_ctr_size(ctr_size),
31 m_ctr_blocks(m_cipher->parallel_bytes() / m_block_size),
32 m_counter(m_cipher->parallel_bytes()),
33 m_pad(m_counter.size()),
34 m_pad_pos(0)
35 {
36 BOTAN_ARG_CHECK(m_ctr_size >= 4 && m_ctr_size <= m_block_size,
37 "Invalid CTR-BE counter size");
38 }
#define BOTAN_ARG_CHECK(expr, msg)
Definition: assert.h:36

References BOTAN_ARG_CHECK.

Member Function Documentation

◆ assert_key_material_set() [1/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( ) const
inlineprotectedinherited

Definition at line 182 of file sym_algo.h.

183 {
185 }
virtual bool has_keying_material() const =0
void assert_key_material_set() const
Definition: sym_algo.h:182

Referenced by Botan::Salsa20::cipher_bytes(), Botan::AES_128::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::DES::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Lion::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SEED::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::SM4::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::AES_128::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::DES::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::Lion::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::GHASH::final(), Botan::GHASH::ghash_update(), Botan::ChaCha::seek(), seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data_n(), Botan::Salsa20::set_iv_bytes(), Botan::GHASH::update(), and Botan::GHASH::update_associated_data().

◆ assert_key_material_set() [2/2]

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

Definition at line 187 of file sym_algo.h.

188 {
189 if(!predicate)
190 throw_key_not_set_error();
191 }

◆ buffer_size()

size_t Botan::CTR_BE::buffer_size ( ) const
overridevirtual

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.

Implements Botan::StreamCipher.

Definition at line 59 of file ctr.cpp.

60 {
61 return m_pad.size();
62 }

◆ cipher() [1/2]

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

Encrypt or decrypt a message

Parameters
inthe plaintext
outthe byte array to hold the output, i.e. the ciphertext
lenthe length of both in and out in bytes

Definition at line 61 of file stream_cipher.h.

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

Referenced by Botan::StreamCipher::create(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), and Botan::Sodium::crypto_stream_xsalsa20_xor_ic().

◆ cipher() [2/2]

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

Encrypt or decrypt a message

Parameters
inthe plaintext
outthe byte array to hold the output, i.e. the ciphertext with at least the same size as in

Definition at line 70 of file stream_cipher.h.

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

References BOTAN_ARG_CHECK.

◆ cipher1() [1/2]

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

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

Parameters
bufthe plaintext / ciphertext

Definition at line 125 of file stream_cipher.h.

126 { cipher(buf, buf); }

◆ cipher1() [2/2]

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

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

Parameters
bufthe plaintext / ciphertext
lenthe length of buf in bytes

Definition at line 117 of file stream_cipher.h.

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

◆ clear()

void Botan::CTR_BE::clear ( )
overridevirtual

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

Implements Botan::SymmetricAlgorithm.

Definition at line 40 of file ctr.cpp.

41 {
42 m_cipher->clear();
43 zeroise(m_pad);
44 zeroise(m_counter);
45 zap(m_iv);
46 m_pad_pos = 0;
47 }
void zeroise(std::vector< T, Alloc > &vec)
Definition: secmem.h:119
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:129

References Botan::zap(), and Botan::zeroise().

◆ clone()

StreamCipher * Botan::StreamCipher::clone ( ) const
inlineinherited
Returns
a new object representing the same algorithm as *this

Definition at line 199 of file stream_cipher.h.

200 {
201 return this->new_object().release();
202 }
virtual std::unique_ptr< StreamCipher > new_object() const =0

◆ create()

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

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

Parameters
algo_specalgorithm name
providerprovider implementation to use
Returns
a null pointer if the algo/provider combination cannot be found

Definition at line 38 of file stream_cipher.cpp.

40 {
41#if defined(BOTAN_HAS_SHAKE_CIPHER)
42 if(algo_spec == "SHAKE-128" || algo_spec == "SHAKE-128-XOF")
43 {
44 if(provider.empty() || provider == "base")
45 return std::make_unique<SHAKE_128_Cipher>();
46 }
47
48 if(algo_spec == "SHAKE-256" || algo_spec == "SHAKE-256-XOF")
49 {
50 if(provider.empty() || provider == "base")
51 return std::make_unique<SHAKE_256_Cipher>();
52 }
53#endif
54
55#if defined(BOTAN_HAS_CHACHA)
56 if(algo_spec == "ChaCha20")
57 {
58 if(provider.empty() || provider == "base")
59 return std::make_unique<ChaCha>(20);
60 }
61#endif
62
63#if defined(BOTAN_HAS_SALSA20)
64 if(algo_spec == "Salsa20")
65 {
66 if(provider.empty() || provider == "base")
67 return std::make_unique<Salsa20>();
68 }
69#endif
70
71 const SCAN_Name req(algo_spec);
72
73#if defined(BOTAN_HAS_CTR_BE)
74 if((req.algo_name() == "CTR-BE" || req.algo_name() == "CTR") && req.arg_count_between(1,2))
75 {
76 if(provider.empty() || provider == "base")
77 {
78 auto cipher = BlockCipher::create(req.arg(0));
79 if(cipher)
80 {
81 size_t ctr_size = req.arg_as_integer(1, cipher->block_size());
82 return std::make_unique<CTR_BE>(std::move(cipher), ctr_size);
83 }
84 }
85 }
86#endif
87
88#if defined(BOTAN_HAS_CHACHA)
89 if(req.algo_name() == "ChaCha")
90 {
91 if(provider.empty() || provider == "base")
92 return std::make_unique<ChaCha>(req.arg_as_integer(0, 20));
93 }
94#endif
95
96#if defined(BOTAN_HAS_OFB)
97 if(req.algo_name() == "OFB" && req.arg_count() == 1)
98 {
99 if(provider.empty() || provider == "base")
100 {
101 if(auto cipher = BlockCipher::create(req.arg(0)))
102 return std::make_unique<OFB>(std::move(cipher));
103 }
104 }
105#endif
106
107#if defined(BOTAN_HAS_RC4)
108
109 if(req.algo_name() == "RC4" ||
110 req.algo_name() == "ARC4" ||
111 req.algo_name() == "MARK-4")
112 {
113 const size_t skip = (req.algo_name() == "MARK-4") ? 256 : req.arg_as_integer(0, 0);
114
115 if(provider.empty() || provider == "base")
116 {
117 return std::make_unique<RC4>(skip);
118 }
119 }
120
121#endif
122
123 BOTAN_UNUSED(req);
125
126 return nullptr;
127 }
#define BOTAN_UNUSED(...)
Definition: assert.h:141
static std::unique_ptr< BlockCipher > create(std::string_view algo_spec, std::string_view provider="")
virtual std::string provider() const

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, Botan::StreamCipher::cipher(), Botan::BlockCipher::create(), and Botan::StreamCipher::provider().

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

◆ create_or_throw()

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

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

Parameters
algo_specalgorithm name
providerprovider implementation to use Throws a Lookup_Error if the algo/provider combination cannot be found

Definition at line 131 of file stream_cipher.cpp.

133 {
134 if(auto sc = StreamCipher::create(algo, provider))
135 {
136 return sc;
137 }
138 throw Lookup_Error("Stream cipher", algo, provider);
139 }
static std::unique_ptr< StreamCipher > create(std::string_view algo_spec, std::string_view provider="")

References Botan::StreamCipher::create(), and Botan::StreamCipher::provider().

Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), Botan::Sodium::crypto_secretbox_detached(), Botan::Sodium::crypto_secretbox_open_detached(), Botan::Sodium::crypto_secretbox_xsalsa20poly1305(), Botan::Sodium::crypto_secretbox_xsalsa20poly1305_open(), Botan::Sodium::crypto_stream_chacha20(), Botan::Sodium::crypto_stream_chacha20_ietf(), Botan::Sodium::crypto_stream_chacha20_ietf_xor_ic(), Botan::Sodium::crypto_stream_chacha20_xor_ic(), Botan::Sodium::crypto_stream_xchacha20(), Botan::Sodium::crypto_stream_xchacha20_xor_ic(), and Botan::Dilithium_AES_Symmetric_Primitives::XOF().

◆ decrypt()

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

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

Parameters
inoutthe plaintext / ciphertext

Definition at line 149 of file stream_cipher.h.

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

◆ default_iv_length()

size_t Botan::CTR_BE::default_iv_length ( ) const
overridevirtual

Return the default (preferred) nonce length If this function returns 0, then this cipher does not support nonces

Default implementation returns 0

Reimplemented from Botan::StreamCipher.

Definition at line 49 of file ctr.cpp.

50 {
51 return m_block_size;
52 }

◆ encipher()

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

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

Parameters
inoutthe plaintext / ciphertext

Definition at line 133 of file stream_cipher.h.

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

◆ encrypt()

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

Encrypt a message The message is encrypted in place.

Parameters
inoutthe plaintext / ciphertext

Definition at line 141 of file stream_cipher.h.

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

◆ has_keying_material()

bool Botan::CTR_BE::has_keying_material ( ) const
overridevirtual
Returns
true if a key has been set on this object

Implements Botan::SymmetricAlgorithm.

Definition at line 74 of file ctr.cpp.

75 {
76 return m_cipher->has_keying_material();
77 }

◆ key_spec()

Key_Length_Specification Botan::CTR_BE::key_spec ( ) const
overridevirtual
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 64 of file ctr.cpp.

65 {
66 return m_cipher->key_spec();
67 }

◆ keystream_bytes()

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T Botan::StreamCipher::keystream_bytes ( size_t  bytes)
inlineinherited

Get bytes from the keystream

Parameters
bytesThe number of bytes to be produced

Definition at line 104 of file stream_cipher.h.

105 {
106 T out(bytes);
107 write_keystream(out);
108 return out;
109 }
void write_keystream(uint8_t out[], size_t len)
Definition: stream_cipher.h:85
FE_25519 T
Definition: ge.cpp:36

References T.

◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const
inlineinherited
Returns
maximum allowed key length

Definition at line 123 of file sym_algo.h.

124 {
125 return key_spec().maximum_keylength();
126 }
size_t maximum_keylength() const
Definition: sym_algo.h:72
virtual Key_Length_Specification key_spec() const =0

◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 131 of file sym_algo.h.

132 {
133 return key_spec().minimum_keylength();
134 }
size_t minimum_keylength() const
Definition: sym_algo.h:64

◆ name()

std::string Botan::CTR_BE::name ( ) const
overridevirtual
Returns
the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 87 of file ctr.cpp.

88 {
89 if(m_ctr_size == m_block_size)
90 return fmt("CTR-BE({})", m_cipher->name());
91 else
92 return fmt("CTR-BE({},{})", m_cipher->name(), m_ctr_size);
93 }
std::string fmt(std::string_view format, const T &... args)
Definition: fmt.h:60

References Botan::fmt().

◆ new_object()

std::unique_ptr< StreamCipher > Botan::CTR_BE::new_object ( ) const
overridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::StreamCipher.

Definition at line 69 of file ctr.cpp.

70 {
71 return std::make_unique<CTR_BE>(m_cipher->new_object(), m_ctr_size);
72 }

◆ provider()

virtual std::string Botan::StreamCipher::provider ( ) const
inlinevirtualinherited
Returns
provider information about this implementation. Default is "base", might also return "sse2", "avx2" or some other arbitrary string.

Reimplemented in Botan::ChaCha.

Definition at line 219 of file stream_cipher.h.

219{ return "base"; }

Referenced by Botan::StreamCipher::create(), and Botan::StreamCipher::create_or_throw().

◆ providers()

std::vector< std::string > Botan::StreamCipher::providers ( std::string_view  algo_spec)
staticinherited
Returns
list of available providers for this algorithm, empty if not available

Definition at line 141 of file stream_cipher.cpp.

142 {
143 return probe_providers_of<StreamCipher>(algo_spec);
144 }

◆ seek()

void Botan::CTR_BE::seek ( uint64_t  offset)
overridevirtual

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

Parameters
offsetthe offset where we begin to generate the keystream

Implements Botan::StreamCipher.

Definition at line 239 of file ctr.cpp.

240 {
242
243 const uint64_t base_counter = m_ctr_blocks * (offset / m_counter.size());
244
245 zeroise(m_counter);
246 buffer_insert(m_counter, 0, m_iv);
247
248 const size_t BS = m_block_size;
249
250 // Set m_counter blocks to IV, IV + 1, ... IV + n
251
252 if(m_ctr_size == 4 && BS >= 8)
253 {
254 const uint32_t low32 = load_be<uint32_t>(&m_counter[BS-4], 0);
255
256 if(m_ctr_blocks >= 4 && is_power_of_2(m_ctr_blocks))
257 {
258 size_t written = 1;
259 while(written < m_ctr_blocks)
260 {
261 copy_mem(&m_counter[written*BS], &m_counter[0], BS*written);
262 written *= 2;
263 }
264 }
265 else
266 {
267 for(size_t i = 1; i != m_ctr_blocks; ++i)
268 {
269 copy_mem(&m_counter[i*BS], &m_counter[0], BS - 4);
270 }
271 }
272
273 for(size_t i = 1; i != m_ctr_blocks; ++i)
274 {
275 const uint32_t c = static_cast<uint32_t>(low32 + i);
276 store_be(c, &m_counter[(BS-4)+i*BS]);
277 }
278 }
279 else
280 {
281 // do everything sequentially:
282 for(size_t i = 1; i != m_ctr_blocks; ++i)
283 {
284 buffer_insert(m_counter, i*BS, &m_counter[(i-1)*BS], BS);
285
286 for(size_t j = 0; j != m_ctr_size; ++j)
287 if(++m_counter[i*BS + (BS - 1 - j)])
288 break;
289 }
290 }
291
292 if(base_counter > 0)
293 add_counter(base_counter);
294
295 m_cipher->encrypt_n(m_counter.data(), m_pad.data(), m_ctr_blocks);
296 m_pad_pos = offset % m_counter.size();
297 }
constexpr bool is_power_of_2(T arg)
Definition: bit_ops.h:45
size_t buffer_insert(std::vector< T, Alloc > &buf, size_t buf_offset, const T input[], size_t input_length)
Definition: mem_ops.h:221
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition: mem_ops.h:126
constexpr uint32_t load_be< uint32_t >(const uint8_t in[], size_t off)
Definition: loadstor.h:190
constexpr void store_be(uint16_t in, uint8_t out[2])
Definition: loadstor.h:449

References Botan::SymmetricAlgorithm::assert_key_material_set(), Botan::buffer_insert(), Botan::copy_mem(), Botan::is_power_of_2(), Botan::load_be< uint32_t >(), Botan::store_be(), and Botan::zeroise().

◆ set_iv() [1/2]

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

Resync the cipher using the IV

Parameters
ivthe initialization vector
iv_lenthe length of the IV in bytes

Definition at line 172 of file stream_cipher.h.

173 { set_iv_bytes(iv, iv_len); }
virtual void set_iv_bytes(const uint8_t iv[], size_t iv_len)=0

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)
inlineinherited

Resync the cipher using the IV

Parameters
ivthe initialization vector

Definition at line 179 of file stream_cipher.h.

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

◆ set_key() [1/3]

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey key)
inlineinherited

◆ set_key() [2/3]

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

Set the symmetric key of this object.

Parameters
keythe to be set as a byte array.
lengthin bytes of key param

Definition at line 17 of file sym_algo.cpp.

18 {
19 if(!valid_keylength(length))
20 throw Invalid_Key_Length(name(), length);
21 key_schedule(key, length);
22 }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:141
virtual std::string name() const =0

References Botan::SymmetricAlgorithm::name(), and Botan::SymmetricAlgorithm::valid_keylength().

◆ set_key() [3/3]

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

Set the symmetric key of this object.

Parameters
keythe contiguous byte range to be set.

Definition at line 159 of file sym_algo.h.

160 {
161 set_key(key.data(), key.size());
162 }

◆ valid_iv_length()

bool Botan::CTR_BE::valid_iv_length ( size_t  iv_len) const
overridevirtual
Parameters
iv_lenthe length of the IV in bytes
Returns
if the length is valid for this algorithm

Reimplemented from Botan::StreamCipher.

Definition at line 54 of file ctr.cpp.

55 {
56 return (iv_len <= m_block_size);
57 }

◆ valid_keylength()

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

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

Parameters
lengththe key length to be checked.
Returns
true if the key length is valid.

Definition at line 141 of file sym_algo.h.

142 {
143 return key_spec().valid_keylength(length);
144 }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:54

Referenced by Botan::SymmetricAlgorithm::set_key().

◆ write_keystream() [1/2]

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

Fill a given buffer with keystream bytes

The contents of out are ignored/overwritten

Parameters
outthe byte array to hold the keystream

Definition at line 95 of file stream_cipher.h.

96 { generate_keystream(out.data(), out.size()); }
virtual void generate_keystream(uint8_t out[], size_t len)

◆ write_keystream() [2/2]

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

Write keystream bytes to a buffer

The contents of out are ignored/overwritten

Parameters
outthe byte array to hold the keystream
lenthe length of out in bytes

Definition at line 85 of file stream_cipher.h.

86 { generate_keystream(out, len); }

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


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