Botan 1.10.17
Botan::CTS_Decryption Class Reference

#include <cts.h>

Inheritance diagram for Botan::CTS_Decryption:
Botan::Keyed_Filter Botan::Filter

Public Member Functions

virtual bool attachable ()
 CTS_Decryption (BlockCipher *cipher)
 CTS_Decryption (BlockCipher *cipher, const SymmetricKey &key, const InitializationVector &iv)
std::string name () const
void set_iv (const InitializationVector &)
void set_key (const SymmetricKey &key)
virtual void start_msg ()
bool valid_iv_length (size_t iv_len) const
bool valid_keylength (size_t key_len) const
 ~CTS_Decryption ()

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

CBC decryption with ciphertext stealing

Definition at line 54 of file cts.h.

Constructor & Destructor Documentation

◆ CTS_Decryption() [1/2]

Botan::CTS_Decryption::CTS_Decryption ( BlockCipher * cipher)

Definition at line 117 of file cts.cpp.

117 :
118 cipher(ciph)
119 {
120 buffer.resize(2 * cipher->block_size());
121 state.resize(cipher->block_size());
122 temp.resize(cipher->block_size());
123 position = 0;
124 }

Referenced by Botan::get_cipher_mode().

◆ CTS_Decryption() [2/2]

Botan::CTS_Decryption::CTS_Decryption ( BlockCipher * cipher,
const SymmetricKey & key,
const InitializationVector & iv )

Definition at line 129 of file cts.cpp.

131 :
132 cipher(ciph)
133 {
134 buffer.resize(2 * cipher->block_size());
135 state.resize(cipher->block_size());
136 temp.resize(cipher->block_size());
137 position = 0;
138
139 set_key(key);
140 set_iv(iv);
141 }
void set_key(const SymmetricKey &key)
Definition cts.h:61
void set_iv(const InitializationVector &)
Definition cts.cpp:146

References set_iv(), and set_key().

◆ ~CTS_Decryption()

Botan::CTS_Decryption::~CTS_Decryption ( )
inline

Definition at line 75 of file cts.h.

75{ delete cipher; }

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.

50{ return true; }

◆ name()

std::string Botan::CTS_Decryption::name ( ) const
inlinevirtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 57 of file cts.h.

57{ return cipher->name() + "/CTS"; }

Referenced by set_iv().

◆ send() [1/4]

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

Definition at line 63 of file filter.h.

63{ send(&in, 1); }
void send(const byte in[], size_t length)
Definition filter.cpp:28

References send().

Referenced by send().

◆ send() [2/4]

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

◆ send() [3/4]

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

Definition at line 68 of file filter.h.

68{ 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
insome input for the filter
lengththe number of bytes of in to send

Definition at line 74 of file filter.h.

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

References send().

◆ set_iv()

void Botan::CTS_Decryption::set_iv ( const InitializationVector & iv)
virtual

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 146 of file cts.cpp.

147 {
148 if(!valid_iv_length(iv.length()))
149 throw Invalid_IV_Length(name(), iv.length());
150
151 state = iv.bits_of();
152 zeroise(buffer);
153 position = 0;
154 }
std::string name() const
Definition cts.h:57
bool valid_iv_length(size_t iv_len) const
Definition cts.h:66
void zeroise(MemoryRegion< T > &vec)
Definition secmem.h:428
Invalid_IV_Length(const std::string &mode, size_t bad_len)
Definition exceptn.h:80

References Botan::OctetString::bits_of(), Botan::Invalid_IV_Length::Invalid_IV_Length(), Botan::OctetString::length(), name(), valid_iv_length(), and Botan::zeroise().

Referenced by CTS_Decryption().

◆ set_key()

void Botan::CTS_Decryption::set_key ( const SymmetricKey & key)
inlinevirtual

Set the key of this filter

Parameters
keythe key to use

Implements Botan::Keyed_Filter.

Definition at line 61 of file cts.h.

61{ cipher->set_key(key); }

Referenced by CTS_Decryption().

◆ 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.

38{}

◆ valid_iv_length()

bool Botan::CTS_Decryption::valid_iv_length ( size_t length) const
inlinevirtual

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 66 of file cts.h.

67 { return (iv_len == cipher->block_size()); }

Referenced by set_iv().

◆ valid_keylength()

bool Botan::CTS_Decryption::valid_keylength ( size_t length) const
inlinevirtual

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

Implements Botan::Keyed_Filter.

Definition at line 63 of file cts.h.

64 { return cipher->valid_keylength(key_len); }

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