Fapi_PcrExtend(3)

✨ NAME ✨

okay so this is the Fapi_PcrExtend(3) page, bestie — manual-name vibe folded in here: Library Functions Manual 🫶. The icon of the page is Fapi_PcrExtend — literally Fapi_PcrExtend, no cap.

🦋 SYNOPSIS 🦋

Here are the functions, exactly as they are — copy/paste energy only, periodt:

TSS2_RC Fapi_PcrExtend (FAPI_CONTEXT *context, uint32_t pcr, uint8_t
    const *data, size_t dataSize, char const *logData)
TSS2_RC Fapi_PcrExtend_Async (FAPI_CONTEXT *context, uint32_t pcr,
    uint8_t const *data, size_t dataSize, char const *logData)
TSS2_RC Fapi_PcrExtend_Finish (FAPI_CONTEXT *context)

💅 Detailed Description 💅

The FAPI functions let you invoke PcrExtend either as a one-call situation or in an asynchronous manner. That's the whole vibe: one-call or async, both iconic 💖.

👑 Function Documentation 👑

💖 TSS2_RC Fapi_PcrExtend 💖

Signature check, bestie:

TSS2_RC Fapi_PcrExtend (FAPI_CONTEXT * context, uint32_t pcr, uint8_t const
    * data, size_t dataSize, char const * logData)

One-Call function for Fapi_PcrExtend — yes, one call and you're doing the thing ✨.

It performs an extend operation on a given PCR.

Parameters 🎀

• context — The FAPI_CONTEXT.
• pcr — The PCR to extend.
• data — The data that is to be extended on the PCR.
• dataSize — The size of data in bytes.
• logData — A JSON representation of data to be written to the PCR's event log. May be NULL.

Return values 🌈

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context or data is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_NO_PCR — if no such PCR exists on this TPM.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_TRY_AGAIN — if an I/O operation is not finished yet and this function needs to be called again.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if a key was not found.
• TSS2_FAPI_RC_GENERAL_FAILURE — if an internal error occurred.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if policy search for a certain policy digest was not successful.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.
• TSS2_FAPI_RC_BAD_PATH — if the path is used in inappropriate context or contains illegal characters.

🦋 TSS2_RC Fapi_PcrExtend_Async 🦋

Signature, because we keep it exact:

TSS2_RC Fapi_PcrExtend_Async (FAPI_CONTEXT * context, uint32_t pcr, uint8_t
    const * data, size_t dataSize, char const * logData)

Asynchronous function for Fapi_PcrExtend — it performs an extend operation on a given PCR. When you're ready to wrap it up, call Fapi_PcrExtend_Finish to finish the execution of this command, okay bestie?

Parameters 🎀

• context — The FAPI_CONTEXT.
• pcr — The PCR to extend.
• data — The data that is to be extended on the PCR.
• dataSize — The size of data in bytes.
• logData — A JSON representation of data to be written to the PCR's event log. May be NULL.

Return values 🌈

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context or data is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_NO_PCR — if no such PCR exists on this TPM.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.

🎀 TSS2_RC Fapi_PcrExtend_Finish 🎀

Signature, staying exact:

TSS2_RC Fapi_PcrExtend_Finish (FAPI_CONTEXT * context)

Asynchronous finish function for Fapi_PcrExtend — this function should be called after a previous Fapi_PcrExtend_Async. That's the sequence, iykyk 💅.

Parameters 🎀

• context — The FAPI_CONTEXT.

Return values 🌈

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_TRY_AGAIN — if the asynchronous operation is not yet complete. Call this function again later.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if a key was not found.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_GENERAL_FAILURE — if an internal error occurred.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if policy search for a certain policy digest was not successful.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.
• TSS2_FAPI_RC_BAD_PATH — if the path is used in inappropriate context or contains illegal characters.

🌸 Author 🌸

Generated automatically by Doxygen for tpm2-tss from the source code. Doxygen really said “I got you” 💅.

---

Cute final sign-off, bestie: this page comes from tpm2-tss, Version 4.1.5, and the manual page is Fapi_PcrExtend(3). Bye, slay responsibly 💖✨