Команда сканирования
Запуск агента производится при помощи команды scan с возможными вариантами сканирования:
scan dir– сканирование директории;scan file– сканирование файла;scan image– сканирование контейнерного образа;scan bom– сканирование SBOM;scan <technology>- сканирование директории с применением настроек для указанной технологии;scan build– сканирование сборки.
Опции запуска
Доступные и необходимые опции запуска агента для сканирования можно посмотреть при помощи флага help.
В параметре --api_url должен быть указан полный адрес on-premise платформы. Значение для --api_token можно взять в профиле пользователя платформы.
Указание параметра --project позволит при сканировании применить политики, относящиеся к выбранному проекту.
Для указания пути к файлу сохранения SBOM необходимо добавить параметр --bom-path в запрос или назначить переменную bom-path в config-файле. По умолчанию SBOM сохраняется в директории запуска в файл bom.json.
Результаты работы
В зависимости от результата работы и параметров запуска агент возвращает соответствующий exit code:
- 0 – успешное сканирование, проблемы не были выявлены;
- 1 – в результате сканирования найдены проблемы, соответствующие настроенным политикам безопасности, необходимо действие пользователя;
- 2 – ошибка сканирования;
- 3 – пустой результат, не были найдены артефакты для анализа. Возвращается только если параметр
--block-on-empty-resultимеет значениеtrue.
Ошибки резолва
2026.35.0 Если агенту не удалось разрешить зависимости для части манифестов, список таких манифестов выводится в конце результатов сканирования под заголовком Ошибки резолва. По нему можно проверить, всё ли необходимое для разрешения зависимостей есть в сборочном окружении.
Приоритет настроек
Поскольку параметры запуска агента можно настроить несколькими способами, при одновременном использовании двух и более способов агент будет принимать параметры в следующем порядке приоритетов:
- Значение команды scan-technology (если она используется);
- Значение флага команды;
- Значение переменной окружения;
- Значение из конфиг-файла.
Запуск без участия платформы
Если параметры --api_url и --api_token не заданы, запуск сканирования будет производиться без взаимодействия с платформой CodeScoring. В результате сканирования будет сгенерирован файл SBOM, содержащий только список компонентов и их версий без обогащения дополнительной информацией.
