自定义模式是用户定义的模式,可用来标识 secret scanning 支持的默认模式未检测到的机密。 有关详细信息,请参阅“为机密扫描定义自定义模式”。
在企业级别,只有自定义模式的创建者才能编辑模式,并在试运行中使用它。 在存储库和组织级别编辑自定义模式没有类似限制。
编辑自定义模式
将更改保存到自定义模式时,这将关闭使用该模式的先前版本创建的所有 机密扫描警报 警报。
-
导航到创建自定义模式的位置。 可以在存储库、组织或企业帐户中创建自定义模式。
- 对于仓库或组织,显示创建自定义模式的仓库或组织的“Security & analysis”设置。 有关详细信息,请参阅“为仓库定义自定义模式”或“为组织定义自定义模式”。
- 对于企业,在“Policies”下显示“Code security”区域,然后单击“Security features”****。 有关详细信息,请参阅“为企业帐户定义自定义模式”。
-
在“Secret scanning”下要编辑的自定义模式的右侧,单击 。
-
准备好测试编辑后的自定义模式时,若要识别匹配项而不创建警报,请单击“保存并试运行”****。
-
查看并测试更改后,单击“Publish changes”****。
-
根据需要,若要为自定义模式启用推送保护,请单击“启用”。
注意
- 自定义模式的推送保护仅适用于启用了 secret scanning 作为推送保护的存储库。 有关启用推送保护的详细信息,请参阅“关于推送保护”。
- 为常见的自定义模式启用推送保护可能会对参与者造成干扰。

-
根据需要,若要为自定义模式禁用推送保护,请单击“禁用”****。

删除自定义模式
在删除自定义模式时,GitHub 提供了关闭与模式相关的 机密扫描警报 或保留这些警报的选项。
- 导航到创建自定义模式的位置。 可以在存储库、组织或企业帐户中创建自定义模式。
- 对于仓库或组织,显示创建自定义模式的仓库或组织的“Security & analysis”设置。 有关详细信息,请参阅“为仓库定义自定义模式”或“为组织定义自定义模式”。
- 对于企业,在“Policies”下显示“Code security”区域,然后单击“Security features”****。 有关详细信息,请参阅“为企业帐户定义自定义模式”。
- 在要删除的自定义模式的右侧,单击“”。
- 查看确认,并选择一种方法来处理与自定义模式相关的任何打开的警报。
- 单击“是,删除此模式”****。
如果选择在删除自定义模式时关闭警报,则需要注意删除过程在后台异步发生。 对于生成大量警报(数千个或多个)的自定义模式,删除过程可能需要几分钟到几小时才能完成。 可以在该过程完成时继续工作。
为自定义模式启用推送保护
可以启用 secret scanning 作为在企业、组织或存储库级别存储的自定义模式的推送保护。
为企业中存储的自定义模式启用推送保护
注意
- 若要为自定义模式启用推送保护,需要在企业级启用 secret scanning 作为推送保护。
- 为常见的自定义模式启用推送保护可能会对参与者造成干扰。
在企业级别为自定义模式启用推送保护之前,还必须使用试运行测试自定义模式。 只能对具有管理访问权限的存储库执行试运行。 如果企业所有者想要对组织中的任何存储库执行试运行,则必须分配有组织所有者角色才可以。 有关详细信息,请参阅“管理您在企业所属组织中的角色”。
-
在 GitHub Enterprise Server 的右上角,单击你的个人资料头像,然后单击“Enterprise settings”****。
-
在页面左侧的企业帐户边栏中,单击“ Policies”********。
-
在 “Policies”下,单击“Code security”****。
-
在“Code security”下,单击“Security features”****。
-
在“Secret scanning”的“自定义模式”下,单击 以获取感兴趣的模式。
注意
在企业级别,只能为已创建的自定义模式编辑和启用推送保护。
-
若要为自定义模式启用推送保护,请向下滚动到“推送保护”,然后单击“启用”****。
注意
启用推送保护的选项仅对已发布的模式可见。

启用 secret scanning 作为组织中自定义模式的推送保护
在组织级别为自定义模式启用推送保护之前,必须确保在组织中为要扫描的存储库启用 secret scanning。 要启用组织中所有存储库上的 secret scanning,请参阅 管理组织的安全和分析设置。
-
在 GitHub 的右上角,单击个人资料图片,然后单击“ Your organizations”****。
-
在组织旁边,单击“设置”。
-
在边栏的“Security”部分中,选择“Code security”下拉菜单,然后单击“Global settings”********。
-
在“自定义模式”下,单击 以获取感兴趣的模式。
-
若要为自定义模式启用推送保护,请向下滚动到“推送保护”,然后单击“启用”****。
注意
- 启用推送保护的选项仅对已发布的模式可见。
- 自定义模式的推送保护仅适用于组织中启用了 secret scanning 作为推送保护的存储库。
- 为常见的自定义模式启用推送保护可能会对参与者造成干扰。

启用 secret scanning 作为存储库中自定义模式的推送保护
在存储库级别为自定义模式启用推送保护之前,必须定义存储库的自定义模式,并在存储库中对其进行测试。 有关详细信息,请参阅“为机密扫描定义自定义模式”。
-
在 GitHub 上,导航到存储库的主页面。
-
在仓库名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”。

-
在边栏的“Security”部分中,单击“ Code security”****。
-
在“Code security”下,查找“GitHub Advanced Security”。
-
在“Secret scanning”的“自定义模式”下,单击 以获取感兴趣的模式。
-
若要为自定义模式启用推送保护,请向下滚动到“推送保护”,然后单击“启用”****。
注意
启用推送保护的选项仅对已发布的模式可见。
