Skip to main content

评估机密扫描警报

了解可帮助你评估警报并确定其修复优先级的额外功能,例如检查机密的有效性。

谁可以使用此功能?

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

关于评估警报

有一些额外功能可帮助你评估警报,以便更好地确定其优先级并进行管理。 您可以:

  • 检查机密的有效性,了解机密是否仍处于活动状态。 仅适用于 GitHub 令牌。 请参阅检查机密的有效性
  • 执行“按需”有效性检查,以获取最新的验证状态。 请参阅 “执行按需有效性检查”。
  • 查看令牌的元数据。 仅适用于 GitHub 令牌。 例如查看上次使用令牌的时间。 请参阅查看 GitHub 令牌元数据
  • 查看暴露机密的扩展元数据检查,以查看详细信息,例如机密所有者以及如何联系机密所有者。 仅适用于 OpenAI API、Google OAuth 和 Slack 令牌。 请参阅查看令牌的扩展元数据
  • 查看分配给警报的标签。 有关更多信息,请参阅查看警报标签

检查机密的有效性

验证检查让您知道哪些机密属于 activeinactive 机密,帮助你排列 警报优先级。 active 机密是仍可能被利用的机密,因此应该优先审查和修正它们的警报。

默认情况下,GitHub 检查 GitHub 令牌的有效性,并在警报视图中显示令牌的验证状态。

使用 GitHub Team 或 GitHub Enterprise Cloud 且拥有 GitHub Secret Protection 许可证的组织还可为合作伙伴模式启用验证检查。 有关详细信息,请参阅“检查机密的有效性”。

有效期Status结果
活动机密activeGitHub 向此机密的提供者进行了核实,发现此机密处于活动状态
可能处于活动状态的机密unknownGitHub 尚不支持对此令牌类型进行验证检查
可能处于活动状态的机密unknownGitHub 无法验证此机密
机密处于非活动状态inactive应确保未发生未经授权的访问

合作伙伴模式的有效性检查可用于以下存储库类型:

GHE.com 上的 具有数据驻留的 GitHub Enterprise Cloud 不支持针对合作伙伴模式的有效性检查。

有关如何为合作伙伴模式启用有效性检查的信息,请参阅 为存储库启用有效性检查;有关当前支持哪些合作伙伴模式的信息,请参阅 支持的机密扫描模式

可以使用 REST API 检索每个令牌的最新验证状态的列表。 有关详细信息,请参阅 REST API 文档中的“适用于机密扫描的 REST API 终结点”。 还可以使用 Webhook 来通知与 secret scanning 警报相关的活动。 有关更多信息,请参阅 secret_scanning_alert 中的 事件。

向 GitHub Copilot 聊天 咨询 secret scanning 警报

拥有 GitHub Copilot Enterprise 许可证后,你可以向 Copilot 对话助手 寻求帮助,以更好地理解组织存储库中的安全警报(包括 secret scanning 警报)。 有关详细信息,请参阅“在 GitHub 中向 GitHub Copilot 提问”。

执行按需验证检查

          **
          **如果为存储库启用了合作伙伴模式的验证检查,则可通过单击警报视图中的“<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-sync" aria-label="sync" role="img"><path d="M1.705 8.005a.75.75 0 0 1 .834.656 5.5 5.5 0 0 0 9.592 2.97l-1.204-1.204a.25.25 0 0 1 .177-.427h3.646a.25.25 0 0 1 .25.25v3.646a.25.25 0 0 1-.427.177l-1.38-1.38A7.002 7.002 0 0 1 1.05 8.84a.75.75 0 0 1 .656-.834ZM8 2.5a5.487 5.487 0 0 0-4.131 1.869l1.204 1.204A.25.25 0 0 1 4.896 6H1.25A.25.25 0 0 1 1 5.75V2.104a.25.25 0 0 1 .427-.177l1.38 1.38A7.002 7.002 0 0 1 14.95 7.16a.75.75 0 0 1-1.49.178A5.5 5.5 0 0 0 8 2.5Z"></path></svg> Verify secret”,对任何受支持的机密执行“按需”验证检查。 GitHub 将模式发送给相关合作伙伴,并在警报视图中显示机密的验证状态。

显示 secret scanning 警报的用户界面的屏幕截图。 标有“验证机密”的按钮以橙色轮廓突出显示。

查看 GitHub 令牌元数据

注意

GitHub 令牌的元数据目前处于 公共预览版 阶段,可能会发生变化。

在活动的 GitHub 令牌警报视图中,可以查看有关令牌的某些元数据。 此元数据可以帮助你识别令牌,并确定要采取的修正步骤。

令牌(如personal access token和其他凭据)被视为个人信息。 有关使用 GitHub令牌的详细信息,请参阅 GitHub 的隐私声明可接受的使用政策

GitHub 令牌的 UI 的屏幕截图,其中显示了令牌元数据。

GitHub 令牌的元数据可用于任何启用了机密扫描的存储库的活动令牌。 如果令牌已被撤销或无法验证其状态,则元数据将不可用。 GitHub 会自动撤销公共存储库中的 GitHub 令牌,因此公共存储库中 GitHub 令牌的元数据极有可能不可用。 以下元数据可用于活动的 GitHub 令牌:

MetadataDescription
机密名称GitHub 令牌的创建者为该令牌提供的名称
机密所有者令牌所有者的 GitHub 句柄
创建时间令牌的创建日期
过期日期令牌的过期日期
上次使用时间上次使用令牌的日期
Access令牌是否具有组织访问权限

只有对包含已泄露机密的存储库具有管理员权限的人员才能查看安全警报详细信息和警报的令牌元数据。 企业所有者可以出于此目的请求对存储库的临时访问权限。 如果授予访问权限,GitHub 会通知包含泄露机密的存储库的所有者,在存储库所有者和企业审计日志中报告该操作,并启用 2 小时的访问权限。 有关更多信息,请参阅 访问企业中用户拥有的存储库

查看令牌的扩展元数据

注意

扩展的令牌元数据检查功能处于公开预览中,并可能发生变化。

在激活的GitHub令牌警报视图中,可以看到详细的元数据信息,例如所有者和联系人的详细信息。

下表显示了 所有可用的元数据。 请注意,元数据检查目前仅限于 OpenAI API、Google OAuth 和 Slack 令牌,并且每个令牌显示的元数据只能表示存在内容的子集。

元数据类型Description
负责人 ID提供者为拥有机密的用户或服务帐户分配的唯一标识符
所有者名称可读的用户名或密钥所有者的显示名称
所有者电子邮件与所有者关联的电子邮件地址
组织名称机密所属的组织/工作区/项目的名称
组织 ID提供商为该组织分配的唯一标识
机密颁发日期创建或最近颁发机密(令牌或密钥)时的时间戳
秘密到期日期计划机密过期时的时间戳
机密名称为机密分配的人工显示名称或标签
机密 ID提供程序的机密唯一标识符

查看警报标签

在警报视图中,你可以查看分配给该警报的任何标签。 标签提供有关警报的额外详细信息,可指导你采取的修复方法。

Secret scanning 警报可以分配以下标签。 根据分配的标签,你会在警报视图中看到额外信息。

LabelDescription警报视图信息
public leak你的存储库中检测到的机密也已通过 GitHub 对代码、讨论、要点、问题、拉取请求和维基的至少一次扫描被发现为公开泄露。 这可能要求你更紧急地处理该警报,或者与私下暴露的令牌相比,以不同方式修复该警报。你会看到指向检测到泄露机密的任何特定公共位置的链接。
multi-repo你的存储库中检测到的机密已在你的组织或企业的多个存储库中找到。 此信息可帮助你更轻松地在组织或企业中消除该警报的重复项。如果你拥有适当的权限,你会看到指向你的组织或企业中同一机密的任何特定警报的链接。

后续步骤

  •         [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/resolving-alerts)