Высокопроизводительный сканер секретов. CLI, библиотека Go, расширение для Burp Suite и расширение для Chrome. 487 правил обнаружения с проверкой учетных данных в реальном времени.
<img width="1200" height="628" alt="Titus — высокопроизводительный сканер секретов для исходного кода, истории git и бинарных файлов" src="https://assets.kitploit.com/production/public/readmes/11969/d2f6b99d686a073185db1b7299fa5f033067b057000062cf592a4ae15a796034.png" />
# Titus: высокопроизводительный сканер секретов
[](https://go.dev)
[](LICENSE)
[](https://github.com/praetorian-inc/titus/actions)
**Titus** — это высокопроизводительный сканер секретов, который обнаруживает учётные данные, API-ключи и токены в исходном коде, файлах и истории git. Он поставляется с 487 правилами обнаружения, охватывающими сотни сервисов и типов учётных данных, взятыми из [NoseyParker](https://github.com/praetorian-inc/noseyparker) и [Kingfisher](https://github.com/mongodb/kingfisher). Titus работает как CLI, Go-библиотека, расширение для Burp Suite и расширение для браузера Chrome — все они используют один и тот же движок обнаружения и набор правил.
Созданный для инженеров по безопасности, пентестеров и команд DevSecOps, Titus сочетает ускоренное сопоставление регулярных выражений на базе [Hyperscan](https://github.com/intel/hyperscan)/[Vectorscan](https://github.com/VectorCamp/vectorscan) с проверкой учётных данных в реальном времени, чтобы находить и подтверждать утечки секретов по всей вашей кодовой базе.
## Содержание
- [Почему Titus?](#why-titus)
- [Установка](#installation)
- [Быстрый старт](#quick-start)
- [Параметры сканирования](#scanning-options)
- [Оценка находок](#finding-scoring)
- [Go-библиотека](#go-library-for-secrets-detection)
- [Расширение для Burp Suite](#burp-suite-extension-for-secret-scanning)
- [Расширение для браузера](#chrome-browser-extension-for-secret-scanning)
- [Сборка из исходного кода](#building-from-source)
- [Участие в разработке](#contributing)
- [Лицензия](#license)
## Почему Titus?
- **Быстрое сканирование секретов**: сопоставление регулярных выражений ускоряется с помощью [Hyperscan](https://github.com/intel/hyperscan)/[Vectorscan](https://github.com/VectorCamp/vectorscan), когда они доступны, с чистой Go-реализацией в качестве запасного варианта для переносимости на любую платформу.
- **Широкий охват обнаружения учётных данных**: 487 правил обнаруживают API-ключи, токены и учётные данные для AWS, GCP, Azure, GitHub, Slack, баз данных, систем CI/CD и сотен других сервисов.
- **Проверка секретов в реальном времени**: обнаруженные секреты проверяются через их исходные API, чтобы подтвердить, активны ли они, что снижает число ложных срабатываний и помогает расставить приоритеты при устранении.
- **Оценка серьёзности на основе риска**: каждая находка получает числовую оценку (0–100) и уровень серьёзности (info → critical). Оценки настраиваются на основе статических метаданных правил, контекста доступности кода и вызовов API в реальном времени, которые измеряют реальный масштаб угрозы от учётных данных, — так что самые опасные находки всегда оказываются на первом месте.
- **Сканирование образов контейнеров**: сканируйте образы Docker и OCI напрямую из любого реестра, tar-архива или каталога с раскладкой OCI — без необходимости в демоне Docker или бинарном файле.
- **Несколько интерфейсов для любого рабочего процесса**: сканируйте из CLI, встраивайте как Go-библиотеку, пассивно сканируйте HTTP-трафик в Burp Suite или сканируйте веб-страницы в Chrome во время тестирования безопасности приложений.
- **Извлечение из бинарных файлов**: извлекайте и сканируйте секреты из документов Office, PDF, архивов (zip, tar, 7z), мобильных приложений (APK, IPA), расширений для браузера и многого другого.
## Установка
Скачайте готовый бинарный файл со страницы [Releases](../../releases) или соберите из исходного кода:
```bash
make build
```
Бинарный файл будет находиться в `dist/titus`.
## Быстрый старт
```bash
# Scan a file for secrets
titus scan path/to/file.txt
# Scan a directory for leaked credentials
titus scan path/to/directory
# Scan a public GitHub repository (no token needed)
titus scan github.com/org/repo
# Scan a public GitLab project (no token needed)
titus scan gitlab.com/namespace/project
# Scan git history for secrets in past commits
titus scan --git path/to/repo
# Scan a Docker / OCI image (pulled from a registry — no docker daemon required)
titus scan --docker alpine:latest
# Validate detected secrets against source APIs
titus scan path/to/code --validate
```
Результаты записываются в хранилище данных (`titus.ds` по умолчанию) и выводятся в консоль.
### Подкоманды
<!-- BEGIN generated: cli-subcommands -->
Titus организует свою функциональность в следующие специализированные подкоманды:
```bash
titus analyze # Analyze a credential on demand — detect type, validate, score, and enumerate resources
titus enum # Enumerate remote services for secrets
titus explore # Interactively explore scan results
titus report # Generate a report from scan results
titus rules # Manage detection rules
titus scan # Scan a target for secrets
titus serve # Run as streaming server for Burp extension integration
titus version # Show version information
```
<!-- END generated: cli-subcommands -->
Каждая подкоманда принимает `--help` для собственных флагов. Формы верхнего уровня `titus <provider>`, существовавшие до появления `titus enum <provider>`, по-прежнему работают, но они скрыты и устарели, а не являются псевдонимами, поэтому они перечислены в сгенерированном справочнике, а не здесь.
<!-- BEGIN generated: cli-aliases -->
Полный справочник — каждая подкоманда, псевдоним и флаг, включая скрытые от `--help` — генерируется в [docs/CLI.md](https://github.com/praetorian-inc/titus/blob/main/docs/CLI.md).
<!-- END generated: cli-aliases -->
## Параметры сканирования
### Сканирование GitHub и GitLab
Сканируйте публичные репозитории напрямую по URL — API-токен не требуется:
```bash
# Scan a GitHub repository
titus scan github.com/kubernetes/kubernetes
# Scan a GitLab project
titus scan gitlab.com/gitlab-org/cli
# Full URLs work too
titus scan https://github.com/org/repo
titus scan https://gitlab.com/namespace/project.git
```
Для сканирования в масштабе организации или пользователя используйте специальные подкоманды:
```bash
# Scan all public repos in a GitHub org
titus github --org kubernetes
# Scan all repos in a GitHub org with a token (private repos + higher rate limits)
titus github --org kubernetes --token $GITHUB_TOKEN
# Scan all repos for a GitHub user
titus github --user octocat
# Scan all projects in a GitLab group
titus gitlab scan --group mygroup --token $GITLAB_TOKEN
# Scan a single repo with git history (finds deleted secrets)
titus github scan owner/repo --git
```
Токены необязательны для публичных репозиториев. Задайте `GITHUB_TOKEN` или `GITLAB_TOKEN` (либо используйте `--token`) для доступа к приватным репозиториям и повышения лимитов API.
### Сканирование образов Docker / OCI
Сканируйте образы контейнеров напрямую — без docker-демона и без бинарника `docker`. Titus загружает образы напрямую из любого OCI-реестра по HTTPS (используя учётные данные из `~/.docker/config.json`) либо читает образы из локального tarball, созданного `docker save`, или из каталога раскладки OCI-образа. Затем он сканирует метаданные манифеста и конфигурации образа, а также каждый обычный файл в каждом слое, включая файлы нижних слоёв, удалённые последующими слоями (поскольку секреты могут оставаться восстановимыми из истории образа).
```bash
# Pull from a registry and scan
titus scan --docker alpine:latest
titus scan docker://ghcr.io/owner/repo:tag
# Scan an image saved to a tarball:
# docker save my-app:latest -o my-app.tar
# podman save my-app:latest -o my-app.tar
titus scan --docker ./my-app.tar
# Scan an OCI image layout directory:
# docker buildx build --output type=oci,dest=./img/ .
# skopeo copy docker://my-app:latest oci:./img:latest
titus scan --docker ./img/
```
Аутентификация использует существующую конфигурацию Docker / Podman (`~/.docker/config.json`, `${XDG_RUNTIME_DIR}/containers/auth.json`). Для приватных реестров, требующих нового входа, сначала следует выполнить аутентификацию с помощью `docker login` (или `podman login`, или `crane auth login`) — titus не запрашивает учётные данные.
### Просмотр результатов сканирования
Используйте `report`, чтобы повторно прочитать результаты предыдущего сканирования:
```bash
# Human-readable summary of detected secrets
titus report
# JSON output for programmatic processing
titus report --format json
# SARIF output for CI/CD integration with GitHub Advanced Security
titus report --format sarif
# Report from a specific datastore
titus report --datastore path/to/titus.ds
# Only findings from one repository (host-qualified as recorded, or without the host)
titus report --repo github.com/acme/api
# Repeat a selector, or combine selectors; a location matching any value is kept
titus report --namespace github.com/acme --namespace gitlab.example.com/acme --path src/config.yaml
# List the repository, namespace and path values that select current findings
titus report sources
# List every recorded source, including sources with no findings
titus report sources all
```
Формат вывода также можно задать во время сканирования с помощью `--format`:
```bash
titus scan path/to/code --format json
```
### Проверка обнаруженных секретов
Передайте `--validate` во время сканирования, чтобы проверить обнаруженные секреты через их исходные API:
```bash
titus scan path/to/code --validate
```
Проверка выполняется параллельно (по умолчанию 4 воркера, настраивается с помощью `--validate-workers`) и помечает каждую находку как подтверждённую, опровергнутую или неизвестную.
### Правила обнаружения фильтрации
```bash
# List all available detection rules
titus rules list
# Scan with only specific rules (e.g., AWS and GCP credentials)
titus scan path/to/code --rules-include "aws,gcp"
# Exclude rules by pattern
titus scan path/to/code --rules-exclude "kingfisher.generic"
# Use a custom rules file for organization-specific secrets
titus scan path/to/code --rules path/to/custom-rules.yaml
# Opt in to rules marked noisy: true (high false-positive rate, off by default)
titus scan path/to/code --include-noisy
```
Правила, помеченные `visible: false`, являются вспомогательными: они захватывают контекст для других правил, например идентификатор клиента, имя учётной записи или хост, а не секрет. Их шаблоны по-прежнему выполняются, но совпадения по ним никогда не выводятся — ни через CLI, ни через библиотеку Go, даже если правило выбрано явно.
### Извлечение секретов из бинарных файлов
Titus умеет извлекать текст из бинарных форматов файлов и сканировать содержимое на наличие секретов:
```bash
# Extract and scan all supported binary formats
titus scan path/to/files --extract=all
# Target specific formats
titus scan path/to/files --extract=xlsx,docx,pdf,zip
```
Поддерживаемые форматы включают офисные документы (xlsx, docx, pptx, odp, ods, odt), PDF-файлы, Jupyter notebooks, базы данных SQLite, электронную почту (eml, rtf) и архивы (zip, tar, tar.gz, jar, war, ear, apk, ipa, crx, xpi, 7z). Архивы рекурсивно распаковываются с настраиваемыми ограничениями по глубине и размеру.
```bash
# Tune extraction limits for large codebases
titus scan path/to/files --extract=all \
--extract-max-size 10MB \
--extract-max-total 100MB \
--extract-max-depth 5
```
Для баз данных SQLite Titus извлекает текст из всех таблиц (по умолчанию 1000 строк на таблицу). Используйте `--sqlite-row-limit` для настройки:
```bash
# Full dump of all SQLite tables (no row limit)
titus scan path/to/files --extract=all --sqlite-row-limit 0
# Custom row limit per table
titus scan path/to/files --extract=all --sqlite-row-limit 5000
```
## Оценка находок
Каждая находка, которую создаёт Titus, имеет числовую оценку от 0 до 100 и уровень серьёзности:
| Оценка | Серьёзность |
|-------|----------|
| 0–20 | info |
| 21–40 | low |
| 41–60 | medium |
| 61–80 | high |
| 81–100 | critical |
Оценки начинаются с `base_score` правила и корректируются **модификаторами** — условиями, которые повышают или понижают оценку в зависимости от того, что известно об учётных данных:
```bash
# Score findings using static rule metadata only (no network calls)
titus scan path/to/code
# Score findings AND make live API calls to verify credential blast radius
# (calls AWS STS/IAM and GitHub API for supported credential types)
titus scan path/to/code --score-scope
# Override the accessibility context (default: auto-detected from git remote)
titus scan path/to/code --accessibility public # no penalty for public repos
titus scan path/to/code --accessibility private # -25 penalty (default for local scans)
```
Titus поставляется с YAML-скоринговыми модулями для учётных данных AWS, GitHub PAT и токенов Slack, а также с Go-скоринговыми модулями на основе SDK, которые выполняют перечисление политик IAM в реальном времени (AWS) и проверку разрешений репозитория (GitHub fine-grained PAT), когда включён `--score-scope`.
Полный справочник см. в [docs/scoring.md](https://github.com/praetorian-inc/titus/blob/main/docs/scoring.md): уровни серьёзности, виды модификаторов, сведения о встроенных скоринговых модулях и о том, как писать собственные YAML- или Go-скоринговые модули.
## Go-библиотека для обнаружения секретов
Titus можно импортировать как Go-библиотеку, чтобы добавить обнаружение секретов в собственные инструменты и конвейеры.
```bash
go get github.com/praetorian-inc/titus
```
```go
package main
import (
"fmt"
"log"
"github.com/praetorian-inc/titus"
)
func main() {
// Initialize the secrets scanner with default rules
scanner, err := titus.NewScanner()
if err != nil {
log.Fatal(err)
}
defer scanner.Close()
// Scan a string for API keys, tokens, and credentials
matches, err := scanner.ScanString(`aws_access_key_id = AKIADEADBEEFDEADBEEF`)
if err != nil {
log.Fatal(err)
}
for _, match := range matches {
fmt.Printf("%s (rule: %s) at line %d\n",
match.RuleName, match.RuleID,
match.Location.SourceSpan.Start.Line,
)
}
}
```
Библиотека также поддерживает сканирование байтов и файлов, проверку обнаруженных секретов и загрузку пользовательских правил:
```go
// Scan a file for leaked credentials
matches, err := scanner.ScanFile("/path/to/config.json")
// Enable validation to check if detected secrets are live
scanner, err := titus.NewScanner(titus.WithValidation())
// Load custom detection rules for organization-specific secrets
rules, err := titus.LoadRulesFromFile("/path/to/rules.yaml")
scanner, err := titus.NewScanner(titus.WithRules(rules))
```
Полную справку по API, шаблоны параллельного выполнения и дополнительные примеры см. в [docs/library-usage.md](https://github.com/praetorian-inc/titus/blob/main/docs/library-usage.md).
## Расширение Burp Suite для сканирования секретов
Расширение Burp сканирует HTTP-ответы на наличие секретов во время проксирования трафика и активного тестирования на проникновение.
### Настройка
#### Linux / macOS (сборка из исходного кода)
```bash
# Build the CLI and Burp extension JAR, install CLI to ~/.titus/
make install-burp
```
Затем загрузите `dist/titus-burp-1.0.0-all.jar` в Burp Suite через Extensions > Add.
#### Windows (загрузка из Releases)
1. Скачайте `titus-windows-amd64.exe` и `titus-burp-<version>.jar` из [Releases](../../releases)
2. Создайте каталог Titus и установите бинарный файл:
```powershell
mkdir %USERPROFILE%\.titus
copy titus-windows-amd64.exe %USERPROFILE%\.titus\titus.exe
```
3. Загрузите JAR в Burp Suite через Extensions > Add
#### Linux / macOS (загрузка из Releases)
1. Скачайте подходящий бинарный файл для вашей платформы и `titus-burp-<version>.jar` из [Releases](../../releases):
- `titus-linux-amd64` или `titus-linux-arm64` для Linux
- `titus-darwin-amd64` или `titus-darwin-arm64` для macOS
2. Установите бинарный файл:
```bash
mkdir -p ~/.titus
cp titus-<platform> ~/.titus/titus
chmod +x ~/.titus/titus
```
3. Загрузите JAR в Burp Suite через Extensions > Add
Расширение запускает процесс `titus serve` в фоновом режиме и обменивается данными через stdin/stdout с использованием NDJSON. Правила обнаружения загружаются один раз при запуске.
### Возможности расширения для Burp
- **Пассивное сканирование секретов**: автоматически сканирует прокси-трафик по мере его прохождения через Burp
- **Активное сканирование секретов**: контекстное меню по правому клику для сканирования выбранных запросов
- **Дедупликация**: один и тот же секрет сообщается только один раз за сессию
- **Быстрая фильтрация**: бинарное содержимое, изображения и нетекстовые ответы пропускаются
- **Проверка учётных данных в реальном времени**: проверка обнаруженных секретов через исходные API для подтверждения их активности
- **Управление ложными срабатываниями**: пометка находок как ложных срабатываний для фильтрации шума
- **Классификация по критичности**: находки цветовым кодом по уровню риска (High/Medium/Low)
- **Экспорт**: сохранение находок в JSON для отчётности
### Интерфейс расширения для Burp
Расширение добавляет вкладку **Titus** в Burp с тремя подвкладками:
**Secrets**: Все обнаруженные секреты с фильтрацией по типу, хосту и статусу проверки.
Titus Burp Suite extension secrets tab showing detected API keys and credentials with validation status
- **Статус проверки**: показывает, были ли проверены секреты (Active/Inactive/Unknown)
- **Фильтрация**: нажмите кнопки Type, Host или Status для фильтрации по конкретным значениям; используйте поле поиска для текстового и regex-сопоставления
- **Массовые действия**: выберите несколько строк для пакетной проверки или пометки как ложных срабатываний
- **Панель Secret Details**: выберите находку для просмотра:
- **Details**: информация о правиле, категория, полное значение секрета, время первого обнаружения
- **URLs**: все местоположения, где был найден этот секрет
- **Validation**: результат проверки с подробностями (например, AWS account ID, ARN)
- **Request/Response**: полный HTTP-трафик с выделенным секретом
**Statistics**: Сводное представление секретов, сгруппированных по типу и хосту.
<img width="1964" height="848" alt="Titus Burp Suite extension statistics tab showing secrets by type and host" src="https://assets.kitploit.com/production/public/readmes/11969/4a3d6f997049bb8bba621ceb8511b9a41c63867a5c1e8add6065c483706ac36a.png" />
- **Summary**: Общее количество уникальных секретов, просканированных хостов, разбивка по проверке (активные и неактивные) и количество ложных срабатываний
- **Secrets by Type**: Количество каждого типа секретов с классификацией по категориям
- **Secrets by Host**: Количество секретов, найденных на каждом хосте
**Settings**: Настройка параметров сканирования, проверки и сопоставления уровней критичности.
Titus Burp Suite extension settings tab with scan configuration options
- **Настройки сканирования**:
- *Пассивное сканирование*: автоматически сканировать весь прокси-трафик (включено по умолчанию)
- *Сканирование тела запроса*: также сканировать тела запросов на наличие секретов, отправляемых приложением
- *Проверка*: включите для проверки секретов через исходные API (выполняет исходящие запросы и может вызвать оповещения)
- **Параметры сканирования**: рабочие потоки, максимальный размер файла, длина контекстного фрагмента
- **Настройка критичности**: настройка уровней критичности для каждой категории секретов
- **Действия**: очистить кэш, сбросить настройки, сохранить/экспортировать находки в JSON
При просмотре любого запроса в Burp во вкладке инспектора ответов появляется вкладка **Titus**, если обнаружены секреты, что обеспечивает быстрый доступ к находкам без переключения на основную вкладку Titus.
Titus tab in Burp Suite response inspector highlighting detected secrets in HTTP responses
## Расширение для браузера Chrome для сканирования секретов
Расширение для Chrome сканирует веб-страницы на наличие секретов во время оценки безопасности веб-приложений.
### Установка
```bash
make build-extension
```
1. Перейдите по адресу `chrome://extensions/`
2. Включите **Режим разработчика**
3. Нажмите **Загрузить распакованное расширение** и выберите каталог `extension/`
### Возможности браузерного расширения
- Сканирует встроенный и внешний JavaScript, а также таблицы стилей на наличие API-ключей и токенов
- Сканирует localStorage и sessionStorage на наличие утёкших учётных данных
- Опциональный перехват сетевых ответов для комплексного обнаружения секретов
- Результаты отображаются во всплывающем окне и на панели управления
<img width="1719" height="958" alt="Всплывающее окно расширения Titus для Chrome с обнаруженными секретами на веб-странице" src="https://assets.kitploit.com/production/public/readmes/11969/057a24e2746412ceabe1aac0292a2de463de1efee5bca2489ca34b59d8b0dc2c.png" />
<img width="1744" height="827" alt="Панель управления расширения Titus для Chrome с агрегированными результатами обнаружения секретов" src="https://assets.kitploit.com/production/public/readmes/11969/265d972fadcc7f212944d7a1d8fd58a43446e7199d1209900e83b96a546ffb00.png" />
### Уведомление о безопасности
Браузерное расширение удаляет заголовки Content Security Policy и CORS с посещаемых страниц для сканирования внешних ресурсов. Это ослабляет защиту сайтов, которые вы посещаете, пока расширение активно. **Включайте только во время активного тестирования безопасности.**
## Сборка из исходного кода
### Стандартная сборка (с ускорением Vectorscan)
По умолчанию Titus компилируется с [Vectorscan](https://github.com/VectorCamp/vectorscan) (ARM) / [Hyperscan](https://github.com/intel/hyperscan) (x86) для SIMD-ускоренного сопоставления регулярных выражений. Для этого требуются CGO, библиотека C и `pkg-config` (который cgo использует для поиска библиотеки). `make build` проверяет их наличие и пытается установить всё недостающее через Homebrew / apt / dnf:
```bash
# Build the CLI binary with vectorscan acceleration (outputs to dist/titus)
make build
# Build the Burp Suite extension JAR
make build-burp
# Build the Chrome browser extension
make build-extension
# Run unit tests
make test
# Run integration tests
make integration-test
```
При запуске вы увидите `[vectorscan] N/N rules compiled for Hyperscan`, когда ускоренный движок активен.
Чтобы установить библиотеку C самостоятельно, вместо того чтобы полагаться на автоустановку:
```bash
# macOS (Homebrew)
brew install pkg-config vectorscan
# Ubuntu/Debian
sudo apt-get install pkg-config libhyperscan-dev
# Fedora/RHEL
sudo dnf install pkgconf-pkg-config vectorscan-devel
# Or build vectorscan from source:
git clone --depth 1 --branch vectorscan/5.4.11 https://github.com/VectorCamp/vectorscan.git
cd vectorscan && cmake -B build -DCMAKE_INSTALL_PREFIX=/usr/local && cmake --build build && sudo cmake --install build
```
---
[Read more](https://github.com/praetorian-inc/titus)