SysTutorials Posts

TCG Software Stack Developer’s Reference Name Tspi_TPM_TakeOwnership – take ownership of a TPM Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_TakeOwnership(TSS_HTPM hTPM, TSS_HKEY hKeySRK, TSS_HKEY hEndorsementPubKey); Description Tspi_TPM_TakeOwnership takes ownership of a TPM. Taking ownership is the process of inserting a shared secret into the TPM….

TCG Software Stack Developer’s Reference Name Tspi_TPM_StirRandom – add entropy to the TPM random number generator Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_StirRandom(TSS_HTPM hTPM, UINT32 ulEntropyDataLength, BYTE* rgbEntropyData); Description Tspi_TPM_StirRandom adds entropy to the TPM random number generator for the purpose of generating better random…

TCG Software Stack Developer’s Reference Name Tspi_TPM_SetStatus – modify the TPM’s status Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_SetStatus(TSS_HTPM hTPM, TSS_FLAG statusFlag, TSS_BOOL fTpmState); Description Tspi_TPM_SetStatus alters the status of the TPM. Depending on the chosen statusFlag, fTpmState may or may not be ignored. This…

TCG Software Stack Developer’s Reference Name Tspi_TPM_SelfTestFull – perform a self-test of each internal TPM function Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_SelfTestFull(TSS_HTPM hTPM); Description Tspi_TPM_SelfTestFull assures that the TPM is functioning as designed. For FIPS certification, crypto modules are required to test themselves before…

Tspi_TPM_Quote2 – retreive a signed set of PCR values with a more complete view than Tspi_TPM_Quote. Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_Quote2(TSS_HTPM hTPM, TSS_HKEY hIdentKey, TSS_BOOL fAddVersion, TSS_HPCRS hPcrComposite, TSS_VALIDATION* pValidationData, UINT32* versionInfoSize, BYTE** versionInfo); Description Tspi_TPM_Quote2 quotes a TCG system, providing the requestor…

Tspi_TPM_Quote – retreive a signed set of PCR values. Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_Quote(TSS_HTPM hTPM, TSS_HKEY hIdentKey, TSS_HPCRS hPcrComposite, TSS_VALIDATION* pValidationData); Description Tspi_TPM_Quote destroys a context by passing in the handle to that context. Parameters hTPM Handle of the TPM object. hIdentKey Handle…

TCG Software Stack Developer’s Reference Name Tspi_TPM_PcrRead – read the value in a PCR register Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_PcrRead(TSS_HTPM hTPM, UINT32 ulPcrIndex, UINT32* pulPcrValueLength, BYTE** prgbPcrValue); Description Tspi_TPM_PcrRead reads a PCR register to find the current values. Parameters hTPM The hTPM parameter…

TCG Software Stack Developer’s Reference Name Tspi_TPM_PcrExtend – extend a PCR register and optionally write the PCR event log. Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_PcrExtend(TSS_HTPM hTPM, UINT32 ulPcrIndex, UINT32 ulPcrDataLength, BYTE* pbPcrData, TSS_PCR_EVENT* pPcrEvent, UINT32* pulPcrValueLength, BYTE** prgbPcrValue); Description Tspi_TPM_PcrExtend extends a PCR register…

TCG Software Stack Developer’s Reference Name Tspi_TPM_OwnerGetSRKPubKey – get public key of the SRK Synopsis #include <tss/tspi.h> TSS_RESULT Tspi_TPM_OwnerGetSRKPubKey(TSS_HTPM hTPM, UINT32* pulPubKeyLength, BYTE** prgbPubKey); Description Tspi_TPM_OwnerGetSRKPubKey returns the public key of the key object using owner authorization. This can only be used on 1.2 TPMs, and only to return the public key of the SRK….

TCG Software Stack Developer’s Reference Name Tspi_TPM_LoadMaintenancePubKey- load the public maintenance key into the TPM Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_LoadMaintenancePubKey(TSS_HTPM hTPM, TSS_HKEY hMaintenanceKey, TSS_VALIDATION* pValidationData); Description Tspi_TPM_LoadMaintenancePubKey loads the public maintenance key into the TPM. The maintenance key can only be loaded once;…

TCG Software Stack Developer’s Reference Name Tspi_TPM_KillMaintenanceFeature – Disables the ability to create a maintenance archive Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_KillMaintenanceFeature(TSS_HTPM hTPM); Description Tspi_TPM_KillMaintenanceFeature disables the functionality of creating a maintenance archive. This feature is not yet implemented. Parameters hTPM The hTPM parameter…

Tspi_TPM_GetTestResult- get manufacturer specific information regarding the results of a self test. Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_GetTestResult(TSS_HTPM hTPM, UINT32* pulTestResultLength, BYTE** prgbTestResult); Description Tspi_TPM_GetTestResult is provided by a manufacturer of a TPM to provide manufacturer specific self test results. Parameters hTPM Handle of…

TCG Software Stack Developer’s Reference Name Tspi_TPM_GetStatus – query the TPM’s status Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_GetStatus(TSS_HTPM hTPM, TSS_FLAG statusFlag, BOOL* pfTpmState); Description Tspi_TPM_GetStatus queries the status of the TPM, returning a specific status based on the flags specified. This command is not…

TCG Software Stack Developer’s Reference Name Tspi_TPM_GetRandom – generate a random number on the TPM Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_GetRandom(TSS_HTPM hTPM, UINT32 size, BYTE** random); Description Tspi_TPM_GetRandom gets a good random number for the purpose of generating symmetric keys, nonces, or seeding a…

TCG Software Stack Developer’s Reference Name Tspi_TPM_GetPubEndorsementKey – create a TSS key object from the TPM’s public endorsement key Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_GetPubEndorsementKey(TSS_HTPM hTPM, TSS_BOOL fOwnerAuthorized, TSS_VALIDATION* pValidationData, TSS_HKEY* phEndorsementPubKey); Description Tspi_TPM_GetPubEndorsementKey This function retrieves the public endorsement key (PubEK) from the…

Tspi_TPM_GetEvents- get a specific number of PCR events for a given index. Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_GetEvents(TSS_HTPM hTPM, UINT32 ulPcrIndex, UINT32 ulStartNumber, UINT32* pulEventNumber, TSS_PCR_EVENT* prgbPcrEvents); Description Tspi_TPM_GetEvents provides a specific number of PCR events for a given index. Parameters hTPM Handle of…

Tspi_TPM_GetEventLog- get the entire PCR event log. Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_GetEventLog(TSS_HTPM hTPM, UINT32* pulEventNumber, TSS_PCR_EVENT** prgPcrEvents); Description Tspi_TPM_GetEventLog provides the whole event log that was used to create all of the PCRs. Parameters hTPM Handle of the TPM object. pulEventNumber Receives number…

Tspi_TPM_GetEvent- get a PCR event for a given PCR index and event number. Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_GetEvent(TSS_HTPM hTPM, UINT32 ulPcrIndex, UINT32 ulEventNumber, TSS_PCR_EVENT* pPcrEvent); Description Tspi_TPM_GetEvent provides a PCR event for a given PCR index and event number. Parameters hTPM Handle of…

TCG Software Stack Developer’s Reference Name Tspi_TPM_GetCapability – get information on the capabilities of the TPM Synopsis #include <tss/platform.h> #include <tss/tcpa_defines.h> #include <tss/tcpa_typedef.h> #include <tss/tcpa_struct.h> #include <tss/tss_typedef.h> #include <tss/tss_structs.h> #include <tss/tspi.h> TSS_RESULT Tspi_TPM_GetCapability(TSS_HTPM hTPM, TSS_FLAG capArea, UINT32 ulSubCapLength, BYTE* rgbSubCap, UINT32* pulRespDataLength, BYTE** prgbRespData); Description Tspi_TPM_GetCapability gets information on various capabilities of the TPM. This…

Tspi_TPM_GetAuditDigest – retrieve the audit digest. Synopsis #include <tss/tspi.h> TSS_RESULT Tspi_TPM_GetAuditDigest(TSS_HTPM hTpm, TSS_HKEY hKey, TSS_BOOL closeAudit, UINT32* pulAuditDigestSize, BYTE** prgbAuditDigest, TPM_COUNTER_VALUE* pCounterValue, TSS_VALIDATION* pValidationData, UINT32* ordSize, UINT32** ordList); Description Tspi_TPM_GetAuditDigest is used to retrieve the audit digest. The audit digest may be signed or unsigned. If the audit digest is signed (hKey is non-NULL) then…