Esys_GetCapability(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Esys_GetCapability — the tpm2-tss glow-up, bestie edition ✨

Okay so picture this: you're deep in the tpm2-tss library manual, page three, and you meet Esys_GetCapability — literally the ESAPI function for the TPM2_GetCapability command. She's the one who asks the TPM "hey babes, what can you do?" and the TPM answers in capability data. Iconic behavior, no cap. 🎀

✨ NAME ✨

Esys_GetCapability — the ESAPI function for the TPM2_GetCapability command. That's it, that's the whole vibe. 🦋

🌸 SYNOPSIS 🌸

Functions

TSS2_RC Esys_GetCapability_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CAP capability,
    UINT32 property, UINT32 propertyCount)
TSS2_RC Esys_GetCapability (ESYS_CONTEXT *esysContext, ESYS_TR shandle1,
    ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CAP capability, UINT32
    property, UINT32 propertyCount, TPMI_YES_NO *moreData,
    TPMS_CAPABILITY_DATA **capabilityData)
TSS2_RC Esys_GetCapability_Finish (ESYS_CONTEXT *esysContext,
    TPMI_YES_NO *moreData, TPMS_CAPABILITY_DATA **capabilityData)

💖 Detailed Description 💖

So the ESAPI function here is the one that invokes the TPM2_GetCapability command — and you get to pick your fighter: either the one-call variant (chill, blocks, gets it done) or the asynchronous manner (send it and dip). Both are valid, both are serving. 👑

🔥 Function Documentation 🔥

TSS2_RC Esys_GetCapability (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CAP capability, UINT32 property, UINT32 propertyCount, TPMI_YES_NO * moreData, TPMS_CAPABILITY_DATA ** capabilityData)

One-Call function for TPM2_GetCapability — the "I'll wait, it's fine" girlie. 💅

This function invokes the TPM2_GetCapability command in a one-call variant. Translation: the function will block until the TPM response is available, so she's not leaving until she gets her answer, periodt. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation — so that's on her, not you, bestie. 🫶

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • capability — Group selection; determines the format of the response.
  • property — Further definition of information.
  • propertyCount — Number of properties of the indicated type to return.
  • moreData — Flag to indicate if there are more values of this type.
  • capabilityData — The capability data. (callee-allocated)

Return values

  • TSS2_RC_SUCCESS — if the function call was a success. slay. ✨
  • 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. one thing at a time, babe.
  • 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_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. they said "we're not touching that," and honestly? respect.

TSS2_RC Esys_GetCapability_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CAP capability, UINT32 property, UINT32 propertyCount)

Asynchronous function for TPM2_GetCapability — the "text you later" variant. 🦋

This function invokes the TPM2_GetCapability 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. All input parameters are const. In order to retrieve the TPM's response call Esys_GetCapability_Finish — she left you on read, so you gotta follow up. 🙈

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • capability — Group selection; determines the format of the response.
  • property — Further definition of information.
  • propertyCount — Number of properties of the indicated type to return.

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_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_GetCapability_Finish (ESYS_CONTEXT * esysContext, TPMI_YES_NO * moreData, TPMS_CAPABILITY_DATA ** capabilityData)

Asynchronous finish function for TPM2_GetCapability — the "so… what did she say?" moment. 👀

This function returns the results of a TPM2_GetCapability command invoked via Esys_GetCapability_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 — literally "don't need it, don't want it, skip." 💁‍♀️

lowkey the docs say it was invoked via Esys_GetCapability_Finish — yes bestie, that's what the page says, we're not fixing it, we're just reporting it. 🫡

Parameters

  • esysContext — The ESYS_CONTEXT.
  • moreData — Flag to indicate if there are more values of this type.
  • capabilityData — The capability data. (callee-allocated)

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. she's taking a minute, 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. (Not a human, not a vibe curator — a whole robot wrote this and honestly she ate. 👑)

🍓 okay that's the whole page, every flag, every return code, every const, every NULL. no crumbs left. 💖

tpm2-tss — Version 4.1.5 — and this page is dated Esys_GetCapability(3), mwah. 💋

📦 where this page comes from