Botan 2.19.5 Crypto and TLS for C&

Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption Class Referencefinal

`#include <tls_cbc.h>`

Inheritance diagram for Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption:

## Public Member Functions
virtual bool | associated_data_requires_key () const
bool | authenticated () const override
void | clear () override final
size_t | default_nonce_length () const override final
void | finish (secure_vector< uint8_t > &final_block, size_t offset=0) override
Key_Length_Specification | key_spec () const override final
virtual size_t | maximum_associated_data_inputs () const
size_t | maximum_keylength () const
size_t | minimum_final_size () const override
size_t | minimum_keylength () const
std::string | name () const override final
size_t | output_length (size_t input_length) const override
size_t | process (uint8_t buf[], size_t sz) override final
virtual std::string | provider () const
void | reset () override final
template<typename Alloc >
void | set_ad (const std::vector< uint8_t, Alloc > &ad)
void | set_associated_data (const uint8_t ad[], size_t ad_len) override
virtual void | set_associated_data_n (size_t i, const uint8_t ad[], size_t ad_len)
template<typename Alloc >
void | set_associated_data_vec (const std::vector< uint8_t, Alloc > &ad)
template<typename Alloc >
void | set_key (const std::vector< uint8_t, Alloc > &key)
void | set_key (const SymmetricKey &key)
void | set_key (const uint8_t key[], size_t length)
void | start ()
template<typename Alloc >
void | start (const std::vector< uint8_t, Alloc > &nonce)
void | start (const uint8_t nonce[], size_t nonce_len)
size_t | tag_size () const override final
| TLS_CBC_HMAC_AEAD_Decryption (std::unique_ptr< BlockCipher > cipher, std::unique_ptr< MessageAuthenticationCode > mac, const size_t cipher_keylen, const size_t mac_keylen, const Protocol_Version version, bool use_encrypt_then_mac)
void | update (secure_vector< uint8_t > &buffer, size_t offset=0)
size_t | update_granularity () const override final
bool | valid_keylength (size_t length) const
bool | valid_nonce_length (size_t nl) const override final

## Static Public Member Functions
static std::unique_ptr< AEAD_Mode > | create (const std::string &algo, Cipher_Dir direction, const std::string &provider="")
static std::unique_ptr< AEAD_Mode > | create_or_throw (const std::string &algo, Cipher_Dir direction, const std::string &provider="")
static std::vector< std::string > | providers (const std::string &algo_spec)

## Protected Member Functions
std::vector< uint8_t > & | assoc_data ()
std::vector< uint8_t > | assoc_data_with_len (uint16_t len)
size_t | block_size () const
Cipher_Mode & | cbc () const
secure_vector< uint8_t > & | cbc_state ()
size_t | cipher_keylen () const
bool | is_datagram_protocol () const
size_t | iv_size () const
MessageAuthenticationCode & | mac () const
size_t | mac_keylen () const
secure_vector< uint8_t > & | msg ()
bool | use_encrypt_then_mac () const
void | verify_key_set (bool cond) const

## Detailed Description

TLS_CBC_HMAC_AEAD Decryption

Definition at line 142 of file tls_cbc.h.

## Constructor & Destructor Documentation

## ◆ TLS_CBC_HMAC_AEAD_Decryption()

Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption::TLS_CBC_HMAC_AEAD_Decryption | ( | std::unique_ptr< BlockCipher > | cipher,
|  | std::unique_ptr< MessageAuthenticationCode > | mac,
|  | const size_t | cipher_keylen,
|  | const size_t | mac_keylen,
|  | const Protocol_Version | version,
|  | bool | use_encrypt_then_mac
| ) |  |
| inline

Definition at line 147 of file tls_cbc.h.

152 :
153 TLS_CBC_HMAC_AEAD_Mode(DECRYPTION,
154 std::move(cipher),
155 std::move(mac),
156 cipher_keylen,
157 mac_keylen,
158 version,
159 use_encrypt_then_mac)
160 {}
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::mac_keylen
size_t mac_keylen() const
Definition: tls_cbc.h:58
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::use_encrypt_then_mac
bool use_encrypt_then_mac() const
Definition: tls_cbc.h:62
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::TLS_CBC_HMAC_AEAD_Mode
TLS_CBC_HMAC_AEAD_Mode(Cipher_Dir direction, std::unique_ptr< BlockCipher > cipher, std::unique_ptr< MessageAuthenticationCode > mac, size_t cipher_keylen, size_t mac_keylen, Protocol_Version version, bool use_encrypt_then_mac)
Definition: tls_cbc.cpp:27
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::cipher_keylen
size_t cipher_keylen() const
Definition: tls_cbc.h:57
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::mac
MessageAuthenticationCode & mac() const
Definition: tls_cbc.h:68
Botan::DECRYPTION
@ DECRYPTION
Definition: cipher_mode.h:23

## Member Function Documentation

## ◆ assoc_data()

std::vector< uint8_t > & Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::assoc_data | ( |  | ) |
| inline protected inherited

Definition at line 75 of file tls_cbc.h.

75{ return m_ad; }

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::set_associated_data().

## ◆ assoc_data_with_len()

std::vector< uint8_t > Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::assoc_data_with_len | ( | uint16_t | len | ) |
| protected inherited

Definition at line 123 of file tls_cbc.cpp.

124 {
125 std::vector<uint8_t> ad = m_ad;
126 BOTAN_ASSERT(ad.size() == 13, "Expected AAD size");
127 ad[11] = get_byte(0, len);
128 ad[12] = get_byte(1, len);
129 return ad;
130 }
BOTAN_ASSERT
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
Botan::get_byte
constexpr uint8_t get_byte(size_t byte_num, T input)
Definition: loadstor.h:41

References BOTAN_ASSERT, and Botan::get_byte().

Referenced by finish().

## ◆ associated_data_requires_key()

virtual bool Botan::AEAD_Mode::associated_data_requires_key | ( |  | ) | const
| inline virtual inherited

Most AEADs require the key to be set prior to setting the AD A few allow the AD to be set even before the cipher is keyed. Such ciphers would return false from this function.

Reimplemented in Botan::CCM_Mode, and Botan::ChaCha20Poly1305_Mode.

Definition at line 94 of file aead.h.

94{ return true; }

## ◆ authenticated()

bool Botan::AEAD_Mode::authenticated | ( |  | ) | const
| inline override virtual inherited

Returns
  true iff this mode provides authentication as well as confidentiality.

Reimplemented from Botan::Cipher_Mode.

Definition at line 47 of file aead.h.

47{ return true; }

## ◆ block_size()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::block_size | ( |  | ) | const
| inline protected inherited

Definition at line 60 of file tls_cbc.h.

60{ return m_block_size; }

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), finish(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::output_length(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::set_associated_data(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::valid_nonce_length().

## ◆ cbc()

Cipher_Mode & Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::cbc | ( |  | ) | const
| inline protected inherited

Definition at line 66 of file tls_cbc.h.

66{ return *m_cbc; }

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::clear().

## ◆ cbc_state()

secure_vector< uint8_t > & Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::cbc_state | ( |  | ) |
| inline protected inherited

Definition at line 74 of file tls_cbc.h.

74{ return m_cbc_state; }

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), finish(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::reset().

## ◆ cipher_keylen()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::cipher_keylen | ( |  | ) | const
| inline protected inherited

Definition at line 57 of file tls_cbc.h.

57{ return m_cipher_keylen; }

## ◆ clear()

void Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::clear | ( |  | ) |
| final override virtual inherited

Reset the state.

Implements Botan::SymmetricAlgorithm.

Definition at line 55 of file tls_cbc.cpp.

56 {
57 cbc().clear();
58 mac().clear();
59 reset();
60 }
Botan::SymmetricAlgorithm::clear
virtual void clear()=0
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::reset
void reset() override final
Definition: tls_cbc.cpp:62
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::cbc
Cipher_Mode & cbc() const
Definition: tls_cbc.h:66

References Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::cbc(), Botan::SymmetricAlgorithm::clear(), Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::mac(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::reset().

## ◆ create()

std::unique_ptr< AEAD_Mode > Botan::AEAD_Mode::create | ( | const std::string & | algo,
|  | Cipher_Dir | direction,
|  | const std::string & | provider = `""`
| ) |  |
| static inherited

Create an AEAD mode

Parameters

  algo | the algorithm to create
  direction | specify if this should be an encryption or decryption AEAD
  provider | optional specification for provider to use

Returns
  an AEAD mode or a null pointer if not available

Definition at line 60 of file aead.cpp.

63 {
64 BOTAN_UNUSED(provider);
65#if defined(BOTAN_HAS_AEAD_CHACHA20_POLY1305)
66 if(algo == "ChaCha20Poly1305")
67 {
68 if(dir == ENCRYPTION)
69 return std::unique_ptr<AEAD_Mode>(new ChaCha20Poly1305_Encryption);
70 else
71 return std::unique_ptr<AEAD_Mode>(new ChaCha20Poly1305_Decryption);
72
73 }
74#endif
75
76 if(algo.find('/') != std::string::npos)
77 {
78 const std::vector<std::string> algo_parts = split_on(algo, '/');
79 const std::string cipher_name = algo_parts[0];
80 const std::vector<std::string> mode_info = parse_algorithm_name(algo_parts[1]);
81
82 if(mode_info.empty())
83 return std::unique_ptr<AEAD_Mode>();
84
85 std::ostringstream alg_args;
86
87 alg_args << '(' << cipher_name;
88 for(size_t i = 1; i < mode_info.size(); ++i)
89 alg_args << ',' << mode_info[i];
90 for(size_t i = 2; i < algo_parts.size(); ++i)
91 alg_args << ',' << algo_parts[i];
92 alg_args << ')';
93
94 const std::string mode_name = mode_info[0] + alg_args.str();
95 return AEAD_Mode::create(mode_name, dir);
96 }
97
98#if defined(BOTAN_HAS_BLOCK_CIPHER)
99
100 SCAN_Name req(algo);
101
102 if(req.arg_count() == 0)
103 {
104 return std::unique_ptr<AEAD_Mode>();
105 }
106
107 std::unique_ptr<BlockCipher> bc(BlockCipher::create(req.arg(0), provider));
108
109 if(!bc)
110 {
111 return std::unique_ptr<AEAD_Mode>();
112 }
113
114#if defined(BOTAN_HAS_AEAD_CCM)
115 if(req.algo_name() == "CCM")
116 {
117 size_t tag_len = req.arg_as_integer(1, 16);
118 size_t L_len = req.arg_as_integer(2, 3);
119 if(dir == ENCRYPTION)
120 return std::unique_ptr<AEAD_Mode>(new CCM_Encryption(bc.release(), tag_len, L_len));
121 else
122 return std::unique_ptr<AEAD_Mode>(new CCM_Decryption(bc.release(), tag_len, L_len));
123 }
124#endif
125
126#if defined(BOTAN_HAS_AEAD_GCM)
127 if(req.algo_name() == "GCM")
128 {
129 size_t tag_len = req.arg_as_integer(1, 16);
130 if(dir == ENCRYPTION)
131 return std::unique_ptr<AEAD_Mode>(new GCM_Encryption(bc.release(), tag_len));
132 else
133 return std::unique_ptr<AEAD_Mode>(new GCM_Decryption(bc.release(), tag_len));
134 }
135#endif
136
137#if defined(BOTAN_HAS_AEAD_OCB)
138 if(req.algo_name() == "OCB")
139 {
140 size_t tag_len = req.arg_as_integer(1, 16);
141 if(dir == ENCRYPTION)
142 return std::unique_ptr<AEAD_Mode>(new OCB_Encryption(bc.release(), tag_len));
143 else
144 return std::unique_ptr<AEAD_Mode>(new OCB_Decryption(bc.release(), tag_len));
145 }
146#endif
147
148#if defined(BOTAN_HAS_AEAD_EAX)
149 if(req.algo_name() == "EAX")
150 {
151 size_t tag_len = req.arg_as_integer(1, bc->block_size());
152 if(dir == ENCRYPTION)
153 return std::unique_ptr<AEAD_Mode>(new EAX_Encryption(bc.release(), tag_len));
154 else
155 return std::unique_ptr<AEAD_Mode>(new EAX_Decryption(bc.release(), tag_len));
156 }
157#endif
158
159#if defined(BOTAN_HAS_AEAD_SIV)
160 if(req.algo_name() == "SIV")
161 {
162 if(dir == ENCRYPTION)
163 return std::unique_ptr<AEAD_Mode>(new SIV_Encryption(bc.release()));
164 else
165 return std::unique_ptr<AEAD_Mode>(new SIV_Decryption(bc.release()));
166 }
167#endif
168
169#endif
170
171 return std::unique_ptr<AEAD_Mode>();
172 }
BOTAN_UNUSED
#define BOTAN_UNUSED(...)
Definition: assert.h:142
Botan::AEAD_Mode::create
static std::unique_ptr< AEAD_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition: aead.cpp:60
Botan::BlockCipher::create
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
Definition: block_cipher.cpp:104
Botan::Cipher_Mode::provider
virtual std::string provider() const
Definition: cipher_mode.h:180
Botan::split_on
std::vector< std::string > split_on(const std::string &str, char delim)
Definition: parsing.cpp:148
Botan::ENCRYPTION
@ ENCRYPTION
Definition: cipher_mode.h:23
Botan::parse_algorithm_name
std::vector< std::string > parse_algorithm_name(const std::string &namex)
Definition: parsing.cpp:95

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), BOTAN_UNUSED, Botan::AEAD_Mode::create(), Botan::BlockCipher::create(), Botan::ENCRYPTION, Botan::parse_algorithm_name(), Botan::Cipher_Mode::provider(), and Botan::split_on().

Referenced by Botan::AEAD_Mode::create(), Botan::Cipher_Mode::create(), Botan::AEAD_Mode::create_or_throw(), and Botan::get_aead().

## ◆ create_or_throw()

std::unique_ptr< AEAD_Mode > Botan::AEAD_Mode::create_or_throw | ( | const std::string & | algo,
|  | Cipher_Dir | direction,
|  | const std::string & | provider = `""`
| ) |  |
| static inherited

Create an AEAD mode, or throw

Parameters

  algo | the algorithm to create
  direction | specify if this should be an encryption or decryption AEAD
  provider | optional specification for provider to use

Returns
  an AEAD mode, or throw an exception

Definition at line 50 of file aead.cpp.

53 {
54 if(auto aead = AEAD_Mode::create(algo, dir, provider))
55 return aead;
56
57 throw Lookup_Error("AEAD", algo, provider);
58 }

References Botan::AEAD_Mode::create(), and Botan::Cipher_Mode::provider().

Referenced by Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::TLS::Session::decrypt(), Botan::TLS::Session::encrypt(), Botan::mceies_decrypt(), and Botan::mceies_encrypt().

## ◆ default_nonce_length()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::default_nonce_length | ( |  | ) | const
| inline final override virtual inherited

Returns
  default AEAD nonce size (a commonly supported value among AEAD modes, and large enough that random collisions are unlikely)

Reimplemented from Botan::AEAD_Mode.

Definition at line 42 of file tls_cbc.h.

42{ return m_iv_size; }

## ◆ finish()

void Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption::finish | ( | secure_vector< uint8_t > & | final_block,
|  | size_t | offset = `0`
| ) |  |
| override virtual

Complete processing of a message.

Parameters

  final_block | in/out parameter which must be at least minimum_final_size() bytes, and will be set to any final output
  offset | an offset into final_block to begin processing

Implements Botan::Cipher_Mode.

Definition at line 377 of file tls_cbc.cpp.

378 {
379 update(buffer, offset);
380 buffer.resize(offset);
381
382 const size_t record_len = msg().size();
383 uint8_t* record_contents = msg().data();
384
385 // This early exit does not leak info because all the values compared are public
386 if(record_len < tag_size() ||
387 (record_len - (use_encrypt_then_mac() ? tag_size() : 0)) % block_size() != 0)
388 {
389 throw TLS_Exception(Alert::BAD_RECORD_MAC, "Message authentication failure");
390 }
391
392 if(use_encrypt_then_mac())
393 {
394 const size_t enc_size = record_len - tag_size();
395 const size_t enc_iv_size = enc_size + iv_size();
396
397 BOTAN_ASSERT_NOMSG(enc_iv_size <= 0xFFFF);
398
399 mac().update(assoc_data_with_len(static_cast<uint16_t>(enc_iv_size)));
400 if(iv_size() > 0)
401 {
402 mac().update(cbc_state());
403 }
404 mac().update(record_contents, enc_size);
405
406 std::vector<uint8_t> mac_buf(tag_size());
407 mac().final(mac_buf.data());
408
409 const size_t mac_offset = enc_size;
410
411 const bool mac_ok = constant_time_compare(&record_contents[mac_offset], mac_buf.data(), tag_size());
412
413 if(!mac_ok)
414 {
415 throw TLS_Exception(Alert::BAD_RECORD_MAC, "Message authentication failure");
416 }
417
418 cbc_decrypt_record(record_contents, enc_size);
419
420 // 0 if padding was invalid, otherwise 1 + padding_bytes
421 const uint16_t pad_size = check_tls_cbc_padding(record_contents, enc_size);
422
423 // No oracle here, whoever sent us this had the key since MAC check passed
424 if(pad_size == 0)
425 {
426 throw TLS_Exception(Alert::BAD_RECORD_MAC, "Message authentication failure");
427 }
428
429 const uint8_t* plaintext_block = &record_contents[0];
430 const size_t plaintext_length = enc_size - pad_size;
431
432 buffer.insert(buffer.end(), plaintext_block, plaintext_block + plaintext_length);
433 }
434 else
435 {
436 cbc_decrypt_record(record_contents, record_len);
437
438 CT::poison(record_contents, record_len);
439
440 // 0 if padding was invalid, otherwise 1 + padding_bytes
441 uint16_t pad_size = check_tls_cbc_padding(record_contents, record_len);
442
443 /*
444 This mask is zero if there is not enough room in the packet to get a valid MAC.
445
446 We have to accept empty packets, since otherwise we are not compatible
447 with how OpenSSL's countermeasure for fixing BEAST in TLS 1.0 CBC works
448 (sending empty records, instead of 1/(n-1) splitting)
449 */
450
451 // We know the cast cannot overflow as pad_size <= 256 && tag_size <= 32
452 const auto size_ok_mask = CT::Mask<uint16_t>::is_lte(
453 static_cast<uint16_t>(tag_size() + pad_size),
454 static_cast<uint16_t>(record_len));
455
456 pad_size = size_ok_mask.if_set_return(pad_size);
457
458 CT::unpoison(record_contents, record_len);
459
460 /*
461 This is unpoisoned sooner than it should. The pad_size leaks to plaintext_length and
462 then to the timing channel in the MAC computation described in the Lucky 13 paper.
463 */
464 CT::unpoison(pad_size);
465
466 const uint8_t* plaintext_block = &record_contents[0];
467 const uint16_t plaintext_length = static_cast<uint16_t>(record_len - tag_size() - pad_size);
468
469 mac().update(assoc_data_with_len(plaintext_length));
470 mac().update(plaintext_block, plaintext_length);
471
472 std::vector<uint8_t> mac_buf(tag_size());
473 mac().final(mac_buf.data());
474
475 const size_t mac_offset = record_len - (tag_size() + pad_size);
476
477 const bool mac_ok = constant_time_compare(&record_contents[mac_offset], mac_buf.data(), tag_size());
478
479 const auto ok_mask = size_ok_mask & CT::Mask<uint16_t>::expand(mac_ok) & CT::Mask<uint16_t>::expand(pad_size);
480
481 CT::unpoison(ok_mask);
482
483 if(ok_mask.is_set())
484 {
485 buffer.insert(buffer.end(), plaintext_block, plaintext_block + plaintext_length);
486 }
487 else
488 {
489 perform_additional_compressions(record_len, pad_size);
490
491 /*
492 * In DTLS case we have to finish computing the MAC since we require the
493 * MAC state be reset for future packets. This extra timing channel may
494 * be exploitable in a Lucky13 variant.
495 */
496 if(is_datagram_protocol())
497 mac().final(mac_buf);
498 throw TLS_Exception(Alert::BAD_RECORD_MAC, "Message authentication failure");
499 }
500 }
501 }
BOTAN_ASSERT_NOMSG
#define BOTAN_ASSERT_NOMSG(expr)
Definition: assert.h:68
Botan::Buffered_Computation::update
void update(const uint8_t in[], size_t length)
Definition: buf_comp.h:33
Botan::Buffered_Computation::final
void final(uint8_t out[])
Definition: buf_comp.h:83
Botan::CT::Mask::expand
static Mask< T > expand(T v)
Definition: ct_utils.h:123
Botan::CT::Mask::is_lte
static Mask< T > is_lte(T x, T y)
Definition: ct_utils.h:173
Botan::Cipher_Mode::update
void update(secure_vector< uint8_t > &buffer, size_t offset=0)
Definition: cipher_mode.h:112
Botan::TLS::Alert::BAD_RECORD_MAC
@ BAD_RECORD_MAC
Definition: tls_alert.h:30
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::block_size
size_t block_size() const
Definition: tls_cbc.h:60
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::cbc_state
secure_vector< uint8_t > & cbc_state()
Definition: tls_cbc.h:74
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::assoc_data_with_len
std::vector< uint8_t > assoc_data_with_len(uint16_t len)
Definition: tls_cbc.cpp:123
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::is_datagram_protocol
bool is_datagram_protocol() const
Definition: tls_cbc.h:64
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::msg
secure_vector< uint8_t > & msg()
Definition: tls_cbc.h:76
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::tag_size
size_t tag_size() const override final
Definition: tls_cbc.h:40
Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::iv_size
size_t iv_size() const
Definition: tls_cbc.h:59
Botan::CT::poison
void poison(const T *p, size_t n)
Definition: ct_utils.h:48
Botan::CT::unpoison
void unpoison(const T *p, size_t n)
Definition: ct_utils.h:59
Botan::TLS::check_tls_cbc_padding
uint16_t check_tls_cbc_padding(const uint8_t record[], size_t record_len)
Definition: tls_cbc.cpp:249
Botan::constant_time_compare
bool constant_time_compare(const uint8_t x[], const uint8_t y[], size_t len)
Definition: mem_ops.h:82

References Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::assoc_data_with_len(), Botan::TLS::Alert::BAD_RECORD_MAC, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::block_size(), BOTAN_ASSERT_NOMSG, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::cbc_state(), Botan::TLS::check_tls_cbc_padding(), Botan::constant_time_compare(), Botan::CT::Mask< T >::expand(), Botan::Buffered_Computation::final(), Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::is_datagram_protocol(), Botan::CT::Mask< T >::is_lte(), Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::iv_size(), Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::mac(), Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::msg(), Botan::CT::poison(), Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::tag_size(), Botan::CT::unpoison(), Botan::Buffered_Computation::update(), Botan::Cipher_Mode::update(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::use_encrypt_then_mac().

## ◆ is_datagram_protocol()

bool Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::is_datagram_protocol | ( |  | ) | const
| inline protected inherited

Definition at line 64 of file tls_cbc.h.

64{ return m_is_datagram; }

Referenced by finish().

## ◆ iv_size()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::iv_size | ( |  | ) | const
| inline protected inherited

Definition at line 59 of file tls_cbc.h.

59{ return m_iv_size; }

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), finish(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::set_associated_data(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::valid_nonce_length().

## ◆ key_spec()

Key_Length_Specification Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::key_spec | ( |  | ) | const
| final override virtual inherited

Returns
  object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 86 of file tls_cbc.cpp.

87 {
88 return Key_Length_Specification(m_cipher_keylen + m_mac_keylen);
89 }

## ◆ mac()

MessageAuthenticationCode & Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::mac | ( |  | ) | const
| inline protected inherited

Definition at line 68 of file tls_cbc.h.

69 {
70 BOTAN_ASSERT_NONNULL(m_mac);
71 return *m_mac;
72 }
BOTAN_ASSERT_NONNULL
#define BOTAN_ASSERT_NONNULL(ptr)
Definition: assert.h:107

References BOTAN_ASSERT_NONNULL.

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::clear(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), finish(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::TLS_CBC_HMAC_AEAD_Mode().

## ◆ mac_keylen()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::mac_keylen | ( |  | ) | const
| inline protected inherited

Definition at line 58 of file tls_cbc.h.

58{ return m_mac_keylen; }

## ◆ maximum_associated_data_inputs()

virtual size_t Botan::AEAD_Mode::maximum_associated_data_inputs | ( |  | ) | const
| inline virtual inherited

Returns the maximum supported number of associated data inputs which can be provided to set_associated_data_n

If returns 0, then no associated data is supported.

Reimplemented in Botan::SIV_Mode.

Definition at line 87 of file aead.h.

87{ return 1; }

## ◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength | ( |  | ) | const
| inline inherited

Returns
  maximum allowed key length

Definition at line 120 of file sym_algo.h.

121 {
122 return key_spec().maximum_keylength();
123 }
Botan::Key_Length_Specification::maximum_keylength
size_t maximum_keylength() const
Definition: sym_algo.h:70
Botan::SymmetricAlgorithm::key_spec
virtual Key_Length_Specification key_spec() const =0

## ◆ minimum_final_size()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption::minimum_final_size | ( |  | ) | const
| inline override virtual

Returns
  required minimium size to finalize() - may be any length larger than this.

Implements Botan::Cipher_Mode.

Definition at line 164 of file tls_cbc.h.

164{ return tag_size(); }

## ◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength | ( |  | ) | const
| inline inherited

Returns
  minimum allowed key length

Definition at line 128 of file sym_algo.h.

129 {
130 return key_spec().minimum_keylength();
131 }
Botan::Key_Length_Specification::minimum_keylength
size_t minimum_keylength() const
Definition: sym_algo.h:62

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

## ◆ msg()

secure_vector< uint8_t > & Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::msg | ( |  | ) |
| inline protected inherited

Definition at line 76 of file tls_cbc.h.

76{ return m_msg; }

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), and finish().

## ◆ name()

std::string Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::name | ( |  | ) | const
| final override virtual inherited

Returns
  the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 69 of file tls_cbc.cpp.

70 {
71 return "TLS_CBC(" + m_cipher_name + "," + m_mac_name + ")";
72 }

## ◆ output_length()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption::output_length | ( | size_t | input_length | ) | const
| override virtual

Returns the size of the output if this transform is used to process a message with input_length bytes. In most cases the answer is precise. If it is not possible to precise (namely for CBC decryption) instead a lower bound is returned.

Implements Botan::Cipher_Mode.

Definition at line 290 of file tls_cbc.cpp.

291 {
292 /*
293 * We don't know this because the padding is arbitrary
294 */
295 return 0;
296 }

## ◆ process()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::process | ( | uint8_t | msg[],
|  | size_t | msg_len
| ) |  |
| final override virtual inherited

Process message blocks

Input must be a multiple of update_granularity

Processes msg in place and returns bytes written. Normally this will be either msg_len (indicating the entire message was processed) or for certain AEAD modes zero (indicating that the mode requires the entire message be processed in one pass).

Parameters

  msg | the message to be processed
  msg_len | length of the message in bytes

Implements Botan::Cipher_Mode.

Definition at line 117 of file tls_cbc.cpp.

118 {
119 m_msg.insert(m_msg.end(), buf, buf + sz);
120 return 0;
121 }

## ◆ provider()

virtual std::string Botan::Cipher_Mode::provider | ( |  | ) | const
| inline virtual inherited

Returns
  provider information about this implementation. Default is "base", might also return "sse2", "avx2", "openssl", or some other arbitrary string.

Reimplemented in Botan::GCM_Mode.

Definition at line 180 of file cipher_mode.h.

180{ return "base"; }

Referenced by Botan::AEAD_Mode::create(), Botan::Cipher_Mode::create(), Botan::AEAD_Mode::create_or_throw(), and Botan::Cipher_Mode::create_or_throw().

## ◆ providers()

std::vector< std::string > Botan::Cipher_Mode::providers | ( | const std::string & | algo_spec | ) |
| static inherited

Returns
  list of available providers for this algorithm, empty if not available

Parameters

  algo_spec | algorithm name

Definition at line 173 of file cipher_mode.cpp.

174 {
175 const std::vector<std::string>& possible = { "base", "openssl", "commoncrypto" };
176 std::vector<std::string> providers;
177 for(auto&& prov : possible)
178 {
179 std::unique_ptr<Cipher_Mode> mode = Cipher_Mode::create(algo_spec, ENCRYPTION, prov);
180 if(mode)
181 {
182 providers.push_back(prov); // available
183 }
184 }
185 return providers;
186 }
Botan::Cipher_Mode::providers
static std::vector< std::string > providers(const std::string &algo_spec)
Definition: cipher_mode.cpp:173
Botan::Cipher_Mode::create
static std::unique_ptr< Cipher_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition: cipher_mode.cpp:50

References Botan::Cipher_Mode::create(), Botan::ENCRYPTION, and Botan::Cipher_Mode::providers().

Referenced by Botan::Cipher_Mode::providers().

## ◆ reset()

void Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::reset | ( |  | ) |
| final override virtual inherited

Resets just the message specific state and allows encrypting again under the existing key

Implements Botan::Cipher_Mode.

Definition at line 62 of file tls_cbc.cpp.

63 {
64 cbc_state().clear();
65 m_ad.clear();
66 m_msg.clear();
67 }

References Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::cbc_state().

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::clear().

## ◆ set_ad()

template<typename Alloc >

void Botan::AEAD_Mode::set_ad | ( | const std::vector< uint8_t, Alloc > & | ad | ) |
| inline inherited

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.

See set_associated_data().

Parameters

  ad | the associated data

Definition at line 121 of file aead.h.

122 {
123 set_associated_data(ad.data(), ad.size());
124 }
Botan::AEAD_Mode::set_associated_data
virtual void set_associated_data(const uint8_t ad[], size_t ad_len)=0

Referenced by Botan::TLS::write_record().

## ◆ set_associated_data()

void Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::set_associated_data | ( | const uint8_t | ad[],
|  | size_t | ad_len
| ) |  |
| override virtual inherited

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.

Unless reset by another call, the associated data is kept between messages. Thus, if the AD does not change, calling once (after set_key) is the optimum.

Parameters

  ad | the associated data
  ad_len | length of add in bytes

Implements Botan::AEAD_Mode.

Reimplemented in Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption.

Definition at line 132 of file tls_cbc.cpp.

133 {
134 if(ad_len != 13)
135 throw Invalid_Argument("Invalid TLS AEAD associated data length");
136 m_ad.assign(ad, ad + ad_len);
137 }

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::set_associated_data().

## ◆ set_associated_data_n()

void Botan::AEAD_Mode::set_associated_data_n | ( | size_t | i,
|  | const uint8_t | ad[],
|  | size_t | ad_len
| ) |  |
| virtual inherited

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.

Unless reset by another call, the associated data is kept between messages. Thus, if the AD does not change, calling once (after set_key) is the optimum.

Some AEADs (namely SIV) support multiple AD inputs. For all other modes only nominal AD input 0 is supported; all other values of i will cause an exception.

Parameters

  ad | the associated data
  ad_len | length of add in bytes

Reimplemented in Botan::SIV_Mode.

Definition at line 42 of file aead.cpp.

43 {
44 if(i == 0)
45 this->set_associated_data(ad, ad_len);
46 else
47 throw Invalid_Argument("AEAD '" + name() + "' does not support multiple associated data");
48 }
Botan::SymmetricAlgorithm::name
virtual std::string name() const =0

References Botan::SymmetricAlgorithm::name(), and Botan::AEAD_Mode::set_associated_data().

Referenced by Botan::SIV_Mode::set_associated_data().

## ◆ set_associated_data_vec()

template<typename Alloc >

void Botan::AEAD_Mode::set_associated_data_vec | ( | const std::vector< uint8_t, Alloc > & | ad | ) |
| inline inherited

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.

See set_associated_data().

Parameters

  ad | the associated data

Definition at line 106 of file aead.h.

107 {
108 set_associated_data(ad.data(), ad.size());
109 }

## ◆ set_key() [1/3]

template<typename Alloc >

void Botan::SymmetricAlgorithm::set_key | ( | const std::vector< uint8_t, Alloc > & | key | ) |
| inline inherited

Definition at line 153 of file sym_algo.h.

154 {
155 set_key(key.data(), key.size());
156 }
Botan::SymmetricAlgorithm::set_key
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:147

## ◆ set_key() [2/3]

void Botan::SymmetricAlgorithm::set_key | ( | const SymmetricKey & | key | ) |
| inline inherited

Set the symmetric key of this object.

Parameters

  key | the SymmetricKey to be set.

Definition at line 147 of file sym_algo.h.

148 {
149 set_key(key.begin(), key.length());
150 }

References Botan::OctetString::begin(), and Botan::OctetString::length().

Referenced by Botan::aont_package(), Botan::aont_unpackage(), botan_block_cipher_set_key(), botan_cipher_set_key(), botan_mac_set_key(), Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), and Botan::Sodium::randombytes_buf_deterministic().

## ◆ set_key() [3/3]

void Botan::SymmetricAlgorithm::set_key | ( | const uint8_t | key[],
|  | size_t | length
| ) |  |
| inherited

Set the symmetric key of this object.

Parameters

  key | the to be set as a byte array.
  length | in bytes of key param

Definition at line 17 of file sym_algo.cpp.

18 {
19 if(!valid_keylength(length))
20 throw Invalid_Key_Length(name(), length);
21 key_schedule(key, length);
22 }
Botan::SymmetricAlgorithm::valid_keylength
bool valid_keylength(size_t length) const
Definition: sym_algo.h:138

References Botan::SymmetricAlgorithm::name(), and Botan::SymmetricAlgorithm::valid_keylength().

## ◆ start() [1/3]

void Botan::Cipher_Mode::start | ( |  | ) |
| inline inherited

Begin processing a message.

Definition at line 87 of file cipher_mode.h.

88 {
89 return start_msg(nullptr, 0);
90 }
Botan::Cipher_Mode::start_msg
virtual void start_msg(const uint8_t nonce[], size_t nonce_len)=0

## ◆ start() [2/3]

template<typename Alloc >

void Botan::Cipher_Mode::start | ( | const std::vector< uint8_t, Alloc > & | nonce | ) |
| inline inherited

Begin processing a message.

Parameters

  nonce | the per message nonce

Definition at line 69 of file cipher_mode.h.

70 {
71 start_msg(nonce.data(), nonce.size());
72 }

Referenced by botan_cipher_start(), and Botan::TLS::write_record().

## ◆ start() [3/3]

void Botan::Cipher_Mode::start | ( | const uint8_t | nonce[],
|  | size_t | nonce_len
| ) |  |
| inline inherited

Begin processing a message.

Parameters

  nonce | the per message nonce
  nonce_len | length of nonce

Definition at line 79 of file cipher_mode.h.

80 {
81 start_msg(nonce, nonce_len);
82 }

## ◆ tag_size()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::tag_size | ( |  | ) | const
| inline final override virtual inherited

Returns
  the size of the authentication tag used (in bytes)

Reimplemented from Botan::Cipher_Mode.

Definition at line 40 of file tls_cbc.h.

40{ return m_tag_size; }

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), finish(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::output_length().

## ◆ update()

void Botan::Cipher_Mode::update | ( | secure_vector< uint8_t > & | buffer,
|  | size_t | offset = `0`
| ) |  |
| inline inherited

Process some data. Input must be in size update_granularity() uint8_t blocks.

Parameters

  buffer | in/out parameter which will possibly be resized
  offset | an offset into blocks to begin processing

Definition at line 112 of file cipher_mode.h.

113 {
114 BOTAN_ASSERT(buffer.size() >= offset, "Offset ok");
115 uint8_t* buf = buffer.data() + offset;
116 const size_t buf_size = buffer.size() - offset;
117
118 const size_t written = process(buf, buf_size);
119 buffer.resize(offset + written);
120 }
Botan::Cipher_Mode::process
virtual size_t process(uint8_t msg[], size_t msg_len)=0

References BOTAN_ASSERT.

Referenced by botan_cipher_update(), Botan::ChaCha20Poly1305_Encryption::finish(), Botan::EAX_Encryption::finish(), Botan::CBC_Encryption::finish(), Botan::CTS_Encryption::finish(), Botan::CBC_Decryption::finish(), Botan::CTS_Decryption::finish(), Botan::CFB_Encryption::finish(), Botan::CFB_Decryption::finish(), Botan::XTS_Encryption::finish(), Botan::XTS_Decryption::finish(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), and finish().

## ◆ update_granularity()

size_t Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::update_granularity | ( |  | ) | const
| final override virtual inherited

Returns
  size of required blocks to update

Implements Botan::Cipher_Mode.

Definition at line 74 of file tls_cbc.cpp.

75 {
76 return 1; // just buffers anyway
77 }

## ◆ use_encrypt_then_mac()

bool Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::use_encrypt_then_mac | ( |  | ) | const
| inline protected inherited

Definition at line 62 of file tls_cbc.h.

62{ return m_use_encrypt_then_mac; }

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), finish(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::output_length(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::set_associated_data().

## ◆ valid_keylength()

bool Botan::SymmetricAlgorithm::valid_keylength | ( | size_t | length | ) | const
| inline inherited

Check whether a given key length is valid for this algorithm.

Parameters

  length | the key length to be checked.

Returns
  true if the key length is valid.

Definition at line 138 of file sym_algo.h.

139 {
140 return key_spec().valid_keylength(length);
141 }
Botan::Key_Length_Specification::valid_keylength
bool valid_keylength(size_t length) const
Definition: sym_algo.h:52

Referenced by Botan::aont_package(), Botan::aont_unpackage(), and Botan::SymmetricAlgorithm::set_key().

## ◆ valid_nonce_length()

bool Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::valid_nonce_length | ( | size_t | nonce_len | ) | const
| final override virtual inherited

Returns
  true iff nonce_len is a valid length for the nonce

Implements Botan::Cipher_Mode.

Definition at line 79 of file tls_cbc.cpp.

80 {
81 if(m_cbc_state.empty())
82 return nl == block_size();
83 return nl == iv_size();
84 }

References Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::block_size(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::iv_size().

## ◆ verify_key_set()

void Botan::SymmetricAlgorithm::verify_key_set | ( | bool | cond | ) | const
| inline protected inherited

Definition at line 171 of file sym_algo.h.

172 {
173 if(cond == false)
174 throw_key_not_set_error();
175 }

Referenced by Botan::ChaCha::cipher(), Botan::CTR_BE::cipher(), Botan::RC4::cipher(), Botan::Salsa20::cipher(), Botan::SHAKE_128_Cipher::cipher(), Botan::AES_128::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::CAST_256::decrypt_n(), Botan::DES::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::DESX::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::KASUMI::decrypt_n(), Botan::Lion::decrypt_n(), Botan::MISTY1::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SEED::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::SM4::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::XTEA::decrypt_n(), Botan::AES_128::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::CAST_256::encrypt_n(), Botan::DES::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::DESX::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::KASUMI::encrypt_n(), Botan::Lion::encrypt_n(), Botan::MISTY1::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::XTEA::encrypt_n(), Botan::OCB_Encryption::finish(), Botan::OCB_Decryption::finish(), Botan::GHASH::ghash_update(), Botan::CFB_Encryption::process(), Botan::CFB_Decryption::process(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data(), Botan::ChaCha::set_iv(), Botan::Salsa20::set_iv(), Botan::GHASH::update(), Botan::GHASH::update_associated_data(), and Botan::ChaCha::write_keystream().

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

- src/lib/tls/tls_cbc/tls_cbc.h
- src/lib/tls/tls_cbc/tls_cbc.cpp