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

#include <aead_filt.h>

Inheritance diagram for Botan::AEAD_Filter:
Botan::Cipher_Mode_Filter Botan::Keyed_Filter Botan::Buffered_Filter Botan::Filter

Public Member Functions

 AEAD_Filter (AEAD_Mode *aead)
 
virtual bool attachable ()
 
Key_Length_Specification key_spec () const override
 
std::string name () const override
 
void set_associated_data (const uint8_t ad[], size_t ad_len)
 
void set_iv (const InitializationVector &iv) override
 
void set_key (const SymmetricKey &key) override
 
bool valid_iv_length (size_t length) const override
 
bool valid_keylength (size_t length) const
 

Protected Member Functions

virtual void send (const uint8_t in[], size_t length)
 
void send (uint8_t in)
 
void send (const secure_vector< uint8_t > &in)
 
void send (const std::vector< uint8_t > &in)
 
void send (const secure_vector< uint8_t > &in, size_t length)
 
void send (const std::vector< uint8_t > &in, size_t length)
 

Detailed Description

Filter interface for AEAD Modes

Definition at line 19 of file aead_filt.h.

Constructor & Destructor Documentation

◆ AEAD_Filter()

Botan::AEAD_Filter::AEAD_Filter ( AEAD_Mode aead)
inline

Definition at line 22 of file aead_filt.h.

22 : Cipher_Mode_Filter(aead) {}
Cipher_Mode_Filter(Cipher_Mode *t)

Member Function Documentation

◆ attachable()

virtual bool Botan::Filter::attachable ( )
inlinevirtualinherited

Check whether this filter is an attachable filter.

Returns
true if this filter is attachable, false otherwise

Reimplemented in Botan::SecureQueue, and Botan::DataSink.

Definition at line 52 of file filter.h.

52 { return true; }

◆ key_spec()

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

Implements Botan::Keyed_Filter.

Definition at line 51 of file cipher_filter.cpp.

52  {
53  return m_mode->key_spec();
54  }

◆ name()

std::string Botan::Cipher_Mode_Filter::name ( ) const
overridevirtualinherited
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 36 of file cipher_filter.cpp.

37  {
38  return m_mode->name();
39  }

◆ send() [1/6]

void Botan::Filter::send ( const uint8_t  in[],
size_t  length 
)
protectedvirtualinherited
Parameters
insome input for the filter
lengththe length of in

Definition at line 27 of file filter.cpp.

References Botan::Filter::write().

Referenced by Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().

28  {
29  if(!length)
30  return;
31 
32  bool nothing_attached = true;
33  for(size_t j = 0; j != total_ports(); ++j)
34  if(m_next[j])
35  {
36  if(m_write_queue.size())
37  m_next[j]->write(m_write_queue.data(), m_write_queue.size());
38  m_next[j]->write(input, length);
39  nothing_attached = false;
40  }
41 
42  if(nothing_attached)
43  m_write_queue += std::make_pair(input, length);
44  else
45  m_write_queue.clear();
46  }
virtual void write(const uint8_t input[], size_t length)=0

◆ send() [2/6]

void Botan::Filter::send ( uint8_t  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 65 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

65 { send(&in, 1); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [3/6]

void Botan::Filter::send ( const secure_vector< uint8_t > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 70 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

70 { send(in.data(), in.size()); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [4/6]

void Botan::Filter::send ( const std::vector< uint8_t > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 75 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

75 { send(in.data(), in.size()); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [5/6]

void Botan::Filter::send ( const secure_vector< uint8_t > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 81 of file filter.h.

82  {
83  send(in.data(), length);
84  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [6/6]

void Botan::Filter::send ( const std::vector< uint8_t > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 90 of file filter.h.

91  {
92  send(in.data(), length);
93  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ set_associated_data()

void Botan::AEAD_Filter::set_associated_data ( const uint8_t  ad[],
size_t  ad_len 
)
inline

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before end_msg.

Parameters
adthe associated data
ad_lenlength of add in bytes

Definition at line 32 of file aead_filt.h.

33  {
34  dynamic_cast<AEAD_Mode&>(get_transform()).set_associated_data(ad, ad_len);
35  }
void set_associated_data(const uint8_t ad[], size_t ad_len)
Definition: aead_filt.h:32

◆ set_iv()

void Botan::Cipher_Mode_Filter::set_iv ( const InitializationVector iv)
overridevirtualinherited

Set the initialization vector of this filter. Note: you should call set_iv() only after you have called set_key()

Parameters
ivthe initialization vector to use

Reimplemented from Botan::Keyed_Filter.

Definition at line 41 of file cipher_filter.cpp.

References Botan::OctetString::bits_of(), and Botan::unlock().

42  {
43  m_nonce = unlock(iv.bits_of());
44  }
std::vector< T > unlock(const secure_vector< T > &in)
Definition: secmem.h:95

◆ set_key()

void Botan::Cipher_Mode_Filter::set_key ( const SymmetricKey key)
overridevirtualinherited

Set the key of this filter

Parameters
keythe key to use

Implements Botan::Keyed_Filter.

Definition at line 46 of file cipher_filter.cpp.

47  {
48  m_mode->set_key(key);
49  }

◆ valid_iv_length()

bool Botan::Cipher_Mode_Filter::valid_iv_length ( size_t  length) const
overridevirtualinherited

Check whether an IV length is valid for this filter

Parameters
lengththe IV length to be checked for validity
Returns
true if the IV length is valid, false otherwise

Reimplemented from Botan::Keyed_Filter.

Definition at line 56 of file cipher_filter.cpp.

57  {
58  return m_mode->valid_nonce_length(length);
59  }

◆ valid_keylength()

bool Botan::Keyed_Filter::valid_keylength ( size_t  length) const
inlineinherited

Check whether a key length is valid for this filter

Parameters
lengththe key length to be checked for validity
Returns
true if the key length is valid, false otherwise

Definition at line 42 of file key_filt.h.

43  {
44  return key_spec().valid_keylength(length);
45  }
virtual Key_Length_Specification key_spec() const =0
bool valid_keylength(size_t length) const
Definition: key_spec.h:51

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