.TH "Esys_StartAuthSession" 3 "Sun May 7 2023" "Version 4.0.1" "tpm2-tss" \" -*- nroff -*- .ad l .nh .SH NAME Esys_StartAuthSession \- The ESAPI function for the TPM2_StartAuthSession command\&. .SH SYNOPSIS .br .PP .SS "Functions" .in +1c .ti -1c .RI "TSS2_RC \fBEsys_StartAuthSession_Async\fP (\fBESYS_CONTEXT\fP *esysContext, \fBESYS_TR\fP tpmKey, \fBESYS_TR\fP bind, \fBESYS_TR\fP shandle1, \fBESYS_TR\fP shandle2, \fBESYS_TR\fP shandle3, const TPM2B_NONCE *nonceCaller, TPM2_SE sessionType, const TPMT_SYM_DEF *symmetric, TPMI_ALG_HASH authHash)" .br .ti -1c .RI "TSS2_RC \fBEsys_StartAuthSession\fP (\fBESYS_CONTEXT\fP *esysContext, \fBESYS_TR\fP tpmKey, \fBESYS_TR\fP bind, \fBESYS_TR\fP shandle1, \fBESYS_TR\fP shandle2, \fBESYS_TR\fP shandle3, const TPM2B_NONCE *nonceCaller, TPM2_SE sessionType, const TPMT_SYM_DEF *symmetric, TPMI_ALG_HASH authHash, \fBESYS_TR\fP *sessionHandle)" .br .in -1c .SH "Detailed Description" .PP ESAPI function to invoke the TPM2_StartAuthSession command either as a one-call or in an asynchronous manner\&. .SH "Function Documentation" .PP .SS "TSS2_RC Esys_StartAuthSession (\fBESYS_CONTEXT\fP * esysContext, \fBESYS_TR\fP tpmKey, \fBESYS_TR\fP bind, \fBESYS_TR\fP shandle1, \fBESYS_TR\fP shandle2, \fBESYS_TR\fP shandle3, const TPM2B_NONCE * nonceCaller, TPM2_SE sessionType, const TPMT_SYM_DEF * symmetric, TPMI_ALG_HASH authHash, \fBESYS_TR\fP * sessionHandle)" One-Call function for TPM2_StartAuthSession .PP This function invokes the TPM2_StartAuthSession 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\&. .PP \fBParameters\fP .RS 4 \fIesysContext\fP The \fBESYS_CONTEXT\fP\&. .br \fItpmKey\fP Handle of a loaded decrypt key used to encrypt salt\&. .br \fIbind\fP Entity providing the authValue\&. .br \fIshandle1\fP First session handle\&. .br \fIshandle2\fP Second session handle\&. .br \fIshandle3\fP Third session handle\&. .br \fInonceCaller\fP Initial nonceCaller, sets nonceTPM size for the session\&. .br \fIsessionType\fP Indicates the type of the session; simple HMAC or policy (including a trial policy)\&. .br \fIsymmetric\fP The algorithm and key size for parameter encryption\&. .br \fIauthHash\fP Hash algorithm to use for the session\&. .br \fIsessionHandle\fP ESYS_TR handle of ESYS resource for TPMI_SH_AUTH_SESSION\&. .RE .PP \fBReturn values\fP .RS 4 \fITSS2_RC_SUCCESS\fP if the function call was a success\&. .br \fITSS2_ESYS_RC_BAD_REFERENCE\fP if the esysContext or required input pointers or required output handle references are NULL\&. .br \fITSS2_ESYS_RC_BAD_CONTEXT\fP if esysContext corruption is detected\&. .br \fITSS2_ESYS_RC_MEMORY\fP if the ESAPI cannot allocate enough memory for internal operations or return parameters\&. .br \fITSS2_ESYS_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. .br \fITSS2_ESYS_RC_INSUFFICIENT_RESPONSE\fP if the TPM's response does not at least contain the tag, response length, and response code\&. .br \fITSS2_ESYS_RC_MALFORMED_RESPONSE\fP if the TPM's response is corrupted\&. .br \fITSS2_ESYS_RC_RSP_AUTH_FAILED\fP if the response HMAC from the TPM did not verify\&. .br \fITSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS\fP if more than one session has the 'decrypt' attribute bit set\&. .br \fITSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS\fP if more than one session has the 'encrypt' attribute bit set\&. .br \fITSS2_ESYS_RC_BAD_TR\fP if any of the ESYS_TR objects are unknown to the \fBESYS_CONTEXT\fP or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE\&. .br \fITSS2_RCs\fP produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally\&. .RE .PP .SS "TSS2_RC Esys_StartAuthSession_Async (\fBESYS_CONTEXT\fP * esysContext, \fBESYS_TR\fP tpmKey, \fBESYS_TR\fP bind, \fBESYS_TR\fP shandle1, \fBESYS_TR\fP shandle2, \fBESYS_TR\fP shandle3, const TPM2B_NONCE * nonceCaller, TPM2_SE sessionType, const TPMT_SYM_DEF * symmetric, TPMI_ALG_HASH authHash)" Asynchronous function for TPM2_StartAuthSession .PP This function invokes the TPM2_StartAuthSession command in a 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_StartAuthSession_Finish\&. .PP \fBParameters\fP .RS 4 \fIesysContext\fP The \fBESYS_CONTEXT\fP\&. .br \fItpmKey\fP Handle of a loaded decrypt key used to encrypt salt\&. .br \fIbind\fP Entity providing the authValue\&. .br \fIshandle1\fP First session handle\&. .br \fIshandle2\fP Second session handle\&. .br \fIshandle3\fP Third session handle\&. .br \fInonceCaller\fP Initial nonceCaller, sets nonceTPM size for the session\&. .br \fIsessionType\fP Indicates the type of the session; simple HMAC or policy (including a trial policy)\&. .br \fIsymmetric\fP The algorithm and key size for parameter encryption\&. .br \fIauthHash\fP Hash algorithm to use for the session\&. .RE .PP \fBReturn values\fP .RS 4 \fIESYS_RC_SUCCESS\fP if the function call was a success\&. .br \fITSS2_ESYS_RC_BAD_REFERENCE\fP if the esysContext or required input pointers or required output handle references are NULL\&. .br \fITSS2_ESYS_RC_BAD_CONTEXT\fP if esysContext corruption is detected\&. .br \fITSS2_ESYS_RC_MEMORY\fP if the ESAPI cannot allocate enough memory for internal operations or return parameters\&. .br \fITSS2_RCs\fP produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally\&. .br \fITSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS\fP if more than one session has the 'decrypt' attribute bit set\&. .br \fITSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS\fP if more than one session has the 'encrypt' attribute bit set\&. .br \fITSS2_ESYS_RC_BAD_TR\fP if any of the ESYS_TR objects are unknown to the \fBESYS_CONTEXT\fP or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE\&. .RE .PP .SH "Author" .PP Generated automatically by Doxygen for tpm2-tss from the source code\&.