reverse-engineering-anything/docs/provider-evaluation.md

Static-analysis provider evaluation

Status: Ghidra is approved as the direction for REA's next full read-only analysis provider. This note does not claim that Ghidra support is implemented or shipped.

The provider-neutral target, provider registry, deterministic target binding, analysis-profile commitment, Evidence provenance, snapshot v2, and bounded provider-process lifecycle foundations are implemented. Ghidra support itself remains gated on its launcher, bridge, semantic adapter, and multi-fixture conformance suite. A provider is not a drop-in replacement for Hopper: every capability must be mapped explicitly, with truthful unavailable or degraded results where the engine cannot provide equivalent semantics.

ADR-0001 fixes the provider registry, deterministic selection, target binding, analysis profile, snapshot migration, and compatibility semantics that implementation must follow.

Approved Ghidra v1 boundary

• Keep the existing provider-neutral CLI and MCP tool names.
• Bind one deep-analysis provider to a target for the target's lifetime; never fail over silently between Hopper and Ghidra.
• Start with bring-your-own Ghidra and a compatible Java runtime. Setup must not install or upgrade Java.
• Run Ghidra headlessly in an owned process with a private temporary project, bounded startup/analysis/request deadlines, cancellation, and cleanup.
• Prefer a packaged Java bridge loaded through Ghidra's script path. PyGhidra remains useful for prototypes but is not a mandatory production dependency.
• Implement read-only inventories, assembly, decompilation, function metadata, calls, references, containment, and bounded search first.
• Report GUI cursor/navigation and persistent mutation operations as unavailable until their semantics and project ownership are explicitly designed.
• Verify real claims on Linux with at least two distinct source-owned binaries; compare normalized semantic facts rather than provider-specific pseudocode text.

Shared provider-process foundation

src/process/ now provides the mechanisms that a long-lived Hopper or Ghidra adapter genuinely shares: run-token-authenticated process-group ownership, mode-0700 temporary runtime roots, one absolute startup deadline, correlated request timeout/cancellation cleanup, bounded stdout and stderr retention with exact byte counts, process-exit diagnostics, and bounded TERM-to-KILL shutdown. Reusable fixtures exercise exit, timeout, cancellation, graceful termination, forced termination, double-close, spawn failure, and resource release.

The foundation does not define a bridge schema, socket framing, health payload, analysis model, or shutdown acknowledgement. Hopper keeps its authenticated NDJSON-over-Unix-socket protocol in src/hopper/; Ghidra may use its own Java bridge and transport while reusing only these process mechanisms.

Shortlist

Provider	License / automation surface	What it brings	REA fit and blockers
Ghidra	Apache-2.0 source license; analyzeHeadless, Java APIs, and PyGhidra	Broad static analysis, many processors and formats, scripting, and project/database workflows	Strong candidate for a full provider. Requires a Java/JDK runtime, isolated project/cache directories, process supervision, and a stable adapter for Ghidra's project-oriented model.
Rizin / rz-pipe	Rizin repository contains LGPL-3.0 and GPL-3.0 components; rizin, rz-bin, and language bridges through rzpipe	Portable CLI analysis, disassembly/debugging, many architectures and file formats, JSON command output	Good candidate for a process-backed Linux provider and fast metadata fallback. License/component inventory must be preserved; command output needs version-pinned parsers and semantic conformance before evidence is trusted.
LIEF	Apache-2.0; C++, Python, and other bindings	Deterministic parsing and modification of ELF, PE, Mach-O, COFF, and related executable formats; headers, sections, symbols, relocations, and functions	Best near-term complement, not a decompiler replacement. It can cover format metadata and artifact evidence without a long-lived analysis process; function semantics, pseudocode, CFG, and cross-reference parity remain out of scope unless separately demonstrated.
Binary Ninja	API/documentation components are MIT, while the analysis product is licensed by edition; commercial, Ultimate, or Headless license is required for headless automation	Python/Core/C++/Rust APIs, headless loading, IL layers, function analysis, plugins, and configurable analysis	Strong technical fit for a native provider, especially function dossiers. Commercial licensing, license-secret handling, native runtime packaging, and multithreaded lifecycle rules are material deployment blockers.

Recommended order

1. Use the implemented explicit provider registry and target binding without changing Hopper behavior.
2. Implement the bounded read-only Ghidra provider described above and admit capabilities individually through the shared conformance corpus.
3. Connect Electron/native-add-on application findings to the selected native analysis provider without introducing provider-prefixed tools.
4. Evaluate LIEF or Rizin later as complementary metadata/disassembly providers, and Binary Ninja as an optional licensed provider, using the same admission gate.

Required admission gate

Before implementation, an adapter proposal must provide:

• a capability matrix covering supported, unsupported, and degraded results;
• provider identity, version, analysis profile, target digest, authority, limitations, and deterministic locations in every Evidence v2 record;
• bounded subprocess or library lifetime, cancellation, timeouts, and cleanup;
• actionable local diagnostics that retain paths, digests, mismatch locations, and provider metadata while redacting credentials, authorization headers, license secrets, and other genuine secrets;
• the same source-owned fixture corpus across architectures and formats;
• repeatable checks for function identity, addresses, strings, names, xrefs, CFG, and pseudocode wherever those capabilities are claimed.

These gates turn the accepted direction into verified capabilities rather than prematurely claiming equivalence or redistribution support.

Primary-source notes

• Ghidra 12.1.2 documents headless batch mode and its Java runtime requirements in its release-specific Getting Started guide; the official release supplies the corresponding distribution and checksums.
• Rizin lists supported formats, architectures, tools, and rzpipe bridges in its repository README; rz-pipe documents JSON command transport and pipe backends.
• LIEF's format tutorial and Python API document parsing and format-agnostic binary access.
• Binary Ninja documents its headless automation model, edition licenses, and the MIT license for API/documentation components.