Defining custom patterns for secret scanning

About custom patterns for 秘密扫描

GitHub performs 秘密扫描 on public and private repositories for secret patterns provided by GitHub and GitHub partners. For more information on the 秘密扫描 partner program, see "Secret scanning partner program."

However, there can be situations where you want to scan for other secret patterns in your private repositories. For example, you might have a secret pattern that is internal to your organization. For these situations, you can define custom 秘密扫描 patterns in your enterprise, organization, or private repository on GitHub. You can define up to 500 custom patterns for each organization or enterprise account, and up to 100 custom patterns per private repository.

Regular expression syntax for custom patterns

Custom patterns for 秘密扫描 are specified as regular expressions. 秘密扫描 uses the Hyperscan library and only supports Hyperscan regex constructs, which are a subset of PCRE syntax. Hyperscan option modifiers are not supported. For more information on Hyperscan pattern constructs, see "Pattern support" in the Hyperscan documentation.

Defining a custom pattern for a repository

Before defining a custom pattern, you must ensure that 秘密扫描 is enabled on your repository. For more information, see "Configuring 秘密扫描 for your repositories."

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

2. 在仓库名称下，单击 Settings（设置）。

3. 在左侧边栏中，单击 Security & analysis（安全和分析）。

4. 在“Configure security and analysis features（配置安全和分析功能）”下，查找“GitHub Advanced Security”。

5. Under "秘密扫描", under "Custom patterns", click New pattern.

6. 输入新自定义模式的详细信息：

   1. 您至少必须提供模式的名称，以及秘密模式格式的正则表达式。
   2. 您可以点击更多选项 来提供密钥格式的其他周围内容或额外匹配要求。
   3. Provide a sample test string to make sure your configuration is matching the patterns you expect.

   

7. When you are satisfied with your new custom pattern, click Create pattern.

After your pattern is created, 秘密扫描 将在 GitHub 仓库中存在的所有分支上扫描整个 Git 历史记录的任何密钥。 For more information on viewing 秘密扫描 alerts, see "Managing alerts from 秘密扫描."

Defining a custom pattern for an organization

Before defining a custom pattern, you must ensure that you enable 秘密扫描 for the private repositories that you want to scan in your organization. To enable 秘密扫描 on all private repositories in your organization, see "Managing security and analysis settings for your organization."

1. In the top right corner of GitHub.com, click your profile photo, then click Your organizations.

2. 在组织旁边，单击 Settings（设置）。

3. 在左侧边栏中，单击 Security & analysis（安全和分析）。

4. 在“Configure security and analysis features（配置安全和分析功能）”下，查找“GitHub Advanced Security”。

5. Under "秘密扫描", under "Custom patterns", click New pattern.

6. 输入新自定义模式的详细信息：

   1. 您至少必须提供模式的名称，以及秘密模式格式的正则表达式。
   2. 您可以点击更多选项 来提供密钥格式的其他周围内容或额外匹配要求。
   3. Provide a sample test string to make sure your configuration is matching the patterns you expect.

   

7. When you are satisfied with your new custom pattern, click Create pattern.

After your pattern is created, 秘密扫描 scans for any secrets in private repositories in your organization, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing 秘密扫描 alerts, see "Managing alerts from 秘密扫描."

Defining a custom pattern for an enterprise account

Before defining a custom pattern, you must ensure that you enable secret scanning for your enterprise account. For more information, see "Enabling GitHub Advanced Security for your enterprise."

1. 在企业账户侧边栏中，单击 Policies（政策）。

2. 在 策略下，单击“Advanced Security（高级安全性）”。

3. Under "GitHub Advanced Security", click the Security features tab.

4. Under "Secret scanning custom patterns", click New pattern.

5. 输入新自定义模式的详细信息：

   1. 您至少必须提供模式的名称，以及秘密模式格式的正则表达式。
   2. 您可以点击更多选项 来提供密钥格式的其他周围内容或额外匹配要求。
   3. Provide a sample test string to make sure your configuration is matching the patterns you expect.

   

6. When you are satisfied with your new custom pattern, click Create pattern.

After your pattern is created, 秘密扫描 scans for any secrets in private repositories within your enterprise's organizations with GitHub Advanced Security enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing 秘密扫描 alerts, see "Managing alerts from 秘密扫描."

Editing a custom pattern

When you save a change to a custom pattern, this closes all the 秘密扫描 alerts that were created using the previous version of the pattern.

1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account.
   • For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "Defining a custom pattern for a repository" or "Defining a custom pattern for an organization" above.
   • For an enterprise, under "Policies" display the "Advanced Security" area, and then click Security features. For more information, see "Defining a custom pattern for an enterprise account" above.
2. Under "秘密扫描", to the right of the custom pattern you want to edit, click .
3. When you have reviewed and tested your changes, click Save changes.

Removing a custom pattern

1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account.

   • For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "Defining a custom pattern for a repository" or "Defining a custom pattern for an organization" above.
   • For an enterprise, under "Policies" display the "Advanced Security" area, and then click Security features. For more information, see "Defining a custom pattern for an enterprise account" above.

2. To the right of the custom pattern you want to remove, click .

3. Review the confirmation, and select a method for dealing with any open alerts relating to the custom pattern.

4. Click Yes, delete this pattern.