配置仓库的密码扫描

您可以配置 GitHub 如何扫描您仓库中的密码。

People with admin permissions to a repository can enable 秘密扫描 for the repository.

秘密扫描 适用于所有公共仓库以及启用了 GitHub Advanced Security 的组织拥有的私有仓库。 更多信息请参阅“关于 GitHub Advanced Security”。

注:秘密扫描 默认在公共仓库上启用,无法关闭。 您只能配置私有仓库的 秘密扫描。

为私有仓库启用 秘密扫描

启用后,秘密扫描 将在 GitHub 仓库中存在的所有分支上扫描整个 Git 历史记录的任何密钥。

  1. 在 GitHub 上,导航到仓库的主页面。

  2. 在仓库名称下,单击 Settings(设置)仓库设置按钮

  3. 在左侧边栏中,单击 Security & analysis(安全和分析)仓库设置中的"Security & analysis(安全和分析)"选项卡

  4. 如果 Advanced Security 尚未对仓库启用,请在“GitHub Advanced Security”右侧单击 Enable(启用)为仓库启用 GitHub Advanced Security

  5. 查看启用 Advanced Security 的影响,然后点击 对仓库启用 GitHub Advanced Security

  6. 当您启用 Advanced Security 时,秘密扫描 可能会因为组织的设置而自动启用。 如果 "秘密扫描" 显示 Enable(启用)按钮,则您仍需通过单击 Enable(启用)来启用 秘密扫描。 如果您看到 Disable(禁用)按钮,则表明 秘密扫描 已启用。 为仓库启用 秘密扫描

排除私有仓库中的 秘密扫描 警报

您可以使用 secret_scanning.yml 文件从 秘密扫描 排除目录。 例如,可以排除包含测试或随机生成内容的目录。

  1. 在 GitHub 上,导航到仓库的主页面。

  2. 在文件列表上方,使用 Add file(添加文件)下拉菜单,单击 Create new file(创建新文件)"添加文件"下拉菜单中的"创建新文件"按钮

  3. 在文件名字段中,键入 .github/secret_scanning.yml

  4. Edit new file(编辑新文件)下,键入 paths-ignore:,后接您想要从 秘密扫描 排除的路径。

    paths-ignore:
      - "foo/bar/*.js"
    

    您可以使用特殊字符(如 *)来过滤路径。 有关过滤模式的更多信息,请参阅“GitHub Actions 的工作流程语法”。

    注意:

    • 如果 paths-ignore 中的条目超过 1,000 个,秘密扫描 只会从扫描中排除前 1,000 个目录。
    • 如果 secret_scanning.yml 大于 1 MB,秘密扫描 将忽略整个文件。

您也可以忽略来自 秘密扫描 的个别警报。 更多信息请参阅“管理来自 秘密扫描 的警报”。

延伸阅读

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。