Configurar a varredura de segredo para os seus repositórios

Habilitar varredura secreta para repositórios privados

Once enabled, varredura secreta scans for any secrets in your entire Git history on all branches present in your GitHub repository.

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

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

3. Na barra lateral esquerda, clique em Security & analysis (Segurança e análise).

4. Se Segurança Avançada ainda não estiver habilitado para o repositório, à direita de "Segurança Avançada GitHub", clique em Habilitar.

5. Revise o impacto de habilitar Segurança Avançada, e clique em Permitir Segurança Avançada GitHub para este repositório.

6. Quando você habilitar Segurança Avançada, varredura secreta pode ser habilitado automaticamente para o repositório, devido às configurações da organização. Se "Varredura secreta" é exibido com um botão habilitar. Você ainda precisa habilitar varredura secreta clicando em Habilitar. Se você vir um botão Desabilitar, significa que varredura secreta já está habilitado.

Excluir alertas de varredura secreta em repositórios privados

Você pode usar um arquivo secret_scanning.yml para excluir diretórios do varredura secreta. Por exemplo, você pode excluir diretórios que contenham testes ou conteúdo gerado aleatoriamente.

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

2. Acima da lista de arquivos, utilizando o menu suspenso Add file (Adicionar arquivo), clique em Create new file (Criar novo arquivo).

3. No campo do nome de arquivo, digite .github/secret_scanning.yml. .

4. Em Editar o novo arquivo, digite paths-ignore: seguido pelos paths que você deseja excluir do varredura secreta.

   paths-ignore:
     - "foo/bar/*.js"
   

   Você pode usar caracteres especiais, como * para filtrar paths. Para obter mais informações sobre padrões de filtro, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

   Notas:

   • Se houver mais de 1.000 entradas em paths-ignore, varredura secreta excluirá apenas os primeiros 1.000 diretórios das verificações.
   • Se secret_scanning.yml for maior que 1 MB, varredura secreta ignorará todo o arquivo.

Você também pode ignorar alertas individuais de varredura secreta. Para obter mais informações, consulte "Gerenciando alertas do varredura secreta."

Leia mais

• "Gerenciando configurações de segurança e análise para sua organização"
• "Defining custom patterns for varredura secreta"