# backtrip — .NET & JVM Decompiler in Rust
[](https://crates.io/crates/backtrip)
[](https://docs.rs/backtrip)
[](LICENSE)
[](https://www.rust-lang.org/)
[](#tests)
**backtrip** is a decompiler written in Rust with two independent back ends:
- **.NET** — parses ECMA-335 PE/CLI metadata and CIL bytecode, then
reconstructs readable C# source from compiled assemblies (`.dll`/`.exe`),
with ildasm-style IL disassembly.
- **Java** — parses JVM class files (`0xCAFEBABE`, JVMS chapter 4) and JVM
bytecode (JVMS chapter 6), then reconstructs readable Java source from
compiled `.class` files, with javap-style bytecode disassembly.
Both share the same CLI and the same control-flow restructuring engine.
backtrip also provides obfuscation detection, structural verification, and
JSON metadata export for .NET — all from a single fast native binary with
zero runtime dependencies.
## Why backtrip?
Most mainstream decompilers are large tools bound to a managed runtime —
the .NET ones (ILSpy, dnSpy, dotPeek) are C#-based and need a .NET runtime,
usually behind a desktop GUI, while the Java ones (CFR, Vineflower, Procyon)
need a JVM. backtrip deliberately takes the opposite trade-off:
- **One native binary, zero runtime dependencies** — written in Rust, it
parses PE/CLI metadata and CIL directly. No .NET runtime, no JVM, no GUI:
it runs anywhere Cargo does and finishes in milliseconds.
- **Scriptable and composable** — a real CLI (`--json`, `--list`, `--type`,
`--recursive`) plus a small library API. Decompilation, IL disassembly, and
metadata extraction pipe cleanly into diffs, CI pipelines, and custom
analysis tools.
- **Verifiable fidelity** — the round-trip test decompiles a real assembly,
recompiles the emitted C# with `dotnet`, and re-decompiles the result: the
output must build with zero errors and reach a fixed point (identical
output up to label renumbering). When the decompiler cannot confidently
reconstruct control flow, it emits `goto` labels or a comment rather than
plausible-looking but incorrect C#.
- **Analysis built in** — obfuscation detection, structural verification
(`--verify`), and JSON export are first-class features, not afterthoughts.
- **Lightweight by design** — one dependency (`clap`), a small footprint, and
fast incremental builds.
**When to reach for backtrip**: quick inspection on any machine; batch or
recursive analysis of many assemblies; CI gates that must prove metadata
survives decompilation; machine-readable extraction via JSON; headless
pipelines. **When to reach for ILSpy / dnSpy / dotPeek (or CFR / Vineflower
on the Java side)**: interactive browsing, debugger-integrated inspection,
or when you need the last few percent of source reconstruction — C#
`async`/`await` and `yield` state machines, and Java lambda / method-reference
reconstruction, are not there yet (see
[Limitations](#limitations--roadmap)).
## Features
### .NET Metadata & IL Parsing
- **PE32 / PE32+ header parsing** with RVA-to-offset resolution
- **Full metadata stream parsing** — `#~`, `#Strings`, `#US`, `#GUID`, `#Blob`
- **All standard metadata tables** via a generic, column-based schema with
correct coded-index and heap-index sizing
- **Type, method, field, and parameter signatures** (ECMA-335 II.23)
- **Complete CIL opcode table** (ECMA-335 III) and bytecode decoder
- **IL disassembler** producing ildasm-style output
### Java Class File Support
- **Class file parsing** (JVMS chapter 4): full constant pool (all 17 tags,
modified UTF-8), access flags, fields, methods, and the attributes needed
for decompilation (`Code`, `ConstantValue`, `Exceptions`, `InnerClasses`,
`Signature`, `LocalVariableTable`, `BootstrapMethods`, `SourceFile`)
- **Field/method descriptor parsing** (JVMS 4.3) with array and object types
- **Generic `Signature` rendering** (JVMS 4.7.9.1): class/method type
parameters, parameterized types (`List<String>`), type variables and
wildcards (`? super T`) in declarations
- **Complete JVM opcode table** (JVMS chapter 6, including `wide`,
`tableswitch`, `lookupswitch`, `invokedynamic`) and bytecode decoder
- **Java source reconstruction**: classes/interfaces/enums, modifiers,
constants, javac-style `for`/`while` loops, `switch` inlining, ternary and
boolean-return reconstruction, `try`/`catch`/`finally` from the exception
table, and javac 9+ `invokedynamic` string concatenation decoded back into
`+` expressions from the BootstrapMethods recipe
- **javap-style disassembler** (`--il` on a `.class` file)
- **`.jar` archive support**: zip reading with a built-in raw-DEFLATE
decoder (no dependencies) — `--list`, filtered decompilation, and
disassembly work directly on real-world jars
- Decompiled output **recompiles with `javac`** (verified by the test suite
against a real fixture)
Inputs are detected by magic bytes (`MZ` vs `0xCAFEBABE`), not by file
extension — the same commands work for both formats.
### C# Decompilation
- **Arithmetic, logic, comparison, and conversion operators**
- **String literals, numeric constants, arguments, and locals**
- **Instance/static field access, array element access, `newarr`/`ldlen`**
- **Method calls** — `call` / `callvirt` / `newobj` with argument reconstruction
- **`ref` / `out` parameters** — ByRef params render with correct semantics and call-site keywords
- **`params` arrays** — `[ParamArray]` renders as `params int[] xs`; vararg signatures render their sentinel as `...`
- **Lambda inlining** — display class + `Func`/`Action` construction + `Invoke` collapse to a lambda expression with captured variables (`((int x) => x + offset)(10)`)
- **Type operations** — `box` / `unbox.any` / `castclass` / `isinst` (`is`/`as`)
- **Constructors** with access modifiers, `static` / `virtual` / `override` / `abstract`
- **Type kinds** — class / struct / interface / enum / delegate detection
- **Generic type parameters**
- **Properties and events** with getter/setter rendering
- **Custom attributes** (`[Obsolete]`, `[DllImport]`, etc.)
### Structured Control Flow Recovery
- **`if` / `else if` / `else`** — reconstructed from conditional branches
- **`while` and `do-while` loops** — reconstructed from backward branches
- **`for` loops** — detected from initializer + condition + incrementer patterns
- **`switch` statements** — case bodies inlined, `goto` labels eliminated
- **`switch` expressions** — `V_0 = ...; goto` pattern → clean `switch` with `break`
- **`try` / `catch` / `finally`** — reconstructed from exception handlers
- **`using` blocks** — detected from `try`/`finally` + `Dispose()` pattern
- **`foreach` loops** — detected from `GetEnumerator` + `MoveNext` + `Current` pattern
- **Collection initializers** — `new List()` + `.Add()` calls collapsed to `{ ... }`
- **Object initializers** — `new T() { Prop = v }` collapsed from `new`/`default` + member sets
### Tooling & Analysis
- **Compilable output** — `using` directives inferred from the assembly's
type references (`System`, `System.IO`, ...), `System.*` names rendered as
simple names, and correct statement forms (ref/out params, property
accessors, foreach variables, bool literals, `base()` initializers) so the
decompiled C# rebuilds under `dotnet` — validated by the round-trip test
- **Recursive multi-assembly decompilation** — `--recursive` decompiles all
`.dll`/`.exe` files in a directory
- **JSON metadata export** — `--json` outputs a structured model of types,
methods, and fields for machine consumption
- **Obfuscation detection** — `--detect-obfuscation` scans for non-printable
names, control-flow flattening, and string encryption
- **Structural verification** — `--verify` checks that all types/methods/fields
from metadata appear in the decompiled output
## Install
From [crates.io](https://crates.io/crates/backtrip):
```bash
cargo install backtrip
```
Or build from source:
```bash
cargo build --release
```
The resulting binary is at `target/release/backtrip`. No .NET runtime or JVM
is required to run backtrip — it parses PE files and class files directly.
## Usage
```bash
# Decompile to C# (one .cs file per type) into ./decompiled
backtrip path/to/Assembly.dll
# Choose an output directory
backtrip path/to/Assembly.dll -o out/
# Decompile a single type to stdout
backtrip path/to/Assembly.dll --type Calculator --stdout
# Emit CIL disassembly instead of C#
backtrip path/to/Assembly.dll --il
# List types in the assembly
backtrip path/to/Assembly.dll --list
# Recursively decompile all assemblies in a directory
backtrip ./bin/Release/net8.0/ --recursive -o out/
# Export assembly metadata as JSON
backtrip path/to/Assembly.dll --json
# Detect obfuscation indicators
backtrip path/to/Assembly.dll --detect-obfuscation
# Verify decompiled output against metadata
backtrip path/to/Assembly.dll --verify
# Decompile a JVM class file to Java (auto-detected by magic bytes)
backtrip path/to/HelloWorld.class
# Decompile every class in a jar archive
backtrip path/to/library.jar -o out/
# javap-style bytecode disassembly of a class file
backtrip path/to/HelloWorld.class --il --stdout
# List the class name
backtrip path/to/HelloWorld.class --list
# Recursively decompile .dll/.exe/.class files in a directory
backtrip ./build/ --recursive -o out/
```
### CLI Reference
| `<assembly>` | Path to .NET `.dll` / `.exe`, or a directory with `--recursive` |
| `-o, --output <dir>` | Output directory (default `decompiled`) |
| `--il` | Emit IL disassembly instead of C# source |
| `--list` | List types in the assembly and exit |
| `--type <name>` | Decompile only the matching type |
| `--stdout` | Print matched type to stdout (requires `--type`) |
| `--recursive` | Decompile all `.dll`/`.exe`/`.class`/`.jar` in a directory |
| `--json` | Export assembly metadata as JSON to stdout |
| `--detect-obfuscation` | Scan for obfuscation indicators and emit warnings |
| `--verify` | Verify decompiled output against metadata |
| `-h, --help` | Show help |
| `-V, --version` | Show version |
## Project Layout
```
src/
pe.rs PE parsing + RVA resolution
metadata/
streams.rs metadata root + heaps (#Strings, #US, #GUID, #Blob)
tables.rs metadata table schemas + coded indexes + row parser
signatures.rs Type / MethodSig / FieldSig parsing
reader.rs high-level accessors tying everything together
cil/
opcodes.rs full CIL opcode table (ECMA-335 III)
decoder.rs bytecode → Instruction stream
disasm.rs Instruction → IL text
java/
classfile.rs JVMS ch. 4 class file parser (constant pool, members)
descriptor.rs JVMS 4.3 field/method descriptors + generic Signature
opcodes.rs full JVM opcode table (JVMS ch. 6)
decoder.rs bytecode → Instruction stream
disasm.rs javap-style bytecode text
jar.rs .jar support (zip central directory + raw-DEFLATE decoder)
decompile/
csharp.rs C# decompiler (expression-stack machine)
java.rs Java decompiler (expression-stack machine, javac passes)
flow.rs shared control-flow restructuring passes (both back ends)
json.rs JSON metadata export
obfuscation.rs obfuscation detection
verify.rs structural verification
output.rs per-type file writer
main.rs CLI (clap) + magic-byte format dispatch
lib.rs library root (for integration tests)
examples/
decompile.rs library-usage example (parse → decompile → print)
tests/
integration.rs end-to-end tests (Sample.dll, Roundtrip.dll, java/jar
fixtures, CLI smoke tests)
docs_sync.rs doc-drift enforcement (fails cargo test on stale docs)
fixtures/ Sample.cs + Roundtrip.cs (.NET) and *.java + *.jar (Java)
```
## Tests
```bash
cargo test
```
The .NET integration tests run against a **prebuilt** fixture
(`tests/fixtures/bin/Release/net8.0/Sample.dll`) and assert the decompiler
reproduces expected C# fragments — including control flow, switch statements,
switch expressions, try/catch, using blocks, foreach, properties, events,
delegates, nested types, enums, interfaces, abstract/virtual/override
hierarchies, generic classes and methods, static constructors, arrays, and
box/unbox/castclass conversions. Rebuild the fixture with
`cd tests/fixtures && dotnet build -c Release` (dotnet SDK 8+).
A second prebuilt fixture (`tests/fixtures/roundtrip/Roundtrip.dll`) drives the
**round-trip test**: the decompiled output is recompiled with `dotnet` and
must build (0 errors), then the recompiled assembly is re-decompiled and must
expose the same type set. This validates that the emitted C# is actually
compilable — usings, name resolution, and statement rendering.
The Java integration tests run against prebuilt class files
(`tests/fixtures/java/bin/demo/`) and jar archives, assert decompiled Java
fragments, and recompile the decompiled output with `javac` (skipped when
`javac` is absent). Rebuild with `javac -d tests/fixtures/java/bin
tests/fixtures/java/*.java` (JDK 17+).
Finally, `tests/docs_sync.rs` makes documentation drift a test failure: the
AGENTS.md module list and TODO.md test counts must match the code.
## Library Usage
backtrip is a library as well as a CLI. The
[`examples/decompile.rs`](examples/decompile.rs) example shows the minimal
pipeline — parse PE, load metadata, decompile:
```bash
cargo run --example decompile -- path/to/Assembly.dll
```
The same functions (`PeImage::parse`, `metadata::load`, `Reader::new`,
`decompile_assembly`) power the CLI and the integration tests.
## How It Works
backtrip works in three stages:
1. **PE parsing** — Reads the portable executable headers and locates the
.NET metadata root and CLI header.
2. **Metadata decoding** — Parses the metadata streams and tables to extract
type definitions, method signatures, field layouts, and custom attributes.
3. **CIL decompilation** — Decodes the IL bytecode into an instruction stream,
then uses an expression-stack machine to reconstruct C# source. Post-
processing passes restructure control flow (`if`/`else`, `while`, `for`,
`switch`, `try`/`catch`), collapse patterns (`using`, `foreach`,
collection initializers), and clean up compiler-generated names.
For Java inputs the stages mirror this: class-file parsing (constant pool,
members, attributes) → descriptor/`Signature` decoding → JVM bytecode
decompilation or javap-style disassembly, with `.jar` archives unpacked
(zip + inflate) before per-class decompilation.
## Comparison with Other Tools
### .NET tools
| Language | Rust | C++/CLI | C# | C# | C# |
| License | Apache-2.0 | MS | MIT | MIT | Proprietary (free) |
| CLI tool | Yes | Yes | Yes (`ilspycmd`) | No (GUI) | No (GUI) |
| IL disassembly | Yes | Yes | Yes | Yes | Yes |
| C# decompilation | Partial | No | Full | Full | Full |
| Java decompilation | Yes (`.class`/`.jar`) | No | No | No | No |
| Zero runtime dependencies | Yes | No (SDK) | No (.NET) | No (.NET) | No (.NET) |
| Round-trip compile gate | Yes | No | No | No | No |
| JSON export | Yes | No | No | No | No |
| Obfuscation detection | Yes | No | No | No | No |
| Structural verification | Yes | No | No | No | No |
| Recursive batch mode | Yes | No | Yes | No | No |
**Where each tool fits**:
- **ildasm** — the reference IL disassembler shipped with the .NET SDK.
IL only; no C# reconstruction. Good for checking what the compiler
actually emitted.
- **ILSpy / ilspycmd** — the open-source standard for C# decompilation.
Excellent output quality, actively developed, usable as a library and a
CLI. The benchmark to beat for reconstruction fidelity.
- **dnSpy** — ILSpy-derived; adds a debugger and assembly editing. GUI-only.
- **dotPeek** — JetBrains' free decompiler. Polished GUI plus PDB
generation; Windows-centric.
### Java tools
| Language | Rust | Java (JDK) | Java | Java | Java |
| License | Apache-2.0 | GPLv2 + Classpath exception | MIT | Apache-2.0 | Apache-2.0 |
| CLI tool | Yes | Yes | Yes | Yes | Yes |
| Bytecode disassembly | Yes | Yes | No | No | No |
| Java decompilation | Partial | No | Full | Full | Full |
| .NET decompilation | Yes (`.dll`/`.exe`) | No | No | No | No |
| Zero runtime dependencies | Yes | No (JDK) | No (JRE) | No (JRE) | No (JRE) |
| Round-trip compile gate | Yes | No | No | No | No |
| JSON export | Yes | No | No | No | No |
| Obfuscation detection | Yes | No | No | No | No |
| Structural verification | Yes | No | No | No | No |
| Recursive batch mode | Yes | No | No | No | No |
- **javap** — the bytecode disassembler shipped with the JDK. The reference
for what `javac` actually emitted; disassembly only, no Java source
reconstruction.
- **CFR** — a widely used open-source Java decompiler (MIT). Strong output
quality across modern Java syntax, usable as a CLI and a library. The
Java-side benchmark for reconstruction fidelity.
- **Vineflower** — the actively developed Fernflower fork (Apache-2.0);
among the best Java reconstruction quality today, with IDE integrations.
- **Procyon** — a solid Java decompiler (Apache-2.0) with good newer-syntax
handling; development has been mostly dormant.
- **backtrip** — a headless, dependency-free alternative in both ecosystems,
with verification tooling the others lack. Choose it where a native
binary, scripting, or CI integration matters more than maximum source
fidelity — and use the round-trip gate to *prove* the output compiles.
## Limitations & Roadmap
See [`TODO.md`](TODO.md) for the full roadmap. Notable upcoming work:
- `async` / `await` state-machine recognition and reversal
- `yield` iterator state-machine reversal
- Switch expressions with type patterns and property patterns
- Round-trip IL diffing (recompiled IL never matches exactly; semantic
comparison is future work)
- Java: generic type inference in method bodies (locals/`new` stay erased —
needs stack-map-frame analysis), lambda / method-reference reconstruction
(`LambdaMetafactory`), local-variable naming without `-g`, and Zip64 jar
archives
## License
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.