Fapi_GetPl...rtificates(3)

💅 NAME

Fapi_GetPlatformCertificates — literally Fapi_GetPlatformCertificates, no cap 😭💖. Also folding in the page tea right here: title is Fapi_GetPl...rtificates(3), manual name is Library Functions Manual — now you're caught up, bestie 🫶.

✨ SYNOPSIS ✨

🎀 Functions

TSS2_RC Fapi_GetPlatformCertificates (FAPI_CONTEXT *context, uint8_t
    **certificates, size_t *certificatesSize)
TSS2_RC Fapi_GetPlatformCertificates_Async (FAPI_CONTEXT *context)
TSS2_RC Fapi_GetPlatformCertificates_Finish (FAPI_CONTEXT *context,
    uint8_t **certificates, size_t *certificatesSize)

🌸 DETAILED DESCRIPTION 🌸

These are the FAPI functions that invoke GetPlatformCertificates either as a one-call or in an asynchronous manner, periodt ✨.

🧚 FUNCTION DOCUMENTATION 🧚

💖 One-call: Fapi_GetPlatformCertificates

TSS2_RC Fapi_GetPlatformCertificates (FAPI_CONTEXT * context, uint8_t **
    certificates, size_t * certificatesSize)

One-call function for Fapi_GetPlatformCertificates — yes bestie, the one-shot version 💅.

Platform certificates for TPM 2.0 can consist not only of a single certificate but a series of so-called delta certificates. This function returns the set of Platform certificates concatenated in a continuous buffer. Obsessed with a continuous buffer, honestly 🫶✨.

🍓 Parameters

• context — the FAPI_CONTEXT 👑.
• certificates — the platform certificates 🎀.
• certificatesSize — the size of the buffer with the certificates. May be NULL 💀.

💀 Return values

• TSS2_RC_SUCCESS — the function call was a success, slay ✅.
• TSS2_FAPI_RC_BAD_REFERENCE — context or certificates is NULL 😭.
• TSS2_FAPI_RC_BAD_CONTEXT — context corruption was detected 👀.
• TSS2_FAPI_RC_BAD_SEQUENCE — the context already has an asynchronous operation pending, not now bestie 💅.
• TSS2_FAPI_RC_IO_ERROR — the data cannot be saved 🫠.
• TSS2_FAPI_RC_MEMORY — FAPI cannot allocate enough memory for internal operations or return parameters 😵‍💫.
• TSS2_FAPI_RC_NO_TPM — FAPI was initialized in no-TPM-mode via its config file 🚫.
• TSS2_FAPI_RC_NO_CERT — an error did occur during certificate downloading 😬.
• TSS2_FAPI_RC_TRY_AGAIN — an I/O operation is not finished yet and this function needs to be called again 🔁.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — a required authorization callback is not set 🙈.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — the authorization attempt fails 😤.
• TSS2_FAPI_RC_GENERAL_FAILURE — an internal error occurred 💥.
• TSS2_FAPI_RC_POLICY_UNKNOWN — 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_KEY_NOT_FOUND — a key was not found 🔑.
• TSS2_FAPI_RC_BAD_PATH — the path is used in inappropriate context or contains illegal characters 🛣️.
• TSS2_FAPI_RC_BAD_VALUE — an invalid value was passed into the function 🚩.
• TSS2_FAPI_RC_PATH_NOT_FOUND — a FAPI object path was not found during authorization 🧭.

🦋 Async: Fapi_GetPlatformCertificates_Async

TSS2_RC Fapi_GetPlatformCertificates_Async (FAPI_CONTEXT * context)

Asynchronous function for Fapi_GetPlatformCertificates — it's giving async main character energy ⏳✨.

Platform certificates for TPM 2.0 can consist not only of a single certificate but a series of so-called delta certificates. This function returns the set of Platform certificates concatenated in a continuous buffer. Again: continuous buffer, iconic 🫶.

Call Fapi_GetPlatformCertificates_Finish to finish the execution of this command, bestie 💅.

🍓 Parameters

• context — the FAPI_CONTEXT 👑.

💀 Return values

• TSS2_RC_SUCCESS — the function call was a success, periodt ✅.
• TSS2_FAPI_RC_BAD_REFERENCE — context is NULL 😭.
• TSS2_FAPI_RC_BAD_CONTEXT — context corruption was detected 👀.
• TSS2_FAPI_RC_BAD_SEQUENCE — the context already has an asynchronous operation pending 🚨.
• TSS2_FAPI_RC_IO_ERROR — the data cannot be saved 🫠.
• TSS2_FAPI_RC_MEMORY — FAPI cannot allocate enough memory for internal operations or return parameters 😵‍💫.
• TSS2_FAPI_RC_NO_TPM — FAPI was initialized in no-TPM-mode via its config file 🚫.

🌟 Finish: Fapi_GetPlatformCertificates_Finish

TSS2_RC Fapi_GetPlatformCertificates_Finish (FAPI_CONTEXT * context, uint8_t
    ** certificates, size_t * certificatesSize)

Asynchronous finish function for Fapi_GetPlatformCertificates — the grand finale, your async era is ending 🌈.

This function should be called after a previous Fapi_GetPlatformCertificates_Async, iykyk 🧚.

🍓 Parameters

• context — the FAPI_CONTEXT 👑.
• certificates — the platform certificates 🎀.
• certificatesSize — the size of the buffer with the certificates. May be NULL 💀.

💀 Return values

• TSS2_RC_SUCCESS — the function call was a success, ate ✅.
• TSS2_FAPI_RC_BAD_REFERENCE — context or certificates is NULL 😭.
• TSS2_FAPI_RC_BAD_CONTEXT — context corruption was detected 👀.
• TSS2_FAPI_RC_BAD_SEQUENCE — the context already has an asynchronous operation pending 🚨.
• TSS2_FAPI_RC_IO_ERROR — the data cannot be saved 🫠.
• TSS2_FAPI_RC_MEMORY — FAPI cannot allocate enough memory for internal operations or return parameters 😵‍💫.
• TSS2_FAPI_RC_TRY_AGAIN — the asynchronous operation is not yet complete. Call this function again later 🔁.
• TSS2_FAPI_RC_NO_CERT — an error did occur during certificate downloading 😬.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — a required authorization callback is not set 🙈.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — the authorization attempt fails 😤.
• TSS2_FAPI_RC_GENERAL_FAILURE — an internal error occurred 💥.
• TSS2_FAPI_RC_POLICY_UNKNOWN — 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_KEY_NOT_FOUND — a key was not found 🔑.
• TSS2_FAPI_RC_BAD_PATH — the path is used in inappropriate context or contains illegal characters 🛣️.
• TSS2_FAPI_RC_BAD_VALUE — an invalid value was passed into the function 🚩.
• TSS2_FAPI_RC_PATH_NOT_FOUND — a FAPI object path was not found during authorization 🧭.

👑 AUTHOR 👑

Generated automatically by Doxygen for tpm2-tss from the source code 📝✨.

---

Ok that's the whole page, bestie — source: tpm2-tss, version: 4.1.5; the footer has no date printed, so I'm not inventing one 💀. Bye and go get those platform certificates 🫶💖🎀