#include <tpm.h>

Inheritance diagram for Botan::TPM_PrivateKey:

Public Member Functions
std::string	algo_name () const override

AlgorithmIdentifier	algorithm_identifier () const override

bool	check_key (RandomNumberGenerator &rng, bool) const override

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

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

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

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

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

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

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

TPM_Context &	ctx () const

virtual Signature_Format	default_x509_signature_format () const

size_t	estimated_strength () const override

std::vector< uint8_t >	export_blob () const

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

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

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

BigInt	get_e () const

BigInt	get_n () const

virtual OID	get_oid () const

TSS_HKEY	handle () const

size_t	key_length () const override

virtual size_t	message_part_size () const

virtual size_t	message_parts () 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_Key >	public_key () const

std::vector< uint8_t >	public_key_bits () const override

std::string	register_key (TPM_Storage_Type storage_type)

virtual bool	stateful_operation () const

std::vector< uint8_t >	subject_public_key () const

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

	TPM_PrivateKey (TPM_Context &ctx, const std::string &uuid, TPM_Storage_Type storage_type)

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

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

                                                          : m_ctx(ctx)
    {
    // TODO: can also do OAEP decryption via binding keys
    // TODO: offer signing, binding (decrypt), or legacy (sign + decrypt) keys?
 
    TSS_FLAG key_flags = bit_flag(bits) | TSS_KEY_VOLATILE | TSS_KEY_TYPE_SIGNING;
 
    TSS_HKEY key;
    TSPI_CHECK_SUCCESS(::Tspi_Context_CreateObject(m_ctx.handle(), TSS_OBJECT_TYPE_RSAKEY, key_flags, &key));
 
    TSPI_CHECK_SUCCESS(::Tspi_SetAttribUint32(key, TSS_TSPATTRIB_KEY_INFO,
                                          TSS_TSPATTRIB_KEYINFO_SIGSCHEME,
                                          TSS_SS_RSASSAPKCS1V15_DER));
 
    TSS_HPOLICY policy;
    TSPI_CHECK_SUCCESS(::Tspi_Context_CreateObject(m_ctx.handle(), TSS_OBJECT_TYPE_POLICY, TSS_POLICY_USAGE, &policy));
    set_policy_secret(policy, key_password);
    TSPI_CHECK_SUCCESS(::Tspi_Policy_AssignToObject(policy, key));
 
    TSPI_CHECK_SUCCESS(::Tspi_Key_CreateKey(key, ctx.srk(), 0));
    m_key = key;
    }

◆ TPM_PrivateKey() [2/3]

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

Definition at line 228 of file tpm.cpp.

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

◆ TPM_PrivateKey() [3/3]

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

Definition at line 243 of file tpm.cpp.

                                                                : m_ctx(ctx)
    {
    TSPI_CHECK_SUCCESS(::Tspi_Context_LoadKeyByBlob(m_ctx.handle(), m_ctx.srk(), blob.size(),
                                                const_cast<uint8_t*>(blob.data()),
                                                &m_key));
 
    //TSPI_CHECK_SUCCESS(::Tspi_Key_LoadKey(m_key, m_ctx.srk()));
    }

Member Function Documentation

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

Definition at line 169 of file tpm.h.

169 { 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 346 of file tpm.cpp.

References Botan::Public_Key::get_oid(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

    {
    return AlgorithmIdentifier(get_oid(),
                               AlgorithmIdentifier::USE_NULL_PARAM);
    }

◆ check_key()

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

overridevirtual

Test the key values for consistency.

Parameters

rng	rng to use
strong	whether to perform strong and lengthy version of the test

Returns: true if the test is passed

Implements Botan::Public_Key.

Definition at line 379 of file tpm.cpp.

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

◆ create_decryption_op()

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

virtualinherited

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

Return an decryption operation for this key/params or throw

Parameters

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

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

Definition at line 114 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

◆ create_encryption_op()

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

virtualinherited

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

Return an encryption operation for this key/params or throw

Parameters

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

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

Definition at line 91 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

◆ create_kem_decryption_op()

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

virtualinherited

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

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

Parameters

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

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

Definition at line 122 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

◆ create_kem_encryption_op()

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

virtualinherited

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

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

Parameters

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

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

Definition at line 99 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

◆ create_key_agreement_op()

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

virtualinherited

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

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

Parameters

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

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

Definition at line 138 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

◆ create_signature_op()

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

overridevirtual

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

Return a signature operation for this key/params or throw

Parameters

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

Reimplemented from Botan::Private_Key.

Definition at line 451 of file tpm.cpp.

    {
    return std::unique_ptr<PK_Ops::Signature>(new TPM_Signing_Operation(*this, params));
    }

◆ create_verification_op()

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

virtualinherited

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

Return a verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented in Botan::XMSS_PublicKey, Botan::RSA_PublicKey, Botan::ECDSA_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_PublicKey, Botan::Ed25519_PublicKey, and Botan::DSA_PublicKey.

Definition at line 107 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

◆ ctx()

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

inline

Definition at line 144 of file tpm.h.

Referenced by register_key(), and registered_keys().

144 { return m_ctx; }

◆ default_x509_signature_format()

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

inlinevirtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 126 of file pk_keys.h.

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

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

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

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

Definition at line 336 of file tpm.cpp.

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

    {
    return if_work_factor(key_length());
    }

◆ export_blob()

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

Definition at line 367 of file tpm.cpp.

References Botan::TPM_Context::handle().

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

◆ fingerprint()

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

inlineinherited

Definition at line 216 of file pk_keys.h.

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

◆ fingerprint_private()

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

inherited

Returns: Hash of the PKCS #8 encoding for this key object

Definition at line 85 of file pk_keys.cpp.

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

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

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

◆ fingerprint_public()

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

inherited

Returns: Hash of the subject public key

Definition at line 77 of file pk_keys.cpp.

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

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

◆ get_e()

BigInt Botan::TPM_PrivateKey::get_e ( ) const

Definition at line 324 of file tpm.cpp.

References Botan::BigInt::decode(), and Botan::TPM_Context::handle().

Referenced by public_key(), and public_key_bits().

    {
    if(m_e == 0)
       {
       m_e = BigInt::decode(get_obj_attr(m_ctx.handle(), m_key,
                                         TSS_TSPATTRIB_RSAKEY_INFO,
                                         TSS_TSPATTRIB_KEYINFO_RSA_EXPONENT));
       }
 
    return m_e;
    }

◆ get_n()

BigInt Botan::TPM_PrivateKey::get_n ( ) const

Definition at line 312 of file tpm.cpp.

References Botan::BigInt::decode(), and Botan::TPM_Context::handle().

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

    {
    if(m_n == 0)
       {
       m_n = BigInt::decode(get_obj_attr(m_ctx.handle(), m_key,
                                         TSS_TSPATTRIB_RSAKEY_INFO,
                                         TSS_TSPATTRIB_KEYINFO_RSA_MODULUS));
       }
 
    return m_n;
    }

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 53 of file pk_keys.cpp.

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

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

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

◆ handle()

TSS_HKEY Botan::TPM_PrivateKey::handle ( ) const

inline

Definition at line 146 of file tpm.h.

146 { 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 341 of file tpm.cpp.

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

Referenced by estimated_strength().

    {
    return get_n().bits();
    }

◆ message_part_size()

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

inlinevirtualinherited

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

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

Returns: size of the message parts in bits

Reimplemented in Botan::ECDSA_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_PublicKey, and Botan::DSA_PublicKey.

Definition at line 124 of file pk_keys.h.

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

124 { return 0; }

◆ message_parts()

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

inlinevirtualinherited

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

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

Returns: number of message parts

Reimplemented in Botan::ECDSA_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_PublicKey, and Botan::DSA_PublicKey.

Definition at line 113 of file pk_keys.h.

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

113 { return 1; }

◆ pkcs8_algorithm_identifier()

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

inlinevirtualinherited

Returns: PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

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

Definition at line 205 of file pk_keys.h.

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

206 { return algorithm_identifier(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

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

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

◆ private_key_info()

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

inherited

Returns: PKCS #8 private key encoding for this key object

Definition at line 61 of file pk_keys.cpp.

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

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

    {
    const size_t PKCS8_VERSION = 0;
 
    return DER_Encoder()
          .start_cons(SEQUENCE)
             .encode(PKCS8_VERSION)
             .encode(pkcs8_algorithm_identifier())
             .encode(private_key_bits(), OCTET_STRING)
          .end_cons()
       .get_contents();
    }

◆ public_key()

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

Returns a copy of the public key

Definition at line 374 of file tpm.cpp.

References get_e(), and get_n().

    {
    return std::unique_ptr<Public_Key>(new RSA_PublicKey(get_n(), get_e()));
    }

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

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents_unlocked(), get_e(), get_n(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

    {
    return DER_Encoder()
       .start_cons(SEQUENCE)
         .encode(get_n())
         .encode(get_e())
       .end_cons()
       .get_contents_unlocked();
    }

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

References ctx(), Botan::TPM_Context::handle(), Botan::UUID::is_valid(), Botan::UUID::to_string(), TSPI_CHECK_SUCCESS, and Botan::User.

    {
    if(!m_uuid.is_valid())
       {
       TPM_RNG rng(ctx()); // use system_rng or arg RNG& instead?
       m_uuid = UUID(rng);
       m_storage = storage_type;
 
       const TSS_UUID key_uuid = to_tss_uuid(m_uuid);
       const TSS_FLAG key_ps_type =
          (storage_type == TPM_Storage_Type::User) ? TSS_PS_TYPE_USER : TSS_PS_TYPE_SYSTEM;
 
       const TSS_UUID srk_uuid = TSS_UUID_SRK;
 
       TSPI_CHECK_SUCCESS(::Tspi_Context_RegisterKey(m_ctx.handle(),
                                                 m_key,
                                                 key_ps_type,
                                                 key_uuid,
                                                 TSS_PS_TYPE_SYSTEM,
                                                 srk_uuid));
 
       }
 
    // Presumably we could re-register in the other store and same UUID
    // Doesn't seem like what is desired most of the time here
    if(storage_type != m_storage)
       {
       throw TPM_Error("TPM key " + m_uuid.to_string() +
                       " already registered with different storage type");
       }
 
    return format_url(m_uuid, m_storage);
    }

◆ registered_keys()

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

static

Definition at line 287 of file tpm.cpp.

References ctx(), Botan::TPM_Context::handle(), and TSPI_CHECK_SUCCESS.

    {
    TSS_KM_KEYINFO2* key_info;
    UINT32 key_info_size;
 
    // TODO: does the PS type matter here at all?
    TSPI_CHECK_SUCCESS(::Tspi_Context_GetRegisteredKeysByUUID2(ctx.handle(),
                                                           TSS_PS_TYPE_SYSTEM,
                                                           nullptr,
                                                           &key_info_size,
                                                           &key_info));
 
    std::vector<std::string> r(key_info_size);
 
    for(size_t i = 0; i != key_info_size; ++i)
       {
       r[i] = format_url(key_info[i].keyUUID, key_info[i].persistentStorageType);
       }
 
    // TODO: are we supposed to free this memory and if so how?
    //TSPI_CHECK_SUCCESS(::Tspi_Context_FreeMemory(ctx.handle(), key_info));
 
    return r;
    }

◆ stateful_operation()

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

inlinevirtualinherited

Reimplemented in Botan::XMSS_PrivateKey.

Definition at line 189 of file pk_keys.h.

189 { return false; }

◆ subject_public_key()

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

inherited

Returns: X.509 subject key encoding for this key object

Definition at line 38 of file pk_keys.cpp.

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

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

    {
    std::vector<uint8_t> output;
 
    DER_Encoder(output).start_cons(SEQUENCE)
          .encode(algorithm_identifier())
          .encode(public_key_bits(), BIT_STRING)
       .end_cons();
 
    return output;
    }

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

src/lib/prov/tpm/tpm.h
src/lib/prov/tpm/tpm.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TPM_PrivateKey() [1/3]

◆ TPM_PrivateKey() [2/3]

◆ TPM_PrivateKey() [3/3]

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ create_decryption_op()

◆ create_encryption_op()

◆ create_kem_decryption_op()

◆ create_kem_encryption_op()

◆ create_key_agreement_op()

◆ create_signature_op()

◆ create_verification_op()

◆ ctx()

◆ default_x509_signature_format()

◆ estimated_strength()

◆ export_blob()

◆ fingerprint()

◆ fingerprint_private()

◆ fingerprint_public()

◆ get_e()

◆ get_n()

◆ get_oid()

◆ handle()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ pkcs8_algorithm_identifier()

◆ private_key_bits()

◆ private_key_info()

◆ public_key()

◆ public_key_bits()

◆ register_key()

◆ registered_keys()

◆ stateful_operation()

◆ subject_public_key()