我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

配置仓库的密码扫描

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

拥有仓库管理员权限的人可启用仓库的 秘密扫描。

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

本文内容

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

为私有仓库启用 秘密扫描

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

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

    仓库设置按钮

  3. 在左侧边栏中,单击 Security & analysis(安全和分析)

    仓库设置中的"Security & analysis(安全和分析)"选项卡

  4. 您可能需要启用 GitHub Advanced Security 才能对“秘密扫描”激活按钮。 在“GitHub Advanced Security”右边单击 Enable(启用)

    为仓库启用 GitHub Advanced Security

  5. 单击为此仓库启用 GitHub Advanced Security 以确认操作。

    确认为仓库启用 GitHub Advanced Security

  6. 启用 GitHub 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,秘密扫描 将忽略整个文件。

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

延伸阅读

此文档对您有帮助吗?

Privacy policy

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

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

做出贡献

或, 了解如何参与。