Esys_StirRandom(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

✨ Esys_StirRandom — from the tpm2-tss manual collection, page 3 💅

okay so bestie, welcome to Esys_StirRandom(3) — this is the ESAPI function that wraps the TPM2_StirRandom command. That's literally the whole vibe. Let's get into it 🫶

✨ NAME ✨

Esys_StirRandom — The ESAPI function for the TPM2_StirRandom command.

✨ SYNOPSIS ✨

🎀 Functions

TSS2_RC Esys_StirRandom_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const
    TPM2B_SENSITIVE_DATA *inData)
TSS2_RC Esys_StirRandom (ESYS_CONTEXT *esysContext, ESYS_TR shandle1,
    ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_DATA
    *inData)
TSS2_RC Esys_StirRandom_Finish (ESYS_CONTEXT *esysContext)

✨ Detailed Description ✨

ESAPI function to invoke the TPM2_StirRandom command either as a one-call or in an asynchronous manner. That's it, that's the whole genre. Pick your lane: block-y or async-y 🌈

✨ Function Documentation ✨

💜 TSS2_RC Esys_StirRandom (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_DATA * inData)

One-Call function for TPM2_StirRandom 👑

This function invokes the TPM2_StirRandom command in a one-call variant. Which means — heads up — the function will block until the TPM response is available. Like, it's just sitting there waiting. Patient queen energy. 💅

All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. Not your problem, bestie, it handles that itself ✨

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • inData — Additional information.

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_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_StirRandom_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_DATA * inData)

Asynchronous function for TPM2_StirRandom ⭐

This function invokes the TPM2_StirRandom command in a asynchronous variant. Meaning: the function will return as soon as the command has been sent downwards the stack to the TPM. No waiting around, she's got places to be 🧚

All input parameters are const. In order to retrieve the TPM's response call Esys_StirRandom_Finish. Don't forget the finish, bestie, otherwise you're just leaving it on read 😭

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • inData — Additional information.

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_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_StirRandom_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_StirRandom 🎀

This function returns the results of a TPM2_StirRandom command invoked via Esys_StirRandom_Finish. Yes, the manpage literally says "invoked via Esys_StirRandom_Finish" — that's what it says, so that's what we're telling you, no cap 🙈

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 truly do not care, you may simply not care 💀

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. Yeah, a robot wrote this one, iconic behavior honestly 🤖✨

and that's the page!! 💖 this came from the tpm2-tss squad, Version 4.1.5, dated Esys_StirRandom(3) — go stir some random, bestie, you've got this 👑🦋

📦 where this page comes from