Перейти к основному содержимому
Версия: Текущая

Отчёты сканирования

Отчёты сохраняют область сканирования, покрытие, результаты проверки и найденные совпадения для последующего просмотра. При ручной проверке проекта начните с отчёта HTML:

php scanner /var/www/example --lite --report-only

По умолчанию сканер записывает scanner-report.html в текущий каталог. Используйте --path-report=<path>, чтобы выбрать другое расположение.

HTML-отчёт, созданный на основе тестовых файлов сканера, с итогами покрытия, уровнями серьёзности, фильтрами и найденными файламиHTML-отчёт, созданный на основе тестовых файлов сканера, с итогами покрытия, уровнями серьёзности, фильтрами и найденными файлами

Обзор разделяет обнаруженные, подходящие, просканированные, кэшированные, проверенные и пропущенные файлы. Это помогает понять, было ли покрыто нужное проектное содержимое. Итоги по уровню серьёзности обобщают находки. Используйте текстовый поиск и фильтры серьёзности, затем проверяйте каждый фрагмент в контексте исходного файла перед действием.

Режимы отчётов

ОпцияПоведение
--reportСохраняет отчёт и оставляет интерактивные действия
--report-only, -rСохраняет отчёт и отключает интерактивные действия
--disable-report, --no-reportЗапрещает создание отчёта

Используйте --report-only для первого сканирования или автоматической задачи, которая не должна изменять просканированные файлы.

Форматы отчётов

Задайте формат с помощью --report-format=<format>:

ФорматНазначение
htmlПросмотр в браузере с темами светлой и тёмной, поиском и фильтрами серьёзности
txtПереносимые сводки для терминалов и текстовых архивов
jsonПодробные находки для скриптов и автоматической обработки
sarifИмпорт в инструменты, поддерживающие Static Analysis Results Interchange

Например, создайте JSON-отчёт по указанному пути:

php scanner /var/www/example --lite --report-only \
--report-format=json \
--path-report=/var/reports/amwscan.json

Сначала проверьте покрытие

Отчёт может не содержать находок, даже если сканер пропустил часть цели. Проверьте итоги покрытия и причины пропусков, прежде чем считать результат чистым. Ограничения архивов, нечитаемые файлы, фильтры путей, расширения и ограничения размера могут уменьшить покрытие.

Отчёты могут содержать локальные пути и совпавший код. Храните их вне общедоступного корня документов и ограничивайте доступ при сохранении в качестве артефактов сборки или передаче другому проверяющему.

Все параметры отчётов и журналов см. в справочнике CLI-команд.