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

#include <ocb.h>

Inheritance diagram for Botan::OCB_Decryption:
Botan::OCB_Mode Botan::AEAD_Mode Botan::Cipher_Mode Botan::SymmetricAlgorithm

Public Member Functions

virtual bool associated_data_requires_key () const
 
bool authenticated () const override
 
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
 
virtual size_t maximum_associated_data_inputs () const
 
size_t maximum_keylength () const
 
size_t minimum_final_size () const override
 
size_t minimum_keylength () const
 
std::string name () const override
 
 OCB_Decryption (BlockCipher *cipher, size_t tag_size=16)
 
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_ad (const std::vector< uint8_t, Alloc > &ad)
 
void set_associated_data (const uint8_t ad[], size_t ad_len) override
 
virtual void set_associated_data_n (size_t i, const uint8_t ad[], size_t ad_len)
 
template<typename Alloc >
void set_associated_data_vec (const std::vector< uint8_t, Alloc > &ad)
 
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 ()
 
size_t tag_size () const override
 
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) const override
 

Static Public Member Functions

static std::unique_ptr< AEAD_Modecreate (const std::string &algo, Cipher_Dir direction, const std::string &provider="")
 
static std::unique_ptr< AEAD_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
 
size_t par_blocks () const
 
size_t par_bytes () const
 
void verify_key_set (bool cond) const
 

Protected Attributes

secure_vector< uint8_t > m_ad_hash
 
size_t m_block_index = 0
 
secure_vector< uint8_t > m_checksum
 
std::unique_ptr< BlockCipherm_cipher
 
std::unique_ptr< L_computer > m_L
 

Detailed Description

Definition at line 110 of file ocb.h.

Constructor & Destructor Documentation

◆ OCB_Decryption()

Botan::OCB_Decryption::OCB_Decryption ( BlockCipher cipher,
size_t  tag_size = 16 
)
inline
Parameters
cipherthe block cipher to use
tag_sizeis how big the auth tag will be

Definition at line 117 of file ocb.h.

117  :
118  OCB_Mode(cipher, tag_size) {}
size_t tag_size() const override
Definition: ocb.h:46
OCB_Mode(BlockCipher *cipher, size_t tag_size)
Definition: ocb.cpp:161

Member Function Documentation

◆ associated_data_requires_key()

virtual bool Botan::AEAD_Mode::associated_data_requires_key ( ) const
inlinevirtualinherited

Most AEADs require the key to be set prior to setting the AD A few allow the AD to be set even before the cipher is keyed. Such ciphers would return false from this function.

Reimplemented in Botan::ChaCha20Poly1305_Mode, and Botan::CCM_Mode.

Definition at line 94 of file aead.h.

94 { return true; }

◆ authenticated()

bool Botan::AEAD_Mode::authenticated ( ) const
inlineoverridevirtualinherited
Returns
true iff this mode provides authentication as well as confidentiality.

Reimplemented from Botan::Cipher_Mode.

Definition at line 47 of file aead.h.

47 { return true; }

◆ block_size()

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

◆ clear()

void Botan::OCB_Mode::clear ( )
overridevirtualinherited

Reset the state.

Implements Botan::SymmetricAlgorithm.

Definition at line 187 of file ocb.cpp.

References Botan::OCB_Mode::m_cipher, Botan::OCB_Mode::m_L, and Botan::OCB_Mode::reset().

188  {
189  m_cipher->clear();
190  m_L.reset(); // add clear here?
191  reset();
192  }
std::unique_ptr< BlockCipher > m_cipher
Definition: ocb.h:65
void reset() override
Definition: ocb.cpp:194
std::unique_ptr< L_computer > m_L
Definition: ocb.h:66

◆ create()

std::unique_ptr< AEAD_Mode > Botan::AEAD_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 60 of file aead.cpp.

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

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

63  {
65 #if defined(BOTAN_HAS_AEAD_CHACHA20_POLY1305)
66  if(algo == "ChaCha20Poly1305")
67  {
68  if(dir == ENCRYPTION)
69  return std::unique_ptr<AEAD_Mode>(new ChaCha20Poly1305_Encryption);
70  else
71  return std::unique_ptr<AEAD_Mode>(new ChaCha20Poly1305_Decryption);
72 
73  }
74 #endif
75 
76  if(algo.find('/') != std::string::npos)
77  {
78  const std::vector<std::string> algo_parts = split_on(algo, '/');
79  const std::string cipher_name = algo_parts[0];
80  const std::vector<std::string> mode_info = parse_algorithm_name(algo_parts[1]);
81 
82  if(mode_info.empty())
83  return std::unique_ptr<AEAD_Mode>();
84 
85  std::ostringstream alg_args;
86 
87  alg_args << '(' << cipher_name;
88  for(size_t i = 1; i < mode_info.size(); ++i)
89  alg_args << ',' << mode_info[i];
90  for(size_t i = 2; i < algo_parts.size(); ++i)
91  alg_args << ',' << algo_parts[i];
92  alg_args << ')';
93 
94  const std::string mode_name = mode_info[0] + alg_args.str();
95  return AEAD_Mode::create(mode_name, dir);
96  }
97 
98 #if defined(BOTAN_HAS_BLOCK_CIPHER)
99 
100  SCAN_Name req(algo);
101 
102  if(req.arg_count() == 0)
103  {
104  return std::unique_ptr<AEAD_Mode>();
105  }
106 
107  std::unique_ptr<BlockCipher> bc(BlockCipher::create(req.arg(0), provider));
108 
109  if(!bc)
110  {
111  return std::unique_ptr<AEAD_Mode>();
112  }
113 
114 #if defined(BOTAN_HAS_AEAD_CCM)
115  if(req.algo_name() == "CCM")
116  {
117  size_t tag_len = req.arg_as_integer(1, 16);
118  size_t L_len = req.arg_as_integer(2, 3);
119  if(dir == ENCRYPTION)
120  return std::unique_ptr<AEAD_Mode>(new CCM_Encryption(bc.release(), tag_len, L_len));
121  else
122  return std::unique_ptr<AEAD_Mode>(new CCM_Decryption(bc.release(), tag_len, L_len));
123  }
124 #endif
125 
126 #if defined(BOTAN_HAS_AEAD_GCM)
127  if(req.algo_name() == "GCM")
128  {
129  size_t tag_len = req.arg_as_integer(1, 16);
130  if(dir == ENCRYPTION)
131  return std::unique_ptr<AEAD_Mode>(new GCM_Encryption(bc.release(), tag_len));
132  else
133  return std::unique_ptr<AEAD_Mode>(new GCM_Decryption(bc.release(), tag_len));
134  }
135 #endif
136 
137 #if defined(BOTAN_HAS_AEAD_OCB)
138  if(req.algo_name() == "OCB")
139  {
140  size_t tag_len = req.arg_as_integer(1, 16);
141  if(dir == ENCRYPTION)
142  return std::unique_ptr<AEAD_Mode>(new OCB_Encryption(bc.release(), tag_len));
143  else
144  return std::unique_ptr<AEAD_Mode>(new OCB_Decryption(bc.release(), tag_len));
145  }
146 #endif
147 
148 #if defined(BOTAN_HAS_AEAD_EAX)
149  if(req.algo_name() == "EAX")
150  {
151  size_t tag_len = req.arg_as_integer(1, bc->block_size());
152  if(dir == ENCRYPTION)
153  return std::unique_ptr<AEAD_Mode>(new EAX_Encryption(bc.release(), tag_len));
154  else
155  return std::unique_ptr<AEAD_Mode>(new EAX_Decryption(bc.release(), tag_len));
156  }
157 #endif
158 
159 #if defined(BOTAN_HAS_AEAD_SIV)
160  if(req.algo_name() == "SIV")
161  {
162  if(dir == ENCRYPTION)
163  return std::unique_ptr<AEAD_Mode>(new SIV_Encryption(bc.release()));
164  else
165  return std::unique_ptr<AEAD_Mode>(new SIV_Decryption(bc.release()));
166  }
167 #endif
168 
169 #endif
170 
171  return std::unique_ptr<AEAD_Mode>();
172  }
std::vector< std::string > split_on(const std::string &str, char delim)
Definition: parsing.cpp:148
static std::unique_ptr< AEAD_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition: aead.cpp:60
std::vector< std::string > parse_algorithm_name(const std::string &namex)
Definition: parsing.cpp:95
#define BOTAN_UNUSED(...)
Definition: assert.h:142
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
virtual std::string provider() const
Definition: cipher_mode.h:180

◆ create_or_throw()

std::unique_ptr< AEAD_Mode > Botan::AEAD_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 50 of file aead.cpp.

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

Referenced by Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::TLS::Session::decrypt(), Botan::TLS::Session::encrypt(), Botan::mceies_decrypt(), and Botan::mceies_encrypt().

53  {
54  if(auto aead = AEAD_Mode::create(algo, dir, provider))
55  return aead;
56 
57  throw Lookup_Error("AEAD", algo, provider);
58  }
static std::unique_ptr< AEAD_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition: aead.cpp:60
virtual std::string provider() const
Definition: cipher_mode.h:180

◆ default_nonce_length()

size_t Botan::AEAD_Mode::default_nonce_length ( ) const
inlineoverridevirtualinherited
Returns
default AEAD nonce size (a commonly supported value among AEAD modes, and large enough that random collisions are unlikely)

Implements Botan::Cipher_Mode.

Reimplemented in Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, and Botan::CCM_Mode.

Definition at line 130 of file aead.h.

130 { return 12; }

◆ finish()

void Botan::OCB_Decryption::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.

Definition at line 465 of file ocb.cpp.

References Botan::OCB_Mode::block_size(), BOTAN_ASSERT, Botan::constant_time_compare(), Botan::OCB_Mode::m_ad_hash, Botan::OCB_Mode::m_block_index, Botan::OCB_Mode::m_checksum, Botan::OCB_Mode::m_cipher, Botan::OCB_Mode::m_L, Botan::OCB_Mode::tag_size(), Botan::SymmetricAlgorithm::verify_key_set(), Botan::xor_buf(), and Botan::zeroise().

466  {
467  verify_key_set(m_L != nullptr);
468 
469  const size_t BS = block_size();
470 
471  BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane");
472  const size_t sz = buffer.size() - offset;
473  uint8_t* buf = buffer.data() + offset;
474 
475  BOTAN_ASSERT(sz >= tag_size(), "We have the tag");
476 
477  const size_t remaining = sz - tag_size();
478 
479  secure_vector<uint8_t> mac(BS);
480 
481  if(remaining)
482  {
483  const size_t final_full_blocks = remaining / BS;
484  const size_t final_bytes = remaining - (final_full_blocks * BS);
485 
486  decrypt(buf, final_full_blocks);
487  mac ^= m_L->offset();
488 
489  if(final_bytes)
490  {
491  BOTAN_ASSERT(final_bytes < BS, "Only a partial block left");
492 
493  uint8_t* remainder = &buf[remaining - final_bytes];
494 
495  mac ^= m_L->star();
496  secure_vector<uint8_t> pad(BS);
497  m_cipher->encrypt(mac, pad); // P_*
498  xor_buf(remainder, pad.data(), final_bytes);
499 
500  xor_buf(m_checksum.data(), remainder, final_bytes);
501  m_checksum[final_bytes] ^= 0x80;
502  }
503  }
504  else
505  mac = m_L->offset();
506 
507  // compute the mac
508 
509  // fold checksum
510  for(size_t i = 0; i != m_checksum.size(); i += BS)
511  {
512  xor_buf(mac.data(), m_checksum.data() + i, BS);
513  }
514 
515  mac ^= m_L->dollar();
516  m_cipher->encrypt(mac);
517  mac ^= m_ad_hash;
518 
519  // reset state
521  m_block_index = 0;
522 
523  // compare mac
524  const uint8_t* included_tag = &buf[remaining];
525 
526  if(!constant_time_compare(mac.data(), included_tag, tag_size()))
527  throw Invalid_Authentication_Tag("OCB tag check failed");
528 
529  // remove tag from end of message
530  buffer.resize(remaining + offset);
531  }
std::unique_ptr< BlockCipher > m_cipher
Definition: ocb.h:65
void verify_key_set(bool cond) const
Definition: sym_algo.h:171
bool constant_time_compare(const uint8_t x[], const uint8_t y[], size_t len)
Definition: mem_ops.h:82
size_t tag_size() const override
Definition: ocb.h:46
#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:262
std::unique_ptr< L_computer > m_L
Definition: ocb.h:66
size_t block_size() const
Definition: ocb.h:60
secure_vector< uint8_t > m_ad_hash
Definition: ocb.h:71
secure_vector< uint8_t > m_checksum
Definition: ocb.h:70
size_t m_block_index
Definition: ocb.h:68
void zeroise(std::vector< T, Alloc > &vec)
Definition: secmem.h:117

◆ key_spec()

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

Implements Botan::SymmetricAlgorithm.

Definition at line 223 of file ocb.cpp.

References Botan::OCB_Mode::m_cipher.

224  {
225  return m_cipher->key_spec();
226  }
std::unique_ptr< BlockCipher > m_cipher
Definition: ocb.h:65

◆ maximum_associated_data_inputs()

virtual size_t Botan::AEAD_Mode::maximum_associated_data_inputs ( ) const
inlinevirtualinherited

Returns the maximum supported number of associated data inputs which can be provided to set_associated_data_n

If returns 0, then no associated data is supported.

Reimplemented in Botan::SIV_Mode.

Definition at line 87 of file aead.h.

87 { return 1; }

◆ 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
virtual Key_Length_Specification key_spec() const =0

◆ minimum_final_size()

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

Implements Botan::Cipher_Mode.

Definition at line 126 of file ocb.h.

References Botan::OCB_Mode::tag_size().

126 { return tag_size(); }
size_t tag_size() const override
Definition: ocb.h:46

◆ minimum_keylength()

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

Definition at line 128 of file sym_algo.h.

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

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

◆ name()

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

Implements Botan::SymmetricAlgorithm.

Definition at line 213 of file ocb.cpp.

References Botan::OCB_Mode::m_cipher.

214  {
215  return m_cipher->name() + "/OCB"; // include tag size?
216  }
std::unique_ptr< BlockCipher > m_cipher
Definition: ocb.h:65

◆ output_length()

size_t Botan::OCB_Decryption::output_length ( size_t  input_length) const
inlineoverridevirtual

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.

Definition at line 120 of file ocb.h.

References BOTAN_ASSERT, and Botan::OCB_Mode::tag_size().

121  {
122  BOTAN_ASSERT(input_length >= tag_size(), "Sufficient input");
123  return input_length - tag_size();
124  }
size_t tag_size() const override
Definition: ocb.h:46
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55

◆ par_blocks()

size_t Botan::OCB_Mode::par_blocks ( ) const
inlineprotectedinherited

Definition at line 61 of file ocb.h.

61 { return m_par_blocks; }

◆ par_bytes()

size_t Botan::OCB_Mode::par_bytes ( ) const
inlineprotectedinherited

Definition at line 62 of file ocb.h.

62 { return m_checksum.size(); }
secure_vector< uint8_t > m_checksum
Definition: ocb.h:70

◆ process()

size_t Botan::OCB_Decryption::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 458 of file ocb.cpp.

References Botan::OCB_Mode::block_size(), BOTAN_ASSERT, and Botan::OCB_Mode::update_granularity().

459  {
460  BOTAN_ASSERT(sz % update_granularity() == 0, "Invalid OCB input size");
461  decrypt(buf, sz / block_size());
462  return sz;
463  }
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
size_t update_granularity() const override
Definition: ocb.cpp:218
size_t block_size() const
Definition: ocb.h:60

◆ 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::OCB_Mode::reset ( )
overridevirtualinherited

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

Implements Botan::Cipher_Mode.

Definition at line 194 of file ocb.cpp.

References Botan::OCB_Mode::m_ad_hash, Botan::OCB_Mode::m_block_index, Botan::OCB_Mode::m_checksum, and Botan::zeroise().

Referenced by Botan::OCB_Mode::clear().

195  {
196  m_block_index = 0;
199  m_last_nonce.clear();
200  m_stretch.clear();
201  }
secure_vector< uint8_t > m_ad_hash
Definition: ocb.h:71
secure_vector< uint8_t > m_checksum
Definition: ocb.h:70
size_t m_block_index
Definition: ocb.h:68
void zeroise(std::vector< T, Alloc > &vec)
Definition: secmem.h:117

◆ set_ad()

template<typename Alloc >
void Botan::AEAD_Mode::set_ad ( const std::vector< uint8_t, Alloc > &  ad)
inlineinherited

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.

See set_associated_data().

Parameters
adthe associated data

Definition at line 121 of file aead.h.

Referenced by Botan::TLS::write_record().

122  {
123  set_associated_data(ad.data(), ad.size());
124  }
virtual void set_associated_data(const uint8_t ad[], size_t ad_len)=0

◆ set_associated_data()

void Botan::OCB_Mode::set_associated_data ( const uint8_t  ad[],
size_t  ad_len 
)
overridevirtualinherited

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.

Unless reset by another call, the associated data is kept between messages. Thus, if the AD does not change, calling once (after set_key) is the optimum.

Parameters
adthe associated data
ad_lenlength of add in bytes

Implements Botan::AEAD_Mode.

Definition at line 234 of file ocb.cpp.

References Botan::OCB_Mode::m_ad_hash, Botan::OCB_Mode::m_cipher, Botan::OCB_Mode::m_L, and Botan::SymmetricAlgorithm::verify_key_set().

235  {
236  verify_key_set(m_L != nullptr);
237  m_ad_hash = ocb_hash(*m_L, *m_cipher, ad, ad_len);
238  }
std::unique_ptr< BlockCipher > m_cipher
Definition: ocb.h:65
void verify_key_set(bool cond) const
Definition: sym_algo.h:171
std::unique_ptr< L_computer > m_L
Definition: ocb.h:66
secure_vector< uint8_t > m_ad_hash
Definition: ocb.h:71

◆ set_associated_data_n()

void Botan::AEAD_Mode::set_associated_data_n ( size_t  i,
const uint8_t  ad[],
size_t  ad_len 
)
virtualinherited

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.

Unless reset by another call, the associated data is kept between messages. Thus, if the AD does not change, calling once (after set_key) is the optimum.

Some AEADs (namely SIV) support multiple AD inputs. For all other modes only nominal AD input 0 is supported; all other values of i will cause an exception.

Parameters
adthe associated data
ad_lenlength of add in bytes

Reimplemented in Botan::SIV_Mode.

Definition at line 42 of file aead.cpp.

References Botan::SymmetricAlgorithm::name(), and Botan::AEAD_Mode::set_associated_data().

Referenced by Botan::SIV_Mode::set_associated_data().

43  {
44  if(i == 0)
45  this->set_associated_data(ad, ad_len);
46  else
47  throw Invalid_Argument("AEAD '" + name() + "' does not support multiple associated data");
48  }
virtual std::string name() const =0
virtual void set_associated_data(const uint8_t ad[], size_t ad_len)=0

◆ set_associated_data_vec()

template<typename Alloc >
void Botan::AEAD_Mode::set_associated_data_vec ( const std::vector< uint8_t, Alloc > &  ad)
inlineinherited

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.

See set_associated_data().

Parameters
adthe associated data

Definition at line 106 of file aead.h.

107  {
108  set_associated_data(ad.data(), ad.size());
109  }
virtual void set_associated_data(const uint8_t ad[], size_t ad_len)=0

◆ set_key() [1/3]

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

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

◆ tag_size()

size_t Botan::OCB_Mode::tag_size ( ) const
inlineoverridevirtualinherited
Returns
the size of the authentication tag used (in bytes)

Reimplemented from Botan::Cipher_Mode.

Definition at line 46 of file ocb.h.

Referenced by Botan::OCB_Encryption::finish(), finish(), minimum_final_size(), Botan::OCB_Encryption::output_length(), and output_length().

46 { return m_tag_size; }

◆ 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(), Botan::CTS_Encryption::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::OCB_Mode::update_granularity ( ) const
overridevirtualinherited
Returns
size of required blocks to update

Implements Botan::Cipher_Mode.

Definition at line 218 of file ocb.cpp.

References Botan::OCB_Mode::block_size().

Referenced by Botan::OCB_Encryption::process(), and process().

219  {
220  return (m_par_blocks * block_size());
221  }
size_t block_size() const
Definition: ocb.h:60

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

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

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

◆ valid_nonce_length()

bool Botan::OCB_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.

Definition at line 203 of file ocb.cpp.

References Botan::OCB_Mode::block_size().

204  {
205  if(length == 0)
206  return false;
207  if(block_size() == 16)
208  return length < 16;
209  else
210  return length < (block_size() - 1);
211  }
size_t block_size() const
Definition: ocb.h:60

◆ verify_key_set()

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

Definition at line 171 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::DESX::decrypt_n(), Botan::XTEA::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::DES::decrypt_n(), Botan::MISTY1::decrypt_n(), Botan::CAST_256::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SM4::decrypt_n(), Botan::AES_128::decrypt_n(), Botan::KASUMI::decrypt_n(), Botan::SEED::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::AES_192::decrypt_n(), Botan::GOST_28147_89::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::XTEA::encrypt_n(), Botan::DESX::encrypt_n(), Botan::Camellia_128::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::AES_192::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::OCB_Encryption::finish(), 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().

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

Member Data Documentation

◆ m_ad_hash

secure_vector<uint8_t> Botan::OCB_Mode::m_ad_hash
protectedinherited

◆ m_block_index

size_t Botan::OCB_Mode::m_block_index = 0
protectedinherited

Definition at line 68 of file ocb.h.

Referenced by Botan::OCB_Encryption::finish(), finish(), and Botan::OCB_Mode::reset().

◆ m_checksum

secure_vector<uint8_t> Botan::OCB_Mode::m_checksum
protectedinherited

Definition at line 70 of file ocb.h.

Referenced by Botan::OCB_Encryption::finish(), finish(), and Botan::OCB_Mode::reset().

◆ m_cipher

std::unique_ptr<BlockCipher> Botan::OCB_Mode::m_cipher
protectedinherited

◆ m_L

std::unique_ptr<L_computer> Botan::OCB_Mode::m_L
protectedinherited

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