Сканер секретов без зависимостей для исходного кода и истории git, который обнаруживает утёкшие API-ключи, токены и приватные ключи, с редактированным выводом и готовой к использованию задачей GitLab CI.
Небольшой сканер секретов без зависимостей для исходного кода и истории git, с готовым заданием GitLab CI.
Он находит утёкшие API-ключи, токены, приватные ключи и пароли до того, как они попадут в продакшен, включая секреты, которые были закоммичены один раз и «удалены» позже, но всё ещё остаются в истории.
$ 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.
В той демонстрации ключ AWS был удалён из settings.py в более позднем коммите. Обычное сканирование файлов показывает, что репозиторий чист, но ключ всё ещё можно восстановить с помощью git log -p, поэтому он по-прежнему утёк.
password = "...".changeme, ${API_KEY}, {{ vault_token }} и <your-password>.--rev-range base..HEAD сканирует только новые коммиты..secretscanignore (шаблоны в стиле gitignore) и встроенная директива # secretscan:ignore.--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
| Код выхода | Значение |
|---|---|
| 0 | Нет находок на уровне --fail-on или выше |
| 1 | Находки на уровне --fail-on или выше |
| 2 | Ошибка использования (неверный путь, не git-репозиторий, ...) |
Добавьте встроенный маркер:
EXAMPLE_KEY = "..." # secretscan:ignore
Или создайте .secretscanignore в корне репозитория:
# test fixtures
tests/fixtures/
*.lock
Добавьте переиспользуемую задачу в любой проект:
include:
- remote: "https://gitlab.com/DaveyD347/secrets-scanner/-/raw/main/templates/secretscan.gitlab-ci.yml"
Задание клонирует полную историю (GIT_DEPTH: 0), сканирует только новые коммиты в конвейерах merge request, а в остальных случаях — всю историю, завершает конвейер с ошибкой при обнаружении находок и загружает gl-secret-detection-report.json как отчёт secret_detection. В GitLab Ultimate эти находки отображаются в виджете безопасности merge request и в отчёте об уязвимостях; на других тарифах отчёт всё равно сохраняется как артефакт для скачивания. Задайте SECRETSCAN_FAIL_ON, чтобы настроить порог.
Собственный .gitlab-ci.yml этого репозитория выполняет линтинг, тестирование на Python 3.10–3.13 с покрытием и запускает сканер по собственной истории.
src/secretscan/rules.py) — это регулярные выражения. Первая группа захвата — это секрет.
У общих правил также задана минимальная энтропия, чтобы password = "aaaaaaaaaaaa" не срабатывало..git, node_modules, virtualenv, бинарные файлы (проверка на NUL-байт),
файлы размером более 2 МБ и всё, что указано в .secretscanignore.git log --all --reverse -p --unified=0 и разбирает поток diff, отслеживая
текущий коммит, файл и номер строки на новой стороне из каждого заголовка ханка @@. Проверяются только строки +, поэтому
секрет сообщается один раз — в коммите, который его внёс, а не один раз для каждого последующего коммита.pip install -e ".[dev]"
pytest
ruff check . && ruff format --check .
Тестовые фикстуры никогда не содержат реальных учётных данных. Поддельные токены в tests/fakes.py собираются из частей во время выполнения, чтобы сам репозиторий не содержал полных строк, похожих на токены. Это сохраняет чистоту самопроверки CI и позволяет избежать срабатывания защиты от push в GitLab.
MIT
Откройте для себя самые используемые инструменты нашего сообщества.
Данных о популярности пока нет.