SysTutorials Posts

TCG Software Stack Developer’s Reference Name Tspi_TPM_DirWrite – write to a Data Integrity 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_DirWrite(TSS_HTPM hTPM, UINT32 ulDirIndex, UINT32 ulDirDataLength, BYTE* rgbDirData); Description Tspi_TPM_DirWrite writes a data integrity register. You need to know the DIR index and data you…

TCG Software Stack Developer’s Reference Name Tspi_TPM_DirRead – Read a Data Integrity 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_DirRead(TSS_HTPM hTPM, UINT32 ulDirIndex, UINT32* pulDirDataLength, BYTE** prgbDirData); Description Tspi_TPM_DirRead reads a data integrity register. DIRs are non-volatile (persistent across reboots) memory areas maintained by the…

TCG Software Stack Developer’s Reference Name Tspi_TPM_CreateMaintenanceArchive – create the TPM manufacturer specific maintenance archive data. 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_CreateMaintenanceArchive(TSS_HTPM hTPM, TSS_BOOL fGenerateRndNumber, UINT32* pulRndNumberLength, BYTE** prgbRndNumber, UINT32* pulArchiveDataLength, BYTE** prgbArchiveData); Description Tspi_TPM_CreateMaintenanceArchive creates the TPM Manufacturer specific maintenance archive data. This…

TCG Software Stack Developer’s Reference Name Tspi_TPM_CreateEndorsementKey – create the 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_CreateEndorsementKey(TSS_HTPM hTPM, TSS_HKEY hKey, TSS_VALIDATION* pValidationData); Description Tspi_TPM_CreateEndorsementKey creates an endorsement key. This function is currently not implemented. Before this method is called, the key information for…

Tspi_TPM_CollateIdentityRequest – Gets all the informatin necessary to send to a trusted third party (TTP), repartory to asking the TTP to create a certificate for identity. 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_CollateIdentityRequest(TSS_HTPM hTPM, TSS_HKEY hKeySRK, TSS_HKEY hCAPPubKey, UINT32 ulIdentityLabelData, BYTE* rgbIdentityLabelData, TSS_HKEY hIdentityKey, TSS_ALGORITHM_ID…

TCG Software Stack Developer’s Reference Name Tspi_TPM_ClearOwner – clear TPM ownership 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_ClearOwner(TSS_HTPM hTPM, TSS_BOOL fForcedClear); Description Tspi_TPM_ClearOwner wipes the TPM of everything but its endorsement key. It will wipe the SRK, so anything locked to the SRK will also…

TCG Software Stack Developer’s Reference Name Tspi_TPM_CheckMaintenancePubKey- check the public maintenance 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_CheckMaintenancePubKey(TSS_HTPM hTPM, TSS_HKEY hMaintenanceKey, TSS_VALIDATION* pValidationData); Description Tspi_TPM_CheckMaintenancePubKey checks the public maintenance key. If hMaintenanceKey is NULL, then pValidationData must not be NULL; the caller has to…

Tspi_TPM_CertifySelfTest- have the TPM sign its self test data 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_CertifySelfTest(TSS_HTPM hTPM, TSS_HKEY hKey, TSS_VALIDATION* pValidationData ); Description Tspi_TPM_CertifySelfTest performs a self-test of each internal TPM function and returns an authenticated value (signature) if the test has passed. Parameters hTPM…

TCG Software Stack Developer’s Reference Name Tspi_TPM_CMKSetRestrictions – set restrictions on use of delegated Certified Migratable Keys Synopsis #include <tss/tspi.h> TSS_RESULT Tspi_TPM_CMKSetRestrictions(TSS_HTPM hTPM, TSS_CMK_DELEGATE CmkDelegate); Description Tspi_TPM_CMKSetRestrictions is used to set restrictions on the delegated use of Certified Migratable Keys (CMKs). Use of this command cannot itself be delegated. Parameters hTPM The hTPM parameter is…

Tspi_TPM_AuthorizeMigrationTicket- create the migration ticket required for the migration process. 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_AuthorizeMigrationTicket(TSS_HTPM hTPM, TSS_HKEY hMigrationKey, TSS_MIGRATE_SCHEME migrationScheme, UINT32* pulMigTicketLength, BYTE** prgbMigTicket); Description Tspi_TPM_AuthorizeMigrationTicket is used by the owner to authorize a target public key for migration. This mean sthat when…

TCG Software Stack Developers Reference Name Tspi_SetAttribUint32 – set a 32bit attribute associated with a given class or object 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_SetAttribUint32(TSS_HOBJECT hObject, TSS_FLAG attribFlag, TSS_FLAG subFlag, UINT32 ulAttrib); Description Tspi_SetAttribUint32 sets a uint32 attribute associated with a given class or…

Tspi_SetAttribData – set a non 32bit attribute of an object. 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_SetAttribData(TSS_HOBJECT hObject, TSS_FLAG attribFlag, TSS_FLAG subFlag, UINT32 ulAttribDataSize, BYTE* rgbAttribData); Description Tspi_SetAttribData sets the attributes associated with a given class of object that aren’t UINT32. The structure and size…

Tspi_Policy_SetSecret – set the authorization data of a policy object and define the handling of its retrieval 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_Policy_SetSecret(TSS_HPOLICY hPolicy, TSS_FLAG secretMode, UINT32 ulSecretLength, BYTE* rgbSecret); Description TSS_Policy_SetSecret sets the authorization data for an object. This mthod also defines the…

TCG Software Stack Developers Reference Name Tspi_Policy_FlushSecret – flush a cached secret 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_Policy_FlushSecret(TSS_HPOLICY hPolicy); Description Tspi_Policy_FlushSecret tells the TSS to flush a secret that it had cached for a user. Parameters hPolicy The hPolicy parameter is the handle of…

TCG Software Stack Developers Reference Name Tspi_Policy_AssignToObject – assign a policy to an object 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_Policy_AssignToObject(TSS_HPOLICY hPolicy, TSS_HOBJECT hObject); Description Tspi_Policy_AssignToObject assigns a given object to a certain policy. The object then uses its assigned policy to process an authorized…

Tspi_PcrComposite_SetPcrValue- set the digest for a given PCR index inside a PCR composite object. 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_PcrComposite_SetPcrValue(TSS_HPCRS hPcrComposite, UINT32 ulPcrIndex, UINT32 ulPcrValueLength, BYTE* rgbPcrValue); Description Tspi_PcrComposite_SetPcrValue sets the digest for a given PCR index inside the PCR composite object. Parameters hPcrComposite…

Tspi_PcrComposite_SelectPcrIndex- select a PCR index inside a PCR composite object. 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_PcrComposite_SelectPcrIndex(TSS_HPCRS hPcrComposite, UINT32 ulPcrIndex); Description Tspi_PcrComposite_SelectPcrIndex selects a PCR index inside a PCR composite object. The PCR composite object must be created withthe function Tspi_Context_CreateObject(). An exampled for the…

Tspi_PcrComposite_GetPcrValue – get the digest value of a given PCR index inside a PCR composite object. 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_PcrComposite_GetPcrValue(TSS_HPCRS hPcrComposite, UINT32 ulPcrIndex, UINT32* ulPcrValueLength, BYTE** rgbPcrValue); Description Tspi_PcrComposite_GetPcrValue returns the digest value of a given PCR index inside a PCR composite…

Tspi_Key_WrapKey – wrap a key with the key addressed by hWrappingKey. 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_Key_WrapKey(TSS_HKEY hKey, TSS_HKEY hWrappingKey, TSS_HPCRS hPcrComposite); Description TSS_Key_WrapKey wraps the private key hKey using the public key addressed by hWrappingKey. If hPcrComposite is not set to NULL (0),…

TCG Software Stack Developer’s Reference Name Tspi_Key_UnloadKey – unload a key from 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_Key_UnloadKey(TSS_HKEY hKey); Description Tspi_Key_UnloadKey unloads the key referenced by the given key object from the TPM. This call will result in a TPM_EvictKey operation for…