关于 secret scanning 警报页
在为存储库启用 secret scanning 或将提交推送到启用了 secret scanning 的存储库时,GitHub 会扫描内容,以查找与服务提供商定义的模式以及企业、组织或存储库中定义的任何自定义模式匹配的机密。
当 secret scanning 检测到机密时,GitHub 将生成警报。 GitHub 在存储库的“安全性”选项卡中显示警报。
为了帮助你更有效地对警报进行会审,GitHub 将警报分为两个列表:
- 默认警报****
- 通用警报****
默认警报列表
默认警报列表显示与支持的模式和指定的自定义模式相关的警报。 这是警报的主要视图。
通用警报列表
通用警报列表显示与非提供程序模式(如私钥)相关的警报,或者使用 AI 检测到的通用机密(如密码)。 这些类型的警报可以具有较高的测试中使用的误报或机密比率。 可以从默认警报列表切换到通用警报列表。
此外还显示属于以下类别的警报:
- 每个存储库的数量限制为 5000 个警报(这包括打开和关闭的警报)。
- 不显示在安全概览的摘要视图中,仅在“Secret scanning”视图中显示。
- 对于非提供程序模式 ,仅在 GitHub 上显示前五个检测到的位置,对于 AI 检测到的通用机密 ,仅显示第一个检测到的位置。
若要让 GitHub 扫描非提供程序模式 和通用机密 ,必须为存储库或组织启用 。 有关详细信息,请参阅 为非提供程序模式启用机密扫描 和 启用 Copilot 机密扫描的通用机密检测。
GitHub 会继续将新的模式和机密类型发布到通用警报列表,并在功能完成时将其提升为默认列表(例如,在其数量和误报率处于合理的低水平时)。
查看警报
secret scanning 的警报显示在存储库的“安全”选项卡下。
-
在 GitHub 上,导航到存储库的主页面。
-
在存储库名称下,单击“ 安全性”。 如果看不到“安全性”选项卡,请选择 下拉菜单并单击“安全性” 。
-
在左边栏的“漏洞警报”下,单击“Secret scanning”。
-
(可选)切换到“通用”可查看非提供程序模式或使用 AI 检测到的通用机密的警报。
-
在“Secret scanning”下,单击要查看的警报。
注意
只有对包含已泄露机密的存储库具有管理员权限的人员才能查看安全警报详细信息和警报的令牌元数据。 企业所有者可以出于此目的请求对存储库的临时访问权限。
筛选警报
可将各种筛选器应用于警报列表,帮助找到你要查看的警报。 可以使用警报列表上方的下拉菜单,或在搜索栏中输入表中列出的限定符。
Qualifier | 说明 |
---|---|
bypassed | 显示已绕过推送保护的机密的警报 (true )。 有关详细信息,请参阅“关于推送保护”。 |
is | 显示处于开放状态 (open )、处于关闭状态 (closed )、在公共仓库发现的警报 (publicly-leaked ),或者在同一组织或企业内的多个仓库中发现的警报 (multi-repository )。 |
props | 显示具有特定自定义属性 (CUSTOM_PROPERTY_NAME ) 集的仓库的警报。 例如,props:data_sensitivity:high 将显示 data_sensitivity 属性设置为值 high 的仓库的结果。 |
provider | 显示特定提供程序 (PROVIDER-NAME ) 的警报,例如 provider:github 。 有关支持的合作伙伴的列表,请参阅 支持的机密扫描模式。 |
repo | 显示在指定仓库 (REPOSITORY-NAME ) 中检测到的警报,例如 repo:octo-repository 。 |
resolution | 显示标记为以下关闭原因的警报:“误报”(false-positive )、“通过配置隐藏”(hidden-by-config )、“模式已删除”(pattern-deleted )、“模式已编辑”(pattern-edited )、“已撤销”(revoked )、“用于测试”(used-in-tests ) 或“不会修复”(wont-fix )。 |
results | 显示与支持的机密和自定义模式相关的警报 (default ),或与非提供商模式(例如私钥)相关的警报 (generic ),以及与 AI 检测到的通用机密(如密码)相关的警报。 请参阅“支持的机密扫描模式”,有关 AI 检测到的通用机密的详细信息,请参阅“使用 Copilot 机密扫描负责任地检测通用机密”。 |
secret-type | 显示特定机密类型 (SECRET-NAME ) 的警报,例如 secret-type:github_personal_access_token 。 有关支持的机密类型的列表,请参阅 支持的机密扫描模式。 |
sort | 按从最新到最旧 (created-desc )、最旧到最新 (created-asc )、最近更新时间 (updated-desc ) 或最远更新时间 (updated-asc ) 显示警报。 |
team | 显示由指定团队成员所有的警报,例如:team:octocat-dependabot-team 。 |
topic | 显示具有匹配仓库主题的警报,例如:topic:asdf 。 |
validity | 显示具有特定有效性(active 、inactive 或 unknown )的机密的警报。 仅适用于 GitHub 令牌,除非启用有效性检查。有关有效性状态的详细信息,请参阅“评估来自机密扫描的警报”。 |