1 /* 2 * Copyright (c) 2020-2022, Arm Limited. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef EVENT_LOG_H 8 #define EVENT_LOG_H 9 10 #include <stdint.h> 11 12 #include <common/debug.h> 13 #include <common/tbbr/tbbr_img_def.h> 14 #include <drivers/auth/crypto_mod.h> 15 #include <drivers/measured_boot/event_log/tcg.h> 16 17 /* 18 * Set Event Log debug level to one of: 19 * 20 * LOG_LEVEL_ERROR 21 * LOG_LEVEL_INFO 22 * LOG_LEVEL_WARNING 23 * LOG_LEVEL_VERBOSE 24 */ 25 #if EVENT_LOG_LEVEL == LOG_LEVEL_ERROR 26 #define LOG_EVENT ERROR 27 #elif EVENT_LOG_LEVEL == LOG_LEVEL_NOTICE 28 #define LOG_EVENT NOTICE 29 #elif EVENT_LOG_LEVEL == LOG_LEVEL_WARNING 30 #define LOG_EVENT WARN 31 #elif EVENT_LOG_LEVEL == LOG_LEVEL_INFO 32 #define LOG_EVENT INFO 33 #elif EVENT_LOG_LEVEL == LOG_LEVEL_VERBOSE 34 #define LOG_EVENT VERBOSE 35 #else 36 #error "Not supported EVENT_LOG_LEVEL" 37 #endif 38 39 /* Number of hashing algorithms supported */ 40 #define HASH_ALG_COUNT 1U 41 42 #define EVLOG_INVALID_ID UINT32_MAX 43 44 #define MEMBER_SIZE(type, member) sizeof(((type *)0)->member) 45 46 /* 47 * Each event log entry has some metadata (i.e. a string) that identifies 48 * what is measured.These macros define these strings. 49 * Note that these strings follow the standardization recommendations 50 * defined in the Arm Server Base Security Guide (a.k.a. SBSG, Arm DEN 0086), 51 * where applicable. They should not be changed in the code. 52 * Where the SBSG does not make recommendations, we are free to choose any 53 * naming convention. 54 * The key thing is to choose meaningful strings so that when the TPM event 55 * log is used in attestation, the different components can be identified. 56 */ 57 #define EVLOG_BL2_STRING "BL_2" 58 #define EVLOG_BL31_STRING "SECURE_RT_EL3" 59 #if defined(SPD_opteed) 60 #define EVLOG_BL32_STRING "SECURE_RT_EL1_OPTEE" 61 #elif defined(SPD_tspd) 62 #define EVLOG_BL32_STRING "SECURE_RT_EL1_TSPD" 63 #elif defined(SPD_tlkd) 64 #define EVLOG_BL32_STRING "SECURE_RT_EL1_TLKD" 65 #elif defined(SPD_trusty) 66 #define EVLOG_BL32_STRING "SECURE_RT_EL1_TRUSTY" 67 #else 68 #define EVLOG_BL32_STRING "SECURE_RT_EL1_UNKNOWN" 69 #endif 70 #define EVLOG_BL32_EXTRA1_STRING "SECURE_RT_EL1_OPTEE_EXTRA1" 71 #define EVLOG_BL32_EXTRA2_STRING "SECURE_RT_EL1_OPTEE_EXTRA2" 72 #define EVLOG_BL33_STRING "BL_33" 73 #define EVLOG_FW_CONFIG_STRING "FW_CONFIG" 74 #define EVLOG_HW_CONFIG_STRING "HW_CONFIG" 75 #define EVLOG_NT_FW_CONFIG_STRING "NT_FW_CONFIG" 76 #define EVLOG_SCP_BL2_STRING "SYS_CTRL_2" 77 #define EVLOG_SOC_FW_CONFIG_STRING "SOC_FW_CONFIG" 78 #define EVLOG_STM32_STRING "STM32" 79 #define EVLOG_TB_FW_CONFIG_STRING "TB_FW_CONFIG" 80 #define EVLOG_TOS_FW_CONFIG_STRING "TOS_FW_CONFIG" 81 #define EVLOG_RMM_STRING "RMM" 82 #define EVLOG_SP1_STRING "SP1" 83 #define EVLOG_SP2_STRING "SP2" 84 #define EVLOG_SP3_STRING "SP3" 85 #define EVLOG_SP4_STRING "SP4" 86 #define EVLOG_SP5_STRING "SP5" 87 #define EVLOG_SP6_STRING "SP6" 88 #define EVLOG_SP7_STRING "SP7" 89 #define EVLOG_SP8_STRING "SP8" 90 91 typedef struct { 92 unsigned int id; 93 const char *name; 94 unsigned int pcr; 95 } event_log_metadata_t; 96 97 #define ID_EVENT_SIZE (sizeof(id_event_headers_t) + \ 98 (sizeof(id_event_algorithm_size_t) * HASH_ALG_COUNT) + \ 99 sizeof(id_event_struct_data_t)) 100 101 #define LOC_EVENT_SIZE (sizeof(event2_header_t) + \ 102 sizeof(tpmt_ha) + TCG_DIGEST_SIZE + \ 103 sizeof(event2_data_t) + \ 104 sizeof(startup_locality_event_t)) 105 106 #define LOG_MIN_SIZE (ID_EVENT_SIZE + LOC_EVENT_SIZE) 107 108 #define EVENT2_HDR_SIZE (sizeof(event2_header_t) + \ 109 sizeof(tpmt_ha) + TCG_DIGEST_SIZE + \ 110 sizeof(event2_data_t)) 111 112 /* Functions' declarations */ 113 void event_log_buf_init(uint8_t *event_log_start, uint8_t *event_log_finish); 114 void event_log_init(uint8_t *event_log_start, uint8_t *event_log_finish); 115 void event_log_write_specid_event(void); 116 void event_log_write_header(void); 117 void dump_event_log(uint8_t *log_addr, size_t log_size); 118 const event_log_metadata_t *plat_event_log_get_metadata(void); 119 int event_log_measure(uintptr_t data_base, uint32_t data_size, 120 unsigned char hash_data[CRYPTO_MD_MAX_SIZE]); 121 void event_log_record(const uint8_t *hash, uint32_t event_type, 122 const event_log_metadata_t *metadata_ptr); 123 int event_log_measure_and_record(uintptr_t data_base, uint32_t data_size, 124 uint32_t data_id); 125 size_t event_log_get_cur_size(uint8_t *event_log_start); 126 127 #endif /* EVENT_LOG_H */ 128