Shodan MCP Server

🚀 shodan-mcp-server

このサーバーは、Shodan API へのアクセスを提供する Model Context Protocol (MCP) サーバーです。プログラムから Shodan をクエリし、デバイスや脆弱性などに関する情報を取得できます。

🚀 クイックスタート

shodan-mcp-server は、Model Context Protocol (MCP) を使用して、Shodan の情報をアプリケーションに簡単に統合する方法を提供します。いくつかのツールを公開しており、さまざまな種類の情報を取得するために Shodan をクエリできます。

✨ 主な機能

• ホスト情報：特定の IP アドレスの詳細情報を取得
• 検索：Shodan の検索構文を使用してそのデータベースをクエリ
• DNS 解決：ドメイン名を解決
• CVE 情報：特定の CVE 脆弱性の詳細情報を取得

📦 インストール

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

git clone https://github.com/X3r0K/Shodan-MCP-Server.git
cd shodan-mcp-server

2. 依存関係をインストールします：

npm install

3. プロジェクトをビルドします：

npm run build

📚 ドキュメント

設定

1. Shodan から Shodan API キーを取得します。
2. MCP 設定ファイル（例：~/.config/mcp/settings.json）で MCP サーバーを設定します：

{
  "mcpServers": {
    "shodan": {
      "command": "node",
      "args": ["/path/to/shodan-mcp-server/build/index.js"],
      "env": {
        "SHODAN_API_KEY": "<your_shodan_api_key>"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

<your_shodan_api_key> を実際の Shodan API キーに置き換え、/path/to/shodan-mcp-server を実際の shodan-mcp-server のパスに置き換えてください。

Node.js での使用

@modelcontextprotocol/sdk パッケージを使用して、Node.js から MCP サーバーを使用できます：

1. MCP SDK をインストールします：

npm install @modelcontextprotocol/sdk

2. use_mcp_tool 関数を使用してツールを呼び出します：

import { use_mcp_tool } from '@modelcontextprotocol/sdk';

async function get_ip_info() {
    try {
        const result = await use_mcp_tool('shodan', 'get_ip_info', {
            ip: '8.8.8.8' // サンプル IP アドレス
        });
        console.log(result);
    } catch (error) {
        console.error('Error:', error);
    }
}

get_ip_info();

API ドキュメント

get_ip_info

• 説明：指定された IP アドレスの詳細情報を取得します。
• パラメータ：
  • ip（文字列）：クエリする IP アドレス。
• 戻り値：以下の内容を含むオブジェクト：
  • ip：対象の IP アドレス。
  • hostnames：その IP に関連付けられたホスト名の配列。
  • location：国、都市、緯度経度を含む地理的位置情報。
  • ASN：オートノマスシステム番号とその所有者。
  • ports：開いているポートのリストと対応するサービス。

dns_lookup

• 説明：ドメイン名を解決し、対応する IP アドレスを取得します。
• パラメータ：
  • domain（文字列）：解決するドメイン名。
• 戻り値：以下の内容を含むオブジェクト：
  • domain：対象のドメイン名。
  • ips：そのドメインに関連付けられた IP アドレスのリスト。

get_vulnerabilities

• 説明：指定された IP に関連する脆弱性情報を取得します。
• パラメータ：
  • ip（文字列）：クエリする IP アドレス。
• 戻り値：以下の内容を含む配列：
  • id：脆弱性 ID。
  • title：脆弱性のタイトル。
  • severity：脆弱性の深刻度レベル（例："high", "medium", "low"）。

cve_info

• 説明：特定の CVE 脆弱性の詳細情報を取得します。
• パラメータ：
  • cve_id（文字列）：CVE ID（例："CVE-2021-XXXX"）。
• 戻り値：以下の内容を含むオブジェクト：
  • id：CVE ID。
  • summary：脆弱性の概要。
  • severity：脆弱性の深刻度レベル。
  • affected_packages：影響を受けるソフトウェアパッケージまたはコンポーネントのリスト。

search

• 説明：Shodan の検索構文を使用してデータベースをクエリします。
• パラメータ：
  • query（文字列）：実行する検索クエリ。
• 戻り値：一致する結果を含むオブジェクトで、各結果には以下が含まれます：
  • ip：IP アドレス。
  • port：開いているポート。
  • service：実行中のサービス。

プロジェクト構造

shodan-mcp-server/
├── index.js          # メインプログラムのエントリーポイント
├── build/           # ビルド出力ディレクトリ
├── package.json     # 依存関係管理ファイル
└── README.md        # プロジェクトドキュメント

貢献ガイド

貢献者は以下の方法で参加できます：

1. 問題を提出する：エラーを報告するか、機能要求を提出する。
2. プルリクエストを提出する：問題を修正するか、新機能を追加する。

コードを提出する前に、プロジェクトの 貢献規約 を読み、従ってください。

📄 ライセンス

このプロジェクトは MIT License の下で保護されています。