Configurar a verificação de segredo para seus repositórios

Como habilitar os alertas de verificação de segredo para usuários

Você pode habilitar alertas de verificação de segredo para usuários em qualquer repositório seu repositório público gratuito. Uma vez habilitado, o secret scanning verifica todos segredos em todo o histórico do Git em todos os branches presentes no repositório GitHub. Além disso, o secret scanning verifica o seguinte:

• Descrições e comentários em issues
• Títulos, descrições e comentários em issues históricos abertos e fechados
• Títulos, descrições e comentários em pull requests
• Títulos, descrições e comentários em GitHub Discussions
• Wikis

Essa varredura adicional é gratuita para repositórios públicos.

Você também pode habilitar secret scanning para vários repositórios em uma organização ao mesmo tempo. Para obter mais informações, confira "Guia de início rápido da proteção da sua organização".

O administrador de um repositório pode optar por desabilitar o secret scanning em um repositório a qualquer momento. Para obter mais informações, confira "Gerenciando as configurações de segurança e análise do repositório".

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.

   

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

4. Role a página para baixo até a parte inferior e clique em Habilitar na secret scanning. Se um botão Desabilitar for exibido, isso indicará que a secret scanning já está habilitada no repositório.

   

Como habilitar recursos adicionais do alertas de verificação de segredo para usuários

Você pode habilitar os seguintes recursos adicionais de secret scanning por meio das configurações "Segurança e análise de código" do repositório:

• Proteção por push. Para obter mais informações, confira "Proteção por push para repositórios e organizações".

Habilitar alertas de verificação de segredo para usuários para todos os repositórios públicos

Você pode habilitar secret scanning para todos os repositórios públicos nas configurações de conta pessoal.

1. No canto superior direito de qualquer página, clique na foto do seu perfil e em Configurações.

   

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

3. Em "Segurança e análise de código", à direita de "Secret scanning", clique em Desabilitar tudo ou Habilitar tudo.

4. Opcionalmente, caso deseje habilitar a proteção por push, clique em Habilitar à direita de "Proteção por push". Quando você habilita a proteção por push na organização ou no repositório, a secret scanning também verifica pushes para segredos com suporte. A Secret scanning lista todos os segredos detectados para que o autor possa revisar os segredos e removê-los ou, se necessário, permitir que esses segredos sejam enviados por push. Para obter mais informações, confira "Proteção por push para repositórios e organizações".

   

Como excluir diretórios dos alertas de verificação de segredo para usuários

Você pode configurar um arquivo secret_scanning.yml para excluir diretórios de secret scanning, inclusive quando você usa proteção por push. Por exemplo, você pode excluir diretórios que contenham testes ou conteúdo gerado aleatoriamente.

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

2. Acima da lista de arquivos, selecione o menu suspenso Adicionar arquivo e clique em Criar arquivo.

   Como alternativa, é possível clicar em na exibição em árvore de arquivos à esquerda.

   

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

4. Em Editar novo arquivo, digite paths-ignore: seguido dos caminhos que deseja excluir da secret scanning.

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

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

   Observações:

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

Você também pode ignorar alertas individuais de secret scanning. Para obter mais informações, confira "Gerenciar alertas da verificação de segredo".