ESYS_TR(3) | tpm2-tss | ESYS_TR(3) |
ESYS_TR - Esys Tpm Resource ESYS_TR
Global ESYS_TR objects
typedef uint32_t ESYS_TR
TSS2_RC Esys_TR_SetAuth (ESYS_CONTEXT *esysContext,
ESYS_TR handle, TPM2B_AUTH const *authValue)
TSS2_RC Esys_TR_GetName (ESYS_CONTEXT *esysContext,
ESYS_TR handle, TPM2B_NAME **name)
TSS2_RC Esys_TR_FromTPMPublic_Async (ESYS_CONTEXT *esysContext,
TPM2_HANDLE tpm_handle, ESYS_TR optionalSession1, ESYS_TR
optionalSession2, ESYS_TR optionalSession3)
TSS2_RC Esys_TR_FromTPMPublic_Finish (ESYS_CONTEXT *esysContext,
ESYS_TR *object)
TSS2_RC Esys_TR_FromTPMPublic (ESYS_CONTEXT *esysContext,
TPM2_HANDLE tpm_handle, ESYS_TR optionalSession1, ESYS_TR
optionalSession2, ESYS_TR optionalSession3, ESYS_TR *object)
TSS2_RC Esys_TR_Serialize (ESYS_CONTEXT *esys_context,
ESYS_TR object, uint8_t **buffer, size_t *buffer_size)
TSS2_RC Esys_TR_Deserialize (ESYS_CONTEXT *esys_context, uint8_t
const *buffer, size_t buffer_size, ESYS_TR *esys_handle)
TSS2_RC Esys_TR_Close (ESYS_CONTEXT *esys_context,
ESYS_TR *rsrc_handle)
TSS2_RC Esys_TRSess_GetAttributes (ESYS_CONTEXT *esysContext,
ESYS_TR session, TPMA_SESSION *flags)
TSS2_RC Esys_TRSess_SetAttributes (ESYS_CONTEXT *esysContext,
ESYS_TR session, TPMA_SESSION flags, TPMA_SESSION mask)
Virtual objects with meta data for Tpm Resources. The Esys TPM Resources are the virtual objects inside the ESYSCONTEXT that hold the metadata for corresponding TPM Resources.
There are a set of global ESYS_TR objects such as ESYS_TR_NON or for the various PCRs and hierarchies. ESYS_TR_MIN_OBJECT denotes the first non-global ESYS_TR object.
Reference to the virtual object inside the ESYS_CONTEXT that holds the metadata for the corresponding TPM Resource. Such can be Transient key, Persistent objects, NV spaces, Sessions or PCRs.
Close an ESYS_TR without removing it from the TPM.
This function deletes an ESYS_TR object from an ESYS_CONTEXT without deleting it from the TPM. This is useful for NV-Indices or persistent keys, after Esys_TR_Serialize has been called. Transient objects should be deleted using Esys_FlushContext.
Parameters
Return values
Deserialization of an ESYS_TR from a byte buffer.
Deserialize the metadata of an ESYS_TR object from a byte buffer that was stored on disk for later use by a different program or context. An object can be deserialized using Esys_TR_Deserialize.
Parameters
Return values
Creation of an ESYS_TR object from TPM metadata.
This function can be used to create ESYS_TR object for Tpm Resources that are not created or loaded (e.g. using ESys_CreatePrimary or ESys_Load) but pre-exist inside the TPM. Examples are NV-Indices or persistent object.
Note: For PCRs and hierarchies, please use the global ESYS_TR identifiers. Note: If a session is provided the TPM is queried for the metadata twice. First without a session to retrieve some metadata then with the session where this metadata is used in the session HMAC calculation and thereby verified.
Since man in the middle attacks should be prevented as much as possible it is recommended to pass a session.
Parameters
Return values
Start synchronous creation of an ESYS_TR object from TPM metadata.
This function starts the asynchronous retrieval of metadata from the TPM in order to create a new ESYS_TR object.
Parameters
Return values
Finish asynchronous creation of an ESYS_TR object from TPM metadata.
This function finishes the asynchronous retrieval of metadata from the TPM in order to create a new ESYS_TR object.
Parameters
Return values
Retrieve the TPM public name of an Esys_TR object.
Some operations (i.e. Esys_PolicyNameHash) require the name of a TPM object to be passed. Esys_TR_GetName provides this name to the caller.
Parameters
Return values
Serialization of an ESYS_TR into a byte buffer.
Serialize the metadata of an ESYS_TR object into a byte buffer such that it can be stored on disk for later use by a different program or context. The serialized object can be deserialized suing Esys_TR_Deserialize.
Parameters
Return values
Set the authorization value of an ESYS_TR.
Authorization values are associated with ESYS_TR Tpm Resource object. They are then picked up whenever an authorization is needed.
Note: The authorization value is not stored in the metadata during Esys_TR_Serialize. Therefor Esys_TR_SetAuth needs to be called again after every Esys_TR_Deserialize.
Parameters
Return values
Retrieve the Session Attributes of the ESYS_TR session.
Sessions possess attributes, such as whether they shall continue of be flushed after the next command, or whether they are used to encrypt parameters. Note: this function only applies to ESYS_TR objects that represent sessions.
Parameters
Return values
Set session attributes
Set or unset a session's attributes according to the provided flags and mask.
new_attributes = old_attributes & ~mask | flags & mask
Note: this function only applies to ESYS_TR objects that represent
sessions.
Parameters
Return values
Generated automatically by Doxygen for tpm2-tss from the source code.
Sun Feb 19 2023 | Version 3.2.1 |