定义密钥扫描的自定义模式

您可以在组织和私有仓库中定义秘密扫描的自定义模式。

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

注意：秘密扫描的自定义模式目前处于测试阶段，可能会更改。

GitHub 在公共和私有仓库中执行performs 秘密扫描，以用于 GitHub 和 GitHub 模式提供的密钥模式。有关秘密扫描合作伙伴计划的更多信息，请参阅“密码扫描合作伙伴计划”。

但是，在某些情况下，您需要扫描私有仓库中的其他密钥模式。例如，您可能有一个属于您组织内部的密钥模式。在这些情况下，您可以在组织和 GitHub 上的私有仓库中定义自定义秘密扫描模式。您可以为每个私有仓库或组织定义多达 20 个自定义模式。

注意： 在测试版中，对秘密扫描使用自定义模式时存在一些限制：

秘密扫描的自定义模式被指定为正则表达式。秘密扫描使用 Hyperscan 库，只支持 Hyperscan regex 结构（PCRE 语法的子集）。不支持 Hyperscan 选项修饰符。有关 Hyperscan 模式构造的更多信息，请参阅 Hyperscan 文档中的“模式支持”。

在定义自定义模式之前，您必须确保仓库上启用了秘密扫描。更多信息请参阅“为仓库配置秘密扫描”。

在 GitHub 上，导航到仓库的主页面。
在仓库名称下，单击 Settings（设置）。
在左侧边栏中，单击 Security & analysis（安全和分析）。
在“Configure security and analysis features（配置安全和分析功能）”下，查找“GitHub Advanced Security”。
在“秘密扫描”下，单击添加秘密扫描自定义模式。
输入新自定义模式的详细信息：
1. 您至少必须提供模式的名称，以及秘密模式格式的正则表达式。
2. 您可以点击更多选项 来提供密钥格式的其他周围内容或额外匹配要求。
3. 您可以提供示例测试字符串，然后单击 Test（测试）按钮，以确保您的配置与预期的模式匹配。
当您对新自定义模式满意时，点击 Create custom pattern（创建自定义模式）。

在模式创建后，秘密扫描将在 GitHub 仓库中存在的所有分支上扫描整个 Git 历史记录的任何密钥。有关查看秘密扫描警报的详细信息，请参阅“管理来自秘密扫描的警报”。

在定义自定义模式之前，您必须确保在组织中为要扫描的私有仓库启用秘密扫描。要在您的组织中启用秘密扫描所有私有仓库，请参阅“管理组织的安全和分析设置”。

注意： 自定义模式测试版期间没有干运行功能。为了避免过多的误报秘密扫描警报，我们建议您在为整个组织定义自定义模式之前，先在仓库中测试自定义模式。

在 GitHub 的右上角，单击您的个人资料照片，然后单击 Your organizations（您的组织）。
在组织旁边，单击 Settings（设置）。
在左侧边栏中，单击 Security & analysis（安全和分析）。
在“Configure security and analysis features（配置安全和分析功能）”下，查找“GitHub Advanced Security”。
在“秘密扫描”下，单击添加秘密扫描自定义模式。
输入新自定义模式的详细信息：
1. 您至少必须提供模式的名称，以及秘密模式格式的正则表达式。
2. 您可以点击更多选项 来提供密钥格式的其他周围内容或额外匹配要求。
3. 您可以提供示例测试字符串，然后单击 Test（测试）按钮，以确保您的配置与预期的模式匹配。
当您对新自定义模式满意时，点击 Create custom pattern（创建自定义模式）。

创建模式后，秘密扫描扫描组织中的私有仓库中的任何密钥，包括其所有分支的整个 Git 历史记录。组织所有者和仓库管理员将会收到发现的任何密钥警报通知，并且可以审查发现密钥的仓库中的警报。有关查看秘密扫描警报的详细信息，请参阅“管理来自秘密扫描的警报”。

删除自定义模式还可以关闭模式创建的所有秘密扫描警报。

导航到创建自定义模式的仓库或组织的 Security & analysis（安全和分析）设置。更多信息请参阅“定义仓库的自定义模式”或“定义组织的自定义模式”。
在“Configure security and analysis features（配置安全和分析功能）”下，查找“GitHub Advanced Security”。
在“秘密扫描”下，找到要删除的自定义模式，然后单击 Remove（删除）。
查看确认并单击 Remove custom pattern（删除自定义模式）。

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