Esys_EncryptDecrypt(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 NAME 💖

okay so bestie, this is Esys_EncryptDecrypt(3) — the ESAPI function for the TPM2_EncryptDecrypt command. That's the whole name moment: Esys_EncryptDecrypt — The ESAPI function for the TPM2_EncryptDecrypt command. 💅

✨ SYNOPSIS ✨

🦋 Functions 🦋

Like, three function besties show up here:

TSS2_RC Esys_EncryptDecrypt_Async (ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO decrypt, TPMI_ALG_CIPHER_MODE mode, const TPM2B_IV *ivIn, const TPM2B_MAX_BUFFER *inData)
TSS2_RC Esys_EncryptDecrypt (ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO decrypt, TPMI_ALG_CIPHER_MODE mode, const TPM2B_IV *ivIn, const TPM2B_MAX_BUFFER *inData, TPM2B_MAX_BUFFER **outData, TPM2B_IV **ivOut)
TSS2_RC Esys_EncryptDecrypt_Finish (ESYS_CONTEXT *esysContext, TPM2B_MAX_BUFFER **outData, TPM2B_IV **ivOut)

🌈 Detailed Description 🌈

ESAPI function to invoke the TPM2_EncryptDecrypt command either as a one-call or in an asynchronous manner. That's the tea: you got the one-and-done path and the send-it-then-catch-up-later path. Pick your main character energy. 🦋

🧚 Function Documentation 🧚

🔥 TSS2_RC Esys_EncryptDecrypt (...) — One-Call Function for TPM2_EncryptDecrypt 🔥

TSS2_RC Esys_EncryptDecrypt (ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO decrypt, TPMI_ALG_CIPHER_MODE mode, const TPM2B_IV *ivIn, const TPM2B_MAX_BUFFER *inData, TPM2B_MAX_BUFFER **outData, TPM2B_IV **ivOut)

One-Call function for TPM2_EncryptDecrypt. This function invokes the TPM2_EncryptDecrypt 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. literally one call and you wait for the TPM to finish its little moment. 💅

🌸 Parameters 🌸

  • esysContext — The ESYS_CONTEXT.
  • keyHandle — The symmetric key used for the operation.
  • shandle1 — Session handle for authorization of keyHandle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • decrypt — If YES, then the operation is decryption; if NO, the operation is encryption.
  • mode — Symmetric mode.
  • ivIn — An initial value as required by the algorithm.
  • inData — The data to be encrypted/decrypted.
  • outData — Encrypted or decrypted output. (callee-allocated)
  • ivOut — Chaining value to use for IV in next round. (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_EncryptDecrypt_Async (...) — Asynchronous Function for TPM2_EncryptDecrypt 💫

TSS2_RC Esys_EncryptDecrypt_Async (ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO decrypt, TPMI_ALG_CIPHER_MODE mode, const TPM2B_IV *ivIn, const TPM2B_MAX_BUFFER *inData)

Asynchronous function for TPM2_EncryptDecrypt. This function invokes the TPM2_EncryptDecrypt 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_EncryptDecrypt_Finish. she sends it and dips, then you come back for the results later. ✨

🌸 Parameters 🌸

  • esysContext — The ESYS_CONTEXT.
  • keyHandle — The symmetric key used for the operation.
  • shandle1 — Session handle for authorization of keyHandle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • decrypt — If YES, then the operation is decryption; if NO, the operation is encryption.
  • mode — Symmetric mode.
  • ivIn — An initial value as required by the algorithm.
  • inData — The data to be encrypted/decrypted.

🎀 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_EncryptDecrypt_Finish (...) — Asynchronous Finish Function for TPM2_EncryptDecrypt 🦋

TSS2_RC Esys_EncryptDecrypt_Finish (ESYS_CONTEXT *esysContext, TPM2B_MAX_BUFFER **outData, TPM2B_IV **ivOut)

Asynchronous finish function for TPM2_EncryptDecrypt. This function returns the results of a TPM2_EncryptDecrypt command invoked via Esys_EncryptDecrypt_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. so if you don't need a value, you can absolutely just pass NULL and keep it moving. 🫶

🌸 Parameters 🌸

  • esysContext — The ESYS_CONTEXT.
  • outData — Encrypted or decrypted output. (callee-allocated)
  • ivOut — Chaining value to use for IV in next round. (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. she was born from the source code, no cap. 💜

And that's the whole page, bestie! Footer vibes: tpm2-tss, Version 4.1.5, Esys_EncryptDecrypt(3) — no date listed, just iconic behavior. 💅✨💖

📦 where this page comes from