1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*******************************************************************************
3 * Copyright 2017-2018, Fraunhofer SIT sponsored by Infineon Technologies AG
4 * All rights reserved.
5 *******************************************************************************/
6
7 #ifdef HAVE_CONFIG_H
8 #include <config.h>
9 #endif
10
11 #include <stdlib.h>
12
13 #include "tss2_esys.h"
14
15 #include "esys_iutil.h"
16 #define LOGMODULE test
17 #include "util/log.h"
18 #include "util/aux_util.h"
19
20 /** This test is intended to test the definition of a counter in NV ram and to
21 * test the ESYS NV_Increment function.
22 *
23 * Tested ESYS commands:
24 * - Esys_FlushContext() (M)
25 * - Esys_NV_DefineSpace() (M)
26 * - Esys_NV_Increment() (M)
27 * - Esys_NV_Read() (M)
28 * - Esys_NV_ReadPublic() (M)
29 * - Esys_NV_UndefineSpace() (M)
30 * - Esys_StartAuthSession() (M)
31 *
32 * Used compiler defines: TEST_SESSION
33 *
34 * @param[in,out] esys_context The ESYS_CONTEXT.
35 * @retval EXIT_FAILURE
36 * @retval EXIT_SUCCESS
37 */
38
39 int
test_esys_nv_ram_counter(ESYS_CONTEXT * esys_context)40 test_esys_nv_ram_counter(ESYS_CONTEXT * esys_context)
41 {
42 TSS2_RC r;
43 ESYS_TR nvHandle = ESYS_TR_NONE;
44
45 TPM2B_NV_PUBLIC *nvPublic = NULL;
46 TPM2B_NAME *nvName = NULL;
47
48 TPM2B_MAX_NV_BUFFER *nv_test_data = NULL;
49
50 #ifdef TEST_SESSION
51 ESYS_TR session = ESYS_TR_NONE;
52 TPMT_SYM_DEF symmetric = {.algorithm = TPM2_ALG_AES,
53 .keyBits = {.aes = 128},
54 .mode = {.aes = TPM2_ALG_CFB}
55 };
56 TPMA_SESSION sessionAttributes;
57 TPM2B_NONCE nonceCaller = {
58 .size = 20,
59 .buffer = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
60 11, 12, 13, 14, 15, 16, 17, 18, 19, 20}
61 };
62
63 memset(&sessionAttributes, 0, sizeof sessionAttributes);
64
65 r = Esys_StartAuthSession(esys_context, ESYS_TR_NONE, ESYS_TR_NONE,
66 ESYS_TR_NONE, ESYS_TR_NONE, ESYS_TR_NONE,
67 &nonceCaller,
68 TPM2_SE_HMAC, &symmetric, TPM2_ALG_SHA256,
69 &session);
70 goto_if_error(r, "Error: During initialization of session", error);
71 #endif /* TEST_SESSION */
72
73 TPM2B_AUTH auth = {.size = 20,
74 .buffer={10, 11, 12, 13, 14, 15, 16, 17, 18, 19,
75 20, 21, 22, 23, 24, 25, 26, 27, 28, 29}};
76 #ifdef TEST_LARGE_AUTH
77 for (int i = 0; i < 33; i++)
78 auth.buffer[i] = i;
79 auth.size = 33;
80 #endif
81
82 TPM2B_NV_PUBLIC publicInfo = {
83 .size = 0,
84 .nvPublic = {
85 .nvIndex =TPM2_NV_INDEX_FIRST,
86 .nameAlg = TPM2_ALG_SHA256,
87 .attributes = (
88 TPMA_NV_OWNERWRITE |
89 TPMA_NV_AUTHWRITE |
90 TPMA_NV_WRITE_STCLEAR |
91 TPMA_NV_AUTHREAD |
92 TPMA_NV_OWNERREAD |
93 TPM2_NT_COUNTER << TPMA_NV_TPM2_NT_SHIFT
94 ),
95 .authPolicy = {
96 .size = 0,
97 .buffer = {},
98 },
99 .dataSize = 8,
100 }
101 };
102
103 r = Esys_NV_DefineSpace(esys_context,
104 ESYS_TR_RH_OWNER,
105 #ifdef TEST_SESSION
106 session,
107 #else
108 ESYS_TR_PASSWORD,
109 #endif
110 ESYS_TR_NONE,
111 ESYS_TR_NONE,
112 &auth,
113 &publicInfo,
114 &nvHandle);
115
116 goto_if_error(r, "Error esys define nv space", error);
117
118 r = Esys_NV_ReadPublic(esys_context,
119 nvHandle,
120 ESYS_TR_NONE,
121 ESYS_TR_NONE,
122 ESYS_TR_NONE,
123 &nvPublic,
124 &nvName);
125 goto_if_error(r, "Error: nv read public", error);
126
127 RSRC_NODE_T *nvHandleNode;
128
129 r = esys_GetResourceObject(esys_context, nvHandle, &nvHandleNode);
130 goto_if_error(r, "Error: nv get resource object", error);
131
132 if (nvName->size != nvHandleNode->rsrc.name.size ||
133 memcmp(&nvName->name, &nvHandleNode->rsrc.name.name, nvName->size) != 0) {
134 LOG_ERROR("Error: define space name not equal");
135 goto error;
136 }
137 r = Esys_NV_Increment(esys_context,
138 nvHandle,
139 nvHandle,
140 #ifdef TEST_SESSION
141 session,
142 #else
143 ESYS_TR_PASSWORD,
144 #endif
145 ESYS_TR_NONE,
146 ESYS_TR_NONE);
147
148 goto_if_error(r, "Error esys nv write", error);
149
150 Esys_Free(nvPublic);
151 Esys_Free(nvName);
152
153 r = Esys_NV_ReadPublic(esys_context,
154 nvHandle,
155 ESYS_TR_NONE,
156 ESYS_TR_NONE,
157 ESYS_TR_NONE,
158 &nvPublic,
159 &nvName);
160 goto_if_error(r, "Error: nv read public", error);
161
162 r = esys_GetResourceObject(esys_context, nvHandle, &nvHandleNode);
163 goto_if_error(r, "Error: nv get resource object", error);
164
165 if (nvName->size != nvHandleNode->rsrc.name.size ||
166 memcmp(&nvName->name, &nvHandleNode->rsrc.name.name, nvName->size) != 0) {
167 LOG_ERROR("Error: nv write name not equal");
168 goto error;
169 }
170
171 Esys_Free(nvPublic);
172 Esys_Free(nvName);
173
174 r = Esys_NV_Read(esys_context,
175 nvHandle,
176 nvHandle,
177 #ifdef TEST_SESSION
178 session,
179 #else
180 ESYS_TR_PASSWORD,
181 #endif
182 ESYS_TR_NONE,
183 ESYS_TR_NONE,
184 8,
185 0,
186 &nv_test_data);
187
188 goto_if_error(r, "Error esys nv read", error);
189
190 r = Esys_NV_ReadPublic(esys_context,
191 nvHandle,
192 ESYS_TR_NONE,
193 ESYS_TR_NONE,
194 ESYS_TR_NONE,
195 &nvPublic,
196 &nvName);
197 goto_if_error(r, "Error: nv read public", error);
198
199 r = esys_GetResourceObject(esys_context, nvHandle, &nvHandleNode);
200 goto_if_error(r, "Error: nv get resource object", error);
201
202 if (nvName->size != nvHandleNode->rsrc.name.size ||
203 memcmp(&nvName->name, &nvHandleNode->rsrc.name.name, nvName->size) != 0) {
204 LOG_ERROR("Error: nv read name not equal");
205 goto error;
206 }
207
208 r = Esys_NV_UndefineSpace(esys_context,
209 ESYS_TR_RH_OWNER,
210 nvHandle,
211 #ifdef TEST_SESSION
212 session,
213 #else
214 ESYS_TR_PASSWORD,
215 #endif
216 ESYS_TR_NONE,
217 ESYS_TR_NONE
218 );
219 goto_if_error(r, "Error: NV_UndefineSpace", error);
220
221
222 #ifdef TEST_SESSION
223 r = Esys_FlushContext(esys_context, session);
224 goto_if_error(r, "Error: FlushContext", error);
225 #endif
226
227 Esys_Free(nvPublic);
228 Esys_Free(nvName);
229 Esys_Free(nv_test_data);
230 return EXIT_SUCCESS;
231
232 error:
233
234 if (nvHandle != ESYS_TR_NONE) {
235 if (Esys_NV_UndefineSpace(esys_context,
236 ESYS_TR_RH_OWNER,
237 nvHandle,
238 #ifdef TEST_SESSION
239 session,
240 #else
241 ESYS_TR_PASSWORD,
242 #endif
243 ESYS_TR_NONE,
244 ESYS_TR_NONE) != TSS2_RC_SUCCESS) {
245 LOG_ERROR("Cleanup nvHandle failed.");
246 }
247 }
248
249 #ifdef TEST_SESSION
250 if (session != ESYS_TR_NONE) {
251 if (Esys_FlushContext(esys_context, session) != TSS2_RC_SUCCESS) {
252 LOG_ERROR("Cleanup session failed.");
253 }
254 }
255 #endif
256
257 Esys_Free(nvPublic);
258 Esys_Free(nvName);
259 Esys_Free(nv_test_data);
260 return EXIT_FAILURE;
261 }
262
263 int
test_invoke_esys(ESYS_CONTEXT * esys_context)264 test_invoke_esys(ESYS_CONTEXT * esys_context) {
265 return test_esys_nv_ram_counter(esys_context);
266 }
267