Botan::ECDSA_PrivateKey Class Reference

#include <ecdsa.h>

Inheritance diagram for Botan::ECDSA_PrivateKey:

Public Member Functions
std::string	algo_name () const override
AlgorithmIdentifier	algorithm_identifier () const override
bool	check_key (RandomNumberGenerator &rng, bool) const override
std::vector< byte >	DER_domain () const
const EC_Group &	domain () const
EC_Group_Encoding	domain_format () const
	ECDSA_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits)
	ECDSA_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x=0)
size_t	estimated_strength () const override
virtual OID	get_oid () const
size_t	max_input_bits () const override
size_t	message_part_size () const override
size_t	message_parts () const override
virtual AlgorithmIdentifier	pkcs8_algorithm_identifier () const
secure_vector< byte >	pkcs8_private_key () const override
const BigInt &	private_value () const
const PointGFp &	public_point () const
void	set_parameter_encoding (EC_Group_Encoding enc)
std::vector< byte >	x509_subject_public_key () const override

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

Protected Attributes
EC_Group_Encoding	m_domain_encoding
EC_Group	m_domain_params
BigInt	m_private_key
PointGFp	m_public_key

Detailed Description

This class represents ECDSA Private Keys

Definition at line 63 of file ecdsa.h.

Constructor & Destructor Documentation

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

inline

Load a private key

Parameters

alg_id	the X.509 algorithm identifier
key_bits	PKCS #8 structure

Definition at line 73 of file ecdsa.h.

                                                            :
         EC_PrivateKey(alg_id, key_bits) {}

Botan::ECDSA_PrivateKey::ECDSA_PrivateKey ( RandomNumberGenerator &  rng, const EC_Group &  domain, const BigInt &  x = 0  )

inline

Generate a new private key

Parameters

rng	a random number generator
domain	parameters to used for this key
x	the private key (if zero, generate a new random key)

Definition at line 83 of file ecdsa.h.

                                            :
         EC_PrivateKey(rng, domain, x) {}

Member Function Documentation

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

inlineoverridevirtualinherited

Get this keys algorithm name.

Returns

this keys algorithm name ("ECDSA")

Implements Botan::Public_Key.

Definition at line 41 of file ecdsa.h.

{ return "ECDSA"; }

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());
   }

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

overridevirtual

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

Reimplemented from Botan::EC_PublicKey.

Definition at line 21 of file ecdsa.cpp.

References BOTAN_ASSERT, Botan::BOTAN_REGISTER_PK_SIGNATURE_OP(), Botan::BOTAN_REGISTER_PK_VERIFY_OP(), Botan::EC_PublicKey::domain(), Botan::BigInt::encode_fixed_length_int_pair(), Botan::generate_rfc6979_nonce(), Botan::PointGFp::get_affine_x(), Botan::EC_Group::get_base_point(), Botan::EC_Group::get_order(), Botan::hash_for_emsa(), Botan::inverse_mod(), Botan::PointGFp::is_zero(), Botan::ECDSA_PublicKey::max_input_bits(), Botan::ECDSA_PublicKey::message_part_size(), Botan::ECDSA_PublicKey::message_parts(), Botan::mul_add(), Botan::multi_exponentiate(), Botan::EC_PrivateKey::private_value(), Botan::EC_PublicKey::public_point(), Botan::BigInt::random_integer(), and Botan::KeyPair::signature_consistency_check().

   {
   if(!public_point().on_the_curve())
      return false;

   if(!strong)
      return true;

   return KeyPair::signature_consistency_check(rng, *this, "EMSA1(SHA-256)");
   }

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()); }

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::ECGDSA_PrivateKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), check_key(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::ECDH_PublicKey::ECDH_PublicKey(), Botan::EC_PublicKey::estimated_strength(), and Botan::GOST_3410_PublicKey::GOST_3410_PublicKey().

{ return m_domain_params; }

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

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());
   }

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.

References Botan::Public_Key::check_key().

Referenced by Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

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

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::IF_Scheme_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");
      }
   }

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(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), and Botan::NR_PrivateKey::NR_PrivateKey().

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

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

overrideprotectedvirtualinherited

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.

References Botan::Public_Key::check_key().

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

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

size_t Botan::ECDSA_PublicKey::max_input_bits ( ) const

inlineoverridevirtualinherited

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

the maximum number of input bits

Implements Botan::Public_Key.

Definition at line 48 of file ecdsa.h.

Referenced by check_key().

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

size_t Botan::ECDSA_PublicKey::message_part_size ( ) const

inlineoverridevirtualinherited

Find out the message part size supported by this scheme/key.

Returns

size of the message parts in bits

Reimplemented from Botan::Public_Key.

Definition at line 53 of file ecdsa.h.

Referenced by check_key().

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

size_t Botan::ECDSA_PublicKey::message_parts ( ) const

inlineoverridevirtualinherited

Find out the number of message parts supported by this scheme.

Returns

number of message parts

Reimplemented from Botan::Public_Key.

Definition at line 51 of file ecdsa.h.

Referenced by check_key().

{ return 2; }

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

Reimplemented in Botan::GOST_3410_PrivateKey.

Definition at line 109 of file pk_keys.h.

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

         { return algorithm_identifier(); }

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

overridevirtualinherited

Returns

PKCS #8 private key encoding for this key object

Implements Botan::Private_Key.

Definition at line 108 of file ecc_key.cpp.

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

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

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

inherited

Get the private key value of this key object.

Returns

the private key value of this key object

Definition at line 73 of file ecc_key.cpp.

Referenced by Botan::ECGDSA_PrivateKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), check_key(), Botan::ECDH_PublicKey::ECDH_PublicKey(), and Botan::GOST_3410_PublicKey::GOST_3410_PublicKey().

   {
   if(m_private_key == 0)
      throw Invalid_State("EC_PrivateKey::private_value - uninitialized");

   return m_private_key;
   }

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(), check_key(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::GOST_3410_PublicKey::x509_subject_public_key(), and Botan::EC_PublicKey::x509_subject_public_key().

{ return m_public_key; }

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

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

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

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

BigInt Botan::EC_PrivateKey::m_private_key

protectedinherited

Definition at line 134 of file ecc_key.h.

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/ecdsa/ecdsa.h
• src/lib/pubkey/ecdsa/ecdsa.cpp