Botan 3.14.1
Crypto and TLS for C&
Botan::RSA_PrivateKey Class Referencefinal

#include <rsa.h>

Inheritance diagram for Botan::RSA_PrivateKey:
Botan::Private_Key Botan::RSA_PublicKey Botan::Public_Key Botan::Public_Key Botan::Asymmetric_Key Botan::Asymmetric_Key

Public Member Functions

std::unique_ptr< PK_Ops::Decryption > _create_decryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const override
std::unique_ptr< PK_Ops::Encryption > _create_encryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const override
std::unique_ptr< PK_Ops::KEM_Decryption > _create_kem_decryption_op (RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const override
std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op (const PK_KEM_Options_Reader &options) const override
virtual std::unique_ptr< PK_Ops::Key_Agreement > _create_key_agreement_op (RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const
std::unique_ptr< PK_Ops::Signature > _create_signature_op (RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const override
std::unique_ptr< PK_Ops::Verification > _create_verification_op (const PK_Signature_Options_Reader &options) const override
virtual Signature_Format _default_x509_signature_format () const
virtual std::optional< size_t > _signature_element_size_for_DER_encoding () const
std::string algo_name () const override
AlgorithmIdentifier algorithm_identifier () const override
bool check_key (RandomNumberGenerator &rng, bool strong) const override
std::unique_ptr< PK_Ops::Decryption > create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Encryption > create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::KEM_Decryption > create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::KEM_Encryption > create_kem_encryption_op (std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Key_Agreement > create_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Signature > create_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Verification > create_verification_op (std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Verification > create_x509_verification_op (const AlgorithmIdentifier &alg_id, std::string_view provider) const override
Signature_Format default_x509_signature_format () const
size_t estimated_strength () const override
std::string fingerprint_private (std::string_view alg) const
std::string fingerprint_public (std::string_view alg="SHA-256") const
std::unique_ptr< Private_Key > generate_another (RandomNumberGenerator &rng) const override
const BigInt & get_c () const
const BigInt & get_d () const
const BigInt & get_d1 () const
const BigInt & get_d2 () const
const BigInt & get_e () const
const BigInt & get_int_field (std::string_view field) const override
const BigInt & get_n () const
OID get_oid () const
const BigInt & get_p () const
const BigInt & get_q () const
size_t key_length () const override
size_t message_part_size () const
size_t message_parts () const
virtual OID object_identifier () const
virtual AlgorithmIdentifier pkcs8_algorithm_identifier () const
std::shared_ptr< const RSA_Private_Data > private_data () const
secure_vector< uint8_t > private_key_bits () const override
secure_vector< uint8_t > private_key_info () const
std::shared_ptr< const RSA_Public_Data > public_data () const
std::unique_ptr< Public_Key > public_key () const override
std::vector< uint8_t > public_key_bits () const override
virtual secure_vector< uint8_t > raw_private_key_bits () const
std::vector< uint8_t > raw_public_key_bits () const override
virtual std::optional< uint64_t > remaining_operations () const
 Retrieves the number of remaining operations if this is a stateful private key.
 RSA_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
 RSA_PrivateKey (const BigInt &p, const BigInt &q, const BigInt &e, const BigInt &d=BigInt::zero(), const BigInt &n=BigInt::zero())
 RSA_PrivateKey (RandomNumberGenerator &rng, size_t bits, size_t exp=65537)
virtual bool stateful_operation () const
std::vector< uint8_t > subject_public_key () const
bool supports_operation (PublicKeyOperation op) const override

Protected Member Functions

void init (BigInt &&n, BigInt &&e)

Protected Attributes

std::shared_ptr< const RSA_Public_Data > m_public

Detailed Description

RSA Private Key

Definition at line 100 of file rsa.h.

Constructor & Destructor Documentation

◆ RSA_PrivateKey() [1/3]

Botan::RSA_PrivateKey::RSA_PrivateKey ( const AlgorithmIdentifier & alg_id,
std::span< const uint8_t > key_bits )

Load a private key.

Parameters
alg_idthe X.509 algorithm identifier
key_bitsPKCS#1 RSAPrivateKey bits

Definition at line 545 of file rsa.cpp.

545 {
546 if(alg_id.oid().registered_name() == "RSA" && !alg_id.parameters_are_null_or_empty()) {
547 throw Decoding_Error("Unexpected parameters for RSA private key");
548 }
549
550 BigInt n;
551 BigInt e;
552 BigInt d;
553 BigInt p;
554 BigInt q;
555 BigInt d1;
556 BigInt d2;
557 BigInt c;
558
559 BER_Decoder(key_bits, BER_Decoder::Limits::DER())
560 .start_sequence()
561 .decode_and_check<size_t>(0, "Unknown PKCS #1 key format version")
562 .decode(n)
563 .decode(e)
564 .decode(d)
565 .decode(p)
566 .decode(q)
567 .decode(d1)
568 .decode(d2)
569 .decode(c)
570 .end_cons()
571 .verify_end();
572
573 RSA_PublicKey::init(std::move(n), std::move(e));
574
575 RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
576
577 check_rsa_secret_exponent(get_e(), get_d(), get_p(), get_q());
578}
static Limits DER()
Definition ber_dec.h:44
const BigInt & get_q() const
Definition rsa.cpp:476
const BigInt & get_p() const
Definition rsa.cpp:472
const BigInt & get_d() const
Definition rsa.cpp:480
void init(BigInt &&n, BigInt &&e)
Definition rsa.cpp:381
const BigInt & get_e() const
Definition rsa.cpp:377
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
Definition pem.cpp:64

References Botan::BER_Decoder::decode_and_check(), Botan::BER_Decoder::Limits::DER(), get_d(), Botan::RSA_PublicKey::get_e(), get_p(), get_q(), Botan::RSA_PublicKey::init(), Botan::AlgorithmIdentifier::oid(), Botan::AlgorithmIdentifier::parameters_are_null_or_empty(), Botan::OID::registered_name(), and Botan::BER_Decoder::start_sequence().

◆ RSA_PrivateKey() [2/3]

Botan::RSA_PrivateKey::RSA_PrivateKey ( const BigInt & p,
const BigInt & q,
const BigInt & e,
const BigInt & d = BigInt::zero(),
const BigInt & n = BigInt::zero() )

Construct a private key from the specified parameters.

Parameters
pthe first prime
qthe second prime
ethe exponent
dif specified, this has to be d with exp * d = 1 mod (p - 1, q - 1). Leave it as 0 if you wish to the constructor to calculate it.
nif specified, this must be n = p * q. Leave it as 0 if you wish to the constructor to calculate it.

Definition at line 580 of file rsa.cpp.

581 {
582 BigInt p = prime1;
583 BigInt q = prime2;
584 BigInt n = mod;
585 if(n.is_zero()) {
586 n = p * q;
587 }
588
589 BigInt e = exp;
590
591 RSA_PublicKey::init(std::move(n), std::move(e));
592
593 // Validated early since the arithmetic below depends on it
594 check_rsa_private_key_params(get_n(), p, q);
595
596 BigInt d = d_exp;
597 const bool compute_d = d.is_zero();
598
599 if(!compute_d) {
600 check_rsa_secret_exponent(get_e(), d, p, q);
601 }
602
603 CT::poison_all(p, q, d);
604
605 const BigInt p_minus_1 = p - 1;
606 const BigInt q_minus_1 = q - 1;
607
608 if(compute_d) {
609 const BigInt phi_n = lcm(p_minus_1, q_minus_1);
610 if(auto d_inv = compute_rsa_secret_exponent(get_e(), phi_n, p, q)) {
611 d = std::move(*d_inv);
612 } else {
613 throw Decoding_Error("Invalid RSA private key: e has no inverse modulo lcm(p-1, q-1)");
614 }
615 }
616
617 BigInt d1 = ct_modulo(d, p_minus_1);
618 BigInt d2 = ct_modulo(d, q_minus_1);
619
620 const BigInt q_mod_p = ct_modulo(q, p);
621 if(q_mod_p.is_zero()) {
622 throw Decoding_Error("Invalid RSA private key: p divides q");
623 }
624 BigInt c = inverse_mod_secret_prime(q_mod_p, p);
625
626 CT::unpoison_all(p, q, d, d1, d2, c);
627
628 RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
629}
const BigInt & get_n() const
Definition rsa.cpp:373
constexpr void poison_all(const Ts &... ts)
Definition ct_utils.h:201
constexpr void unpoison_all(const Ts &... ts)
Definition ct_utils.h:207
BigInt inverse_mod_secret_prime(const BigInt &x, const BigInt &p)
Definition mod_inv.cpp:278
std::optional< BigInt > compute_rsa_secret_exponent(const BigInt &e, const BigInt &phi_n, const BigInt &p, const BigInt &q)
Definition mod_inv.cpp:337
BigInt lcm(const BigInt &a, const BigInt &b)
Definition numthry.cpp:296
BigInt ct_modulo(const BigInt &x, const BigInt &y)
Definition divide.cpp:262

References Botan::compute_rsa_secret_exponent(), Botan::ct_modulo(), Botan::RSA_PublicKey::get_e(), Botan::RSA_PublicKey::get_n(), Botan::RSA_PublicKey::init(), Botan::inverse_mod_secret_prime(), Botan::BigInt::is_zero(), Botan::lcm(), Botan::CT::poison_all(), and Botan::CT::unpoison_all().

◆ RSA_PrivateKey() [3/3]

Botan::RSA_PrivateKey::RSA_PrivateKey ( RandomNumberGenerator & rng,
size_t bits,
size_t exp = 65537 )

Create a new private key with the specified bit length

Parameters
Random Number Generatorsthe random number generator to use
bitsthe desired bit length of the private key
expthe public exponent to be used

Definition at line 634 of file rsa.cpp.

634 {
635 constexpr size_t MIN_RSA_BITS = 1024;
636 constexpr size_t MOD_RSA_BITS = 8;
637
638 if(bits < MIN_RSA_BITS) {
639 throw Invalid_Argument(fmt("Cannot create an RSA key of {} bits: must be at least {} bits", bits, MIN_RSA_BITS));
640 } else if(bits > MAX_RSA_BITS) {
641 throw Invalid_Argument(
642 fmt("Cannot create an RSA key of {} bits: must be no more than {} bits", bits, MAX_RSA_BITS));
643 } else if(bits % MOD_RSA_BITS != 0) {
644 throw Invalid_Argument(
645 fmt("Cannot create an RSA key of {} bits: must be a multiple of {} bits", bits, MOD_RSA_BITS));
646 }
647
648 if(exp < 3 || exp % 2 == 0) {
649 throw Invalid_Argument("Invalid RSA encryption exponent");
650 }
651
652 const size_t p_bits = (bits + 1) / 2;
653 const size_t q_bits = bits - p_bits;
654
655 BigInt p;
656 BigInt q;
657 BigInt n;
658 BigInt e = BigInt::from_u64(exp);
659
660 for(size_t attempt = 0;; ++attempt) {
661 if(attempt > 10) {
662 throw Internal_Error("RNG failure during RSA key generation");
663 }
664
665 // TODO could generate primes in thread pool
666 p = generate_rsa_prime(rng, rng, p_bits, e);
667 q = generate_rsa_prime(rng, rng, q_bits, e);
668 CT::poison_all(p, q);
669
670 const BigInt diff = p - q;
671 if(diff.bits() < (bits / 2) - 100) {
672 continue;
673 }
674
675 n = p * q;
676 CT::unpoison(n);
677
678 if(n.bits() != bits) {
679 continue;
680 }
681
682 break;
683 }
684
685 const BigInt p_minus_1 = p - 1;
686 const BigInt q_minus_1 = q - 1;
687
688 const BigInt phi_n = lcm(p_minus_1, q_minus_1);
689 // This is guaranteed because p,q == 3 mod 4
691
692 // generate_rsa_prime ensures gcd(e, p-1) == gcd(e, q-1) == 1 so the inverse exists
693 auto d = compute_rsa_secret_exponent(e, phi_n, p, q);
694 BOTAN_ASSERT_NOMSG(d.has_value());
695
696 BigInt d1 = ct_modulo(*d, p_minus_1);
697 BigInt d2 = ct_modulo(*d, q_minus_1);
698 BigInt c = inverse_mod_secret_prime(ct_modulo(q, p), p);
699
700 CT::unpoison_all(p, q, *d, d1, d2, c);
701
702 RSA_PublicKey::init(std::move(n), std::move(e));
703
704 RSA_PrivateKey::init(std::move(*d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
705}
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:82
#define BOTAN_DEBUG_ASSERT(expr)
Definition assert.h:136
static BigInt from_u64(uint64_t n)
Definition bigint.cpp:31
constexpr void unpoison(const T *p, size_t n)
Definition ct_utils.h:67
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53
size_t low_zero_bits(const BigInt &n)
Definition numthry.cpp:194
BigInt generate_rsa_prime(RandomNumberGenerator &keygen_rng, RandomNumberGenerator &prime_test_rng, size_t bits, const BigInt &coprime, size_t prob)
Definition make_prm.cpp:252

References Botan::BigInt::bits(), BOTAN_ASSERT_NOMSG, BOTAN_DEBUG_ASSERT, Botan::compute_rsa_secret_exponent(), Botan::ct_modulo(), Botan::fmt(), Botan::BigInt::from_u64(), Botan::generate_rsa_prime(), Botan::RSA_PublicKey::init(), Botan::inverse_mod_secret_prime(), Botan::lcm(), Botan::low_zero_bits(), Botan::CT::poison_all(), Botan::CT::unpoison(), and Botan::CT::unpoison_all().

Member Function Documentation

◆ _create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::RSA_PrivateKey::_create_decryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) const
overridevirtual

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a decryption operation for this key/options or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
optionswhich specify parameters of the encryption beyond those implicit to the key itself

Reimplemented from Botan::Private_Key.

Definition at line 1205 of file rsa.cpp.

1206 {
1208
1209 return std::make_unique<RSA_Decryption_Operation>(*this, options, rng);
1210}
std::string algo_name() const override
Definition rsa.h:41
void require_software_provider(const OptionsT &options, std::string_view algo_name)

References Botan::RSA_PublicKey::algo_name(), and Botan::require_software_provider().

◆ _create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::RSA_PublicKey::_create_encryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) const
overridevirtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return an encryption operation for this key/options or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
optionswhich specify parameters of the encryption beyond those implicit to the public key itself

Reimplemented from Botan::Public_Key.

Reimplemented in Botan::TPM2::RSA_PublicKey.

Definition at line 1105 of file rsa.cpp.

1106 {
1107 BOTAN_UNUSED(rng);
1109
1110 return std::make_unique<RSA_Encryption_Operation>(*this, options);
1111}
#define BOTAN_UNUSED
Definition assert.h:151

References algo_name(), BOTAN_UNUSED, and Botan::require_software_provider().

◆ _create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::RSA_PrivateKey::_create_kem_decryption_op ( RandomNumberGenerator & rng,
const PK_KEM_Options_Reader & options ) const
overridevirtual

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a KEM decryption operation for this key/options or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
optionswhich specify parameters of the KEM beyond those implicit to the key itself

Reimplemented from Botan::Private_Key.

Definition at line 1212 of file rsa.cpp.

1213 {
1215
1216 return std::make_unique<RSA_KEM_Decryption_Operation>(*this, options, rng);
1217}

References Botan::RSA_PublicKey::algo_name(), and Botan::require_software_provider().

◆ _create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::RSA_PublicKey::_create_kem_encryption_op ( const PK_KEM_Options_Reader & options) const
overridevirtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a KEM encryption operation for this key/options or throw

Parameters
optionswhich specify parameters of the KEM beyond those implicit to the public key itself

Reimplemented from Botan::Public_Key.

Definition at line 1113 of file rsa.cpp.

1114 {
1116
1117 return std::make_unique<RSA_KEM_Encryption_Operation>(*this, options);
1118}

References algo_name(), and Botan::require_software_provider().

◆ _create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::_create_key_agreement_op ( RandomNumberGenerator & rng,
const PK_Key_Agreement_Options_Reader & options ) const
virtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a key agreement operation for this key/options or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
optionswhich specify parameters of the key agreement beyond those implicit to the key itself

Reimplemented in Botan::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 148 of file pk_keys.cpp.

149 {
150 BOTAN_UNUSED(rng, options);
151 throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
152}
virtual std::string algo_name() const =0

References Botan::Asymmetric_Key::algo_name(), BOTAN_UNUSED, and Botan::fmt().

Referenced by create_key_agreement_op(), and Botan::PK_Key_Agreement::PK_Key_Agreement().

◆ _create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::RSA_PrivateKey::_create_signature_op ( RandomNumberGenerator & rng,
const PK_Signature_Options_Reader & options ) const
overridevirtual

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a signature operation for this key/params or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
optionsallow controlling behavior

Reimplemented from Botan::Private_Key.

Definition at line 1219 of file rsa.cpp.

1220 {
1222
1223 return std::make_unique<RSA_Signature_Operation>(*this, options, rng);
1224}

References Botan::RSA_PublicKey::algo_name(), and Botan::require_software_provider().

◆ _create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::RSA_PublicKey::_create_verification_op ( const PK_Signature_Options_Reader & options) const
overridevirtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a verification operation for this key/params or throw

Parameters
optionswhich specify parameters of the signature beyond those implicit to the public key itself

Reimplemented from Botan::Public_Key.

Reimplemented in Botan::TPM2::RSA_PublicKey.

Definition at line 1120 of file rsa.cpp.

1121 {
1123
1124 return std::make_unique<RSA_Verify_Operation>(*this, options);
1125}

References algo_name(), and Botan::require_software_provider().

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const
virtualinherited

◆ _signature_element_size_for_DER_encoding()

virtual std::optional< size_t > Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding ( ) const
inlinevirtualinherited

Certain signatures schemes such as ECDSA have more than one element, and certain unfortunate protocols decided the thing to do was not concatenate them as normally done, but instead DER encode each of the elements as independent values.

If this returns a value x then the signature is checked to be exactly 2*x bytes and split in half for DER encoding.

Reimplemented in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 148 of file pk_keys.h.

148{ return {}; }

Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ algo_name()

◆ algorithm_identifier()

AlgorithmIdentifier Botan::RSA_PublicKey::algorithm_identifier ( ) const
overridevirtualinherited

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 426 of file rsa.cpp.

426 {
427 return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_NULL_PARAM);
428}
virtual OID object_identifier() const
Definition pk_keys.cpp:24

References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

Referenced by Botan::TPM2::RSA_PrivateKey::public_key().

◆ check_key()

bool Botan::RSA_PrivateKey::check_key ( RandomNumberGenerator & rng,
bool strong ) const
overridevirtual

Test the key values for consistency.

Note this function is always "best effort"; for many algorithms it is not computationally possible to ensure the key is correctly formed in all respects. There is always the possibility a malformed key will be accepted; this is especially the case for public keys.

Parameters
Random Number Generatorsrng to use for randomized testing (may be ignored)
strongwhether to perform strong and lengthy version of the test, however for many algorithms this has no effect
Returns
true if the tests passed

Implements Botan::Asymmetric_Key.

Definition at line 732 of file rsa.cpp.

732 {
733 if(get_n() < 35 || get_n().is_even() || get_e() < 3 || get_e().is_even()) {
734 return false;
735 }
736
737 const auto scope = CT::scoped_poison(*m_private);
738
739 if(get_d() < 2 || get_p() < 3 || get_q() < 3) {
740 return false;
741 }
742
743 if(get_p() * get_q() != get_n()) {
744 return false;
745 }
746
747 if(get_p() == get_q()) {
748 return false;
749 }
750
751 if(get_d1() != ct_modulo(get_d(), get_p() - 1)) {
752 return false;
753 }
754 if(get_d2() != ct_modulo(get_d(), get_q() - 1)) {
755 return false;
756 }
758 return false;
759 }
760
761 const size_t prob = (strong) ? 128 : 12;
762
763 if(!is_prime(get_p(), rng, prob)) {
764 return false;
765 }
766 if(!is_prime(get_q(), rng, prob)) {
767 return false;
768 }
769
770 if(strong) {
771 if(ct_modulo(get_e() * get_d(), lcm(get_p() - 1, get_q() - 1)) != 1) {
772 return false;
773 }
774
775#if defined(BOTAN_HAS_PSS) && defined(BOTAN_HAS_SHA_256)
776 const std::string padding = "PSS(SHA-256)";
777#else
778 const std::string padding = "Raw";
779#endif
780
781 return KeyPair::signature_consistency_check(rng, *this, padding);
782 }
783
784 return true;
785}
const BigInt & get_c() const
Definition rsa.cpp:484
const BigInt & get_d2() const
Definition rsa.cpp:492
const BigInt & get_d1() const
Definition rsa.cpp:488
constexpr auto scoped_poison(const Ts &... xs)
Definition ct_utils.h:222
bool signature_consistency_check(RandomNumberGenerator &rng, const Private_Key &private_key, const Public_Key &public_key, std::string_view padding)
Definition keypair.cpp:49
bool is_prime(const BigInt &n, RandomNumberGenerator &rng, size_t prob, bool is_random)
Definition numthry.cpp:449

References Botan::ct_modulo(), get_c(), get_d(), get_d1(), get_d2(), Botan::RSA_PublicKey::get_e(), Botan::RSA_PublicKey::get_n(), get_p(), get_q(), Botan::inverse_mod_secret_prime(), Botan::is_prime(), Botan::lcm(), Botan::CT::scoped_poison(), and Botan::KeyPair::signature_consistency_check().

◆ create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return an decryption operation for this key/params or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
paramsadditional parameters
providerthe provider to use

Definition at line 185 of file pk_keys.cpp.

187 {
188 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
189 const auto reader = PK_Options_Reader_Access::read(options);
190 auto op = this->_create_decryption_op(rng, reader);
192 return op;
193}
PK_Encryption_Options with_provider(std::string_view provider)
static void throw_if_unexamined(const ReaderT &reader, std::string_view algo_name)
static PK_Encryption_Options_Reader read(const PK_Encryption_Options &options)
virtual std::unique_ptr< PK_Ops::Decryption > _create_decryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:130
PK_Encryption_Options parse_legacy_enc_options(const Public_Key &key, std::string_view params)

References _create_decryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_enc_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Encryption_Options::with_provider().

◆ create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return an encryption operation for this key/params or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
paramsadditional parameters
providerthe provider to use

Definition at line 175 of file pk_keys.cpp.

177 {
178 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
179 const auto reader = PK_Options_Reader_Access::read(options);
180 auto op = this->_create_encryption_op(rng, reader);
182 return op;
183}
virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:107

References _create_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_enc_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Encryption_Options::with_provider().

◆ create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::create_kem_decryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a KEM decryption operation for this key/params or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
paramsadditional parameters
providerthe provider to use

Definition at line 204 of file pk_keys.cpp.

206 {
207 const auto options = parse_legacy_kem_options(params).with_provider(provider);
208 const auto reader = PK_Options_Reader_Access::read(options);
209 auto op = this->_create_kem_decryption_op(rng, reader);
211 return op;
212}
PK_KEM_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::KEM_Decryption > _create_kem_decryption_op(RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:136
PK_KEM_Options parse_legacy_kem_options(std::string_view params)

References _create_kem_decryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_kem_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_KEM_Options::with_provider().

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op ( std::string_view params,
std::string_view provider ) const
inherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a KEM encryption operation for this key/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Definition at line 195 of file pk_keys.cpp.

196 {
197 const auto options = parse_legacy_kem_options(params).with_provider(provider);
198 const auto reader = PK_Options_Reader_Access::read(options);
199 auto op = this->_create_kem_encryption_op(reader);
201 return op;
202}
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op(const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:113

References _create_kem_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_kem_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_KEM_Options::with_provider().

◆ create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::create_key_agreement_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a key agreement operation for this key/params or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
paramsadditional parameters
providerthe provider to use

Definition at line 214 of file pk_keys.cpp.

216 {
217 const auto options = parse_legacy_ka_options(params).with_provider(provider);
218 const auto reader = PK_Options_Reader_Access::read(options);
219 auto op = this->_create_key_agreement_op(rng, reader);
221 return op;
222}
PK_Key_Agreement_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Key_Agreement > _create_key_agreement_op(RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const
Definition pk_keys.cpp:148
PK_Key_Agreement_Options parse_legacy_ka_options(std::string_view params)

References _create_key_agreement_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_ka_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Key_Agreement_Options::with_provider().

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::create_signature_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a signature operation for this key/params or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
paramsadditional parameters
providerthe provider to use

Definition at line 165 of file pk_keys.cpp.

167 {
168 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
169 const auto reader = PK_Options_Reader_Access::for_signing(options);
170 auto op = this->_create_signature_op(rng, reader);
172 return op;
173}
static PK_Signature_Options_Reader for_signing(const PK_Signature_Options &options)
PK_Signature_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Signature > _create_signature_op(RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:142
PK_Signature_Options parse_legacy_sig_options(const Public_Key &key, std::string_view params)

References _create_signature_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_signing(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op ( std::string_view params,
std::string_view provider ) const
inherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a verification operation for this key/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Definition at line 156 of file pk_keys.cpp.

157 {
158 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
159 const auto reader = PK_Options_Reader_Access::for_verification(options);
160 auto op = this->_create_verification_op(reader);
162 return op;
163}
static PK_Signature_Options_Reader for_verification(const PK_Signature_Options &options)
virtual std::unique_ptr< PK_Ops::Verification > _create_verification_op(const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:119

References _create_verification_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_verification(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::RSA_PublicKey::create_x509_verification_op ( const AlgorithmIdentifier & signature_algorithm,
std::string_view provider ) const
overridevirtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a verification operation for this combination of key and signature algorithm or throw.

Parameters
signature_algorithmis the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 1195 of file rsa.cpp.

1196 {
1197 if(provider == "base" || provider.empty()) {
1198 return std::make_unique<RSA_Verify_Operation>(
1199 *this, PK_Options_Reader_Access::for_verification(parse_rsa_signature_algorithm(alg_id)));
1200 }
1201
1202 throw Provider_Not_Found(algo_name(), provider);
1203}

References algo_name(), and Botan::PK_Options_Reader_Access::for_verification().

◆ default_x509_signature_format()

Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const
inlineinherited

Definition at line 245 of file pk_keys.h.

245 {
247 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:32

References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().

Referenced by default_x509_signature_format().

◆ estimated_strength()

size_t Botan::RSA_PublicKey::estimated_strength ( ) const
overridevirtualinherited

Return the estimated strength of the underlying key against the best currently known attack. Note that this ignores anything but pure attacks against the key itself and do not take into account padding schemes, usage mistakes, etc which might reduce the strength. However it does suffice to provide an upper bound.

Returns
estimated strength in bits

Implements Botan::Asymmetric_Key.

Definition at line 422 of file rsa.cpp.

422 {
423 return if_work_factor(key_length());
424}
size_t key_length() const override
Definition rsa.cpp:418
size_t if_work_factor(size_t bits)

References Botan::if_work_factor(), and key_length().

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg) const
inherited
Returns
Hash of the algorithm specific private key encoding
Warning
This hashes private_key_bits(), which does not include the algorithm identifier; keys of different algorithms with identical raw encodings (such as an Ed25519 and an X25519 key built from the same 32 bytes) share a fingerprint.

Definition at line 103 of file pk_keys.cpp.

103 {
104 return create_hex_fingerprint(private_key_bits(), hash_algo);
105}
virtual secure_vector< uint8_t > private_key_bits() const =0
std::string create_hex_fingerprint(std::span< const uint8_t > bits, std::string_view hash_name)
Definition pk_keys.cpp:40

References Botan::create_hex_fingerprint(), and private_key_bits().

Referenced by Botan::Certificate_Store_In_SQL::find_certs_for_key(), Botan::Certificate_Store_In_SQL::insert_key(), and Botan::Certificate_Store_In_SQL::remove_key().

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( std::string_view alg = "SHA-256") const
inherited
Returns
Hash of the subject public key

Definition at line 96 of file pk_keys.cpp.

96 {
97 return create_hex_fingerprint(subject_public_key(), hash_algo);
98}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:65

References Botan::create_hex_fingerprint(), and subject_public_key().

Referenced by public_key_bits().

◆ generate_another()

std::unique_ptr< Private_Key > Botan::RSA_PublicKey::generate_another ( RandomNumberGenerator & rng) const
overridevirtualinherited

Generate another (cryptographically independent) key pair using the same algorithm parameters as this key. This is most useful for algorithms that support PublicKeyOperation::KeyAgreement to generate a fitting ephemeral key pair. For other key types it might throw Not_Implemented.

Implements Botan::Asymmetric_Key.

Reimplemented in Botan::TPM2::RSA_PublicKey.

Definition at line 369 of file rsa.cpp.

369 {
370 return std::make_unique<RSA_PrivateKey>(rng, m_public->public_modulus_bits(), 65537);
371}
std::shared_ptr< const RSA_Public_Data > m_public
Definition rsa.h:90

References m_public.

◆ get_c()

const BigInt & Botan::RSA_PrivateKey::get_c ( ) const

Definition at line 484 of file rsa.cpp.

484 {
485 return m_private->get_c();
486}

Referenced by check_key(), and private_key_bits().

◆ get_d()

const BigInt & Botan::RSA_PrivateKey::get_d ( ) const

Get d with exp * d = 1 mod (p - 1, q - 1).

Returns
d

Definition at line 480 of file rsa.cpp.

480 {
481 return m_private->get_d();
482}

Referenced by check_key(), private_key_bits(), and RSA_PrivateKey().

◆ get_d1()

const BigInt & Botan::RSA_PrivateKey::get_d1 ( ) const

Definition at line 488 of file rsa.cpp.

488 {
489 return m_private->get_d1();
490}

Referenced by check_key(), and private_key_bits().

◆ get_d2()

const BigInt & Botan::RSA_PrivateKey::get_d2 ( ) const

Definition at line 492 of file rsa.cpp.

492 {
493 return m_private->get_d2();
494}

Referenced by check_key(), and private_key_bits().

◆ get_e()

const BigInt & Botan::RSA_PublicKey::get_e ( ) const
inherited

◆ get_int_field()

const BigInt & Botan::RSA_PrivateKey::get_int_field ( std::string_view field) const
overridevirtual

Access an algorithm specific field

If the field is not known for this algorithm, an Invalid_Argument is thrown. The interpretation of the result requires knowledge of which algorithm is involved. For instance for RSA "p" represents one of the secret primes, while for DSA "p" is the public prime.

Some algorithms may not implement this method at all.

This is primarily used to implement the FFI botan_pubkey_get_field and botan_privkey_get_field functions.

TODO(Botan4) Change this to return by value

Reimplemented from Botan::Asymmetric_Key.

Definition at line 707 of file rsa.cpp.

707 {
708 if(field == "p") {
709 return m_private->get_p();
710 } else if(field == "q") {
711 return m_private->get_q();
712 } else if(field == "d") {
713 return m_private->get_d();
714 } else if(field == "c") {
715 return m_private->get_c();
716 } else if(field == "d1") {
717 return m_private->get_d1();
718 } else if(field == "d2") {
719 return m_private->get_d2();
720 } else {
721 return RSA_PublicKey::get_int_field(field);
722 }
723}
const BigInt & get_int_field(std::string_view field) const override
Definition rsa.cpp:359

References Botan::RSA_PublicKey::get_int_field().

◆ get_n()

const BigInt & Botan::RSA_PublicKey::get_n ( ) const
inherited

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const
inlineinherited

Deprecated version of object_identifier

Definition at line 172 of file pk_keys.h.

172{ return this->object_identifier(); }

References get_oid(), and Botan::Asymmetric_Key::object_identifier().

Referenced by get_oid().

◆ get_p()

const BigInt & Botan::RSA_PrivateKey::get_p ( ) const

Get the first prime p.

Returns
prime p

Definition at line 472 of file rsa.cpp.

472 {
473 return m_private->get_p();
474}

Referenced by check_key(), private_key_bits(), and RSA_PrivateKey().

◆ get_q()

const BigInt & Botan::RSA_PrivateKey::get_q ( ) const

Get the second prime q.

Returns
prime q

Definition at line 476 of file rsa.cpp.

476 {
477 return m_private->get_q();
478}

Referenced by check_key(), private_key_bits(), and RSA_PrivateKey().

◆ init()

void Botan::RSA_PublicKey::init ( BigInt && n,
BigInt && e )
protectedinherited

Definition at line 381 of file rsa.cpp.

381 {
382 if(n.signum() <= 0 || n.is_even() || n.bits() < 384 || n.bits() > MAX_RSA_BITS) {
383 throw Decoding_Error("Invalid RSA public key modulus");
384 }
385 if(e.is_even() || e <= 1 || e >= n || e.bits() > 256) {
386 throw Decoding_Error("Invalid RSA public key exponent");
387 }
388 m_public = std::make_shared<RSA_Public_Data>(std::move(n), std::move(e));
389}

References m_public.

Referenced by Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), RSA_PublicKey(), RSA_PublicKey(), and RSA_PublicKey().

◆ key_length()

size_t Botan::RSA_PublicKey::key_length ( ) const
overridevirtualinherited

Return an integer value best approximating the length of the primary security parameter. For example for RSA this will be the size of the modulus, for ECDSA the size of the ECC group, and for McEliece the size of the code will be returned.

Implements Botan::Public_Key.

Definition at line 418 of file rsa.cpp.

418 {
419 return m_public->public_modulus_bits();
420}

References m_public.

Referenced by estimated_strength().

◆ message_part_size()

size_t Botan::Public_Key::message_part_size ( ) const
inlineinherited

Returns how large each of the message parts referred to by message_parts() is

This function is public but applications should have few reasons to ever call this.

Returns
size of the message parts in bits

Definition at line 236 of file pk_keys.h.

236 {
237 return _signature_element_size_for_DER_encoding().value_or(0);
238 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().

Referenced by message_part_size().

◆ message_parts()

size_t Botan::Public_Key::message_parts ( ) const
inlineinherited

Returns more than 1 if the output of this algorithm (ciphertext, signature) should be treated as more than one value. This is used for algorithms like DSA and ECDSA, where the (r,s) output pair can be encoded as either a plain binary list or a TLV tagged DER encoding depending on the protocol.

This function is public but applications should have few reasons to ever call this.

Returns
number of message parts

Definition at line 223 of file pk_keys.h.

223 {
225 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().

Referenced by message_parts().

◆ object_identifier()

◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const
inlinevirtualinherited

Return the PKCS #8 AlgorithmIdentifier for this key

Note
normally this is the same as the public key identifier, but a few oddball algorithms use a different value

Reimplemented in Botan::GOST_3410_PrivateKey, and Botan::HSS_LMS_PrivateKey.

Definition at line 390 of file pk_keys.h.

390{ return algorithm_identifier(); }
virtual AlgorithmIdentifier algorithm_identifier() const =0

References Botan::Public_Key::algorithm_identifier().

Referenced by private_key_info().

◆ private_data()

std::shared_ptr< const RSA_Private_Data > Botan::RSA_PrivateKey::private_data ( ) const

Definition at line 452 of file rsa.cpp.

452 {
453 return m_private;
454}

◆ private_key_bits()

secure_vector< uint8_t > Botan::RSA_PrivateKey::private_key_bits ( ) const
overridevirtual

Return the PKCS8 private key encoding

Note
this encoding omits the outer PKCS8 algorithm identifiers and will not be portably decodable on its own. Prefer private_key_info.

Implements Botan::Private_Key.

Definition at line 456 of file rsa.cpp.

456 {
457 return DER_Encoder()
458 .start_sequence()
459 .encode(static_cast<size_t>(0))
460 .encode(get_n())
461 .encode(get_e())
462 .encode(get_d())
463 .encode(get_p())
464 .encode(get_q())
465 .encode(get_d1())
466 .encode(get_d2())
467 .encode(get_c())
468 .end_cons()
469 .get_contents();
470}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_c(), Botan::DER_Encoder::get_contents(), get_d(), get_d1(), get_d2(), Botan::RSA_PublicKey::get_e(), Botan::RSA_PublicKey::get_n(), get_p(), get_q(), and Botan::DER_Encoder::start_sequence().

◆ private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const
inherited

Return PKCS #8 private key encoding for this key object

Definition at line 77 of file pk_keys.cpp.

77 {
78 const size_t PKCS8_VERSION = 0;
79
80 return DER_Encoder()
81 .start_sequence()
82 .encode(PKCS8_VERSION)
85 .end_cons()
86 .get_contents();
87}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:390

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, pkcs8_algorithm_identifier(), private_key_bits(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(), Botan::PKCS8::PEM_encode(), and public_key().

◆ public_data()

std::shared_ptr< const RSA_Public_Data > Botan::RSA_PublicKey::public_data ( ) const
inherited

Definition at line 355 of file rsa.cpp.

355 {
356 return m_public;
357}

References m_public.

◆ public_key()

std::unique_ptr< Public_Key > Botan::RSA_PrivateKey::public_key ( ) const
overridevirtual

Allocate a new object for the public key associated with this private key.

Returns
public key

Implements Botan::Private_Key.

Definition at line 725 of file rsa.cpp.

725 {
726 return std::make_unique<RSA_PublicKey>(get_n(), get_e());
727}

References Botan::RSA_PublicKey::get_e(), and Botan::RSA_PublicKey::get_n().

◆ public_key_bits()

std::vector< uint8_t > Botan::RSA_PublicKey::public_key_bits ( ) const
overridevirtualinherited

Return the subject public key encoding of this public key

Note
this excludes the parameters field and may not be reliably decodable

Implements Botan::Public_Key.

Definition at line 434 of file rsa.cpp.

434 {
435 std::vector<uint8_t> output;
436 DER_Encoder der(output);
437 der.start_sequence().encode(get_n()).encode(get_e()).end_cons();
438
439 return output;
440}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_e(), get_n(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::TPM2::RSA_PrivateKey::public_key().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::Private_Key::raw_private_key_bits ( ) const
virtualinherited

Return the binary private key bits, with no additional encoding

Note
some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus not implement this function. The default implementation throws Not_Implemented

Reimplemented in Botan::Classic_McEliece_PrivateKey, Botan::DH_PrivateKey, Botan::DSA_PrivateKey, Botan::EC_PrivateKey, Botan::Ed25519_PrivateKey, Botan::Ed448_PrivateKey, Botan::ElGamal_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::HSS_LMS_PrivateKey, Botan::KEX_to_KEM_Adapter_PrivateKey, Botan::Module_Lattice_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 89 of file pk_keys.cpp.

89 {
90 throw Not_Implemented(algo_name() + " does not implement raw_private_key_bits");
91}

References Botan::Asymmetric_Key::algo_name().

Referenced by private_key_bits().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::RSA_PublicKey::raw_public_key_bits ( ) const
overridevirtualinherited

Return the raw public key bits (algorithm specific) with no extra encoding

For key agreements this is an alias for PK_Key_Agreement_Key::public_value.

Note
some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus throw Not_Implemented when invoking this method.

Implements Botan::Public_Key.

Reimplemented in Botan::TPM2::RSA_PublicKey.

Definition at line 430 of file rsa.cpp.

430 {
431 throw Not_Implemented("an RSA public key does not provide a raw binary representation.");
432}

◆ remaining_operations()

virtual std::optional< uint64_t > Botan::Private_Key::remaining_operations ( ) const
inlinevirtualinherited

Retrieves the number of remaining operations if this is a stateful private key.

Returns
the number of remaining operations or std::nullopt if not applicable.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 403 of file pk_keys.h.

403{ return std::nullopt; }

◆ stateful_operation()

virtual bool Botan::Private_Key::stateful_operation ( ) const
inlinevirtualinherited

Indicates if this key is stateful, ie that performing a private key operation requires updating the key storage.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 396 of file pk_keys.h.

396{ return false; }

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited

Return the SubjectPublicKeyInfo encoding of this public key

This is the subjectPublicKey field plus the algorithm-specific parameters

Definition at line 65 of file pk_keys.cpp.

65 {
66 std::vector<uint8_t> output;
67
68 DER_Encoder(output)
69 .start_sequence()
70 .encode(algorithm_identifier())
71 .encode_octet_aligned_bitstring(public_key_bits())
72 .end_cons();
73
74 return output;
75}
virtual std::vector< uint8_t > public_key_bits() const =0

References algorithm_identifier(), Botan::DER_Encoder::encode(), Botan::DER_Encoder::encode_octet_aligned_bitstring(), Botan::DER_Encoder::end_cons(), public_key_bits(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), fingerprint_public(), Botan::X509::PEM_encode(), and public_key_bits().

◆ supports_operation()

bool Botan::RSA_PublicKey::supports_operation ( PublicKeyOperation op) const
overridevirtualinherited

Return true if this key could be used for the specified type of operation.

Implements Botan::Asymmetric_Key.

Reimplemented in Botan::TPM2::RSA_PublicKey.

Definition at line 407 of file rsa.cpp.

References Botan::Encryption, Botan::KeyEncapsulation, and Botan::Signature.

Member Data Documentation

◆ m_public

std::shared_ptr<const RSA_Public_Data> Botan::RSA_PublicKey::m_public
protectedinherited

Definition at line 90 of file rsa.h.

Referenced by generate_another(), get_e(), get_int_field(), get_n(), init(), key_length(), and public_data().


The documentation for this class was generated from the following files: