Botan::OCB_Encryption Class Reference

#include <ocb.h>

Inheritance diagram for Botan::OCB_Encryption:

Public Member Functions
virtual bool	associated_data_requires_key () const
bool	authenticated () const
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_Encryption (std::unique_ptr< 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)
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)
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_Mode >	create (const std::string &algo, Cipher_Dir direction, const std::string &provider="")
static std::unique_ptr< AEAD_Mode >	create_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< BlockCipher >	m_cipher
std::unique_ptr< L_computer >	m_L

Detailed Description

Definition at line 86 of file ocb.h.

Constructor & Destructor Documentation

OCB_Encryption()

Botan::OCB_Encryption::OCB_Encryption ( std::unique_ptr< BlockCipher >  cipher, size_t  tag_size = 16  )

inline

Parameters

cipher	the block cipher to use
tag_size	is how big the auth tag will be

Definition at line 93 of file ocb.h.

                                                                              :
         OCB_Mode(std::move(cipher), tag_size) {}

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::CCM_Mode, and Botan::ChaCha20Poly1305_Mode.

Definition at line 92 of file aead.h.

{ return true; }

authenticated()

bool Botan::Cipher_Mode::authenticated ( ) const

inlineinherited

Returns

true iff this mode provides authentication as well as confidentiality.

Definition at line 169 of file cipher_mode.h.

{ return this->tag_size() > 0; }

block_size()

size_t Botan::OCB_Mode::block_size ( ) const

inlineprotectedinherited

Definition at line 58 of file ocb.h.

{ return m_block_size; }

Referenced by finish(), Botan::OCB_Decryption::finish(), process(), Botan::OCB_Decryption::process(), Botan::OCB_Mode::update_granularity(), and Botan::OCB_Mode::valid_nonce_length().

clear()

void Botan::OCB_Mode::clear ( )

overridevirtualinherited

Reset the state.

Implements Botan::SymmetricAlgorithm.

Definition at line 187 of file ocb.cpp.

   {
   m_cipher->clear();
   m_L.reset(); // add clear here?
   reset();
   }

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

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

algo	the algorithm to create
direction	specify if this should be an encryption or decryption AEAD
provider	optional specification for provider to use

Returns

an AEAD mode or a null pointer if not available

Definition at line 60 of file aead.cpp.

   {
   BOTAN_UNUSED(provider);
#if defined(BOTAN_HAS_AEAD_CHACHA20_POLY1305)
   if(algo == "ChaCha20Poly1305")
      {
      if(dir == ENCRYPTION)
         return std::make_unique<ChaCha20Poly1305_Encryption>();
      else
         return std::make_unique<ChaCha20Poly1305_Decryption>();
 
      }
#endif
 
   if(algo.find('/') != std::string::npos)
      {
      const std::vector<std::string> algo_parts = split_on(algo, '/');
      const std::string cipher_name = algo_parts[0];
      const std::vector<std::string> mode_info = parse_algorithm_name(algo_parts[1]);
 
      if(mode_info.empty())
         return std::unique_ptr<AEAD_Mode>();
 
      std::ostringstream mode_name;
 
      mode_name << mode_info[0] << '(' << cipher_name;
      for(size_t i = 1; i < mode_info.size(); ++i)
         mode_name << ',' << mode_info[i];
      for(size_t i = 2; i < algo_parts.size(); ++i)
         mode_name << ',' << algo_parts[i];
      mode_name << ')';
 
      return AEAD_Mode::create(mode_name.str(), dir);
      }
 
#if defined(BOTAN_HAS_BLOCK_CIPHER)
 
   SCAN_Name req(algo);
 
   if(req.arg_count() == 0)
      {
      return std::unique_ptr<AEAD_Mode>();
      }
 
   std::unique_ptr<BlockCipher> bc(BlockCipher::create(req.arg(0), provider));
 
   if(!bc)
      {
      return std::unique_ptr<AEAD_Mode>();
      }
 
#if defined(BOTAN_HAS_AEAD_CCM)
   if(req.algo_name() == "CCM")
      {
      size_t tag_len = req.arg_as_integer(1, 16);
      size_t L_len = req.arg_as_integer(2, 3);
      if(dir == ENCRYPTION)
         return std::make_unique<CCM_Encryption>(std::move(bc), tag_len, L_len);
      else
         return std::make_unique<CCM_Decryption>(std::move(bc), tag_len, L_len);
      }
#endif
 
#if defined(BOTAN_HAS_AEAD_GCM)
   if(req.algo_name() == "GCM")
      {
      size_t tag_len = req.arg_as_integer(1, 16);
      if(dir == ENCRYPTION)
         return std::make_unique<GCM_Encryption>(std::move(bc), tag_len);
      else
         return std::make_unique<GCM_Decryption>(std::move(bc), tag_len);
      }
#endif
 
#if defined(BOTAN_HAS_AEAD_OCB)
   if(req.algo_name() == "OCB")
      {
      size_t tag_len = req.arg_as_integer(1, 16);
      if(dir == ENCRYPTION)
         return std::make_unique<OCB_Encryption>(std::move(bc), tag_len);
      else
         return std::make_unique<OCB_Decryption>(std::move(bc), tag_len);
      }
#endif
 
#if defined(BOTAN_HAS_AEAD_EAX)
   if(req.algo_name() == "EAX")
      {
      size_t tag_len = req.arg_as_integer(1, bc->block_size());
      if(dir == ENCRYPTION)
         return std::make_unique<EAX_Encryption>(std::move(bc), tag_len);
      else
         return std::make_unique<EAX_Decryption>(std::move(bc), tag_len);
      }
#endif
 
#if defined(BOTAN_HAS_AEAD_SIV)
   if(req.algo_name() == "SIV")
      {
      if(dir == ENCRYPTION)
         return std::make_unique<SIV_Encryption>(std::move(bc));
      else
         return std::make_unique<SIV_Decryption>(std::move(bc));
      }
#endif
 
#endif
 
   return std::unique_ptr<AEAD_Mode>();
   }

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

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

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

algo	the algorithm to create
direction	specify if this should be an encryption or decryption AEAD
provider	optional specification for provider to use

Returns

an AEAD mode, or throw an exception

Definition at line 50 of file aead.cpp.

   {
   if(auto aead = AEAD_Mode::create(algo, dir, provider))
      return aead;
 
   throw Lookup_Error("AEAD", algo, provider);
   }

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

Referenced by Botan::TLS::Cipher_State::advance_with_server_hello(), Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::TLS::Session::decrypt(), and Botan::TLS::Session::encrypt().

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::CCM_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.

Definition at line 128 of file aead.h.

{ return 12; }

finish()

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

overridevirtual

Complete processing of a message.

Parameters

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

Implements Botan::Cipher_Mode.

Definition at line 375 of file ocb.cpp.

   {
   verify_key_set(m_L != nullptr);
 
   const size_t BS = block_size();
 
   BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane");
   const size_t sz = buffer.size() - offset;
   uint8_t* buf = buffer.data() + offset;
 
   secure_vector<uint8_t> mac(BS);
 
   if(sz)
      {
      const size_t final_full_blocks = sz / BS;
      const size_t remainder_bytes = sz - (final_full_blocks * BS);
 
      encrypt(buf, final_full_blocks);
      mac = m_L->offset();
 
      if(remainder_bytes)
         {
         BOTAN_ASSERT(remainder_bytes < BS, "Only a partial block left");
         uint8_t* remainder = &buf[sz - remainder_bytes];
 
         xor_buf(m_checksum.data(), remainder, remainder_bytes);
         m_checksum[remainder_bytes] ^= 0x80;
 
         // Offset_*
         mac ^= m_L->star();
 
         secure_vector<uint8_t> pad(BS);
         m_cipher->encrypt(mac, pad);
         xor_buf(remainder, pad.data(), remainder_bytes);
         }
      }
   else
      {
      mac = m_L->offset();
      }
 
   // now compute the tag
 
   // fold checksum
   for(size_t i = 0; i != m_checksum.size(); i += BS)
      {
      xor_buf(mac.data(), m_checksum.data() + i, BS);
      }
 
   xor_buf(mac.data(), m_L->dollar().data(), BS);
   m_cipher->encrypt(mac);
   xor_buf(mac.data(), m_ad_hash.data(), BS);
 
   buffer += std::make_pair(mac.data(), tag_size());
 
   zeroise(m_checksum);
   m_block_index = 0;
   }

References Botan::OCB_Mode::block_size(), BOTAN_ASSERT, 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().

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.

   {
   return m_cipher->key_spec();
   }

References Botan::OCB_Mode::m_cipher.

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 85 of file aead.h.

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

         {
         return key_spec().maximum_keylength();
         }

minimum_final_size()

size_t Botan::OCB_Encryption::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 99 of file ocb.h.

{ return 0; }

minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const

inlineinherited

Returns

minimum allowed key length

Definition at line 128 of file sym_algo.h.

         {
         return key_spec().minimum_keylength();
         }

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

name()

std::string Botan::OCB_Mode::name ( ) const

overridevirtualinherited

Returns

the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 213 of file ocb.cpp.

   {
   return m_cipher->name() + "/OCB"; // include tag size?
   }

References Botan::OCB_Mode::m_cipher.

output_length()

size_t Botan::OCB_Encryption::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 96 of file ocb.h.

         { return input_length + tag_size(); }

par_blocks()

size_t Botan::OCB_Mode::par_blocks ( ) const

inlineprotectedinherited

Definition at line 59 of file ocb.h.

{ return m_par_blocks; }

par_bytes()

size_t Botan::OCB_Mode::par_bytes ( ) const

inlineprotectedinherited

Definition at line 60 of file ocb.h.

{ return m_checksum.size(); }

process()

size_t Botan::OCB_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

msg	the message to be processed
msg_len	length of the message in bytes

Implements Botan::Cipher_Mode.

Definition at line 368 of file ocb.cpp.

   {
   BOTAN_ASSERT(sz % update_granularity() == 0, "Invalid OCB input size");
   encrypt(buf, sz / block_size());
   return sz;
   }

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

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.

{ 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_spec

algorithm name

Definition at line 172 of file cipher_mode.cpp.

   {
   const std::vector<std::string>& possible = { "base", "commoncrypto" };
   std::vector<std::string> providers;
   for(auto&& prov : possible)
      {
      std::unique_ptr<Cipher_Mode> mode = Cipher_Mode::create(algo_spec, ENCRYPTION, prov);
      if(mode)
         {
         providers.push_back(prov); // available
         }
      }
   return providers;
   }

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

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

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.

   {
   m_block_index = 0;
   zeroise(m_ad_hash);
   zeroise(m_checksum);
   m_last_nonce.clear();
   m_stretch.clear();
   }

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

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

ad	the associated data

Definition at line 119 of file aead.h.

         {
         set_associated_data(ad.data(), ad.size());
         }

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

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

ad	the associated data
ad_len	length of add in bytes

Implements Botan::AEAD_Mode.

Definition at line 234 of file ocb.cpp.

   {
   verify_key_set(m_L != nullptr);
   m_ad_hash = ocb_hash(*m_L, *m_cipher, ad, ad_len);
   }

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

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

ad	the associated data
ad_len	length of add in bytes

Reimplemented in Botan::SIV_Mode.

Definition at line 42 of file aead.cpp.

   {
   if(i == 0)
      this->set_associated_data(ad, ad_len);
   else
      throw Invalid_Argument("AEAD '" + name() + "' does not support multiple associated data");
   }

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

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

ad	the associated data

Definition at line 104 of file aead.h.

         {
         set_associated_data(ad.data(), ad.size());
         }

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.

         {
         set_key(key.data(), key.size());
         }

set_key() [2/3]

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

inlineinherited

Set the symmetric key of this object.

Parameters

key	the SymmetricKey to be set.

Definition at line 147 of file sym_algo.h.

         {
         set_key(key.begin(), key.length());
         }

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

Referenced by botan_cipher_set_key(), botan_mac_set_key(), Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), and Botan::Sodium::randombytes_buf_deterministic().

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

key	the to be set as a byte array.
length	in bytes of key param

Definition at line 17 of file sym_algo.cpp.

   {
   if(!valid_keylength(length))
      throw Invalid_Key_Length(name(), length);
   key_schedule(key, length);
   }

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.

         {
         return start_msg(nullptr, 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

nonce

the per message nonce

Definition at line 69 of file cipher_mode.h.

         {
         start_msg(nonce.data(), nonce.size());
         }

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

nonce	the per message nonce
nonce_len	length of nonce

Definition at line 79 of file cipher_mode.h.

         {
         start_msg(nonce, nonce_len);
         }

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 44 of file ocb.h.

{ return m_tag_size; }

Referenced by finish(), and Botan::OCB_Decryption::finish().

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

buffer	in/out parameter which will possibly be resized
offset	an offset into blocks to begin processing

Definition at line 112 of file cipher_mode.h.

         {
         BOTAN_ASSERT(buffer.size() >= offset, "Offset ok");
         uint8_t* buf = buffer.data() + offset;
         const size_t buf_size = buffer.size() - offset;
 
         const size_t written = process(buf, buf_size);
         buffer.resize(offset + written);
         }

References BOTAN_ASSERT.

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

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.

   {
   return (m_par_blocks * block_size());
   }

References Botan::OCB_Mode::block_size().

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

valid_keylength()

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

inlineinherited

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

Parameters

length

the key length to be checked.

Returns

true if the key length is valid.

Definition at line 138 of file sym_algo.h.

         {
         return key_spec().valid_keylength(length);
         }

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

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.

   {
   if(length == 0)
      return false;
   if(block_size() == 16)
      return length < 16;
   else
      return length < (block_size() - 1);
   }

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

         {
         if(cond == false)
            throw_key_not_set_error();
         }

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

Member Data Documentation

m_ad_hash

secure_vector<uint8_t> Botan::OCB_Mode::m_ad_hash

protectedinherited

Definition at line 69 of file ocb.h.

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

m_block_index

size_t Botan::OCB_Mode::m_block_index = 0

protectedinherited

Definition at line 66 of file ocb.h.

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

m_checksum

secure_vector<uint8_t> Botan::OCB_Mode::m_checksum

protectedinherited

Definition at line 68 of file ocb.h.

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

m_cipher

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

protectedinherited

Definition at line 63 of file ocb.h.

Referenced by Botan::OCB_Mode::clear(), finish(), Botan::OCB_Decryption::finish(), Botan::OCB_Mode::key_spec(), Botan::OCB_Mode::name(), and Botan::OCB_Mode::set_associated_data().

m_L

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

protectedinherited

Definition at line 64 of file ocb.h.

Referenced by Botan::OCB_Mode::clear(), finish(), Botan::OCB_Decryption::finish(), and Botan::OCB_Mode::set_associated_data().

---

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

• src/lib/modes/aead/ocb/ocb.h
• src/lib/modes/aead/ocb/ocb.cpp