Esys_ChangePPS(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Esys_ChangePPS — the TPM2_ChangePPS ESAPI moment

okay so bestie, welcome to Esys_ChangePPS(3), a page from the Library Functions Manual (tpm2-tss girlies know 👑). this is the ESAPI function for the TPM2_ChangePPS command, and it's literally the whole vibe. three functions, one job, no cap. 🦋

✨ SYNOPSIS ✨

🎀 Functions

TSS2_RC Esys_ChangePPS_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_ChangePPS (ESYS_CONTEXT *esysContext, ESYS_TR authHandle,
    ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_ChangePPS_Finish (ESYS_CONTEXT *esysContext)

🌸 Detailed Description

ESAPI function to invoke the TPM2_ChangePPS command either as a one-call or in an asynchronous manner. that's it, that's the whole deal, and honestly? iconic. ✨

🌈 Function Documentation

🧚 TSS2_RC Esys_ChangePPS (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

One-Call function for TPM2_ChangePPS

This function invokes the TPM2_ChangePPS command in a one-call variant. Translation bestie: the function will block until the TPM response is available — it's giving patient main character energy, it waits for its answer. 😌 All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. no cap. 💅

🍓 Parameters

  • esysContext — The ESYS_CONTEXT.
  • authHandle — TPM2_RH_PLATFORM+{PP}.
  • shandle1 — Session handle for authorization of authHandle
  • 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_ChangePPS_Async (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

Asynchronous function for TPM2_ChangePPS

This function invokes the TPM2_ChangePPS command in a asynchronous variant. so like, the function will return as soon as the command has been sent downwards the stack to the TPM — she drops it off and dips, no waiting around 💀. All input parameters are const. In order to retrieve the TPM's response call Esys_ChangePPS_Finish. (that's your callback era, bestie 🫶)

🍓 Parameters

  • esysContext — The ESYS_CONTEXT.
  • authHandle — TPM2_RH_PLATFORM+{PP}.
  • shandle1 — Session handle for authorization of authHandle
  • 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_ChangePPS_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_ChangePPS

This function returns the results of a TPM2_ChangePPS command invoked via Esys_ChangePPS_Finish. (yes bestie, the page literally says it was invoked via Esys_ChangePPS_Finish — that's what the source says, we don't question the source 💀). 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 you can ghost any output you don't care about, slay 🙈.

🍓 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.
🫶 friendly reminder: TSS2_ESYS_RC_TRY_AGAIN is a whole mood — the timeout counter expired before the TPM response showed up. try again, bestie, they're just not texting back yet.

👑 Author

Generated automatically by Doxygen for tpm2-tss from the source code. (not a human author, a robot did this, and honestly it ate 🤖✨)

kisses and see-you-laters, bestie 💖 — this whole page is tpm2-tss, Version 4.1.5, and it's the Esys_ChangePPS(3) page. go change that PPS, you absolute icon 🌸💅🎀

📦 where this page comes from