Added support for OCI image indexes and manifest

Added test for dockerv2 kiwix-serve (3.8.1) and ociv1 (3.8.2)

Fixes #12

Author: rgaudin

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Support for OCI image indexes and manifest (#12)
+
 ## [1.1.0] - 2024-01-30
 
 ### Added

src/docker_export/__init__.py

@@ -37,6 +37,15 @@
 logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
 logger = logging.getLogger("docker-export")
 logging.getLogger("urllib3").setLevel(logging.WARNING)
+CT_DOCKER_MANIFEST_LIST = "application/vnd.docker.distribution.manifest.list.v2+json"
+CT_DOCKER_MANIFEST = "application/vnd.docker.distribution.manifest.v2+json"
+CT_OCI_INDEXES = "application/vnd.oci.image.index.v1+json"
+CT_OCI_MANIFEST = "application/vnd.oci.image.manifest.v1+json"
+CT_OCI_IMAGE_CONFIG = "application/vnd.oci.image.config.v1+json"
+CT_OCI_EMPTY = "application/vnd.oci.image.config.v1+json"
+CT_OCI_LAYERS = (
+    "application/vnd.oci.image.layer.v1.tar,application/vnd.oci.image.layer.v1.tar+gzip"
+)
 
 
 class ImageNotFoundError(Exception): ...
@@ -384,7 +393,7 @@ def get_manifests(image: Image, auth: RegistryAuth):
         f"/manifests/{image.reference}",
         headers=dict(
             **auth.headers,
-            **{"Accept": "application/vnd.docker.distribution.manifest.list.v2+json"},
+            **{"Accept": ", ".join([CT_DOCKER_MANIFEST_LIST, CT_OCI_INDEXES])},
         ),
         timeout=REQUEST_TIMEOUT,
     )
@@ -415,13 +424,12 @@ def get_layers_manifest_for(
         f"/manifests/{reference}",
         headers=dict(
             **auth.headers,
-            **{"Accept": "application/vnd.docker.distribution.manifest.v2+json"},
+            **{"Accept": ", ".join([CT_DOCKER_MANIFEST, CT_OCI_MANIFEST])},
         ),
         timeout=REQUEST_TIMEOUT,
     )
     if resp.status_code != http.HTTPStatus.OK:
-        raise OSError("HTTP {resp.status_code}: {resp.reason} -- {resp.text}")
-
+        raise OSError(f"HTTP {resp.status_code}: {resp.reason} -- {resp.text}")
     return resp.json()
 
 
@@ -438,7 +446,7 @@ def get_layers_from_v1_manifest(
         )
 
     return {
-        "mediaType": "application/vnd.docker.distribution.manifest.v2+json",
+        "mediaType": CT_DOCKER_MANIFEST,
         "schemaVersion": 2,
         "config": {
             "mediaType": "application/vnd.docker.container.image.v1+json",
@@ -447,7 +455,7 @@ def get_layers_from_v1_manifest(
         },
         "layers": [
             {
-                "mediaType": "application/vnd.docker.distribution.manifest.v2+json",
+                "mediaType": CT_DOCKER_MANIFEST,
                 "digest": layer["blobSum"],
                 # "size": None,
                 "platform": {"architecture": architecture, "os": os},
@@ -524,7 +532,7 @@ def download_layer_blob(
         f"https://{image.registry}/v2/{image.fullname}/blobs/{layer_digest}",
         headers=dict(
             **auth.headers,
-            **{"Accept": "application/vnd.docker.distribution.manifest.v2+json"},
+            **{"Accept": CT_DOCKER_MANIFEST},
         ),
         stream=True,
         timeout=REQUEST_TIMEOUT,
@@ -536,7 +544,7 @@ def download_layer_blob(
             layer["urls"][0],
             headers=dict(
                 **auth.headers,
-                **{"Accept": "application/vnd.docker.distribution.manifest.v2+json"},
+                **{"Accept": CT_DOCKER_MANIFEST},
             ),
             stream=True,
             timeout=REQUEST_TIMEOUT,

tests/test_digest.py

@@ -24,6 +24,16 @@
             # which is the Docker-Content-Digest
             "sha256:148e55d6f2c3fa74bdba8f2b6870677cfcb268e5a9bebc9e5135a026f502f447",
         ),
+        (
+            "ghcr.io/offspot/kiwix-serve:3.8.2",
+            "linux/arm64",
+            "sha256:eb186010ca6318da285db02383d2bb4aef45034faead4eb8a78fcde758d919c3",
+        ),
+        (
+            "ghcr.io/offspot/kiwix-serve:3.8.1",
+            "linux/amd64",
+            "sha256:c7e75fd985a93aedcc4582751f23d64bcf4274294fff63c3b7a0ba32bc3d103f",
+        ),
         (
             f"{kiwix_tools}:3.5.0-2",
             "linux/amd64",