ghidra README

The project's README from github.com/NationalSecurityAgency/ghidra. As one markdown file: README.md.

Ghidra Software Reverse Engineering Framework

Ghidra is a software reverse engineering (SRE) framework created and maintained by the National Security Agency Research Directorate. This framework includes a suite of full-featured, high-end software analysis tools that enable users to analyze compiled code on a variety of platforms including Windows, macOS, and Linux. Capabilities include disassembly, assembly, decompilation, graphing, and scripting, along with hundreds of other features. Ghidra supports a wide variety of processor instruction sets and executable formats and can be run in both user-interactive and automated modes. Users may also develop their own Ghidra extension components and/or scripts using Java or Python.

In support of NSA's Cybersecurity mission, Ghidra was built to solve scaling and teaming problems on complex SRE efforts, and to provide a customizable and extensible SRE research platform. NSA has applied Ghidra SRE capabilities to a variety of problems that involve analyzing malicious code and generating deep insights for SRE analysts who seek a better understanding of potential vulnerabilities in networks and systems.

If you are a U.S. citizen interested in projects like this, to develop Ghidra and other cybersecurity tools for NSA to help protect our nation and its allies, consider applying for a career with us.

Security Warning

WARNING: There are known security vulnerabilities within certain versions of Ghidra. Before proceeding, please read through Ghidra's Security Advisories for a better understanding of how you might be impacted.

Install

To install an official pre-built multi-platform Ghidra release:

For additional information and troubleshooting tips about installing and running a Ghidra release, please refer to the Getting Started document which can be found at the root of a Ghidra installation directory.

Build

Build Ghidra

To create the latest development build for your platform from this source repository:

Install build tools:
Download and extract the source:

Download from GitHub

unzip ghidra-master
cd ghidra-master

NOTE: Instead of downloading the compressed source, you may instead want to clone the GitHub repository: git clone https://github.com/NationalSecurityAgency/ghidra.git

Download additional build dependencies into source repository:

NOTE: If an Internet connection is available and you did not install Gradle, the ./gradlew (or gradlew.bat) command may be used in place of the gradle command in the following instructions.

gradle -I gradle/support/fetchDependencies.gradle
Create development build:
gradle buildGhidra

The compressed development build will be located at build/dist/.

For more detailed information on building Ghidra, please read the Developer's Guide.

For issues building, please check the Known Issues section for possible solutions.

Develop

User Scripts and Extensions

Ghidra installations support users writing custom scripts and extensions via the GhidraDev plugin for Eclipse. The plugin and its corresponding instructions can be found within a Ghidra release at Extensions/Eclipse/GhidraDev/ or at this link. Alternatively, Visual Studio Code may be used to edit scripts by clicking the Visual Studio Code icon in the Script Manager. Fully-featured Visual Studio Code projects can be created from a Ghidra CodeBrowser window at Tools -> Create VSCode Module project.

NOTE: Both the GhidraDev plugin for Eclipse and Visual Studio Code integrations only support developing against fully built Ghidra installations which can be downloaded from the Releases page.

Advanced Development

To develop the Ghidra tool itself, it is highly recommended to use Eclipse, which the Ghidra development process has been highly customized for.

Install build and development tools:
Prepare the development environment:
gradle prepdev eclipse buildNatives
Import Ghidra projects into Eclipse:

When Eclipse finishes building the projects, Ghidra can be launched and debugged with the provided Ghidra Eclipse run configuration.

For more detailed information on developing Ghidra, please read the Developer's Guide.

Contribute

If you would like to contribute bug fixes, improvements, and new features back to Ghidra, please take a look at our Contributor's Guide to see how you can participate in this open source project.

ghidra (NationalSecurityAgency/ghidra)

Searching Database…

91.8K ·GitHub
Что это такое?Ghidra — это фреймворк для реверс-инжиниринга программного обеспечения (SRE), созданный и поддерживаемый Исследовательским управлением АНБ США. Он используется для дизассемблирования, декомпиляции, построения графов и анализа скомпилированного кода.
Это GUI-приложение или инструмент командной строки?В основном это настольное GUI-приложение с полным набором мощных средств анализа (дизассемблирование, декомпиляция, построение графов), но его также можно запускать в безголовом (headless) режиме для автоматизации и писать для него скрипты на Java или Python.
Как установить и запустить Ghidra?Установите JDK 21 64-bit, скачайте официальный многоплатформенный zip-архив релиза со страницы Releases, распакуйте его, затем запустите ./ghidraRun (ghidraRun.bat в Windows) или ./support/pyghidraRun для запуска на основе Python через PyGhidra.
Что нужно установить перед сборкой из исходников, а не использованием релиза?Для сборки из исходников нужны JDK 25 64-bit, Gradle 9.1.0+ (или обёртка gradlew), Python3 версий 3.9–3.14 с pip, а также GCC/Clang и make в Linux/macOS или Visual Studio/MSVC Build Tools с Windows SDK и C++ ATL в Windows.
Кто обычно пользуется Ghidra?Специалисты по безопасности, аналитики вредоносного ПО и реверс-инженеры, которым нужно анализировать скомпилированный код, чтобы понимать уязвимости в сетях и системах.
Можно ли писать свои скрипты или расширения для Ghidra?Да, пользователи могут писать собственные скрипты и расширения на Java или Python с помощью плагина GhidraDev для Eclipse или редактировать скрипты через интеграцию с Visual Studio Code.
Можно ли запускать Ghidra в автоматическом режиме без участия пользователя?Да, Ghidra может работать как в интерактивном режиме с участием пользователя, так и в автоматическом, что полезно для масштабного или скриптового анализа.
Зачем АНБ создало и выпустило Ghidra?АНБ создало Ghidra, чтобы решить проблемы масштабирования и совместной работы над сложными проектами реверс-инжиниринга программного обеспечения, а также предоставить настраиваемую и расширяемую исследовательскую платформу в поддержку своей миссии в области кибербезопасности.
Какие типы бинарных файлов может анализировать Ghidra?Ghidra поддерживает широкий спектр наборов инструкций процессоров и форматов исполняемых файлов, что позволяет дизассемблировать и декомпилировать код с множества различных платформ.
Size
405.9 MB
Stars
91.8K
Age
7y
Commits · 90 Days