Botan  1.11.15
Public Types | Public Member Functions | Protected Member Functions
Botan::XTS_Mode Class Reference

#include <xts.h>

Inheritance diagram for Botan::XTS_Mode:
Botan::Cipher_Mode Botan::Keyed_Transform Botan::Transform Botan::XTS_Decryption Botan::XTS_Encryption

List of all members.

Public Types

typedef SCAN_Name Spec

Public Member Functions

virtual bool authenticated () const
void clear () override
size_t default_nonce_length () const override
virtual void finish (secure_vector< byte > &final_block, size_t offset=0)=0
Key_Length_Specification key_spec () const override
size_t minimum_final_size () const override
std::string name () const override
virtual size_t output_length (size_t input_length) const =0
virtual std::string provider () const
template<typename Alloc >
void set_key (const std::vector< byte, Alloc > &key)
void set_key (const SymmetricKey &key)
void set_key (const byte key[], size_t length)
template<typename Alloc >
secure_vector< bytestart (const std::vector< byte, Alloc > &nonce)
secure_vector< bytestart (const byte nonce[], size_t nonce_len)
secure_vector< bytestart ()
template<typename Alloc >
secure_vector< bytestart_vec (const std::vector< byte, Alloc > &nonce)
virtual size_t tag_size () const
virtual void update (secure_vector< byte > &blocks, size_t offset=0)=0
size_t update_granularity () const override
bool valid_keylength (size_t length) const
bool valid_nonce_length (size_t n) const override

Protected Member Functions

const BlockCiphercipher () const
const bytetweak () const
void update_tweak (size_t last_used)
 XTS_Mode (BlockCipher *cipher)

Detailed Description

IEEE P1619 XTS Mode

Definition at line 19 of file xts.h.


Member Typedef Documentation

typedef SCAN_Name Botan::Transform::Spec [inherited]

Definition at line 27 of file transform.h.


Constructor & Destructor Documentation

Botan::XTS_Mode::XTS_Mode ( BlockCipher cipher) [protected]

Definition at line 53 of file xts.cpp.

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

                                      : m_cipher(cipher)
   {
   if(m_cipher->block_size() != 8 && m_cipher->block_size() != 16)
      throw std::invalid_argument("Bad cipher for XTS: " + cipher->name());

   m_tweak_cipher.reset(m_cipher->clone());
   m_tweak.resize(update_granularity());
   }

Member Function Documentation

virtual bool Botan::Cipher_Mode::authenticated ( ) const [inline, virtual, inherited]

Returns true iff this mode provides authentication as well as confidentiality.

Reimplemented in Botan::AEAD_Mode.

Definition at line 26 of file cipher_mode.h.

{ return false; }
const BlockCipher& Botan::XTS_Mode::cipher ( ) const [inline, protected]
void Botan::XTS_Mode::clear ( ) [override, virtual]

Implements Botan::Transform.

Definition at line 62 of file xts.cpp.

References Botan::zeroise().

   {
   m_cipher->clear();
   m_tweak_cipher->clear();
   zeroise(m_tweak);
   }
size_t Botan::XTS_Mode::default_nonce_length ( ) const [override, virtual]

Return the default size for a nonce

Implements Botan::Transform.

Definition at line 89 of file xts.cpp.

References Botan::BlockCipher::block_size(), and cipher().

   {
   return cipher().block_size();
   }
virtual void Botan::Transform::finish ( secure_vector< byte > &  final_block,
size_t  offset = 0 
) [pure virtual, inherited]
Key_Length_Specification Botan::XTS_Mode::key_spec ( ) const [override, virtual]
Returns:
object describing limits on key size

Implements Botan::Keyed_Transform.

Definition at line 84 of file xts.cpp.

References cipher(), Botan::SymmetricAlgorithm::key_spec(), and Botan::Key_Length_Specification::multiple().

   {
   return cipher().key_spec().multiple(2);
   }
size_t Botan::XTS_Mode::minimum_final_size ( ) const [override, virtual]
Returns:
required minimium size to finalize() - may be any length larger than this.

Implements Botan::Transform.

Definition at line 79 of file xts.cpp.

References Botan::BlockCipher::block_size(), and cipher().

Referenced by Botan::XTS_Encryption::finish(), and Botan::XTS_Decryption::finish().

   {
   return cipher().block_size() + 1;
   }
std::string Botan::XTS_Mode::name ( ) const [override, virtual]

Implements Botan::Transform.

Definition at line 69 of file xts.cpp.

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

   {
   return cipher().name() + "/XTS";
   }
virtual size_t Botan::Transform::output_length ( size_t  input_length) const [pure virtual, inherited]
virtual std::string Botan::Transform::provider ( ) const [inline, virtual, inherited]

Return some short name describing the provider of this tranformation. Useful in cases where multiple implementations are available (eg, different implementations of AES). Default "core" is used for the 'standard' implementation included in the library.

Definition at line 120 of file transform.h.

{ return "core"; }
template<typename Alloc >
void Botan::Keyed_Transform::set_key ( const std::vector< byte, Alloc > &  key) [inline, inherited]

Definition at line 148 of file transform.h.

Referenced by botan_cipher_set_key().

         {
         set_key(&key[0], key.size());
         }
void Botan::Keyed_Transform::set_key ( const SymmetricKey key) [inline, inherited]

Definition at line 153 of file transform.h.

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

         {
         set_key(key.begin(), key.length());
         }
void Botan::Keyed_Transform::set_key ( const byte  key[],
size_t  length 
) [inline, inherited]

Set the symmetric key of this transform

Parameters:
keycontains the key material
lengthin bytes of key param

Definition at line 163 of file transform.h.

         {
         if(!valid_keylength(length))
            throw Invalid_Key_Length(name(), length);
         key_schedule(key, length);
         }
template<typename Alloc >
secure_vector<byte> Botan::Transform::start ( const std::vector< byte, Alloc > &  nonce) [inline, inherited]

Begin processing a message.

Parameters:
noncethe per message nonce

Definition at line 34 of file transform.h.

Referenced by botan_cipher_start().

         {
         return start(&nonce[0], nonce.size());
         }
secure_vector<byte> Botan::Transform::start ( const byte  nonce[],
size_t  nonce_len 
) [inline, inherited]

Begin processing a message.

Parameters:
noncethe per message nonce
nonce_lenlength of nonce

Definition at line 55 of file transform.h.

         {
         return start_raw(nonce, nonce_len);
         }
secure_vector<byte> Botan::Transform::start ( ) [inline, inherited]

Begin processing a message.

Definition at line 63 of file transform.h.

         {
         return start_raw(nullptr, 0);
         }
template<typename Alloc >
secure_vector<byte> Botan::Transform::start_vec ( const std::vector< byte, Alloc > &  nonce) [inline, inherited]

Begin processing a message.

Parameters:
noncethe per message nonce

Definition at line 45 of file transform.h.

         {
         return start(&nonce[0], nonce.size());
         }
virtual size_t Botan::Cipher_Mode::tag_size ( ) const [inline, virtual, inherited]

Return the size of the authentication tag used (in bytes)

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

Definition at line 31 of file cipher_mode.h.

Referenced by botan_cipher_get_tag_length().

{ return 0; }
const byte* Botan::XTS_Mode::tweak ( ) const [inline, protected]
virtual void Botan::Transform::update ( secure_vector< byte > &  blocks,
size_t  offset = 0 
) [pure virtual, inherited]
size_t Botan::XTS_Mode::update_granularity ( ) const [override, virtual]
Returns:
size of required blocks to update

Implements Botan::Transform.

Definition at line 74 of file xts.cpp.

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

Referenced by Botan::XTS_Encryption::update(), Botan::XTS_Decryption::update(), update_tweak(), and XTS_Mode().

   {
   return cipher().parallel_bytes();
   }
void Botan::XTS_Mode::update_tweak ( size_t  last_used) [protected]

Definition at line 123 of file xts.cpp.

References update_granularity().

Referenced by Botan::XTS_Encryption::update(), and Botan::XTS_Decryption::update().

   {
   const size_t BS = m_tweak_cipher->block_size();

   if(which > 0)
      poly_double(&m_tweak[0], &m_tweak[(which-1)*BS], BS);

   const size_t blocks_in_tweak = update_granularity() / BS;

   for(size_t i = 1; i < blocks_in_tweak; ++i)
      poly_double(&m_tweak[i*BS], &m_tweak[(i-1)*BS], BS);
   }
bool Botan::Keyed_Transform::valid_keylength ( size_t  length) const [inline, inherited]

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 142 of file transform.h.

References Botan::Key_Length_Specification::valid_keylength().

         {
         return key_spec().valid_keylength(length);
         }
bool Botan::XTS_Mode::valid_nonce_length ( size_t  nonce_len) const [override, virtual]

Return true iff nonce_len is a valid length for the nonce

Implements Botan::Transform.

Definition at line 94 of file xts.cpp.

References Botan::BlockCipher::block_size(), cipher(), and n.

   {
   return cipher().block_size() == n;
   }

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