Esys_GetTime(3)

Hey bestie 💖 welcome to Esys_GetTime(3) from the Library Functions Manual — the manual name is folded in near the top like a little bookmark, and this page is all about the ESAPI function for the TPM2_GetTime command. It’s giving very specific TPM energy, and we’re gonna get through every single detail together. ✨

---

🎀 NAME 🎀

Esys_GetTime — The ESAPI function for the TPM2_GetTime command.

📜 SYNOPSIS 📜

Functions

Async send-it-off version:

TSS2_RC Esys_GetTime_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    privacyAdminHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR
    shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const
    TPMT_SIG_SCHEME *inScheme)

One-call version:

TSS2_RC Esys_GetTime (ESYS_CONTEXT *esysContext, ESYS_TR
    privacyAdminHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR
    shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const
    TPMT_SIG_SCHEME *inScheme, TPM2B_ATTEST **timeInfo, TPMT_SIGNATURE
    **signature)

Finish-the-async version:

TSS2_RC Esys_GetTime_Finish (ESYS_CONTEXT *esysContext, TPM2B_ATTEST
    **timeInfo, TPMT_SIGNATURE **signature)

🦋 DETAILED DESCRIPTION 🦋

ESAPI function to invoke the TPM2_GetTime command either as a one-call or in an asynchronous manner. That’s the whole menu: one-call energy, or async energy. Pick your vibe. 💅

💅 FUNCTION DOCUMENTATION 💅

👑 TSS2_RC Esys_GetTime — one-call function for TPM2_GetTime 👑

TSS2_RC Esys_GetTime (ESYS_CONTEXT * esysContext, ESYS_TR
    privacyAdminHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR
    shandle2, ESYS_TR shandle3, const TPM2B_DATA * qualifyingData, const
    TPMT_SIG_SCHEME * inScheme, TPM2B_ATTEST ** timeInfo, TPMT_SIGNATURE **
    signature)

One-Call function for TPM2_GetTime. This function invokes the TPM2_GetTime command in a one-call variant. That means it will block until the TPM response is available — no sneaky background nonsense here, bestie. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. 🫶

Parameters

• esysContext — The ESYS_CONTEXT.
• privacyAdminHandle — TPM2_Handle of the privacy administrator (TPM2_RH_ENDORSEMENT).
• signHandle — The keyHandle identifier of a loaded key that can perform digital signatures.
• shandle1 — Session handle for authorization of privacyAdminHandle.
• shandle2 — Session handle for authorization of signHandle.
• shandle3 — Third session handle.
• qualifyingData — Data to tick stamp.
• inScheme — TPM2_Signing scheme to use if the scheme for signHandle is TPM2_ALG_NULL.
• timeInfo — Standard TPM-generated attestation block. (callee-allocated)
• signature — The signature over timeInfo. (callee-allocated)

Return values

• TSS2_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_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.
• 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_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🌈 TSS2_RC Esys_GetTime_Async — asynchronous function for TPM2_GetTime 🌈

TSS2_RC Esys_GetTime_Async (ESYS_CONTEXT * esysContext, ESYS_TR
    privacyAdminHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR
    shandle2, ESYS_TR shandle3, const TPM2B_DATA * qualifyingData, const
    TPMT_SIG_SCHEME * inScheme)

Asynchronous function for TPM2_GetTime. This function invokes the TPM2_GetTime command in an asynchronous variant. That means it will return as soon as the command has been sent downwards the stack to the TPM. All input parameters are const. In order to retrieve the TPM's response, call Esys_GetTime_Finish. 🦋

Parameters

• esysContext — The ESYS_CONTEXT.
• privacyAdminHandle — TPM2_Handle of the privacy administrator (TPM2_RH_ENDORSEMENT).
• signHandle — The keyHandle identifier of a loaded key that can perform digital signatures.
• shandle1 — Session handle for authorization of privacyAdminHandle.
• shandle2 — Session handle for authorization of signHandle.
• shandle3 — Third session handle.
• qualifyingData — Data to tick stamp.
• inScheme — TPM2_Signing scheme to use if the scheme for signHandle is TPM2_ALG_NULL.

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_RC Esys_GetTime_Finish — asynchronous finish function for TPM2_GetTime 🎀

TSS2_RC Esys_GetTime_Finish (ESYS_CONTEXT * esysContext, TPM2B_ATTEST **
    timeInfo, TPMT_SIGNATURE ** signature)

Asynchronous finish function for TPM2_GetTime. This function returns the results of a TPM2_GetTime command invoked via Esys_GetTime_Finish. All non-simple output parameters are allocated by the function's implementation. Also: NULL can be passed for every output parameter if the value is not required — so yes, you can ghost the outputs you don’t need. 🙈

Parameters

• esysContext — The ESYS_CONTEXT.
• timeInfo — Standard TPM-generated attestation block. (callee-allocated)
• signature — The signature over timeInfo. (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, I’m just here to make it make sense, bestie. 💖

---

Cute footer sign-off: tpm2-tss, Version 4.1.5, and Esys_GetTime(3) — the footer has no date listed, so I’m not inventing one, periodt. 🫶💅