Skip to main content

Gerar expressões regulares para padrões personalizados com IA

Você pode usar o gerador de expressões regulares para gerar expressões regulares para padrões personalizados. O gerador usa um modelo de IA para gerar expressões que correspondem à sua entrada e, opcionalmente, exemplos de cadeias de caracteres.

Quem pode usar esse recurso?

Os Alertas de verificação de segredo para parceiros são executados automaticamente em repositórios públicos e pacotes npm públicos para notificar os provedores de serviço sobre os segredos vazados do GitHub.com.

Os Alertas de verificação de segredo para usuários estão disponíveis gratuitamente em todos os repositórios públicos. As organizações que usam o GitHub Enterprise Cloud com uma licença do GitHub Advanced Security também podem habilitar alertas de verificação de segredo para usuários em seus repositórios privados e internos. Para obter mais informações, confira "Sobre a verificação de segredo" e "Sobre a Segurança Avançada do GitHub".

Para obter informações sobre como é possível testar o GitHub Advanced Security de forma gratuita, confira “Como configurar uma avaliação gratuita do GitHub Advanced Security”.

Observação: o gerador de expressões regulares está em beta. A funcionalidade e a documentação estão sujeitas a alterações. Se você tiver uma conta corporativa e usar o GitHub Advanced Security, poderá entrar na lista de espera para recursos de IA do GitHub Advanced Security.

Sobre o gerador de expressões regulares

Os padrões personalizados são formatados como expressões regulares. Você pode digitar manualmente uma expressão regular no GitHub ou pode usar o gerador de expressões regulares. O gerador usa um modelo de IA generativa em que você insere uma descrição de texto do tipo de padrão que deseja detectar, incluindo cadeias de caracteres de exemplo opcionais que devem ser detectadas. O modelo retorna até três expressões regulares para revisão.

Para obter instruções sobre como gerar uma expressão regular manualmente para seu repositório ou sua organização, confira "Definir padrões personalizados para a verificação de segredo".

Para obter mais informações sobre o gerador, confira "Sobre o gerador de expressões regulares para padrões personalizados."

Gerar uma expressão regular para um repositório usando o gerador

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

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

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na seção "Segurança" da barra lateral, clique em Segurança de código e análise.

  4. Em "Segurança e análise de código", encontre o "GitHub Advanced Security".

  5. Em "Secret scanning", em "Padrões personalizados", clique em Novo padrão.

  6. No campo "Nome do padrão", digite um nome para o seu padrão.

  7. No canto superior direito, clique em Gerar com IA.

    Nota: Você pode inserir uma expressão regular manualmente em vez de usar o gerador, digitando uma expressão regular no formato do seu padrão de segredo, no campo "Formato de segredo". Para obter mais informações, confira "Definir um padrão personalizado para um repositório" ou "Definir um padrão personalizado para uma organização".

  8. No painel deslizante exibido:

    • Preencha o campo "Eu quero uma expressão regular que", descrevendo, de preferência em inglês simples, quais padrões você deseja que sua expressão regular capture. Você pode usar outras linguagens naturais, mas o desempenho pode não ser tão bom quanto com o inglês.

    • Preencha o campo "Exemplos do que estou procurando", dando um exemplo de um padrão que você deseja verificar.

    • Clique em Gerar sugestões.

    • Se desejar, clique em uma sugestão para exibir uma descrição da expressão regular.

    • Clique em Usar resultados na seção Resultados que aparece, para o resultado que você deseja usar.

      Captura de tela de um formulário de padrão personalizado preenchido de secret scanning.

  9. Clique em Mais opções para fornecer outro conteúdo complementar ou requisitos de correspondência adicionais para o formato secreto. O GitHub adicionará os exemplos digitados no painel deslizante ao campo Cadeia de caracteres de teste.

  10. Quando estiver pronto para testar seu novo padrão personalizado, a fim de identificar correspondências no repositório sem criar alertas, clique em Salvar e executar uma simulação.

  11. Quando o teste terminar, você verá uma amostra de resultados (até 1.000). Revise os resultados e identifique quaisquer resultados falso-positivos. Captura de tela mostrando os resultados da simulação.

  12. Edite o novo padrão personalizado para corrigir problemas com os resultados e testar suas alterações e clique em Salvar e executar uma simulação.

  13. Quando estiver satisfeito com o novo padrão personalizado, clique em Publicar padrão.

Você pode configurar o secret scanning para verificar pushes em busca de padrões personalizados antes que os commits sejam mesclados no branch padrão. Para obter mais informações, consulte "Habilitar a proteção por push para um padrão personalizado".

Gerar uma expressão regular para uma organização usando o gerador

  1. No canto superior direito do GitHub.com, selecione sua foto do perfil e em Suas organizações.

    Captura de tela do menu suspenso na imagem de perfil do @octocat. "Suas organizações" está contornado em laranja escuro.

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

  3. Na seção "Segurança" da barra lateral, clique em Segurança de código e análise.

  4. Em "Segurança e análise de código", encontre o "GitHub Advanced Security".

  5. Em "Secret scanning", em "Padrões personalizados", clique em Novo padrão.

  6. No campo "Nome do padrão", digite um nome para o seu padrão.

  7. No canto superior direito, clique em Gerar com IA.

    Nota: Você pode inserir uma expressão regular manualmente em vez de usar o gerador, digitando uma expressão regular no formato do seu padrão de segredo, no campo "Formato de segredo". Para obter mais informações, confira "Definir um padrão personalizado para um repositório" ou "Definir um padrão personalizado para uma organização".

  8. No painel deslizante exibido:

    • Preencha o campo "Eu quero uma expressão regular que", descrevendo, de preferência em inglês simples, quais padrões você deseja que sua expressão regular capture. Você pode usar outras linguagens naturais, mas o desempenho pode não ser tão bom quanto com o inglês.

    • Preencha o campo "Exemplos do que estou procurando", dando um exemplo de um padrão que você deseja verificar.

    • Clique em Gerar sugestões.

    • Se desejar, clique em uma sugestão para exibir uma descrição da expressão regular.

    • Clique em Usar resultados na seção Resultados que aparece, para o resultado que você deseja usar.

      Captura de tela de um formulário de padrão personalizado preenchido de secret scanning.

  9. Clique em Mais opções para fornecer outro conteúdo complementar ou requisitos de correspondência adicionais para o formato secreto. O GitHub adicionará os exemplos digitados no painel deslizante ao campo Cadeia de caracteres de teste.

  10. Se estiver pronto para testar seu novo padrão personalizado para identificar correspondências em repositórios específicos sem criar alertas, clique em Salvar e executar uma simulação.

  11. Selecione os repositórios em que deseja realizar a simulação.

    • Para realizar a simulação em toda a organização, selecione Todos os repositórios da organização.
    • Para especificar os repositórios nos quais você deseja realizar a simulação, selecione Repositórios selecionados, pesquise e selecione até dez repositórios.
  12. Quando tudo estiver pronto para testar seu novo padrão personalizado, clique em Executar.

  13. Quando o teste terminar, você verá uma amostra de resultados (até 1.000). Revise os resultados e identifique quaisquer resultados falso-positivos. Captura de tela mostrando os resultados da simulação.

  14. Edite o novo padrão personalizado para corrigir problemas com os resultados e testar suas alterações e clique em Salvar e executar uma simulação.

  15. Quando estiver satisfeito com o novo padrão personalizado, clique em Publicar padrão.

Você pode configurar o secret scanning para verificar pushes em busca de padrões personalizados antes que os commits sejam mesclados no branch padrão. Para obter mais informações, consulte "Habilitar a proteção por push para um padrão personalizado".