Esys_Create(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 NAME 💖

Esys_Create — the ESAPI function for the TPM2_Create command. That’s the name section, and we’re already iconic. This page is Esys_Create(3) from the Library Functions Manual, bestie — tpm2-tss girlies rise. 🫶

✨ SYNOPSIS ✨

Here’s the function trio in all their exact, non-negotiable glory:

TSS2_RC Esys_Create_Async (ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_CREATE *inSensitive, const TPM2B_PUBLIC *inPublic, const TPM2B_DATA *outsideInfo, const TPML_PCR_SELECTION *creationPCR)
TSS2_RC Esys_Create (ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_CREATE *inSensitive, const TPM2B_PUBLIC *inPublic, const TPM2B_DATA *outsideInfo, const TPML_PCR_SELECTION *creationPCR, TPM2B_PRIVATE **outPrivate, TPM2B_PUBLIC **outPublic, TPM2B_CREATION_DATA **creationData, TPM2B_DIGEST **creationHash, TPMT_TK_CREATION **creationTicket)
TSS2_RC Esys_Create_Finish (ESYS_CONTEXT *esysContext, TPM2B_PRIVATE **outPrivate, TPM2B_PUBLIC **outPublic, TPM2B_CREATION_DATA **creationData, TPM2B_DIGEST **creationHash, TPMT_TK_CREATION **creationTicket)

🦋 Detailed Description 🦋

Okay so this is the ESAPI function to invoke the TPM2_Create command either as a one-call or in an asynchronous manner. Pick your main character energy: block-until-done, or send-it-and-come-back-later. 💅

🎀 Function Documentation 🎀

💅 TSS2_RC Esys_Create — One-Call function for TPM2_Create

TSS2_RC Esys_Create (ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_CREATE *inSensitive, const TPM2B_PUBLIC *inPublic, const TPM2B_DATA *outsideInfo, const TPML_PCR_SELECTION *creationPCR, TPM2B_PRIVATE **outPrivate, TPM2B_PUBLIC **outPublic, TPM2B_CREATION_DATA **creationData, TPM2B_DIGEST **creationHash, TPMT_TK_CREATION **creationTicket)

This function invokes the TPM2_Create command in a one-call variant. That means it will block until the TPM response is available, no cap. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. ✨

🍓 Parameters

  • esysContext — the ESYS_CONTEXT.
  • parentHandle — handle of parent for new object.
  • shandle1 — session handle for authorization of parentHandle.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • inSensitive — the sensitive data.
  • inPublic — the public template.
  • outsideInfo — data that will be included in the creation data for this object to provide permanent, verifiable linkage between this object and some object owner data.
  • creationPCR — PCR that will be used in creation data.
  • outPrivate — the private portion of the object. (callee-allocated)
  • outPublic — the public portion of the created object. (callee-allocated)
  • creationData — contains a TPMS_CREATION_DATA. (callee-allocated)
  • creationHash — digest of creationData using nameAlg of outPublic. (callee-allocated)
  • creationTicket — ticket used by TPM2_CertifyCreation() to validate that the creation data was produced by the TPM. (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_Create_Async — Asynchronous function for TPM2_Create

TSS2_RC Esys_Create_Async (ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_CREATE *inSensitive, const TPM2B_PUBLIC *inPublic, const TPM2B_DATA *outsideInfo, const TPML_PCR_SELECTION *creationPCR)

This function invokes the TPM2_Create 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_Create_Finish. 🦋

🍓 Parameters

  • esysContext — the ESYS_CONTEXT.
  • parentHandle — handle of parent for new object.
  • shandle1 — session handle for authorization of parentHandle.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • inSensitive — the sensitive data.
  • inPublic — the public template.
  • outsideInfo — data that will be included in the creation data for this object to provide permanent, verifiable linkage between this object and some object owner data.
  • creationPCR — PCR that will be used in creation data.

🔥 Return values

  • ESYS_RC_SUCCESS — if the function call was a success. Yes, bestie, that one starts with ESYS_ in the original — keep it exact. 💅
  • 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_Create_Finish — Asynchronous finish function for TPM2_Create

TSS2_RC Esys_Create_Finish (ESYS_CONTEXT *esysContext, TPM2B_PRIVATE **outPrivate, TPM2B_PUBLIC **outPublic, TPM2B_CREATION_DATA **creationData, TPM2B_DIGEST **creationHash, TPMT_TK_CREATION **creationTicket)

This function returns the results of a TPM2_Create command invoked via Esys_Create_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. 🌸

🍓 Parameters

  • esysContext — the ESYS_CONTEXT.
  • outPrivate — the private portion of the object. (callee-allocated)
  • outPublic — the public portion of the created object. (callee-allocated)
  • creationData — contains a TPMS_CREATION_DATA. (callee-allocated)
  • creationHash — digest of creationData using nameAlg of outPublic. (callee-allocated)
  • creationTicket — ticket used by TPM2_CertifyCreation() to validate that the creation data was produced by the TPM. (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. The robot wrote it, the vibes are ours. 🤖💖

Source/version sign-off: tpm2-tss, Version 4.1.5, footer tag Esys_Create(3) — and the original footer had no separate date line, so no date to quote, bestie. No cap, periodt. 🫶✨

📦 where this page comes from