#include <ecc_key.h>

Inheritance diagram for Botan::EC_PrivateKey:

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_PrivateKey (const AlgorithmIdentifier &alg_id, const MemoryRegion< byte > &key_bits)
	EC_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &private_key)
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 AlgorithmIdentifier	pkcs8_algorithm_identifier () const
MemoryVector< byte >	pkcs8_private_key () const
const BigInt &	private_value () 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_PrivateKey ()
void	gen_check (RandomNumberGenerator &rng) const
void	load_check (RandomNumberGenerator &rng) const

Protected Attributes
EC_Group_Encoding	domain_encoding
EC_Group	domain_params
BigInt	private_key
PointGFp	public_key

Detailed Description

This abstract class represents ECC private keys

Definition at line 92 of file ecc_key.h.

Constructor & Destructor Documentation

◆ EC_PrivateKey() [1/3]

Botan::EC_PrivateKey::EC_PrivateKey	(	RandomNumberGenerator &	rng,
		const EC_Group &	ec_group,
		const BigInt &	x )

EC_PrivateKey constructor

Definition at line 81 of file ecc_key.cpp.

   {
   domain_params = ec_group;
   domain_encoding = EC_DOMPAR_ENC_EXPLICIT;
 
   if(x == 0)
      private_key = BigInt::random_integer(rng, 1, domain().get_order());
   else
      private_key = x;
 
   public_key = domain().get_base_point() * private_key;
 
   BOTAN_ASSERT(public_key.on_the_curve(),
                "ECC private key was not on the curve");
   }

References BOTAN_ASSERT, Botan::EC_PublicKey::domain(), Botan::EC_PublicKey::domain_encoding, Botan::EC_PublicKey::domain_params, Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_Group::get_base_point(), Botan::PointGFp::on_the_curve(), private_key, Botan::EC_PublicKey::public_key, and Botan::BigInt::random_integer().

Referenced by Botan::ECDH_PrivateKey::ECDH_PrivateKey(), Botan::ECDH_PrivateKey::ECDH_PrivateKey(), Botan::ECDSA_PrivateKey::ECDSA_PrivateKey(), and Botan::ECDSA_PrivateKey::ECDSA_PrivateKey().

◆ EC_PrivateKey() [2/3]

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

Definition at line 110 of file ecc_key.cpp.

   {
   domain_params = EC_Group(alg_id.parameters);
   domain_encoding = EC_DOMPAR_ENC_EXPLICIT;
 
   BER_Decoder(key_bits)
      .start_cons(SEQUENCE)
         .decode_and_check<size_t>(1, "Unknown version code for ECC key")
         .decode_octet_string_bigint(private_key);
         // possibly group params and public key follow
 
   public_key = domain().get_base_point() * private_key;
 
   BOTAN_ASSERT(public_key.on_the_curve(),
                "Loaded ECC private key not on the curve");
   }

References Botan::BER_Decoder::BER_Decoder(), BOTAN_ASSERT, Botan::EC_PublicKey::domain(), Botan::EC_PublicKey::domain_encoding, Botan::EC_PublicKey::domain_params, Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_Group::EC_Group(), Botan::EC_Group::get_base_point(), Botan::PointGFp::on_the_curve(), Botan::AlgorithmIdentifier::parameters, private_key, Botan::EC_PublicKey::public_key, and Botan::SEQUENCE.

◆ EC_PrivateKey() [3/3]

Botan::EC_PrivateKey::EC_PrivateKey ( )

inlineprotected

Definition at line 111 of file ecc_key.h.

111{}

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

virtualinherited

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

virtualinherited

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

inlineinherited

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

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

inlineinherited

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

◆ gen_check()

void Botan::Private_Key::gen_check ( RandomNumberGenerator & rng ) const

protectedinherited

Self-test after generating a key

Parameters

rng	a random number generator

Definition at line 49 of file pk_keys.cpp.

   {
   if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_GENERATE))
      throw Self_Test_Failure(algo_name() + " private key generation failed");
   }

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

Referenced by Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::NR_PrivateKey::NR_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

◆ 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::Private_Key::load_check ( RandomNumberGenerator & rng ) const

protectedvirtualinherited

Self-test after loading a key

Parameters

rng	a random number generator

Reimplemented from Botan::Public_Key.

Definition at line 40 of file pk_keys.cpp.

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

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

Referenced by Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), Botan::NR_PrivateKey::NR_PrivateKey(), and Botan::NR_PrivateKey::NR_PrivateKey().

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

◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const

inlinevirtualinherited

Returns: PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

Definition at line 98 of file pk_keys.h.

99 { return algorithm_identifier(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

References Botan::Public_Key::algorithm_identifier().

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

◆ pkcs8_private_key()

MemoryVector< byte > Botan::EC_PrivateKey::pkcs8_private_key ( ) const

virtual

Returns: PKCS #8 private key encoding for this key object

Implements Botan::Private_Key.

Definition at line 99 of file ecc_key.cpp.

   {
   return DER_Encoder()
      .start_cons(SEQUENCE)
         .encode(static_cast<size_t>(1))
         .encode(BigInt::encode_1363(private_key, private_key.bytes()),
                 OCTET_STRING)
      .end_cons()
      .get_contents();
   }

References Botan::BigInt::bytes(), Botan::DER_Encoder::encode(), Botan::BigInt::encode_1363(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OCTET_STRING, private_key, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

◆ private_value()

const BigInt & Botan::EC_PrivateKey::private_value ( ) const

Get the private key value of this key object.

Returns: the private key value of this key object

Definition at line 70 of file ecc_key.cpp.

   {
   if(private_key == 0)
      throw Invalid_State("EC_PrivateKey::private_value - uninitialized");
 
   return private_key;
   }

References Botan::Invalid_State::Invalid_State(), and private_key.

Referenced by Botan::ECDH_KA_Operation::ECDH_KA_Operation().

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

inherited

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

virtualinherited

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

protectedinherited

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

protectedinherited

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

◆ private_key

BigInt Botan::EC_PrivateKey::private_key

protected

Definition at line 113 of file ecc_key.h.

Referenced by EC_PrivateKey(), EC_PrivateKey(), pkcs8_private_key(), and private_value().

◆ public_key

PointGFp Botan::EC_PublicKey::public_key

protectedinherited

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_PrivateKey() [1/3]

◆ EC_PrivateKey() [2/3]

◆ EC_PrivateKey() [3/3]

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ DER_domain()

◆ domain()

◆ domain_format()

◆ gen_check()

◆ get_oid()

◆ load_check()

◆ max_input_bits()

◆ message_part_size()

◆ message_parts()

◆ pkcs8_algorithm_identifier()

◆ pkcs8_private_key()

◆ private_value()

◆ public_point()

◆ set_parameter_encoding()

◆ x509_subject_public_key()

Member Data Documentation

◆ domain_encoding

◆ domain_params

◆ private_key

◆ public_key