DragonFly On-Line Manual Pages

Search: Section:  

Tspi_TPM_GetAuditDigest(3)            TCG Software Stack Developer's Reference


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
       validation.  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)

Search: Section: