dissect.target 3.23.2.dev22__tar.gz → 3.23.2.dev23__tar.gz

{dissect_target-3.23.2.dev22 → dissect_target-3.23.2.dev23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.target
-Version: 3.23.2.dev22
+Version: 3.23.2.dev23
 Summary: This module ties all other Dissect modules together, it provides a programming API and command line tools which allow easy access to various data sources inside disk images or file collections (a.k.a. targets)
 Author-email: Dissect Team <dissect@fox-it.com>
 License-Expression: AGPL-3.0-or-later
@@ -39,6 +39,7 @@ Requires-Dist: dissect.archive<2,>=1; extra == "full"
 Requires-Dist: dissect.btrfs<2,>=1; extra == "full"
 Requires-Dist: dissect.cim<4,>=3; extra == "full"
 Requires-Dist: dissect.clfs<2,>=1; extra == "full"
+Requires-Dist: dissect.cramfs<2,>=1; extra == "full"
 Requires-Dist: dissect.esedb<4,>=3; extra == "full"
 Requires-Dist: dissect.etl<4,>=3; extra == "full"
 Requires-Dist: dissect.extfs<4,>=3; extra == "full"
@@ -65,6 +66,7 @@ Requires-Dist: dissect.archive[dev]<2.0.dev,>=1.0.dev; extra == "dev"
 Requires-Dist: dissect.btrfs[dev]<2.0.dev,>=1.0.dev; extra == "dev"
 Requires-Dist: dissect.cim[dev]<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.clfs[dev]<2.0.dev,>=1.0.dev; extra == "dev"
+Requires-Dist: dissect.cramfs[dev]<2.0.dev,>=1.0.dev; extra == "dev"
 Requires-Dist: dissect.cstruct<5.0.dev,>=4.0.dev; extra == "dev"
 Requires-Dist: dissect.esedb[dev]<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.etl[dev]<4.0.dev,>=3.0.dev; extra == "dev"

{dissect_target-3.23.2.dev22 → dissect_target-3.23.2.dev23}/dissect/target/filesystem.py

@@ -1764,6 +1764,7 @@ register("vmfs", "VmfsFilesystem")
 register("btrfs", "BtrfsFilesystem")
 register("exfat", "ExfatFilesystem")
 register("squashfs", "SquashFSFilesystem")
+register("cramfs", "CramfsFilesystem")
 register("jffs", "JffsFilesystem")
 register("qnxfs", "QnxFilesystem")
 register("zip", "ZipFilesystem")

dissect_target-3.23.2.dev23/dissect/target/filesystems/cramfs.py

@@ -0,0 +1,139 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, BinaryIO
+
+import dissect.cramfs as cramfs
+from dissect.cramfs.c_cramfs import c_cramfs
+
+from dissect.target.exceptions import (
+    FileNotFoundError,
+    FilesystemError,
+    IsADirectoryError,
+    NotADirectoryError,
+    NotASymlinkError,
+)
+from dissect.target.filesystem import Filesystem, FilesystemEntry
+from dissect.target.helpers import fsutil
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+    from dissect.cramfs import INode
+
+
+class CramfsFilesystem(Filesystem):
+    __type__ = "cramfs"
+
+    def __init__(self, fh: BinaryIO, *args, **kwargs):
+        super().__init__(fh, *args, **kwargs)
+        self.cramfs = cramfs.CramFS(fh)
+
+    @staticmethod
+    def _detect(fh: BinaryIO) -> bool:
+        """Detect a CramFS filesystem on a given file-like object."""
+        return int.from_bytes(fh.read(4), "little") == c_cramfs.CRAMFS_MAGIC
+
+    def get(self, path: str) -> FilesystemEntry:
+        return CramfsFilesystemEntry(self, path, self._get_node(path))
+
+    def _get_node(self, path: str, node: INode | None = None) -> INode:
+        """Returns an internal CramFS inode for a given path and optional relative inode."""
+        try:
+            return self.cramfs.get(path, node)
+        except cramfs.FileNotFoundError as e:
+            raise FileNotFoundError(path) from e
+        except cramfs.NotADirectoryError as e:
+            raise NotADirectoryError(path) from e
+        except cramfs.NotASymlinkError as e:
+            raise NotASymlinkError(path) from e
+        except cramfs.Error as e:
+            raise FileNotFoundError(path) from e
+
+
+class CramfsFilesystemEntry(FilesystemEntry):
+    fs: CramfsFilesystem
+    entry: INode
+
+    def get(self, path: str) -> FilesystemEntry:
+        full_path = fsutil.join(self.path, path, alt_separator=self.fs.alt_separator)
+        return CramfsFilesystemEntry(self.fs, full_path, self.fs._get_node(path, self.entry))
+
+    def open(self) -> BinaryIO:
+        """Returns file handle (file-like object)."""
+        if self.is_dir():
+            raise IsADirectoryError(self.path)
+        return self._resolve().entry.open()
+
+    def _iterdir(self) -> Iterator[INode]:
+        if not self.is_dir():
+            raise NotADirectoryError(self.path)
+
+        if self.is_symlink():
+            yield from self.readlink_ext().iterdir()
+        else:
+            yield from self.entry.iterdir()
+
+    def iterdir(self) -> Iterator[str]:
+        """List the directory contents of a directory. Returns a generator of strings."""
+        yield from (inode.name for inode in self._iterdir())
+
+    def scandir(self) -> Iterator[FilesystemEntry]:
+        """List the directory contents of this directory. Returns a generator of filesystem entries."""
+        yield from (self.get(entry.name) for entry in self._iterdir())
+
+    def is_dir(self, follow_symlinks: bool = True) -> bool:
+        """Return whether this entry is a directory."""
+        try:
+            return self._resolve(follow_symlinks=follow_symlinks).entry.is_dir()
+        except FilesystemError:
+            return False
+
+    def is_file(self, follow_symlinks: bool = True) -> bool:
+        """Return whether this entry is a file."""
+        try:
+            return self._resolve(follow_symlinks=follow_symlinks).entry.is_file()
+        except FilesystemError:
+            return False
+
+    def is_symlink(self) -> bool:
+        """Return whether this entry is a link."""
+        return self.entry.is_symlink()
+
+    def readlink(self) -> str:
+        """Read the link of the given path if it is a symlink. Returns a string."""
+        if not self.is_symlink():
+            raise NotASymlinkError(self.path)
+
+        return self.entry.link
+
+    def stat(self, follow_symlinks: bool = True) -> fsutil.stat_result:
+        """Return the stat information of this entry."""
+        return self._resolve(follow_symlinks=follow_symlinks).lstat()
+
+    def lstat(self) -> fsutil.stat_result:
+        """Return the stat information of the given path, without resolving links."""
+        node = self.entry
+
+        # mode, ino, dev, nlink, uid, gid, size, ..., blocksize, numblocks
+        st_info = [
+            node.mode,
+            node.offset,  # use inode offset as inode number
+            id(self.fs),  # device ID of the filesystem
+            1,  # cramfs inodes always have 1 nlinks
+            node.uid,
+            node.gid,
+            node.size,
+            0,  # cramfs inodes don't have timestamps
+            0,
+            0,
+            0,
+            0,
+            0,
+            0,
+            0,
+            0,
+            c_cramfs.CRAMFS_BLOCK_SIZE,
+            len(node.blocks),
+        ]
+
+        return fsutil.stat_result(st_info)

{dissect_target-3.23.2.dev22 → dissect_target-3.23.2.dev23}/dissect.target.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.target
-Version: 3.23.2.dev22
+Version: 3.23.2.dev23
 Summary: This module ties all other Dissect modules together, it provides a programming API and command line tools which allow easy access to various data sources inside disk images or file collections (a.k.a. targets)
 Author-email: Dissect Team <dissect@fox-it.com>
 License-Expression: AGPL-3.0-or-later
@@ -39,6 +39,7 @@ Requires-Dist: dissect.archive<2,>=1; extra == "full"
 Requires-Dist: dissect.btrfs<2,>=1; extra == "full"
 Requires-Dist: dissect.cim<4,>=3; extra == "full"
 Requires-Dist: dissect.clfs<2,>=1; extra == "full"
+Requires-Dist: dissect.cramfs<2,>=1; extra == "full"
 Requires-Dist: dissect.esedb<4,>=3; extra == "full"
 Requires-Dist: dissect.etl<4,>=3; extra == "full"
 Requires-Dist: dissect.extfs<4,>=3; extra == "full"
@@ -65,6 +66,7 @@ Requires-Dist: dissect.archive[dev]<2.0.dev,>=1.0.dev; extra == "dev"
 Requires-Dist: dissect.btrfs[dev]<2.0.dev,>=1.0.dev; extra == "dev"
 Requires-Dist: dissect.cim[dev]<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.clfs[dev]<2.0.dev,>=1.0.dev; extra == "dev"
+Requires-Dist: dissect.cramfs[dev]<2.0.dev,>=1.0.dev; extra == "dev"
 Requires-Dist: dissect.cstruct<5.0.dev,>=4.0.dev; extra == "dev"
 Requires-Dist: dissect.esedb[dev]<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.etl[dev]<4.0.dev,>=3.0.dev; extra == "dev"

{dissect_target-3.23.2.dev22 → dissect_target-3.23.2.dev23}/dissect.target.egg-info/SOURCES.txt

@@ -40,6 +40,7 @@ dissect/target/filesystems/btrfs.py
 dissect/target/filesystems/cb.py
 dissect/target/filesystems/config.py
 dissect/target/filesystems/cpio.py
+dissect/target/filesystems/cramfs.py
 dissect/target/filesystems/dir.py
 dissect/target/filesystems/exfat.py
 dissect/target/filesystems/extfs.py
@@ -478,6 +479,7 @@ tests/filesystems/test_btrfs.py
 tests/filesystems/test_cb.py
 tests/filesystems/test_config.py
 tests/filesystems/test_cpio.py
+tests/filesystems/test_cramfs.py
 tests/filesystems/test_dir.py
 tests/filesystems/test_exfat.py
 tests/filesystems/test_extfs.py

{dissect_target-3.23.2.dev22 → dissect_target-3.23.2.dev23}/dissect.target.egg-info/requires.txt

@@ -21,6 +21,7 @@ dissect.archive[dev]<2.0.dev,>=1.0.dev
 dissect.btrfs[dev]<2.0.dev,>=1.0.dev
 dissect.cim[dev]<4.0.dev,>=3.0.dev
 dissect.clfs[dev]<2.0.dev,>=1.0.dev
+dissect.cramfs[dev]<2.0.dev,>=1.0.dev
 dissect.cstruct<5.0.dev,>=4.0.dev
 dissect.esedb[dev]<4.0.dev,>=3.0.dev
 dissect.etl[dev]<4.0.dev,>=3.0.dev
@@ -52,6 +53,7 @@ dissect.archive<2,>=1
 dissect.btrfs<2,>=1
 dissect.cim<4,>=3
 dissect.clfs<2,>=1
+dissect.cramfs<2,>=1
 dissect.esedb<4,>=3
 dissect.etl<4,>=3
 dissect.extfs<4,>=3

{dissect_target-3.23.2.dev22 → dissect_target-3.23.2.dev23}/pyproject.toml

@@ -52,6 +52,7 @@ full = [
     "dissect.btrfs>=1,<2",
     "dissect.cim>=3,<4",
     "dissect.clfs>=1,<2",
+    "dissect.cramfs>=1,<2",
     "dissect.esedb>=3,<4",
     "dissect.etl>=3,<4",
     "dissect.extfs>=3,<4",
@@ -79,6 +80,7 @@ dev = [
     "dissect.btrfs[dev]>=1.0.dev,<2.0.dev",
     "dissect.cim[dev]>=3.0.dev,<4.0.dev",
     "dissect.clfs[dev]>=1.0.dev,<2.0.dev",
+    "dissect.cramfs[dev]>=1.0.dev,<2.0.dev",
     "dissect.cstruct>=4.0.dev,<5.0.dev",
     "dissect.esedb[dev]>=3.0.dev,<4.0.dev",
     "dissect.etl[dev]>=3.0.dev,<4.0.dev",

dissect_target-3.23.2.dev23/tests/filesystems/test_cramfs.py

@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+import gzip
+from typing import TYPE_CHECKING
+
+import pytest
+
+from dissect.target.filesystems.cramfs import CramfsFilesystem, CramfsFilesystemEntry, c_cramfs
+from tests._utils import absolute_path
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+
+def test_cramfs_detect() -> None:
+    """Test that CramFS filesystems are correctly detected."""
+    with gzip.open(absolute_path("_data/filesystems/cramfs/cramfs.bin.gz"), "rb") as fh:
+        assert CramfsFilesystem.detect(fh)
+        assert CramfsFilesystem(fh).cramfs
+
+
+@pytest.fixture
+def cramfs() -> Iterator[CramfsFilesystemEntry]:
+    with gzip.open(absolute_path("_data/filesystems/cramfs/cramfs.bin.gz"), "rb") as fh:
+        cramfs = CramfsFilesystem(fh)
+        yield cramfs
+
+
+@pytest.mark.parametrize(
+    ("entry_path", "expected_blocks"),
+    [
+        ("/bin", 1),
+        ("/home", 0),
+        ("/bin/dvrbox", 6),
+    ],
+)
+def test_cramfs_stat(cramfs: CramfsFilesystem, entry_path: str, expected_blocks: int) -> None:
+    """Test consistency in ``stat()`` results."""
+    cramfs_entry = cramfs.get(entry_path)
+    inode = cramfs_entry.entry
+
+    stat = cramfs_entry.stat()
+    assert stat.st_mode == inode.mode
+    assert stat.st_ino == inode.offset
+    assert stat.st_dev == id(cramfs_entry.fs)
+    assert stat.st_nlink == 1
+    assert stat.st_uid == inode.uid
+    assert stat.st_gid == inode.gid
+    assert stat.st_size == inode.size
+    assert stat.st_blksize == c_cramfs.CRAMFS_BLOCK_SIZE
+    assert stat.st_blocks == expected_blocks
+
+
+def test_cramfs_symlinks(cramfs: CramfsFilesystem) -> None:
+    symlink = cramfs.get("/bin/macGuarder")
+    target = cramfs.get("/bin/dvrbox")
+
+    assert symlink.is_file()
+    assert symlink.is_symlink()
+    assert symlink.name == "macGuarder"
+    assert symlink.readlink() == "./dvrbox"
+    assert symlink.readlink_ext().name == target.name
+
+    assert target.is_file()
+    assert target.name == "dvrbox"
+
+
+def test_cramfs_dir(cramfs: CramfsFilesystem) -> None:
+    dir = cramfs.get("/etc/init.d")
+    assert dir.is_dir()
+
+    entries = list(dir.iterdir())
+    assert len(entries) == 2
+    assert sorted(entries) == sorted(["dnode", "rcS"])
+
+    entries = [entry.name for entry in dir.scandir()]
+    assert dir.is_dir()
+    assert len(entries) == 2
+    assert sorted(entries) == sorted(["dnode", "rcS"])