Esys_Duplicate(3)

💖 NAME 💖

Esys_Duplicate — the ESAPI function for the TPM2_Duplicate command. Welcome to the Esys_Duplicate(3) page from the Library Functions Manual, bestie — she's a little technical but honestly iconic.

✨ SYNOPSIS ✨

TSS2_RC Esys_Duplicate_Async (ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR newParentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *encryptionKeyIn, const TPMT_SYM_DEF_OBJECT *symmetricAlg)
TSS2_RC Esys_Duplicate (ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR newParentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *encryptionKeyIn, const TPMT_SYM_DEF_OBJECT *symmetricAlg, TPM2B_DATA **encryptionKeyOut, TPM2B_PRIVATE **duplicate, TPM2B_ENCRYPTED_SECRET **outSymSeed)
TSS2_RC Esys_Duplicate_Finish (ESYS_CONTEXT *esysContext, TPM2B_DATA **encryptionKeyOut, TPM2B_PRIVATE **duplicate, TPM2B_ENCRYPTED_SECRET **outSymSeed)

🌸 Detailed Description 🌸

ESAPI function to invoke the TPM2_Duplicate command either as a one-call or in an asynchronous manner. So like, two whole vibes: send it and wait, or send it and come back for the response later. Both valid. Both slay. 💅

🌈 Function Documentation 🌈

💅 Esys_Duplicate — one-call function for TPM2_Duplicate

TSS2_RC Esys_Duplicate (ESYS_CONTEXT * esysContext, ESYS_TR objectHandle, ESYS_TR newParentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA * encryptionKeyIn, const TPMT_SYM_DEF_OBJECT * symmetricAlg, TPM2B_DATA ** encryptionKeyOut, TPM2B_PRIVATE ** duplicate, TPM2B_ENCRYPTED_SECRET ** outSymSeed)

Okay so this is the full-send one-call variant. It invokes the TPM2_Duplicate command, and it will block until the TPM response is available — no sneaky background business. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. Periodt. 🫶

Parameters

• esysContext — The ESYS_CONTEXT.
• objectHandle — Loaded object to duplicate.
• newParentHandle — Shall reference the public area of an asymmetric key.
• shandle1 — Session handle for authorization of objectHandle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• encryptionKeyIn — Optional symmetric encryption key.
• symmetricAlg — Definition for the symmetric algorithm to be used for the inner wrapper.
• encryptionKeyOut — If the caller provided an encryption key or if symmetricAlg was TPM2_ALG_NULL, then this will be the TPM2_Empty TPM2_Buffer; otherwise, it shall contain the TPM2_TPM-generated, symmetric encryption key for the inner wrapper. (callee-allocated)
• duplicate — Private area that may be encrypted by encryptionKeyIn; and may be doubly encrypted. (callee-allocated)
• outSymSeed — Seed protected by the asymmetric algorithms of new parent (NP). (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.

---

🦋 Esys_Duplicate_Async — asynchronous function for TPM2_Duplicate

TSS2_RC Esys_Duplicate_Async (ESYS_CONTEXT * esysContext, ESYS_TR objectHandle, ESYS_TR newParentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA * encryptionKeyIn, const TPMT_SYM_DEF_OBJECT * symmetricAlg)

This one invokes the TPM2_Duplicate command in a asynchronous variant. That means it returns 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_Duplicate_Finish — that's the finisher, bestie. ✨

Parameters

• esysContext — The ESYS_CONTEXT.
• objectHandle — Loaded object to duplicate.
• newParentHandle — Shall reference the public area of an asymmetric key.
• shandle1 — Session handle for authorization of objectHandle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• encryptionKeyIn — Optional symmetric encryption key.
• symmetricAlg — Definition for the symmetric algorithm to be used for the inner wrapper.

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.

---

🎀 Esys_Duplicate_Finish — asynchronous finish function for TPM2_Duplicate

TSS2_RC Esys_Duplicate_Finish (ESYS_CONTEXT * esysContext, TPM2B_DATA ** encryptionKeyOut, TPM2B_PRIVATE ** duplicate, TPM2B_ENCRYPTED_SECRET ** outSymSeed)

This function returns the results of a TPM2_Duplicate command invoked via Esys_Duplicate_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 — lowkey convenient, highkey valid. 💜

Parameters

• esysContext — The ESYS_CONTEXT.
• encryptionKeyOut — If the caller provided an encryption key or if symmetricAlg was TPM2_ALG_NULL, then this will be the TPM2_Empty TPM2_Buffer; otherwise, it shall contain the TPM2_TPM-generated, symmetric encryption key for the inner wrapper. (callee-allocated)
• duplicate — Private area that may be encrypted by encryptionKeyIn; and may be doubly encrypted. (callee-allocated)
• outSymSeed — Seed protected by the asymmetric algorithms of new parent (NP). (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 writing a dramatic monologue — Doxygen said it, bestie. 😭

---

💖 That's the whole Esys_Duplicate(3) situation! Sourced from tpm2-tss, Version 4.1.5 — date? not listed on the page, but the vibes are timeless. Mwah! ✨