ESYS_HIERARCHYCHANGEAUTH(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

✨ NAME ✨

okay so bestie, this is Esys_HierarchyChangeAuth(3) from the Library Functions Manual, and it is literally the ESAPI function for the TPM2_HierarchyChangeAuth command. That's the whole name vibe. 💅

🦋 SYNOPSIS 🦋

✨ Functions ✨

TSS2_RC Esys_HierarchyChangeAuth_Async (ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *newAuth)
TSS2_RC Esys_HierarchyChangeAuth (ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *newAuth)
TSS2_RC Esys_HierarchyChangeAuth_Finish (ESYS_CONTEXT *esysContext)

🌸 Detailed Description 🌸

This is the ESAPI function that invokes the TPM2_HierarchyChangeAuth command — either as a one-call situation or in an asynchronous manner. Pick your vibe. ✨

💜 Function Documentation 💜

💅 TSS2_RC Esys_HierarchyChangeAuth (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH * newAuth) 💅

One-Call function for TPM2_HierarchyChangeAuth.

This one is the one-call baddie. It invokes the TPM2_HierarchyChangeAuth command in a one-call variant, which 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. no cap. 🫶

Parameters

  • esysContext — the ESYS_CONTEXT.
  • authHandle — TPM2_RH_LOCKOUT, TPM2_RH_ENDORSEMENT, TPM2_RH_OWNER, or TPM2_RH_PLATFORM+{PP}.
  • shandle1 — session handle for authorization of authHandle.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • newAuth — new authorization value.

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_ENCRYPT_PARAM — if one of the sessions has the 'encrypt' attribute set and the command does not support encryption of the first response parameter.
  • lower-layer TSS2_RCs — produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🦋 TSS2_RC Esys_HierarchyChangeAuth_Async (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH * newAuth) 🦋

Asynchronous function for TPM2_HierarchyChangeAuth.

This invokes the TPM2_HierarchyChangeAuth command in the asynchronous variant, so 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_HierarchyChangeAuth_Finish. iykyk. ⭐

Parameters

  • esysContext — the ESYS_CONTEXT.
  • authHandle — TPM2_RH_LOCKOUT, TPM2_RH_ENDORSEMENT, TPM2_RH_OWNER, or TPM2_RH_PLATFORM+{PP}.
  • shandle1 — session handle for authorization of authHandle.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • newAuth — new authorization value.

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.
  • lower-layer 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_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_HierarchyChangeAuth_Finish (ESYS_CONTEXT * esysContext) 🎀

Asynchronous finish function for TPM2_HierarchyChangeAuth.

This function returns the results of a TPM2_HierarchyChangeAuth command invoked via Esys_HierarchyChangeAuth_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. periodt. 🌈

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.
  • lower-layer 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.

and that's the whole page, bestie. the footer doesn't give a separate date, just tpm2-tss, Version 4.1.5, and Esys_HierarchyChangeAuth(3) — that's the sign-off. 💖✨

📦 where this page comes from