TSPI_TPM_GETAUDITDIGEST(3)

✨ Tspi_TPM_GetAuditDigest ✨

okay bestie, welcome to the Tspi_T...tDigest(3) page 💖 this one lives in the TCG Software Stack Developer's Reference, and it's literally all about pulling up your audit digest. no cap.

🌸 NAME 🌸

Tspi_TPM_GetAuditDigest — retrieve the audit digest. that's it. that's the whole job. 💅

🦋 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);

look at all those params, she's serving main character energy fr fr 😭

🎀 DESCRIPTION 🎀

so like, Tspi_TPM_GetAuditDigest is the function you call to retrieve the audit digest. and here's the tea: the audit digest may be signed or unsigned — it's giving two very different moods.

• if the audit digest is signed (meaning hKey is non-NULL 👑) then you get back the current audit digest, the current audit counter and, optionally, the hash of the audited ordinal list plus a signature.
• if the audit digest is not signed (meaning hKey is NULL 🙈) then you get back the current audit digest, the current audit counter and the full list of audited ordinals.

either way you're eating good. ⭐

💜 PARAMETERS 💜

🌈 hTpm

handle of the TPM object. your TPM bestie. 🫶

🎀 hKey

handle of the signature key object (the handle can be NULL). yes, NULL is allowed, she's flexible like that.

💅 closeAudit

a flag indicating whether or not to close the current audit digest after it is signed. ⚠️ heads up: this parameter is ignored if hKey is NULL.

✨ pulAuditDigestSize

pointer to the size of the returned audit digest. just the size, bestie, the receipts come next.

🦋 prgbAuditDigest

pointer to a buffer that holds the returned audit digest. this is where the actual digest lives 🍓

🌸 pCounterValue

pointer to a TPM_COUNTER_VALUE structure that holds the returned audit counter. iconic little struct.

🔥 pValidationData

pointer to a validation data structure. okay so this one is lowkey the most involved — the validation data structure provides external information required to compute the signature. let's break it down:

• 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). 🔐

and if this parameter is NULL then the TSS will perform the validation for you. 🫡 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. 💀 not the internal error, we hate to see it

👑 CONFORMING TO 👑

Tspi_TPM_GetAuditDigest conforms to the Trusted Computing Group Software Specification Version 1.2. certified, compliant, slay. periodt. 💖

and that's the whole page bestie!! this was TSS 1.2, dated 2007-06-27 — yeah she's an elder icon but she still hits 🎀 go get those audit digests, mwah 💋✨