Definindo padrões personalizados para varredura de segredo

Sobre padrões personalizados para varredura secreta

Você pode definir padrões personalizados para identificar segredos que não são detectados pelos padrões padrão compatíbeis com varredura secreta. 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ço compatíveis, consulte " Padrões de Varredura secreta".

É possível definir padrões personalizados para sua empresa, organização ou repositório. Varredura secreta é vompatível com até 500 padrões personalizados para cada conta da organização ou empresa e até 100 padrões personalizados por repositório.

Sintaxe de expressão regular para padrões personalizados

Você pode especificar padrões personalizados para >- secret scanning for advanced security como uma ou mais expressões regulares.

• Formato secreto: 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, isto é definido como \A|[^0-9A-Za-z], o que significa que o segredo deve 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 deve ser seguido por uma nova linha ou um caractere não alfanumérico.
• Requisitos adicionais de correspondência: uma ou mais expressões opcionais que o segredo propriamente dito deve 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. Par aobter um exemplo de um padrão personalizado, consulte "Exemplo de um padrão personalizado especificado com requisitos adicionais" abaixo.

Varredura secreta usa a biblioteca Hyperscan e é compatível apenas os construtores 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 construções de padrões do Hyperscan, consulte "suporte do padrãona documentação do Hyperscan.

Definindo um padrão personalizado para um repositório

Antes de definir um padrão personalizado, você deve garantir que varredura secreta está habilitado no seu repositório. Para obter mais informações, consulte "Configurar varredura secreta para os seus repositórios".

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

2. No nome do seu repositório, clique em Configurações.

3. In the "Security" section of the sidebar, click Code security and analysis.

4. Under "Code security and analysis", find "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.

   

7. Quando estiver pronto para testar seu novo padrão personalizado, para identificar correspondências no repositório sem criar alertas, clique em Salvar testar.

8. When the dry run finishes, you'll see a sample of results (up to 1000). Revise os resultados e identifique quaisquer resultados falso-positivos.

9. Edit the new custom pattern to fix any problems with the results, then, to test your changes, click Save and dry run.

   Note: The dry run feature is currently in beta and subject to change.

10. When you're satisfied with your new custom pattern, click Publish pattern.

Após a criação do seu padrão, varredura secreta verifica todos segredos em todo o histórico do Git em todos os branches presentes no repositório GitHub. Para mais informações sobre visualização de alertas varredura secreta, consulte "Gerenciando alertas de varredura secreta".

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	Expressão regular e campo
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 deve corresponder a [A-Z] e [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 dos $%@!	Requisitos adicionais: o segredo deve 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 varredura secreta para os repositórios que você deseja fazer a digitalização na organização. Para habilitar varredura secreta em todos os repositórios da sua organização, consulte "gerenciar configurações de segurança e análise da sua organização".

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

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

3. In the "Security" section of the sidebar, click Code security and analysis.

4. Under "Code security and analysis", find "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.

   

7. Quando você estiver pronto para testar seu novo padrão personalizado, para identificar correspondências em repositórios selecionados sem criar alertas, clique em Salvar e testar.

8. Search for and select up to 10 repositories where you want to perform the dry run.

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

10. When the dry run finishes, you'll see a sample of results (up to 1000). Revise os resultados e identifique quaisquer resultados falso-positivos.

11. Edit the new custom pattern to fix any problems with the results, then, to test your changes, click Save and dry run.

    Note: The dry run feature is currently in beta and subject to change.

12. When you're satisfied with your new custom pattern, click Publish pattern.

Depois que o padrão for criado, varredura secreta 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 varredura secreta, consulte "Gerenciar alertas de varredura secreta".

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, consulte "Habilitar Segurança Avançada GitHub para a sua empresa."

1. No canto superior direito de GitHub.com, clique na sua foto de perfil e, em seguida, clique em Suas empresas.

2. Na lista de empresas, clique na empresa que você deseja visualizar.

3. Na barra lateral da conta corporativa, clique em Policies.

4. Em Políticas, clique em "Segurança Avançada".

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

6. Em "Padrões de personalização de digitalização de segredos", clique em Novo padrão.

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

   

8. Quando estiver pronto para testar seu novo padrão personalizado, para identificar correspondências no repositório sem criar alertas, clique em Salvar testar.

9. Search for and select up to 10 repositories where you want to perform the dry run.

10. Quando estiver pronto para testar seu novo padrão personalizado, clique em Testar.

11. When the dry run finishes, you'll see a sample of results (up to 1000). Revise os resultados e identifique quaisquer resultados falso-positivos.

12. Edit the new custom pattern to fix any problems with the results, then, to test your changes, click Save and dry run.

    Note: The dry run feature is currently in beta and subject to change.

13. When you're satisfied with your new custom pattern, click Publish pattern.

Depois que o seu padrão for criado, varredura secreta irá digitalizar qualquer segredo em repositórios nas organizações da sua empresa com Segurança Avançada GitHub 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 varredura secreta, consulte "Gerenciar alertas de varredura secreta".

Editando um padrão personalizado

Ao salvar uma alteração em um padrão personalizado, isso irá fechar todos os alertas de varredura secreta que foram criados usando a versão anterior do padrão.

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, exiba as configurações "Segurança & análise" do repositório ou organização onde o padrão personalizado foi criado. Para mais informações consulte "Definir um padrão personalizado para um repositório" ou "Definir um padrão personalizado para uma organização" acima.
   • Para uma empresa, em "Políticas" exiba a área "Segurança Avançada" e, em seguida, clique em Funcionalidades de segurança. Para obter mais informações, consulte "Definindo um padrão personalizado para uma conta corporativa" acima.
2. Em "Varredura secreta", à direita do padrão personalizado que você deseja editar, clique em .
3. Ao revisar e testar suas alterações, clique em Salvar alterações.

Removendo um padrão personalizado

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, exiba as configurações "Segurança & análise" do repositório ou organização onde o padrão personalizado foi criado. Para mais informações consulte "Definir um padrão personalizado para um repositório" ou "Definir um padrão personalizado para uma organização" acima.
   • Para uma empresa, em "Políticas" exiba a área "Segurança Avançada" e, em seguida, clique em Funcionalidades de segurança. Para obter mais informações, consulte "Definindo um padrão personalizado para uma conta corporativa" acima.