Botan 3.8.1
Crypto and TLS for C&
Botan::TPM_PrivateKey Class Referencefinal

#include <tpm.h>

Inheritance diagram for Botan::TPM_PrivateKey:
Botan::Private_Key Botan::Public_Key Botan::Asymmetric_Key

Public Member Functions

virtual Signature_Format _default_x509_signature_format () 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) const override
 
virtual std::unique_ptr< PK_Ops::Decryptioncreate_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::KEM_Decryptioncreate_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::Key_Agreementcreate_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
std::unique_ptr< PK_Ops::Signaturecreate_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
 
virtual std::unique_ptr< PK_Ops::Verificationcreate_verification_op (std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::Verificationcreate_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const
 
TPM_Contextctx () const
 
Signature_Format default_x509_signature_format () const
 
size_t estimated_strength () const override
 
std::vector< uint8_t > export_blob () const
 
std::string fingerprint_private (std::string_view alg) const
 
std::string fingerprint_public (std::string_view alg="SHA-256") const
 
std::unique_ptr< Private_Keygenerate_another (RandomNumberGenerator &) const override
 
BigInt get_e () const
 
virtual const BigIntget_int_field (std::string_view field) const
 
BigInt get_n () const
 
OID get_oid () const
 
TSS_HKEY handle () 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
 
secure_vector< uint8_t > private_key_bits () const override
 
secure_vector< uint8_t > private_key_info () const
 
std::unique_ptr< Public_Keypublic_key () const override
 
std::vector< uint8_t > public_key_bits () const override
 
virtual secure_vector< uint8_t > raw_private_key_bits () const
 
std::vector< uint8_t > raw_public_key_bits () const override
 
std::string register_key (TPM_Storage_Type storage_type)
 
virtual std::optional< uint64_t > remaining_operations () const
 Retrieves the number of remaining operations if this is a stateful private key.
 
virtual bool stateful_operation () const
 
std::vector< uint8_t > subject_public_key () const
 
bool supports_operation (PublicKeyOperation op) const override
 
 TPM_PrivateKey (TPM_Context &ctx, const std::vector< uint8_t > &blob)
 
 TPM_PrivateKey (TPM_Context &ctx, size_t bits, const char *key_password)
 
 TPM_PrivateKey (TPM_Context &ctx, std::string_view uuid, TPM_Storage_Type storage_type)
 

Static Public Member Functions

static std::vector< std::string > registered_keys (TPM_Context &ctx)
 

Detailed Description

Definition at line 108 of file tpm.h.

Constructor & Destructor Documentation

◆ TPM_PrivateKey() [1/3]

Botan::TPM_PrivateKey::TPM_PrivateKey ( TPM_Context & ctx,
size_t bits,
const char * key_password )

Definition at line 178 of file tpm.cpp.

178 : m_ctx(ctx) {
179 // TODO: can also do OAEP decryption via binding keys
180 // TODO: offer signing, binding (decrypt), or legacy (sign + decrypt) keys?
181
182 TSS_FLAG key_flags = bit_flag(bits) | TSS_KEY_VOLATILE | TSS_KEY_TYPE_SIGNING;
183
184 TSS_HKEY key;
185 TSPI_CHECK_SUCCESS(::Tspi_Context_CreateObject(m_ctx.handle(), TSS_OBJECT_TYPE_RSAKEY, key_flags, &key));
186
188 ::Tspi_SetAttribUint32(key, TSS_TSPATTRIB_KEY_INFO, TSS_TSPATTRIB_KEYINFO_SIGSCHEME, TSS_SS_RSASSAPKCS1V15_DER));
189
190 TSS_HPOLICY policy;
191 TSPI_CHECK_SUCCESS(::Tspi_Context_CreateObject(m_ctx.handle(), TSS_OBJECT_TYPE_POLICY, TSS_POLICY_USAGE, &policy));
192 set_policy_secret(policy, key_password);
193 TSPI_CHECK_SUCCESS(::Tspi_Policy_AssignToObject(policy, key));
194
195 TSPI_CHECK_SUCCESS(::Tspi_Key_CreateKey(key, ctx.srk(), 0));
196 m_key = key;
197}
TPM_Context & ctx() const
Definition tpm.h:140
#define TSPI_CHECK_SUCCESS(expr)
Definition tpm.cpp:67

References ctx(), and TSPI_CHECK_SUCCESS.

◆ TPM_PrivateKey() [2/3]

Botan::TPM_PrivateKey::TPM_PrivateKey ( TPM_Context & ctx,
std::string_view uuid,
TPM_Storage_Type storage_type )

Definition at line 200 of file tpm.cpp.

200 :
201 m_ctx(ctx), m_uuid(uuid_str), m_storage(storage_type) {
202 const TSS_FLAG key_ps_type = (m_storage == TPM_Storage_Type::User) ? TSS_PS_TYPE_USER : TSS_PS_TYPE_SYSTEM;
203
204 TSPI_CHECK_SUCCESS(::Tspi_Context_LoadKeyByUUID(m_ctx.handle(), key_ps_type, to_tss_uuid(m_uuid), &m_key));
205}

References ctx(), TSPI_CHECK_SUCCESS, and Botan::User.

◆ TPM_PrivateKey() [3/3]

Botan::TPM_PrivateKey::TPM_PrivateKey ( TPM_Context & ctx,
const std::vector< uint8_t > & blob )

Definition at line 207 of file tpm.cpp.

207 : m_ctx(ctx) {
208 TSPI_CHECK_SUCCESS(::Tspi_Context_LoadKeyByBlob(
209 m_ctx.handle(), m_ctx.srk(), to_uint32(blob.size()), const_cast<uint8_t*>(blob.data()), &m_key));
210
211 //TSPI_CHECK_SUCCESS(::Tspi_Key_LoadKey(m_key, m_ctx.srk()));
212}

References ctx(), and TSPI_CHECK_SUCCESS.

Member Function Documentation

◆ _default_x509_signature_format()

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

◆ _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 137 of file pk_keys.h.

137{ return {}; }

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

◆ algo_name()

std::string Botan::TPM_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 167 of file tpm.h.

167{ return "RSA"; } // ???

◆ algorithm_identifier()

AlgorithmIdentifier Botan::TPM_PrivateKey::algorithm_identifier ( ) const
overridevirtual
Returns
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 284 of file tpm.cpp.

284 {
285 return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_NULL_PARAM);
286}
virtual OID object_identifier() const
Definition pk_keys.cpp:22

References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

◆ check_key()

bool Botan::TPM_PrivateKey::check_key ( RandomNumberGenerator & rng,
bool  ) const
overridevirtual

Implements Botan::Asymmetric_Key.

Definition at line 310 of file tpm.cpp.

310 {
311 return true; // TODO do a kat or pairwise check
312}

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

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

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

Definition at line 119 of file pk_keys.cpp.

121 {
122 throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
123}
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(), and Botan::fmt().

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

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

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

Definition at line 98 of file pk_keys.cpp.

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

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

Referenced by 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,
std::string_view params,
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 KEM decryption operation for this key/params or throw

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

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

127 {
128 throw Lookup_Error(fmt("{} does not support KEM decryption", algo_name()));
129}

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

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

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

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

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

Referenced by 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,
std::string_view params,
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 key agreement operation for this key/params or throw

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

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

Definition at line 137 of file pk_keys.cpp.

139 {
140 throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
141}

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

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

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::TPM_PrivateKey::create_signature_op ( RandomNumberGenerator & rng,
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 signature operation for this key/params or throw

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

Reimplemented from Botan::Private_Key.

Definition at line 375 of file tpm.cpp.

377 {
378 return std::make_unique<TPM_Signing_Operation>(*this, params);
379}

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op ( std::string_view params,
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 key/params or throw

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

Definition at line 109 of file pk_keys.cpp.

110 {
111 throw Lookup_Error(fmt("{} does not support verification", algo_name()));
112}

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

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

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

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

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

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

◆ ctx()

TPM_Context & Botan::TPM_PrivateKey::ctx ( ) const
inline

Definition at line 140 of file tpm.h.

140{ return m_ctx; }

Referenced by register_key(), registered_keys(), TPM_PrivateKey(), TPM_PrivateKey(), and TPM_PrivateKey().

◆ default_x509_signature_format()

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

Definition at line 228 of file pk_keys.h.

228 {
230 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:30

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

Referenced by default_x509_signature_format().

◆ estimated_strength()

size_t Botan::TPM_PrivateKey::estimated_strength ( ) const
overridevirtual

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 276 of file tpm.cpp.

276 {
277 return if_work_factor(key_length());
278}
size_t key_length() const override
Definition tpm.cpp:280
size_t if_work_factor(size_t bits)

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

◆ export_blob()

std::vector< uint8_t > Botan::TPM_PrivateKey::export_blob ( ) const

Definition at line 302 of file tpm.cpp.

302 {
303 return get_obj_attr(m_ctx.handle(), m_key, TSS_TSPATTRIB_KEY_BLOB, TSS_TSPATTRIB_KEYBLOB_BLOB);
304}

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg) const
inherited
Returns
Hash of the PKCS #8 encoding for this key object

Definition at line 94 of file pk_keys.cpp.

94 {
95 return create_hex_fingerprint(private_key_bits(), hash_algo);
96}
virtual secure_vector< uint8_t > private_key_bits() const =0
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, std::string_view hash_name)
Definition pk_keys.cpp:38

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

87 {
88 return create_hex_fingerprint(subject_public_key(), hash_algo);
89}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:56

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

Referenced by public_key_bits().

◆ generate_another()

std::unique_ptr< Private_Key > Botan::TPM_PrivateKey::generate_another ( 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 169 of file tpm.h.

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

◆ get_e()

BigInt Botan::TPM_PrivateKey::get_e ( ) const

Definition at line 267 of file tpm.cpp.

267 {
268 if(m_e == 0) {
269 m_e = BigInt::from_bytes(
270 get_obj_attr(m_ctx.handle(), m_key, TSS_TSPATTRIB_RSAKEY_INFO, TSS_TSPATTRIB_KEYINFO_RSA_EXPONENT));
271 }
272
273 return m_e;
274}
static BigInt from_bytes(std::span< const uint8_t > bytes)
Definition bigint.cpp:86

References Botan::BigInt::from_bytes().

Referenced by public_key(), and public_key_bits().

◆ get_int_field()

const BigInt & Botan::Asymmetric_Key::get_int_field ( std::string_view field) const
virtualinherited

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 in Botan::DH_PrivateKey, Botan::DH_PublicKey, Botan::DSA_PrivateKey, Botan::DSA_PublicKey, Botan::EC_PrivateKey, Botan::EC_PublicKey, Botan::ElGamal_PrivateKey, Botan::ElGamal_PublicKey, Botan::RSA_PrivateKey, and Botan::RSA_PublicKey.

Definition at line 18 of file pk_keys.cpp.

18 {
19 throw Unknown_PK_Field_Name(algo_name(), field);
20}

References algo_name().

Referenced by estimated_strength(), Botan::EC_PublicKey::get_int_field(), and Botan::RSA_PublicKey::get_int_field().

◆ get_n()

BigInt Botan::TPM_PrivateKey::get_n ( ) const

Definition at line 258 of file tpm.cpp.

258 {
259 if(m_n == 0) {
260 m_n = BigInt::from_bytes(
261 get_obj_attr(m_ctx.handle(), m_key, TSS_TSPATTRIB_RSAKEY_INFO, TSS_TSPATTRIB_KEYINFO_RSA_MODULUS));
262 }
263
264 return m_n;
265}

References Botan::BigInt::from_bytes().

Referenced by key_length(), public_key(), and public_key_bits().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const
inlineinherited

Deprecated version of object_identifier

Definition at line 161 of file pk_keys.h.

161{ return this->object_identifier(); }

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

Referenced by get_oid().

◆ handle()

TSS_HKEY Botan::TPM_PrivateKey::handle ( ) const
inline

Definition at line 142 of file tpm.h.

142{ return m_key; }

◆ key_length()

size_t Botan::TPM_PrivateKey::key_length ( ) const
overridevirtual

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 280 of file tpm.cpp.

280 {
281 return get_n().bits();
282}
size_t bits() const
Definition bigint.cpp:310
BigInt get_n() const
Definition tpm.cpp:258

References Botan::BigInt::bits(), and get_n().

Referenced by estimated_strength().

◆ message_part_size()

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

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

Definition at line 221 of file pk_keys.h.

221 {
222 return _signature_element_size_for_DER_encoding().value_or(0);
223 }

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

208 {
210 }

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
Returns
PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

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

Definition at line 323 of file pk_keys.h.

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

References Botan::Public_Key::algorithm_identifier().

Referenced by private_key_info().

◆ private_key_bits()

secure_vector< uint8_t > Botan::TPM_PrivateKey::private_key_bits ( ) const
overridevirtual
Returns
BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 298 of file tpm.cpp.

298 {
299 throw TPM_Error("Private key export not supported for TPM keys");
300}

◆ private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const
inherited
Returns
PKCS #8 private key encoding for this key object

Definition at line 68 of file pk_keys.cpp.

68 {
69 const size_t PKCS8_VERSION = 0;
70
71 return DER_Encoder()
72 .start_sequence()
73 .encode(PKCS8_VERSION)
76 .end_cons()
77 .get_contents();
78}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:323

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

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

Returns a copy of the public key

Implements Botan::Private_Key.

Definition at line 306 of file tpm.cpp.

306 {
307 return std::make_unique<RSA_PublicKey>(get_n(), get_e());
308}
BigInt get_e() const
Definition tpm.cpp:267

References get_e(), and get_n().

◆ public_key_bits()

std::vector< uint8_t > Botan::TPM_PrivateKey::public_key_bits ( ) const
overridevirtual
Returns
BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 288 of file tpm.cpp.

288 {
289 std::vector<uint8_t> bits;
290 DER_Encoder(bits).start_sequence().encode(get_n()).encode(get_e()).end_cons();
291 return bits;
292}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_e(), get_n(), and Botan::DER_Encoder::start_sequence().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::Private_Key::raw_private_key_bits ( ) const
virtualinherited
Returns
binary private key bits, with no additional encoding

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus not implement this function. The default implementation throws Not_Implemented

Reimplemented in Botan::Classic_McEliece_PrivateKey, Botan::DH_PrivateKey, Botan::Dilithium_PrivateKey, Botan::DSA_PrivateKey, Botan::EC_PrivateKey, Botan::Ed25519_PrivateKey, Botan::Ed448_PrivateKey, Botan::ElGamal_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::HSS_LMS_PrivateKey, Botan::KEX_to_KEM_Adapter_PrivateKey, Botan::Kyber_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 80 of file pk_keys.cpp.

80 {
81 throw Not_Implemented(algo_name() + " does not implement raw_private_key_bits");
82}

References Botan::Asymmetric_Key::algo_name().

Referenced by private_key_bits().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::TPM_PrivateKey::raw_public_key_bits ( ) const
overridevirtual
Returns
binary public key bits, with no additional encoding

For key agreements this is an alias for PK_Key_Agreement_Key::public_value.

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus throw Not_Implemented when invoking this method.

Implements Botan::Public_Key.

Definition at line 294 of file tpm.cpp.

294 {
295 throw TPM_Error("Raw public key export not supported for RSA TPM keys");
296}

◆ register_key()

std::string Botan::TPM_PrivateKey::register_key ( TPM_Storage_Type storage_type)

If the key is not currently registered under a known UUID, generates a new random UUID and registers the key. Returns the access URL.

Definition at line 214 of file tpm.cpp.

214 {
215 if(!m_uuid.is_valid()) {
216 TPM_RNG rng(ctx()); // use system_rng or arg RNG& instead?
217 m_uuid = UUID(rng);
218 m_storage = storage_type;
219
220 const TSS_UUID key_uuid = to_tss_uuid(m_uuid);
221 const TSS_FLAG key_ps_type = (storage_type == TPM_Storage_Type::User) ? TSS_PS_TYPE_USER : TSS_PS_TYPE_SYSTEM;
222
223 const TSS_UUID srk_uuid = TSS_UUID_SRK;
224
226 ::Tspi_Context_RegisterKey(m_ctx.handle(), m_key, key_ps_type, key_uuid, TSS_PS_TYPE_SYSTEM, srk_uuid));
227 }
228
229 // Presumably we could re-register in the other store and same UUID
230 // Doesn't seem like what is desired most of the time here
231 if(storage_type != m_storage) {
232 throw TPM_Error("TPM key " + m_uuid.to_string() + " already registered with different storage type");
233 }
234
235 return format_url(m_uuid, m_storage);
236}

References ctx(), TSPI_CHECK_SUCCESS, and Botan::User.

◆ registered_keys()

std::vector< std::string > Botan::TPM_PrivateKey::registered_keys ( TPM_Context & ctx)
static

Definition at line 238 of file tpm.cpp.

238 {
239 TSS_KM_KEYINFO2* key_info;
240 UINT32 key_info_size;
241
242 // TODO: does the PS type matter here at all?
244 ::Tspi_Context_GetRegisteredKeysByUUID2(ctx.handle(), TSS_PS_TYPE_SYSTEM, nullptr, &key_info_size, &key_info));
245
246 std::vector<std::string> r(key_info_size);
247
248 for(size_t i = 0; i != key_info_size; ++i) {
249 r[i] = format_url(key_info[i].keyUUID, key_info[i].persistentStorageType);
250 }
251
252 // TODO: are we supposed to free this memory and if so how?
253 //TSPI_CHECK_SUCCESS(::Tspi_Context_FreeMemory(ctx.handle(), key_info));
254
255 return r;
256}

References ctx(), and TSPI_CHECK_SUCCESS.

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

336{ return std::nullopt; }

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

329{ return false; }

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited
Returns
X.509 subject key encoding for this key object

Definition at line 56 of file pk_keys.cpp.

56 {
57 std::vector<uint8_t> output;
58
59 DER_Encoder(output)
60 .start_sequence()
61 .encode(algorithm_identifier())
63 .end_cons();
64
65 return output;
66}
virtual std::vector< uint8_t > public_key_bits() const =0

References algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), 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::TPM_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 173 of file tpm.h.

References Botan::Signature.


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