Botan: Botan::IF_Scheme_PublicKey Class Reference

Botan::IF_Scheme_PublicKey::IF_Scheme_PublicKey ( )

inlineprotected

Definition at line 51 of file if_algo.h.

51 {}

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::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECDH_PublicKey, Botan::ElGamal_PublicKey, Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::NR_PublicKey, Botan::RSA_PublicKey, and Botan::RW_PublicKey.

Referenced by Botan::TLS::Certificate_Verify::Certificate_Verify(), Botan::EAC_Signed_Object::check_signature(), Botan::X509_Object::check_signature(), Botan::TLS::Handshake_State::choose_sig_format(), Botan::choose_sig_format(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::find_constraints(), Botan::Private_Key::gen_check(), Botan::Public_Key::get_oid(), Botan::Public_Key::load_check(), Botan::Private_Key::load_check(), Botan::PK_Decryptor_EME::PK_Decryptor_EME(), Botan::PK_Encryptor_EME::PK_Encryptor_EME(), Botan::PK_Key_Agreement::PK_Key_Agreement(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::TLS::Handshake_State::understand_sig_format().

AlgorithmIdentifier Botan::IF_Scheme_PublicKey::algorithm_identifier ( ) const

virtual

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 21 of file if_algo.cpp.

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

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

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

virtual

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

Implements Botan::Public_Key.

Reimplemented in Botan::IF_Scheme_PrivateKey, Botan::RW_PrivateKey, and Botan::RSA_PrivateKey.

Definition at line 51 of file if_algo.cpp.

References e, Botan::BigInt::is_even(), and n.

    {
    if(n < 35 || n.is_even() || e < 2)
       return false;
    return true;
    }

size_t Botan::IF_Scheme_PublicKey::estimated_strength ( ) const

overridevirtual

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 16 of file if_algo.cpp.

References Botan::BigInt::bits(), Botan::dl_work_factor(), and n.

    {
    return dl_work_factor(n.bits());
    }

const BigInt& Botan::IF_Scheme_PublicKey::get_e ( ) const

inline

Returns: public exponent

Definition at line 44 of file if_algo.h.

44 { return e; }

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

inline

Returns: public modulus

Definition at line 39 of file if_algo.h.

References n.

39 { return n; }

OID Botan::Public_Key::get_oid ( ) const

virtualinherited

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(), algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), and Botan::EC_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::Public_Key::load_check ( RandomNumberGenerator & rng ) const

protectedvirtualinherited

Self-test after loading a key

Parameters

rng	a random number generator

Reimplemented in Botan::Private_Key.

Definition at line 31 of file pk_keys.cpp.

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

    {
    if(!check_key(rng, BOTAN_PUBLIC_KEY_STRONG_CHECKS_ON_LOAD))
       throw Invalid_Argument(algo_name() + ": Invalid public key");
    }

size_t Botan::IF_Scheme_PublicKey::max_input_bits ( ) const

inlinevirtual

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

Returns: maximum message size in bits

Implements Botan::Public_Key.

Definition at line 46 of file if_algo.h.

References n.

46 { return (n.bits() - 1); }

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

inlinevirtualinherited

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.

67 { return 0; }

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

inlinevirtualinherited

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

61 { return 1; }

std::vector< byte > Botan::IF_Scheme_PublicKey::x509_subject_public_key ( ) const

virtual

Returns: X.509 subject key encoding for this key object

Implements Botan::Public_Key.

Definition at line 27 of file if_algo.cpp.

References e, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents_unlocked(), n, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

    {
    return DER_Encoder()
       .start_cons(SEQUENCE)
          .encode(n)
          .encode(e)
       .end_cons()
       .get_contents_unlocked();
    }

BigInt Botan::IF_Scheme_PublicKey::e

protected

Definition at line 53 of file if_algo.h.

Referenced by check_key(), Botan::RSA_PrivateKey::check_key(), Botan::RW_PrivateKey::check_key(), Botan::IF_Scheme_PrivateKey::check_key(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), IF_Scheme_PublicKey(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RW_PrivateKey::RW_PrivateKey(), and x509_subject_public_key().

BigInt Botan::IF_Scheme_PublicKey::n

protected

Definition at line 53 of file if_algo.h.

Referenced by check_key(), Botan::IF_Scheme_PrivateKey::check_key(), estimated_strength(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), IF_Scheme_PublicKey(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RW_PrivateKey::RW_PrivateKey(), and x509_subject_public_key().

Public Member Functions
virtual std::string	algo_name () const =0

AlgorithmIdentifier	algorithm_identifier () const

bool	check_key (RandomNumberGenerator &rng, bool) const

size_t	estimated_strength () const override

const BigInt &	get_e () const

const BigInt &	get_n () const

virtual OID	get_oid () const

	IF_Scheme_PublicKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits)

	IF_Scheme_PublicKey (const BigInt &n, const BigInt &e)

size_t	max_input_bits () const

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

std::vector< byte >	x509_subject_public_key () const

Protected Member Functions
	IF_Scheme_PublicKey ()

virtual void	load_check (RandomNumberGenerator &rng) const

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation