Инструмент статического анализа кода с учётом фреймворков для автоматизированного ревью исходного кода, включающий платформозависимые правила, анализ потоков данных (taint analysis), оценку трудозатрат и базовые линии подавления предупреждений.
# Daksh SCRA (Помощник по проверке исходного кода) ``` Author: - Debasis Mohanty ([email protected]) - Twitter / X: @coffeensecurity - www.coffeeandsecurity.com ``` ## О Daksh SCRA Daksh SCRA (Source Code Review Assist) создан для повышения эффективности процесса проверки исходного кода, обеспечивая хорошо структурированный и организованный подход для ревьюеров кода. Вместо того чтобы без разбора помечать всё как потенциальную проблему, Daksh SCRA поощряет вдумчивый анализ, побуждая к исследованию и подтверждению потенциальных проблем. Этот подход снижает спешку с пометкой каждой потенциальной проблемы как бага, сокращая путаницу и потери времени на ложные срабатывания. ### Дебют Daksh SCRA был впервые представлен во время обучающей сессии по проверке исходного кода на Black Hat USA 2022 (6–9 августа), где он был ненавязчиво продемонстрирован определённой аудитории. Его официальный публичный дебют состоялся на Black Hat USA 2023 в Лас-Вегасе. ## Возможности и функциональность DakshSCRA объединяет отличительные возможности для ручной проверки исходного кода — от областей интереса по путям к файлам и оценки трудозатрат до разведки программного обеспечения, контекстных правил и межфайлового анализа. | Возможность | Метка | Почему это важно | |---|---|---| | **Области интереса по путям к файлам** | Первые в мире* | Сканирует сами имена файлов и каталогов наряду с кодом, чтобы помечать подозрительные пути, такие как резервные копии, отладочные эндпоинты, дампы конфигураций и файлы учётных данных, которые ревьюеры часто пропускают. | | **Научная оценка трудозатрат** | Первые в мире* | Формирует количественную оценку трудозатрат на ручную проверку на основе размера кодовой базы и сигналов проекта. Настраиваемые допущения делают планирование работ явным и воспроизводимым. | | **Разведка программного обеспечения** | Вторые в мире* | Определяет языки, фреймворки и инфраструктуру по содержимому файлов и структуре проекта до сканирования. Связывает инвентаризацию технологий с автоматическим выбором правил, семантическим анализом и планированием проверки. | | **Продвинутый семантический и межфайловый анализ** | Самый продвинутый open source на момент выпуска* | Отслеживает контролируемые пользователем данные от источника до стока через границы поддерживаемых файлов с помощью специализированного анализа. Advanced Analysis вышел вместе с оригинальным RDL в марте 2026 года; RDL v2 расширяет семантическую оценку правил на несколько файлов. | * На основе общих поисков на момент введения каждой возможности. Похожая возможность не была найдена в open source инструментах проверки безопасности кода. Для оценки трудозатрат похожий подход не был найден и в коммерческих инструментах. Recon занял второе место после Microsoft Application Inspector. Межфайловый анализ был самым продвинутым среди open source инструментов проверки кода на момент его выпуска. ### История возможностей и подтверждения | Возможность / веха | Дата | Релиз | Подтверждение / охват | |---|---|---|---| | Начальная бета и правила путей к файлам | 22 октября 2022 | v0.1-beta | [Первоначальный выпуск; сохранённый исходный код включает выделенный перечень правил для путей к файлам.](https://github.com/coffeeandsecurity/DakshSCRA/releases/tag/v0.1-beta) | | Разведка программного обеспечения (опубликованное представление) | 9 июля 2023 | v0.3-beta | [Примечания к выпуску представляют recon; более ранний код репозитория является отдельным подтверждением реализации.](https://github.com/coffeeandsecurity/DakshSCRA/releases/tag/v0.3-beta) | | Оценка трудозатрат на ручную проверку (реализация) | 29 июля 2023 | Коммит реализации | [Добавлен выделенный модуль оценки; это не дата последующего релиза с исправлениями.](https://github.com/coffeeandsecurity/DakshSCRA/commit/65d5c6a) | | Оригинальный RDL и межфайловый Advanced Analysis | 2 марта 2026 | v0.31-beta | [Условная логика правил и независимый межфайловый анализ выпущены вместе. Отображаемая дата релиза — 2 марта; метка времени публикации — 1 марта 2026 года, 18:39 UTC.](https://github.com/coffeeandsecurity/DakshSCRA/commit/d90ba51) | ### Сравнительные подтверждения - **Предшественник recon:** [Microsoft Application Inspector](https://www.microsoft.com/en-us/security/blog/2020/01/16/introducing-microsoft-application-inspector/) (16 января 2020) описывает более ранний инструмент анализа характеристик исходного кода. Recon в Daksh SCRA поставлен вторым после него. Даты обозначают вехи репозитория или релиза. DakshSCRA был представлен во время обучения на **Black Hat USA 2022** и публично дебютировал на **Black Hat USA 2023**. Эти даты описывают представление проекта, а не все текущие функции. > Активные улучшения продолжаются. В ближайших выпусках запланировано множество новых функций и улучшений. Не стесняйтесь вносить вклад в обновление или добавление новых правил и будущую разработку. Если вы обнаружите какие-либо ошибки, сообщите о них на [[email protected]](mailto:[email protected]). Подробная документация: [https://dakshlabs.com/#docs](https://dakshlabs.com/#docs) --- ## Начало работы Есть два способа запустить Daksh SCRA — выберите тот, который лучше подходит для вашего рабочего процесса: | | Лучше всего подходит для | Перейти к | |---|---|---| | 🌐 **Веб-интерфейс (Docker)** | Самый простой способ начать — одна команда, панель управления в браузере, отображение хода сканирования в реальном времени и просмотр отчётов/артефактов. Рекомендуется для большинства пользователей. | [Веб-интерфейс (Docker)](#web-ui-docker) | | 💻 **CLI (Python)** | Скриптинг, CI-конвейеры или запуск сканирований без Docker. | [Настройка CLI](#cli-setup) | Оба способа запускают один и тот же движок сканирования — веб-интерфейс является браузерным фронтендом поверх того же CLI, поэтому результаты в любом случае идентичны. --- ## Веб-интерфейс (Docker) Самый быстрый способ запустить Daksh SCRA — через его браузерный веб-интерфейс, запускаемый с помощью Docker-скрипта запуска с учётом хоста. Он предоставляет вам средство запуска сканирования, живой поток консоли и просматриваемую историю прошлых отчётов. Скрипту запуска требуется Python 3 (только стандартная библиотека); приложение и его зависимости работают в Docker. Настройка Docker запускает веб-интерфейс и CLI как независимые сервисы, собранные из одного образа, поэтому вы можете использовать любой из них (или оба) из одного контейнера. ### Запуск веб-интерфейса После загрузки Daksh SCRA с GitHub **сначала распакуйте ZIP-архив**. Откройте терминал (PowerShell или командную строку в Windows) внутри распакованной папки проекта, содержащей `docker-compose.yml` и `dakshscra.py`. **Выполняйте все команды запуска и Docker Compose, приведённые ниже, из этой папки.** Если ваш терминал открывается в другом месте, сначала перейдите в распакованную папку: ```text cd "path/to/extracted/DakshSCRA-folder" ``` Замените пример пути на фактическое место загрузки и имя папки. Если вы вместо этого клонировали репозиторий, выполните `cd DakshSCRA` из его родительской папки. Помощник запуска распознаёт Windows, WSL, Linux и macOS, затем монтирует корень хоста, доступные диски Windows и общие папки в режиме только для чтения перед запуском контейнеров. Запускайте его на компьютере, где работает Docker. Linux, macOS или WSL (в foreground): ```bash python3 tools/start_webui.py ``` Windows PowerShell или командная строка (на переднем плане): ```powershell py tools/start_webui.py ``` Для запуска в отсоединённом (фоновом) режиме добавьте `--detach`. Контейнеры продолжат работать после возврата команды запуска, оставляя ваш терминал доступным. Linux, macOS или WSL (отсоединённый режим): ```bash python3 tools/start_webui.py --detach ``` Windows PowerShell или командная строка (в отдельном окне): ```powershell py tools/start_webui.py --detach ``` Используйте `--dry-run`, чтобы просмотреть обнаруженные пути без запуска контейнеров. Существующие переопределения путей в `.env` учитываются. Учётные записи, сканирования и runtime-том сохраняются при пересоздании контейнеров. Docker Desktop может потребовать разрешение на совместное использование выбранных путей хоста. Если он отклоняет монтирование, разрешите это расположение в Docker Desktop и запустите помощник повторно. Удалённый браузер видит папки **хоста Docker**, а не диски своего собственного компьютера. Автоматическое обнаружение требует локального движка Docker; запускайте помощник на хосте движка при использовании удалённого контекста Docker. Для вручную настроенных монтирований по-прежнему доступна команда `docker compose up --build -d api web`. Её базовая конфигурация монтирует репозиторий в `/scan-targets`, а `${DAKSH_HOST_MOUNT:-/}` в `/host/root`. Используйте помощник для обнаружения дисков Windows и ярлыков общих папок; обычный Compose не может определить ОС клиента. Затем откройте [http://localhost:3030](http://localhost:3030). Чтобы использовать другой порт: ```bash DAKSH_PORT=9090 python3 tools/start_webui.py ``` Остановите стек с помощью: ```bash docker compose down ``` ### Освобождение дискового пространства после повторных сборок Docker Используйте отдельные вспомогательные скрипты очистки из папки репозитория. По умолчанию они выполняют только предварительный просмотр: **Это удаляет контейнеры Daksh, образы сервисов, сети и тома, включая сохранённые учётные записи, историю сканирований и артефакты, хранящиеся в runtime-томе. Сначала сделайте резервную копию всего, что хотите сохранить.** ```bash python3 tools/clean_project_docker.py python3 tools/purge_all_docker.py ``` Добавьте `--execute` для удаления, затем введите запрошенное подтверждение. Первый помощник удаляет контейнеры, сети, образы сервисов и тома этого проекта, сохраняя общий кэш сборки. Второй принудительно удаляет контейнеры **во всех проектах на выбранном движке Docker** и очищает образы, сети, именованные/анонимные тома и кэш сборщика по умолчанию. Он может затронуть удалённый движок. Ни один из них не удаляет привязанные (bind-mounted) файлы хоста и не удаляет Docker. Пользователи Windows могут заменить `python3` на `py`. См. [область очистки и команды](https://github.com/coffeeandsecurity/dakshscra/blob/main/docs/usage-guide.md#docker-cleanup-and-full-purge) для пользовательских имён проектов, исключений и подробностей удаления. Проверьте оставшееся использование диска Docker с помощью: ```bash docker system df ``` Чтобы освободить только неиспользуемый кэш сборки, сохранив при этом сохранённые данные Daksh, выполните просто `docker builder prune --all --force`. Файлы в привязанных к хосту папках, включая репозиторий и цели сканирования, остаются на диске. Когда будете готовы, запустите снова с помощью `python3 tools/start_webui.py --detach`. ### Вход в систему Веб-интерфейс требует учётную запись. **Первый вход** 1. Запустите портал (`python3 tools/start_webui.py --detach`) и откройте [http://localhost:3030](http://localhost:3030). 2. Страница входа определяет первичную настройку. Она предварительно заполняет имя пользователя `admin` и начальный пароль и показывает уведомление о первичной настройке. | Параметр | Значение | |---|---| | Имя пользователя | `admin` (или `DAKSH_ADMIN_USERNAME` из `.env`) | | Начальный пароль | `Daksh@ChangeMe1` (или `DAKSH_ADMIN_PASSWORD` из `.env`) | 3. Нажмите **Sign in**. Появляется полноэкранный шаг **смены пароля**, который нельзя пропустить. Введите начальный пароль как текущий пароль, выберите новый пароль (не менее 8 символов, отличный от текущего) и при желании измените имя пользователя. 4. После сохранения вы попадаете на панель управления. С этого момента страница входа больше ничего не предзаполняет; входите со своими учётными данными. Начальный пароль используется только пока в базе данных нет учётных записей, и перестаёт работать сразу после его смены. До этого любой, кто может получить доступ к порталу, может войти с ним, поэтому задайте `DAKSH_ADMIN_PASSWORD` в `.env` перед первым запуском, если портал доступен другим. Учётная запись администратора может создавать дополнительные учётные записи через API-эндпоинт `POST /api/v1/auth/users` (отдельного интерфейса для этого пока нет). Новые и сброшенные учётные записи также должны сменить назначенный им пароль при первом входе. Полный список настроек, связанных с аутентификацией (время жизни сессии, безопасность cookie, CORS), см. в `.env.example`. ### Что вы получаете - Адаптивный конструктор команд для режимов scan, recon, estimate, recon+estimate, list и PDF-from-JSON - Консольный вывод в реальном времени и живой прогресс по каждому этапу во время выполнения - Снимки артефактов для каждого задания для выходных данных HTML / PDF / JSON - Руководство в режиме Developer Mode, Code Review Mode или Both для результатов и отчётов; по умолчанию используется Both - Быстрая навигация в браузере между формой запуска, живым выводом, артефактами и недавними заданиями - Встроенный обозреватель каталогов для выбора целевых путей (с учётом ОС: Windows, macOS, Linux / Docker) Под капотом CLI остаётся источником истины — он выполняет всё сканирование и генерирует все выходные данные HTML / PDF / JSON. Веб-интерфейс выполняет одно активное задание за раз и сохраняет снимки выходных данных каждого завершённого задания в `runtime/webui/jobs/<job-id>/artifacts/`, чтобы прошлые отчёты оставались доступными. ### Запуск CLI в Docker Вам также не нужна локальная среда Python для использования CLI — он доступен как отдельный сервис Compose, собранный из того же образа: ```bash docker compose run --rm cli -h docker compose run --rm cli -r auto -t /scan-targets/path/to/source ``` ### Что в образе - Бэкенд FastAPI + фронтенд Web UI - Полный CLI Daksh SCRA в виде отдельного сервиса - Playwright Chromium для генерации PDF - Постоянные тома `reports/` и `runtime/` - Монтирование путей хоста, чтобы сканирования могли получать доступ к деревьям исходников изнутри контейнера **Ключевые точки монтирования:** | Монтирование | Путь внутри контейнера | |---|---| | Исходники проекта | `/app` | | Корень сканирования по умолчанию (репозиторий или `DAKSH_SCAN_ROOT`) | `/scan-targets` | | Файловая система хоста (системный диск в Windows) | `/host/root` | | Дополнительные диски Windows/WSL | `/host/drives/<letter>` | | Домашний каталог текущего пользователя | `/host/user` | | Общие папки хоста | `/host/locations/<name>` | | Необязательный `DAKSH_HOST_SOURCE` | `/host/source` | Скопируйте `.env.example` в `.env` для необязательных переопределений путей и аутентификации. `DAKSH_BROWSE_ROOTS` — это разделённый запятыми список разрешённых путей **контейнера**; оставьте его незаданным, чтобы обнаруживать смонтированные расположения. Устаревшие списки разрешённых путей `/host/c`, `/host/d` или `/mnt` следует удалить или обновить при переходе на helper. Папки хоста доступны только для чтения; отчёты и данные времени выполнения остаются доступными для записи в их существующих местах приложения. Перезапустите с помощью helper после подключения ещё одного диска. Docker-сокет или привилегированный контейнер не требуются. --- ## Настройка CLI Предпочитаете запускать Daksh SCRA напрямую с помощью Python? Вот как настроить его локально. ### Предварительные требования - Python 3.8+ - Все библиотеки, перечисленные в `requirements.txt` ### 1. Загрузите Daksh SCRA ```bash git clone https://github.com/coffeeandsecurity/DakshSCRA.git ``` Или скачайте последний zip-архив с [https://github.com/coffeeandsecurity/DakshSCRA](https://github.com/coffeeandsecurity/DakshSCRA) и распакуйте его. ### 2. Настройка виртуального окружения > 💡 Виртуальное окружение можно создать в любом каталоге — оно не обязательно должно находиться внутри папки DakshSCRA. **Вариант A: Настройка в один шаг (рекомендуется)** ```bash python setup_env.py ``` Этот скрипт создаёт виртуальное окружение, устанавливает все зависимости и устанавливает браузер Chromium от Playwright (необходим для экспорта в PDF). **Вариант B: Ручная настройка** Windows: ```bash python -m venv daksh-env .\daksh-env\Scripts\activate ``` macOS / Linux: ```bash python3 -m venv daksh-env source daksh-env/bin/activate ``` Затем установите зависимости: ```bash cd path/to/DakshSCRA pip install -r requirements.txt playwright install chromium ``` ## Использование CLI Используйте `python` внутри виртуального окружения или `python3` вне его. ### Параметры командной строки ``` usage: dakshscra.py [-h] [-r RULES] [-f FILE_TYPES] [-v] [-t TARGET_DIR] [-l {R,RF}] [--recon] [--rs] [--estimate] [-rpt FORMATS] [--pdf-from-json] [--json-input-dir PATH] [--pdf-output PATH] [--pdf-multi-dir PATH] [--pdf-single-only] [--skip-analysis] [--loc] [--baseline-file PATH] [--baseline-generate] [--no-baseline] [--review-config PATH] [--resume-scan] [--state-file PATH] [--no-state] [--state] ``` | Опция | Описание | |---|---| | `-r RULES` | Правила платформы (например, `php`, `java`, `php,java`) или `auto` для автоопределения | | `-f FILE_TYPES` | Переопределить типы файлов по умолчанию для сканирования | | `-v` | Уровень подробности (`-v`, `-vv`, `-vvv`) | | `-t TARGET_DIR` | Каталог с исходным кодом цели | | `-l {R,RF}` | Список правил платформ + фреймворков `[R]` или с включением типов файлов `[RF]` | | `--recon` | Запустить разведку (определение платформы / фреймворка / языка) | | `--rs`, `--recon-strict` | Строгая разведка: только обнаружения с высокой достоверностью (использовать с `--recon`) | | `--estimate` | Оценить трудозатраты на проверку кода исходя из размера кодовой базы | | `-rpt`, `--report FORMATS` | Форматы отчётов: `html`, `pdf`, `docx`, `json` или их комбинация через запятую (по умолчанию: `html`) | | `--pdf-from-json` | Создать PDF-отчёт(ы) из существующих JSON-выводов без повторного сканирования | | `--json-input-dir PATH` | Каталог JSON-отчётов (по умолчанию: `./reports/data`) | | `--pdf-output PATH` | Путь к единому PDF-файлу (по умолчанию: `./reports/scan/pdf/report.pdf`) | | `--pdf-multi-dir PATH` | Каталог для многофайловых PDF-отчётов (по умолчанию: `./reports/scan/pdf/multi-file`) | | `--pdf-single-only` | Создавать только объединённый единый PDF-файл; пропустить набор многофайловых отчётов по платформам | | `--skip-analysis` | Отключить этап анализатора для этого запуска | | `--loc` | Подсчитать эффективное количество строк кода | | `--baseline-file PATH` | Файл базовой линии подавления (JSON) | | `--baseline-generate` | Создать базовую линию подавления из текущих находок | | `--no-baseline` | Отключить подавление по базовой линии для этого запуска | | `--review-config PATH` | Файл триажа находок (JSON); подавлять ранее проверенные ложные срабатывания в отчётах | | `--resume-scan` | Возобновить ранее прерванное сканирование из файла состояния | | `--state-file PATH` | Пользовательский путь к файлу состояния / контрольной точки сканирования | | `--no-state` | Отключить контрольные точки состояния сканирования для этого запуска | | `--state` | Принудительно включить контрольные точки состояния сканирования для этого запуска | ### Пример использования > `-f` (типы файлов) необязателен. Если не указан, DakshSCRA использует типы файлов по умолчанию для выбранной платформы(платформ). ```bash # Single platform scan python dakshscra.py -r php -t /path/to/source # Multiple platforms python dakshscra.py -r php,java,cpp -t /path/to/source # Auto-detect platform and apply matching rules python dakshscra.py -r auto -t /path/to/source # Override filetypes python dakshscra.py -r php -f dotnet -t /path/to/source # Reconnaissance only (no scanning) python dakshscra.py --recon -t /path/to/source # Reconnaissance + scanning python dakshscra.py --recon -r php -t /path/to/source # Strict recon (high-confidence detections only) python dakshscra.py --recon --rs -t /path/to/source # Effort estimation python dakshscra.py --estimate -t /path/to/source # Scan with HTML + PDF report output python dakshscra.py -r auto -t /path/to/source -rpt html,pdf # Verbosity levels python dakshscra.py -r php -v -t /path/to/source # default python dakshscra.py -r php -vvv -t /path/to/source # show all pattern checks # Generate suppression baseline from current findings python dakshscra.py -r auto -t /path/to/source --baseline-generate # Apply suppression baseline (suppress known FPs) python dakshscra.py -r auto -t /path/to/source --baseline-file config/suppressions.json # Disable baseline for this run python dakshscra.py -r auto -t /path/to/source --no-baseline # Apply findings triage / review config python dakshscra.py -r auto -t /path/to/source --review-config config/review.json # Scan with checkpoint state enabled python dakshscra.py -r auto -t /path/to/source --state # Resume an interrupted scan python dakshscra.py -r auto -t /path/to/source --resume-scan # Resume with a custom state file python dakshscra.py -r auto -t /path/to/source --resume-scan --state-file runtime/scan_state.json # Generate PDF from existing JSON outputs (no re-scan) python dakshscra.py --pdf-from-json # Generate PDF from a custom JSON directory python dakshscra.py --pdf-from-json --json-input-dir ./custom/reports/data # Custom output paths for PDF ``` --- [Read more](https://github.com/coffeeandsecurity/dakshscra)