• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

randombit / botan / 19012754211

02 Nov 2025 01:10PM UTC coverage: 90.677% (+0.006%) from 90.671%
19012754211

push

github

web-flow
Merge pull request #5137 from randombit/jack/clang-tidy-includes

Remove various unused includes flagged by clang-tidy misc-include-cleaner

100457 of 110786 relevant lines covered (90.68%)

12189873.8 hits per line

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

97.54
/src/lib/misc/roughtime/roughtime.cpp
1
/*
2
* Roughtime
3
* (C) 2019 Nuno Goncalves <nunojpg@gmail.com>
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7

8
#include <botan/roughtime.h>
9

10
#include <botan/base64.h>
11
#include <botan/hash.h>
12
#include <botan/mem_ops.h>
13
#include <botan/pubkey.h>
14
#include <botan/rng.h>
15
#include <botan/internal/socket_udp.h>
16
#include <botan/internal/stl_util.h>
17

18
#include <map>
19
#include <sstream>
20

21
namespace Botan {
22

23
namespace {
24

25
// This exists to work around a LGTM false positive
26
static_assert(Roughtime::request_min_size == 1024, "Expected minimum size");
27

28
template <class T>
29
struct is_array : std::false_type {};
30

31
template <class T, std::size_t N>
32
struct is_array<std::array<T, N>> : std::true_type {};
33

34
template <typename T>
35
T impl_from_little_endian(const uint8_t* t, const size_t i)
921✔
36
   requires(sizeof(T) <= sizeof(int64_t))
37
{
38
   return T(static_cast<int64_t>(t[i]) << i * 8) + (i == 0 ? T(0) : impl_from_little_endian<T>(t, i - 1));
1,856✔
39
}
40

41
template <typename T>
42
T from_little_endian(const uint8_t* t) {
369✔
43
   return impl_from_little_endian<T>(t, sizeof(T) - 1);
369✔
44
}
45

46
template <typename T>
47
T copy(const uint8_t* t)
142✔
48
   requires(is_array<T>::value)
49
{
50
   return typecast_copy<T>(t);  //arrays are endianness independent, so we do a memcpy
142✔
51
}
52

53
template <typename T>
54
T copy(const uint8_t* t)
92✔
55
   requires(!is_array<T>::value)
56
{
57
   //other types are arithmetic, so we account that roughtime serializes as little endian
58
   return from_little_endian<T>(t);
92✔
59
}
60

61
template <typename T>
62
std::map<std::string, std::vector<uint8_t>> unpack_roughtime_packet(T bytes) {
124✔
63
   if(bytes.size() < 8) {
94✔
64
      throw Roughtime::Roughtime_Error("Map length is under minimum of 8 bytes");
1✔
65
   }
66
   const auto buf = bytes.data();
123✔
67
   const uint32_t num_tags = buf[0];
123✔
68
   const uint32_t start_content = num_tags * 8;
123✔
69
   if(start_content > bytes.size()) {
123✔
70
      throw Roughtime::Roughtime_Error("Map length too small to contain all tags");
1✔
71
   }
72
   uint32_t start = start_content;
122✔
73
   std::map<std::string, std::vector<uint8_t>> tags;
122✔
74
   for(uint32_t i = 0; i < num_tags; ++i) {
517✔
75
      const size_t end =
457✔
76
         ((i + 1) == num_tags) ? bytes.size() : start_content + from_little_endian<uint32_t>(buf + 4 + i * 4);
614✔
77
      if(end > bytes.size()) {
367✔
78
         throw Roughtime::Roughtime_Error("Tag end index out of bounds");
1✔
79
      }
80
      if(end < start) {
396✔
81
         throw Roughtime::Roughtime_Error("Tag offset must be more than previous tag offset");
1✔
82
      }
83
      const char* label_ptr = cast_uint8_ptr_to_char(buf) + (num_tags + i) * 4;
395✔
84
      const char label[] = {label_ptr[0], label_ptr[1], label_ptr[2], label_ptr[3], 0};
395✔
85
      auto ret = tags.emplace(label, std::vector<uint8_t>(buf + start, buf + end));
792✔
86
      if(!ret.second) {
395✔
87
         throw Roughtime::Roughtime_Error(std::string("Map has duplicated tag: ") + label);
×
88
      }
89
      start = static_cast<uint32_t>(end);
395✔
90
   }
91
   return tags;
120✔
92
}
2✔
93

94
template <typename T>
95
T get(const std::map<std::string, std::vector<uint8_t>>& map, const std::string& label) {
262✔
96
   const auto& tag = map.find(label);
262✔
97
   if(tag == map.end()) {
262✔
98
      throw Roughtime::Roughtime_Error("Tag " + label + " not found");
2✔
99
   }
100
   if(tag->second.size() != sizeof(T)) {
261✔
101
      throw Roughtime::Roughtime_Error("Tag " + label + " has unexpected size");
2✔
102
   }
103
   return copy<T>(tag->second.data());
260✔
104
}
105

106
const std::vector<uint8_t>& get_v(const std::map<std::string, std::vector<uint8_t>>& map, const std::string& label) {
87✔
107
   const auto& tag = map.find(label);
87✔
108
   if(tag == map.end()) {
87✔
109
      throw Roughtime::Roughtime_Error("Tag " + label + " not found");
2✔
110
   }
111
   return tag->second;
86✔
112
}
113

114
bool verify_signature(const std::array<uint8_t, 32>& pk,
27✔
115
                      const std::vector<uint8_t>& payload,
116
                      const std::array<uint8_t, 64>& signature) {
117
   constexpr std::string_view context("RoughTime v1 response signature\0", 32);
27✔
118
   Ed25519_PublicKey key(std::vector<uint8_t>(pk.data(), pk.data() + pk.size()));
27✔
119
   PK_Verifier verifier(key, "Pure");
27✔
120
   verifier.update(context);
27✔
121
   verifier.update(payload);
27✔
122
   return verifier.check_signature(signature.data(), signature.size());
54✔
123
}
27✔
124

125
std::array<uint8_t, 64> hashLeaf(const std::array<uint8_t, 64>& leaf) {
24✔
126
   std::array<uint8_t, 64> ret{};
24✔
127
   auto hash = HashFunction::create_or_throw("SHA-512");
24✔
128
   hash->update(0);
24✔
129
   hash->update(leaf.data(), leaf.size());
24✔
130
   hash->final(ret.data());
24✔
131
   return ret;
24✔
132
}
24✔
133

134
void hashNode(std::span<uint8_t, 64> hash, std::span<const uint8_t, 64> node, bool reverse) {
3✔
135
   auto h = HashFunction::create_or_throw("SHA-512");
3✔
136
   h->update(1);
3✔
137
   if(reverse) {
3✔
138
      h->update(node.data(), node.size());
2✔
139
      h->update(hash.data(), hash.size());
2✔
140
   } else {
141
      h->update(hash.data(), hash.size());
1✔
142
      h->update(node.data(), node.size());
1✔
143
   }
144
   h->final(hash.data());
6✔
145
}
3✔
146

147
template <size_t N, typename T>
148
std::array<uint8_t, N> vector_to_array(std::vector<uint8_t, T> vec) {
13✔
149
   if(vec.size() != N) {
13✔
150
      throw std::logic_error("Invalid vector size");
×
151
   }
152
   return typecast_copy<std::array<uint8_t, N>>(vec.data());
13✔
153
}
154
}  // namespace
155

156
namespace Roughtime {
157

158
Nonce::Nonce(const std::vector<uint8_t>& nonce) : m_nonce{} {
27✔
159
   if(nonce.size() != 64) {
27✔
160
      throw Invalid_Argument("Roughtime nonce must be 64 bytes long");
2✔
161
   }
162
   m_nonce = typecast_copy<std::array<uint8_t, 64>>(nonce.data());
25✔
163
}
25✔
164

165
Nonce::Nonce(RandomNumberGenerator& rng) : m_nonce(rng.random_array<64>()) {}
6✔
166

167
std::array<uint8_t, request_min_size> encode_request(const Nonce& nonce) {
8✔
168
   std::array<uint8_t, request_min_size> buf = {{2, 0, 0, 0, 64, 0, 0, 0, 'N', 'O', 'N', 'C', 'P', 'A', 'D', 0xff}};
8✔
169
   std::memcpy(buf.data() + 16, nonce.get_nonce().data(), nonce.get_nonce().size());
8✔
170
   std::memset(buf.data() + 16 + nonce.get_nonce().size(), 0, buf.size() - 16 - nonce.get_nonce().size());
8✔
171
   return buf;
8✔
172
}
173

174
Response Response::from_bits(const std::vector<uint8_t>& response, const Nonce& nonce) {
34✔
175
   const auto response_v = unpack_roughtime_packet(response);
37✔
176
   const auto cert = unpack_roughtime_packet(get_v(response_v, "CERT"));
71✔
177
   const auto cert_dele = get<std::array<uint8_t, 72>>(cert, "DELE");
30✔
178
   const auto cert_sig = get<std::array<uint8_t, 64>>(cert, "SIG");
39✔
179
   const auto cert_dele_v = unpack_roughtime_packet(cert_dele);
30✔
180
   const auto srep = get_v(response_v, "SREP");
39✔
181
   const auto srep_v = unpack_roughtime_packet(srep);
39✔
182

183
   const auto cert_dele_pubk = get<std::array<uint8_t, 32>>(cert_dele_v, "PUBK");
29✔
184
   const auto sig = get<std::array<uint8_t, 64>>(response_v, "SIG");
29✔
185
   if(!verify_signature(cert_dele_pubk, srep, sig)) {
27✔
186
      throw Roughtime_Error("Response signature invalid");
1✔
187
   }
188

189
   const auto indx = get<uint32_t>(response_v, "INDX");
26✔
190
   const auto path = get_v(response_v, "PATH");
34✔
191
   const auto srep_root = get<std::array<uint8_t, 64>>(srep_v, "ROOT");
26✔
192
   const size_t size = path.size();
26✔
193
   const size_t levels = size / 64;
26✔
194

195
   if(size % 64 != 0) {
26✔
196
      throw Roughtime_Error("Merkle tree path size must be multiple of 64 bytes");
1✔
197
   }
198
   if(indx >= (1U << levels)) {
25✔
199
      throw Roughtime_Error("Merkle tree path is too short");
1✔
200
   }
201

202
   BufferSlicer slicer(path);
24✔
203
   auto hash = hashLeaf(nonce.get_nonce());
24✔
204
   auto index = indx;
205
   for(std::size_t level = 0; level < levels; ++level) {
27✔
206
      hashNode(hash, slicer.take<64>(), index % 2 == 1);
3✔
207
      index >>= 1;
3✔
208
   }
209

210
   if(srep_root != hash) {
24✔
211
      throw Roughtime_Error("Nonce verification failed");
1✔
212
   }
213

214
   const auto cert_dele_maxt = sys_microseconds64(get<microseconds64>(cert_dele_v, "MAXT"));
23✔
215
   const auto cert_dele_mint = sys_microseconds64(get<microseconds64>(cert_dele_v, "MINT"));
23✔
216
   const auto srep_midp = sys_microseconds64(get<microseconds64>(srep_v, "MIDP"));
23✔
217
   const auto srep_radi = get<microseconds32>(srep_v, "RADI");
28✔
218
   if(srep_midp < cert_dele_mint) {
23✔
219
      throw Roughtime_Error("Midpoint earlier than delegation start");
1✔
220
   }
221
   if(srep_midp > cert_dele_maxt) {
22✔
222
      throw Roughtime_Error("Midpoint later than delegation end");
1✔
223
   }
224
   return {cert_dele, cert_sig, srep_midp, srep_radi};
21✔
225
}
82✔
226

227
bool Response::validate(const Ed25519_PublicKey& pk) const {
20✔
228
   constexpr std::string_view context("RoughTime v1 delegation signature--\0", 36);
20✔
229
   PK_Verifier verifier(pk, "Pure");
20✔
230
   verifier.update(context);
20✔
231
   verifier.update(m_cert_dele.data(), m_cert_dele.size());
20✔
232
   return verifier.check_signature(m_cert_sig.data(), m_cert_sig.size());
40✔
233
}
20✔
234

235
Nonce nonce_from_blind(const std::vector<uint8_t>& previous_response, const Nonce& blind) {
11✔
236
   std::array<uint8_t, 64> ret{};
11✔
237
   const auto blind_arr = blind.get_nonce();
11✔
238
   auto hash = HashFunction::create_or_throw("SHA-512");
11✔
239
   hash->update(previous_response);
11✔
240
   hash->update(hash->final());
11✔
241
   hash->update(blind_arr.data(), blind_arr.size());
11✔
242
   hash->final(ret.data());
11✔
243

244
   return Nonce(ret);
11✔
245
}
11✔
246

247
Chain::Chain(std::string_view str) {
13✔
248
   std::istringstream ss{std::string(str)};  // FIXME C++23 avoid copy
26✔
249
   const std::string ERROR_MESSAGE = "Line does not have 4 space separated fields";
13✔
250
   for(std::string s; std::getline(ss, s);) {
25✔
251
      size_t start = 0;
19✔
252
      size_t end = 0;
19✔
253
      end = s.find(' ', start);
19✔
254
      if(end == std::string::npos) {
19✔
255
         throw Decoding_Error(ERROR_MESSAGE);
1✔
256
      }
257
      const auto publicKeyType = s.substr(start, end - start);
18✔
258
      if(publicKeyType != "ed25519") {
18✔
259
         throw Not_Implemented("Only ed25519 publicKeyType is implemented");
1✔
260
      }
261

262
      start = end + 1;
17✔
263
      end = s.find(' ', start);
17✔
264
      if(end == std::string::npos) {
17✔
265
         throw Decoding_Error(ERROR_MESSAGE);
1✔
266
      }
267
      const auto serverPublicKey = Ed25519_PublicKey(base64_decode(s.substr(start, end - start)));
38✔
268

269
      start = end + 1;
15✔
270
      end = s.find(' ', start);
15✔
271
      if(end == std::string::npos) {
15✔
272
         throw Decoding_Error(ERROR_MESSAGE);
1✔
273
      }
274
      if((end - start) != 88) {
14✔
275
         throw Decoding_Error("Nonce has invalid length");
1✔
276
      }
277
      const auto vec = base64_decode(s.substr(start, end - start));
13✔
278
      const auto nonceOrBlind = Nonce(vector_to_array<64>(base64_decode(s.substr(start, end - start))));
26✔
279

280
      start = end + 1;
13✔
281
      end = s.find(' ', start);
13✔
282
      if(end != std::string::npos) {
13✔
283
         throw Decoding_Error(ERROR_MESSAGE);
1✔
284
      }
285
      const auto response = unlock(base64_decode(s.substr(start)));
37✔
286

287
      m_links.push_back({response, serverPublicKey, nonceOrBlind});
24✔
288
   }
46✔
289
}
20✔
290

291
std::vector<Response> Chain::responses() const {
7✔
292
   std::vector<Response> responses;
7✔
293
   for(size_t i = 0; i < m_links.size(); ++i) {
17✔
294
      const auto& l = m_links[i];
11✔
295
      const auto nonce = i > 0 ? nonce_from_blind(m_links[i - 1].response(), l.nonce_or_blind()) : l.nonce_or_blind();
11✔
296
      const auto response = Response::from_bits(l.response(), nonce);
11✔
297
      if(!response.validate(l.public_key())) {
11✔
298
         throw Roughtime_Error("Invalid signature or public key");
1✔
299
      }
300
      responses.push_back(response);
10✔
301
   }
302
   return responses;
6✔
303
}
1✔
304

305
Nonce Chain::next_nonce(const Nonce& blind) const {
4✔
306
   return m_links.empty() ? blind : nonce_from_blind(m_links.back().response(), blind);
4✔
307
}
308

309
void Chain::append(const Link& new_link, size_t max_chain_size) {
6✔
310
   if(max_chain_size <= 0) {
6✔
311
      throw Invalid_Argument("Max chain size must be positive");
1✔
312
   }
313

314
   while(m_links.size() >= max_chain_size) {
6✔
315
      if(m_links.size() == 1) {
2✔
316
         auto new_link_updated = new_link;
1✔
317
         new_link_updated.nonce_or_blind() =
1✔
318
            nonce_from_blind(m_links[0].response(), new_link.nonce_or_blind());  //we need to convert blind to nonce
1✔
319
         m_links.clear();
1✔
320
         m_links.push_back(new_link_updated);
1✔
321
         return;
1✔
322
      }
1✔
323
      if(m_links.size() >= 2) {
1✔
324
         m_links[1].nonce_or_blind() =
1✔
325
            nonce_from_blind(m_links[0].response(), m_links[1].nonce_or_blind());  //we need to convert blind to nonce
1✔
326
      }
327
      m_links.erase(m_links.begin());
1✔
328
   }
329
   m_links.push_back(new_link);
4✔
330
}
331

332
std::string Chain::to_string() const {
4✔
333
   std::string s;
4✔
334
   s.reserve((7 + 1 + 88 + 1 + 44 + 1 + 480) * m_links.size());
4✔
335
   for(const auto& link : m_links) {
11✔
336
      s += "ed25519";
7✔
337
      s += ' ';
7✔
338
      s += base64_encode(link.public_key().get_public_key());
14✔
339
      s += ' ';
7✔
340
      s += base64_encode(link.nonce_or_blind().get_nonce().data(), link.nonce_or_blind().get_nonce().size());
14✔
341
      s += ' ';
7✔
342
      s += base64_encode(link.response());
14✔
343
      s += '\n';
14✔
344
   }
345
   return s;
4✔
346
}
×
347

348
std::vector<uint8_t> online_request(std::string_view uri, const Nonce& nonce, std::chrono::milliseconds timeout) {
6✔
349
   const std::chrono::system_clock::time_point start_time = std::chrono::system_clock::now();
6✔
350
   auto socket = OS::open_socket_udp(uri, timeout);
6✔
351
   if(!socket) {
6✔
352
      throw Not_Implemented("No socket support enabled in build");
×
353
   }
354

355
   const auto encoded = encode_request(nonce);
6✔
356
   socket->write(encoded.data(), encoded.size());
6✔
357

358
   if(std::chrono::system_clock::now() - start_time > timeout) {
6✔
359
      throw System_Error("Timeout during socket write");
×
360
   }
361

362
   std::vector<uint8_t> buffer;
6✔
363
   buffer.resize(360 + 64 * 10 + 1);  //response basic size is 360 bytes + 64 bytes for each level of merkle tree
6✔
364
                                      //add one additional byte to be able to differentiate if datagram got truncated
365
   const auto n = socket->read(buffer.data(), buffer.size());
6✔
366

367
   if(n == 0 || std::chrono::system_clock::now() - start_time > timeout) {
6✔
368
      throw System_Error("Timeout waiting for response");
×
369
   }
370

371
   if(n == buffer.size()) {
6✔
372
      throw System_Error("Buffer too small");
×
373
   }
374

375
   buffer.resize(n);
6✔
376
   return buffer;
6✔
377
}
6✔
378

379
std::vector<Server_Information> servers_from_str(std::string_view str) {
12✔
380
   std::vector<Server_Information> servers;
12✔
381
   std::istringstream ss{std::string(str)};  // FIXME C++23 avoid copy
24✔
382

383
   const std::string ERROR_MESSAGE = "Line does not have at least 5 space separated fields";
12✔
384
   for(std::string s; std::getline(ss, s);) {
20✔
385
      size_t start = 0;
16✔
386
      size_t end = 0;
16✔
387
      end = s.find(' ', start);
16✔
388
      if(end == std::string::npos) {
16✔
389
         throw Decoding_Error(ERROR_MESSAGE);
1✔
390
      }
391
      const auto name = s.substr(start, end - start);
15✔
392

393
      start = end + 1;
15✔
394
      end = s.find(' ', start);
15✔
395
      if(end == std::string::npos) {
15✔
396
         throw Decoding_Error(ERROR_MESSAGE);
1✔
397
      }
398
      const auto publicKeyType = s.substr(start, end - start);
14✔
399
      if(publicKeyType != "ed25519") {
14✔
400
         throw Not_Implemented("Only ed25519 publicKeyType is implemented");
1✔
401
      }
402

403
      start = end + 1;
13✔
404
      end = s.find(' ', start);
13✔
405

406
      if(end == std::string::npos) {
13✔
407
         throw Decoding_Error(ERROR_MESSAGE);
1✔
408
      }
409
      const auto publicKeyBase64 = s.substr(start, end - start);
12✔
410
      const auto publicKey = Ed25519_PublicKey(base64_decode(publicKeyBase64));
16✔
411

412
      start = end + 1;
11✔
413
      end = s.find(' ', start);
11✔
414
      if(end == std::string::npos) {
11✔
415
         throw Decoding_Error(ERROR_MESSAGE);
1✔
416
      }
417
      const auto protocol = s.substr(start, end - start);
10✔
418
      if(protocol != "udp") {
10✔
419
         throw Not_Implemented("Only UDP protocol is implemented");
1✔
420
      }
421

422
      const auto addresses = [&]() {
2✔
423
         std::vector<std::string> addr;
9✔
424
         for(;;) {
9✔
425
            start = end + 1;
9✔
426
            end = s.find(' ', start);
9✔
427
            const auto address = s.substr(start, (end == std::string::npos) ? std::string::npos : end - start);
9✔
428
            if(address.empty()) {
9✔
429
               return addr;
430
            }
431
            addr.push_back(address);
8✔
432
            if(end == std::string::npos) {
8✔
433
               return addr;
434
            }
435
         }
9✔
436
      }();
9✔
437
      if(addresses.empty()) {
9✔
438
         throw Decoding_Error(ERROR_MESSAGE);
1✔
439
      }
440

441
      servers.push_back({name, publicKey, addresses});
16✔
442
   }
37✔
443
   return servers;
8✔
444
}
20✔
445

446
}  // namespace Roughtime
447

448
}  // namespace Botan
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc