export-tar/import-tar: support for POSIX ACLs (PAX format)

Implemented handling of POSIX access and default ACLs in tar files.
New keys, `SCHILY.acl.access` and `SCHILY.acl.default`, are used
to store these ACLs in the tar PAX headers.

Author: ThomasWaldmann

src/borg/archive.py

@@ -1566,6 +1566,12 @@ def s_to_ns(s):
                         bkey = key.encode("utf-8", errors="surrogateescape")
                         bvalue = value.encode("utf-8", errors="surrogateescape")
                         xattrs[bkey] = bvalue
+                    elif key == SCHILY_ACL_ACCESS:
+                        # Process POSIX access ACL
+                        item.acl_access = value.encode("utf-8", errors="surrogateescape")
+                    elif key == SCHILY_ACL_DEFAULT:
+                        # Process POSIX default ACL
+                        item.acl_default = value.encode("utf-8", errors="surrogateescape")
                 if xattrs:
                     item.xattrs = xattrs
         yield item, status

src/borg/archiver/tar_cmds.py

@@ -216,6 +216,13 @@ def item_to_paxheaders(format, item):
                     key = SCHILY_XATTR + bkey.decode("utf-8", errors="surrogateescape")
                     value = bvalue.decode("utf-8", errors="surrogateescape")
                     ph[key] = value
+            # Add POSIX access and default ACL if present
+            acl_access = item.get("acl_access")
+            if acl_access is not None:
+                ph[SCHILY_ACL_ACCESS] = acl_access.decode("utf-8", errors="surrogateescape")
+            acl_default = item.get("acl_default")
+            if acl_default is not None:
+                ph[SCHILY_ACL_DEFAULT] = acl_default.decode("utf-8", errors="surrogateescape")
             if format == "BORG":  # BORG format additions
                 ph["BORG.item.version"] = "1"
                 # BORG.item.meta - just serialize all metadata we have:

src/borg/constants.py

@@ -125,6 +125,8 @@
 
 # tar related
 SCHILY_XATTR = "SCHILY.xattr."  # xattr key prefix in tar PAX headers
+SCHILY_ACL_ACCESS = "SCHILY.acl.access"  # POSIX access ACL in tar PAX headers
+SCHILY_ACL_DEFAULT = "SCHILY.acl.default"  # POSIX default ACL in tar PAX headers
 
 # special tags
 # @PROT protects archives against accidential deletion or modification by delete, prune or recreate.

src/borg/testsuite/archiver/tar_cmds_test.py

@@ -10,6 +10,8 @@
 from . import assert_dirs_equal, _extract_hardlinks_setup, cmd, requires_hardlinks, RK_ENCRYPTION
 from . import create_test_files, create_regular_file
 from . import generate_archiver_tests
+from ...platform import acl_get, acl_set
+from ..platform.platform_test import skipif_not_linux, skipif_acls_not_working
 
 pytest_generate_tests = lambda metafunc: generate_archiver_tests(metafunc, kinds="local,remote,binary")  # NOQA
 
@@ -269,3 +271,89 @@ def test_roundtrip_pax_xattrs(archivers, request):
         extracted_path = os.path.abspath("input/file")
         xa_value_extracted = xattr.getxattr(extracted_path.encode(), xa_key)
     assert xa_value_extracted == xa_value
+
+
+@skipif_not_linux
+@skipif_acls_not_working
+def test_acl_roundtrip(archivers, request):
+    """Test the complete workflow for POSIX ACLs with export-tar and import-tar.
+
+    This test follows the workflow:
+    1. set filesystem ACLs
+    2. create a Borg archive
+    3. export-tar this archive
+    4. import-tar the resulting tar file
+    5. extract the imported archive
+    6. check the expected ACLs in the filesystem
+    """
+    archiver = request.getfixturevalue(archivers)
+
+    # Define helper functions for working with ACLs
+    def get_acl(path):
+        item = {}
+        acl_get(path, item, os.stat(path))
+        return item
+
+    def set_acl(path, access=None, default=None):
+        item = {"acl_access": access, "acl_default": default}
+        acl_set(path, item)
+
+    # Define example ACLs
+    ACCESS_ACL = b"user::rw-\nuser:root:rw-:0\ngroup::r--\ngroup:root:r--:0\nmask::rw-\nother::r--"
+    DEFAULT_ACL = b"user::rw-\nuser:root:r--:0\ngroup::r--\ngroup:root:r--:0\nmask::rw-\nother::r--"
+
+    # 1. Set filesystem ACLs
+    # Create test files with ACLs
+    create_regular_file(archiver.input_path, "file")
+    os.mkdir(os.path.join(archiver.input_path, "dir"))
+
+    file_path = os.path.join(archiver.input_path, "file")
+    dir_path = os.path.join(archiver.input_path, "dir")
+
+    # Set ACLs on the test files
+    try:
+        set_acl(file_path, access=ACCESS_ACL)
+        set_acl(dir_path, access=ACCESS_ACL, default=DEFAULT_ACL)
+    except OSError as e:
+        pytest.skip(f"Failed to set ACLs: {e}")
+
+    file_acl = get_acl(file_path)
+    dir_acl = get_acl(dir_path)
+
+    if not file_acl.get("acl_access") or not dir_acl.get("acl_access") or not dir_acl.get("acl_default"):
+        pytest.skip("ACLs not supported or not working correctly")
+
+    # 2. Create a Borg archive
+    cmd(archiver, "repo-create", "--encryption=none")
+    cmd(archiver, "create", "original", "input")
+
+    # 3. export-tar this archive to a tar file
+    cmd(archiver, "export-tar", "original", "acls.tar", "--tar-format=PAX")
+
+    # 4. import-tar the resulting tar file
+    cmd(archiver, "import-tar", "imported", "acls.tar")
+
+    # 5. Extract the imported archive
+    with changedir(archiver.output_path):
+        cmd(archiver, "extract", "imported")
+
+        # 6. Check the expected ACLs in the filesystem
+        extracted_file_path = os.path.abspath("input/file")
+        extracted_dir_path = os.path.abspath("input/dir")
+
+        extracted_file_acl = get_acl(extracted_file_path)
+        extracted_dir_acl = get_acl(extracted_dir_path)
+
+        # Check that access ACLs were preserved
+        assert "acl_access" in extracted_file_acl
+        assert extracted_file_acl["acl_access"] == file_acl["acl_access"]
+        assert b"user:root:rw-" in file_acl["acl_access"]
+
+        assert "acl_access" in extracted_dir_acl
+        assert extracted_dir_acl["acl_access"] == dir_acl["acl_access"]
+        assert b"user:root:rw-" in dir_acl["acl_access"]
+
+        # Check that default ACLs were preserved for directories
+        assert "acl_default" in extracted_dir_acl
+        assert extracted_dir_acl["acl_default"] == dir_acl["acl_default"]
+        assert b"user:root:r--" in dir_acl["acl_default"]