Botan  1.10.9
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Botan::CBC_Encryption Class Reference

#include <cbc.h>

Inheritance diagram for Botan::CBC_Encryption:
Botan::Keyed_Filter Botan::Buffered_Filter Botan::Filter

Public Member Functions

virtual bool attachable ()
 
 CBC_Encryption (BlockCipher *cipher, BlockCipherModePaddingMethod *padding)
 
 CBC_Encryption (BlockCipher *cipher, BlockCipherModePaddingMethod *padding, const SymmetricKey &key, const InitializationVector &iv)
 
std::string name () const
 
void set_iv (const InitializationVector &iv)
 
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
 
 ~CBC_Encryption ()
 

Protected Member Functions

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

Private Member Functions

void buffer_reset ()
 
size_t buffered_block_size () const
 
size_t current_position () const
 

Detailed Description

CBC Encryption

Definition at line 21 of file cbc.h.

Constructor & Destructor Documentation

Botan::CBC_Encryption::CBC_Encryption ( BlockCipher cipher,
BlockCipherModePaddingMethod padding 
)

Definition at line 17 of file cbc.cpp.

References Botan::BlockCipher::block_size(), name(), Botan::BlockCipherModePaddingMethod::name(), Botan::MemoryRegion< T >::resize(), and Botan::BlockCipherModePaddingMethod::valid_blocksize().

18  :
19  Buffered_Filter(ciph->block_size(), 0),
20  cipher(ciph), padder(pad)
21  {
22  if(!padder->valid_blocksize(cipher->block_size()))
23  throw Invalid_Block_Size(name(), padder->name());
24 
25  state.resize(cipher->block_size());
26  }
void resize(size_t n)
Definition: secmem.h:211
virtual bool valid_blocksize(size_t block_size) const =0
std::string name() const
Definition: cbc.cpp:107
Buffered_Filter(size_t block_size, size_t final_minimum)
Definition: buf_filt.cpp:18
virtual std::string name() const =0
virtual size_t block_size() const =0
Botan::CBC_Encryption::CBC_Encryption ( BlockCipher cipher,
BlockCipherModePaddingMethod padding,
const SymmetricKey key,
const InitializationVector iv 
)

Definition at line 31 of file cbc.cpp.

References Botan::BlockCipher::block_size(), name(), Botan::BlockCipherModePaddingMethod::name(), Botan::MemoryRegion< T >::resize(), set_iv(), set_key(), and Botan::BlockCipherModePaddingMethod::valid_blocksize().

34  :
35  Buffered_Filter(ciph->block_size(), 0),
36  cipher(ciph), padder(pad)
37  {
38  if(!padder->valid_blocksize(cipher->block_size()))
39  throw Invalid_Block_Size(name(), padder->name());
40 
41  state.resize(cipher->block_size());
42 
43  set_key(key);
44  set_iv(iv);
45  }
void resize(size_t n)
Definition: secmem.h:211
virtual bool valid_blocksize(size_t block_size) const =0
std::string name() const
Definition: cbc.cpp:107
void set_key(const SymmetricKey &key)
Definition: cbc.h:29
Buffered_Filter(size_t block_size, size_t final_minimum)
Definition: buf_filt.cpp:18
virtual std::string name() const =0
virtual size_t block_size() const =0
void set_iv(const InitializationVector &iv)
Definition: cbc.cpp:50
Botan::CBC_Encryption::~CBC_Encryption ( )
inline

Definition at line 45 of file cbc.h.

45 { delete cipher; delete padder; }

Member Function Documentation

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 50 of file filter.h.

50 { return true; }
std::string Botan::CBC_Encryption::name ( ) const
virtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 107 of file cbc.cpp.

References Botan::Algorithm::name(), and Botan::BlockCipherModePaddingMethod::name().

Referenced by CBC_Encryption(), and set_iv().

108  {
109  return (cipher->name() + "/CBC/" + padder->name());
110  }
virtual std::string name() const =0
virtual std::string name() const =0
void Botan::Filter::send ( const byte  in[],
size_t  length 
)
protectedinherited
Parameters
insome input for the filter
lengththe length of in

Definition at line 28 of file filter.cpp.

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

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

29  {
30  bool nothing_attached = true;
31  for(size_t j = 0; j != total_ports(); ++j)
32  if(next[j])
33  {
34  if(write_queue.size())
35  next[j]->write(&write_queue[0], write_queue.size());
36  next[j]->write(input, length);
37  nothing_attached = false;
38  }
39 
40  if(nothing_attached)
41  write_queue += std::make_pair(input, length);
42  else
43  write_queue.clear();
44  }
virtual void write(const byte input[], size_t length)=0
size_t size() const
Definition: secmem.h:29
void Botan::Filter::send ( byte  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 63 of file filter.h.

References Botan::Filter::send().

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

63 { send(&in, 1); }
void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const MemoryRegion< byte > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 68 of file filter.h.

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

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

68 { send(&in[0], in.size()); }
void send(const byte in[], size_t length)
Definition: filter.cpp:28
size_t size() const
Definition: secmem.h:29
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  }
void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::CBC_Encryption::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 50 of file cbc.cpp.

References Botan::OctetString::bits_of(), Botan::Buffered_Filter::buffer_reset(), Botan::OctetString::length(), name(), and valid_iv_length().

Referenced by CBC_Encryption().

51  {
52  if(!valid_iv_length(iv.length()))
53  throw Invalid_IV_Length(name(), iv.length());
54 
55  state = iv.bits_of();
56  buffer_reset();
57  }
bool valid_iv_length(size_t iv_len) const
Definition: cbc.h:34
std::string name() const
Definition: cbc.cpp:107
void Botan::CBC_Encryption::set_key ( const SymmetricKey key)
inlinevirtual

Set the key of this filter

Parameters
keythe key to use

Implements Botan::Keyed_Filter.

Definition at line 29 of file cbc.h.

Referenced by CBC_Encryption().

29 { cipher->set_key(key); }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:60
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::Zlib_Decompression, Botan::EAX_Base, Botan::Bzip_Decompression, Botan::PBE_PKCS5v20, Botan::PBE_PKCS5v15, Botan::Bzip_Compression, and Botan::Zlib_Compression.

Definition at line 38 of file filter.h.

38 {}
bool Botan::CBC_Encryption::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 34 of file cbc.h.

Referenced by set_iv().

35  { return (iv_len == cipher->block_size()); }
virtual size_t block_size() const =0
bool Botan::CBC_Encryption::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 31 of file cbc.h.

32  { return cipher->valid_keylength(key_len); }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:51

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