Shodan MCP Server

🚀 shodan-mcp-server

shodan-mcp-server 是一個基於 Model Context Protocol (MCP) 的服務器，它提供了對 Shodan API 的訪問能力。藉助該服務器，你能夠以編程方式查詢 Shodan，獲取設備、漏洞等相關信息，輕鬆將 Shodan 情報集成到自己的應用程序中。

🚀 快速開始

shodan-mcp-server 提供了一種簡便的方式，將 Shodan 情報集成到您的應用程序中，使用 Model Context Protocol (MCP)。它公開了幾個工具，允許您查詢 Shodan 以獲取各種類型的信息。

✨ 主要特性

• 主機信息：獲取特定 IP 地址的詳細信息。
• 搜索：使用 Shodan 的搜索語法查詢其數據庫。
• DNS 解析：解析域名。
• CVE 信息：獲取特定 CVE 漏洞的詳細信息。

📦 安裝指南

克隆倉庫

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

安裝依賴項

npm install

構建項目

npm run build

💻 使用示例

與 Node.js 的使用

您可以通過 Node.js 使用 MCP 服務器，使用 @modelcontextprotocol/sdk 包。

安裝 MCP SDK

npm install @modelcontextprotocol/sdk

使用 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：運行的服務。

配置

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 路徑。

🔧 技術細節

項目結構

shodan-mcp-server/
├── index.js          # 主程序入口
├── build/           # 構建輸出目錄
├── package.json     # 依賴管理文件
└── README.md        # 項目文檔

🤝 貢獻指南

貢獻者可以通過以下方式參與：

1. 提交問題：報告錯誤或提出功能請求。
2. 提交拉取請求：修復問題或添加新功能。

請確保在提交代碼之前閱讀並遵循項目的 貢獻規範。

📄 許可證

本項目受 MIT License 保護。