Pular para o conteúdo
Linux para todos os rolês
  1. Rolês e receitas
  2. Receitas
  3. Verificação de segredos

Verificação de segredos

O gitleaks confere cada commit e barra os que levam uma chave de API ou uma senha, e o Git passa a ignorar os arquivos .env e as chaves em todos os projetos.

seguranca/segredos Risco baixo Pede a senha de administrador Testada em máquina virtual no Ubuntu e no Debian
Três arquivos indo para um commit. O .env nem entra, porque o Git ignora. O config.py com um token é barrado pelo gitleaks. O ola.py passa. git add . && git commit .env ignorado pelo Git config.py barrado: tem um token ola.py passa gitleaks protect --staged roda antes de cada commit, em todos os projetos
Ilustração. Duas barreiras: o Git nem oferece o .env, e o gitleaks confere o resto.

Em resumo

O que faz e o que não faz

O que faz

  • Confere cada commit com o gitleaks e barra o que leva uma chave de API, um token ou uma senha.
  • Faz o Git ignorar os arquivos .env e as chaves privadas em todos os projetos, inclusive os que você clonar depois.
  • Mantém os ganchos de cada projeto funcionando: o gancho do bora chama o do projeto depois do gitleaks.

O que não faz

  • Não apaga segredos que já foram para o histórico: para isso, troque a chave no site do provedor.
  • Não passa por cima de um core.hooksPath que você já tinha.
  • Não roda nos projetos que definem os próprios ganchos com o husky ou o core.hooksPath do projeto.
  • Não impede um git commit --no-verify, para quando o gitleaks errar.

Passo a passo

Como o bora aplica esta receita

As mesmas quatro etapas de toda receita, com o que esta confere em cada uma.

  1. Verificar já está aplicada?

    Confere se o git e o gitleaks estão instalados, se o arquivo de exclusões globais tem o bloco do bora e se o core.hooksPath aponta para os ganchos do bora.

  2. Aplicar faz a mudança

    • Para, sem mudar nada, se a conta já usar outro core.hooksPath.
    • Acrescenta o bloco do bora ao ~/.config/git/ignore (ou ao arquivo do core.excludesFile).
    • Cria ~/.config/git/ganchos-bora, com o gancho e um link para cada nome de gancho, e configura o core.hooksPath.
  3. Testar funcionou?

    Num repositório de teste, como a pessoa: um .env fica fora do Git, um commit com um token do GitHub inventado é barrado, um commit sem segredo passa e um gancho do próprio projeto continua rodando.

  4. Desfazer quando você pedir

    Tira o core.hooksPath e o bloco do bora, apaga os ganchos e remove os pacotes que a receita instalou. As suas outras linhas ficam.

No terminal

Uma aplicação de verdade

A saída de um teste no Ubuntu 24.04, encurtada nas linhas do apt.

Os porquês

Por que assim

Por que não basta apagar o arquivo depois?

A chave continua no histórico do Git, e num repositório público robôs acham em minutos. O único conserto é trocar a chave no site do provedor. Por isso o melhor é não deixar entrar.

Por que nos ganchos da conta, e não em cada projeto?

Assim vale para todo projeto, inclusive os que você clonar amanhã, sem lembrar de instalar nada. O gancho do bora chama o .git/hooks de cada projeto depois, para não quebrar o que já existia.

E se o gitleaks errar?

Ele às vezes acha que um texto de exemplo é uma chave. Melhor um alarme falso do que uma chave de verdade no GitHub. Confira o que ele apontou e, se for alarme falso, faça o commit com git commit --no-verify.

Como

O que muda no sistema

Parâmetros

O que dá para escolher

ParâmetroPadrãoO que é
usuarioautoA conta que vai programar. "auto" é quem rodou o bora com sudo.

No menu, o bora pergunta o que precisa. Num script ou num agente, passe os parâmetros na linha de comando:
bora plano --receitas seguranca/segredos -p seguranca/segredos.usuario=auto

Confira você mesmo

Os comandos para conferir

gitleaks detectConfere o projeto inteiro, com todo o histórico.
git check-ignore -v .envMostra qual regra faz o Git ignorar o arquivo.
git config --global core.hooksPathMostra a pasta dos ganchos da sua conta.

Onde funciona

Distros e testes

UbuntuTestada em VMUbuntu, Mint, Pop!_OS, Zorin
DebianTestada em VMDebian 13
FedoraPlanejadaFedora, Nobara
ArchPlanejadaArch, CachyOS, EndeavourOS, Manjaro
Fedora imutávelPlanejadaBazzite, Silverblue, Kinoite
openSUSEPlanejadaTumbleweed, Leap

Registro de testes

DistroOndeDataResultado
Debian 13Contêiner (teste automático)09/11/2026Passou
Ubuntu 24.04Contêiner (teste automático)09/11/2026Passou
Ubuntu 26.04Contêiner (teste automático)09/11/2026Passou
Debian 13Máquina virtual09/11/2026Passou
Ubuntu 24.04Máquina virtual09/11/2026Passou
Ubuntu 26.04Máquina virtual09/11/2026Passou

Testada em contêiner: passou nos testes automáticos dessa família, que rodam num contêiner a cada pull request, sem kernel, disco nem tela de login de verdade. Testada em VM: além disso, foi aplicada, conferida e desfeita numa máquina virtual (VM) de verdade, o que o CI faz toda semana. O registro acima mostra a última vez de cada distro. Enquanto uma receita só tem o teste em contêiner, o bora avisa quando monta o plano. Testar numa máquina sua é uma das ajudas mais valiosas.

Onde ela entra

Rolês que usam esta receita

Fontes

Para ler mais

Bora melhorar

Falta alguma coisa?

Os pedidos viram issues no GitHub, onde qualquer pessoa pode comentar, votar com um 👍 ou se oferecer para fazer.