AegisGate

Category: Testing & Security | Uploader: ax128 | Downloads: 0 | Version: v1.0（Latest）

> **What is this document?** This is an agent-executable skill document for AegisGate — an open-source LLM security gateway. It walks through installation, startup, token registration, upstream configuration, and client integration on a fresh machine.

Changelog: Source: GitHub https://github.com/ax128/AegisGate

Directory Structure

Current level: tree/main/

📁 .github/
- 📁 workflows/
  - 📄 ci.yml 1.7 KB
📁 aegisgate/
- 📁 adapters/
  - 📁 openai_compat/
    
    📄 __init__.py 15 B
    
    📄 compat_bridge.py 37.5 KB
    
    📄 mapper.py 23.2 KB
    
    📄 offload.py 3.2 KB
    
    📄 payload_compat.py 5.3 KB
    
    📄 pipeline_runtime.py 11.1 KB
    
    📄 router.py 298.5 KB
    
    📄 sanitize.py 20.1 KB
    
    📄 stream_utils.py 13.4 KB
    
    📄 upstream.py 9.4 KB
  - 📁 relay_compat/
    
    📄 __init__.py 15 B
    
    📄 mapper.py 567 B
    
    📄 router.py 2.9 KB
  - 📁 v2_proxy/
    
    📄 __init__.py 38 B
    
    📄 router.py 49.5 KB
  - 📄 __init__.py 15 B
- 📁 config/
  - 📄 __init__.py 15 B
  - 📄 feature_flags.py 2.2 KB
  - 📄 redact_values.py 4.1 KB
  - 📄 security_level.py 2.2 KB
  - 📄 security_rules.py 32.1 KB
  - 📄 settings.py 8.0 KB
- 📁 core/
  - 📄 __init__.py 15 B
  - 📄 audit.py 2.7 KB
  - 📄 background_worker.py 1.8 KB
  - 📄 confirmation.py 3.2 KB
  - 📄 confirmation_cache_task.py 1.8 KB
  - 📄 confirmation_flow.py 4.9 KB
  - 📄 context.py 1.2 KB
  - 📄 dangerous_response_log.py 9.9 KB
  - 📄 errors.py 286 B
  - 📄 gateway.py 53.3 KB
  - 📄 gateway_auth.py 6.5 KB
  - 📄 gateway_keys.py 4.8 KB
  - 📄 gateway_network.py 3.5 KB
  - 📄 gateway_ui_config.py 17.6 KB
  - 📄 gateway_ui_routes.py 31.1 KB
  - 📄 gw_tokens.py 13.0 KB
  - 📄 hot_reload.py 12.6 KB
  - 📄 models.py 3.0 KB
  - 📄 pipeline.py 4.1 KB
  - 📄 registry.py 997 B
  - 📄 security_boundary.py 4.0 KB
  - 📄 semantic.py 17.5 KB
  - 📄 stats.py 12.7 KB
  - 📄 tfidf_model.py 4.0 KB
- 📁 filters/
  - 📄 __init__.py 15 B
  - 📄 anomaly_detector.py 12.3 KB
  - 📄 base.py 680 B
  - 📄 exact_value_redaction.py 1.6 KB
  - 📄 injection_detector.py 27.0 KB
  - 📄 output_sanitizer.py 137 B
  - 📄 post_restore_guard.py 6.6 KB
  - 📄 privilege_guard.py 5.4 KB
  - 📄 rag_poison_guard.py 11.2 KB
  - 📄 redaction.py 9.7 KB
  - 📄 request_sanitizer.py 10.5 KB
  - 📄 restoration.py 6.5 KB
  - 📄 sanitizer.py 14.8 KB
  - 📄 system_prompt_guard.py 2.2 KB
  - 📄 tool_call_guard.py 9.6 KB
  - 📄 untrusted_content_guard.py 4.7 KB
- 📁 models/
  - 📁 tfidf/
    
    📄 classifier.joblib 62.0 KB
    
    📄 vectorizer.joblib 103.7 KB
- 📁 observability/
  - 📄 __init__.py 903 B
  - 📄 logging.py 2.4 KB
  - 📄 metrics.py 4.8 KB
  - 📄 tracing.py 4.9 KB
- 📁 policies/
  - 📁 rules/
    
    📄 default.yaml 349 B
    
    📄 permissive.yaml 202 B
    
    📄 security_filters.yaml 39.0 KB
    
    📄 strict.yaml 801 B
  - 📄 __init__.py 15 B
  - 📄 policy_engine.py 6.0 KB
- 📁 storage/
  - 📄 __init__.py 780 B
  - 📄 crypto.py 2.9 KB
  - 📄 kv.py 3.0 KB
  - 📄 offload.py 1.5 KB
  - 📄 postgres_store.py 19.9 KB
  - 📄 redis_store.py 15.7 KB
  - 📄 sqlite_store.py 17.9 KB
- 📁 tests/
  - 📄 conftest.py 1.6 KB
  - 📄 test_hot_reload_unit.py 6.4 KB
  - 📄 test_openai_request_mapping.py 6.9 KB
  - 📄 test_passthrough_filter_mode.py 37.7 KB
  - 📄 test_request_redaction_routes.py 29.1 KB
  - 📄 test_response_sanitization_routes.py 26.3 KB
  - 📄 test_sanitize_helpers.py 10.7 KB
  - 📄 test_streaming_router.py 72.9 KB
- 📁 util/
  - 📄 __init__.py 15 B
  - 📄 base64_detect.py 957 B
  - 📄 debug_excerpt.py 3.3 KB
  - 📄 logger.py 5.2 KB
  - 📄 masking.py 872 B
  - 📄 redaction_whitelist.py 2.7 KB
  - 📄 risk_scoring.py 1.3 KB
- 📄 __init__.py 74 B
- 📄 init_config.py 9.0 KB
📁 config/
- 📄 .env.example 6.1 KB
- 📄 gw_tokens.json.example 1.3 KB
- 📄 model_map.json 459 B
- 📄 README.md 6.4 KB
- 📄 security_filters.yaml 39.0 KB
📁 logs/
- 📄 .gitkeep 0 B
📁 scripts/
- 📄 caddy-entrypoint.sh 806 B
- 📄 local_launcher.py 15.8 KB
- 📄 redeploy.sh 1.3 KB
- 📄 train_tfidf.py 12.5 KB
📁 www/
- 📁 assets/
  - 📄 app.css 31.8 KB
  - 📄 app.js 48.7 KB
  - 📄 login.js 1.8 KB
- 📄 index.html 40.7 KB
- 📄 login.html 4.8 KB
📄 .dockerignore 66 B
📄 .gitignore 1.3 KB
📄 aegisgate-local.py 121 B
📄 AGENTS.md 2.5 KB
📄 AICLIENT2API-QUICKSTART.md 1.1 KB
📄 Caddyfile.example 4.0 KB
📄 CHANGELOG.md 21.8 KB
📄 CLAUDE.md 27.7 KB
📄 CLIPROXY-QUICKSTART.md 1.0 KB
📄 docker-compose.yml 2.1 KB
📄 Dockerfile 1.1 KB
📄 LICENSE 1.1 KB
📄 OTHER_TERMINAL_CLIENTS_USAGE.md 4.9 KB
📄 pyproject.toml 3.1 KB
📄 README.md 21.1 KB
📄 README_zh.md 47.0 KB
📄 SKILL.md 7.7 KB
📄 SUB2API-QUICKSTART.md 1.0 KB
📄 WEBUI-QUICKSTART.md 2.7 KB

SKILL.md

# AegisGate Agent Skill

> **What is this document?** This is an agent-executable skill document for AegisGate — an open-source LLM security gateway. It walks through installation, startup, token registration, upstream configuration, and client integration on a fresh machine.

本技能文档给 Agent 直接使用，目标是：在一台新机器上完成 AegisGate 的安装、启动、注册 token 或配置直连上游、以及客户端接入配置。

## 0) What does AegisGate do? 先读项目要点（必须）

- AegisGate 是 LLM 安全网关：请求侧脱敏/清洗，响应侧检测/自动净化（auto-sanitize）；`responses` 结构化 `input`（含 function/tool 输出）也会在转发上游前做脱敏。
- **两种路由模式**（可同时启用）：
  - **Token 路由**（推荐多租户场景）：每个 token 绑定独立的上游地址；注册/管理 token 时需提供网关密钥。
    - v1（LLM）：`http://<host>:18080/v1/__gw__/t/<TOKEN>/...`
    - v2（通用 HTTP 代理）：`http://<host>:18080/v2/__gw__/t/<TOKEN>`，须携带 `x-target-url: <完整目标URL>` 请求头
  - **直连上游**（单用户/Agent 快速接入）：设置 `AEGIS_UPSTREAM_BASE_URL=<上游地址>` 后，可直接请求 `/v1/...`，无需注册 token。`v2` 仍必须使用 token 路径。
- **脱敏豁免字段（whitelist_key）**：注册 token 时可指定逗号分隔的字段名列表（如 `api_key,secret,token`）。请求体中这些字段的值**不做 PII 脱敏**，直接透传到上游。适用于需要原始凭证通过的场景。支持以下匹配模式：
  - JSON：`"field":"value"` 或 `"field": "value"`
  - 等号赋值：`field=value`
  - 冒号赋值：`field:value`
  - URL 查询参数：`?field=value`
- 管理接口（`/__gw__/register|lookup|unregister|add|remove`）应只允许内网/管理机访问。

## 1) What are the prerequisites? 环境检查

```bash
uname -a
cat /etc/os-release
which docker || true
which docker-compose || true
git --version || true
python3 --version || true
```

## 2) How to install Docker? 如果没有 Docker：先安装（Ubuntu/Debian）

```bash
sudo apt-get update
sudo apt-get install -y ca-certificates curl gnupg
sudo install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo $VERSION_CODENAME) stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
sudo systemctl enable --now docker
docker --version
docker compose version
```

可选（免 sudo）：

```bash
sudo usermod -aG docker "$USER"
newgrp docker
```

## 3) How to get the source code? 获取源码

### 3.1 Git 方式

```bash
git clone https://github.com/ax128/AegisGate.git
cd AegisGate
```

### 3.2 已有源码目录

```bash
cd /path/to/AegisGate
```

## 4) How to start AegisGate with Docker? 推荐安装方式

```bash
docker compose up -d --build
docker compose ps
docker compose logs -f aegisgate
```

健康检查：

```bash
curl -sS http://127.0.0.1:18080/health
```

## 5) How to run without Docker? 源码本地运行

```bash
python3 -m venv .venv
source .venv/bin/activate
python -m pip install -U pip
python -m pip install -e .
uvicorn aegisgate.core.gateway:app --host 127.0.0.1 --port 18080
```

## 6) How to connect upstream LLM providers? 接入方式选择

### 6.1 What is token routing? Token 路由（多租户，推荐）

注册上游并生成 token：

```bash
# gateway_key 从 cat config/aegis_gateway.key 获取
curl -X POST http://127.0.0.1:18080/__gw__/register \
  -H "Content-Type: application/json" \
  -d '{"upstream_base":"https://your-upstream.example.com/v1","gateway_key":"<AEGIS_GATEWAY_KEY>"}'
```

期望返回：

```json
{
  "token": "Ab3k9Qx7Yp",
  "baseUrl": "http://127.0.0.1:18080/v1/__gw__/t/Ab3k9Qx7Yp"
}
```

注册时可附带脱敏豁免字段（如 `api_key` 字段值不做脱敏）：

```bash
curl -X POST http://127.0.0.1:18080/__gw__/register \
  -H "Content-Type: application/json" \
  -d '{"upstream_base":"https://your-upstream.example.com/v1","gateway_key":"<AEGIS_GATEWAY_KEY>","whitelist_key":["api_key","secret"]}'
```

### 6.2 What is direct upstream mode? 直连上游（单用户/Agent 快速接入）

在 `config/.env` 中设置：

```env
AEGIS_UPSTREAM_BASE_URL=https://your-upstream.example.com/v1
```

重启后直接请求 `/v1/...`，无需注册 token。`/v2/...` 不支持直连模式，仍需使用 `/v2/__gw__/t/<TOKEN>/...`：

```bash
curl -X POST http://127.0.0.1:18080/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <UPSTREAM_API_KEY>" \
  -d '{"model":"gpt-4.1-mini","input":"hello"}'
```

## 7) How to verify the gateway is working? 验证调用

### Token 路由

```bash
curl -X POST "http://127.0.0.1:18080/v1/__gw__/t/<TOKEN>/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <UPSTREAM_API_KEY>" \
  -d '{"model":"gpt-4.1-mini","input":"hello"}'
```

### 直连上游

```bash
curl -X POST "http://127.0.0.1:18080/v1/responses" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <UPSTREAM_API_KEY>" \
  -d '{"model":"gpt-4.1-mini","input":"hello"}'
```

## 8) How to configure AI agents and clients? 客户端配置模板

### Token 路由

```yaml
provider: openai_compatible
base_url: http://127.0.0.1:18080/v1/__gw__/t/<TOKEN>
api_key: <UPSTREAM_API_KEY>
model: gpt-4.1-mini
```

### 直连上游

```yaml
provider: openai_compatible
base_url: http://127.0.0.1:18080/v1
api_key: <UPSTREAM_API_KEY>
model: gpt-4.1-mini
```

说明：
- 若客户端默认流式输出，网关会处理 `[DONE]` 断流恢复。
- 直连模式下不需要 `base_url` 携带 token 路径段。

## 9) How to manage tokens and the gateway? 常用管理命令

查看 token：

```bash
curl -X POST http://127.0.0.1:18080/__gw__/lookup \
  -H "Content-Type: application/json" \
  -d '{"token":"<TOKEN>"}'
```

删除 token：

```bash
curl -X POST http://127.0.0.1:18080/__gw__/unregister \
  -H "Content-Type: application/json" \
  -d '{"token":"<TOKEN>"}'
```

查看所有 token（需要网关密钥）：

```bash
curl http://127.0.0.1:18080/__ui__/api/tokens \
  -H "X-Gateway-Key: <AEGIS_GATEWAY_KEY>"
```

查看日志：

```bash
docker compose logs -f aegisgate
```

重启：

```bash
docker compose restart aegisgate
```

升级：

```bash
git pull
docker compose up -d --build
```

## 10) How to troubleshoot issues? 故障排查顺序

1. `health` 是否正常（`curl http://127.0.0.1:18080/health`）。
2. 确认使用哪种路由模式：token 路由（路径含 `/v1/__gw__/t/<TOKEN>/...`）或直连上游（`AEGIS_UPSTREAM_BASE_URL` 是否已设置）。
3. Token 路由：token 是否存在（`/__gw__/lookup`）；上游地址与 API key 是否正确。
4. 直连模式：`.env` 中 `AEGIS_UPSTREAM_BASE_URL` 是否正确，是否已重启。
5. 看 `docker compose logs -f aegisgate` 是否有 `upstream` 错误、自动净化（auto-sanitize）、阻断原因。

## 11) What are the security best practices? 安全基线

- 对外仅暴露业务入口，管理接口仅限内网。
- 默认监听建议使用 `127.0.0.1`，通过反向代理做外部暴露控制。
- 不在日志或工单中明文粘贴密钥、token、cookie、私钥、助记词。
- 生产环境定期轮换 `config/aegis_gateway.key`（替换文件内容后重启服务）。
- `whitelist_key` 字段只填真正需要豁免脱敏的字段名，最小化敏感数据明文透传范围。

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

AegisGate

Directory Structure

SKILL.md

Report

Notice