Scanner de segredos sem dependências para código-fonte e histórico do git que detecta chaves de API, tokens e chaves privadas vazados, com saída redigida e um job de CI do GitLab pronto para uso.
Um pequeno scanner de segredos sem dependências para código-fonte e histórico do git, com um job de CI do GitLab pronto a usar.
Ele encontra chaves de API, tokens, chaves privadas e senhas vazadas antes de chegarem à produção, incluindo segredos que foram commitados uma vez e "removidos" depois, mas que continuam presentes no histórico.
$ secretscan scan . --history
[HIGH ] url-credentials deploy.sh:1 (commit 79831acaf3, Dev <[email protected]>)
Credentials embedded in a URL: Fake********
[HIGH ] aws-access-key-id settings.py:1 (commit 79831acaf3, Dev <[email protected]>)
AWS access key ID: AKIA************
2 potential secret(s) found.
Nessa demonstração, a chave da AWS foi excluída de settings.py em um commit posterior. Uma varredura simples de arquivos diz que o repositório está
limpo, mas a chave ainda pode ser recuperada com git log -p, portanto ainda está vazada.
password = "...".changeme, ${API_KEY}, {{ vault_token }} e <your-password>.--rev-range base..HEAD varre apenas os novos commits..secretscanignore (globs no estilo gitignore) e # secretscan:ignore inline.--fail-on.pip install git+https://gitlab.com/DaveyD347/secrets-scanner.git
# or, from a clone
pip install -e ".[dev]"
secretscan scan # scan the current directory's files
secretscan scan path/to/repo --history # files + entire git history
secretscan scan . --history-only # history only
secretscan scan . --rev-range origin/main..HEAD # only commits not yet on main
secretscan scan . --format json -o findings.json
secretscan scan . --fail-on high # only fail on high/critical
secretscan rules # list rules
| Código de saída | Significado |
|---|---|
| 0 | Nenhum achado igual ou superior a --fail-on |
| 1 | Achados iguais ou superiores a --fail-on |
| 2 | Erro de uso (caminho inválido, não é um repositório git, ...) |
Adicione um marcador inline:
EXAMPLE_KEY = "..." # secretscan:ignore
Ou crie .secretscanignore na raiz do repositório:
# test fixtures
tests/fixtures/
*.lock
Adicione o job reutilizável a qualquer projeto:
include:
- remote: "https://gitlab.com/DaveyD347/secrets-scanner/-/raw/main/templates/secretscan.gitlab-ci.yml"
A tarefa clona o histórico completo (GIT_DEPTH: 0), verifica apenas os novos commits em pipelines de merge request e o
histórico completo nos demais casos, falha o pipeline ao encontrar achados e envia gl-secret-detection-report.json como um
relatório secret_detection. No GitLab Ultimate, esses achados aparecem no widget de segurança do merge request e
no relatório de vulnerabilidades; em outros níveis, o relatório ainda é mantido como artefato para download. Defina
SECRETSCAN_FAIL_ON para ajustar o limite.
O próprio .gitlab-ci.yml deste repositório faz lint, testa em Python 3.10 a 3.13 com cobertura,
e executa o scanner contra seu próprio histórico.
src/secretscan/rules.py) são expressões regulares. O primeiro grupo de captura é o segredo.
Regras genéricas também definem uma entropia mínima para que password = "aaaaaaaaaaaa" não dispare..git, node_modules, virtualenvs, binários (detecção de byte NUL),
arquivos com mais de 2 MB e qualquer coisa em .secretscanignore.git log --all --reverse -p --unified=0 e analisa o fluxo de diff, rastreando o
commit atual, o arquivo e o número da linha do lado novo a partir de cada cabeçalho de hunk @@. Apenas linhas + são verificadas, então
um segredo é reportado uma vez, no commit que o introduziu, em vez de uma vez para cada commit posterior.pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
Os fixtures de teste nunca contêm credenciais reais. Os tokens falsos em tests/fakes.py são montados a partir de partes em tempo de execução, de modo que o próprio repositório não contém nenhuma string completa com formato de token. Isso mantém a auto-verificação da CI limpa e evita acionar a proteção de push do GitLab.
MIT
Descubra as ferramentas mais usadas pela nossa comunidade.
Sem dados de popularidade ainda.