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

#include <cipher_mode.h>

Inheritance diagram for Botan::Cipher_Mode:
Botan::AEAD_Mode Botan::CBC_Mode Botan::CFB_Mode Botan::Stream_Cipher_Mode Botan::XTS_Mode Botan::CCM_Mode Botan::ChaCha20Poly1305_Mode Botan::EAX_Mode Botan::GCM_Mode Botan::OCB_Mode Botan::SIV_Mode Botan::TLS::TLS_CBC_HMAC_AEAD_Mode Botan::CBC_Decryption Botan::CBC_Encryption Botan::CFB_Decryption Botan::CFB_Encryption Botan::XTS_Decryption Botan::XTS_Encryption

Public Member Functions

virtual bool authenticated () const
 
virtual void clear ()=0
 
virtual size_t default_nonce_length () const =0
 
virtual void finish (secure_vector< uint8_t > &final_block, size_t offset=0)=0
 
virtual Key_Length_Specification key_spec () const =0
 
virtual size_t minimum_final_size () const =0
 
virtual std::string name () const =0
 
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
 
virtual void reset ()=0
 
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 void start_msg (const uint8_t nonce[], size_t nonce_len)=0
 
virtual size_t tag_size () const
 
void update (secure_vector< uint8_t > &buffer, size_t offset=0)
 
virtual size_t update_granularity () const =0
 
bool valid_keylength (size_t length) const
 
virtual bool valid_nonce_length (size_t nonce_len) const =0
 
virtual ~Cipher_Mode ()=default
 

Static Public Member Functions

static std::vector< std::string > providers (const std::string &algo_spec)
 

Detailed Description

Interface for cipher modes

Definition at line 23 of file cipher_mode.h.

Constructor & Destructor Documentation

◆ ~Cipher_Mode()

virtual Botan::Cipher_Mode::~Cipher_Mode ( )
virtualdefault

Member Function Documentation

◆ authenticated()

virtual bool Botan::Cipher_Mode::authenticated ( ) const
inlinevirtual
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; }

◆ clear()

virtual void Botan::Cipher_Mode::clear ( )
pure virtual

◆ default_nonce_length()

virtual size_t Botan::Cipher_Mode::default_nonce_length ( ) const
pure virtual

◆ finish()

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

◆ key_spec()

virtual Key_Length_Specification Botan::Cipher_Mode::key_spec ( ) const
pure virtual

◆ minimum_final_size()

virtual size_t Botan::Cipher_Mode::minimum_final_size ( ) const
pure virtual

◆ name()

virtual std::string Botan::Cipher_Mode::name ( ) const
pure virtual

◆ output_length()

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

◆ process()

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

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
inlinevirtual
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)
static
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()

virtual void Botan::Cipher_Mode::reset ( )
pure virtual

◆ set_key() [1/3]

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

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)
inline

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 
)
inline

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)
inline

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 
)
inline

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

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

◆ start_msg()

virtual void Botan::Cipher_Mode::start_msg ( const uint8_t  nonce[],
size_t  nonce_len 
)
pure virtual

◆ tag_size()

virtual size_t Botan::Cipher_Mode::tag_size ( ) const
inlinevirtual
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; }

◆ update()

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

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

virtual size_t Botan::Cipher_Mode::update_granularity ( ) const
pure virtual

◆ valid_keylength()

bool Botan::Cipher_Mode::valid_keylength ( size_t  length) const
inline

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

virtual bool Botan::Cipher_Mode::valid_nonce_length ( size_t  nonce_len) const
pure virtual

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