acquire 3.17.dev7__tar.gz → 3.18.dev2__tar.gz

{acquire-3.17.dev7/acquire.egg-info → acquire-3.18.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: acquire
-Version: 3.17.dev7
+Version: 3.18.dev2
 Summary: A tool to quickly gather forensic artifacts from disk images or a live system into a lightweight container
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

{acquire-3.17.dev7 → acquire-3.18.dev2}/acquire/uploaders/minio.py

@@ -1,4 +1,3 @@
-import os
 from pathlib import Path
 from typing import Any, Optional
 
@@ -20,6 +19,7 @@ class MinIO(UploaderPlugin):
         self.access_id = upload.get("access_id")
         self.access_key = upload.get("access_key")
         self.bucket_name = upload.get("bucket")
+        self.folder = upload.get("folder", "").rstrip("/")
 
         if not all((self.endpoint, self.access_id, self.access_key, self.bucket_name)):
             raise ValueError("Invalid cloud upload configuration")
@@ -45,7 +45,11 @@ class MinIO(UploaderPlugin):
         return Minio(self.endpoint, self.access_id, self.access_key, http_client=http_client)
 
     def upload_file(self, client: Any, path: Path) -> None:
-        client.fput_object(self.bucket_name, os.path.basename(path), path)
+        object_path = path.name
+        if self.folder:
+            object_path = f"{self.folder}/{object_path}"
+
+        client.fput_object(self.bucket_name, object_path, path)
 
     def finish(self, client: Any) -> None:
         pass

{acquire-3.17.dev7 → acquire-3.18.dev2}/acquire/version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '3.17.dev7'
-__version_tuple__ = version_tuple = (3, 17, 'dev7')
+__version__ = version = '3.18.dev2'
+__version_tuple__ = version_tuple = (3, 18, 'dev2')

{acquire-3.17.dev7 → acquire-3.18.dev2}/acquire/volatilestream.py

@@ -1,7 +1,9 @@
 import os
+from concurrent import futures
 from io import SEEK_SET, UnsupportedOperation
 from pathlib import Path
 from stat import S_IRGRP, S_IROTH, S_IRUSR
+from typing import Any, Callable
 
 from dissect.util.stream import AlignedStream
 
@@ -14,6 +16,35 @@ except ImportError:
     HAS_FCNTL = False
 
 
+def timeout(func: Callable, *, timelimit: int) -> Callable:
+    """Timeout a function if it takes too long to complete.
+
+    Args:
+        func: a function to wrap.
+        timelimit: The time in seconds that an operation is allowed to run.
+
+    Raises:
+        TimeoutError: If its time exceeds the timelimit
+    """
+
+    def wrapper(*args: Any, **kwargs: Any) -> Any:
+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
+            future = executor.submit(func, *args, **kwargs)
+
+            try:
+                result = future.result(timelimit)
+            except futures.TimeoutError:
+                raise TimeoutError
+            finally:
+                # Make sure the thread stops right away.
+                executor._threads.clear()
+                futures.thread._threads_queues.clear()
+
+            return result
+
+    return wrapper
+
+
 class VolatileStream(AlignedStream):
     """Streaming class to handle various procfs and sysfs edge-cases.  Backed by `AlignedStream`.
 
@@ -41,6 +72,8 @@ class VolatileStream(AlignedStream):
         st_mode = os.fstat(self.fd).st_mode
         write_only = (st_mode & (S_IRUSR | S_IRGRP | S_IROTH)) == 0  # novermin
 
+        self._os_read = timeout(os.read, timelimit=5)
+
         super().__init__(0 if write_only else size)
 
     def seek(self, pos: int, whence: int = SEEK_SET) -> int:
@@ -53,8 +86,8 @@ class VolatileStream(AlignedStream):
         result = []
         while length:
             try:
-                buf = os.read(self.fd, min(length, self.size - offset))
-            except BlockingIOError:
+                buf = self._os_read(self.fd, min(length, self.size - offset))
+            except (BlockingIOError, TimeoutError):
                 break
 
             if not buf:

{acquire-3.17.dev7 → acquire-3.18.dev2/acquire.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: acquire
-Version: 3.17.dev7
+Version: 3.18.dev2
 Summary: A tool to quickly gather forensic artifacts from disk images or a live system into a lightweight container
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

{acquire-3.17.dev7 → acquire-3.18.dev2}/acquire.egg-info/SOURCES.txt

@@ -58,6 +58,7 @@ tests/test_outputs_tar.py
 tests/test_outputs_zip.py
 tests/test_plugin.py
 tests/test_utils.py
+tests/test_volatile.py
 tests/data/private_key.pem
 tests/data/public_key.pem
 tests/docs/Makefile

{acquire-3.17.dev7 → acquire-3.18.dev2}/tests/test_minio_uploader.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+from typing import Callable
 from unittest.mock import Mock, patch
 
 import pytest
@@ -79,3 +80,35 @@ def test_upload_file_multiple_failures(minio_instance: MinIO):
     with patch("acquire.uploaders.plugin.log") as mocked_logger:
         upload_files_using_uploader(minio_instance, [Path("hello")])
         mocked_logger.error.assert_called_with("Upload %s FAILED after too many attempts. Stopping.", Path("hello"))
+
+
+def test_minio_folder_initialization(minio_plugin: Callable) -> None:
+    arguments = {"endpoint": "test", "access_id": "test", "access_key": "test", "bucket": "test", "folder": "Uploads/"}
+    minio = minio_plugin(upload=arguments)
+    assert minio.folder == "Uploads"
+
+    arguments["folder"] = "Uploads/test_folder"
+    minio_no_backslash = minio_plugin(upload=arguments)
+    assert minio_no_backslash.folder == "Uploads/test_folder"
+
+    arguments.pop("folder")
+    minio_no_folder = minio_plugin(upload=arguments)
+    assert minio_no_folder.folder == ""
+
+
+def test_upload_file_with_folder(minio_instance: MinIO):
+    mock_client = Mock()
+    test_path = Path("example.txt")
+    minio_instance.folder = "test_folder"
+    minio_instance.upload_file(mock_client, test_path)
+
+    mock_client.fput_object.assert_called_once_with("test", "test_folder/example.txt", test_path)
+
+
+def test_upload_file_without_folder(minio_instance: MinIO):
+    mock_client = Mock()
+    test_path = Path("example.txt")
+    minio_instance.folder = ""
+    minio_instance.upload_file(mock_client, test_path)
+
+    mock_client.fput_object.assert_called_once_with("test", "example.txt", test_path)

acquire-3.18.dev2/tests/test_volatile.py

@@ -0,0 +1,20 @@
+from time import sleep, time
+
+import pytest
+
+from acquire.volatilestream import timeout
+
+
+def test_timeout():
+    def snooze():
+        sleep(10)
+
+    function = timeout(snooze, timelimit=5)
+    start = time()
+
+    with pytest.raises(TimeoutError):
+        function()
+
+    end = time()
+
+    assert end - start < 6