Skip to main content

Sobre a varredura de segredo

O GitHub Enterprise Server 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 for organization-owned repositories in GitHub Enterprise Server if your enterprise has a license for Segurança Avançada GitHub. For more information, see "GitHub's products."

Observação: O administrador do site deve habilitar varredura secreta para your GitHub Enterprise Server instance antes de usar este recurso. Para obter mais informações, consulte "Configurar o varredura secreta para seu aplicativo ".

Sobre o varredura secreta

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. Os provedores de serviço podem fazer parceria com o GitHub para fornecer os respectivos formatos de segredo para verificação. Para obter detalhes dos segredos e provedores de serviço compatíveis, consulte " Parceiros de Varredura secreta".

To find out about our partner program, see "Varredura secreta partner program" in the GitHub Enterprise Cloud documentation

Sobre varredura secreta em GitHub Enterprise Server

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 repositórios da sua organização ou para todos os novos repositórios dentro da sua organização. Para obter mais informações, consulte "Gerenciando as configurações de segurança e análise para o seu repositório" e "Gerenciando as configurações de segurança e análise para a sua organização."

As versões 3.1 ou inferior a GitHub Enterprise Server não permitem que você defina seus próprios padrões para detecção de segredos.

Sobre alertas de varredura secreta

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 detectar um segredo em um privado, GitHub gera um alerta.

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

  • GitHub envia um alerta de e-mail para o contribuidor que fez o commit do segredo no repositório com um link para o alerta de varredura secreta relacionado. O autor do commit pode visualizar o alerta no repositório e resolver o alerta.

  • GitHub exibe um alerta no repositório.

Para obter mais informações sobre a visualização e resolução de alertas de varredura secreta, consulte "Gerenciar alertas de varredura secreta."

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

Você pode usar a API REST para monitorar resultados de varredura secreta nos repositórios privados. Para obter mais informações sobre pontos de extremidade da API, consulte "Varredura secreta".

Leia mais