Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Sobre a varredura de segredo

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

Neste artigo

Esse documento ajudou você?

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.

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.

Se alguém verificar um segredo de um parceiro GitHub em um repositório público ou privado, varredura secreta pode detectar o segredo e ajudar você a mitigar o impacto do vazamento.

Os provedores de serviço podem fazer parceria com o GitHub para fornecer os respectivos formatos de segredo para verificação. Para obter mais informações, consulte "Verificação de segredo".

Sobre o varredura secreta para repositórios públicos

Quando você faz push para um repositório público, o GitHub verifica segredos no conteúdo dos commits. Se você alternar um repositório privado para público, o GitHub verifica segredos em todo o repositório.

Quando o varredura secreta detecta um conjunto de credenciais, notificamos o provedor de serviço que emitiu o segredo. O provedor de serviço valida a credencial e decide se deve revogar o segredo, emitir um novo segredo ou entrar em contato com você diretamente, o que dependerá dos riscos associados a você ou ao provedor de serviço.

O GitHub atualmente verifica repositórios públicos para encontrar segredos emitidos pelos seguintes provedores de serviços.

  • Adafruit
  • Alibaba Cloud
  • Amazon Web Services (AWS)
  • Atlassian
  • Azure
  • Clojars
  • CloudBees CodeShip
  • Databricks
  • Datadog
  • Discord
  • Dropbox
  • Dynatrace
  • Finicity
  • Frame.io
  • GitHub
  • GoCardless
  • Google Cloud
  • Hashicorp Terraform
  • Hubspot
  • Mailchimp
  • Mailgun
  • MessageBird
  • npm
  • NuGet
  • Palantir
  • Plivo
  • Postman
  • Proctorio
  • Pulumi
  • Samsara
  • Shopify
  • Slack
  • SSLMate
  • Stripe
  • Tencent Cloud
  • Twilio

Sobre o varredura secreta para repositórios privados

Observação: Varredura secreta para repositórios privados está atualmente em beta e sujeitos a alterações. Para solicitar acesso ao beta, join the waitlist.

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

Quando o varredura secreta detecta um segredo em um repositório privado, o GitHub envia alertas.

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

  • O GitHub exibe um alerta no repositório. Para obter mais informações, consulte "Gerenciando alertas do varredura secreta."

O GitHub atualmente verifica repositórios públicos para encontrar segredos emitidos pelos seguintes provedores de serviços.

  • Adafruit
  • Alibaba Cloud
  • Amazon Web Services (AWS)
  • Atlassian
  • Azure
  • Clojars
  • CloudBees CodeShip
  • Databricks
  • Discord
  • Dropbox
  • Dynatrace
  • Finicity
  • Frame.io
  • GitHub
  • GoCardless
  • Google Cloud
  • Hashicorp Terraform
  • Hubspot
  • Mailchimp
  • Mailgun
  • npm
  • NuGet
  • Palantir
  • Postman
  • Proctorio
  • Pulumi
  • Samsara
  • Shopify
  • Slack
  • SSLMate
  • Stripe
  • Tencent Cloud
  • Twilio

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ê?

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.