Esys_Hash(3)

🌸 NAME 🌸

Esys_Hash β€” the ESAPI function for the TPM2_Hash command. This page is Esys_Hash(3) from the Library Functions Manual, and yes bestie, we are officially in the manual-page era. πŸ’…


✨ SYNOPSIS ✨

πŸŽ€ Functions πŸŽ€

TSS2_RC Esys_Hash_Finish (ESYS_CONTEXT *esysContext, TPM2B_DIGEST
    **outHash, TPMT_TK_HASHCHECK **validation)

One function, one signature, zero mystery. Slay. ✨


πŸ¦‹ Detailed Description πŸ¦‹

ESAPI function to invoke the TPM2_Hash command either as a one-call or in an asynchronous manner. That’s the whole vibe: one-call mode or async mode, and this page is the ESAPI doorway to TPM2_Hash. 🫢


πŸ’« Function Documentation πŸ’«

πŸ”₯ TSS2_RC Esys_Hash_Finish πŸ”₯

TSS2_RC Esys_Hash_Finish (ESYS_CONTEXT * esysContext, TPM2B_DIGEST **
    outHash, TPMT_TK_HASHCHECK ** validation)

Asynchronous finish function for TPM2_Hash. πŸ’–

This function returns the results of a TPM2_Hash command invoked via Esys_Hash_Finish. 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. No cap, that’s literally the contract. πŸŽ€

🌟 Parameters 🌟

  • esysContext β€” The ESYS_CONTEXT.
  • outHash β€” Results. (callee-allocated)
  • validation β€” TPM2_Ticket indicating that the sequence of octets used to compute outDigest did not start with TPM2_GENERATED_VALUE. (callee-allocated)

πŸ“ 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 hand-writing lore, the Doxygen machine did that.


okay final footer-ish sign-off, bestie: this page comes from tpm2-tss, Version 4.1.5, and the footer also carries Esys_Hash(3). Date? The page doesn’t show one, so I’m not inventing it β€” periodt. πŸ’–βœ¨

πŸ“¦ where this page comes from