Botan  1.11.15
Public Member Functions | Protected Member Functions | Protected Attributes
Botan::ECDH_PublicKey Class Reference

#include <ecdh.h>

Inheritance diagram for Botan::ECDH_PublicKey:
Botan::EC_PublicKey Botan::Public_Key Botan::ECDH_PrivateKey

List of all members.

Public Member Functions

std::string algo_name () const
AlgorithmIdentifier algorithm_identifier () const
bool check_key (RandomNumberGenerator &rng, bool strong) const
std::vector< byteDER_domain () const
const EC_Groupdomain () 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
virtual size_t message_part_size () const
virtual size_t message_parts () const
const PointGFppublic_point () const
std::vector< bytepublic_value () const
void set_parameter_encoding (EC_Group_Encoding enc)
std::vector< bytex509_subject_public_key () const

Protected Member Functions

 ECDH_PublicKey ()
virtual void load_check (RandomNumberGenerator &rng) const

Protected Attributes

EC_Group_Encoding domain_encoding
EC_Group domain_params
PointGFp public_key

Detailed Description

This class represents ECDH Public Keys.

Definition at line 20 of file ecdh.h.


Constructor & Destructor Documentation

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) {}
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_parthe domain parameters associated with this key
public_pointthe public point defining this key

Definition at line 33 of file ecdh.h.

                                                   :
         EC_PublicKey(dom_par, public_point) {}
Botan::ECDH_PublicKey::ECDH_PublicKey ( ) [inline, protected]

Definition at line 58 of file ecdh.h.

{}

Member Function Documentation

std::string Botan::ECDH_PublicKey::algo_name ( ) const [inline, virtual]

Get this keys algorithm name.

Returns:
this keys algorithm name

Implements Botan::Public_Key.

Definition at line 41 of file ecdh.h.

{ return "ECDH"; }
Returns:
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 50 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());
   }
bool Botan::EC_PublicKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const [virtual, inherited]

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

Implements Botan::Public_Key.

Reimplemented in Botan::ECDSA_PrivateKey.

Definition at line 44 of file ecc_key.cpp.

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

   {
   return public_point().on_the_curve();
   }
std::vector<byte> Botan::EC_PublicKey::DER_domain ( ) const [inline, inherited]

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

Definition at line 72 of file ecc_key.h.

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

         { return domain().DER_encode(domain_format()); }
const EC_Group& Botan::EC_PublicKey::domain ( ) const [inline, inherited]

Get the domain parameters of this key.

Exceptions:
Invalid_Stateis thrown if the domain parameters of this point are not set
Returns:
the domain parameters of this key

Definition at line 60 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 domain_params; }

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

Returns:
the encoding to use

Definition at line 79 of file ecc_key.h.

         { return domain_encoding; }
size_t Botan::EC_PublicKey::estimated_strength ( ) const [override, 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

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());
   }
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::Public_Key::load_check ( RandomNumberGenerator rng) const [protected, virtual, inherited]

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 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::ECDH_PublicKey::max_input_bits ( ) const [inline, virtual]

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(); }
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; }
const PointGFp& Botan::EC_PublicKey::public_point ( ) const [inline, inherited]

Get the public point of this key.

Exceptions:
Invalid_Stateis thrown if the domain parameters of this point are not set
Returns:
the public point of this key

Definition at line 45 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::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 public_key; }
std::vector<byte> Botan::ECDH_PublicKey::public_value ( ) const [inline]
Returns:
public point value

Reimplemented in Botan::ECDH_PrivateKey.

Definition at line 54 of file ecdh.h.

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

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

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

Parameters:
encthe encoding to use

Definition at line 60 of file ecc_key.cpp.

References Botan::EC_PublicKey::domain_encoding, Botan::EC_PublicKey::domain_params, Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_IMPLICITCA, Botan::EC_DOMPAR_ENC_OID, and Botan::EC_Group::get_oid().

Referenced by Botan::DE_EAC::create_cvc_req(), Botan::DE_EAC::link_cvca(), and Botan::DE_EAC::sign_request().

   {
   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) && (domain_params.get_oid() == ""))
      throw Invalid_Argument("Invalid encoding form OID specified for "
                             "EC-key object whose corresponding domain "
                             "parameters are without oid");

   domain_encoding = form;
   }
std::vector< byte > Botan::EC_PublicKey::x509_subject_public_key ( ) const [virtual, inherited]
Returns:
X.509 subject key encoding for this key object

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 55 of file ecc_key.cpp.

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


Member Data Documentation

PointGFp Botan::EC_PublicKey::public_key [protected, inherited]

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