Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

tspi_tpm_getauditdigest(3) [centos man page]

Tspi_TPM_GetAuditDigest(3)			     TCG Software Stack Developer's Reference				Tspi_TPM_GetAuditDigest(3)

NAME
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 the current audit digest, the current audit counter and, optionally, the hash of the audited ordinal list and a signature are returned. If the audit digest is not signed (hKey is NULL) then the current audit digest, the current audit counter and the full list of audited ordinals is returned. PARAMETERS
hTpm Handle of the TPM object. hKey Handle of the signature key object (the handle can be NULL). closeAudit A flag indicating whether or not to close the current audit digest after it is signed. This parameter is ignored if hKey is NULL. pulAuditDigestSize Pointer to the size of the returned audit digest. prgbAuditDigest Pointer to a buffer that holds the returned audit digest. pCounterValue Pointer to a TPM_COUNTER_VALUE structure that holds the returned audit counter. pValidationData Pointer to a validation data structure. The validation data structure provides external information required to compute the signature. On input, the fields representing the ExternalData must contain an anti-replay nonce that will be used in the signing operation. On output, this structure provides a buffer containing the data used to compute the validation data and a buffer containing the validation data (a signature generated by signing the data using the key referenced by hKey). If this parameter is NULL then the TSS will perform the valida- tion. This parameter is ignored if hKey is NULL. ordSize Pointer to the number of ordinals in the returned audited ordinal list. This parameter is ignored if hKey is non-NULL. ordList Pointer to a buffer that holds the returned audited ordinal list. This parameter is ignored if hKey is non-NULL. RETURN CODES
Tspi_TPM_GetAuditDigest returns TSS_SUCCESS on success, otherwise one of the following values are returned: TSS_E_INVALID_HANDLE TSS_E_BAD_PARAMETER TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS. CONFORMING TO
Tspi_TPM_GetAuditDigest conforms to the Trusted Computing Group Software Specification Version 1.2 TSS 1.2 2007-06-27 Tspi_TPM_GetAuditDigest(3)

Check Out this Related Man Page

Tspi_Key_WrapKey(3)				     TCG Software Stack Developer's Reference				       Tspi_Key_WrapKey(3)

NAME
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), the created key blob is bound to its PCR values. The key object addressed by hKey must contain the key information needed for the creation. On successful return from this call, hKey can be loaded into a TPM. hKey must have been created as a migratable key and should have its usage and migrations secrets set using Tspi_Policy_SetSecret(3). Also, hKey should have had its private key set to either RSA private component, p or q. PARAMETERS
hKey The handle of the key object that is wrapped. hWrappingKey The handle to the key used to wrap the newly created key. hPcrComposite The handle to an object, if the value of the handle doesn't equal NULL, the newly create key will be bound ot the PCR values described with this object. RETURN CODES
Tspi_Key_WrapKey returns TSS_SUCCESS on success, otherwise one of the following values are returned: TSS_E_INVALID_HANDLE - Either hKey, hWrappingKey or hPcrComposite are invalid handles. TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS. CONFORMING TO
Tspi_Key_WrapKey conforms to the Trusted Computing Group Software Specification version 1.1 Golden SEE ALSO
Tspi_Key_CreateKey(3), Tspi_Key_CertifyKey(3), Tspi_Key_RegisterKey(3). TSS 1.1 2004-05-26 Tspi_Key_WrapKey(3)
Man Page