mirror of
https://github.com/NationalSecurityAgency/ghidra
synced 2024-08-28 05:20:21 +00:00
GP-847: Improved README.md
This commit is contained in:
Ryan Kurtz
parent
512fc1b8b7
commit
7c82d7b7b5
113
README.md
113
README.md
|
|
@ -1,19 +1,116 @@
|
|||
<img src="Ghidra/Features/Base/src/main/resources/images/GHIDRA_3.png" width="400">
|
||||
|
||||
# Ghidra Software Reverse Engineering Framework
|
||||
|
||||
Ghidra is a software reverse engineering (SRE) framework created and maintained by the [National Security Agency][nsa] 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 plug-in components and/or scripts using Java or Python.
|
||||
Ghidra is a software reverse engineering (SRE) framework created and maintained by the
|
||||
[National Security Agency][nsa] 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.
|
||||
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.
|
||||
|
||||
To start developing extensions and scripts, try out the GhidraDev plugin for Eclipse, which is part of the distribution package. The full release build can be downloaded from our [project homepage][project].
|
||||
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][career].
|
||||
|
||||
This repository contains the source for the core framework, features, and extensions.
|
||||
If you would like to contribute, please take a look at our [contributor guide][contrib] to see how you can participate in this open source project.
|
||||
## Install
|
||||
To install an official pre-built multi-platform Ghidra release:
|
||||
* Install [JDK 11 64-bit][jdk11]
|
||||
* Download a Ghidra release file from [ghidra-sre.org][project]
|
||||
* Extract the Ghidra release file
|
||||
* Launch Ghidra: `./ghidraRun` (or `ghidraRun.bat` for Windows)
|
||||
|
||||
For additional information and troubleshooting tips about installing and running a Ghidra release,
|
||||
please refer to `docs/InstallationGuide.html` which can be found in your extracted Ghidra release
|
||||
directory.
|
||||
|
||||
## Build
|
||||
|
||||
To create the latest development build for your platform from this source repository:
|
||||
|
||||
##### Install build tools:
|
||||
* [JDK 11 64-bit][jdk11]
|
||||
* [Gradle][gradle] (minimum v5.0)
|
||||
* make, gcc, and g++ (Linux/macOS-only)
|
||||
* [Microsoft Visual Studio][vs] (Windows-only)
|
||||
|
||||
##### Download and extract the source:
|
||||
[Download from GitHub][master]
|
||||
```
|
||||
$ 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:
|
||||
```
|
||||
$ gradle -I gradle/support/fetchDependencies init
|
||||
```
|
||||
|
||||
##### 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 Guide][devguide].
|
||||
|
||||
## 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/`.
|
||||
|
||||
### 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:
|
||||
* Follow the above build instructions so the build completes without errors
|
||||
* Install [Eclipse IDE for Java Developers][eclipse]
|
||||
|
||||
##### Prepare the development environment (Linux-only, see **NOTE** for Windows/macOS):
|
||||
```
|
||||
$ gradle prepdev eclipse buildNatives_linux64
|
||||
```
|
||||
**NOTE:** If you are on a Windows or macOS platform, change `buildNatives_linux64` to
|
||||
`buildNatives_win64` or `gradle buildNatives_osx64`.
|
||||
|
||||
##### Import Ghidra projects into Eclipse:
|
||||
* *File* -> *Import...*
|
||||
* *General* | *Existing Projects into Workspace*
|
||||
* Select root directory to be your downloaded or cloned ghidra source repository
|
||||
* Check *Search for nested projects*
|
||||
* Click *Finish*
|
||||
|
||||
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 Guide][devguide].
|
||||
|
||||
## Contribute
|
||||
If you would like to contribute bug fixes, improvements, and new features back to Ghidra, please
|
||||
take a look at our [Contributor Guide][contrib] to see how you can participate in this open
|
||||
source project.
|
||||
|
||||
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][career].
|
||||
|
||||
[nsa]: https://www.nsa.gov
|
||||
[contrib]: CONTRIBUTING.md
|
||||
[devguide]: DevGuide.md
|
||||
[career]: https://www.intelligencecareers.gov/nsa
|
||||
[project]: https://www.ghidra-sre.org/
|
||||
[jdk11]: https://adoptopenjdk.net/releases.html?variant=openjdk11&jvmVariant=hotspot
|
||||
[gradle]: https://gradle.org/releases/
|
||||
[vs]: https://visualstudio.microsoft.com/vs/community/
|
||||
[eclipse]: https://www.eclipse.org/downloads/packages/
|
||||
[master]: https://github.com/NationalSecurityAgency/ghidra/archive/refs/heads/master.zip
|
||||
Loading…
Reference in a new issue