Add uefi_log_handler.rs to parse UEFI binary

Resolves: #1020

Signed-off-by: Sergio Arroutbi <[email protected]>

Author: sarroutbi

Cargo.lock

@@ -20,6 +20,7 @@ actix-web =  { version = "4", default-features = false, features = ["macros", "o
 anyhow = { version = "1.0", features = ["backtrace"] }
 assert_cmd = { version = "2.0.16" }
 base64 = "0.22"
+byteorder = "1.5.0"
 cfg-if = "1"
 chrono = { version = "0.4.40", features = ["serde"] }
 clap = { version = "4.5", features = ["derive"] }

Cargo.toml

@@ -5,6 +5,7 @@ use keylime::config::{KeylimeConfig, PushModelConfigTrait};
 use keylime::context_info::ContextInfo;
 use keylime::ima::ImaLog;
 use keylime::structures;
+use keylime::uefi::uefi_log_handler;
 use log::error;
 
 pub trait StructureFiller {
@@ -47,11 +48,32 @@ impl StructureFiller for FillerFromHardware<'_> {
 
 pub struct FillerFromHardware<'a> {
     pub tpm_context_info: &'a mut ContextInfo,
+    pub uefi_log_handler: Option<uefi_log_handler::UefiLogHandler>,
 }
 
 impl<'a> FillerFromHardware<'a> {
     pub fn new(tpm_context_info: &'a mut ContextInfo) -> Self {
-        FillerFromHardware { tpm_context_info }
+        // TODO: Change config obtaining here to avoid repetitions
+        let global_config = KeylimeConfig::new();
+        let ml_path = match global_config {
+            Ok(config) => config.agent.measuredboot_ml_path.clone(),
+            Err(_) => "".to_string(),
+        };
+        let uefi_log_handler =
+            uefi_log_handler::UefiLogHandler::new(&ml_path);
+        match uefi_log_handler {
+            Ok(handler) => FillerFromHardware {
+                tpm_context_info,
+                uefi_log_handler: Some(handler),
+            },
+            Err(e) => {
+                error!("Failed to create UEFI log handler: {}", e);
+                FillerFromHardware {
+                    tpm_context_info,
+                    uefi_log_handler: None,
+                }
+            }
+        }
     }
     // TODO: Change this function to use the attestation request appropriately
     // Add self to the function signature to use the tpm_context
@@ -81,6 +103,10 @@ impl<'a> FillerFromHardware<'a> {
                 0
             }
         };
+        let uefi_count = self
+            .uefi_log_handler
+            .as_ref()
+            .map_or(0, |handler| handler.get_entry_count());
         structures::AttestationRequest {
             data: structures::RequestData {
                 type_: "attestation".to_string(),
@@ -111,7 +137,7 @@ impl<'a> FillerFromHardware<'a> {
                             evidence_type: "uefi_log".to_string(),
                             capabilities: structures::LogCapabilities {
                                 evidence_version: Some(config.get_uefi_logs_evidence_version()),
-                                entry_count: 0, // Placeholder, as we don't have a count here
+                                entry_count: uefi_count,
                                 supports_partial_access: config.get_uefi_logs_supports_partial_access(),
                                 appendable: config.get_uefi_logs_appendable(),
                                 formats: config.get_uefi_logs_formats(),

keylime-push-model-agent/src/struct_filler.rs

@@ -11,6 +11,7 @@ version.workspace = true
 actix-web.workspace = true
 anyhow.workspace = true
 base64.workspace = true
+byteorder.workspace = true
 chrono.workspace = true
 config.workspace = true
 glob.workspace = true

keylime/Cargo.toml

@@ -134,6 +134,7 @@ mod tests {
     fn test_cert_no_server_cert() {
         // Ensure the test cert file does not exist before the test
         const TEST_KEY_PATH: &str = "test_key.pem";
+        let _ = std::fs::remove_file(TEST_KEY_PATH);
         let config = CertificateConfig {
             agent_uuid: "test-uuid".to_string(),
             contact_ip: "1.2.3.4".to_string(),

keylime/src/cert.rs

@@ -22,19 +22,23 @@ pub const DEFAULT_UEFI_LOGS_APPENDABLE: bool = true;
 pub const DEFAULT_UEFI_LOGS_EVIDENCE_VERSION: &str = "2.1";
 pub const DEFAULT_UEFI_LOGS_FORMATS: &[&str] = &["application/octet-stream"];
 pub const DEFAULT_UEFI_LOGS_SUPPORTS_PARTIAL_ACCESS: bool = true;
-pub const DEFAULT_MEASUREDBOOT_ML_DIRECTORY_PATH: &str =
-    "/sys/kernel/security/tpm0";
-pub static DEFAULT_MEASUREDBOOT_ML_COUNT_FILE: Lazy<String> =
-    Lazy::new(|| format!("{}/count", DEFAULT_MEASUREDBOOT_ML_DIRECTORY_PATH));
+
+pub const DEFAULT_UEFI_LOGS_BINARY_PATH: &str = "/sys/kernel/security/tpm0";
+pub const DEFAULT_UEFI_LOGS_BINARY_FILE: &str = "binary_bios_measurements";
+pub static DEFAULT_UEFI_LOGS_BINARY_FILE_PATH: Lazy<String> =
+    Lazy::new(|| {
+        format!(
+            "{}/{}",
+            DEFAULT_UEFI_LOGS_BINARY_PATH, DEFAULT_UEFI_LOGS_BINARY_FILE
+        )
+    });
 
 pub trait PushModelConfigTrait {
     fn get_certification_keys_server_identifier(&self) -> String;
     fn get_contact_ip(&self) -> String;
     fn get_contact_port(&self) -> u32;
     fn get_enable_iak_idevid(&self) -> bool;
     fn get_ek_handle(&self) -> String;
-    fn get_measuredboot_ml_directory_path(&self) -> String;
-    fn get_measuredboot_ml_count_file(&self) -> String;
     fn get_ima_logs_appendable(&self) -> bool;
     fn get_ima_logs_formats(&self) -> Vec<String>;
     fn get_ima_logs_supports_partial_access(&self) -> bool;
@@ -51,6 +55,7 @@ pub trait PushModelConfigTrait {
     fn get_registrar_api_versions(&self) -> Vec<String>;
     fn get_api_versions(&self) -> Vec<String>;
     fn get_uefi_logs_appendable(&self) -> bool;
+    fn get_uefi_logs_binary_file_path(&self) -> String;
     fn get_uefi_logs_evidence_version(&self) -> String;
     fn get_uefi_logs_formats(&self) -> Vec<String>;
     fn get_uefi_logs_supports_partial_access(&self) -> bool;
@@ -78,11 +83,6 @@ impl Default for PushModelConfig {
                 .to_string()
                 .clone(),
             ima_ml_count_file: DEFAULT_IMA_ML_COUNT_FILE.to_string().clone(),
-            measuredboot_ml_directory_path:
-                DEFAULT_MEASUREDBOOT_ML_DIRECTORY_PATH.to_string().clone(),
-            measuredboot_ml_count_file: DEFAULT_MEASUREDBOOT_ML_COUNT_FILE
-                .to_string()
-                .clone(),
             registrar_ip: DEFAULT_REGISTRAR_IP.to_string(),
             registrar_port: DEFAULT_REGISTRAR_PORT,
             registrar_api_versions: DEFAULT_REGISTRAR_API_VERSIONS
@@ -93,6 +93,8 @@ impl Default for PushModelConfig {
             server_key: DEFAULT_SERVER_KEY.to_string(),
             server_key_password: DEFAULT_SERVER_KEY_PASSWORD.to_string(),
             uefi_logs_appendable: DEFAULT_UEFI_LOGS_APPENDABLE,
+            uefi_logs_binary_file_path: DEFAULT_UEFI_LOGS_BINARY_FILE_PATH
+                .to_string(),
             uefi_logs_evidence_version: DEFAULT_UEFI_LOGS_EVIDENCE_VERSION
                 .to_string(),
             uefi_logs_formats: DEFAULT_UEFI_LOGS_FORMATS
@@ -125,8 +127,6 @@ pub struct PushModelConfig {
     ima_logs_supports_partial_access: bool,
     ima_ml_directory_path: String,
     ima_ml_count_file: String,
-    measuredboot_ml_directory_path: String,
-    measuredboot_ml_count_file: String,
     registrar_api_versions: Vec<String>,
     registrar_ip: String,
     registrar_port: u32,
@@ -136,6 +136,7 @@ pub struct PushModelConfig {
     tpm_encryption_alg: String,
     tpm_hash_alg: String,
     tpm_signing_alg: String,
+    uefi_logs_binary_file_path: String,
     uefi_logs_evidence_version: String,
     uefi_logs_supports_partial_access: bool,
     uefi_logs_appendable: bool,
@@ -190,14 +191,6 @@ impl PushModelConfigTrait for PushModelConfig {
         self.ima_ml_directory_path.clone()
     }
 
-    fn get_measuredboot_ml_directory_path(&self) -> String {
-        self.measuredboot_ml_directory_path.clone()
-    }
-
-    fn get_measuredboot_ml_count_file(&self) -> String {
-        self.measuredboot_ml_count_file.clone()
-    }
-
     fn get_registrar_ip(&self) -> String {
         self.registrar_ip.clone()
     }
@@ -226,6 +219,10 @@ impl PushModelConfigTrait for PushModelConfig {
         self.uefi_logs_appendable
     }
 
+    fn get_uefi_logs_binary_file_path(&self) -> String {
+        self.uefi_logs_binary_file_path.clone()
+    }
+
     fn get_uefi_logs_evidence_version(&self) -> String {
         self.uefi_logs_evidence_version.clone()
     }
@@ -265,9 +262,9 @@ impl PushModelConfigTrait for PushModelConfig {
             enable_iak_idevid: {}, ek_handle: {},
             ima_logs_appendable: {}, ima_logs_formats: {:?}, ima_logs_supports_partial_access: {},
             ima_ml_directory_path: {}, ima_ml_count_file: {},
-            measuredboot_ml_directory_path: {}, measuredboot_ml_count_file: {},
             registrar_ip: {}, registrar_port: {}, server_cert: {},
             server_key: {}, server_key_password: {},
+            uefi_logs_binary_file_path: {},
             uefi_logs_evidence_version: {}, uefi_logs_supports_partial_access: {},
             uefi_logs_appendable: {}, uefi_logs_formats: {:?},
             tpm_encryption_alg: {}, tpm_hash_alg: {}, tpm_signing_alg: {},
@@ -282,13 +279,12 @@ impl PushModelConfigTrait for PushModelConfig {
             self.ima_logs_supports_partial_access,
             self.ima_ml_directory_path,
             self.ima_ml_count_file,
-            self.measuredboot_ml_directory_path,
-            self.measuredboot_ml_count_file,
             self.registrar_ip,
             self.registrar_port,
             self.server_cert,
             self.server_key,
             self.server_key_password,
+            self.uefi_logs_binary_file_path,
             self.uefi_logs_evidence_version,
             self.uefi_logs_supports_partial_access,
             self.uefi_logs_appendable,
@@ -343,19 +339,18 @@ mod tests {
             pmc.get_ima_ml_count_file()
                 == DEFAULT_IMA_ML_COUNT_FILE.to_string()
         );
-        assert!(
-            pmc.get_measuredboot_ml_directory_path()
-                == DEFAULT_MEASUREDBOOT_ML_DIRECTORY_PATH
-        );
-        assert!(
-            pmc.get_measuredboot_ml_count_file()
-                == DEFAULT_MEASUREDBOOT_ML_COUNT_FILE.to_string()
-        );
         assert!(pmc.get_registrar_ip() == DEFAULT_REGISTRAR_IP);
         assert!(pmc.get_registrar_port() == DEFAULT_REGISTRAR_PORT);
         assert!(pmc.get_server_cert() == DEFAULT_SERVER_CERT);
         assert!(pmc.get_server_key() == DEFAULT_SERVER_KEY);
         assert!(pmc.get_server_key_password() == DEFAULT_SERVER_KEY_PASSWORD);
+        assert!(
+            pmc.get_uefi_logs_appendable() == DEFAULT_UEFI_LOGS_APPENDABLE
+        );
+        assert!(
+            pmc.get_uefi_logs_binary_file_path()
+                == DEFAULT_UEFI_LOGS_BINARY_FILE_PATH.to_string()
+        );
         assert!(
             pmc.get_uefi_logs_evidence_version()
                 == DEFAULT_UEFI_LOGS_EVIDENCE_VERSION
@@ -384,7 +379,7 @@ mod tests {
 
     #[test]
     fn test_display_config() {
-        let pmc = PushModelConfig::default();
+        let pmc = PushModelConfig::new();
         let display_string = pmc.to_string();
         assert!(display_string
             .contains(&pmc.get_certification_keys_server_identifier()));
@@ -404,11 +399,6 @@ mod tests {
         ));
         assert!(display_string.contains(&pmc.get_ima_ml_directory_path()));
         assert!(display_string.contains(&pmc.get_ima_ml_count_file()));
-        assert!(display_string
-            .contains(&pmc.get_measuredboot_ml_directory_path()));
-        assert!(
-            display_string.contains(&pmc.get_measuredboot_ml_count_file())
-        );
         assert!(display_string.contains(&pmc.get_registrar_ip()));
         assert!(
             display_string.contains(&pmc.get_registrar_port().to_string())

keylime/src/config/push_model.rs

@@ -112,6 +112,8 @@ pub enum Error {
     CertificateGeneration(
         #[from] crate::crypto::x509::CertificateBuilderError,
     ),
+    #[error("UEFI Log parser error: {0}")]
+    UEFILog(String),
     #[error("{0}")]
     Other(String),
 }

keylime/src/error.rs

@@ -23,6 +23,7 @@ pub mod secure_mount;
 pub mod serialization;
 pub mod structures;
 pub mod tpm;
+pub mod uefi;
 pub mod version;
 
 #[macro_use]

keylime/src/lib.rs

@@ -0,0 +1,3 @@
+pub mod uefi_log_handler;
+
+pub use uefi_log_handler::*;