開発者ガイド[Ghidraドキュメント]

• Java JDK 11 (64-bit)－JDK 11の無料のロング・ターム・サポート（LTS）バージョンは、以下によって提供されます。：
  • AdoptOpenJDK
    • https://adoptopenjdk.net/releases.html?variant=openjdk11&jvmVariant=hotspot
  • • https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html
• Gradle 5.0以降－私たちは、バージョン5.0を使用し、最高6.8.3.でテストします。
  • https://gradle.org/next-steps/?version=5.0&format=bin
• C/C++コンパイラ - 私たちは、LinuxではGCC、macOSではXcode（Clang）、WindowsではVisual Studio（2017以降）を使用しています。
  • https://gcc.gnu.org/
  • https://developer.apple.com/xcode/
  • https://visualstudio.microsoft.com/downloads/

• Eclipse - JDK 11をサポートする必要があります。Eclipse 2018-12以降が機能するはずです。他のIDEも機能する可能性がありますが、私たちは、テストを行っていません。
  • https://www.eclipse.org/downloads/

• Git－私たちは、Windowsの公式インストーラを使用します。Windowsのために、あなたは、（WSL - LinuxのためのWindowsサブシステム）を持つ、githubのCLIやGitを使用もできます。ほとんどのLinuxディストリビューションは、それらのリポジトリに、Gitを持っています。Xcodeは、macOSで、Gitを提供します。あなたが、ghidraリポジトリの.zipファイルをダウンロードする場合、あなたは、Gitをスキップすることができます。
  • https://git-scm.com/downloads
  • https://cli.github.com/

• Bashは、LinuxとmacOSでは、議論の余地があります。Windowでは、私たちは、MinGWを使用します。これは、Window用のGitで、配布されるかもしれません。自動ビルドを使用している場合、これはスキップできます。
  • https://osdn.net/projects/mingw/releases/

• dex2jar. 私たちは、バージョン2.0を使用します。
  • https://github.com/pxb1988/dex2jar/releases
• AXMLPrinter2
  • https://code.google.com/archive/p/android4me/downloads
• HFS Explorer. 私たちは、バージョン0.21を使用します。
  • https://sourceforge.net/projects/catacombae/files/HFSExplorer/0.21/
  • https://github.com/unsound/hfsexplorer/releases （より新しいバージョン）
• さらに、もう一つのJavaサービス・ラッパ。私たちは、Ghidraパッケージをビルドするためだけに、バージョン12.12を使用します。
  • https://sourceforge.net/projects/yajsw/files/yajsw/yajsw-stable-12.12/
• Eclipse PDE － GhidraDevプラグインを開発するための環境。
  • https://www.eclipse.org/pde/
• Eclipse CDT. 私たちは、バージョン8.6.0に対して、ビルドします。－GhidraDevプラグインの依存関係を構築します。
  • https://www.eclipse.org/cdt/
• PyDev. 私たちは、バージョン6.3.1に対して、ビルドします。－GhidraDevプラグインの依存関係を構築します。
  • https://sourceforge.net/projects/pydev/files/pydev/

開発環境を、構築、および/または、設定するとき、Gradleによって、自動的に、Maven CentralとBintray JCenterからダウンロードされるものは他にもたくさんあります。あなたが、これらのオフラインを必要とする場合、理にかなった一連の行動は、開発環境をオンラインで設定することであり、おそらく、構造を実行し、続いて、Gradleのキャッシュをスクレイプします。

GitHubのdex2jarプロジェクトのリリースページから、dex-tools-2.0.zipをダウンロードします。libディレクトリから、~/git/ghidra/dependencies/flatRepoまでdex-*.jarファイルを解凍します：

cd ~/Downloads   # Or wherever
curl -OL https://github.com/pxb1988/dex2jar/releases/download/2.0/dex-tools-2.0.zip
unzip dex-tools-2.0.zip
cp dex2jar-2.0/lib/dex-*.jar ~/git/ghidra/dependencies/flatRepo/

code.google.comの"android4me"アーカイブから、AXMLPrinter2.jarをダウンロードします。 ~/git/ghidra/dependencies/flatRepoに、それを配置します。：

cd ~/git/ghidra/dependencies/flatRepo
curl -OL https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/android4me/AXMLPrinter2.jar

Get Dependencies for DMG:

www.catacombae.orgからhfsexplorer-0_21-bin.zipをダウンロードします。http://www.catacombae.org/ libディレクトリを ~/git/ghidra/dependencies/flatRepoに解凍します。：

cd ~/Downloads   # Or wherever
curl -OL https://sourceforge.net/projects/catacombae/files/HFSExplorer/0.21/hfsexplorer-0_21-bin.zip
mkdir hfsx
cd hfsx
unzip ../hfsexplorer-0_21-bin.zip
cd lib
cp csframework.jar hfsx_dmglib.jar hfsx.jar iharder-base64.jar ~/git/ghidra/dependencies/flatRepo/

Get Dependencies for GhidraServer

GhidraServerをビルドするには、「さらにもう一つのJavaサービス・ラッパ」（yajsw）バージョン12.12が必要です。www.sourceforge.netのプロジェクトから、yajsw-stable-12.12.zipを~/git/ghidra/dependencies/GhidraServer/にダウンロードし、以下に配置します。：

cd ~/Downloads   # Or wherever
curl -OL https://sourceforge.net/projects/yajsw/files/yajsw/yajsw-stable-12.12/yajsw-stable-12.12.zip
cp ~/Downloads/yajsw-stable-12.12.zip ~/git/ghidra/dependencies/GhidraServer/

Get Dependencies for GhidraDev

Eclipse用のGhidraDevプラグインをビルドするには、Eclipse用のCDTおよびPyDevプラグインが必要です。Eclipse Foundationから、cdt-8.6.0.zipをダウンロードし、次の場所に配置します。： ~/git/ghidra/dependencies/GhidraDev/：

cd ~/Downloads   # Or wherever
curl -OL 'https://archive.eclipse.org/tools/cdt/releases/8.6/cdt-8.6.0.zip'
curl -o 'cdt-8.6.0.zip.sha512' -L --retry 3 'https://www.eclipse.org/downloads/sums.php?type=sha512&file=/tools/cdt/releases/8.6/cdt-8.6.0.zip'
shasum -a 512 -c 'cdt-8.6.0.zip.sha512'
cp ~/Downloads/cdt-8.6.0.zip ~/git/ghidra/dependencies/GhidraDev/

www.pydev.orgから、PyDev 6.3.1.zipをダウンロードします。そして、同じディレクトリに、それを配置します。：

cd ~/Downloads   # Or wherever
curl -L -o 'PyDev 6.3.1.zip' https://sourceforge.net/projects/pydev/files/pydev/PyDev%206.3.1/PyDev%206.3.1.zip
cp ~/Downloads/'PyDev 6.3.1.zip' ~/git/ghidra/dependencies/GhidraDev/

Get Ghidra Function ID datasets

ghidra-data GitHubリポジトリから、Ghidra関数のIDデータセット・ファイルをダウンロードし、それらを、~/git/ghidra/dependencies/fidbに配置します。：

cd ~/Downloads   # Or wherever
curl -L -o 'vs2012_x64.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2012_x64.fidb
curl -L -o 'vs2012_x86.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2012_x86.fidb
curl -L -o 'vs2015_x64.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2015_x64.fidb
curl -L -o 'vs2015_x86.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2015_x86.fidb
curl -L -o 'vs2017_x64.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2017_x64.fidb
curl -L -o 'vs2017_x86.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2017_x86.fidb
curl -L -o 'vs2019_x64.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2019_x64.fidb
curl -L -o 'vs2019_x86.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2019_x86.fidb
curl -L -o 'vsOlder_x64.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vsOlder_x64.fidb
curl -L -o 'vsOlder_x86.fidb' https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vsOlder_x86.fidb
cp ~/Downloads/*.fidb ~/git/ghidra/dependencies/fidb/

Prepare the Environment

プロジェクト・ルートから、以下を実行します。：

gradle prepDev

prepDevタスクには、主に、いくつかのソースを生成する、私たちの組み込みのヘルプにインデックスを付け、いくつかの依存関係をアンパックすることが含まれています。

Import Eclipse Projects

Ghidraを開発して/変更するために、あなたは、最初に、Eclipseプロジェクトを生成するために、Gradleを使用する必要があります。プロジェクト・ルートから：

gradle eclipse

[ファイル]-> [インポート]を選択し、[全般]を展開して、[既存のプロジェクトをワークスペースに]を選択します。ソースリポジトリのルートを選択し、[ネストされたプロジェクトの検索]を選択します。すべて選択し、終了します。以下で説明するように、環境が、適切に準備されるまで、ビルド・パス・エラーが、表示される場合があります。

Building the natives

Ghidraのコンポーネントの一部は、ネイティブ・プラットフォームのために構築されます。私たちは、現在、Linux、macOS、Windowsの64bitのx86システムをサポートしています。他の可能性もあるはずですが、テストは行っていません。

次に、Gradleを使用してビルドします。：

gradle buildNatives_linux64

gradle buildNatives_osx64

gradle buildNatives_win64

これにより、逆コンパイラ、GNUツールチェーンのデマングラ、そりコンパイラ、および（Windowsの場合のみ）PDBパーサが構築されます。

Pre-compile Language Modules (optional)

オプションとして、すべての言語モジュールをプレコンパイルするために、あなたは、実行もするかもしれません。：

gradle sleighCompile

言語モジュールが、プレコンパイルされていない場合、Ghidraは、必要に応じて、実行時に、それらをコンパイルします。

Import and Build GhidraDev project (optional)

GhidraDev Eclipseプラグインを開発することは、EclipseマーケットプレイスからインストールできるEclipse PDE（プラグイン開発環境）が必要です。それは、RCPとRAP開発者のためのEclipse IDEにも含まれています。GhidraDev Eclipseプロジェクトを生成するために、以下を実行します。：

gradle eclipse -PeclipsePDE

新しく生成されたGhidraDevプロジェクトをEclipseにインポートします。

GhidraDevプラグインを、どのように構築するかについての説明のための~/git/ghidra/GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build_README.txtを参照してください。

Run and Debug Ghidra from Eclipse

EclipseからGhidraを実行、あるいは、デバッグするために、（通常、"Run"や"Debug"ボタンの下にある）提供されている起動構成を使用します。ランチャーが表示されない場合、それは、おそらく、お気に入りとして、マークされていません。[実行]ボタンの横にあるドロップダウンをクリックして、[構成の実行]を選択します。続いて、左側の[Javaアプリケーション]を展開して、[Ghidra]ランチャーを見つけます。

Running tests

単体テストを実行するために、以下を実行します。

gradle unitTestReport

より複雑な統合テストを実行する場合、以下を実行します。

gradle integrationTest

単体テストと統合テストを実行するために、そして、使用するレポートを生成します。

gradle combinedTestReport