Esys_Rewrap(3)

💖 Esys_Rewrap(3) — the TPM2_Rewrap ESAPI moment

okay so bestie, welcome to Esys_Rewrap(3) from the Library Functions Manual — this page is literally all about the ESAPI function for the TPM2_Rewrap command, and it's giving very specific crypto-gremlin energy. 💅✨

🌸 NAME

Esys_Rewrap — the ESAPI function for the TPM2_Rewrap command. That's the whole name vibe, no cap. 🫶

✨ SYNOPSIS

🎀 Functions

TSS2_RC Esys_Rewrap_Async (ESYS_CONTEXT *esysContext, ESYS_TR oldParent,
    ESYS_TR newParent, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR
    shandle3, const TPM2B_PRIVATE *inDuplicate, const TPM2B_NAME *name,
    const TPM2B_ENCRYPTED_SECRET *inSymSeed)
TSS2_RC Esys_Rewrap (ESYS_CONTEXT *esysContext, ESYS_TR oldParent,
    ESYS_TR newParent, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR
    shandle3, const TPM2B_PRIVATE *inDuplicate, const TPM2B_NAME *name,
    const TPM2B_ENCRYPTED_SECRET *inSymSeed, TPM2B_PRIVATE
    **outDuplicate, TPM2B_ENCRYPTED_SECRET **outSymSeed)
TSS2_RC Esys_Rewrap_Finish (ESYS_CONTEXT *esysContext, TPM2B_PRIVATE
    **outDuplicate, TPM2B_ENCRYPTED_SECRET **outSymSeed)

🦋 Detailed Description

okay so this is the ESAPI function to invoke the TPM2_Rewrap command either as a one-call situation or in an asynchronous manner. Both vibes are on the menu, and both are iconic. 🍓

🧚 Function Documentation

💅 Esys_Rewrap — One-Call function for TPM2_Rewrap

One-Call function for TPM2_Rewrap

This function invokes the TPM2_Rewrap command in a one-call variant. This means the function will block until the TPM response is available. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. No cap, it just waits for the TPM to answer. 💖

🫶 Parameters

• esysContext — The ESYS_CONTEXT.
• oldParent — Parent of object.
• newParent — New parent of the object.
• shandle1 — Session handle for authorization of oldParent.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• inDuplicate — An object encrypted using symmetric key derived from inSymSeed.
• name — The Name of the object being rewrapped.
• inSymSeed — The seed for the symmetric key and HMAC key.
• outDuplicate — An object encrypted using symmetric key derived from outSymSeed. (callee-allocated)
• outSymSeed — Seed for a symmetric key protected by newParent asymmetric key. (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_Rewrap_Async — Asynchronous function for TPM2_Rewrap

Asynchronous function for TPM2_Rewrap

This function invokes the TPM2_Rewrap command in an asynchronous variant. This means the function 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_Rewrap_Finish. It's giving "send it and dip," bestie. 💅

🫶 Parameters

• esysContext — The ESYS_CONTEXT.
• oldParent — Parent of object.
• newParent — New parent of the object.
• shandle1 — Session handle for authorization of oldParent.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• inDuplicate — An object encrypted using symmetric key derived from inSymSeed.
• name — The Name of the object being rewrapped.
• inSymSeed — The seed for the symmetric key and HMAC key.

🌈 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_Rewrap_Finish — Asynchronous finish function for TPM2_Rewrap

Asynchronous finish function for TPM2_Rewrap

This function returns the results of a TPM2_Rewrap command invoked via Esys_Rewrap_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. Yes, that's what the page says — we're keeping the details exactly as they are. 🫶

🫶 Parameters

• esysContext — The ESYS_CONTEXT.
• outDuplicate — An object encrypted using symmetric key derived from outSymSeed. (callee-allocated)
• outSymSeed — Seed for a symmetric key protected by newParent asymmetric key. (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. So like, not me writing this by hand — Doxygen ate and left no crumbs. 💀✨

---

and that's the footer, bestie: tpm2-tss, Version 4.1.5, on the Esys_Rewrap(3) page. There's no date in the footer, so I'm not inventing one — periodt. 🫶💖