Botan  1.11.34
Crypto and TLS for C++11
Public Member Functions | Protected Member Functions | List of all members
Botan::ECB_Encryption Class Referencefinal

#include <ecb.h>

Inheritance diagram for Botan::ECB_Encryption:
Botan::ECB_Mode Botan::Cipher_Mode

Public Member Functions

virtual bool authenticated () const
 
void clear () override
 
size_t default_nonce_length () const override
 
 ECB_Encryption (BlockCipher *cipher, BlockCipherModePaddingMethod *padding)
 
void finish (secure_vector< byte > &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< byte, Alloc > &key)
 
void set_key (const SymmetricKey &key)
 
void set_key (const byte key[], size_t length)
 
template<typename Alloc >
void start (const std::vector< byte, Alloc > &nonce)
 
void start (const byte nonce[], size_t nonce_len)
 
void start ()
 
virtual size_t tag_size () const
 
void update (secure_vector< byte > &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
 

Protected Member Functions

const BlockCiphercipher () const
 
const BlockCipherModePaddingMethodpadding () const
 

Detailed Description

ECB Encryption

Definition at line 56 of file ecb.h.

Constructor & Destructor Documentation

§ ECB_Encryption()

Botan::ECB_Encryption::ECB_Encryption ( BlockCipher cipher,
BlockCipherModePaddingMethod padding 
)
inline
Parameters
cipherblock cipher to use
paddingpadding method to use

Definition at line 63 of file ecb.h.

63  :
ECB_Mode(BlockCipher *cipher, BlockCipherModePaddingMethod *padding)
Definition: ecb.cpp:14
const BlockCipherModePaddingMethod & padding() const
Definition: ecb.h:43
const BlockCipher & cipher() const
Definition: ecb.h:41

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

145 { return false; }

§ cipher()

const BlockCipher& Botan::ECB_Mode::cipher ( ) const
inlineprotectedinherited

§ clear()

void Botan::ECB_Mode::clear ( )
overridevirtualinherited

Zeroise all state See also reset_msg()

Implements Botan::Cipher_Mode.

Definition at line 24 of file ecb.cpp.

25  {
26  m_cipher->clear();
27  }

§ default_nonce_length()

size_t Botan::ECB_Mode::default_nonce_length ( ) const
overridevirtualinherited
Returns
the default size for a nonce

Implements Botan::Cipher_Mode.

Definition at line 50 of file ecb.cpp.

51  {
52  return 0;
53  }

§ finish()

void Botan::ECB_Encryption::finish ( secure_vector< byte > &  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 93 of file ecb.cpp.

References Botan::BlockCipherModePaddingMethod::add_padding(), Botan::BlockCipher::block_size(), BOTAN_ASSERT, Botan::ECB_Mode::cipher(), Botan::ECB_Mode::name(), Botan::ECB_Mode::padding(), and Botan::Cipher_Mode::update().

94  {
95  BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane");
96  const size_t sz = buffer.size() - offset;
97 
98  const size_t BS = cipher().block_size();
99 
100  const size_t bytes_in_final_block = sz % BS;
101 
102  padding().add_padding(buffer, bytes_in_final_block, BS);
103 
104  if(buffer.size() % BS)
105  throw Exception("Did not pad to full block size in " + name());
106 
107  update(buffer, offset);
108  }
void update(secure_vector< byte > &buffer, size_t offset=0)
Definition: cipher_mode.h:81
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:27
const BlockCipherModePaddingMethod & padding() const
Definition: ecb.h:43
std::string name() const override
Definition: ecb.cpp:35
virtual void add_padding(secure_vector< byte > &buffer, size_t final_block_bytes, size_t block_size) const =0
virtual size_t block_size() const =0
const BlockCipher & cipher() const
Definition: ecb.h:41

§ key_spec()

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

Implements Botan::Cipher_Mode.

Definition at line 45 of file ecb.cpp.

References Botan::ECB_Mode::cipher(), and Botan::SymmetricAlgorithm::key_spec().

46  {
47  return cipher().key_spec();
48  }
virtual Key_Length_Specification key_spec() const =0
const BlockCipher & cipher() const
Definition: ecb.h:41

§ minimum_final_size()

size_t Botan::ECB_Encryption::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 71 of file ecb.cpp.

72  {
73  return 0;
74  }

§ name()

std::string Botan::ECB_Mode::name ( ) const
overridevirtualinherited

Implements Botan::Cipher_Mode.

Definition at line 35 of file ecb.cpp.

References Botan::ECB_Mode::cipher(), Botan::BlockCipherModePaddingMethod::name(), Botan::SymmetricAlgorithm::name(), and Botan::ECB_Mode::padding().

Referenced by finish(), Botan::ECB_Decryption::finish(), and Botan::ECB_Mode::valid_nonce_length().

36  {
37  return cipher().name() + "/ECB/" + padding().name();
38  }
virtual std::string name() const =0
const BlockCipherModePaddingMethod & padding() const
Definition: ecb.h:43
virtual std::string name() const =0
const BlockCipher & cipher() const
Definition: ecb.h:41

§ output_length()

size_t Botan::ECB_Encryption::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 76 of file ecb.cpp.

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

77  {
78  if(input_length == 0)
79  return cipher().block_size();
80  else
81  return round_up(input_length, cipher().block_size());
82  }
size_t round_up(size_t n, size_t align_to)
Definition: rounding.h:22
virtual size_t block_size() const =0
const BlockCipher & cipher() const
Definition: ecb.h:41

§ padding()

const BlockCipherModePaddingMethod& Botan::ECB_Mode::padding ( ) const
inlineprotectedinherited

Definition at line 43 of file ecb.h.

Referenced by finish(), Botan::ECB_Decryption::finish(), and Botan::ECB_Mode::name().

43 { return *m_padding; }

§ process()

size_t Botan::ECB_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
msgthe message to be processed
msg_lenlength of the message in bytes

Implements Botan::Cipher_Mode.

Definition at line 84 of file ecb.cpp.

References Botan::BlockCipher::block_size(), BOTAN_ASSERT, Botan::ECB_Mode::cipher(), and Botan::BlockCipher::encrypt_n().

85  {
86  const size_t BS = cipher().block_size();
87  BOTAN_ASSERT(sz % BS == 0, "ECB input is full blocks");
88  const size_t blocks = sz / BS;
89  cipher().encrypt_n(buf, buf, blocks);
90  return sz;
91  }
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:27
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
const BlockCipher & cipher() const
Definition: ecb.h:41

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

202 { return "base"; }

§ reset()

void Botan::ECB_Mode::reset ( )
overridevirtualinherited

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

Implements Botan::Cipher_Mode.

Definition at line 29 of file ecb.cpp.

30  {
31  // no msg state here
32  return;
33  }

§ set_key() [1/3]

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

Set the symmetric key of this transform

Parameters
keycontains the key material

Definition at line 172 of file cipher_mode.h.

Referenced by botan_cipher_set_key().

173  {
174  set_key(key.data(), key.size());
175  }
void set_key(const std::vector< byte, Alloc > &key)
Definition: cipher_mode.h:172

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

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

182  {
183  set_key(key.begin(), key.length());
184  }
void set_key(const std::vector< byte, Alloc > &key)
Definition: cipher_mode.h:172

§ set_key() [3/3]

void Botan::Cipher_Mode::set_key ( const byte  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 191 of file cipher_mode.h.

192  {
193  if(!valid_keylength(length))
194  throw Invalid_Key_Length(name(), length);
195  key_schedule(key, length);
196  }
virtual std::string name() const =0
bool valid_keylength(size_t length) const
Definition: cipher_mode.h:162

§ start() [1/3]

template<typename Alloc >
void Botan::Cipher_Mode::start ( const std::vector< byte, Alloc > &  nonce)
inlineinherited

Begin processing a message.

Parameters
noncethe per message nonce

Definition at line 38 of file cipher_mode.h.

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

39  {
40  start_msg(nonce.data(), nonce.size());
41  }
virtual void start_msg(const byte nonce[], size_t nonce_len)=0

§ start() [2/3]

void Botan::Cipher_Mode::start ( const byte  nonce[],
size_t  nonce_len 
)
inlineinherited

Begin processing a message.

Parameters
noncethe per message nonce
nonce_lenlength of nonce

Definition at line 48 of file cipher_mode.h.

49  {
50  start_msg(nonce, nonce_len);
51  }
virtual void start_msg(const byte nonce[], size_t nonce_len)=0

§ start() [3/3]

void Botan::Cipher_Mode::start ( )
inlineinherited

Begin processing a message.

Definition at line 56 of file cipher_mode.h.

57  {
58  return start_msg(nullptr, 0);
59  }
virtual void start_msg(const byte 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::CCM_Mode, Botan::OCB_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, and Botan::EAX_Mode.

Definition at line 150 of file cipher_mode.h.

Referenced by botan_cipher_get_tag_length().

150 { return 0; }

§ update()

void Botan::Cipher_Mode::update ( secure_vector< byte > &  buffer,
size_t  offset = 0 
)
inlineinherited

Process some data. Input must be in size update_granularity() byte blocks.

Parameters
bufferin/out parameter which will possibly be resized
offsetan offset into blocks to begin processing

Definition at line 81 of file cipher_mode.h.

References BOTAN_ASSERT.

Referenced by botan_cipher_update(), finish(), Botan::XTS_Encryption::finish(), Botan::ChaCha20Poly1305_Encryption::finish(), Botan::CBC_Encryption::finish(), Botan::CFB_Encryption::finish(), Botan::EAX_Encryption::finish(), Botan::XTS_Decryption::finish(), Botan::ECB_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().

82  {
83  BOTAN_ASSERT(buffer.size() >= offset, "Offset ok");
84  byte* buf = buffer.data() + offset;
85  const size_t buf_size = buffer.size() - offset;
86 
87  const size_t written = process(buf, buf_size);
88  buffer.resize(offset + written);
89  }
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:27
virtual size_t process(uint8_t msg[], size_t msg_len)=0
std::uint8_t byte
Definition: types.h:31

§ update_granularity()

size_t Botan::ECB_Mode::update_granularity ( ) const
overridevirtualinherited
Returns
size of required blocks to update

Implements Botan::Cipher_Mode.

Definition at line 40 of file ecb.cpp.

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

41  {
42  return cipher().parallel_bytes();
43  }
size_t parallel_bytes() const
Definition: block_cipher.h:62
const BlockCipher & cipher() const
Definition: ecb.h:41

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

163  {
164  return key_spec().valid_keylength(length);
165  }
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::ECB_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 55 of file ecb.cpp.

References Botan::ECB_Mode::name().

56  {
57  return (n == 0);
58  }

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