Esys_PolicyLocality(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 Esys_PolicyLocality(3) 💖

okay so bestie, welcome to the Library Functions Manual entry for Esys_PolicyLocality — this is the ESAPI glow-up that lets you poke the TPM2_PolicyLocality command. she's giving TPM policy realness and honestly? iconic. 🎀

✨ NAME ✨

Esys_PolicyLocality — the ESAPI function for the TPM2_PolicyLocality command. that's it, that's the vibe. 🦋

🌸 SYNOPSIS 🌸

💅 Functions

TSS2_RC Esys_PolicyLocality_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPMA_LOCALITY locality)
TSS2_RC Esys_PolicyLocality (ESYS_CONTEXT *esysContext, ESYS_TR
    policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPMA_LOCALITY locality)
TSS2_RC Esys_PolicyLocality_Finish (ESYS_CONTEXT *esysContext)

🌈 Detailed Description

ESAPI function to invoke the TPM2_PolicyLocality command either as a one-call or in an asynchronous manner. two paths, same destination, both slay. ✨

👑 Function Documentation

🧚 TSS2_RC Esys_PolicyLocality (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMA_LOCALITY locality)

One-Call function for TPM2_PolicyLocality — the "just do it already" edition. 😌

This function invokes the TPM2_PolicyLocality command in a one-call variant. This means the function will block until the TPM response is available (yes, she waits, she's committed 🫶). All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation.

Parameters

  • esysContext — The ESYS_CONTEXT. the main character of this whole situation.
  • policySession — Handle for the policy session being extended.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • locality — The allowed localities for the policy.

Return values

  • TSS2_RC_SUCCESS — if the function call was a success. we love a win. 💖
  • TSS2_ESYS_RC_BAD_REFERENCE — if the esysContext or required input pointers or required output handle references are NULL. literally nothing to hold onto 😭
  • 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. one thing at a time bestie, there's already a queue 💀
  • 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. not the vibe check failing 😬
  • 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. it's giving "we don't touch those, not our department" 🙈

🌟 TSS2_RC Esys_PolicyLocality_Async (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMA_LOCALITY locality)

Asynchronous function for TPM2_PolicyLocality — the "send it and go live your life" edition. 💫

This function invokes the TPM2_PolicyLocality command in a asynchronous variant. This means the function will return as soon as the command has been sent downwards the stack to the TPM — she does not wait around, she has places to be. All input parameters are const. In order to retrieve the TPM's response call Esys_PolicyLocality_Finish. 👈 don't forget this part, fr fr

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.
  • locality — The allowed localities for 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_PolicyLocality_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_PolicyLocality — the closing the loop moment, the "so what did the TPM say" reveal. 🌸

This function returns the results of a TPM2_PolicyLocality command invoked via Esys_PolicyLocality_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. lowkey efficient 💅

Parameters

  • esysContext — The ESYS_CONTEXT.

Return values

  • TSS2_RC_SUCCESS — on success. ✅
  • ESYS_RC_SUCCESS — if the function call was a success. (yes, both of these are listed, and yes, we're keeping both, don't @ me 🫶)
  • 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. she's not ghosting you, she's just slow, 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 technically not a person, but she ate regardless 👑

bestie reminder: every single error code above is literally in the original, so if you hit one, it's real, it's valid, and it's not you being dramatic. 🍓

sign-off 💖 — this lil page comes from tpm2-tss, Version 4.1.5, and the footer date slot is exactly where Esys_PolicyLocality(3) hangs out on the Library Functions Manual. mwah, go extend that policy session, you've got this 🫶✨

📦 where this page comes from