Managing custom patterns

Custom patterns are user-defined patterns that you can use to identify secrets that are not detected by the default patterns supported by secret scanning. For more information, see Defining custom patterns for secret scanning.

At the enterprise level, only the creator of a custom pattern can edit the pattern, and use it in a dry run. There are no similar restrictions for editing custom patterns at repository and organization level.

Editing a custom pattern

When you save a change to a custom pattern, this closes all the alertas de verificação de segredo that were created using the previous version of the pattern.

1. Acesse o local onde o padrão personalizado foi criado. Um padrão personalizado pode ser criado na conta de um repositório, organização ou empresa.

   • Para um repositório ou organização, veja as configurações de "Advanced Security" do repositório ou da organização em que o padrão personalizado foi criado. Para obter mais informações, confira Como definir um padrão personalizado para um repositório ou Como definir um padrão personalizado para uma organização.
   • Para uma empresa, em "Políticas", exiba a área "Advanced Security" e clique em Recursos de segurança. Para obter mais informações, confira Defining a custom pattern for an enterprise account.

2. Under "Custom patterns", to the right of the custom pattern you want to edit, click .

3. When you're ready to test your edited custom pattern, to identify matches without creating alerts, click Save and dry run.

4. When you have reviewed and tested your changes, click Publish changes.

5. Opcionalmente, para habilitar a proteção push para seu padrão personalizado, clique em Habilitar.

   Observação

   • A proteção de push para padrões personalizados será aplicada somente a repositórios que tenham o secret scanning como uma proteção de push habilitada. Para saber mais sobre como habilitar a proteção por push, confira Sobre a proteção por push.
   • Habilitar a proteção de push para padrões personalizados comumente encontrados pode ser prejudicial para os colaboradores.
   

6. Optionally, to disable push protection for your custom pattern, click Disable.

   

Removing a custom pattern

When you remove a custom pattern, GitHub gives you the option to close the alertas de verificação de segredo relating to the pattern, or keep these alerts.

1. Acesse o local onde o padrão personalizado foi criado. Um padrão personalizado pode ser criado na conta de um repositório, organização ou empresa.
   • Para um repositório ou organização, veja as configurações de "Advanced Security" do repositório ou da organização em que o padrão personalizado foi criado. Para obter mais informações, confira Como definir um padrão personalizado para um repositório ou Como definir um padrão personalizado para uma organização.
   • Para uma empresa, em "Políticas", exiba a área "Advanced Security" e clique em Recursos de segurança. Para obter mais informações, confira Defining a custom pattern for an enterprise account.
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.

If you choose to close the alerts when removing a custom pattern, you need to be aware that the deletion process happens asynchronously in the background. For custom patterns that have generated a high volume of alerts (thousands or more), the deletion process may take several minutes to hours to complete. You can continue working while the process completes.

Enabling push protection for a custom pattern

You can enable secret scanning as a push protection for custom patterns stored at the enterprise, organization, or repository level.

Enabling push protection for a custom pattern stored in an enterprise

Before enabling push protection for a custom pattern at enterprise level, you must also test your custom patterns using dry runs. Você só pode executar uma simulação em repositórios aos quais você tem acesso de administração. Se um proprietário da empresa quiser acesso para executar simulações em qualquer repositório em uma organização, ele deverá receber a função de proprietário da organização. Para saber mais, confira Gerenciando sua função em uma organização pertencente à sua empresa.

1. Na parte superior da página, clique em Policies.{ % else %}No lado esquerdo da página, na barra lateral da conta empresarial, clique em Policies.

2. Em "Policies", clique em Advanced Security.

3. Under "Advanced Security", click Security features.

4. Em "Secret scanning", em "Padrões personalizados", clique em para o padrão de interesse.

   Observação

   At the enterprise level, you can only edit and enable push protection for custom patterns that you created.

5. To enable push protection for your custom pattern, scroll down to "Push Protection", and click Enable.

   Observação

   A opção para ativar a proteção por push é visível apenas para padrões publicados.

   

Enabling secret scanning as a push protection in an organization for a custom pattern

Before enabling push protection for a custom pattern at organization level, you must ensure that you enable secret scanning for the repositories that you want to scan in your organization. To enable secret scanning on all repositories in your organization, see Gerenciando as configurações de segurança e de análise da sua organização.

1. No canto superior direito de GitHub, clique na foto de perfil e clique em Your organizations.

2. Ao lado da organização, clique em Configurações.

3. In the "Security" section of the sidebar, select the Advanced Security dropdown menu, then click Global settings.

4. Under "Custom patterns", click for the pattern of interest.

5. To enable push protection for your custom pattern, scroll down to "Push Protection", and click Enable.

   Observação

   • A opção para ativar a proteção por push é visível apenas para padrões publicados.
   • A proteção de push para padrões personalizados será aplicada somente a repositórios em sua organização que tenham o secret scanning como uma proteção de push habilitada. Para saber mais, confira Sobre a proteção por push.
   • Habilitar a proteção de push para padrões personalizados comumente encontrados pode ser prejudicial para os colaboradores.
   

Enabling secret scanning as a push protection in a repository for a custom pattern

Before enabling push protection for a custom pattern at repository level, you must define the custom pattern for the repository, and test it in the repository. For more information, see Defining custom patterns for secret scanning.

1. Em GitHub, acesse a página principal do repositório.

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na seção "Security" da barra lateral, clique em Advanced Security.

4. Under "Secret Protection", under "Custom patterns", click for the pattern of interest.

5. To enable push protection for your custom pattern, scroll down to "Push Protection", and click Enable.

   Observação

   A opção para ativar a proteção por push é visível apenas para padrões publicados.