启用 用户的机密扫描警报
可以为任何你拥有的免费公共存储库启用用户的机密扫描警报。 启用后,secret scanning 将在 GitHub 仓库中存在的所有分支上扫描整个 Git 历史记录的任何密钥。 此外,secret scanning 会扫描:
- 问题中的描述和评论
- 打开和结束的_历史_问题中的标题、描述和评论
- 拉取请求中的标题、描述和评论
- GitHub Discussions中的标题、描述和注释
- Wiki
此项额外扫描对公共存储库是免费的。
注意: 拉取请求和 GitHub Discussions 中的内容的扫描和 wiki 目前处于 Beta 版,可能会有变动。
还可以同时为组织中的多个存储库启用 secret scanning。 有关详细信息,请参阅“保护组织快速入门”。
存储库管理员可以选择随时为存储库禁用secret scanning。 有关详细信息,请参阅“管理存储库的安全和分析设置”。
-
在 GitHub.com 上,导航到存储库的主页。
-
在存储库名称下,单击 “设置”。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。
-
在边栏的“安全性”部分中,单击“ 代码安全性和分析”。
-
向下滚动到页面底部,为 secret scanning 单击“启用”。 如果你看到“禁用”按钮,则表示已为存储库启用 secret scanning。
启用 用户的机密扫描警报 的额外功能
可以通过存储库的“代码安全和分析”设置启用以下附加 secret scanning 功能:
- 推送保护。 有关详细信息,请参阅“存储库和组织的推送保护”。
为所有公共存储库启用用户的机密扫描警报
可以通过个人帐户设置为所有现有的公共存储库启用secret scanning。
注意****:从 2024 年 3 月 11 日起,你新创建的所有公共存储库将会默认启用secret scanning和推送保护。 仍然可以在存储库的“代码安全和分析”设置页面中选择为单个存储库禁用这些功能。 有关详细信息,请参阅“管理存储库的安全和分析设置”。
- 在 GitHub 任意页的右上角,单击个人资料照片,然后单击“设置”。
- 在边栏的“安全性”部分中,单击“ 代码安全性和分析”。
- 在“代码安全和分析”下的“Secret scanning”右侧,单击“全部禁用”或“全部启用”。
从 用户的机密扫描警报 中排除目录
可以将 secret_scanning.yml 文件配置为从 secret scanning 中排除目录,包括使用推送保护时。 例如,可以排除包含测试或随机生成内容的目录。
-
在 GitHub.com 上,导航到存储库的主页。
-
在文件列表上方,选择“添加文件” 下拉菜单,然后单击“ 创建新文件” 。
也可在左侧的文件树状视图中单击 。
-
在文件名字段中,键入 .github/secret_scanning.yml。
-
在“编辑新文件”下,键入
paths-ignore:
,后跟要从 secret scanning 中排除的路径。paths-ignore: - "foo/bar/*.js"
可以使用特殊字符(例如
*
)来筛选路径。 有关筛选器模式的详细信息,请参阅“GitHub Actions 的工作流语法”。注意:
- 如果
paths-ignore
中的条目超过 1,000 个,secret scanning 只会从扫描中排除前 1,000 个目录。 - 如果
secret_scanning.yml
大于 1 MB,secret scanning 将忽略整个文件。
- 如果
您也可以忽略来自 secret scanning 的个别警报。 有关详细信息,请参阅“管理来自机密扫描的警报”。