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_Decryption Class Referencefinal

#include <xts.h>

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

Public Member Functions

virtual 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
 
size_t minimum_final_size () const override
 
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
 
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
 
 XTS_Decryption (BlockCipher *cipher)
 

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)
 

Detailed Description

IEEE P1619 XTS Decryption

Definition at line 77 of file xts.h.

Constructor & Destructor Documentation

◆ XTS_Decryption()

Botan::XTS_Decryption::XTS_Decryption ( BlockCipher cipher)
inlineexplicit
Parameters
cipherunderlying block cipher

Definition at line 83 of file xts.h.

83 : XTS_Mode(cipher) {}
const BlockCipher & cipher() const
Definition: xts.h:44
XTS_Mode(BlockCipher *cipher)
Definition: xts.cpp:14

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
inlineprotectedinherited

◆ clear()

void Botan::XTS_Mode::clear ( )
overridevirtualinherited

Zeroise all state See also reset_msg()

Implements Botan::Cipher_Mode.

Definition at line 25 of file xts.cpp.

References Botan::XTS_Mode::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
overridevirtualinherited
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 Botan::XTS_Mode::cipher().

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

◆ finish()

void Botan::XTS_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 204 of file xts.cpp.

References Botan::BlockCipher::block_size(), BOTAN_ASSERT, Botan::XTS_Mode::cipher(), Botan::BlockCipher::decrypt(), Botan::XTS_Mode::minimum_final_size(), Botan::XTS_Mode::tweak(), Botan::Cipher_Mode::update(), and Botan::xor_buf().

205  {
206  BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane");
207  const size_t sz = buffer.size() - offset;
208  uint8_t* buf = buffer.data() + offset;
209 
210  BOTAN_ASSERT(sz >= minimum_final_size(), "Have sufficient final input in XTS decrypt");
211 
212  const size_t BS = cipher().block_size();
213 
214  if(sz % BS == 0)
215  {
216  update(buffer, offset);
217  }
218  else
219  {
220  // steal ciphertext
221  const size_t full_blocks = ((sz / BS) - 1) * BS;
222  const size_t final_bytes = sz - full_blocks;
223  BOTAN_ASSERT(final_bytes > BS && final_bytes < 2*BS, "Left over size in expected range");
224 
225  secure_vector<uint8_t> last(buf + full_blocks, buf + full_blocks + final_bytes);
226  buffer.resize(full_blocks + offset);
227  update(buffer, offset);
228 
229  xor_buf(last, tweak() + BS, BS);
230  cipher().decrypt(last);
231  xor_buf(last, tweak() + BS, BS);
232 
233  for(size_t i = 0; i != final_bytes - BS; ++i)
234  {
235  last[i] ^= last[i + BS];
236  last[i + BS] ^= last[i];
237  last[i] ^= last[i + BS];
238  }
239 
240  xor_buf(last, tweak(), BS);
241  cipher().decrypt(last);
242  xor_buf(last, tweak(), BS);
243 
244  buffer += last;
245  }
246  }
void update(secure_vector< uint8_t > &buffer, size_t offset=0)
Definition: cipher_mode.h:87
const BlockCipher & cipher() const
Definition: xts.h:44
const uint8_t * tweak() const
Definition: xts.h:42
void decrypt(const uint8_t in[], uint8_t out[]) const
Definition: block_cipher.h:91
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:29
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition: mem_ops.h:163
size_t minimum_final_size() const override
Definition: xts.cpp:47
virtual size_t block_size() const =0

◆ key_spec()

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

Implements Botan::Cipher_Mode.

Definition at line 52 of file xts.cpp.

References Botan::XTS_Mode::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
overridevirtualinherited
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 Botan::XTS_Mode::cipher().

Referenced by Botan::XTS_Encryption::finish(), and 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
overridevirtualinherited

Implements Botan::Cipher_Mode.

Definition at line 37 of file xts.cpp.

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

Referenced by Botan::XTS_Mode::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()

size_t Botan::XTS_Decryption::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. Will throw if unable to give a precise answer.

Implements Botan::Cipher_Mode.

Definition at line 175 of file xts.cpp.

176  {
177  return input_length;
178  }

◆ process()

size_t Botan::XTS_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 180 of file xts.cpp.

References Botan::BlockCipher::block_size(), BOTAN_ASSERT, Botan::XTS_Mode::cipher(), Botan::BlockCipher::decrypt_n_xex(), Botan::XTS_Mode::tweak(), Botan::XTS_Mode::update_granularity(), and Botan::XTS_Mode::update_tweak().

181  {
182  const size_t BS = cipher().block_size();
183 
184  BOTAN_ASSERT(sz % BS == 0, "Input is full blocks");
185  size_t blocks = sz / BS;
186 
187  const size_t blocks_in_tweak = update_granularity() / BS;
188 
189  while(blocks)
190  {
191  const size_t to_proc = std::min(blocks, blocks_in_tweak);
192 
193  cipher().decrypt_n_xex(buf, tweak(), to_proc);
194 
195  buf += to_proc * BS;
196  blocks -= to_proc;
197 
198  update_tweak(to_proc);
199  }
200 
201  return sz;
202  }
void update_tweak(size_t last_used)
Definition: xts.cpp:89
const BlockCipher & cipher() const
Definition: xts.h:44
const uint8_t * tweak() const
Definition: xts.h:42
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:29
size_t update_granularity() const override
Definition: xts.cpp:42
virtual size_t block_size() const =0
virtual void decrypt_n_xex(uint8_t data[], const uint8_t mask[], size_t blocks) const
Definition: block_cipher.h:182

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

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 Botan::XTS_Mode::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
inlineprotectedinherited

Definition at line 42 of file xts.h.

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

42 { return m_tweak.data(); }

◆ 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(), 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
overridevirtualinherited
Returns
size of required blocks to update

Implements Botan::Cipher_Mode.

Definition at line 42 of file xts.cpp.

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

Referenced by Botan::XTS_Encryption::process(), process(), and Botan::XTS_Mode::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)
protectedinherited

Definition at line 89 of file xts.cpp.

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

Referenced by Botan::XTS_Encryption::process(), process(), and Botan::XTS_Mode::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
overridevirtualinherited
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(), Botan::XTS_Mode::cipher(), Botan::copy_mem(), Botan::XTS_Mode::name(), and Botan::XTS_Mode::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: