Esys_PCR_Reset(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

✨ NAME ✨

okay so this is the Esys_PCR_Reset(3) page, bestie — it's the ESAPI function for the TPM2_PCR_Reset command. 💅

🌸 SYNOPSIS 🌸

Functions

TSS2_RC Esys_PCR_Reset_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_PCR_Reset (ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle,
    ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_PCR_Reset_Finish (ESYS_CONTEXT *esysContext)

🦋 Detailed Description 🦋

So this is the ESAPI function that lets you invoke the TPM2_PCR_Reset command — and you can do it either as a one-call vibe or in an asynchronous manner. Pick your fighter, both are iconic. ✨

🎀 Function Documentation 🎀

TSS2_RC Esys_PCR_Reset (ESYS_CONTEXT * esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

One-Call function for TPM2_PCR_Reset — literally the whole thing in one go, no cap.

This function invokes the TPM2_PCR_Reset command in a one-call variant. What that means: the function will block until the TPM response is available (so yes, it's gonna sit there and wait, that's the whole point). All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. 🫶

Parameters

  • esysContext — The ESYS_CONTEXT.
  • pcrHandle — The PCR to reset.
  • shandle1 — Session handle for authorization of pcrHandle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.

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_PCR_Reset_Async (ESYS_CONTEXT * esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

Asynchronous function for TPM2_PCR_Reset — the "send it and dip" edition. 💨

This function invokes the TPM2_PCR_Reset command in a asynchronous variant. Which 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_PCR_Reset_Finish. Like, don't forget the finish part, bestie, the response is waiting for you. 😭

Parameters

  • esysContext — The ESYS_CONTEXT.
  • pcrHandle — The PCR to reset.
  • shandle1 — Session handle for authorization of pcrHandle.
  • 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_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_PCR_Reset_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_PCR_Reset — the part where you actually collect what you started. 👑

This function returns the results of a TPM2_PCR_Reset command invoked via Esys_PCR_Reset_Finish. (Yes, that's what the page says — we're quoting the vibe exactly, don't come for me. 🫶) 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. Slay, flexible API.

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. So nobody hand-wrote this, it's a robot doing its little robot thing. 🤖✨

okay that's the whole page, bestie — every flag, every TSS2_RC, every parameter, all of it. Go reset that PCR responsibly. 💅🔥

this iconic little page came from tpm2-tss, Version 4.1.5 — mwah, no notes 🎀

📦 where this page comes from