Botan  2.8.0
Crypto and TLS for C++11
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::CTS_Encryption Class Referencefinal

#include <cbc.h>

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

Public Member Functions

virtual bool authenticated () const
 
void clear () override
 
 CTS_Encryption (BlockCipher *cipher)
 
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
 
void set_key (const SymmetricKey &key)
 
template<typename Alloc >
void set_key (const std::vector< uint8_t, Alloc > &key)
 
void set_key (const uint8_t key[], size_t length)
 
template<typename Alloc >
void start (const std::vector< uint8_t, Alloc > &nonce)
 
void start (const uint8_t nonce[], size_t nonce_len)
 
void start ()
 
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 with ciphertext stealing (CBC-CS3 variant)

Definition at line 91 of file cbc.h.

Constructor & Destructor Documentation

◆ CTS_Encryption()

Botan::CTS_Encryption::CTS_Encryption ( BlockCipher cipher)
inlineexplicit
Parameters
cipherblock cipher to use

Definition at line 97 of file cbc.h.

97 : CBC_Encryption(cipher, nullptr) {}
CBC_Encryption(BlockCipher *cipher, BlockCipherModePaddingMethod *padding)
Definition: cbc.h:76
const BlockCipher & cipher() const
Definition: cbc.h:41

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.

References Botan::CBC_Mode::reset().

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

◆ 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 54 of file cipher_mode.cpp.

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

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

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

◆ 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 44 of file cipher_mode.cpp.

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

47  {
48  if(auto mode = Cipher_Mode::create(algo, direction, provider))
49  return mode;
50 
51  throw Lookup_Error("Cipher mode", algo, provider);
52  }
static std::unique_ptr< Cipher_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition: cipher_mode.cpp:54
virtual std::string provider() const
Definition: cipher_mode.h:180

◆ 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.

References Botan::CBC_Mode::block_size().

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

◆ finish()

void Botan::CTS_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

Reimplemented from Botan::CBC_Encryption.

Definition at line 159 of file cbc.cpp.

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

160  {
161  BOTAN_STATE_CHECK(state().empty() == false);
162  BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane");
163  uint8_t* buf = buffer.data() + offset;
164  const size_t sz = buffer.size() - offset;
165 
166  const size_t BS = block_size();
167 
168  if(sz < BS + 1)
169  throw Encoding_Error(name() + ": insufficient data to encrypt");
170 
171  if(sz % BS == 0)
172  {
173  update(buffer, offset);
174 
175  // swap last two blocks
176  for(size_t i = 0; i != BS; ++i)
177  std::swap(buffer[buffer.size()-BS+i], buffer[buffer.size()-2*BS+i]);
178  }
179  else
180  {
181  const size_t full_blocks = ((sz / BS) - 1) * BS;
182  const size_t final_bytes = sz - full_blocks;
183  BOTAN_ASSERT(final_bytes > BS && final_bytes < 2*BS, "Left over size in expected range");
184 
185  secure_vector<uint8_t> last(buf + full_blocks, buf + full_blocks + final_bytes);
186  buffer.resize(full_blocks + offset);
187  update(buffer, offset);
188 
189  xor_buf(last.data(), state_ptr(), BS);
190  cipher().encrypt(last.data());
191 
192  for(size_t i = 0; i != final_bytes - BS; ++i)
193  {
194  last[i] ^= last[i + BS];
195  last[i + BS] ^= last[i];
196  }
197 
198  cipher().encrypt(last.data());
199 
200  buffer += last;
201  }
202  }
secure_vector< uint8_t > & state()
Definition: cbc.h:51
std::string name() const override
Definition: cbc.cpp:38
void update(secure_vector< uint8_t > &buffer, size_t offset=0)
Definition: cipher_mode.h:112
#define BOTAN_STATE_CHECK(expr)
Definition: assert.h:49
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition: mem_ops.h:174
uint8_t * state_ptr()
Definition: cbc.h:53
size_t block_size() const
Definition: cbc.h:49
void encrypt(const uint8_t in[], uint8_t out[]) const
Definition: block_cipher.h:81
const BlockCipher & cipher() const
Definition: cbc.h:41

◆ 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.

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

52  {
53  return cipher().key_spec();
54  }
virtual Key_Length_Specification key_spec() const =0
const BlockCipher & cipher() const
Definition: cbc.h:41

◆ maximum_keylength()

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

Definition at line 38 of file sym_algo.h.

39  {
40  return key_spec().maximum_keylength();
41  }
size_t maximum_keylength() const
Definition: key_spec.h:69
virtual Key_Length_Specification key_spec() const =0

◆ minimum_final_size()

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

Reimplemented from Botan::CBC_Encryption.

Definition at line 149 of file cbc.cpp.

References Botan::CBC_Mode::block_size().

150  {
151  return block_size() + 1;
152  }
size_t block_size() const
Definition: cbc.h:49

◆ minimum_keylength()

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

Definition at line 46 of file sym_algo.h.

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

47  {
48  return key_spec().minimum_keylength();
49  }
virtual Key_Length_Specification key_spec() const =0
size_t minimum_keylength() const
Definition: key_spec.h:61

◆ name()

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

Implements Botan::SymmetricAlgorithm.

Definition at line 38 of file cbc.cpp.

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

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

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

◆ output_length()

size_t Botan::CTS_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.

Reimplemented from Botan::CBC_Encryption.

Definition at line 154 of file cbc.cpp.

155  {
156  return input_length; // no ciphertext expansion in CTS
157  }

◆ padding()

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

Definition at line 43 of file cbc.h.

References BOTAN_ASSERT_NONNULL.

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

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

◆ process()

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

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.

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

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  }
secure_vector< uint8_t > & state()
Definition: cbc.h:51
#define BOTAN_STATE_CHECK(expr)
Definition: assert.h:49
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition: mem_ops.h:174
uint8_t * state_ptr()
Definition: cbc.h:53
size_t block_size() const
Definition: cbc.h:49
void encrypt(const uint8_t in[], uint8_t out[]) const
Definition: block_cipher.h:81
const BlockCipher & cipher() const
Definition: cbc.h:41

◆ 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.

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

180 { return "base"; }

◆ 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 190 of file cipher_mode.cpp.

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

191  {
192  const std::vector<std::string>& possible = { "base", "openssl", "commoncrypto" };
193  std::vector<std::string> providers;
194  for(auto&& prov : possible)
195  {
196  std::unique_ptr<Cipher_Mode> mode = Cipher_Mode::create(algo_spec, ENCRYPTION, prov);
197  if(mode)
198  {
199  providers.push_back(prov); // available
200  }
201  }
202  return providers;
203  }
static std::unique_ptr< Cipher_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition: cipher_mode.cpp:54
static std::vector< std::string > providers(const std::string &algo_spec)

◆ 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.

Reimplemented in Botan::CBC_Decryption.

Definition at line 33 of file cbc.cpp.

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

34  {
35  m_state.clear();
36  }

◆ set_key() [1/3]

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

Set the symmetric key of this object.

Parameters
keythe SymmetricKey to be set.

Definition at line 65 of file sym_algo.h.

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), botan_block_cipher_set_key(), botan_cipher_set_key(), botan_mac_set_key(), Botan::FPE::fe1_decrypt(), and Botan::FPE::fe1_encrypt().

66  {
67  set_key(key.begin(), key.length());
68  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:65

◆ set_key() [2/3]

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

Definition at line 71 of file sym_algo.h.

72  {
73  set_key(key.data(), key.size());
74  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:65

◆ 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.

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

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:56
virtual std::string name() const =0

◆ start() [1/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.

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

70  {
71  start_msg(nonce.data(), nonce.size());
72  }
virtual void start_msg(const uint8_t nonce[], size_t nonce_len)=0

◆ start() [2/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  }
virtual void start_msg(const uint8_t nonce[], size_t nonce_len)=0

◆ start() [3/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

◆ state()

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

◆ state_ptr()

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

Definition at line 53 of file cbc.h.

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

53 { return m_state.data(); }

◆ tag_size()

virtual size_t Botan::Cipher_Mode::tag_size ( ) const
inlinevirtualinherited
Returns
the size of the authentication tag used (in bytes)

Reimplemented in Botan::SIV_Mode, Botan::CCM_Mode, Botan::OCB_Mode, Botan::ChaCha20Poly1305_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::GCM_Mode, and Botan::EAX_Mode.

Definition at line 174 of file cipher_mode.h.

Referenced by botan_cipher_get_tag_length().

174 { return 0; }

◆ 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.

References BOTAN_ASSERT.

Referenced by botan_cipher_update(), Botan::XTS_Encryption::finish(), Botan::ChaCha20Poly1305_Encryption::finish(), Botan::CFB_Encryption::finish(), Botan::CBC_Encryption::finish(), Botan::EAX_Encryption::finish(), Botan::XTS_Decryption::finish(), Botan::CFB_Decryption::finish(), finish(), Botan::CBC_Decryption::finish(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), Botan::CTS_Decryption::finish(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption::finish().

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  }
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
virtual size_t process(uint8_t msg[], size_t msg_len)=0

◆ 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.

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

47  {
48  return cipher().parallel_bytes();
49  }
size_t parallel_bytes() const
Definition: block_cipher.h:63
const BlockCipher & cipher() const
Definition: cbc.h:41

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

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

57  {
58  return key_spec().valid_keylength(length);
59  }
bool valid_keylength(size_t length) const
Definition: key_spec.h:51
virtual Key_Length_Specification key_spec() const =0

◆ valid_nonce_length()

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

Reimplemented from Botan::CBC_Mode.

Definition at line 144 of file cbc.cpp.

References Botan::CBC_Mode::block_size().

145  {
146  return (n == block_size());
147  }
size_t block_size() const
Definition: cbc.h:49

◆ verify_key_set()

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

Definition at line 89 of file sym_algo.h.

Referenced by Botan::Salsa20::cipher(), Botan::CTR_BE::cipher(), Botan::RC4::cipher(), Botan::SHAKE_128_Cipher::cipher(), Botan::ChaCha::cipher(), Botan::CAST_128::decrypt_n(), Botan::SM4::decrypt_n(), Botan::DES::decrypt_n(), Botan::KASUMI::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::AES_128::decrypt_n(), Botan::DESX::decrypt_n(), Botan::CAST_256::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SEED::decrypt_n(), Botan::XTEA::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::MISTY1::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::Lion::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::SEED::encrypt_n(), Botan::CAST_256::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SM4::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::KASUMI::encrypt_n(), Botan::AES_128::encrypt_n(), Botan::MISTY1::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::DES::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::DESX::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::XTEA::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::Lion::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::OCB_Encryption::finish(), Botan::OCB_Decryption::finish(), Botan::GHASH::ghash_update(), Botan::CFB_Encryption::process(), Botan::CFB_Decryption::process(), Botan::Salsa20::seek(), Botan::CTR_BE::seek(), Botan::ChaCha::seek(), Botan::OCB_Mode::set_associated_data(), Botan::Salsa20::set_iv(), Botan::ChaCha::set_iv(), Botan::GHASH::update(), Botan::GHASH::update_associated_data(), and Botan::ChaCha::write_keystream().

90  {
91  if(cond == false)
92  throw_key_not_set_error();
93  }

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