Находите, проверяйте и анализируйте утекшие учетные данные
<p align="center">
<img alt="GoReleaser Logo" src="https://assets.kitploit.com/production/public/readmes/3815/31dbdb577b88b3a967e2c18f9b0f3d4a7031dafe7e392c51320178aba6352603.png" height="140" />
<h2 align="center">TruffleHog</h2>
<p align="center">Находит утёкшие учётные данные.</p>
</p>
---
<div align="center">
[](https://goreportcard.com/report/github.com/trufflesecurity/trufflehog/v3)
[](/LICENSE)
[](/pkg/detectors)
</div>
---
# :mag_right: _Сейчас сканирует_
<div align="center">
<img src="https://raw.githubusercontent.com/trufflesecurity/trufflehog/HEAD/assets/scanning_logos.svg">
**...и многое другое**
Чтобы узнать больше о TruffleHog, его возможностях и функциях, посетите нашу [страницу продукта](https://trufflesecurity.com/trufflehog?gclid=CjwKCAjwouexBhAuEiwAtW_Zx5IW87JNj97Ci7heFnA5ar6-DuNzT2Y5nIl9DuZ-FOUqx0Qg3vb9nxoClcEQAvD_BwE).
</div>
# :globe_with_meridians: TruffleHog Enterprise
Хотите непрерывно отслеживать **Git, Jira, Slack, Confluence, Microsoft Teams, Sharepoint (и не только)** на предмет учётных данных? У нас есть корпоративный продукт, который может помочь! Узнайте больше на <https://trufflesecurity.com/trufflehog-enterprise>.
Мы направляем выручку от корпоративного продукта на финансирование новых классных open source проектов, которые приносят пользу всему сообществу.
</div>
# Что такое TruffleHog 🐽
TruffleHog — самый мощный инструмент для **обнаружения, классификации, валидации** и **анализа** секретов. В этом контексте секрет — это учётные данные, которые машина использует для аутентификации на другой машине. Сюда входят API-ключи, пароли к базам данных, закрытые ключи шифрования и многое другое.
## Обнаружение 🔍
TruffleHog умеет искать секреты во множестве мест, включая Git, чаты, вики, логи, платформы тестирования API, объектные хранилища, файловые системы и не только.
## Классификация 📁
TruffleHog классифицирует более 800 типов секретов, сопоставляя их с конкретной идентичностью, которой они принадлежат. Это секрет AWS? Секрет Stripe? Секрет Cloudflare? Пароль Postgres? Закрытый ключ SSL? Иногда это трудно определить на глаз, поэтому TruffleHog классифицирует всё, что находит.
## Валидация ✅
Для каждого секрета, который TruffleHog может классифицировать, он также может выполнить вход, чтобы подтвердить, действует ли этот секрет. Этот шаг критически важен, чтобы понять, есть ли активная реальная угроза.
## Анализ 🔬
Для примерно 20 наиболее часто утекающих типов учётных данных вместо отправки одного запроса для проверки возможности входа TruffleHog может отправлять множество запросов, чтобы узнать всё, что можно, о секрете. Кто его создал? К каким ресурсам он даёт доступ? Какие у него права на эти ресурсы?
# :loudspeaker: Присоединяйтесь к нашему сообществу
Есть вопросы? Отзывы? Заходите в Slack или Discord и общайтесь с нами.
Присоединяйтесь к нашему [Slack-сообществу](https://join.slack.com/t/trufflehog-community/shared_invite/zt-pw2qbi43-Aa86hkiimstfdKH9UCpPzQ)
Присоединяйтесь к [Secret Scanning Discord](https://discord.gg/8Hzbrnkr7E)
# :tv: Демо

```bash
docker run --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --org=trufflesecurity
```
# :floppy_disk: Установка
Для вас доступно несколько вариантов:
### Пользователи MacOS
```bash
brew install trufflehog
```
### Docker:
<sub><i>_Убедитесь, что Docker engine запущен, прежде чем выполнять следующие команды:_</i></sub>
#### Unix
```bash
docker run --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys
```
#### Командная строка Windows
```bash
docker run --rm -it -v "%cd:/=\%:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys
```
#### Windows PowerShell
```bash
docker run --rm -it -v "${PWD}:/pwd" trufflesecurity/trufflehog github --repo https://github.com/trufflesecurity/test_keys
```
#### Mac на M1 и M2
```bash
docker run --platform linux/arm64 --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys
```
### Бинарные релизы
```bash
Download and unpack from https://github.com/trufflesecurity/trufflehog/releases
```
### Сборка из исходного кода
```bash
git clone https://github.com/trufflesecurity/trufflehog.git
cd trufflehog; go install
```
### Использование скрипта установки
```bash
curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin
```
### Использование скрипта установки, проверка подписи контрольной суммы (требуется установленный cosign)
```bash
curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -v -b /usr/local/bin
```
### Использование скрипта установки для установки конкретной версии
```bash
curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin <ReleaseTag like v3.56.0>
```
# :closed_lock_with_key: Проверка артефактов
Контрольные суммы применяются ко всем артефактам, а полученный файл контрольных сумм подписывается с помощью cosign.
Для проверки подписи вам потребуется следующий инструмент:
- [Cosign](https://docs.sigstore.dev/cosign/system_config/installation/)
Шаги проверки следующие:
1. Скачайте нужные вам файлы артефактов, а также следующие файлы со страницы [releases](https://github.com/trufflesecurity/trufflehog/releases).
- trufflehog\_{version}\_checksums.txt
- trufflehog\_{version}\_checksums.txt.pem
- trufflehog\_{version}\_checksums.txt.sig
2. Проверьте подпись:
```shell
cosign verify-blob <path to trufflehog_{version}_checksums.txt> \
--certificate <path to trufflehog_{version}_checksums.txt.pem> \
--signature <path to trufflehog_{version}_checksums.txt.sig> \
--certificate-identity-regexp 'https://github\.com/trufflesecurity/trufflehog/\.github/workflows/.+' \
--certificate-oidc-issuer "https://token.actions.githubusercontent.com"
```
3. После подтверждения действительности подписи можно перейти к проверке соответствия сумм SHA256 загруженному артефакту:
```shell
sha256sum --ignore-missing -c trufflehog_{version}_checksums.txt
```
Замените `{version}` на версию загруженных файлов
Кроме того, если вы используете скрипт установки, передайте опцию `-v` для выполнения проверки подписи.
Для этого требуется, чтобы бинарный файл Cosign был установлен до запуска скрипта установки.
# :rocket: Быстрый старт
## 1: Сканирование репозитория только на проверенные секреты
Команда:
```bash
trufflehog git https://github.com/trufflesecurity/test_keys --results=verified
```
Ожидаемый результат:
```
🐷🔑🐷 TruffleHog. Unearth your secrets. 🐷🔑🐷
Found verified result 🐷🔑
Detector Type: AWS
Decoder Type: PLAIN
Raw result: AKIAYVP4CIPPERUVIFXG
Line: 4
Commit: fbc14303ffbf8fb1c2c1914e8dda7d0121633aca
File: keys
Email: counter <[email protected]>
Repository: https://github.com/trufflesecurity/test_keys
Timestamp: 2022-06-16 10:17:40 -0700 PDT
...
```
## 2: Сканирование организации GitHub только на предмет подтверждённых секретов
```bash
trufflehog github --org=trufflesecurity --results=verified
```
## 3: Сканирование организации GitHub с исключением архивных репозиториев
```bash
trufflehog github --org=trufflesecurity --exclude-archived
```
## 4: Сканирование репозитория GitHub только на наличие подтверждённых секретов и получение вывода в формате JSON
Команда:
```bash
trufflehog git https://github.com/trufflesecurity/test_keys --results=verified --json
```
Ожидаемый результат:
```
{"SourceMetadata":{"Data":{"Git":{"commit":"fbc14303ffbf8fb1c2c1914e8dda7d0121633aca","file":"keys","email":"counter \[email protected]\u003e","repository":"https://github.com/trufflesecurity/test_keys","timestamp":"2022-06-16 10:17:40 -0700 PDT","line":4}}},"SourceID":0,"SourceType":16,"SourceName":"trufflehog - git","DetectorType":2,"DetectorName":"AWS","DecoderName":"PLAIN","Verified":true,"Raw":"AKIAYVP4CIPPERUVIFXG","Redacted":"AKIAYVP4CIPPERUVIFXG","ExtraData":{"account":"595918472158","arn":"arn:aws:iam::595918472158:user/canarytokens.com@@mirux23ppyky6hx3l6vclmhnj","user_id":"AIDAYVP4CIPPJ5M54LRCY"},"StructuredData":null}
...
```
TruffleHog также может выводить [SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) с помощью `--sarif` вместо `--json`. GitHub code scanning нативно понимает SARIF, поэтому его загрузка отображает находки прямо в диффах pull request'ов и на вкладке Security репозитория, а также отслеживает находки как новые/исправленные между сканированиями вместо того, чтобы сообщать об одной и той же находке при каждом запуске — см. раздел [TruffleHog Github Action](#octocat-trufflehog-github-action) ниже о том, как его загрузить. Обратите внимание, что, в отличие от других форматов вывода, результаты SARIF буферизуются в памяти на время полного сканирования и записываются в конце, поскольку SARIF требует единый JSON-документ, а не поток — это нормально для типичных сканирований, но сканирования, порождающие очень большое количество результатов, будут использовать пропорционально больше памяти.
## 5: Сканирование репозитория GitHub + его issues и pull request'ов
```bash
trufflehog github --repo=https://github.com/trufflesecurity/test_keys --issue-comments --pr-comments
```
## 6: Сканирование S3-бакета для получения результатов с высокой степенью достоверности (подтверждённые + неизвестные)
```bash
trufflehog s3 --bucket=<bucket name> --results=verified,unknown
```
## 7: Сканирование S3-бакетов с использованием IAM-ролей
```bash
trufflehog s3 --role-arn=<iam role arn>
```
## 8: Сканирование репозитория Github с использованием SSH-аутентификации в Docker
```bash
docker run --rm -v "$HOME/.ssh:/root/.ssh:ro" trufflesecurity/trufflehog:latest git ssh://github.com/trufflesecurity/test_keys
```
## 9: Сканирование отдельных файлов или каталогов
```bash
trufflehog filesystem path/to/file1.txt path/to/file2.txt path/to/dir
```
## 10: Сканирование локального git-репозитория
Клонируйте git-репозиторий. Например, репозиторий [test keys](https://github.com/trufflesecurity/trufflehog/blob/main/git%40github.com%3Atrufflesecurity/test_keys.git).
```bash
git clone [email protected]:trufflesecurity/test_keys.git
```
Запустите trufflehog из родительского каталога (вне git-репозитория).
```bash
trufflehog git file://test_keys --results=verified,unknown
```
Для защиты от вредоносных конфигураций git при локальном сканировании (см. CVE-2025-41390) TruffleHog клонирует локальные git-репозитории во временный каталог перед сканированием. Это соответствует [рекомендациям Git по безопасности](https://git-scm.com/docs/git#_security). Если вы хотите указать собственный путь для клонирования репозитория (вместо tmp), можно использовать флаг `--clone-path`. Если вы хотите пропустить процесс локального клонирования и сканировать репозиторий напрямую (делайте это только для доверенных репозиториев), можно использовать флаг `--trust-local-git-config`.
## 11: Сканирование GCS-бакетов только на верифицированные секреты
```bash
trufflehog gcs --project-id=<project-ID> --cloud-environment --results=verified
```
## 12: Сканирование Docker-образа только на наличие подтверждённых секретов
Используйте флаг `--image` несколько раз для сканирования нескольких образов.
```bash
# to scan from a remote registry
trufflehog docker --image trufflesecurity/secrets --results=verified
# to scan from the local docker daemon
trufflehog docker --image docker://new_image:tag --results=verified
# to scan from an image saved as a tarball
trufflehog docker --image file://path_to_image.tar --results=verified
```
## 13: Сканирование в CI
Установите флаг `--since-commit` в значение вашей ветки по умолчанию, в которую выполняется слияние (например, "main"). Установите флаг `--branch` в имя ветки вашего PR (например, "feature-1"). В зависимости от используемой вами платформы CI/CD это значение можно получать динамически (например, [CIRCLE_BRANCH в Circle CI](https://circleci.com/docs/variables/) и [TRAVIS_PULL_REQUEST_BRANCH в Travis CI](https://docs.travis-ci.com/user/environment-variables/)). Если репозиторий клонируется и целевая ветка уже извлечена в ходе рабочего процесса CI/CD, то `--branch HEAD` должно быть достаточно. Флаг `--fail` вернёт код ошибки 183, если будут найдены действительные учётные данные.
```bash
trufflehog git file://. --since-commit main --branch feature-1 --results=verified,unknown --fail
```
## 14: Сканирование рабочей области Postman
Используйте флаги `--workspace-id`, `--collection-id`, `--environment` несколько раз для сканирования нескольких целей.
```bash
trufflehog postman --token=<postman api token> --workspace-id=<workspace id>
```
## 15: Сканирование сервера Jenkins
```bash
trufflehog jenkins --url https://jenkins.example.com --username admin --password admin
```
## 16: Сканирование сервера Elasticsearch
### Сканирование локального кластера
Существует два способа аутентификации в локальном кластере с помощью TruffleHog: (1) имя пользователя и пароль, (2) сервисный токен.
#### Подключение к локальному кластеру с именем пользователя и паролем
```bash
trufflehog elasticsearch --nodes 192.168.14.3 192.168.14.4 --username truffle --password hog
```
#### Подключение к локальному кластеру с помощью сервисного токена
```bash
trufflehog elasticsearch --nodes 192.168.14.3 192.168.14.4 --service-token ‘AAEWVaWM...Rva2VuaSDZ’
```
### Сканирование кластера Elastic Cloud
Чтобы просканировать кластер в Elastic Cloud, вам понадобятся Cloud ID и API-ключ.
```bash
trufflehog elasticsearch \
--cloud-id 'search-prod:dXMtY2Vx...YjM1ODNlOWFiZGRlNjI0NA==' \
--api-key 'MlVtVjBZ...ZSYlduYnF1djh3NG5FQQ=='
```
## 17. Сканирование репозитория GitHub на предмет перекрёстных ссылок на объекты между форками и удалённых коммитов
Следующая команда перечислит удалённые и скрытые коммиты в репозитории GitHub, а затем просканирует их на наличие секретов. Это функция альфа-версии.
```bash
trufflehog github-experimental --repo https://github.com/<USER>/<REPO>.git --object-discovery
```
Помимо обычного вывода TruffleHog, флаг `--object-discovery` создаёт два файла в новом каталоге `$HOME/.trufflehog`: `valid_hidden.txt` и `invalid.txt`. Они используются для отслеживания состояния при перечислении коммитов, а также для предоставления пользователям полного списка всех скрытых и удалённых коммитов (`valid_hidden.txt`). Если вы хотите автоматически удалять эти файлы после сканирования, добавьте флаг `--delete-cached-data`.
**Примечание**: Перечисление всех валидных коммитов в репозитории этим методом занимает от 20 минут до нескольких часов в зависимости от размера вашего репозитория. Мы добавили индикатор выполнения, чтобы вы были в курсе, сколько времени займёт перечисление. Само сканирование секретов выполняется чрезвычайно быстро.
Для получения дополнительной информации о Cross Fork Object References, пожалуйста, [прочитайте нашу публикацию в блоге](https://trufflesecurity.com/blog/anyone-can-access-deleted-and-private-repo-data-github).
## 18. Сканирование Hugging Face
### Сканирование модели, датасета, пространства или бакета Hugging Face
```bash
trufflehog huggingface \
--model <model_id> \
--dataset <dataset_id> \
--space <space_id> \
--bucket <bucket_id>
```
### Сканирование всех моделей, датасетов, пространств и бакетов, принадлежащих организации или пользователю Hugging Face
```bash
trufflehog huggingface --org <orgname> --user <username>
```
(Опционально) При сканировании организации или пользователя можно пропустить целый класс ресурсов с помощью `--skip-all-models`, `--skip-all-datasets`, `--skip-all-spaces`, `--skip-all-buckets` ИЛИ конкретный ресурс с помощью `--ignore-models <model_id>`, `--ignore-datasets <dataset_id>`, `--ignore-spaces <space_id>`, `--ignore-buckets <bucket_id>`.
### Сканирование обсуждений и комментариев к PR
```bash
trufflehog huggingface --model <model_id> --include-discussions --include-prs
```
## 19. Сканирование входных данных stdin
```bash
aws s3 cp s3://example/gzipped/data.gz - | gunzip -c | trufflehog stdin
```
# :question: FAQ
- Я вижу только `🐷🔑🐷 TruffleHog. Unearth your secrets. 🐷🔑🐷`, и программа завершается — что это значит?
- Это означает, что секреты не обнаружены
- Почему сканирование GitHub-организации занимает так много времени?
- Неаутентифицированные сканирования GitHub имеют ограничения по частоте запросов. Чтобы повысить лимиты, добавьте флаг `--token` с персональным токеном доступа
- Сообщается, что приватный ключ подтверждён, что это значит?
- Подтверждённый результат означает, что TruffleHog подтвердил валидность учётных данных, проверив их через API сервиса. Для приватных ключей мы подтвердили, что ключ можно использовать в реальном времени для SSH- или SSL-аутентификации. Подробнее читайте в нашем блоге Driftwood [Blog post](https://trufflesecurity.com/blog/driftwood-know-if-private-keys-are-sensitive/)
- Есть ли простой способ игнорировать определённые секреты?
- Если сканируемый источник [поддерживает номера строк](https://github.com/trufflesecurity/trufflehog/blob/d6375ba92172fd830abb4247cca15e3176448c5d/pkg/engine/engine.go#L358-L365), можно добавить комментарий `trufflehog:ignore` в строку, содержащую секрет, чтобы игнорировать этот секрет.
- Можно ли находить секреты, помеченные `trufflehog:ignore`?
- Передайте `--no-ignore-tag`, чтобы выводить результаты, даже если их строка содержит комментарий `trufflehog:ignore`. Это полезно для просмотра ранее принятых находок.
# :newspaper: Что нового в v3?
TruffleHog v3 — это полная переработка на Go с множеством новых мощных возможностей.
- Мы **добавили более 700 детекторов учётных данных с поддержкой активной проверки через соответствующие API**.
- Мы также добавили нативную **поддержку сканирования GitHub, GitLab, Docker, файловых систем, S3, GCS, Circle CI и Travis CI**.
- **Мгновенно проверяйте приватные ключи** по миллионам пользователей GitHub и **миллиардам** TLS-сертификатов с помощью нашей технологии [Driftwood](https://trufflesecurity.com/blog/driftwood).
- Сканируйте бинарные файлы, документы и другие форматы файлов
- Доступно как GitHub Action и pre-commit hook
## Что такое проверка учётных данных?
Для каждой потенциально обнаруженной учётной записи мы кропотливо реализовали программную проверку через API, к которому она, по нашему мнению, относится. Проверка устраняет ложные срабатывания и предоставляет три статуса результата:
- **verified**: учётные данные подтверждены как валидные и активные путём тестирования через API
- **unverified**: учётные данные обнаружены, но валидность не подтверждена (могут быть недействительными, просроченными или проверка отключена)
- **unknown**: проверка была предпринята, но не удалась из-за ошибок, например сетевого сбоя или сбоя API
Например, [детектор учётных данных AWS](https://github.com/trufflesecurity/trufflehog/blob/main/pkg/detectors/aws/access_keys/accesskey.go) выполняет вызов API `GetCallerIdentity` к AWS API, чтобы проверить, активны ли учётные данные AWS.
# :memo: Использование
TruffleHog имеет подкоманду для каждого источника данных, который вы можете захотеть просканировать:
- git
- github
- gitlab
- huggingface
- docker
- s3
- filesystem (файлы и каталоги)
- syslog
- circleci
- travisci
- gcs (Google Cloud Storage)
- postman
- jenkins
- elasticsearch
- stdin
- multi-scan
Каждая подкоманда может иметь параметры, которые можно увидеть с помощью флага `--help`, переданного подкоманде:
```
$ trufflehog git --help
usage: TruffleHog [<flags>] <command> [<args> ...]
TruffleHog is a tool for finding credentials.
Flags:
-h, --[no-]help Show context-sensitive help (also try --help-long and --help-man).
--log-level=0 Logging verbosity on a scale of 0 (info) to 5 (trace). Can be
disabled with "-1".
--[no-]profile Enables profiling and sets a pprof and fgprof server on :18066.
-j, --[no-]json Output in JSON format.
--[no-]json-legacy Use the pre-v3.0 JSON format. Only works with git, gitlab,
and github sources.
--[no-]github-actions Output in GitHub Actions format.
--[no-]sarif Output in SARIF format for upload to GitHub code scanning (e.g.
via github/codeql-action/upload-sarif).
--concurrency=12 Number of concurrent workers.
--[no-]no-verification Don't verify the results.
--results=RESULTS Specifies which type(s) of results to output: verified (confirmed
valid by API), unknown (verification failed due to error),
unverified (detected but not verified), filtered_unverified
(unverified but would have been filtered out). Defaults to
verified,unverified,unknown.
--[no-]no-color Disable colorized output
--[no-]allow-verification-overlap
Allow verification of similar credentials across detectors
--[no-]filter-unverified Only output first unverified result per chunk per detector if there
are more than one results.
--filter-entropy=FILTER-ENTROPY
Filter unverified results with Shannon entropy. Start with 3.0.
--config=CONFIG Path to configuration file.
--[no-]print-avg-detector-time
Print the average time spent on each detector.
--[no-]no-update Don't check for updates.
--[no-]fail Exit with code 183 if results are found.
--[no-]fail-on-scan-errors
Exit with non-zero error code if an error occurs during the scan.
--verifier=VERIFIER ... Set custom verification endpoints.
--[no-]custom-verifiers-only
Only use custom verification endpoints.
--detector-timeout=DETECTOR-TIMEOUT
Maximum time to spend scanning chunks per detector (e.g., 30s).
--archive-max-size=ARCHIVE-MAX-SIZE
Maximum size of archive to scan. (Byte units eg. 512B, 2KB, 4MB)
--archive-max-depth=ARCHIVE-MAX-DEPTH
Maximum depth of archive to scan.
--archive-timeout=ARCHIVE-TIMEOUT
Maximum time to spend extracting an archive.
--include-detectors="all" Comma separated list of detector types to include. Protobuf name or
IDs may be used, as well as ranges.
--exclude-detectors=EXCLUDE-DETECTORS
Comma separated list of detector types to exclude. Protobuf name
or IDs may be used, as well as ranges. IDs defined here take
precedence over the include list.
--[no-]no-verification-cache
Disable verification caching
--[no-]force-skip-binaries
Force skipping binaries.
--[no-]force-skip-archives
Force skipping archives.
--[no-]skip-additional-refs
Skip additional references.
--user-agent-suffix=USER-AGENT-SUFFIX
Suffix to add to User-Agent.
--[no-]version Show application version.
Commands:
help [<command>...]
Show help.
git [<flags>] <uri>
Find credentials in git repositories.
github [<flags>]
Find credentials in GitHub repositories.
github-experimental --repo=REPO [<flags>]
Run an experimental GitHub scan. Must specify at least one experimental sub-module to run:
object-discovery.
gitlab --token=TOKEN [<flags>]
```
---
[Read more](https://github.com/trufflesecurity/trufflehog)