diff --git a/app-forensics/libfsxfs/Manifest b/app-forensics/libfsxfs/Manifest new file mode 100644 index 000000000..72ce84cf2 --- /dev/null +++ b/app-forensics/libfsxfs/Manifest @@ -0,0 +1,2 @@ +DIST libfsxfs-experimental-20220706.tar.gz 1739918 BLAKE2B 45ec1f1741bb68a234008d1a4d8d35acdcd69a5e4940da9cbe3c576b5fb5a3a882202fda155a67e25aab727840d4b02fd3f443643619a3c986c1f81cd2355463 SHA512 cfba8660bf9100f02c757e396317367ead5754670c0dc5d3d5529ac4ecedf24938414a26c179fe783c837f58176674882b80bb6e6f70bd5f106641eb4e5587ee +DIST libfsxfs-experimental-20220829.tar.gz 1733183 BLAKE2B a3f40833a724b1c2c2c8b78107473dd30141f5659a1ce511cd906afab607384e570ec7a01801bb9f04ceb09d783bd3a7a1a42580283fc9270d95a6fd90a36a75 SHA512 b751b657a1fa33671cf426dd2873bfc7d1e7f323c5f27d0691bf8fca65d076fc009cb8725f194e7335b43a5a6ca094cea7bbb201cf3b89ec43c60aece4b5ebda diff --git a/app-forensics/libfsxfs/files/2022-11-pyfsxfs_test_volume.py b/app-forensics/libfsxfs/files/2022-11-pyfsxfs_test_volume.py new file mode 100644 index 000000000..e379c6f6a --- /dev/null +++ b/app-forensics/libfsxfs/files/2022-11-pyfsxfs_test_volume.py @@ -0,0 +1,294 @@ +#!/usr/bin/env python +# +# Python-bindings volume type test script +# +# Copyright (C) 2020-2022, Joachim Metz +# +# Refer to AUTHORS for acknowledgements. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with this program. If not, see . + +import argparse +import os +import sys +import unittest + +import pyfsxfs + + +class DataRangeFileObject(object): + """File-like object that maps an in-file data range.""" + + def __init__(self, path, range_offset, range_size): + """Initializes a file-like object. + + Args: + path (str): path of the file that contains the data range. + range_offset (int): offset where the data range starts. + range_size (int): size of the data range starts, or None to indicate + the range should continue to the end of the parent file-like object. + """ + super(DataRangeFileObject, self).__init__() + self._current_offset = 0 + self._file_object = open(path, "rb") + self._range_offset = range_offset + self._range_size = range_size + + def __enter__(self): + """Enters a with statement.""" + return self + + def __exit__(self, unused_type, unused_value, unused_traceback): + """Exits a with statement.""" + return + + def close(self): + """Closes the file-like object.""" + if self._file_object: + self._file_object.close() + self._file_object = None + + def get_offset(self): + """Retrieves the current offset into the file-like object. + + Returns: + int: current offset in the data range. + """ + return self._current_offset + + def get_size(self): + """Retrieves the size of the file-like object. + + Returns: + int: size of the data range. + """ + return self._range_size + + def read(self, size=None): + """Reads a byte string from the file-like object at the current offset. + + The function will read a byte string of the specified size or + all of the remaining data if no size was specified. + + Args: + size (Optional[int]): number of bytes to read, where None is all + remaining data. + + Returns: + bytes: data read. + + Raises: + IOError: if the read failed. + """ + if (self._range_offset < 0 or + (self._range_size is not None and self._range_size < 0)): + raise IOError("Invalid data range.") + + if self._current_offset < 0: + raise IOError( + "Invalid current offset: {0:d} value less than zero.".format( + self._current_offset)) + + if (self._range_size is not None and + self._current_offset >= self._range_size): + return b"" + + if size is None: + size = self._range_size + if self._range_size is not None and self._current_offset + size > self._range_size: + size = self._range_size - self._current_offset + + self._file_object.seek( + self._range_offset + self._current_offset, os.SEEK_SET) + + data = self._file_object.read(size) + + self._current_offset += len(data) + + return data + + def seek(self, offset, whence=os.SEEK_SET): + """Seeks to an offset within the file-like object. + + Args: + offset (int): offset to seek to. + whence (Optional(int)): value that indicates whether offset is an absolute + or relative position within the file. + + Raises: + IOError: if the seek failed. + """ + if self._current_offset < 0: + raise IOError( + "Invalid current offset: {0:d} value less than zero.".format( + self._current_offset)) + + if whence == os.SEEK_CUR: + offset += self._current_offset + elif whence == os.SEEK_END: + offset += self._range_size + elif whence != os.SEEK_SET: + raise IOError("Unsupported whence.") + if offset < 0: + raise IOError("Invalid offset value less than zero.") + + self._current_offset = offset + + +class VolumeTypeTests(unittest.TestCase): + """Tests the volume type.""" + + def test_signal_abort(self): + """Tests the signal_abort function.""" + fsxfs_volume = pyfsxfs.volume() + + fsxfs_volume.signal_abort() + + def test_open(self): + """Tests the open function.""" + test_source = unittest.source + if not test_source: + raise unittest.SkipTest("missing source") + + if unittest.offset: + raise unittest.SkipTest("source defines offset") + + fsxfs_volume = pyfsxfs.volume() + + fsxfs_volume.open(test_source) + + with self.assertRaises(IOError): + fsxfs_volume.open(test_source) + + fsxfs_volume.close() + + with self.assertRaises(TypeError): + fsxfs_volume.open(None) + + with self.assertRaises(ValueError): + fsxfs_volume.open(test_source, mode="w") + + def test_open_file_object(self): + """Tests the open_file_object function.""" + test_source = unittest.source + if not test_source: + raise unittest.SkipTest("missing source") + + if not os.path.isfile(test_source): + raise unittest.SkipTest("source not a regular file") + + fsxfs_volume = pyfsxfs.volume() + + with DataRangeFileObject( + test_source, unittest.offset or 0, None) as file_object: + + fsxfs_volume.open_file_object(file_object) + + with self.assertRaises(IOError): + fsxfs_volume.open_file_object(file_object) + + fsxfs_volume.close() + + with self.assertRaises(TypeError): + fsxfs_volume.open_file_object(None) + + with self.assertRaises(ValueError): + fsxfs_volume.open_file_object(file_object, mode="w") + + def test_close(self): + """Tests the close function.""" + test_source = unittest.source + if not test_source: + raise unittest.SkipTest("missing source") + + fsxfs_volume = pyfsxfs.volume() + + with self.assertRaises(IOError): + fsxfs_volume.close() + + def test_open_close(self): + """Tests the open and close functions.""" + test_source = unittest.source + if not test_source: + return + + if unittest.offset: + raise unittest.SkipTest("source defines offset") + + fsxfs_volume = pyfsxfs.volume() + + # Test open and close. + fsxfs_volume.open(test_source) + fsxfs_volume.close() + + # Test open and close a second time to validate clean up on close. + fsxfs_volume.open(test_source) + fsxfs_volume.close() + + if os.path.isfile(test_source): + with open(test_source, "rb") as file_object: + + # Test open_file_object and close. + fsxfs_volume.open_file_object(file_object) + fsxfs_volume.close() + + # Test open_file_object and close a second time to validate clean up on close. + fsxfs_volume.open_file_object(file_object) + fsxfs_volume.close() + + # Test open_file_object and close and dereferencing file_object. + fsxfs_volume.open_file_object(file_object) + del file_object + fsxfs_volume.close() + + def test_get_label(self): + """Tests the get_label function and label property.""" + test_source = unittest.source + if not test_source: + raise unittest.SkipTest("missing source") + + fsxfs_volume = pyfsxfs.volume() + + with DataRangeFileObject( + test_source, unittest.offset or 0, None) as file_object: + + fsxfs_volume = pyfsxfs.volume() + fsxfs_volume.open_file_object(file_object) + + label = fsxfs_volume.get_label() + self.assertIsNotNone(label) + + self.assertIsNotNone(fsxfs_volume.label) + + fsxfs_volume.close() + + +if __name__ == "__main__": + argument_parser = argparse.ArgumentParser() + + argument_parser.add_argument( + "-o", "--offset", dest="offset", action="store", default=None, + type=int, help="offset of the source file.") + + argument_parser.add_argument( + "source", nargs="?", action="store", metavar="PATH", + default=None, help="path of the source file.") + + options, unknown_options = argument_parser.parse_known_args() + unknown_options.insert(0, sys.argv[0]) + + setattr(unittest, "offset", options.offset) + setattr(unittest, "source", options.source) + + unittest.main(argv=unknown_options, verbosity=2) diff --git a/app-forensics/libfsxfs/libfsxfs-20220706.ebuild b/app-forensics/libfsxfs/libfsxfs-20220706.ebuild new file mode 100644 index 000000000..8e98e94e2 --- /dev/null +++ b/app-forensics/libfsxfs/libfsxfs-20220706.ebuild @@ -0,0 +1,73 @@ +# Copyright 1999-2019 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI=8 + +PYTHON_COMPAT=( python3_{10..11} ) +inherit autotools python-single-r1 + +DESCRIPTION="Library and tools to access the SGI X File System (XFS)" +HOMEPAGE="https://github.com/libyal/libfsxfs" +SRC_URI="https://github.com/libyal/libfsxfs/releases/download/${PV}/${PN}-experimental-${PV}.tar.gz" + +LICENSE="LGPL-3" +SLOT="0" +KEYWORDS="amd64 ~arm64 x86" +IUSE="nls unicode python +fuse +threads debug" + +REQUIRED_USE=" + python? ( ${PYTHON_REQUIRED_USE} ) +" + +DEPEND=" + nls? ( + virtual/libiconv + virtual/libintl + ) + python? ( dev-lang/python:* ) + app-forensics/libbfio[nls=,unicode=,threads=] + dev-libs/libcdata[nls=] + dev-libs/libcerror[nls=] + dev-libs/libcfile[nls=,unicode=] + dev-libs/libclocale[nls=,unicode=] + dev-libs/libcnotify[nls=] + dev-libs/libcpath[nls=,unicode=] + dev-libs/libcsplit[nls=,unicode=] + dev-libs/libcthreads[nls=] + dev-libs/libfcache[nls=] + dev-libs/libfdata[nls=,threads=] + dev-libs/libfdatetime[nls=] + dev-libs/libfguid[nls=] + dev-libs/libhmac[nls=,unicode=,threads=] + dev-libs/libuna[nls=,unicode=] + dev-libs/openssl +" +RDEPEND=" + ${DEPEND} + python? ( ${PYTHON_DEPS} ) + fuse? ( sys-fs/fuse ) +" + +src_prepare() { + # workaround for missing files in distribution package, see https://github.com/libyal/libfsxfs/issues/9 + # should not be required any more in releases after 20220829 + cp "${FILESDIR}/2022-11-pyfsxfs_test_volume.py" "${WORKDIR}/${P}/tests/pyfsxfs_test_volume.py" + + eautoreconf + eapply_user +} + +src_configure() { + econf \ + $(use_enable nls) \ + $(use_with nls libiconv-prefix) \ + $(use_with nls libintl-prefix) \ + $(use_enable unicode wide-character-type) \ + $(use_enable debug verbose-output ) \ + $(use_enable debug debug-output ) \ + $(use_enable threads multi-threading-support) \ + $(use_enable python) \ + $(use_enable python python3) \ + $(use_with fuse libfuse) \ + +} diff --git a/app-forensics/libfsxfs/libfsxfs-20220829.ebuild b/app-forensics/libfsxfs/libfsxfs-20220829.ebuild new file mode 100644 index 000000000..8e98e94e2 --- /dev/null +++ b/app-forensics/libfsxfs/libfsxfs-20220829.ebuild @@ -0,0 +1,73 @@ +# Copyright 1999-2019 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI=8 + +PYTHON_COMPAT=( python3_{10..11} ) +inherit autotools python-single-r1 + +DESCRIPTION="Library and tools to access the SGI X File System (XFS)" +HOMEPAGE="https://github.com/libyal/libfsxfs" +SRC_URI="https://github.com/libyal/libfsxfs/releases/download/${PV}/${PN}-experimental-${PV}.tar.gz" + +LICENSE="LGPL-3" +SLOT="0" +KEYWORDS="amd64 ~arm64 x86" +IUSE="nls unicode python +fuse +threads debug" + +REQUIRED_USE=" + python? ( ${PYTHON_REQUIRED_USE} ) +" + +DEPEND=" + nls? ( + virtual/libiconv + virtual/libintl + ) + python? ( dev-lang/python:* ) + app-forensics/libbfio[nls=,unicode=,threads=] + dev-libs/libcdata[nls=] + dev-libs/libcerror[nls=] + dev-libs/libcfile[nls=,unicode=] + dev-libs/libclocale[nls=,unicode=] + dev-libs/libcnotify[nls=] + dev-libs/libcpath[nls=,unicode=] + dev-libs/libcsplit[nls=,unicode=] + dev-libs/libcthreads[nls=] + dev-libs/libfcache[nls=] + dev-libs/libfdata[nls=,threads=] + dev-libs/libfdatetime[nls=] + dev-libs/libfguid[nls=] + dev-libs/libhmac[nls=,unicode=,threads=] + dev-libs/libuna[nls=,unicode=] + dev-libs/openssl +" +RDEPEND=" + ${DEPEND} + python? ( ${PYTHON_DEPS} ) + fuse? ( sys-fs/fuse ) +" + +src_prepare() { + # workaround for missing files in distribution package, see https://github.com/libyal/libfsxfs/issues/9 + # should not be required any more in releases after 20220829 + cp "${FILESDIR}/2022-11-pyfsxfs_test_volume.py" "${WORKDIR}/${P}/tests/pyfsxfs_test_volume.py" + + eautoreconf + eapply_user +} + +src_configure() { + econf \ + $(use_enable nls) \ + $(use_with nls libiconv-prefix) \ + $(use_with nls libintl-prefix) \ + $(use_enable unicode wide-character-type) \ + $(use_enable debug verbose-output ) \ + $(use_enable debug debug-output ) \ + $(use_enable threads multi-threading-support) \ + $(use_enable python) \ + $(use_enable python python3) \ + $(use_with fuse libfuse) \ + +} diff --git a/app-forensics/libfsxfs/metadata.xml b/app-forensics/libfsxfs/metadata.xml new file mode 100644 index 000000000..8d6997c48 --- /dev/null +++ b/app-forensics/libfsxfs/metadata.xml @@ -0,0 +1,11 @@ + + + + + unknown@pentoo.ch + Author Unknown + + + Enable FUSE support + +