public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Filip Schauer <f.schauer@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH proxmox 17/26] oci: add a public pull_image_as_tar function
Date: Thu, 12 Nov 2026 15:10:44 +0100	[thread overview]
Message-ID: <20261112141109.137298-18-f.schauer@proxmox.com> (raw)
In-Reply-To: <20261112141109.137298-1-f.schauer@proxmox.com>

Signed-off-by: Filip Schauer <f.schauer@proxmox.com>
---
 proxmox-oci/Cargo.toml     |   1 +
 proxmox-oci/debian/control |   2 +
 proxmox-oci/src/lib.rs     | 111 +++++++++++++++++++++++++++++++++++++
 3 files changed, 114 insertions(+)

diff --git a/proxmox-oci/Cargo.toml b/proxmox-oci/Cargo.toml
index 45248658..87754e50 100644
--- a/proxmox-oci/Cargo.toml
+++ b/proxmox-oci/Cargo.toml
@@ -27,6 +27,7 @@ zstd.workspace = true
 proxmox-base64.workspace = true
 proxmox-http = { workspace = true, features = [ "client-sync" ] }
 proxmox-io.workspace = true
+proxmox-lang.workspace = true
 
 [dev-dependencies]
 anyhow.workspace = true
diff --git a/proxmox-oci/debian/control b/proxmox-oci/debian/control
index 9ec73059..62dc2cd2 100644
--- a/proxmox-oci/debian/control
+++ b/proxmox-oci/debian/control
@@ -14,6 +14,7 @@ Build-Depends-Arch: cargo:native <!nocheck>,
  librust-proxmox-http-1+client-sync-dev (>= 1.0.5-~~) <!nocheck>,
  librust-proxmox-http-1+default-dev (>= 1.0.5-~~) <!nocheck>,
  librust-proxmox-io-1+default-dev (>= 1.2.1-~~) <!nocheck>,
+ librust-proxmox-lang-1+default-dev (>= 1.5-~~) <!nocheck>,
  librust-serde-1+default-dev <!nocheck>,
  librust-serde-json-1+default-dev <!nocheck>,
  librust-sha2-0.10+default-dev <!nocheck>,
@@ -41,6 +42,7 @@ Depends:
  librust-proxmox-http-1+client-sync-dev (>= 1.0.5-~~),
  librust-proxmox-http-1+default-dev (>= 1.0.5-~~),
  librust-proxmox-io-1+default-dev (>= 1.2.1-~~),
+ librust-proxmox-lang-1+default-dev (>= 1.5-~~),
  librust-serde-1+default-dev,
  librust-serde-json-1+default-dev,
  librust-sha2-0.10+default-dev,
diff --git a/proxmox-oci/src/lib.rs b/proxmox-oci/src/lib.rs
index 672d81e0..542c9cee 100644
--- a/proxmox-oci/src/lib.rs
+++ b/proxmox-oci/src/lib.rs
@@ -1,9 +1,15 @@
+use std::fs::{File, remove_file};
+use std::io;
 use std::path::Path;
 
+use oci_spec::OciSpecError;
 pub use oci_spec::distribution::Reference;
 pub use oci_spec::image::{Arch, Config, Os};
+use oci_spec::image::{Descriptor, ImageIndexBuilder, MediaType, OciLayoutBuilder};
 use thiserror::Error;
 
+use proxmox_lang::try_block;
+
 pub mod client;
 use client::{Client, ClientConfig, OciClientError, RegistryAuth};
 
@@ -69,3 +75,108 @@ pub fn list_repository_tags(
     let tag_list = client.list_tags(reference, None, None)?;
     Ok(tag_list.tags().to_vec())
 }
+
+#[derive(Debug, Error)]
+pub enum PullTarError {
+    #[error(transparent)]
+    Client(#[from] OciClientError),
+    #[error(transparent)]
+    Io(#[from] io::Error),
+    #[error(transparent)]
+    OciSpec(#[from] OciSpecError),
+}
+
+/// Pull an OCI image from a registry and save it as a tar archive.
+///
+/// This removes the tar archive on error.
+///
+/// # Arguments
+///
+/// * `reference` - OCI reference specifying the image repository and tag/digest to pull
+/// * `auth` - Authentication credentials/method to access the registry
+/// * `tar_path` - Destination file path where the tar archive will be written to
+pub fn pull_image_as_tar(
+    reference: &Reference,
+    auth: RegistryAuth,
+    tar_path: impl AsRef<Path>,
+) -> Result<(), PullTarError> {
+    let mut client = Client::new(ClientConfig::default(), auth);
+    println!("Pulling image manifest and image config");
+    let meta = client.pull_image_manifest_and_config(reference, None, None)?;
+
+    let layout = OciLayoutBuilder::default()
+        .image_layout_version("1.0.0")
+        .build()?;
+    let manifest_descriptor = Descriptor::new(
+        MediaType::ImageManifest,
+        meta.manifest.raw.len() as u64,
+        meta.manifest.digest.clone(),
+    );
+    let index = ImageIndexBuilder::default()
+        .schema_version(2u32)
+        .manifests([manifest_descriptor])
+        .build()?;
+
+    let oci_tar_file = File::create(&tar_path)?;
+    let mut tar = tar::Builder::new(oci_tar_file);
+
+    try_block!({
+        let mut layout_header = tar::Header::new_old();
+        let mut layout_entry = tar.append_writer(&mut layout_header, "oci-layout")?;
+        layout.to_writer(&mut layout_entry)?;
+        layout_entry.finish()?;
+
+        let mut index_header = tar::Header::new_old();
+        let mut index_entry = tar.append_writer(&mut index_header, "index.json")?;
+        index.to_writer(&mut index_entry)?;
+        index_entry.finish()?;
+
+        let mut manifest_header = tar::Header::new_old();
+        manifest_header.set_size(meta.manifest.raw.len() as u64);
+        manifest_header.set_cksum();
+        tar.append_data(
+            &mut manifest_header,
+            format!(
+                "blobs/{}/{}",
+                meta.manifest.digest.algorithm(),
+                meta.manifest.digest.digest()
+            ),
+            &meta.manifest.raw[..],
+        )?;
+
+        let mut config_header = tar::Header::new_old();
+        config_header.set_size(meta.config.raw.len() as u64);
+        config_header.set_cksum();
+        tar.append_data(
+            &mut config_header,
+            format!(
+                "blobs/{}/{}",
+                meta.config.digest.algorithm(),
+                meta.config.digest.digest()
+            ),
+            &meta.config.raw[..],
+        )?;
+
+        for layer in meta.manifest.manifest.layers() {
+            let layer_digest = layer.digest();
+            println!("Pulling blob {layer_digest}");
+            let mut layer_header = tar::Header::new_old();
+            let mut layer_entry = tar.append_writer(
+                &mut layer_header,
+                format!(
+                    "blobs/{}/{}",
+                    layer_digest.algorithm(),
+                    layer_digest.digest()
+                ),
+            )?;
+            client.pull_blob(reference, layer, &mut layer_entry)?;
+            layer_entry.finish()?;
+        }
+
+        Ok(tar.finish()?)
+    })
+    .inspect_err(|_| {
+        drop(tar);
+        let _ = remove_file(tar_path);
+    })
+}
-- 
2.47.3





  parent reply	other threads:[~2026-11-12 14:15 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-12 14:10 [PATCH container/manager/proxmox{,-perl-rs}/storage 00/26] oci: add native registry client and prepare for OverlayFS Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox-perl-rs 01/26] pve-rs: oci: update doc comment of parse_and_extract_image Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 02/26] oci: rename error when no manifest can be selected Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 03/26] oci: add `os` parameter to parse_and_extract_image Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox-perl-rs 04/26] pve-rs: " Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 05/26] oci: add a digest helper module Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 06/26] oci: reduce redundant layer decompression during extraction Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 07/26] oci: factor out parsing and extraction into modules Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 08/26] oci: explicitly set mtime of directories when extracting layer Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 09/26] oci: add a registry client Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 10/26] oci: add a public list_repository_tags function Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox-perl-rs 11/26] pve-rs: oci: expose list_repository_tags Filip Schauer
2026-11-12 14:10 ` [PATCH manager 12/26] use proxmox-oci instead of skopeo for listing tags from OCI registries Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 13/26] oci: rename parse_and_extract_image to be tar-specific Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox-perl-rs 14/26] pve-rs: " Filip Schauer
2026-11-12 14:10 ` [PATCH container 15/26] oci create: " Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 16/26] oci: rename ProxmoxOciError to ParseAndExtractTarError Filip Schauer
2026-11-12 14:10 ` Filip Schauer [this message]
2026-11-12 14:10 ` [PATCH proxmox-perl-rs 18/26] pve-rs: oci: expose pull_image_as_tar Filip Schauer
2026-11-12 14:10 ` [PATCH storage 19/26] use proxmox-oci instead of skopeo for pulling from OCI registries Filip Schauer
2026-11-12 14:10 ` [PATCH storage 20/26] api: oci image pull: fix temp file cleanup on task stop Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 21/26] oci: add a public pull_image_to_oci_storage function Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox-perl-rs 22/26] pve-rs: oci: expose pull_image_to_oci_storage Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 23/26] fix #7058: oci: add compatibility for Docker Image Manifest V2 Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 24/26] oci: include media type in ParseError::WrongMediaType Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox 25/26] oci: add public functions for removing OCI images Filip Schauer
2026-11-12 14:10 ` [PATCH proxmox-perl-rs 26/26] pve-rs: oci: expose " Filip Schauer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261112141109.137298-18-f.schauer@proxmox.com \
    --to=f.schauer@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal