Botan 3.7.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

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) const override
 
std::unique_ptr< PK_Ops::Decryptioncreate_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::KEM_Decryptioncreate_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const override
 
virtual std::unique_ptr< PK_Ops::Key_Agreementcreate_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
std::unique_ptr< PK_Ops::Signaturecreate_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::Verificationcreate_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_Keygenerate_another (RandomNumberGenerator &rng) const override
 
const BigIntget_c () const
 
const BigIntget_d () const
 
const BigIntget_d1 () const
 
const BigIntget_d2 () const
 
const BigIntget_e () const
 
const BigIntget_int_field (std::string_view field) const override
 
const BigIntget_n () const
 
OID get_oid () const
 
const BigIntget_p () const
 
const BigIntget_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_Keypublic_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 101 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 258 of file rsa.cpp.

258 {
259 BigInt n, e, d, p, q, d1, d2, c;
260
261 BER_Decoder(key_bits)
262 .start_sequence()
263 .decode_and_check<size_t>(0, "Unknown PKCS #1 key format version")
264 .decode(n)
265 .decode(e)
266 .decode(d)
267 .decode(p)
268 .decode(q)
269 .decode(d1)
270 .decode(d2)
271 .decode(c)
272 .end_cons();
273
274 RSA_PublicKey::init(std::move(n), std::move(e));
275
276 RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
277}
void init(BigInt &&n, BigInt &&e)
Definition rsa.cpp:150
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
Definition pem.cpp:62

References Botan::BER_Decoder::decode_and_check(), Botan::RSA_PublicKey::init(), 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 279 of file rsa.cpp.

280 {
281 BigInt p = prime1;
282 BigInt q = prime2;
283 BigInt n = mod;
284 if(n.is_zero()) {
285 n = p * q;
286 }
287
288 BigInt e = exp;
289
290 BigInt d = d_exp;
291
292 const BigInt p_minus_1 = p - 1;
293 const BigInt q_minus_1 = q - 1;
294
295 if(d.is_zero()) {
296 const BigInt phi_n = lcm(p_minus_1, q_minus_1);
297 d = compute_rsa_secret_exponent(e, phi_n, p, q);
298 }
299
300 BigInt d1 = ct_modulo(d, p_minus_1);
301 BigInt d2 = ct_modulo(d, q_minus_1);
302 BigInt c = inverse_mod_secret_prime(ct_modulo(q, p), p);
303
304 RSA_PublicKey::init(std::move(n), std::move(e));
305
306 RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
307}
BigInt inverse_mod_secret_prime(const BigInt &x, const BigInt &p)
Definition mod_inv.cpp:280
BigInt lcm(const BigInt &a, const BigInt &b)
Definition numthry.cpp:270
BigInt ct_modulo(const BigInt &x, const BigInt &y)
Definition divide.cpp:181
BigInt compute_rsa_secret_exponent(const BigInt &e, const BigInt &phi_n, const BigInt &p, const BigInt &q)
Definition mod_inv.cpp:330

References Botan::compute_rsa_secret_exponent(), Botan::ct_modulo(), Botan::RSA_PublicKey::init(), Botan::inverse_mod_secret_prime(), Botan::BigInt::is_zero(), and Botan::lcm().

◆ 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
rngthe random number generator to use
bitsthe desired bit length of the private key
expthe public exponent to be used

Definition at line 312 of file rsa.cpp.

312 {
313 if(bits < 1024) {
314 throw Invalid_Argument(fmt("Cannot create an RSA key only {} bits long", bits));
315 }
316
317 if(exp < 3 || exp % 2 == 0) {
318 throw Invalid_Argument("Invalid RSA encryption exponent");
319 }
320
321 const size_t p_bits = (bits + 1) / 2;
322 const size_t q_bits = bits - p_bits;
323
324 BigInt p, q, n;
325 BigInt e = BigInt::from_u64(exp);
326
327 for(size_t attempt = 0;; ++attempt) {
328 if(attempt > 10) {
329 throw Internal_Error("RNG failure during RSA key generation");
330 }
331
332 // TODO could generate primes in thread pool
333 p = generate_rsa_prime(rng, rng, p_bits, e);
334 q = generate_rsa_prime(rng, rng, q_bits, e);
335
336 const BigInt diff = p - q;
337 if(diff.bits() < (bits / 2) - 100) {
338 continue;
339 }
340
341 n = p * q;
342
343 if(n.bits() != bits) {
344 continue;
345 }
346
347 break;
348 }
349
350 const BigInt p_minus_1 = p - 1;
351 const BigInt q_minus_1 = q - 1;
352
353 const BigInt phi_n = lcm(p_minus_1, q_minus_1);
354 // This is guaranteed because p,q == 3 mod 4
356
357 BigInt d = compute_rsa_secret_exponent(e, phi_n, p, q);
358 BigInt d1 = ct_modulo(d, p_minus_1);
359 BigInt d2 = ct_modulo(d, q_minus_1);
360 BigInt c = inverse_mod_secret_prime(ct_modulo(q, p), p);
361
362 RSA_PublicKey::init(std::move(n), std::move(e));
363
364 RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q), std::move(d1), std::move(d2), std::move(c));
365}
#define BOTAN_DEBUG_ASSERT(expr)
Definition assert.h:98
static BigInt from_u64(uint64_t n)
Definition bigint.cpp:28
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:167
BigInt generate_rsa_prime(RandomNumberGenerator &keygen_rng, RandomNumberGenerator &prime_test_rng, size_t bits, const BigInt &coprime, size_t prob)
Definition make_prm.cpp:211

References Botan::BigInt::bits(), 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(), and Botan::low_zero_bits().

Member Function Documentation

◆ _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 136 of file pk_keys.h.

136{ return {}; }

Referenced by Botan::Asymmetric_Key::_default_x509_signature_format(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ algo_name()

std::string Botan::RSA_PublicKey::algo_name ( ) const
inlineoverridevirtualinherited

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 41 of file rsa.h.

41{ return "RSA"; }

◆ algorithm_identifier()

AlgorithmIdentifier Botan::RSA_PublicKey::algorithm_identifier ( ) const
overridevirtualinherited
Returns
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 183 of file rsa.cpp.

183 {
184 return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_NULL_PARAM);
185}
virtual OID object_identifier() const
Definition pk_keys.cpp:22

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

◆ check_key()

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

Implements Botan::Asymmetric_Key.

Definition at line 392 of file rsa.cpp.

392 {
393 if(get_n() < 35 || get_n().is_even() || get_e() < 3 || get_e().is_even()) {
394 return false;
395 }
396
397 if(get_d() < 2 || get_p() < 3 || get_q() < 3) {
398 return false;
399 }
400
401 if(get_p() * get_q() != get_n()) {
402 return false;
403 }
404
405 if(get_p() == get_q()) {
406 return false;
407 }
408
409 if(get_d1() != ct_modulo(get_d(), get_p() - 1)) {
410 return false;
411 }
412 if(get_d2() != ct_modulo(get_d(), get_q() - 1)) {
413 return false;
414 }
416 return false;
417 }
418
419 const size_t prob = (strong) ? 128 : 12;
420
421 if(!is_prime(get_p(), rng, prob)) {
422 return false;
423 }
424 if(!is_prime(get_q(), rng, prob)) {
425 return false;
426 }
427
428 if(strong) {
429 if(ct_modulo(get_e() * get_d(), lcm(get_p() - 1, get_q() - 1)) != 1) {
430 return false;
431 }
432
433#if defined(BOTAN_HAS_PSS) && defined(BOTAN_HAS_SHA_256)
434 const std::string padding = "PSS(SHA-256)";
435#else
436 const std::string padding = "Raw";
437#endif
438
439 return KeyPair::signature_consistency_check(rng, *this, padding);
440 }
441
442 return true;
443}
const BigInt & get_q() const
Definition rsa.cpp:233
const BigInt & get_c() const
Definition rsa.cpp:241
const BigInt & get_p() const
Definition rsa.cpp:229
const BigInt & get_d2() const
Definition rsa.cpp:249
const BigInt & get_d() const
Definition rsa.cpp:237
const BigInt & get_d1() const
Definition rsa.cpp:245
const BigInt & get_n() const
Definition rsa.cpp:142
const BigInt & get_e() const
Definition rsa.cpp:146
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:355

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(), and Botan::KeyPair::signature_consistency_check().

◆ create_decryption_op()

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

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
rnga 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

Reimplemented from Botan::Private_Key.

Definition at line 815 of file rsa.cpp.

817 {
818 if(provider == "base" || provider.empty()) {
819 return std::make_unique<RSA_Decryption_Operation>(*this, params, rng);
820 }
821
822 throw Provider_Not_Found(algo_name(), provider);
823}
std::string algo_name() const override
Definition rsa.h:41

◆ create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::RSA_PublicKey::create_encryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) 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/params or throw

Parameters
rnga 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

Reimplemented from Botan::Public_Key.

Reimplemented in Botan::TPM2::RSA_PublicKey.

Definition at line 730 of file rsa.cpp.

732 {
733 if(provider == "base" || provider.empty()) {
734 return std::make_unique<RSA_Encryption_Operation>(*this, params);
735 }
736 throw Provider_Not_Found(algo_name(), provider);
737}

◆ create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::RSA_PrivateKey::create_kem_decryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) 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/params or throw

Parameters
rnga 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

Reimplemented from Botan::Private_Key.

Definition at line 825 of file rsa.cpp.

827 {
828 if(provider == "base" || provider.empty()) {
829 return std::make_unique<RSA_KEM_Decryption_Operation>(*this, params, rng);
830 }
831
832 throw Provider_Not_Found(algo_name(), provider);
833}

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::RSA_PublicKey::create_kem_encryption_op ( std::string_view params,
std::string_view provider ) 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/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 739 of file rsa.cpp.

740 {
741 if(provider == "base" || provider.empty()) {
742 return std::make_unique<RSA_KEM_Encryption_Operation>(*this, params);
743 }
744 throw Provider_Not_Found(algo_name(), provider);
745}

◆ 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
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/params or throw

Parameters
rnga 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

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

Definition at line 137 of file pk_keys.cpp.

139 {
140 throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
141}
virtual std::string algo_name() const =0

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

Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::RSA_PrivateKey::create_signature_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) 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
rnga 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

Reimplemented from Botan::Private_Key.

Definition at line 835 of file rsa.cpp.

837 {
838 if(provider == "base" || provider.empty()) {
839 return std::make_unique<RSA_Signature_Operation>(*this, params, rng);
840 }
841
842 throw Provider_Not_Found(algo_name(), provider);
843}

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::RSA_PublicKey::create_verification_op ( std::string_view params,
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 key/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Reimplemented in Botan::TPM2::RSA_PublicKey.

Definition at line 747 of file rsa.cpp.

748 {
749 if(provider == "base" || provider.empty()) {
750 return std::make_unique<RSA_Verify_Operation>(*this, params);
751 }
752
753 throw Provider_Not_Found(algo_name(), provider);
754}

◆ 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 806 of file rsa.cpp.

807 {
808 if(provider == "base" || provider.empty()) {
809 return std::make_unique<RSA_Verify_Operation>(*this, parse_rsa_signature_algorithm(alg_id));
810 }
811
812 throw Provider_Not_Found(algo_name(), provider);
813}

◆ default_x509_signature_format()

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

Definition at line 227 of file pk_keys.h.

227 {
229 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:30

◆ 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 179 of file rsa.cpp.

179 {
180 return if_work_factor(key_length());
181}
size_t key_length() const override
Definition rsa.cpp:175
size_t if_work_factor(size_t bits)

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

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg) const
inherited
Returns
Hash of the PKCS #8 encoding for this key object

Definition at line 94 of file pk_keys.cpp.

94 {
95 return create_hex_fingerprint(private_key_bits(), hash_algo);
96}
virtual secure_vector< uint8_t > private_key_bits() const =0
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, std::string_view hash_name)
Definition pk_keys.cpp:38

References Botan::create_hex_fingerprint(), and Botan::Private_Key::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 87 of file pk_keys.cpp.

87 {
88 return create_hex_fingerprint(subject_public_key(), hash_algo);
89}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:56

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

◆ 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 138 of file rsa.cpp.

138 {
139 return std::make_unique<RSA_PrivateKey>(rng, m_public->public_modulus_bits(), m_public->get_e().to_u32bit());
140}
std::shared_ptr< const RSA_Public_Data > m_public
Definition rsa.h:91

References Botan::RSA_PublicKey::m_public.

◆ get_c()

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

Definition at line 241 of file rsa.cpp.

241 {
242 return m_private->get_c();
243}

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 237 of file rsa.cpp.

237 {
238 return m_private->get_d();
239}

Referenced by check_key(), and private_key_bits().

◆ get_d1()

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

Definition at line 245 of file rsa.cpp.

245 {
246 return m_private->get_d1();
247}

Referenced by check_key(), and private_key_bits().

◆ get_d2()

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

Definition at line 249 of file rsa.cpp.

249 {
250 return m_private->get_d2();
251}

Referenced by check_key(), and private_key_bits().

◆ get_e()

const BigInt & Botan::RSA_PublicKey::get_e ( ) const
inherited
Returns
public exponent

Definition at line 146 of file rsa.cpp.

146 {
147 return m_public->get_e();
148}

References Botan::RSA_PublicKey::m_public.

Referenced by check_key(), Botan::RSA_PublicKey::check_key(), private_key_bits(), public_key(), and Botan::RSA_PublicKey::public_key_bits().

◆ 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 367 of file rsa.cpp.

367 {
368 if(field == "p") {
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();
380 } else {
381 return RSA_PublicKey::get_int_field(field);
382 }
383}
const BigInt & get_int_field(std::string_view field) const override
Definition rsa.cpp:128

References Botan::RSA_PublicKey::get_int_field().

◆ get_n()

const BigInt & Botan::RSA_PublicKey::get_n ( ) const
inherited
Returns
public modulus

Definition at line 142 of file rsa.cpp.

142 {
143 return m_public->get_n();
144}

References Botan::RSA_PublicKey::m_public.

Referenced by check_key(), Botan::RSA_PublicKey::check_key(), private_key_bits(), public_key(), and Botan::RSA_PublicKey::public_key_bits().

◆ get_oid()

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

Deprecated version of object_identifier

Definition at line 160 of file pk_keys.h.

160{ return this->object_identifier(); }

◆ get_p()

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

Get the first prime p.

Returns
prime p

Definition at line 229 of file rsa.cpp.

229 {
230 return m_private->get_p();
231}

Referenced by check_key(), and private_key_bits().

◆ get_q()

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

Get the second prime q.

Returns
prime q

Definition at line 233 of file rsa.cpp.

233 {
234 return m_private->get_q();
235}

Referenced by check_key(), and private_key_bits().

◆ init()

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

Definition at line 150 of file rsa.cpp.

150 {
151 if(n.is_negative() || n.is_even() || n.bits() < 5 /* n >= 3*5 */ || e.is_negative() || e.is_even()) {
152 throw Decoding_Error("Invalid RSA public key parameters");
153 }
154 m_public = std::make_shared<RSA_Public_Data>(std::move(n), std::move(e));
155}

References Botan::RSA_PublicKey::m_public.

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

◆ 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 175 of file rsa.cpp.

175 {
176 return m_public->public_modulus_bits();
177}

References Botan::RSA_PublicKey::m_public.

Referenced by Botan::RSA_PublicKey::estimated_strength().

◆ message_part_size()

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

Returns how large each of the message parts refered 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 220 of file pk_keys.h.

220 {
221 return _signature_element_size_for_DER_encoding().value_or(0);
222 }

◆ 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 207 of file pk_keys.h.

207 {
209 }

◆ object_identifier()

◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const
inlinevirtualinherited
Returns
PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

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

Definition at line 322 of file pk_keys.h.

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

Referenced by Botan::Private_Key::private_key_info().

◆ private_data()

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

Definition at line 209 of file rsa.cpp.

209 {
210 return m_private;
211}

◆ private_key_bits()

secure_vector< uint8_t > Botan::RSA_PrivateKey::private_key_bits ( ) const
overridevirtual
Returns
BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 213 of file rsa.cpp.

213 {
214 return DER_Encoder()
215 .start_sequence()
216 .encode(static_cast<size_t>(0))
217 .encode(get_n())
218 .encode(get_e())
219 .encode(get_d())
220 .encode(get_p())
221 .encode(get_q())
222 .encode(get_d1())
223 .encode(get_d2())
224 .encode(get_c())
225 .end_cons()
226 .get_contents();
227}

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
Returns
PKCS #8 private key encoding for this key object

Definition at line 68 of file pk_keys.cpp.

68 {
69 const size_t PKCS8_VERSION = 0;
70
71 return DER_Encoder()
72 .start_sequence()
73 .encode(PKCS8_VERSION)
76 .end_cons()
77 .get_contents();
78}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:322

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::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(), and Botan::PKCS8::PEM_encode().

◆ public_data()

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

Definition at line 124 of file rsa.cpp.

124 {
125 return m_public;
126}

References Botan::RSA_PublicKey::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 385 of file rsa.cpp.

385 {
386 return std::make_unique<RSA_PublicKey>(get_n(), get_e());
387}

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
Returns
BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 191 of file rsa.cpp.

191 {
192 std::vector<uint8_t> output;
193 DER_Encoder der(output);
194 der.start_sequence().encode(get_n()).encode(get_e()).end_cons();
195
196 return output;
197}

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

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::Private_Key::raw_private_key_bits ( ) const
virtualinherited
Returns
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::Dilithium_PrivateKey, Botan::DSA_PrivateKey, Botan::EC_PrivateKey, Botan::Ed25519_PrivateKey, Botan::Ed448_PrivateKey, Botan::ElGamal_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::HSS_LMS_PrivateKey, Botan::Kyber_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 80 of file pk_keys.cpp.

80 {
81 throw Not_Implemented(algo_name() + " does not implement raw_private_key_bits");
82}

References Botan::Asymmetric_Key::algo_name().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::RSA_PublicKey::raw_public_key_bits ( ) const
overridevirtualinherited
Returns
binary public key bits, with no additional 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 187 of file rsa.cpp.

187 {
188 throw Not_Implemented("an RSA public key does not provide a raw binary representation.");
189}

◆ 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 335 of file pk_keys.h.

335{ 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 328 of file pk_keys.h.

328{ return false; }

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited
Returns
X.509 subject key encoding for this key object

Definition at line 56 of file pk_keys.cpp.

56 {
57 std::vector<uint8_t> output;
58
59 DER_Encoder(output)
60 .start_sequence()
61 .encode(algorithm_identifier())
63 .end_cons();
64
65 return output;
66}
virtual std::vector< uint8_t > public_key_bits() const =0

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

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

◆ 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 164 of file rsa.cpp.

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

Member Data Documentation

◆ m_public


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