Definir padrões personalizados para a verificação de segredo

Sobre padrões personalizados para secret scanning

Você pode definir padrões personalizados para identificar segredos que não são detectados pelos padrões padrão compatíbeis com secret scanning. Por exemplo, você pode ter um padrão de segredo que é interno da sua organização. Para obter detalhes dos segredos e provedores de serviços com suporte, confira Padrões de varredura de segredos com suporte.

É possível definir padrões personalizados para sua empresa, organização ou repositório. Os Secret scanning dão suporte para até 500 padrões personalizados para cada organização ou conta corporativa e até 100 padrões personalizados por repositório.

Também é possível habilitar a proteção de push para padrões personalizados. Para obter mais informações sobre a proteção por push, confira Sobre a proteção por push.

Sobre o uso de expressões regulares para padrões personalizados

É possível especificar padrões personalizados para o secret scanning como uma ou mais expressões regulares.

Os Secret scanning usam a biblioteca Hyperscan e só dão suporte a constructos regex do Hyperscan, que são um subconjunto da sintaxe PCRE. Os modificadores de opções de huperscan não são compatíveis. Para obter mais informações sobre os constructos de padrão do Hyperscan, confira Suporte a padrões na documentação do Hyperscan.

A seção More options na interface do usuário ajuda você a escrever expressões regulares manualmente.

• Formato do segredo: uma expressão que descreve o formato do próprio segredo.
• Antes do segredo: uma expressão que descreve os caracteres que vêm antes do segredo. Por padrão, isso é definido como \A|[^0-9A-Za-z], o que significa que o segredo precisa estar no início de uma linha ou ser precedido por um caractere não alfanumérico.
• Após o segredo: uma expressão que descreve os caracteres que vêm após o segredo. Por padrão, isso é definido como \z|[^0-9A-Za-z], o que significa que o segredo precisa ser seguido por uma nova linha ou por um caractere não alfanumérico.
• Requisitos adicionais de correspondência: uma ou mais expressões opcionais às quais o próprio segredo precisa ou não corresponder.

Para tokens simples você normalmente só precisa especificar um formato de segredo. Os outros campos proporcionam flexibilidade para que você possa especificar segredos mais complexos sem criar expressões regulares complexas. Para ver um exemplo de padrão personalizado, confira Exemplo de um padrão personalizado especificado com requisitos adicionais abaixo.

Definindo um padrão personalizado para um repositório

Antes de definir um padrão personalizado, você deve garantir que secret scanning está habilitado no seu repositório. Para saber mais, confira Habilitando a varredura de segredos para seu repositório.

1. Em GitHub, acesse 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.

   

3. Na seção "Security" da barra lateral, clique em Code security and analysis.

4. Em "Code security and analysis", encontre "GitHub Advanced Security."

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

6. Insira as informações para o novo padrão personalizado. 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.

   1. No campo "Nome do padrão", digite um nome para o padrão.
   2. No campo "Formato de segredo", digite uma expressão regular para o formato do seu padrão de segredo.
   3. Clique em More options para fornecer outro conteúdo complementar ou requisitos de correspondência adicionais para o formato secreto.
   4. Forneça um exemplo de cadeia de caracteres de teste para verificar se a sua configuração está correspondendo aos padrões esperados.
   

7. 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.

8. Quando o teste terminar, você verá uma amostra de resultados (até 1.000). Revise os resultados e identifique quaisquer resultados falso-positivos.

   

9. 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.

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

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

    Note

    O botão "Enable" não estará disponível até que a simulação seja bem-sucedida e você publique o padrão.

    Para obter mais informações sobre a proteção por push, confira Sobre a proteção por push.

Depois que o padrão for criado, secret scanning verifica todos segredos em todo o histórico do Git em todos os branches presentes no repositório GitHub. Para saber mais sobre como exibir alertas de verificação de segredo, confira Gerenciar alertas da verificação de segredo.

Exemplo de um padrão personalizado especificado usando requisitos adicionais

Uma empresa tem um token interno com cinco características. Eles usam os diferentes campos para especificar como identificar tokens da seguinte forma:

Característica	Campo e expressão regular
Comprimento entre 5 e 10 caracteres	Formato do segredo: [$#%@AA-Za-z0-9]{5,10}
Não termina com um .	Após o segredo: [^\.]
Contém números e letras maiúsculas	Requisitos adicionais: o segredo precisa corresponder a [A-Z] e a [0-9]
Não inclui mais de uma letra minúscula consecutiva	Requisitos adicionais: o segredo não deve corresponder a [a-z]{2,}
Contém um destes caracteres: $%@!	Requisitos adicionais: o segredo precisa corresponder a [$%@!]

Esses tokens iriam corresponder ao padrão personalizado descrito acima:

a9@AAfT!         # Secret string match: a9@AAfT
ee95GG@ZA942@aa  # Secret string match: @ZA942@a
a9@AA!ee9        # Secret string match: a9@AA

Estas strings não correspondem ao padrão personalizado descrito acima:

a9@AA.!
a@AAAAA
aa9@AA!ee9
aAAAe9

Definindo um padrão personalizado para uma organização

Antes de definir um padrão personalizado, você deverá habilitar secret scanning para os repositórios que você deseja fazer a digitalização na organização. Para habilitar o secret scanning em todos os repositórios da sua organização, confira Gerenciando as configurações de segurança e de análise da sua organização.

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

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 "Code security and analysis", encontre "GitHub Advanced Security."

5. Em "Verificação de segredo", em "Padrões personalizados", clique em Novo padrão..

6. Insira as informações para o novo padrão personalizado. 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.

   1. No campo "Nome do padrão", digite um nome para o padrão.
   2. No campo "Formato de segredo", digite uma expressão regular para o formato do seu padrão de segredo.
   3. Clique em More options para fornecer outro conteúdo complementar ou requisitos de correspondência adicionais para o formato secreto.
   4. Forneça um exemplo de cadeia de caracteres de teste para verificar se a sua configuração está correspondendo aos padrões esperados.
   

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

8. 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.

9. Quando tudo estiver pronto para testar seu novo padrão personalizado, clique em Executar.

10. Quando o teste terminar, você verá uma amostra de resultados (até 1.000). Revise os resultados e identifique quaisquer resultados falso-positivos.

    

11. 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.

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

13. Opcionalmente, a fim de habilitar a proteção de push para o padrão personalizado, clique em Habilitar. Para saber mais, confira Sobre a proteção por push.

    Note

    • 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 obter mais informações, 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.

Depois que o padrão for criado, secret scanning irá verificar todos os segredos nos repositórios na sua organização, incluindo todo seu histórico do Git em todos os branches. Os proprietários da organização e administradores do repositório receberão um alerta sobre todos os segredos encontrados e poderão revisar o alerta no repositório onde o segredo for encontrado. Para obter mais informações sobre a visualização de alertas de verificação de segredo, confira Gerenciar alertas da verificação de segredo.

Definir um padrão personalizado para uma conta corporativa

Antes de definir um padrão personalizado, você deverá garantir que você habilite a digitalização de segredo para a sua conta corporativa. Para obter mais informações, confira "Como habilitar o GitHub Advanced Security para sua empresa".

1. No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.

   

2. Do lado esquerdo da página, na barra lateral da conta empresarial, clique em Políticas. 1. Em "Policies", clique em Code security and analysis.

3. Em "Code security and analysis", clique em Security features.

4. Em "Padrões personalizados de verificação de segredo", clique em Novo padrão.

5. Insira as informações para o novo padrão personalizado. 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.

   1. No campo "Nome do padrão", digite um nome para o padrão.
   2. No campo "Formato de segredo", digite uma expressão regular para o formato do seu padrão de segredo.
   3. Clique em More options para fornecer outro conteúdo complementar ou requisitos de correspondência adicionais para o formato secreto.
   4. Forneça um exemplo de cadeia de caracteres de teste para verificar se a sua configuração está correspondendo aos padrões esperados.
   

6. Quando estiver pronto para testar o novo padrão personalizado, clique em Salvar e executar uma simulação para identificar correspondências na empresa sem criar alertas.

7. Pesquise e selecione até 10 repositórios em que você deseja executar a simulação.

8. Quando tudo estiver pronto para testar seu novo padrão personalizado, clique em Executar.

9. Quando o teste terminar, você verá uma amostra de resultados (até 1.000). Revise os resultados e identifique quaisquer resultados falso-positivos.

   

10. 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.

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

12. Opcionalmente, a fim de habilitar a proteção de push para o padrão personalizado, clique em Habilitar. Para saber mais, confira Sobre a proteção por push.

    Note

    • Para habilitar a proteção de push para padrões personalizados, é preciso habilitar o secret scanning como a proteção de push no nível corporativo. Para obter mais informações, 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.

Depois que o seu padrão for criado, secret scanning irá digitalizar qualquer segredo em repositórios nas organizações da sua empresa com GitHub Advanced Security habilitado, incluindo todo seu histórico do Git em todos os branches. Os proprietários da organização e administradores do repositório receberão um alerta sobre todos os segredos encontrados e poderão revisar o alerta no repositório onde o segredo for encontrado. Para obter mais informações sobre a visualização de alertas de verificação de segredo, confira Gerenciar alertas da verificação de segredo.

Leitura adicional

• Gerenciando padrões personalizados
• Métricas para padrões personalizados