Esta versão do GitHub Enterprise será descontinuada em 2022-02-16. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, melhorar a segurança e novos recursos, upgrade to the latest version of GitHub Enterprise. Para ajuda com a atualização, contact GitHub Enterprise support.

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 está disponível se você tiver uma licença para Segurança Avançada GitHub. Para obter mais informações, consulte "Sobre Segurança Avançada GitHub".

Observação: Varredura secreta para repositórios pertencentes à organização, está atualmente na versão beta e sujeita a alterações.

If you're using an earlier version of GitHub Enterprise Server, you'll have to upgrade to use varredura secreta. For more information about upgrading your GitHub Enterprise Server instance, see "About upgrades to new releases" and refer to the Upgrade assistant to find the upgrade path from your current release version.

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

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 ser associados com GitHub para fornecer seus formatos de segredo para varredura.

Se alguém verificar um segredo com um padrão conhecido em um repositório em GitHub Enterprise Server, varredura secreta captura o segredo como é verificado e ajuda a mitigar o impacto da fuga. 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 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 seus repositórios ou para todos os novos repositórios dentro da sua organização. Para obter mais informações, consulte "Gerenciar segurança e configurações de análise para o seu repositório" e "Gerenciar configurações de segurança e análise para a 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. Para obter mais informações, 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".

Lista de segredos compatíveis

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

ProviderSegredo compatívelSlug da API
Adafruit IOChave de IO de Adafruitadafruit_io_key
AzureAzure SQL Connection Stringazure_sql_connection_string Azure

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.