Botan  2.11.0
Crypto and TLS for C++11
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::CCM_Encryption Class Referencefinal

#include <ccm.h>

Inheritance diagram for Botan::CCM_Encryption:
Botan::CCM_Mode Botan::AEAD_Mode Botan::Cipher_Mode Botan::SymmetricAlgorithm

Public Member Functions

bool associated_data_requires_key () const override
 
bool authenticated () const override
 
 CCM_Encryption (BlockCipher *cipher, size_t tag_size=16, size_t L=3)
 
void clear () override
 
size_t default_nonce_length () const override
 
void finish (secure_vector< uint8_t > &final_block, size_t offset=0) override
 
Key_Length_Specification key_spec () const override
 
size_t maximum_keylength () const
 
size_t minimum_final_size () const override
 
size_t minimum_keylength () const
 
std::string name () const override
 
size_t output_length (size_t input_length) const override
 
size_t process (uint8_t buf[], size_t sz) override
 
virtual std::string provider () const
 
void reset () override
 
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
 
template<typename Alloc >
void set_associated_data_vec (const std::vector< uint8_t, Alloc > &ad)
 
void set_key (const SymmetricKey &key)
 
template<typename Alloc >
void set_key (const std::vector< uint8_t, Alloc > &key)
 
void set_key (const uint8_t key[], size_t length)
 
template<typename Alloc >
void start (const std::vector< uint8_t, Alloc > &nonce)
 
void start (const uint8_t nonce[], size_t nonce_len)
 
void start ()
 
size_t tag_size () const override
 
void update (secure_vector< uint8_t > &buffer, size_t offset=0)
 
size_t update_granularity () const override
 
bool valid_keylength (size_t length) const
 
bool valid_nonce_length (size_t) const override
 

Static Public Member Functions

static std::unique_ptr< AEAD_Modecreate (const std::string &algo, Cipher_Dir direction, const std::string &provider="")
 
static std::unique_ptr< AEAD_Modecreate_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

const secure_vector< uint8_t > & ad_buf () const
 
const BlockCiphercipher () const
 
void encode_length (uint64_t len, uint8_t out[])
 
secure_vector< uint8_t > format_b0 (size_t msg_size)
 
secure_vector< uint8_t > format_c0 ()
 
void inc (secure_vector< uint8_t > &C)
 
size_t L () const
 
secure_vector< uint8_t > & msg_buf ()
 
void verify_key_set (bool cond) const
 

Detailed Description

CCM Encryption

Definition at line 78 of file ccm.h.

Constructor & Destructor Documentation

◆ CCM_Encryption()

Botan::CCM_Encryption::CCM_Encryption ( BlockCipher cipher,
size_t  tag_size = 16,
size_t  L = 3 
)
inline
Parameters
ciphera 128-bit block cipher
tag_sizeis how big the auth tag will be (even values between 4 and 16 are accepted)
Llength of L parameter. The total message length must be less than 2**L bytes, and the nonce is 15-L bytes.

Definition at line 88 of file ccm.h.

88  :
size_t L() const
Definition: ccm.h:49
const BlockCipher & cipher() const
Definition: ccm.h:51
CCM_Mode(BlockCipher *cipher, size_t tag_size, size_t L)
Definition: ccm.cpp:20
size_t tag_size() const override
Definition: ccm.h:44

Member Function Documentation

◆ ad_buf()

const secure_vector<uint8_t>& Botan::CCM_Mode::ad_buf ( ) const
inlineprotectedinherited

Definition at line 57 of file ccm.h.

Referenced by finish(), and Botan::CCM_Decryption::finish().

57 { return m_ad_buf; }

◆ associated_data_requires_key()

bool Botan::CCM_Mode::associated_data_requires_key ( ) const
inlineoverridevirtualinherited

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

Definition at line 28 of file ccm.h.

28 { return false; }

◆ authenticated()

bool Botan::AEAD_Mode::authenticated ( ) const
inlineoverridevirtualinherited
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; }

◆ cipher()

const BlockCipher& Botan::CCM_Mode::cipher ( ) const
inlineprotectedinherited

Definition at line 51 of file ccm.h.

Referenced by finish(), and Botan::CCM_Decryption::finish().

51 { return *m_cipher; }

◆ clear()

void Botan::CCM_Mode::clear ( )
overridevirtualinherited

Reset the state.

Implements Botan::SymmetricAlgorithm.

Definition at line 35 of file ccm.cpp.

References Botan::CCM_Mode::reset().

36  {
37  m_cipher->clear();
38  reset();
39  }
void reset() override
Definition: ccm.cpp:41

◆ create()

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

Create an AEAD mode

Parameters
algothe algorithm to create
directionspecify if this should be an encryption or decryption AEAD
provideroptional specification for provider to use
Returns
an AEAD mode or a null pointer if not available

Definition at line 52 of file aead.cpp.

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

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

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

◆ 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 = "" 
)
staticinherited

Create an AEAD mode, or throw

Parameters
algothe algorithm to create
directionspecify if this should be an encryption or decryption AEAD
provideroptional specification for provider to use
Returns
an AEAD mode, or throw an exception

Definition at line 42 of file aead.cpp.

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().

45  {
46  if(auto aead = AEAD_Mode::create(algo, dir, provider))
47  return aead;
48 
49  throw Lookup_Error("AEAD", algo, provider);
50  }
static std::unique_ptr< AEAD_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition: aead.cpp:52
virtual std::string provider() const
Definition: cipher_mode.h:180

◆ default_nonce_length()

size_t Botan::CCM_Mode::default_nonce_length ( ) const
overridevirtualinherited
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 58 of file ccm.cpp.

References Botan::CCM_Mode::L().

59  {
60  return (15-L());
61  }
size_t L() const
Definition: ccm.h:49

◆ encode_length()

void Botan::CCM_Mode::encode_length ( uint64_t  len,
uint8_t  out[] 
)
protectedinherited

Definition at line 117 of file ccm.cpp.

References BOTAN_ASSERT_NOMSG, Botan::get_byte(), and Botan::CCM_Mode::L().

Referenced by Botan::CCM_Mode::format_b0().

118  {
119  const size_t len_bytes = L();
120 
121  BOTAN_ASSERT_NOMSG(len_bytes >= 1 && len_bytes <= 8);
122 
123  for(size_t i = 0; i != len_bytes; ++i)
124  out[len_bytes-1-i] = get_byte(sizeof(uint64_t)-1-i, len);
125 
126  if(len_bytes < 8 && (len >> (len_bytes*8)) > 0)
127  throw Encoding_Error("CCM message length too long to encode in L field");
128  }
size_t L() const
Definition: ccm.h:49
constexpr uint8_t get_byte(size_t byte_num, T input)
Definition: loadstor.h:39
#define BOTAN_ASSERT_NOMSG(expr)
Definition: assert.h:68

◆ finish()

void Botan::CCM_Encryption::finish ( secure_vector< uint8_t > &  final_block,
size_t  offset = 0 
)
overridevirtual

Complete processing of a message.

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

Implements Botan::Cipher_Mode.

Definition at line 163 of file ccm.cpp.

References Botan::CCM_Mode::ad_buf(), BOTAN_ARG_CHECK, Botan::CCM_Mode::cipher(), Botan::CCM_Mode::format_b0(), Botan::CCM_Mode::format_c0(), Botan::CCM_Mode::inc(), Botan::CCM_Mode::msg_buf(), T, Botan::CCM_Mode::tag_size(), X, and Botan::xor_buf().

164  {
165  BOTAN_ARG_CHECK(buffer.size() >= offset, "Offset is sane");
166 
167  buffer.insert(buffer.begin() + offset, msg_buf().begin(), msg_buf().end());
168 
169  const size_t sz = buffer.size() - offset;
170  uint8_t* buf = buffer.data() + offset;
171 
172  const secure_vector<uint8_t>& ad = ad_buf();
173  BOTAN_ARG_CHECK(ad.size() % CCM_BS == 0, "AD is block size multiple");
174 
175  const BlockCipher& E = cipher();
176 
177  secure_vector<uint8_t> T(CCM_BS);
178  E.encrypt(format_b0(sz), T);
179 
180  for(size_t i = 0; i != ad.size(); i += CCM_BS)
181  {
182  xor_buf(T.data(), &ad[i], CCM_BS);
183  E.encrypt(T);
184  }
185 
186  secure_vector<uint8_t> C = format_c0();
187  secure_vector<uint8_t> S0(CCM_BS);
188  E.encrypt(C, S0);
189  inc(C);
190 
191  secure_vector<uint8_t> X(CCM_BS);
192 
193  const uint8_t* buf_end = &buf[sz];
194 
195  while(buf != buf_end)
196  {
197  const size_t to_proc = std::min<size_t>(CCM_BS, buf_end - buf);
198 
199  xor_buf(T.data(), buf, to_proc);
200  E.encrypt(T);
201 
202  E.encrypt(C, X);
203  xor_buf(buf, X.data(), to_proc);
204  inc(C);
205 
206  buf += to_proc;
207  }
208 
209  T ^= S0;
210 
211  buffer += std::make_pair(T.data(), tag_size());
212  }
fe X
Definition: ge.cpp:27
secure_vector< uint8_t > format_c0()
Definition: ccm.cpp:151
const BlockCipher & cipher() const
Definition: ccm.h:51
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition: mem_ops.h:202
void inc(secure_vector< uint8_t > &C)
Definition: ccm.cpp:130
#define BOTAN_ARG_CHECK(expr, msg)
Definition: assert.h:37
fe T
Definition: ge.cpp:37
secure_vector< uint8_t > format_b0(size_t msg_size)
Definition: ccm.cpp:137
const secure_vector< uint8_t > & ad_buf() const
Definition: ccm.h:57
secure_vector< uint8_t > & msg_buf()
Definition: ccm.h:59
size_t tag_size() const override
Definition: ccm.h:44

◆ format_b0()

secure_vector< uint8_t > Botan::CCM_Mode::format_b0 ( size_t  msg_size)
protectedinherited

Definition at line 137 of file ccm.cpp.

References Botan::copy_mem(), Botan::CCM_Mode::encode_length(), Botan::CCM_Mode::L(), and Botan::CCM_Mode::tag_size().

Referenced by finish(), and Botan::CCM_Decryption::finish().

138  {
139  secure_vector<uint8_t> B0(CCM_BS);
140 
141  const uint8_t b_flags =
142  static_cast<uint8_t>((m_ad_buf.size() ? 64 : 0) + (((tag_size()/2)-1) << 3) + (L()-1));
143 
144  B0[0] = b_flags;
145  copy_mem(&B0[1], m_nonce.data(), m_nonce.size());
146  encode_length(sz, &B0[m_nonce.size()+1]);
147 
148  return B0;
149  }
size_t L() const
Definition: ccm.h:49
void encode_length(uint64_t len, uint8_t out[])
Definition: ccm.cpp:117
void copy_mem(T *out, const T *in, size_t n)
Definition: mem_ops.h:122
size_t tag_size() const override
Definition: ccm.h:44

◆ format_c0()

secure_vector< uint8_t > Botan::CCM_Mode::format_c0 ( )
protectedinherited

Definition at line 151 of file ccm.cpp.

References Botan::copy_mem(), and Botan::CCM_Mode::L().

Referenced by finish(), and Botan::CCM_Decryption::finish().

152  {
153  secure_vector<uint8_t> C(CCM_BS);
154 
155  const uint8_t a_flags = static_cast<uint8_t>(L() - 1);
156 
157  C[0] = a_flags;
158  copy_mem(&C[1], m_nonce.data(), m_nonce.size());
159 
160  return C;
161  }
size_t L() const
Definition: ccm.h:49
void copy_mem(T *out, const T *in, size_t n)
Definition: mem_ops.h:122

◆ inc()

void Botan::CCM_Mode::inc ( secure_vector< uint8_t > &  C)
protectedinherited

Definition at line 130 of file ccm.cpp.

Referenced by finish(), and Botan::CCM_Decryption::finish().

131  {
132  for(size_t i = 0; i != C.size(); ++i)
133  if(++C[C.size()-i-1])
134  break;
135  }

◆ key_spec()

Key_Length_Specification Botan::CCM_Mode::key_spec ( ) const
overridevirtualinherited
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 74 of file ccm.cpp.

75  {
76  return m_cipher->key_spec();
77  }

◆ L()

size_t Botan::CCM_Mode::L ( ) const
inlineprotectedinherited

◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 38 of file sym_algo.h.

39  {
40  return key_spec().maximum_keylength();
41  }
size_t maximum_keylength() const
Definition: key_spec.h:69
virtual Key_Length_Specification key_spec() const =0

◆ minimum_final_size()

size_t Botan::CCM_Encryption::minimum_final_size ( ) const
inlineoverridevirtual
Returns
required minimium size to finalize() - may be any length larger than this.

Implements Botan::Cipher_Mode.

Definition at line 96 of file ccm.h.

96 { return 0; }

◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const
inlineinherited
Returns
maximum allowed key length

Definition at line 46 of file sym_algo.h.

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

47  {
48  return key_spec().minimum_keylength();
49  }
virtual Key_Length_Specification key_spec() const =0
size_t minimum_keylength() const
Definition: key_spec.h:61

◆ msg_buf()

secure_vector<uint8_t>& Botan::CCM_Mode::msg_buf ( )
inlineprotectedinherited

Definition at line 59 of file ccm.h.

Referenced by finish(), and Botan::CCM_Decryption::finish().

59 { return m_msg_buf; }

◆ name()

std::string Botan::CCM_Mode::name ( ) const
overridevirtualinherited
Returns
the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 48 of file ccm.cpp.

References Botan::CCM_Mode::L(), Botan::CCM_Mode::tag_size(), and Botan::ASN1::to_string().

49  {
50  return (m_cipher->name() + "/CCM(" + std::to_string(tag_size()) + "," + std::to_string(L())) + ")";
51  }
size_t L() const
Definition: ccm.h:49
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:213
size_t tag_size() const override
Definition: ccm.h:44

◆ output_length()

size_t Botan::CCM_Encryption::output_length ( size_t  input_length) const
inlineoverridevirtual

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 93 of file ccm.h.

94  { return input_length + tag_size(); }
size_t tag_size() const override
Definition: ccm.h:44

◆ process()

size_t Botan::CCM_Mode::process ( uint8_t  msg[],
size_t  msg_len 
)
overridevirtualinherited

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
msgthe message to be processed
msg_lenlength of the message in bytes

Implements Botan::Cipher_Mode.

Definition at line 110 of file ccm.cpp.

References BOTAN_STATE_CHECK.

111  {
112  BOTAN_STATE_CHECK(m_nonce.size() > 0);
113  m_msg_buf.insert(m_msg_buf.end(), buf, buf + sz);
114  return 0; // no output until finished
115  }
#define BOTAN_STATE_CHECK(expr)
Definition: assert.h:49

◆ provider()

virtual std::string Botan::Cipher_Mode::provider ( ) const
inlinevirtualinherited
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.

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

180 { return "base"; }

◆ providers()

std::vector< std::string > Botan::Cipher_Mode::providers ( const std::string &  algo_spec)
staticinherited
Returns
list of available providers for this algorithm, empty if not available
Parameters
algo_specalgorithm name

Definition at line 190 of file cipher_mode.cpp.

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

191  {
192  const std::vector<std::string>& possible = { "base", "openssl", "commoncrypto" };
193  std::vector<std::string> providers;
194  for(auto&& prov : possible)
195  {
196  std::unique_ptr<Cipher_Mode> mode = Cipher_Mode::create(algo_spec, ENCRYPTION, prov);
197  if(mode)
198  {
199  providers.push_back(prov); // available
200  }
201  }
202  return providers;
203  }
static std::unique_ptr< Cipher_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition: cipher_mode.cpp:54
static std::vector< std::string > providers(const std::string &algo_spec)

◆ reset()

void Botan::CCM_Mode::reset ( )
overridevirtualinherited

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

Implements Botan::Cipher_Mode.

Definition at line 41 of file ccm.cpp.

Referenced by Botan::CCM_Mode::clear().

42  {
43  m_nonce.clear();
44  m_msg_buf.clear();
45  m_ad_buf.clear();
46  }

◆ set_ad()

template<typename Alloc >
void Botan::AEAD_Mode::set_ad ( const std::vector< uint8_t, Alloc > &  ad)
inlineinherited

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
adthe associated data

Definition at line 95 of file aead.h.

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

96  {
97  set_associated_data(ad.data(), ad.size());
98  }
virtual void set_associated_data(const uint8_t ad[], size_t ad_len)=0

◆ set_associated_data()

void Botan::CCM_Mode::set_associated_data ( const uint8_t  ad[],
size_t  ad_len 
)
overridevirtualinherited

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
adthe associated data
ad_lenlength of add in bytes

Implements Botan::AEAD_Mode.

Definition at line 84 of file ccm.cpp.

References BOTAN_ARG_CHECK, and Botan::get_byte().

85  {
86  m_ad_buf.clear();
87 
88  if(length)
89  {
90  // FIXME: support larger AD using length encoding rules
91  BOTAN_ARG_CHECK(length < (0xFFFF - 0xFF), "Supported CCM AD length");
92 
93  m_ad_buf.push_back(get_byte(0, static_cast<uint16_t>(length)));
94  m_ad_buf.push_back(get_byte(1, static_cast<uint16_t>(length)));
95  m_ad_buf += std::make_pair(ad, length);
96  while(m_ad_buf.size() % CCM_BS)
97  m_ad_buf.push_back(0); // pad with zeros to full block size
98  }
99  }
constexpr uint8_t get_byte(size_t byte_num, T input)
Definition: loadstor.h:39
#define BOTAN_ARG_CHECK(expr, msg)
Definition: assert.h:37

◆ set_associated_data_vec()

template<typename Alloc >
void Botan::AEAD_Mode::set_associated_data_vec ( const std::vector< uint8_t, Alloc > &  ad)
inlineinherited

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
adthe associated data

Definition at line 80 of file aead.h.

81  {
82  set_associated_data(ad.data(), ad.size());
83  }
virtual void set_associated_data(const uint8_t ad[], size_t ad_len)=0

◆ set_key() [1/3]

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey key)
inlineinherited

◆ set_key() [2/3]

template<typename Alloc >
void Botan::SymmetricAlgorithm::set_key ( const std::vector< uint8_t, Alloc > &  key)
inlineinherited

Definition at line 71 of file sym_algo.h.

72  {
73  set_key(key.data(), key.size());
74  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:65

◆ 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
keythe to be set as a byte array.
lengthin bytes of key param

Definition at line 17 of file sym_algo.cpp.

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

18  {
19  if(!valid_keylength(length))
20  throw Invalid_Key_Length(name(), length);
21  key_schedule(key, length);
22  }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:56
virtual std::string name() const =0

◆ start() [1/3]

template<typename Alloc >
void Botan::Cipher_Mode::start ( const std::vector< uint8_t, Alloc > &  nonce)
inlineinherited

Begin processing a message.

Parameters
noncethe per message nonce

Definition at line 69 of file cipher_mode.h.

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

70  {
71  start_msg(nonce.data(), nonce.size());
72  }
virtual void start_msg(const uint8_t nonce[], size_t nonce_len)=0

◆ start() [2/3]

void Botan::Cipher_Mode::start ( const uint8_t  nonce[],
size_t  nonce_len 
)
inlineinherited

Begin processing a message.

Parameters
noncethe per message nonce
nonce_lenlength of nonce

Definition at line 79 of file cipher_mode.h.

80  {
81  start_msg(nonce, nonce_len);
82  }
virtual void start_msg(const uint8_t nonce[], size_t nonce_len)=0

◆ start() [3/3]

void Botan::Cipher_Mode::start ( )
inlineinherited

Begin processing a message.

Definition at line 87 of file cipher_mode.h.

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

◆ tag_size()

size_t Botan::CCM_Mode::tag_size ( ) const
inlineoverridevirtualinherited
Returns
the size of the authentication tag used (in bytes)

Reimplemented from Botan::Cipher_Mode.

Definition at line 44 of file ccm.h.

Referenced by finish(), Botan::CCM_Decryption::finish(), Botan::CCM_Mode::format_b0(), and Botan::CCM_Mode::name().

44 { return m_tag_size; }

◆ update()

void Botan::Cipher_Mode::update ( secure_vector< uint8_t > &  buffer,
size_t  offset = 0 
)
inlineinherited

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

Parameters
bufferin/out parameter which will possibly be resized
offsetan offset into blocks to begin processing

Definition at line 112 of file cipher_mode.h.

References BOTAN_ASSERT.

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

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  }
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
virtual size_t process(uint8_t msg[], size_t msg_len)=0

◆ update_granularity()

size_t Botan::CCM_Mode::update_granularity ( ) const
overridevirtualinherited
Returns
size of required blocks to update

Implements Botan::Cipher_Mode.

Definition at line 63 of file ccm.cpp.

64  {
65  /*
66  This value does not particularly matter as regardless CCM_Mode::update
67  buffers all input, so in theory this could be 1. However as for instance
68  Transform_Filter creates update_granularity() uint8_t buffers, use a
69  somewhat large size to avoid bouncing on a tiny buffer.
70  */
71  return m_cipher->parallel_bytes();
72  }

◆ valid_keylength()

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t  length) const
inlineinherited

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

Parameters
lengththe key length to be checked.
Returns
true if the key length is valid.

Definition at line 56 of file sym_algo.h.

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

57  {
58  return key_spec().valid_keylength(length);
59  }
bool valid_keylength(size_t length) const
Definition: key_spec.h:51
virtual Key_Length_Specification key_spec() const =0

◆ valid_nonce_length()

bool Botan::CCM_Mode::valid_nonce_length ( size_t  nonce_len) const
overridevirtualinherited
Returns
true iff nonce_len is a valid length for the nonce

Implements Botan::Cipher_Mode.

Definition at line 53 of file ccm.cpp.

References Botan::CCM_Mode::L().

54  {
55  return (n == (15-L()));
56  }
size_t L() const
Definition: ccm.h:49

◆ verify_key_set()

void Botan::SymmetricAlgorithm::verify_key_set ( bool  cond) const
inlineprotectedinherited

Definition at line 89 of file sym_algo.h.

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

90  {
91  if(cond == false)
92  throw_key_not_set_error();
93  }

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