add optional --timeout CLI option and bump to 0.4.3

Author: RobinDavid

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-binexport"
-version = "0.4.2"
+version = "0.4.3"
 description = "Python wrapper to manipulate binexport files (protobuf)"
 readme = { file = "README.md", content-type = "text/markdown" }
 authors = [{ name = "Quarkslab", email = "diffing@quarkslab.com" }]

src/binexport/__main__.py

@@ -56,11 +56,11 @@ def recursive_file_iter(p: Path) -> Generator[Path, None, None]:
             yield from recursive_file_iter(f)
 
 
-def export_job(ingress, egress, backend: DisassemblerBackend) -> None:
+def export_job(ingress, egress, backend: DisassemblerBackend, timeout: int | None) -> None:
     while True:
         try:
             file = ingress.get(timeout=0.5)
-            res = ProgramBinExport.generate(file.as_posix(), backend=backend)
+            res = ProgramBinExport.generate(file.as_posix(), backend=backend, timeout=timeout)
             egress.put((file, res))
         except queue.Empty:
             pass
@@ -128,13 +128,20 @@ def check_disassembler_availability(disass: DisassemblerBackend, disass_path: st
     "(if not provided search $PATH or environment variable IDA_PATH, GHIDRA_PATH)",
 )
 @click.option("-t", "--threads", type=int, default=1, help="Thread number to use")
+@click.option(
+    "--timeout",
+    type=int,
+    default=None,
+    help="Per-file export timeout in seconds (if not set, no timeout is enforced)",
+)
 @click.option("-v", "--verbose", count=True, help="To activate or not the verbosity")
 @click.option("--stop-on-error", is_flag=True, default=False, help="Stop on error")
 @click.argument("input_file", type=click.Path(exists=True), metavar="<binary file|directory>")
 def main(disassembler: str,
          disass_path: str,
          input_file: str,
          threads: int,
+         timeout: int | None,
          verbose: bool,
          stop_on_error: bool) -> None:
     """
@@ -162,7 +169,7 @@ def main(disassembler: str,
 
     # Launch all workers
     for _ in range(threads):
-        pool.apply_async(export_job, (ingress, egress, engine))
+        pool.apply_async(export_job, (ingress, egress, engine, timeout))
 
     # Pre-fill ingress queue
     total = 0

src/binexport/program.py

@@ -130,7 +130,7 @@ def from_binary(
         output_file: str | pathlib.Path = "",
         override: bool = False,
         backend: DisassemblerBackend = DisassemblerBackend.IDA,
-        timeout: int = 600,
+        timeout: int | None = 600,
     ) -> ProgramBinExport:
         """
         Generate the .BinExport file for the given program and return an instance
@@ -165,8 +165,18 @@ def generate(
         output_file: str | pathlib.Path = "",
         override: bool = False,
         backend: DisassemblerBackend = DisassemblerBackend.IDA,
-        timeout: int = 600,
+        timeout: int | None = 600,
     ) -> pathlib.Path:
+        """
+        Generate the .BinExport file for the given program.
+
+        :param exec_file: executable file path
+        :param output_file: BinExport output file
+        :param override: Override the .BinExport if already existing.
+        :param backend: The backend to use.
+        :param timeout: Per-file export timeout in seconds. Pass ``None`` to disable.
+        :return: the path of the generated BinExport file
+        """
 
         exec_file = pathlib.Path(exec_file)
         binexport_file = (
@@ -209,7 +219,7 @@ def generate(
     def _from_ida(
         exec_file: pathlib.Path,
         binexport_file: pathlib.Path,
-        timeout: int = 600,
+        timeout: int | None = 600,
     ) -> bool:
         """
         Generate the .BinExport file for the given program and return an instance
@@ -246,7 +256,7 @@ def _from_ida(
     def _from_binary_ninja(
         exec_file: pathlib.Path,
         binexport_file: pathlib.Path,
-        timeout: int = 600,
+        timeout: int | None = 600,
     ) -> bool:
         """
         Generate the .BinExport file for the given program and return an instance
@@ -285,7 +295,7 @@ def _from_binary_ninja(
     def _from_ghidra(
         exec_file: pathlib.Path,
         binexport_file: pathlib.Path,
-        timeout: int = 600,
+        timeout: int | None = 600,
     ) -> bool:
         """
         Generate the .BinExport file for the given program and return an instance