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

#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="SHA") 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< bytepkcs8_private_key () const override
 
 RSA_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &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< bytex509_subject_public_key () const override
 
virtual std::vector< bytex509_subject_public_key () const =0
 

Protected Attributes

BigInt m_e
 
BigInt m_n
 

Detailed Description

RSA Private Key

Definition at line 82 of file rsa.h.

Constructor & Destructor Documentation

§ RSA_PrivateKey() [1/3]

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

Load a private key.

Parameters
alg_idthe X.509 algorithm identifier
key_bitsPKCS #8 structure

Definition at line 92 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().

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

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

References Botan::inverse_mod(), Botan::BigInt::is_even(), Botan::BigInt::is_nonzero(), Botan::lcm(), Botan::RSA_PublicKey::m_e, and Botan::RSA_PublicKey::m_n.

113  :
114  m_d{ d_exp }, m_p{ prime1 }, m_q{ prime2 }, m_d1{}, m_d2{}, m_c{ inverse_mod( m_q, m_p ) }
115  {
116  m_n = mod.is_nonzero() ? mod : m_p * m_q;
117  m_e = exp;
118 
119  if(m_d == 0)
120  {
121  BigInt inv_for_d = lcm(m_p - 1, m_q - 1);
122  if(m_e.is_even())
123  inv_for_d >>= 1;
124 
125  m_d = inverse_mod(m_e, inv_for_d);
126  }
127 
128  m_d1 = m_d % (m_p - 1);
129  m_d2 = m_d % (m_q - 1);
130  }
bool is_even() const
Definition: bigint.h:232
bool is_nonzero() const
Definition: bigint.h:244
BigInt m_e
Definition: rsa.h:76
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
Definition: numthry.cpp:276
BigInt m_n
Definition: rsa.h:76
BigInt lcm(const BigInt &a, const BigInt &b)
Definition: numthry.cpp:73

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

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

137  {
138  if(bits < 1024)
139  throw Invalid_Argument(algo_name() + ": Can't make a key that is only " +
140  std::to_string(bits) + " bits long");
141  if(exp < 3 || exp % 2 == 0)
142  throw Invalid_Argument(algo_name() + ": Invalid encryption exponent");
143 
144  m_e = exp;
145 
146  do
147  {
148  m_p = random_prime(rng, (bits + 1) / 2, m_e);
149  m_q = random_prime(rng, bits - m_p.bits(), m_e);
150  m_n = m_p * m_q;
151  } while(m_n.bits() != bits);
152 
153  m_d = inverse_mod(m_e, lcm(m_p - 1, m_q - 1));
154  m_d1 = m_d % (m_p - 1);
155  m_d2 = m_d % (m_q - 1);
156  m_c = inverse_mod(m_q, m_p);
157  }
size_t bits() const
Definition: bigint.cpp:184
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:47
BigInt m_e
Definition: rsa.h:76
std::string algo_name() const override
Definition: rsa.h:38
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
Definition: numthry.cpp:276
BigInt m_n
Definition: rsa.h:76
BigInt lcm(const BigInt &a, const BigInt &b)
Definition: numthry.cpp:73
BigInt random_prime(RandomNumberGenerator &rng, size_t bits, const BigInt &coprime, size_t equiv, size_t modulo)
Definition: make_prm.cpp:17

Member Function Documentation

§ algo_name() [1/2]

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

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

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

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

39  {
40  return AlgorithmIdentifier(get_oid(),
42  }
virtual OID get_oid() const
Definition: pk_keys.cpp:20

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

References Botan::BigInt::bits(), get_c(), get_d1(), get_d2(), Botan::RSA_PublicKey::get_e(), Botan::RSA_PublicKey::get_n(), get_p(), get_q(), Botan::inverse_mod(), Botan::BigInt::is_even(), Botan::is_prime(), Botan::lcm(), m_blinder, m_c, Botan::RSA_PublicKey::m_e, m_mod_p, Botan::RSA_PublicKey::m_n, m_powermod_d1_p, m_powermod_d2_q, m_powermod_e_n, Botan::mul_add(), Botan::KeyPair::signature_consistency_check(), and Botan::sub_mul().

163  {
164  if(m_n < 35 || m_n.is_even() || m_e < 2 || m_d < 2 || m_p < 3 || m_q < 3 || m_p*m_q != m_n)
165  return false;
166 
167  if(m_d1 != m_d % (m_p - 1) || m_d2 != m_d % (m_q - 1) || m_c != inverse_mod(m_q, m_p))
168  return false;
169 
170  const size_t prob = (strong) ? 56 : 12;
171 
172  if(!is_prime(m_p, rng, prob) || !is_prime(m_q, rng, prob))
173  return false;
174 
175  if(strong)
176  {
177  if((m_e * m_d) % lcm(m_p - 1, m_q - 1) != 1)
178  return false;
179 
180  return KeyPair::signature_consistency_check(rng, *this, "EMSA4(SHA-256)");
181  }
182 
183  return true;
184  }
bool is_prime(const BigInt &n, RandomNumberGenerator &rng, size_t prob, bool is_random)
Definition: numthry.cpp:438
bool is_even() const
Definition: bigint.h:232
BigInt m_e
Definition: rsa.h:76
bool signature_consistency_check(RandomNumberGenerator &rng, const Private_Key &private_key, const Public_Key &public_key, const std::string &padding)
Definition: keypair.cpp:48
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
Definition: numthry.cpp:276
BigInt m_n
Definition: rsa.h:76
BigInt lcm(const BigInt &a, const BigInt &b)
Definition: numthry.cpp:73

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

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

470  {
471 #if defined(BOTAN_HAS_OPENSSL)
472  if(provider == "openssl" || provider.empty())
473  {
474  try
475  {
476  return make_openssl_rsa_dec_op(*this, params);
477  }
478  catch(Exception& e)
479  {
480  if(provider == "openssl")
481  throw Exception("OpenSSL RSA provider rejected key:", e.what());
482  }
483  }
484 #endif
485 
486  if(provider == "base" || provider.empty())
487  return std::unique_ptr<PK_Ops::Decryption>(new RSA_Decryption_Operation(*this, params, rng));
488 
489  throw Provider_Not_Found(algo_name(), provider);
490  }
std::string algo_name() const override
Definition: rsa.h:38

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

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

411  {
412 #if defined(BOTAN_HAS_OPENSSL)
413  if(provider == "openssl" || provider.empty())
414  {
415  try
416  {
417  return make_openssl_rsa_enc_op(*this, params);
418  }
419  catch(Exception& e)
420  {
421  /*
422  * If OpenSSL for some reason could not handle this (eg due to OAEP params),
423  * throw if openssl was specifically requested but otherwise just fall back
424  * to the normal version.
425  */
426  if(provider == "openssl")
427  throw Exception("OpenSSL RSA provider rejected key:", e.what());
428  }
429  }
430 #endif
431 
432  if(provider == "base" || provider.empty())
433  return std::unique_ptr<PK_Ops::Encryption>(new RSA_Encryption_Operation(*this, params));
434  throw Provider_Not_Found(algo_name(), provider);
435  }
std::string algo_name() const override
Definition: rsa.h:38

§ 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, and Botan::ElGamal_PublicKey.

Definition at line 56 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

59  {
60  throw Lookup_Error(algo_name() + " does not support encryption");
61  }
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 493 of file rsa.cpp.

References Botan::RSA_PublicKey::algo_name().

496  {
497  if(provider == "base" || provider.empty())
498  return std::unique_ptr<PK_Ops::KEM_Decryption>(new RSA_KEM_Decryption_Operation(*this, params, rng));
499 
500  throw Provider_Not_Found(algo_name(), provider);
501  }
std::string algo_name() const override
Definition: rsa.h:38

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

References Botan::RSA_PublicKey::algo_name().

441  {
442  if(provider == "base" || provider.empty())
443  return std::unique_ptr<PK_Ops::KEM_Encryption>(new RSA_KEM_Encryption_Operation(*this, params));
444  throw Provider_Not_Found(algo_name(), provider);
445  }
std::string algo_name() const override
Definition: rsa.h:38

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

References Botan::Public_Key::algo_name().

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

67  {
68  throw Lookup_Error(algo_name() + " does not support KEM encryption");
69  }
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 103 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

106  {
107  throw Lookup_Error(algo_name() + " does not support key agreement");
108  }
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 504 of file rsa.cpp.

References Botan::RSA_PublicKey::algo_name().

507  {
508 #if defined(BOTAN_HAS_OPENSSL)
509  if(provider == "openssl" || provider.empty())
510  {
511  std::unique_ptr<PK_Ops::Signature> res = make_openssl_rsa_sig_op(*this, params);
512  if(res)
513  return res;
514  }
515 #endif
516 
517  if(provider == "base" || provider.empty())
518  return std::unique_ptr<PK_Ops::Signature>(new RSA_Signature_Operation(*this, params, rng));
519 
520  throw Provider_Not_Found(algo_name(), provider);
521  }
std::string algo_name() const override
Definition: rsa.h:38

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

References Botan::RSA_PublicKey::algo_name().

450  {
451 #if defined(BOTAN_HAS_OPENSSL)
452  if(provider == "openssl" || provider.empty())
453  {
454  std::unique_ptr<PK_Ops::Verification> res = make_openssl_rsa_ver_op(*this, params);
455  if(res)
456  return res;
457  }
458 #endif
459 
460  if(provider == "base" || provider.empty())
461  return std::unique_ptr<PK_Ops::Verification>(new RSA_Verify_Operation(*this, params));
462 
463  throw Provider_Not_Found(algo_name(), provider);
464  }
std::string algo_name() const override
Definition: rsa.h:38

§ 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_WOTS_PublicKey, Botan::XMSS_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, and Botan::DSA_PublicKey.

Definition at line 72 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Verifier::PK_Verifier().

74  {
75  throw Lookup_Error(algo_name() + " does not support verification");
76  }
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, 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 33 of file rsa.cpp.

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

34  {
35  return if_work_factor(key_length());
36  }
size_t key_length() const override
Definition: rsa.cpp:28
size_t if_work_factor(size_t bits)
Definition: workfactor.cpp:19

§ fingerprint()

std::string Botan::Private_Key::fingerprint ( const std::string &  alg = "SHA") const
inherited
Returns
Hash of the PKCS #8 encoding for this key object

Definition at line 34 of file pk_keys.cpp.

References Botan::HashFunction::create(), hash, and Botan::hex_encode().

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

35  {
36  secure_vector<byte> buf = pkcs8_private_key();
37  std::unique_ptr<HashFunction> hash(HashFunction::create(alg));
38  hash->update(buf);
39  const auto hex_print = hex_encode(hash->final());
40 
41  std::string formatted_print;
42 
43  for(size_t i = 0; i != hex_print.size(); i += 2)
44  {
45  formatted_print.push_back(hex_print[i]);
46  formatted_print.push_back(hex_print[i+1]);
47 
48  if(i != hex_print.size() - 2)
49  formatted_print.push_back(':');
50  }
51 
52  return formatted_print;
53  }
virtual secure_vector< byte > pkcs8_private_key() const =0
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
Definition: hash.cpp:93
MechanismType hash
void hex_encode(char output[], const byte input[], size_t input_length, bool uppercase)
Definition: hex.cpp:14

§ get_c()

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

Definition at line 137 of file rsa.h.

References m_c.

Referenced by check_key().

137 { 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 135 of file rsa.h.

135 { return m_d; }

§ get_d1()

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

Definition at line 138 of file rsa.h.

Referenced by check_key().

138 { return m_d1; }

§ get_d2()

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

Definition at line 139 of file rsa.h.

Referenced by check_key().

139 { return m_d2; }

§ get_e()

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

Definition at line 54 of file rsa.h.

Referenced by check_key().

54 { return m_e; }
BigInt m_e
Definition: rsa.h:76

§ get_n()

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

Definition at line 49 of file rsa.h.

References m_n.

Referenced by check_key().

49 { return m_n; }
BigInt m_n
Definition: rsa.h:76

§ 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 20 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::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().

21  {
22  try {
23  return OIDS::lookup(algo_name());
24  }
25  catch(Lookup_Error&)
26  {
27  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
28  }
29  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:18

§ get_p()

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

Get the first prime p.

Returns
prime p

Definition at line 123 of file rsa.h.

Referenced by check_key().

123 { 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 129 of file rsa.h.

References m_q.

Referenced by check_key().

129 { 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, 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 28 of file rsa.cpp.

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

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

29  {
30  return m_n.bits();
31  }
size_t bits() const
Definition: bigint.cpp:184
BigInt m_n
Definition: rsa.h:76

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

Definition at line 106 of file pk_keys.h.

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

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

Definition at line 95 of file pk_keys.h.

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

95 { 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 170 of file pk_keys.h.

Referenced by Botan::PKCS8::BER_encode().

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

§ pkcs8_private_key()

secure_vector< byte > Botan::RSA_PrivateKey::pkcs8_private_key ( ) const
overridevirtual
Returns
PKCS #8 private key encoding for this key object

Implements Botan::Private_Key.

Definition at line 75 of file rsa.cpp.

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

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

§ x509_subject_public_key() [1/2]

std::vector< byte > Botan::RSA_PublicKey::x509_subject_public_key ( ) const
overridevirtualinherited
Returns
X.509 subject key encoding for this key object

Implements Botan::Public_Key.

Definition at line 44 of file rsa.cpp.

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

45  {
46  return DER_Encoder()
47  .start_cons(SEQUENCE)
48  .encode(m_n)
49  .encode(m_e)
50  .end_cons()
51  .get_contents_unlocked();
52  }
BigInt m_e
Definition: rsa.h:76
BigInt m_n
Definition: rsa.h:76

§ x509_subject_public_key() [2/2]

virtual std::vector<byte> Botan::Public_Key::x509_subject_public_key ( ) const
pure virtualinherited

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: