xref: /aosp_15_r20/external/tpm2-tss/test/integration/esys-evict-control-serialization.int.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 <stdlib.h>
12*758e9fbaSOystein Eftevaag 
13*758e9fbaSOystein Eftevaag #include "tss2_esys.h"
14*758e9fbaSOystein Eftevaag 
15*758e9fbaSOystein Eftevaag #include "esys_iutil.h"
16*758e9fbaSOystein Eftevaag #define LOGMODULE test
17*758e9fbaSOystein Eftevaag #include "util/log.h"
18*758e9fbaSOystein Eftevaag #include "util/aux_util.h"
19*758e9fbaSOystein Eftevaag 
20*758e9fbaSOystein Eftevaag /** This test is intended to test EvictControl and ESAPI Serialization.
21*758e9fbaSOystein Eftevaag  *
22*758e9fbaSOystein Eftevaag  * We start by creating a primary key (Esys_CreatePrimary). Based on this
23*758e9fbaSOystein Eftevaag  * key a persistent object is created (Esys_EvictControl). The resource of
24*758e9fbaSOystein Eftevaag  * this object will be serialized and deserialized with the corresponding
25*758e9fbaSOystein Eftevaag  * ESAPI functions (Esys_TR_Serialize, Esys_TR_Deserialize).
26*758e9fbaSOystein Eftevaag  * To check whether the deserialization was successful a new object will
27*758e9fbaSOystein Eftevaag  * be created with the handle returned by the deserialize function.
28*758e9fbaSOystein Eftevaag  *
29*758e9fbaSOystein Eftevaag  * Tested ESAPI commands:
30*758e9fbaSOystein Eftevaag  *  - Esys_Create() (M)
31*758e9fbaSOystein Eftevaag  *  - Esys_CreatePrimary() (M)
32*758e9fbaSOystein Eftevaag  *  - Esys_EvictControl() (M)
33*758e9fbaSOystein Eftevaag  *  - Esys_FlushContext() (M)
34*758e9fbaSOystein Eftevaag  *
35*758e9fbaSOystein Eftevaag  * @param[in,out] esys_context The ESYS_CONTEXT.
36*758e9fbaSOystein Eftevaag  * @retval EXIT_FAILURE
37*758e9fbaSOystein Eftevaag  * @retval EXIT_SUCCESS
38*758e9fbaSOystein Eftevaag  */
39*758e9fbaSOystein Eftevaag 
40*758e9fbaSOystein Eftevaag int
test_esys_evict_control_serialization(ESYS_CONTEXT * esys_context)41*758e9fbaSOystein Eftevaag test_esys_evict_control_serialization(ESYS_CONTEXT * esys_context)
42*758e9fbaSOystein Eftevaag {
43*758e9fbaSOystein Eftevaag     TSS2_RC r;
44*758e9fbaSOystein Eftevaag     ESYS_TR primaryHandle = ESYS_TR_NONE;
45*758e9fbaSOystein Eftevaag     ESYS_TR persistent_handle1 = ESYS_TR_NONE;
46*758e9fbaSOystein Eftevaag 
47*758e9fbaSOystein Eftevaag     TPM2B_PUBLIC *outPublic = NULL;
48*758e9fbaSOystein Eftevaag     TPM2B_CREATION_DATA *creationData = NULL;
49*758e9fbaSOystein Eftevaag     TPM2B_DIGEST *creationHash = NULL;
50*758e9fbaSOystein Eftevaag     TPMT_TK_CREATION *creationTicket = NULL;
51*758e9fbaSOystein Eftevaag     TPM2B_PUBLIC *outPublic2 = NULL;
52*758e9fbaSOystein Eftevaag     TPM2B_PRIVATE *outPrivate2 = NULL;
53*758e9fbaSOystein Eftevaag     TPM2B_CREATION_DATA *creationData2 = NULL;
54*758e9fbaSOystein Eftevaag     TPM2B_DIGEST *creationHash2 = NULL;
55*758e9fbaSOystein Eftevaag     TPMT_TK_CREATION *creationTicket2 = NULL;
56*758e9fbaSOystein Eftevaag 
57*758e9fbaSOystein Eftevaag     TPM2B_AUTH authValuePrimary = {
58*758e9fbaSOystein Eftevaag         .size = 5,
59*758e9fbaSOystein Eftevaag         .buffer = {1, 2, 3, 4, 5}
60*758e9fbaSOystein Eftevaag     };
61*758e9fbaSOystein Eftevaag 
62*758e9fbaSOystein Eftevaag     TPM2B_SENSITIVE_CREATE inSensitivePrimary = {
63*758e9fbaSOystein Eftevaag         .size = 0,
64*758e9fbaSOystein Eftevaag         .sensitive = {
65*758e9fbaSOystein Eftevaag             .userAuth = {
66*758e9fbaSOystein Eftevaag                  .size = 0,
67*758e9fbaSOystein Eftevaag                  .buffer = {0 },
68*758e9fbaSOystein Eftevaag              },
69*758e9fbaSOystein Eftevaag             .data = {
70*758e9fbaSOystein Eftevaag                  .size = 0,
71*758e9fbaSOystein Eftevaag                  .buffer = {0},
72*758e9fbaSOystein Eftevaag              },
73*758e9fbaSOystein Eftevaag         },
74*758e9fbaSOystein Eftevaag     };
75*758e9fbaSOystein Eftevaag 
76*758e9fbaSOystein Eftevaag     inSensitivePrimary.sensitive.userAuth = authValuePrimary;
77*758e9fbaSOystein Eftevaag 
78*758e9fbaSOystein Eftevaag     TPM2B_PUBLIC inPublic = {
79*758e9fbaSOystein Eftevaag         .size = 0,
80*758e9fbaSOystein Eftevaag         .publicArea = {
81*758e9fbaSOystein Eftevaag             .type = TPM2_ALG_RSA,
82*758e9fbaSOystein Eftevaag             .nameAlg = TPM2_ALG_SHA256,
83*758e9fbaSOystein Eftevaag             .objectAttributes = (TPMA_OBJECT_USERWITHAUTH |
84*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_RESTRICTED |
85*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_DECRYPT |
86*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_FIXEDTPM |
87*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_FIXEDPARENT |
88*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_SENSITIVEDATAORIGIN),
89*758e9fbaSOystein Eftevaag             .authPolicy = {
90*758e9fbaSOystein Eftevaag                  .size = 0,
91*758e9fbaSOystein Eftevaag              },
92*758e9fbaSOystein Eftevaag             .parameters.rsaDetail = {
93*758e9fbaSOystein Eftevaag                  .symmetric = {
94*758e9fbaSOystein Eftevaag                      .algorithm = TPM2_ALG_AES,
95*758e9fbaSOystein Eftevaag                      .keyBits.aes = 128,
96*758e9fbaSOystein Eftevaag                      .mode.aes = TPM2_ALG_CFB},
97*758e9fbaSOystein Eftevaag                  .scheme = {
98*758e9fbaSOystein Eftevaag                       .scheme = TPM2_ALG_NULL
99*758e9fbaSOystein Eftevaag                   },
100*758e9fbaSOystein Eftevaag                  .keyBits = 2048,
101*758e9fbaSOystein Eftevaag                  .exponent = 0,
102*758e9fbaSOystein Eftevaag              },
103*758e9fbaSOystein Eftevaag             .unique.rsa = {
104*758e9fbaSOystein Eftevaag                  .size = 0,
105*758e9fbaSOystein Eftevaag                  .buffer = {},
106*758e9fbaSOystein Eftevaag              },
107*758e9fbaSOystein Eftevaag         },
108*758e9fbaSOystein Eftevaag     };
109*758e9fbaSOystein Eftevaag     LOG_INFO("\nRSA key will be created.");
110*758e9fbaSOystein Eftevaag 
111*758e9fbaSOystein Eftevaag     TPM2B_DATA outsideInfo = {
112*758e9fbaSOystein Eftevaag         .size = 0,
113*758e9fbaSOystein Eftevaag         .buffer = {},
114*758e9fbaSOystein Eftevaag     };
115*758e9fbaSOystein Eftevaag 
116*758e9fbaSOystein Eftevaag     TPML_PCR_SELECTION creationPCR = {
117*758e9fbaSOystein Eftevaag         .count = 0,
118*758e9fbaSOystein Eftevaag     };
119*758e9fbaSOystein Eftevaag 
120*758e9fbaSOystein Eftevaag     TPM2B_AUTH authValue = {
121*758e9fbaSOystein Eftevaag         .size = 0,
122*758e9fbaSOystein Eftevaag         .buffer = {}
123*758e9fbaSOystein Eftevaag     };
124*758e9fbaSOystein Eftevaag 
125*758e9fbaSOystein Eftevaag     r = Esys_TR_SetAuth(esys_context, ESYS_TR_RH_OWNER, &authValue);
126*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error: TR_SetAuth", error);
127*758e9fbaSOystein Eftevaag 
128*758e9fbaSOystein Eftevaag     RSRC_NODE_T *primaryHandle_node;
129*758e9fbaSOystein Eftevaag 
130*758e9fbaSOystein Eftevaag     r = Esys_CreatePrimary(esys_context, ESYS_TR_RH_OWNER, ESYS_TR_PASSWORD,
131*758e9fbaSOystein Eftevaag                            ESYS_TR_NONE, ESYS_TR_NONE, &inSensitivePrimary, &inPublic,
132*758e9fbaSOystein Eftevaag                            &outsideInfo, &creationPCR, &primaryHandle,
133*758e9fbaSOystein Eftevaag                            &outPublic, &creationData, &creationHash,
134*758e9fbaSOystein Eftevaag                            &creationTicket);
135*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error esys create primary", error);
136*758e9fbaSOystein Eftevaag 
137*758e9fbaSOystein Eftevaag     r = esys_GetResourceObject(esys_context, primaryHandle,
138*758e9fbaSOystein Eftevaag                                &primaryHandle_node);
139*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error Esys GetResourceObject", error);
140*758e9fbaSOystein Eftevaag 
141*758e9fbaSOystein Eftevaag     LOG_INFO("Created Primary with handle 0x%08x...",
142*758e9fbaSOystein Eftevaag              primaryHandle_node->rsrc.handle);
143*758e9fbaSOystein Eftevaag 
144*758e9fbaSOystein Eftevaag     r = Esys_TR_SetAuth(esys_context, primaryHandle, &authValuePrimary);
145*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error: TR_SetAuth", error);
146*758e9fbaSOystein Eftevaag 
147*758e9fbaSOystein Eftevaag     TPM2_HANDLE permanentHandle = TPM2_PERSISTENT_FIRST;
148*758e9fbaSOystein Eftevaag     ESYS_TR persistent_handle2;
149*758e9fbaSOystein Eftevaag 
150*758e9fbaSOystein Eftevaag     r = Esys_EvictControl(esys_context, ESYS_TR_RH_OWNER, primaryHandle,
151*758e9fbaSOystein Eftevaag                           ESYS_TR_PASSWORD, ESYS_TR_NONE, ESYS_TR_NONE,
152*758e9fbaSOystein Eftevaag                           permanentHandle, &persistent_handle1);
153*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error Esys EvictControl", error);
154*758e9fbaSOystein Eftevaag 
155*758e9fbaSOystein Eftevaag     size_t buffer_size;
156*758e9fbaSOystein Eftevaag     uint8_t *buffer;
157*758e9fbaSOystein Eftevaag 
158*758e9fbaSOystein Eftevaag     r = Esys_TR_Serialize(esys_context, persistent_handle1, &buffer, &buffer_size);
159*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error Esys_TR_Serialize", error);
160*758e9fbaSOystein Eftevaag 
161*758e9fbaSOystein Eftevaag     r = Esys_TR_Deserialize(esys_context, buffer, buffer_size, &persistent_handle2);
162*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error Esys_TR_Deserialize", error);
163*758e9fbaSOystein Eftevaag 
164*758e9fbaSOystein Eftevaag     free(buffer);
165*758e9fbaSOystein Eftevaag 
166*758e9fbaSOystein Eftevaag     TPM2B_AUTH authKey2 = {
167*758e9fbaSOystein Eftevaag         .size = 6,
168*758e9fbaSOystein Eftevaag         .buffer = {6, 7, 8, 9, 10, 11}
169*758e9fbaSOystein Eftevaag     };
170*758e9fbaSOystein Eftevaag 
171*758e9fbaSOystein Eftevaag     TPM2B_SENSITIVE_CREATE inSensitive2 = {
172*758e9fbaSOystein Eftevaag         .size = 0,
173*758e9fbaSOystein Eftevaag         .sensitive = {
174*758e9fbaSOystein Eftevaag             .userAuth = {
175*758e9fbaSOystein Eftevaag                  .size = 0,
176*758e9fbaSOystein Eftevaag                  .buffer = {0}
177*758e9fbaSOystein Eftevaag              },
178*758e9fbaSOystein Eftevaag             .data = {
179*758e9fbaSOystein Eftevaag                  .size = 0,
180*758e9fbaSOystein Eftevaag                  .buffer = {}
181*758e9fbaSOystein Eftevaag              }
182*758e9fbaSOystein Eftevaag         }
183*758e9fbaSOystein Eftevaag     };
184*758e9fbaSOystein Eftevaag 
185*758e9fbaSOystein Eftevaag     inSensitive2.sensitive.userAuth = authKey2;
186*758e9fbaSOystein Eftevaag 
187*758e9fbaSOystein Eftevaag     TPM2B_PUBLIC inPublic2 = {
188*758e9fbaSOystein Eftevaag         .size = 0,
189*758e9fbaSOystein Eftevaag         .publicArea = {
190*758e9fbaSOystein Eftevaag             .type = TPM2_ALG_RSA,
191*758e9fbaSOystein Eftevaag             .nameAlg = TPM2_ALG_SHA256,
192*758e9fbaSOystein Eftevaag             .objectAttributes = (TPMA_OBJECT_USERWITHAUTH |
193*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_RESTRICTED |
194*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_DECRYPT |
195*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_FIXEDTPM |
196*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_FIXEDPARENT |
197*758e9fbaSOystein Eftevaag                                  TPMA_OBJECT_SENSITIVEDATAORIGIN),
198*758e9fbaSOystein Eftevaag 
199*758e9fbaSOystein Eftevaag             .authPolicy = {
200*758e9fbaSOystein Eftevaag                  .size = 0,
201*758e9fbaSOystein Eftevaag              },
202*758e9fbaSOystein Eftevaag             .parameters.rsaDetail = {
203*758e9fbaSOystein Eftevaag                  .symmetric = {
204*758e9fbaSOystein Eftevaag                      .algorithm = TPM2_ALG_AES,
205*758e9fbaSOystein Eftevaag                      .keyBits.aes = 128,
206*758e9fbaSOystein Eftevaag                      .mode.aes = TPM2_ALG_CFB
207*758e9fbaSOystein Eftevaag                  },
208*758e9fbaSOystein Eftevaag                  .scheme = {
209*758e9fbaSOystein Eftevaag                       .scheme =
210*758e9fbaSOystein Eftevaag                       TPM2_ALG_NULL,
211*758e9fbaSOystein Eftevaag                   },
212*758e9fbaSOystein Eftevaag                  .keyBits = 2048,
213*758e9fbaSOystein Eftevaag                  .exponent = 0
214*758e9fbaSOystein Eftevaag              },
215*758e9fbaSOystein Eftevaag             .unique.rsa = {
216*758e9fbaSOystein Eftevaag                  .size = 0,
217*758e9fbaSOystein Eftevaag                  .buffer = {}
218*758e9fbaSOystein Eftevaag                  ,
219*758e9fbaSOystein Eftevaag              }
220*758e9fbaSOystein Eftevaag         }
221*758e9fbaSOystein Eftevaag     };
222*758e9fbaSOystein Eftevaag 
223*758e9fbaSOystein Eftevaag     TPM2B_DATA outsideInfo2 = {
224*758e9fbaSOystein Eftevaag         .size = 0,
225*758e9fbaSOystein Eftevaag         .buffer = {}
226*758e9fbaSOystein Eftevaag         ,
227*758e9fbaSOystein Eftevaag     };
228*758e9fbaSOystein Eftevaag 
229*758e9fbaSOystein Eftevaag     TPML_PCR_SELECTION creationPCR2 = {
230*758e9fbaSOystein Eftevaag         .count = 0,
231*758e9fbaSOystein Eftevaag     };
232*758e9fbaSOystein Eftevaag 
233*758e9fbaSOystein Eftevaag     r = Esys_TR_SetAuth(esys_context, persistent_handle2, &authValuePrimary);
234*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error: TR_SetAuth", error);
235*758e9fbaSOystein Eftevaag 
236*758e9fbaSOystein Eftevaag     r = Esys_Create(esys_context,
237*758e9fbaSOystein Eftevaag                     persistent_handle2,
238*758e9fbaSOystein Eftevaag                     ESYS_TR_PASSWORD, ESYS_TR_NONE, ESYS_TR_NONE,
239*758e9fbaSOystein Eftevaag                     &inSensitive2,
240*758e9fbaSOystein Eftevaag                     &inPublic2,
241*758e9fbaSOystein Eftevaag                     &outsideInfo2,
242*758e9fbaSOystein Eftevaag                     &creationPCR2,
243*758e9fbaSOystein Eftevaag                     &outPrivate2,
244*758e9fbaSOystein Eftevaag                     &outPublic2,
245*758e9fbaSOystein Eftevaag                     &creationData2, &creationHash2, &creationTicket2);
246*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error esys create with new handle from evict object",
247*758e9fbaSOystein Eftevaag                   error);
248*758e9fbaSOystein Eftevaag 
249*758e9fbaSOystein Eftevaag     r = Esys_FlushContext(esys_context, primaryHandle);
250*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error during FlushContext", error);
251*758e9fbaSOystein Eftevaag 
252*758e9fbaSOystein Eftevaag     r = Esys_EvictControl(esys_context, ESYS_TR_RH_OWNER, persistent_handle1,
253*758e9fbaSOystein Eftevaag                           ESYS_TR_PASSWORD, ESYS_TR_NONE, ESYS_TR_NONE,
254*758e9fbaSOystein Eftevaag                           permanentHandle, &persistent_handle1);
255*758e9fbaSOystein Eftevaag     goto_if_error(r, "Error Esys EvictControl", error);
256*758e9fbaSOystein Eftevaag 
257*758e9fbaSOystein Eftevaag     Esys_Free(outPublic);
258*758e9fbaSOystein Eftevaag     Esys_Free(creationData);
259*758e9fbaSOystein Eftevaag     Esys_Free(creationHash);
260*758e9fbaSOystein Eftevaag     Esys_Free(creationTicket);
261*758e9fbaSOystein Eftevaag     Esys_Free(outPublic2);
262*758e9fbaSOystein Eftevaag     Esys_Free(outPrivate2);
263*758e9fbaSOystein Eftevaag     Esys_Free(creationData2);
264*758e9fbaSOystein Eftevaag     Esys_Free(creationHash2);
265*758e9fbaSOystein Eftevaag     Esys_Free(creationTicket2);
266*758e9fbaSOystein Eftevaag     return EXIT_SUCCESS;
267*758e9fbaSOystein Eftevaag 
268*758e9fbaSOystein Eftevaag  error:
269*758e9fbaSOystein Eftevaag 
270*758e9fbaSOystein Eftevaag     if (persistent_handle1 != ESYS_TR_NONE) {
271*758e9fbaSOystein Eftevaag         if (Esys_EvictControl(esys_context, ESYS_TR_RH_OWNER, persistent_handle1,
272*758e9fbaSOystein Eftevaag                                ESYS_TR_PASSWORD, ESYS_TR_NONE, ESYS_TR_NONE,
273*758e9fbaSOystein Eftevaag                                permanentHandle, &persistent_handle1) != TSS2_RC_SUCCESS) {
274*758e9fbaSOystein Eftevaag             LOG_ERROR("Cleanup EvictControl failed");
275*758e9fbaSOystein Eftevaag 
276*758e9fbaSOystein Eftevaag         }
277*758e9fbaSOystein Eftevaag     }
278*758e9fbaSOystein Eftevaag 
279*758e9fbaSOystein Eftevaag     if (primaryHandle != ESYS_TR_NONE) {
280*758e9fbaSOystein Eftevaag         if (Esys_FlushContext(esys_context, primaryHandle) != TSS2_RC_SUCCESS) {
281*758e9fbaSOystein Eftevaag             LOG_ERROR("Cleanup primaryHandle failed.");
282*758e9fbaSOystein Eftevaag         }
283*758e9fbaSOystein Eftevaag     }
284*758e9fbaSOystein Eftevaag 
285*758e9fbaSOystein Eftevaag     Esys_Free(outPublic);
286*758e9fbaSOystein Eftevaag     Esys_Free(creationData);
287*758e9fbaSOystein Eftevaag     Esys_Free(creationHash);
288*758e9fbaSOystein Eftevaag     Esys_Free(creationTicket);
289*758e9fbaSOystein Eftevaag     Esys_Free(outPublic2);
290*758e9fbaSOystein Eftevaag     Esys_Free(outPrivate2);
291*758e9fbaSOystein Eftevaag     Esys_Free(creationData2);
292*758e9fbaSOystein Eftevaag     Esys_Free(creationHash2);
293*758e9fbaSOystein Eftevaag     Esys_Free(creationTicket2);
294*758e9fbaSOystein Eftevaag     return EXIT_FAILURE;
295*758e9fbaSOystein Eftevaag }
296*758e9fbaSOystein Eftevaag 
297*758e9fbaSOystein Eftevaag int
test_invoke_esapi(ESYS_CONTEXT * esys_context)298*758e9fbaSOystein Eftevaag test_invoke_esapi(ESYS_CONTEXT * esys_context) {
299*758e9fbaSOystein Eftevaag     return test_esys_evict_control_serialization(esys_context);
300*758e9fbaSOystein Eftevaag }
301