Esys_PolicyNameHash(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Esys_PolicyNameHash — from the Library Functions Manual bestie files ✨

Okay so real talk, this is the page for Esys_PolicyNameHash(3), and it's all about the ESAPI wrapper for the TPM2_PolicyNameHash command. TPM stuff can look scary but it's actually giving very structured, very slay energy once you get the rhythm. Let's go 🫶

🎀 NAME 🎀

Esys_PolicyNameHash — the ESAPI function for the TPM2_PolicyNameHash command. That's it, that's the whole vibe check 💖

🌸 SYNOPSIS 🌸

✨ Functions ✨

Here's the trio, bestie — three functions, all TSS2_RC returning, all iconic in their own way:

TSS2_RC Esys_PolicyNameHash_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    const TPM2B_DIGEST *nameHash)
TSS2_RC Esys_PolicyNameHash (ESYS_CONTEXT *esysContext, ESYS_TR
    policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    const TPM2B_DIGEST *nameHash)
TSS2_RC Esys_PolicyNameHash_Finish (ESYS_CONTEXT *esysContext)

🦋 Detailed Description 🦋

So this is the ESAPI function that invokes the TPM2_PolicyNameHash command — and you can hit it either as a one-call situation or in an asynchronous manner. Pick your fighter, both are valid 💅

👑 Function Documentation 👑

🌈 TSS2_RC Esys_PolicyNameHash (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST * nameHash)

One-Call function for TPM2_PolicyNameHash — the "just do it and wait" option, and honestly? Main character energy.

This function invokes the TPM2_PolicyNameHash command in a one-call variant. Translation: the function will block until the TPM response is available. No running off, no leaving you on read — it waits for the reply, periodt. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. 💖

🌸 Parameters 🌸

  • esysContext — The ESYS_CONTEXT. The whole context situation.
  • policySession — Handle for the policy session being extended. We're growing the policy, bestie 🧚
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • nameHash — The digest to be added to the policy. The star of the show ✨

💀 Return values 💀

  • TSS2_RC_SUCCESS — if the function call was a success. We love a clean win 🎀
  • 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. Lowkey the layers below you doing their own thing, and that's fine 🙈

🦋 TSS2_RC Esys_PolicyNameHash_Async (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST * nameHash)

Asynchronous function for TPM2_PolicyNameHash — the "send it and dip" version, and ngl it's giving efficiency ✨

This function invokes the TPM2_PolicyNameHash command in an asynchronous variant. Which means: the function will return as soon as the command has been sent downwards the stack to the TPM. It does not wait around for the reply — she has places to be. All input parameters are const. In order to retrieve the TPM's response, call Esys_PolicyNameHash_Finish. Don't forget the finish, bestie, or you'll be left wondering 😭

🌸 Parameters 🌸

  • esysContext — The ESYS_CONTEXT.
  • policySession — Handle for the policy session being extended.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • nameHash — The digest to be added to the policy.

💀 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_PolicyNameHash_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_PolicyNameHash — the reunion episode 🎬

This function returns the results of a TPM2_PolicyNameHash command invoked via Esys_PolicyNameHash_Finish. All non-simple output parameters are allocated by the function's implementation. And here's a cute little detail: NULL can be passed for every output parameter if the value is not required. Skip what you don't need, no pressure 💅

🌸 Parameters 🌸

  • esysContext — The ESYS_CONTEXT. That's the whole list, she's low maintenance.

💀 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. (Not a fail, just a "girl, try again" 🔥)
  • 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 no human author to credit here — Doxygen did that, and honestly? It ate 👑

💖 Okay that's the whole page! Go extend that policy, bestie. You got this. 🦋

Big sparkly sign-off energy: this cutie page came from tpm2-tss, Version 4.1.5, and it's filed under Esys_PolicyNameHash(3) 💜 No cap, that's the version info, keep it for your records 📝✨

📦 where this page comes from