efi_tcg2.h 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Defines data structures and APIs that allow an OS to interact with UEFI
  4. * firmware to query information about the device
  5. *
  6. * This file refers the following TCG specification.
  7. * - TCG PC Client Platform Firmware Profile Specification
  8. * https://trustedcomputinggroup.org/resource/pc-client-specific-platform-firmware-profile-specification/
  9. *
  10. * - TCG EFI Protocol Specification
  11. * https://trustedcomputinggroup.org/resource/tcg-efi-protocol-specification/
  12. *
  13. * Copyright (c) 2020, Linaro Limited
  14. */
  15. #if !defined _EFI_TCG2_PROTOCOL_H_
  16. #define _EFI_TCG2_PROTOCOL_H_
  17. #include <efi_api.h>
  18. #include <tpm-v2.h>
  19. #define EFI_TCG2_PROTOCOL_GUID \
  20. EFI_GUID(0x607f766c, 0x7455, 0x42be, 0x93, \
  21. 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
  22. /* TPMV2 only */
  23. #define TCG2_EVENT_LOG_FORMAT_TCG_2 0x00000002
  24. #define EFI_TCG2_EXTEND_ONLY 0x0000000000000001
  25. #define PE_COFF_IMAGE 0x0000000000000010
  26. #define EFI_TCG2_MAX_PCR_INDEX 23
  27. /* Algorithm Registry */
  28. #define EFI_TCG2_BOOT_HASH_ALG_SHA1 0x00000001
  29. #define EFI_TCG2_BOOT_HASH_ALG_SHA256 0x00000002
  30. #define EFI_TCG2_BOOT_HASH_ALG_SHA384 0x00000004
  31. #define EFI_TCG2_BOOT_HASH_ALG_SHA512 0x00000008
  32. #define EFI_TCG2_BOOT_HASH_ALG_SM3_256 0x00000010
  33. #define EFI_TCG2_FINAL_EVENTS_TABLE_VERSION 1
  34. #define TPM2_EVENT_LOG_SIZE CONFIG_EFI_TCG2_PROTOCOL_EVENTLOG_SIZE
  35. typedef u32 efi_tcg_event_log_bitmap;
  36. typedef u32 efi_tcg_event_log_format;
  37. typedef u32 efi_tcg_event_algorithm_bitmap;
  38. /**
  39. * struct tdEFI_TCG2_VERSION - structure of EFI TCG2 version
  40. * @major: major version
  41. * @minor: minor version
  42. */
  43. struct efi_tcg2_version {
  44. u8 major;
  45. u8 minor;
  46. };
  47. /**
  48. * struct tdEFI_TCG2_EVENT_HEADER - structure of EFI TCG2 event header
  49. * @header_size: size of the event header
  50. * @header_version: header version
  51. * @pcr_index: index of the PCR that is extended
  52. * @event_type: type of the event that is extended
  53. */
  54. struct efi_tcg2_event_header {
  55. u32 header_size;
  56. u16 header_version;
  57. u32 pcr_index;
  58. u32 event_type;
  59. } __packed;
  60. /**
  61. * struct tdEFI_TCG2_EVENT - structure of EFI TCG2 event
  62. * @size: total size of the event including the size component, the header
  63. * and the event data
  64. * @header: event header
  65. * @event: event to add
  66. */
  67. struct efi_tcg2_event {
  68. u32 size;
  69. struct efi_tcg2_event_header header;
  70. u8 event[];
  71. } __packed;
  72. /**
  73. * struct tdUEFI_IMAGE_LOAD_EVENT - structure of PE/COFF image measurement
  74. * @image_location_in_memory: image address
  75. * @image_length_in_memory: image size
  76. * @image_link_time_address: image link time address
  77. * @length_of_device_path: devive path size
  78. * @device_path: device path
  79. */
  80. struct uefi_image_load_event {
  81. efi_physical_addr_t image_location_in_memory;
  82. u64 image_length_in_memory;
  83. u64 image_link_time_address;
  84. u64 length_of_device_path;
  85. struct efi_device_path device_path[];
  86. };
  87. /**
  88. * struct tdEFI_TCG2_BOOT_SERVICE_CAPABILITY - protocol capability information
  89. * @size: allocated size of the structure
  90. * @structure_version: version of this structure
  91. * @protocol_version: version of the EFI TCG2 protocol.
  92. * @hash_algorithm_bitmap: supported hash algorithms
  93. * @supported_event_logs: bitmap of supported event log formats
  94. * @tpm_present_flag: false = TPM not present
  95. * @max_command_size: max size (in bytes) of a command
  96. * that can be sent to the TPM
  97. * @max_response_size: max size (in bytes) of a response that
  98. * can be provided by the TPM
  99. * @manufacturer_id: 4-byte Vendor ID
  100. * @number_of_pcr_banks: maximum number of PCR banks
  101. * @active_pcr_banks: bitmap of currently active
  102. * PCR banks (hashing algorithms).
  103. */
  104. struct efi_tcg2_boot_service_capability {
  105. u8 size;
  106. struct efi_tcg2_version structure_version;
  107. struct efi_tcg2_version protocol_version;
  108. efi_tcg_event_algorithm_bitmap hash_algorithm_bitmap;
  109. efi_tcg_event_log_bitmap supported_event_logs;
  110. u8 tpm_present_flag;
  111. u16 max_command_size;
  112. u16 max_response_size;
  113. u32 manufacturer_id;
  114. u32 number_of_pcr_banks;
  115. efi_tcg_event_algorithm_bitmap active_pcr_banks;
  116. };
  117. /* up to and including the vendor ID (manufacturer_id) field */
  118. #define BOOT_SERVICE_CAPABILITY_MIN \
  119. offsetof(struct efi_tcg2_boot_service_capability, number_of_pcr_banks)
  120. #define TCG_EFI_SPEC_ID_EVENT_SIGNATURE_03 "Spec ID Event03"
  121. #define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MAJOR_TPM2 2
  122. #define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MINOR_TPM2 0
  123. #define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_ERRATA_TPM2 2
  124. /**
  125. * struct TCG_EfiSpecIdEventAlgorithmSize - hashing algorithm information
  126. *
  127. * @algorithm_id: algorithm defined in enum tpm2_algorithms
  128. * @digest_size: size of the algorithm
  129. */
  130. struct tcg_efi_spec_id_event_algorithm_size {
  131. u16 algorithm_id;
  132. u16 digest_size;
  133. } __packed;
  134. /**
  135. * struct TCG_EfiSpecIDEventStruct - content of the event log header
  136. *
  137. * @signature: signature, set to Spec ID Event03
  138. * @platform_class: class defined in TCG ACPI Specification
  139. * Client Common Header.
  140. * @spec_version_minor: minor version
  141. * @spec_version_major: major version
  142. * @spec_version_errata: major version
  143. * @uintn_size: size of the efi_uintn_t fields used in various
  144. * data structures used in this specification.
  145. * 0x01 indicates u32 and 0x02 indicates u64
  146. * @number_of_algorithms: hashing algorithms used in this event log
  147. * @digest_sizes: array of number_of_algorithms pairs
  148. * 1st member defines the algorithm id
  149. * 2nd member defines the algorithm size
  150. */
  151. struct tcg_efi_spec_id_event {
  152. u8 signature[16];
  153. u32 platform_class;
  154. u8 spec_version_minor;
  155. u8 spec_version_major;
  156. u8 spec_errata;
  157. u8 uintn_size;
  158. u32 number_of_algorithms;
  159. struct tcg_efi_spec_id_event_algorithm_size digest_sizes[];
  160. } __packed;
  161. /**
  162. * struct tdEFI_TCG2_FINAL_EVENTS_TABLE - log entries after Get Event Log
  163. * @version: version number for this structure
  164. * @number_of_events: number of events recorded after invocation of
  165. * GetEventLog()
  166. * @event: List of events of type tcg_pcr_event2
  167. */
  168. struct efi_tcg2_final_events_table {
  169. u64 version;
  170. u64 number_of_events;
  171. struct tcg_pcr_event2 event[];
  172. };
  173. /**
  174. * struct tdUEFI_VARIABLE_DATA - event log structure of UEFI variable
  175. * @variable_name: The vendorGUID parameter in the
  176. * GetVariable() API.
  177. * @unicode_name_length: The length in CHAR16 of the Unicode name of
  178. * the variable.
  179. * @variable_data_length: The size of the variable data.
  180. * @unicode_name: The CHAR16 unicode name of the variable
  181. * without NULL-terminator.
  182. * @variable_data: The data parameter of the efi variable
  183. * in the GetVariable() API.
  184. */
  185. struct efi_tcg2_uefi_variable_data {
  186. efi_guid_t variable_name;
  187. u64 unicode_name_length;
  188. u64 variable_data_length;
  189. u16 unicode_name[1];
  190. u8 variable_data[1];
  191. };
  192. struct efi_tcg2_protocol {
  193. efi_status_t (EFIAPI * get_capability)(struct efi_tcg2_protocol *this,
  194. struct efi_tcg2_boot_service_capability *capability);
  195. efi_status_t (EFIAPI * get_eventlog)(struct efi_tcg2_protocol *this,
  196. efi_tcg_event_log_format log_format,
  197. u64 *event_log_location, u64 *event_log_last_entry,
  198. bool *event_log_truncated);
  199. efi_status_t (EFIAPI * hash_log_extend_event)(struct efi_tcg2_protocol *this,
  200. u64 flags,
  201. efi_physical_addr_t data_to_hash,
  202. u64 data_to_hash_len,
  203. struct efi_tcg2_event *efi_tcg_event);
  204. efi_status_t (EFIAPI * submit_command)(struct efi_tcg2_protocol *this,
  205. u32 input_parameter_block_size,
  206. u8 *input_parameter_block,
  207. u32 output_parameter_block_size,
  208. u8 *output_parameter_block);
  209. efi_status_t (EFIAPI * get_active_pcr_banks)(struct efi_tcg2_protocol *this,
  210. u32 *active_pcr_banks);
  211. efi_status_t (EFIAPI * set_active_pcr_banks)(struct efi_tcg2_protocol *this,
  212. u32 active_pcr_banks);
  213. efi_status_t (EFIAPI * get_result_of_set_active_pcr_banks)(struct efi_tcg2_protocol *this,
  214. u32 *operation_present,
  215. u32 *response);
  216. };
  217. #endif