Ghidrassistmcp

🚀 GhidrAssistMCP

GhidrAssistMCPは、強力なGhidra拡張機能です。MCP（Model Context Protocol）サーバーを提供し、AIアシスタントやその他のツールが標準化されたAPIを通じてGhidraのリバースエンジニアリング機能と相互作用できるようにします。

🚀 クイックスタート

GhidrAssistMCPは、AIによる分析ツールとGhidraの包括的なリバースエンジニアリングプラットフォームを橋渡しします。Model Context Protocolを実装することで、この拡張機能は外部のAIアシスタント、自動分析ツール、およびカスタムスクリプトがGhidraの分析機能とシームレスに相互作用できるようにします。

✨ 主な機能

• MCPサーバー統合：公式SDKを使用した完全なModel Context Protocolサーバーの実装
• 31の組み込みツール：関数、データ、相互参照などをカバーする包括的な分析ツールセット
• 設定可能なUI：ツールの管理とアクティビティの監視に便利な使いやすいインターフェース
• リアルタイムロギング：すべてのMCPリクエストとレスポンスを詳細なログで追跡
• 動的ツール管理：個別のツールを有効/無効にし、設定を永続化
• 現在のコンテキスト認識：Ghidraの現在のカーソル位置とアクティブな関数を理解するツール

📦 インストール

前提条件

• Ghidra 11.4以上 (Ghidra 11.4 Publicでテスト済み)
• MCPクライアント（GhidrAssistなど）

バイナリリリース（推奨）

1. 最新のリリースをダウンロード：
   • リリースページにアクセスします。
   • 最新の.zipファイル（例：GhidrAssistMCP-v1.0.0.zip）をダウンロードします。
2. 拡張機能をインストール：
   • Ghidraで、File → Install Extensions → Add Extension を選択します。
   • ダウンロードしたZIPファイルを選択します。
   • 指示に従ってGhidraを再起動します。
3. プラグインを有効にする：
   • File → Configure → Configure Plugins を選択します。
   • "GhidrAssistMCP"を検索します。
   • チェックボックスをオンにしてプラグインを有効にします。

ソースからビルド

1. リポジトリをクローン：

   git clone <repository-url>
   cd GhidrAssistMCP
   

2. Ghidraのインストールパスを設定：

   export GHIDRA_INSTALL_DIR=/path/to/your/ghidra/installation
   

3. 拡張機能をビルド：

   gradle buildExtension
   

4. 拡張機能をインストール：
   • dist/ディレクトリから生成されたZIPファイルをコピーします。
   • Ghidraで、File → Install Extensions → Add Extension を選択します。
   • ZIPファイルを選択し、Ghidraを再起動します。
5. プラグインを有効にする：
   • File → Configure → Configure Plugins を選択します。
   • "GhidrAssistMCP"を検索します。
   • チェックボックスをオンにしてプラグインを有効にします。

📚 ドキュメント

初期設定

1. コントロールパネルを開く：
   • Window → GhidrAssistMCP（またはツールバーアイコンを使用）
2. サーバー設定を構成する：
   • ホスト：デフォルトはlocalhost
   • ポート：デフォルトは8080
   • 有効/無効：MCPサーバーのオン/オフを切り替えます。

ツール管理

設定タブでは、次のことができます。

• すべての利用可能なツールを表示（合計31個）
• チェックボックスを使用して個々のツールを有効/無効にする
• 設定を保存してセッション間で永続化する
• ツールの状態をリアルタイムで監視する

利用可能なツール

プログラム分析

• get_program_info - 基本的なプログラム情報を取得する
• list_functions - プログラム内のすべての関数をリストする
• list_data - データ定義をリストする
• list_strings - 文字列参照をリストする
• list_imports - インポートされた関数をリストする
• list_exports - エクスポートされた関数をリストする
• list_segments - メモリセグメントをリストする
• list_namespaces - 名前空間をリストする
• list_classes - クラス定義をリストする
• list_methods - メソッド定義をリストする

関数分析

• get_function_info - 詳細な関数情報を取得する
• get_class_info - 詳細なクラス情報を取得する
• get_function_by_address - 特定のアドレスの関数を見つける
• get_current_function - カーソル位置の関数を取得する
• decompile_function - 関数をC言語のようなコードに逆コンパイルする
• disassemble_function - アセンブリ逆アセンブルを取得する
• search_functions - 名前パターンで関数を検索する
• search_classes - 名前パターンでクラスを検索する
• function_xrefs - 関数の相互参照を取得する

位置とナビゲーション

• get_current_address - 現在のカーソルアドレスを取得する
• xrefs_to - アドレスへの参照を見つける
• xrefs_from - アドレスからの参照を見つける

変更ツール

• rename_function - 関数をリネームする
• rename_function_by_address - 特定のアドレスの関数をリネームする
• rename_variable - 変数をリネームする
• rename_data - データ定義をリネームする
• set_function_prototype - 関数のシグネチャを設定する
• set_local_variable_type - 変数のデータ型を設定する
• set_disassembly_comment - 逆アセンブルコメントを追加する
• set_decompiler_comment - 逆コンパイルコメントを追加する

高度な分析

• auto_create_struct - 変数の使用パターンから構造体を自動的に作成する

💻 使用例

基本的なプログラム情報

{
  "method": "tools/call",
  "params": {
    "name": "get_program_info"
  }
}

関数分析

{
  "method": "tools/call",
  "params": {
    "name": "get_function_info",
    "arguments": {
      "function_name": "main"
    }
  }
}

逆コンパイル

{
  "method": "tools/call",
  "params": {
    "name": "decompile_function",
    "arguments": {
      "function_name": "encrypt_data"
    }
  }
}

構造体の作成

{
  "method": "tools/call",
  "params": {
    "name": "auto_create_struct",
    "arguments": {
      "function_identifier": "0x00401000",
      "variable_name": "ctx"
    }
  }
}

関数のプロトタイプの設定

{
  "method": "tools/call",
  "params": {
    "name": "set_function_prototype",
    "arguments": {
      "function_address": "0x00401000",
      "prototype": "int main(int argc, char** argv)"
    }
  }
}

🔧 技術詳細

コアコンポーネント

GhidrAssistMCP/
├── GhidrAssistMCPPlugin      # メインプラグインのエントリポイント
├── GhidrAssistMCPServer      # HTTP/SSE MCPサーバー
├── GhidrAssistMCPBackend     # ツールの管理と実行
├── GhidrAssistMCPProvider    # UIコンポーネントのプロバイダー
└── tools/                    # 個々のMCPツール
    ├── Analysis Tools/
    ├── Modification Tools/
    └── Navigation Tools/

MCPプロトコルの実装

• トランスポート：Server-Sent Events (SSE)を使用したHTTP
• エンドポイント：
  • GET /sse - 双方向通信のためのSSE接続
  • POST /message - メッセージ交換エンドポイント
• ツール登録：動的なツールの検出と登録
• セッション管理：適切なライフサイクル管理を備えたステートフルセッション

プラグインアーキテクチャ

1. オブザーバーパターン：イベントリスナーを使用した分離されたUI更新
2. トランザクション管理：ロールバックサポートを備えた安全なデータベース操作
3. ツールレジストリ：有効/無効化機能を備えた動的なツール登録
4. 設定の永続化：Ghidraの設定システムに保存される構成
5. スレッドセーフティ：UI操作のための適切なSwing EDT処理

開発

プロジェクト構造

src/main/java/ghidrassistmcp/
├── GhidrAssistMCPPlugin.java      # メインプラグインクラス
├── GhidrAssistMCPProvider.java    # タブ付きのUIプロバイダー
├── GhidrAssistMCPServer.java      # MCPサーバーの実装
├── GhidrAssistMCPBackend.java     # バックエンドのツール管理
├── McpBackend.java                # バックエンドインターフェース
├── McpTool.java                   # ツールインターフェース
├── McpEventListener.java          # イベント通知インターフェース
└── tools/                         # ツールの実装
    ├── ProgramInfoTool.java
    ├── ListFunctionsTool.java
    ├── DecompileFunctionTool.java
    ├── AutoCreateStructTool.java
    └── ... (合計29個のツール)

新しいツールの追加

1. McpToolインターフェースを実装する：

   public class MyCustomTool implements McpTool {
       @Override
       public String getName() { return "my_custom_tool"; }
       
       @Override
       public String getDescription() { return "Description"; }
       
       @Override
       public McpSchema.JsonSchema getInputSchema() { /* ... */ }
       
       @Override
       public McpSchema.CallToolResult execute(Map<String, Object> arguments, Program program) {
           // 実装
       }
   }
   

2. バックエンドに登録する：

   // GhidrAssistMCPBackendコンストラクタ内
   registerTool(new MyCustomTool());
   

ビルドコマンド

# クリーンビルド
gradle clean

# 拡張機能をビルド
gradle buildExtension

# 特定のGhidraパスでビルド
gradle -PGHIDRA_INSTALL_DIR=/path/to/ghidra buildExtension

# デバッグビルド
gradle buildExtension --debug

依存関係

• MCP SDK：io.modelcontextprotocol.sdk:mcp:0.10.0
• Jetty Server：11.0.20 (HTTP/SSEトランスポート)
• Jackson：2.17.0 (JSON処理)
• Ghidra API：Ghidraのインストールに同梱されています。

ロギング

UIロギング

Logタブでは、次のようなリアルタイム監視が可能です。

• セッションイベント：サーバーの起動/停止、プログラムの変更
• ツールリクエスト：REQ: tool_name {parameters...}
• ツールレスポンス：RES: tool_name {response...}
• エラーメッセージ：失敗した操作と診断情報

コンソールロギング

Ghidraのコンソールでは、詳細なロギングが行われます。

• ツールの登録と初期化
• MCPサーバーのライフサイクルイベント
• データベースのトランザクション操作
• エラーのスタックトレースとデバッグ情報

トラブルシューティング

一般的な問題

サーバーが起動しない

• ポート8080が使用可能か確認します。
• Ghidraのインストールパスを確認します。
• コンソールログを調べてエラーを確認します。

ツールが表示されない

• プラグインが有効になっていることを確認します。
• 設定タブでツールの状態を確認します。
• ログでバックエンドの初期化を確認します。

MCPクライアントの接続問題

• サーバーが実行中であることを確認します（GhidrAssistMCPウィンドウを確認）。
• 接続をテストします：curl http://localhost:8080/sse
• ファイアウォールの設定を確認します。

ツールの実行失敗

• プログラムがGhidraにロードされていることを確認します。
• ツールのパラメータが正しいことを確認します。
• ログタブのエラーメッセージを確認します。

デバッグモード

Ghidraの起動時に次のオプションを追加することで、デバッグロギングを有効にします。

-Dlog4j.logger.ghidrassistmcp=DEBUG

コントリビュート

1. リポジトリをフォークする
2. 機能ブランチを作成する：git checkout -b feature-name
3. 適切なテストを行いながら変更を加える
4. コードスタイルに従う：既存のパターンと規則を使用する
5. 詳細な説明付きでプルリクエストを送信する

コード標準

• 適切な場所でJava 21以上の機能を使用する
• 意味のあるメッセージを持つ適切な例外処理を行う
• すべてのデータベース操作にトランザクションセーフティを持たせる
• UI操作にスレッドセーフティを持たせる
• パブリックAPIに包括的なドキュメントを付ける

📄 ライセンス

このプロジェクトはMITライセンスの下でライセンスされています。詳細については、LICENSEファイルを参照してください。

謝辞

• NSA/Ghidraチーム：優れたリバースエンジニアリングプラットフォームの提供
• Anthropic：Model Context Protocolの仕様策定

質問や問題は？

バグレポート、機能リクエスト、または使用方法や開発に関する質問は、プロジェクトのリポジトリでイシューを作成してください。