Botan 3.0.0-alpha0
Crypto and TLS for C&
Public Types | Public Member Functions | List of all members
Botan::TPM_Context Class Referencefinal

#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 48 of file tpm.h.

Constructor & Destructor Documentation

◆ TPM_Context()

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

Definition at line 165 of file tpm.cpp.

165 :
166 m_pin_cb(cb),
167 m_srk_policy(0)
168 {
169 TSPI_CHECK_SUCCESS(::Tspi_Context_Create(&m_ctx));
170 TSPI_CHECK_SUCCESS(::Tspi_Context_Connect(m_ctx, nullptr));
171
172 TSPI_CHECK_SUCCESS(::Tspi_Context_GetTpmObject(m_ctx, &m_tpm));
173
174 const TSS_UUID SRK_UUID = TSS_UUID_SRK;
175
176 TSPI_CHECK_SUCCESS(::Tspi_Context_LoadKeyByUUID(m_ctx, TSS_PS_TYPE_SYSTEM, SRK_UUID, &m_srk));
177
178 TSPI_CHECK_SUCCESS(::Tspi_GetPolicyObject(m_srk, TSS_POLICY_USAGE, &m_srk_policy));
179 set_policy_secret(m_srk_policy, srk_password);
180
181 // TODO: do we have to cache it?
182 // TODO: try to use SRK with null, if it fails call the pin cb?
183 }
#define TSPI_CHECK_SUCCESS(expr)
Definition: tpm.cpp:77

References TSPI_CHECK_SUCCESS.

◆ ~TPM_Context()

Botan::TPM_Context::~TPM_Context ( )

Definition at line 185 of file tpm.cpp.

186 {
187 TSPI_CHECK_SUCCESS(::Tspi_Context_CloseObject(m_ctx, m_srk));
188 //TSPI_CHECK_SUCCESS(::Tspi_Context_CloseObject(m_ctx, m_tpm));
189 TSPI_CHECK_SUCCESS(::Tspi_Context_Close(m_srk_policy));
190 TSPI_CHECK_SUCCESS(::Tspi_Context_Close(m_ctx));
191 }

References TSPI_CHECK_SUCCESS.

Member Function Documentation

◆ current_counter()

uint32_t Botan::TPM_Context::current_counter ( )

Definition at line 193 of file tpm.cpp.

194 {
195 uint32_t r = 0;
196 TSPI_CHECK_SUCCESS(::Tspi_TPM_ReadCounter(m_tpm, &r));
197 return r;
198 }

References TSPI_CHECK_SUCCESS.

◆ gen_random()

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

Definition at line 200 of file tpm.cpp.

201 {
202 BYTE* mem;
203 TSPI_CHECK_SUCCESS(::Tspi_TPM_GetRandom(m_tpm, to_uint32(out_len), &mem));
204 copy_mem(out, reinterpret_cast<const uint8_t*>(mem), out_len);
205 TSPI_CHECK_SUCCESS(::Tspi_Context_FreeMemory(m_ctx, mem));
206 }
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition: mem_ops.h:126

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 60 of file tpm.h.

61 {
62 return m_pin_cb(who);
63 }

◆ handle()

TSS_HCONTEXT Botan::TPM_Context::handle ( ) const
inline

◆ srk()

TSS_HKEY Botan::TPM_Context::srk ( ) const
inline

Definition at line 68 of file tpm.h.

68{ return m_srk; }

◆ stir_random()

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

Definition at line 208 of file tpm.cpp.

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

References TSPI_CHECK_SUCCESS.


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