1 // SPDX-License-Identifier: GPL-2.0+
3 * Defines APIs that allow an OS to interact with UEFI firmware to query
4 * information about the device.
5 * https://trustedcomputinggroup.org/resource/tcg-efi-protocol-specification/
7 * Copyright (c) 2020, Linaro Limited
10 #define LOG_CATEGORY LOGC_EFI
13 #include <efi_loader.h>
14 #include <efi_variable.h>
19 #include <version_string.h>
22 #include <u-boot/hash-checksum.h>
23 #include <u-boot/sha1.h>
24 #include <u-boot/sha256.h>
25 #include <u-boot/sha512.h>
26 #include <linux/unaligned/be_byteshift.h>
27 #include <linux/unaligned/le_byteshift.h>
28 #include <linux/unaligned/generic.h>
32 * struct event_log_buffer - internal eventlog management structure
34 * @buffer: eventlog buffer
35 * @final_buffer: finalevent config table buffer
36 * @pos: current position of 'buffer'
37 * @final_pos: current position of 'final_buffer'
38 * @get_event_called: true if GetEventLog has been invoked at least once
39 * @ebs_called: true if ExitBootServices has been invoked
40 * @truncated: true if the 'buffer' is truncated
42 struct event_log_buffer {
45 size_t pos; /* eventlog position */
46 size_t final_pos; /* final events config table position */
47 size_t last_event_size;
48 bool get_event_called;
53 static struct event_log_buffer event_log;
54 static bool tcg2_efi_app_invoked;
56 * When requesting TPM2_CAP_TPM_PROPERTIES the value is on a standard offset.
57 * Since the current tpm2_get_capability() response buffers starts at
58 * 'union tpmu_capabilities data' of 'struct tpms_capability_data', calculate
59 * the response size and offset once for all consumers
61 #define TPM2_RESPONSE_BUFFER_SIZE (sizeof(struct tpms_capability_data) - \
62 offsetof(struct tpms_capability_data, data))
63 #define properties_offset (offsetof(struct tpml_tagged_tpm_property, tpm_property) + \
64 offsetof(struct tpms_tagged_property, value))
66 static const efi_guid_t efi_guid_tcg2_protocol = EFI_TCG2_PROTOCOL_GUID;
67 static const efi_guid_t efi_guid_final_events = EFI_TCG2_FINAL_EVENTS_TABLE_GUID;
75 static const struct digest_info hash_algo_list[] = {
78 EFI_TCG2_BOOT_HASH_ALG_SHA1,
79 TPM2_SHA1_DIGEST_SIZE,
83 EFI_TCG2_BOOT_HASH_ALG_SHA256,
84 TPM2_SHA256_DIGEST_SIZE,
88 EFI_TCG2_BOOT_HASH_ALG_SHA384,
89 TPM2_SHA384_DIGEST_SIZE,
93 EFI_TCG2_BOOT_HASH_ALG_SHA512,
94 TPM2_SHA512_DIGEST_SIZE,
98 struct variable_info {
104 static struct variable_info secure_variables[] = {
105 {u"SecureBoot", true, 7},
112 {u"DeployedMode", false, 1},
113 {u"AuditMode", false, 1},
116 #define MAX_HASH_COUNT ARRAY_SIZE(hash_algo_list)
119 * alg_to_mask - Get a TCG hash mask for algorithms
121 * @hash_alg: TCG defined algorithm
123 * @Return: TCG hashing algorithm bitmaps, 0 if the algorithm is not supported
125 static u32 alg_to_mask(u16 hash_alg)
129 for (i = 0; i < MAX_HASH_COUNT; i++) {
130 if (hash_algo_list[i].hash_alg == hash_alg)
131 return hash_algo_list[i].hash_mask;
138 * alg_to_len - Get a TCG hash len for algorithms
140 * @hash_alg: TCG defined algorithm
142 * @Return: len of chosen algorithm, 0 if the algorithm is not supported
144 static u16 alg_to_len(u16 hash_alg)
148 for (i = 0; i < MAX_HASH_COUNT; i++) {
149 if (hash_algo_list[i].hash_alg == hash_alg)
150 return hash_algo_list[i].hash_len;
156 static bool is_tcg2_protocol_installed(void)
158 struct efi_handler *handler;
161 ret = efi_search_protocol(efi_root, &efi_guid_tcg2_protocol, &handler);
162 return ret == EFI_SUCCESS;
165 static u32 tcg_event_final_size(struct tpml_digest_values *digest_list)
170 len = offsetof(struct tcg_pcr_event2, digests);
171 len += offsetof(struct tpml_digest_values, digests);
172 for (i = 0; i < digest_list->count; i++) {
173 u16 hash_alg = digest_list->digests[i].hash_alg;
175 len += offsetof(struct tpmt_ha, digest);
176 len += alg_to_len(hash_alg);
178 len += sizeof(u32); /* tcg_pcr_event2 event_size*/
183 /* tcg2_pcr_extend - Extend PCRs for a TPM2 device for a given tpml_digest_values
186 * @digest_list: list of digest algorithms to extend
188 * @Return: status code
190 static efi_status_t tcg2_pcr_extend(struct udevice *dev, u32 pcr_index,
191 struct tpml_digest_values *digest_list)
196 for (i = 0; i < digest_list->count; i++) {
197 u32 alg = digest_list->digests[i].hash_alg;
199 rc = tpm2_pcr_extend(dev, pcr_index, alg,
200 (u8 *)&digest_list->digests[i].digest,
203 EFI_PRINT("Failed to extend PCR\n");
204 return EFI_DEVICE_ERROR;
211 /* tcg2_pcr_read - Read PCRs for a TPM2 device for a given tpml_digest_values
214 * @pcr_index: PCR index
215 * @digest_list: list of digest algorithms to extend
217 * @Return: status code
219 static efi_status_t tcg2_pcr_read(struct udevice *dev, u32 pcr_index,
220 struct tpml_digest_values *digest_list)
222 struct tpm_chip_priv *priv;
223 unsigned int updates, pcr_select_min;
227 priv = dev_get_uclass_priv(dev);
229 return EFI_DEVICE_ERROR;
231 pcr_select_min = priv->pcr_select_min;
233 for (i = 0; i < digest_list->count; i++) {
234 u16 hash_alg = digest_list->digests[i].hash_alg;
235 u8 *digest = (u8 *)&digest_list->digests[i].digest;
237 rc = tpm2_pcr_read(dev, pcr_index, pcr_select_min,
238 hash_alg, digest, alg_to_len(hash_alg),
241 EFI_PRINT("Failed to read PCR\n");
242 return EFI_DEVICE_ERROR;
249 /* put_event - Append an agile event to an eventlog
251 * @pcr_index: PCR index
252 * @event_type: type of event added
253 * @digest_list: list of digest algorithms to add
254 * @size: size of event
255 * @event: event to add
256 * @log: log buffer to append the event
259 static void put_event(u32 pcr_index, u32 event_type,
260 struct tpml_digest_values *digest_list, u32 size,
261 u8 event[], void *log)
268 * size refers to the length of event[] only, we need to check against
269 * the final tcg_pcr_event2 size
271 event_size = size + tcg_event_final_size(digest_list);
273 put_unaligned_le32(pcr_index, log);
274 pos = offsetof(struct tcg_pcr_event2, event_type);
275 put_unaligned_le32(event_type, (void *)((uintptr_t)log + pos));
276 pos = offsetof(struct tcg_pcr_event2, digests); /* count */
277 put_unaligned_le32(digest_list->count, (void *)((uintptr_t)log + pos));
279 pos += offsetof(struct tpml_digest_values, digests);
280 for (i = 0; i < digest_list->count; i++) {
281 u16 hash_alg = digest_list->digests[i].hash_alg;
282 u8 *digest = (u8 *)&digest_list->digests[i].digest;
284 put_unaligned_le16(hash_alg, (void *)((uintptr_t)log + pos));
285 pos += offsetof(struct tpmt_ha, digest);
286 memcpy((void *)((uintptr_t)log + pos), digest, alg_to_len(hash_alg));
287 pos += alg_to_len(hash_alg);
290 put_unaligned_le32(size, (void *)((uintptr_t)log + pos));
291 pos += sizeof(u32); /* tcg_pcr_event2 event_size*/
292 memcpy((void *)((uintptr_t)log + pos), event, size);
296 * make sure the calculated buffer is what we checked against
297 * This check should never fail. It checks the code above is
298 * calculating the right length for the event we are adding
300 if (pos != event_size)
301 log_err("Appending to the EventLog failed\n");
304 /* tcg2_agile_log_append - Append an agile event to an eventlog
306 * @pcr_index: PCR index
307 * @event_type: type of event added
308 * @digest_list: list of digest algorithms to add
309 * @size: size of event
310 * @event: event to add
311 * @log: log buffer to append the event
313 * @Return: status code
315 static efi_status_t tcg2_agile_log_append(u32 pcr_index, u32 event_type,
316 struct tpml_digest_values *digest_list,
317 u32 size, u8 event[])
319 void *log = (void *)((uintptr_t)event_log.buffer + event_log.pos);
320 u32 event_size = size + tcg_event_final_size(digest_list);
321 struct efi_tcg2_final_events_table *final_event;
322 efi_status_t ret = EFI_SUCCESS;
324 /* if ExitBootServices hasn't been called update the normal log */
325 if (!event_log.ebs_called) {
326 if (event_log.truncated ||
327 event_log.pos + event_size > TPM2_EVENT_LOG_SIZE) {
328 event_log.truncated = true;
329 return EFI_VOLUME_FULL;
331 put_event(pcr_index, event_type, digest_list, size, event, log);
332 event_log.pos += event_size;
333 event_log.last_event_size = event_size;
336 if (!event_log.get_event_called)
339 /* if GetEventLog has been called update FinalEventLog as well */
340 if (event_log.final_pos + event_size > TPM2_EVENT_LOG_SIZE)
341 return EFI_VOLUME_FULL;
343 log = (void *)((uintptr_t)event_log.final_buffer + event_log.final_pos);
344 put_event(pcr_index, event_type, digest_list, size, event, log);
346 final_event = event_log.final_buffer;
347 final_event->number_of_events++;
348 event_log.final_pos += event_size;
354 * platform_get_tpm_device() - retrieve TPM device
356 * This function retrieves the udevice implementing a TPM
358 * This function may be overridden if special initialization is needed.
361 * Return: status code
363 __weak efi_status_t platform_get_tpm2_device(struct udevice **dev)
365 for_each_tpm_device(*dev) {
366 /* Only support TPMv2 devices */
367 if (tpm_get_version(*dev) == TPM_V2)
371 return EFI_NOT_FOUND;
375 * platform_get_eventlog() - retrieve the eventlog address and size
377 * This function retrieves the eventlog address and size if the underlying
378 * firmware has done some measurements and passed them.
380 * This function may be overridden based on platform specific method of
381 * passing the eventlog address and size.
384 * @addr: eventlog address
386 * Return: status code
388 __weak efi_status_t platform_get_eventlog(struct udevice *dev, u64 *addr,
394 basep = dev_read_prop(dev, "tpm_event_log_addr", NULL);
396 return EFI_NOT_FOUND;
398 *addr = be64_to_cpup((__force __be64 *)basep);
400 sizep = dev_read_prop(dev, "tpm_event_log_size", NULL);
402 return EFI_NOT_FOUND;
404 *sz = be32_to_cpup((__force __be32 *)sizep);
406 log_debug("event log empty\n");
407 return EFI_NOT_FOUND;
414 * tpm2_get_max_command_size() - get the supported max command size
417 * @max_command_size: output buffer for the size
419 * Return: 0 on success, -1 on error
421 static int tpm2_get_max_command_size(struct udevice *dev, u16 *max_command_size)
423 u8 response[TPM2_RESPONSE_BUFFER_SIZE];
426 memset(response, 0, sizeof(response));
427 ret = tpm2_get_capability(dev, TPM2_CAP_TPM_PROPERTIES,
428 TPM2_PT_MAX_COMMAND_SIZE, response, 1);
432 *max_command_size = (uint16_t)get_unaligned_be32(response +
439 * tpm2_get_max_response_size() - get the supported max response size
442 * @max_response_size: output buffer for the size
444 * Return: 0 on success, -1 on error
446 static int tpm2_get_max_response_size(struct udevice *dev,
447 u16 *max_response_size)
449 u8 response[TPM2_RESPONSE_BUFFER_SIZE];
452 memset(response, 0, sizeof(response));
453 ret = tpm2_get_capability(dev, TPM2_CAP_TPM_PROPERTIES,
454 TPM2_PT_MAX_RESPONSE_SIZE, response, 1);
458 *max_response_size = (uint16_t)get_unaligned_be32(response +
465 * tpm2_get_manufacturer_id() - get the manufacturer ID
468 * @manufacturer_id: output buffer for the id
470 * Return: 0 on success, -1 on error
472 static int tpm2_get_manufacturer_id(struct udevice *dev, u32 *manufacturer_id)
474 u8 response[TPM2_RESPONSE_BUFFER_SIZE];
477 memset(response, 0, sizeof(response));
478 ret = tpm2_get_capability(dev, TPM2_CAP_TPM_PROPERTIES,
479 TPM2_PT_MANUFACTURER, response, 1);
483 *manufacturer_id = get_unaligned_be32(response + properties_offset);
489 * tpm2_get_num_pcr() - get the number of PCRs
492 * @manufacturer_id: output buffer for the number
494 * Return: 0 on success, -1 on error
496 static int tpm2_get_num_pcr(struct udevice *dev, u32 *num_pcr)
498 u8 response[TPM2_RESPONSE_BUFFER_SIZE];
501 memset(response, 0, sizeof(response));
502 ret = tpm2_get_capability(dev, TPM2_CAP_TPM_PROPERTIES,
503 TPM2_PT_PCR_COUNT, response, 1);
507 *num_pcr = get_unaligned_be32(response + properties_offset);
508 if (*num_pcr > TPM2_MAX_PCRS)
515 * is_active_pcr() - Check if a supported algorithm is active
518 * @selection: struct of PCR information
520 * Return: true if PCR is active
522 static bool is_active_pcr(struct tpms_pcr_selection *selection)
526 * check the pcr_select. If at least one of the PCRs supports the
527 * algorithm add it on the active ones
529 for (i = 0; i < selection->size_of_select; i++) {
530 if (selection->pcr_select[i])
538 * tpm2_get_pcr_info() - get the supported, active PCRs and number of banks
541 * @supported_pcr: bitmask with the algorithms supported
542 * @active_pcr: bitmask with the active algorithms
543 * @pcr_banks: number of PCR banks
545 * Return: 0 on success, -1 on error
547 static int tpm2_get_pcr_info(struct udevice *dev, u32 *supported_pcr,
548 u32 *active_pcr, u32 *pcr_banks)
550 u8 response[TPM2_RESPONSE_BUFFER_SIZE];
551 struct tpml_pcr_selection pcrs;
559 memset(response, 0, sizeof(response));
560 ret = tpm2_get_capability(dev, TPM2_CAP_PCRS, 0, response, 1);
564 pcrs.count = get_unaligned_be32(response);
566 * We only support 5 algorithms for now so check against that
567 * instead of TPM2_NUM_PCR_BANKS
569 if (pcrs.count > MAX_HASH_COUNT || pcrs.count < 1)
572 tpm_ret = tpm2_get_num_pcr(dev, &num_pcr);
576 for (i = 0; i < pcrs.count; i++) {
578 * Definition of TPMS_PCR_SELECTION Structure
581 * pcr_select: u8 array
583 * The offsets depend on the number of the device PCRs
584 * so we have to calculate them based on that
586 u32 hash_offset = offsetof(struct tpml_pcr_selection, selection) +
587 i * offsetof(struct tpms_pcr_selection, pcr_select) +
588 i * ((num_pcr + 7) / 8);
589 u32 size_select_offset =
590 hash_offset + offsetof(struct tpms_pcr_selection,
592 u32 pcr_select_offset =
593 hash_offset + offsetof(struct tpms_pcr_selection,
596 pcrs.selection[i].hash =
597 get_unaligned_be16(response + hash_offset);
598 pcrs.selection[i].size_of_select =
599 __get_unaligned_be(response + size_select_offset);
600 if (pcrs.selection[i].size_of_select > TPM2_PCR_SELECT_MAX)
602 /* copy the array of pcr_select */
603 memcpy(pcrs.selection[i].pcr_select, response + pcr_select_offset,
604 pcrs.selection[i].size_of_select);
607 for (i = 0; i < pcrs.count; i++) {
608 u32 hash_mask = alg_to_mask(pcrs.selection[i].hash);
611 *supported_pcr |= hash_mask;
612 if (is_active_pcr(&pcrs.selection[i]))
613 *active_pcr |= hash_mask;
615 EFI_PRINT("Unknown algorithm %x\n", pcrs.selection[i].hash);
619 *pcr_banks = pcrs.count;
627 * __get_active_pcr_banks() - returns the currently active PCR banks
629 * @active_pcr_banks: pointer for receiving the bitmap of currently
632 * Return: status code
634 static efi_status_t __get_active_pcr_banks(u32 *active_pcr_banks)
637 u32 active = 0, supported = 0, pcr_banks = 0;
641 ret = platform_get_tpm2_device(&dev);
642 if (ret != EFI_SUCCESS)
645 err = tpm2_get_pcr_info(dev, &supported, &active, &pcr_banks);
647 ret = EFI_DEVICE_ERROR;
651 *active_pcr_banks = active;
657 /* tcg2_create_digest - create a list of digests of the supported PCR banks
658 * for a given memory range
660 * @input: input memory
661 * @length: length of buffer to calculate the digest
662 * @digest_list: list of digests to fill in
664 * Return: status code
666 static efi_status_t tcg2_create_digest(const u8 *input, u32 length,
667 struct tpml_digest_values *digest_list)
670 sha256_context ctx_256;
671 sha512_context ctx_512;
672 u8 final[TPM2_SHA512_DIGEST_SIZE];
677 ret = __get_active_pcr_banks(&active);
678 if (ret != EFI_SUCCESS)
681 digest_list->count = 0;
682 for (i = 0; i < MAX_HASH_COUNT; i++) {
683 u16 hash_alg = hash_algo_list[i].hash_alg;
685 if (!(active & alg_to_mask(hash_alg)))
690 sha1_update(&ctx, input, length);
691 sha1_finish(&ctx, final);
693 case TPM2_ALG_SHA256:
694 sha256_starts(&ctx_256);
695 sha256_update(&ctx_256, input, length);
696 sha256_finish(&ctx_256, final);
698 case TPM2_ALG_SHA384:
699 sha384_starts(&ctx_512);
700 sha384_update(&ctx_512, input, length);
701 sha384_finish(&ctx_512, final);
703 case TPM2_ALG_SHA512:
704 sha512_starts(&ctx_512);
705 sha512_update(&ctx_512, input, length);
706 sha512_finish(&ctx_512, final);
711 digest_list->digests[digest_list->count].hash_alg = hash_alg;
712 memcpy(&digest_list->digests[digest_list->count].digest, final,
713 (u32)alg_to_len(hash_alg));
714 digest_list->count++;
721 * efi_tcg2_get_capability() - protocol capability information and state information
723 * @this: TCG2 protocol instance
724 * @capability: caller allocated memory with size field to the size of
725 * the structure allocated
727 * Return: status code
729 static efi_status_t EFIAPI
730 efi_tcg2_get_capability(struct efi_tcg2_protocol *this,
731 struct efi_tcg2_boot_service_capability *capability)
734 efi_status_t efi_ret;
737 EFI_ENTRY("%p, %p", this, capability);
739 if (!this || !capability) {
740 efi_ret = EFI_INVALID_PARAMETER;
744 if (capability->size < BOOT_SERVICE_CAPABILITY_MIN) {
745 capability->size = BOOT_SERVICE_CAPABILITY_MIN;
746 efi_ret = EFI_BUFFER_TOO_SMALL;
750 if (capability->size < sizeof(*capability)) {
751 capability->size = sizeof(*capability);
752 efi_ret = EFI_BUFFER_TOO_SMALL;
756 capability->structure_version.major = 1;
757 capability->structure_version.minor = 1;
758 capability->protocol_version.major = 1;
759 capability->protocol_version.minor = 1;
761 efi_ret = platform_get_tpm2_device(&dev);
762 if (efi_ret != EFI_SUCCESS) {
763 capability->supported_event_logs = 0;
764 capability->hash_algorithm_bitmap = 0;
765 capability->tpm_present_flag = false;
766 capability->max_command_size = 0;
767 capability->max_response_size = 0;
768 capability->manufacturer_id = 0;
769 capability->number_of_pcr_banks = 0;
770 capability->active_pcr_banks = 0;
772 efi_ret = EFI_SUCCESS;
776 /* We only allow a TPMv2 device to register the EFI protocol */
777 capability->supported_event_logs = TCG2_EVENT_LOG_FORMAT_TCG_2;
779 capability->tpm_present_flag = true;
781 /* Supported and active PCRs */
782 capability->hash_algorithm_bitmap = 0;
783 capability->active_pcr_banks = 0;
784 ret = tpm2_get_pcr_info(dev, &capability->hash_algorithm_bitmap,
785 &capability->active_pcr_banks,
786 &capability->number_of_pcr_banks);
788 efi_ret = EFI_DEVICE_ERROR;
792 /* Max command size */
793 ret = tpm2_get_max_command_size(dev, &capability->max_command_size);
795 efi_ret = EFI_DEVICE_ERROR;
799 /* Max response size */
800 ret = tpm2_get_max_response_size(dev, &capability->max_response_size);
802 efi_ret = EFI_DEVICE_ERROR;
806 /* Manufacturer ID */
807 ret = tpm2_get_manufacturer_id(dev, &capability->manufacturer_id);
809 efi_ret = EFI_DEVICE_ERROR;
813 return EFI_EXIT(EFI_SUCCESS);
815 return EFI_EXIT(efi_ret);
819 * efi_tcg2_get_eventlog() - retrieve the the address of an event log and its
822 * @this: TCG2 protocol instance
823 * @log_format: type of event log format
824 * @event_log_location: pointer to the memory address of the event log
825 * @event_log_last_entry: pointer to the address of the start of the last
826 * entry in the event log in memory, if log contains
828 * @event_log_truncated: set to true, if the Event Log is missing at i
831 * Return: status code
833 static efi_status_t EFIAPI
834 efi_tcg2_get_eventlog(struct efi_tcg2_protocol *this,
835 efi_tcg_event_log_format log_format,
836 u64 *event_log_location, u64 *event_log_last_entry,
837 bool *event_log_truncated)
839 efi_status_t ret = EFI_SUCCESS;
842 EFI_ENTRY("%p, %u, %p, %p, %p", this, log_format, event_log_location,
843 event_log_last_entry, event_log_truncated);
845 if (!this || !event_log_location || !event_log_last_entry ||
846 !event_log_truncated) {
847 ret = EFI_INVALID_PARAMETER;
851 /* Only support TPMV2 */
852 if (log_format != TCG2_EVENT_LOG_FORMAT_TCG_2) {
853 ret = EFI_INVALID_PARAMETER;
857 ret = platform_get_tpm2_device(&dev);
858 if (ret != EFI_SUCCESS) {
859 event_log_location = NULL;
860 event_log_last_entry = NULL;
861 *event_log_truncated = false;
865 *event_log_location = (uintptr_t)event_log.buffer;
866 *event_log_last_entry = (uintptr_t)(event_log.buffer + event_log.pos -
867 event_log.last_event_size);
868 *event_log_truncated = event_log.truncated;
869 event_log.get_event_called = true;
872 return EFI_EXIT(ret);
876 * tcg2_hash_pe_image() - calculate PE/COFF image hash
878 * @efi: pointer to the EFI binary
879 * @efi_size: size of @efi binary
880 * @digest_list: list of digest algorithms to extend
882 * Return: status code
884 static efi_status_t tcg2_hash_pe_image(void *efi, u64 efi_size,
885 struct tpml_digest_values *digest_list)
887 WIN_CERTIFICATE *wincerts = NULL;
889 struct efi_image_regions *regs = NULL;
890 void *new_efi = NULL;
891 u8 hash[TPM2_SHA512_DIGEST_SIZE];
896 new_efi = efi_prepare_aligned_image(efi, &efi_size);
898 return EFI_OUT_OF_RESOURCES;
900 if (!efi_image_parse(new_efi, efi_size, ®s, &wincerts,
902 log_err("Parsing PE executable image failed\n");
903 ret = EFI_UNSUPPORTED;
907 ret = __get_active_pcr_banks(&active);
908 if (ret != EFI_SUCCESS) {
912 digest_list->count = 0;
913 for (i = 0; i < MAX_HASH_COUNT; i++) {
914 u16 hash_alg = hash_algo_list[i].hash_alg;
916 if (!(active & alg_to_mask(hash_alg)))
920 hash_calculate("sha1", regs->reg, regs->num, hash);
922 case TPM2_ALG_SHA256:
923 hash_calculate("sha256", regs->reg, regs->num, hash);
925 case TPM2_ALG_SHA384:
926 hash_calculate("sha384", regs->reg, regs->num, hash);
928 case TPM2_ALG_SHA512:
929 hash_calculate("sha512", regs->reg, regs->num, hash);
934 digest_list->digests[digest_list->count].hash_alg = hash_alg;
935 memcpy(&digest_list->digests[digest_list->count].digest, hash,
936 (u32)alg_to_len(hash_alg));
937 digest_list->count++;
949 * tcg2_measure_pe_image() - measure PE/COFF image
951 * @efi: pointer to the EFI binary
952 * @efi_size: size of @efi binary
953 * @handle: loaded image handle
954 * @loaded_image: loaded image protocol
956 * Return: status code
958 efi_status_t tcg2_measure_pe_image(void *efi, u64 efi_size,
959 struct efi_loaded_image_obj *handle,
960 struct efi_loaded_image *loaded_image)
962 struct tpml_digest_values digest_list;
965 u32 pcr_index, event_type, event_size;
966 struct uefi_image_load_event *image_load_event;
967 struct efi_device_path *device_path;
968 u32 device_path_length;
969 IMAGE_DOS_HEADER *dos;
970 IMAGE_NT_HEADERS32 *nt;
971 struct efi_handler *handler;
973 if (!is_tcg2_protocol_installed())
976 ret = platform_get_tpm2_device(&dev);
977 if (ret != EFI_SUCCESS)
978 return EFI_SECURITY_VIOLATION;
980 switch (handle->image_type) {
981 case IMAGE_SUBSYSTEM_EFI_APPLICATION:
983 event_type = EV_EFI_BOOT_SERVICES_APPLICATION;
985 case IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER:
987 event_type = EV_EFI_BOOT_SERVICES_DRIVER;
989 case IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER:
991 event_type = EV_EFI_RUNTIME_SERVICES_DRIVER;
994 return EFI_UNSUPPORTED;
997 ret = tcg2_hash_pe_image(efi, efi_size, &digest_list);
998 if (ret != EFI_SUCCESS)
1001 ret = tcg2_pcr_extend(dev, pcr_index, &digest_list);
1002 if (ret != EFI_SUCCESS)
1005 ret = efi_search_protocol(&handle->header,
1006 &efi_guid_loaded_image_device_path, &handler);
1007 if (ret != EFI_SUCCESS)
1010 device_path = handler->protocol_interface;
1011 device_path_length = efi_dp_size(device_path);
1012 if (device_path_length > 0) {
1013 /* add end node size */
1014 device_path_length += sizeof(struct efi_device_path);
1016 event_size = sizeof(struct uefi_image_load_event) + device_path_length;
1017 image_load_event = calloc(1, event_size);
1018 if (!image_load_event)
1019 return EFI_OUT_OF_RESOURCES;
1021 image_load_event->image_location_in_memory = (uintptr_t)efi;
1022 image_load_event->image_length_in_memory = efi_size;
1023 image_load_event->length_of_device_path = device_path_length;
1025 dos = (IMAGE_DOS_HEADER *)efi;
1026 nt = (IMAGE_NT_HEADERS32 *)(efi + dos->e_lfanew);
1027 if (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR64_MAGIC) {
1028 IMAGE_NT_HEADERS64 *nt64 = (IMAGE_NT_HEADERS64 *)nt;
1030 image_load_event->image_link_time_address =
1031 nt64->OptionalHeader.ImageBase;
1032 } else if (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1033 image_load_event->image_link_time_address =
1034 nt->OptionalHeader.ImageBase;
1036 ret = EFI_INVALID_PARAMETER;
1040 /* device_path_length might be zero */
1041 memcpy(image_load_event->device_path, device_path, device_path_length);
1043 ret = tcg2_agile_log_append(pcr_index, event_type, &digest_list,
1044 event_size, (u8 *)image_load_event);
1047 free(image_load_event);
1053 * efi_tcg2_hash_log_extend_event() - extend and optionally log events
1055 * @this: TCG2 protocol instance
1056 * @flags: bitmap providing additional information on the
1058 * @data_to_hash: physical address of the start of the data buffer
1060 * @data_to_hash_len: the length in bytes of the buffer referenced by
1062 * @efi_tcg_event: pointer to data buffer containing information
1065 * Return: status code
1067 static efi_status_t EFIAPI
1068 efi_tcg2_hash_log_extend_event(struct efi_tcg2_protocol *this, u64 flags,
1069 u64 data_to_hash, u64 data_to_hash_len,
1070 struct efi_tcg2_event *efi_tcg_event)
1072 struct udevice *dev;
1074 u32 event_type, pcr_index, event_size;
1075 struct tpml_digest_values digest_list;
1077 EFI_ENTRY("%p, %llu, %llu, %llu, %p", this, flags, data_to_hash,
1078 data_to_hash_len, efi_tcg_event);
1080 if (!this || !data_to_hash || !efi_tcg_event) {
1081 ret = EFI_INVALID_PARAMETER;
1085 ret = platform_get_tpm2_device(&dev);
1086 if (ret != EFI_SUCCESS)
1089 if (efi_tcg_event->size < efi_tcg_event->header.header_size +
1091 ret = EFI_INVALID_PARAMETER;
1095 if (efi_tcg_event->header.pcr_index > EFI_TCG2_MAX_PCR_INDEX) {
1096 ret = EFI_INVALID_PARAMETER;
1101 * if PE_COFF_IMAGE is set we need to make sure the image is not
1102 * corrupted, verify it and hash the PE/COFF image in accordance with
1103 * the procedure specified in "Calculating the PE Image Hash"
1104 * section of the "Windows Authenticode Portable Executable Signature
1107 if (flags & PE_COFF_IMAGE) {
1108 IMAGE_NT_HEADERS32 *nt;
1110 ret = efi_check_pe((void *)(uintptr_t)data_to_hash,
1111 data_to_hash_len, (void **)&nt);
1112 if (ret != EFI_SUCCESS) {
1113 log_err("Not a valid PE-COFF file\n");
1114 ret = EFI_UNSUPPORTED;
1117 ret = tcg2_hash_pe_image((void *)(uintptr_t)data_to_hash,
1118 data_to_hash_len, &digest_list);
1120 ret = tcg2_create_digest((u8 *)(uintptr_t)data_to_hash,
1121 data_to_hash_len, &digest_list);
1124 if (ret != EFI_SUCCESS)
1127 pcr_index = efi_tcg_event->header.pcr_index;
1128 event_type = efi_tcg_event->header.event_type;
1130 ret = tcg2_pcr_extend(dev, pcr_index, &digest_list);
1131 if (ret != EFI_SUCCESS)
1134 if (flags & EFI_TCG2_EXTEND_ONLY) {
1135 if (event_log.truncated)
1136 ret = EFI_VOLUME_FULL;
1141 * The efi_tcg_event size includes the size component and the
1144 event_size = efi_tcg_event->size - sizeof(efi_tcg_event->size) -
1145 efi_tcg_event->header.header_size;
1146 ret = tcg2_agile_log_append(pcr_index, event_type, &digest_list,
1147 event_size, efi_tcg_event->event);
1149 return EFI_EXIT(ret);
1153 * efi_tcg2_submit_command() - Send command to the TPM
1155 * @this: TCG2 protocol instance
1156 * @input_param_block_size: size of the TPM input parameter block
1157 * @input_param_block: pointer to the TPM input parameter block
1158 * @output_param_block_size: size of the TPM output parameter block
1159 * @output_param_block: pointer to the TPM output parameter block
1161 * Return: status code
1163 static efi_status_t EFIAPI
1164 efi_tcg2_submit_command(struct efi_tcg2_protocol *this,
1165 u32 input_param_block_size,
1166 u8 *input_param_block,
1167 u32 output_param_block_size,
1168 u8 *output_param_block)
1170 struct udevice *dev;
1173 size_t resp_buf_size = output_param_block_size;
1175 EFI_ENTRY("%p, %u, %p, %u, %p", this, input_param_block_size,
1176 input_param_block, output_param_block_size, output_param_block);
1178 if (!this || !input_param_block || !input_param_block_size) {
1179 ret = EFI_INVALID_PARAMETER;
1183 ret = platform_get_tpm2_device(&dev);
1184 if (ret != EFI_SUCCESS)
1187 rc = tpm2_submit_command(dev, input_param_block,
1188 output_param_block, &resp_buf_size);
1190 ret = (rc == -ENOSPC) ? EFI_OUT_OF_RESOURCES : EFI_DEVICE_ERROR;
1196 return EFI_EXIT(ret);
1200 * efi_tcg2_get_active_pcr_banks() - returns the currently active PCR banks
1202 * @this: TCG2 protocol instance
1203 * @active_pcr_banks: pointer for receiving the bitmap of currently
1206 * Return: status code
1208 static efi_status_t EFIAPI
1209 efi_tcg2_get_active_pcr_banks(struct efi_tcg2_protocol *this,
1210 u32 *active_pcr_banks)
1214 if (!this || !active_pcr_banks) {
1215 ret = EFI_INVALID_PARAMETER;
1219 EFI_ENTRY("%p, %p", this, active_pcr_banks);
1220 ret = __get_active_pcr_banks(active_pcr_banks);
1223 return EFI_EXIT(ret);
1227 * efi_tcg2_set_active_pcr_banks() - sets the currently active PCR banks
1229 * @this: TCG2 protocol instance
1230 * @active_pcr_banks: bitmap of the requested active PCR banks
1232 * Return: status code
1234 static efi_status_t EFIAPI
1235 efi_tcg2_set_active_pcr_banks(__maybe_unused struct efi_tcg2_protocol *this,
1236 u32 __maybe_unused active_pcr_banks)
1238 return EFI_UNSUPPORTED;
1242 * efi_tcg2_get_result_of_set_active_pcr_banks() - retrieve result for previous
1243 * set_active_pcr_banks()
1245 * @this: TCG2 protocol instance
1246 * @operation_present: non-zero value to indicate a
1247 * set_active_pcr_banks operation was
1248 * invoked during last boot
1249 * @response: result value could be returned
1251 * Return: status code
1253 static efi_status_t EFIAPI
1254 efi_tcg2_get_result_of_set_active_pcr_banks(__maybe_unused struct efi_tcg2_protocol *this,
1255 u32 __maybe_unused *operation_present,
1256 u32 __maybe_unused *response)
1258 return EFI_UNSUPPORTED;
1261 static const struct efi_tcg2_protocol efi_tcg2_protocol = {
1262 .get_capability = efi_tcg2_get_capability,
1263 .get_eventlog = efi_tcg2_get_eventlog,
1264 .hash_log_extend_event = efi_tcg2_hash_log_extend_event,
1265 .submit_command = efi_tcg2_submit_command,
1266 .get_active_pcr_banks = efi_tcg2_get_active_pcr_banks,
1267 .set_active_pcr_banks = efi_tcg2_set_active_pcr_banks,
1268 .get_result_of_set_active_pcr_banks = efi_tcg2_get_result_of_set_active_pcr_banks,
1272 * parse_event_log_header() - Parse and verify the event log header fields
1274 * @buffer: Pointer to the start of the eventlog
1275 * @size: Size of the eventlog
1276 * @pos: Return offset of the next event in buffer right
1277 * after the event header i.e specID
1279 * Return: status code
1281 static efi_status_t parse_event_log_header(void *buffer, u32 size, u32 *pos)
1283 struct tcg_pcr_event *event_header = (struct tcg_pcr_event *)buffer;
1286 if (size < sizeof(*event_header))
1287 return EFI_COMPROMISED_DATA;
1289 if (get_unaligned_le32(&event_header->pcr_index) != 0 ||
1290 get_unaligned_le32(&event_header->event_type) != EV_NO_ACTION)
1291 return EFI_COMPROMISED_DATA;
1293 for (i = 0; i < sizeof(event_header->digest); i++) {
1294 if (event_header->digest[i])
1295 return EFI_COMPROMISED_DATA;
1298 *pos += sizeof(*event_header);
1304 * parse_specid_event() - Parse and verify the specID Event in the eventlog
1307 * @buffer: Pointer to the start of the eventlog
1308 * @log_size: Size of the eventlog
1309 * @pos: [in] Offset of specID event in the eventlog buffer
1310 * [out] Return offset of the next event in the buffer
1312 * @digest_list: list of digests in the event
1314 * Return: status code
1315 * @pos Offset in the eventlog where the specID event ends
1316 * @digest_list: list of digests in the event
1318 static efi_status_t parse_specid_event(struct udevice *dev, void *buffer,
1319 u32 log_size, u32 *pos,
1320 struct tpml_digest_values *digest_list)
1322 struct tcg_efi_spec_id_event *spec_event;
1323 struct tcg_pcr_event *event_header = (struct tcg_pcr_event *)buffer;
1324 size_t spec_event_size;
1325 u32 active = 0, supported = 0, pcr_count = 0, alg_count = 0;
1326 u32 spec_active = 0;
1331 if (*pos >= log_size || (*pos + sizeof(*spec_event)) > log_size)
1332 return EFI_COMPROMISED_DATA;
1334 /* Check specID event data */
1335 spec_event = (struct tcg_efi_spec_id_event *)((uintptr_t)buffer + *pos);
1336 /* Check for signature */
1337 if (memcmp(spec_event->signature, TCG_EFI_SPEC_ID_EVENT_SIGNATURE_03,
1338 sizeof(TCG_EFI_SPEC_ID_EVENT_SIGNATURE_03))) {
1339 log_err("specID Event: Signature mismatch\n");
1340 return EFI_COMPROMISED_DATA;
1343 if (spec_event->spec_version_minor !=
1344 TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MINOR_TPM2 ||
1345 spec_event->spec_version_major !=
1346 TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MAJOR_TPM2)
1347 return EFI_COMPROMISED_DATA;
1349 if (spec_event->number_of_algorithms > MAX_HASH_COUNT ||
1350 spec_event->number_of_algorithms < 1) {
1351 log_err("specID Event: Number of algorithms incorrect\n");
1352 return EFI_COMPROMISED_DATA;
1355 alg_count = spec_event->number_of_algorithms;
1357 err = tpm2_get_pcr_info(dev, &supported, &active, &pcr_count);
1359 return EFI_DEVICE_ERROR;
1361 digest_list->count = 0;
1363 * We have to take care that the sequence of algorithms that we record
1364 * in digest_list matches the sequence in eventlog.
1366 for (i = 0; i < alg_count; i++) {
1368 get_unaligned_le16(&spec_event->digest_sizes[i].algorithm_id);
1370 if (!(supported & alg_to_mask(hash_alg))) {
1371 log_err("specID Event: Unsupported algorithm\n");
1372 return EFI_COMPROMISED_DATA;
1374 digest_list->digests[digest_list->count++].hash_alg = hash_alg;
1376 spec_active |= alg_to_mask(hash_alg);
1380 * TCG specification expects the event log to have hashes for all
1383 if (spec_active != active) {
1385 * Previous stage bootloader should know all the active PCR's
1386 * and use them in the Eventlog.
1388 log_err("specID Event: All active hash alg not present\n");
1389 return EFI_COMPROMISED_DATA;
1393 * the size of the spec event and placement of vendor_info_size
1394 * depends on supported algoriths
1397 offsetof(struct tcg_efi_spec_id_event, digest_sizes) +
1398 alg_count * sizeof(spec_event->digest_sizes[0]);
1400 if (*pos + spec_event_size >= log_size)
1401 return EFI_COMPROMISED_DATA;
1403 vendor_sz = *(uint8_t *)((uintptr_t)buffer + *pos + spec_event_size);
1405 spec_event_size += sizeof(vendor_sz) + vendor_sz;
1406 *pos += spec_event_size;
1408 if (get_unaligned_le32(&event_header->event_size) != spec_event_size) {
1409 log_err("specID event: header event size mismatch\n");
1410 /* Right way to handle this can be to call SetActive PCR's */
1411 return EFI_COMPROMISED_DATA;
1418 * tcg2_parse_event() - Parse the event in the eventlog
1421 * @buffer: Pointer to the start of the eventlog
1422 * @log_size: Size of the eventlog
1423 * @offset: [in] Offset of the event in the eventlog buffer
1424 * [out] Return offset of the next event in the buffer
1425 * @digest_list: list of digests in the event
1426 * @pcr Index of the PCR in the event
1428 * Return: status code
1430 static efi_status_t tcg2_parse_event(struct udevice *dev, void *buffer,
1431 u32 log_size, u32 *offset,
1432 struct tpml_digest_values *digest_list,
1435 struct tcg_pcr_event2 *event = NULL;
1436 u32 count, size, event_size;
1439 event_size = tcg_event_final_size(digest_list);
1440 if (*offset >= log_size || *offset + event_size > log_size) {
1441 log_err("Event exceeds log size\n");
1442 return EFI_COMPROMISED_DATA;
1445 event = (struct tcg_pcr_event2 *)((uintptr_t)buffer + *offset);
1446 *pcr = get_unaligned_le32(&event->pcr_index);
1449 count = get_unaligned_le32(&event->digests.count);
1450 if (count != digest_list->count)
1451 return EFI_COMPROMISED_DATA;
1453 pos = offsetof(struct tcg_pcr_event2, digests);
1454 pos += offsetof(struct tpml_digest_values, digests);
1456 for (int i = 0; i < digest_list->count; i++) {
1458 u16 hash_alg = digest_list->digests[i].hash_alg;
1459 u8 *digest = (u8 *)&digest_list->digests[i].digest;
1461 alg = get_unaligned_le16((void *)((uintptr_t)event + pos));
1463 if (alg != hash_alg)
1464 return EFI_COMPROMISED_DATA;
1466 pos += offsetof(struct tpmt_ha, digest);
1467 memcpy(digest, (void *)((uintptr_t)event + pos), alg_to_len(hash_alg));
1468 pos += alg_to_len(hash_alg);
1471 size = get_unaligned_le32((void *)((uintptr_t)event + pos));
1473 pos += sizeof(u32); /* tcg_pcr_event2 event_size*/
1476 /* make sure the calculated buffer is what we checked against */
1477 if (pos != event_size)
1478 return EFI_COMPROMISED_DATA;
1481 return EFI_COMPROMISED_DATA;
1489 * tcg2_get_fw_eventlog() - Get the eventlog address and size
1491 * If the previous firmware has passed some eventlog, this function get it's
1492 * location and check for it's validity.
1495 * @log_buffer: eventlog address
1496 * @log_sz: eventlog size
1498 * Return: status code
1500 static efi_status_t tcg2_get_fw_eventlog(struct udevice *dev, void *log_buffer,
1503 struct tpml_digest_values digest_list;
1509 bool extend_pcr = false;
1512 ret = platform_get_eventlog(dev, &base, &sz);
1513 if (ret != EFI_SUCCESS)
1516 if (sz > TPM2_EVENT_LOG_SIZE)
1517 return EFI_VOLUME_FULL;
1519 buffer = (void *)(uintptr_t)base;
1521 /* Parse the eventlog to check for its validity */
1522 ret = parse_event_log_header(buffer, sz, &pos);
1526 ret = parse_specid_event(dev, buffer, sz, &pos, &digest_list);
1528 log_err("Error parsing SPEC ID Event\n");
1532 ret = tcg2_pcr_read(dev, 0, &digest_list);
1534 log_err("Error reading PCR 0\n");
1539 * If PCR0 is 0, previous firmware didn't have the capability
1540 * to extend the PCR. In this scenario, extend the PCR as
1541 * the eventlog is parsed.
1543 for (i = 0; i < digest_list.count; i++) {
1544 u8 hash_buf[TPM2_SHA512_DIGEST_SIZE] = { 0 };
1545 u16 hash_alg = digest_list.digests[i].hash_alg;
1547 if (!memcmp((u8 *)&digest_list.digests[i].digest, hash_buf,
1548 alg_to_len(hash_alg)))
1553 ret = tcg2_parse_event(dev, buffer, sz, &pos, &digest_list,
1556 log_err("Error parsing event\n");
1560 ret = tcg2_pcr_extend(dev, pcr, &digest_list);
1561 if (ret != EFI_SUCCESS) {
1562 log_err("Error in extending PCR\n");
1566 /* Clear the digest for next event */
1567 for (i = 0; i < digest_list.count; i++) {
1568 u16 hash_alg = digest_list.digests[i].hash_alg;
1570 (u8 *)&digest_list.digests[i].digest;
1572 memset(digest, 0, alg_to_len(hash_alg));
1577 memcpy(log_buffer, buffer, sz);
1584 * create_specid_event() - Create the first event in the eventlog
1587 * @event_header: Pointer to the final event header
1588 * @event_size: final spec event size
1590 * Return: status code
1592 static efi_status_t create_specid_event(struct udevice *dev, void *buffer,
1595 struct tcg_efi_spec_id_event *spec_event;
1596 size_t spec_event_size;
1597 efi_status_t ret = EFI_DEVICE_ERROR;
1598 u32 active = 0, supported = 0, pcr_count = 0, alg_count = 0;
1603 * Create Spec event. This needs to be the first event in the log
1604 * according to the TCG EFI protocol spec
1607 /* Setup specID event data */
1608 spec_event = (struct tcg_efi_spec_id_event *)buffer;
1609 memcpy(spec_event->signature, TCG_EFI_SPEC_ID_EVENT_SIGNATURE_03,
1610 sizeof(spec_event->signature));
1611 put_unaligned_le32(0, &spec_event->platform_class); /* type client */
1612 spec_event->spec_version_minor =
1613 TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MINOR_TPM2;
1614 spec_event->spec_version_major =
1615 TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MAJOR_TPM2;
1616 spec_event->spec_errata =
1617 TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_ERRATA_TPM2;
1618 spec_event->uintn_size = sizeof(efi_uintn_t) / sizeof(u32);
1620 err = tpm2_get_pcr_info(dev, &supported, &active, &pcr_count);
1625 for (i = 0; i < pcr_count; i++) {
1626 u16 hash_alg = hash_algo_list[i].hash_alg;
1627 u16 hash_len = hash_algo_list[i].hash_len;
1629 if (active & alg_to_mask(hash_alg)) {
1630 put_unaligned_le16(hash_alg,
1631 &spec_event->digest_sizes[alg_count].algorithm_id);
1632 put_unaligned_le16(hash_len,
1633 &spec_event->digest_sizes[alg_count].digest_size);
1638 spec_event->number_of_algorithms = alg_count;
1639 if (spec_event->number_of_algorithms > MAX_HASH_COUNT ||
1640 spec_event->number_of_algorithms < 1)
1644 * the size of the spec event and placement of vendor_info_size
1645 * depends on supported algoriths
1648 offsetof(struct tcg_efi_spec_id_event, digest_sizes) +
1649 spec_event->number_of_algorithms * sizeof(spec_event->digest_sizes[0]);
1650 /* no vendor info for us */
1651 memset(buffer + spec_event_size, 0, 1);
1652 /* add a byte for vendor_info_size in the spec event */
1653 spec_event_size += 1;
1654 *event_size = spec_event_size;
1663 * tcg2_uninit - remove the final event table and free efi memory on failures
1665 void tcg2_uninit(void)
1669 ret = efi_install_configuration_table(&efi_guid_final_events, NULL);
1670 if (ret != EFI_SUCCESS)
1671 log_err("Failed to delete final events config table\n");
1673 efi_free_pool(event_log.buffer);
1674 event_log.buffer = NULL;
1675 efi_free_pool(event_log.final_buffer);
1676 event_log.final_buffer = NULL;
1678 if (!is_tcg2_protocol_installed())
1681 ret = efi_uninstall_multiple_protocol_interfaces(efi_root, &efi_guid_tcg2_protocol,
1682 &efi_tcg2_protocol, NULL);
1683 if (ret != EFI_SUCCESS)
1684 log_err("Failed to remove EFI TCG2 protocol\n");
1688 * create_final_event() - Create the final event and install the config
1689 * defined by the TCG EFI spec
1691 static efi_status_t create_final_event(void)
1693 struct efi_tcg2_final_events_table *final_event;
1697 * All events generated after the invocation of
1698 * EFI_TCG2_GET_EVENT_LOGS need to be stored in an instance of an
1699 * EFI_CONFIGURATION_TABLE
1701 ret = efi_allocate_pool(EFI_ACPI_MEMORY_NVS, TPM2_EVENT_LOG_SIZE,
1702 &event_log.final_buffer);
1703 if (ret != EFI_SUCCESS)
1706 memset(event_log.final_buffer, 0xff, TPM2_EVENT_LOG_SIZE);
1707 final_event = event_log.final_buffer;
1708 final_event->number_of_events = 0;
1709 final_event->version = EFI_TCG2_FINAL_EVENTS_TABLE_VERSION;
1710 event_log.final_pos = sizeof(*final_event);
1711 ret = efi_install_configuration_table(&efi_guid_final_events,
1713 if (ret != EFI_SUCCESS) {
1714 efi_free_pool(event_log.final_buffer);
1715 event_log.final_buffer = NULL;
1723 * tcg2_measure_event() - common function to add event log and extend PCR
1726 * @pcr_index: PCR index
1727 * @event_type: type of event added
1729 * @event: event data
1731 * Return: status code
1734 tcg2_measure_event(struct udevice *dev, u32 pcr_index, u32 event_type,
1735 u32 size, u8 event[])
1737 struct tpml_digest_values digest_list;
1740 ret = tcg2_create_digest(event, size, &digest_list);
1741 if (ret != EFI_SUCCESS)
1744 ret = tcg2_pcr_extend(dev, pcr_index, &digest_list);
1745 if (ret != EFI_SUCCESS)
1748 ret = tcg2_agile_log_append(pcr_index, event_type, &digest_list,
1756 * efi_append_scrtm_version - Append an S-CRTM EV_S_CRTM_VERSION event on the
1757 * eventlog and extend the PCRs
1761 * @Return: status code
1763 static efi_status_t efi_append_scrtm_version(struct udevice *dev)
1767 ret = tcg2_measure_event(dev, 0, EV_S_CRTM_VERSION,
1768 strlen(version_string) + 1,
1769 (u8 *)version_string);
1775 * efi_init_event_log() - initialize an eventlog
1777 * Return: status code
1779 static efi_status_t efi_init_event_log(void)
1782 * vendor_info_size is currently set to 0, we need to change the length
1783 * and allocate the flexible array member if this changes
1785 struct tcg_pcr_event *event_header = NULL;
1786 struct udevice *dev;
1787 size_t spec_event_size;
1790 ret = platform_get_tpm2_device(&dev);
1791 if (ret != EFI_SUCCESS)
1794 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, TPM2_EVENT_LOG_SIZE,
1795 (void **)&event_log.buffer);
1796 if (ret != EFI_SUCCESS)
1800 * initialize log area as 0xff so the OS can easily figure out the
1803 memset(event_log.buffer, 0xff, TPM2_EVENT_LOG_SIZE);
1806 * The log header is defined to be in SHA1 event log entry format.
1807 * Setup event header
1809 event_header = (struct tcg_pcr_event *)event_log.buffer;
1811 event_log.last_event_size = 0;
1812 event_log.get_event_called = false;
1813 event_log.ebs_called = false;
1814 event_log.truncated = false;
1817 * Check if earlier firmware have passed any eventlog. Different
1818 * platforms can use different ways to do so.
1820 ret = tcg2_get_fw_eventlog(dev, event_log.buffer, &event_log.pos);
1822 * If earlier firmware hasn't passed any eventlog, go ahead and
1823 * create the eventlog header.
1825 if (ret == EFI_NOT_FOUND) {
1826 put_unaligned_le32(0, &event_header->pcr_index);
1827 put_unaligned_le32(EV_NO_ACTION, &event_header->event_type);
1828 memset(&event_header->digest, 0, sizeof(event_header->digest));
1829 ret = create_specid_event(dev,
1830 (void *)((uintptr_t)event_log.buffer +
1831 sizeof(*event_header)),
1833 if (ret != EFI_SUCCESS)
1835 put_unaligned_le32(spec_event_size, &event_header->event_size);
1836 event_log.pos = spec_event_size + sizeof(*event_header);
1837 event_log.last_event_size = event_log.pos;
1840 * Add SCRTM version to the log if previous firmmware
1841 * doesn't pass an eventlog.
1843 ret = efi_append_scrtm_version(dev);
1846 if (ret != EFI_SUCCESS)
1849 ret = create_final_event();
1850 if (ret != EFI_SUCCESS)
1856 efi_free_pool(event_log.buffer);
1857 event_log.buffer = NULL;
1862 * tcg2_measure_variable() - add variable event log and extend PCR
1865 * @pcr_index: PCR index
1866 * @event_type: type of event added
1867 * @var_name: variable name
1869 * @data_size: variable data size
1870 * @data: variable data
1872 * Return: status code
1874 static efi_status_t tcg2_measure_variable(struct udevice *dev, u32 pcr_index,
1875 u32 event_type, const u16 *var_name,
1876 const efi_guid_t *guid,
1877 efi_uintn_t data_size, u8 *data)
1881 struct efi_tcg2_uefi_variable_data *event;
1883 event_size = sizeof(event->variable_name) +
1884 sizeof(event->unicode_name_length) +
1885 sizeof(event->variable_data_length) +
1886 (u16_strlen(var_name) * sizeof(u16)) + data_size;
1887 event = malloc(event_size);
1889 return EFI_OUT_OF_RESOURCES;
1891 guidcpy(&event->variable_name, guid);
1892 event->unicode_name_length = u16_strlen(var_name);
1893 event->variable_data_length = data_size;
1894 memcpy(event->unicode_name, var_name,
1895 (event->unicode_name_length * sizeof(u16)));
1897 memcpy((u16 *)event->unicode_name + event->unicode_name_length,
1900 ret = tcg2_measure_event(dev, pcr_index, event_type, event_size,
1907 * tcg2_measure_boot_variable() - measure boot variables
1911 * Return: status code
1913 static efi_status_t tcg2_measure_boot_variable(struct udevice *dev)
1917 u16 var_name[] = u"BootOrder";
1918 u16 boot_name[] = u"Boot####";
1920 efi_uintn_t var_data_size;
1924 boot_order = efi_get_var(var_name, &efi_global_variable_guid,
1927 /* If "BootOrder" is not defined, skip the boot variable measurement */
1931 ret = tcg2_measure_variable(dev, 1, EV_EFI_VARIABLE_BOOT2, var_name,
1932 &efi_global_variable_guid, var_data_size,
1934 if (ret != EFI_SUCCESS)
1937 count = var_data_size / sizeof(*boot_order);
1938 boot_index = boot_order;
1939 for (i = 0; i < count; i++) {
1940 efi_create_indexed_name(boot_name, sizeof(boot_name),
1941 "Boot", *boot_index++);
1943 bootvar = efi_get_var(boot_name, &efi_global_variable_guid,
1947 log_debug("%ls not found\n", boot_name);
1951 ret = tcg2_measure_variable(dev, 1, EV_EFI_VARIABLE_BOOT2,
1953 &efi_global_variable_guid,
1954 var_data_size, bootvar);
1956 if (ret != EFI_SUCCESS)
1966 * tcg2_measure_smbios() - measure smbios table
1969 * @entry: pointer to the smbios_entry structure
1971 * Return: status code
1974 tcg2_measure_smbios(struct udevice *dev,
1975 const struct smbios_entry *entry)
1978 struct smbios_header *smbios_copy;
1979 struct smbios_handoff_table_pointers2 *event = NULL;
1983 * TCG PC Client PFP Spec says
1984 * "SMBIOS structures that contain static configuration information
1985 * (e.g. Platform Manufacturer Enterprise Number assigned by IANA,
1986 * platform model number, Vendor and Device IDs for each SMBIOS table)
1987 * that is relevant to the security of the platform MUST be measured".
1988 * Device dependent parameters such as serial number are cleared to
1989 * zero or spaces for the measurement.
1991 event_size = sizeof(struct smbios_handoff_table_pointers2) +
1992 FIELD_SIZEOF(struct efi_configuration_table, guid) +
1993 entry->struct_table_length;
1994 event = calloc(1, event_size);
1996 ret = EFI_OUT_OF_RESOURCES;
2000 event->table_description_size = sizeof(SMBIOS_HANDOFF_TABLE_DESC);
2001 memcpy(event->table_description, SMBIOS_HANDOFF_TABLE_DESC,
2002 sizeof(SMBIOS_HANDOFF_TABLE_DESC));
2003 put_unaligned_le64(1, &event->number_of_tables);
2004 guidcpy(&event->table_entry[0].guid, &smbios_guid);
2005 smbios_copy = (struct smbios_header *)((uintptr_t)&event->table_entry[0].table);
2006 memcpy(&event->table_entry[0].table,
2007 (void *)((uintptr_t)entry->struct_table_address),
2008 entry->struct_table_length);
2010 smbios_prepare_measurement(entry, smbios_copy);
2012 ret = tcg2_measure_event(dev, 1, EV_EFI_HANDOFF_TABLES2, event_size,
2014 if (ret != EFI_SUCCESS)
2024 * find_smbios_table() - find smbios table
2026 * Return: pointer to the smbios table
2028 static void *find_smbios_table(void)
2032 for (i = 0; i < systab.nr_tables; i++) {
2033 if (!guidcmp(&smbios_guid, &systab.tables[i].guid))
2034 return systab.tables[i].table;
2041 * tcg2_measure_gpt_table() - measure gpt table
2044 * @loaded_image: handle to the loaded image
2046 * Return: status code
2049 tcg2_measure_gpt_data(struct udevice *dev,
2050 struct efi_loaded_image_obj *loaded_image)
2053 efi_handle_t handle;
2054 struct efi_handler *dp_handler, *io_handler;
2055 struct efi_device_path *orig_device_path;
2056 struct efi_device_path *device_path;
2057 struct efi_device_path *dp;
2058 struct efi_block_io *block_io;
2059 struct efi_gpt_data *event = NULL;
2060 efi_guid_t null_guid = NULL_GUID;
2062 gpt_entry *entry = NULL;
2064 u32 num_of_valid_entry = 0;
2067 u32 total_gpt_entry_size;
2069 ret = efi_search_protocol(&loaded_image->header,
2070 &efi_guid_loaded_image_device_path,
2072 if (ret != EFI_SUCCESS)
2075 orig_device_path = dp_handler->protocol_interface;
2076 if (!orig_device_path) /* no device path, skip GPT measurement */
2079 device_path = efi_dp_dup(orig_device_path);
2081 return EFI_OUT_OF_RESOURCES;
2083 dp = search_gpt_dp_node(device_path);
2085 /* no GPT device path node found, skip GPT measurement */
2090 /* read GPT header */
2091 dp->type = DEVICE_PATH_TYPE_END;
2092 dp->sub_type = DEVICE_PATH_SUB_TYPE_END;
2094 ret = EFI_CALL(systab.boottime->locate_device_path(&efi_block_io_guid,
2096 if (ret != EFI_SUCCESS)
2099 ret = efi_search_protocol(handle, &efi_block_io_guid, &io_handler);
2100 if (ret != EFI_SUCCESS)
2102 block_io = io_handler->protocol_interface;
2104 gpt_h = memalign(block_io->media->io_align, block_io->media->block_size);
2106 ret = EFI_OUT_OF_RESOURCES;
2110 ret = block_io->read_blocks(block_io, block_io->media->media_id, 1,
2111 block_io->media->block_size, gpt_h);
2112 if (ret != EFI_SUCCESS)
2115 /* read GPT entry */
2116 total_gpt_entry_size = gpt_h->num_partition_entries *
2117 gpt_h->sizeof_partition_entry;
2118 entry = memalign(block_io->media->io_align, total_gpt_entry_size);
2120 ret = EFI_OUT_OF_RESOURCES;
2124 ret = block_io->read_blocks(block_io, block_io->media->media_id,
2125 gpt_h->partition_entry_lba,
2126 total_gpt_entry_size, entry);
2127 if (ret != EFI_SUCCESS)
2130 /* count valid GPT entry */
2132 for (i = 0; i < gpt_h->num_partition_entries; i++) {
2133 if (guidcmp(&null_guid, &gpt_e->partition_type_guid))
2134 num_of_valid_entry++;
2136 gpt_e = (gpt_entry *)((u8 *)gpt_e + gpt_h->sizeof_partition_entry);
2139 /* prepare event data for measurement */
2140 event_size = sizeof(struct efi_gpt_data) +
2141 (num_of_valid_entry * gpt_h->sizeof_partition_entry);
2142 event = calloc(1, event_size);
2144 ret = EFI_OUT_OF_RESOURCES;
2147 memcpy(event, gpt_h, sizeof(gpt_header));
2148 put_unaligned_le64(num_of_valid_entry, &event->number_of_partitions);
2150 /* copy valid GPT entry */
2152 num_of_valid_entry = 0;
2153 for (i = 0; i < gpt_h->num_partition_entries; i++) {
2154 if (guidcmp(&null_guid, &gpt_e->partition_type_guid)) {
2155 memcpy((u8 *)event->partitions +
2156 (num_of_valid_entry * gpt_h->sizeof_partition_entry),
2157 gpt_e, gpt_h->sizeof_partition_entry);
2158 num_of_valid_entry++;
2161 gpt_e = (gpt_entry *)((u8 *)gpt_e + gpt_h->sizeof_partition_entry);
2164 ret = tcg2_measure_event(dev, 5, EV_EFI_GPT_EVENT, event_size, (u8 *)event);
2171 efi_free_pool(device_path);
2176 /* Return the byte size of reserved map area in DTB or -1 upon error */
2177 static ssize_t size_of_rsvmap(void *dtb)
2179 struct fdt_reserve_entry e;
2184 rsvmap_base = (u8 *)dtb + fdt_off_mem_rsvmap(dtb);
2185 size_max = fdt_totalsize(dtb) - fdt_off_mem_rsvmap(dtb);
2189 memcpy(&e, rsvmap_base + size, sizeof(e));
2191 if (size > size_max)
2199 * efi_tcg2_measure_dtb() - measure DTB passed to the OS
2201 * @dtb: pointer to the device tree blob
2203 * Return: status code
2205 efi_status_t efi_tcg2_measure_dtb(void *dtb)
2207 struct uefi_platform_firmware_blob2 *blob;
2208 struct fdt_header *header;
2209 sha256_context hash_ctx;
2210 struct udevice *dev;
2211 ssize_t rsvmap_size;
2215 if (!is_tcg2_protocol_installed())
2218 ret = platform_get_tpm2_device(&dev);
2219 if (ret != EFI_SUCCESS)
2220 return EFI_SECURITY_VIOLATION;
2222 rsvmap_size = size_of_rsvmap(dtb);
2223 if (rsvmap_size < 0)
2224 return EFI_SECURITY_VIOLATION;
2226 event_size = sizeof(*blob) + sizeof(EFI_DTB_EVENT_STRING) + SHA256_SUM_LEN;
2227 blob = calloc(1, event_size);
2229 return EFI_OUT_OF_RESOURCES;
2231 blob->blob_description_size = sizeof(EFI_DTB_EVENT_STRING);
2232 memcpy(blob->data, EFI_DTB_EVENT_STRING, blob->blob_description_size);
2234 /* Measure populated areas of the DTB */
2236 sha256_starts(&hash_ctx);
2237 sha256_update(&hash_ctx, (u8 *)header, sizeof(struct fdt_header));
2238 sha256_update(&hash_ctx, (u8 *)dtb + fdt_off_dt_struct(dtb), fdt_size_dt_strings(dtb));
2239 sha256_update(&hash_ctx, (u8 *)dtb + fdt_off_dt_strings(dtb), fdt_size_dt_struct(dtb));
2240 sha256_update(&hash_ctx, (u8 *)dtb + fdt_off_mem_rsvmap(dtb), rsvmap_size);
2241 sha256_finish(&hash_ctx, blob->data + blob->blob_description_size);
2243 ret = tcg2_measure_event(dev, 0, EV_POST_CODE, event_size, (u8 *)blob);
2250 * efi_tcg2_measure_efi_app_invocation() - measure efi app invocation
2252 * Return: status code
2254 efi_status_t efi_tcg2_measure_efi_app_invocation(struct efi_loaded_image_obj *handle)
2258 struct udevice *dev;
2260 struct smbios_entry *entry;
2262 if (!is_tcg2_protocol_installed())
2265 if (tcg2_efi_app_invoked)
2268 ret = platform_get_tpm2_device(&dev);
2269 if (ret != EFI_SUCCESS)
2270 return EFI_SECURITY_VIOLATION;
2272 ret = tcg2_measure_boot_variable(dev);
2273 if (ret != EFI_SUCCESS)
2276 ret = tcg2_measure_event(dev, 4, EV_EFI_ACTION,
2277 strlen(EFI_CALLING_EFI_APPLICATION),
2278 (u8 *)EFI_CALLING_EFI_APPLICATION);
2279 if (ret != EFI_SUCCESS)
2282 entry = (struct smbios_entry *)find_smbios_table();
2284 ret = tcg2_measure_smbios(dev, entry);
2285 if (ret != EFI_SUCCESS)
2289 ret = tcg2_measure_gpt_data(dev, handle);
2290 if (ret != EFI_SUCCESS)
2293 for (pcr_index = 0; pcr_index <= 7; pcr_index++) {
2294 ret = tcg2_measure_event(dev, pcr_index, EV_SEPARATOR,
2295 sizeof(event), (u8 *)&event);
2296 if (ret != EFI_SUCCESS)
2300 tcg2_efi_app_invoked = true;
2306 * efi_tcg2_measure_efi_app_exit() - measure efi app exit
2308 * Return: status code
2310 efi_status_t efi_tcg2_measure_efi_app_exit(void)
2313 struct udevice *dev;
2315 if (!is_tcg2_protocol_installed())
2318 ret = platform_get_tpm2_device(&dev);
2319 if (ret != EFI_SUCCESS)
2322 ret = tcg2_measure_event(dev, 4, EV_EFI_ACTION,
2323 strlen(EFI_RETURNING_FROM_EFI_APPLICATION),
2324 (u8 *)EFI_RETURNING_FROM_EFI_APPLICATION);
2329 * efi_tcg2_notify_exit_boot_services() - ExitBootService callback
2331 * @event: callback event
2332 * @context: callback context
2335 efi_tcg2_notify_exit_boot_services(struct efi_event *event, void *context)
2338 struct udevice *dev;
2340 EFI_ENTRY("%p, %p", event, context);
2342 event_log.ebs_called = true;
2344 if (!is_tcg2_protocol_installed()) {
2349 ret = platform_get_tpm2_device(&dev);
2350 if (ret != EFI_SUCCESS)
2353 ret = tcg2_measure_event(dev, 5, EV_EFI_ACTION,
2354 strlen(EFI_EXIT_BOOT_SERVICES_INVOCATION),
2355 (u8 *)EFI_EXIT_BOOT_SERVICES_INVOCATION);
2356 if (ret != EFI_SUCCESS)
2359 ret = tcg2_measure_event(dev, 5, EV_EFI_ACTION,
2360 strlen(EFI_EXIT_BOOT_SERVICES_SUCCEEDED),
2361 (u8 *)EFI_EXIT_BOOT_SERVICES_SUCCEEDED);
2368 * efi_tcg2_notify_exit_boot_services_failed()
2369 * - notify ExitBootServices() is failed
2371 * Return: status code
2373 efi_status_t efi_tcg2_notify_exit_boot_services_failed(void)
2375 struct udevice *dev;
2378 if (!is_tcg2_protocol_installed())
2381 ret = platform_get_tpm2_device(&dev);
2382 if (ret != EFI_SUCCESS)
2385 ret = tcg2_measure_event(dev, 5, EV_EFI_ACTION,
2386 strlen(EFI_EXIT_BOOT_SERVICES_INVOCATION),
2387 (u8 *)EFI_EXIT_BOOT_SERVICES_INVOCATION);
2388 if (ret != EFI_SUCCESS)
2391 ret = tcg2_measure_event(dev, 5, EV_EFI_ACTION,
2392 strlen(EFI_EXIT_BOOT_SERVICES_FAILED),
2393 (u8 *)EFI_EXIT_BOOT_SERVICES_FAILED);
2400 * tcg2_measure_secure_boot_variable() - measure secure boot variables
2404 * Return: status code
2406 static efi_status_t tcg2_measure_secure_boot_variable(struct udevice *dev)
2409 efi_uintn_t data_size;
2414 u32 deployed_audit_pcr_index = 1;
2416 size = sizeof(deployed_mode);
2417 ret = efi_get_variable_int(u"DeployedMode", &efi_global_variable_guid,
2418 NULL, &size, &deployed_mode, NULL);
2419 if (ret != EFI_SUCCESS || !deployed_mode)
2420 deployed_audit_pcr_index = 7;
2422 count = ARRAY_SIZE(secure_variables);
2423 for (i = 0; i < count; i++) {
2424 const efi_guid_t *guid;
2426 guid = efi_auth_var_get_guid(secure_variables[i].name);
2428 data = efi_get_var(secure_variables[i].name, guid, &data_size);
2429 if (!data && !secure_variables[i].accept_empty)
2432 if (u16_strcmp(u"DeployedMode", secure_variables[i].name))
2433 secure_variables[i].pcr_index = deployed_audit_pcr_index;
2434 if (u16_strcmp(u"AuditMode", secure_variables[i].name))
2435 secure_variables[i].pcr_index = deployed_audit_pcr_index;
2437 ret = tcg2_measure_variable(dev, secure_variables[i].pcr_index,
2438 EV_EFI_VARIABLE_DRIVER_CONFIG,
2439 secure_variables[i].name, guid,
2442 if (ret != EFI_SUCCESS)
2451 * efi_tcg2_do_initial_measurement() - do initial measurement
2453 * Return: status code
2455 efi_status_t efi_tcg2_do_initial_measurement(void)
2458 struct udevice *dev;
2460 if (!is_tcg2_protocol_installed())
2463 ret = platform_get_tpm2_device(&dev);
2464 if (ret != EFI_SUCCESS)
2465 return EFI_SECURITY_VIOLATION;
2467 ret = tcg2_measure_secure_boot_variable(dev);
2468 if (ret != EFI_SUCCESS)
2476 * efi_tcg2_register() - register EFI_TCG2_PROTOCOL
2478 * If a TPM2 device is available, the TPM TCG2 Protocol is registered
2480 * Return: status code
2482 efi_status_t efi_tcg2_register(void)
2484 efi_status_t ret = EFI_SUCCESS;
2485 struct udevice *dev;
2486 struct efi_event *event;
2489 ret = platform_get_tpm2_device(&dev);
2490 if (ret != EFI_SUCCESS) {
2491 log_warning("Missing TPMv2 device for EFI_TCG_PROTOCOL\n");
2495 /* initialize the TPM as early as possible. */
2496 err = tpm_auto_start(dev);
2498 log_err("TPM startup failed\n");
2502 ret = efi_init_event_log();
2503 if (ret != EFI_SUCCESS) {
2508 ret = efi_install_multiple_protocol_interfaces(&efi_root, &efi_guid_tcg2_protocol,
2509 &efi_tcg2_protocol, NULL);
2510 if (ret != EFI_SUCCESS) {
2515 ret = efi_create_event(EVT_SIGNAL_EXIT_BOOT_SERVICES, TPL_CALLBACK,
2516 efi_tcg2_notify_exit_boot_services, NULL,
2518 if (ret != EFI_SUCCESS) {
2526 log_err("Cannot install EFI_TCG2_PROTOCOL\n");