New release

Adds:
* Test data, tests and Github workflow to automate them on both Linux and Windows platforms
* Support for passing the private key in memory instead of reading it from a file, useful when using orc-decrypt as a library
* Support for preserving the input archives' original directory structure in the output directory

Fixes:
* Several Windows-specific bugs
* Workaround a potential bug when handling 3DES decryption with cryptography > 42
* Logging with contextual information

.github/workflows/python-package.yml

@@ -0,0 +1,44 @@
+name: Python tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: "${{ matrix.os }}"
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install ruff pytest pytest-cov pytest-console-scripts
+        python -m pip install -vvv .
+    - name: Lint with Ruff  
+      run: |  
+        ruff check .
+      continue-on-error: true  
+    - name: "Test with pytest on ${{ matrix.os }} Python ${{ matrix.python-version }}"
+      run: |  
+        coverage run -m pytest --log-level INFO
+    - name: Generate Coverage Report  
+      run: |  
+        coverage report -m

.gitignore

@@ -1 +1,9 @@
-build*
+.idea
+dist
+build
+*.egg-info
+__pycache__
+.tox
+.coverage
+report.xml
+coverage.xml

setup.py

@@ -1,31 +1,46 @@
 import os
+import shutil
 import subprocess
 import sys
 from pathlib import Path
 
 from setuptools import find_packages
 from setuptools import setup
+from setuptools.command.build import build
 from setuptools.command.install import install
 
 here = Path(__file__).parent.resolve()
 build_dir = here / "build"
 build_type = "Release"
 
 
-class MyInstall(install):
+class MyBuild(build):
     def run(self):
         if subprocess.call(["cmake", "-S", ".", "-B", build_dir.resolve()]) != 0:
             sys.exit(-1)
-        if subprocess.call(["cmake", "--build", build_dir.resolve(), "--config", build_type]) != 0:
+        if (
+            subprocess.call(
+                ["cmake", "--build", build_dir.resolve(), "--config", build_type]
+            )
+            != 0
+        ):
             sys.exit(-1)
-        # Try to install but ignore errors if permission is denied
-        subprocess.call(["cmake", "--install", build_dir.resolve(), "--config", build_type])
-        install.run(self)
+        return super().run()
+
+
+class MyInstall(install):
+    def run(self):
+        if "VIRTUAL_ENV" in os.environ and sys.platform == "win32":
+            shutil.copy(
+                build_dir / build_type / "unstream.exe",
+                Path(os.environ["VIRTUAL_ENV"]) / "Scripts" / "unstream.exe",
+            )
+        return super().run()
 
 
 setup(
     name="anssi-orcdecrypt",
-    version="4.1",
+    version="5.3.2",
     url="https://github.com/DFIR-ORC/orc-decrypt",
     license="LGPL-2.1+",
     author="Sebastien Chapiron",
@@ -36,10 +51,22 @@ def run(self):
     install_requires=["cryptography>=0.6"],
     packages=find_packages(where="src"),
     package_dir={"": "src"},
+    data_files=[
+        (
+            "bin",
+            [
+                (
+                    str(build_dir / build_type / "unstream.exe")
+                    if sys.platform == "win32"
+                    else str(build_dir / "unstream")
+                ),
+            ],
+        ),
+    ],
     zip_safe=False,
     entry_points={
         "console_scripts": [
-            "orc-decrypt=anssi_orcdecrypt.cli:main",
+            "orc-decrypt=orcdecrypt.cli:entrypoint",
         ],
     },
     classifiers=[  # Optional
@@ -49,11 +76,13 @@ def run(self):
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3 :: Only",
         "Operating System :: Unix",
     ],
     python_requires=">=3.8, <4",
     cmdclass={
+        "build": MyBuild,
         "install": MyInstall,
     },
 )