feat: Adds validation_state to the json reports from the Reader (#930)

* feat: Add validation_status to manifest reports
chore: remove Store and ManifestStore and ManifestStoreReport from the non-v1 public SDK
refactoring and code removal

* chore: clean up unreferenced values

* chore: restore summarize_manifest_store due to feedback

* chore: remove wasm build warning

cawg_identity/src/identity_assertion/assertion.rs

@@ -200,13 +200,9 @@ impl IdentityAssertion {
             >,
         > = BTreeMap::new();
 
-        for manifest in reader.iter_manifests() {
+        for (id, manifest) in reader.manifests() {
             let report = Self::summarize_all_impl(manifest, verifier).await;
-
-            // TO DO: What to do if manifest doesn't have a label?
-            if let Some(label) = manifest.label() {
-                reports.insert(label.to_owned(), report);
-            }
+            reports.insert(id.clone(), report);
         }
 
         IdentityAssertionsForManifestStore::<

make_test_images/src/compare_manifests.rs

@@ -15,7 +15,7 @@
 use std::collections::HashMap;
 use std::{fs, path::Path};
 
-use c2pa::{Error, Reader as ManifestStore, Result};
+use c2pa::{Error, Reader, Result};
 
 /// Compares all the files in two directories and returns a list of issues
 pub fn compare_folders<P: AsRef<Path>, Q: AsRef<Path>>(folder1: P, folder2: Q) -> Result<()> {
@@ -79,17 +79,16 @@ pub fn compare_image_manifests<P: AsRef<Path>, Q: AsRef<Path>>(
 ) -> Result<Vec<String>> {
     let manifest_store1 = match m1.as_ref().extension() {
         Some(ext) if ext == "json" => {
-            ManifestStore::from_json(&fs::read_to_string(m1)?)
+            Reader::from_json(&fs::read_to_string(m1)?)
             //serde_json::from_str(&fs::read_to_string(m1)?).map_err(Error::JsonError)
         }
-        _ => ManifestStore::from_file(m1.as_ref()),
+        _ => Reader::from_file(m1.as_ref()),
     };
     let manifest_store2 = match m2.as_ref().extension() {
-        Some(ext) if ext == "json" => ManifestStore::from_json(&fs::read_to_string(m2)?),
-        _ => ManifestStore::from_file(m2.as_ref()),
+        Some(ext) if ext == "json" => Reader::from_json(&fs::read_to_string(m2)?),
+        _ => Reader::from_file(m2.as_ref()),
     };
-    // let manifest_store1 = ManifestStore::from_file(m1);
-    // let manifest_store2 = ManifestStore::from_file(m2);
+
     match (manifest_store1, manifest_store2) {
         (Ok(manifest_store1), Ok(manifest_store2)) => {
             compare_manifests(&manifest_store1, &manifest_store2)
@@ -102,8 +101,8 @@ pub fn compare_image_manifests<P: AsRef<Path>, Q: AsRef<Path>>(
 
 /// Compares two manifest stores and returns a list of issues.
 pub fn compare_manifests(
-    manifest_store1: &ManifestStore,
-    manifest_store2: &ManifestStore,
+    manifest_store1: &Reader,
+    manifest_store2: &Reader,
 ) -> Result<Vec<String>> {
     // first we need to gather all the manifests in the order they are first seen recursively
     let mut labels1 = Vec::new();
@@ -136,11 +135,7 @@ pub fn compare_manifests(
 }
 
 // creates list of manifests in the order they are first seen from the active manifest
-fn gather_manifests(
-    manifest_store: &ManifestStore,
-    manifest_label: &str,
-    labels: &mut Vec<String>,
-) {
+fn gather_manifests(manifest_store: &Reader, manifest_label: &str, labels: &mut Vec<String>) {
     if !labels.contains(&manifest_label.to_string()) {
         labels.push(manifest_label.to_string());
     }

sdk/src/builder.rs

@@ -1476,7 +1476,7 @@ mod tests {
             .add("thumbnail.jpg", TEST_THUMBNAIL.to_vec())
             .unwrap();
 
-        // sign the ManifestStoreBuilder and write it to the output stream
+        // sign the Builder and write it to the output stream
         let signer = crate::utils::test::temp_async_remote_signer();
         builder
             .sign_async(signer.as_ref(), format, &mut source, &mut dest)
@@ -1511,7 +1511,7 @@ mod tests {
             .add_resource("thumbnail.jpg", Cursor::new(TEST_THUMBNAIL))
             .unwrap();
 
-        // sign the ManifestStoreBuilder and write it to the output stream
+        // sign the Builder and write it to the output stream
         let signer = test_signer(SigningAlg::Ps256);
         let manifest_data = builder
             .sign(signer.as_ref(), "image/jpeg", &mut source, &mut dest)
@@ -1680,7 +1680,7 @@ mod tests {
         zipped.rewind().unwrap();
         let mut builder = Builder::from_archive(&mut zipped).unwrap();
 
-        // sign the ManifestStoreBuilder and write it to the output stream
+        // sign the Builder and write it to the output stream
         let signer = test_signer(SigningAlg::Ps256);
         let _manifest_data = builder
             .sign(signer.as_ref(), "image/jpeg", &mut source, &mut dest)
@@ -1866,6 +1866,7 @@ mod tests {
             .expect("builder sign");
 
         output.set_position(0);
+        println!("output len: {}", output.get_ref().len());
         let reader = Reader::from_stream("jpeg", &mut output).expect("from_bytes");
         println!("reader = {reader}");
         let m = reader.active_manifest().unwrap();

sdk/src/claim.rs

@@ -81,6 +81,7 @@ static _V2_SPEC_DEPRECATED_ASSERTIONS: [&str; 4] = [
 // Enum to encapsulate the data type of the source asset.  This simplifies
 // having different implementations for functions as a single entry point can be
 // used to handle different data types.
+#[allow(dead_code)] // Bytes and third param in StreamFragment not used without v1_api feature
 pub enum ClaimAssetData<'a> {
     #[cfg(feature = "file_io")]
     Path(&'a Path),

sdk/src/ingredient.rs

@@ -45,7 +45,7 @@ use crate::{
     store::Store,
     utils::xmp_inmemory_utils::XmpInfo,
     validation_results::ValidationResults,
-    validation_status::{self, validation_results_for_store, ValidationStatus},
+    validation_status::{self, ValidationStatus},
 };
 
 #[derive(Debug, Default, Deserialize, Serialize)]
@@ -589,7 +589,7 @@ impl Ingredient {
         match result {
             Ok(store) => {
                 // generate validation results from the store
-                let validation_results = validation_results_for_store(&store, validation_log);
+                let validation_results = ValidationResults::from_store(&store, validation_log);
 
                 if let Some(claim) = store.provenance_claim() {
                     // if the parent claim is valid and has a thumbnail, use it

sdk/src/jumbf_io.rs

@@ -282,7 +282,7 @@ pub fn load_jumbf_from_file<P: AsRef<Path>>(in_path: P) -> Result<Vec<u8>> {
     }
 }
 
-#[cfg(feature = "file_io")]
+#[cfg(all(feature = "v1_api", feature = "file_io"))]
 pub(crate) fn object_locations(in_path: &Path) -> Result<Vec<HashObjectPositions>> {
     let ext = get_file_extension(in_path).ok_or(Error::UnsupportedType)?;
 
@@ -329,14 +329,13 @@ where
     }
 }
 
-#[cfg(feature = "file_io")]
 /// removes the C2PA JUMBF from an asset
 /// Note: Use with caution since this deletes C2PA data
 /// It is useful when creating remote manifests from embedded manifests
 ///
 /// path - path to file to be updated
 /// returns Unsupported type or errors from remove_cai_store
-#[allow(dead_code)]
+#[cfg(feature = "file_io")]
 pub fn remove_jumbf_from_file<P: AsRef<Path>>(path: P) -> Result<()> {
     let ext = get_file_extension(path.as_ref()).ok_or(Error::UnsupportedType)?;
     match get_assetio_handler(&ext) {

sdk/src/lib.rs

@@ -121,6 +121,7 @@ pub use manifest::{Manifest, SignatureInfo};
 pub use manifest_assertion::{ManifestAssertion, ManifestAssertionKind};
 #[cfg(feature = "v1_api")]
 pub use manifest_store::ManifestStore;
+#[cfg(feature = "v1_api")]
 pub use manifest_store_report::ManifestStoreReport;
 pub use reader::Reader;
 pub use resource_store::{ResourceRef, ResourceStore};
@@ -148,6 +149,7 @@ pub(crate) mod jumbf;
 
 pub(crate) mod manifest;
 pub(crate) mod manifest_assertion;
+#[cfg(feature = "v1_api")]
 pub(crate) mod manifest_store;
 pub(crate) mod manifest_store_report;
 #[allow(dead_code)]

sdk/src/manifest_store.rs

@@ -30,7 +30,7 @@ use crate::{
     jumbf::labels::{manifest_label_from_uri, to_absolute_uri, to_relative_uri},
     store::Store,
     validation_results::ValidationResults,
-    validation_status::{validation_results_for_store, ValidationStatus},
+    validation_status::ValidationStatus,
     Error, Manifest, Result,
 };
 
@@ -183,7 +183,7 @@ impl ManifestStore {
         validation_log: &impl StatusTracker,
         #[cfg(feature = "file_io")] resource_path: Option<&Path>,
     ) -> ManifestStore {
-        let mut validation_results = validation_results_for_store(&store, validation_log);
+        let mut validation_results = ValidationResults::from_store(&store, validation_log);
 
         let mut manifest_store = ManifestStore::new();
         manifest_store.active_manifest = store.provenance_label();
@@ -220,7 +220,7 @@ impl ManifestStore {
         validation_log: &impl StatusTracker,
         #[cfg(feature = "file_io")] resource_path: Option<&Path>,
     ) -> ManifestStore {
-        let mut validation_results = validation_results_for_store(&store, validation_log);
+        let mut validation_results = ValidationResults::from_store(&store, validation_log);
 
         let mut manifest_store = ManifestStore::new();
         manifest_store.active_manifest = store.provenance_label();
@@ -252,10 +252,6 @@ impl ManifestStore {
         manifest_store
     }
 
-    pub(crate) fn store(&self) -> &Store {
-        &self.store
-    }
-
     /// Creates a new Manifest Store from a Manifest
     #[allow(dead_code)]
     #[deprecated(since = "0.38.0", note = "Please use Reader::from_json() instead")]
@@ -272,7 +268,6 @@ impl ManifestStore {
     }
 
     /// Generate a Store from a format string and bytes.
-    #[cfg(feature = "v1_api")]
     #[deprecated(since = "0.38.0", note = "Please use Reader::from_stream() instead")]
     #[cfg(feature = "v1_api")]
     #[async_generic]

sdk/src/manifest_store_report.rs

@@ -26,7 +26,7 @@ use serde_json::Value;
 
 use crate::{
     assertion::AssertionData, claim::Claim, store::Store, validation_results::ValidationResults,
-    validation_status::ValidationStatus, Result,
+    validation_status::ValidationStatus, Result, ValidationState,
 };
 
 /// Low level JSON based representation of Manifest Store - used for debugging
@@ -39,6 +39,7 @@ pub struct ManifestStoreReport {
     #[serde(skip_serializing_if = "Option::is_none")]
     validation_status: Option<Vec<ValidationStatus>>,
     pub(crate) validation_results: Option<ValidationResults>,
+    pub(crate) validation_state: Option<ValidationState>,
 }
 
 impl ManifestStoreReport {
@@ -54,9 +55,20 @@ impl ManifestStoreReport {
             manifests,
             validation_status: None,
             validation_results: None,
+            validation_state: None,
         })
     }
 
+    pub(crate) fn from_store_with_results(
+        store: &Store,
+        validation_results: &ValidationResults,
+    ) -> Result<Self> {
+        let mut report = Self::from_store(store)?;
+        report.validation_results = Some(validation_results.clone());
+        report.validation_state = Some(validation_results.validation_state());
+        Ok(report)
+    }
+
     /// Prints tree view of manifest store
     #[cfg(feature = "file_io")]
     #[cfg(feature = "v1_api")]