Esys_VerifySignature(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

✨ Esys_VerifySignature(3) ✨

Okay bestie, so this is a page from the tpm2-tss library functions manual, and it's literally all about the ESAPI function for the TPM2_VerifySignature command. No cap, it's giving "crypto verification realness" and we're gonna break it down together 💖

🎀 NAME 🎀

Esys_VerifySignature — the ESAPI function for the TPM2_VerifySignature command. That's it, that's the vibe check ✨

🌸 SYNOPSIS 🌸

Functions

TSS2_RC Esys_VerifySignature_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    const TPM2B_DIGEST *digest, const TPMT_SIGNATURE *signature)

TSS2_RC Esys_VerifySignature (ESYS_CONTEXT *esysContext, ESYS_TR
    keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    const TPM2B_DIGEST *digest, const TPMT_SIGNATURE *signature,
    TPMT_TK_VERIFIED **validation)

TSS2_RC Esys_VerifySignature_Finish (ESYS_CONTEXT *esysContext,
    TPMT_TK_VERIFIED **validation)

🦋 Detailed Description 🦋

So basically, this is the ESAPI function to invoke the TPM2_VerifySignature command. You can either do it as a one-call situation or in an asynchronous manner. Two paths, one goal, we love options 💅

🌈 Function Documentation 🌈

💜 TSS2_RC Esys_VerifySignature (ESYS_CONTEXT * esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST * digest, const TPMT_SIGNATURE * signature, TPMT_TK_VERIFIED ** validation)

One-Call function for TPM2_VerifySignature

This function invokes the TPM2_VerifySignature command in a one-call variant, bestie. It means the function will block until the TPM response is available — no multitasking, just vibes waiting for that answer. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation, so you don't gotta worry about that part 🫶

Parameters

  • esysContext — the ESYS_CONTEXT. Your whole context, your main character energy.
  • keyHandle — handle of public key that will be used in the validation. Like, the key we're checking against 🔑
  • shandle1 — first session handle.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • digest — digest of the signed message. The ~essence~ of what was signed.
  • signature — signature to be tested. The thing we're like, is this even real?
  • validation — . (callee-allocated). That's literally what it says, it's callee-allocated, okurrr.

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. Not the vibe.
  • 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_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. Rude.
  • 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_BAD_TR if any of the ESYS_TR objects are unknown to the ESYS_CONTEXT or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE.
  • 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.

🎀 TSS2_RC Esys_VerifySignature_Async (ESYS_CONTEXT * esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST * digest, const TPMT_SIGNATURE * signature)

Asynchronous function for TPM2_VerifySignature

This function invokes the TPM2_VerifySignature command in an asynchronous variant, meaning the function will return as soon as the command has been sent downwards the stack to the TPM. No waiting, we're moving fast 💨 All input parameters are const. In order to retrieve the TPM's response, call Esys_VerifySignature_Finish. That's the whole point, iykyk.

Parameters

  • esysContext — the ESYS_CONTEXT.
  • keyHandle — handle of public key that will be used in the validation.
  • shandle1 — first session handle.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • digest — digest of the signed message.
  • signature — signature to be tested.

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_BAD_TR if any of the ESYS_TR objects are unknown to the ESYS_CONTEXT or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE.
  • 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_VerifySignature_Finish (ESYS_CONTEXT * esysContext, TPMT_TK_VERIFIED ** validation)

Asynchronous finish function for TPM2_VerifySignature

This function returns the results of a TPM2_VerifySignature command invoked via Esys_VerifySignature_Finish. (Yes bestie, it says Esys_VerifySignature_Finish right there in the description — we're just relaying the lore, no editing.) 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 — so like, if you don't need it, just say NULL and move on 🙈

Parameters

  • esysContext — the ESYS_CONTEXT.
  • validation — . (callee-allocated). Again, callee-allocated, keep up 💅

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.
  • 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 me writing a whole essay, it's the robots doing the work fr fr 🤖

So yeah, that's literally the whole page. Esys_VerifySignature, Esys_VerifySignature_Async, and Esys_VerifySignature_Finish — three little icons doing big things in the TPM world. Go verify those signatures, bestie, and remember: TSS2_RC_SUCCESS is the only outcome we're manifesting ✨💖

tpm2-tss · Version 4.1.5 · Esys_VerifySignature(3) — that's the source, the version, and the date vibes, all wrapped up with a bow 🎀 See you in the next manpage, babe! 🦋

📦 where this page comes from