API Shield 通过发现端点、验证请求架构和检测滥用模式来保护您的 API。本指南将逐步引导您完成从配置会话标识符到启用高级保护的初始设置。
虽然不是严格要求,但建议您在开始使用 API Shield 时配置您的 会话标识符。当 Cloudflare 检查您的 API 流量以识别单个会话时,我们可以提供更多用于可见性、管理和控制的工具。
如果您不确定您的 API 使用哪些会话标识符,请咨询您的开发团队。
会话标识符应能唯一标识 API 客户端。API 流量常用的会话标识符是 Authorization 标头。当 API 使用 JSON Web Token(JWT)进行客户端身份验证时,其值可能随时间变化。你可以使用 JWT 中的 sub 或 email 等声明值作为会话标识符,在不同时间唯一标识会话。
如果未配置会话标识符,且超过 1% 的符合条件的采样客户端 2xx 响应请求包含 Authorization 标头,Cloudflare 会自动将此标头配置为 API Shield 会话标识符。Cloudflare 不会覆盖现有会话标识符配置。
配置会话标识符(包括基于 cookie 的标识符)需要 API Shield 订阅或符合条件的 API Shield 试用。配置的标识符可为 API Discovery 提供可选证据,并供 Sequence Mitigation、速率限制建议、Sequence Analytics 和 Authentication Posture 使用。
最多可以配置 10 个会话标识符。
-
在 Cloudflare 仪表板中,转到 Security Settings(安全设置) 页面。
前往 Settings(设置) ↗ -
按 API abuse 进行筛选。
-
在 Session identifiers(会话标识符) 上,选择 Configure session identifiers(配置会话标识符)。
-
选择 Manage identifiers(管理标识符)。
-
选择会话标识符的类型(cookie、HTTP 标头或 JWT 声明)。
-
输入会话标识符的名称。
-
选择 Save(保存)。
API Shield 为符合条件且已保存的操作生成速率限制建议。建议要求具有 API Shield 访问权限、已配置与操作流量匹配的会话标识符、足够的数据以及已完成的处理。满足这些要求后,你可以查看每个操作和每个会话的建议,并创建速率限制规则。
Discovery 在识别 API 流量时,可以将配置的会话标识符用作一个信号。会话标识符还支持 Sequence Analytics 中的会话流量分析。
应用程序配置文件 (Application Profiles) 提供一个 Schema Profile,包含两种来源。架构学习会根据流量生成配置文件,架构验证则使用已上传的 OpenAPI 架构。
两种来源在配置文件可用后都会提供始终开启的检测。缓解需要单独的 WAF 自定义规则。
如果您维护 OpenAPI 架构,请按照架构验证上传流程操作。API Shield 仍是 OpenAPI 兼容性、架构治理和自动化的参考文档。
API Shield 与 Cloudflare WAF 的敏感数据检测规则集配合使用,可在其 HTTP 响应中识别返回敏感数据(例如社会安全号或信用卡号)的 API 端点。审查这些端点以验证仅在预期的地方返回敏感数据。
您可以通过选择一行中路径旁边的图标来识别返回敏感数据的端点。展开端点以查看触发了哪些规则的详细信息,并通过探索 Firewall Events(防火墙事件) 中的事件来查看更多信息。
Web 资产会根据流量持续发现操作。操作按 HTTP 方法、主机名模式和路径模式表示一个端点。
您也可以在 Web Assets(Web 资产) > Operations(操作) 下手动添加操作。发现和手动创建仅会添加清单条目。
要开始架构学习,请从操作的更多选项菜单中选择 Learn profile(学习配置文件)。通过 View details(查看详情) > Security overview(安全概述) 审查学到的架构。
收集到足够的合格流量后,您可以为整个 zone 请求一次临时架构学习运行。
完整流程和流量阈值请参阅应用程序配置文件快速入门。
速率限制规则允许您为匹配表达式的请求定义速率限制,并选择达到这些速率限制时执行的操作。
API Shield 会为符合条件的已保存操作生成速率限制建议。建议需要具备 API Shield 访问权限、与操作流量匹配的已配置会话标识符、足够的数据以及处理完成。这些建议按操作和会话限定范围,而不是应用于整个站点或基于 IP 地址。
每个会话的速率限制会跟踪单个访客在其会话期间发往特定端点的流量。这减少了宽泛范围规则的误报,同时仍能限制滥用流量。
学到的架构导出是针对所选主机名的 OpenAPI 时间点快照。它包含按方法和路径划分的已学习操作以及检测到的路径变量(例如 /users/{id})。还可以包含检测到的查询参数、其格式以及速率限制建议。
您可以在 Cloudflare 仪表板 或通过 API 导出学到的架构。
导出使用 OpenAPI v3.0.0。要使用固定配置文件,请通过架构验证上传该文件。
顺序分析 (Sequence Analytics) 可识别 API 请求的常见模式 — 例如,用户在发起资金转账之前检查其账户余额。
顺序按优先级得分进行排序,该得分衡量了特定 API 请求按一致顺序一起发生的可能性。高分顺序包含可能在顺序中的其他操作之前发生的 API 请求。
顺序缓解 (Sequence mitigation) 允许您为与您的 API 通信的已验证身份客户端强制执行请求模式。使用顺序分析来识别您的 API 客户端遵循的顺序,然后将 API Shield 保护(速率限制、架构验证、JWT 验证和 mTLS)应用于高分顺序中的端点。与您的开发团队确认预期的端点顺序。
更多信息请参阅 使用顺序分析自动检测 API 滥用 ↗ 博客文章。
JSON Web 令牌 (JWT) 验证可验证客户端发送的令牌未被篡改且未过期。使用 Cloudflare 仪表板或 API 配置 JWT 验证。
如果您的源站使用 GraphQL,您可以考虑对 GraphQL 查询大小和深度设置限制。
GraphQL 恶意查询保护会扫描 GraphQL 流量,以查找具有过度嵌套或大小可能导致源站过载并导致拒绝服务的查询。您可以创建规则来设置最大查询深度和大小,以便在这些查询到达您的源站之前将其阻止。
更多信息请参阅 博客文章 ↗。
如果您运营的 API 需要或可以从额外保护层中受益,您可以考虑使用双向 TLS (mTLS)。
双向 TLS (mTLS) 身份验证需要客户端和服务器都使用证书验证彼此的身份。在标准 TLS 中,只有服务器证明其身份。mTLS 增加了客户端验证,这对于不通过身份提供程序进行身份验证的设备(如 IoT 硬件)很有用。