跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

Schema Profiles

最后更新 查看 MarkdownAgent 设置

Schema Profile 会对预期请求字段及其约束建模。您可以从流量中学习,也可以提供上传的 schema。

配置文件可用后,Cloudflare 会运行始终开启的检测。检测本身不会缓解请求。

从流量中学习

operation 是 Cloudflare 对端点的称呼。其身份由 HTTP 方法、主机名模式和路径模式组成。

Web Assets 会在 Web Assets > Operations 下持续发现 operation。您也可以手动添加 operation。

这两种方法只会将 operation 加入清单。要开始分析,请从该 operation 的溢出菜单中选择 Learn profile(学习配置文件)。

满足流量要求

学习每周运行一次,使用过去七天内的合格流量。只有收到 2xx 响应的请求才会计入。

字段学习阈值需要 1,000 个合格请求。边界学习阈值需要 10,000 个合格请求。

达到字段学习阈值后,Cloudflare 可以学习请求字段。达到边界学习阈值后,Cloudflare 可以学习数值范围、字符串长度等约束。

使用计划学习时,第一个配置文件会在下一次每周运行后出现。这可能需要在达到相关阈值后最多七天。您也可以为整个 zone 请求一次临时 schema 学习运行。

查看学习内容

从该 operation 的溢出菜单中选择 View details(查看详情)。学习到的 schema 会出现在 Security overview(安全概览) 下。

在受支持的情况下,配置文件可以学习这些请求组成部分:

  • 路径变量
  • 查询参数
  • 标头和 cookie
  • JSON 请求正文
  • 表单编码的请求正文

配置文件可以验证整数、字符串、通用唯一标识符(UUID)和数组。支持的约束包括数值范围、字符串长度、字符类别,以及最多包含三个值的枚举。

成功流量中也可能包含 bot、扫描器或恶意请求。在强制执行其检测之前,请先查看学习到的配置文件。

随着合格流量变化,每周运行和手动运行都可以更新配置文件。若需要固定 schema,请将学习到的 schema 导出为 OpenAPI,并上传以进行验证。

考虑限制

学习得到的 Schema Profiles 有以下限制:

  • 不支持 multipart 表单、GraphQL 和 XML。
  • 重复参数会对每个值进行验证,但不强制唯一性。
  • 不强制要求必填参数存在。
  • 仅新增参数不会产生违规。
  • 约束适用于已学习字段,而不是完整允许列表。

使用上传的 schema

上传的 OpenAPI schema 提供预期结构,而不是观察到的流量。它通过 cf.schema_validation.uploaded.violated 产生检测。

API Shield 提供详细的 Schema validation 参考,涵盖支持的版本、导入流程、OpenAPI 字段、正文限制和故障排查。

有关自动化,请参阅 API 和 Terraform 说明。

这篇文档对您有帮助吗?