Botan::TPM2::Object Class Reference

#include <tpm2_object.h>

Public Member Functions
void	_disengage () noexcept
	Reset the object's internal state without flushing its TPM handles.
PublicInfo &	_public_info (const SessionBundle &sessions, std::optional< TPMI_ALG_PUBLIC > expected_type={}) const
void	_reset () noexcept
	Flush the object's TPM handles and reset its internal state.
ObjectAttributes	attributes (const SessionBundle &sessions) const
const std::shared_ptr< Context > &	context () const
bool	has_persistent_handle () const
bool	has_transient_handle () const
	Object (const Object &)=delete
	Object (Object &&other) noexcept
	Object (std::shared_ptr< Context > ctx)
	Object (std::shared_ptr< Context > ctx, ESYS_TR handle)
Object &	operator= (const Object &)=delete
Object &	operator= (Object &&other) noexcept
TPM2_HANDLE	persistent_handle () const
ESYS_TR	transient_handle () const noexcept
virtual	~Object ()

Friends
class	ObjectSetter

Detailed Description

Wraps and manages the lifetime of TPM2 object handles both for transient and persistent objects. When this object is destroyed, the handles are released accordingly.

Note that some TSS2 library functions may internally release handles passed to them. In such cases, the Object instance can be disengaged, ensuring that the handles are not released twice. This is an internal functionality and should not be used directly.

Definition at line 85 of file tpm2_object.h.

Constructor & Destructor Documentation

Object() [1/4]

Botan::TPM2::Object::Object ( std::shared_ptr< Context > ctx )

explicit

Definition at line 48 of file tpm2_object.cpp.

                                         : m_ctx(std::move(ctx)), m_handles(std::make_unique<ObjectHandles>()) {
   BOTAN_ASSERT_NONNULL(m_ctx);
}

References BOTAN_ASSERT_NONNULL.

Object() [2/4]

Botan::TPM2::Object::Object	(	std::shared_ptr< Context >	ctx,
		ESYS_TR	handle )

Create an object wrapper from a user-provided transient handle.

Use this to wrap an externally created transient object handle into a Botan::TPM2::Object instance. This is useful when the object is created by the application and not by the Botan::TPM2 library.

Note that this will take ownership of the ESYS_TR handle and will release it when the object is destroyed.

Parameters

ctx	the TPM context to use
handle	the transient handle to wrap

Definition at line 52 of file tpm2_object.cpp.

                                                         : Object(std::move(ctx)) {
   m_handles->transient = handle;
}

~Object()

Botan::TPM2::Object::~Object ( )

virtual

Definition at line 63 of file tpm2_object.cpp.

                {
   if(m_handles) {
      flush();
   }
}

Object() [3/4]

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

delete

Object() [4/4]

Botan::TPM2::Object::Object ( Object && other )

noexcept

Definition at line 56 of file tpm2_object.cpp.

                                      :
      m_ctx(std::move(other.m_ctx)),
      m_handles(std::move(other.m_handles)),
      m_public_info(std::move(other.m_public_info)) {
   other.scrub();
}

Member Function Documentation

_disengage()

void Botan::TPM2::Object::_disengage ( )

noexcept

Reset the object's internal state without flushing its TPM handles.

Definition at line 107 of file tpm2_object.cpp.

                                 {
   m_handles = std::make_unique<ObjectHandles>();
   m_public_info.reset();
}

Referenced by _reset(), and Botan::TPM2::HashFunction::final_with_ticket().

_public_info()

PublicInfo & Botan::TPM2::Object::_public_info	(	const SessionBundle &	sessions,
		std::optional< TPMI_ALG_PUBLIC >	expected_type = {} ) const

Definition at line 134 of file tpm2_object.cpp.

                                                                                                                {
   if(!m_public_info) {
      m_public_info = std::make_unique<PublicInfo>();
 
      check_rc("Esys_ReadPublic",
               Esys_ReadPublic(*m_ctx,
                               m_handles->transient,
                               sessions[0],
                               sessions[1],
                               sessions[2],
                               out_ptr(m_public_info->pub),
                               out_ptr(m_public_info->name),
                               out_ptr(m_public_info->qualified_name)));
      BOTAN_ASSERT_NONNULL(m_public_info->pub);
 
      if(expected_type) {
         BOTAN_STATE_CHECK(m_public_info->pub->publicArea.type == *expected_type);
      }
   }
 
   return *m_public_info;
}

References BOTAN_ASSERT_NONNULL, BOTAN_STATE_CHECK, Botan::TPM2::check_rc(), and Botan::out_ptr().

Referenced by attributes(), Botan::TPM2::PrivateKey::create(), Botan::TPM2::PublicKey::create(), Botan::TPM2::PrivateKey::raw_public_key_bits(), and Botan::TPM2::PublicKey::raw_public_key_bits().

_reset()

void Botan::TPM2::Object::_reset ( )

noexcept

Flush the object's TPM handles and reset its internal state.

Definition at line 101 of file tpm2_object.cpp.

                             {
   flush();
   _disengage();
}

References _disengage().

Referenced by Botan::TPM2::HashFunction::clear().

attributes()

ObjectAttributes Botan::TPM2::Object::attributes

(

const SessionBundle &

sessions

)

const

Definition at line 129 of file tpm2_object.cpp.

                                                                       {
   const auto attrs = _public_info(sessions).pub->publicArea.objectAttributes;
   return ObjectAttributes::read(attrs);
}

References _public_info(), Botan::TPM2::PublicInfo::pub, and Botan::TPM2::ObjectAttributes::read().

Referenced by Botan::TPM2::PrivateKey::is_parent().

context()

const std::shared_ptr< Context > & Botan::TPM2::Object::context ( ) const

inline

Definition at line 110 of file tpm2_object.h.

{ return m_ctx; }

Referenced by Botan::TPM2::Session::attributes(), Botan::TPM2::HashFunction::final_with_ticket(), Botan::TPM2::HashFunction::new_object(), Botan::TPM2::Session::set_attributes(), and Botan::TPM2::Session::tpm_nonce().

has_persistent_handle()

bool Botan::TPM2::Object::has_persistent_handle

(

)

const

Definition at line 112 of file tpm2_object.cpp.

                                         {
   return m_handles->persistent.has_value();
}

Referenced by Botan::TPM2::PrivateKey::create(), Botan::TPM2::PublicKey::create(), persistent_handle(), and Botan::TPM2::PrivateKey::raw_private_key_bits().

has_transient_handle()

bool Botan::TPM2::Object::has_transient_handle

(

)

const

Definition at line 116 of file tpm2_object.cpp.

                                        {
   return m_handles->transient != ESYS_TR_NONE;
}

Referenced by Botan::TPM2::PrivateKey::create_transient_from_template(), and Botan::TPM2::HashFunction::final_with_ticket().

operator=() [1/2]

Object & Botan::TPM2::Object::operator= ( const Object & )

delete

operator=() [2/2]

Object & Botan::TPM2::Object::operator= ( Object && other )

noexcept

Definition at line 69 of file tpm2_object.cpp.

                                                 {
   if(this != &other) {
      flush();
      m_ctx = std::move(other.m_ctx);
      m_handles = std::move(other.m_handles);
      m_public_info = std::move(other.m_public_info);
      other.scrub();
   }
   return *this;
}

persistent_handle()

TPM2_HANDLE Botan::TPM2::Object::persistent_handle

(

)

const

Definition at line 120 of file tpm2_object.cpp.

                                            {
   BOTAN_STATE_CHECK(has_persistent_handle());
   return *m_handles->persistent;
}

References BOTAN_STATE_CHECK, and has_persistent_handle().

transient_handle()

ESYS_TR Botan::TPM2::Object::transient_handle ( ) const

noexcept

Definition at line 125 of file tpm2_object.cpp.

                                                {
   return m_handles->transient;
}

Referenced by Botan::TPM2::Session::attributes(), Botan::TPM2::Session::authenticated_session(), Botan::TPM2::EC_PrivateKey::create_unrestricted_transient(), Botan::TPM2::RSA_PrivateKey::create_unrestricted_transient(), Botan::TPM2::HashFunction::final_with_ticket(), Botan::TPM2::PrivateKey::load_transient(), Botan::TPM2::Session::set_attributes(), and Botan::TPM2::Session::tpm_nonce().

Friends And Related Symbol Documentation

ObjectSetter

friend class ObjectSetter

friend

Definition at line 125 of file tpm2_object.h.

---

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

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