Botan::TPM_Context Class Reference

#include <tpm.h>

Public Types
typedef std::function< std::string(std::string)>	pin_cb

Public Member Functions
uint32_t	current_counter ()
void	gen_random (uint8_t out[], size_t out_len)
std::string	get_user_pin (const std::string &who)
TSS_HCONTEXT	handle () const
TSS_HKEY	srk () const
void	stir_random (const uint8_t in[], size_t in_len)
	TPM_Context (pin_cb cb, const char *srk_password)
	~TPM_Context ()

Detailed Description

Creates a connection to the TPM. All other TPM types take and hold a TPM_Context reference, so all other objects must be deallocated before ~TPM_Context runs.

Use nullptr for the srk_password to indicate the well known secret (ie, an unencrypted SRK). This is usually what you want.

TODO: handling owner password?

Definition at line 41 of file tpm.h.

Member Typedef Documentation

pin_cb

typedef std::function<std::string(std::string)> Botan::TPM_Context::pin_cb

User callback for getting the PIN. Will be passed the best available description of what we are attempting to load.

Definition at line 47 of file tpm.h.

Constructor & Destructor Documentation

TPM_Context()

Botan::TPM_Context::TPM_Context	(	pin_cb	cb,
		const char *	srk_password )

Definition at line 136 of file tpm.cpp.

                                                            : m_pin_cb(cb), m_srk_policy(0) {
   TSPI_CHECK_SUCCESS(::Tspi_Context_Create(&m_ctx));
   TSPI_CHECK_SUCCESS(::Tspi_Context_Connect(m_ctx, nullptr));
 
   TSPI_CHECK_SUCCESS(::Tspi_Context_GetTpmObject(m_ctx, &m_tpm));
 
   const TSS_UUID SRK_UUID = TSS_UUID_SRK;
 
   TSPI_CHECK_SUCCESS(::Tspi_Context_LoadKeyByUUID(m_ctx, TSS_PS_TYPE_SYSTEM, SRK_UUID, &m_srk));
 
   TSPI_CHECK_SUCCESS(::Tspi_GetPolicyObject(m_srk, TSS_POLICY_USAGE, &m_srk_policy));
   set_policy_secret(m_srk_policy, srk_password);
 
   // TODO: do we have to cache it?
   // TODO: try to use SRK with null, if it fails call the pin cb?
}

References TSPI_CHECK_SUCCESS.

~TPM_Context()

Botan::TPM_Context::~TPM_Context

(

)

Definition at line 153 of file tpm.cpp.

                          {
   TSPI_CHECK_SUCCESS(::Tspi_Context_CloseObject(m_ctx, m_srk));
   //TSPI_CHECK_SUCCESS(::Tspi_Context_CloseObject(m_ctx, m_tpm));
   TSPI_CHECK_SUCCESS(::Tspi_Context_Close(m_srk_policy));
   TSPI_CHECK_SUCCESS(::Tspi_Context_Close(m_ctx));
}

References TSPI_CHECK_SUCCESS.

Member Function Documentation

current_counter()

uint32_t Botan::TPM_Context::current_counter

(

)

Definition at line 160 of file tpm.cpp.

                                      {
   uint32_t r = 0;
   TSPI_CHECK_SUCCESS(::Tspi_TPM_ReadCounter(m_tpm, &r));
   return r;
}

References TSPI_CHECK_SUCCESS.

gen_random()

void Botan::TPM_Context::gen_random	(	uint8_t	out[],
		size_t	out_len )

Definition at line 166 of file tpm.cpp.

                                                          {
   BYTE* mem;
   TSPI_CHECK_SUCCESS(::Tspi_TPM_GetRandom(m_tpm, to_uint32(out_len), &mem));
   copy_mem(out, reinterpret_cast<const uint8_t*>(mem), out_len);
   TSPI_CHECK_SUCCESS(::Tspi_Context_FreeMemory(m_ctx, mem));
}

References Botan::copy_mem(), and TSPI_CHECK_SUCCESS.

get_user_pin()

std::string Botan::TPM_Context::get_user_pin ( const std::string & who )

inline

Definition at line 59 of file tpm.h.

{ return m_pin_cb(who); }

handle()

TSS_HCONTEXT Botan::TPM_Context::handle ( ) const

inline

Definition at line 63 of file tpm.h.

{ return m_ctx; }

Referenced by Botan::TPM_PrivateKey::export_blob(), Botan::TPM_PrivateKey::get_e(), Botan::TPM_PrivateKey::get_n(), Botan::TPM_PrivateKey::register_key(), Botan::TPM_PrivateKey::registered_keys(), Botan::TPM_PrivateKey::TPM_PrivateKey(), Botan::TPM_PrivateKey::TPM_PrivateKey(), and Botan::TPM_PrivateKey::TPM_PrivateKey().

srk()

TSS_HKEY Botan::TPM_Context::srk ( ) const

inline

Definition at line 65 of file tpm.h.

{ return m_srk; }

Referenced by Botan::TPM_PrivateKey::TPM_PrivateKey(), and Botan::TPM_PrivateKey::TPM_PrivateKey().

stir_random()

void Botan::TPM_Context::stir_random	(	const uint8_t	in[],
		size_t	in_len )

Definition at line 173 of file tpm.cpp.

                                                               {
   TSPI_CHECK_SUCCESS(::Tspi_TPM_StirRandom(m_tpm, to_uint32(in_len), const_cast<BYTE*>(in)));
}

References TSPI_CHECK_SUCCESS.

---

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

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