21782759586

Committed 07 Feb 2026 12:31PM UTC coverage: 90.073% (-0.001%) from 90.074%

Build # 21782759586

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #5289 from randombit/jack/header-patrol-2

Further misc header reductions, forward declarations, etc

Run Details

102244 of 113513 relevant lines covered (90.07%)

11458499.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.27

/src/lib/modes/aead/ccm/ccm.cpp

/*
* CCM Mode Encryption
* (C) 2013,2018 Jack Lloyd
* (C) 2016 Daniel Neus, Rohde & Schwarz Cybersecurity
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include <botan/internal/ccm.h>

#include <botan/exceptn.h>
#include <botan/internal/ct_utils.h>
#include <botan/internal/fmt.h>
#include <botan/internal/loadstor.h>

namespace Botan {

// 128-bit cipher is intrinsic to CCM definition
static const size_t CCM_BS = 16;

/*
* CCM_Mode Constructor
*/
CCM_Mode::CCM_Mode(std::unique_ptr<BlockCipher> cipher, size_t tag_size, size_t L) :
      m_tag_size(tag_size), m_L(L), m_cipher(std::move(cipher)) {
   if(m_cipher->block_size() != CCM_BS) {
      throw Invalid_Argument(m_cipher->name() + " cannot be used with CCM mode");
   }

   if(L < 2 || L > 8) {
      throw Invalid_Argument(fmt("Invalid CCM L value {}", L));
   }

   if(tag_size < 4 || tag_size > 16 || tag_size % 2 != 0) {
      throw Invalid_Argument(fmt("Invalid CCM tag length {}", tag_size));
   }
}

void CCM_Mode::clear() {
   m_cipher->clear();
   reset();
}

void CCM_Mode::reset() {
   m_nonce.clear();
   m_msg_buf.clear();
   m_ad_buf.clear();
}

std::string CCM_Mode::name() const {
   return fmt("{}/CCM({},{})", m_cipher->name(), tag_size(), L());
}

bool CCM_Mode::valid_nonce_length(size_t length) const {
   return (length == (15 - L()));
}

size_t CCM_Mode::default_nonce_length() const {
   return (15 - L());
}

size_t CCM_Mode::update_granularity() const {
   return 1;
}

size_t CCM_Mode::ideal_granularity() const {
   // Completely arbitrary
   return m_cipher->parallel_bytes();
}

bool CCM_Mode::requires_entire_message() const {
   return true;
}

Key_Length_Specification CCM_Mode::key_spec() const {
   return m_cipher->key_spec();
}

bool CCM_Mode::has_keying_material() const {
   return m_cipher->has_keying_material();
}

void CCM_Mode::key_schedule(std::span<const uint8_t> key) {
   m_cipher->set_key(key);
}

void CCM_Mode::set_associated_data_n(size_t idx, std::span<const uint8_t> ad) {
   BOTAN_ARG_CHECK(idx == 0, "CCM: cannot handle non-zero index in set_associated_data_n");

   m_ad_buf.clear();

   if(!ad.empty()) {
      // FIXME: support larger AD using length encoding rules
      BOTAN_ARG_CHECK(ad.size() < (0xFFFF - 0xFF), "Supported CCM AD length");

      m_ad_buf.push_back(get_byte<0>(static_cast<uint16_t>(ad.size())));
      m_ad_buf.push_back(get_byte<1>(static_cast<uint16_t>(ad.size())));
      m_ad_buf.insert(m_ad_buf.end(), ad.begin(), ad.end());
      while(m_ad_buf.size() % CCM_BS != 0) {
         m_ad_buf.push_back(0);  // pad with zeros to full block size
      }
   }
}

void CCM_Mode::start_msg(const uint8_t nonce[], size_t nonce_len) {
   if(!valid_nonce_length(nonce_len)) {
      throw Invalid_IV_Length(name(), nonce_len);
   }

   m_nonce.assign(nonce, nonce + nonce_len);
   m_msg_buf.clear();
}

size_t CCM_Mode::process_msg(uint8_t buf[], size_t sz) {
   BOTAN_STATE_CHECK(!m_nonce.empty());
   m_msg_buf.insert(m_msg_buf.end(), buf, buf + sz);
   return 0;  // no output until finished
}

void CCM_Mode::encode_length(uint64_t len, uint8_t out[]) {
   const size_t len_bytes = L();

   BOTAN_ASSERT_NOMSG(len_bytes >= 2 && len_bytes <= 8);

   for(size_t i = 0; i != len_bytes; ++i) {
      out[len_bytes - 1 - i] = get_byte_var(sizeof(uint64_t) - 1 - i, len);
   }

   if(len_bytes < 8 && (len >> (len_bytes * 8)) > 0) {
      throw Encoding_Error("CCM message length too long to encode in L field");
   }
}

void CCM_Mode::inc(secure_vector<uint8_t>& C) {
   for(size_t i = 0; i != C.size(); ++i) {
      uint8_t& b = C[C.size() - i - 1];
      b += 1;
      if(b > 0) {
         break;
      }
   }
}

secure_vector<uint8_t> CCM_Mode::format_b0(size_t sz) {
   if(m_nonce.size() != 15 - L()) {
      throw Invalid_State("CCM mode must set nonce");
   }
   secure_vector<uint8_t> B0(CCM_BS);

   const uint8_t b_flags =
      static_cast<uint8_t>((!m_ad_buf.empty() ? 64 : 0) + (((tag_size() / 2) - 1) << 3) + (L() - 1));

   B0[0] = b_flags;
   copy_mem(&B0[1], m_nonce.data(), m_nonce.size());
   encode_length(sz, &B0[m_nonce.size() + 1]);

   return B0;
}

secure_vector<uint8_t> CCM_Mode::format_c0() {
   if(m_nonce.size() != 15 - L()) {
      throw Invalid_State("CCM mode must set nonce");
   }
   secure_vector<uint8_t> C(CCM_BS);

   const uint8_t a_flags = static_cast<uint8_t>(L() - 1);

   C[0] = a_flags;
   copy_mem(&C[1], m_nonce.data(), m_nonce.size());

   return C;
}

void CCM_Encryption::finish_msg(secure_vector<uint8_t>& buffer, size_t offset) {
   BOTAN_ARG_CHECK(buffer.size() >= offset, "Offset is out of range");

   buffer.insert(buffer.begin() + offset, msg_buf().begin(), msg_buf().end());

   const size_t sz = buffer.size() - offset;
   uint8_t* buf = buffer.data() + offset;

   const secure_vector<uint8_t>& ad = ad_buf();
   BOTAN_ARG_CHECK(ad.size() % CCM_BS == 0, "AD is block size multiple");

   const BlockCipher& E = cipher();

   secure_vector<uint8_t> T(CCM_BS);
   E.encrypt(format_b0(sz), T);

   for(size_t i = 0; i != ad.size(); i += CCM_BS) {
      xor_buf(T.data(), &ad[i], CCM_BS);
      E.encrypt(T);
   }

   secure_vector<uint8_t> C = format_c0();
   secure_vector<uint8_t> S0(CCM_BS);
   E.encrypt(C, S0);
   inc(C);

   secure_vector<uint8_t> X(CCM_BS);

   const uint8_t* buf_end = &buf[sz];

   while(buf != buf_end) {
      const size_t to_proc = std::min<size_t>(CCM_BS, buf_end - buf);

      xor_buf(T.data(), buf, to_proc);
      E.encrypt(T);

      E.encrypt(C, X);
      xor_buf(buf, X.data(), to_proc);
      inc(C);

      buf += to_proc;
   }

   T ^= S0;

   buffer += std::make_pair(T.data(), tag_size());

   reset();
}

void CCM_Decryption::finish_msg(secure_vector<uint8_t>& buffer, size_t offset) {
   BOTAN_ARG_CHECK(buffer.size() >= offset, "Offset is out of range");

   buffer.insert(buffer.begin() + offset, msg_buf().begin(), msg_buf().end());

   const size_t sz = buffer.size() - offset;
   uint8_t* buf = buffer.data() + offset;

   BOTAN_ARG_CHECK(sz >= tag_size(), "input did not include the tag");

   const secure_vector<uint8_t>& ad = ad_buf();
   BOTAN_ARG_CHECK(ad.size() % CCM_BS == 0, "AD is block size multiple");

   const BlockCipher& E = cipher();

   secure_vector<uint8_t> T(CCM_BS);
   E.encrypt(format_b0(sz - tag_size()), T);

   for(size_t i = 0; i != ad.size(); i += CCM_BS) {
      xor_buf(T.data(), &ad[i], CCM_BS);
      E.encrypt(T);
   }

   secure_vector<uint8_t> C = format_c0();

   secure_vector<uint8_t> S0(CCM_BS);
   E.encrypt(C, S0);
   inc(C);

   secure_vector<uint8_t> X(CCM_BS);

   const uint8_t* buf_end = &buf[sz - tag_size()];

   while(buf != buf_end) {
      const size_t to_proc = std::min<size_t>(CCM_BS, buf_end - buf);

      E.encrypt(C, X);
      xor_buf(buf, X.data(), to_proc);
      inc(C);

      xor_buf(T.data(), buf, to_proc);
      E.encrypt(T);

      buf += to_proc;
   }

   T ^= S0;

   if(!CT::is_equal(T.data(), buf_end, tag_size()).as_bool()) {
      throw Invalid_Authentication_Tag("CCM tag check failed");
   }

   buffer.resize(buffer.size() - tag_size());

   reset();
}

}  // namespace Botan

1	/*
2	* CCM Mode Encryption
3	* (C) 2013,2018 Jack Lloyd
4	* (C) 2016 Daniel Neus, Rohde & Schwarz Cybersecurity
5	*
6	* Botan is released under the Simplified BSD License (see license.txt)
7	*/
8
9	#include <botan/internal/ccm.h>
10
11	#include <botan/exceptn.h>
12	#include <botan/internal/ct_utils.h>
13	#include <botan/internal/fmt.h>
14	#include <botan/internal/loadstor.h>
15
16	namespace Botan {
17
18	// 128-bit cipher is intrinsic to CCM definition
19	static const size_t CCM_BS = 16;
20
21	/*
22	* CCM_Mode Constructor
23	*/
24	CCM_Mode::CCM_Mode(std::unique_ptr<BlockCipher> cipher, size_t tag_size, size_t L) :	244✔
25	m_tag_size(tag_size), m_L(L), m_cipher(std::move(cipher)) {	244✔
26	if(m_cipher->block_size() != CCM_BS) {	244✔
27	throw Invalid_Argument(m_cipher->name() + " cannot be used with CCM mode");	×
28	}
29
30	if(L < 2 \|\| L > 8) {	244✔
31	throw Invalid_Argument(fmt("Invalid CCM L value {}", L));	×
32	}
33
34	if(tag_size < 4 \|\| tag_size > 16 \|\| tag_size % 2 != 0) {	244✔
35	throw Invalid_Argument(fmt("Invalid CCM tag length {}", tag_size));	×
36	}
37	}	244✔
38
39	void CCM_Mode::clear() {	70✔
40	m_cipher->clear();	70✔
41	reset();	140✔
42	}	70✔
43
44	void CCM_Mode::reset() {	815✔
45	m_nonce.clear();	382✔
46	m_msg_buf.clear();	815✔
47	m_ad_buf.clear();	815✔
48	}	312✔
49
50	std::string CCM_Mode::name() const {	35✔
51	return fmt("{}/CCM({},{})", m_cipher->name(), tag_size(), L());	35✔
52	}
53
54	bool CCM_Mode::valid_nonce_length(size_t length) const {	643✔
55	return (length == (15 - L()));	643✔
56	}
57
58	size_t CCM_Mode::default_nonce_length() const {	36✔
59	return (15 - L());	36✔
60	}
61
62	size_t CCM_Mode::update_granularity() const {	456✔
63	return 1;	456✔
64	}
65
66	size_t CCM_Mode::ideal_granularity() const {	216✔
67	// Completely arbitrary
68	return m_cipher->parallel_bytes();	216✔
69	}
70
71	bool CCM_Mode::requires_entire_message() const {	84✔
72	return true;	84✔
73	}
74
75	Key_Length_Specification CCM_Mode::key_spec() const {	176✔
76	return m_cipher->key_spec();	176✔
77	}
78
79	bool CCM_Mode::has_keying_material() const {	245✔
80	return m_cipher->has_keying_material();	245✔
81	}
82
83	void CCM_Mode::key_schedule(std::span<const uint8_t> key) {	174✔
84	m_cipher->set_key(key);	174✔
85	}	174✔
86
87	void CCM_Mode::set_associated_data_n(size_t idx, std::span<const uint8_t> ad) {	672✔
88	BOTAN_ARG_CHECK(idx == 0, "CCM: cannot handle non-zero index in set_associated_data_n");	672✔
89
90	m_ad_buf.clear();	672✔
91
92	if(!ad.empty()) {	672✔
93	// FIXME: support larger AD using length encoding rules
94	BOTAN_ARG_CHECK(ad.size() < (0xFFFF - 0xFF), "Supported CCM AD length");	648✔
95
96	m_ad_buf.push_back(get_byte<0>(static_cast<uint16_t>(ad.size())));	648✔
97	m_ad_buf.push_back(get_byte<1>(static_cast<uint16_t>(ad.size())));	648✔
98	m_ad_buf.insert(m_ad_buf.end(), ad.begin(), ad.end());	648✔
99	while(m_ad_buf.size() % CCM_BS != 0) {	6,093✔
100	m_ad_buf.push_back(0); // pad with zeros to full block size	5,445✔
101	}
102	}
103	}	672✔
104
105	void CCM_Mode::start_msg(const uint8_t nonce[], size_t nonce_len) {	608✔
106	if(!valid_nonce_length(nonce_len)) {	608✔
107	throw Invalid_IV_Length(name(), nonce_len);	×
108	}
109
110	m_nonce.assign(nonce, nonce + nonce_len);	608✔
111	m_msg_buf.clear();	608✔
112	}	608✔
113
114	size_t CCM_Mode::process_msg(uint8_t buf[], size_t sz) {	1,894✔
115	BOTAN_STATE_CHECK(!m_nonce.empty());	1,894✔
116	m_msg_buf.insert(m_msg_buf.end(), buf, buf + sz);	1,754✔
117	return 0; // no output until finished	1,754✔
118	}
119
120	void CCM_Mode::encode_length(uint64_t len, uint8_t out[]) {	538✔
121	const size_t len_bytes = L();	538✔
122
123	BOTAN_ASSERT_NOMSG(len_bytes >= 2 && len_bytes <= 8);	538✔
124
125	for(size_t i = 0; i != len_bytes; ++i) {	2,155✔
126	out[len_bytes - 1 - i] = get_byte_var(sizeof(uint64_t) - 1 - i, len);	1,617✔
127	}
128
129	if(len_bytes < 8 && (len >> (len_bytes * 8)) > 0) {	538✔
130	throw Encoding_Error("CCM message length too long to encode in L field");	×
131	}
132	}	538✔
133
134	void CCM_Mode::inc(secure_vector<uint8_t>& C) {	6,628✔
135	for(size_t i = 0; i != C.size(); ++i) {	6,628✔
136	uint8_t& b = C[C.size() - i - 1];	6,628✔
137	b += 1;	6,628✔
138	if(b > 0) {	6,628✔
139	break;
140	}
141	}
142	}	×
143
144	secure_vector<uint8_t> CCM_Mode::format_b0(size_t sz) {	748✔
145	if(m_nonce.size() != 15 - L()) {	748✔
146	throw Invalid_State("CCM mode must set nonce");	210✔
147	}
148	secure_vector<uint8_t> B0(CCM_BS);	538✔
149
150	const uint8_t b_flags =	538✔
151	static_cast<uint8_t>((!m_ad_buf.empty() ? 64 : 0) + (((tag_size() / 2) - 1) << 3) + (L() - 1));	560✔
152
153	B0[0] = b_flags;	538✔
154	copy_mem(&B0[1], m_nonce.data(), m_nonce.size());	538✔
155	encode_length(sz, &B0[m_nonce.size() + 1]);	538✔
156
157	return B0;	538✔
158	}	×
159
160	secure_vector<uint8_t> CCM_Mode::format_c0() {	538✔
161	if(m_nonce.size() != 15 - L()) {	538✔
162	throw Invalid_State("CCM mode must set nonce");	×
163	}
164	secure_vector<uint8_t> C(CCM_BS);	538✔
165
166	const uint8_t a_flags = static_cast<uint8_t>(L() - 1);	538✔
167
168	C[0] = a_flags;	538✔
169	copy_mem(&C[1], m_nonce.data(), m_nonce.size());	538✔
170
171	return C;	538✔
172	}	×
173
174	void CCM_Encryption::finish_msg(secure_vector<uint8_t>& buffer, size_t offset) {	321✔
175	BOTAN_ARG_CHECK(buffer.size() >= offset, "Offset is out of range");	321✔
176
177	buffer.insert(buffer.begin() + offset, msg_buf().begin(), msg_buf().end());	321✔
178
179	const size_t sz = buffer.size() - offset;	321✔
180	uint8_t* buf = buffer.data() + offset;	321✔
181
182	const secure_vector<uint8_t>& ad = ad_buf();	321✔
183	BOTAN_ARG_CHECK(ad.size() % CCM_BS == 0, "AD is block size multiple");	321✔
184
185	const BlockCipher& E = cipher();	321✔
186
187	secure_vector<uint8_t> T(CCM_BS);	321✔
188	E.encrypt(format_b0(sz), T);	537✔
189
190	for(size_t i = 0; i != ad.size(); i += CCM_BS) {	563✔
191	xor_buf(T.data(), &ad[i], CCM_BS);	347✔
192	E.encrypt(T);	694✔
193	}
194
195	secure_vector<uint8_t> C = format_c0();	216✔
196	secure_vector<uint8_t> S0(CCM_BS);	216✔
197	E.encrypt(C, S0);	216✔
198	inc(C);	216✔
199
200	secure_vector<uint8_t> X(CCM_BS);	216✔
201
202	const uint8_t* buf_end = &buf[sz];	216✔
203
204	while(buf != buf_end) {	3,159✔
205	const size_t to_proc = std::min<size_t>(CCM_BS, buf_end - buf);	2,943✔
206
207	xor_buf(T.data(), buf, to_proc);	2,943✔
208	E.encrypt(T);	2,943✔
209
210	E.encrypt(C, X);	2,943✔
211	xor_buf(buf, X.data(), to_proc);	2,943✔
212	inc(C);	2,943✔
213
214	buf += to_proc;	2,943✔
215	}
216
217	T ^= S0;	216✔
218
219	buffer += std::make_pair(T.data(), tag_size());	216✔
220
221	reset();	432✔
222	}	864✔
223
224	void CCM_Decryption::finish_msg(secure_vector<uint8_t>& buffer, size_t offset) {	427✔
225	BOTAN_ARG_CHECK(buffer.size() >= offset, "Offset is out of range");	427✔
226
227	buffer.insert(buffer.begin() + offset, msg_buf().begin(), msg_buf().end());	427✔
228
229	const size_t sz = buffer.size() - offset;	427✔
230	uint8_t* buf = buffer.data() + offset;	427✔
231
232	BOTAN_ARG_CHECK(sz >= tag_size(), "input did not include the tag");	427✔
233
234	const secure_vector<uint8_t>& ad = ad_buf();	427✔
235	BOTAN_ARG_CHECK(ad.size() % CCM_BS == 0, "AD is block size multiple");	427✔
236
237	const BlockCipher& E = cipher();	427✔
238
239	secure_vector<uint8_t> T(CCM_BS);	427✔
240	E.encrypt(format_b0(sz - tag_size()), T);	854✔
241
242	for(size_t i = 0; i != ad.size(); i += CCM_BS) {	882✔
243	xor_buf(T.data(), &ad[i], CCM_BS);	560✔
244	E.encrypt(T);	1,120✔
245	}
246
247	secure_vector<uint8_t> C = format_c0();	322✔
248
249	secure_vector<uint8_t> S0(CCM_BS);	427✔
250	E.encrypt(C, S0);	322✔
251	inc(C);	322✔
252
253	secure_vector<uint8_t> X(CCM_BS);	427✔
254
255	const uint8_t* buf_end = &buf[sz - tag_size()];	322✔
256
257	while(buf != buf_end) {	3,469✔
258	const size_t to_proc = std::min<size_t>(CCM_BS, buf_end - buf);	3,147✔
259
260	E.encrypt(C, X);	3,147✔
261	xor_buf(buf, X.data(), to_proc);	3,147✔
262	inc(C);	3,147✔
263
264	xor_buf(T.data(), buf, to_proc);	3,147✔
265	E.encrypt(T);	3,147✔
266
267	buf += to_proc;	3,147✔
268	}
269
270	T ^= S0;	322✔
271
272	if(!CT::is_equal(T.data(), buf_end, tag_size()).as_bool()) {	322✔
273	throw Invalid_Authentication_Tag("CCM tag check failed");	105✔
274	}
275
276	buffer.resize(buffer.size() - tag_size());	217✔
277
278	reset();	434✔
279	}	1,183✔
280
281	} // namespace Botan

randombit / botan / 21782759586

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous