D-810 ng (Next Generation) is an IDA Pro plugin which can be used to deobfuscate code at decompilation time by modifying IDA Pro microcode. It was designed with the following goals in mind:
- It should have as least as possible impact on our standard reverse engineering workflow
- Fully integrated to IDA Pro
- It should be easily extensible and configurable
- Fast creation of new deobfuscation rules
- Configurable so that we don't have to modify the source code to use rules for a specific project
- Performance impact should be reasonable
- Our goal is to be transparent for the reverse engineer
- But we don't care if the decompilation of a function takes 1 more second if the resulting code is much simpler.
Only IDA v9 or later is supported with Python 3.10 and higher (since we need the microcode Python API)
Copy the contents of this repository to .idapro/plugins
or %appdata%\Hex-Rays\IDA pro\plugins
.
It is recommended to install Z3 to be able to use several features of D-810:
pip3 install z3-solver
- Load the plugin by using the
Ctrl-Shift-D
shortcut, you should see this configuration GUI
- Choose or create your project configuration
- If you are not sure what to do here, leave default_instruction_only.json.
- Click on the
Start
button to enable deobfuscation - Decompile an obfuscated function, the code should be simplified (hopefully)
- When you want to disable deobfuscation, just click on the
Stop
button.
D-810 ng comes with a built-in test runner that automatically loads system tests from the tests folder, under tests/system
. This GUI is a simple test runner that allows a developer to run tests inside of IDA Pro, accessing the hexrays decompiler API and utilizing specific samples under samples/bins
to test transformations.
The test runner is self-explanatory:
Test reloading exists without needing to restart IDA Pro
and you can execute different part of the tests via the testing context menu:
In samples/src
, there are various C
programs compiled using the samples/src/Makefile
into a shared library, without optimizations (-O0
). On Windows, that shared library is a .dll
, on Darwin(Mac)/Linux, it is a .so
. Included is an example compiled dll, libobfuscated.dll
, that can serve as a testing ground for seeing the plugin in action. Please make a pull request with more obfuscation C
examples to build a repository of obfuscated sample code for further research.
The sample binaries are built via the samples/Makefile
. You can cross-target OS and architecture.
- Default output name:
bins/<binary_name>_<hostos>_<arch>.<suffix>
<binary_name>
defaults tolibobfuscated
(override withBINARY_NAME
)<hostos>
is the system you build on:windows
,darwin
, orlinux
<arch>
is the requested build arch (normalized):x86_64
,x86
,arm64
, …<suffix>
comes from the target OS:dll
(windows),dylib
(darwin),so
(linux)
- If you explicitly set
BINARY_NAME
(env or CLI), the output name is simplified to:bins/<BINARY_NAME>.<suffix>
Flags you can pass to make
:
TARGET_OS
(default:windows
)- One of:
windows
,darwin
,linux
,native
(uses the host OS)
- One of:
BUILD_ARCH
(default:x86_64
)- Examples:
x86_64
,x86
,arm64
- Also accepts explicit compiler flags (e.g.,
-m64
,-m32
) - On macOS we use
-arch <name>
under the hood (e.g.,-arch x86_64
)
- Examples:
BINARY_NAME
(default:libobfuscated
)
Notes:
- Builds are unoptimized by default:
-O0 -g
and inlining/vectorization are disabled. - We rely on the host toolchain for linking.
TARGET_OS
selects the output suffix; cross-linking toolchains are up to your environment.
Examples (run from the repo root):
# Build defaults: Windows DLL for x86_64; name includes your host OS
cd samples && make
# → bins/libobfuscated_<hostos>_x86_64.dll
# Build Linux .so for arm64
make TARGET_OS=linux BUILD_ARCH=arm64
# → bins/libobfuscated_<hostos>_arm64.so
# Build macOS .dylib for x86_64
make TARGET_OS=darwin BUILD_ARCH=x86_64
# → bins/libobfuscated_<hostos>_x86_64.dylib
# Build for the native host OS, 32-bit x86
make TARGET_OS=native BUILD_ARCH=x86
# → bins/libobfuscated_<hostos>_x86.<ext>
# Customize the base name (explicit BINARY_NAME removes host/arch suffixes)
make BINARY_NAME=libobfuscatedv2
# → bins/libobfuscatedv2.<ext>
# Clean artifacts
make clean
This plugin is still in early stage of development, so issues may will happen.
- Modifying incorrectly IDA microcode may lead IDA to crash. We try to detect that as much as possible to avoid crash, but since it may still happen save you IDA database often
- Plugin is tested on Windows, Mac and Linux.
Work in progress
Currently, you can read our blog post to get some information.
This library is licensed under LGPL V3 license. See the LICENSE file for details.
See AUTHORS for the list of contributors to the project.
Rolf Rolles for the huge work he has done with his HexRaysDeob plugin and all the information about Hex-Rays microcode internals described in his blog post. We are still using some part of his plugin in D-810.
Dennis Elser for the genmc plugin plugin which was very helpful for debugging D-810 errors.
A special thank you to Boris Batteux for this great plugin!