10#include <botan/ber_dec.h>
11#include <botan/der_enc.h>
12#include <botan/numthry.h>
13#include <botan/pss_params.h>
14#include <botan/reducer.h>
15#include <botan/internal/blinding.h>
16#include <botan/internal/divide.h>
17#include <botan/internal/emsa.h>
18#include <botan/internal/fmt.h>
19#include <botan/internal/keypair.h>
20#include <botan/internal/mod_inv.h>
21#include <botan/internal/monty.h>
22#include <botan/internal/monty_exp.h>
23#include <botan/internal/parsing.h>
24#include <botan/internal/pk_ops_impl.h>
25#include <botan/internal/workfactor.h>
27#if defined(BOTAN_HAS_THREAD_UTILS)
28 #include <botan/internal/thread_pool.h>
33class RSA_Public_Data
final {
35 RSA_Public_Data(BigInt&& n, BigInt&& e) :
38 m_mod_n(Modular_Reducer::for_public_modulus(m_n)),
39 m_monty_n(std::make_shared<Montgomery_Params>(m_n, m_mod_n)),
40 m_public_modulus_bits(m_n.bits()),
41 m_public_modulus_bytes(m_n.bytes()) {}
43 BigInt public_op(
const BigInt& m)
const {
44 const size_t powm_window = 1;
49 const BigInt& get_n()
const {
return m_n; }
51 const BigInt& get_e()
const {
return m_e; }
53 size_t public_modulus_bits()
const {
return m_public_modulus_bits; }
55 size_t public_modulus_bytes()
const {
return m_public_modulus_bytes; }
57 const std::shared_ptr<const Montgomery_Params>& monty_n()
const {
return m_monty_n; }
59 const Modular_Reducer& reducer_mod_n()
const {
return m_mod_n; }
64 Modular_Reducer m_mod_n;
65 std::shared_ptr<const Montgomery_Params> m_monty_n;
66 size_t m_public_modulus_bits;
67 size_t m_public_modulus_bytes;
70class RSA_Private_Data
final {
72 RSA_Private_Data(BigInt&& d, BigInt&& p, BigInt&& q, BigInt&& d1, BigInt&& d2, BigInt&& c) :
79 m_monty_p(std::make_shared<Montgomery_Params>(m_p)),
80 m_monty_q(std::make_shared<Montgomery_Params>(m_q)),
81 m_c_monty(m_monty_p, m_c),
83 m_q_bits(m_q.bits()) {}
85 const BigInt& get_d()
const {
return m_d; }
87 const BigInt& get_p()
const {
return m_p; }
89 const BigInt& get_q()
const {
return m_q; }
91 const BigInt& get_d1()
const {
return m_d1; }
93 const BigInt& get_d2()
const {
return m_d2; }
95 const BigInt& get_c()
const {
return m_c; }
97 const Montgomery_Int& get_c_monty()
const {
return m_c_monty; }
99 const std::shared_ptr<const Montgomery_Params>& monty_p()
const {
return m_monty_p; }
101 const std::shared_ptr<const Montgomery_Params>& monty_q()
const {
return m_monty_q; }
103 size_t p_bits()
const {
return m_p_bits; }
105 size_t q_bits()
const {
return m_q_bits; }
107 bool primes_imbalanced()
const {
return p_bits() != q_bits(); }
117 std::shared_ptr<const Montgomery_Params> m_monty_p;
118 std::shared_ptr<const Montgomery_Params> m_monty_q;
119 Montgomery_Int m_c_monty;
131 }
else if(field ==
"e") {
139 return std::make_unique<RSA_PrivateKey>(rng,
m_public->public_modulus_bits(),
m_public->get_e().to_u32bit());
151 if(n.is_negative() || n.is_even() || n.bits() < 5 || e.is_negative() || e.is_even()) {
154 m_public = std::make_shared<RSA_Public_Data>(std::move(n), std::move(e));
161 init(std::move(n), std::move(e));
172 init(std::move(n), std::move(e));
176 return m_public->public_modulus_bits();
188 throw Not_Implemented(
"an RSA public key does not provide a raw binary representation.");
192 std::vector<uint8_t> output;
216 .
encode(
static_cast<size_t>(0))
230 return m_private->get_p();
234 return m_private->get_q();
238 return m_private->get_d();
242 return m_private->get_c();
246 return m_private->get_d1();
250 return m_private->get_d2();
254 m_private = std::make_shared<RSA_Private_Data>(
255 std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
259 BigInt n, e, d, p, q, d1, d2, c;
276 RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
292 const BigInt p_minus_1 = p - 1;
293 const BigInt q_minus_1 = q - 1;
296 const BigInt phi_n =
lcm(p_minus_1, q_minus_1);
306 RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
317 if(exp < 3 || exp % 2 == 0) {
321 const size_t p_bits = (bits + 1) / 2;
322 const size_t q_bits = bits - p_bits;
327 for(
size_t attempt = 0;; ++attempt) {
336 const BigInt diff = p - q;
337 if(diff.
bits() < (bits / 2) - 100) {
343 if(n.
bits() != bits) {
350 const BigInt p_minus_1 = p - 1;
351 const BigInt q_minus_1 = q - 1;
353 const BigInt phi_n =
lcm(p_minus_1, q_minus_1);
364 RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
369 return m_private->get_p();
370 }
else if(field ==
"q") {
371 return m_private->get_q();
372 }
else if(field ==
"d") {
373 return m_private->get_d();
374 }
else if(field ==
"c") {
375 return m_private->get_c();
376 }
else if(field ==
"d1") {
377 return m_private->get_d1();
378 }
else if(field ==
"d2") {
379 return m_private->get_d2();
386 return std::make_unique<RSA_PublicKey>(
get_n(),
get_e());
419 const size_t prob = (strong) ? 128 : 12;
433#if defined(BOTAN_HAS_PSS) && defined(BOTAN_HAS_SHA_256)
434 const std::string padding =
"PSS(SHA-256)";
436 const std::string padding =
"Raw";
450class RSA_Private_Operation {
452 size_t public_modulus_bits()
const {
return m_public->public_modulus_bits(); }
454 size_t public_modulus_bytes()
const {
return m_public->public_modulus_bytes(); }
456 explicit RSA_Private_Operation(
const RSA_PrivateKey& rsa, RandomNumberGenerator& rng) :
457 m_public(rsa.public_data()),
458 m_private(rsa.private_data()),
460 m_public->reducer_mod_n(),
462 [this](const BigInt& k) {
return m_public->public_op(k); },
465 m_max_d1_bits(m_private->p_bits() + m_blinding_bits),
466 m_max_d2_bits(m_private->q_bits() + m_blinding_bits) {}
468 void raw_op(std::span<uint8_t> out, std::span<const uint8_t> input) {
469 if(input.size() > public_modulus_bytes()) {
470 throw Decoding_Error(
"RSA input is too long for this key");
472 const BigInt input_bn(input.data(), input.size());
473 if(input_bn >= m_public->get_n()) {
474 throw Decoding_Error(
"RSA input is too large for this key");
479 const BigInt recovered = m_blinder.unblind(rsa_private_op(m_blinder.blind(input_bn)));
480 BOTAN_ASSERT(input_bn == m_public->public_op(recovered),
"RSA consistency check");
481 BOTAN_ASSERT(m_public->public_modulus_bytes() == out.size(),
"output size check");
482 recovered.serialize_to(out);
486 BigInt rsa_private_op(
const BigInt& m)
const {
491 if(m_private->primes_imbalanced()) {
492 return monty_exp(m_public->monty_n(), m, m_private->get_d(), m_public->get_n().bits()).
value();
495 static constexpr size_t powm_window = 4;
498 const BigInt d1_mask(m_blinder.rng(), m_blinding_bits);
500#if defined(BOTAN_HAS_THREAD_UTILS) && !defined(BOTAN_HAS_VALGRIND)
501 #define BOTAN_RSA_USE_ASYNC
504#if defined(BOTAN_RSA_USE_ASYNC)
514 const BigInt masked_d1 = m_private->get_d1() + (d1_mask * (m_private->get_p() - 1));
516 auto j1 =
monty_execute(*powm_d1_p, masked_d1, m_max_d1_bits);
518#if defined(BOTAN_RSA_USE_ASYNC)
523 const BigInt d2_mask(m_blinder.rng(), m_blinding_bits);
524 const BigInt masked_d2 = m_private->get_d2() + (d2_mask * (m_private->get_q() - 1));
528#if defined(BOTAN_RSA_USE_ASYNC)
529 auto j1 = future_j1.get();
547 j1 = (j1 - j2_p) * m_private->get_c_monty();
548 return j1.value() * m_private->get_q() + j2;
551 std::shared_ptr<const RSA_Public_Data> m_public;
552 std::shared_ptr<const RSA_Private_Data> m_private;
556 const size_t m_blinding_bits;
557 const size_t m_max_d1_bits;
558 const size_t m_max_d2_bits;
561class RSA_Signature_Operation
final :
public PK_Ops::Signature,
562 private RSA_Private_Operation {
564 void update(std::span<const uint8_t> msg)
override { m_emsa->update(msg.data(), msg.size()); }
566 std::vector<uint8_t> sign(RandomNumberGenerator& rng)
override {
567 const size_t max_input_bits = public_modulus_bits() - 1;
568 const auto msg = m_emsa->raw_data();
569 const auto padded = m_emsa->encoding_of(msg, max_input_bits, rng);
571 std::vector<uint8_t> out(public_modulus_bytes());
576 size_t signature_length()
const override {
return public_modulus_bytes(); }
578 AlgorithmIdentifier algorithm_identifier()
const override;
580 std::string hash_function()
const override {
return m_emsa->hash_function(); }
582 RSA_Signature_Operation(
const RSA_PrivateKey& rsa, std::string_view padding, RandomNumberGenerator& rng) :
583 RSA_Private_Operation(rsa, rng), m_emsa(EMSA::create_or_throw(padding)) {}
586 std::unique_ptr<EMSA> m_emsa;
589AlgorithmIdentifier RSA_Signature_Operation::algorithm_identifier()
const {
590 const std::string emsa_name = m_emsa->name();
593 const std::string full_name =
"RSA/" + emsa_name;
594 const OID oid = OID::from_string(full_name);
595 return AlgorithmIdentifier(oid, AlgorithmIdentifier::USE_EMPTY_PARAM);
596 }
catch(Lookup_Error&) {}
598 if(emsa_name.starts_with(
"PSS(")) {
599 auto parameters = PSS_Params::from_emsa_name(m_emsa->name()).serialize();
600 return AlgorithmIdentifier(
"RSA/PSS", parameters);
603 throw Invalid_Argument(
fmt(
"Signatures using RSA/{} are not supported", emsa_name));
606class RSA_Decryption_Operation
final :
public PK_Ops::Decryption_with_EME,
607 private RSA_Private_Operation {
609 RSA_Decryption_Operation(
const RSA_PrivateKey& rsa, std::string_view eme, RandomNumberGenerator& rng) :
610 PK_Ops::Decryption_with_EME(eme), RSA_Private_Operation(rsa, rng) {}
612 size_t plaintext_length(
size_t )
const override {
return public_modulus_bytes(); }
614 secure_vector<uint8_t> raw_decrypt(std::span<const uint8_t> input)
override {
615 secure_vector<uint8_t> out(public_modulus_bytes());
621class RSA_KEM_Decryption_Operation
final :
public PK_Ops::KEM_Decryption_with_KDF,
622 private RSA_Private_Operation {
624 RSA_KEM_Decryption_Operation(
const RSA_PrivateKey& key, std::string_view kdf, RandomNumberGenerator& rng) :
625 PK_Ops::KEM_Decryption_with_KDF(kdf), RSA_Private_Operation(key, rng) {}
627 size_t raw_kem_shared_key_length()
const override {
return public_modulus_bytes(); }
629 size_t encapsulated_key_length()
const override {
return public_modulus_bytes(); }
631 void raw_kem_decrypt(std::span<uint8_t> out_shared_key, std::span<const uint8_t> encapsulated_key)
override {
632 raw_op(out_shared_key, encapsulated_key);
639class RSA_Public_Operation {
641 explicit RSA_Public_Operation(
const RSA_PublicKey& rsa) : m_public(rsa.public_data()) {}
643 size_t public_modulus_bits()
const {
return m_public->public_modulus_bits(); }
646 BigInt public_op(
const BigInt& m)
const {
647 if(m >= m_public->get_n()) {
648 throw Decoding_Error(
"RSA public op - input is too large");
651 return m_public->public_op(m);
654 size_t public_modulus_bytes()
const {
return m_public->public_modulus_bytes(); }
656 const BigInt& get_n()
const {
return m_public->get_n(); }
659 std::shared_ptr<const RSA_Public_Data> m_public;
662class RSA_Encryption_Operation
final :
public PK_Ops::Encryption_with_EME,
663 private RSA_Public_Operation {
665 RSA_Encryption_Operation(
const RSA_PublicKey& rsa, std::string_view eme) :
666 PK_Ops::Encryption_with_EME(eme), RSA_Public_Operation(rsa) {}
668 size_t ciphertext_length(
size_t )
const override {
return public_modulus_bytes(); }
670 size_t max_ptext_input_bits()
const override {
return public_modulus_bits() - 1; }
672 std::vector<uint8_t> raw_encrypt(std::span<const uint8_t> input, RandomNumberGenerator& )
override {
673 BigInt input_bn(input);
674 return public_op(input_bn).serialize(public_modulus_bytes());
678class RSA_Verify_Operation
final :
public PK_Ops::Verification,
679 private RSA_Public_Operation {
681 void update(std::span<const uint8_t> msg)
override { m_emsa->update(msg.data(), msg.size()); }
683 bool is_valid_signature(std::span<const uint8_t> sig)
override {
684 const auto msg = m_emsa->raw_data();
685 const auto message_repr = recover_message_repr(sig.data(), sig.size());
686 return m_emsa->verify(message_repr, msg, public_modulus_bits() - 1);
689 RSA_Verify_Operation(
const RSA_PublicKey& rsa, std::string_view padding) :
690 RSA_Public_Operation(rsa), m_emsa(EMSA::create_or_throw(padding)) {}
692 std::string hash_function()
const override {
return m_emsa->hash_function(); }
695 std::vector<uint8_t> recover_message_repr(
const uint8_t input[],
size_t input_len) {
696 if(input_len > public_modulus_bytes()) {
697 throw Decoding_Error(
"RSA signature too large to be valid for this key");
699 BigInt input_bn(input, input_len);
700 return public_op(input_bn).serialize();
703 std::unique_ptr<EMSA> m_emsa;
706class RSA_KEM_Encryption_Operation
final :
public PK_Ops::KEM_Encryption_with_KDF,
707 private RSA_Public_Operation {
709 RSA_KEM_Encryption_Operation(
const RSA_PublicKey& key, std::string_view kdf) :
710 PK_Ops::KEM_Encryption_with_KDF(kdf), RSA_Public_Operation(key) {}
713 size_t raw_kem_shared_key_length()
const override {
return public_modulus_bytes(); }
715 size_t encapsulated_key_length()
const override {
return public_modulus_bytes(); }
717 void raw_kem_encrypt(std::span<uint8_t> out_encapsulated_key,
718 std::span<uint8_t> raw_shared_key,
719 RandomNumberGenerator& rng)
override {
720 const BigInt r = BigInt::random_integer(rng, 1, get_n());
721 const BigInt c = public_op(r);
723 c.serialize_to(out_encapsulated_key);
724 r.serialize_to(raw_shared_key);
731 std::string_view params,
732 std::string_view provider)
const {
733 if(provider ==
"base" || provider.empty()) {
734 return std::make_unique<RSA_Encryption_Operation>(*
this, params);
740 std::string_view provider)
const {
741 if(provider ==
"base" || provider.empty()) {
742 return std::make_unique<RSA_KEM_Encryption_Operation>(*
this, params);
748 std::string_view provider)
const {
749 if(provider ==
"base" || provider.empty()) {
750 return std::make_unique<RSA_Verify_Operation>(*
this, params);
761 if(sig_info.empty() || sig_info.size() != 2 || sig_info[0] !=
"RSA") {
762 throw Decoding_Error(
"Unknown AlgorithmIdentifier for RSA X.509 signatures");
765 std::string padding = sig_info[1];
767 if(padding ==
"PSS") {
770 throw Decoding_Error(
"PSS params must be provided");
777 const std::string hash_algo = pss_params.hash_function();
778 if(hash_algo !=
"SHA-1" && hash_algo !=
"SHA-224" && hash_algo !=
"SHA-256" && hash_algo !=
"SHA-384" &&
779 hash_algo !=
"SHA-512" && hash_algo !=
"SHA-3(224)" && hash_algo !=
"SHA-3(256)" &&
780 hash_algo !=
"SHA-3(384)" && hash_algo !=
"SHA-3(512)") {
781 throw Decoding_Error(
"Unacceptable hash for PSS signatures");
784 if(pss_params.mgf_function() !=
"MGF1") {
785 throw Decoding_Error(
"Unacceptable MGF for PSS signatures");
790 if(pss_params.hash_algid() != pss_params.mgf_hash_algid()) {
791 throw Decoding_Error(
"Unacceptable MGF hash for PSS signatures");
794 if(pss_params.trailer_field() != 1) {
795 throw Decoding_Error(
"Unacceptable trailer field for PSS signatures");
798 padding +=
fmt(
"({},MGF1,{})", hash_algo, pss_params.salt_length());
807 std::string_view provider)
const {
808 if(provider ==
"base" || provider.empty()) {
809 return std::make_unique<RSA_Verify_Operation>(*
this, parse_rsa_signature_algorithm(alg_id));
816 std::string_view params,
817 std::string_view provider)
const {
818 if(provider ==
"base" || provider.empty()) {
819 return std::make_unique<RSA_Decryption_Operation>(*
this, params, rng);
826 std::string_view params,
827 std::string_view provider)
const {
828 if(provider ==
"base" || provider.empty()) {
829 return std::make_unique<RSA_KEM_Decryption_Operation>(*
this, params, rng);
836 std::string_view params,
837 std::string_view provider)
const {
838 if(provider ==
"base" || provider.empty()) {
839 return std::make_unique<RSA_Signature_Operation>(*
this, params, rng);
#define BOTAN_DEBUG_ASSERT(expr)
#define BOTAN_ASSERT(expr, assertion_made)
const std::vector< uint8_t > & parameters() const
virtual const BigInt & get_int_field(std::string_view field) const
virtual OID object_identifier() const
BER_Decoder & decode(bool &out)
BER_Decoder start_sequence()
BER_Decoder & decode_and_check(const T &expected, std::string_view error_msg)
static BigInt from_u64(uint64_t n)
secure_vector< uint8_t > get_contents()
DER_Encoder & start_sequence()
DER_Encoder & encode(bool b)
static Montgomery_Int from_wide_int(const std::shared_ptr< const Montgomery_Params > ¶ms, const BigInt &x)
std::string to_formatted_string() const
const BigInt & get_q() const
const BigInt & get_int_field(std::string_view field) const override
std::shared_ptr< const RSA_Private_Data > private_data() const
std::unique_ptr< PK_Ops::Decryption > create_decryption_op(RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
const BigInt & get_c() const
std::unique_ptr< PK_Ops::Signature > create_signature_op(RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
RSA_PrivateKey(const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
const BigInt & get_p() const
const BigInt & get_d2() const
bool check_key(RandomNumberGenerator &rng, bool) const override
const BigInt & get_d() const
secure_vector< uint8_t > private_key_bits() const override
std::unique_ptr< PK_Ops::KEM_Decryption > create_kem_decryption_op(RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
std::unique_ptr< Public_Key > public_key() const override
const BigInt & get_d1() const
std::unique_ptr< PK_Ops::Encryption > create_encryption_op(RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
void init(BigInt &&n, BigInt &&e)
size_t key_length() const override
std::unique_ptr< PK_Ops::Verification > create_verification_op(std::string_view params, std::string_view provider) const override
std::unique_ptr< PK_Ops::Verification > create_x509_verification_op(const AlgorithmIdentifier &alg_id, std::string_view provider) const override
const BigInt & get_int_field(std::string_view field) const override
const BigInt & get_n() const
size_t estimated_strength() const override
std::unique_ptr< PK_Ops::KEM_Encryption > create_kem_encryption_op(std::string_view params, std::string_view provider) const override
std::unique_ptr< Private_Key > generate_another(RandomNumberGenerator &rng) const override
std::vector< uint8_t > raw_public_key_bits() const override
AlgorithmIdentifier algorithm_identifier() const override
std::vector< uint8_t > public_key_bits() const override
std::shared_ptr< const RSA_Public_Data > m_public
std::shared_ptr< const RSA_Public_Data > public_data() const
const BigInt & get_e() const
bool supports_operation(PublicKeyOperation op) const override
bool check_key(RandomNumberGenerator &rng, bool) const override
auto run(F &&f, Args &&... args) -> std::future< typename std::invoke_result< F, Args... >::type >
static Thread_Pool & global_instance()
int(* update)(CTX *, const void *, CC_LONG len)
int(* final)(unsigned char *, CTX *)
bool signature_consistency_check(RandomNumberGenerator &rng, const Private_Key &private_key, const Public_Key &public_key, std::string_view padding)
BigInt inverse_mod_secret_prime(const BigInt &x, const BigInt &p)
std::string fmt(std::string_view format, const T &... args)
BigInt lcm(const BigInt &a, const BigInt &b)
std::vector< std::string > split_on(std::string_view str, char delim)
size_t low_zero_bits(const BigInt &n)
Montgomery_Int monty_execute_vartime(const Montgomery_Exponentation_State &precomputed_state, const BigInt &k)
bool is_prime(const BigInt &n, RandomNumberGenerator &rng, size_t prob, bool is_random)
BigInt ct_modulo(const BigInt &x, const BigInt &y)
BigInt compute_rsa_secret_exponent(const BigInt &e, const BigInt &phi_n, const BigInt &p, const BigInt &q)
Montgomery_Int monty_exp(const std::shared_ptr< const Montgomery_Params > ¶ms_p, const BigInt &g, const BigInt &k, size_t max_k_bits)
BigInt generate_rsa_prime(RandomNumberGenerator &keygen_rng, RandomNumberGenerator &prime_test_rng, size_t bits, const BigInt &coprime, size_t prob)
Montgomery_Int monty_execute(const Montgomery_Exponentation_State &precomputed_state, const BigInt &k, size_t max_k_bits)
std::vector< T, secure_allocator< T > > secure_vector
BigInt inverse_mod_rsa_public_modulus(const BigInt &x, const BigInt &n)
size_t if_work_factor(size_t bits)
std::shared_ptr< const Montgomery_Exponentation_State > monty_precompute(const Montgomery_Int &g, size_t window_bits, bool const_time)