Extract API logic from caliptra_common into new caliptra-api crate. (#…

…988)

Host libraries should not have transitive deps on caliptra-drivers.

Cargo.toml

@@ -22,6 +22,7 @@ exclude = [
 ]
 
 members = [
+  "api",
   "builder",
   "cfi/lib",
   "cfi/derive",
@@ -83,6 +84,7 @@ asn1 = "0.13.0"
 bitfield = "0.14.0"
 bitflags = "2.0.1"
 bit-vec = "0.6.3"
+caliptra-api = { path = "api" }
 caliptra-cfi-lib = { path = "cfi/lib", default-features = false, features = ["cfi", "cfi-counter" ] }
 caliptra-cfi-derive = { path = "cfi/derive" }
 caliptra_common = { path = "common", default-features = false }

FROZEN_IMAGES.sha384sum

@@ -1,3 +1,3 @@
 # WARNING: Do not update this file without the approval of the Caliptra TAC
-3b3d2e3fc803aebed8334ddb2db470403b232a7de70a1394e19149ae5280e6c357235cec2f64ebd8d229efa2f8f4cac9  caliptra-rom-no-log.bin
-a309276ecd74586409d9f0c01a75c3c1ab43a72fa3a5fee6527a3dc6a3bfc5e6334ddf73e58dd2cb3ab142b273cb6b20  caliptra-rom-with-log.bin
+2c7b77ae40e6c760a26fe37d1a3b45910435196f642ef76f1df96e49eec5cf710fb7159d89189a0b4eae47007ddc2b98  caliptra-rom-no-log.bin
+0c518139f1cd88acbd06ff4e24b28823008347ce5186e84af54adabedcd00c52b3ad9b6a0e6aaf8514b4dfafed5b64cb  caliptra-rom-with-log.bin

api/Cargo.toml

@@ -0,0 +1,13 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "caliptra-api"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+bitflags.workspace = true
+caliptra-error.workspace = true
+zerocopy.workspace = true

api/src/lib.rs

@@ -0,0 +1,11 @@
+// Licensed under the Apache-2.0 license
+
+#![no_std]
+
+mod capabilities;
+mod checksum;
+pub mod mailbox;
+
+pub use caliptra_error as error;
+pub use capabilities::Capabilities;
+pub use checksum::{calc_checksum, verify_checksum};

common/src/mailbox_api.rs → api/src/mailbox.rs

@@ -1,6 +1,6 @@
 // Licensed under the Apache-2.0 license
 
-use caliptra_drivers::{CaliptraError, CaliptraResult};
+use caliptra_error::{CaliptraError, CaliptraResult};
 use core::mem::size_of;
 use zerocopy::{AsBytes, FromBytes, LayoutVerified};
 

common/Cargo.toml

@@ -13,6 +13,7 @@ caliptra-cpu.workspace = true
 caliptra-drivers.workspace = true
 caliptra-image-types = { workspace = true, default-features = false }
 caliptra-image-verify.workspace = true
+caliptra-api.workspace = true
 caliptra-registers.workspace = true
 ufmt.workspace = true
 zerocopy.workspace = true

common/src/lib.rs

@@ -3,14 +3,17 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 
 pub mod boot_status;
-pub mod capabilities;
-pub mod checksum;
+pub mod capabilities {
+    pub use caliptra_api::Capabilities;
+}
+pub mod checksum {
+    pub use caliptra_api::{calc_checksum, verify_checksum};
+}
 pub mod crypto;
 pub mod dice;
 pub mod error_handler;
 pub mod fips;
 pub mod keyids;
-pub mod mailbox_api;
 pub mod verifier;
 pub mod wdt;
 
@@ -21,6 +24,7 @@ pub use hand_off::{
 };
 
 pub use boot_status::RomBootStatus;
+pub use caliptra_api::mailbox as mailbox_api;
 pub use caliptra_drivers::cprint;
 pub use caliptra_drivers::cprintln;
 pub use caliptra_drivers::fuse_log as fuse;

hw-model/Cargo.toml

@@ -16,12 +16,12 @@ itrng = ["caliptra-verilated?/itrng"]
 [dependencies]
 bitfield.workspace = true
 bit-vec.workspace = true
-caliptra_common = { workspace = true, default-features = false }
 caliptra-emu-bus.workspace = true
 caliptra-emu-cpu.workspace = true
 caliptra-emu-periph.workspace = true
 caliptra-emu-types.workspace = true
 caliptra-hw-model-types.workspace = true
+caliptra-api.workspace = true
 caliptra-registers.workspace = true
 caliptra-verilated = { workspace = true, optional = true }
 rand.workspace = true

hw-model/src/lib.rs

@@ -7,7 +7,7 @@ use std::{
     io::{stdout, ErrorKind, Write},
 };
 
-use caliptra_common::mailbox_api::{self, StashMeasurementResp};
+use caliptra_api as api;
 use caliptra_emu_bus::Bus;
 use caliptra_hw_model_types::{
     ErrorInjectionMode, EtrngResponse, RandomEtrngResponses, RandomNibbles, DEFAULT_CPTRA_OBF_KEY,
@@ -889,19 +889,19 @@ pub trait HwModel {
         let response = response.ok_or(ModelError::UploadMeasurementResponseError)?;
 
         // Get response as a response header struct
-        let response = StashMeasurementResp::read_from(response.as_slice())
+        let response = api::mailbox::StashMeasurementResp::read_from(response.as_slice())
             .ok_or(ModelError::UploadMeasurementResponseError)?;
 
         // Verify checksum and FIPS status
-        if !caliptra_common::checksum::verify_checksum(
+        if !api::verify_checksum(
             response.hdr.chksum,
             0x0,
             &response.as_bytes()[core::mem::size_of_val(&response.hdr.chksum)..],
         ) {
             return Err(ModelError::UploadMeasurementResponseError);
         }
 
-        if response.hdr.fips_status != mailbox_api::MailboxRespHeader::FIPS_STATUS_APPROVED {
+        if response.hdr.fips_status != api::mailbox::MailboxRespHeader::FIPS_STATUS_APPROVED {
             return Err(ModelError::UploadMeasurementResponseError);
         }