common: Add more TCG classes for event log parsing (#7)

Add class 'TcgEventType', 'TcgImrEventLogEntry', 'TcgEfiSpecIdEvent'
and 'TcgEfiSpecIdEventAlgorithmSize' for event log parsing

Signed-off-by: Ruoyu Ying <[email protected]>

common/python/cctrusted_base/tcg.py

@@ -74,3 +74,273 @@ def hash(self) -> list:
         Return the hash of digest
         """
         return self._hash
+
+class TcgEventType:
+    """
+    TCG EventType defined at
+    https://trustedcomputinggroup.org/wp-content/uploads/TCG_EFI_Platform_1_22_Final_-v15.pdf
+    """
+
+    EV_PREBOOT_CERT = 0x0
+    EV_POST_CODE = 0x1
+    EV_UNUSED = 0x2
+    EV_NO_ACTION = 0x3
+    EV_SEPARATOR = 0x4
+    EV_ACTION = 0x5
+    EV_EVENT_TAG = 0x6
+    EV_S_CRTM_CONTENTS = 0x7
+    EV_S_CRTM_VERSION = 0x8
+    EV_CPU_MICROCODE = 0x9
+    EV_PLATFORM_CONFIG_FLAGS = 0xa
+    EV_TABLE_OF_DEVICES = 0xb
+    EV_COMPACT_HASH = 0xc
+    EV_IPL = 0xd
+    EV_IPL_PARTITION_DATA = 0xe
+    EV_NONHOST_CODE = 0xf
+    EV_NONHOST_CONFIG = 0x10
+    EV_NONHOST_INFO = 0x11
+    EV_OMIT_BOOT_DEVICE_EVENTS = 0x12
+
+    EV_EFI_EVENT_BASE = 0x80000000
+    EV_EFI_VARIABLE_DRIVER_CONFIG = EV_EFI_EVENT_BASE + 0x1
+    EV_EFI_VARIABLE_BOOT = EV_EFI_EVENT_BASE + 0x2
+    EV_EFI_BOOT_SERVICES_APPLICATION = EV_EFI_EVENT_BASE + 0x3
+    EV_EFI_BOOT_SERVICES_DRIVER = EV_EFI_EVENT_BASE + 0x4
+    EV_EFI_RUNTIME_SERVICES_DRIVER = EV_EFI_EVENT_BASE + 0x5
+    EV_EFI_GPT_EVENT = EV_EFI_EVENT_BASE + 0x6
+    EV_EFI_ACTION = EV_EFI_EVENT_BASE + 0x7
+    EV_EFI_PLATFORM_FIRMWARE_BLOB = EV_EFI_EVENT_BASE + 0x8
+    EV_EFI_HANDOFF_TABLES = EV_EFI_EVENT_BASE + 0x9
+    EV_EFI_VARIABLE_AUTHORITY = EV_EFI_EVENT_BASE + 0x10
+
+    TCG_EVENT_TYPE_TABLE = {
+        EV_PREBOOT_CERT: "EV_PREBOOT_CERT",
+        EV_POST_CODE: "EV_POST_CODE",
+        EV_UNUSED: "EV_UNUSED",
+        EV_NO_ACTION: "EV_NO_ACTION",
+        EV_SEPARATOR: "EV_SEPARATOR",
+        EV_ACTION: "EV_ACTION",
+        EV_EVENT_TAG: "EV_EVENT_TAG",
+        EV_S_CRTM_CONTENTS: "EV_S_CRTM_CONTENTS",
+        EV_S_CRTM_VERSION: "EV_S_CRTM_VERSION",
+        EV_CPU_MICROCODE: "EV_CPU_MICROCODE",
+        EV_PLATFORM_CONFIG_FLAGS: "EV_PLATFORM_CONFIG_FLAGS",
+        EV_TABLE_OF_DEVICES: "EV_TABLE_OF_DEVICES",
+        EV_COMPACT_HASH: "EV_COMPACT_HASH",
+        EV_IPL: "EV_IPL",
+        EV_IPL_PARTITION_DATA: "EV_IPL_PARTITION_DATA",
+        EV_NONHOST_CODE: "EV_NONHOST_CODE",
+        EV_NONHOST_CONFIG: "EV_NONHOST_CONFIG",
+        EV_NONHOST_INFO: "EV_NONHOST_INFO",
+        EV_OMIT_BOOT_DEVICE_EVENTS: "EV_OMIT_BOOT_DEVICE_EVENTS",
+        EV_EFI_EVENT_BASE: "EV_EFI_EVENT_BASE",
+        EV_EFI_VARIABLE_DRIVER_CONFIG: "EV_EFI_VARIABLE_DRIVER_CONFIG",
+        EV_EFI_VARIABLE_BOOT: "EV_EFI_VARIABLE_BOOT",
+        EV_EFI_BOOT_SERVICES_APPLICATION: "EV_EFI_BOOT_SERVICES_APPLICATION",
+        EV_EFI_BOOT_SERVICES_DRIVER: "EV_EFI_BOOT_SERVICES_DRIVER",
+        EV_EFI_RUNTIME_SERVICES_DRIVER: "EV_EFI_RUNTIME_SERVICES_DRIVER",
+        EV_EFI_GPT_EVENT: "EV_EFI_GPT_EVENT",
+        EV_EFI_ACTION: "EV_EFI_ACTION",
+        EV_EFI_PLATFORM_FIRMWARE_BLOB: "EV_EFI_PLATFORM_FIRMWARE_BLOB",
+        EV_EFI_HANDOFF_TABLES: "EV_EFI_HANDOFF_TABLES",
+        EV_EFI_VARIABLE_AUTHORITY: "EV_EFI_VARIABLE_AUTHORITY"
+    }
+
+    def __init__(self, event_type:int) -> None:
+        assert event_type in TcgEventType.TCG_EVENT_TYPE_TABLE, \
+            "invalid parameter event_type"
+        self._event_type = event_type
+
+    @staticmethod
+    def get_event_type_string(event_type:int) -> str:
+        """
+        Get event type string
+        """
+        if event_type in TcgEventType.TCG_EVENT_TYPE_TABLE:
+            return TcgEventType.TCG_EVENT_TYPE_TABLE[event_type]
+        return "UNKNOWN"
+
+    @property
+    def event_type(self) -> int:
+        """
+        Get event type
+        """
+        return self._event_type
+
+    def __str__(self) -> str:
+        """
+        Event type string
+        """
+        return self.get_event_type_string(self._event_type)
+
+class TcgImrEventLogEntry:
+    """
+    TCG IMR Event struct defined at
+    https://trustedcomputinggroup.org/wp-content/uploads/TCG_EFI_Platform_1_22_Final_-v15.pdf
+
+    typedef struct {
+        TCG_PCRINDEX PCRIndex; //PCRIndex event extended to
+        TCG_EVENTTYPE EventType;//See Table 7-1, below
+        TCG_DIGEST Digest; //Value extended into PCRIndex
+        UINT32 EventSize;//Size of the event data
+        UINT8 Event[1]; //The event data
+        } TCG_PCR_EVENT; //Structure to be added to the
+                         //Event Log
+
+    """
+
+    def __init__(self) -> None:
+        self._imr_index:int = None
+        self._event_type:TcgEventType = None
+        self._digest:TcgDigest = None
+        self._event_size:int = None
+        self._event:int = None
+
+    @property
+    def imr_index(self) -> int:
+        """
+        Get IMR index
+        """
+        return self._imr_index
+
+    @property
+    def event_type(self) -> TcgEventType:
+        """
+        Get event type
+        """
+        return self._event_type
+
+    @property
+    def digest(self) -> TcgDigest:
+        """
+        Get event digest
+        """
+        return self._digest
+
+    @property
+    def event_size(self) -> int:
+        """
+        Get event size
+        """
+        return self._event_size
+
+    @property
+    def event(self) -> int:
+        """
+        Get event start address
+        """
+        return self._event
+
+class TcgEfiSpecIdEvent:
+    """
+    TCG TCG_EfiSpecIDEventStruct defined at
+    https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf
+
+    typedef struct tdTCG_EfiSpecIdEventStruct {
+        BYTE[16] signature;
+        UINT32 platformClass;
+        UINT8 specVersionMinor;
+        UINT8 specVersionMajor;
+        UINT8 specErrata;
+        UINT8 uintnSize;
+        UINT32 numberOfAlgorithms;
+        TCG_EfiSpecIdEventAlgorithmSize[numberOfAlgorithms] digestSizes;
+        UINT8 vendorInfoSize;
+        BYTE[VendorInfoSize] vendorInfo;
+    } TCG_EfiSpecIDEventStruct;
+    """
+
+    def __init__(self) -> None:
+        self._signature:list[bytes] = None
+        self._platform_class:int = None
+        self._spec_version_minor:int = None
+        self._sepc_version_major:int = None
+        self._spec_errata:int = None
+        self._uintn_size:int = None
+        self._number_of_algos:int = None
+        self._digest_sizes:list[TcgEfiSpecIdEventAlgorithmSize] = None
+
+    @property
+    def signature(self) -> list[bytes]:
+        """
+        Get signature
+        """
+        return self._signature
+
+    @property
+    def platform_class(self) -> int:
+        """
+        Get platform class
+        """
+        return self._platform_class
+
+    @property
+    def spec_version_minor(self) -> int:
+        """
+        Get spec minor version
+        """
+        return self._spec_version_minor
+
+    @property
+    def sepc_version_major(self) -> int:
+        """
+        Get spec major version
+        """
+        return self._sepc_version_major
+
+    @property
+    def spec_errata(self) -> int:
+        """
+        Get spec errata
+        """
+        return self._spec_errata
+
+    @property
+    def uintn_size(self) -> int:
+        """
+        Get uintn size
+        """
+        return self._uintn_size
+
+    @property
+    def number_of_algos(self) -> int:
+        """
+        Get number of algorithms
+        """
+        return self._number_of_algos
+
+    @property
+    def digest_sizes(self):
+        """
+        Get digest size
+        """
+        return self._digest_sizes
+
+class TcgEfiSpecIdEventAlgorithmSize:
+    """
+    TCG TCG_EfiSpecIdEventAlgorithmSize defined at
+    https://trustedcomputinggroup.org/wp-content/uploads/EFI-Protocol-Specification-rev13-160330final.pdf
+
+    typedef struct tdTCG_EfiSpecIdEventAlgorithmSize {
+        UINT16 algorithmId;
+        UINT16 digestSize;
+    } TCG_EfiSpecIdEventAlgorithmSize;
+    """
+
+    def __init__(self) -> None:
+        self._algo_id:int = None
+        self._digest_size:int = None
+
+    @property
+    def algo_id(self):
+        """
+        Get algorithm id
+        """
+        return self._algo_id
+
+    @property
+    def digest_size(self):
+        """
+        Get digest_size
+        """
+        return self._digest_size