update to support docker metadata object

surfactant/infoextractors/docker_tarball_file.py

@@ -0,0 +1,85 @@
+# Copyright 2024 Lawrence Livermore National Security, LLC
+# see: ${repository}/LICENSE
+#
+# SPDX-License-Identifier: MIT
+
+import json
+import tarfile
+from pathlib import PurePosixPath
+from typing import IO, Any, Dict, List, Union
+
+import surfactant.plugin
+from surfactant.sbomtypes import SBOM, Software
+
+
+class optics:
+    class tarball:
+        @staticmethod
+        def manifest_file(tarball: tarfile.TarFile) -> Union[IO[bytes], None]:
+            return tarball.extractfile(
+                {tarinfo.name: tarinfo for tarinfo in tarball.getmembers()}["manifest.json"]
+            )
+
+        @staticmethod
+        def config_file(tarball: tarfile.TarFile, path: str) -> Union[IO[bytes], None]:
+            return tarball.extractfile(
+                {tarinfo.name: tarinfo for tarinfo in tarball.getmembers()}[path]
+            )
+
+    class manifest:
+        @staticmethod
+        def config_path(manifest: List[Dict[str, Any]]) -> List[str]:
+            path = "Config"
+            return [entry[path] for entry in manifest]
+
+        @staticmethod
+        def repo_tags(manifest: List[Dict[str, Any]]) -> List[str]:
+            path = "RepoTags"
+            return [entry[path] for entry in manifest]
+
+
+def portable_path_list(*paths: str):
+    """Convert paths to a portable format acknowledged by"""
+    return tuple([str(PurePosixPath(path_str)) for path_str in paths])
+
+
+def supports_file(filename: str, filetype: str) -> bool:
+    EXPECTED_FILETYPE = "TAR"
+
+    expected_members = portable_path_list(
+        "index.json",
+        "manifest.json",
+        "oci-layout",
+        "repositories",
+        "blobs/sha256",
+    )
+
+    if filetype != EXPECTED_FILETYPE:
+        return False
+
+    with tarfile.open(filename) as this_tarfile:
+        found_members = portable_path_list(*[member.name for member in this_tarfile.getmembers()])
+
+    return all([expected_member in found_members for expected_member in expected_members])
+
+
+@surfactant.plugin.hookimpl
+def extract_file_info(sbom: SBOM, software: Software, filename: str, filetype: str) -> object:
+    if not supports_file(filename, filetype):
+        return None
+    return extract_image_info(filename)
+
+
+def extract_image_info(filename: str):
+    """Return image configuration objects mapped by their paths."""
+    root_key = "dockerImageConfigs"
+    image_info: Dict[str, List[Dict[str, Any]]] = {root_key: []}
+    with tarfile.open(filename) as tarball:
+        # we know the manifest file is present or we wouldn't be this far
+        assert (manifest_file := optics.tarball.manifest_file(tarball))
+        manifest = json.load(manifest_file)
+        for config_path in optics.manifest.config_path(manifest):
+            assert (config_file := optics.tarball.config_file(tarball, config_path))
+            config = json.load(config_file)
+            image_info[root_key].append(config)
+    return image_info

surfactant/plugin/manager.py

@@ -17,6 +17,7 @@ def _register_plugins(pm: pluggy.PluginManager) -> None:
     from surfactant.infoextractors import (
         a_out_file,
         coff_file,
+        docker_tarball_file,
         elf_file,
         java_file,
         js_file,
@@ -43,6 +44,7 @@ def _register_plugins(pm: pluggy.PluginManager) -> None:
         id_extension,
         a_out_file,
         coff_file,
+        docker_tarball_file,
         elf_file,
         java_file,
         js_file,