yztgx / retdec-idaplugin

IDA plugin for RetDec

RetDec IDA plugin

RetDec plugin for IDA (Interactive Disassembler).

The plugin is compatible with IDA versions >= 6.6.

Requirements

Note: These are requirements to build the RetDec IDA plugin, not to run it. See our User Guide for information on plugin installation, configuration, and use.

• A compiler supporting C++14
  • On Windows, only Microsoft Visual C++ is supported (version >= Visual Studio 2015).
• CMake (version >= 3.6)
• IDA SDK (version == 6.6)
• IDA plugin libraries
  • You can build your own IDA plugin libraries with scripts/download-and-build-libs.sh. This requires the Linux bash shell. On Windows, you need to install and configure an environment like MSYS2. You can follow RetDec's Windows environment setup guide to help you get everything you need.

Build and Installation

• Recursively clone the repository (it contains submodules):
  • git clone --recursive https://github.com/avast-tl/retdec-idaplugin.git
• Linux:
  • cd retdec-idaplugin
  • mkdir build && cd build
  • cmake .. -DIDAPLUGIN_LIBS_DIR=<path> -DIDA_SDK_DIR=<path>
  • make && make install
• Windows:
  • Open MSBuild command prompt, or any terminal that is configured to run the msbuild command.
  • cd retdec-idaplugin
  • mkdir build && cd build
  • cmake .. -DIDAPLUGIN_LIBS_DIR=<path> -DIDA_SDK_DIR=<path> -G<generator>
  • msbuild /m /p:Configuration=Release retdec-idaplugin.sln
  • msbuild /m /p:Configuration=Release INSTALL.vcxproj
  • Alternatively, you can open retdec-idaplugin.sln generated by cmake in Visual Studio IDE.

You must pass the following parameters to cmake:

• -DIDAPLUGIN_LIBS_DIR=</path/to/idaplugin/libs> to tell cmake where the IDA plugin libraries are located.
• -DIDA_SDK_DIR=</path/to/idasdk> to tell cmake where the IDA SDK is located.
• (Windows only) -G<generator> is -G"Visual Studio 14 2015" for 32-bit build using Visual Studio 2015, or -G"Visual Studio 14 2015 Win64" for 64-bit build using Visual Studio 2015. Later versions of Visual Studio may be used.

You can pass the following additional parameters to cmake:

• -DIDA_PATH=</path/to/ida> to tell cmake where to install the plugin. If specified, installation will copy plugin binary into IDA_PATH/plugins, and content of scripts/idc directory into IDA_PATH/idc. If not set, installation step does nothing.

User Guide

Note: The user guide, in its present state, assumes that the RetDec IDA plugin is downloaded as a binary package from the RetDec official web page. This will be fixed in the future. You can still use it to learn about the plugin, just use files built in this repository instead of those distributed in a binary package.

The user guide in a PDF form is located in doc/user_guide/user_guide.pdf.

You can build your own guide by running make in doc/user_guide directory:

• Requires GNU make.
• Requires LaTeX, LaTeX packages, and related tools.
• The resulting PDF will overwrite the original user_guide.pdf.

License

Copyright (c) 2017 Avast Software, licensed under the MIT license. See the LICENSE file for more details.

RetDec IDA plugin uses third-party libraries or other resources listed, along with their licenses, in the LICENSE-THIRD-PARTY file.

Contributing

See RetDec contribution guidelines.