Botan  2.9.0
Crypto and TLS for C++11
Public Member Functions | Protected Attributes | List of all members
Botan::RSA_PrivateKey Class Referencefinalabstract

#include <rsa.h>

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

Public Member Functions

virtual std::string algo_name () const =0
 
std::string algo_name () const override
 
AlgorithmIdentifier algorithm_identifier () const override
 
virtual AlgorithmIdentifier algorithm_identifier () const =0
 
bool check_key (RandomNumberGenerator &rng, bool) const override
 
std::unique_ptr< PK_Ops::Decryptioncreate_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
 
std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
 
virtual std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
std::unique_ptr< PK_Ops::KEM_Decryptioncreate_kem_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
 
std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
 
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
virtual std::unique_ptr< PK_Ops::Key_Agreementcreate_key_agreement_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
std::unique_ptr< PK_Ops::Signaturecreate_signature_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
 
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (const std::string &params, const std::string &provider) const override
 
virtual std::unique_ptr< PK_Ops::Verificationcreate_verification_op (const std::string &params, const std::string &provider) const
 
virtual size_t estimated_strength () const =0
 
size_t estimated_strength () const override
 
std::string fingerprint (const std::string &alg) const
 
std::string fingerprint_private (const std::string &alg) const
 
std::string fingerprint_public (const std::string &alg="SHA-256") const
 
const BigIntget_c () const
 
const BigIntget_d () const
 
const BigIntget_d1 () const
 
const BigIntget_d2 () const
 
const BigIntget_e () const
 
const BigIntget_n () const
 
virtual OID get_oid () const
 
const BigIntget_p () const
 
const BigIntget_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
 
secure_vector< uint8_t > private_key_bits () const override
 
secure_vector< uint8_t > private_key_info () const
 
std::vector< uint8_t > public_key_bits () const override
 
virtual std::vector< uint8_t > public_key_bits () const =0
 
 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=0, const BigInt &n=0)
 
 RSA_PrivateKey (RandomNumberGenerator &rng, size_t bits, size_t exp=65537)
 
std::vector< uint8_t > subject_public_key () const
 

Protected Attributes

BigInt m_e
 
BigInt m_n
 

Detailed Description

RSA Private Key

Definition at line 84 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_idthe X.509 algorithm identifier
key_bitsPKCS#1 RSAPrivateKey bits

Definition at line 96 of file rsa.cpp.

References Botan::PEM_Code::decode(), Botan::BER_Decoder::decode_and_check(), Botan::RSA_PublicKey::m_e, Botan::RSA_PublicKey::m_n, Botan::SEQUENCE, and Botan::BER_Decoder::start_cons().

98  {
99  BER_Decoder(key_bits)
100  .start_cons(SEQUENCE)
101  .decode_and_check<size_t>(0, "Unknown PKCS #1 key format version")
102  .decode(m_n)
103  .decode(m_e)
104  .decode(m_d)
105  .decode(m_p)
106  .decode(m_q)
107  .decode(m_d1)
108  .decode(m_d2)
109  .decode(m_c)
110  .end_cons();
111  }
BigInt m_e
Definition: rsa.h:78
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
Definition: pem.cpp:68
BigInt m_n
Definition: rsa.h:78

◆ RSA_PrivateKey() [2/3]

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

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

117  :
118  m_d{ d_exp }, m_p{ prime1 }, m_q{ prime2 }, m_d1{}, m_d2{}, m_c{ inverse_mod( m_q, m_p ) }
119  {
120  m_n = mod.is_nonzero() ? mod : m_p * m_q;
121  m_e = exp;
122 
123  if(m_d == 0)
124  {
125  const BigInt phi_n = lcm(m_p - 1, m_q - 1);
126  m_d = inverse_mod(m_e, phi_n);
127  }
128 
129  m_d1 = ct_modulo(m_d, m_p - 1);
130  m_d2 = ct_modulo(m_d, m_q - 1);
131  }
BigInt ct_modulo(const BigInt &x, const BigInt &y)
Definition: divide.cpp:118
bool is_nonzero() const
Definition: bigint.h:414
BigInt m_e
Definition: rsa.h:78
BigInt lcm(const BigInt &a, const BigInt &b)
Definition: numthry.cpp:85
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
Definition: numthry.cpp:290
BigInt m_n
Definition: rsa.h:78

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

References Botan::RSA_PublicKey::algo_name(), Botan::BigInt::bits(), Botan::ct_modulo(), Botan::generate_rsa_prime(), Botan::inverse_mod(), Botan::lcm(), Botan::RSA_PublicKey::m_e, Botan::RSA_PublicKey::m_n, and Botan::ASN1::to_string().

138  {
139  if(bits < 1024)
140  throw Invalid_Argument(algo_name() + ": Can't make a key that is only " +
141  std::to_string(bits) + " bits long");
142  if(exp < 3 || exp % 2 == 0)
143  throw Invalid_Argument(algo_name() + ": Invalid encryption exponent");
144 
145  m_e = exp;
146 
147  const size_t p_bits = (bits + 1) / 2;
148  const size_t q_bits = bits - p_bits;
149 
150  do
151  {
152  m_p = generate_rsa_prime(rng, rng, p_bits, m_e);
153  m_q = generate_rsa_prime(rng, rng, q_bits, m_e);
154  m_n = m_p * m_q;
155  } while(m_n.bits() != bits);
156 
157  // FIXME: lcm calls gcd which is not const time
158  const BigInt phi_n = lcm(m_p - 1, m_q - 1);
159  // FIXME: this uses binary ext gcd because phi_n is even
160  m_d = inverse_mod(m_e, phi_n);
161  m_d1 = ct_modulo(m_d, m_p - 1);
162  m_d2 = ct_modulo(m_d, m_q - 1);
163  m_c = inverse_mod(m_q, m_p);
164  }
size_t bits() const
Definition: bigint.cpp:281
BigInt ct_modulo(const BigInt &x, const BigInt &y)
Definition: divide.cpp:118
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:210
BigInt m_e
Definition: rsa.h:78
BigInt lcm(const BigInt &a, const BigInt &b)
Definition: numthry.cpp:85
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
Definition: numthry.cpp:290
std::string algo_name() const override
Definition: rsa.h:40
BigInt generate_rsa_prime(RandomNumberGenerator &keygen_rng, RandomNumberGenerator &prime_test_rng, size_t bits, const BigInt &coprime, size_t prob)
Definition: make_prm.cpp:177
BigInt m_n
Definition: rsa.h:78

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::XMSS_WOTS_PublicKey, Botan::XMSS_PublicKey, Botan::TPM_PrivateKey, Botan::ECDSA_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::ECDH_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_PublicKey, Botan::RSA_PublicKey, Botan::McEliece_PublicKey, Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::Ed25519_PublicKey, Botan::ElGamal_PublicKey, and Botan::Curve25519_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::PSSR::config_for_x509(), Botan::EMSA_PKCS1v15::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_Key_Agreement::PK_Key_Agreement(), 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 40 of file rsa.h.

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

40 { return "RSA"; }

◆ algorithm_identifier() [1/2]

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

Implements Botan::Public_Key.

Definition at line 41 of file rsa.cpp.

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

42  {
43  return AlgorithmIdentifier(get_oid(),
45  }
virtual OID get_oid() const
Definition: pk_keys.cpp:53

◆ algorithm_identifier() [2/2]

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

◆ check_key()

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

Test the key values for consistency.

Parameters
rngrng to use
strongwhether to perform strong and lengthy version of the test
Returns
true if the test is passed

Reimplemented from Botan::RSA_PublicKey.

Definition at line 169 of file rsa.cpp.

References Botan::ct_modulo(), Botan::inverse_mod(), Botan::BigInt::is_even(), Botan::is_prime(), Botan::lcm(), Botan::RSA_PublicKey::m_e, Botan::RSA_PublicKey::m_n, and Botan::KeyPair::signature_consistency_check().

170  {
171  if(m_n < 35 || m_n.is_even() || m_e < 3 || m_e.is_even())
172  return false;
173 
174  if(m_d < 2 || m_p < 3 || m_q < 3 || m_p*m_q != m_n)
175  return false;
176 
177  if(m_d1 != ct_modulo(m_d, m_p - 1) || m_d2 != ct_modulo(m_d, m_q - 1) || m_c != inverse_mod(m_q, m_p))
178  return false;
179 
180  const size_t prob = (strong) ? 128 : 12;
181 
182  if(!is_prime(m_p, rng, prob) || !is_prime(m_q, rng, prob))
183  return false;
184 
185  if(strong)
186  {
187  if(ct_modulo(m_e * m_d, lcm(m_p - 1, m_q - 1)) != 1)
188  return false;
189 
190  return KeyPair::signature_consistency_check(rng, *this, "EMSA4(SHA-256)");
191  }
192 
193  return true;
194  }
bool is_prime(const BigInt &n, RandomNumberGenerator &rng, size_t prob, bool is_random)
Definition: numthry.cpp:488
BigInt ct_modulo(const BigInt &x, const BigInt &y)
Definition: divide.cpp:118
bool is_even() const
Definition: bigint.h:402
BigInt m_e
Definition: rsa.h:78
bool signature_consistency_check(RandomNumberGenerator &rng, const Private_Key &private_key, const Public_Key &public_key, const std::string &padding)
Definition: keypair.cpp:49
BigInt lcm(const BigInt &a, const BigInt &b)
Definition: numthry.cpp:85
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
Definition: numthry.cpp:290
BigInt m_n
Definition: rsa.h:78

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

References Botan::RSA_PublicKey::algo_name(), and Botan::Exception::what().

549  {
550 #if defined(BOTAN_HAS_OPENSSL)
551  if(provider == "openssl" || provider.empty())
552  {
553  try
554  {
555  return make_openssl_rsa_dec_op(*this, params);
556  }
557  catch(Exception& e)
558  {
559  if(provider == "openssl")
560  throw Lookup_Error("OpenSSL RSA provider rejected key:" + std::string(e.what()));
561  }
562  }
563 #endif
564 
565  if(provider == "base" || provider.empty())
566  return std::unique_ptr<PK_Ops::Decryption>(new RSA_Decryption_Operation(*this, params, rng));
567 
568  throw Provider_Not_Found(algo_name(), provider);
569  }
std::string algo_name() const override
Definition: rsa.h:40

◆ create_encryption_op() [1/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
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.

Definition at line 487 of file rsa.cpp.

References Botan::RSA_PublicKey::algo_name(), and Botan::Exception::what().

490  {
491 #if defined(BOTAN_HAS_OPENSSL)
492  if(provider == "openssl" || provider.empty())
493  {
494  try
495  {
496  return make_openssl_rsa_enc_op(*this, params);
497  }
498  catch(Exception& e)
499  {
500  /*
501  * If OpenSSL for some reason could not handle this (eg due to OAEP params),
502  * throw if openssl was specifically requested but otherwise just fall back
503  * to the normal version.
504  */
505  if(provider == "openssl")
506  throw Lookup_Error("OpenSSL RSA provider rejected key:" + std::string(e.what()));
507  }
508  }
509 #endif
510 
511  if(provider == "base" || provider.empty())
512  return std::unique_ptr<PK_Ops::Encryption>(new RSA_Encryption_Operation(*this, params));
513  throw Provider_Not_Found(algo_name(), provider);
514  }
std::string algo_name() const override
Definition: rsa.h:40

◆ create_encryption_op() [2/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
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::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::ElGamal_PublicKey.

Definition at line 94 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

97  {
98  throw Lookup_Error(algo_name() + " does not support encryption");
99  }
virtual std::string algo_name() const =0

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

References Botan::RSA_PublicKey::algo_name().

575  {
576  if(provider == "base" || provider.empty())
577  return std::unique_ptr<PK_Ops::KEM_Decryption>(new RSA_KEM_Decryption_Operation(*this, params, rng));
578 
579  throw Provider_Not_Found(algo_name(), provider);
580  }
std::string algo_name() const override
Definition: rsa.h:40

◆ create_kem_encryption_op() [1/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
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.

Definition at line 517 of file rsa.cpp.

References Botan::RSA_PublicKey::algo_name().

520  {
521  if(provider == "base" || provider.empty())
522  return std::unique_ptr<PK_Ops::KEM_Encryption>(new RSA_KEM_Encryption_Operation(*this, params));
523  throw Provider_Not_Found(algo_name(), provider);
524  }
std::string algo_name() const override
Definition: rsa.h:40

◆ create_kem_encryption_op() [2/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
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::RSA_PublicKey, and Botan::McEliece_PublicKey.

Definition at line 102 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

105  {
106  throw Lookup_Error(algo_name() + " does not support KEM encryption");
107  }
virtual std::string algo_name() const =0

◆ 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
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::ECDH_PrivateKey, Botan::Curve25519_PrivateKey, and Botan::DH_PrivateKey.

Definition at line 141 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

144  {
145  throw Lookup_Error(algo_name() + " does not support key agreement");
146  }
virtual std::string algo_name() const =0

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

References Botan::RSA_PublicKey::algo_name().

586  {
587 #if defined(BOTAN_HAS_OPENSSL)
588  if(provider == "openssl" || provider.empty())
589  {
590  std::unique_ptr<PK_Ops::Signature> res = make_openssl_rsa_sig_op(*this, params);
591  if(res)
592  return res;
593  }
594 #endif
595 
596  if(provider == "base" || provider.empty())
597  return std::unique_ptr<PK_Ops::Signature>(new RSA_Signature_Operation(*this, params, rng));
598 
599  throw Provider_Not_Found(algo_name(), provider);
600  }
std::string algo_name() const override
Definition: rsa.h:40

◆ create_verification_op() [1/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
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 527 of file rsa.cpp.

References Botan::RSA_PublicKey::algo_name().

529  {
530 #if defined(BOTAN_HAS_OPENSSL)
531  if(provider == "openssl" || provider.empty())
532  {
533  std::unique_ptr<PK_Ops::Verification> res = make_openssl_rsa_ver_op(*this, params);
534  if(res)
535  return res;
536  }
537 #endif
538 
539  if(provider == "base" || provider.empty())
540  return std::unique_ptr<PK_Ops::Verification>(new RSA_Verify_Operation(*this, params));
541 
542  throw Provider_Not_Found(algo_name(), provider);
543  }
std::string algo_name() const override
Definition: rsa.h:40

◆ create_verification_op() [2/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
paramsadditional parameters
providerthe provider to use

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

Definition at line 110 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

112  {
113  throw Lookup_Error(algo_name() + " does not support verification");
114  }
virtual std::string algo_name() const =0

◆ 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::XMSS_WOTS_PublicKey, Botan::XMSS_PublicKey, Botan::TPM_PrivateKey, Botan::EC_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::DL_Scheme_PublicKey, Botan::RSA_PublicKey, Botan::McEliece_PublicKey, Botan::Ed25519_PublicKey, and Botan::Curve25519_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 36 of file rsa.cpp.

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

37  {
38  return if_work_factor(key_length());
39  }
size_t if_work_factor(size_t bits)
Definition: workfactor.cpp:38
size_t key_length() const override
Definition: rsa.cpp:31

◆ fingerprint()

std::string Botan::Private_Key::fingerprint ( const std::string &  alg) const
inlineinherited

Definition at line 204 of file pk_keys.h.

205  {
206  return fingerprint_private(alg); // match behavior in previous versions
207  }
std::string fingerprint_private(const std::string &alg) const
Definition: pk_keys.cpp:88

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

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

89  {
91  }
virtual secure_vector< uint8_t > private_key_bits() const =0
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:23
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, const std::string &hash_name)
Definition: pk_keys.cpp:17

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

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

81  {
83  }
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:23
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, const std::string &hash_name)
Definition: pk_keys.cpp:17
std::vector< uint8_t > subject_public_key() const
Definition: pk_keys.cpp:38

◆ get_c()

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

Definition at line 139 of file rsa.h.

139 { return m_c; }

◆ get_d()

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

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

Returns
d

Definition at line 137 of file rsa.h.

137 { return m_d; }

◆ get_d1()

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

Definition at line 140 of file rsa.h.

140 { return m_d1; }

◆ get_d2()

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

Definition at line 141 of file rsa.h.

141 { return m_d2; }

◆ get_e()

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

Definition at line 56 of file rsa.h.

References m_e.

56 { return m_e; }
BigInt m_e
Definition: rsa.h:78

◆ get_n()

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

Definition at line 51 of file rsa.h.

References m_n.

51 { return m_n; }
BigInt m_n
Definition: rsa.h:78

◆ 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.

References Botan::Public_Key::algo_name(), and Botan::OIDS::lookup().

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

54  {
55  try {
56  return OIDS::lookup(algo_name());
57  }
58  catch(Lookup_Error&)
59  {
60  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
61  }
62  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:113

◆ get_p()

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

Get the first prime p.

Returns
prime p

Definition at line 125 of file rsa.h.

125 { return m_p; }

◆ get_q()

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

Get the second prime q.

Returns
prime q

Definition at line 131 of file rsa.h.

131 { return m_q; }

◆ 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::XMSS_WOTS_PublicKey, Botan::XMSS_PublicKey, Botan::TPM_PrivateKey, Botan::EC_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::DL_Scheme_PublicKey, Botan::RSA_PublicKey, Botan::McEliece_PublicKey, Botan::Ed25519_PublicKey, and Botan::Curve25519_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 31 of file rsa.cpp.

References Botan::BigInt::bits(), and Botan::RSA_PublicKey::m_n.

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

32  {
33  return m_n.bits();
34  }
size_t bits() const
Definition: bigint.cpp:281
BigInt m_n
Definition: rsa.h:78

◆ 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::ECDSA_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_PublicKey, and Botan::DSA_PublicKey.

Definition at line 119 of file pk_keys.h.

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

119 { return 0; }

◆ 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::ECDSA_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_PublicKey, and Botan::DSA_PublicKey.

Definition at line 108 of file pk_keys.h.

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

108 { return 1; }

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

Definition at line 193 of file pk_keys.h.

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

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

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

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::RSA_PublicKey::m_e, Botan::RSA_PublicKey::m_n, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

80  {
81  return DER_Encoder()
82  .start_cons(SEQUENCE)
83  .encode(static_cast<size_t>(0))
84  .encode(m_n)
85  .encode(m_e)
86  .encode(m_d)
87  .encode(m_p)
88  .encode(m_q)
89  .encode(m_d1)
90  .encode(m_d2)
91  .encode(m_c)
92  .end_cons()
93  .get_contents();
94  }
BigInt m_e
Definition: rsa.h:78
BigInt m_n
Definition: rsa.h:78

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

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OCTET_STRING, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::private_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

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

65  {
66  const size_t PKCS8_VERSION = 0;
67 
68  return DER_Encoder()
69  .start_cons(SEQUENCE)
70  .encode(PKCS8_VERSION)
72  .encode(private_key_bits(), OCTET_STRING)
73  .end_cons()
74  .get_contents();
75  }
virtual secure_vector< uint8_t > private_key_bits() const =0
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition: pk_keys.h:193

◆ public_key_bits() [1/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 47 of file rsa.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::RSA_PublicKey::m_e, Botan::RSA_PublicKey::m_n, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

48  {
49  std::vector<uint8_t> output;
50  DER_Encoder der(output);
51  der.start_cons(SEQUENCE)
52  .encode(m_n)
53  .encode(m_e)
54  .end_cons();
55 
56  return output;
57  }
BigInt m_e
Definition: rsa.h:78
BigInt m_n
Definition: rsa.h:78

◆ public_key_bits() [2/2]

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

◆ 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.

References Botan::Public_Key::algorithm_identifier(), Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

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

39  {
40  std::vector<uint8_t> output;
41 
42  DER_Encoder(output).start_cons(SEQUENCE)
43  .encode(algorithm_identifier())
44  .encode(public_key_bits(), BIT_STRING)
45  .end_cons();
46 
47  return output;
48  }
virtual std::vector< uint8_t > public_key_bits() const =0
virtual AlgorithmIdentifier algorithm_identifier() const =0

Member Data Documentation

◆ m_e

BigInt Botan::RSA_PublicKey::m_e
protectedinherited

◆ m_n

BigInt Botan::RSA_PublicKey::m_n
protectedinherited

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