rust-deobf 0.1.0__tar.gz

rust_deobf-0.1.0/CHANGELOG.md

@@ -0,0 +1,111 @@
+# Changelog
+
+All notable changes to rust-deobf are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[Semantic Versioning](https://semver.org/) (pre-1.0: a minor bump may change a tool's `--json`
+shape or CLI flags; a patch bump never does). The `rust-deobf` and `rust-deobf-premium`
+distributions always share one version.
+
+## [Unreleased]
+
+## [0.1.0rc2] - 2026-11-11
+
+Second release candidate. 0.1.0rc1 published nothing: its installed-wheel test failed on Windows +
+Python 3.10 (release run 42976295297), so neither distribution reached PyPI.
+
+### Fixed
+- **Installed std signature layer.** The wheel did not ship `data/libfunc_sigs_std.json.gz`
+  (package-data matched `data/*.json` only) and `recover_libfuncs` looked for it under
+  `site-packages/scripts/`; an installed rust-deobf therefore loaded no prebuilt-std signatures
+  (0 instead of 4989). Both fixed; `rust-deobf doctor` checks the file.
+- **Library mode put `site-packages/scripts` first on `sys.path`.** `gen_sigdb` and every premium
+  module inserted `<parent of the package>/scripts` -- the clone's `scripts/`, but a foreign
+  directory once installed. Had another distribution installed a top-level `scripts` package, its
+  modules (`recover`, ...) would have shadowed the host program's. Clone-only paths are now added
+  only in a checkout.
+- The installed-wheel test compared `sys.path` entries with `==`; Windows Python 3.10 spells a
+  venv's site-packages `lib` while the resolved package path is `Lib`. It now compares normalised
+  paths, and also fails if importing the modules adds any other `sys.path` entry.
+- **capstone / unicorn are always installed.** Their `platform_machine != "ARM64"` marker (meant for
+  native ARM64 Python, which has no wheels) also matched x64 Python 3.14 on Windows-on-ARM --
+  `platform_machine` is the host CPU there -- so pip left both out of the recommended setup.
+  Native ARM64 Python now fails at `pip install` instead (README: use x64 Python).
+- **Emulation: an AEAD's last block with its scratch neighbours** is no longer reported as a string
+  (`:gUnmetry-offa` next to `...telemetry-off`; obfuse_aes on AArch64).
+
+### Changed
+- **The benchmark gate is deterministic.** Four benchmark crates draw fresh keys per build, and the
+  per-push verdict followed the key (VALIDATION §77). `bench_src/*/Cargo.lock` is committed, obfuse
+  / obfuse_aes / obfuse_xor are built with a fixed `seed=` per literal, and muddy (unseedable) runs
+  in the weekly schedule only. Earlier one-build recall/precision figures are single samples.
+
+## [0.1.0rc1] - 2026-11-11
+
+Release candidate for 0.1.0: the first end-to-end run of the release pipeline -- build, the
+installed-wheel tests on four operating systems, and Trusted Publishing to PyPI for both
+distributions. The content is the 0.1.0 section below.
+
+## [0.1.0] - 2026-11-11
+
+First packaged release on PyPI (`pip install rust-deobf` / `pipx install rust-deobf`; premium
+modules via `pip install "rust-deobf[premium]"`). Everything below was developed in the open
+before packaging and is summarised by theme.
+
+### Added
+- **Packaging and the `rust-deobf` command.** One console command dispatching to every tool
+  (`rust-deobf recover|triage|unpack|metadata|imports|cfg|...`), plus `rust-deobf list`,
+  `rust-deobf doctor` (Python, dependency, platform and optional-tool checks) and
+  `rust-deobf --version`; `python -m rust_deobf` works too. The Apache-2.0 core ships as
+  `rust-deobf`; the premium modules ship separately as `rust-deobf-premium`
+  (`pip install "rust-deobf[premium]"`). Extras: `dynamic` (Frida), `rules` (yara-python,
+  flare-capa), `dev`. Release pipeline on `v*` tags with installed-wheel smoke tests on Linux,
+  Windows and macOS, PyPI Trusted Publishing and a GitHub Release. The clone-and-run workflow
+  (`python3 scripts/<tool>.py`) is unchanged.
+- **String recovery.** Unified front end `recover.py` (static call-site dataflow for x86-64 and
+  AArch64, stack strings, Rust `&str` literal splitting, `cryptify`, hash-obfuscated API imports)
+  with isolated engines, exit codes, batch/JSONL mode and a FLOSS-compatible export.
+- **Emulation.** Unicorn engine with a real loader (ELF/PE/Mach-O, TLS, chained fixups), a C
+  runtime, path exploration and global-constructor replay; hard resource caps found by fuzzing
+  the analyzer itself (`fuzz_recover.py`).
+- **Metadata and structure.** Rust toolchain/crate/panic-site recovery that survives `strip`;
+  library-function identification by byte signature with call-graph propagation; trait-object and
+  C++ (Itanium) vtables/RTTI; enum discriminant/niche layout (DWARF names when present); Go pclntab
+  names; resolved call graph + coverage; per-function behavior and source-language maps;
+  crypto-constant identification; anti-analysis inventory and build provenance.
+- **Triage and integration.** One-screen SOC triage card with calibrated signal, LLM-assisted
+  triage over the deterministic facts, capa + YARA rule export, an MCP server (stdio), headless
+  Ghidra annotation, a uniform `--json` output contract across result-producing tools.
+- **Deobfuscation tiers (premium, AGPL-3.0-or-later OR commercial).** Control-flow-flattening
+  detection and de-flattening (x86-64 + AArch64), provable MBA/expression simplification with Z3,
+  opaque-predicate detection with a sound per-flag model, static and emulation-based VM
+  devirtualization (randomized opcodes, encrypted operands, relooper structuring), and
+  optimization reversal (jump-table un-switching, unrolled loops).
+- **Unpacking.** Static unpacking by emulation to the original entry point (UPX and UPX-like,
+  PE/ELF, x86-64/x86/AArch64, staged packers) with import-table reconstruction; embedded-artifact
+  carving and keyless blob triage; an opt-in dynamic (Frida) dump cross-validated against the
+  static result. Nothing executes a sample by default.
+- **Cross-platform.** Verified on x86-64 Linux, ARM64 Kali and Windows x64 (x64 Python on
+  Windows-on-ARM); test fixtures build for the host architecture.
+
+- **October 2026 round (VALIDATION.md §62–§70).** Keyless LZ4 / aPLib / BriefLZ / LZNT1
+  decompression in blob triage (`decompress.py`); async `Future::poll` state machines
+  (`recover_async.py`, rustc 1.70–1.99, ELF/PE/Mach-O, x86-64/AArch64/i386); per-binary
+  library-signature DBs for the binary's own rustc, target and crates (`gen_sigdb.py`) plus a
+  bundled std layer for AArch64 and PE; Rust idioms in stripped binaries -- format strings with
+  their traits, panic/safety checks with `file:line:col`, drops, enum-like returns
+  (`recover_idioms.py`, annotated in Ghidra); a bridge pushing all of it into a running GhidraMCP or
+  ida-pro-mcp (`decompiler_bridge.py`, `decompiler_selfcheck.py`); 32-bit PE emulation; the 2026
+  obfuscation crates obfuse and obfany in the benchmark; ~1.4–1.6x faster emulation and 2.5–3.7x
+  faster devirtualisation with identical output.
+
+### Fixed
+- A full bug-review round across the toolkit (emulator `.bss`/TLS/strlen edge cases, embedded and
+  blob carving bounds, import binding past junk bytes and on ARM64, YARA/capa output that always
+  compiles, MCP JSON-RPC edge cases, Go pclntab layouts, enum/crypto/lang/antianalysis false
+  positives, sound opaque-predicate lifting, ARM64 loop decoding in `opt_reverse`, batch `--json`
+  that survives one failing target), plus Windows and AArch64 portability fixes.
+
+[Unreleased]: https://github.com/VAHPEM/rust-deobf/compare/v0.1.0...HEAD
+[0.1.0rc2]: https://github.com/VAHPEM/rust-deobf/releases/tag/v0.1.0rc2
+[0.1.0rc1]: https://github.com/VAHPEM/rust-deobf/releases/tag/v0.1.0rc1
+[0.1.0]: https://github.com/VAHPEM/rust-deobf/releases/tag/v0.1.0

rust_deobf-0.1.0/CLA.md

@@ -0,0 +1,48 @@
+# Contributor License Agreement (CLA)
+
+This project uses an open-core model (see [`LICENSING.md`](LICENSING.md)). To keep the premium
+modules dual-licensable (AGPL-3.0-or-later **or** commercial), the author must retain the full set
+of rights in all contributed premium code. This CLA records that.
+
+> **Status: draft.** This is a starting point, not legal advice. Before relying on it commercially,
+> have it reviewed by an IP lawyer, and consider a standard instrument (for example the Apache
+> Individual CLA, or a DCO for the core).
+
+## 1. Scope
+
+- Contributions to the **core** (everything outside `premium/`, licensed Apache-2.0) are accepted
+  **inbound = outbound**: you license your contribution under Apache-2.0. A Developer Certificate of
+  Origin (`Signed-off-by:`) sign-off is sufficient.
+- Contributions to **`premium/`** (dual-licensed) require agreeing to the terms below.
+
+## 2. Copyright license
+
+You grant the author (Ve / VAHPEM) a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
+copyright license to reproduce, prepare derivative works of, publicly display, sublicense, and
+distribute your contribution and such derivative works, **including the right to license your
+contribution under both the AGPL-3.0-or-later and separate commercial terms.**
+
+You retain all other rights, title, and interest in your contribution, and may use it elsewhere.
+
+## 3. Patent license
+
+You grant the author and recipients a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
+patent license to make, use, sell, and otherwise transfer your contribution, for patent claims you
+can license that are necessarily infringed by your contribution alone or in combination with the
+project.
+
+## 4. Your representations
+
+- The contribution is your original work, or you have the right to submit it under this CLA.
+- The contribution does not knowingly violate any third party's rights.
+- If your employer has rights to work you create, you have permission to contribute, or your
+  employer has waived such rights for contributions to this project.
+
+## 5. No warranty
+
+The contribution is provided "as is", without warranty of any kind.
+
+---
+
+To agree: add a `Signed-off-by: Name <email>` line to your commits (DCO) for core, and for premium
+contributions state in your pull request that you agree to this CLA.

rust_deobf-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Ve Pham (VAHPEM)
+
+   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.

rust_deobf-0.1.0/LICENSING.md

@@ -0,0 +1,46 @@
+# Licensing
+
+rust-deobf uses an **open-core** model. There are two tiers, with different licenses.
+
+## Core — Apache License 2.0
+
+Everything in the repository **except** the `premium/` directory is licensed under the
+Apache License 2.0 (see [`LICENSE`](LICENSE)). This is a permissive, OSI-approved license:
+you may use it, including in closed-source and commercial products, with attribution and
+subject to Apache 2.0's patent terms. The core is, and will stay, free.
+
+This covers detection (including VM / anti-emulation detection), string and
+metadata recovery, artifact/IOC extraction, and the SOC triage pipeline — the
+capabilities that make the free tool useful on its own.
+
+## Premium modules — AGPL-3.0-or-later OR Commercial
+
+Modules under the `premium/` directory are **dual-licensed**:
+
+> Licensed under the GNU Affero General Public License v3.0 **or later**
+> (AGPL-3.0-or-later), **OR** under a separate commercial license.
+> Contact the author for commercial licensing.
+
+- **AGPL-3.0-or-later** — free for open-source, research, and personal use. Note the AGPL's
+  network clause: if you run a modified version of a premium module as a network service,
+  you must offer that service's users the corresponding source. See [`premium/LICENSE`](premium/LICENSE).
+- **Commercial license** — for using a premium module in a closed-source product or a hosted
+  service without the AGPL's source-disclosure obligations. Contact
+  **Ve (VAHPEM) <ve0912084386@gmail.com>**.
+
+Each file under `premium/` carries an `SPDX-License-Identifier` header stating its license.
+The per-file SPDX header is authoritative; GitHub's repository-level license badge reflects the
+Apache-2.0 core only and does **not** relicense the premium modules.
+
+## Why two tiers
+
+The core is a public good and a *produit d'appel* — it builds reputation and adoption. The
+premium modules are the high-effort capabilities whose value the author chooses to protect and,
+optionally, monetize. Keeping the copyright wholly with the author (see [`CLA.md`](CLA.md)) is
+what makes the dual license possible.
+
+## Contributing
+
+Contributions to **core** are accepted under Apache-2.0 inbound=outbound. Contributions to
+**premium/** require signing the [Contributor License Agreement](CLA.md) so the dual-license can
+be maintained. See [`CLA.md`](CLA.md).

rust_deobf-0.1.0/MANIFEST.in

@@ -0,0 +1,7 @@
+# sdist of the core (rust-deobf). The package modules, scripts/data/*.json, pyproject.toml,
+# setup.py, README.md and LICENSE are added by setuptools; premium/, tests/, bench_src/, build/,
+# gallery/ and assets/ are deliberately NOT in the core sdist (premium/ is its own distribution).
+include CHANGELOG.md LICENSING.md CLA.md
+prune premium
+prune tests
+prune build