Botan 3.14.1
Crypto and TLS for C&
Botan::TPM2::EC_PrivateKey Class Referencefinal

#include <tpm2_ecc.h>

Inheritance diagram for Botan::TPM2::EC_PrivateKey:
Botan::TPM2::PrivateKey Botan::EC_PublicKey Botan::Private_Key Botan::Public_Key Botan::Public_Key Botan::Asymmetric_Key Botan::Asymmetric_Key

Public Member Functions

virtual std::unique_ptr< PK_Ops::Decryption > _create_decryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::KEM_Decryption > _create_kem_decryption_op (RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op (const PK_KEM_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::Key_Agreement > _create_key_agreement_op (RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const
std::unique_ptr< PK_Ops::Signature > _create_signature_op (Botan::RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const override
virtual std::unique_ptr< PK_Ops::Verification > _create_verification_op (const PK_Signature_Options_Reader &options) const
virtual Signature_Format _default_x509_signature_format () const
const EC_AffinePoint & _public_ec_point () const
virtual std::optional< size_t > _signature_element_size_for_DER_encoding () const
std::string algo_name () const override
AlgorithmIdentifier algorithm_identifier () const override
bool check_key (RandomNumberGenerator &rng, bool strong) const override
std::unique_ptr< PK_Ops::Decryption > create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Encryption > create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::KEM_Decryption > create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
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::Key_Agreement > create_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Signature > create_signature_op (RandomNumberGenerator &rng, 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
virtual std::unique_ptr< PK_Ops::Verification > create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const
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_private (std::string_view alg) const
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
Object & handles ()
const Object & handles () const
bool is_parent () const
size_t key_length () const override
size_t message_part_size () const
size_t message_parts () const
virtual OID object_identifier () const
virtual AlgorithmIdentifier pkcs8_algorithm_identifier () const
EC_Point_Format point_encoding () const
secure_vector< uint8_t > private_key_bits () const override
secure_vector< uint8_t > private_key_info () const
const EC_AffinePoint & public_ec_point () const
std::unique_ptr< Public_Key > public_key () const override
std::vector< uint8_t > public_key_bits () const override
secure_vector< uint8_t > raw_private_key_bits () const override
std::vector< uint8_t > raw_public_key_bits () const override
virtual std::optional< uint64_t > remaining_operations () const
 Retrieves the number of remaining operations if this is a stateful private key.
const SessionBundle & sessions () const
void set_parameter_encoding (EC_Group_Encoding enc)
void set_point_encoding (EC_Point_Format enc)
virtual bool stateful_operation () const
std::vector< uint8_t > subject_public_key () const
bool supports_operation (PublicKeyOperation op) const override

Static Public Member Functions

static std::unique_ptr< PrivateKey > create_transient_from_template (const std::shared_ptr< Context > &ctx, const SessionBundle &sessions, ESYS_TR parent, const TPMT_PUBLIC &key_template, const TPM2B_SENSITIVE_CREATE &sensitive_data)
static std::unique_ptr< TPM2::PrivateKey > create_unrestricted_transient (const std::shared_ptr< Context > &ctx, const SessionBundle &sessions, std::span< const uint8_t > auth_value, const TPM2::PrivateKey &parent, const EC_Group &group)
static std::unique_ptr< PrivateKey > load_persistent (const std::shared_ptr< Context > &ctx, TPM2_HANDLE persistent_object_handle, std::span< const uint8_t > auth_value, const SessionBundle &sessions)
static std::unique_ptr< PrivateKey > load_transient (const std::shared_ptr< Context > &ctx, std::span< const uint8_t > auth_value, const TPM2::PrivateKey &parent, std::span< const uint8_t > public_blob, std::span< const uint8_t > private_blob, const SessionBundle &sessions)

Protected Member Functions

 EC_PrivateKey (Object handle, SessionBundle sessions, const std::pair< EC_Group, EC_AffinePoint > &public_key, std::span< const uint8_t > private_blob={})
 EC_PrivateKey (Object handle, SessionBundle sessions, const TPM2B_PUBLIC *public_blob, std::span< const uint8_t > private_blob={})

Static Protected Member Functions

static const AlgorithmIdentifier & assert_algorithm_identifier (const AlgorithmIdentifier &alg_id, std::string_view alg_name)
static std::unique_ptr< PrivateKey > create (Object handles, const SessionBundle &sessions, const TPM2B_PUBLIC *public_info, std::span< const uint8_t > private_blob)

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

Detailed Description

Definition at line 50 of file tpm2_ecc.h.

Constructor & Destructor Documentation

◆ EC_PrivateKey() [1/2]

Botan::TPM2::EC_PrivateKey::EC_PrivateKey ( Object handle,
SessionBundle sessions,
const TPM2B_PUBLIC * public_blob,
std::span< const uint8_t > private_blob = {} )
protected

Definition at line 32 of file tpm2_ecc.cpp.

35 :
36 EC_PrivateKey(std::move(handle), std::move(sessions), ecc_pubkey_from_tss2_public(public_blob), private_blob) {}
EC_PrivateKey(Object handle, SessionBundle sessions, const TPM2B_PUBLIC *public_blob, std::span< const uint8_t > private_blob={})
Definition tpm2_ecc.cpp:32
const SessionBundle & sessions() const
Definition tpm2_key.h:224

References EC_PrivateKey(), and Botan::TPM2::PrivateKey::sessions().

Referenced by EC_PrivateKey(), and TPM2::PrivateKey.

◆ EC_PrivateKey() [2/2]

Botan::TPM2::EC_PrivateKey::EC_PrivateKey ( Object handle,
SessionBundle sessions,
const std::pair< EC_Group, EC_AffinePoint > & public_key,
std::span< const uint8_t > private_blob = {} )
protected

Definition at line 38 of file tpm2_ecc.cpp.

41 :
42 Botan::TPM2::PrivateKey(std::move(handle), std::move(sessions), private_blob),
43 Botan::EC_PublicKey(public_key.first, public_key.second) {}
std::unique_ptr< Public_Key > public_key() const override
Definition tpm2_ecc.cpp:45

References Botan::EC_PublicKey::EC_PublicKey(), public_key(), Botan::TPM2::PrivateKey::sessions(), and TPM2::PrivateKey.

Member Function Documentation

◆ _create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::_create_decryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) const
virtualinherited

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

Return a decryption operation for this key/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the encryption beyond those implicit to the key itself

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

Definition at line 130 of file pk_keys.cpp.

131 {
132 BOTAN_UNUSED(rng, options);
133 throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
134}
#define BOTAN_UNUSED
Definition assert.h:151
virtual std::string algo_name() const =0
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

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

Referenced by create_decryption_op(), and Botan::PK_Decryptor_EME::PK_Decryptor_EME().

◆ _create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::_create_encryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) 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/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the encryption beyond those implicit to the public key itself

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

Definition at line 107 of file pk_keys.cpp.

108 {
109 BOTAN_UNUSED(rng, options);
110 throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
111}

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

Referenced by create_encryption_op(), and Botan::PK_Encryptor_EME::PK_Encryptor_EME().

◆ _create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::_create_kem_decryption_op ( RandomNumberGenerator & rng,
const PK_KEM_Options_Reader & options ) const
virtualinherited

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

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

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the KEM beyond those implicit to the key itself

Reimplemented in Botan::Classic_McEliece_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::KEX_to_KEM_Adapter_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, and Botan::TLS::Hybrid_KEM_PrivateKey.

Definition at line 136 of file pk_keys.cpp.

137 {
138 BOTAN_UNUSED(rng, options);
139 throw Lookup_Error(fmt("{} does not support KEM decryption", algo_name()));
140}

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

Referenced by create_kem_decryption_op(), and Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().

◆ _create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::_create_kem_encryption_op ( const PK_KEM_Options_Reader & options) 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/options or throw

Parameters
optionswhich specify parameters of the KEM beyond those implicit to the public key itself

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

Definition at line 113 of file pk_keys.cpp.

114 {
115 BOTAN_UNUSED(options);
116 throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
117}

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

Referenced by create_kem_encryption_op(), and Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

◆ _create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::_create_key_agreement_op ( RandomNumberGenerator & rng,
const PK_Key_Agreement_Options_Reader & options ) const
virtualinherited

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

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

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the key agreement beyond those implicit to the key itself

Reimplemented in Botan::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 148 of file pk_keys.cpp.

149 {
150 BOTAN_UNUSED(rng, options);
151 throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
152}

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

Referenced by create_key_agreement_op(), and Botan::PK_Key_Agreement::PK_Key_Agreement().

◆ _create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::TPM2::EC_PrivateKey::_create_signature_op ( Botan::RandomNumberGenerator & rng,
const PK_Signature_Options_Reader & options ) const
overridevirtual

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

Return a signature operation for this key/params or throw

Parameters
Random Number Generatorsa 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.
optionsallow controlling behavior

Reimplemented from Botan::Private_Key.

Definition at line 259 of file tpm2_ecc.cpp.

260 {
261 BOTAN_UNUSED(rng);
262 require_hardware_provider(options, algo_name(), "tpm2");
263 return std::make_unique<EC_Signature_Operation>(handles(), sessions(), options);
264}
std::string algo_name() const override
Definition tpm2_ecc.h:53
void require_hardware_provider(const OptionsT &options, std::string_view algo_name, std::string_view provider_name)

References algo_name(), BOTAN_UNUSED, Botan::TPM2::PrivateKey::handles(), Botan::require_hardware_provider(), and Botan::TPM2::PrivateKey::sessions().

◆ _create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::_create_verification_op ( const PK_Signature_Options_Reader & options) 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 key/params or throw

Parameters
optionswhich specify parameters of the signature beyond those implicit to the public key itself

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::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::RSA_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 119 of file pk_keys.cpp.

120 {
121 BOTAN_UNUSED(options);
122 throw Lookup_Error(fmt("{} does not support verification", algo_name()));
123}

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

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

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const
virtualinherited

◆ _public_ec_point()

const EC_AffinePoint & Botan::EC_PublicKey::_public_ec_point ( ) const
inlineinherited

Definition at line 115 of file ecc_key.h.

115{ return public_ec_point(); }
const EC_AffinePoint & public_ec_point() const
Definition ecc_key.cpp:88

References public_ec_point().

◆ _signature_element_size_for_DER_encoding()

virtual std::optional< size_t > Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding ( ) const
inlinevirtualinherited

Certain signatures schemes such as ECDSA have more than one element, and certain unfortunate protocols decided the thing to do was not concatenate them as normally done, but instead DER encode each of the elements as independent values.

If this returns a value x then the signature is checked to be exactly 2*x bytes and split in half for DER encoding.

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

148{ return {}; }

Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ algo_name()

std::string Botan::TPM2::EC_PrivateKey::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 53 of file tpm2_ecc.h.

53 {
54 // TODO: Different types of ECC
55 // TPM ECC keys may be used for different algorithms, so we do not always know the exact algorithm
56 // because it may be used for ECDH, ECDSA, ECDAA, etc.
57 // However, at least for signatures, we can say it is ECDSA since EdDSA is not supported by tpm2-tss and
58 // ECDAA and ECSCHNORR are not supported by Botan.
59 return "ECDSA";
60 }

Referenced by _create_signature_op().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::EC_PublicKey::algorithm_identifier ( ) const
overridevirtualinherited

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 98 of file ecc_key.cpp.

98 {
99 return AlgorithmIdentifier(object_identifier(), DER_domain());
100}
virtual OID object_identifier() const
Definition pk_keys.cpp:24
std::vector< uint8_t > DER_domain() const
Definition ecc_key.cpp:110

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

Referenced by ~EC_PublicKey().

◆ assert_algorithm_identifier()

const AlgorithmIdentifier & Botan::EC_PublicKey::assert_algorithm_identifier ( const AlgorithmIdentifier & alg_id,
std::string_view alg_name )
staticprotectedinherited

Definition at line 48 of file ecc_key.cpp.

49 {
50 if(alg_id.oid() != OID::from_string(alg_name)) {
51 throw Decoding_Error(
52 fmt("Unexpected AlgorithmIdentifier OID {} in association with {} key", alg_id.oid(), alg_name));
53 }
54
55 return alg_id; // NOLINT(*-return-const-ref-from-parameter)
56}
static OID from_string(std::string_view str)
Definition asn1_oid.cpp:80

References Botan::fmt(), Botan::OID::from_string(), and Botan::AlgorithmIdentifier::oid().

Referenced by Botan::ECDSA_PrivateKey::ECDSA_PrivateKey(), Botan::ECDSA_PublicKey::ECDSA_PublicKey(), Botan::ECGDSA_PrivateKey::ECGDSA_PrivateKey(), Botan::ECGDSA_PublicKey::ECGDSA_PublicKey(), Botan::ECKCDSA_PrivateKey::ECKCDSA_PrivateKey(), and Botan::ECKCDSA_PublicKey::ECKCDSA_PublicKey().

◆ check_key()

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

Test the key values for consistency.

Note this function is always "best effort"; for many algorithms it is not computationally possible to ensure the key is correctly formed in all respects. There is always the possibility a malformed key will be accepted; this is especially the case for public keys.

Parameters
Random Number Generatorsrng to use for randomized testing (may be ignored)
strongwhether to perform strong and lengthy version of the test, however for many algorithms this has no effect
Returns
true if the tests passed

Implements Botan::Asymmetric_Key.

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

Definition at line 93 of file ecc_key.cpp.

93 {
94 // We already checked when deserializing that the point was on the curve
95 return domain().verify_group(rng, strong) && !public_ec_point().is_identity();
96}
bool is_identity() const
Return true if this point is the identity element.
bool verify_group(RandomNumberGenerator &rng, bool strong=false) const
Definition ec_group.cpp:881
const EC_Group & domain() const
Definition ecc_key.cpp:76

References domain(), Botan::EC_AffinePoint::is_identity(), public_ec_point(), and Botan::EC_Group::verify_group().

Referenced by Botan::EC_PrivateKey::check_key(), and ~EC_PublicKey().

◆ create()

std::unique_ptr< PrivateKey > Botan::TPM2::PrivateKey::create ( Object handles,
const SessionBundle & sessions,
const TPM2B_PUBLIC * public_info,
std::span< const uint8_t > private_blob )
staticprotectedinherited

Definition at line 299 of file tpm2_key.cpp.

302 {
303 if(public_info == nullptr) {
304 public_info = handles._public_info(sessions).pub.get();
305 }
306
307#if defined(BOTAN_HAS_TPM2_RSA_ADAPTER)
308 if(public_info->publicArea.type == TPM2_ALG_RSA) {
309 return std::unique_ptr<RSA_PrivateKey>(
310 new RSA_PrivateKey(std::move(handles), sessions, public_info, private_blob));
311 }
312#endif
313
314#if defined(BOTAN_HAS_TPM2_ECC_ADAPTER)
315 if(public_info->publicArea.type == TPM2_ALG_ECC) {
316 return std::unique_ptr<EC_PrivateKey>(new EC_PrivateKey(std::move(handles), sessions, public_info, private_blob));
317 }
318#endif
319
320 throw Not_Implemented(Botan::fmt("Loaded a {} private key of an unsupported type",
321 handles.has_persistent_handle() ? "persistent" : "transient"));
322}

References Botan::fmt(), handles(), and sessions().

Referenced by create_transient_from_template(), load_persistent(), and load_transient().

◆ create_decryption_op()

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

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

Return an decryption operation for this key/params or throw

Parameters
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 185 of file pk_keys.cpp.

187 {
188 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
189 const auto reader = PK_Options_Reader_Access::read(options);
190 auto op = this->_create_decryption_op(rng, reader);
192 return op;
193}
PK_Encryption_Options with_provider(std::string_view provider)
static void throw_if_unexamined(const ReaderT &reader, std::string_view algo_name)
static PK_Encryption_Options_Reader read(const PK_Encryption_Options &options)
virtual std::unique_ptr< PK_Ops::Decryption > _create_decryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:130
PK_Encryption_Options parse_legacy_enc_options(const Public_Key &key, std::string_view params)

References _create_decryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_enc_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Encryption_Options::with_provider().

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

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
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 175 of file pk_keys.cpp.

177 {
178 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
179 const auto reader = PK_Options_Reader_Access::read(options);
180 auto op = this->_create_encryption_op(rng, reader);
182 return op;
183}
virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:107

References _create_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_enc_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Encryption_Options::with_provider().

◆ create_kem_decryption_op()

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

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

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

Parameters
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 204 of file pk_keys.cpp.

206 {
207 const auto options = parse_legacy_kem_options(params).with_provider(provider);
208 const auto reader = PK_Options_Reader_Access::read(options);
209 auto op = this->_create_kem_decryption_op(rng, reader);
211 return op;
212}
PK_KEM_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::KEM_Decryption > _create_kem_decryption_op(RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:136
PK_KEM_Options parse_legacy_kem_options(std::string_view params)

References _create_kem_decryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_kem_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_KEM_Options::with_provider().

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

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
paramsadditional parameters
providerthe provider to use

Definition at line 195 of file pk_keys.cpp.

196 {
197 const auto options = parse_legacy_kem_options(params).with_provider(provider);
198 const auto reader = PK_Options_Reader_Access::read(options);
199 auto op = this->_create_kem_encryption_op(reader);
201 return op;
202}
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op(const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:113

References _create_kem_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_kem_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_KEM_Options::with_provider().

◆ create_key_agreement_op()

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

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

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

Parameters
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 214 of file pk_keys.cpp.

216 {
217 const auto options = parse_legacy_ka_options(params).with_provider(provider);
218 const auto reader = PK_Options_Reader_Access::read(options);
219 auto op = this->_create_key_agreement_op(rng, reader);
221 return op;
222}
PK_Key_Agreement_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Key_Agreement > _create_key_agreement_op(RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const
Definition pk_keys.cpp:148
PK_Key_Agreement_Options parse_legacy_ka_options(std::string_view params)

References _create_key_agreement_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_ka_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Key_Agreement_Options::with_provider().

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::create_signature_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

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

Return a signature operation for this key/params or throw

Parameters
Random Number Generatorsa 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.
paramsadditional parameters
providerthe provider to use

Definition at line 165 of file pk_keys.cpp.

167 {
168 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
169 const auto reader = PK_Options_Reader_Access::for_signing(options);
170 auto op = this->_create_signature_op(rng, reader);
172 return op;
173}
static PK_Signature_Options_Reader for_signing(const PK_Signature_Options &options)
PK_Signature_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Signature > _create_signature_op(RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:142
PK_Signature_Options parse_legacy_sig_options(const Public_Key &key, std::string_view params)

References _create_signature_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_signing(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().

◆ create_transient_from_template()

std::unique_ptr< PrivateKey > Botan::TPM2::PrivateKey::create_transient_from_template ( const std::shared_ptr< Context > & ctx,
const SessionBundle & sessions,
ESYS_TR parent,
const TPMT_PUBLIC & key_template,
const TPM2B_SENSITIVE_CREATE & sensitive_data )
staticinherited

This is a wrapper around Esys_CreateLoaded creating a transient key from a given key_template with sensitive_data. It gives maximal flexibility to the caller to create a key with their own TSS2 template configuration.

Please use this if you know what you are doing, only! Most users should use the more convenient create_transient() methods of the derived classes.

Parameters
ctxThe TPM context to use
sessionsThe session bundle to use in Esys_CreateLoaded().
parentThe handle of the parent object to create the new key under (this may reference a "Primary Seed" to create a "Primary Key", a "Storage Parent" to create an "Ordinary Key", or a "Derivation Parent" to create a "Derived Key").
key_templateThe template data to use for the key creation. It will be passed to Tss2_MU_TPMT_PUBLIC_Marshal() and Esys_CreateLoaded().
sensitive_dataThe sensitive data (e.g. with the desired auth value) to use for the key creation.

Definition at line 224 of file tpm2_key.cpp.

228 {
230
231 // NOLINTBEGIN(*-branch-clone)
232
233 switch(key_template.type) {
234 case TPM2_ALG_RSA:
235#if not defined(BOTAN_HAS_TPM2_RSA_ADAPTER)
236 throw Not_Implemented("TPM2-based RSA keys are not supported in this build");
237#endif
238 break;
239 case TPM2_ALG_ECC:
240#if not defined(BOTAN_HAS_TPM2_ECC_ADAPTER)
241 throw Not_Implemented("TPM2-based ECC keys are not supported in this build");
242#endif
243 break;
244 default:
245 throw Invalid_Argument("Unsupported key type");
246 }
247
248 // NOLINTEND(*-branch-clone)
249
250 const auto marshalled_template = marshal_template(key_template);
251
252 Object handle(ctx);
253 unique_esys_ptr<TPM2B_PRIVATE> private_bytes;
255
256 // Esys_CreateLoaded can create different object types depending on the type
257 // of the parent passed in. Namely, this will create a Primary object if the
258 // parent is referencing a Primary Seed; an Ordinary Object if the parent is
259 // referencing a Storage Parent; and a Derived Object if the parent is
260 // referencing a Derivation Parent.
261 //
262 // See the Architecture Document, Section 27.1.
263 check_rc("Esys_CreateLoaded",
264 Esys_CreateLoaded(ctx->esys_context(),
265 parent,
266 sessions[0],
267 sessions[1],
268 sessions[2],
269 &sensitive_data,
270 &marshalled_template,
271 out_transient_handle(handle),
272 out_ptr(private_bytes),
273 out_ptr(public_info)));
274 BOTAN_ASSERT_NONNULL(private_bytes);
275 BOTAN_ASSERT_NOMSG(public_info->publicArea.type == key_template.type);
276 BOTAN_ASSERT_NOMSG(handle.has_transient_handle());
277
278 return create(std::move(handle), sessions, public_info.get(), as_span(*private_bytes));
279}
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:82
#define BOTAN_ASSERT_NONNULL(ptr)
Definition assert.h:121
static std::unique_ptr< PrivateKey > create(Object handles, const SessionBundle &sessions, const TPM2B_PUBLIC *public_info, std::span< const uint8_t > private_blob)
Definition tpm2_key.cpp:299
constexpr void check_rc(std::string_view location, TSS2_RC rc)
Definition tpm2_util.h:53
std::unique_ptr< T, esys_liberator > unique_esys_ptr
A unique pointer type for ESYS handles that automatically frees the handle.
Definition tpm2_util.h:161
constexpr auto out_transient_handle(Object &object)
Definition tpm2_util.h:217
constexpr auto as_span(tpm2_buffer auto &data)
Construct a std::span as a view into a TPM2 buffer.
Definition tpm2_util.h:101
constexpr auto out_ptr(T &outptr) noexcept
Definition stl_util.h:164

References Botan::TPM2::as_span(), BOTAN_ASSERT_NOMSG, BOTAN_ASSERT_NONNULL, Botan::TPM2::check_rc(), create(), Botan::TPM2::Object::has_transient_handle(), Botan::out_ptr(), Botan::TPM2::out_transient_handle(), and sessions().

Referenced by Botan::TPM2::EC_PrivateKey::create_unrestricted_transient(), and Botan::TPM2::RSA_PrivateKey::create_unrestricted_transient().

◆ create_unrestricted_transient()

std::unique_ptr< TPM2::PrivateKey > Botan::TPM2::EC_PrivateKey::create_unrestricted_transient ( const std::shared_ptr< Context > & ctx,
const SessionBundle & sessions,
std::span< const uint8_t > auth_value,
const TPM2::PrivateKey & parent,
const EC_Group & group )
static

Create a transient EC key with the given group EC Group, under the given parent key, with the given auth_value. This key may only be used for ECDSA signatures.

Parameters
ctxThe TPM context to use
sessionsThe session bundle to use in the creation of the key
auth_valueThe auth value to use for the key
parentThe parent key to create the new key under
groupThe desired EC Group

Definition at line 65 of file tpm2_ecc.cpp.

69 {
70 // TODO: Code duplication from RSA_PrivateKey::create_unrestricted_transient
71 BOTAN_ARG_CHECK(parent.is_parent(), "The passed key cannot be used as a parent key");
72
73 const auto curve_id = get_tpm2_curve_id(group.get_curve_oid());
74 if(!curve_id) {
75 throw Invalid_Argument("Unsupported ECC curve");
76 }
77
78 const TPM2B_SENSITIVE_CREATE sensitive_data = {
79 .size = 0, // ignored
80 .sensitive =
81 {
82 .userAuth = copy_into<TPM2B_AUTH>(auth_value),
83
84 // Architecture Document, Section 25.2.3
85 // When an asymmetric key is created, the caller is not allowed to
86 // provide the sensitive data of the key.
88 },
89 };
90
91 const TPMT_PUBLIC key_template = {
92 .type = TPM2_ALG_ECC,
93
94 // This is the algorithm for fingerprinting the newly created public key.
95 // For best compatibility we always use SHA-256.
96 .nameAlg = TPM2_ALG_SHA256,
97
98 // This sets up the key to be both a decryption and a signing key, forbids
99 // its duplication (fixed_tpm, fixed_parent) and ensures that the key's
100 // private portion can be used only by a user with an HMAC or password
101 // session.
102 .objectAttributes = ObjectAttributes::render({
103 .fixed_tpm = true,
104 .fixed_parent = true,
105 .sensitive_data_origin = true,
106 .user_with_auth = true,
107 .decrypt = true, // TODO: Shall we set this?
108 .sign_encrypt = true,
109 }),
110
111 // We currently do not support policy-based authorization
112 .authPolicy = init_empty<TPM2B_DIGEST>(),
113 .parameters =
114 {
115 .eccDetail =
116 {
117 // Structures Document (Part 2), Section 12.2.3.5
118 // If the key is not a restricted decryption key, this field
119 // shall be set to TPM_ALG_NULL.
120 //
121 // TODO: Once we stop supporting TSS < 4.0, we could use
122 // `.keyBits = {.null = {}}, .mode = {.null = {}}`
123 // which better reflects our intention here.
124 .symmetric =
125 {
126 .algorithm = TPM2_ALG_NULL,
127 .keyBits = {.sym = 0},
128 .mode = {.sym = TPM2_ALG_NULL},
129 },
130
131 // Structures Document (Part 2), Section 12.2.3.6
132 // If the decrypt attribute of the key is SET, then this shall be a
133 // valid key exchange scheme or TPM_ALG_NULL
134 //
135 // TODO: Once we stop supporting TSS < 4.0, we could use
136 // `.details = {.null = {}}`
137 // which better reflects our intention here.
138 .scheme =
139 {
140 .scheme = TPM2_ALG_NULL,
141 .details = {.anySig = {.hashAlg = TPM2_ALG_NULL}},
142 },
143 .curveID = curve_id.value(),
144
145 // Structures Document (Part 2), Section 12.2.3.6
146 // If the kdf parameter associated with curveID is not
147 // TPM_ALG_NULL then this is required to be NULL.
148 // NOTE There are currently no commands where this parameter
149 // has effect and, in the reference code, this field needs to
150 // be set to TPM_ALG_NULL
151 // TODO: Easier initialization?
152 .kdf = {.scheme = TPM2_ALG_NULL, .details = {.kdf2 = {.hashAlg = TPM2_ALG_NULL}}},
153 },
154 },
155
156 // For creating an asymmetric key this value is not used.
157 .unique = {.ecc = {}},
158 };
159
161 ctx, sessions, parent.handles().transient_handle(), key_template, sensitive_data);
162}
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:33
static std::unique_ptr< PrivateKey > create_transient_from_template(const std::shared_ptr< Context > &ctx, const SessionBundle &sessions, ESYS_TR parent, const TPMT_PUBLIC &key_template, const TPM2B_SENSITIVE_CREATE &sensitive_data)
Definition tpm2_key.cpp:224
constexpr T init_empty()
Create an empty TPM2 buffer of the given type.
Definition tpm2_util.h:151
std::optional< TPM2_ECC_CURVE > get_tpm2_curve_id(const OID &curve_oid)
constexpr void copy_into(T &dest, std::span< const uint8_t > data)
Definition tpm2_util.h:116
static TPMA_OBJECT render(ObjectAttributes attributes)

References BOTAN_ARG_CHECK, Botan::TPM2::copy_into(), Botan::TPM2::PrivateKey::create_transient_from_template(), Botan::EC_Group::get_curve_oid(), Botan::TPM2::get_tpm2_curve_id(), Botan::TPM2::PrivateKey::handles(), Botan::TPM2::init_empty(), Botan::TPM2::PrivateKey::is_parent(), Botan::TPM2::ObjectAttributes::render(), Botan::TPM2::PrivateKey::sessions(), and Botan::TPM2::Object::transient_handle().

◆ create_verification_op()

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

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
paramsadditional parameters
providerthe provider to use

Definition at line 156 of file pk_keys.cpp.

157 {
158 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
159 const auto reader = PK_Options_Reader_Access::for_verification(options);
160 auto op = this->_create_verification_op(reader);
162 return op;
163}
static PK_Signature_Options_Reader for_verification(const PK_Signature_Options &options)
virtual std::unique_ptr< PK_Ops::Verification > _create_verification_op(const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:119

References _create_verification_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_verification(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().

◆ 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_algorithmis the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
providerthe 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 125 of file pk_keys.cpp.

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

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

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

◆ default_x509_signature_format()

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

Definition at line 245 of file pk_keys.h.

245 {
247 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:32

References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().

Referenced by default_x509_signature_format().

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

110 {
111 return domain().DER_encode(domain_format());
112}
std::vector< uint8_t > DER_encode(EC_Group_Encoding form) const
Definition ec_group.cpp:831
EC_Group_Encoding domain_format() const
Definition ecc_key.h:96

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

Referenced by algorithm_identifier(), and ~EC_PublicKey().

◆ domain()

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

Get the domain parameters of this key.

Exceptions
Invalid_Stateis thrown if the domain parameters of this point are not set
Returns
the domain parameters of this key

Definition at line 76 of file ecc_key.cpp.

76 {
78 return m_public_key->group();
79}
#define BOTAN_STATE_CHECK(expr)
Definition assert.h:49
std::shared_ptr< const EC_PublicKey_Data > m_public_key
Definition ecc_key.h:148

References BOTAN_STATE_CHECK, and m_public_key.

Referenced by Botan::ECDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::ECGDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::ECKCDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::GOST_3410_PublicKey::_signature_element_size_for_DER_encoding(), Botan::SM2_PublicKey::_signature_element_size_for_DER_encoding(), Botan::GOST_3410_PublicKey::algo_name(), Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_ec_privkey_get_group(), botan_ec_pubkey_get_group(), botan_pubkey_ecc_key_used_explicit_encoding(), botan_pubkey_sm2_compute_za(), check_key(), Botan::SM2_PrivateKey::check_key(), DER_domain(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), EC_PublicKey(), EC_PublicKey(), Botan::ECDH_PublicKey::generate_another(), Botan::ECDSA_PublicKey::generate_another(), Botan::ECGDSA_PublicKey::generate_another(), Botan::ECKCDSA_PublicKey::generate_another(), Botan::GOST_3410_PublicKey::generate_another(), Botan::SM2_PublicKey::generate_another(), get_int_field(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), 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(), set_parameter_encoding(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), and ~EC_PublicKey().

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

96{ return m_domain_encoding; }
EC_Group_Encoding m_domain_encoding
Definition ecc_key.h:149

References domain_format(), and m_domain_encoding.

Referenced by DER_domain(), and domain_format().

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

32 {
34}
size_t key_length() const override
Definition ecc_key.cpp:28
size_t ecp_work_factor(size_t bits)

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

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg) const
inherited
Returns
Hash of the algorithm specific private key encoding
Warning
This hashes private_key_bits(), which does not include the algorithm identifier; keys of different algorithms with identical raw encodings (such as an Ed25519 and an X25519 key built from the same 32 bytes) share a fingerprint.

Definition at line 103 of file pk_keys.cpp.

103 {
104 return create_hex_fingerprint(private_key_bits(), hash_algo);
105}
virtual secure_vector< uint8_t > private_key_bits() const =0
std::string create_hex_fingerprint(std::span< const uint8_t > bits, std::string_view hash_name)
Definition pk_keys.cpp:40

References Botan::create_hex_fingerprint(), and 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().

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

96 {
97 return create_hex_fingerprint(subject_public_key(), hash_algo);
98}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:65

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

Referenced by public_key_bits().

◆ generate_another()

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

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.

Definition at line 62 of file tpm2_ecc.h.

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

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

TODO(Botan4) Change this to return by value

Reimplemented from Botan::Asymmetric_Key.

Definition at line 252 of file ecc_key.cpp.

252 {
253 if(field == "public_x" || field == "public_y") {
254 throw Not_Implemented(fmt("EC_PublicKey::get_int_field no longer implements getter for {}", field));
255 } else if(field == "base_x") {
256 return this->domain().get_g_x();
257 } else if(field == "base_y") {
258 return this->domain().get_g_y();
259 } else if(field == "p") {
260 return this->domain().get_p();
261 } else if(field == "a") {
262 return this->domain().get_a();
263 } else if(field == "b") {
264 return this->domain().get_b();
265 } else if(field == "cofactor") {
266 return this->domain().get_cofactor();
267 } else if(field == "order") {
268 return this->domain().get_order();
269 } else {
270 return Public_Key::get_int_field(field);
271 }
272}
virtual const BigInt & get_int_field(std::string_view field) const
Definition pk_keys.cpp:20
const BigInt & get_b() const
Definition ec_group.cpp:745
const BigInt & get_a() const
Definition ec_group.cpp:741
const BigInt & get_g_y() const
Definition ec_group.cpp:793
const BigInt & get_cofactor() const
Definition ec_group.cpp:797
const BigInt & get_p() const
Definition ec_group.cpp:737
const BigInt & get_order() const
Definition ec_group.cpp:785
const BigInt & get_g_x() const
Definition ec_group.cpp:789

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

172{ return this->object_identifier(); }

References get_oid(), and Botan::Asymmetric_Key::object_identifier().

Referenced by get_oid().

◆ handles() [1/2]

◆ handles() [2/2]

const Object & Botan::TPM2::PrivateKey::handles ( ) const
inlineinherited

Definition at line 222 of file tpm2_key.h.

222{ return m_handle; }

◆ is_parent()

bool Botan::TPM2::PrivateKey::is_parent ( ) const
inherited

Definition at line 291 of file tpm2_key.cpp.

291 {
292 // Architectural Document, Section 4.54
293 // any object with the decrypt and restricted attributes SET and the sign
294 // attribute CLEAR
295 const auto attrs = m_handle.attributes(m_sessions);
296 return attrs.decrypt && attrs.restricted && !attrs.sign_encrypt;
297}

Referenced by Botan::TPM2::EC_PrivateKey::create_unrestricted_transient(), and Botan::TPM2::RSA_PrivateKey::create_unrestricted_transient().

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

28 {
29 return domain().get_p_bits();
30}
size_t get_p_bits() const
Definition ec_group.cpp:721

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

Referenced by estimated_strength().

◆ load_persistent()

std::unique_ptr< PrivateKey > Botan::TPM2::PrivateKey::load_persistent ( const std::shared_ptr< Context > & ctx,
TPM2_HANDLE persistent_object_handle,
std::span< const uint8_t > auth_value,
const SessionBundle & sessions )
staticinherited

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

Parameters
ctxThe TPM context to use
persistent_object_handleThe handle of the persistent object to load
auth_valueThe auth value required to use the key
sessionsThe session bundle to use for the key's operations

Definition at line 184 of file tpm2_key.cpp.

187 {
188 return create(load_persistent_object(ctx, persistent_object_handle, auth_value, sessions),
189 sessions,
190 nullptr /* pull public info from handle */,
191 {} /* persistent keys don't have an encrypted private blob */);
192}

References create(), and sessions().

Referenced by Botan::TPM2::Context::storage_root_key().

◆ load_transient()

std::unique_ptr< PrivateKey > Botan::TPM2::PrivateKey::load_transient ( const std::shared_ptr< Context > & ctx,
std::span< const uint8_t > auth_value,
const TPM2::PrivateKey & parent,
std::span< const uint8_t > public_blob,
std::span< const uint8_t > private_blob,
const SessionBundle & sessions )
staticinherited

Load a private key from the public and private blobs 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
ctxThe TPM context to use
auth_valueThe auth value required to use the key
parentThe parent key the key was originally created under
public_blobThe public blob of the key to load
private_blobThe private blob of the key to load
sessionsThe session bundle to use for loading

Definition at line 194 of file tpm2_key.cpp.

199 {
201 Object handle(ctx);
202
203 const auto public_data = unmarshal_public_blob(public_blob);
204 const auto private_data = copy_into<TPM2B_PRIVATE>(private_blob);
205
206 check_rc("Esys_Load",
207 Esys_Load(ctx->esys_context(),
208 parent.handles().transient_handle(),
209 sessions[0],
210 sessions[1],
211 sessions[2],
212 &private_data,
213 &public_data,
214 out_transient_handle(handle)));
215
216 if(!auth_value.empty()) {
217 const auto user_auth = copy_into<TPM2B_AUTH>(auth_value);
218 check_rc("Esys_TR_SetAuth", Esys_TR_SetAuth(ctx->esys_context(), handle.transient_handle(), &user_auth));
219 }
220
221 return create(std::move(handle), sessions, nullptr /* pull public info from handle */, private_blob);
222}

References BOTAN_ASSERT_NONNULL, Botan::TPM2::check_rc(), Botan::TPM2::copy_into(), create(), handles(), Botan::TPM2::out_transient_handle(), sessions(), and Botan::TPM2::Object::transient_handle().

◆ message_part_size()

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

Returns how large each of the message parts referred 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

Definition at line 236 of file pk_keys.h.

236 {
237 return _signature_element_size_for_DER_encoding().value_or(0);
238 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().

Referenced by message_part_size().

◆ message_parts()

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

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

Definition at line 223 of file pk_keys.h.

223 {
225 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().

Referenced by message_parts().

◆ object_identifier()

◆ pkcs8_algorithm_identifier()

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

Return the PKCS #8 AlgorithmIdentifier for this key

Note
normally this is the same as the public key identifier, but a few oddball algorithms use a different value

Reimplemented in Botan::GOST_3410_PrivateKey, and Botan::HSS_LMS_PrivateKey.

Definition at line 390 of file pk_keys.h.

390{ return algorithm_identifier(); }
virtual AlgorithmIdentifier algorithm_identifier() const =0

References Botan::Public_Key::algorithm_identifier().

Referenced by private_key_info().

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

102{ return m_point_encoding; }
EC_Point_Format m_point_encoding
Definition ecc_key.h:150

References m_point_encoding.

Referenced by raw_public_key_bits().

◆ private_key_bits()

secure_vector< uint8_t > Botan::TPM2::PrivateKey::private_key_bits ( ) const
inlineoverridevirtualinherited
Exceptions
Not_Implementedkeys hosted in a TPM2 cannot be exported

Implements Botan::Private_Key.

Definition at line 205 of file tpm2_key.h.

205 {
206 throw Not_Implemented("cannot export private key bits from a TPM2 key, maybe use raw_private_key_bits()?");
207 }

◆ private_key_info()

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

Return PKCS #8 private key encoding for this key object

Definition at line 77 of file pk_keys.cpp.

77 {
78 const size_t PKCS8_VERSION = 0;
79
80 return DER_Encoder()
81 .start_sequence()
82 .encode(PKCS8_VERSION)
85 .end_cons()
86 .get_contents();
87}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:390

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, pkcs8_algorithm_identifier(), private_key_bits(), and Botan::DER_Encoder::start_sequence().

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

◆ public_ec_point()

◆ public_key()

std::unique_ptr< Public_Key > Botan::TPM2::EC_PrivateKey::public_key ( ) const
overridevirtual

Allocate a new object for the public key associated with this private key.

Returns
public key

Implements Botan::Private_Key.

Definition at line 45 of file tpm2_ecc.cpp.

45 {
46 return std::make_unique<Botan::ECDSA_PublicKey>(domain(), public_ec_point());
47}

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

Referenced by EC_PrivateKey().

◆ public_key_bits()

std::vector< uint8_t > Botan::TPM2::EC_PrivateKey::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 57 of file tpm2_ecc.cpp.

57 {
59}
std::vector< uint8_t > raw_public_key_bits() const override
Definition ecc_key.cpp:102

References Botan::EC_PublicKey::raw_public_key_bits().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::TPM2::PrivateKey::raw_private_key_bits ( ) const
overridevirtualinherited
Returns
the encrypted private key blob, if the key is transient
Exceptions
Invalid_Stateif the key is persistent

Reimplemented from Botan::Private_Key.

Definition at line 281 of file tpm2_key.cpp.

281 {
282 BOTAN_STATE_CHECK(!m_handle.has_persistent_handle());
283 BOTAN_ASSERT_NOMSG(!m_private_blob.empty());
284 return Botan::lock(m_private_blob);
285}
secure_vector< T > lock(const std::vector< T > &in)
Definition secmem.h:145

References BOTAN_ASSERT_NOMSG, BOTAN_STATE_CHECK, and Botan::lock().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::TPM2::EC_PrivateKey::raw_public_key_bits ( ) const
overridevirtual
Returns
the public key encoding in TPM2B_PUBLIC format

Implements Botan::Public_Key.

Definition at line 61 of file tpm2_ecc.cpp.

61 {
63}
std::vector< uint8_t > raw_public_key_bits() const override
Definition tpm2_key.cpp:287

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

◆ remaining_operations()

virtual std::optional< uint64_t > Botan::Private_Key::remaining_operations ( ) const
inlinevirtualinherited

Retrieves the number of remaining operations if this is a stateful private key.

Returns
the number of remaining operations or std::nullopt if not applicable.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 403 of file pk_keys.h.

403{ return std::nullopt; }

◆ sessions()

◆ 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
encthe encoding to use

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

Definition at line 122 of file ecc_key.cpp.

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

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

Referenced by ~EC_PublicKey().

◆ 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
encthe encoding to use

Definition at line 114 of file ecc_key.cpp.

114 {
116 throw Invalid_Argument("Invalid point encoding for EC_PublicKey");
117 }
118
119 m_point_encoding = enc;
120}

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

Referenced by ~EC_PublicKey().

◆ stateful_operation()

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

Indicates if this key is stateful, ie that performing a private key operation requires updating the key storage.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 396 of file pk_keys.h.

396{ return false; }

◆ subject_public_key()

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

Return the SubjectPublicKeyInfo encoding of this public key

This is the subjectPublicKey field plus the algorithm-specific parameters

Definition at line 65 of file pk_keys.cpp.

65 {
66 std::vector<uint8_t> output;
67
68 DER_Encoder(output)
69 .start_sequence()
70 .encode(algorithm_identifier())
71 .encode_octet_aligned_bitstring(public_key_bits())
72 .end_cons();
73
74 return output;
75}
virtual std::vector< uint8_t > public_key_bits() const =0

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

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

◆ supports_operation()

bool Botan::TPM2::EC_PrivateKey::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 97 of file tpm2_ecc.h.

References Botan::Signature.

◆ TPM2::PrivateKey

friend class TPM2::PrivateKey
friend

Definition at line 103 of file tpm2_ecc.h.

References EC_PrivateKey(), and Botan::TPM2::PrivateKey::sessions().

Referenced by EC_PrivateKey().

Member Data Documentation

◆ m_domain_encoding

◆ m_point_encoding

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

Definition at line 150 of file ecc_key.h.

Referenced by point_encoding(), and set_point_encoding().

◆ m_public_key


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