1 /* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
2 * Use of this source code is governed by a BSD-style license that can be
3 * found in the LICENSE file.
6 /* A lightweight TPM command library.
8 * The general idea is that TPM commands are array of bytes whose
9 * fields are mostly compile-time constant. The goal is to build much
10 * of the commands at compile time (or build time) and change some of
11 * the fields at run time as needed. The code in
12 * utility/tlcl_generator.c builds structures containing the commands,
13 * as well as the offsets of the fields that need to be set at run
19 #include <tpm_lite/tlcl.h>
22 #include "tlcl_internal.h"
23 #include "tlcl_structures.h"
27 #define VBDEBUG(format, args...) printf(format, ## args)
29 #include <console/console.h>
30 #define VBDEBUG(format, args...) printk(BIOS_DEBUG, format, ## args)
33 static int tpm_send_receive(const uint8_t *request
,
34 uint32_t request_length
,
36 uint32_t *response_length
)
38 size_t len
= *response_length
;
39 if (tis_sendrecv(request
, request_length
, response
, &len
))
40 return VB2_ERROR_UNKNOWN
;
41 /* check 64->32bit overflow and (re)check response buffer overflow */
42 if (len
> *response_length
)
43 return VB2_ERROR_UNKNOWN
;
44 *response_length
= len
;
48 /* Sets the size field of a TPM command. */
49 static inline void set_tpm_command_size(uint8_t* buffer
, uint32_t size
) {
50 to_tpm_uint32(buffer
+ sizeof(uint16_t), size
);
53 /* Gets the size field of a TPM command. */
54 __attribute__((unused
))
55 static inline int tpm_command_size(const uint8_t* buffer
) {
57 from_tpm_uint32(buffer
+ sizeof(uint16_t), &size
);
61 /* Gets the code field of a TPM command. */
62 static inline int tpm_command_code(const uint8_t* buffer
) {
64 from_tpm_uint32(buffer
+ sizeof(uint16_t) + sizeof(uint32_t), &code
);
68 /* Gets the return code field of a TPM result. */
69 static inline int tpm_return_code(const uint8_t* buffer
) {
70 return tpm_command_code(buffer
);
73 /* Like TlclSendReceive below, but do not retry if NEEDS_SELFTEST or
74 * DOING_SELFTEST errors are returned.
76 static uint32_t tlcl_send_receive_no_retry(const uint8_t* request
,
77 uint8_t* response
, int max_length
) {
78 uint32_t response_length
= max_length
;
81 result
= tpm_send_receive(request
, tpm_command_size(request
),
82 response
, &response_length
);
84 /* Communication with TPM failed, so response is garbage */
85 VBDEBUG("TPM: command 0x%x send/receive failed: 0x%x\n",
86 tpm_command_code(request
), result
);
89 /* Otherwise, use the result code from the response */
90 result
= tpm_return_code(response
);
92 /* TODO: add paranoia about returned response_length vs. max_length
93 * (and possibly expected length from the response header). See
94 * crosbug.com/17017 */
96 VBDEBUG("TPM: command 0x%x returned 0x%x\n",
97 tpm_command_code(request
), result
);
103 /* Sends a TPM command and gets a response. Returns 0 if success or the TPM
104 * error code if error. Waits for the self test to complete if needed. */
105 uint32_t tlcl_send_receive(const uint8_t* request
, uint8_t* response
,
107 uint32_t result
= tlcl_send_receive_no_retry(request
, response
,
109 /* If the command fails because the self test has not completed, try it
110 * again after attempting to ensure that the self test has completed. */
111 if (result
== TPM_E_NEEDS_SELFTEST
|| result
== TPM_E_DOING_SELFTEST
) {
112 result
= tlcl_continue_self_test();
113 if (result
!= TPM_SUCCESS
)
115 #if defined(TPM_BLOCKING_CONTINUESELFTEST) || defined(VB_RECOVERY_MODE)
116 /* Retry only once */
117 result
= tlcl_send_receive_no_retry(request
, response
,
120 /* This needs serious testing. The TPM specification says: "iii.
121 * The caller MUST wait for the actions of TPM_ContinueSelfTest
122 * to complete before reissuing the command C1." But, if
123 * ContinueSelfTest is non-blocking, how do we know that the
124 * actions have completed other than trying again? */
126 result
= tlcl_send_receive_no_retry(request
, response
,
128 } while (result
== TPM_E_DOING_SELFTEST
);
134 /* Sends a command and returns the error code. */
135 static uint32_t send(const uint8_t* command
) {
136 uint8_t response
[TPM_LARGE_ENOUGH_COMMAND_SIZE
];
137 return tlcl_send_receive(command
, response
, sizeof(response
));
140 /* Exported functions. */
142 uint32_t tlcl_lib_init(void) {
144 return VB2_ERROR_UNKNOWN
;
146 return VB2_ERROR_UNKNOWN
;
150 uint32_t tlcl_startup(void) {
151 VBDEBUG("TPM: Startup\n");
152 return send(tpm_startup_cmd
.buffer
);
155 uint32_t tlcl_resume(void) {
156 VBDEBUG("TPM: Resume\n");
157 return send(tpm_resume_cmd
.buffer
);
160 uint32_t tlcl_self_test_full(void)
162 VBDEBUG("TPM: Self test full\n");
163 return send(tpm_selftestfull_cmd
.buffer
);
166 uint32_t tlcl_continue_self_test(void)
168 uint8_t response
[TPM_LARGE_ENOUGH_COMMAND_SIZE
];
169 VBDEBUG("TPM: Continue self test\n");
170 /* Call the No Retry version of SendReceive to avoid recursion. */
171 return tlcl_send_receive_no_retry(tpm_continueselftest_cmd
.buffer
,
172 response
, sizeof(response
));
175 uint32_t tlcl_define_space(uint32_t index
, uint32_t perm
, uint32_t size
)
177 struct s_tpm_nv_definespace_cmd cmd
;
178 VBDEBUG("TPM: TlclDefineSpace(0x%x, 0x%x, %d)\n", index
, perm
, size
);
179 memcpy(&cmd
, &tpm_nv_definespace_cmd
, sizeof(cmd
));
180 to_tpm_uint32(cmd
.buffer
+ tpm_nv_definespace_cmd
.index
, index
);
181 to_tpm_uint32(cmd
.buffer
+ tpm_nv_definespace_cmd
.perm
, perm
);
182 to_tpm_uint32(cmd
.buffer
+ tpm_nv_definespace_cmd
.size
, size
);
183 return send(cmd
.buffer
);
186 uint32_t tlcl_write(uint32_t index
, const void* data
, uint32_t length
)
188 struct s_tpm_nv_write_cmd cmd
;
189 uint8_t response
[TPM_LARGE_ENOUGH_COMMAND_SIZE
];
190 const int total_length
=
191 kTpmRequestHeaderLength
+ kWriteInfoLength
+ length
;
193 VBDEBUG("TPM: tlcl_write(0x%x, %d)\n", index
, length
);
194 memcpy(&cmd
, &tpm_nv_write_cmd
, sizeof(cmd
));
195 assert(total_length
<= TPM_LARGE_ENOUGH_COMMAND_SIZE
);
196 set_tpm_command_size(cmd
.buffer
, total_length
);
198 to_tpm_uint32(cmd
.buffer
+ tpm_nv_write_cmd
.index
, index
);
199 to_tpm_uint32(cmd
.buffer
+ tpm_nv_write_cmd
.length
, length
);
200 memcpy(cmd
.buffer
+ tpm_nv_write_cmd
.data
, data
, length
);
202 return tlcl_send_receive(cmd
.buffer
, response
, sizeof(response
));
205 uint32_t tlcl_read(uint32_t index
, void* data
, uint32_t length
)
207 struct s_tpm_nv_read_cmd cmd
;
208 uint8_t response
[TPM_LARGE_ENOUGH_COMMAND_SIZE
];
209 uint32_t result_length
;
212 VBDEBUG("TPM: tlcl_read(0x%x, %d)\n", index
, length
);
213 memcpy(&cmd
, &tpm_nv_read_cmd
, sizeof(cmd
));
214 to_tpm_uint32(cmd
.buffer
+ tpm_nv_read_cmd
.index
, index
);
215 to_tpm_uint32(cmd
.buffer
+ tpm_nv_read_cmd
.length
, length
);
217 result
= tlcl_send_receive(cmd
.buffer
, response
, sizeof(response
));
218 if (result
== TPM_SUCCESS
&& length
> 0) {
219 uint8_t* nv_read_cursor
= response
+ kTpmResponseHeaderLength
;
220 from_tpm_uint32(nv_read_cursor
, &result_length
);
221 nv_read_cursor
+= sizeof(uint32_t);
222 memcpy(data
, nv_read_cursor
, result_length
);
229 uint32_t tlcl_assert_physical_presence(void) {
230 VBDEBUG("TPM: Asserting physical presence\n");
231 return send(tpm_ppassert_cmd
.buffer
);
234 uint32_t tlcl_physical_presence_cmd_enable(void) {
235 VBDEBUG("TPM: Enable the physical presence command\n");
236 return send(tpm_ppenable_cmd
.buffer
);
239 uint32_t tlcl_finalize_physical_presence(void) {
240 VBDEBUG("TPM: Enable PP cmd, disable HW pp, and set lifetime lock\n");
241 return send(tpm_finalizepp_cmd
.buffer
);
244 uint32_t tlcl_set_nv_locked(void) {
245 VBDEBUG("TPM: Set NV locked\n");
246 return tlcl_define_space(TPM_NV_INDEX_LOCK
, 0, 0);
249 uint32_t tlcl_force_clear(void) {
250 VBDEBUG("TPM: Force clear\n");
251 return send(tpm_forceclear_cmd
.buffer
);
254 uint32_t tlcl_set_enable(void) {
255 VBDEBUG("TPM: Enabling TPM\n");
256 return send(tpm_physicalenable_cmd
.buffer
);
259 uint32_t tlcl_set_deactivated(uint8_t flag
)
261 struct s_tpm_physicalsetdeactivated_cmd cmd
;
262 VBDEBUG("TPM: SetDeactivated(%d)\n", flag
);
263 memcpy(&cmd
, &tpm_physicalsetdeactivated_cmd
, sizeof(cmd
));
264 *(cmd
.buffer
+ cmd
.deactivated
) = flag
;
265 return send(cmd
.buffer
);
268 uint32_t tlcl_get_permanent_flags(TPM_PERMANENT_FLAGS
* pflags
)
270 uint8_t response
[TPM_LARGE_ENOUGH_COMMAND_SIZE
];
272 uint32_t result
= tlcl_send_receive(tpm_getflags_cmd
.buffer
, response
,
274 if (result
!= TPM_SUCCESS
)
276 from_tpm_uint32(response
+ kTpmResponseHeaderLength
, &size
);
277 assert(size
== sizeof(TPM_PERMANENT_FLAGS
));
278 memcpy(pflags
, response
+ kTpmResponseHeaderLength
+ sizeof(size
),
279 sizeof(TPM_PERMANENT_FLAGS
));
283 uint32_t tlcl_get_flags(uint8_t* disable
, uint8_t* deactivated
,
286 TPM_PERMANENT_FLAGS pflags
;
287 uint32_t result
= tlcl_get_permanent_flags(&pflags
);
288 if (result
== TPM_SUCCESS
) {
290 *disable
= pflags
.disable
;
292 *deactivated
= pflags
.deactivated
;
294 *nvlocked
= pflags
.nvLocked
;
295 VBDEBUG("TPM: flags disable=%d, deactivated=%d, nvlocked=%d\n",
296 pflags
.disable
, pflags
.deactivated
, pflags
.nvLocked
);
301 uint32_t tlcl_set_global_lock(void)
304 VBDEBUG("TPM: Set global lock\n");
305 return tlcl_write(TPM_NV_INDEX0
, (uint8_t*) &x
, 0);
308 uint32_t tlcl_extend(int pcr_num
, const uint8_t* in_digest
,
311 struct s_tpm_extend_cmd cmd
;
312 uint8_t response
[kTpmResponseHeaderLength
+ kPcrDigestLength
];
315 memcpy(&cmd
, &tpm_extend_cmd
, sizeof(cmd
));
316 to_tpm_uint32(cmd
.buffer
+ tpm_extend_cmd
.pcrNum
, pcr_num
);
317 memcpy(cmd
.buffer
+ cmd
.inDigest
, in_digest
, kPcrDigestLength
);
319 result
= tlcl_send_receive(cmd
.buffer
, response
, sizeof(response
));
320 if (result
!= TPM_SUCCESS
)
324 memcpy(out_digest
, response
+ kTpmResponseHeaderLength
,