Fapi_VerifySignature(3)

💖 Fapi_VerifySignature(3) — Library Functions Manual energy 💖

okay bestie, welcome to Fapi_VerifySignature(3) from the Library Functions Manual, brought to you by the tpm2-tss girlies ✨ This page is literally about verifying signatures with FAPI, and it comes in one-call, async, and finish flavors. No cap.

---

🌸 NAME 🌸

Fapi_VerifySignature — the FAPI signature-verifying function set: one-call, async, and async-finish. It’s giving “verify that signature, bestie.” 💅

---

✨ SYNOPSIS ✨

Three functions, one very specific vibe:

TSS2_RC Fapi_VerifySignature (FAPI_CONTEXT *context, char const
    *keyPath, uint8_t const *digest, size_t digestSize, uint8_t const
    *signature, size_t signatureSize)
TSS2_RC Fapi_VerifySignature_Async (FAPI_CONTEXT *context, char const
    *keyPath, uint8_t const *digest, size_t digestSize, uint8_t const
    *signature, size_t signatureSize)
TSS2_RC Fapi_VerifySignature_Finish (FAPI_CONTEXT *context)

---

🌈 DETAILED DESCRIPTION 🌈

FAPI functions to invoke VerifySignature either as a one-call situation or in an asynchronous manner. Pick your era, bestie 🦋

---

🎀 FUNCTION DOCUMENTATION 🎀

💅 TSS2_RC Fapi_VerifySignature — the one-call function

TSS2_RC Fapi_VerifySignature (FAPI_CONTEXT *context, char const
    *keyPath, uint8_t const *digest, size_t digestSize, uint8_t const
    *signature, size_t signatureSize)

One-Call function for Fapi_VerifySignature.

It verifies a signature using a public key found in a keyPath. Main character behavior, honestly 👑

🍓 Parameters

• context — The FAPI_CONTEXT.
• keyPath — The path to the verification public key.
• digest — The digest that was signed. Must be already hashed.
• digestSize — the size of digest in bytes.
• signature — The signature to be verified.
• signatureSize — The size of signature in bytes.

💀 Return values

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context, keyPath, signature, or digest is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if keyPath does not map to a FAPI object.
• TSS2_FAPI_RC_BAD_KEY — if the object at publicKeyPath is not a key, or is a key that is unsuitable for the requested operation.
• TSS2_FAPI_RC_BAD_VALUE — if signature is invalid (has the wrong format) or if digestSize is zero.
• TSS2_FAPI_RC_SIGNATURE_VERIFICATION_FAILED — if the signature fails to verify.
• 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_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• 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_GENERAL_FAILURE — if an internal error occurred.
• 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_VerifySignature_Async — the async function

TSS2_RC Fapi_VerifySignature_Async (FAPI_CONTEXT *context, char const
    *keyPath, uint8_t const *digest, size_t digestSize, uint8_t const
    *signature, size_t signatureSize)

Asynchronous function for Fapi_VerifySignature.

It verifies a signature using a public key found in a keyPath.

Call Fapi_VerifySignature_Finish to finish the execution of this command. Do not forget the finish, bestie — that’s the whole sequel 😭

🍓 Parameters

• context — The FAPI_CONTEXT.
• keyPath — The path to the verification public key.
• digest — The digest that was signed. Must be already hashed.
• digestSize — the size of digest in bytes.
• signature — The signature to be verified.
• signatureSize — The size of signature in bytes.

💀 Return values

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context, keyPath, signature, or digest is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if keyPath does not map to a FAPI object.
• TSS2_FAPI_RC_BAD_KEY — if the object at publicKeyPath is not a key, or is a key that is unsuitable for the requested operation.
• TSS2_FAPI_RC_BAD_VALUE — if signature is invalid (has the wrong format) or if digestSize is zero.
• TSS2_FAPI_RC_SIGNATURE_VERIFICATION_FAILED — if the signature fails to verify.
• 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_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• 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_VerifySignature_Finish — the finish function

TSS2_RC Fapi_VerifySignature_Finish (FAPI_CONTEXT *context)

Asynchronous finish function for Fapi_VerifySignature.

This function should be called after a previous Fapi_VerifySignature_Async. It’s literally the “finish the thing” era 🎀

🍓 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_GENERAL_FAILURE — if an internal error occurred.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_SIGNATURE_VERIFICATION_FAILED — if the signature could not be verified.

---

💜 AUTHOR 💜

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

---

That’s the whole page, bestie. Footer energy: source tpm2-tss, Version 4.1.5, and the date slot is literally not on the footer line, so I’m not inventing one 🙈 Stay verified, stay iconic 💅✨