Botan::TPM2::EC_PublicKey Class Reference

#include <tpm2_ecc.h>

Inheritance diagram for Botan::TPM2::EC_PublicKey:

Public Member Functions
const EC_AffinePoint &	_public_key () const
std::string	algo_name () const override
AlgorithmIdentifier	algorithm_identifier () const override
bool	check_key (RandomNumberGenerator &rng, bool strong) const override
virtual std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Verification >	create_verification_op (std::string_view params, std::string_view provider) const override
virtual std::unique_ptr< PK_Ops::Verification >	create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const
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
size_t	estimated_strength () const override
std::string	fingerprint_public (std::string_view alg="SHA-256") const
std::unique_ptr< Private_Key >	generate_another (Botan::RandomNumberGenerator &) const override
const BigInt &	get_int_field (std::string_view field) const override
OID	get_oid () const
const Object &	handles () const
size_t	key_length () const override
virtual size_t	message_part_size () const
virtual size_t	message_parts () const
virtual OID	object_identifier () const
EC_Point_Format	point_encoding () const
std::vector< uint8_t >	public_key_bits () const override
const EC_Point &	public_point () const
std::vector< uint8_t >	raw_public_key_bits () const override
const SessionBundle &	sessions () const
void	set_parameter_encoding (EC_Group_Encoding enc)
void	set_point_encoding (EC_Point_Format enc)
std::vector< uint8_t >	subject_public_key () const
bool	supports_operation (PublicKeyOperation op) const override

Static Public Member Functions
static std::unique_ptr< PublicKey >	load_persistent (const std::shared_ptr< Context > &ctx, TPM2_HANDLE persistent_object_handle, const SessionBundle &sessions={})
static std::unique_ptr< PublicKey >	load_transient (const std::shared_ptr< Context > &ctx, std::span< const uint8_t > public_blob, const SessionBundle &sessions)

Protected Member Functions
	EC_PublicKey (Object handle, SessionBundle sessions, const TPM2B_PUBLIC *public_blob)
	EC_PublicKey (Object handle, SessionBundle sessions, std::pair< EC_Group, EC_AffinePoint > public_key)

Static Protected Member Functions
static std::unique_ptr< PublicKey >	create (Object handles, const SessionBundle &sessions)

Protected Attributes
EC_Group_Encoding	m_domain_encoding = EC_Group_Encoding::NamedCurve
EC_Point_Format	m_point_encoding = EC_Point_Format::Uncompressed
std::shared_ptr< const EC_PublicKey_Data >	m_public_key

Friends
class	TPM2::PublicKey

Detailed Description

Definition at line 16 of file tpm2_ecc.h.

Constructor & Destructor Documentation

EC_PublicKey() [1/2]

Botan::TPM2::EC_PublicKey::EC_PublicKey ( Object handle, SessionBundle sessions, const TPM2B_PUBLIC * public_blob )

protected

Definition at line 21 of file tpm2_ecc.cpp.

                                                                                                 :
      EC_PublicKey(std::move(handle), std::move(sessions), ecc_pubkey_from_tss2_public(public_blob)) {}

EC_PublicKey() [2/2]

Botan::TPM2::EC_PublicKey::EC_PublicKey ( Object handle, SessionBundle sessions, std::pair< EC_Group, EC_AffinePoint > public_key )

protected

Definition at line 24 of file tpm2_ecc.cpp.

                                                                                                              :
      Botan::TPM2::PublicKey(std::move(handle), std::move(sessions)),
      Botan::EC_PublicKey(std::move(public_key.first), public_key.second) {}

Member Function Documentation

_public_key()

const EC_AffinePoint & Botan::EC_PublicKey::_public_key ( ) const

inherited

Definition at line 69 of file ecc_key.cpp.

                                                      {
   BOTAN_STATE_CHECK(m_public_key != nullptr);
   return m_public_key->public_key();
}

References BOTAN_STATE_CHECK, and Botan::EC_PublicKey::m_public_key.

algo_name()

std::string Botan::TPM2::EC_PublicKey::algo_name ( ) const

inlineoverridevirtual

Get the name of the underlying public key scheme.

Returns

name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 19 of file tpm2_ecc.h.

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

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

References Botan::EC_PublicKey::DER_domain(), and Botan::Asymmetric_Key::object_identifier().

check_key()

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

overridevirtualinherited

Implements Botan::Public_Key.

Reimplemented in Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, and Botan::SM2_PrivateKey.

Definition at line 74 of file ecc_key.cpp.

                                                                     {
   return domain().verify_group(rng) && domain().verify_public_element(public_point());
}

References Botan::EC_PublicKey::domain(), Botan::EC_PublicKey::public_point(), Botan::EC_Group::verify_group(), and Botan::EC_Group::verify_public_element().

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

create()

std::unique_ptr< PublicKey > Botan::TPM2::PublicKey::create ( Object handles, const SessionBundle & sessions )

staticprotectedinherited

Definition at line 161 of file tpm2_key.cpp.

                                                                                        {
   [[maybe_unused]] const auto* pubinfo = handles._public_info(sessions).pub.get();
#if defined(BOTAN_HAS_TPM2_RSA_ADAPTER)
   if(pubinfo->publicArea.type == TPM2_ALG_RSA) {
      return std::unique_ptr<PublicKey>(new RSA_PublicKey(std::move(handles), sessions, pubinfo));
   }
#endif
#if defined(BOTAN_HAS_TPM2_ECC_ADAPTER)
   if(pubinfo->publicArea.type == TPM2_ALG_ECC) {
      return std::unique_ptr<PublicKey>(new EC_PublicKey(std::move(handles), sessions, pubinfo));
   }
#endif
 
   throw Not_Implemented(Botan::fmt("Loaded a {} public key of an unsupported type",
                                    handles.has_persistent_handle() ? "persistent" : "transient"));
}

References Botan::TPM2::Object::_public_info(), Botan::fmt(), Botan::TPM2::PublicKey::handles(), Botan::TPM2::Object::has_persistent_handle(), Botan::TPM2::PublicInfo::pub, and Botan::TPM2::PublicKey::sessions().

Referenced by Botan::TPM2::PublicKey::load_persistent(), and Botan::TPM2::PublicKey::load_transient().

create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op ( RandomNumberGenerator & rng, std::string_view params, std::string_view 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::ElGamal_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.

Definition at line 90 of file pk_keys.cpp.

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

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

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

create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op ( std::string_view params, std::string_view 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

params	additional parameters
provider	the provider to use

Reimplemented in Botan::FrodoKEM_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, and Botan::TLS::KEX_to_KEM_Adapter_PublicKey.

Definition at line 96 of file pk_keys.cpp.

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

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

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

create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::TPM2::EC_PublicKey::create_verification_op ( std::string_view params, std::string_view provider ) const

overridevirtual

This is an internal library function exposed on key types. In 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 242 of file tpm2_ecc.cpp.

                                                                                                          {
   BOTAN_UNUSED(provider);
   return std::make_unique<EC_Verification_Operation>(handles(), sessions(), params);
}

References BOTAN_UNUSED, Botan::TPM2::PublicKey::handles(), and Botan::TPM2::PublicKey::sessions().

create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_x509_verification_op ( const AlgorithmIdentifier & signature_algorithm, std::string_view provider ) const

virtualinherited

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

Return a verification operation for this combination of key and signature algorithm or throw.

Parameters

signature_algorithm	is the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
provider	the provider to use

Reimplemented in Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SphincsPlus_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 106 of file pk_keys.cpp.

                                                                                                      {
   throw Lookup_Error(fmt("{} does not support X.509 verification", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Verifier::PK_Verifier().

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 201 of file pk_keys.h.

                                                                     {
         return (this->message_parts() >= 2) ? Signature_Format::DerSequence : Signature_Format::Standard;
      }

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

DER_domain()

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

inherited

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

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

References Botan::EC_Group::DER_encode(), Botan::EC_PublicKey::domain(), and Botan::EC_PublicKey::domain_format().

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

domain()

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

inherited

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

                                           {
   BOTAN_STATE_CHECK(m_public_key != nullptr);
   return m_public_key->group();
}

References BOTAN_STATE_CHECK, and Botan::EC_PublicKey::m_public_key.

Referenced by Botan::GOST_3410_PublicKey::algo_name(), Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_pubkey_ecc_key_used_explicit_encoding(), botan_pubkey_sm2_compute_za(), Botan::EC_PublicKey::check_key(), Botan::SM2_PrivateKey::check_key(), Botan::EC_PublicKey::DER_domain(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::ECDH_PublicKey::generate_another(), Botan::ECDSA_PublicKey::generate_another(), Botan::EC_PublicKey::get_int_field(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::EC_PublicKey::key_length(), Botan::ECDH_PrivateKey::public_key(), Botan::ECDSA_PrivateKey::public_key(), Botan::ECGDSA_PrivateKey::public_key(), Botan::ECKCDSA_PrivateKey::public_key(), Botan::GOST_3410_PrivateKey::public_key(), Botan::SM2_PrivateKey::public_key(), Botan::TPM2::EC_PrivateKey::public_key(), Botan::ECDSA_PublicKey::recovery_param(), and Botan::EC_PublicKey::set_parameter_encoding().

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

{ return m_domain_encoding; }

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

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::Asymmetric_Key.

Definition at line 27 of file ecc_key.cpp.

                                              {
   return ecp_work_factor(key_length());
}

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

fingerprint_public()

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

inherited

Returns

Hash of the subject public key

Definition at line 79 of file pk_keys.cpp.

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

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

generate_another()

std::unique_ptr< Private_Key > Botan::TPM2::PublicKey::generate_another ( Botan::RandomNumberGenerator & rng ) const

inlineoverridevirtualinherited

Generate another (cryptographically independent) key pair using the same algorithm parameters as this key. This is most useful for algorithms that support PublicKeyOperation::KeyAgreement to generate a fitting ephemeral key pair. For other key types it might throw Not_Implemented.

Implements Botan::Asymmetric_Key.

Reimplemented in Botan::TPM2::RSA_PublicKey.

Definition at line 90 of file tpm2_key.h.

                                                                                              {
         throw Not_Implemented("Cannot generate a new TPM-based keypair from this asymmetric key");
      }

get_int_field()

const BigInt & Botan::EC_PublicKey::get_int_field ( std::string_view field ) const

overridevirtualinherited

Access an algorithm specific field

If the field is not known for this algorithm, an Invalid_Argument is thrown. The interpretation of the result requires knowledge of which algorithm is involved. For instance for RSA "p" represents one of the secret primes, while for DSA "p" is the public prime.

Some algorithms may not implement this method at all.

This is primarily used to implement the FFI botan_pubkey_get_field and botan_privkey_get_field functions.

Reimplemented from Botan::Asymmetric_Key.

Definition at line 204 of file ecc_key.cpp.

                                                                    {
   if(field == "public_x" || field == "public_y") {
      throw Not_Implemented(fmt("EC_PublicKey::get_int_field no longer implements getter for {}", field));
   } else if(field == "base_x") {
      return this->domain().get_g_x();
   } else if(field == "base_y") {
      return this->domain().get_g_y();
   } else if(field == "p") {
      return this->domain().get_p();
   } else if(field == "a") {
      return this->domain().get_a();
   } else if(field == "b") {
      return this->domain().get_b();
   } else if(field == "cofactor") {
      return this->domain().get_cofactor();
   } else if(field == "order") {
      return this->domain().get_order();
   } else {
      return Public_Key::get_int_field(field);
   }
}

References Botan::EC_PublicKey::domain(), Botan::fmt(), Botan::EC_Group::get_a(), Botan::EC_Group::get_b(), Botan::EC_Group::get_cofactor(), Botan::EC_Group::get_g_x(), Botan::EC_Group::get_g_y(), Botan::Asymmetric_Key::get_int_field(), Botan::EC_Group::get_order(), and Botan::EC_Group::get_p().

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

get_oid()

OID Botan::Public_Key::get_oid ( ) const

inlineinherited

Deprecated version of object_identifier

Definition at line 132 of file pk_keys.h.

{ return this->object_identifier(); }

handles()

const Object & Botan::TPM2::PublicKey::handles ( ) const

inlineinherited

Definition at line 99 of file tpm2_key.h.

{ return m_handle; }

Referenced by Botan::TPM2::PublicKey::create(), Botan::TPM2::RSA_PublicKey::create_encryption_op(), create_verification_op(), and Botan::TPM2::RSA_PublicKey::create_verification_op().

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

                                      {
   return domain().get_p_bits();
}

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

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

load_persistent()

std::unique_ptr< PublicKey > Botan::TPM2::PublicKey::load_persistent ( const std::shared_ptr< Context > & ctx, TPM2_HANDLE persistent_object_handle, const SessionBundle & sessions = {} )

staticinherited

Load a public key that resides in the TPM's persistent storage.

Parameters

ctx	The TPM context to use
persistent_object_handle	The handle of the persistent object to load
sessions	The session bundle to use for loading

Definition at line 131 of file tpm2_key.cpp.

                                                                                     {
   return create(load_persistent_object(ctx, persistent_object_handle, {}, sessions), sessions);
}

References Botan::TPM2::PublicKey::create(), and Botan::TPM2::PublicKey::sessions().

load_transient()

std::unique_ptr< PublicKey > Botan::TPM2::PublicKey::load_transient ( const std::shared_ptr< Context > & ctx, std::span< const uint8_t > public_blob, const SessionBundle & sessions )

staticinherited

Load a public key from the public blob obtained by a TPM key creation.

Transient keys don't reside inside the TPM but must be loaded by the application as required. Once this object is destructed, the transient memory on the TPM is cleared.

Parameters

ctx	The TPM context to use
public_blob	The public blob of the key to load
sessions	The session bundle to use for loading

Definition at line 137 of file tpm2_key.cpp.

                                                                                    {
   const auto public_data = unmarshal_public_blob(public_blob);
 
   BOTAN_ASSERT_NONNULL(ctx);
 
   Object handle(ctx);
   check_rc("Esys_LoadExternal",
            Esys_LoadExternal(*ctx,
                              sessions[0],
                              sessions[1],
                              sessions[2],
                              nullptr /* no private data to be loaded */,
                              &public_data,
                              TPM2_RH_NULL,
                              out_transient_handle(handle)));
   return create(std::move(handle), sessions);
}

References BOTAN_ASSERT_NONNULL, Botan::TPM2::check_rc(), Botan::TPM2::PublicKey::create(), Botan::TPM2::out_transient_handle(), and Botan::TPM2::PublicKey::sessions().

message_part_size()

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

inlinevirtualinherited

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 in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 199 of file pk_keys.h.

{ return 0; }

Referenced by Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

message_parts()

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

inlinevirtualinherited

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 in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 188 of file pk_keys.h.

{ return 1; }

Referenced by Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

object_identifier()

OID Botan::Asymmetric_Key::object_identifier ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns

OID of the public key scheme

Reimplemented in Botan::Dilithium_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, and Botan::SphincsPlus_PublicKey.

Definition at line 22 of file pk_keys.cpp.

                                            {
   try {
      return OID::from_string(algo_name());
   } catch(Lookup_Error&) {
      throw Lookup_Error(fmt("Public key algorithm {} has no defined OIDs", algo_name()));
   }
}

References Botan::Asymmetric_Key::algo_name(), Botan::fmt(), and Botan::OID::from_string().

Referenced by Botan::DH_PublicKey::algorithm_identifier(), Botan::DSA_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::Ed448_PublicKey::algorithm_identifier(), Botan::ElGamal_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), Botan::X25519_PublicKey::algorithm_identifier(), and Botan::X448_PublicKey::algorithm_identifier().

point_encoding()

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

{ return m_point_encoding; }

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

public_key_bits()

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

overridevirtual

Returns

the public key encoding in ordinary point encoding

See also

EC_PublicKey::set_point_encoding()

Implements Botan::Public_Key.

Definition at line 45 of file tpm2_ecc.cpp.

                                                       {
   return Botan::EC_PublicKey::raw_public_key_bits();
}

References Botan::EC_PublicKey::raw_public_key_bits().

public_point()

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

inherited

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

                                                 {
   BOTAN_STATE_CHECK(m_public_key != nullptr);
   return m_public_key->legacy_point();
}

References BOTAN_STATE_CHECK, and Botan::EC_PublicKey::m_public_key.

Referenced by botan_pubkey_sm2_compute_za(), Botan::EC_PublicKey::check_key(), Botan::ECDH_PrivateKey::public_key(), Botan::ECDSA_PrivateKey::public_key(), Botan::ECGDSA_PrivateKey::public_key(), Botan::ECKCDSA_PrivateKey::public_key(), Botan::GOST_3410_PrivateKey::public_key(), Botan::SM2_PrivateKey::public_key(), Botan::TPM2::EC_PrivateKey::public_key(), Botan::GOST_3410_PublicKey::public_key_bits(), Botan::EC_PublicKey::raw_public_key_bits(), and Botan::ECDSA_PublicKey::recovery_param().

raw_public_key_bits()

std::vector< uint8_t > Botan::TPM2::EC_PublicKey::raw_public_key_bits ( ) const

overridevirtual

Returns

the public key encoding in TPM2B_PUBLIC format

Implements Botan::Public_Key.

Definition at line 49 of file tpm2_ecc.cpp.

                                                           {
   return TPM2::PublicKey::raw_public_key_bits();
}

References Botan::TPM2::PublicKey::raw_public_key_bits().

sessions()

const SessionBundle & Botan::TPM2::PublicKey::sessions ( ) const

inlineinherited

Definition at line 101 of file tpm2_key.h.

{ return m_sessions; }

Referenced by Botan::TPM2::PublicKey::create(), Botan::TPM2::RSA_PublicKey::create_encryption_op(), create_verification_op(), Botan::TPM2::RSA_PublicKey::create_verification_op(), Botan::TPM2::PublicKey::load_persistent(), and Botan::TPM2::PublicKey::load_transient().

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

This function is deprecated; in a future major release only namedCurve encoding of domain parameters will be allowed.

Definition at line 102 of file ecc_key.cpp.

                                                                {
   if(form == EC_Group_Encoding::NamedCurve && domain().get_curve_oid().empty()) {
      throw Invalid_Argument("Cannot used NamedCurve encoding for a curve without an OID");
   }
 
   m_domain_encoding = form;
}

References Botan::EC_PublicKey::domain(), Botan::EC_PublicKey::m_domain_encoding, and Botan::NamedCurve.

set_point_encoding()

void Botan::EC_PublicKey::set_point_encoding ( EC_Point_Format enc )

inherited

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

Parameters

enc	the encoding to use

Definition at line 94 of file ecc_key.cpp.

                                                         {
   if(enc != EC_Point_Format::Compressed && enc != EC_Point_Format::Uncompressed && enc != EC_Point_Format::Hybrid) {
      throw Invalid_Argument("Invalid point encoding for EC_PublicKey");
   }
 
   m_point_encoding = enc;
}

References Botan::Compressed, Botan::Hybrid, Botan::EC_PublicKey::m_point_encoding, and Botan::Uncompressed.

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 48 of file pk_keys.cpp.

                                                        {
   std::vector<uint8_t> output;
 
   DER_Encoder(output)
      .start_sequence()
      .encode(algorithm_identifier())
      .encode(public_key_bits(), ASN1_Type::BitString)
      .end_cons();
 
   return output;
}

References Botan::Public_Key::algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), and Botan::DER_Encoder::start_sequence().

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

supports_operation()

bool Botan::TPM2::EC_PublicKey::supports_operation ( PublicKeyOperation op ) const

inlineoverridevirtual

Return true if this key could be used for the specified type of operation.

Implements Botan::Asymmetric_Key.

Definition at line 32 of file tpm2_ecc.h.

                                                                    {
         // TODO: ECDH/Key Agreement
         return op == PublicKeyOperation::Signature;
      }

Friends And Related Symbol Documentation

TPM2::PublicKey

friend class TPM2::PublicKey

friend

Definition at line 41 of file tpm2_ecc.h.

Member Data Documentation

m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding = EC_Group_Encoding::NamedCurve

protectedinherited

Definition at line 132 of file ecc_key.h.

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

m_point_encoding

EC_Point_Format Botan::EC_PublicKey::m_point_encoding = EC_Point_Format::Uncompressed

protectedinherited

Definition at line 133 of file ecc_key.h.

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

m_public_key

std::shared_ptr<const EC_PublicKey_Data> Botan::EC_PublicKey::m_public_key

protectedinherited

Definition at line 131 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::_public_key(), Botan::EC_PublicKey::domain(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::EC_PrivateKey::private_key_bits(), and Botan::EC_PublicKey::public_point().

---

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

• src/lib/prov/tpm2/tpm2_ecc/tpm2_ecc.h
• src/lib/prov/tpm2/tpm2_ecc/tpm2_ecc.cpp