Defining custom patterns for secret scanning

You can define custom patterns for varredura secreta in organizations and private repositories.

Varredura secreta está disponível para todos os repositórios públicos e para repositórios privados pertencentes a organizações em que Segurança Avançada GitHub está habilitado. Para obter mais informações, consulte "Sobre Segurança Avançada GitHub".

About custom patterns for varredura secreta

GitHub performs varredura secreta on public and private repositories for secret patterns provided by GitHub and GitHub partners. For more information on the varredura secreta 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 varredura secreta 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 varredura secreta are specified as regular expressions. Varredura secreta 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 varredura secreta is enabled on your repository. For more information, see "Configuring varredura secreta for your repositories."

  1. No GitHub.com, navegue até a página principal do repositório.

  2. No nome do seu repositório, clique em Configurações. Botão de configurações do repositório

  3. Na barra lateral esquerda, clique em Security & analysis (Segurança e análise). aba de "Segurança & análise" nas configurações do repositório

  4. Em "Configurar recursos de segurança e análise", encontre "Segurança Avançada GitHub".

  5. Under "Varredura secreta", under "Custom patterns", click New pattern.

  6. Insira as informações para o seu novo padrão personalizado:

    1. Você deve fornecer, pelo menos, o nome para o seu padrão e uma expressão regular para o formato do seu padrão de segredo.
    2. Você pode clicar em Mais opções para fornecer outros conteúdos adjacentes ou requisitos adicionais de correspondência para o formato do segredo.
    3. Provide a sample test string to make sure your configuration is matching the patterns you expect.

    Crie um formulário de padrão personalizado de varredura secreta

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

After your pattern is created, varredura secreta verifica todos segredos em todo o histórico do Git em todos os branches presentes no repositório GitHub. For more information on viewing varredura secreta alerts, see "Managing alerts from varredura secreta."

Defining a custom pattern for an organization

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

Note: As there is no dry-run functionality, we recommend that you test your custom patterns in a repository before defining them for your entire organization. That way, you can avoid creating excess false-positive varredura secreta alerts.

  1. In the top right corner of GitHub.com, click your profile photo, then click Your organizations. Suas organizações no menu de perfil

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

  3. Na barra lateral esquerda, clique em Security & analysis (Segurança e análise). "Security & analysis" (Segurança e análise) aba nas configurações da organização

  4. Em "Configurar recursos de segurança e análise", encontre "Segurança Avançada GitHub".

  5. Under "Varredura secreta", under "Custom patterns", click New pattern.

  6. Insira as informações para o seu novo padrão personalizado:

    1. Você deve fornecer, pelo menos, o nome para o seu padrão e uma expressão regular para o formato do seu padrão de segredo.
    2. Você pode clicar em Mais opções para fornecer outros conteúdos adjacentes ou requisitos adicionais de correspondência para o formato do segredo.
    3. Provide a sample test string to make sure your configuration is matching the patterns you expect.

    Crie um formulário de padrão personalizado de varredura secreta

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

After your pattern is created, varredura secreta 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 varredura secreta alerts, see "Managing alerts from varredura secreta."

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 Segurança Avançada GitHub for your enterprise."

Note: As there is no dry-run functionality, we recommend that you test your custom patterns in a repository before defining them for your entire enterprise. That way, you can avoid creating excess false-positive varredura secreta alerts.

  1. Na barra lateral da conta corporativa, clique em Policies. Aba de políticas na barra lateral da conta corporativa

  2. Em Políticas, clique em "Segurança Avançada". Políticas de "Segurança avançada" na barra lateral

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

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

  5. Insira as informações para o seu novo padrão personalizado:

    1. Você deve fornecer, pelo menos, o nome para o seu padrão e uma expressão regular para o formato do seu padrão de segredo.
    2. Você pode clicar em Mais opções para fornecer outros conteúdos adjacentes ou requisitos adicionais de correspondência para o formato do segredo.
    3. Provide a sample test string to make sure your configuration is matching the patterns you expect.

    Crie um formulário de padrão personalizado de varredura secreta

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

After your pattern is created, varredura secreta scans for any secrets in private repositories within your enterprise's organizations with Segurança Avançada GitHub 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 varredura secreta alerts, see "Managing alerts from varredura secreta."

Editing a custom pattern

When you save a change to a custom pattern, this closes all the varredura secreta 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.
  2. Under "Varredura secreta", 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.

  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.

    Confirming deletion of a custom varredura secreta pattern

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.