跳至主要内容

管理自定义模式

您可以查看、编辑和删除自定义模式,并为自定义模式启用推送保护。

谁可以使用此功能?

仓库所有者、组织所有者、安全经理、企业管理员以及拥有 admin 角色的用户

自定义模式是用户定义的模式,您可以用它们来识别默认秘密扫描所不支持的机密。欲了解更多信息,请参阅 自定义秘密扫描模式的定义

在企业级别,仅自定义模式的创建者可以编辑该模式并在演练中使用。对于仓库和组织级别的自定义模式,编辑没有类似限制。

编辑自定义模式

当您保存对自定义模式的更改时,会关闭所有使用该模式先前版本创建的秘密扫描警报。

  1. 前往创建自定义模式的地点。自定义模式可以在仓库、组织或企业账户中创建。

  2. 在“自定义模式”下,想要编辑的自定义模式右侧,点击.

  3. 准备好测试编辑后的自定义模式,以在不创建警报的情况下识别匹配项时,点击 保存并演练

  4. 审阅并测试完更改后,点击 发布更改

  5. 可选:若要为自定义模式启用推送保护,请点击 启用

    注意

    • 自定义模式的推送保护仅适用于已启用秘密扫描推送保护的仓库。有关启用推送保护的更多信息,请参阅 关于推送保护
    • 为常见的自定义模式启用推送保护可能会对贡献者造成干扰。

    Screenshot of custom pattern page with the button to enable push protection emphasized.

  6. 可选:若要为自定义模式禁用推送保护,请点击 禁用

    Screenshot of the custom pattern page with the button to disable push protection highlighted with a dark orange outline.

删除自定义模式

删除自定义模式时,GitHub 会让您选择关闭与该模式相关的秘密扫描警报,或保留这些警报。

  1. 前往创建自定义模式的地点。自定义模式可以在仓库、组织或企业账户中创建。
  2. 要删除的自定义模式右侧,点击.
  3. 检查确认信息,并选择处理与该自定义模式相关的任何未解决警报的方法。
  4. 点击 是的,删除此模式

如果您在删除自定义模式时选择关闭警报,需要注意删除过程会在后台异步进行。对于生成大量警报(数千或更多)的自定义模式,删除过程可能需要几分钟到数小时才能完成。您可以在此期间继续其他工作。

为自定义模式启用推送保护

您可以为存储在企业、组织或仓库级别的自定义模式启用秘密扫描作为推送保护。

为企业中存储的自定义模式启用推送保护

注意

  • 若要为自定义模式启用推送保护,需要在企业级别启用秘密扫描作为推送保护。
  • 为常见的自定义模式启用推送保护可能会对贡献者造成干扰。

在企业级别为自定义模式启用推送保护之前,您还必须使用演练对自定义模式进行测试。演练只能在您拥有管理员权限的仓库上执行。如果企业所有者希望在组织中的任何仓库执行演练,则必须被授予组织所有者角色。欲了解更多信息,请参阅 管理您在企业拥有的组织中的角色

  1. 转到您的企业。例如,在 GitHub.com 上的 企业 页面。

  2. 在页面顶部,点击 政策

  3. 在 “策略”,点击 高级安全

  4. 在“高级安全”下,点击 安全功能

  5. 在“秘密扫描”,在“自定义模式”下,点击对应感兴趣的模式。

    注意

    在企业级别,您只能编辑和为自己创建的自定义模式启用推送保护。

  6. 要为自定义模式启用推送保护,请向下滚动至“推送保护”,并点击 启用

    注意

    仅已发布的模式会显示启用推送保护的选项。

    Screenshot of the custom pattern page with the button to enable push protection highlighted with a dark orange outline.

在组织中为自定义模式启用秘密扫描作为推送保护

在组织级别为自定义模式启用推送保护之前,您必须确保为组织中想要扫描的仓库启用秘密扫描。若要在组织中为所有仓库启用秘密扫描,请参阅 管理组织的安全和分析设置

  1. 在 GitHub 右上角,点击您的个人资料图片,然后点击 组织

  2. 点击即可选择组织。

  3. 在您的组织名称下,点击 设置。如果您看不到 “设置” 选项卡,请选择 下拉菜单,然后点击 设置

    Screenshot of the tabs in an organization's profile. The "Settings" tab is outlined in dark orange.

  4. 在侧边栏的 “Security” 部分,选择 Advanced Security 下拉菜单,然后点击 Global settings

  5. 在“自定义模式”下,点击对应感兴趣的模式。

  6. 要为自定义模式启用推送保护,请向下滚动至“推送保护”,并点击 启用

    注意

    • 仅已发布的模式会显示启用推送保护的选项。
    • 自定义模式的推送保护仅适用于您组织中已启用秘密扫描推送保护的仓库。
    • 为常见的自定义模式启用推送保护可能会对贡献者造成干扰。

    Screenshot of the "Push protection" section of the custom pattern page. A button, labeled "Enable", is outlined in dark orange.

在仓库中为自定义模式启用秘密扫描作为推送保护

在仓库级别为自定义模式启用推送保护之前,您必须为仓库定义自定义模式并在仓库中进行测试。欲了解更多信息,请参阅 为秘密扫描定义自定义模式

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

  2. 在您的仓库名称下,点击 设置。如果您看不到 “设置” 选项卡,请选择 下拉菜单,然后点击 设置

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  3. 在侧边栏的Security部分,点击 Advanced Security

  4. 在“秘密保护”下, 在“自定义模式”下,点击对应感兴趣的模式。

  5. 要为自定义模式启用推送保护,请向下滚动至“推送保护”,并点击 启用

    注意

    仅已发布的模式会显示启用推送保护的选项。

    Screenshot of the "Push protection" section of the custom pattern page. A button, labeled "Enable", is outlined in dark orange.

© . This site is unofficial and not affiliated with GitHub, Inc.