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

randombit / botan / 6187089116

14 Sep 2023 02:42PM CUT coverage: 91.716% (-0.005%) from 91.721%
6187089116

push

github

web-flow
Merge pull request #3696 from randombit/raw_ops_span

rsa, raw_op using std::span view for raw_kem_decrypt to avoid

79098 of 86242 relevant lines covered (91.72%)

8640988.08 hits per line

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

93.53
/src/lib/pubkey/rsa/rsa.cpp
1
/*
2
* RSA
3
* (C) 1999-2010,2015,2016,2018,2019,2023 Jack Lloyd
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7

8
#include <botan/rsa.h>
9

10
#include <botan/ber_dec.h>
11
#include <botan/der_enc.h>
12
#include <botan/reducer.h>
13
#include <botan/internal/blinding.h>
14
#include <botan/internal/divide.h>
15
#include <botan/internal/emsa.h>
16
#include <botan/internal/fmt.h>
17
#include <botan/internal/keypair.h>
18
#include <botan/internal/monty.h>
19
#include <botan/internal/monty_exp.h>
20
#include <botan/internal/parsing.h>
21
#include <botan/internal/pk_ops_impl.h>
22
#include <botan/internal/pss_params.h>
23
#include <botan/internal/workfactor.h>
24

25
#if defined(BOTAN_HAS_THREAD_UTILS)
26
   #include <botan/internal/thread_pool.h>
27
#endif
28

29
namespace Botan {
30

31
class RSA_Public_Data final {
32
   public:
33
      RSA_Public_Data(BigInt&& n, BigInt&& e) :
13,976✔
34
            m_n(n),
13,976✔
35
            m_e(e),
13,976✔
36
            m_monty_n(std::make_shared<Montgomery_Params>(m_n)),
13,976✔
37
            m_public_modulus_bits(m_n.bits()),
13,976✔
38
            m_public_modulus_bytes(m_n.bytes()) {}
13,976✔
39

40
      BigInt public_op(const BigInt& m) const {
26,397✔
41
         const size_t powm_window = 1;
26,397✔
42
         auto powm_m_n = monty_precompute(m_monty_n, m, powm_window, false);
26,397✔
43
         return monty_execute_vartime(*powm_m_n, m_e);
26,397✔
44
      }
26,397✔
45

46
      const BigInt& get_n() const { return m_n; }
27,778✔
47

48
      const BigInt& get_e() const { return m_e; }
3✔
49

50
      size_t public_modulus_bits() const { return m_public_modulus_bits; }
19,973✔
51

52
      size_t public_modulus_bytes() const { return m_public_modulus_bytes; }
34,859✔
53

54
   private:
55
      BigInt m_n;
56
      BigInt m_e;
57
      std::shared_ptr<const Montgomery_Params> m_monty_n;
58
      size_t m_public_modulus_bits;
59
      size_t m_public_modulus_bytes;
60
};
61

62
class RSA_Private_Data final {
63
   public:
64
      RSA_Private_Data(BigInt&& d, BigInt&& p, BigInt&& q, BigInt&& d1, BigInt&& d2, BigInt&& c) :
2,570✔
65
            m_d(d),
2,570✔
66
            m_p(p),
2,570✔
67
            m_q(q),
2,570✔
68
            m_d1(d1),
2,570✔
69
            m_d2(d2),
2,570✔
70
            m_c(c),
2,570✔
71
            m_mod_p(m_p),
2,570✔
72
            m_mod_q(m_q),
2,570✔
73
            m_monty_p(std::make_shared<Montgomery_Params>(m_p, m_mod_p)),
2,570✔
74
            m_monty_q(std::make_shared<Montgomery_Params>(m_q, m_mod_q)),
2,570✔
75
            m_p_bits(m_p.bits()),
2,570✔
76
            m_q_bits(m_q.bits()) {}
2,570✔
77

78
      const BigInt& get_d() const { return m_d; }
1✔
79

80
      const BigInt& get_p() const { return m_p; }
4,838✔
81

82
      const BigInt& get_q() const { return m_q; }
9,675✔
83

84
      const BigInt& get_d1() const { return m_d1; }
4,837✔
85

86
      const BigInt& get_d2() const { return m_d2; }
4,837✔
87

88
      const BigInt& get_c() const { return m_c; }
×
89

90
      const Modular_Reducer& mod_p() const { return m_mod_p; }
9,674✔
91

92
      const Modular_Reducer& mod_q() const { return m_mod_q; }
4,837✔
93

94
      const std::shared_ptr<const Montgomery_Params>& monty_p() const { return m_monty_p; }
4,837✔
95

96
      const std::shared_ptr<const Montgomery_Params>& monty_q() const { return m_monty_q; }
4,837✔
97

98
      size_t p_bits() const { return m_p_bits; }
1,321✔
99

100
      size_t q_bits() const { return m_q_bits; }
1,321✔
101

102
   private:
103
      BigInt m_d;
104
      BigInt m_p;
105
      BigInt m_q;
106
      BigInt m_d1;
107
      BigInt m_d2;
108
      BigInt m_c;
109

110
      Modular_Reducer m_mod_p;
111
      Modular_Reducer m_mod_q;
112
      std::shared_ptr<const Montgomery_Params> m_monty_p;
113
      std::shared_ptr<const Montgomery_Params> m_monty_q;
114
      size_t m_p_bits;
115
      size_t m_q_bits;
116
};
117

118
std::shared_ptr<const RSA_Public_Data> RSA_PublicKey::public_data() const {
12,383✔
119
   return m_public;
12,383✔
120
}
121

122
const BigInt& RSA_PublicKey::get_int_field(std::string_view field) const {
8✔
123
   if(field == "n") {
11✔
124
      return m_public->get_n();
3✔
125
   } else if(field == "e") {
5✔
126
      return m_public->get_e();
3✔
127
   } else {
128
      return Public_Key::get_int_field(field);
2✔
129
   }
130
}
131

132
const BigInt& RSA_PublicKey::get_n() const {
525✔
133
   return m_public->get_n();
525✔
134
}
135

136
const BigInt& RSA_PublicKey::get_e() const {
496✔
137
   return m_public->get_e();
496✔
138
}
139

140
void RSA_PublicKey::init(BigInt&& n, BigInt&& e) {
14,798✔
141
   if(n.is_negative() || n.is_even() || n.bits() < 5 /* n >= 3*5 */ || e.is_negative() || e.is_even()) {
43,767✔
142
      throw Decoding_Error("Invalid RSA public key parameters");
822✔
143
   }
144
   m_public = std::make_shared<RSA_Public_Data>(std::move(n), std::move(e));
13,976✔
145
}
13,976✔
146

147
RSA_PublicKey::RSA_PublicKey(const AlgorithmIdentifier& /*unused*/, std::span<const uint8_t> key_bits) {
11,738✔
148
   BigInt n, e;
11,738✔
149
   BER_Decoder(key_bits).start_sequence().decode(n).decode(e).end_cons();
12,609✔
150

151
   init(std::move(n), std::move(e));
11,704✔
152
}
23,476✔
153

154
bool RSA_PublicKey::supports_operation(PublicKeyOperation op) const {
1,083✔
155
   return op == PublicKeyOperation::Signature || op == PublicKeyOperation::Encryption ||
1,083✔
156
          op == PublicKeyOperation::KeyEncapsulation;
1,083✔
157
}
158

159
RSA_PublicKey::RSA_PublicKey(const BigInt& modulus, const BigInt& exponent) {
521✔
160
   BigInt n = modulus;
521✔
161
   BigInt e = exponent;
521✔
162
   init(std::move(n), std::move(e));
521✔
163
}
1,042✔
164

165
size_t RSA_PublicKey::key_length() const {
4,716✔
166
   return m_public->public_modulus_bits();
4,716✔
167
}
168

169
size_t RSA_PublicKey::estimated_strength() const {
3,413✔
170
   return if_work_factor(key_length());
3,413✔
171
}
172

173
AlgorithmIdentifier RSA_PublicKey::algorithm_identifier() const {
403✔
174
   return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_NULL_PARAM);
403✔
175
}
176

177
std::vector<uint8_t> RSA_PublicKey::public_key_bits() const {
341✔
178
   std::vector<uint8_t> output;
341✔
179
   DER_Encoder der(output);
341✔
180
   der.start_sequence().encode(get_n()).encode(get_e()).end_cons();
341✔
181

182
   return output;
341✔
183
}
341✔
184

185
/*
186
* Check RSA Public Parameters
187
*/
188
bool RSA_PublicKey::check_key(RandomNumberGenerator& /*rng*/, bool /*strong*/) const {
9✔
189
   if(get_n() < 35 || get_n().is_even() || get_e() < 3 || get_e().is_even()) {
27✔
190
      return false;
×
191
   }
192
   return true;
193
}
194

195
std::shared_ptr<const RSA_Private_Data> RSA_PrivateKey::private_data() const {
1,321✔
196
   return m_private;
1,321✔
197
}
198

199
secure_vector<uint8_t> RSA_PrivateKey::private_key_bits() const {
94✔
200
   return DER_Encoder()
188✔
201
      .start_sequence()
94✔
202
      .encode(static_cast<size_t>(0))
94✔
203
      .encode(get_n())
94✔
204
      .encode(get_e())
94✔
205
      .encode(get_d())
94✔
206
      .encode(get_p())
94✔
207
      .encode(get_q())
94✔
208
      .encode(get_d1())
94✔
209
      .encode(get_d2())
94✔
210
      .encode(get_c())
94✔
211
      .end_cons()
94✔
212
      .get_contents();
188✔
213
}
214

215
const BigInt& RSA_PrivateKey::get_p() const {
170✔
216
   return m_private->get_p();
170✔
217
}
218

219
const BigInt& RSA_PrivateKey::get_q() const {
169✔
220
   return m_private->get_q();
169✔
221
}
222

223
const BigInt& RSA_PrivateKey::get_d() const {
137✔
224
   return m_private->get_d();
137✔
225
}
226

227
const BigInt& RSA_PrivateKey::get_c() const {
107✔
228
   return m_private->get_c();
107✔
229
}
230

231
const BigInt& RSA_PrivateKey::get_d1() const {
107✔
232
   return m_private->get_d1();
107✔
233
}
234

235
const BigInt& RSA_PrivateKey::get_d2() const {
107✔
236
   return m_private->get_d2();
107✔
237
}
238

239
void RSA_PrivateKey::init(BigInt&& d, BigInt&& p, BigInt&& q, BigInt&& d1, BigInt&& d2, BigInt&& c) {
2,570✔
240
   m_private = std::make_shared<RSA_Private_Data>(
7,710✔
241
      std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
2,570✔
242
}
2,570✔
243

244
RSA_PrivateKey::RSA_PrivateKey(const AlgorithmIdentifier& /*unused*/, std::span<const uint8_t> key_bits) {
2,108✔
245
   BigInt n, e, d, p, q, d1, d2, c;
2,108✔
246

247
   BER_Decoder(key_bits)
2,131✔
248
      .start_sequence()
4,209✔
249
      .decode_and_check<size_t>(0, "Unknown PKCS #1 key format version")
4,199✔
250
      .decode(n)
2,098✔
251
      .decode(e)
2,097✔
252
      .decode(d)
2,096✔
253
      .decode(p)
2,096✔
254
      .decode(q)
2,096✔
255
      .decode(d1)
2,095✔
256
      .decode(d2)
2,094✔
257
      .decode(c)
2,090✔
258
      .end_cons();
2,090✔
259

260
   RSA_PublicKey::init(std::move(n), std::move(e));
2,087✔
261

262
   RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
2,085✔
263
}
16,864✔
264

265
RSA_PrivateKey::RSA_PrivateKey(
428✔
266
   const BigInt& prime1, const BigInt& prime2, const BigInt& exp, const BigInt& d_exp, const BigInt& mod) {
428✔
267
   BigInt p = prime1;
428✔
268
   BigInt q = prime2;
428✔
269
   BigInt n = mod;
428✔
270
   if(n.is_zero()) {
856✔
271
      n = p * q;
427✔
272
   }
273

274
   BigInt e = exp;
428✔
275

276
   BigInt d = d_exp;
428✔
277

278
   const BigInt p_minus_1 = p - 1;
428✔
279
   const BigInt q_minus_1 = q - 1;
428✔
280

281
   if(d.is_zero()) {
856✔
282
      const BigInt phi_n = lcm(p_minus_1, q_minus_1);
427✔
283
      d = inverse_mod(e, phi_n);
427✔
284
   }
427✔
285

286
   BigInt d1 = ct_modulo(d, p_minus_1);
428✔
287
   BigInt d2 = ct_modulo(d, q_minus_1);
428✔
288
   BigInt c = inverse_mod(q, p);
428✔
289

290
   RSA_PublicKey::init(std::move(n), std::move(e));
428✔
291

292
   RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
428✔
293
}
4,280✔
294

295
/*
296
* Create a RSA private key
297
*/
298
RSA_PrivateKey::RSA_PrivateKey(RandomNumberGenerator& rng, size_t bits, size_t exp) {
58✔
299
   if(bits < 1024) {
58✔
300
      throw Invalid_Argument(fmt("Cannot create an RSA key only {} bits long", bits));
×
301
   }
302

303
   if(exp < 3 || exp % 2 == 0) {
58✔
304
      throw Invalid_Argument("Invalid RSA encryption exponent");
×
305
   }
306

307
   const size_t p_bits = (bits + 1) / 2;
58✔
308
   const size_t q_bits = bits - p_bits;
58✔
309

310
   BigInt p, q, n;
58✔
311
   BigInt e = BigInt::from_u64(exp);
58✔
312

313
   for(size_t attempt = 0;; ++attempt) {
11✔
314
      if(attempt > 10) {
69✔
315
         throw Internal_Error("RNG failure during RSA key generation");
1✔
316
      }
317

318
      // TODO could generate primes in thread pool
319
      p = generate_rsa_prime(rng, rng, p_bits, e);
68✔
320
      q = generate_rsa_prime(rng, rng, q_bits, e);
68✔
321

322
      const BigInt diff = p - q;
68✔
323
      if(diff.bits() < (bits / 2) - 100) {
68✔
324
         continue;
11✔
325
      }
326

327
      n = p * q;
57✔
328

329
      if(n.bits() != bits) {
57✔
330
         continue;
×
331
      }
332

333
      break;
57✔
334
   }
11✔
335

336
   const BigInt p_minus_1 = p - 1;
57✔
337
   const BigInt q_minus_1 = q - 1;
57✔
338

339
   const BigInt phi_n = lcm(p_minus_1, q_minus_1);
57✔
340
   // This is guaranteed because p,q == 3 mod 4
341
   BOTAN_DEBUG_ASSERT(low_zero_bits(phi_n) == 1);
57✔
342

343
   BigInt d = inverse_mod(e, phi_n);
57✔
344
   BigInt d1 = ct_modulo(d, p_minus_1);
57✔
345
   BigInt d2 = ct_modulo(d, q_minus_1);
57✔
346
   BigInt c = inverse_mod(q, p);
57✔
347

348
   RSA_PublicKey::init(std::move(n), std::move(e));
57✔
349

350
   RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
57✔
351
}
631✔
352

353
const BigInt& RSA_PrivateKey::get_int_field(std::string_view field) const {
6✔
354
   if(field == "p") {
10✔
355
      return m_private->get_p();
1✔
356
   } else if(field == "q") {
8✔
357
      return m_private->get_q();
1✔
358
   } else if(field == "d") {
6✔
359
      return m_private->get_d();
1✔
360
   } else if(field == "c") {
5✔
361
      return m_private->get_c();
×
362
   } else if(field == "d1") {
3✔
363
      return m_private->get_d1();
×
364
   } else if(field == "d2") {
3✔
365
      return m_private->get_d2();
×
366
   } else {
367
      return RSA_PublicKey::get_int_field(field);
3✔
368
   }
369
}
370

371
std::unique_ptr<Public_Key> RSA_PrivateKey::public_key() const {
5✔
372
   return std::make_unique<RSA_PublicKey>(get_n(), get_e());
5✔
373
}
374

375
/*
376
* Check Private RSA Parameters
377
*/
378
bool RSA_PrivateKey::check_key(RandomNumberGenerator& rng, bool strong) const {
11✔
379
   if(get_n() < 35 || get_n().is_even() || get_e() < 3 || get_e().is_even()) {
33✔
380
      return false;
×
381
   }
382

383
   if(get_d() < 2 || get_p() < 3 || get_q() < 3) {
11✔
384
      return false;
×
385
   }
386

387
   if(get_p() * get_q() != get_n()) {
22✔
388
      return false;
389
   }
390

391
   if(get_p() == get_q()) {
11✔
392
      return false;
393
   }
394

395
   if(get_d1() != ct_modulo(get_d(), get_p() - 1)) {
33✔
396
      return false;
397
   }
398
   if(get_d2() != ct_modulo(get_d(), get_q() - 1)) {
33✔
399
      return false;
400
   }
401
   if(get_c() != inverse_mod(get_q(), get_p())) {
22✔
402
      return false;
403
   }
404

405
   const size_t prob = (strong) ? 128 : 12;
11✔
406

407
   if(!is_prime(get_p(), rng, prob)) {
11✔
408
      return false;
409
   }
410
   if(!is_prime(get_q(), rng, prob)) {
10✔
411
      return false;
412
   }
413

414
   if(strong) {
10✔
415
      if(ct_modulo(get_e() * get_d(), lcm(get_p() - 1, get_q() - 1)) != 1) {
56✔
416
         return false;
417
      }
418

419
      return KeyPair::signature_consistency_check(rng, *this, "EMSA4(SHA-256)");
8✔
420
   }
421

422
   return true;
423
}
424

425
namespace {
426

427
/**
428
* RSA private (decrypt/sign) operation
429
*/
430
class RSA_Private_Operation {
431
   protected:
432
      size_t public_modulus_bits() const { return m_public->public_modulus_bits(); }
1,498✔
433

434
      size_t public_modulus_bytes() const { return m_public->public_modulus_bytes(); }
4,854✔
435

436
      explicit RSA_Private_Operation(const RSA_PrivateKey& rsa, RandomNumberGenerator& rng) :
1,321✔
437
            m_public(rsa.public_data()),
1,321✔
438
            m_private(rsa.private_data()),
1,321✔
439
            m_blinder(
2,642✔
440
               m_public->get_n(),
1,321✔
441
               rng,
442
               [this](const BigInt& k) { return m_public->public_op(k); },
1,327✔
443
               [this](const BigInt& k) { return inverse_mod(k, m_public->get_n()); }),
1,327✔
444
            m_blinding_bits(64),
1,321✔
445
            m_max_d1_bits(m_private->p_bits() + m_blinding_bits),
1,321✔
446
            m_max_d2_bits(m_private->q_bits() + m_blinding_bits) {}
1,321✔
447

448
      void raw_op(std::span<uint8_t> out, std::span<const uint8_t> input) {
4,854✔
449
         if(input.size() > public_modulus_bytes()) {
4,854✔
450
            throw Decoding_Error("RSA input is too long for this key");
×
451
         }
452
         const BigInt input_bn(input.data(), input.size());
4,854✔
453
         if(input_bn >= m_public->get_n()) {
4,854✔
454
            throw Decoding_Error("RSA input is too large for this key");
16✔
455
         }
456
         // TODO: This should be a function on blinder
457
         // BigInt Blinder::run_blinded_function(std::function<BigInt, BigInt> fn, const BigInt& input);
458

459
         const BigInt recovered = m_blinder.unblind(rsa_private_op(m_blinder.blind(input_bn)));
9,691✔
460
         BOTAN_ASSERT(input_bn == m_public->public_op(recovered), "RSA consistency check");
14,511✔
461
         BOTAN_ASSERT(m_public->public_modulus_bytes() == out.size(), "output size check");
4,837✔
462
         BigInt::encode_1363(out, recovered);
4,837✔
463
      }
9,674✔
464

465
      secure_vector<uint8_t> raw_op(const uint8_t input[], size_t input_len) {
4,843✔
466
         secure_vector<uint8_t> out(m_public->public_modulus_bytes());
4,843✔
467
         raw_op(out, {input, input_len});
4,843✔
468
         return out;
4,826✔
469
      }
17✔
470

471
   private:
472
      BigInt rsa_private_op(const BigInt& m) const {
4,837✔
473
         /*
474
         TODO
475
         Consider using Montgomery reduction instead of Barrett, using
476
         the "Smooth RSA-CRT" method. https://eprint.iacr.org/2007/039.pdf
477
         */
478

479
         static constexpr size_t powm_window = 4;
4,837✔
480

481
         // Compute this in main thread to avoid racing on the rng
482
         const BigInt d1_mask(m_blinder.rng(), m_blinding_bits);
4,837✔
483

484
#if defined(BOTAN_HAS_THREAD_UTILS) && !defined(BOTAN_HAS_VALGRIND)
485
   #define BOTAN_RSA_USE_ASYNC
486
#endif
487

488
#if defined(BOTAN_RSA_USE_ASYNC)
489
         /*
490
         * Precompute m.sig_words in the main thread before calling async. Otherwise
491
         * the two threads race (during Modular_Reducer::reduce) and while the output
492
         * is correct in both threads, helgrind warns.
493
         */
494
         m.sig_words();
4,837✔
495

496
         auto future_j1 = Thread_Pool::global_instance().run([this, &m, &d1_mask]() {
4,837✔
497
#endif
498
            const BigInt masked_d1 = m_private->get_d1() + (d1_mask * (m_private->get_p() - 1));
9,674✔
499
            auto powm_d1_p = monty_precompute(m_private->monty_p(), m_private->mod_p().reduce(m), powm_window);
4,837✔
500
            BigInt j1 = monty_execute(*powm_d1_p, masked_d1, m_max_d1_bits);
4,837✔
501

502
#if defined(BOTAN_RSA_USE_ASYNC)
503
            return j1;
4,837✔
504
         });
14,511✔
505
#endif
506

507
         const BigInt d2_mask(m_blinder.rng(), m_blinding_bits);
4,837✔
508
         const BigInt masked_d2 = m_private->get_d2() + (d2_mask * (m_private->get_q() - 1));
9,674✔
509
         auto powm_d2_q = monty_precompute(m_private->monty_q(), m_private->mod_q().reduce(m), powm_window);
4,837✔
510
         const BigInt j2 = monty_execute(*powm_d2_q, masked_d2, m_max_d2_bits);
4,837✔
511

512
#if defined(BOTAN_RSA_USE_ASYNC)
513
         BigInt j1 = future_j1.get();
4,837✔
514
#endif
515

516
         /*
517
         * To recover the final value from the CRT representation (j1,j2)
518
         * we use Garner's algorithm:
519
         * c = q^-1 mod p (this is precomputed)
520
         * h = c*(j1-j2) mod p
521
         * m = j2 + h*q
522
         *
523
         * We must avoid leaking if j1 >= j2 or not, as doing so allows deriving
524
         * information about the secret prime. Do this by first adding p to j1,
525
         * which should ensure the subtraction of j2 does not underflow. But
526
         * this may still underflow if p and q are imbalanced in size.
527
         */
528

529
         j1 =
4,837✔
530
            m_private->mod_p().multiply(m_private->mod_p().reduce((m_private->get_p() + j1) - j2), m_private->get_c());
19,348✔
531
         return j1 * m_private->get_q() + j2;
9,674✔
532
      }
29,022✔
533

534
      std::shared_ptr<const RSA_Public_Data> m_public;
535
      std::shared_ptr<const RSA_Private_Data> m_private;
536

537
      // XXX could the blinder starting pair be shared?
538
      Blinder m_blinder;
539
      const size_t m_blinding_bits;
540
      const size_t m_max_d1_bits;
541
      const size_t m_max_d2_bits;
542
};
543

544
class RSA_Signature_Operation final : public PK_Ops::Signature,
×
545
                                      private RSA_Private_Operation {
546
   public:
547
      void update(const uint8_t msg[], size_t msg_len) override { m_emsa->update(msg, msg_len); }
1,499✔
548

549
      secure_vector<uint8_t> sign(RandomNumberGenerator& rng) override {
1,498✔
550
         const size_t max_input_bits = public_modulus_bits() - 1;
1,498✔
551
         const auto msg = m_emsa->raw_data();
1,498✔
552
         const auto padded = m_emsa->encoding_of(msg, max_input_bits, rng);
1,498✔
553
         return raw_op(padded.data(), padded.size());
1,497✔
554
      }
2,993✔
555

556
      size_t signature_length() const override { return public_modulus_bytes(); }
268✔
557

558
      AlgorithmIdentifier algorithm_identifier() const override;
559

560
      std::string hash_function() const override { return m_emsa->hash_function(); }
115✔
561

562
      RSA_Signature_Operation(const RSA_PrivateKey& rsa, std::string_view padding, RandomNumberGenerator& rng) :
1,100✔
563
            RSA_Private_Operation(rsa, rng), m_emsa(EMSA::create_or_throw(padding)) {}
1,100✔
564

565
   private:
566
      std::unique_ptr<EMSA> m_emsa;
567
};
568

569
AlgorithmIdentifier RSA_Signature_Operation::algorithm_identifier() const {
74✔
570
   const std::string emsa_name = m_emsa->name();
74✔
571

572
   try {
74✔
573
      const std::string full_name = "RSA/" + emsa_name;
74✔
574
      const OID oid = OID::from_string(full_name);
74✔
575
      return AlgorithmIdentifier(oid, AlgorithmIdentifier::USE_EMPTY_PARAM);
53✔
576
   } catch(Lookup_Error&) {}
127✔
577

578
   if(emsa_name.starts_with("EMSA4(")) {
21✔
579
      auto parameters = PSS_Params::from_emsa_name(m_emsa->name()).serialize();
42✔
580
      return AlgorithmIdentifier("RSA/EMSA4", parameters);
21✔
581
   }
21✔
582

583
   throw Not_Implemented("No algorithm identifier defined for RSA with " + emsa_name);
×
584
}
74✔
585

586
class RSA_Decryption_Operation final : public PK_Ops::Decryption_with_EME,
×
587
                                       private RSA_Private_Operation {
588
   public:
589
      RSA_Decryption_Operation(const RSA_PrivateKey& rsa, std::string_view eme, RandomNumberGenerator& rng) :
210✔
590
            PK_Ops::Decryption_with_EME(eme), RSA_Private_Operation(rsa, rng) {}
210✔
591

592
      size_t plaintext_length(size_t /*ctext_len*/) const override { return public_modulus_bytes(); }
125✔
593

594
      secure_vector<uint8_t> raw_decrypt(const uint8_t input[], size_t input_len) override {
3,346✔
595
         return raw_op(input, input_len);
3,346✔
596
      }
597
};
598

599
class RSA_KEM_Decryption_Operation final : public PK_Ops::KEM_Decryption_with_KDF,
×
600
                                           private RSA_Private_Operation {
601
   public:
602
      RSA_KEM_Decryption_Operation(const RSA_PrivateKey& key, std::string_view kdf, RandomNumberGenerator& rng) :
11✔
603
            PK_Ops::KEM_Decryption_with_KDF(kdf), RSA_Private_Operation(key, rng) {}
11✔
604

605
      size_t raw_kem_shared_key_length() const override { return public_modulus_bytes(); }
11✔
606

607
      size_t encapsulated_key_length() const override { return public_modulus_bytes(); }
10✔
608

609
      void raw_kem_decrypt(std::span<uint8_t> out_shared_key, std::span<const uint8_t> encapsulated_key) override {
11✔
610
         raw_op(out_shared_key, encapsulated_key);
11✔
611
      }
11✔
612
};
613

614
/**
615
* RSA public (encrypt/verify) operation
616
*/
617
class RSA_Public_Operation {
×
618
   public:
619
      explicit RSA_Public_Operation(const RSA_PublicKey& rsa) : m_public(rsa.public_data()) {}
10,870✔
620

621
      size_t public_modulus_bits() const { return m_public->public_modulus_bits(); }
19,973✔
622

623
   protected:
624
      BigInt public_op(const BigInt& m) const {
20,262✔
625
         if(m >= m_public->get_n()) {
20,262✔
626
            throw Decoding_Error("RSA public op - input is too large");
29✔
627
         }
628

629
         return m_public->public_op(m);
20,233✔
630
      }
631

632
      size_t public_modulus_bytes() const { return m_public->public_modulus_bytes(); }
20,505✔
633

634
      const BigInt& get_n() const { return m_public->get_n(); }
11✔
635

636
   private:
637
      std::shared_ptr<const RSA_Public_Data> m_public;
638
};
639

640
class RSA_Encryption_Operation final : public PK_Ops::Encryption_with_EME,
×
641
                                       private RSA_Public_Operation {
642
   public:
643
      RSA_Encryption_Operation(const RSA_PublicKey& rsa, std::string_view eme) :
181✔
644
            PK_Ops::Encryption_with_EME(eme), RSA_Public_Operation(rsa) {}
181✔
645

646
      size_t ciphertext_length(size_t /*ptext_len*/) const override { return public_modulus_bytes(); }
125✔
647

648
      size_t max_ptext_input_bits() const override { return public_modulus_bits() - 1; }
372✔
649

650
      secure_vector<uint8_t> raw_encrypt(const uint8_t input[],
249✔
651
                                         size_t input_len,
652
                                         RandomNumberGenerator& /*rng*/) override {
653
         BigInt input_bn(input, input_len);
249✔
654
         return BigInt::encode_1363(public_op(input_bn), public_modulus_bytes());
498✔
655
      }
249✔
656
};
657

658
class RSA_Verify_Operation final : public PK_Ops::Verification,
×
659
                                   private RSA_Public_Operation {
660
   public:
661
      void update(const uint8_t msg[], size_t msg_len) override { m_emsa->update(msg, msg_len); }
20,078✔
662

663
      bool is_valid_signature(const uint8_t sig[], size_t sig_len) override {
20,076✔
664
         const auto msg = m_emsa->raw_data();
20,076✔
665
         const auto message_repr = recover_message_repr(sig, sig_len);
20,076✔
666
         return m_emsa->verify(message_repr, msg, public_modulus_bits() - 1);
19,973✔
667
      }
39,901✔
668

669
      RSA_Verify_Operation(const RSA_PublicKey& rsa, std::string_view padding) :
10,870✔
670
            RSA_Public_Operation(rsa), m_emsa(EMSA::create_or_throw(padding)) {}
10,870✔
671

672
      std::string hash_function() const override { return m_emsa->hash_function(); }
8,885✔
673

674
   private:
675
      std::vector<uint8_t> recover_message_repr(const uint8_t input[], size_t input_len) {
20,076✔
676
         if(input_len > public_modulus_bytes()) {
20,076✔
677
            throw Decoding_Error("RSA signature too large to be valid for this key");
74✔
678
         }
679
         BigInt input_bn(input, input_len);
20,002✔
680
         return BigInt::encode(public_op(input_bn));
39,975✔
681
      }
19,973✔
682

683
      std::unique_ptr<EMSA> m_emsa;
684
};
685

686
class RSA_KEM_Encryption_Operation final : public PK_Ops::KEM_Encryption_with_KDF,
×
687
                                           private RSA_Public_Operation {
688
   public:
689
      RSA_KEM_Encryption_Operation(const RSA_PublicKey& key, std::string_view kdf) :
11✔
690
            PK_Ops::KEM_Encryption_with_KDF(kdf), RSA_Public_Operation(key) {}
11✔
691

692
   private:
693
      size_t raw_kem_shared_key_length() const override { return public_modulus_bytes(); }
11✔
694

695
      size_t encapsulated_key_length() const override { return public_modulus_bytes(); }
44✔
696

697
      void raw_kem_encrypt(std::span<uint8_t> out_encapsulated_key,
11✔
698
                           std::span<uint8_t> raw_shared_key,
699
                           RandomNumberGenerator& rng) override {
700
         const BigInt r = BigInt::random_integer(rng, 1, get_n());
11✔
701
         const BigInt c = public_op(r);
11✔
702

703
         // TODO: simplify that once BigInt::encode_1363() has a std::span<> overload
704
         BigInt::encode_1363(out_encapsulated_key.data(), out_encapsulated_key.size(), c);
11✔
705
         BigInt::encode_1363(raw_shared_key.data(), raw_shared_key.size(), r);
11✔
706
      }
22✔
707
};
708

709
}  // namespace
710

711
std::unique_ptr<PK_Ops::Encryption> RSA_PublicKey::create_encryption_op(RandomNumberGenerator& /*rng*/,
550✔
712
                                                                        std::string_view params,
713
                                                                        std::string_view provider) const {
714
   if(provider == "base" || provider.empty()) {
674✔
715
      return std::make_unique<RSA_Encryption_Operation>(*this, params);
181✔
716
   }
717
   throw Provider_Not_Found(algo_name(), provider);
738✔
718
}
719

720
std::unique_ptr<PK_Ops::KEM_Encryption> RSA_PublicKey::create_kem_encryption_op(std::string_view params,
11✔
721
                                                                                std::string_view provider) const {
722
   if(provider == "base" || provider.empty()) {
11✔
723
      return std::make_unique<RSA_KEM_Encryption_Operation>(*this, params);
11✔
724
   }
725
   throw Provider_Not_Found(algo_name(), provider);
×
726
}
727

728
std::unique_ptr<PK_Ops::Verification> RSA_PublicKey::create_verification_op(std::string_view params,
4,038✔
729
                                                                            std::string_view provider) const {
730
   if(provider == "base" || provider.empty()) {
4,809✔
731
      return std::make_unique<RSA_Verify_Operation>(*this, params);
1,728✔
732
   }
733

734
   throw Provider_Not_Found(algo_name(), provider);
4,620✔
735
}
736

737
namespace {
738

739
std::string parse_rsa_signature_algorithm(const AlgorithmIdentifier& alg_id) {
9,145✔
740
   const auto sig_info = split_on(alg_id.oid().to_formatted_string(), '/');
9,145✔
741

742
   if(sig_info.empty() || sig_info.size() != 2 || sig_info[0] != "RSA") {
9,145✔
743
      throw Decoding_Error("Unknown AlgorithmIdentifier for RSA X.509 signatures");
1✔
744
   }
745

746
   std::string padding = sig_info[1];
9,144✔
747

748
   if(padding == "EMSA4") {
9,144✔
749
      // "MUST contain RSASSA-PSS-params"
750
      if(alg_id.parameters().empty()) {
534✔
751
         throw Decoding_Error("PSS params must be provided");
×
752
      }
753

754
      PSS_Params pss_params(alg_id.parameters());
534✔
755

756
      // hash_algo must be SHA1, SHA2-224, SHA2-256, SHA2-384 or SHA2-512
757
      const std::string hash_algo = pss_params.hash_function();
534✔
758
      if(hash_algo != "SHA-1" && hash_algo != "SHA-224" && hash_algo != "SHA-256" && hash_algo != "SHA-384" &&
534✔
759
         hash_algo != "SHA-512") {
10✔
760
         throw Decoding_Error("Unacceptable hash for PSS signatures");
×
761
      }
762

763
      if(pss_params.mgf_function() != "MGF1") {
534✔
764
         throw Decoding_Error("Unacceptable MGF for PSS signatures");
×
765
      }
766

767
      // For MGF1, it is strongly RECOMMENDED that the underlying hash
768
      // function be the same as the one identified by hashAlgorithm
769
      //
770
      // Must be SHA1, SHA2-224, SHA2-256, SHA2-384 or SHA2-512
771
      if(pss_params.hash_algid() != pss_params.mgf_hash_algid()) {
534✔
772
         throw Decoding_Error("Unacceptable MGF hash for PSS signatures");
2✔
773
      }
774

775
      if(pss_params.trailer_field() != 1) {
532✔
776
         throw Decoding_Error("Unacceptable trailer field for PSS signatures");
×
777
      }
778

779
      padding += fmt("({},MGF1,{})", hash_algo, pss_params.salt_length());
1,588✔
780
   }
534✔
781

782
   return padding;
9,142✔
783
}
9,145✔
784

785
}  // namespace
786

787
std::unique_ptr<PK_Ops::Verification> RSA_PublicKey::create_x509_verification_op(const AlgorithmIdentifier& alg_id,
9,145✔
788
                                                                                 std::string_view provider) const {
789
   if(provider == "base" || provider.empty()) {
9,145✔
790
      return std::make_unique<RSA_Verify_Operation>(*this, parse_rsa_signature_algorithm(alg_id));
9,677✔
791
   }
792

793
   throw Provider_Not_Found(algo_name(), provider);
×
794
}
795

796
std::unique_ptr<PK_Ops::Decryption> RSA_PrivateKey::create_decryption_op(RandomNumberGenerator& rng,
654✔
797
                                                                         std::string_view params,
798
                                                                         std::string_view provider) const {
799
   if(provider == "base" || provider.empty()) {
803✔
800
      return std::make_unique<RSA_Decryption_Operation>(*this, params, rng);
210✔
801
   }
802

803
   throw Provider_Not_Found(algo_name(), provider);
888✔
804
}
805

806
std::unique_ptr<PK_Ops::KEM_Decryption> RSA_PrivateKey::create_kem_decryption_op(RandomNumberGenerator& rng,
11✔
807
                                                                                 std::string_view params,
808
                                                                                 std::string_view provider) const {
809
   if(provider == "base" || provider.empty()) {
11✔
810
      return std::make_unique<RSA_KEM_Decryption_Operation>(*this, params, rng);
11✔
811
   }
812

813
   throw Provider_Not_Found(algo_name(), provider);
×
814
}
815

816
std::unique_ptr<PK_Ops::Signature> RSA_PrivateKey::create_signature_op(RandomNumberGenerator& rng,
1,901✔
817
                                                                       std::string_view params,
818
                                                                       std::string_view provider) const {
819
   if(provider == "base" || provider.empty()) {
2,169✔
820
      return std::make_unique<RSA_Signature_Operation>(*this, params, rng);
1,100✔
821
   }
822

823
   throw Provider_Not_Found(algo_name(), provider);
1,602✔
824
}
825

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

© 2025 Coveralls, Inc