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

randombit / botan / 24014286417

06 Apr 2026 12:48AM UTC coverage: 89.453% (-0.001%) from 89.454%
24014286417

Pull #5521

github

web-flow
Merge 2fb3a6cd7 into 417709dd7
Pull Request #5521: Rollup of small fixes

105877 of 118360 relevant lines covered (89.45%)

11453159.57 hits per line

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

89.22
/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_SYSTEM_RNG)
70
   #include <botan/system_rng.h>
71
#endif
72

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

77
#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
78
   #include <signal.h>
79
   #include <stdlib.h>
80
#endif
81

82
namespace Botan_CLI {
83

84
namespace {
85

86
class TimingTestTimer {
87
   public:
88
      TimingTestTimer() : m_start(get_high_resolution_clock()) {}
641✔
89

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

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

99
      uint64_t m_start;
100
};
101

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

113
      virtual ~Timing_Test() = default;
×
114

115
      Timing_Test(const Timing_Test& other) = delete;
116
      Timing_Test(Timing_Test&& other) = delete;
117
      Timing_Test& operator=(const Timing_Test& other) = delete;
118
      Timing_Test& operator=(Timing_Test&& other) = delete;
119

120
      std::vector<std::vector<uint64_t>> execute_evaluation(const std::vector<std::string>& inputs,
121
                                                            size_t warmup_runs,
122
                                                            size_t measurement_runs);
123

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

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

128
   protected:
129
      Botan::RandomNumberGenerator& timing_test_rng() { return (*m_rng); }
2✔
130

131
   private:
132
      std::shared_ptr<Botan::RandomNumberGenerator> m_rng;
133
};
134

135
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_EME_PKCS1) && defined(BOTAN_HAS_EME_RAW)
136

137
class Bleichenbacker_Timing_Test final : public Timing_Test {
×
138
   public:
139
      explicit Bleichenbacker_Timing_Test(size_t keysize) :
1✔
140
            m_privkey(timing_test_rng(), keysize),
1✔
141
            m_pubkey(m_privkey.public_key()),
1✔
142
            m_enc(*m_pubkey, timing_test_rng(), "Raw"),
1✔
143
            m_dec(m_privkey, timing_test_rng(), "PKCS1v15") {}
2✔
144

145
      std::vector<uint8_t> prepare_input(const std::string& input) override {
4✔
146
         const std::vector<uint8_t> input_vector = Botan::hex_decode(input);
4✔
147
         return m_enc.encrypt(input_vector, timing_test_rng());
4✔
148
      }
4✔
149

150
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override {
76✔
151
         const TimingTestTimer timer;
76✔
152
         m_dec.decrypt_or_random(input.data(), m_ctext_length, m_expected_content_size, timing_test_rng());
76✔
153
         return timer.complete();
76✔
154
      }
155

156
   private:
157
      const size_t m_expected_content_size = 48;
158
      const size_t m_ctext_length = 256;
159
      Botan::RSA_PrivateKey m_privkey;
160
      std::unique_ptr<Botan::Public_Key> m_pubkey;
161
      Botan::PK_Encryptor_EME m_enc;
162
      Botan::PK_Decryptor_EME m_dec;
163
};
164

165
#endif
166

167
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_EME_OAEP) && defined(BOTAN_HAS_EME_RAW)
168

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

184
      std::vector<uint8_t> prepare_input(const std::string& input) override {
2✔
185
         const std::vector<uint8_t> input_vector = Botan::hex_decode(input);
2✔
186
         return m_enc.encrypt(input_vector, timing_test_rng());
2✔
187
      }
2✔
188

189
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override {
38✔
190
         const TimingTestTimer timer;
38✔
191
         try {
38✔
192
            m_dec.decrypt(input.data(), m_ctext_length);
38✔
193
         } catch(Botan::Decoding_Error&) {}
38✔
194
         return timer.complete();
38✔
195
      }
196

197
   private:
198
      const std::string m_encrypt_padding = "Raw";
199
      const std::string m_decrypt_padding = "EME1(SHA-256)";
200
      const size_t m_ctext_length = 256;
201
      Botan::RSA_PrivateKey m_privkey;
202
      std::unique_ptr<Botan::Public_Key> m_pubkey;
203
      Botan::PK_Encryptor_EME m_enc;
204
      Botan::PK_Decryptor_EME m_dec;
205
};
206

207
#endif
208

209
#if defined(BOTAN_HAS_TLS_CBC)
210

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

226
      std::vector<uint8_t> prepare_input(const std::string& input) override;
227
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
228

229
   private:
230
      const std::string m_mac_algo;
231
      const size_t m_mac_keylen;
232
      Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption m_dec;
233
};
234

235
std::vector<uint8_t> Lucky13_Timing_Test::prepare_input(const std::string& input) {
12✔
236
   const std::vector<uint8_t> input_vector = Botan::hex_decode(input);
12✔
237
   const std::vector<uint8_t> key(16);
12✔
238
   const std::vector<uint8_t> iv(16);
12✔
239

240
   auto enc = Botan::Cipher_Mode::create("AES-128/CBC/NoPadding", Botan::Cipher_Dir::Encryption);
12✔
241
   enc->set_key(key);
12✔
242
   enc->start(iv);
12✔
243
   Botan::secure_vector<uint8_t> buf(input_vector.begin(), input_vector.end());
12✔
244
   enc->finish(buf);
12✔
245

246
   return unlock(buf);
12✔
247
}
60✔
248

249
uint64_t Lucky13_Timing_Test::measure_critical_function(const std::vector<uint8_t>& input) {
228✔
250
   Botan::secure_vector<uint8_t> data(input.begin(), input.end());
228✔
251
   Botan::secure_vector<uint8_t> aad(13);
228✔
252
   const Botan::secure_vector<uint8_t> iv(16);
228✔
253
   const Botan::secure_vector<uint8_t> key(16 + m_mac_keylen);
228✔
254

255
   m_dec.set_key(unlock(key));
228✔
256
   m_dec.set_associated_data(aad);
228✔
257
   m_dec.start(unlock(iv));
228✔
258

259
   const TimingTestTimer timer;
228✔
260
   try {
228✔
261
      m_dec.finish(data);
228✔
262
   } catch(Botan::TLS::TLS_Exception&) {}
228✔
263
   return timer.complete();
228✔
264
}
912✔
265

266
#endif
267

268
#if defined(BOTAN_HAS_ECDSA)
269

270
class ECDSA_Timing_Test final : public Timing_Test {
×
271
   public:
272
      explicit ECDSA_Timing_Test(const std::string& ecgroup);
273

274
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
275

276
   private:
277
      const Botan::EC_Group m_group;
278
      const Botan::EC_Scalar m_x;
279
      Botan::EC_Scalar m_b;
280
};
281

282
ECDSA_Timing_Test::ECDSA_Timing_Test(const std::string& ecgroup) :
1✔
283
      m_group(Botan::EC_Group::from_name(ecgroup)),
1✔
284
      m_x(Botan::EC_Scalar::random(m_group, timing_test_rng())),
1✔
285
      m_b(Botan::EC_Scalar::random(m_group, timing_test_rng())) {}
2✔
286

287
uint64_t ECDSA_Timing_Test::measure_critical_function(const std::vector<uint8_t>& input) {
38✔
288
   const auto k = Botan::EC_Scalar::from_bytes_with_trunc(m_group, input);
38✔
289
   // fixed message to minimize noise
290
   const auto m = Botan::EC_Scalar::from_bytes_with_trunc(m_group, std::vector<uint8_t>{5});
38✔
291

292
   const TimingTestTimer timer;
38✔
293

294
   // the following ECDSA operations involve and should not leak any information about k
295

296
   const auto r = Botan::EC_Scalar::gk_x_mod_order(k, timing_test_rng());
38✔
297

298
   const auto k_inv = (m_b * k).invert();
38✔
299

300
   const auto xr_m = ((m_x * m_b) * r) + (m * m_b);
38✔
301

302
   const auto s = (k_inv * xr_m);
38✔
303

304
   // Generate the next blinding value via modular squaring
305
   m_b.square_self();
38✔
306

307
   BOTAN_UNUSED(r, s);
38✔
308

309
   return timer.complete();
76✔
310
}
38✔
311

312
#endif
313

314
#if defined(BOTAN_HAS_ECC_GROUP)
315

316
class ECC_Mul_Timing_Test final : public Timing_Test {
×
317
   public:
318
      explicit ECC_Mul_Timing_Test(std::string_view ecgroup) : m_group(Botan::EC_Group::from_name(ecgroup)) {}
1✔
319

320
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
321

322
   private:
323
      const Botan::EC_Group m_group;
324
};
325

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

329
   const TimingTestTimer timer;
38✔
330
   const auto kG = Botan::EC_AffinePoint::g_mul(k, timing_test_rng());
38✔
331
   return timer.complete();
76✔
332
}
38✔
333

334
#endif
335

336
#if defined(BOTAN_HAS_DL_GROUP)
337

338
class Powmod_Timing_Test final : public Timing_Test {
×
339
   public:
340
      explicit Powmod_Timing_Test(std::string_view dl_group) : m_group(Botan::DL_Group::from_name(dl_group)) {}
1✔
341

342
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
343

344
   private:
345
      Botan::DL_Group m_group;
346
};
347

348
uint64_t Powmod_Timing_Test::measure_critical_function(const std::vector<uint8_t>& input) {
57✔
349
   const Botan::BigInt x(input.data(), input.size());
57✔
350
   const size_t max_x_bits = m_group.p_bits();
57✔
351

352
   const TimingTestTimer timer;
57✔
353

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

356
   return timer.complete();
114✔
357
}
57✔
358

359
#endif
360

361
#if defined(BOTAN_HAS_NUMBERTHEORY)
362

363
class Invmod_Timing_Test final : public Timing_Test {
×
364
   public:
365
      explicit Invmod_Timing_Test(size_t p_bits) { m_p = Botan::random_prime(timing_test_rng(), p_bits); }
2✔
366

367
      uint64_t measure_critical_function(const std::vector<uint8_t>& input) override;
368

369
   private:
370
      Botan::BigInt m_p;
371
};
372

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

376
   const TimingTestTimer timer;
38✔
377
   const Botan::BigInt inv = Botan::inverse_mod_secret_prime(k, m_p);
38✔
378
   return timer.complete();
76✔
379
}
38✔
380

381
#endif
382

383
std::vector<std::vector<uint64_t>> Timing_Test::execute_evaluation(const std::vector<std::string>& raw_inputs,
10✔
384
                                                                   size_t warmup_runs,
385
                                                                   size_t measurement_runs) {
386
   std::vector<std::vector<uint64_t>> all_results(raw_inputs.size());
10✔
387
   std::vector<std::vector<uint8_t>> inputs(raw_inputs.size());
10✔
388

389
   for(auto& result : all_results) {
37✔
390
      result.reserve(measurement_runs);
27✔
391
   }
392

393
   for(size_t i = 0; i != inputs.size(); ++i) {
37✔
394
      inputs[i] = prepare_input(raw_inputs[i]);
27✔
395
   }
396

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

402
   size_t total_runs = 0;
10✔
403
   std::vector<uint64_t> results(inputs.size());
10✔
404

405
   while(total_runs < (warmup_runs + measurement_runs)) {
200✔
406
      for(size_t i = 0; i != inputs.size(); ++i) {
703✔
407
         results[i] = measure_critical_function(inputs[i]);
513✔
408
      }
409

410
      total_runs++;
190✔
411

412
      if(total_runs > warmup_runs) {
190✔
413
         for(size_t i = 0; i != results.size(); ++i) {
592✔
414
            all_results[i].push_back(results[i]);
432✔
415
         }
416
      }
417
   }
418

419
   return all_results;
10✔
420
}
10✔
421

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

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

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

433
      void go() override {
10✔
434
         const std::string test_type = get_arg("test_type");
10✔
435
         const size_t warmup_runs = get_arg_sz("warmup-runs");
10✔
436
         const size_t measurement_runs = get_arg_sz("measurement-runs");
10✔
437

438
         std::unique_ptr<Timing_Test> test = lookup_timing_test(test_type);
10✔
439

440
         if(!test) {
10✔
441
            throw CLI_Error("Unknown or unavailable test type '" + test_type + "'");
×
442
         }
443

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

446
         if(filename.empty()) {
10✔
447
            const std::string test_data_dir = get_arg("test-data-dir");
10✔
448
            filename = test_data_dir + "/" + test_type + ".vec";
20✔
449
         }
10✔
450

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

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

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

463
         output() << oss.str();
10✔
464
      }
20✔
465

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

482
      static std::unique_ptr<Timing_Test> lookup_timing_test(std::string_view test_type);
483

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

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

508
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_EME_OAEP) && defined(BOTAN_HAS_EME_RAW)
509
   if(test_type == "manger") {
9✔
510
      return std::make_unique<Manger_Timing_Test>(2048);
1✔
511
   }
512
#endif
513

514
#if defined(BOTAN_HAS_ECDSA)
515
   if(test_type == "ecdsa") {
8✔
516
      return std::make_unique<ECDSA_Timing_Test>("secp384r1");
1✔
517
   }
518
#endif
519

520
#if defined(BOTAN_HAS_ECC_GROUP)
521
   if(test_type == "ecc_mul") {
7✔
522
      return std::make_unique<ECC_Mul_Timing_Test>("brainpool512r1");
1✔
523
   }
524
#endif
525

526
#if defined(BOTAN_HAS_NUMBERTHEORY)
527
   if(test_type == "inverse_mod") {
6✔
528
      return std::make_unique<Invmod_Timing_Test>(512);
1✔
529
   }
530
#endif
531

532
#if defined(BOTAN_HAS_DL_GROUP)
533
   if(test_type == "pow_mod") {
5✔
534
      return std::make_unique<Powmod_Timing_Test>("modp/ietf/1024");
1✔
535
   }
536
#endif
537

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

550
   BOTAN_UNUSED(test_type);
×
551

552
   return nullptr;
×
553
}
554

555
BOTAN_REGISTER_COMMAND("timing_test", Timing_Test_Command);
11✔
556

557
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_EME_PKCS1) && defined(BOTAN_TARGET_OS_HAS_FILESYSTEM) && \
558
   defined(BOTAN_HAS_SYSTEM_RNG)
559

560
class MARVIN_Test_Command final : public Command {
561
   public:
562
      MARVIN_Test_Command() :
2✔
563
            Command("marvin_test key_file ctext_dir --runs=1K --report-every=0 --output-nsec --expect-pt-len=0") {}
4✔
564

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

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

569
   #if defined(BOTAN_TARGET_OS_HAS_POSIX1)
570
      static inline volatile sig_atomic_t g_sigint_recv = 0;
571

572
      static void marvin_sigint_handler(int /*signal*/) { g_sigint_recv = 1; }
×
573
   #endif
574

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

583
   #if defined(BOTAN_TARGET_OS_HAS_POSIX1)
584
         ::setenv("BOTAN_THREAD_POOL_SIZE", "none", /*overwrite?*/ 1);
1✔
585

586
         struct sigaction sigaction {};
1✔
587

588
         sigaction.sa_handler = marvin_sigint_handler;
1✔
589
         sigemptyset(&sigaction.sa_mask);
1✔
590
         sigaction.sa_flags = 0;
1✔
591

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

598
         Botan::DataSource_Stream key_src(key_file);
1✔
599
         const auto key = Botan::PKCS8::load_key(key_src);
1✔
600

601
         if(key->algo_name() != "RSA") {
1✔
602
            throw CLI_Usage_Error("Unexpected key type for MARVIN test");
×
603
         }
604

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

607
         std::vector<std::string> names;
1✔
608
         std::vector<uint8_t> ciphertext_data;
1✔
609

610
         for(const auto& filename : Botan::get_files_recursive(ctext_dir)) {
5✔
611
            const auto contents = this->slurp_file(filename);
4✔
612

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

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

623
            names.push_back(parts[parts.size() - 1]);
4✔
624
            ciphertext_data.insert(ciphertext_data.end(), contents.begin(), contents.end());
4✔
625
         }
9✔
626

627
         if(names.empty()) {
1✔
628
            throw CLI_Usage_Error("Empty ciphertext directory for MARVIN test");
×
629
         }
630

631
         auto& test_results_file = output();
1✔
632

633
         const size_t testcases = names.size();
1✔
634

635
   #if defined(BOTAN_HAS_CHACHA_RNG)
636
         auto rng = Botan::ChaCha_RNG(Botan::system_rng());
1✔
637
   #else
638
         auto& rng = Botan::system_rng();
639
   #endif
640

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

643
         std::vector<size_t> indexes;
1✔
644
         for(size_t i = 0; i != testcases; ++i) {
5✔
645
            indexes.push_back(i);
4✔
646
         }
647

648
         std::vector<std::vector<uint64_t>> measurements(testcases);
1✔
649
         for(auto& m : measurements) {
5✔
650
            m.reserve(measurement_runs);
4✔
651
         }
652

653
         // This is only set differently if we exit early from the loop
654
         size_t runs_completed = measurement_runs;
1✔
655

656
         std::vector<uint8_t> ciphertext(modulus_bytes);
1✔
657

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

663
            shuffle(indexes, rng);
32✔
664

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

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

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

690
         report_results(test_results_file, names, measurements, runs_completed, output_nsec);
1✔
691
      }
3✔
692

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

707
         for(size_t r = 0; r != runs_completed; ++r) {
33✔
708
            for(size_t t = 0; t != names.size(); ++t) {
160✔
709
               if(t > 0) {
128✔
710
                  output << ",";
96✔
711
               }
712

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

725
      static size_t parse_runs_arg(const std::string& param) {
1✔
726
         if(param.starts_with("-")) {
1✔
727
            throw CLI_Usage_Error("Cannot have a negative run count");
×
728
         }
729

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

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

756
BOTAN_REGISTER_COMMAND("marvin_test", MARVIN_Test_Command);
2✔
757

758
#endif
759

760
}  // namespace
761

762
}  // 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