binaryninja apiダウンロード - binaryninja apiソースコードのダウンロード

binaryninja api

その他のカテゴリー

1.0.0

ダウンロード

バイナリNinja API

このリポジトリには、Binary Ninja リバースエンジニアリングプラットフォーム用の C++、Python、および Rust API のドキュメントとソースコードが含まれています。

ドキュメント

次の API については、オンラインドキュメントを利用できます。

C++ API、安定版ブランチ
Python API、安定版ブランチ
Python API、開発ブランチ
Rust API、安定版ブランチ
Rust API、開発ブランチ

使用法と組み立て説明書

Binary Ninja API を構築するには、ファイルapi_REVISION.txtのハッシュと一致する特定のリビジョンを使用する必要があります。このファイルは、Linux および Windows のルートインストールフォルダー、または macOS のアプリのContents/Resourcesサブフォルダーに配置する必要があります。これを行う最も簡単な方法は、このリポジトリのクローンを作成し (またはサブモジュールとして追加し)、 git checkout $(cat api_REVISION.txt | awk -F/ '{print $NF}')のようなことを実行することです。 cmakeなどを使用してこれを設定する方法のドキュメントは、ここにあります。

C++ を使用して Binary Ninja プラグインを作成するには、C++ API をビルドする必要があります。 API ライブラリの構築は、ほとんどの CMake ベースのプロジェクトと同様に行われます。基本的な手順の概要は次のとおりです。

 # Get the source
git clone https://github.com/Vector35/binaryninja-api.git
cd binaryninja-api
git submodule update --init --recursive

# Configure an out-of-source build setup
cmake -S . -B build # (additional arguments go here if needed)

# Compile
cmake --build build -j8

デフォルトのビルド設定に加えて、次のことを行うこともできます。

ビルド例。 API サンプルをビルドするには、ビルドの構成時に-DBN_API_BUILD_EXAMPLES=ONを CMake に渡します。ビルドが成功したら、 installターゲットを実行して、ビルドされたプラグインをインストールできます。「Unix Makefiles」ビルドジェネレーターを使用する場合、これはmake installのようになります。
UIプラグインを構築します。 UI プラグインを構築するには、Qt 6.7.2 (執筆時点) がインストールされている必要があります。
ヘッドレスで構築します。ヘッドレス Binary Ninja ディストリビューションを使用している場合、または UI プラグインをビルドしたくない場合は、ビルドの構成時に-DHEADLESS=ONを CMake に渡します。

トラブルシューティング

Binary Ninja がプラットフォームのデフォルト (CMakeLists.txt で定義) とは異なる場所にインストールされている場合、「Binary Ninja Core Not Found」というエラーが表示される可能性があります。ビルドセットアップの構成時に-DBN_INSTALL_DIR=/path/to/binaryninja CMake に渡すことで、Binary Ninja インストールへのパスを指定します。
Binary Ninja は 64 ビット専用の製品であるため、必ず 64 ビットのコンパイルおよびリンク環境を使用してください。 LNK1107などの Windows のエラーは、ビットが一致していないことを示している可能性があります。

例

多くの例が利用可能です。 Python サンプルフォルダーには、Python API のさまざまなアプリケーションが示されています。C++ サンプルには次のものが含まれます。

background_task は、バックグラウンドタスクの管理を示すプラグインです。*
bin-info は、特定のバイナリに関する情報を端末に出力するスタンドアロンの実行可能ファイルです。*
Breakpoint は、x86 バイナリ内の領域を選択し、コンテキストメニューを使用してその領域にブレークポイントバイトを入力できるようにするプラグインです。
command-line disassm は、コマンドラインに逆アセンブリをダンプする方法を示します。*
llil-parser は低レベル IL を解析し、型を照合してビジタークラスを使用する方法を示します。*
mlil-parser は中レベル IL を解析し、型を照合してビジタークラスを使用する方法を示します。*
print_syscalls は、指定されたバイナリで使用される syscall を出力するスタンドアロンの実行可能ファイルです。*
triage は、デフォルトで有効になっているフル機能のプラグインで、QT を介した UI の拡張など、さまざまなタスクを実行する方法を示します。
workflows は、ワークフローを使用して分析パイプラインを拡張する方法を示すプラグインのコレクションです。
x86 拡張機能は、完全な置き換えを作成せずに、組み込みアーキテクチャの動作を変更する方法を示すアーキテクチャ拡張機能を作成します。

* ヘッドレス API アクセスをサポートするライセンスが必要です。

問題

このリポジトリの問題トラッカーは、ここに含まれるソースコードの問題だけでなく、より広範な Binary Ninja 製品の問題も追跡します。

支店

このリポジトリには、 devとmaster 2 つのプライマリブランチがあります。

devブランチには最新のアップデートがあり、Binary Ninja の最新の開発ビルドを追跡します。プルリクエストはこのブランチに対して行う必要があります。 masterブランチは、Binary Ninja の安定したビルドを追跡します。 Binary Ninja を初めてインストールした場合は、安定版リリースチャネルを使用している可能性があります。

貢献する

このリポジトリへの一般からの貢献を歓迎します。このリポジトリ内の API とドキュメントのほとんどは MIT ライセンスに基づいてライセンスされていますが、API はクローズドソースの商用アプリケーションである Binary Ninja と連携します。さらに、Rust API は Apache 2.0 ライセンスに基づいてライセンスされています。

最初の PR を送信するときに貢献に興味がある場合は、オンラインで貢献ライセンス契約に署名できるようにする通知が CLA アシスタントから届きます。