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

发现

最后更新 查看 MarkdownAgent 设置

大多数开发团队都在努力跟踪他们的 API。Cloudflare 发现 (Discovery) 可帮助您映射并了解您的 API 攻击面 — 即攻击者可能针对的完整端点集。

过程

Cloudflare 通过对合格的抽样流量应用启发式路径规范化,来生成 API 端点 的映射图。这些启发式方法按路径结构和类似变量的分段模式对请求进行分组。

例如,您可能拥有数千个 API,但很多调用看起来很相似,例如:

  • api.example.com/profile/238
  • api.example.com/profile/392

发现可能会将这两个路径分组为 api.example.com/profile/{var1}。生成的 {varN} 占位符标识类似变量的分段,并不会分配语义名称。

生成的端点图可能如下所示:

/api/login/{var1}
/api/auth
/api/account/{var1}
/api/password_reset
/api/logout

Cloudflare 还可以在兼容的子域之间合并常见的规范化操作。仅属于某个主机名的操作可以保留在该主机名上。

us-api.example.com/api/v1/users/{var1}
de-api.example.com/api/v1/users/{var1}
fr-api.example.com/api/v1/users/{var1}
jp-api.example.com/api/v1/users/{var1}

Cloudflare 可能将这些常见操作合并为 {hostVar1}.example.com/api/v1/users/{var1}。

有关更多技术细节,请参阅博客文章 ↗。

已发现的操作

发现结果可以作为 candidate(候选)或 shadow(影子)操作出现。候选操作会在边缘匹配。影子操作则不会。

当请求匹配已发布的候选操作时,该匹配可以为日志、规则、分析和适用检测提供操作上下文。您无需保存每个已发现的操作。

您无需保存每个已发现的操作。保存操作会将其移动到 full 状态。处于 full 状态的操作支持持久化 API 配置文件、风险发现以及需要已知 API 端点的保护。

要保存已发现的操作:

  1. 在 Cloudflare 仪表板中,前往 Web Assets(Web 资产) 页面。

    前往 Web assets(Web 资产) ↗
  2. 前往 Operations(操作) 选项卡。

  3. 打开候选或影子操作的行操作。

  4. 选择 Learn profile(学习配置文件)。

Cloudflare 会将该操作移动到 full 状态。行操作随后会显示 Learning profile(正在学习配置文件),这并不表示学习已完成。有关更多信息,请参阅开始配置文件学习。

发现操作

发现使用多种信号(包括机器学习和已配置的会话标识符)来识别 API 流量。配置会话标识符是可选的。

要审查发现结果:

  1. 在 Cloudflare 仪表板中,前往 Web Assets(Web 资产) 页面。

    前往 Web assets(Web 资产) ↗
  2. 前往 Operations(操作) 选项卡。

  3. 选择 Discovered(已发现) 快捷过滤器,它会应用 Candidate(候选) 和 Shadow(影子) 状态过滤器。您也可以手动选择这两种状态。

您可以将关于发现结果的任何反馈直接提交给您的账户团队。

要求

发现需要账户级和 zone 级都有有效的 API Shield 订阅。如果订阅在账户级有效但未分配给该 zone,则不会对该 zone 运行发现。

发现会分析抽样的代理流量。合格请求使用受支持的 HTTP 方法、使用 /cdn-cgi 之外的路径,并包含合格的发现信号。

要让端点出现在发现结果中,合格的抽样流量必须满足以下条件:

  • 请求必须从 Cloudflare 边缘返回 2xx 响应代码。
  • 请求不得直接来自 Cloudflare Worker。通过 Cloudflare 流量模拟器或其他基于 Worker 的测试工具发送的流量不会计入发现阈值。
  • 端点必须在连续 10 天内收到至少 500 个请求。

更多信息请参阅发现要求。

可用性

发现需要付费的 API Shield 插件,该插件面向企业版客户提供。请联系您的账户团队了解更多信息。

这篇文档对您有帮助吗?