Botan::ECDH_PublicKey Class Reference

#include <ecdh.h>

Inheritance diagram for Botan::ECDH_PublicKey:

Public Member Functions
std::string	algo_name () const override
AlgorithmIdentifier	algorithm_identifier () const override
bool	check_key (RandomNumberGenerator &rng, bool strong) const override
std::vector< byte >	DER_domain () const
const EC_Group &	domain () const
EC_Group_Encoding	domain_format () const
	ECDH_PublicKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits)
	ECDH_PublicKey (const EC_Group &dom_par, const PointGFp &public_point)
size_t	estimated_strength () const override
virtual OID	get_oid () const
size_t	max_input_bits () const override
virtual size_t	message_part_size () const
virtual size_t	message_parts () const
const PointGFp &	public_point () const
std::vector< byte >	public_value () const
void	set_parameter_encoding (EC_Group_Encoding enc)
std::vector< byte >	x509_subject_public_key () const override

Protected Member Functions
	ECDH_PublicKey ()
virtual void	load_check (RandomNumberGenerator &rng) const

Protected Attributes
EC_Group_Encoding	m_domain_encoding
EC_Group	m_domain_params
PointGFp	m_public_key

Detailed Description

This class represents ECDH Public Keys.

Definition at line 20 of file ecdh.h.

Constructor & Destructor Documentation

ECDH_PublicKey() [1/3]

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

inline

Definition at line 24 of file ecdh.h.

                                                          :
         EC_PublicKey(alg_id, key_bits) {}

ECDH_PublicKey() [2/3]

Botan::ECDH_PublicKey::ECDH_PublicKey ( const EC_Group &  dom_par, const PointGFp &  public_point  )

inline

Construct a public key from a given public point.

Parameters

dom_par	the domain parameters associated with this key
public_point	the public point defining this key

Definition at line 33 of file ecdh.h.

                                                   :
         EC_PublicKey(dom_par, public_point) {}

ECDH_PublicKey() [3/3]

Botan::ECDH_PublicKey::ECDH_PublicKey ( )

protected

Definition at line 15 of file ecdh.cpp.

{}

Member Function Documentation

algo_name()

std::string Botan::ECDH_PublicKey::algo_name ( ) const

inlineoverridevirtual

Get this keys algorithm name.

Returns

this keys algorithm name

Implements Botan::Public_Key.

Definition at line 41 of file ecdh.h.

{ return "ECDH"; }

algorithm_identifier()

AlgorithmIdentifier Botan::EC_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Returns

X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 48 of file ecc_key.cpp.

References Botan::EC_PublicKey::DER_domain(), and Botan::Public_Key::get_oid().

Referenced by Botan::GOST_3410_PrivateKey::pkcs8_algorithm_identifier().

   {
   return AlgorithmIdentifier(get_oid(), DER_domain());
   }

check_key()

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

overridevirtualinherited

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::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, and Botan::ECKCDSA_PrivateKey.

Definition at line 42 of file ecc_key.cpp.

References Botan::PointGFp::on_the_curve(), and Botan::EC_PublicKey::public_point().

   {
   return public_point().on_the_curve();
   }

DER_domain()

std::vector<byte> Botan::EC_PublicKey::DER_domain ( ) const

inlineinherited

Return the DER encoding of this keys domain in whatever format is preset for this particular key

Definition at line 71 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::algorithm_identifier().

         { return domain().DER_encode(domain_format()); }

domain()

const EC_Group& Botan::EC_PublicKey::domain ( ) const

inlineinherited

Get the domain parameters of this key.

Exceptions

Invalid_State

is thrown if the domain parameters of this point are not set

Returns

the domain parameters of this key

Definition at line 59 of file ecc_key.h.

Referenced by Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::EC_PublicKey::estimated_strength(), and Botan::GOST_3410_PublicKey::GOST_3410_PublicKey().

{ return m_domain_params; }

domain_format()

EC_Group_Encoding Botan::EC_PublicKey::domain_format ( ) const

inlineinherited

Get the domain parameter encoding to be used when encoding this key.

Returns

the encoding to use

Definition at line 78 of file ecc_key.h.

         { return m_domain_encoding; }

estimated_strength()

size_t Botan::EC_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 21 of file ecc_key.cpp.

References Botan::EC_PublicKey::domain(), and Botan::ecp_work_factor().

   {
   return ecp_work_factor(domain().get_curve().get_p().bits());
   }

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

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::RSA_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), and Botan::TPM_PrivateKey::algorithm_identifier().

   {
   try {
      return OIDS::lookup(algo_name());
      }
   catch(Lookup_Error&)
      {
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
      }
   }

load_check()

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

Referenced by Botan::Curve25519_PrivateKey::Curve25519_PrivateKey().

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

max_input_bits()

size_t Botan::ECDH_PublicKey::max_input_bits ( ) const

inlineoverridevirtual

Get the maximum number of bits allowed to be fed to this key. This is the bitlength of the order of the base point.

Returns

maximum number of input bits

Implements Botan::Public_Key.

Definition at line 49 of file ecdh.h.

         { return domain().get_order().bits(); }

message_part_size()

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

Definition at line 67 of file pk_keys.h.

{ return 0; }

message_parts()

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

Definition at line 61 of file pk_keys.h.

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

{ return 1; }

public_point()

const PointGFp& Botan::EC_PublicKey::public_point ( ) const

inlineinherited

Get the public point of this key.

Exceptions

Invalid_State

is thrown if the domain parameters of this point are not set

Returns

the public point of this key

Definition at line 44 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::check_key(), Botan::ECGDSA_PrivateKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), Botan::ECDSA_PrivateKey::check_key(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::x509_subject_public_key(), and Botan::EC_PublicKey::x509_subject_public_key().

{ return m_public_key; }

public_value()

std::vector<byte> Botan::ECDH_PublicKey::public_value ( ) const

inline

Returns

public point value

Definition at line 55 of file ecdh.h.

References Botan::EC2OSP(), Botan::PointGFp::UNCOMPRESSED, and Botan::unlock().

Referenced by Botan::ECDH_PrivateKey::public_value().

         { return unlock(EC2OSP(public_point(), PointGFp::UNCOMPRESSED)); }

set_parameter_encoding()

void Botan::EC_PublicKey::set_parameter_encoding ( EC_Group_Encoding  enc )

inherited

Set the domain parameter encoding to be used when encoding this key.

Parameters

enc	the encoding to use

Definition at line 58 of file ecc_key.cpp.

References Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_IMPLICITCA, Botan::EC_DOMPAR_ENC_OID, Botan::EC_Group::get_oid(), Botan::EC_PublicKey::m_domain_encoding, and Botan::EC_PublicKey::m_domain_params.

   {
   if(form != EC_DOMPAR_ENC_EXPLICIT &&
      form != EC_DOMPAR_ENC_IMPLICITCA &&
      form != EC_DOMPAR_ENC_OID)
      throw Invalid_Argument("Invalid encoding form for EC-key object specified");

   if((form == EC_DOMPAR_ENC_OID) && (m_domain_params.get_oid() == ""))
      throw Invalid_Argument("Invalid encoding form OID specified for "
                             "EC-key object whose corresponding domain "
                             "parameters are without oid");

   m_domain_encoding = form;
   }

x509_subject_public_key()

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

overridevirtualinherited

Returns

X.509 subject key encoding for this key object

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 53 of file ecc_key.cpp.

References Botan::PointGFp::COMPRESSED, Botan::EC2OSP(), Botan::EC_PublicKey::public_point(), and Botan::unlock().

   {
   return unlock(EC2OSP(public_point(), PointGFp::COMPRESSED));
   }

Member Data Documentation

m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding

protectedinherited

Definition at line 89 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), and Botan::EC_PublicKey::set_parameter_encoding().

m_domain_params

EC_Group Botan::EC_PublicKey::m_domain_params

protectedinherited

Definition at line 87 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), and Botan::EC_PublicKey::set_parameter_encoding().

m_public_key

PointGFp Botan::EC_PublicKey::m_public_key

protectedinherited

Definition at line 88 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), and Botan::GOST_3410_PublicKey::GOST_3410_PublicKey().

---

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

• src/lib/pubkey/ecdh/ecdh.h
• src/lib/pubkey/ecdh/ecdh.cpp