Botan  1.10.9
Public Member Functions | Protected Member Functions | List of all members
Botan::Public_Key Class Referenceabstract

#include <pk_keys.h>

Inheritance diagram for Botan::Public_Key:
Botan::DL_Scheme_PublicKey Botan::EC_PublicKey Botan::IF_Scheme_PublicKey Botan::Private_Key Botan::DH_PublicKey Botan::DL_Scheme_PrivateKey Botan::DSA_PublicKey Botan::ElGamal_PublicKey Botan::NR_PublicKey Botan::EC_PrivateKey Botan::ECDH_PublicKey Botan::ECDSA_PublicKey Botan::GOST_3410_PublicKey Botan::IF_Scheme_PrivateKey Botan::RSA_PublicKey Botan::RW_PublicKey Botan::DL_Scheme_PrivateKey Botan::EC_PrivateKey Botan::IF_Scheme_PrivateKey Botan::PK_Key_Agreement_Key

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 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 MemoryVector< bytex509_subject_public_key () const =0
 
virtual ~Public_Key ()
 

Protected Member Functions

virtual void load_check (RandomNumberGenerator &rng) const
 

Detailed Description

Public Key Base Class.

Definition at line 21 of file pk_keys.h.

Constructor & Destructor Documentation

virtual Botan::Public_Key::~Public_Key ( )
inlinevirtual

Definition at line 74 of file pk_keys.h.

74 {}

Member Function Documentation

virtual std::string Botan::Public_Key::algo_name ( ) const
pure virtual
virtual AlgorithmIdentifier Botan::Public_Key::algorithm_identifier ( ) const
pure virtual
virtual bool Botan::Public_Key::check_key ( RandomNumberGenerator rng,
bool  strong 
) const
pure virtual

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

Implemented in Botan::DL_Scheme_PrivateKey, Botan::ECDSA_PrivateKey, Botan::IF_Scheme_PrivateKey, Botan::RW_PrivateKey, Botan::DSA_PrivateKey, Botan::EC_PublicKey, Botan::RSA_PrivateKey, Botan::ElGamal_PrivateKey, Botan::NR_PrivateKey, Botan::IF_Scheme_PublicKey, and Botan::DL_Scheme_PublicKey.

Referenced by Botan::Private_Key::gen_check(), load_check(), and Botan::Private_Key::load_check().

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

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 algo_name(), and Botan::OIDS::lookup().

Referenced by Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::IF_Scheme_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), and Botan::EC_PublicKey::algorithm_identifier().

18  {
19  try {
20  return OIDS::lookup(algo_name());
21  }
22  catch(Lookup_Error)
23  {
24  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
25  }
26  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:31
void Botan::Public_Key::load_check ( RandomNumberGenerator rng) const
protectedvirtual

Self-test after loading a key

Parameters
rnga random number generator

Reimplemented in Botan::Private_Key.

Definition at line 31 of file pk_keys.cpp.

References algo_name(), and check_key().

32  {
33  if(!check_key(rng, BOTAN_PUBLIC_KEY_STRONG_CHECKS_ON_LOAD))
34  throw Invalid_Argument(algo_name() + ": Invalid public key");
35  }
virtual bool check_key(RandomNumberGenerator &rng, bool strong) const =0
virtual std::string algo_name() const =0
std::invalid_argument Invalid_Argument
Definition: exceptn.h:20
RandomNumberGenerator * rng
Definition: global_rng.cpp:165
virtual size_t Botan::Public_Key::max_input_bits ( ) const
pure virtual

Get the maximum message size in bits supported by this public key.

Returns
maximum message size in bits

Implemented in Botan::GOST_3410_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::IF_Scheme_PublicKey, Botan::NR_PublicKey, Botan::DSA_PublicKey, Botan::ElGamal_PublicKey, and Botan::DH_PublicKey.

Referenced by Botan::choose_sig_format().

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

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

56 { return 0; }
virtual size_t Botan::Public_Key::message_parts ( ) const
inlinevirtual

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

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

50 { return 1; }
virtual MemoryVector<byte> Botan::Public_Key::x509_subject_public_key ( ) const
pure virtual
Returns
X.509 subject key encoding for this key object

Implemented in Botan::EC_PublicKey, Botan::GOST_3410_PublicKey, Botan::IF_Scheme_PublicKey, and Botan::DL_Scheme_PublicKey.

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


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