Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/airbus-cert/Yagi
Yet Another Ghidra Integration for IDA
https://github.com/airbus-cert/Yagi
decompiler disassembler ghidra ida-plugin reverse-engineering
Last synced: about 2 months ago
JSON representation
Yet Another Ghidra Integration for IDA
- Host: GitHub
- URL: https://github.com/airbus-cert/Yagi
- Owner: airbus-cert
- License: apache-2.0
- Created: 2021-09-07T08:48:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-04T15:01:49.000Z (over 2 years ago)
- Last Synced: 2024-08-05T17:27:25.243Z (5 months ago)
- Topics: decompiler, disassembler, ghidra, ida-plugin, reverse-engineering
- Language: C++
- Homepage:
- Size: 36.5 MB
- Stars: 477
- Watchers: 22
- Forks: 39
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - airbus-cert/Yagi - Yet Another Ghidra Integration for IDA (C++)
README
# Yagi
Yet Another Ghidra Integration for IDA
## Overview
Yagi intends to include the wonderful [Ghidra](https://github.com/NationalSecurityAgency/ghidra) decompiler into both [IDA pro](https://hex-rays.com/ida-pro/) and [IDA Free](https://hex-rays.com/ida-free/).
:package: **You can download installers for Windows and Linux versions [here](https://github.com/airbus-cert/Yagi/releases), then press F3 and enjoy!** :package:
Here is the list of architectures that Yagi can decompile at the moment:
|Arch Names|Yagi|
|----------|-----------|
|x86|✔️|
|x86_64|✔️|
|arm|✔️|
|aarch64(armv8)|✔️|
|powerpc|✔️|
|mips|✔️|
|sparc|✔️|
|avr8|✔️|
|6502|✔️|
|z80|✔️|
|eBPF|:bee:✔️:bee:|
|cp1600|❌|
|cr16|❌|
|dalvik|❌|
|jvm|❌|
|tricore|❌|
|riscv|❌|
|System Z|❌|
|xCore|❌|
|68000|❌|
It's easy to add one if it's supported by Ghidra. Just open an issue, and we will do our best!
It allows you to edit the following items:
* Global Symbol like function prototype, global variable, etc.
* Local stack variables name and type
* Local registry variables name and type
|Key|Interact|
|----------|-----------|
|Decompile| :computer_mouse: Place cursor on function :keyboard: **F3** |
|Edit Type| :keyboard: **Y** |
|Clear Type| :keyboard: **C** |
|Edit Name| :keyboard: **N** |
|Cross References| :keyboard: **X** |
|Navigate| :computer_mouse: **Double Click** on keyword |
:floppy_disk: **Changes are save into IDA database** :floppy_disk:
## Build
As `Yagi` is built using git `submodules` to handle Ghidra dependencies, you will first need to do a *recursive* clone:
```
git clone https://github.com/airbus-cert/Yagi --recursive
```
### For Windows
#### Install Dependencies
As Ghidra uses `bison` and `flex` to parse the `sleigh` grammar, we need first to install build dependencies from [here](https://github.com/lexxmark/winflexbison/releases/)
You also need the `IDA` SDK associated with your version of IDA.
#### Cmake
Yagi's build system is based on cmake; you can find an MSI package [here](https://github.com/Kitware/CMake/releases/).
You need at least a Visual Studio compiler with C++ toolchain.
#### Production
To generate a Wix installer, you need to install [WiX](https://github.com/wixtoolset/wix3/releases) before.
Then, let the `cmake` magic happen:
```
git clone https://github.com/airbus-cert/Yagi --recursive
mkdir build_yagi
cd build_yagi
cmake ..\Yagi -DIDA_SDK_SOURCE_DIR=[PATH_TO_IDA_SDK_ROOT_FOLDER] -DCPACK_PACKAGE_INSTALL_DIRECTORY="IDA Pro 7.6"
cmake --build . --target package --config release
```
A new `yagi-1.0.0-win64.msi` will be generated. It will contain all the necessary dependencies to install the plugin.
#### Development
To create a dev environment you need to generate the Visual Studio solution:
```
git clone https://github.com/airbus-cert/Yagi --recursive
mkdir build_yagi
cd build_yagi
cmake ..\Yagi -DIDA_SDK_SOURCE_DIR=[PATH_TO_IDA_SDK_ROOT_FOLDER] -DBUILD_TESTS=ON
```
`PATH_TO_IDA_SDK_ROOT_FOLDER` represents the root path of the decompressed archive provided by Hex-Rays.
To launch unit tests, just use `ctest` installed with `cmake`:
```
cd tests
ctest -VV
```
### For Linux
#### Install Dependencies
As Ghidra uses `bison` and `flex` to parse the `sleigh` grammar and Yagi is built using Cmake and C++, you will need the following:
```
apt install cmake c++ git flex bison yacc
```
#### Production
To generate an installer script:
```
git clone https://github.com/airbus-cert/Yagi --recursive
mkdir build_yagi
cd build_yagi
cmake ../Yagi -DIDA_SDK_SOURCE_DIR=[PATH_TO_IDA_SDK_ROOT_FOLDER]
cmake --build . --target package --config release
```
This will produce a `yagi-1.0.0-Linux.sh` script. Then you just have to launch it:
```
./yagi-1.0.0-Linux.sh --prefix=[PATH_TO_IDA_INSTALL_FOLDER]
y
n
```
Enjoy!
#### Development
To generate a dev environment you need to generate the Makefile:
```
git clone https://github.com/airbus-cert/Yagi --recursive
mkdir build_yagi
cd build_yagi
cmake ../Yagi -DIDA_SDK_SOURCE_DIR=[PATH_TO_IDA_SDK_ROOT_FOLDER] -DBUILD_TESTS=ON -DCMAKE_BUILD_TYPE=Debug
make
```
To launch unit tests, just use `ctest` installed with `cmake`:
```
cd tests
ctest -VV
```
## TODO
* Handle enum types
* Add rules to handle end function computation on AARCH64
* Change constant type (key H, R)
## Credits and references
Thanks [Ghidra](https://ghidra-sre.org/) development team to open sources this master piece of software.
Thanks [Hex-Ray](https://hex-rays.com/) teams to built a very extensible software.