xref: /aosp_15_r20/external/tpm2-tss/src/tss2-esys/api/Esys_StartAuthSession.c (revision 758e9fba6fc9adbf15340f70c73baee7b168b1c9)
1*758e9fbaSOystein Eftevaag /* SPDX-License-Identifier: BSD-2-Clause */
2*758e9fbaSOystein Eftevaag /*******************************************************************************
3*758e9fbaSOystein Eftevaag  * Copyright 2017-2018, Fraunhofer SIT sponsored by Infineon Technologies AG
4*758e9fbaSOystein Eftevaag  * All rights reserved.
5*758e9fbaSOystein Eftevaag  ******************************************************************************/
6*758e9fbaSOystein Eftevaag 
7*758e9fbaSOystein Eftevaag #ifdef HAVE_CONFIG_H
8*758e9fbaSOystein Eftevaag #include <config.h>
9*758e9fbaSOystein Eftevaag #endif
10*758e9fbaSOystein Eftevaag 
11*758e9fbaSOystein Eftevaag #include "tss2_mu.h"
12*758e9fbaSOystein Eftevaag #include "tss2_sys.h"
13*758e9fbaSOystein Eftevaag #include "tss2_esys.h"
14*758e9fbaSOystein Eftevaag 
15*758e9fbaSOystein Eftevaag #include "esys_types.h"
16*758e9fbaSOystein Eftevaag #include "esys_iutil.h"
17*758e9fbaSOystein Eftevaag #include "esys_mu.h"
18*758e9fbaSOystein Eftevaag #define LOGMODULE esys
19*758e9fbaSOystein Eftevaag #include "util/log.h"
20*758e9fbaSOystein Eftevaag #include "util/aux_util.h"
21*758e9fbaSOystein Eftevaag 
22*758e9fbaSOystein Eftevaag /** Store command parameters inside the ESYS_CONTEXT for use during _Finish */
store_input_parameters(ESYS_CONTEXT * esysContext,ESYS_TR tpmKey,ESYS_TR bind,const TPM2B_NONCE * nonceCaller,TPM2_SE sessionType,const TPMT_SYM_DEF * symmetric,TPMI_ALG_HASH authHash)23*758e9fbaSOystein Eftevaag static void store_input_parameters (
24*758e9fbaSOystein Eftevaag     ESYS_CONTEXT *esysContext,
25*758e9fbaSOystein Eftevaag     ESYS_TR tpmKey,
26*758e9fbaSOystein Eftevaag     ESYS_TR bind,
27*758e9fbaSOystein Eftevaag     const TPM2B_NONCE *nonceCaller,
28*758e9fbaSOystein Eftevaag     TPM2_SE sessionType,
29*758e9fbaSOystein Eftevaag     const TPMT_SYM_DEF *symmetric,
30*758e9fbaSOystein Eftevaag     TPMI_ALG_HASH authHash)
31*758e9fbaSOystein Eftevaag {
32*758e9fbaSOystein Eftevaag     esysContext->in.StartAuthSession.tpmKey = tpmKey;
33*758e9fbaSOystein Eftevaag     esysContext->in.StartAuthSession.bind = bind;
34*758e9fbaSOystein Eftevaag     esysContext->in.StartAuthSession.sessionType = sessionType;
35*758e9fbaSOystein Eftevaag     esysContext->in.StartAuthSession.authHash = authHash;
36*758e9fbaSOystein Eftevaag     if (nonceCaller == NULL) {
37*758e9fbaSOystein Eftevaag         esysContext->in.StartAuthSession.nonceCaller = NULL;
38*758e9fbaSOystein Eftevaag     } else {
39*758e9fbaSOystein Eftevaag         esysContext->in.StartAuthSession.nonceCallerData = *nonceCaller;
40*758e9fbaSOystein Eftevaag         esysContext->in.StartAuthSession.nonceCaller =
41*758e9fbaSOystein Eftevaag             &esysContext->in.StartAuthSession.nonceCallerData;
42*758e9fbaSOystein Eftevaag     }
43*758e9fbaSOystein Eftevaag     if (symmetric == NULL) {
44*758e9fbaSOystein Eftevaag         esysContext->in.StartAuthSession.symmetric = NULL;
45*758e9fbaSOystein Eftevaag     } else {
46*758e9fbaSOystein Eftevaag         esysContext->in.StartAuthSession.symmetricData = *symmetric;
47*758e9fbaSOystein Eftevaag         esysContext->in.StartAuthSession.symmetric =
48*758e9fbaSOystein Eftevaag             &esysContext->in.StartAuthSession.symmetricData;
49*758e9fbaSOystein Eftevaag     }
50*758e9fbaSOystein Eftevaag }
51*758e9fbaSOystein Eftevaag 
52*758e9fbaSOystein Eftevaag /** One-Call function for TPM2_StartAuthSession
53*758e9fbaSOystein Eftevaag  *
54*758e9fbaSOystein Eftevaag  * This function invokes the TPM2_StartAuthSession command in a one-call
55*758e9fbaSOystein Eftevaag  * variant. This means the function will block until the TPM response is
56*758e9fbaSOystein Eftevaag  * available. All input parameters are const. The memory for non-simple output
57*758e9fbaSOystein Eftevaag  * parameters is allocated by the function implementation.
58*758e9fbaSOystein Eftevaag  *
59*758e9fbaSOystein Eftevaag  * @param[in,out] esysContext The ESYS_CONTEXT.
60*758e9fbaSOystein Eftevaag  * @param[in]  tpmKey Handle of a loaded decrypt key used to encrypt salt.
61*758e9fbaSOystein Eftevaag  * @param[in]  bind Entity providing the authValue.
62*758e9fbaSOystein Eftevaag  * @param[in]  shandle1 First session handle.
63*758e9fbaSOystein Eftevaag  * @param[in]  shandle2 Second session handle.
64*758e9fbaSOystein Eftevaag  * @param[in]  shandle3 Third session handle.
65*758e9fbaSOystein Eftevaag  * @param[in]  nonceCaller Initial nonceCaller, sets nonceTPM size for the
66*758e9fbaSOystein Eftevaag  *             session.
67*758e9fbaSOystein Eftevaag  * @param[in]  sessionType Indicates the type of the session; simple HMAC or
68*758e9fbaSOystein Eftevaag  *             policy (including a trial policy).
69*758e9fbaSOystein Eftevaag  * @param[in]  symmetric The algorithm and key size for parameter encryption.
70*758e9fbaSOystein Eftevaag  * @param[in]  authHash Hash algorithm to use for the session.
71*758e9fbaSOystein Eftevaag  * @param[out] sessionHandle  ESYS_TR handle of ESYS resource for TPMI_SH_AUTH_SESSION.
72*758e9fbaSOystein Eftevaag  * @retval TSS2_RC_SUCCESS if the function call was a success.
73*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input
74*758e9fbaSOystein Eftevaag  *         pointers or required output handle references are NULL.
75*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_CONTEXT: if esysContext corruption is detected.
76*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_MEMORY: if the ESAPI cannot allocate enough memory for
77*758e9fbaSOystein Eftevaag  *         internal operations or return parameters.
78*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_SEQUENCE: if the context has an asynchronous
79*758e9fbaSOystein Eftevaag  *         operation already pending.
80*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_INSUFFICIENT_RESPONSE: if the TPM's response does not
81*758e9fbaSOystein Eftevaag  *          at least contain the tag, response length, and response code.
82*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_MALFORMED_RESPONSE: if the TPM's response is corrupted.
83*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_RSP_AUTH_FAILED: if the response HMAC from the TPM
84*758e9fbaSOystein Eftevaag            did not verify.
85*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS: if more than one session has
86*758e9fbaSOystein Eftevaag  *         the 'decrypt' attribute bit set.
87*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS: if more than one session has
88*758e9fbaSOystein Eftevaag  *         the 'encrypt' attribute bit set.
89*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_TR: if any of the ESYS_TR objects are unknown
90*758e9fbaSOystein Eftevaag  *         to the ESYS_CONTEXT or are of the wrong type or if required
91*758e9fbaSOystein Eftevaag  *         ESYS_TR objects are ESYS_TR_NONE.
92*758e9fbaSOystein Eftevaag  * @retval TSS2_RCs produced by lower layers of the software stack may be
93*758e9fbaSOystein Eftevaag  *         returned to the caller unaltered unless handled internally.
94*758e9fbaSOystein Eftevaag  */
95*758e9fbaSOystein Eftevaag TSS2_RC
Esys_StartAuthSession(ESYS_CONTEXT * esysContext,ESYS_TR tpmKey,ESYS_TR bind,ESYS_TR shandle1,ESYS_TR shandle2,ESYS_TR shandle3,const TPM2B_NONCE * nonceCaller,TPM2_SE sessionType,const TPMT_SYM_DEF * symmetric,TPMI_ALG_HASH authHash,ESYS_TR * sessionHandle)96*758e9fbaSOystein Eftevaag Esys_StartAuthSession(
97*758e9fbaSOystein Eftevaag     ESYS_CONTEXT *esysContext,
98*758e9fbaSOystein Eftevaag     ESYS_TR tpmKey,
99*758e9fbaSOystein Eftevaag     ESYS_TR bind,
100*758e9fbaSOystein Eftevaag     ESYS_TR shandle1,
101*758e9fbaSOystein Eftevaag     ESYS_TR shandle2,
102*758e9fbaSOystein Eftevaag     ESYS_TR shandle3,
103*758e9fbaSOystein Eftevaag     const TPM2B_NONCE *nonceCaller,
104*758e9fbaSOystein Eftevaag     TPM2_SE sessionType,
105*758e9fbaSOystein Eftevaag     const TPMT_SYM_DEF *symmetric,
106*758e9fbaSOystein Eftevaag     TPMI_ALG_HASH authHash, ESYS_TR *sessionHandle)
107*758e9fbaSOystein Eftevaag {
108*758e9fbaSOystein Eftevaag     TSS2_RC r;
109*758e9fbaSOystein Eftevaag 
110*758e9fbaSOystein Eftevaag     r = Esys_StartAuthSession_Async(esysContext, tpmKey, bind, shandle1,
111*758e9fbaSOystein Eftevaag                                     shandle2, shandle3, nonceCaller, sessionType,
112*758e9fbaSOystein Eftevaag                                     symmetric, authHash);
113*758e9fbaSOystein Eftevaag     return_if_error(r, "Error in async function");
114*758e9fbaSOystein Eftevaag 
115*758e9fbaSOystein Eftevaag     /* Set the timeout to indefinite for now, since we want _Finish to block */
116*758e9fbaSOystein Eftevaag     int32_t timeouttmp = esysContext->timeout;
117*758e9fbaSOystein Eftevaag     esysContext->timeout = -1;
118*758e9fbaSOystein Eftevaag     /*
119*758e9fbaSOystein Eftevaag      * Now we call the finish function, until return code is not equal to
120*758e9fbaSOystein Eftevaag      * from TSS2_BASE_RC_TRY_AGAIN.
121*758e9fbaSOystein Eftevaag      * Note that the finish function may return TSS2_RC_TRY_AGAIN, even if we
122*758e9fbaSOystein Eftevaag      * have set the timeout to -1. This occurs for example if the TPM requests
123*758e9fbaSOystein Eftevaag      * a retransmission of the command via TPM2_RC_YIELDED.
124*758e9fbaSOystein Eftevaag      */
125*758e9fbaSOystein Eftevaag     do {
126*758e9fbaSOystein Eftevaag         r = Esys_StartAuthSession_Finish(esysContext, sessionHandle);
127*758e9fbaSOystein Eftevaag         /* This is just debug information about the reattempt to finish the
128*758e9fbaSOystein Eftevaag            command */
129*758e9fbaSOystein Eftevaag         if ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN)
130*758e9fbaSOystein Eftevaag             LOG_DEBUG("A layer below returned TRY_AGAIN: %" PRIx32
131*758e9fbaSOystein Eftevaag                       " => resubmitting command", r);
132*758e9fbaSOystein Eftevaag     } while ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN);
133*758e9fbaSOystein Eftevaag 
134*758e9fbaSOystein Eftevaag     /* Restore the timeout value to the original value */
135*758e9fbaSOystein Eftevaag     esysContext->timeout = timeouttmp;
136*758e9fbaSOystein Eftevaag     return_if_error(r, "Esys Finish");
137*758e9fbaSOystein Eftevaag 
138*758e9fbaSOystein Eftevaag     return TSS2_RC_SUCCESS;
139*758e9fbaSOystein Eftevaag }
140*758e9fbaSOystein Eftevaag 
141*758e9fbaSOystein Eftevaag /** Asynchronous function for TPM2_StartAuthSession
142*758e9fbaSOystein Eftevaag  *
143*758e9fbaSOystein Eftevaag  * This function invokes the TPM2_StartAuthSession command in a asynchronous
144*758e9fbaSOystein Eftevaag  * variant. This means the function will return as soon as the command has been
145*758e9fbaSOystein Eftevaag  * sent downwards the stack to the TPM. All input parameters are const.
146*758e9fbaSOystein Eftevaag  * In order to retrieve the TPM's response call Esys_StartAuthSession_Finish.
147*758e9fbaSOystein Eftevaag  *
148*758e9fbaSOystein Eftevaag  * @param[in,out] esysContext The ESYS_CONTEXT.
149*758e9fbaSOystein Eftevaag  * @param[in]  tpmKey Handle of a loaded decrypt key used to encrypt salt.
150*758e9fbaSOystein Eftevaag  * @param[in]  bind Entity providing the authValue.
151*758e9fbaSOystein Eftevaag  * @param[in]  shandle1 First session handle.
152*758e9fbaSOystein Eftevaag  * @param[in]  shandle2 Second session handle.
153*758e9fbaSOystein Eftevaag  * @param[in]  shandle3 Third session handle.
154*758e9fbaSOystein Eftevaag  * @param[in]  nonceCaller Initial nonceCaller, sets nonceTPM size for the
155*758e9fbaSOystein Eftevaag  *             session.
156*758e9fbaSOystein Eftevaag  * @param[in]  sessionType Indicates the type of the session; simple HMAC or
157*758e9fbaSOystein Eftevaag  *             policy (including a trial policy).
158*758e9fbaSOystein Eftevaag  * @param[in]  symmetric The algorithm and key size for parameter encryption.
159*758e9fbaSOystein Eftevaag  * @param[in]  authHash Hash algorithm to use for the session.
160*758e9fbaSOystein Eftevaag  * @retval ESYS_RC_SUCCESS if the function call was a success.
161*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input
162*758e9fbaSOystein Eftevaag  *         pointers or required output handle references are NULL.
163*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_CONTEXT: if esysContext corruption is detected.
164*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_MEMORY: if the ESAPI cannot allocate enough memory for
165*758e9fbaSOystein Eftevaag  *         internal operations or return parameters.
166*758e9fbaSOystein Eftevaag  * @retval TSS2_RCs produced by lower layers of the software stack may be
167*758e9fbaSOystein Eftevaag            returned to the caller unaltered unless handled internally.
168*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS: if more than one session has
169*758e9fbaSOystein Eftevaag  *         the 'decrypt' attribute bit set.
170*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS: if more than one session has
171*758e9fbaSOystein Eftevaag  *         the 'encrypt' attribute bit set.
172*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_TR: if any of the ESYS_TR objects are unknown
173*758e9fbaSOystein Eftevaag  *         to the ESYS_CONTEXT or are of the wrong type or if required
174*758e9fbaSOystein Eftevaag  *         ESYS_TR objects are ESYS_TR_NONE.
175*758e9fbaSOystein Eftevaag  */
176*758e9fbaSOystein Eftevaag TSS2_RC
Esys_StartAuthSession_Async(ESYS_CONTEXT * esysContext,ESYS_TR tpmKey,ESYS_TR bind,ESYS_TR shandle1,ESYS_TR shandle2,ESYS_TR shandle3,const TPM2B_NONCE * nonceCaller,TPM2_SE sessionType,const TPMT_SYM_DEF * symmetric,TPMI_ALG_HASH authHash)177*758e9fbaSOystein Eftevaag Esys_StartAuthSession_Async(
178*758e9fbaSOystein Eftevaag     ESYS_CONTEXT *esysContext,
179*758e9fbaSOystein Eftevaag     ESYS_TR tpmKey,
180*758e9fbaSOystein Eftevaag     ESYS_TR bind,
181*758e9fbaSOystein Eftevaag     ESYS_TR shandle1,
182*758e9fbaSOystein Eftevaag     ESYS_TR shandle2,
183*758e9fbaSOystein Eftevaag     ESYS_TR shandle3,
184*758e9fbaSOystein Eftevaag     const TPM2B_NONCE *nonceCaller,
185*758e9fbaSOystein Eftevaag     TPM2_SE sessionType,
186*758e9fbaSOystein Eftevaag     const TPMT_SYM_DEF *symmetric,
187*758e9fbaSOystein Eftevaag     TPMI_ALG_HASH authHash)
188*758e9fbaSOystein Eftevaag {
189*758e9fbaSOystein Eftevaag     TSS2_RC r;
190*758e9fbaSOystein Eftevaag     LOG_TRACE("context=%p, tpmKey=%"PRIx32 ", bind=%"PRIx32 ","
191*758e9fbaSOystein Eftevaag               "nonceCaller=%p, sessionType=%02"PRIx8", symmetric=%p,"
192*758e9fbaSOystein Eftevaag               "authHash=%04"PRIx16"",
193*758e9fbaSOystein Eftevaag               esysContext, tpmKey, bind, nonceCaller, sessionType,
194*758e9fbaSOystein Eftevaag               symmetric, authHash);
195*758e9fbaSOystein Eftevaag     TPM2B_ENCRYPTED_SECRET encryptedSaltAux;
196*758e9fbaSOystein Eftevaag     const TPM2B_ENCRYPTED_SECRET *encryptedSalt = &encryptedSaltAux;
197*758e9fbaSOystein Eftevaag     TSS2L_SYS_AUTH_COMMAND auths;
198*758e9fbaSOystein Eftevaag     RSRC_NODE_T *tpmKeyNode;
199*758e9fbaSOystein Eftevaag     RSRC_NODE_T *bindNode;
200*758e9fbaSOystein Eftevaag 
201*758e9fbaSOystein Eftevaag     /* Check context, sequence correctness and set state to error for now */
202*758e9fbaSOystein Eftevaag     if (esysContext == NULL) {
203*758e9fbaSOystein Eftevaag         LOG_ERROR("esyscontext is NULL.");
204*758e9fbaSOystein Eftevaag         return TSS2_ESYS_RC_BAD_REFERENCE;
205*758e9fbaSOystein Eftevaag     }
206*758e9fbaSOystein Eftevaag     r = iesys_check_sequence_async(esysContext);
207*758e9fbaSOystein Eftevaag     if (r != TSS2_RC_SUCCESS)
208*758e9fbaSOystein Eftevaag         return r;
209*758e9fbaSOystein Eftevaag     esysContext->state = _ESYS_STATE_INTERNALERROR;
210*758e9fbaSOystein Eftevaag 
211*758e9fbaSOystein Eftevaag     /* Check input parameters */
212*758e9fbaSOystein Eftevaag     r = check_session_feasibility(shandle1, shandle2, shandle3, 0);
213*758e9fbaSOystein Eftevaag     return_state_if_error(r, _ESYS_STATE_INIT, "Check session usage");
214*758e9fbaSOystein Eftevaag     store_input_parameters(esysContext, tpmKey, bind, nonceCaller, sessionType,
215*758e9fbaSOystein Eftevaag                            symmetric, authHash);
216*758e9fbaSOystein Eftevaag 
217*758e9fbaSOystein Eftevaag     /* Retrieve the metadata objects for provided handles */
218*758e9fbaSOystein Eftevaag     r = esys_GetResourceObject(esysContext, tpmKey, &tpmKeyNode);
219*758e9fbaSOystein Eftevaag     return_state_if_error(r, _ESYS_STATE_INIT, "tpmKey unknown.");
220*758e9fbaSOystein Eftevaag     r = esys_GetResourceObject(esysContext, bind, &bindNode);
221*758e9fbaSOystein Eftevaag     return_state_if_error(r, _ESYS_STATE_INIT, "bind unknown.");
222*758e9fbaSOystein Eftevaag     size_t authHash_size = 0;
223*758e9fbaSOystein Eftevaag     TSS2_RC r2;
224*758e9fbaSOystein Eftevaag     r2 = iesys_compute_encrypted_salt(esysContext, tpmKeyNode,
225*758e9fbaSOystein Eftevaag                                       &encryptedSaltAux);
226*758e9fbaSOystein Eftevaag     return_state_if_error(r2, _ESYS_STATE_INIT, "Error in parameter encryption.");
227*758e9fbaSOystein Eftevaag 
228*758e9fbaSOystein Eftevaag     if (nonceCaller == NULL) {
229*758e9fbaSOystein Eftevaag         r2 = iesys_crypto_hash_get_digest_size(authHash,&authHash_size);
230*758e9fbaSOystein Eftevaag         return_state_if_error(r2, _ESYS_STATE_INIT, "Error in hash_get_digest_size.");
231*758e9fbaSOystein Eftevaag 
232*758e9fbaSOystein Eftevaag         r2 = iesys_crypto_random2b(&esysContext->in.StartAuthSession.nonceCallerData,
233*758e9fbaSOystein Eftevaag                                    authHash_size);
234*758e9fbaSOystein Eftevaag         return_state_if_error(r2, _ESYS_STATE_INIT, "Error in crypto_random2b.");
235*758e9fbaSOystein Eftevaag         esysContext->in.StartAuthSession.nonceCaller
236*758e9fbaSOystein Eftevaag            = &esysContext->in.StartAuthSession.nonceCallerData;
237*758e9fbaSOystein Eftevaag         nonceCaller = esysContext->in.StartAuthSession.nonceCaller;
238*758e9fbaSOystein Eftevaag     }
239*758e9fbaSOystein Eftevaag 
240*758e9fbaSOystein Eftevaag     /* Initial invocation of SAPI to prepare the command buffer with parameters */
241*758e9fbaSOystein Eftevaag     r = Tss2_Sys_StartAuthSession_Prepare(esysContext->sys,
242*758e9fbaSOystein Eftevaag                                           (tpmKeyNode == NULL) ? TPM2_RH_NULL
243*758e9fbaSOystein Eftevaag                                            : tpmKeyNode->rsrc.handle,
244*758e9fbaSOystein Eftevaag                                           (bindNode == NULL) ? TPM2_RH_NULL
245*758e9fbaSOystein Eftevaag                                            : bindNode->rsrc.handle, nonceCaller,
246*758e9fbaSOystein Eftevaag                                           encryptedSalt, sessionType, symmetric,
247*758e9fbaSOystein Eftevaag                                           authHash);
248*758e9fbaSOystein Eftevaag     return_state_if_error(r, _ESYS_STATE_INIT, "SAPI Prepare returned error.");
249*758e9fbaSOystein Eftevaag 
250*758e9fbaSOystein Eftevaag     /* Calculate the cpHash Values */
251*758e9fbaSOystein Eftevaag     r = init_session_tab(esysContext, shandle1, shandle2, shandle3);
252*758e9fbaSOystein Eftevaag     return_state_if_error(r, _ESYS_STATE_INIT, "Initialize session resources");
253*758e9fbaSOystein Eftevaag     iesys_compute_session_value(esysContext->session_tab[0], NULL, NULL);
254*758e9fbaSOystein Eftevaag     iesys_compute_session_value(esysContext->session_tab[1], NULL, NULL);
255*758e9fbaSOystein Eftevaag     iesys_compute_session_value(esysContext->session_tab[2], NULL, NULL);
256*758e9fbaSOystein Eftevaag 
257*758e9fbaSOystein Eftevaag     /* Generate the auth values and set them in the SAPI command buffer */
258*758e9fbaSOystein Eftevaag 
259*758e9fbaSOystein Eftevaag     RSRC_NODE_T none;
260*758e9fbaSOystein Eftevaag     size_t offset = 0;
261*758e9fbaSOystein Eftevaag     none.rsrc.handle = TPM2_RH_NULL;
262*758e9fbaSOystein Eftevaag     none.rsrc.rsrcType = IESYSC_WITHOUT_MISC_RSRC;
263*758e9fbaSOystein Eftevaag     r = Tss2_MU_TPM2_HANDLE_Marshal(TPM2_RH_NULL,
264*758e9fbaSOystein Eftevaag                                 none.rsrc.name.name,
265*758e9fbaSOystein Eftevaag                                 sizeof(none.rsrc.name.name),
266*758e9fbaSOystein Eftevaag                                 &offset);
267*758e9fbaSOystein Eftevaag     return_state_if_error(r, _ESYS_STATE_INIT, "Marshaling TPM handle.");
268*758e9fbaSOystein Eftevaag     none.rsrc.name.size = offset;
269*758e9fbaSOystein Eftevaag     r = iesys_gen_auths(esysContext, tpmKeyNode ? tpmKeyNode : &none,
270*758e9fbaSOystein Eftevaag                                      bindNode ? bindNode : &none, NULL, &auths);
271*758e9fbaSOystein Eftevaag     return_state_if_error(r, _ESYS_STATE_INIT,
272*758e9fbaSOystein Eftevaag                           "Error in computation of auth values");
273*758e9fbaSOystein Eftevaag 
274*758e9fbaSOystein Eftevaag     esysContext->authsCount = auths.count;
275*758e9fbaSOystein Eftevaag     if (auths.count > 0) {
276*758e9fbaSOystein Eftevaag         r = Tss2_Sys_SetCmdAuths(esysContext->sys, &auths);
277*758e9fbaSOystein Eftevaag         return_state_if_error(r, _ESYS_STATE_INIT, "SAPI error on SetCmdAuths");
278*758e9fbaSOystein Eftevaag     }
279*758e9fbaSOystein Eftevaag 
280*758e9fbaSOystein Eftevaag     /* Trigger execution and finish the async invocation */
281*758e9fbaSOystein Eftevaag     r = Tss2_Sys_ExecuteAsync(esysContext->sys);
282*758e9fbaSOystein Eftevaag     return_state_if_error(r, _ESYS_STATE_INTERNALERROR,
283*758e9fbaSOystein Eftevaag                           "Finish (Execute Async)");
284*758e9fbaSOystein Eftevaag 
285*758e9fbaSOystein Eftevaag     esysContext->state = _ESYS_STATE_SENT;
286*758e9fbaSOystein Eftevaag 
287*758e9fbaSOystein Eftevaag     return r;
288*758e9fbaSOystein Eftevaag }
289*758e9fbaSOystein Eftevaag 
290*758e9fbaSOystein Eftevaag /** Asynchronous finish function for TPM2_StartAuthSession
291*758e9fbaSOystein Eftevaag  *
292*758e9fbaSOystein Eftevaag  * This function returns the results of a TPM2_StartAuthSession command
293*758e9fbaSOystein Eftevaag  * invoked via Esys_StartAuthSession_Finish. All non-simple output parameters
294*758e9fbaSOystein Eftevaag  * are allocated by the function's implementation. NULL can be passed for every
295*758e9fbaSOystein Eftevaag  * output parameter if the value is not required.
296*758e9fbaSOystein Eftevaag  *
297*758e9fbaSOystein Eftevaag  * @param[in,out] esysContext The ESYS_CONTEXT.
298*758e9fbaSOystein Eftevaag  * @param[out] sessionHandle  ESYS_TR handle of ESYS resource for TPMI_SH_AUTH_SESSION.
299*758e9fbaSOystein Eftevaag  * @retval TSS2_RC_SUCCESS on success
300*758e9fbaSOystein Eftevaag  * @retval ESYS_RC_SUCCESS if the function call was a success.
301*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input
302*758e9fbaSOystein Eftevaag  *         pointers or required output handle references are NULL.
303*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_CONTEXT: if esysContext corruption is detected.
304*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_MEMORY: if the ESAPI cannot allocate enough memory for
305*758e9fbaSOystein Eftevaag  *         internal operations or return parameters.
306*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_BAD_SEQUENCE: if the context has an asynchronous
307*758e9fbaSOystein Eftevaag  *         operation already pending.
308*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_TRY_AGAIN: if the timeout counter expires before the
309*758e9fbaSOystein Eftevaag  *         TPM response is received.
310*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_INSUFFICIENT_RESPONSE: if the TPM's response does not
311*758e9fbaSOystein Eftevaag  *         at least contain the tag, response length, and response code.
312*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_RSP_AUTH_FAILED: if the response HMAC from the TPM did
313*758e9fbaSOystein Eftevaag  *         not verify.
314*758e9fbaSOystein Eftevaag  * @retval TSS2_ESYS_RC_MALFORMED_RESPONSE: if the TPM's response is corrupted.
315*758e9fbaSOystein Eftevaag  * @retval TSS2_RCs produced by lower layers of the software stack may be
316*758e9fbaSOystein Eftevaag  *         returned to the caller unaltered unless handled internally.
317*758e9fbaSOystein Eftevaag  */
318*758e9fbaSOystein Eftevaag TSS2_RC
Esys_StartAuthSession_Finish(ESYS_CONTEXT * esysContext,ESYS_TR * sessionHandle)319*758e9fbaSOystein Eftevaag Esys_StartAuthSession_Finish(
320*758e9fbaSOystein Eftevaag     ESYS_CONTEXT *esysContext, ESYS_TR *sessionHandle)
321*758e9fbaSOystein Eftevaag {
322*758e9fbaSOystein Eftevaag     TPM2B_NONCE lnonceTPM;
323*758e9fbaSOystein Eftevaag     TSS2_RC r;
324*758e9fbaSOystein Eftevaag     LOG_TRACE("context=%p, sessionHandle=%p",
325*758e9fbaSOystein Eftevaag               esysContext, sessionHandle);
326*758e9fbaSOystein Eftevaag 
327*758e9fbaSOystein Eftevaag     if (esysContext == NULL) {
328*758e9fbaSOystein Eftevaag         LOG_ERROR("esyscontext is NULL.");
329*758e9fbaSOystein Eftevaag         return TSS2_ESYS_RC_BAD_REFERENCE;
330*758e9fbaSOystein Eftevaag     }
331*758e9fbaSOystein Eftevaag 
332*758e9fbaSOystein Eftevaag     /* Check for correct sequence and set sequence to irregular for now */
333*758e9fbaSOystein Eftevaag     if (esysContext->state != _ESYS_STATE_SENT &&
334*758e9fbaSOystein Eftevaag         esysContext->state != _ESYS_STATE_RESUBMISSION) {
335*758e9fbaSOystein Eftevaag         LOG_ERROR("Esys called in bad sequence.");
336*758e9fbaSOystein Eftevaag         return TSS2_ESYS_RC_BAD_SEQUENCE;
337*758e9fbaSOystein Eftevaag     }
338*758e9fbaSOystein Eftevaag     esysContext->state = _ESYS_STATE_INTERNALERROR;
339*758e9fbaSOystein Eftevaag     RSRC_NODE_T *sessionHandleNode = NULL;
340*758e9fbaSOystein Eftevaag 
341*758e9fbaSOystein Eftevaag     /* Allocate memory for response parameters */
342*758e9fbaSOystein Eftevaag     if (sessionHandle == NULL) {
343*758e9fbaSOystein Eftevaag         LOG_ERROR("Handle sessionHandle may not be NULL");
344*758e9fbaSOystein Eftevaag         return TSS2_ESYS_RC_BAD_REFERENCE;
345*758e9fbaSOystein Eftevaag     }
346*758e9fbaSOystein Eftevaag     *sessionHandle = esysContext->esys_handle_cnt++;
347*758e9fbaSOystein Eftevaag     r = esys_CreateResourceObject(esysContext, *sessionHandle, &sessionHandleNode);
348*758e9fbaSOystein Eftevaag     if (r != TSS2_RC_SUCCESS)
349*758e9fbaSOystein Eftevaag         return r;
350*758e9fbaSOystein Eftevaag 
351*758e9fbaSOystein Eftevaag     IESYS_RESOURCE *rsrc = &sessionHandleNode->rsrc;
352*758e9fbaSOystein Eftevaag     rsrc->handle = ESYS_TR_NONE;
353*758e9fbaSOystein Eftevaag     rsrc->misc.rsrc_session.sessionAttributes = TPMA_SESSION_CONTINUESESSION;
354*758e9fbaSOystein Eftevaag     rsrc->misc.rsrc_session.sessionType = esysContext->in.StartAuthSession.sessionType;
355*758e9fbaSOystein Eftevaag     rsrc->misc.rsrc_session.authHash = esysContext->in.StartAuthSession.authHash;
356*758e9fbaSOystein Eftevaag     rsrc->misc.rsrc_session.symmetric = *esysContext->in.StartAuthSession.symmetric;
357*758e9fbaSOystein Eftevaag     rsrc->misc.rsrc_session.nonceCaller = esysContext->in.StartAuthSession.nonceCallerData;
358*758e9fbaSOystein Eftevaag 
359*758e9fbaSOystein Eftevaag     /* Receive the TPM response and handle resubmissions if necessary. */
360*758e9fbaSOystein Eftevaag     r = Tss2_Sys_ExecuteFinish(esysContext->sys, esysContext->timeout);
361*758e9fbaSOystein Eftevaag     if ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN) {
362*758e9fbaSOystein Eftevaag         LOG_DEBUG("A layer below returned TRY_AGAIN: %" PRIx32, r);
363*758e9fbaSOystein Eftevaag         esysContext->state = _ESYS_STATE_SENT;
364*758e9fbaSOystein Eftevaag         goto error_cleanup;
365*758e9fbaSOystein Eftevaag     }
366*758e9fbaSOystein Eftevaag     /* This block handle the resubmission of TPM commands given a certain set of
367*758e9fbaSOystein Eftevaag      * TPM response codes. */
368*758e9fbaSOystein Eftevaag     if (r == TPM2_RC_RETRY || r == TPM2_RC_TESTING || r == TPM2_RC_YIELDED) {
369*758e9fbaSOystein Eftevaag         LOG_DEBUG("TPM returned RETRY, TESTING or YIELDED, which triggers a "
370*758e9fbaSOystein Eftevaag             "resubmission: %" PRIx32, r);
371*758e9fbaSOystein Eftevaag         if (esysContext->submissionCount++ >= _ESYS_MAX_SUBMISSIONS) {
372*758e9fbaSOystein Eftevaag             LOG_WARNING("Maximum number of (re)submissions has been reached.");
373*758e9fbaSOystein Eftevaag             esysContext->state = _ESYS_STATE_INIT;
374*758e9fbaSOystein Eftevaag             goto error_cleanup;
375*758e9fbaSOystein Eftevaag         }
376*758e9fbaSOystein Eftevaag         esysContext->state = _ESYS_STATE_RESUBMISSION;
377*758e9fbaSOystein Eftevaag         r = Tss2_Sys_ExecuteAsync(esysContext->sys);
378*758e9fbaSOystein Eftevaag         if (r != TSS2_RC_SUCCESS) {
379*758e9fbaSOystein Eftevaag             LOG_WARNING("Error attempting to resubmit");
380*758e9fbaSOystein Eftevaag             /* We do not set esysContext->state here but inherit the most recent
381*758e9fbaSOystein Eftevaag              * state of the _async function. */
382*758e9fbaSOystein Eftevaag             goto error_cleanup;
383*758e9fbaSOystein Eftevaag         }
384*758e9fbaSOystein Eftevaag         r = TSS2_ESYS_RC_TRY_AGAIN;
385*758e9fbaSOystein Eftevaag         LOG_DEBUG("Resubmission initiated and returning RC_TRY_AGAIN.");
386*758e9fbaSOystein Eftevaag         goto error_cleanup;
387*758e9fbaSOystein Eftevaag     }
388*758e9fbaSOystein Eftevaag     /* The following is the "regular error" handling. */
389*758e9fbaSOystein Eftevaag     if (iesys_tpm_error(r)) {
390*758e9fbaSOystein Eftevaag         LOG_WARNING("Received TPM Error");
391*758e9fbaSOystein Eftevaag         esysContext->state = _ESYS_STATE_INIT;
392*758e9fbaSOystein Eftevaag         goto error_cleanup;
393*758e9fbaSOystein Eftevaag     } else if (r != TSS2_RC_SUCCESS) {
394*758e9fbaSOystein Eftevaag         LOG_ERROR("Received a non-TPM Error");
395*758e9fbaSOystein Eftevaag         esysContext->state = _ESYS_STATE_INTERNALERROR;
396*758e9fbaSOystein Eftevaag         goto error_cleanup;
397*758e9fbaSOystein Eftevaag     }
398*758e9fbaSOystein Eftevaag 
399*758e9fbaSOystein Eftevaag     /*
400*758e9fbaSOystein Eftevaag      * Now the verification of the response (hmac check) and if necessary the
401*758e9fbaSOystein Eftevaag      * parameter decryption have to be done.
402*758e9fbaSOystein Eftevaag      */
403*758e9fbaSOystein Eftevaag     r = iesys_check_response(esysContext);
404*758e9fbaSOystein Eftevaag     goto_state_if_error(r, _ESYS_STATE_INTERNALERROR, "Error: check response",
405*758e9fbaSOystein Eftevaag                         error_cleanup);
406*758e9fbaSOystein Eftevaag 
407*758e9fbaSOystein Eftevaag     /*
408*758e9fbaSOystein Eftevaag      * After the verification of the response we call the complete function
409*758e9fbaSOystein Eftevaag      * to deliver the result.
410*758e9fbaSOystein Eftevaag      */
411*758e9fbaSOystein Eftevaag     r = Tss2_Sys_StartAuthSession_Complete(esysContext->sys,
412*758e9fbaSOystein Eftevaag                                            &sessionHandleNode->rsrc.handle,
413*758e9fbaSOystein Eftevaag                                            &lnonceTPM);
414*758e9fbaSOystein Eftevaag     goto_state_if_error(r, _ESYS_STATE_INTERNALERROR,
415*758e9fbaSOystein Eftevaag                         "Received error from SAPI unmarshaling" ,
416*758e9fbaSOystein Eftevaag                         error_cleanup);
417*758e9fbaSOystein Eftevaag 
418*758e9fbaSOystein Eftevaag     sessionHandleNode->rsrc.misc.rsrc_session.nonceTPM = lnonceTPM;
419*758e9fbaSOystein Eftevaag     sessionHandleNode->rsrc.rsrcType = IESYSC_SESSION_RSRC;
420*758e9fbaSOystein Eftevaag     if (esysContext->in.StartAuthSession.bind != ESYS_TR_NONE || esysContext->salt.size > 0) {
421*758e9fbaSOystein Eftevaag         ESYS_TR bind = esysContext->in.StartAuthSession.bind;
422*758e9fbaSOystein Eftevaag         ESYS_TR tpmKey = esysContext->in.StartAuthSession.tpmKey;
423*758e9fbaSOystein Eftevaag         RSRC_NODE_T *bindNode;
424*758e9fbaSOystein Eftevaag         r = esys_GetResourceObject(esysContext, bind, &bindNode);
425*758e9fbaSOystein Eftevaag         goto_if_error(r, "get resource", error_cleanup);
426*758e9fbaSOystein Eftevaag 
427*758e9fbaSOystein Eftevaag         RSRC_NODE_T *tpmKeyNode;
428*758e9fbaSOystein Eftevaag         r = esys_GetResourceObject(esysContext, tpmKey, &tpmKeyNode);
429*758e9fbaSOystein Eftevaag         goto_if_error(r, "get resource", error_cleanup);
430*758e9fbaSOystein Eftevaag 
431*758e9fbaSOystein Eftevaag         size_t keyHash_size = 0;
432*758e9fbaSOystein Eftevaag         size_t authHash_size = 0;
433*758e9fbaSOystein Eftevaag         if (tpmKeyNode != NULL) {
434*758e9fbaSOystein Eftevaag             r = iesys_crypto_hash_get_digest_size(
435*758e9fbaSOystein Eftevaag                      tpmKeyNode->rsrc.misc.rsrc_key_pub.publicArea.nameAlg, &
436*758e9fbaSOystein Eftevaag                      keyHash_size);
437*758e9fbaSOystein Eftevaag             if (r != TSS2_RC_SUCCESS) {
438*758e9fbaSOystein Eftevaag                 LOG_ERROR("Error: initialize auth session (%x).", r);
439*758e9fbaSOystein Eftevaag                 return r;
440*758e9fbaSOystein Eftevaag             }
441*758e9fbaSOystein Eftevaag         }
442*758e9fbaSOystein Eftevaag         r = iesys_crypto_hash_get_digest_size(esysContext->in.StartAuthSession.
443*758e9fbaSOystein Eftevaag                                               authHash,&authHash_size);
444*758e9fbaSOystein Eftevaag         if (r != TSS2_RC_SUCCESS) {
445*758e9fbaSOystein Eftevaag             LOG_ERROR("Error: initialize auth session (%x).", r);
446*758e9fbaSOystein Eftevaag             return r;
447*758e9fbaSOystein Eftevaag         }
448*758e9fbaSOystein Eftevaag         /* compute session key */
449*758e9fbaSOystein Eftevaag         size_t secret_size = 0;
450*758e9fbaSOystein Eftevaag         if (tpmKey != ESYS_TR_NONE)
451*758e9fbaSOystein Eftevaag             secret_size += keyHash_size;
452*758e9fbaSOystein Eftevaag         if (bind != ESYS_TR_NONE && bindNode != NULL)
453*758e9fbaSOystein Eftevaag             secret_size += bindNode->auth.size;
454*758e9fbaSOystein Eftevaag         /*
455*758e9fbaSOystein Eftevaag          * A non null pointer for secret is required by the subsequent functions,
456*758e9fbaSOystein Eftevaag          * hence a malloc is called with size 1 if secret_size is zero.
457*758e9fbaSOystein Eftevaag          */
458*758e9fbaSOystein Eftevaag         uint8_t *secret = malloc(secret_size ? secret_size : 1);
459*758e9fbaSOystein Eftevaag         if (secret == NULL) {
460*758e9fbaSOystein Eftevaag             LOG_ERROR("Out of memory.");
461*758e9fbaSOystein Eftevaag             return TSS2_ESYS_RC_MEMORY;
462*758e9fbaSOystein Eftevaag          }
463*758e9fbaSOystein Eftevaag         if  (bind != ESYS_TR_NONE && bindNode != NULL
464*758e9fbaSOystein Eftevaag              && bindNode->auth.size > 0)
465*758e9fbaSOystein Eftevaag              memcpy(&secret[0], &bindNode->auth.buffer[0], bindNode->auth.size);
466*758e9fbaSOystein Eftevaag         if (tpmKey != ESYS_TR_NONE)
467*758e9fbaSOystein Eftevaag             memcpy(&secret[(bind == ESYS_TR_NONE || bindNode == NULL) ? 0
468*758e9fbaSOystein Eftevaag                                : bindNode->auth.size],
469*758e9fbaSOystein Eftevaag                            &esysContext->salt.buffer[0], keyHash_size);
470*758e9fbaSOystein Eftevaag         if (bind != ESYS_TR_NONE &&  bindNode != NULL)
471*758e9fbaSOystein Eftevaag             iesys_compute_bound_entity(&bindNode->rsrc.name,
472*758e9fbaSOystein Eftevaag                                        &bindNode->auth,
473*758e9fbaSOystein Eftevaag                                        &sessionHandleNode->rsrc.misc.rsrc_session.bound_entity);
474*758e9fbaSOystein Eftevaag         LOGBLOB_DEBUG(secret, secret_size, "ESYS Session Secret");
475*758e9fbaSOystein Eftevaag         r = iesys_crypto_KDFa(esysContext->in.StartAuthSession.authHash, secret,
476*758e9fbaSOystein Eftevaag                               secret_size, "ATH",
477*758e9fbaSOystein Eftevaag                                &lnonceTPM, esysContext->in.StartAuthSession.nonceCaller,
478*758e9fbaSOystein Eftevaag                                authHash_size*8, NULL,
479*758e9fbaSOystein Eftevaag                      &sessionHandleNode->rsrc.misc.rsrc_session.sessionKey.buffer[0], FALSE);
480*758e9fbaSOystein Eftevaag         free(secret);
481*758e9fbaSOystein Eftevaag         return_if_error(r, "Error in KDFa computation.");
482*758e9fbaSOystein Eftevaag 
483*758e9fbaSOystein Eftevaag         sessionHandleNode->rsrc.misc.rsrc_session.sessionKey.size = authHash_size;
484*758e9fbaSOystein Eftevaag         LOGBLOB_DEBUG(&sessionHandleNode->rsrc.misc.rsrc_session.sessionKey
485*758e9fbaSOystein Eftevaag                       .buffer[0], authHash_size, "Session Key");
486*758e9fbaSOystein Eftevaag         return_if_error(r,"Error KDFa");
487*758e9fbaSOystein Eftevaag     }
488*758e9fbaSOystein Eftevaag     size_t offset = 0;
489*758e9fbaSOystein Eftevaag     r = Tss2_MU_TPM2_HANDLE_Marshal(sessionHandleNode->rsrc.handle,
490*758e9fbaSOystein Eftevaag                                     &sessionHandleNode->rsrc.name.name[0],
491*758e9fbaSOystein Eftevaag                                     sizeof(sessionHandleNode->rsrc.name.name),
492*758e9fbaSOystein Eftevaag                                     &offset);
493*758e9fbaSOystein Eftevaag     goto_if_error(r, "Marshal session name", error_cleanup);
494*758e9fbaSOystein Eftevaag 
495*758e9fbaSOystein Eftevaag     sessionHandleNode->rsrc.name.size = offset;
496*758e9fbaSOystein Eftevaag     memset(&esysContext->salt, '\0', sizeof(esysContext->salt));
497*758e9fbaSOystein Eftevaag     esysContext->state = _ESYS_STATE_INIT;
498*758e9fbaSOystein Eftevaag 
499*758e9fbaSOystein Eftevaag     return TSS2_RC_SUCCESS;
500*758e9fbaSOystein Eftevaag 
501*758e9fbaSOystein Eftevaag error_cleanup:
502*758e9fbaSOystein Eftevaag     if (sessionHandleNode->rsrc.handle != ESYS_TR_NONE) {
503*758e9fbaSOystein Eftevaag         r = Esys_FlushContext(esysContext, sessionHandleNode->rsrc.handle);
504*758e9fbaSOystein Eftevaag         if (r != TSS2_RC_SUCCESS)
505*758e9fbaSOystein Eftevaag             LOG_ERROR("FlushContext failed.");
506*758e9fbaSOystein Eftevaag     }
507*758e9fbaSOystein Eftevaag     Esys_TR_Close(esysContext, sessionHandle);
508*758e9fbaSOystein Eftevaag 
509*758e9fbaSOystein Eftevaag     return r;
510*758e9fbaSOystein Eftevaag }
511