Esys_SetCo...uditStatus(3)

🌸 NAME 🌸

Esys_SetCommandCodeAuditStatus — The ESAPI function for the TPM2_SetCommandCodeAuditStatus command. This page is Esys_SetCo...uditStatus(3) from the tpm2-tss Library Functions Manual, bestie. 💖

✨ SYNOPSIS ✨

🧚 Functions 🧚

TSS2_RC Esys_SetCommandCodeAuditStatus_Async (ESYS_CONTEXT *esysContext,
    ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPMI_ALG_HASH auditAlg, const TPML_CC *setList, const TPML_CC
    *clearList)
TSS2_RC Esys_SetCommandCodeAuditStatus (ESYS_CONTEXT *esysContext,
    ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPMI_ALG_HASH auditAlg, const TPML_CC *setList, const TPML_CC
    *clearList)
TSS2_RC Esys_SetCommandCodeAuditStatus_Finish (ESYS_CONTEXT
    *esysContext)

💅 Detailed Description 💅

It’s the ESAPI function that invokes the TPM2_SetCommandCodeAuditStatus command either as a one-call girly or in an asynchronous manner. Slay. ✨

🎀 Function Documentation 🎀

🫶 TSS2_RC Esys_SetCommandCodeAuditStatus — the one-call cutie 🫶

TSS2_RC Esys_SetCommandCodeAuditStatus (ESYS_CONTEXT * esysContext, ESYS_TR
    auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPMI_ALG_HASH auditAlg, const TPML_CC * setList, const TPML_CC *
    clearList)

One-Call function for TPM2_SetCommandCodeAuditStatus. This function invokes the TPM2_SetCommandCodeAuditStatus 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. Iconic behavior, honestly. 💅

💖 Parameters 💖

• esysContext — The ESYS_CONTEXT.
• auth — TPM2_RH_OWNER or TPM2_RH_PLATFORM+{PP}.
• shandle1 — Session handle for authorization of auth
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• auditAlg — TPM2_Hash algorithm for the audit digest; if TPM2_ALG_NULL, then the hash is not changed.
• setList — List of commands that will be added to those that will be audited.
• clearList — List of commands that will no longer be audited.

🌈 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_ESYS_RC_NO_DECRYPT_PARAM — if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter.
• TSS2_ESYS_RC_NO_ENCRYPT_PARAM — if one of the sessions has the 'encrypt' attribute set and the command does not support encryption of the first response parameter.
• TSS2_RCs — produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🦋 TSS2_RC Esys_SetCommandCodeAuditStatus_Async — async icon 🦋

TSS2_RC Esys_SetCommandCodeAuditStatus_Async (ESYS_CONTEXT * esysContext,
    ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPMI_ALG_HASH auditAlg, const TPML_CC * setList, const TPML_CC *
    clearList)

Asynchronous function for TPM2_SetCommandCodeAuditStatus. This function invokes the TPM2_SetCommandCodeAuditStatus command in a 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_SetCommandCodeAuditStatus_Finish. No cap, that’s the whole vibe. 🦋

💖 Parameters 💖

• esysContext — The ESYS_CONTEXT.
• auth — TPM2_RH_OWNER or TPM2_RH_PLATFORM+{PP}.
• shandle1 — Session handle for authorization of auth
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• auditAlg — TPM2_Hash algorithm for the audit digest; if TPM2_ALG_NULL, then the hash is not changed.
• setList — List of commands that will be added to those that will be audited.
• clearList — List of commands that will no longer be audited.

🌈 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_ESYS_RC_NO_DECRYPT_PARAM — if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter.
• TSS2_ESYS_RC_NO_ENCRYPT_PARAM — if one of the sessions has the 'encrypt' attribute set and the command does not support encryption of the first response parameter.

🧚 TSS2_RC Esys_SetCommandCodeAuditStatus_Finish — finish-line fairy 🧚

TSS2_RC Esys_SetCommandCodeAuditStatus_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_SetCommandCodeAuditStatus. This function returns the results of a TPM2_SetCommandCodeAuditStatus command invoked via Esys_SetCommandCodeAuditStatus_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. Periodt. 💜

💖 Parameters 💖

• esysContext — The ESYS_CONTEXT.

🌈 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.

---

Cute sign-off: source is tpm2-tss, version is Version 4.1.5, and the footer didn’t include a date — so we’re not inventing one, bestie. Esys_SetCo...uditStatus(3) out. 💅✨