Botan::MAC_Filter Class Reference

#include <filters.h>

Inheritance diagram for Botan::MAC_Filter:

Public Member Functions
virtual bool	attachable ()
void	end_msg ()
	MAC_Filter (const std::string &mac, const SymmetricKey &key, size_t len=0)
	MAC_Filter (const std::string &mac, size_t len=0)
	MAC_Filter (MessageAuthenticationCode *mac_obj, const SymmetricKey &key, size_t out_len=0)
	MAC_Filter (MessageAuthenticationCode *mac_obj, size_t out_len=0)
std::string	name () const
virtual void	set_iv (const InitializationVector &iv)
void	set_key (const SymmetricKey &key)
virtual void	start_msg ()
virtual bool	valid_iv_length (size_t length) const
bool	valid_keylength (size_t length) const
void	write (const byte input[], size_t len)
	~MAC_Filter ()

Protected Member Functions
void	send (byte in)
void	send (const byte in[], size_t length)
void	send (const MemoryRegion< byte > &in)
void	send (const MemoryRegion< byte > &in, size_t length)

Detailed Description

MessageAuthenticationCode Filter.

Definition at line 142 of file filters.h.

Constructor & Destructor Documentation

MAC_Filter() [1/4]

Botan::MAC_Filter::MAC_Filter ( MessageAuthenticationCode * mac_obj, size_t out_len = 0 )

inline

Construct a MAC filter. The MAC key will be left empty.

Parameters

mac_obj	the MAC to use
out_len	the output length of this filter. Leave the default value 0 if you want to use the full output of the MAC. Otherwise, specify a smaller value here so that the output of the MAC will be cut off.

Definition at line 172 of file filters.h.

                                   : OUTPUT_LENGTH(out_len)
         {
         mac = mac_obj;
         }

Referenced by Botan::algorithm_kat(), Botan::CryptoBox::decrypt(), and Botan::CryptoBox::encrypt().

MAC_Filter() [2/4]

Botan::MAC_Filter::MAC_Filter ( MessageAuthenticationCode * mac_obj, const SymmetricKey & key, size_t out_len = 0 )

inline

Construct a MAC filter.

Parameters

mac_obj	the MAC to use
key	the MAC key to use
out_len	the output length of this filter. Leave the default value 0 if you want to use the full output of the MAC. Otherwise, specify a smaller value here so that the output of the MAC will be cut off.

Definition at line 187 of file filters.h.

                                   : OUTPUT_LENGTH(out_len)
         {
         mac = mac_obj;
         mac->set_key(key);
         }

References Botan::SymmetricAlgorithm::set_key().

MAC_Filter() [3/4]

Botan::MAC_Filter::MAC_Filter	(	const std::string &	mac,
		size_t	len = 0 )

Construct a MAC filter. The MAC key will be left empty.

Parameters

mac	the name of the MAC to use
len	the output length of this filter. Leave the default value 0 if you want to use the full output of the MAC. Otherwise, specify a smaller value here so that the output of the MAC will be cut off.

Definition at line 105 of file algo_filt.cpp.

                                                            :
   OUTPUT_LENGTH(len)
   {
   Algorithm_Factory& af = global_state().algorithm_factory();
   mac = af.make_mac(mac_name);
   }

References Botan::Library_State::algorithm_factory(), Botan::global_state(), and Botan::Algorithm_Factory::make_mac().

MAC_Filter() [4/4]

Botan::MAC_Filter::MAC_Filter	(	const std::string &	mac,
		const SymmetricKey &	key,
		size_t	len = 0 )

Construct a MAC filter.

Parameters

mac	the name of the MAC to use
key	the MAC key to use
len	the output length of this filter. Leave the default value 0 if you want to use the full output of the MAC. Otherwise, specify a smaller value here so that the output of the MAC will be cut off.

Definition at line 115 of file algo_filt.cpp.

                                   : OUTPUT_LENGTH(len)
   {
   Algorithm_Factory& af = global_state().algorithm_factory();
   mac = af.make_mac(mac_name);
   mac->set_key(key);
   }

References Botan::Library_State::algorithm_factory(), Botan::global_state(), Botan::Algorithm_Factory::make_mac(), and Botan::SymmetricAlgorithm::set_key().

~MAC_Filter()

Botan::MAC_Filter::~MAC_Filter ( )

inline

Definition at line 217 of file filters.h.

{ delete mac; }

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::DataSink, and Botan::SecureQueue.

Definition at line 50 of file filter.h.

{ return true; }

end_msg()

void Botan::MAC_Filter::end_msg ( )

virtual

Notify that the current message is finished; flush buffers and do end-of-message processing (if any).

Reimplemented from Botan::Filter.

Definition at line 126 of file algo_filt.cpp.

   {
   SecureVector<byte> output = mac->final();
   if(OUTPUT_LENGTH)
      send(output, std::min<size_t>(OUTPUT_LENGTH, output.size()));
   else
      send(output);
   }

References Botan::Filter::send(), and Botan::MemoryRegion< T >::size().

name()

std::string Botan::MAC_Filter::name ( ) const

inlinevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 148 of file filters.h.

{ return mac->name(); }

send() [1/4]

void Botan::Filter::send ( byte in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 63 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

send() [2/4]

void Botan::Filter::send ( const byte in[], size_t length )

protectedinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 28 of file filter.cpp.

   {
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(next[j])
         {
         if(write_queue.size())
            next[j]->write(&write_queue[0], write_queue.size());
         next[j]->write(input, length);
         nothing_attached = false;
         }
 
   if(nothing_attached)
      write_queue += std::make_pair(input, length);
   else
      write_queue.clear();
   }

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Bzip_Decompression::end_msg(), Botan::Hash_Filter::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::MAC_Filter::end_msg(), Botan::PK_Decryptor_Filter::end_msg(), Botan::PK_Encryptor_Filter::end_msg(), Botan::PK_Signer_Filter::end_msg(), Botan::PK_Verifier_Filter::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::Zlib_Decompression::end_msg(), Botan::Bzip_Compression::flush(), Botan::Zlib_Compression::flush(), send(), Botan::Base64_Decoder::write(), Botan::Bzip_Compression::write(), Botan::Bzip_Decompression::write(), Botan::Chain::write(), Botan::Fork::write(), Botan::Hex_Decoder::write(), Botan::StreamCipher_Filter::write(), Botan::Zlib_Compression::write(), and Botan::Zlib_Decompression::write().

send() [3/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 68 of file filter.h.

{ send(&in[0], in.size()); }

References send(), and Botan::MemoryRegion< T >::size().

Referenced by send().

send() [4/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in, size_t length )

inlineprotectedinherited

Parameters

in	some input for the filter
length	the number of bytes of in to send

Definition at line 74 of file filter.h.

         {
         send(&in[0], length);
         }

References send().

set_iv()

void Botan::Keyed_Filter::set_iv ( const InitializationVector & iv )

virtualinherited

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

Parameters

iv	the initialization vector to use

Reimplemented in Botan::CBC_Decryption, Botan::CBC_Encryption, Botan::CFB_Decryption, Botan::CFB_Encryption, Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::EAX_Base, Botan::StreamCipher_Filter, Botan::XTS_Decryption, and Botan::XTS_Encryption.

Definition at line 13 of file basefilt.cpp.

   {
   if(iv.length() != 0)
      throw Invalid_IV_Length(name(), iv.length());
   }

References Botan::Invalid_IV_Length::Invalid_IV_Length(), Botan::OctetString::length(), and Botan::Filter::name().

Referenced by Botan::algorithm_kat(), Botan::get_cipher(), and set_key().

set_key()

void Botan::MAC_Filter::set_key ( const SymmetricKey & key )

inlinevirtual

Set the key of this filter.

Parameters

key	the key to set

Implements Botan::Keyed_Filter.

Definition at line 154 of file filters.h.

{ mac->set_key(key); }

start_msg()

virtual void Botan::Filter::start_msg ( )

inlinevirtualinherited

Start a new message. Must be closed by end_msg() before another message can be started.

Reimplemented in Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::EAX_Base, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Definition at line 38 of file filter.h.

{}

valid_iv_length()

virtual bool Botan::Keyed_Filter::valid_iv_length ( size_t length ) const

inlinevirtualinherited

Check whether an IV length is valid for this filter

Parameters

length

the IV length to be checked for validity

Returns

true if the IV length is valid, false otherwise

Reimplemented in Botan::CBC_Decryption, Botan::CBC_Encryption, Botan::CFB_Decryption, Botan::CFB_Encryption, Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::EAX_Base, Botan::StreamCipher_Filter, Botan::XTS_Decryption, and Botan::XTS_Encryption.

Definition at line 48 of file key_filt.h.

         { return (length == 0); }

Referenced by Botan::algorithm_kat().

valid_keylength()

bool Botan::MAC_Filter::valid_keylength ( size_t length ) const

inlinevirtual

Check whether a key length is valid for this filter.

Parameters

length

the key length to be checked for validity

Returns

true if the key length is valid, false otherwise

Implements Botan::Keyed_Filter.

Definition at line 161 of file filters.h.

         { return mac->valid_keylength(length); }

write()

void Botan::MAC_Filter::write ( const byte input[], size_t length )

inlinevirtual

Write a portion of a message to this filter.

Parameters

input	the input as a byte array
length	the length of the byte array input

Implements Botan::Filter.

Definition at line 145 of file filters.h.

{ mac->update(input, len); }

---

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

• src/filters/filters.h
• src/filters/algo_filt.cpp