Botan::RSA_PrivateKey Class Reference

#include <rsa.h>

Inheritance diagram for Botan::RSA_PrivateKey:

Public Member Functions
virtual std::string	algo_name () const =0
std::string	algo_name () const override
virtual AlgorithmIdentifier	algorithm_identifier () const =0
AlgorithmIdentifier	algorithm_identifier () const override
bool	check_key (RandomNumberGenerator &rng, bool) const override
std::unique_ptr< PK_Ops::Decryption >	create_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
virtual std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
std::unique_ptr< PK_Ops::KEM_Decryption >	create_kem_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
virtual std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
virtual std::unique_ptr< PK_Ops::Key_Agreement >	create_key_agreement_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
std::unique_ptr< PK_Ops::Signature >	create_signature_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
virtual std::unique_ptr< PK_Ops::Verification >	create_verification_op (const std::string &params, const std::string &provider) const
std::unique_ptr< PK_Ops::Verification >	create_verification_op (const std::string &params, const std::string &provider) const override
virtual Signature_Format	default_x509_signature_format () const
virtual size_t	estimated_strength () const =0
size_t	estimated_strength () const override
std::string	fingerprint_private (const std::string &alg) const
std::string	fingerprint_public (const std::string &alg="SHA-256") const
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_n () const
virtual OID	get_oid () const
const BigInt &	get_p () const
const BigInt &	get_q () const
virtual size_t	key_length () const =0
size_t	key_length () const override
virtual size_t	message_part_size () const
virtual size_t	message_parts () 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
virtual std::vector< uint8_t >	public_key_bits () const =0
std::vector< uint8_t >	public_key_bits () const override
	RSA_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< 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

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 92 of file rsa.h.

Constructor & Destructor Documentation

RSA_PrivateKey() [1/3]

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

Load a private key.

Parameters

alg_id	the X.509 algorithm identifier
key_bits	PKCS#1 RSAPrivateKey bits

Definition at line 207 of file rsa.cpp.

   {
   BigInt n, e, d, p, q, d1, d2, c;
 
   BER_Decoder(key_bits)
      .start_sequence()
         .decode_and_check<size_t>(0, "Unknown PKCS #1 key format version")
         .decode(n)
         .decode(e)
         .decode(d)
         .decode(p)
         .decode(q)
         .decode(d1)
         .decode(d2)
         .decode(c)
      .end_cons();
 
   RSA_PublicKey::init(std::move(n), std::move(e));
 
   RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q),
                        std::move(d1), std::move(d2), std::move(c));
   }

References Botan::PEM_Code::decode(), 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

p	the first prime
q	the second prime
e	the exponent
d	if 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.
n	if specified, this must be n = p * q. Leave it as 0 if you wish to the constructor to calculate it.

Definition at line 231 of file rsa.cpp.

   {
   BigInt p = prime1;
   BigInt q = prime2;
   BigInt n = mod;
   if(n.is_zero())
      n = p * q;
 
   BigInt e = exp;
 
   BigInt d = d_exp;
 
   const BigInt p_minus_1 = p - 1;
   const BigInt q_minus_1 = q - 1;
 
   if(d.is_zero())
      {
      const BigInt phi_n = lcm(p_minus_1, q_minus_1);
      d = inverse_mod(e, phi_n);
      }
 
   BigInt d1 = ct_modulo(d, p_minus_1);
   BigInt d2 = ct_modulo(d, q_minus_1);
   BigInt c = inverse_mod(q, p);
 
   RSA_PublicKey::init(std::move(n), std::move(e));
 
   RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q),
                        std::move(d1), std::move(d2), std::move(c));
   }

References Botan::ct_modulo(), Botan::RSA_PublicKey::init(), Botan::inverse_mod(), 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

rng	the random number generator to use
bits	the desired bit length of the private key
exp	the public exponent to be used

Definition at line 269 of file rsa.cpp.

   {
   if(bits < 1024)
      throw Invalid_Argument(algo_name() + ": Can't make a key that is only " +
                             std::to_string(bits) + " bits long");
   if(exp < 3 || exp % 2 == 0)
      throw Invalid_Argument(algo_name() + ": Invalid encryption exponent");
 
   BigInt n, e, d, p, q, d1, d2, c;
 
   e = exp;
 
   const size_t p_bits = (bits + 1) / 2;
   const size_t q_bits = bits - p_bits;
 
   for(size_t attempt = 0; ; ++attempt)
      {
      if(attempt > 10)
         throw Internal_Error("RNG failure during RSA key generation");
 
      // TODO could generate primes in thread pool
      p = generate_rsa_prime(rng, rng, p_bits, e);
      q = generate_rsa_prime(rng, rng, q_bits, e);
 
      const BigInt diff = p - q;
      if(diff.bits() < (bits/2) - 100)
         continue;
 
      n = p * q;
 
      if(n.bits() != bits)
         continue;
 
      break;
      }
 
   const BigInt p_minus_1 = p - 1;
   const BigInt q_minus_1 = q - 1;
 
   const BigInt phi_n = lcm(p_minus_1, q_minus_1);
   // This is guaranteed because p,q == 3 mod 4
   BOTAN_DEBUG_ASSERT(low_zero_bits(phi_n) == 1);
   d = inverse_mod(e, phi_n);
   d1 = ct_modulo(d, p_minus_1);
   d2 = ct_modulo(d, q_minus_1);
   c = inverse_mod(q, p);
 
   RSA_PublicKey::init(std::move(n), std::move(e));
 
   RSA_PrivateKey::init(std::move(d), std::move(p), std::move(q),
                        std::move(d1), std::move(d2), std::move(c));
   }

References Botan::RSA_PublicKey::algo_name(), Botan::BigInt::bits(), BOTAN_DEBUG_ASSERT, Botan::ct_modulo(), Botan::generate_rsa_prime(), Botan::RSA_PublicKey::init(), Botan::inverse_mod(), Botan::lcm(), Botan::low_zero_bits(), and Botan::ASN1::to_string().

Member Function Documentation

algo_name() [1/2]

virtual std::string Botan::Public_Key::algo_name ( ) const

pure virtualinherited

Get the name of the underlying public key scheme.

Returns

name of the public key scheme

Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::ElGamal_PublicKey, Botan::GOST_3410_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.

Referenced by Botan::PKCS8::BER_encode(), botan_pubkey_sm2_compute_za(), Botan::TLS::Policy::check_peer_key_acceptable(), Botan::TLS::Handshake_State::choose_sig_format(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::EMSA1::config_for_x509(), Botan::EMSA_PKCS1v15::config_for_x509(), Botan::PSSR::config_for_x509(), Botan::Private_Key::create_decryption_op(), Botan::Public_Key::create_encryption_op(), Botan::Private_Key::create_kem_decryption_op(), Botan::Public_Key::create_kem_encryption_op(), Botan::Private_Key::create_key_agreement_op(), Botan::Private_Key::create_signature_op(), Botan::Public_Key::create_verification_op(), Botan::Public_Key::get_oid(), Botan::TLS::Handshake_State::parse_sig_format(), Botan::PK_Decryptor_EME::PK_Decryptor_EME(), Botan::PK_Encryptor_EME::PK_Encryptor_EME(), Botan::PK_KEM_Decryptor::PK_KEM_Decryptor(), Botan::PK_KEM_Encryptor::PK_KEM_Encryptor(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), Botan::verify_cert_constraints_valid_for_key_type(), and Botan::X509_Object::verify_signature().

algo_name() [2/2]

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::Public_Key.

Definition at line 43 of file rsa.h.

{ return "RSA"; }

Referenced by create_decryption_op(), Botan::RSA_PublicKey::create_encryption_op(), create_kem_decryption_op(), Botan::RSA_PublicKey::create_kem_encryption_op(), create_signature_op(), Botan::RSA_PublicKey::create_verification_op(), and RSA_PrivateKey().

algorithm_identifier() [1/2]

virtual AlgorithmIdentifier Botan::Public_Key::algorithm_identifier ( ) const

pure virtualinherited

Returns

X.509 AlgorithmIdentifier for this key

Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DL_Scheme_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.

Referenced by Botan::EMSA1::config_for_x509(), and Botan::Public_Key::subject_public_key().

algorithm_identifier() [2/2]

AlgorithmIdentifier Botan::RSA_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Returns

X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 144 of file rsa.cpp.

   {
   return AlgorithmIdentifier(get_oid(), AlgorithmIdentifier::USE_NULL_PARAM);
   }

References Botan::Public_Key::get_oid(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

check_key()

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

overridevirtual

Test the key values for consistency.

Parameters

rng	rng to use
strong	whether to perform strong and lengthy version of the test

Returns

true if the test is passed

Reimplemented from Botan::RSA_PublicKey.

Definition at line 331 of file rsa.cpp.

   {
   if(get_n() < 35 || get_n().is_even() || get_e() < 3 || get_e().is_even())
      return false;
 
   if(get_d() < 2 || get_p() < 3 || get_q() < 3)
      return false;
 
   if(get_p() * get_q() != get_n())
      return false;
 
   if(get_p() == get_q())
      return false;
 
   if(get_d1() != ct_modulo(get_d(), get_p() - 1))
      return false;
   if(get_d2() != ct_modulo(get_d(), get_q() - 1))
      return false;
   if(get_c() != inverse_mod(get_q(), get_p()))
      return false;
 
   const size_t prob = (strong) ? 128 : 12;
 
   if(!is_prime(get_p(), rng, prob))
      return false;
   if(!is_prime(get_q(), rng, prob))
      return false;
 
   if(strong)
      {
      if(ct_modulo(get_e() * get_d(), lcm(get_p() - 1, get_q() - 1)) != 1)
         return false;
 
      return KeyPair::signature_consistency_check(rng, *this, "EMSA4(SHA-256)");
      }
 
   return true;
   }

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(), 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, const std::string &  params, const std::string &  provider  ) const

overridevirtual

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

Return an decryption operation for this key/params or throw

Parameters

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented from Botan::Private_Key.

Definition at line 680 of file rsa.cpp.

   {
   if(provider == "base" || provider.empty())
      return std::make_unique<RSA_Decryption_Operation>(*this, params, rng);
 
   throw Provider_Not_Found(algo_name(), provider);
   }

References Botan::RSA_PublicKey::algo_name().

create_encryption_op() [1/2]

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

virtualinherited

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

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::ElGamal_PublicKey, Botan::RSA_PublicKey, and Botan::SM2_PublicKey.

Definition at line 91 of file pk_keys.cpp.

   {
   throw Lookup_Error(algo_name() + " does not support encryption");
   }

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().

create_encryption_op() [2/2]

std::unique_ptr< PK_Ops::Encryption > Botan::RSA_PublicKey::create_encryption_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  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

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 650 of file rsa.cpp.

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

References Botan::RSA_PublicKey::algo_name().

create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::RSA_PrivateKey::create_kem_decryption_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  provider  ) const

overridevirtual

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

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

Parameters

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented from Botan::Private_Key.

Definition at line 691 of file rsa.cpp.

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

References Botan::RSA_PublicKey::algo_name().

create_kem_encryption_op() [1/2]

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  provider  ) const

virtualinherited

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

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, and Botan::RSA_PublicKey.

Definition at line 99 of file pk_keys.cpp.

   {
   throw Lookup_Error(algo_name() + " does not support KEM encryption");
   }

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

create_kem_encryption_op() [2/2]

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::RSA_PublicKey::create_kem_encryption_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  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

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 660 of file rsa.cpp.

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

References Botan::RSA_PublicKey::algo_name().

create_key_agreement_op()

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

virtualinherited

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

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

Parameters

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::Curve25519_PrivateKey, Botan::DH_PrivateKey, and Botan::ECDH_PrivateKey.

Definition at line 138 of file pk_keys.cpp.

   {
   throw Lookup_Error(algo_name() + " does not support key agreement");
   }

References Botan::Public_Key::algo_name().

create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::RSA_PrivateKey::create_signature_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  provider  ) const

overridevirtual

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

Return a signature operation for this key/params or throw

Parameters

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented from Botan::Private_Key.

Definition at line 702 of file rsa.cpp.

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

References Botan::RSA_PublicKey::algo_name().

create_verification_op() [1/2]

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

virtualinherited

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

Return a verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented in Botan::XMSS_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 107 of file pk_keys.cpp.

   {
   throw Lookup_Error(algo_name() + " does not support verification");
   }

References Botan::Public_Key::algo_name().

Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::create_verification_op(), and Botan::PK_Verifier::PK_Verifier().

create_verification_op() [2/2]

std::unique_ptr< PK_Ops::Verification > Botan::RSA_PublicKey::create_verification_op ( const std::string &  params, const std::string &  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 verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 670 of file rsa.cpp.

   {
   if(provider == "base" || provider.empty())
      return std::make_unique<RSA_Verify_Operation>(*this, params);
 
   throw Provider_Not_Found(algo_name(), provider);
   }

References Botan::RSA_PublicKey::algo_name().

default_x509_signature_format()

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

inlinevirtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 125 of file pk_keys.h.

         {
         return (this->message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
         }

References Botan::DER_SEQUENCE, and Botan::IEEE_1363.

Referenced by Botan::X509_Object::choose_sig_format(), and Botan::X509_Object::verify_signature().

estimated_strength() [1/2]

virtual size_t Botan::Public_Key::estimated_strength ( ) const

pure virtualinherited

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

Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DL_Scheme_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.

Referenced by botan_pubkey_estimated_strength().

estimated_strength() [2/2]

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::Public_Key.

Definition at line 139 of file rsa.cpp.

   {
   return if_work_factor(key_length());
   }

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

fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( const std::string &  alg ) const

inherited

Returns

Hash of the PKCS #8 encoding for this key object

Definition at line 85 of file pk_keys.cpp.

   {
   return create_hex_fingerprint(private_key_bits(), hash_algo);
   }

References Botan::create_hex_fingerprint(), hash_algo, 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 ( const std::string &  alg = "SHA-256" ) const

inherited

Returns

Hash of the subject public key

Definition at line 77 of file pk_keys.cpp.

   {
   return create_hex_fingerprint(subject_public_key(), hash_algo);
   }

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

get_c()

const BigInt & Botan::RSA_PrivateKey::get_c

(

)

const

Definition at line 196 of file rsa.cpp.

{ return m_private->get_c(); }

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

{ return m_private->get_d(); }

Referenced by check_key(), and private_key_bits().

get_d1()

const BigInt & Botan::RSA_PrivateKey::get_d1

(

)

const

Definition at line 197 of file rsa.cpp.

{ return m_private->get_d1(); }

Referenced by check_key(), and private_key_bits().

get_d2()

const BigInt & Botan::RSA_PrivateKey::get_d2

(

)

const

Definition at line 198 of file rsa.cpp.

{ return m_private->get_d2(); }

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

{ return m_public->get_e(); }

References Botan::RSA_PublicKey::m_public.

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

get_n()

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

inherited

Returns

public modulus

Definition at line 104 of file rsa.cpp.

{ return m_public->get_n(); }

References Botan::RSA_PublicKey::m_public.

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

get_oid()

OID Botan::Public_Key::get_oid ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns

OID of the public key scheme

Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 53 of file pk_keys.cpp.

   {
   OID o = OIDS::str2oid_or_empty(algo_name());
   if(o.empty())
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
   return o;
   }

References Botan::Public_Key::algo_name(), Botan::OID::empty(), and Botan::OIDS::str2oid_or_empty().

Referenced by Botan::TPM_PrivateKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::Kyber_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().

get_p()

const BigInt & Botan::RSA_PrivateKey::get_p

(

)

const

Get the first prime p.

Returns

prime p

Definition at line 193 of file rsa.cpp.

{ return m_private->get_p(); }

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

{ return m_private->get_q(); }

Referenced by check_key(), and private_key_bits().

init()

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

protectedinherited

Definition at line 107 of file rsa.cpp.

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

References Botan::RSA_PublicKey::m_public.

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

key_length() [1/2]

virtual size_t Botan::Public_Key::key_length ( ) const

pure virtualinherited

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.

Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DL_Scheme_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.

Referenced by Botan::TLS::Policy::check_peer_key_acceptable().

key_length() [2/2]

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

   {
   return m_public->public_modulus_bits();
   }

References Botan::RSA_PublicKey::m_public.

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

message_part_size()

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

inlinevirtualinherited

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

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

{ return 0; }

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

message_parts()

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

inlinevirtualinherited

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

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

{ return 1; }

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

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, Botan::XMSS_WOTS_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.

Definition at line 212 of file pk_keys.h.

         { return algorithm_identifier(); }

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

   {
   return m_private;
   }

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

   {
   return DER_Encoder()
      .start_sequence()
         .encode(static_cast<size_t>(0))
         .encode(get_n())
         .encode(get_e())
         .encode(get_d())
         .encode(get_p())
         .encode(get_q())
         .encode(get_d1())
         .encode(get_d2())
         .encode(get_c())
      .end_cons()
   .get_contents();
   }

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 61 of file pk_keys.cpp.

   {
   const size_t PKCS8_VERSION = 0;
 
   return DER_Encoder()
         .start_sequence()
            .encode(PKCS8_VERSION)
            .encode(pkcs8_algorithm_identifier())
            .encode(private_key_bits(), ASN1_Type::OctetString)
         .end_cons()
      .get_contents();
   }

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

   {
   return m_public;
   }

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

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

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

public_key_bits() [1/2]

virtual std::vector< uint8_t > Botan::Public_Key::public_key_bits ( ) const

pure virtualinherited

Returns

BER encoded public key bits

Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DL_Scheme_PublicKey, Botan::EC_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.

Referenced by Botan::Public_Key::subject_public_key().

public_key_bits() [2/2]

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

   {
   std::vector<uint8_t> output;
   DER_Encoder der(output);
   der.start_sequence()
         .encode(get_n())
         .encode(get_e())
      .end_cons();
 
   return output;
   }

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().

stateful_operation()

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

inlinevirtualinherited

Reimplemented in Botan::XMSS_PrivateKey.

Definition at line 188 of file pk_keys.h.

{ 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 38 of file pk_keys.cpp.

   {
   std::vector<uint8_t> output;
 
   DER_Encoder(output).start_sequence()
         .encode(algorithm_identifier())
         .encode(public_key_bits(), ASN1_Type::BitString)
      .end_cons();
 
   return output;
   }

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().

Member Data Documentation

m_public

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

protectedinherited

Definition at line 86 of file rsa.h.

Referenced by Botan::RSA_PublicKey::get_e(), Botan::RSA_PublicKey::get_n(), Botan::RSA_PublicKey::init(), Botan::RSA_PublicKey::key_length(), and Botan::RSA_PublicKey::public_data().

---

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

• src/lib/pubkey/rsa/rsa.h
• src/lib/pubkey/rsa/rsa.cpp