Esys_GetCo...uditDigest(3)

okay bestie, welcome to the Library Functions Manual page for Esys_GetCommandAuditDigest(3) from tpm2-tss — the header abbreviates it as Esys_GetCo...uditDigest(3) but we're using the full name because we're not cowards. this page is all about invoking TPM2_GetCommandAuditDigest and it's lowkey iconic.

✨ NAME ✨

Esys_GetCommandAuditDigest — the ESAPI function for the TPM2_GetCommandAuditDigest command. literally what it says on the tin, no cap.

🌸 SYNOPSIS 🌸

🧸 Functions 🧸

TSS2_RC Esys_GetCommandAuditDigest_Async (ESYS_CONTEXT *esysContext,
    ESYS_TR privacyHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR
    shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const
    TPMT_SIG_SCHEME *inScheme)
TSS2_RC Esys_GetCommandAuditDigest (ESYS_CONTEXT *esysContext, ESYS_TR
    privacyHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const
    TPMT_SIG_SCHEME *inScheme, TPM2B_ATTEST **auditInfo, TPMT_SIGNATURE
    **signature)
TSS2_RC Esys_GetCommandAuditDigest_Finish (ESYS_CONTEXT *esysContext,
    TPM2B_ATTEST **auditInfo, TPMT_SIGNATURE **signature)

🦋 Detailed Description 🦋

ESAPI function to invoke the TPM2_GetCommandAuditDigest command either as a one-call or in an asynchronous manner. two modes, both valid, pick your fighter 💅

💜 Function Documentation 💜

🌟 TSS2_RC Esys_GetCommandAuditDigest (...) 🌟

TSS2_RC Esys_GetCommandAuditDigest (ESYS_CONTEXT * esysContext, ESYS_TR
    privacyHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_DATA * qualifyingData, const
    TPMT_SIG_SCHEME * inScheme, TPM2B_ATTEST ** auditInfo, TPMT_SIGNATURE **
    signature)

One-Call function for TPM2_GetCommandAuditDigest

This function invokes the TPM2_GetCommandAuditDigest command in a one-call variant. This means the function will block until the TPM response is available. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation.

💖 Parameters 💖

• esysContext — The ESYS_CONTEXT.
• privacyHandle — TPM2_Handle of the privacy administrator (TPM2_RH_ENDORSEMENT).
• signHandle — The handle of the signing key.
• shandle1 — Session handle for authorization of privacyHandle
• shandle2 — Session handle for authorization of signHandle
• shandle3 — Third session handle.
• qualifyingData — Other data to associate with this audit digest.
• inScheme — TPM2_Signing scheme to use if the scheme for signHandle is TPM2_ALG_NULL.
• auditInfo — The auditInfo that was signed. (callee-allocated)
• signature — The signature over auditInfo. (callee-allocated)

🔥 Return values 🔥

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_ESYS_RC_BAD_REFERENCE — if the esysContext or required input pointers or required output handle references are NULL.
• TSS2_ESYS_RC_BAD_CONTEXT — if esysContext corruption is detected.
• TSS2_ESYS_RC_MEMORY — if the ESAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_ESYS_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_ESYS_RC_INSUFFICIENT_RESPONSE — if the TPM's response does not at least contain the tag, response length, and response code.
• TSS2_ESYS_RC_MALFORMED_RESPONSE — if the TPM's response is corrupted.
• TSS2_ESYS_RC_RSP_AUTH_FAILED — if the response HMAC from the TPM did not verify.
• TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS — if more than one session has the 'decrypt' attribute bit set.
• TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS — if more than one session has the 'encrypt' attribute bit set.
• TSS2_ESYS_RC_BAD_TR — if any of the ESYS_TR objects are unknown to the ESYS_CONTEXT or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE.
• TSS2_RCs — produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🌈 TSS2_RC Esys_GetCommandAuditDigest_Async (...) 🌈

TSS2_RC Esys_GetCommandAuditDigest_Async (ESYS_CONTEXT * esysContext,
    ESYS_TR privacyHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR
    shandle2, ESYS_TR shandle3, const TPM2B_DATA * qualifyingData, const
    TPMT_SIG_SCHEME * inScheme)

Asynchronous function for TPM2_GetCommandAuditDigest

This function invokes the TPM2_GetCommandAuditDigest command in an asynchronous variant. This means the function will return as soon as the command has been sent downwards the stack to the TPM. All input parameters are const. In order to retrieve the TPM's response call Esys_GetCommandAuditDigest_Finish.

bestie, this one is the "send it and dip" version — you must come back with Esys_GetCommandAuditDigest_Finish to actually get the response 💫

💖 Parameters 💖

• esysContext — The ESYS_CONTEXT.
• privacyHandle — TPM2_Handle of the privacy administrator (TPM2_RH_ENDORSEMENT).
• signHandle — The handle of the signing key.
• shandle1 — Session handle for authorization of privacyHandle
• shandle2 — Session handle for authorization of signHandle
• shandle3 — Third session handle.
• qualifyingData — Other data to associate with this audit digest.
• inScheme — TPM2_Signing scheme to use if the scheme for signHandle is TPM2_ALG_NULL.

🔥 Return values 🔥

• ESYS_RC_SUCCESS — if the function call was a success.
• TSS2_ESYS_RC_BAD_REFERENCE — if the esysContext or required input pointers or required output handle references are NULL.
• TSS2_ESYS_RC_BAD_CONTEXT — if esysContext corruption is detected.
• TSS2_ESYS_RC_MEMORY — if the ESAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_RCs — produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.
• TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS — if more than one session has the 'decrypt' attribute bit set.
• TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS — if more than one session has the 'encrypt' attribute bit set.
• TSS2_ESYS_RC_BAD_TR — if any of the ESYS_TR objects are unknown to the ESYS_CONTEXT or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE.

🫶 TSS2_RC Esys_GetCommandAuditDigest_Finish (...) 🫶

TSS2_RC Esys_GetCommandAuditDigest_Finish (ESYS_CONTEXT * esysContext,
    TPM2B_ATTEST ** auditInfo, TPMT_SIGNATURE ** signature)

Asynchronous finish function for TPM2_GetCommandAuditDigest

This function returns the results of a TPM2_GetCommandAuditDigest command invoked via Esys_GetCommandAuditDigest_Finish. All non-simple output parameters are allocated by the function's implementation. NULL can be passed for every output parameter if the value is not required.

cute lil shortcut: if you don't need an output, pass NULL and keep it moving ✨

💖 Parameters 💖

• esysContext — The ESYS_CONTEXT.
• auditInfo — The auditInfo that was signed. (callee-allocated)
• signature — The signature over auditInfo. (callee-allocated)

🔥 Return values 🔥

• TSS2_RC_SUCCESS — on success
• ESYS_RC_SUCCESS — if the function call was a success.
• TSS2_ESYS_RC_BAD_REFERENCE — if the esysContext or required input pointers or required output handle references are NULL.
• TSS2_ESYS_RC_BAD_CONTEXT — if esysContext corruption is detected.
• TSS2_ESYS_RC_MEMORY — if the ESAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_ESYS_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_ESYS_RC_TRY_AGAIN — if the timeout counter expires before the TPM response is received.
• TSS2_ESYS_RC_INSUFFICIENT_RESPONSE — if the TPM's response does not at least contain the tag, response length, and response code.
• TSS2_ESYS_RC_RSP_AUTH_FAILED — if the response HMAC from the TPM did not verify.
• TSS2_ESYS_RC_MALFORMED_RESPONSE — if the TPM's response is corrupted.
• TSS2_RCs — produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

👑 Author 👑

Generated automatically by Doxygen for tpm2-tss from the source code. so yeah, the robots made this one 🤖✨

---

okay that's the whole page bestie 💅 this came from tpm2-tss, version 4.1.5 — and the footer didn't hand me a date, so I'm not gonna invent one, periodt. stay audited 🫶