Esys_ContextSave(3)

💅 NAME 💅

Esys_ContextSave — the ESAPI function for the TPM2_ContextSave command. Also hi bestie, this is Esys_ContextSave(3) from the Library Functions Manual, and we’re gonna get you comfy with it. ✨

---

🎀 SYNOPSIS 🎀

🦋 Functions 🦋

TSS2_RC Esys_ContextSave_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    saveHandle)
TSS2_RC Esys_ContextSave (ESYS_CONTEXT *esysContext, ESYS_TR saveHandle,
    TPMS_CONTEXT **context)
TSS2_RC Esys_ContextSave_Finish (ESYS_CONTEXT *esysContext, TPMS_CONTEXT
    **context)

---

🦋 Detailed Description 🦋

It’s giving ESAPI function to invoke the TPM2_ContextSave command either as a one-call or in an asynchronous manner. Choose your fighter. 💖

---

👑 Function Documentation 👑

💖 TSS2_RC Esys_ContextSave (ESYS_CONTEXT * esysContext, ESYS_TR saveHandle, TPMS_CONTEXT ** context) 💖

One-Call function for TPM2_ContextSave 🫶

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

🌸 Parameters 🌸

• esysContext — The ESYS_CONTEXT.
• saveHandle — Handle of the resource to save.
• context . (callee-allocated) — the page literally leaves it at that, so no extra lore from me. 🙈

🌈 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_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_ContextSave_Async (ESYS_CONTEXT * esysContext, ESYS_TR saveHandle) 💜

Asynchronous function for TPM2_ContextSave 🦋

This function invokes the TPM2_ContextSave command in an asynchronous variant. That means it 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_ContextSave_Finish. 💅

🌸 Parameters 🌸

• esysContext — The ESYS_CONTEXT.
• saveHandle — Handle of the resource to save.

🌈 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_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_ContextSave_Finish (ESYS_CONTEXT * esysContext, TPMS_CONTEXT ** context) 🌸

Asynchronous finish function for TPM2_ContextSave 🐚

This function returns the results of a TPM2_ContextSave command invoked via Esys_ContextSave_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.
• context . (callee-allocated) — same mysterious little line, preserved exactly. 🙈

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

---

Source/version sign-off: this page comes from tpm2-tss, version 4.1.5; the footer’s remaining spot is just Esys_ContextSave(3) doing its little cameo, and there’s no separate date printed in the original. Periodt. 💅