Sobre a varredura de segredo

O GitHub AE verifica repositórios em busca de tipos de segredos conhecidos a fim de impedir o uso fraudulento de segredos que sofreram commit acidentalmente.

Varredura secreta is available as part of Segurança Avançada GitHub, which is free during the beta release. Para obter mais informações, consulte "Sobre Segurança Avançada GitHub".

Note: Varredura secreta for organization-owned repositories is currently in beta and subject to change.

Se o seu projeto se comunicar com um serviço externo, você pode usar um token ou uma chave privada para autenticação. Tokens e chaves privadas são exemplos de segredos que um provedor de serviços pode publicar. Se você marcar um segredo em um repositório, qualquer pessoa que tenha acesso de leitura ao repositório pode usar o segredo para acessar o serviço externo com seus privilégios. Recomendamos que você armazene segredos em um local dedicado e seguro fora do repositório do seu projeto.

Varredura secreta irá fazer a varredura de todo o seu histórico do Git em todos os branches presentes no seu repositório GitHub para obter quaisquer segredos. Service providers can partner with GitHub to provide their secret formats for scanning.

If someone checks a secret with a known pattern into a repository on GitHub AE, varredura secreta catches the secret as it's checked in, and helps you mitigate the impact of the leak. Os administradores do repositório são notificados sobre qualquer submissão que contém um segredo e podem visualizar rapidamente todos os segredos detectados na aba Segurança do repositório.

Sobre varredura secreta em GitHub AE

Varredura secreta está disponível em todos os repositórios de propriedade da organização como parte de Segurança Avançada GitHub. Não está disponível em repositórios pertencentes a usuários.

Se você é um administrador de repositório ou um proprietário de uma organização, você pode habilitar varredura secreta para pertencentes a organizações. Você pode habilitar varredura secreta para todos os seus repositórios ou para todos os novos repositórios da organização. Para mais informações, consulte "Gerenciar configurações de segurança e análise do seu repositório" e "Gerenciar as configurações de segurança e análise da sua organização".

Quando você faz push dos commits para um repositório com varredura secreta habilitado, GitHub verifica o conteúdo dos segredos dos commits.

Quando varredura secreta detecta um segredo em um repositório, GitHub gera um alerta.

  • O GitHub envia um alerta de email para os administradores do repositório e proprietários da organização.

  • GitHub exibe um alerta no repositório.

Os administradores do repositório e proprietários da organização podem conceder acesso aos usuários aos alertas de varredura secreta. Para obter mais informações, consulte "Gerenciar configurações de segurança e análise do repositório".

GitHub atualmente faz a varredura de repositórios para segredos emitidos pelos seguintes provedores de serviços.

ParceiroSegredo compatívelSlug da API

Nota: o Varredura secreta atualmente não permite que você defina seus próprios padrões para detecção de segredos.

Leia mais

Esse documento ajudou você?Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.