SuricataMCP 🚀

SuricataMCP 是一个模型上下文协议服务器，允许 MCP 客户端自主使用 Suricata 进行网络流量分析。它通过诸如 get_suricata_version、get_suricata_help 和 get_alerts_from_pcap_file 等工具实现与 Suricata 的编程交互。

📰 Medium 上的完整指南

为了您的方便，我们编写了一篇完整的 Medium 文章，逐步介绍如何安装和使用 SuricataMCP 与 Cursor。
通过 SuricataMCP 超级充电 Cursor：触手可及的网络安全

---

📦 特性

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

---

⬇️ 下载 Suricata

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

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

按照针对您的操作系统（Linux、macOS 或 Windows）的安装说明操作。

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

sudo apt install suricata

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

---

⚙️ 安装指南

请按照以下步骤在系统上设置 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 更加易于访问和可编程。