Skip to main content

MCP server for FOFA, Quake, and Hunter cyberspace mapping platforms

Project description

FOFA Quake Hunter MCP Server

一个用于查询 FOFA、Quake 和 Hunter 网络空间测绘平台的 MCP (Model Context Protocol) 服务器。

English | 中文


中文

功能特性

  • 🔍 FOFA 查询: 支持 FOFA 网络空间测绘系统的资产查询
  • 🌐 Quake 查询: 支持 360 Quake 网络空间测绘系统的深度查询
  • 🦅 Hunter 查询: 支持奇安信鹰图平台的资产查询
  • 🤖 AI 友好: 所有参数支持自然语言对话设置
  • ⚙️ 灵活配置: 可按需配置单个或多个平台

安装

使用 uvx (推荐)

uvx fofa-quake-hunter-mcp

使用 pip

pip install fofa-quake-hunter-mcp

从源码安装

git clone https://github.com/RuoJi6/fofa_quake_hunter_mcp.git
cd fofa_quake_hunter_mcp
pip install -e .

配置

在 MCP 客户端中配置

在 MCP 配置文件中添加(例如 Claude Desktop 的 claude_desktop_config.json 或 Kiro 的 .kiro/settings/mcp.json):

{
  "mcpServers": {
    "fofa-quake-hunter": {
      "command": "uvx",
      "args": ["fofa-quake-hunter-mcp"],
      "env": {
        "FOFA_EMAIL": "your_email@example.com",
        "FOFA_KEY": "your_fofa_api_key",
        "QUAKE_KEY": "your_quake_api_key",
        "HUNTER_KEY": "your_hunter_api_key"
      }
    }
  }
}

注意: 你可以只配置需要使用的平台,未配置的工具在调用时会返回友好的配置提示。

获取 API Key

功能说明

1. FOFA 查询 (fofa_search)

主要参数:

  • query: 查询语法(如:body="admin", domain="example.com"
  • size: 返回条数(默认 100,最大 10000)
  • page: 页码(默认 1)
  • fields: 返回字段(默认:host,ip,port,domain,title

查询示例:

body="miner start"
domain="example.com" && port="443"
title="login" && country="CN"

2. Quake 查询 (quake_search)

主要参数:

  • query: 查询语法(如:title:"后台", ip:1.1.1.1
  • size: 返回条数(默认 100)
  • include: 包含字段(逗号分隔,见下方可用字段列表)
  • exclude: 排除字段(逗号分隔)
  • pagination_id: 深度翻页 ID(5分钟有效)
  • start_time / end_time: 时间范围(UTC格式:2020-10-14 00:00:00)

可用字段(注册用户 - 服务数据):

ip, port, hostname, transport, asn, org, service.name, 
location.country_cn, location.province_cn, location.city_cn, 
service.http.host, service.http.title, service.http.server

可用字段(会员用户 - 额外服务数据字段):

time, domain, service.response, service.cert, 
components.product_catalog, components.product_type, 
components.product_level, components.product_vendor, 
location.country_en, location.province_en, location.city_en, 
location.district_en, location.district_cn, location.isp, 
service.http.body, components.product_name_cn, components.version, 
service.http.infomation.mail, service.http.favicon.hash, 
service.http.favicon.data, service.http.status_code

查询示例:

title:"后台管理"
ip:1.1.1.1 AND port:80
service:http AND country:"china"

字段筛选示例:

# 只返回 IP 和端口
include: "ip,port"

# 返回 IP、端口和网页标题
include: "ip,port,service.http.title"

# 返回基础信息和组织
include: "ip,port,service.http.title,org,asn"

# 返回完整信息(会员)- 注意使用具体的组件字段
include: "ip,port,service.http.title,service.http.server,domain,components.product_name_cn,components.version"

⚠️ 常见字段错误:

  • components → ✅ 使用具体字段如 components.product_name_cn
  • as_org → ✅ 使用 asnorg
  • as_organization → ✅ 使用 asnorg

3. Hunter 查询 (hunter_search)

主要参数:

  • query: 查询语法(如:web.body="admin", ip="1.1.1.1"
  • page_size: 每页条数(可选:10/50/100,默认 10)
  • page: 页码(默认 1)
  • is_web: 资产类型(1=web资产,2=非web资产,3=全部)
  • fields: 返回字段
  • start_time / end_time: 时间范围(格式:YYYY-MM-DD)

查询示例:

web.body="keyword"
web.title="后台管理系统"
domain="example.com" && web.status_code="200"

AI 对话示例

用户: 查询 FOFA,body="admin",返回 50 条
AI: 将设置 query="body=\"admin\"", size=50

用户: 查询 Quake,标题为"后台管理",只返回 IP 和端口
AI: 将设置 query='title:"后台管理"', include='ip,port'

用户: 查询 Hunter,web.title="登录",只要 web 资产,每页 100 条
AI: 将设置 query='web.title="登录"', is_web=1, page_size=100

功能对比

功能 FOFA Quake Hunter
返回条数控制 ✅ size (1-10000) ✅ size (1-500) ✅ page_size (10/50/100)
字段控制 ✅ fields ✅ include/exclude ✅ fields
翻页 ✅ page ✅ pagination_id ✅ page
时间范围 ✅ start_time/end_time ✅ start_time/end_time
资产类型筛选 ✅ is_web

开发

# 克隆仓库
git clone https://github.com/RuoJi6/fofa_quake_hunter_mcp.git
cd fofa_quake_hunter_mcp

# 安装依赖
uv sync

# 运行服务器
uv run fofa-quake-hunter-mcp

许可证

MIT License - 详见 LICENSE 文件

贡献

欢迎提交 Issue 和 Pull Request!


English

Features

  • 🔍 FOFA Search: Query FOFA cyberspace mapping platform
  • 🌐 Quake Search: Query 360 Quake cyberspace mapping platform with deep pagination
  • 🦅 Hunter Search: Query Qianxin Hunter (鹰图) platform
  • 🤖 AI-Friendly: All parameters support natural language configuration
  • ⚙️ Flexible Config: Configure only the platforms you need

Installation

Using uvx (Recommended)

uvx fofa-quake-hunter-mcp

Using pip

pip install fofa-quake-hunter-mcp

From Source

git clone https://github.com/RuoJi6/fofa_quake_hunter_mcp.git
cd fofa_quake_hunter_mcp
pip install -e .

Configuration

Configure in MCP Client

Add to your MCP configuration file (e.g., Claude Desktop's claude_desktop_config.json or Kiro's .kiro/settings/mcp.json):

{
  "mcpServers": {
    "fofa-quake-hunter": {
      "command": "uvx",
      "args": ["fofa-quake-hunter-mcp"],
      "env": {
        "FOFA_EMAIL": "your_email@example.com",
        "FOFA_KEY": "your_fofa_api_key",
        "QUAKE_KEY": "your_quake_api_key",
        "HUNTER_KEY": "your_hunter_api_key"
      }
    }
  }
}

Note: You can configure only the platforms you need. Unconfigured tools will show friendly setup instructions when called.

Get API Keys

Tools

1. FOFA Search (fofa_search)

Key Parameters:

  • query: Search query (e.g., body="admin", domain="example.com")
  • size: Number of results (default: 100, max: 10000)
  • page: Page number (default: 1)
  • fields: Fields to return (default: host,ip,port,domain,title)

Query Examples:

body="miner start"
domain="example.com" && port="443"
title="login" && country="CN"

2. Quake Search (quake_search)

Key Parameters:

  • query: Search query (e.g., title:"admin", ip:1.1.1.1)
  • size: Number of results (default: 100)
  • include: Fields to include (e.g., ip,port,service.http.title)
  • exclude: Fields to exclude
  • pagination_id: Pagination ID for deep paging (5-minute expiry)
  • start_time / end_time: Time range (UTC format)

Query Examples:

title:"admin panel"
ip:1.1.1.1 AND port:80
service:http AND country:"china"

3. Hunter Search (hunter_search)

Key Parameters:

  • query: Search query (e.g., web.body="admin", ip="1.1.1.1")
  • page_size: Results per page (options: 10/50/100, default: 10)
  • page: Page number (default: 1)
  • is_web: Asset type (1=web assets, 2=non-web assets, 3=all)
  • fields: Fields to return
  • start_time / end_time: Time range (format: YYYY-MM-DD)

Query Examples:

web.body="keyword"
web.title="admin panel"
domain="example.com" && web.status_code="200"

Feature Comparison

Feature FOFA Quake Hunter
Result Count ✅ size (1-10000) ✅ size (1-500) ✅ page_size (10/50/100)
Field Control ✅ fields ✅ include/exclude ✅ fields
Pagination ✅ page ✅ pagination_id ✅ page
Time Range ✅ start_time/end_time ✅ start_time/end_time
Asset Type Filter ✅ is_web

Development

# Clone repository
git clone https://github.com/RuoJi6/fofa_quake_hunter_mcp.git
cd fofa_quake_hunter_mcp

# Install dependencies
uv sync

# Run server
uv run fofa-quake-hunter-mcp

License

MIT License - see LICENSE file for details

Contributing

Issues and Pull Requests are welcome!

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fofa_quake_hunter_mcp-0.1.2.tar.gz (40.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fofa_quake_hunter_mcp-0.1.2-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file fofa_quake_hunter_mcp-0.1.2.tar.gz.

File metadata

  • Download URL: fofa_quake_hunter_mcp-0.1.2.tar.gz
  • Upload date:
  • Size: 40.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for fofa_quake_hunter_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 92bc4980ddc85f193893f0a9f1c550570a0b5ebdd08a4c4b6556855969ea0731
MD5 ba5496abb658b5ad9f6c8302c3cd1ccf
BLAKE2b-256 942881c4683efd7abedc60c83016217118bf4aa2f45e65b560ed400a49ce152b

See more details on using hashes here.

File details

Details for the file fofa_quake_hunter_mcp-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for fofa_quake_hunter_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e9d7738a5765f5c92097a1d38abf0211ba7d3b9c77203a675dcebd0ad9b101c2
MD5 6f62dab67182418d0686da1133b5b5f6
BLAKE2b-256 b47f8e1a8883e3c0de9753bb7078ecdd2a6ec91242c2497ba8abdb27d776d294

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page