Esys_SetAlgorithmSet(3)

💖 NAME 💖

okay so bestie, this is Esys_SetAlgorithmSet(3), and the manual name is Library Functions Manual — folded in right here instead of a copied header line. It's from tpm2-tss and it's the ESAPI function for the TPM2_SetAlgorithmSet command. main character energy only.

✨ SYNOPSIS ✨

🧚 Functions

       TSS2_RC Esys_SetAlgorithmSet_Async (ESYS_CONTEXT *esysContext, ESYS_TR
           authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
           UINT32 algorithmSet)
       TSS2_RC Esys_SetAlgorithmSet (ESYS_CONTEXT *esysContext, ESYS_TR
           authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
           UINT32 algorithmSet)
       TSS2_RC Esys_SetAlgorithmSet_Finish (ESYS_CONTEXT *esysContext)

🌸 Detailed Description 🌸

ESAPI function to invoke the TPM2_SetAlgorithmSet command either as a one-call or in an asynchronous manner. That's the whole vibe: two ways to send it, one way to finish it, and a lot of RC codes to keep track of. 💅

🔥 Function Documentation 🔥

💅 TSS2_RC Esys_SetAlgorithmSet (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT32 algorithmSet)

One-Call function for TPM2_SetAlgorithmSet

okay so this is the one-call variant. It invokes the TPM2_SetAlgorithmSet command and blocks until the TPM response is available. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. no cap, it just waits for the tea ☕

🫶 Parameters

• esysContext — The ESYS_CONTEXT.
• authHandle — TPM2_RH_PLATFORM.
• shandle1 — Session handle for authorization of authHandle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• algorithmSet — A TPM vendor-dependent value indicating the algorithm set selection.

🩷 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_SetAlgorithmSet_Async (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT32 algorithmSet)

Asynchronous function for TPM2_SetAlgorithmSet

this one is the asynchronous variant, bestie. It invokes the TPM2_SetAlgorithmSet command and returns 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_SetAlgorithmSet_Finish. it's giving send-now-collect-later ✨

🫶 Parameters

• esysContext — The ESYS_CONTEXT.
• authHandle — TPM2_RH_PLATFORM.
• shandle1 — Session handle for authorization of authHandle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• algorithmSet — A TPM vendor-dependent value indicating the algorithm set selection.

🩷 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_SetAlgorithmSet_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_SetAlgorithmSet

this is the finish line. It returns the results of a TPM2_SetAlgorithmSet command invoked via Esys_SetAlgorithmSet_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 output, go ahead and pass NULL, it's fine 💅

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

---

okay bestie, that's the whole page. Source/version check: tpm2-tss, Version 4.1.5, Esys_SetAlgorithmSet(3) — and the original footer had no date line, so that's the whole footer tea. mwah 💋💖✨