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

randombit / botan / 22093983912

17 Feb 2026 10:00AM UTC coverage: 90.027% (-0.001%) from 90.028%
22093983912

push

github

web-flow
Merge pull request #5347 from randombit/jack/tls-header-patrol-2

Changes to reduce dependencies in TLS sources/headers

102345 of 113683 relevant lines covered (90.03%)

11397934.0 hits per line

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

89.32
/src/cli/timing_tests.cpp
1
/*
2
* Timing Analysis Tests
3
*
4
* These tests are not for performance, but verifying that two inputs are not handled
5
* in a way that is vulnerable to simple timing attacks.
6
*
7
* Produces output which can be analyzed with the Mona reporting library
8
*
9
* $ git clone https://github.com/seecurity/mona-timing-report.git
10
* $ cd mona-timing-report && ant
11
* $ java -jar ReportingTool.jar --lowerBound=0.4 --upperBound=0.5 --inputFile=$file --name=$file
12
*
13
* (C) 2016 Juraj Somorovsky - juraj.somorovsky@hackmanit.de
14
* (C) 2017 Neverhub
15
* (C) 2017,2018,2019 Jack Lloyd
16
*
17
* Botan is released under the Simplified BSD License (see license.txt)
18
*/
19

20
#include "cli.h"
21

22
#include <botan/hex.h>
23
#include <botan/rng.h>
24
#include <botan/internal/ct_utils.h>
25
#include <botan/internal/filesystem.h>
26
#include <botan/internal/fmt.h>
27
#include <botan/internal/loadstor.h>
28
#include <botan/internal/parsing.h>
29
#include <botan/internal/target_info.h>
30
#include <chrono>
31
#include <fstream>
32
#include <iostream>
33
#include <sstream>
34

35
#if defined(BOTAN_HAS_BIGINT)
36
   #include <botan/bigint.h>
37
#endif
38

39
#if defined(BOTAN_HAS_NUMBERTHEORY)
40
   #include <botan/numthry.h>
41
   #include <botan/internal/mod_inv.h>
42
#endif
43

44
#if defined(BOTAN_HAS_ECC_GROUP)
45
   #include <botan/ec_group.h>
46
#endif
47

48
#if defined(BOTAN_HAS_DL_GROUP)
49
   #include <botan/dl_group.h>
50
#endif
51

52
#if defined(BOTAN_HAS_PUBLIC_KEY_CRYPTO)
53
   #include <botan/pkcs8.h>
54
   #include <botan/pubkey.h>
55
#endif
56

57
#if defined(BOTAN_HAS_RSA)
58
   #include <botan/rsa.h>
59
#endif
60

61
#if defined(BOTAN_HAS_TLS_CBC)
62
   #include <botan/block_cipher.h>
63
   #include <botan/mac.h>
64
   #include <botan/tls_exceptn.h>
65
   #include <botan/tls_version.h>
66
   #include <botan/internal/tls_cbc.h>
67
#endif
68

69
#if defined(BOTAN_HAS_ECDSA)
70
   #include <botan/ecdsa.h>
71
#endif
72

73
#if defined(BOTAN_HAS_SYSTEM_RNG)
74
   #include <botan/system_rng.h>
75
#endif
76

77
#if defined(BOTAN_HAS_CHACHA_RNG)
78
   #include <botan/chacha_rng.h>
79
#endif
80

81
#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
82
   #include <signal.h>
83
   #include <stdlib.h>
84
#endif
85

86
namespace Botan_CLI {
87

88
namespace {
89

90
class TimingTestTimer {
91
   public:
92
      TimingTestTimer() : m_start(get_high_resolution_clock()) {}
641✔
93

94
      uint64_t complete() const { return get_high_resolution_clock() - m_start; }
1,282✔
95

96
   private:
97
      static uint64_t get_high_resolution_clock() {
1,282✔
98
         // TODO use cpu clock where possible/relevant incl serializing instructions
99
         auto now = std::chrono::high_resolution_clock::now().time_since_epoch();
1,206✔
100
         return std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
1,282✔
101
      }
102

103
      uint64_t m_start;
104
};
105

106
}  // namespace
107

108
class Timing_Test {
109
   public:
110
      Timing_Test() {
10✔
111
         /*
112
         A constant seed is ok here since the timing test rng just needs to be
113
         "random" but not cryptographically secure - even std::rand() would be ok.
114
         */
115
         const std::string drbg_seed(64, 'A');
10✔
116
         m_rng = cli_make_rng("", drbg_seed);  // throws if it can't find anything to use
10✔
117
      }
10✔
118

119
      virtual ~Timing_Test() = default;
×
120

121
      Timing_Test(const Timing_Test& other) = delete;
122
      Timing_Test(Timing_Test&& other) = delete;
123
      Timing_Test& operator=(const Timing_Test& other) = delete;
124
      Timing_Test& operator=(Timing_Test&& other) = delete;
125

126
      std::vector<std::vector<uint64_t>> execute_evaluation(const std::vector<std::string>& inputs,
127
                                                            size_t warmup_runs,
128
                                                            size_t measurement_runs);
129

130
      virtual std::vector<uint8_t> prepare_input(const std::string& input) { return Botan::hex_decode(input); }
9✔
131

132
      virtual uint64_t measure_critical_function(const std::vector<uint8_t>& input) = 0;
133

134
   protected:
135
      Botan::RandomNumberGenerator& timing_test_rng() { return (*m_rng); }
2✔
136

137
   private:
138
      std::shared_ptr<Botan::RandomNumberGenerator> m_rng;
139
};
140

141
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_EME_PKCS1) && defined(BOTAN_HAS_EME_RAW)
142

143
class Bleichenbacker_Timing_Test final : public Timing_Test {
×
144
   public:
145
      explicit Bleichenbacker_Timing_Test(size_t keysize) :
1✔
146
            m_privkey(timing_test_rng(), keysize),
1✔
147
            m_pubkey(m_privkey.public_key()),
1✔
148
            m_enc(*m_pubkey, timing_test_rng(), "Raw"),
1✔
149
            m_dec(m_privkey, timing_test_rng(), "PKCS1v15") {}
2✔
150

151
      std::vector<uint8_t> prepare_input(const std::string& input) override {
4✔
152
         const std::vector<uint8_t> input_vector = Botan::hex_decode(input);
4✔
153
         return m_enc.encrypt(input_vector, timing_test_rng());
4✔
154
      }
4✔
155

156
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override {
76✔
157
         const TimingTestTimer timer;
76✔
158
         m_dec.decrypt_or_random(input.data(), m_ctext_length, m_expected_content_size, timing_test_rng());
76✔
159
         return timer.complete();
76✔
160
      }
161

162
   private:
163
      const size_t m_expected_content_size = 48;
164
      const size_t m_ctext_length = 256;
165
      Botan::RSA_PrivateKey m_privkey;
166
      std::unique_ptr<Botan::Public_Key> m_pubkey;
167
      Botan::PK_Encryptor_EME m_enc;
168
      Botan::PK_Decryptor_EME m_dec;
169
};
170

171
#endif
172

173
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_EME_OAEP) && defined(BOTAN_HAS_EME_RAW)
174

175
/*
176
* Test Manger OAEP side channel
177
*
178
* "A Chosen Ciphertext Attack on RSA Optimal Asymmetric Encryption
179
* Padding (OAEP) as Standardized in PKCS #1 v2.0" James Manger
180
* http://archiv.infsec.ethz.ch/education/fs08/secsem/Manger01.pdf
181
*/
182
class Manger_Timing_Test final : public Timing_Test {
×
183
   public:
184
      explicit Manger_Timing_Test(size_t keysize) :
1✔
185
            m_privkey(timing_test_rng(), keysize),
1✔
186
            m_pubkey(m_privkey.public_key()),
1✔
187
            m_enc(*m_pubkey, timing_test_rng(), m_encrypt_padding),
1✔
188
            m_dec(m_privkey, timing_test_rng(), m_decrypt_padding) {}
2✔
189

190
      std::vector<uint8_t> prepare_input(const std::string& input) override {
2✔
191
         const std::vector<uint8_t> input_vector = Botan::hex_decode(input);
2✔
192
         return m_enc.encrypt(input_vector, timing_test_rng());
2✔
193
      }
2✔
194

195
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override {
38✔
196
         const TimingTestTimer timer;
38✔
197
         try {
38✔
198
            m_dec.decrypt(input.data(), m_ctext_length);
38✔
199
         } catch(Botan::Decoding_Error&) {}
38✔
200
         return timer.complete();
38✔
201
      }
202

203
   private:
204
      const std::string m_encrypt_padding = "Raw";
205
      const std::string m_decrypt_padding = "EME1(SHA-256)";
206
      const size_t m_ctext_length = 256;
207
      Botan::RSA_PrivateKey m_privkey;
208
      std::unique_ptr<Botan::Public_Key> m_pubkey;
209
      Botan::PK_Encryptor_EME m_enc;
210
      Botan::PK_Decryptor_EME m_dec;
211
};
212

213
#endif
214

215
#if defined(BOTAN_HAS_TLS_CBC)
216

217
/*
218
* Test handling of countermeasure to the Lucky13 attack
219
*/
220
class Lucky13_Timing_Test final : public Timing_Test {
×
221
   public:
222
      Lucky13_Timing_Test(const std::string& mac_name, size_t mac_keylen) :
4✔
223
            m_mac_algo(mac_name),
8✔
224
            m_mac_keylen(mac_keylen),
4✔
225
            m_dec(Botan::BlockCipher::create_or_throw("AES-128"),
12✔
226
                  Botan::MessageAuthenticationCode::create_or_throw("HMAC(" + m_mac_algo + ")"),
12✔
227
                  16,
228
                  m_mac_keylen,
4✔
229
                  Botan::TLS::Protocol_Version::TLS_V12,
230
                  false) {}
8✔
231

232
      std::vector<uint8_t> prepare_input(const std::string& input) override;
233
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
234

235
   private:
236
      const std::string m_mac_algo;
237
      const size_t m_mac_keylen;
238
      Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption m_dec;
239
};
240

241
std::vector<uint8_t> Lucky13_Timing_Test::prepare_input(const std::string& input) {
12✔
242
   const std::vector<uint8_t> input_vector = Botan::hex_decode(input);
12✔
243
   const std::vector<uint8_t> key(16);
12✔
244
   const std::vector<uint8_t> iv(16);
12✔
245

246
   auto enc = Botan::Cipher_Mode::create("AES-128/CBC/NoPadding", Botan::Cipher_Dir::Encryption);
12✔
247
   enc->set_key(key);
12✔
248
   enc->start(iv);
12✔
249
   Botan::secure_vector<uint8_t> buf(input_vector.begin(), input_vector.end());
12✔
250
   enc->finish(buf);
12✔
251

252
   return unlock(buf);
12✔
253
}
60✔
254

255
uint64_t Lucky13_Timing_Test::measure_critical_function(const std::vector<uint8_t>& input) {
228✔
256
   Botan::secure_vector<uint8_t> data(input.begin(), input.end());
228✔
257
   Botan::secure_vector<uint8_t> aad(13);
228✔
258
   const Botan::secure_vector<uint8_t> iv(16);
228✔
259
   const Botan::secure_vector<uint8_t> key(16 + m_mac_keylen);
228✔
260

261
   m_dec.set_key(unlock(key));
228✔
262
   m_dec.set_associated_data(aad);
228✔
263
   m_dec.start(unlock(iv));
228✔
264

265
   const TimingTestTimer timer;
228✔
266
   try {
228✔
267
      m_dec.finish(data);
228✔
268
   } catch(Botan::TLS::TLS_Exception&) {}
228✔
269
   return timer.complete();
228✔
270
}
912✔
271

272
#endif
273

274
#if defined(BOTAN_HAS_ECDSA)
275

276
class ECDSA_Timing_Test final : public Timing_Test {
×
277
   public:
278
      explicit ECDSA_Timing_Test(const std::string& ecgroup);
279

280
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
281

282
   private:
283
      const Botan::EC_Group m_group;
284
      const Botan::ECDSA_PrivateKey m_privkey;
285
      const Botan::EC_Scalar m_x;
286
      Botan::EC_Scalar m_b;
287
      Botan::EC_Scalar m_b_inv;
288
};
289

290
ECDSA_Timing_Test::ECDSA_Timing_Test(const std::string& ecgroup) :
1✔
291
      m_group(Botan::EC_Group::from_name(ecgroup)),
1✔
292
      m_privkey(timing_test_rng(), m_group),
1✔
293
      m_x(m_privkey._private_key()),
1✔
294
      m_b(Botan::EC_Scalar::random(m_group, timing_test_rng())),
1✔
295
      m_b_inv(m_b.invert()) {}
2✔
296

297
uint64_t ECDSA_Timing_Test::measure_critical_function(const std::vector<uint8_t>& input) {
38✔
298
   const auto k = Botan::EC_Scalar::from_bytes_with_trunc(m_group, input);
38✔
299
   // fixed message to minimize noise
300
   const auto m = Botan::EC_Scalar::from_bytes_with_trunc(m_group, std::vector<uint8_t>{5});
38✔
301

302
   const TimingTestTimer timer;
38✔
303

304
   // the following ECDSA operations involve and should not leak any information about k
305
   const auto r = Botan::EC_Scalar::gk_x_mod_order(k, timing_test_rng());
38✔
306
   const auto k_inv = k.invert();
38✔
307
   m_b.square_self();
38✔
308
   m_b_inv.square_self();
38✔
309
   const auto xr_m = ((m_x * m_b) * r) + (m * m_b);
38✔
310
   const auto s = (k_inv * xr_m) * m_b_inv;
38✔
311
   BOTAN_UNUSED(r, s);
38✔
312

313
   return timer.complete();
76✔
314
}
38✔
315

316
#endif
317

318
#if defined(BOTAN_HAS_ECC_GROUP)
319

320
class ECC_Mul_Timing_Test final : public Timing_Test {
×
321
   public:
322
      explicit ECC_Mul_Timing_Test(std::string_view ecgroup) : m_group(Botan::EC_Group::from_name(ecgroup)) {}
1✔
323

324
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
325

326
   private:
327
      const Botan::EC_Group m_group;
328
};
329

330
uint64_t ECC_Mul_Timing_Test::measure_critical_function(const std::vector<uint8_t>& input) {
38✔
331
   const auto k = Botan::EC_Scalar::from_bytes_with_trunc(m_group, input);
38✔
332

333
   const TimingTestTimer timer;
38✔
334
   const auto kG = Botan::EC_AffinePoint::g_mul(k, timing_test_rng());
38✔
335
   return timer.complete();
76✔
336
}
38✔
337

338
#endif
339

340
#if defined(BOTAN_HAS_DL_GROUP)
341

342
class Powmod_Timing_Test final : public Timing_Test {
×
343
   public:
344
      explicit Powmod_Timing_Test(std::string_view dl_group) : m_group(Botan::DL_Group::from_name(dl_group)) {}
1✔
345

346
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
347

348
   private:
349
      Botan::DL_Group m_group;
350
};
351

352
uint64_t Powmod_Timing_Test::measure_critical_function(const std::vector<uint8_t>& input) {
57✔
353
   const Botan::BigInt x(input.data(), input.size());
57✔
354
   const size_t max_x_bits = m_group.p_bits();
57✔
355

356
   const TimingTestTimer timer;
57✔
357

358
   const Botan::BigInt g_x_p = m_group.power_g_p(x, max_x_bits);
57✔
359

360
   return timer.complete();
114✔
361
}
57✔
362

363
#endif
364

365
#if defined(BOTAN_HAS_NUMBERTHEORY)
366

367
class Invmod_Timing_Test final : public Timing_Test {
×
368
   public:
369
      explicit Invmod_Timing_Test(size_t p_bits) { m_p = Botan::random_prime(timing_test_rng(), p_bits); }
2✔
370

371
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
372

373
   private:
374
      Botan::BigInt m_p;
375
};
376

377
uint64_t Invmod_Timing_Test::measure_critical_function(const std::vector<uint8_t>& input) {
38✔
378
   const Botan::BigInt k(input.data(), input.size());
38✔
379

380
   const TimingTestTimer timer;
38✔
381
   const Botan::BigInt inv = Botan::inverse_mod_secret_prime(k, m_p);
38✔
382
   return timer.complete();
76✔
383
}
38✔
384

385
#endif
386

387
std::vector<std::vector<uint64_t>> Timing_Test::execute_evaluation(const std::vector<std::string>& raw_inputs,
10✔
388
                                                                   size_t warmup_runs,
389
                                                                   size_t measurement_runs) {
390
   std::vector<std::vector<uint64_t>> all_results(raw_inputs.size());
10✔
391
   std::vector<std::vector<uint8_t>> inputs(raw_inputs.size());
10✔
392

393
   for(auto& result : all_results) {
37✔
394
      result.reserve(measurement_runs);
27✔
395
   }
396

397
   for(size_t i = 0; i != inputs.size(); ++i) {
37✔
398
      inputs[i] = prepare_input(raw_inputs[i]);
27✔
399
   }
400

401
   // arbitrary upper bounds of 1 and 10 million resp
402
   if(warmup_runs > 1000000 || measurement_runs > 100000000) {
10✔
403
      throw CLI_Error("Requested execution counts too large, rejecting");
×
404
   }
405

406
   size_t total_runs = 0;
10✔
407
   std::vector<uint64_t> results(inputs.size());
10✔
408

409
   while(total_runs < (warmup_runs + measurement_runs)) {
200✔
410
      for(size_t i = 0; i != inputs.size(); ++i) {
703✔
411
         results[i] = measure_critical_function(inputs[i]);
513✔
412
      }
413

414
      total_runs++;
190✔
415

416
      if(total_runs > warmup_runs) {
190✔
417
         for(size_t i = 0; i != results.size(); ++i) {
592✔
418
            all_results[i].push_back(results[i]);
432✔
419
         }
420
      }
421
   }
422

423
   return all_results;
10✔
424
}
10✔
425

426
class Timing_Test_Command final : public Command {
427
   public:
428
      Timing_Test_Command() :
11✔
429
            Command(
430
               "timing_test test_type --test-data-file= --test-data-dir=src/tests/data/timing "
431
               "--warmup-runs=5000 --measurement-runs=50000") {}
22✔
432

433
      std::string group() const override { return "testing"; }
1✔
434

435
      std::string description() const override { return "Run various timing side channel tests"; }
1✔
436

437
      void go() override {
10✔
438
         const std::string test_type = get_arg("test_type");
10✔
439
         const size_t warmup_runs = get_arg_sz("warmup-runs");
10✔
440
         const size_t measurement_runs = get_arg_sz("measurement-runs");
10✔
441

442
         std::unique_ptr<Timing_Test> test = lookup_timing_test(test_type);
10✔
443

444
         if(!test) {
10✔
445
            throw CLI_Error("Unknown or unavailable test type '" + test_type + "'");
×
446
         }
447

448
         std::string filename = get_arg_or("test-data-file", "");
20✔
449

450
         if(filename.empty()) {
10✔
451
            const std::string test_data_dir = get_arg("test-data-dir");
10✔
452
            filename = test_data_dir + "/" + test_type + ".vec";
20✔
453
         }
10✔
454

455
         const std::vector<std::string> lines = read_testdata(filename);
10✔
456

457
         std::vector<std::vector<uint64_t>> results = test->execute_evaluation(lines, warmup_runs, measurement_runs);
10✔
458

459
         size_t unique_id = 0;
10✔
460
         std::ostringstream oss;
10✔
461
         for(size_t secret_id = 0; secret_id != results.size(); ++secret_id) {
37✔
462
            for(size_t i = 0; i != results[secret_id].size(); ++i) {
459✔
463
               oss << unique_id++ << ";" << secret_id << ";" << results[secret_id][i] << "\n";
432✔
464
            }
465
         }
466

467
         output() << oss.str();
10✔
468
      }
20✔
469

470
   private:
471
      static std::vector<std::string> read_testdata(const std::string& filename) {
10✔
472
         std::vector<std::string> lines;
10✔
473
         std::ifstream infile(filename);
10✔
474
         if(!infile.good()) {
10✔
475
            throw CLI_Error("Error reading test data from '" + filename + "'");
×
476
         }
477
         std::string line;
10✔
478
         while(std::getline(infile, line)) {
70✔
479
            if(!line.empty() && line.at(0) != '#') {
60✔
480
               lines.push_back(line);
27✔
481
            }
482
         }
483
         return lines;
20✔
484
      }
10✔
485

486
      static std::unique_ptr<Timing_Test> lookup_timing_test(std::string_view test_type);
487

488
      std::string help_text() const override {
×
489
         // TODO check feature macros
490
         return (Command::help_text() +
×
491
                 "\ntest_type can take on values "
492
                 "bleichenbacher "
493
                 "manger "
494
                 "ecdsa "
495
                 "ecc_mul "
496
                 "inverse_mod "
497
                 "pow_mod "
498
                 "lucky13sec3 "
499
                 "lucky13sec4sha1 "
500
                 "lucky13sec4sha256 "
501
                 "lucky13sec4sha384 ");
×
502
      }
503
};
504

505
std::unique_ptr<Timing_Test> Timing_Test_Command::lookup_timing_test(std::string_view test_type) {
10✔
506
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_EME_PKCS1) && defined(BOTAN_HAS_EME_RAW)
507
   if(test_type == "bleichenbacher") {
10✔
508
      return std::make_unique<Bleichenbacker_Timing_Test>(2048);
1✔
509
   }
510
#endif
511

512
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_EME_OAEP) && defined(BOTAN_HAS_EME_RAW)
513
   if(test_type == "manger") {
9✔
514
      return std::make_unique<Manger_Timing_Test>(2048);
1✔
515
   }
516
#endif
517

518
#if defined(BOTAN_HAS_ECDSA)
519
   if(test_type == "ecdsa") {
8✔
520
      return std::make_unique<ECDSA_Timing_Test>("secp384r1");
1✔
521
   }
522
#endif
523

524
#if defined(BOTAN_HAS_ECC_GROUP)
525
   if(test_type == "ecc_mul") {
7✔
526
      return std::make_unique<ECC_Mul_Timing_Test>("brainpool512r1");
1✔
527
   }
528
#endif
529

530
#if defined(BOTAN_HAS_NUMBERTHEORY)
531
   if(test_type == "inverse_mod") {
6✔
532
      return std::make_unique<Invmod_Timing_Test>(512);
1✔
533
   }
534
#endif
535

536
#if defined(BOTAN_HAS_DL_GROUP)
537
   if(test_type == "pow_mod") {
5✔
538
      return std::make_unique<Powmod_Timing_Test>("modp/ietf/1024");
1✔
539
   }
540
#endif
541

542
#if defined(BOTAN_HAS_TLS_CBC)
543
   if(test_type == "lucky13sec3" || test_type == "lucky13sec4sha1") {
6✔
544
      return std::make_unique<Lucky13_Timing_Test>("SHA-1", 20);
2✔
545
   }
546
   if(test_type == "lucky13sec4sha256") {
2✔
547
      return std::make_unique<Lucky13_Timing_Test>("SHA-256", 32);
1✔
548
   }
549
   if(test_type == "lucky13sec4sha384") {
1✔
550
      return std::make_unique<Lucky13_Timing_Test>("SHA-384", 48);
1✔
551
   }
552
#endif
553

554
   BOTAN_UNUSED(test_type);
×
555

556
   return nullptr;
×
557
}
558

559
BOTAN_REGISTER_COMMAND("timing_test", Timing_Test_Command);
11✔
560

561
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_EME_PKCS1) && defined(BOTAN_TARGET_OS_HAS_FILESYSTEM) && \
562
   defined(BOTAN_HAS_SYSTEM_RNG)
563

564
class MARVIN_Test_Command final : public Command {
565
   public:
566
      MARVIN_Test_Command() :
2✔
567
            Command("marvin_test key_file ctext_dir --runs=1K --report-every=0 --output-nsec --expect-pt-len=0") {}
4✔
568

569
      std::string group() const override { return "testing"; }
1✔
570

571
      std::string description() const override { return "Run a test for MARVIN attack"; }
1✔
572

573
   #if defined(BOTAN_TARGET_OS_HAS_POSIX1)
574
      static inline volatile sig_atomic_t g_sigint_recv = 0;
575

576
      static void marvin_sigint_handler(int /*signal*/) { g_sigint_recv = 1; }
×
577
   #endif
578

579
      void go() override {
1✔
580
         const std::string key_file = get_arg("key_file");
1✔
581
         const std::string ctext_dir = get_arg("ctext_dir");
1✔
582
         const size_t measurement_runs = parse_runs_arg(get_arg("runs"));
1✔
583
         const size_t expect_pt_len = get_arg_sz("expect-pt-len");
1✔
584
         const size_t report_every = get_arg_sz("report-every");
1✔
585
         const bool output_nsec = flag_set("output-nsec");
1✔
586

587
   #if defined(BOTAN_TARGET_OS_HAS_POSIX1)
588
         ::setenv("BOTAN_THREAD_POOL_SIZE", "none", /*overwrite?*/ 1);
1✔
589

590
         struct sigaction sigaction {};
1✔
591

592
         sigaction.sa_handler = marvin_sigint_handler;
1✔
593
         sigemptyset(&sigaction.sa_mask);
1✔
594
         sigaction.sa_flags = 0;
1✔
595

596
         const int rc = ::sigaction(SIGINT, &sigaction, nullptr);
1✔
597
         if(rc != 0) {
1✔
598
            throw CLI_Error("Failed to set SIGINT handler");
×
599
         }
600
   #endif
601

602
         Botan::DataSource_Stream key_src(key_file);
1✔
603
         const auto key = Botan::PKCS8::load_key(key_src);
1✔
604

605
         if(key->algo_name() != "RSA") {
1✔
606
            throw CLI_Usage_Error("Unexpected key type for MARVIN test");
×
607
         }
608

609
         const size_t modulus_bytes = (key->key_length() + 7) / 8;
1✔
610

611
         std::vector<std::string> names;
1✔
612
         std::vector<uint8_t> ciphertext_data;
1✔
613

614
         for(const auto& filename : Botan::get_files_recursive(ctext_dir)) {
5✔
615
            const auto contents = this->slurp_file(filename);
4✔
616

617
            if(contents.size() != modulus_bytes) {
4✔
618
               throw CLI_Usage_Error(
×
619
                  Botan::fmt("The ciphertext file {} had different size ({}) than the RSA modulus ({})",
×
620
                             filename,
621
                             contents.size(),
×
622
                             modulus_bytes));
×
623
            }
624

625
            const auto parts = Botan::split_on(filename, '/');
4✔
626

627
            names.push_back(parts[parts.size() - 1]);
4✔
628
            ciphertext_data.insert(ciphertext_data.end(), contents.begin(), contents.end());
4✔
629
         }
9✔
630

631
         if(names.empty()) {
1✔
632
            throw CLI_Usage_Error("Empty ciphertext directory for MARVIN test");
×
633
         }
634

635
         auto& test_results_file = output();
1✔
636

637
         const size_t testcases = names.size();
1✔
638

639
   #if defined(BOTAN_HAS_CHACHA_RNG)
640
         auto rng = Botan::ChaCha_RNG(Botan::system_rng());
1✔
641
   #else
642
         auto& rng = Botan::system_rng();
643
   #endif
644

645
         const Botan::PK_Decryptor_EME op(*key, rng, "PKCS1v15");
1✔
646

647
         std::vector<size_t> indexes;
1✔
648
         for(size_t i = 0; i != testcases; ++i) {
5✔
649
            indexes.push_back(i);
4✔
650
         }
651

652
         std::vector<std::vector<uint64_t>> measurements(testcases);
1✔
653
         for(auto& m : measurements) {
5✔
654
            m.reserve(measurement_runs);
4✔
655
         }
656

657
         // This is only set differently if we exit early from the loop
658
         size_t runs_completed = measurement_runs;
1✔
659

660
         std::vector<uint8_t> ciphertext(modulus_bytes);
1✔
661

662
         for(size_t r = 0; r != measurement_runs; ++r) {
33✔
663
            if(r > 0 && report_every > 0 && (r % report_every) == 0) {
32✔
664
               std::cerr << "Gathering sample # " << r << "\n";
×
665
            }
666

667
            shuffle(indexes, rng);
32✔
668

669
            for(const size_t testcase : indexes) {
160✔
670
               // Load the test ciphertext in constant time to avoid cache pollution
671
               for(size_t j = 0; j != testcases; ++j) {
640✔
672
                  const auto j_eq_testcase = Botan::CT::Mask<size_t>::is_equal(j, testcase).as_choice();
512✔
673
                  const auto* testcase_j = &ciphertext_data[j * modulus_bytes];
512✔
674
                  Botan::CT::conditional_assign_mem(j_eq_testcase, ciphertext.data(), testcase_j, modulus_bytes);
1,024✔
675
               }
676

677
               const TimingTestTimer timer;
128✔
678
               op.decrypt_or_random(ciphertext.data(), modulus_bytes, expect_pt_len, rng);
128✔
679
               const uint64_t duration = timer.complete();
128✔
680
               BOTAN_ASSERT_NOMSG(measurements[testcase].size() == r);
128✔
681
               measurements[testcase].push_back(duration);
128✔
682
            }
683

684
   #if defined(BOTAN_TARGET_OS_HAS_POSIX1)
685
            // Early exit check
686
            if(g_sigint_recv != 0) {
32✔
687
               std::cerr << "Exiting early after " << r << " measurements\n";
×
688
               runs_completed = r;
689
               break;
690
            }
691
   #endif
692
         }
693

694
         report_results(test_results_file, names, measurements, runs_completed, output_nsec);
1✔
695
      }
3✔
696

697
   private:
698
      static void report_results(std::ostream& output,
1✔
699
                                 std::span<const std::string> names,
700
                                 std::span<const std::vector<uint64_t>> measurements,
701
                                 size_t runs_completed,
702
                                 bool output_nsec) {
703
         for(size_t t = 0; t != names.size(); ++t) {
5✔
704
            if(t > 0) {
4✔
705
               output << ",";
3✔
706
            }
707
            output << names[t];
4✔
708
         }
709
         output << "\n";
1✔
710

711
         for(size_t r = 0; r != runs_completed; ++r) {
33✔
712
            for(size_t t = 0; t != names.size(); ++t) {
160✔
713
               if(t > 0) {
128✔
714
                  output << ",";
96✔
715
               }
716

717
               const uint64_t dur_nsec = measurements[t][r];
128✔
718
               if(output_nsec) {
128✔
719
                  output << dur_nsec;
×
720
               } else {
721
                  const double dur_s = static_cast<double>(dur_nsec) / 1000000000.0;
128✔
722
                  output << dur_s;
128✔
723
               }
724
            }
725
            output << "\n";
32✔
726
         }
727
      }
1✔
728

729
      static size_t parse_runs_arg(const std::string& param) {
1✔
730
         if(param.starts_with("-")) {
1✔
731
            throw CLI_Usage_Error("Cannot have a negative run count");
×
732
         }
733

734
         if(param.ends_with("m") || param.ends_with("M")) {
1✔
735
            return parse_runs_arg(param.substr(0, param.size() - 1)) * 1'000'000;
×
736
         } else if(param.ends_with("k") || param.ends_with("K")) {
1✔
737
            return parse_runs_arg(param.substr(0, param.size() - 1)) * 1'000;
×
738
         } else {
739
            try {
1✔
740
               return static_cast<size_t>(std::stoul(param));
1✔
741
            } catch(std::exception&) {
×
742
               throw CLI_Usage_Error("Unexpected syntax for --runs option (try 1000, 1K, or 2M)");
×
743
            }
×
744
         }
745
      }
746

747
      template <typename T>
748
      void shuffle(std::vector<T>& vec, Botan::RandomNumberGenerator& rng) {
32✔
749
         const size_t n = vec.size();
32✔
750
         for(size_t i = 0; i != n; ++i) {
160✔
751
            uint8_t jb[sizeof(uint64_t)];
752
            rng.randomize(jb, sizeof(jb));
128✔
753
            const uint64_t j8 = Botan::load_le<uint64_t>(jb, 0);
128✔
754
            const size_t j = i + static_cast<size_t>(j8) % (n - i);
128✔
755
            std::swap(vec[i], vec[j]);
128✔
756
         }
757
      }
32✔
758
};
759

760
BOTAN_REGISTER_COMMAND("marvin_test", MARVIN_Test_Command);
2✔
761

762
#endif
763

764
}  // namespace Botan_CLI
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