Fapi_SetSignCB(3)

🎀 NAME 🎀

okay bestie, welcome to the Fapi_SetSignCB(3) page — the manual name is Library Functions Manual, and the name is literally Fapi_SetSignCB with the one-liner Fapi_SetSignCB. iconic, no cap. 💅

✨ SYNOPSIS ✨

Typedefs

two typedefs on deck, fr fr:

       typedef TSS2_RC(* Fapi_CB_Sign) (char const *objectPath, char const
           *description, char const *publicKey, char const *publicKeyHint,
           uint32_t hashAlg, uint8_t const *dataToSign, size_t dataToSignSize,
           uint8_t const **signature, size_t *signatureSize, void *userData)
       typedef TSS2_RC(* Fapi_CB_PolicyAction) (char const *objectPath, char
           const *action, void *userData)

Functions

the function besties on deck 🫶:

       TSS2_RC Fapi_SetSignCB (FAPI_CONTEXT *context, Fapi_CB_Sign callback,
           void *userData)
       TSS2_RC Fapi_SetPolicyActionCB (FAPI_CONTEXT *context,
           Fapi_CB_PolicyAction callback, void *userData)

🌸 Detailed Description 🌸

these are the FAPI functions to invoke SetSignCB. lowkey that's the whole vibe check. ✨

💅 Function Documentation 💅

🦋 Fapi_SetPolicyActionCB 🦋

       TSS2_RC Fapi_SetPolicyActionCB (FAPI_CONTEXT * context, Fapi_CB_PolicyAction
           callback, void * userData)

Fapi_SetActionCB() registers an application-defined function as a callback that shall be called back upon encountering a policy action element. yes bestie, the description says Fapi_SetActionCB() — that's the name right there in the text, iykyk. 💖

Parameters

• context — The FAPI_CONTEXT.
• callback — The callback function for branch selection.
• userData — A pointer that is provided to all callback invocations.

Return values

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if the context is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the synchronous or Async functions are called while the context has another asynchronous operation outstanding, or the Finish function is called while the context does not have an appropriate asynchronous operation outstanding.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.

🌟 Fapi_SetSignCB 🌟

       TSS2_RC Fapi_SetSignCB (FAPI_CONTEXT * context, Fapi_CB_Sign callback, void
           * userData)

Fapi_SetSignCB() registers an application-defined function as a callback to allow the FAPI to get signatures authorizing use of TPM objects. it's giving signature-gatekeeper energy 🔥.

Parameters

• context — The FAPI_CONTEXT.
• callback — The callback function for signing selection.
• userData — A pointer that is provided to all callback invocations.

Return values

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if the context is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the synchronous or Async functions are called while the context has another asynchronous operation outstanding, or the Finish function is called while the context does not have an appropriate asynchronous operation outstanding.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.

📜 Author 📜

Generated automatically by Doxygen for tpm2-tss from the source code. slay, automation 💖.

---

xoxo bestie 🫶 — footer deets: source tpm2-tss, Version 4.1.5, page Fapi_SetSignCB(3). 💜