Esys_GetSe...uditDigest(3)

💅 Esys_GetSessionAuditDigest(3) — Library Functions Manual, bestie

okay so welcome to the library functions manual corner for Esys_GetSessionAuditDigest(3) — yes, that manual name is folded in right here, cute and cozy.

🌸 NAME 🌸

Esys_GetSessionAuditDigest — the ESAPI function for the TPM2_GetSessionAuditDigest command. periodt 💅

✨ SYNOPSIS ✨

functions, functions, functions:

TSS2_RC Esys_GetSessionAuditDigest_Async (ESYS_CONTEXT *esysContext,
    ESYS_TR privacyAdminHandle, ESYS_TR signHandle, ESYS_TR
    sessionHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme)
TSS2_RC Esys_GetSessionAuditDigest (ESYS_CONTEXT *esysContext, ESYS_TR
    privacyAdminHandle, ESYS_TR signHandle, ESYS_TR sessionHandle,
    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_GetSessionAuditDigest_Finish (ESYS_CONTEXT *esysContext,
    TPM2B_ATTEST **auditInfo, TPMT_SIGNATURE **signature)

🦋 Detailed Description 🦋

okay so this is the ESAPI function to invoke the TPM2_GetSessionAuditDigest command either as a one-call or in an asynchronous manner. Both vibes, same command, no cap. 🫶

💖 Function Documentation 💖

💅 TSS2_RC Esys_GetSessionAuditDigest

TSS2_RC Esys_GetSessionAuditDigest (ESYS_CONTEXT * esysContext, ESYS_TR
       privacyAdminHandle, ESYS_TR signHandle, ESYS_TR sessionHandle, 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_GetSessionAuditDigest. Iconic. ✨

This function invokes the TPM2_GetSessionAuditDigest 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.
• privacyAdminHandle — TPM2_Handle of the privacy administrator (TPM2_RH_ENDORSEMENT).
• signHandle — Handle of the signing key.
• sessionHandle — Handle of the audit session.
• shandle1 — Session handle for authorization of privacyAdminHandle.
• shandle2 — Session handle for authorization of signHandle.
• shandle3 — Third session handle.
• qualifyingData — User-provided qualifying data — may be zero-length.
• inScheme — TPM2_Signing scheme to use if the scheme for signHandle is TPM2_ALG_NULL.
• auditInfo — The audit information 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_GetSessionAuditDigest_Async

TSS2_RC Esys_GetSessionAuditDigest_Async (ESYS_CONTEXT * esysContext,
       ESYS_TR privacyAdminHandle, ESYS_TR signHandle, ESYS_TR sessionHandle,
       ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *
       qualifyingData, const TPMT_SIG_SCHEME * inScheme)

Asynchronous function for TPM2_GetSessionAuditDigest. She sends it and dips, lowkey. 🦋

This function invokes the TPM2_GetSessionAuditDigest 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_GetSessionAuditDigest_Finish.

🎀 Parameters 🎀

• esysContext — The ESYS_CONTEXT.
• privacyAdminHandle — TPM2_Handle of the privacy administrator (TPM2_RH_ENDORSEMENT).
• signHandle — Handle of the signing key.
• sessionHandle — Handle of the audit session.
• shandle1 — Session handle for authorization of privacyAdminHandle.
• shandle2 — Session handle for authorization of signHandle.
• shandle3 — Third session handle.
• qualifyingData — User-provided qualifying data — may be zero-length.
• 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_GetSessionAuditDigest_Finish

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

Asynchronous finish function for TPM2_GetSessionAuditDigest. This is where the TPM tea gets picked up. 🫶

This function returns the results of a TPM2_GetSessionAuditDigest command invoked via Esys_GetSessionAuditDigest_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.

🎀 Parameters 🎀

• esysContext — The ESYS_CONTEXT.
• auditInfo — The audit information 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. Not me writing this by hand, bestie — Doxygen said it first. 😭

---

Footer sign-off tea: source/version is tpm2-tss, Version 4.1.5. The footer doesn't print a date, so I'm not inventing one — fr fr, no cap. Bye bestie! 💖🎀🦋