#include <ecc_key.h>

Inheritance diagram for Botan::EC_PublicKey:

Public Member Functions
virtual std::string	algo_name () const =0
AlgorithmIdentifier	algorithm_identifier () const
bool	check_key (RandomNumberGenerator &rng, bool strong) const
MemoryVector< byte >	DER_domain () const
const EC_Group &	domain () const
EC_Group_Encoding	domain_format () const
	EC_PublicKey (const AlgorithmIdentifier &alg_id, const MemoryRegion< byte > &key_bits)
	EC_PublicKey (const EC_Group &dom_par, const PointGFp &pub_point)
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
const PointGFp &	public_point () const
void	set_parameter_encoding (EC_Group_Encoding enc)
MemoryVector< byte >	x509_subject_public_key () const

Protected Member Functions
	EC_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 abstract ECC public keys. When encoding a key via an encoder that can be accessed via the corresponding member functions, the key will decide upon its internally stored encoding information whether to encode itself with or without domain parameters, or using the domain parameter oid. Furthermore, a public key without domain parameters can be decoded. In that case, it cannot be used for verification until its domain parameters are set by calling the corresponding member function.

Definition at line 30 of file ecc_key.h.

Constructor & Destructor Documentation

◆ EC_PublicKey() [1/3]

Botan::EC_PublicKey::EC_PublicKey	(	const EC_Group &	dom_par,
		const PointGFp &	pub_point )

Definition at line 21 of file ecc_key.cpp.

                                                      :
   domain_params(dom_par), public_key(pub_point),
   domain_encoding(EC_DOMPAR_ENC_EXPLICIT)
   {
   if(domain().get_curve() != public_point().get_curve())
      throw Invalid_Argument("EC_PublicKey: curve mismatch in constructor");
   }

References domain(), domain_encoding, domain_params, Botan::EC_DOMPAR_ENC_EXPLICIT, public_key, and public_point().

Referenced by Botan::ECDH_PublicKey::ECDH_PublicKey(), Botan::ECDH_PublicKey::ECDH_PublicKey(), Botan::ECDSA_PublicKey::ECDSA_PublicKey(), and Botan::ECDSA_PublicKey::ECDSA_PublicKey().

◆ EC_PublicKey() [2/3]

Botan::EC_PublicKey::EC_PublicKey	(	const AlgorithmIdentifier &	alg_id,
		const MemoryRegion< byte > &	key_bits )

Definition at line 30 of file ecc_key.cpp.

   {
   domain_params = EC_Group(alg_id.parameters);
   domain_encoding = EC_DOMPAR_ENC_EXPLICIT;
 
   public_key = OS2ECP(key_bits, domain().get_curve());
   }

References domain(), domain_encoding, domain_params, Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_Group::EC_Group(), Botan::OS2ECP(), Botan::AlgorithmIdentifier::parameters, and public_key.

◆ EC_PublicKey() [3/3]

Botan::EC_PublicKey::EC_PublicKey ( )

inlineprotected

Definition at line 82 of file ecc_key.h.

82: domain_encoding(EC_DOMPAR_ENC_EXPLICIT) {}

References domain_encoding, and Botan::EC_DOMPAR_ENC_EXPLICIT.

Member Function Documentation

◆ algo_name()

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

References get_oid().

Referenced by Botan::Certificate_Verify::Certificate_Verify(), Botan::EAC_Signed_Object::check_signature(), Botan::X509_Object::check_signature(), Botan::choose_sig_format(), Botan::X509::find_constraints(), Botan::Private_Key::gen_check(), get_oid(), Botan::Private_Key::load_check(), 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(), Botan::Server_Hello::Server_Hello(), Botan::Server_Key_Exchange::Server_Key_Exchange(), and Botan::CMS_Encoder::sign().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::EC_PublicKey::algorithm_identifier ( ) const

virtual

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 45 of file ecc_key.cpp.

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

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

◆ check_key()

bool Botan::EC_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::ECDSA_PrivateKey.

Definition at line 39 of file ecc_key.cpp.

   {
   return public_point().on_the_curve();
   }

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

◆ DER_domain()

MemoryVector< byte > Botan::EC_PublicKey::DER_domain ( ) const

inline

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.

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

Botan::EC_Group::DER_encode

SecureVector< byte > DER_encode(EC_Group_Encoding form) const

Definition ec_group.cpp:95

Botan::EC_PublicKey::domain_format

EC_Group_Encoding domain_format() const

Definition ecc_key.h:79

References domain(), and domain_format().

Referenced by algorithm_identifier().

◆ domain()

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

inline

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 60 of file ecc_key.h.

60{ return domain_params; }

References domain_params.

Referenced by DER_domain(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), EC_PublicKey(), EC_PublicKey(), Botan::ECDH_KA_Operation::ECDH_KA_Operation(), Botan::ECDH_PrivateKey::ECDH_PrivateKey(), Botan::ECDSA_PrivateKey::ECDSA_PrivateKey(), Botan::ECDH_PublicKey::max_input_bits(), Botan::ECDSA_PublicKey::max_input_bits(), and Botan::ECDSA_PublicKey::message_part_size().

◆ domain_format()

EC_Group_Encoding Botan::EC_PublicKey::domain_format ( ) const

inline

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.

80 { return domain_encoding; }

References domain_encoding.

Referenced by DER_domain().

◆ 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.

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

References algo_name(), Botan::OIDS::lookup(), and Botan::Lookup_Error::Lookup_Error().

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

◆ 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.

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

References algo_name(), and check_key().

◆ max_input_bits()

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

pure virtualinherited

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

Returns: maximum message size in bits

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

Referenced by Botan::choose_sig_format().

◆ 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::DSA_PublicKey, Botan::ECDSA_PublicKey, and Botan::NR_PublicKey.

Definition at line 56 of file pk_keys.h.

56{ 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::DSA_PublicKey, Botan::ECDSA_PublicKey, and Botan::NR_PublicKey.

Definition at line 50 of file pk_keys.h.

50{ return 1; }

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

◆ public_point()

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

inline

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 45 of file ecc_key.h.

45{ return public_key; }

References public_key.

Referenced by check_key(), Botan::ECDSA_PrivateKey::check_key(), EC_PublicKey(), Botan::ECDH_PublicKey::ECDH_PublicKey(), Botan::ECDSA_PublicKey::ECDSA_PublicKey(), Botan::ECDH_PublicKey::public_value(), and x509_subject_public_key().

◆ set_parameter_encoding()

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

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

Parameters

enc	the encoding to use

Definition at line 55 of file ecc_key.cpp.

   {
   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;
   }

References domain_encoding, 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().

◆ x509_subject_public_key()

MemoryVector< byte > Botan::EC_PublicKey::x509_subject_public_key ( ) const

virtual

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

Implements Botan::Public_Key.

Definition at line 50 of file ecc_key.cpp.

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

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

Member Data Documentation

◆ domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::domain_encoding

protected

Definition at line 86 of file ecc_key.h.

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

◆ domain_params

EC_Group Botan::EC_PublicKey::domain_params

protected

Definition at line 84 of file ecc_key.h.

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

◆ public_key

PointGFp Botan::EC_PublicKey::public_key

protected

Definition at line 85 of file ecc_key.h.

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

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

src/pubkey/ecc_key/ecc_key.h
src/pubkey/ecc_key/ecc_key.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EC_PublicKey() [1/3]

◆ EC_PublicKey() [2/3]

◆ EC_PublicKey() [3/3]

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ DER_domain()

◆ domain()

◆ domain_format()

◆ get_oid()

◆ load_check()

◆ max_input_bits()

◆ message_part_size()

◆ message_parts()

◆ public_point()

◆ set_parameter_encoding()

◆ x509_subject_public_key()

Member Data Documentation

◆ domain_encoding

◆ domain_params

◆ public_key