[pbs-devel] [PATCH stable-2 proxmox-backup 2/2] client: pxar: bail on incompatible format versions

[Christian Ebner]

Implementing the change detection mode with reusable file payloads
required a breaking change in the pxar file format. Unfortunately,
there initial format does not encode a version for clients to check
compatibility to. Therefore, a pxar format version entry is
introduced in version 2 of the file format.

Add a compatibility check based on that entry also for the client,
making it possible to bail early when an incompatible archive is
encountered.

Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
---
 pbs-client/src/catalog_shell.rs | 2 +-
 pbs-client/src/pxar/extract.rs  | 3 +++
 pbs-client/src/pxar/tools.rs    | 7 ++++---
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/pbs-client/src/catalog_shell.rs b/pbs-client/src/catalog_shell.rs
index 98af5699..8bb2f3e0 100644
--- a/pbs-client/src/catalog_shell.rs
+++ b/pbs-client/src/catalog_shell.rs
@@ -767,7 +767,7 @@ impl Shell {
 
         let file = Self::walk_pxar_archive(&self.accessor, &mut stack).await?;
         std::io::stdout()
-            .write_all(crate::pxar::format_multi_line_entry(file.entry()).as_bytes())?;
+            .write_all(crate::pxar::format_multi_line_entry(file.entry())?.as_bytes())?;
         Ok(())
     }
 
diff --git a/pbs-client/src/pxar/extract.rs b/pbs-client/src/pxar/extract.rs
index f6c1991f..51b2c92c 100644
--- a/pbs-client/src/pxar/extract.rs
+++ b/pbs-client/src/pxar/extract.rs
@@ -119,6 +119,9 @@ where
             None => current_match,
         };
         match (did_match, entry.kind()) {
+            (_, EntryKind::Version(version)) => {
+                bail!("got format version {version}, incompatible with this client");
+            }
             (_, EntryKind::Directory) => {
                 callback(entry.path());
 
diff --git a/pbs-client/src/pxar/tools.rs b/pbs-client/src/pxar/tools.rs
index 844a0f73..f28289bd 100644
--- a/pbs-client/src/pxar/tools.rs
+++ b/pbs-client/src/pxar/tools.rs
@@ -146,12 +146,13 @@ pub fn format_single_line_entry(entry: &Entry) -> String {
     )
 }
 
-pub fn format_multi_line_entry(entry: &Entry) -> String {
+pub fn format_multi_line_entry(entry: &Entry) -> Result<String, Error> {
     let mode_string = mode_string(entry);
 
     let meta = entry.metadata();
 
     let (size, link, type_name) = match entry.kind() {
+        EntryKind::Version(version) => bail!("got incompatible format version {version}"),
         EntryKind::File { size, .. } => (format!("{}", *size), String::new(), "file"),
         EntryKind::Symlink(link) => (
             "0".to_string(),
@@ -185,7 +186,7 @@ pub fn format_multi_line_entry(entry: &Entry) -> String {
         Err(_) => std::borrow::Cow::Owned(format!("{:?}", entry.path())),
     };
 
-    format!(
+    Ok(format!(
         "  File: {}{}\n  \
            Size: {:<13} Type: {}\n\
          Access: ({:o}/{})  Uid: {:<5} Gid: {:<5}\n\
@@ -199,5 +200,5 @@ pub fn format_multi_line_entry(entry: &Entry) -> String {
         meta.stat.uid,
         meta.stat.gid,
         format_mtime(&meta.stat.mtime),
-    )
+    ))
 }
-- 
2.30.2