Skip to main content

关于机密扫描警报

了解不同类型的 机密扫描警报。

谁可以使用此功能?

具有管理员角色的存储库所有者、组织所有者、安全管理员和用户

Secret scanning 可用于以下存储库类型:

  • 公共存储库:Secret scanning 自动且免费地运行。
  •           **组织拥有的私有和内部存储库**:在 GitHub Secret Protection 或 GitHub Team 上启用 [GitHub Enterprise Cloud](/get-started/learning-about-github/about-github-advanced-security) 后可用。
    
  • 用户拥有的存储库:在 GitHub Enterprise Cloud 上可用,配合 Enterprise Managed Users。 当企业启用了 GitHub Enterprise Server 时,可在 GitHub Secret Protection 上使用。

关于警报类型

有三种类型的机密扫描警报:


          用户警报:** 在存储库中 **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality** 检测到支持的机密时,在存储库选项卡中向用户报告。
  • 推送保护警报: 当贡献者绕过推送保护时,会在存储库的** Security and quality** 选项卡中向用户报告。
  • 合作伙伴警报: 直接向属于secret scanning合作伙伴计划的保密供应商报告。 这些警报不会在存储库的** Security and quality** 选项卡中报告。

关于 用户警报

          在为存储库启用 secret scanning 或将提交推送到启用了 secret scanning 的存储库时,GitHub 会扫描内容,以查找与服务提供商定义的模式匹配的机密。
          
          当 secret scanning 检测到机密时,GitHub 将生成警报。
          GitHub 在 **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality** 存储库的选项卡中显示警报。
        

为了帮助你更有效地对警报进行会审, GitHub 可将警报分为两个列表:

  • 默认 警报
  • 通用 警报

默认警报列表

默认警报列表显示与支持的模式和指定的自定义模式相关的警报。 这是警报的主要视图。

          通用列表

泛型实验性警报列表显示与非提供程序模式(例如私钥)或通过 AI 检测的通用机密(例如密码)相关的警报。 这些类型的警报可以具有较高的测试中使用的误报或机密比率。 可以从默认警报列表切换到 通用实验性警报列表。

          GitHub 将继续向通用警报列表发布新的模式和机密类型,并在功能完成时(即当它们的数量和误报率适当低时)将其提升到默认列表。

此外,属于此类别的警报:

  • 每个存储库的警报数量(包括打开和关闭的警报)最多限制为 5000 个。
  • 不会显示在安全概述的摘要视图中,仅显示在“Secret scanning”视图中。
  • 对于非提供者模式,仅在 GitHub 上显示前五个检测到的位置,对于 AI 检测到的通用机密,仅显示第一个检测到位置。

若要GitHub扫描非供应商模式以及通用密钥,必须先为存储库或组织启用该功能。 有关详细信息,请参阅 为非提供程序模式启用机密扫描启用 Copilot 机密扫描的通用机密检测

如果访问资源需要配对的凭据,则只有在同一文件中检测到该配对的两个凭据时,机密扫描才会创建警报。 这可确保最关键的泄漏不会隐藏在有关部分泄漏的信息后面。 对匹配还有助于减少误报,因为对的两个元素必须一起使用才能访问提供商的资源。

关于推送保护警报

推送保护会对包含受支持机密的推送操作进行扫描。 如果推送保护检测到受支持的机密,将会阻止该次推送。 当参与者绕过推送保护将机密推送到存储库时,将生成推送保护警报并在存储库的选项卡中显示 Security and quality 。 若要查看某个存储库的所有推送保护警报,必须在警报页面中按 bypassed: true 进行筛选。 有关详细信息,请参阅“查看和筛选来自机密扫描的警报”。

如果访问资源需要配对的凭据,则只有在同一文件中检测到该配对的两个凭据时,机密扫描才会创建警报。 这可确保最关键的泄漏不会隐藏在有关部分泄漏的信息后面。 对匹配还有助于减少误报,因为对的两个元素必须一起使用才能访问提供商的资源。

注意

          还可以为个人帐户启用推送保护,称为“为用户推送保护”,从而防止意外将受支持的机密推送到 _任何_ 公共存储库。 如果你仅选择绕过基于用户的推送保护,则_不会_创建警报。 只有在存储库本身启用了推送保护的情况下,才会创建警报。 有关详细信息,请参阅 [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users)。
          推送保护可能不支持某些旧版令牌,因为这些令牌生成的误报数可能高于其最新版本。 推送保护也可能不适用于旧令牌。 对于 Azure 存储密钥等令牌,GitHub 仅支持“最近创建”令牌,不支持与旧模式匹配的令牌。 有关推送保护限制的详细信息,请参阅 [AUTOTITLE](/code-security/how-tos/secure-your-secrets/troubleshooting-secret-scanning#push-protection-and-pattern-versions)。

关于合作伙伴警报

当 GitHub 检测到公共存储库或 npm 包中泄露的机密时,如果它们是 GitHub 提供的机密扫描合作伙伴计划的一部分,警报会被直接发送给机密提供商。 有关 合作伙伴的机密扫描警报 的更多信息,请参阅 密码扫描合作伙伴计划支持的机密扫描模式

合作伙伴警报不会发送给存储库管理员,因此你无需对此类警报采取任何操作。

延伸阅读