Botan: Botan::CTS_Encryption Class Reference

Botan 1.10.16

Public Member Functions | Protected Member Functions | List of all members
Botan::CTS_Encryption Class Reference

`#include <cts.h>`

Inheritance diagram for Botan::CTS_Encryption:

## Public Member Functions
virtual bool | attachable ()
| CTS_Encryption (BlockCipher *cipher)
| CTS_Encryption (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_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)

## Detailed Description

CBC encryption with ciphertext stealing

Definition at line 19 of file cts.h.

## Constructor & Destructor Documentation

## ◆ CTS_Encryption() [1/2]

Botan::CTS_Encryption::CTS_Encryption | ( | BlockCipher * | cipher | ) |

Definition at line 17 of file cts.cpp.

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

17 :
18 cipher(ciph)
19 {
20 buffer.resize(2 * cipher->block_size());
21 state.resize(cipher->block_size());
22 position = 0;
23 }
Botan::MemoryRegion::resize
void resize(size_t n)
Definition: secmem.h:211
Botan::BlockCipher::block_size
virtual size_t block_size() const =0

## ◆ CTS_Encryption() [2/2]

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

Definition at line 28 of file cts.cpp.

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

30 :
31 cipher(ciph)
32 {
33 buffer.resize(2 * cipher->block_size());
34 state.resize(cipher->block_size());
35 position = 0;
36
37 set_key(key);
38 set_iv(iv);
39 }
Botan::MemoryRegion::resize
void resize(size_t n)
Definition: secmem.h:211
Botan::CTS_Encryption::set_iv
void set_iv(const InitializationVector &)
Definition: cts.cpp:44
Botan::BlockCipher::block_size
virtual size_t block_size() const =0
Botan::CTS_Encryption::set_key
void set_key(const SymmetricKey &key)
Definition: cts.h:26

## ◆ ~CTS_Encryption()

Botan::CTS_Encryption::~CTS_Encryption | ( |  | ) |
| inline

Definition at line 40 of file cts.h.

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

Definition at line 50 of file filter.h.

50 { return true; }

## ◆ name()

std::string Botan::CTS_Encryption::name | ( |  | ) | const
| inlinevirtual

Returns
  descriptive name for this filter

Implements Botan::Filter.

Definition at line 22 of file cts.h.

Referenced by set_iv().

22 { return cipher->name() + "/CTS"; }
Botan::Algorithm::name
virtual std::string name() const =0

## ◆ send() [1/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.

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

Referenced by Botan::Base64_Encoder::Base64_Encoder(), Botan::EAX_Decryption::EAX_Decryption(), Botan::PK_Encryptor_Filter::end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::PBE_PKCS5v15::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::PBE_PKCS5v20::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::Hex_Encoder::Hex_Encoder(), Botan::ECB_Encryption::name(), Botan::EAX_Base::name(), Botan::ECB_Decryption::name(), set_iv(), Botan::CFB_Encryption::set_iv(), Botan::CBC_Encryption::set_iv(), Botan::CFB_Decryption::set_iv(), Botan::CTS_Decryption::set_iv(), Botan::CBC_Decryption::set_iv(), Botan::XTS_Encryption::set_key(), Botan::XTS_Decryption::set_key(), 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 }
Botan::Filter::write
virtual void write(const byte input[], size_t length)=0
Botan::MemoryRegion::clear
void clear()
Definition: secmem.h:152
Botan::MemoryRegion::size
size_t size() const
Definition: secmem.h:29

## ◆ send() [2/4]

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

Parameters

  in | some 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); }
Botan::Filter::send
void send(const byte in[], size_t length)
Definition: filter.cpp:28

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

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

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

68 { send(&in[0], in.size()); }
Botan::Filter::send
void send(const byte in[], size_t length)
Definition: filter.cpp:28
Botan::MemoryRegion::size
size_t size() const
Definition: secmem.h:29

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

75 {
76 send(&in[0], length);
77 }
Botan::Filter::send
void send(const byte in[], size_t length)
Definition: filter.cpp:28

## ◆ set_iv()

void Botan::CTS_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

  iv | the initialization vector to use

Reimplemented from Botan::Keyed_Filter.

Definition at line 44 of file cts.cpp.

References Botan::OctetString::bits_of(), Botan::BlockCipher::block_size(), Botan::MemoryRegion< T >::copy(), Botan::copy_mem(), Botan::BlockCipher::encrypt(), Botan::OctetString::length(), name(), Botan::Filter::send(), Botan::MemoryRegion< T >::size(), valid_iv_length(), Botan::xor_buf(), and Botan::zeroise().

Referenced by CTS_Encryption().

45 {
46 if(!valid_iv_length(iv.length()))
47 throw Invalid_IV_Length(name(), iv.length());
48
49 state = iv.bits_of();
50 zeroise(buffer);
51 position = 0;
52 }
Botan::CTS_Encryption::name
std::string name() const
Definition: cts.h:22
Botan::CTS_Encryption::valid_iv_length
bool valid_iv_length(size_t iv_len) const
Definition: cts.h:31
Botan::zeroise
void zeroise(MemoryRegion< T > &vec)
Definition: secmem.h:415

## ◆ set_key()

void Botan::CTS_Encryption::set_key | ( | const SymmetricKey & | key | ) |
| inlinevirtual

Set the key of this filter

Parameters

  key | the key to use

Implements Botan::Keyed_Filter.

Definition at line 26 of file cts.h.

Referenced by CTS_Encryption().

26 { cipher->set_key(key); }
Botan::SymmetricAlgorithm::set_key
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:60

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

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

38 {}

## ◆ valid_iv_length()

bool Botan::CTS_Encryption::valid_iv_length | ( | size_t | length | ) | const
| inlinevirtual

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 from Botan::Keyed_Filter.

Definition at line 31 of file cts.h.

Referenced by set_iv().

32 { return (iv_len == cipher->block_size()); }
Botan::BlockCipher::block_size
virtual size_t block_size() const =0

## ◆ valid_keylength()

bool Botan::CTS_Encryption::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 28 of file cts.h.

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

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

- src/filters/modes/cts/cts.h
- src/filters/modes/cts/cts.cpp