Esys_ObjectChangeAuth(3)

💖 NAME 💖

Esys_ObjectChangeAuth — the ESAPI function for the TPM2_ObjectChangeAuth command. Short, iconic, to the point. 💅

✨ SYNOPSIS ✨

Functions

TSS2_RC Esys_ObjectChangeAuth_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    objectHandle, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_AUTH *newAuth)
TSS2_RC Esys_ObjectChangeAuth (ESYS_CONTEXT *esysContext, ESYS_TR
    objectHandle, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_AUTH *newAuth, TPM2B_PRIVATE
    **outPrivate)
TSS2_RC Esys_ObjectChangeAuth_Finish (ESYS_CONTEXT *esysContext,
    TPM2B_PRIVATE **outPrivate)

These are the three function besties you're working with, okay? 🫶

🦋 Detailed Description 🦋

ESAPI function to invoke the TPM2_ObjectChangeAuth command either as a one-call or in an asynchronous manner. No cap, that's the whole vibe.

🔥 Function Documentation 🔥

🫶 Esys_ObjectChangeAuth — one-call function 🫶

TSS2_RC Esys_ObjectChangeAuth (ESYS_CONTEXT * esysContext, ESYS_TR
    objectHandle, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_AUTH * newAuth, TPM2B_PRIVATE **
    outPrivate)

One-call function for TPM2_ObjectChangeAuth. This function invokes the TPM2_ObjectChangeAuth command in a one-call variant. That means it will block until the TPM response is available — yes, actually wait for it, bestie. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation.

Parameters

• esysContext — The ESYS_CONTEXT.
• objectHandle — Handle of the object.
• parentHandle — Handle of the parent.
• shandle1 — Session handle for authorization of objectHandle
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• newAuth — New authorization value.
• outPrivate — Private area containing the new authorization value. (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_ObjectChangeAuth_Async — async function 🧚

TSS2_RC Esys_ObjectChangeAuth_Async (ESYS_CONTEXT * esysContext, ESYS_TR
    objectHandle, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_AUTH * newAuth)

Asynchronous function for TPM2_ObjectChangeAuth. This function invokes the TPM2_ObjectChangeAuth command in an 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_ObjectChangeAuth_Finish.

Parameters

• esysContext — The ESYS_CONTEXT.
• objectHandle — Handle of the object.
• parentHandle — Handle of the parent.
• shandle1 — Session handle for authorization of objectHandle
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• newAuth — New authorization value.

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_ObjectChangeAuth_Finish — async finish function 🎀

TSS2_RC Esys_ObjectChangeAuth_Finish (ESYS_CONTEXT * esysContext,
    TPM2B_PRIVATE ** outPrivate)

Asynchronous finish function for TPM2_ObjectChangeAuth. This function returns the results of a TPM2_ObjectChangeAuth command invoked via Esys_ObjectChangeAuth_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 — Private area containing the new authorization value. (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 robots wrote this one, bestie. 🤖💅

---

Source/version check: this page is from tpm2-tss Version 4.1.5. The original footer has no date on it, so I'm not inventing one — periodt. 🌈🎀