The EK Certificate chain can be stored in the NVRAM Indexes ranging f…

…rom 0x01c00100 to 0x01c001ff, with the certificates stored concatenated in DER format.

If handles within this specified range are present, the following steps will be executed:

1. The content of all NV handles will be collected into a vector.
2. The content of the vector will be split into individual certificates.
3. Each certificate will be converted to PEM format.
4. The resulting PEM certificate chain will be provided as the 'ek_ca_chain' attribute to the registrar.

I appreciate any feedback, as I have no experience with the Rust programming language.

keylime-agent/src/main.rs

@@ -464,6 +464,12 @@ async fn main() -> Result<()> {
     // Calculate the SHA-256 hash of the public key in PEM format
     let ek_hash = hash_ek_pubkey(ek_result.public.clone())?;
 
+    // Read EK CA Chain form TPM
+    let ek_ca_chain = match ctx.create_ek_ca_chain() {
+        Ok(value) => Some(value),
+        Err(_) => None,
+    };
+
     // Replace the uuid with the actual EK hash if the option was set.
     // We cannot do that when the configuration is loaded initially,
     // because only have later access to the the TPM.
@@ -723,6 +729,7 @@ async fn main() -> Result<()> {
                 &PublicBuffer::try_from(ek_result.public.clone())?
                     .marshall()?,
                 ek_result.ek_cert,
+                ek_ca_chain,
                 &PublicBuffer::try_from(ak.public)?.marshall()?,
                 Some(
                     &PublicBuffer::try_from(iak.public.clone())?
@@ -749,6 +756,7 @@ async fn main() -> Result<()> {
                 &PublicBuffer::try_from(ek_result.public.clone())?
                     .marshall()?,
                 ek_result.ek_cert,
+                ek_ca_chain,
                 &PublicBuffer::try_from(ak.public)?.marshall()?,
                 None,
                 None,

keylime-agent/src/registrar_agent.rs

@@ -16,6 +16,8 @@ fn is_empty(buf: &[u8]) -> bool {
 struct Register<'a> {
     #[serde(serialize_with = "serialize_maybe_base64")]
     ekcert: Option<Vec<u8>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    ek_ca_chain: Option<String>,
     #[serde(
         serialize_with = "serialize_as_base64",
         skip_serializing_if = "is_empty"
@@ -134,6 +136,7 @@ pub(crate) async fn do_register_agent(
     agent_uuid: &str,
     ek_tpm: &[u8],
     ekcert: Option<Vec<u8>>,
+    ek_ca_chain: Option<String>,
     aik_tpm: &[u8],
     iak_tpm: Option<&[u8]>,
     idevid_tpm: Option<&[u8]>,
@@ -168,6 +171,7 @@ pub(crate) async fn do_register_agent(
 
     let data = Register {
         ekcert,
+        ek_ca_chain,
         ek_tpm,
         aik_tpm,
         iak_tpm,

keylime/src/tpm.rs

@@ -16,7 +16,7 @@ use openssl::{
     memcmp,
     pkey::{HasPublic, Id, PKeyRef, Public},
 };
-
+use openssl::x509::X509;
 use tss_esapi::{
     abstraction::{
         ak,
@@ -57,6 +57,10 @@ use tss_esapi::{
     tss2_esys::{TPML_DIGEST, TPML_PCR_SELECTION},
     Error::Tss2Error,
 };
+use tss_esapi::abstraction::nv;
+use tss_esapi::constants::CapabilityType;
+use tss_esapi::interface_types::resource_handles::NvAuth;
+use tss_esapi::structures::CapabilityData;
 
 /// Maximum size of nonce used in `quote`.
 pub const MAX_NONCE_SIZE: usize = 64;
@@ -108,6 +112,10 @@ const IAK_AUTH_POLICY_SHA256: [u8; 32] = [
 ];
 const UNIQUE_IAK: [u8; 3] = [0x49, 0x41, 0x4b];
 
+const RSA_EK_CERTIFICATE_CHAIN_START: u32 = 0x01c00100;
+const RSA_EK_CERTIFICATE_CHAIN_END: u32 = 0x01c001ff;
+
+
 /// TpmError wraps all possible errors raised in tpm.rs
 #[derive(Error, Debug)]
 pub enum TpmError {
@@ -586,6 +594,119 @@ impl Context {
         })
     }
 
+    pub fn read_ek_ca_chain(&mut self) -> tss_esapi::Result<Vec<u8>> {
+        let mut result: Vec<u8> = Vec::new();
+        let context = &mut self.inner;
+
+        // Get handles for NV-Index in range 0x01c00100 - 0x01c001ff
+        let (capabilities, _) = context.get_capability(
+            CapabilityType::Handles,
+            RSA_EK_CERTIFICATE_CHAIN_START,
+            RSA_EK_CERTIFICATE_CHAIN_END - RSA_EK_CERTIFICATE_CHAIN_START,
+        )?;
+
+        if let CapabilityData::Handles(handle_list) = capabilities {
+            for handle in handle_list.iter() {
+                if let TpmHandle::NvIndex(nv_idx) = handle {
+                    // Attempt to get the NV authorization handle
+                    let nv_auth_handle = context.execute_without_session(|ctx| {
+                        ctx.tr_from_tpm_public(*handle)
+                            .map(|v| NvAuth::NvIndex(v.into()))
+                    })?;
+
+                    // Read the full NV data
+                    let data = context.execute_with_nullauth_session(|ctx| {
+                        nv::read_full(ctx, nv_auth_handle, *nv_idx)
+                    })?;
+
+                    result.extend(data);
+                } else {
+                    // Handle other types of handles if necessary
+                    break; // Skip non-NvIndex handles
+                }
+            }
+        }
+
+        Ok(result) // Return the accumulated result
+    }
+
+    pub fn split_der_certificates(
+        &mut self,
+        der_data: &[u8]
+    ) -> Vec<Vec<u8>>
+    {
+        let mut certificates = Vec::new();
+        let mut offset = 0;
+
+        while offset < der_data.len() {
+            // Check if the current byte indicates the start of a sequence (0x30)
+            if der_data[offset] != 0x30 {
+                break; // Not a valid certificate start
+            }
+
+            // Read the length of the sequence
+            let length_byte = der_data[offset + 1];
+            let cert_length = if length_byte & 0x80 == 0 {
+                // Short form length
+                length_byte as usize + 2 // +2 for the tag and length byte
+            } else {
+                // Long form length
+                let length_of_length = (length_byte & 0x7F) as usize;
+                let length_bytes = &der_data[offset + 2..offset + 2 + length_of_length];
+                let cert_length = length_bytes.iter().fold(0, |acc, &b| (acc << 8) | b as usize);
+                cert_length + 2 + length_of_length // +2 for the tag and length byte
+            };
+
+            // Extract the certificate
+            let cert = der_data[offset..offset + cert_length].to_vec();
+            certificates.push(cert);
+
+            // Move the offset to the next certificate
+            offset += cert_length;
+        }
+
+        certificates
+    }
+
+    pub fn der_to_pem(
+        &mut self,
+        der_certificates: Vec<Vec<u8>>
+    ) -> std::result::Result<String, Box<dyn std::error::Error>> {
+        let mut pem_string = String::new();
+
+        for der in der_certificates {
+            // Convert DER to X509
+            let cert = X509::from_der(&der)?;
+
+            // Convert X509 to PEM format
+            let pem = cert.to_pem()?;
+
+            // Append the PEM string to the result
+            pem_string.push_str(&String::from_utf8(pem)?);
+        }
+
+        Ok(pem_string)
+    }
+
+    /// Read the EK CA Chain from the tpm and return it.
+    ///
+    /// As described in https://trustedcomputinggroup.org/wp-content/uploads/TCG-EK-Credential-Profile-V-2.5-R2_published.pdf (2.2.1.5.2 Handle Values for EK Certificate Chains)
+    /// Intermediate certificates can be stored directly in the TPM. The index used for it should be
+    /// 0x01c00100 - 0x01c001ff. The CA Chain is stored in DER format and will overlflow into the
+    /// next register as long as there is data.
+    ///
+    /// This is for example the case for Intel fTPM, starting 11th gen core.
+    ///
+    /// # Returns
+    ///
+    /// A `String` with all certificates in PEM format if successful, an Error otherwise
+    pub fn create_ek_ca_chain(&mut self) -> std::result::Result<String, Box<dyn std::error::Error>> {
+        let der_data = self.read_ek_ca_chain()?;
+        let der_certificates = self.split_der_certificates(&der_data);
+        let pem_string = self.der_to_pem(der_certificates)?;
+        Ok(pem_string)
+    }
+
     /// Creates an AK
     ///
     /// # Arguments
@@ -2132,6 +2253,14 @@ pub mod testing {
         }
     }
 
+    #[test]
+    #[cfg(feature = "testing")]
+    fn test_create_ek_ca_chain() {
+        let mut ctx = Context::new().unwrap(); //#[allow_ci]
+        let c = ctx.create_ek_ca_chain();
+        assert!(c.is_ok());
+    }
+
     #[test]
     #[cfg(feature = "testing")]
     fn test_create_and_load_ak() {