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
virtual std::unique_ptr< PK_Ops::Decryption >	create_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
virtual std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
virtual std::unique_ptr< PK_Ops::KEM_Decryption >	create_kem_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
virtual std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
virtual std::unique_ptr< PK_Ops::Key_Agreement >	create_key_agreement_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
std::unique_ptr< PK_Ops::Signature >	create_signature_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
std::unique_ptr< PK_Ops::Verification >	create_verification_op (const std::string &params, const std::string &provider) const override
virtual Signature_Format	default_x509_signature_format () const
std::vector< uint8_t >	DER_domain () const
const EC_Group &	domain () const
EC_Group_Encoding	domain_format () const
	ECDSA_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< uint8_t > &key_bits)
	ECDSA_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x=0)
size_t	estimated_strength () const override
std::string	fingerprint (const std::string &alg) const
std::string	fingerprint_private (const std::string &alg) const
std::string	fingerprint_public (const std::string &alg="SHA-256") const
virtual OID	get_oid () const
size_t	key_length () const override
size_t	message_part_size () const override
size_t	message_parts () const override
virtual AlgorithmIdentifier	pkcs8_algorithm_identifier () const
PointGFp::Compression_Type	point_encoding () const
secure_vector< uint8_t >	private_key_bits () const override
secure_vector< uint8_t >	private_key_info () const
const BigInt &	private_value () const
std::vector< uint8_t >	public_key_bits () const override
const PointGFp &	public_point () const
uint8_t	recovery_param (const std::vector< uint8_t > &msg, const BigInt &r, const BigInt &s) const
void	set_parameter_encoding (EC_Group_Encoding enc)
void	set_point_encoding (PointGFp::Compression_Type enc)
virtual bool	stateful_operation () const
std::vector< uint8_t >	subject_public_key () const

Protected Attributes
EC_Group_Encoding	m_domain_encoding
EC_Group	m_domain_params
PointGFp::Compression_Type	m_point_encoding = PointGFp::UNCOMPRESSED
BigInt	m_private_key
PointGFp	m_public_key

Detailed Description

This class represents ECDSA Private Keys

Definition at line 82 of file ecdsa.h.

Constructor & Destructor Documentation

ECDSA_PrivateKey() [1/2]

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

inline

Load a private key

Parameters

alg_id	the X.509 algorithm identifier
key_bits	ECPrivateKey bits

Definition at line 92 of file ecdsa.h.

                                                               :
         EC_PrivateKey(alg_id, key_bits) {}

ECDSA_PrivateKey() [2/2]

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

inline

Create a 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 102 of file ecdsa.h.

                                            :
         EC_PrivateKey(rng, domain, x) {}

Member Function Documentation

algo_name()

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 61 of file ecdsa.h.

Referenced by create_signature_op(), and Botan::ECDSA_PublicKey::create_verification_op().

{ return "ECDSA"; }

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 64 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::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 112 of file ecdsa.cpp.

References Botan::EC_PublicKey::public_point(), 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)");
   }

create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  provider  ) const

virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return an decryption operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::ElGamal_PrivateKey.

Definition at line 114 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().

   {
   throw Lookup_Error(algo_name() + " does not support decryption");
   }

create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  provider  ) const

virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return an encryption operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::ElGamal_PublicKey.

Definition at line 91 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().

   {
   throw Lookup_Error(algo_name() + " does not support encryption");
   }

create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::create_kem_decryption_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  provider  ) const

virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a KEM decryption operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::RSA_PrivateKey, and Botan::McEliece_PrivateKey.

Definition at line 122 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().

   {
   throw Lookup_Error(algo_name() + " does not support KEM decryption");
   }

create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  provider  ) const

virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a KEM encryption operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::RSA_PublicKey, and Botan::McEliece_PublicKey.

Definition at line 99 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

   {
   throw Lookup_Error(algo_name() + " does not support KEM encryption");
   }

create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::create_key_agreement_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  provider  ) const

virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a key agreement operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::ECDH_PrivateKey, Botan::Curve25519_PrivateKey, and Botan::DH_PrivateKey.

Definition at line 138 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().

   {
   throw Lookup_Error(algo_name() + " does not support key agreement");
   }

create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::ECDSA_PrivateKey::create_signature_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  provider  ) const

overridevirtual

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a signature operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented from Botan::Private_Key.

Definition at line 283 of file ecdsa.cpp.

References Botan::ECDSA_PublicKey::algo_name().

   {
#if defined(BOTAN_HAS_OPENSSL)
   if(provider == "openssl" || provider.empty())
      {
      try
         {
         return make_openssl_ecdsa_sig_op(*this, params);
         }
      catch(Lookup_Error& e)
         {
         if(provider == "openssl")
            throw;
         }
      }
#endif

   if(provider == "base" || provider.empty())
      return std::unique_ptr<PK_Ops::Signature>(new ECDSA_Signature_Operation(*this, params, rng));

   throw Provider_Not_Found(algo_name(), provider);
   }

create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::ECDSA_PublicKey::create_verification_op ( const std::string &  params, const std::string &  provider  ) const

overridevirtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 258 of file ecdsa.cpp.

References Botan::ECDSA_PublicKey::algo_name().

   {
#if defined(BOTAN_HAS_OPENSSL)
   if(provider == "openssl" || provider.empty())
      {
      try
         {
         return make_openssl_ecdsa_ver_op(*this, params);
         }
      catch(Lookup_Error& e)
         {
         if(provider == "openssl")
            throw;
         }
      }
#endif

   if(provider == "base" || provider.empty())
      return std::unique_ptr<PK_Ops::Verification>(new ECDSA_Verification_Operation(*this, params));

   throw Provider_Not_Found(algo_name(), provider);
   }

default_x509_signature_format()

virtual Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const

inlinevirtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 125 of file pk_keys.h.

References Botan::DER_SEQUENCE, and Botan::IEEE_1363.

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

         {
         return (this->message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
         }

DER_domain()

std::vector<uint8_t> 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 90 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 72 of file ecc_key.h.

Referenced by Botan::GOST_3410_PublicKey::algo_name(), Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_pubkey_sm2_compute_za(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::EC_PublicKey::key_length(), Botan::ECDSA_PublicKey::recovery_param(), and Botan::SM2_PrivateKey::SM2_PrivateKey().

{ 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 97 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 25 of file ecc_key.cpp.

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

   {
   return ecp_work_factor(key_length());
   }

fingerprint()

std::string Botan::Private_Key::fingerprint ( const std::string &  alg ) const

inlineinherited

Definition at line 215 of file pk_keys.h.

         {
         return fingerprint_private(alg); // match behavior in previous versions
         }

fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( const std::string &  alg ) const

inherited

Returns

Hash of the PKCS #8 encoding for this key object

Definition at line 85 of file pk_keys.cpp.

References Botan::create_hex_fingerprint(), hash_algo, and Botan::Private_Key::private_key_bits().

Referenced by Botan::Certificate_Store_In_SQL::find_certs_for_key(), Botan::Certificate_Store_In_SQL::insert_key(), and Botan::Certificate_Store_In_SQL::remove_key().

   {
   return create_hex_fingerprint(private_key_bits(), hash_algo);
   }

fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( const std::string &  alg = "SHA-256" ) const

inherited

Returns

Hash of the subject public key

Definition at line 77 of file pk_keys.cpp.

References Botan::create_hex_fingerprint(), hash_algo, and Botan::Public_Key::subject_public_key().

   {
   return create_hex_fingerprint(subject_public_key(), hash_algo);
   }

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

Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 53 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), Botan::OID::empty(), and Botan::OIDS::str2oid_or_empty().

Referenced by Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().

   {
   const OID o = OIDS::str2oid_or_empty(algo_name());
   if(o.empty())
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
   return o;
   }

key_length()

size_t Botan::EC_PublicKey::key_length ( ) const

overridevirtualinherited

Return an integer value best approximating the length of the primary security parameter. For example for RSA this will be the size of the modulus, for ECDSA the size of the ECC group, and for McEliece the size of the code will be returned.

Implements Botan::Public_Key.

Definition at line 20 of file ecc_key.cpp.

References Botan::EC_PublicKey::domain(), and Botan::EC_Group::get_p_bits().

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

   {
   return domain().get_p_bits();
   }

message_part_size()

size_t Botan::ECDSA_PublicKey::message_part_size ( ) const

inlineoverridevirtualinherited

Returns how large each of the message parts refered to by message_parts() is

This function is public but applications should have few reasons to ever call this.

Returns

size of the message parts in bits

Reimplemented from Botan::Public_Key.

Definition at line 65 of file ecdsa.h.

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

message_parts()

size_t Botan::ECDSA_PublicKey::message_parts ( ) const

inlineoverridevirtualinherited

Returns more than 1 if the output of this algorithm (ciphertext, signature) should be treated as more than one value. This is used for algorithms like DSA and ECDSA, where the (r,s) output pair can be encoded as either a plain binary list or a TLV tagged DER encoding depending on the protocol.

This function is public but applications should have few reasons to ever call this.

Returns

number of message parts

Reimplemented from Botan::Public_Key.

Definition at line 63 of file ecdsa.h.

{ return 2; }

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

Reimplemented in Botan::XMSS_WOTS_PrivateKey, Botan::GOST_3410_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.

Definition at line 204 of file pk_keys.h.

Referenced by Botan::Private_Key::private_key_info().

         { return algorithm_identifier(); }

point_encoding()

PointGFp::Compression_Type Botan::EC_PublicKey::point_encoding ( ) const

inlineinherited

Get the point encoding method to be used when encoding this key.

Returns

the encoding to use

Definition at line 104 of file ecc_key.h.

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

         { return m_point_encoding; }

private_key_bits()

secure_vector< uint8_t > Botan::EC_PrivateKey::private_key_bits ( ) const

overridevirtualinherited

Returns

BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 147 of file ecc_key.cpp.

References Botan::BIT_STRING, Botan::BigInt::bytes(), Botan::DER_Encoder::encode(), Botan::PointGFp::encode(), Botan::BigInt::encode_1363(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::EC_PrivateKey::m_private_key, Botan::EC_PublicKey::m_public_key, Botan::OCTET_STRING, Botan::PRIVATE, 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)
         .start_cons(ASN1_Tag(1), PRIVATE)
            .encode(m_public_key.encode(PointGFp::Compression_Type::UNCOMPRESSED), BIT_STRING)
         .end_cons()
      .end_cons()
      .get_contents();
   }

private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const

inherited

Returns

PKCS #8 private key encoding for this key object

Definition at line 61 of file pk_keys.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OCTET_STRING, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::private_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), and Botan::PKCS8::BER_encode_encrypted_pbkdf_msec().

   {
   const size_t PKCS8_VERSION = 0;

   return DER_Encoder()
         .start_cons(SEQUENCE)
            .encode(PKCS8_VERSION)
            .encode(pkcs8_algorithm_identifier())
            .encode(private_key_bits(), OCTET_STRING)
         .end_cons()
      .get_contents();
   }

private_value()

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 99 of file ecc_key.cpp.

References Botan::EC_PrivateKey::m_private_key.

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

   return m_private_key;
   }

public_key_bits()

std::vector< uint8_t > Botan::EC_PublicKey::public_key_bits ( ) const

overridevirtualinherited

Returns

BER encoded public key bits

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 69 of file ecc_key.cpp.

References Botan::PointGFp::encode(), Botan::EC_PublicKey::point_encoding(), and Botan::EC_PublicKey::public_point().

Referenced by Botan::EC_PrivateKey::EC_PrivateKey().

   {
   return public_point().encode(point_encoding());
   }

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

Referenced by botan_pubkey_sm2_compute_za(), Botan::EC_PublicKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), Botan::ECGDSA_PrivateKey::check_key(), Botan::SM2_PrivateKey::check_key(), check_key(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::public_key_bits(), Botan::EC_PublicKey::public_key_bits(), and Botan::ECDSA_PublicKey::recovery_param().

{ return m_public_key; }

recovery_param()

uint8_t Botan::ECDSA_PublicKey::recovery_param ( const std::vector< uint8_t > &  msg, const BigInt &  r, const BigInt &  s  ) const

inherited

Definition at line 88 of file ecdsa.cpp.

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

   {
   for(uint8_t v = 0; v != 4; ++v)
      {
      try
         {
         PointGFp R = recover_ecdsa_public_key(this->domain(), msg, r, s, v);

         if(R == this->public_point())
            {
            return v;
            }
         }
      catch(Decoding_Error&)
         {
         // try the next v
         }
      }

   throw Internal_Error("Could not determine ECDSA recovery parameter");
   }

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 84 of file ecc_key.cpp.

References Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_IMPLICITCA, Botan::EC_DOMPAR_ENC_OID, Botan::OID::empty(), Botan::EC_Group::get_curve_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_curve_oid().empty()))
      throw Invalid_Argument("Invalid encoding form OID specified for "
                             "EC-key object whose corresponding domain "
                             "parameters are without oid");

   m_domain_encoding = form;
   }

set_point_encoding()

void Botan::EC_PublicKey::set_point_encoding ( PointGFp::Compression_Type  enc )

inherited

Set the point encoding method to be used when encoding this key.

Parameters

enc	the encoding to use

Definition at line 74 of file ecc_key.cpp.

References Botan::PointGFp::COMPRESSED, Botan::PointGFp::HYBRID, Botan::EC_PublicKey::m_point_encoding, and Botan::PointGFp::UNCOMPRESSED.

   {
   if(enc != PointGFp::COMPRESSED &&
      enc != PointGFp::UNCOMPRESSED &&
      enc != PointGFp::HYBRID)
      throw Invalid_Argument("Invalid point encoding for EC_PublicKey");

   m_point_encoding = enc;
   }

stateful_operation()

virtual bool Botan::Private_Key::stateful_operation ( ) const

inlinevirtualinherited

Reimplemented in Botan::XMSS_PrivateKey.

Definition at line 188 of file pk_keys.h.

{ return false; }

subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const

inherited

Returns

X.509 subject key encoding for this key object

Definition at line 38 of file pk_keys.cpp.

References Botan::Public_Key::algorithm_identifier(), Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), Botan::Public_Key::fingerprint_public(), and Botan::X509::PEM_encode().

   {
   std::vector<uint8_t> output;

   DER_Encoder(output).start_cons(SEQUENCE)
         .encode(algorithm_identifier())
         .encode(public_key_bits(), BIT_STRING)
      .end_cons();

   return output;
   }

Member Data Documentation

m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding

protectedinherited

Definition at line 116 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 114 of file ecc_key.h.

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

m_point_encoding

PointGFp::Compression_Type Botan::EC_PublicKey::m_point_encoding = PointGFp::UNCOMPRESSED

protectedinherited

Definition at line 117 of file ecc_key.h.

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

m_private_key

BigInt Botan::EC_PrivateKey::m_private_key

protectedinherited

Definition at line 167 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::private_key_bits(), Botan::EC_PrivateKey::private_value(), and Botan::SM2_PrivateKey::SM2_PrivateKey().

m_public_key

PointGFp Botan::EC_PublicKey::m_public_key

protectedinherited

Definition at line 115 of file ecc_key.h.

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

---

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

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