dissect.volume 3.14.dev2__tar.gz → 3.14.dev4__tar.gz

dissect_volume-3.14.dev4/.gitattributes

@@ -0,0 +1 @@
+tests/_data/** filter=lfs diff=lfs merge=lfs -text

{dissect_volume-3.14.dev2 → dissect_volume-3.14.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dissect.volume
-Version: 3.14.dev2
+Version: 3.14.dev4
 Summary: A Dissect module implementing a parser for different disk volume and partition systems, for example LVM2, GPT and MBR
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

{dissect_volume-3.14.dev2 → dissect_volume-3.14.dev4}/dissect/volume/lvm/c_lvm2.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dissect.cstruct import cstruct
 
 lvm_def = """

{dissect_volume-3.14.dev2 → dissect_volume-3.14.dev4}/dissect/volume/md/c_md.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dissect.cstruct import cstruct
 
 md_def = """

{dissect_volume-3.14.dev2 → dissect_volume-3.14.dev4}/dissect/volume/md/md.py

@@ -143,14 +143,23 @@ class MDPhysicalDisk(PhysicalDisk):
         super().__init__(fh, self.data_offset * SECTOR_SIZE, self.data_size * SECTOR_SIZE)
 
 
-def find_super_block(fh: BinaryIO) -> tuple[int, int, int]:
-    # Super block can start at a couple of places, depending on version
-    # Just try them all until we find one
+def find_super_block(fh: BinaryIO) -> tuple[int | None, int | None, int | None]:
+    """Find the super block of an MD device.
 
-    size = fh.size if hasattr(fh, "size") else fh.seek(0, io.SEEK_END)
+    Args:
+        fh: The file-like object to search for the super block.
+
+    Returns:
+        A tuple containing the sector, major version, and minor version of the super block, or a
+        tuple of ``None`` if no super block was found.
+    """
+
+    size = fh.size if (hasattr(fh, "size") and fh.size is not None) else fh.seek(0, io.SEEK_END)
     size //= SECTOR_SIZE
 
-    possible_offsets = [
+    # Super block can start at a couple of places, depending on version
+    # Just try them all until we find one
+    possible_sectors = [
         # 0.90.0
         (size & ~(c_md.MD_RESERVED_SECTORS - 1)) - c_md.MD_RESERVED_SECTORS,
         # Major version 1
@@ -162,16 +171,18 @@ def find_super_block(fh: BinaryIO) -> tuple[int, int, int]:
         8,
     ]
 
-    for offset in possible_offsets:
-        fh.seek(offset * SECTOR_SIZE)
+    for sector in possible_sectors:
+        if sector < 0:
+            continue
 
+        fh.seek(sector * SECTOR_SIZE)
         peek = fh.read(12)
         if len(peek) != 12:
             continue
 
         magic, major, minor = struct.unpack("<3I", peek)
         if magic == c_md.MD_SB_MAGIC:
-            return offset, major, minor
+            return sector, major, minor
 
     return None, None, None
 

{dissect_volume-3.14.dev2 → dissect_volume-3.14.dev4}/dissect/volume/vinum/config.py

@@ -356,6 +356,8 @@ def tokenize(line: bytes) -> iter[bytes]:
 
 
 class VinumConfigs(TypedDict):
+    """Vinum configurations."""
+
     volumes: list[Volume]
     plexes: list[Plex]
     sds: list[SD]
@@ -376,7 +378,7 @@ def parse_vinum_config(config_time: datetime, config: bytes) -> VinumConfigs:
 
     Parsing forgiveness and strictness is implemented in the same way as in the vinum kernel code:
 
-    Lines with an unknown configuration "type" (not b"volume", b"plex" or b"sd"), are ignored.
+    Lines with an unknown configuration ``type`` (not ``volume``, ``plex`` or ``sd``), are ignored.
 
     Lines that fail to parse due to:
       - no name present

{dissect_volume-3.14.dev2 → dissect_volume-3.14.dev4}/dissect/volume/vinum/vinum.py

@@ -73,6 +73,8 @@ DefaultByName = defaultdict[bytes, T]
 
 
 class Config(TypedDict):
+    """Configuration."""
+
     volumes: ByName[Volume]
     plexes: ByName[Plex]
     sds: ByName[SD]

{dissect_volume-3.14.dev2 → dissect_volume-3.14.dev4}/dissect.volume.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dissect.volume
-Version: 3.14.dev2
+Version: 3.14.dev4
 Summary: A Dissect module implementing a parser for different disk volume and partition systems, for example LVM2, GPT and MBR
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

dissect_volume-3.14.dev4/dissect.volume.egg-info/SOURCES.txt

@@ -0,0 +1,137 @@
+.git-blame-ignore-revs
+.gitattributes
+COPYRIGHT
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+tox.ini
+dissect.volume.egg-info/PKG-INFO
+dissect.volume.egg-info/SOURCES.txt
+dissect.volume.egg-info/dependency_links.txt
+dissect.volume.egg-info/requires.txt
+dissect.volume.egg-info/top_level.txt
+dissect/volume/__init__.py
+dissect/volume/exceptions.py
+dissect/volume/ldm.py
+dissect/volume/vss.py
+dissect/volume/ddf/__init__.py
+dissect/volume/ddf/c_ddf.py
+dissect/volume/ddf/ddf.py
+dissect/volume/disk/__init__.py
+dissect/volume/disk/disk.py
+dissect/volume/disk/partition.py
+dissect/volume/disk/schemes/__init__.py
+dissect/volume/disk/schemes/apm.py
+dissect/volume/disk/schemes/bsd.py
+dissect/volume/disk/schemes/gpt.py
+dissect/volume/disk/schemes/mbr.py
+dissect/volume/dm/__init__.py
+dissect/volume/dm/btree.py
+dissect/volume/dm/c_dm.py
+dissect/volume/dm/thin.py
+dissect/volume/lvm/__init__.py
+dissect/volume/lvm/c_lvm2.py
+dissect/volume/lvm/lvm2.py
+dissect/volume/lvm/metadata.py
+dissect/volume/lvm/physical.py
+dissect/volume/md/__init__.py
+dissect/volume/md/c_md.py
+dissect/volume/md/md.py
+dissect/volume/raid/__init__.py
+dissect/volume/raid/raid.py
+dissect/volume/raid/stream.py
+dissect/volume/vinum/__init__.py
+dissect/volume/vinum/c_vinum.py
+dissect/volume/vinum/config.py
+dissect/volume/vinum/vinum.py
+tests/__init__.py
+tests/conftest.py
+tests/test_apm.py
+tests/test_bsd.py
+tests/test_ddf.py
+tests/test_dm.py
+tests/test_gpt.py
+tests/test_lvm.py
+tests/test_mbr.py
+tests/test_md.py
+tests/test_vinum.py
+tests/test_vinum_config.py
+tests/_data/ddf/ddf-raid0-1.bin.gz
+tests/_data/ddf/ddf-raid0-2.bin.gz
+tests/_data/ddf/ddf-raid0-3.bin.gz
+tests/_data/ddf/ddf-raid0-raid1-1.bin.gz
+tests/_data/ddf/ddf-raid0-raid1-2.bin.gz
+tests/_data/ddf/ddf-raid1-1.bin.gz
+tests/_data/ddf/ddf-raid1-2.bin.gz
+tests/_data/ddf/ddf-raid10-1.bin.gz
+tests/_data/ddf/ddf-raid10-2.bin.gz
+tests/_data/ddf/ddf-raid10-3.bin.gz
+tests/_data/ddf/ddf-raid10-4.bin.gz
+tests/_data/ddf/ddf-raid4-1.bin.gz
+tests/_data/ddf/ddf-raid4-2.bin.gz
+tests/_data/ddf/ddf-raid5-1.bin.gz
+tests/_data/ddf/ddf-raid5-2.bin.gz
+tests/_data/ddf/ddf-raid5-3.bin.gz
+tests/_data/ddf/ddf-raid6-1.bin.gz
+tests/_data/ddf/ddf-raid6-2.bin.gz
+tests/_data/ddf/ddf-raid6-3.bin.gz
+tests/_data/ddf/ddf-raid6-4.bin.gz
+tests/_data/disk/apm.bin
+tests/_data/disk/bsd.bin
+tests/_data/disk/bsd64.bin.gz
+tests/_data/disk/gpt.bin
+tests/_data/disk/gpt_4k.bin
+tests/_data/disk/gpt_esxi.bin
+tests/_data/disk/gpt_hybrid.bin
+tests/_data/disk/gpt_no_name_xff.bin
+tests/_data/disk/mbr.bin
+tests/_data/dm/dm-thin-data.bin.gz
+tests/_data/dm/dm-thin-empty-data.bin.gz
+tests/_data/dm/dm-thin-empty-metadata.bin.gz
+tests/_data/dm/dm-thin-metadata.bin.gz
+tests/_data/lvm/lvm-mirror-1.bin.gz
+tests/_data/lvm/lvm-mirror-2.bin.gz
+tests/_data/lvm/lvm-thin.bin.gz
+tests/_data/lvm/lvm.bin.gz
+tests/_data/md/md-90-1.bin.gz
+tests/_data/md/md-90-2.bin.gz
+tests/_data/md/md-90-raid1-1.bin.gz
+tests/_data/md/md-90-raid1-2.bin.gz
+tests/_data/md/md-linear-1.bin.gz
+tests/_data/md/md-linear-2.bin.gz
+tests/_data/md/md-raid0-1.bin.gz
+tests/_data/md/md-raid0-2.bin.gz
+tests/_data/md/md-raid0-3.bin.gz
+tests/_data/md/md-raid1-1.bin.gz
+tests/_data/md/md-raid1-2.bin.gz
+tests/_data/md/md-raid10-1.bin.gz
+tests/_data/md/md-raid10-2.bin.gz
+tests/_data/md/md-raid4-1.bin.gz
+tests/_data/md/md-raid4-2.bin.gz
+tests/_data/md/md-raid4-3.bin.gz
+tests/_data/md/md-raid5-1.bin.gz
+tests/_data/md/md-raid5-2.bin.gz
+tests/_data/md/md-raid5-3.bin.gz
+tests/_data/md/md-raid6-1.bin.gz
+tests/_data/md/md-raid6-2.bin.gz
+tests/_data/md/md-raid6-3.bin.gz
+tests/_data/md/md-raid6-4.bin.gz
+tests/_data/vinum/vinum-concat_diska.bin.gz
+tests/_data/vinum/vinum-concat_diskb.bin.gz
+tests/_data/vinum/vinum-mirror_diska.bin.gz
+tests/_data/vinum/vinum-mirror_diskb.bin.gz
+tests/_data/vinum/vinum-raid5_diska.bin.gz
+tests/_data/vinum/vinum-raid5_diskb.bin.gz
+tests/_data/vinum/vinum-raid5_diskc.bin.gz
+tests/_data/vinum/vinum-raid5_diskd.bin.gz
+tests/_data/vinum/vinum-striped_diska.bin.gz
+tests/_data/vinum/vinum-striped_diskb.bin.gz
+tests/_data/vinum/vinum-stripedmirror_diska.bin.gz
+tests/_data/vinum/vinum-stripedmirror_diskb.bin.gz
+tests/_data/vinum/vinum-stripedmirror_diskc.bin.gz
+tests/_data/vinum/vinum-stripedmirror_diskd.bin.gz
+tests/_docs/Makefile
+tests/_docs/__init__.py
+tests/_docs/conf.py
+tests/_docs/index.rst

{dissect_volume-3.14.dev2/tests/docs → dissect_volume-3.14.dev4/tests/_docs}/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?= -jauto
+SPHINXOPTS    ?= -jauto -w $(BUILDDIR)/warnings.log --fail-on-warning
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = build

{dissect_volume-3.14.dev2/tests/docs → dissect_volume-3.14.dev4/tests/_docs}/conf.py

@@ -32,3 +32,8 @@ autodoc_typehints = "signature"
 autodoc_member_order = "groupwise"
 
 autosectionlabel_prefix_document = True
+
+suppress_warnings = [
+    # https://github.com/readthedocs/sphinx-autoapi/issues/285
+    "autoapi.python_import_resolution",
+]

dissect_volume-3.14.dev4/tests/conftest.py

@@ -0,0 +1,254 @@
+from __future__ import annotations
+
+import contextlib
+import gzip
+from pathlib import Path
+from typing import IO, TYPE_CHECKING, BinaryIO
+
+import pytest
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+
+def absolute_path(filename: str) -> Path:
+    return Path(__file__).parent / filename
+
+
+def open_file(name: str, mode: str = "rb") -> Iterator[IO]:
+    with absolute_path(name).open(mode) as fh:
+        yield fh
+
+
+def open_file_gz(name: str, mode: str = "rb") -> Iterator[IO]:
+    with gzip.GzipFile(absolute_path(name), mode) as fh:
+        yield fh
+
+
+def open_files_gz(names: list[str], mode: str = "rb") -> Iterator[list[gzip.GzipFile]]:
+    with contextlib.ExitStack() as stack:
+        yield [stack.enter_context(gzip.GzipFile(absolute_path(name), mode)) for name in names]
+
+
+@pytest.fixture
+def lvm() -> Iterator[BinaryIO]:
+    yield from open_file_gz("_data/lvm/lvm.bin.gz")
+
+
+@pytest.fixture
+def lvm_thin() -> Iterator[BinaryIO]:
+    yield from open_file_gz("_data/lvm/lvm-thin.bin.gz")
+
+
+@pytest.fixture
+def lvm_mirror() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/lvm/lvm-mirror-1.bin.gz", "_data/lvm/lvm-mirror-2.bin.gz"])
+
+
+@pytest.fixture
+def mbr() -> Iterator[BinaryIO]:
+    yield from open_file("_data/disk/mbr.bin")
+
+
+@pytest.fixture
+def gpt() -> Iterator[BinaryIO]:
+    yield from open_file("_data/disk/gpt.bin")
+
+
+@pytest.fixture
+def gpt_hybrid() -> Iterator[BinaryIO]:
+    yield from open_file("_data/disk/gpt_hybrid.bin")
+
+
+@pytest.fixture
+def gpt_4k() -> Iterator[BinaryIO]:
+    yield from open_file("_data/disk/gpt_4k.bin")
+
+
+@pytest.fixture
+def gpt_esxi() -> Iterator[BinaryIO]:
+    yield from open_file("_data/disk/gpt_esxi.bin")
+
+
+@pytest.fixture
+def gpt_no_name_xff() -> Iterator[BinaryIO]:
+    yield from open_file("_data/disk/gpt_no_name_xff.bin")
+
+
+@pytest.fixture
+def apm() -> Iterator[BinaryIO]:
+    yield from open_file("_data/disk/apm.bin")
+
+
+@pytest.fixture
+def bsd() -> Iterator[BinaryIO]:
+    yield from open_file("_data/disk/bsd.bin")
+
+
+@pytest.fixture
+def bsd64() -> Iterator[BinaryIO]:
+    yield from open_file_gz("_data/disk/bsd64.bin.gz")
+
+
+@pytest.fixture
+def dm_thin() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/dm/dm-thin-metadata.bin.gz", "_data/dm/dm-thin-data.bin.gz"])
+
+
+@pytest.fixture
+def dm_thin_empty() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/dm/dm-thin-empty-metadata.bin.gz", "_data/dm/dm-thin-empty-data.bin.gz"])
+
+
+@pytest.fixture
+def md_linear() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/md/md-linear-1.bin.gz", "_data/md/md-linear-2.bin.gz"])
+
+
+@pytest.fixture
+def md_raid0() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/md/md-raid0-1.bin.gz", "_data/md/md-raid0-2.bin.gz", "_data/md/md-raid0-3.bin.gz"])
+
+
+@pytest.fixture
+def md_raid1() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/md/md-raid1-1.bin.gz", "_data/md/md-raid1-2.bin.gz"])
+
+
+@pytest.fixture
+def md_raid4() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/md/md-raid4-1.bin.gz", "_data/md/md-raid4-2.bin.gz", "_data/md/md-raid4-3.bin.gz"])
+
+
+@pytest.fixture
+def md_raid5() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/md/md-raid5-1.bin.gz", "_data/md/md-raid5-2.bin.gz", "_data/md/md-raid5-3.bin.gz"])
+
+
+@pytest.fixture
+def md_raid6() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        [
+            "_data/md/md-raid6-1.bin.gz",
+            "_data/md/md-raid6-2.bin.gz",
+            "_data/md/md-raid6-3.bin.gz",
+            "_data/md/md-raid6-4.bin.gz",
+        ]
+    )
+
+
+@pytest.fixture
+def md_raid10() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/md/md-raid10-1.bin.gz", "_data/md/md-raid10-2.bin.gz"])
+
+
+@pytest.fixture
+def md_90_raid1() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/md/md-90-raid1-1.bin.gz", "_data/md/md-90-raid1-2.bin.gz"])
+
+
+@pytest.fixture
+def ddf_raid0() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        ["_data/ddf/ddf-raid0-1.bin.gz", "_data/ddf/ddf-raid0-2.bin.gz", "_data/ddf/ddf-raid0-3.bin.gz"]
+    )
+
+
+@pytest.fixture
+def ddf_raid1() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/ddf/ddf-raid1-1.bin.gz", "_data/ddf/ddf-raid1-2.bin.gz"])
+
+
+@pytest.fixture
+def ddf_raid0_raid1() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/ddf/ddf-raid0-raid1-1.bin.gz", "_data/ddf/ddf-raid0-raid1-2.bin.gz"])
+
+
+@pytest.fixture
+def ddf_raid4() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(["_data/ddf/ddf-raid4-1.bin.gz", "_data/ddf/ddf-raid4-2.bin.gz"])
+
+
+@pytest.fixture
+def ddf_raid5() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        ["_data/ddf/ddf-raid5-1.bin.gz", "_data/ddf/ddf-raid5-2.bin.gz", "_data/ddf/ddf-raid5-3.bin.gz"]
+    )
+
+
+@pytest.fixture
+def ddf_raid6() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        [
+            "_data/ddf/ddf-raid6-1.bin.gz",
+            "_data/ddf/ddf-raid6-2.bin.gz",
+            "_data/ddf/ddf-raid6-3.bin.gz",
+            "_data/ddf/ddf-raid6-4.bin.gz",
+        ]
+    )
+
+
+@pytest.fixture
+def ddf_raid10() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        [
+            "_data/ddf/ddf-raid10-1.bin.gz",
+            "_data/ddf/ddf-raid10-2.bin.gz",
+            "_data/ddf/ddf-raid10-3.bin.gz",
+            "_data/ddf/ddf-raid10-4.bin.gz",
+        ]
+    )
+
+
+@pytest.fixture
+def vinum_concat() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        [
+            "_data/vinum/vinum-concat_diska.bin.gz",
+            "_data/vinum/vinum-concat_diskb.bin.gz",
+        ]
+    )
+
+
+@pytest.fixture
+def vinum_mirror() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        [
+            "_data/vinum/vinum-mirror_diska.bin.gz",
+            "_data/vinum/vinum-mirror_diskb.bin.gz",
+        ]
+    )
+
+
+@pytest.fixture
+def vinum_raid5() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        [
+            "_data/vinum/vinum-raid5_diska.bin.gz",
+            "_data/vinum/vinum-raid5_diskb.bin.gz",
+            "_data/vinum/vinum-raid5_diskc.bin.gz",
+            "_data/vinum/vinum-raid5_diskd.bin.gz",
+        ]
+    )
+
+
+@pytest.fixture
+def vinum_striped() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        [
+            "_data/vinum/vinum-striped_diska.bin.gz",
+            "_data/vinum/vinum-striped_diskb.bin.gz",
+        ]
+    )
+
+
+@pytest.fixture
+def vinum_stripedmirror() -> Iterator[list[BinaryIO]]:
+    yield from open_files_gz(
+        [
+            "_data/vinum/vinum-stripedmirror_diska.bin.gz",
+            "_data/vinum/vinum-stripedmirror_diskb.bin.gz",
+            "_data/vinum/vinum-stripedmirror_diskc.bin.gz",
+            "_data/vinum/vinum-stripedmirror_diskd.bin.gz",
+        ]
+    )

{dissect_volume-3.14.dev2 → dissect_volume-3.14.dev4}/tests/test_md.py

@@ -1,10 +1,11 @@
 from __future__ import annotations
 
+from io import BytesIO
 from typing import BinaryIO
 
 import pytest
 
-from dissect.volume.md.md import MD
+from dissect.volume.md.md import MD, find_super_block
 from dissect.volume.raid.stream import RAID0Stream
 
 
@@ -61,3 +62,10 @@ def test_md_raid0_zones(md_raid0: list[BinaryIO]) -> None:
     assert fh.zones[1].zone_end == 5242880
     assert fh.zones[1].dev_start == 1048576
     assert len(fh.zones[1].devices) == 2
+
+
+def test_md_search_sb_none_size() -> None:
+    fh = BytesIO()
+    fh.size = None
+
+    assert find_super_block(fh) == (None, None, None)

{dissect_volume-3.14.dev2 → dissect_volume-3.14.dev4}/tox.ini

@@ -55,12 +55,12 @@ deps =
     sphinx-design
     furo
 commands =
-    make -C tests/docs clean
-    make -C tests/docs html
+    make -C tests/_docs clean
+    make -C tests/_docs html
 
 [testenv:docs-linkcheck]
 allowlist_externals = make
 deps = {[testenv:docs-build]deps}
 commands =
-    make -C tests/docs clean
-    make -C tests/docs linkcheck
+    make -C tests/_docs clean
+    make -C tests/_docs linkcheck

dissect_volume-3.14.dev2/.gitattributes

@@ -1,5 +0,0 @@
-tests/data/dm/* filter=lfs diff=lfs merge=lfs -text
-tests/data/md/* filter=lfs diff=lfs merge=lfs -text
-tests/data/ddf/* filter=lfs diff=lfs merge=lfs -text
-tests/data/lvm/* filter=lfs diff=lfs merge=lfs -text
-tests/data/vinum/* filter=lfs diff=lfs merge=lfs -text