Botan  2.4.0
Crypto and TLS for C++11
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::XTS_Mode Class Referenceabstract

#include <xts.h>

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

Public Member Functions

virtual bool authenticated () const
 
void clear () override
 
size_t default_nonce_length () const override
 
virtual void finish (secure_vector< uint8_t > &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 size_t process (uint8_t msg[], size_t msg_len)=0
 
virtual std::string provider () const
 
void reset () override
 
template<typename Alloc >
void set_key (const std::vector< uint8_t, Alloc > &key)
 
void set_key (const SymmetricKey &key)
 
void set_key (const uint8_t key[], size_t length)
 
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::vector< std::string > providers (const std::string &algo_spec)
 

Protected Member Functions

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

Detailed Description

IEEE P1619 XTS Mode

Definition at line 20 of file xts.h.

Constructor & Destructor Documentation

◆ XTS_Mode()

Botan::XTS_Mode::XTS_Mode ( BlockCipher cipher)
explicitprotected

Definition at line 14 of file xts.cpp.

14  : m_cipher(cipher)
15  {
16  if(poly_double_supported_size(m_cipher->block_size()) == false)
17  {
18  throw Invalid_Argument("Cannot use " + cipher->name() + " with XTS");
19  }
20 
21  m_tweak_cipher.reset(m_cipher->clone());
22  m_tweak.resize(update_granularity());
23  }
const BlockCipher & cipher() const
Definition: xts.h:44
virtual std::string name() const =0
size_t update_granularity() const override
Definition: xts.cpp:42
bool poly_double_supported_size(size_t n)
Definition: poly_dbl.h:22

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 151 of file cipher_mode.h.

151 { return false; }

◆ cipher()

const BlockCipher& Botan::XTS_Mode::cipher ( ) const
inlineprotected

◆ clear()

void Botan::XTS_Mode::clear ( )
overridevirtual

Zeroise all state See also reset_msg()

Implements Botan::Cipher_Mode.

Definition at line 25 of file xts.cpp.

References reset().

26  {
27  m_cipher->clear();
28  m_tweak_cipher->clear();
29  reset();
30  }
void reset() override
Definition: xts.cpp:32

◆ default_nonce_length()

size_t Botan::XTS_Mode::default_nonce_length ( ) const
overridevirtual
Returns
the default size for a nonce

Implements Botan::Cipher_Mode.

Definition at line 57 of file xts.cpp.

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

58  {
59  return cipher().block_size();
60  }
const BlockCipher & cipher() const
Definition: xts.h:44
virtual size_t block_size() const =0

◆ finish()

virtual void Botan::Cipher_Mode::finish ( secure_vector< uint8_t > &  final_block,
size_t  offset = 0 
)
pure virtualinherited

◆ key_spec()

Key_Length_Specification Botan::XTS_Mode::key_spec ( ) const
overridevirtual
Returns
object describing limits on key size

Implements Botan::Cipher_Mode.

Definition at line 52 of file xts.cpp.

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

53  {
54  return cipher().key_spec().multiple(2);
55  }
const BlockCipher & cipher() const
Definition: xts.h:44
virtual Key_Length_Specification key_spec() const =0
Key_Length_Specification multiple(size_t n) const
Definition: key_spec.h:87

◆ minimum_final_size()

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

Implements Botan::Cipher_Mode.

Definition at line 47 of file xts.cpp.

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

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

48  {
49  return cipher().block_size() + 1;
50  }
const BlockCipher & cipher() const
Definition: xts.h:44
virtual size_t block_size() const =0

◆ name()

std::string Botan::XTS_Mode::name ( ) const
overridevirtual

Implements Botan::Cipher_Mode.

Definition at line 37 of file xts.cpp.

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

Referenced by valid_nonce_length().

38  {
39  return cipher().name() + "/XTS";
40  }
const BlockCipher & cipher() const
Definition: xts.h:44
virtual std::string name() const =0

◆ output_length()

virtual size_t Botan::Cipher_Mode::output_length ( size_t  input_length) const
pure virtualinherited

◆ process()

virtual size_t Botan::Cipher_Mode::process ( uint8_t  msg[],
size_t  msg_len 
)
pure virtualinherited

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

Implemented in Botan::OCB_Decryption, Botan::CBC_Decryption, Botan::EAX_Decryption, Botan::GCM_Decryption, Botan::OCB_Encryption, Botan::CFB_Decryption, Botan::ChaCha20Poly1305_Decryption, Botan::XTS_Decryption, Botan::EAX_Encryption, Botan::GCM_Encryption, Botan::CBC_Encryption, Botan::CFB_Encryption, Botan::ChaCha20Poly1305_Encryption, Botan::XTS_Encryption, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::SIV_Mode, Botan::CCM_Mode, and Botan::Stream_Cipher_Mode.

Referenced by Botan::TLS::check_tls_cbc_padding(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::set_associated_data().

◆ 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 208 of file cipher_mode.h.

208 { 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 158 of file cipher_mode.cpp.

References Botan::ENCRYPTION, and Botan::get_cipher_mode().

159  {
160  const std::vector<std::string>& possible = { "base", "openssl" };
161  std::vector<std::string> providers;
162  for(auto&& prov : possible)
163  {
164  std::unique_ptr<Cipher_Mode> mode(get_cipher_mode(algo_spec, ENCRYPTION, prov));
165  if(mode)
166  {
167  providers.push_back(prov); // available
168  }
169  }
170  return providers;
171  }
Cipher_Mode * get_cipher_mode(const std::string &algo, Cipher_Dir direction, const std::string &provider)
Definition: cipher_mode.cpp:40
static std::vector< std::string > providers(const std::string &algo_spec)

◆ reset()

void Botan::XTS_Mode::reset ( )
overridevirtual

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

Implements Botan::Cipher_Mode.

Definition at line 32 of file xts.cpp.

References Botan::zeroise().

Referenced by clear().

33  {
34  zeroise(m_tweak);
35  }
void zeroise(std::vector< T, Alloc > &vec)
Definition: secmem.h:181

◆ set_key() [1/3]

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

Set the symmetric key of this transform

Parameters
keycontains the key material

Definition at line 178 of file cipher_mode.h.

Referenced by botan_cipher_set_key(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::key_spec().

179  {
180  set_key(key.data(), key.size());
181  }
void set_key(const std::vector< uint8_t, Alloc > &key)
Definition: cipher_mode.h:178

◆ set_key() [2/3]

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

Set the symmetric key of this transform

Parameters
keycontains the key material

Definition at line 187 of file cipher_mode.h.

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

188  {
189  set_key(key.begin(), key.length());
190  }
void set_key(const std::vector< uint8_t, Alloc > &key)
Definition: cipher_mode.h:178

◆ set_key() [3/3]

void Botan::Cipher_Mode::set_key ( const uint8_t  key[],
size_t  length 
)
inlineinherited

Set the symmetric key of this transform

Parameters
keycontains the key material
lengthin bytes of key param

Definition at line 197 of file cipher_mode.h.

198  {
199  if(!valid_keylength(length))
200  throw Invalid_Key_Length(name(), length);
201  key_schedule(key, length);
202  }
virtual std::string name() const =0
bool valid_keylength(size_t length) const
Definition: cipher_mode.h:168

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

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

45  {
46  start_msg(nonce.data(), nonce.size());
47  }
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 54 of file cipher_mode.h.

55  {
56  start_msg(nonce, nonce_len);
57  }
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 62 of file cipher_mode.h.

63  {
64  return start_msg(nullptr, 0);
65  }
virtual void start_msg(const uint8_t nonce[], size_t nonce_len)=0

◆ 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::OCB_Mode, Botan::CCM_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, and Botan::EAX_Mode.

Definition at line 156 of file cipher_mode.h.

Referenced by botan_cipher_get_tag_length().

156 { return 0; }

◆ tweak()

const uint8_t* Botan::XTS_Mode::tweak ( ) const
inlineprotected

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

88  {
89  BOTAN_ASSERT(buffer.size() >= offset, "Offset ok");
90  uint8_t* buf = buffer.data() + offset;
91  const size_t buf_size = buffer.size() - offset;
92 
93  const size_t written = process(buf, buf_size);
94  buffer.resize(offset + written);
95  }
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:29
virtual size_t process(uint8_t msg[], size_t msg_len)=0

◆ update_granularity()

size_t Botan::XTS_Mode::update_granularity ( ) const
overridevirtual
Returns
size of required blocks to update

Implements Botan::Cipher_Mode.

Definition at line 42 of file xts.cpp.

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

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

43  {
44  return cipher().parallel_bytes();
45  }
size_t parallel_bytes() const
Definition: block_cipher.h:63
const BlockCipher & cipher() const
Definition: xts.h:44

◆ update_tweak()

void Botan::XTS_Mode::update_tweak ( size_t  last_used)
protected

Definition at line 89 of file xts.cpp.

References Botan::poly_double_n_le(), and update_granularity().

Referenced by Botan::XTS_Encryption::process(), Botan::XTS_Decryption::process(), and valid_nonce_length().

90  {
91  const size_t BS = m_tweak_cipher->block_size();
92 
93  if(which > 0)
94  poly_double_n_le(m_tweak.data(), &m_tweak[(which-1)*BS], BS);
95 
96  const size_t blocks_in_tweak = update_granularity() / BS;
97 
98  for(size_t i = 1; i < blocks_in_tweak; ++i)
99  poly_double_n_le(&m_tweak[i*BS], &m_tweak[(i-1)*BS], BS);
100  }
void poly_double_n_le(uint8_t out[], const uint8_t in[], size_t n)
Definition: poly_dbl.cpp:64
size_t update_granularity() const override
Definition: xts.cpp:42

◆ valid_keylength()

bool Botan::Cipher_Mode::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 168 of file cipher_mode.h.

169  {
170  return key_spec().valid_keylength(length);
171  }
virtual Key_Length_Specification key_spec() const =0
bool valid_keylength(size_t length) const
Definition: key_spec.h:51

◆ valid_nonce_length()

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

Implements Botan::Cipher_Mode.

Definition at line 62 of file xts.cpp.

References Botan::BlockCipher::block_size(), cipher(), Botan::copy_mem(), name(), and update_tweak().

63  {
64  return cipher().block_size() == n;
65  }
const BlockCipher & cipher() const
Definition: xts.h:44
virtual size_t block_size() const =0

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