1Tspi_TPM_GetAuditDigTeCsGt(S3o)ftware Stack Developer's RefTesrpein_cTePM_GetAuditDigest(3)
2
3
4

NAME

6       Tspi_TPM_GetAuditDigest - retrieve the audit digest.
7

SYNOPSIS

9       #include <tss/tspi.h>
10
11       TSS_RESULT Tspi_TPM_GetAuditDigest(TSS_HTPM        hTpm,            TSS_HKEY           hKey,
12                                          TSS_BOOL        closeAudit,      UINT32*            pulAuditDigestSize,
13                                          BYTE**          prgbAuditDigest, TPM_COUNTER_VALUE* pCounterValue,
14                                          TSS_VALIDATION* pValidationData, UINT32*            ordSize,
15                                          UINT32**        ordList);
16
17
18

DESCRIPTION

20       Tspi_TPM_GetAuditDigest  is used to retrieve the audit digest.  The au‐
21       dit digest may be signed or unsigned.  If the audit  digest  is  signed
22       (hKey  is  non-NULL)  then  the current audit digest, the current audit
23       counter and, optionally, the hash of the audited  ordinal  list  and  a
24       signature  are  returned.   If  the audit digest is not signed (hKey is
25       NULL) then the current audit digest, the current audit counter and  the
26       full list of audited ordinals is returned.
27

PARAMETERS

29   hTpm
30       Handle of the TPM object.
31
32   hKey
33       Handle of the signature key object (the handle can be NULL).
34
35   closeAudit
36       A  flag indicating whether or not to close the current audit digest af‐
37       ter it is signed.  This parameter is ignored if hKey is NULL.
38
39   pulAuditDigestSize
40       Pointer to the size of the returned audit digest.
41
42   prgbAuditDigest
43       Pointer to a buffer that holds the returned audit digest.
44
45   pCounterValue
46       Pointer to a TPM_COUNTER_VALUE structure that holds the returned  audit
47       counter.
48
49   pValidationData
50       Pointer  to a validation data structure.  The validation data structure
51       provides external information required to compute  the  signature.   On
52       input,  the  fields representing the ExternalData must contain an anti-
53       replay nonce that will be used in the signing  operation.   On  output,
54       this  structure  provides  a buffer containing the data used to compute
55       the validation data and a buffer containing the validation data (a sig‐
56       nature generated by signing the data using the key referenced by hKey).
57       If this parameter is NULL then the TSS  will  perform  the  validation.
58       This parameter is ignored if hKey is NULL.
59
60   ordSize
61       Pointer to the number of ordinals in the returned audited ordinal list.
62       This parameter is ignored if hKey is non-NULL.
63
64   ordList
65       Pointer to a buffer that holds the returned audited ordinal list.  This
66       parameter is ignored if hKey is non-NULL.
67

RETURN CODES

69       Tspi_TPM_GetAuditDigest  returns  TSS_SUCCESS on success, otherwise one
70       of the following values are returned:
71
72       TSS_E_INVALID_HANDLE
73
74       TSS_E_BAD_PARAMETER
75
76       TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.
77

CONFORMING TO

79       Tspi_TPM_GetAuditDigest conforms to the Trusted Computing  Group  Soft‐
80       ware Specification Version 1.2
81
82
83
84
85
86
87TSS 1.2                           2007-06-27        Tspi_TPM_GetAuditDigest(3)
Impressum