Botan  1.11.15
Public Member Functions | Protected Member Functions
Botan::Private_Key Class Reference

#include <pk_keys.h>

Inheritance diagram for Botan::Private_Key:
Botan::Public_Key Botan::Curve25519_PrivateKey Botan::DL_Scheme_PrivateKey Botan::EC_PrivateKey Botan::IF_Scheme_PrivateKey Botan::McEliece_PrivateKey Botan::PK_Key_Agreement_Key Botan::DH_PrivateKey Botan::DSA_PrivateKey Botan::ElGamal_PrivateKey Botan::NR_PrivateKey Botan::ECDH_PrivateKey Botan::ECDSA_PrivateKey Botan::GOST_3410_PrivateKey Botan::RSA_PrivateKey Botan::RW_PrivateKey Botan::Curve25519_PrivateKey Botan::DH_PrivateKey Botan::ECDH_PrivateKey

List of all members.

Public Member Functions

virtual std::string algo_name () const =0
virtual AlgorithmIdentifier algorithm_identifier () const =0
virtual bool check_key (RandomNumberGenerator &rng, bool strong) const =0
virtual size_t estimated_strength () const =0
virtual OID get_oid () const
virtual size_t max_input_bits () const =0
virtual size_t message_part_size () const
virtual size_t message_parts () const
virtual AlgorithmIdentifier pkcs8_algorithm_identifier () const
virtual secure_vector< bytepkcs8_private_key () const =0
virtual std::vector< bytex509_subject_public_key () const =0

Protected Member Functions

void gen_check (RandomNumberGenerator &rng) const
void load_check (RandomNumberGenerator &rng) const

Detailed Description

Private Key Base Class

Definition at line 97 of file pk_keys.h.


Member Function Documentation

virtual std::string Botan::Public_Key::algo_name ( ) const [pure virtual, inherited]
virtual AlgorithmIdentifier Botan::Public_Key::algorithm_identifier ( ) const [pure virtual, inherited]
virtual bool Botan::Public_Key::check_key ( RandomNumberGenerator rng,
bool  strong 
) const [pure virtual, inherited]
virtual size_t Botan::Public_Key::estimated_strength ( ) const [pure virtual, inherited]

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::EC_PublicKey, Botan::DL_Scheme_PublicKey, Botan::McEliece_PublicKey, Botan::IF_Scheme_PublicKey, and Botan::Curve25519_PublicKey.

Referenced by botan_pubkey_estimated_strength().

void Botan::Private_Key::gen_check ( RandomNumberGenerator rng) const [protected]

Self-test after generating a key

Parameters:
rnga random number generator

Definition at line 49 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), and Botan::Public_Key::check_key().

Referenced by Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::NR_PrivateKey::NR_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

   {
   if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_GENERATE))
      throw Self_Test_Failure(algo_name() + " private key generation failed");
   }
OID Botan::Public_Key::get_oid ( ) const [virtual, inherited]

Get the OID of the underlying public key scheme.

Returns:
OID of the public key scheme

Definition at line 17 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::IF_Scheme_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), and Botan::McEliece_PublicKey::algorithm_identifier().

   {
   try {
      return OIDS::lookup(algo_name());
      }
   catch(Lookup_Error)
      {
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
      }
   }
void Botan::Private_Key::load_check ( RandomNumberGenerator rng) const [protected, virtual]

Self-test after loading a key

Parameters:
rnga random number generator

Reimplemented from Botan::Public_Key.

Definition at line 40 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), and Botan::Public_Key::check_key().

Referenced by Botan::Curve25519_PrivateKey::Curve25519_PrivateKey(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), and Botan::NR_PrivateKey::NR_PrivateKey().

   {
   if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_LOAD))
      throw Invalid_Argument(algo_name() + ": Invalid private key");
   }
virtual size_t Botan::Public_Key::max_input_bits ( ) const [pure virtual, inherited]
virtual size_t Botan::Public_Key::message_part_size ( ) const [inline, virtual, inherited]

Find out the message part size supported by this scheme/key.

Returns:
size of the message parts in bits

Reimplemented in Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::NR_PublicKey, and Botan::DSA_PublicKey.

Definition at line 67 of file pk_keys.h.

{ return 0; }
virtual size_t Botan::Public_Key::message_parts ( ) const [inline, virtual, inherited]

Find out the number of message parts supported by this scheme.

Returns:
number of message parts

Reimplemented in Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::NR_PublicKey, and Botan::DSA_PublicKey.

Definition at line 61 of file pk_keys.h.

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

{ return 1; }
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.

Definition at line 109 of file pk_keys.h.

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

         { return algorithm_identifier(); }
virtual secure_vector<byte> Botan::Private_Key::pkcs8_private_key ( ) const [pure virtual]
Returns:
PKCS #8 private key encoding for this key object

Implemented in Botan::McEliece_PrivateKey, Botan::EC_PrivateKey, Botan::DL_Scheme_PrivateKey, Botan::IF_Scheme_PrivateKey, and Botan::Curve25519_PrivateKey.

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

virtual std::vector<byte> Botan::Public_Key::x509_subject_public_key ( ) const [pure virtual, inherited]

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