Esys_Unseal(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 Esys_Unseal 💖

okay so bestie, this is from the Library Functions Manual and it's literally all about Esys_Unseal — the ESAPI function for the TPM2_Unseal command. no cap, it's giving cryptographic realness ✨

🌸 NAME 🌸

Esys_Unseal — the ESAPI function for the TPM2_Unseal command. that's it, that's the vibe 💅

🦋 SYNOPSIS 🦋

Functions

TSS2_RC Esys_Unseal_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    itemHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

TSS2_RC Esys_Unseal (ESYS_CONTEXT *esysContext, ESYS_TR itemHandle,
    ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPM2B_SENSITIVE_DATA **outData)

TSS2_RC Esys_Unseal_Finish (ESYS_CONTEXT *esysContext,
    TPM2B_SENSITIVE_DATA **outData)

🌈 Detailed Description 🌈

so basically, this is the ESAPI function that lets you invoke the TPM2_Unseal command — and you can do it either as a one-call situation or in an asynchronous manner. pick your fighter, bestie 🫶

👑 Function Documentation 👑

💜 TSS2_RC Esys_Unseal (ESYS_CONTEXT * esysContext, ESYS_TR itemHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2B_SENSITIVE_DATA ** outData)

One-Call function for TPM2_Unseal — yes, the main character energy is real 🔥

This function invokes the TPM2_Unseal command in a one-call variant. meaning?? it will literally block until the TPM response is available. like it's not leaving until it gets what it came for, periodt. also, all input parameters are const. and the memory for non-simple output parameters is allocated by the function implementation — so don't you worry about that, it's handled 💅

Parameters

  • esysContext — the ESYS_CONTEXT. iconic.
  • itemHandle — handle of a loaded data object.
  • shandle1 — session handle for authorization of itemHandle
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • outData — unsealed data. (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_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_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🦋 TSS2_RC Esys_Unseal_Async (ESYS_CONTEXT * esysContext, ESYS_TR itemHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

Asynchronous function for TPM2_Unseal — the chill version, lowkey 🌸

This function invokes the TPM2_Unseal command in an asynchronous variant. so it will return as soon as the command has been sent downwards the stack to the TPM — like it's not waiting around, it's a busy queen 💅. all input parameters are const. and in order to retrieve the TPM's response, you gotta call Esys_Unseal_Finish. don't forget, bestie 😭

Parameters

  • esysContext — the ESYS_CONTEXT.
  • itemHandle — handle of a loaded data object.
  • shandle1 — session handle for authorization of itemHandle
  • shandle2 — second session handle.
  • shandle3 — third session handle.

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_RC Esys_Unseal_Finish (ESYS_CONTEXT * esysContext, TPM2B_SENSITIVE_DATA ** outData)

Asynchronous finish function for TPM2_Unseal — the grand finale, the moment we've all been waiting for 👑

This function returns the results of a TPM2_Unseal command invoked via Esys_Unseal_Finish. wait, that's what the original says — yes, it says "invoked via Esys_Unseal_Finish" and we're keeping it exactly as written, no cap 🫶. all non-simple output parameters are allocated by the function's implementation. and honestly? NULL can be passed for every output parameter if the value is not required. so flexible, so iconic.

Parameters

  • esysContext — the ESYS_CONTEXT.
  • outData — unsealed data. (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. slay, automation 💅✨

okay that's the whole thing bestie, you're literally a TPM2_Unseal expert now, iykyk 🧚💖

tpm2-tss · Version 4.1.5 · Esys_Unseal(3) — mwah, love u, go unseal some data responsibly 🫶🎀

📦 where this page comes from