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

Como habilitar os verificação de segredo

Você pode habilitar verificação de segredo em qualquer repositório repositório pertencente a uma organização. 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

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 sua instância do GitHub Enterprise Server, 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. Se o Advanced Security ainda não estiver habilitado no repositório, à direita de "GitHub Advanced Security", clique em Habilitar.

5. Revise o impacto da habilitação do Advanced Security e clique em Habilitar o GitHub Advanced Security neste repositório.

6. Quando você habilitar Advanced Security, secret scanning pode ser habilitado automaticamente para o repositório, devido às configurações da organização. Se "Secret scanning" for mostrado com um botão Habilitar, você ainda precisará habilitar a secret scanning clicando em Habilitar. Se um botão Desabilitar for exibido, a secret scanning já estará habilitada.

   

Como habilitar recursos adicionais do verificação de segredo

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".
• Verificação de padrões que não são de provedor. Para obter mais informações, confira "Habilitar a verificação de padrões que não são de provedor".
• Verificação de padrões personalizados. Para obter mais informações, confira "Definir padrões personalizados para a verificação de segredo".

Habilitar a verificação de padrões que não são de provedor

Você pode habilitar a verificação de padrões que não sejam do provedor. Os padrões que não são de provedores correspondem a segredos, como chaves privadas, e apresentam maior proporção de falsos positivos.

1. No sua instância do GitHub Enterprise Server, 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. Em Secret scanning, marque a caixa de seleção ao lado de "Verificar padrões que não são de provedor".

Para obter mais informações sobre padrões que não são de provedor, confira "Padrões de digitalização de segredo".

Como excluir diretórios dos verificação de segredo

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 sua instância do GitHub Enterprise Server, navegue até a página principal do repositório.

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

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

Leitura adicional

• "Gerenciando as configurações de segurança e de análise da sua organização"
• "Definir padrões personalizados para a verificação de segredo"