Botan 2.19.3
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::CBC_Encryption Class Reference

#include <cbc.h>

Inheritance diagram for Botan::CBC_Encryption:
Botan::CBC_Mode Botan::Cipher_Mode Botan::SymmetricAlgorithm Botan::CTS_Encryption

Public Member Functions

virtual bool authenticated () const
 
 CBC_Encryption (BlockCipher *cipher, BlockCipherModePaddingMethod *padding)
 
void clear () override
 
size_t default_nonce_length () const override
 
void finish (secure_vector< uint8_t > &final_block, size_t offset=0) override
 
Key_Length_Specification key_spec () const override
 
size_t maximum_keylength () const
 
size_t minimum_final_size () const override
 
size_t minimum_keylength () const
 
std::string name () const override
 
size_t output_length (size_t input_length) const override
 
size_t process (uint8_t buf[], size_t size) override
 
virtual std::string provider () const
 
void reset () override
 
template<typename Alloc >
void set_key (const std::vector< uint8_t, Alloc > &key)
 
void set_key (const SymmetricKey &key)
 
void set_key (const uint8_t key[], size_t length)
 
void start ()
 
template<typename Alloc >
void start (const std::vector< uint8_t, Alloc > &nonce)
 
void start (const uint8_t nonce[], size_t nonce_len)
 
virtual size_t tag_size () const
 
void update (secure_vector< uint8_t > &buffer, size_t offset=0)
 
size_t update_granularity () const override
 
bool valid_keylength (size_t length) const
 
bool valid_nonce_length (size_t n) const override
 

Static Public Member Functions

static std::unique_ptr< Cipher_Modecreate (const std::string &algo, Cipher_Dir direction, const std::string &provider="")
 
static std::unique_ptr< Cipher_Modecreate_or_throw (const std::string &algo, Cipher_Dir direction, const std::string &provider="")
 
static std::vector< std::string > providers (const std::string &algo_spec)
 

Protected Member Functions

size_t block_size () const
 
const BlockCiphercipher () const
 
const BlockCipherModePaddingMethodpadding () const
 
secure_vector< uint8_t > & state ()
 
uint8_t * state_ptr ()
 
void verify_key_set (bool cond) const
 

Detailed Description

CBC Encryption

Definition at line 71 of file cbc.h.

Constructor & Destructor Documentation

◆ CBC_Encryption()

Botan::CBC_Encryption::CBC_Encryption ( BlockCipher cipher,
BlockCipherModePaddingMethod padding 
)
inline
Parameters
cipherblock cipher to use
paddingpadding method to use

Definition at line 78 of file cbc.h.

78 :
const BlockCipherModePaddingMethod & padding() const
Definition cbc.h:45
CBC_Mode(BlockCipher *cipher, BlockCipherModePaddingMethod *padding)
Definition cbc.cpp:16
const BlockCipher & cipher() const
Definition cbc.h:43

Member Function Documentation

◆ authenticated()

virtual bool Botan::Cipher_Mode::authenticated ( ) const
inlinevirtualinherited
Returns
true iff this mode provides authentication as well as confidentiality.

Reimplemented in Botan::AEAD_Mode.

Definition at line 169 of file cipher_mode.h.

169{ return false; }

◆ block_size()

size_t Botan::CBC_Mode::block_size ( ) const
inlineprotectedinherited

◆ cipher()

const BlockCipher & Botan::CBC_Mode::cipher ( ) const
inlineprotectedinherited

◆ clear()

void Botan::CBC_Mode::clear ( )
overridevirtualinherited

Reset the state.

Implements Botan::SymmetricAlgorithm.

Definition at line 27 of file cbc.cpp.

28 {
29 m_cipher->clear();
30 reset();
31 }
void reset() override
Definition cbc.cpp:33

References Botan::CBC_Mode::reset().

◆ create()

std::unique_ptr< Cipher_Mode > Botan::Cipher_Mode::create ( const std::string &  algo,
Cipher_Dir  direction,
const std::string &  provider = "" 
)
staticinherited

Create an AEAD mode

Parameters
algothe algorithm to create
directionspecify if this should be an encryption or decryption AEAD
provideroptional specification for provider to use
Returns
an AEAD mode or a null pointer if not available

Definition at line 50 of file cipher_mode.cpp.

53 {
54#if defined(BOTAN_HAS_COMMONCRYPTO)
55 if(provider.empty() || provider == "commoncrypto")
56 {
57 std::unique_ptr<Cipher_Mode> commoncrypto_cipher(make_commoncrypto_cipher_mode(algo, direction));
58
59 if(commoncrypto_cipher)
60 return commoncrypto_cipher;
61
62 if(!provider.empty())
63 return std::unique_ptr<Cipher_Mode>();
64 }
65#endif
66
67#if defined(BOTAN_HAS_STREAM_CIPHER)
68 if(auto sc = StreamCipher::create(algo))
69 {
70 return std::unique_ptr<Cipher_Mode>(new Stream_Cipher_Mode(sc.release()));
71 }
72#endif
73
74#if defined(BOTAN_HAS_AEAD_MODES)
75 if(auto aead = AEAD_Mode::create(algo, direction))
76 {
77 return std::unique_ptr<Cipher_Mode>(aead.release());
78 }
79#endif
80
81 if(algo.find('/') != std::string::npos)
82 {
83 const std::vector<std::string> algo_parts = split_on(algo, '/');
84 const std::string cipher_name = algo_parts[0];
85 const std::vector<std::string> mode_info = parse_algorithm_name(algo_parts[1]);
86
87 if(mode_info.empty())
88 return std::unique_ptr<Cipher_Mode>();
89
90 std::ostringstream alg_args;
91
92 alg_args << '(' << cipher_name;
93 for(size_t i = 1; i < mode_info.size(); ++i)
94 alg_args << ',' << mode_info[i];
95 for(size_t i = 2; i < algo_parts.size(); ++i)
96 alg_args << ',' << algo_parts[i];
97 alg_args << ')';
98
99 const std::string mode_name = mode_info[0] + alg_args.str();
100 return Cipher_Mode::create(mode_name, direction, provider);
101 }
102
103#if defined(BOTAN_HAS_BLOCK_CIPHER)
104
105 SCAN_Name spec(algo);
106
107 if(spec.arg_count() == 0)
108 {
109 return std::unique_ptr<Cipher_Mode>();
110 }
111
112 std::unique_ptr<BlockCipher> bc(BlockCipher::create(spec.arg(0), provider));
113
114 if(!bc)
115 {
116 return std::unique_ptr<Cipher_Mode>();
117 }
118
119#if defined(BOTAN_HAS_MODE_CBC)
120 if(spec.algo_name() == "CBC")
121 {
122 const std::string padding = spec.arg(1, "PKCS7");
123
124 if(padding == "CTS")
125 {
126 if(direction == ENCRYPTION)
127 return std::unique_ptr<Cipher_Mode>(new CTS_Encryption(bc.release()));
128 else
129 return std::unique_ptr<Cipher_Mode>(new CTS_Decryption(bc.release()));
130 }
131 else
132 {
133 std::unique_ptr<BlockCipherModePaddingMethod> pad(get_bc_pad(padding));
134
135 if(pad)
136 {
137 if(direction == ENCRYPTION)
138 return std::unique_ptr<Cipher_Mode>(new CBC_Encryption(bc.release(), pad.release()));
139 else
140 return std::unique_ptr<Cipher_Mode>(new CBC_Decryption(bc.release(), pad.release()));
141 }
142 }
143 }
144#endif
145
146#if defined(BOTAN_HAS_MODE_XTS)
147 if(spec.algo_name() == "XTS")
148 {
149 if(direction == ENCRYPTION)
150 return std::unique_ptr<Cipher_Mode>(new XTS_Encryption(bc.release()));
151 else
152 return std::unique_ptr<Cipher_Mode>(new XTS_Decryption(bc.release()));
153 }
154#endif
155
156#if defined(BOTAN_HAS_MODE_CFB)
157 if(spec.algo_name() == "CFB")
158 {
159 const size_t feedback_bits = spec.arg_as_integer(1, 8*bc->block_size());
160 if(direction == ENCRYPTION)
161 return std::unique_ptr<Cipher_Mode>(new CFB_Encryption(bc.release(), feedback_bits));
162 else
163 return std::unique_ptr<Cipher_Mode>(new CFB_Decryption(bc.release(), feedback_bits));
164 }
165#endif
166
167#endif
168
169 return std::unique_ptr<Cipher_Mode>();
170 }
static std::unique_ptr< AEAD_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition aead.cpp:60
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
virtual std::string provider() const
static std::unique_ptr< Cipher_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
static std::unique_ptr< StreamCipher > create(const std::string &algo_spec, const std::string &provider="")
std::vector< std::string > split_on(const std::string &str, char delim)
Definition parsing.cpp:148
BlockCipherModePaddingMethod * get_bc_pad(const std::string &algo_spec)
Definition mode_pad.cpp:18
@ ENCRYPTION
Definition cipher_mode.h:23
Cipher_Mode * make_commoncrypto_cipher_mode(const std::string &name, Cipher_Dir direction)
std::vector< std::string > parse_algorithm_name(const std::string &namex)
Definition parsing.cpp:95

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::AEAD_Mode::create(), Botan::Cipher_Mode::create(), Botan::BlockCipher::create(), Botan::StreamCipher::create(), Botan::ENCRYPTION, Botan::get_bc_pad(), Botan::make_commoncrypto_cipher_mode(), Botan::parse_algorithm_name(), Botan::Cipher_Mode::provider(), and Botan::split_on().

Referenced by botan_cipher_init(), Botan::Cipher_Mode::create(), Botan::Cipher_Mode::create_or_throw(), Botan::get_cipher_mode(), Botan::pbes2_decrypt(), and Botan::Cipher_Mode::providers().

◆ create_or_throw()

std::unique_ptr< Cipher_Mode > Botan::Cipher_Mode::create_or_throw ( const std::string &  algo,
Cipher_Dir  direction,
const std::string &  provider = "" 
)
staticinherited

Create an AEAD mode, or throw

Parameters
algothe algorithm to create
directionspecify if this should be an encryption or decryption AEAD
provideroptional specification for provider to use
Returns
an AEAD mode, or throw an exception

Definition at line 40 of file cipher_mode.cpp.

43 {
44 if(auto mode = Cipher_Mode::create(algo, direction, provider))
45 return mode;
46
47 throw Lookup_Error("Cipher mode", algo, provider);
48 }

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

Referenced by Botan::ECIES_System_Params::create_cipher(), Botan::CryptoBox::decrypt_bin(), Botan::CryptoBox::encrypt(), and Botan::get_cipher().

◆ default_nonce_length()

size_t Botan::CBC_Mode::default_nonce_length ( ) const
overridevirtualinherited
Returns
the default size for a nonce

Implements Botan::Cipher_Mode.

Definition at line 56 of file cbc.cpp.

57 {
58 return block_size();
59 }
size_t block_size() const
Definition cbc.h:51

References Botan::CBC_Mode::block_size().

◆ finish()

void Botan::CBC_Encryption::finish ( secure_vector< uint8_t > &  final_block,
size_t  offset = 0 
)
overridevirtual

Complete processing of a message.

Parameters
final_blockin/out parameter which must be at least minimum_final_size() bytes, and will be set to any final output
offsetan offset into final_block to begin processing

Implements Botan::Cipher_Mode.

Reimplemented in Botan::CTS_Encryption.

Definition at line 127 of file cbc.cpp.

128 {
129 BOTAN_STATE_CHECK(state().empty() == false);
130 BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane");
131
132 const size_t BS = block_size();
133
134 const size_t bytes_in_final_block = (buffer.size()-offset) % BS;
135
136 padding().add_padding(buffer, bytes_in_final_block, BS);
137
138 BOTAN_ASSERT_EQUAL(buffer.size() % BS, offset % BS, "Padded to block boundary");
139
140 update(buffer, offset);
141 }
#define BOTAN_STATE_CHECK(expr)
Definition assert.h:49
#define BOTAN_ASSERT_EQUAL(expr1, expr2, assertion_made)
Definition assert.h:81
#define BOTAN_ASSERT(expr, assertion_made)
Definition assert.h:55
virtual void add_padding(secure_vector< uint8_t > &buffer, size_t final_block_bytes, size_t block_size) const =0
secure_vector< uint8_t > & state()
Definition cbc.h:53
int(* update)(CTX *, const void *, CC_LONG len)

References Botan::BlockCipherModePaddingMethod::add_padding(), Botan::CBC_Mode::block_size(), BOTAN_ASSERT, BOTAN_ASSERT_EQUAL, BOTAN_STATE_CHECK, Botan::CBC_Mode::padding(), Botan::CBC_Mode::state(), and update.

◆ key_spec()

Key_Length_Specification Botan::CBC_Mode::key_spec ( ) const
overridevirtualinherited
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 51 of file cbc.cpp.

52 {
53 return cipher().key_spec();
54 }
virtual Key_Length_Specification key_spec() const =0

References Botan::CBC_Mode::cipher(), and Botan::SymmetricAlgorithm::key_spec().

◆ maximum_keylength()

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

Definition at line 120 of file sym_algo.h.

121 {
122 return key_spec().maximum_keylength();
123 }
size_t maximum_keylength() const
Definition sym_algo.h:70

◆ minimum_final_size()

size_t Botan::CBC_Encryption::minimum_final_size ( ) const
overridevirtual
Returns
required minimium size to finalize() - may be any length larger than this.

Implements Botan::Cipher_Mode.

Reimplemented in Botan::CTS_Encryption.

Definition at line 89 of file cbc.cpp.

90 {
91 return 0;
92 }

◆ minimum_keylength()

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

Definition at line 128 of file sym_algo.h.

129 {
130 return key_spec().minimum_keylength();
131 }
size_t minimum_keylength() const
Definition sym_algo.h:62

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

◆ name()

std::string Botan::CBC_Mode::name ( ) const
overridevirtualinherited
Returns
the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 38 of file cbc.cpp.

39 {
40 if(m_padding)
41 return cipher().name() + "/CBC/" + padding().name();
42 else
43 return cipher().name() + "/CBC/CTS";
44 }
virtual std::string name() const =0
virtual std::string name() const =0

References Botan::CBC_Mode::cipher(), Botan::SymmetricAlgorithm::name(), Botan::BlockCipherModePaddingMethod::name(), and Botan::CBC_Mode::padding().

Referenced by Botan::CTS_Encryption::finish(), Botan::CBC_Decryption::finish(), and Botan::CTS_Decryption::finish().

◆ output_length()

size_t Botan::CBC_Encryption::output_length ( size_t  input_length) const
overridevirtual

Returns the size of the output if this transform is used to process a message with input_length bytes. In most cases the answer is precise. If it is not possible to precise (namely for CBC decryption) instead a lower bound is returned.

Implements Botan::Cipher_Mode.

Reimplemented in Botan::CTS_Encryption.

Definition at line 94 of file cbc.cpp.

95 {
96 if(input_length == 0)
97 return block_size();
98 else
99 return round_up(input_length, block_size());
100 }
size_t round_up(size_t n, size_t align_to)
Definition rounding.h:21

References Botan::CBC_Mode::block_size(), and Botan::round_up().

◆ padding()

const BlockCipherModePaddingMethod & Botan::CBC_Mode::padding ( ) const
inlineprotectedinherited

Definition at line 45 of file cbc.h.

46 {
47 BOTAN_ASSERT_NONNULL(m_padding);
48 return *m_padding;
49 }
#define BOTAN_ASSERT_NONNULL(ptr)
Definition assert.h:107

References BOTAN_ASSERT_NONNULL.

Referenced by finish(), Botan::CBC_Decryption::finish(), and Botan::CBC_Mode::name().

◆ process()

size_t Botan::CBC_Encryption::process ( uint8_t  msg[],
size_t  msg_len 
)
overridevirtual

Process message blocks

Input must be a multiple of update_granularity

Processes msg in place and returns bytes written. Normally this will be either msg_len (indicating the entire message was processed) or for certain AEAD modes zero (indicating that the mode requires the entire message be processed in one pass).

Parameters
msgthe message to be processed
msg_lenlength of the message in bytes

Implements Botan::Cipher_Mode.

Definition at line 102 of file cbc.cpp.

103 {
104 BOTAN_STATE_CHECK(state().empty() == false);
105 const size_t BS = block_size();
106
107 BOTAN_ASSERT(sz % BS == 0, "CBC input is full blocks");
108 const size_t blocks = sz / BS;
109
110 if(blocks > 0)
111 {
112 xor_buf(&buf[0], state_ptr(), BS);
113 cipher().encrypt(&buf[0]);
114
115 for(size_t i = 1; i != blocks; ++i)
116 {
117 xor_buf(&buf[BS*i], &buf[BS*(i-1)], BS);
118 cipher().encrypt(&buf[BS*i]);
119 }
120
121 state().assign(&buf[BS*(blocks-1)], &buf[BS*blocks]);
122 }
123
124 return sz;
125 }
void encrypt(const uint8_t in[], uint8_t out[]) const
uint8_t * state_ptr()
Definition cbc.h:55
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition mem_ops.h:262

References Botan::CBC_Mode::block_size(), BOTAN_ASSERT, BOTAN_STATE_CHECK, Botan::CBC_Mode::cipher(), Botan::BlockCipher::encrypt(), Botan::CBC_Mode::state(), Botan::CBC_Mode::state_ptr(), and Botan::xor_buf().

◆ provider()

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

Reimplemented in Botan::GCM_Mode.

Definition at line 180 of file cipher_mode.h.

180{ return "base"; }

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

◆ providers()

std::vector< std::string > Botan::Cipher_Mode::providers ( const std::string &  algo_spec)
staticinherited
Returns
list of available providers for this algorithm, empty if not available
Parameters
algo_specalgorithm name

Definition at line 173 of file cipher_mode.cpp.

174 {
175 const std::vector<std::string>& possible = { "base", "openssl", "commoncrypto" };
176 std::vector<std::string> providers;
177 for(auto&& prov : possible)
178 {
179 std::unique_ptr<Cipher_Mode> mode = Cipher_Mode::create(algo_spec, ENCRYPTION, prov);
180 if(mode)
181 {
182 providers.push_back(prov); // available
183 }
184 }
185 return providers;
186 }
static std::vector< std::string > providers(const std::string &algo_spec)

References Botan::Cipher_Mode::create(), Botan::ENCRYPTION, and Botan::Cipher_Mode::providers().

Referenced by Botan::Cipher_Mode::providers().

◆ reset()

void Botan::CBC_Mode::reset ( )
overridevirtualinherited

Resets just the message specific state and allows encrypting again under the existing key

Implements Botan::Cipher_Mode.

Definition at line 33 of file cbc.cpp.

34 {
35 m_state.clear();
36 }

Referenced by Botan::CBC_Mode::clear(), and Botan::CBC_Decryption::reset().

◆ set_key() [1/3]

template<typename Alloc >
void Botan::SymmetricAlgorithm::set_key ( const std::vector< uint8_t, Alloc > &  key)
inlineinherited

Definition at line 153 of file sym_algo.h.

154 {
155 set_key(key.data(), key.size());
156 }
void set_key(const SymmetricKey &key)
Definition sym_algo.h:147

◆ set_key() [2/3]

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

◆ set_key() [3/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:138

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

◆ start() [1/3]

void Botan::Cipher_Mode::start ( )
inlineinherited

Begin processing a message.

Definition at line 87 of file cipher_mode.h.

88 {
89 return start_msg(nullptr, 0);
90 }
virtual void start_msg(const uint8_t nonce[], size_t nonce_len)=0

◆ start() [2/3]

template<typename Alloc >
void Botan::Cipher_Mode::start ( const std::vector< uint8_t, Alloc > &  nonce)
inlineinherited

Begin processing a message.

Parameters
noncethe per message nonce

Definition at line 69 of file cipher_mode.h.

70 {
71 start_msg(nonce.data(), nonce.size());
72 }

Referenced by botan_cipher_start(), and Botan::TLS::write_record().

◆ start() [3/3]

void Botan::Cipher_Mode::start ( const uint8_t  nonce[],
size_t  nonce_len 
)
inlineinherited

Begin processing a message.

Parameters
noncethe per message nonce
nonce_lenlength of nonce

Definition at line 79 of file cipher_mode.h.

80 {
81 start_msg(nonce, nonce_len);
82 }

◆ state()

secure_vector< uint8_t > & Botan::CBC_Mode::state ( )
inlineprotectedinherited

◆ state_ptr()

uint8_t * Botan::CBC_Mode::state_ptr ( )
inlineprotectedinherited

Definition at line 55 of file cbc.h.

55{ return m_state.data(); }

Referenced by Botan::CTS_Encryption::finish(), Botan::CTS_Decryption::finish(), process(), and Botan::CBC_Decryption::process().

◆ tag_size()

virtual size_t Botan::Cipher_Mode::tag_size ( ) const
inlinevirtualinherited

◆ update()

void Botan::Cipher_Mode::update ( secure_vector< uint8_t > &  buffer,
size_t  offset = 0 
)
inlineinherited

Process some data. Input must be in size update_granularity() uint8_t blocks.

Parameters
bufferin/out parameter which will possibly be resized
offsetan offset into blocks to begin processing

Definition at line 112 of file cipher_mode.h.

113 {
114 BOTAN_ASSERT(buffer.size() >= offset, "Offset ok");
115 uint8_t* buf = buffer.data() + offset;
116 const size_t buf_size = buffer.size() - offset;
117
118 const size_t written = process(buf, buf_size);
119 buffer.resize(offset + written);
120 }
virtual size_t process(uint8_t msg[], size_t msg_len)=0

References BOTAN_ASSERT.

Referenced by botan_cipher_update().

◆ update_granularity()

size_t Botan::CBC_Mode::update_granularity ( ) const
overridevirtualinherited
Returns
size of required blocks to update

Implements Botan::Cipher_Mode.

Definition at line 46 of file cbc.cpp.

47 {
48 return cipher().parallel_bytes();
49 }
size_t parallel_bytes() const

References Botan::CBC_Mode::cipher(), and Botan::BlockCipher::parallel_bytes().

◆ 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 138 of file sym_algo.h.

139 {
140 return key_spec().valid_keylength(length);
141 }
bool valid_keylength(size_t length) const
Definition sym_algo.h:52

Referenced by Botan::aont_package(), Botan::aont_unpackage(), and Botan::SymmetricAlgorithm::set_key().

◆ valid_nonce_length()

bool Botan::CBC_Mode::valid_nonce_length ( size_t  nonce_len) const
overridevirtualinherited
Returns
true iff nonce_len is a valid length for the nonce

Implements Botan::Cipher_Mode.

Reimplemented in Botan::CTS_Encryption, and Botan::CTS_Decryption.

Definition at line 61 of file cbc.cpp.

62 {
63 return (n == 0 || n == block_size());
64 }

References Botan::CBC_Mode::block_size().

◆ verify_key_set()

void Botan::SymmetricAlgorithm::verify_key_set ( bool  cond) const
inlineprotectedinherited

Definition at line 171 of file sym_algo.h.

172 {
173 if(cond == false)
174 throw_key_not_set_error();
175 }

Referenced by Botan::ChaCha::cipher(), Botan::CTR_BE::cipher(), Botan::RC4::cipher(), Botan::Salsa20::cipher(), Botan::SHAKE_128_Cipher::cipher(), 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::CAST_256::decrypt_n(), Botan::DES::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::DESX::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::KASUMI::decrypt_n(), Botan::Lion::decrypt_n(), Botan::MISTY1::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::XTEA::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::CAST_256::encrypt_n(), Botan::DES::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::DESX::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::KASUMI::encrypt_n(), Botan::Lion::encrypt_n(), Botan::MISTY1::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::XTEA::encrypt_n(), Botan::OCB_Encryption::finish(), Botan::OCB_Decryption::finish(), Botan::GHASH::ghash_update(), Botan::CFB_Encryption::process(), Botan::CFB_Decryption::process(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data(), Botan::ChaCha::set_iv(), Botan::Salsa20::set_iv(), Botan::GHASH::update(), Botan::GHASH::update_associated_data(), and Botan::ChaCha::write_keystream().


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