Pfsense MCP Server

🚀 pfSense MCP 服務器

pfSense MCP 服務器是一款生產級的模型上下文協議（MCP）服務器，它能讓你通過 Claude Desktop 等生成式人工智能（GenAI）應用與 pfSense 防火牆進行自然語言交互。

✨ 主要特性

• 自然語言接口：使用簡單的英語來控制 pfSense。
• 5 種訪問級別：從只讀監控到應急響應，滿足不同場景需求。
• 多種連接方式：支持 REST API、XML - RPC 和 SSH 連接。
• 6 大功能類別：全面覆蓋安全操作。
• GenAI 集成：可與 Claude Desktop、Continue 等 MCP 客戶端協同工作。
• 生產就緒：具備審計日誌、速率限制和緩存功能。

🚀 快速開始

1. 安裝與配置

# 克隆倉庫
git clone https://github.com/gensecaihq/pfsense-mcp-server.git
cd pfsense-mcp-server

# 複製環境模板
cp .env.example .env

# 編輯配置
nano .env  # 添加你的 pfSense 詳細信息

2. 使用 Docker 運行

# 構建並啟動
docker-compose up -d

# 檢查健康狀態
curl http://localhost:8000/health

3. 配置 Claude Desktop

在你的 Claude Desktop 配置文件（macOS 系統路徑為 ~/Library/Application Support/Claude/claude_desktop_config.json）中添加以下內容：

{
  "mcpServers": {
    "pfsense": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "--env-file", "/path/to/.env", "pfsense-mcp:latest"],
      "env": {
        "MCP_MODE": "stdio"
      }
    }
  }
}

或者在本地運行：

{
  "mcpServers": {
    "pfsense": {
      "command": "python",
      "args": ["/path/to/pfsense-mcp-server/main.py"],
      "env": {
        "PFSENSE_URL": "https://your-pfsense.local",
        "PFSENSE_API_KEY": "your-api-key"
      }
    }
  }
}

🔐 訪問級別

💻 使用示例

基礎用法

以下是一些使用自然語言與 pfSense 交互的示例提示：

"Show me the system status"（顯示系統狀態）
"What IPs are currently blocked?"（當前哪些 IP 被阻止了？）
"Block IP 192.168.1.100"（阻止 IP 192.168.1.100）
"Run a PCI compliance check"（運行 PCI 合規性檢查）
"Analyze threats from the last hour"（分析過去一小時的威脅）
"EMERGENCY: Block all traffic from Russia"（緊急情況：阻止來自俄羅斯的所有流量）

📚 詳細文檔

• Claude Desktop 設置
• GenAI 集成指南
• API 文檔
• 部署指南
• 權限指南

🧪 測試

# 測試連接
python scripts/test_connection.py

# 運行測試
pytest tests/

# 生成令牌
python scripts/generate_token.py alice READ_ONLY

📄 許可證

本項目採用 MIT 許可證，詳情請參閱 LICENSE。