Caddy Defender 插件

Caddy Defender 插件是专为 Caddy 设计的中间件（middleware），允许你基于客户端的 IP 地址阻止或操纵请求。它特别适用于防止不必要的流量，或通过返回垃圾响应来污染 AI（人工智能）训练数据。

---

功能特性

• IP 范围过滤：阻止或操纵来自特定 IP 范围的请求。
• 内置 IP 范围：为流行的 AI 服务（例如 OpenAI、DeepSeek、GitHub Copilot）预定义的 IP 范围。
• 自定义 IP 范围：通过 Caddyfile 配置添加你自己的 IP 范围。
• 多种响应器后端（Responder Backends）：
  • Block：返回 403 Forbidden 响应。
  • Custom：返回自定义消息。
  • Drop：断开连接。
  • Garbage：返回垃圾数据以污染 AI 训练。
  • Redirect：返回带有自定义 URL（统一资源定位符）的 308 Permanent Redirect 响应。
  • Ratelimit：限制请求速率（Ratelimit），可通过 caddy-ratelimit 配置。
  • Tarpit：以缓慢但可配置的速率流式传输数据，以停滞机器人并污染 AI 训练。

---

安装

使用 Docker

使用 Caddy Defender 插件最简单的方法是使用预构建的 Docker 镜像。

1. 拉取 Docker 镜像：

   docker pull ghcr.io/jasonlovesdoggo/caddy-defender:latest
   

2. 运行容器： 使用以下命令配合你的 Caddyfile 运行容器：

   docker run -d \
     --name caddy \
     -v /path/to/Caddyfile:/etc/caddy/Caddyfile \
     -p 80:80 -p 443:443 \
     ghcr.io/jasonlovesdoggo/caddy-defender:latest
   

   将 /path/to/Caddyfile 替换为你的 Caddyfile 路径。

请参阅 在线文档 了解其他安装方法。

---

配置

Caddyfile 语法

defender 指令用于配置 Caddy Defender 插件。其语法如下：

defender <responder> {
    message <custom message>
    ranges <ip_ranges...>
    url <url>
}

• <responder>：要使用的响应器后端。支持的值包括：
  • block：返回 403 Forbidden 响应。
  • custom：返回自定义消息（需要 message）。
  • drop：断开连接。
  • garbage：返回垃圾数据以污染 AI 训练。
  • redirect：返回 308 Permanent Redirect 响应（需要 url）。
  • ratelimit：标记请求以进行速率限制（需要同时安装 Caddy-Ratelimit）。
  • tarpit：以缓慢但可配置的速率流式传输数据，以停滞机器人并污染 AI 训练。
• <ip_ranges...>：可选的 CIDR（无类别域间路由）范围列表或预定义范围键，用于匹配客户端 IP。默认为 aws azurepubliccloud deepseek gcloud githubcopilot openai。
• <custom message>：使用 custom 响应器时返回的自定义消息。
• <url>：redirect 响应器将重定向到的 URI（统一资源标识符）。

有关配置的更多信息，请参阅网站上的 配置页面。

---

快速开始

文档网站 包含插件配置、代码示例等更多信息。

若要快速开始，请遵循 入门指南 使用 Caddy Defender 插件 保护你的服务器。

---

如需示例，请查看 docs/examples.md

---

嵌入式 IP 范围

该插件包含了流行 AI 服务的预定义 IP 范围（IP Ranges）。这些范围嵌入在二进制文件（binary）中，无需额外配置即可使用。

服务	键	IP 范围
阿里云	aliyun	aliyun.go
VPN（虚拟专用网络）	vpn	vpn.go
AWS	aws	aws.go
AWS 区域	aws-us-east-1, aws-us-west-1, aws-eu-west-1	aws_region.go
DeepSeek	deepseek	deepseek.go
GitHub Copilot	githubcopilot	github.go
谷歌云平台	gcloud	gcloud.go
甲骨文云基础设施	oci	oracle.go
微软 Azure	azurepubliccloud	azure.go
OpenAI	openai	openai.go
Mistral	mistral	mistral.go
Vultr	vultr	vultr.go
Cloudflare	cloudflare	cloudflare.go
Digital Ocean	digitalocean	digitalocean.go
Linode	linode	linode.go
私有	private	private.go
所有 IP 地址	all	all.go

默认禁用（需要在构建时手动包含）

服务	键	IP 范围
Tor 出口节点	tor	tor.go
ASN（自治系统号码）	asn	asn.go

欢迎提供更多！如需预编译列表，请参阅 嵌入式结果

贡献

我们欢迎贡献！要开始贡献，请参阅 CONTRIBUTING.md。

---

许可证

本项目采用 MIT 许可证 授权。详情请见 LICENSE 文件。

---

致谢

• 本项目的灵感来源。
• bart - Karl Gaissmaier 的高效路由表实现（平衡 ART 适配），使我们的高性能 IP 匹配成为可能
• 使用 Caddy 构建，充满 ❤️。

Star 历史

Caddy Defender 快速上手指南

Caddy Defender 是一款 Caddy 服务器中间件插件，支持基于客户端 IP 地址阻止或操纵请求。它特别适用于防止恶意流量，或通过返回垃圾数据污染 AI 训练数据。

环境准备

• 操作系统：Linux / macOS / Windows (需支持 Docker)
• 前置依赖：
  • Docker 已安装并正常运行
  • 准备好基本的 Caddyfile 配置文件

安装步骤

推荐使用官方提供的 Docker 镜像进行部署，这是最简便的方式。

1. 拉取 Docker 镜像

   docker pull ghcr.io/jasonlovesdoggo/caddy-defender:latest
   

2. 运行容器

   将本地 Caddyfile 挂载到容器中并启动服务：

   docker run -d \
     --name caddy \
     -v /path/to/Caddyfile:/etc/caddy/Caddyfile \
     -p 80:80 -p 443:443 \
     ghcr.io/jasonlovesdoggo/caddy-defender:latest
   

   注意：请将 /path/to/Caddyfile 替换为你实际的配置文件路径。

基本使用

在 Caddyfile 中使用 defender 指令配置防护规则。以下示例展示如何阻止 OpenAI 的爬虫抓取。

配置示例：

example.com {
    defender block {
        ranges openai
    }
    respond "Hello World"
}

配置说明：

• defender block：设置响应方式为返回 403 Forbidden。
• ranges openai：匹配内置的 OpenAI IP 段。支持 deepseek, githubcopilot, aws, azurepubliccloud 等内置关键词。
• 若不指定 ranges，默认匹配所有主流 AI 服务及云厂商 IP 段。

其他常用响应模式：

• garbage：返回垃圾数据以污染 AI 训练。
• redirect：重定向请求（需配合 url 参数）。
• custom：返回自定义消息（需配合 message 参数）。
• tarpit：慢速流式传输数据以停滞爬虫。

更多配置详情请参考 官方文档。