SuricataMCP

SuricataMCP 🚀

SuricataMCP 是一个模型上下文协议服务，允许 MCP 客户端自主使用 suricata 分析网络流量。它支持通过 get_suricata_version、get_suricata_help 和 get_alerts_from_pcap_file 等工具，以编程方式与 Suricata 交互。

📰 Medium 上的完整指南

为方便起见，我们撰写了一篇完整的 Medium 文章，逐步指导你如何使用 Cursor 安装和使用 SuricataMCP。 借助 SuricataMCP 为 Cursor 增强能力：触手可及的网络安全

---

📦 功能

• 🔡 轻松获取 Suricata 版本和帮助信息。
• 📁 使用简单的工具界面解析 .pcap 文件并检索警报。
• 🧠 基于 MCP 协议构建，可与 Cursor 等 AI 编码工具无缝集成。

---

⬇️ 下载 Suricata

要使用此项目，你需要下载并安装 Suricata：

访问 Suricata 官方网站：https://suricata.io/download/

按照适用于你的操作系统（Linux、macOS 或 Windows）的安装说明操作。

在 Linux 上，也可以通过包管理器安装，例如：

bash sudo apt install suricata

安装后，找到 Suricata 二进制文件和配置文件，以便在 config.py 中设置正确的路径。

---

⚙️ 安装指南

通过 Smithery 安装

通过 Smithery 自动为 Claude Desktop 安装 Suricata 网络流量分析服务：

npx -y @smithery/cli install @Medinios/SuricataMCP --client claude

按照以下步骤在系统上设置 SuricataMCP：

---

1. 克隆仓库

打开终端并运行：

git clone https://github.com/medinios/SuricataMCP.git
cd SuricataMCP

2. 安装依赖项（例如，使用虚拟环境时）

pip install -r requirements.txt

3. 编辑 config.py 文件，指定 Suricata 的安装路径：

SURICATA_DIR = "/path/to/suricata"
SURICATA_EXE_FILE = "suricata"  # or "suricata.exe" on Windows

4. 使用以下配置将 SuricataMCP 添加到你的 AI 平台：

  {
    "mcpServers": {
      "SuricataMcp": {
        "command": "cmd",
        "args": ["/c", "mcp", "run", "[YourPath]\\SuricataMcp\\suricata-mcp.py"]
      }
    }
  }

---

🚀 使用方法

从你的 AI 平台（如 Cursor）在本地运行 MCP 服务。

运行时，该服务会提供以下 MCP 工具：

• get_suricata_version()：返回 Suricata 的版本字符串。
• get_suricata_help()：返回 Suricata CLI 帮助输出。
• get_alerts_from_pcap_file(pcap_destination: str, destination_folder_results: str)：在给定的 .pcap 文件上运行 Suricata，并返回 fast.log 的内容。

---

📄 添加自定义规则

要使用自己的检测规则扩展 Suricata：

1. 将自定义规则文件（例如 custom.rules）添加到 suricata/rules 目录。

---

⚠️ 免责声明

我们与官方 Suricata 项目或 OISF（开放信息安全基金会）没有关联。SuricataMCP 是为在 Cursor 中个人使用而构建的独立集成。 示例 pcap 取自 PCAP-ATTACK

---

🤝 贡献者

该项目由两位热衷于安全、上下文感知系统以及为社区打造实用工具的开发者共同构建。每一行代码、每条 CLI 命令和每项集成，都是专注协作与共同求知的成果。

Sam Med, Raz Tel-Vered

🤝 参与贡献

欢迎提交 PR 和建议！让我们一起让 SuricataMCP 更易于使用和编程。