Botan
1.11.15
|
#include <filters.h>
Public Member Functions | |
virtual bool | attachable () |
void | end_msg () |
Key_Length_Specification | key_spec () const override |
MAC_Filter (MessageAuthenticationCode *mac, size_t out_len=0) | |
MAC_Filter (MessageAuthenticationCode *mac, const SymmetricKey &key, size_t out_len=0) | |
MAC_Filter (const std::string &mac, size_t len=0) | |
MAC_Filter (const std::string &mac, const SymmetricKey &key, size_t 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) |
Protected Member Functions | |
virtual void | send (const byte in[], size_t length) |
void | send (byte in) |
void | send (const secure_vector< byte > &in) |
void | send (const std::vector< byte > &in) |
void | send (const secure_vector< byte > &in, size_t length) |
void | send (const std::vector< byte > &in, size_t length) |
Botan::MAC_Filter::MAC_Filter | ( | MessageAuthenticationCode * | mac, |
size_t | out_len = 0 |
||
) | [inline] |
Construct a MAC filter. The MAC key will be left empty.
mac | 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 157 of file filters.h.
: OUTPUT_LENGTH(out_len), m_mac(mac) { }
Botan::MAC_Filter::MAC_Filter | ( | MessageAuthenticationCode * | mac, |
const SymmetricKey & | key, | ||
size_t | out_len = 0 |
||
) | [inline] |
Construct a MAC filter.
mac | 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 173 of file filters.h.
: OUTPUT_LENGTH(out_len), m_mac(mac) { m_mac->set_key(key); }
Botan::MAC_Filter::MAC_Filter | ( | const std::string & | mac, |
size_t | len = 0 |
||
) |
Construct a MAC filter. The MAC key will be left empty.
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 101 of file algo_filt.cpp.
: OUTPUT_LENGTH(len) { m_mac.reset(Algo_Registry<MessageAuthenticationCode>::global_registry().make(mac_name)); }
Botan::MAC_Filter::MAC_Filter | ( | const std::string & | mac, |
const SymmetricKey & | key, | ||
size_t | len = 0 |
||
) |
Construct a MAC filter.
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 110 of file algo_filt.cpp.
: OUTPUT_LENGTH(len) { m_mac.reset(Algo_Registry<MessageAuthenticationCode>::global_registry().make(mac_name)); m_mac->set_key(key); }
virtual bool Botan::Filter::attachable | ( | ) | [inline, virtual, inherited] |
Check whether this filter is an attachable filter.
Reimplemented in Botan::SecureQueue, and Botan::DataSink.
Definition at line 52 of file filter.h.
{ return true; }
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 120 of file algo_filt.cpp.
References Botan::Filter::send().
Key_Length_Specification Botan::MAC_Filter::key_spec | ( | ) | const [inline, override, virtual] |
Implements Botan::Keyed_Filter.
Definition at line 147 of file filters.h.
{ return m_mac->key_spec(); }
std::string Botan::MAC_Filter::name | ( | ) | const [inline, virtual] |
Implements Botan::Filter.
Definition at line 139 of file filters.h.
{ return m_mac->name(); }
void Botan::Filter::send | ( | const byte | in[], |
size_t | length | ||
) | [protected, virtual, inherited] |
in | some input for the filter |
length | the length of in |
Reimplemented in Botan::Threaded_Fork.
Definition at line 28 of file filter.cpp.
References Botan::Filter::write().
Referenced by Botan::Compression_Decompression_Filter::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hash_Filter::end_msg(), end_msg(), Botan::Compression_Decompression_Filter::flush(), Botan::Compression_Decompression_Filter::start_msg(), Botan::Compression_Decompression_Filter::write(), Botan::StreamCipher_Filter::write(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().
{ if(!length) return; 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(); }
void Botan::Filter::send | ( | byte | in | ) | [inline, protected, inherited] |
in | some input for the filter |
Definition at line 65 of file filter.h.
References Botan::Filter::send().
Referenced by Botan::Filter::send().
{ send(&in, 1); }
void Botan::Filter::send | ( | const secure_vector< byte > & | in | ) | [inline, protected, inherited] |
in | some input for the filter |
Definition at line 70 of file filter.h.
References Botan::Filter::send().
Referenced by Botan::Filter::send().
{ send(&in[0], in.size()); }
void Botan::Filter::send | ( | const std::vector< byte > & | in | ) | [inline, protected, inherited] |
in | some input for the filter |
Definition at line 75 of file filter.h.
References Botan::Filter::send().
Referenced by Botan::Filter::send().
{ send(&in[0], in.size()); }
void Botan::Filter::send | ( | const secure_vector< byte > & | in, |
size_t | length | ||
) | [inline, protected, inherited] |
void Botan::Filter::send | ( | const std::vector< byte > & | in, |
size_t | length | ||
) | [inline, protected, inherited] |
void Botan::Keyed_Filter::set_iv | ( | const InitializationVector & | iv | ) | [virtual, inherited] |
Set the initialization vector of this filter. Note: you should call set_iv() only after you have called set_key()
iv | the initialization vector to use |
Reimplemented in Botan::StreamCipher_Filter, and Botan::Transform_Filter.
Definition at line 13 of file basefilt.cpp.
References Botan::OctetString::length(), and Botan::Filter::name().
Referenced by Botan::get_cipher().
{ if(iv.length() != 0) throw Invalid_IV_Length(name(), iv.length()); }
void Botan::MAC_Filter::set_key | ( | const SymmetricKey & | key | ) | [inline, virtual] |
Set the key of this filter.
key | the key to set |
Implements Botan::Keyed_Filter.
Definition at line 145 of file filters.h.
{ m_mac->set_key(key); }
virtual void Botan::Filter::start_msg | ( | ) | [inline, virtual, inherited] |
Start a new message. Must be closed by end_msg() before another message can be started.
Reimplemented in Botan::Compression_Decompression_Filter.
Definition at line 40 of file filter.h.
{}
virtual bool Botan::Keyed_Filter::valid_iv_length | ( | size_t | length | ) | const [inline, virtual, inherited] |
Check whether an IV length is valid for this filter
length | the IV length to be checked for validity |
Reimplemented in Botan::StreamCipher_Filter, and Botan::Transform_Filter.
Definition at line 57 of file key_filt.h.
{ return (length == 0); }
bool Botan::Keyed_Filter::valid_keylength | ( | size_t | length | ) | const [inline, inherited] |
Check whether a key length is valid for this filter
length | the key length to be checked for validity |
Definition at line 42 of file key_filt.h.
{ return key_spec().valid_keylength(length); }
void Botan::MAC_Filter::write | ( | const byte | input[], |
size_t | length | ||
) | [inline, virtual] |
Write a portion of a message to this filter.
input | the input as a byte array |
length | the length of the byte array input |
Implements Botan::Filter.
Definition at line 136 of file filters.h.
{ m_mac->update(input, len); }