Запуск сканирования через CLI#

Утилита CLI предназначена для ручного запуска сканирования системы безопасности. Она позволяет пользователям запускать процессы сканирования через командную строку, передавая различные параметры для настройки процесса.

Сценарий Просмотр журнала сканирований реализует следующие сценарии:

Основной сценарий.
Исключительные сценарии.
Альтернативные сценарии.

Предусловия#

Перед началом использования утилиты CLI убедитесь, что установлена среда разработки.

Для работы с утилитой необходим установленный пакет SDK и настроенная окружающая среда.

Основной сценарий#

Открыть терминал.
Перейти в рабочую директорию
```
   cd /path/to/cli_directory
```
Запустить сканирование
```
   ./asoc scan start -p parameter_value
```
parameter_value — конкретные параметры, которые зависят от среды и требований.
Настроить параметры через конфигурационный файл
```
   scan:
     level: detailed
     output: xml
```
Запустить сканирование с использованием конфигурации
```
   ./asoc scan start --config=config.yaml
```
Проверить статус сканирования
```
   ./asoc scan status -s scan_id
```

Исключительные сценарии#

Отсутствие прав доступа#

Если команда ./asoc scan start выдает ошибку Access denied, проверьте наличие прав администратора и попробуйте запустить терминал с правами суперпользователя:

   sudo ./asoc scan start -p parameter_value

Некорректные параметры#

Если команда завершается ошибкой Incorrect parameters, проверьте правильность введенных параметров.

Альтернативные сценарии#

Локальное тестирование#

Для проверки настроек перед отправкой данных на сервер выполните тестовую проверку:

   ./asoc scan view

Эта команда имитирует запуск сканирования, но не передает данные на сервер.

Конфигурационные файлы#

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

Пример структуры конфигурационного файла. Этот файл можно передать команде scan start через флаг -c или --config.

Интеграция с CI/CD системами#

Утилита CLI подходит для интеграции с системами непрерывной интеграции и доставки (CI/CD), такими как Jenkins.

Пример интеграции с Jenkins

Этот скрипт запускает сканирование и проверяет его статус в рамках одного пайплайна.

Основные команды и флаги#

Команда/Флаг	Пример использования	Допустимые значения	Описание
`./asoc -h`	Показывает справку по доступным командам и флагам	`-`	Справочная информация по использованию утилиты
`./asoc scan -h`	Показывает справочную информацию по команде `scan`	`-`	Подробности по использованию команды `scan`
`./asoc scan view -h`	Показывает справочную информацию по команде `scan view`	`-`	Подробности по использованию команды `scan view`
`./asoc scan start -h`	Показывает справочную информацию по команде `scan start`	`-`	Подробности по использованию команды `scan start`
`./asoc init -h`	Показывает справочную информацию по команде инициализации конфигурации	`-`	Подробности по созданию конфигурационного файла
`start`	`./asoc scan start`	`-`	Выполнение старта сканирования
`view`	`./asoc scan view`	Нет	Просмотр параметров сканирования без запуска
`--bom`	`./asoc scan start --bom=/path/to/bom/file`	`/path/to/bom/file`	Указание BOM файла для сканирования. Может использоваться многократно
`--compliance`	`./asoc scan start --compliance=/path/to/compliance/file`	`/path/to/compliance/file`	Указание BOM файла для сканирования compliance. Может использоваться многократно
`--exclusion`	`./asoc scan start --exclusion="/.git/"`	`"/.git/"`	Исключение определенных файлов и директорий при упаковке архива. Может использоваться многократно
`--folder`	`./asoc scan start --folder="/path/to/source/folder"`	`"/path/to/source/folder"`	Указание директорий для сканирования. Может использоваться многократно
`--keep`	`./asoc scan start --keep=true`	`true`, `false`	Сохранение архива с результатами сканирования после завершения
`--config`	`./asoc scan start --config=config.yaml`	`path/to/config.yaml`	Указание пути к конфигурационному YAML-файлу
`--log-level`	`./asoc scan start --log-level=debug`	`error`/`err`, `warn`, `info`, `debug`, `trace`	Установка уровня логирования
`--no-banner`	`./asoc scan start --no-banner`	`-`	Скрытие баннера при выполнении команды
`--orch-auth-basic-password`	`./asoc scan start --orch-auth-basic-password=<your_password>`	`<password>`	Указание пароля для базисной аутентификации в ASOC Orchestrator
`--orch-auth-basic-username`	`./asoc scan start --orch-auth-basic-username=<your_username>`	`<your_username>`	Указание имени пользователя для базисной аутентификации в ASOC Orchestrator
`--orch-auth-header-scheme`	`./asoc scan start --orch-auth-header-scheme=Bearer`	`Bearer`	Указание схемы аутентификации для заголовка в ASOC Orchestrator
`--orch-auth-header-token`	`./asoc scan start --orch-auth-header-token=<your_token>`	`<your_token>`	Указание токена для аутентификации в заголовке в ASOC Orchestrator
`--orch-host`	`./asoc scan start --orch-host=https://orchestrator-asoc.example.com`	`https://orchestrator-asoc.example.com`	Указание адреса сервера ASOC Orchestrator
`--orch-http-debug`	`./asoc scan start --orch-http-debug`	`-`	Включить HTTP отладку для ASOC Orchestrator
`--orch-retry-count`	`./asoc scan start --orch-retry-count=5`	`5`	Установить количество попыток подключения к ASOC Orchestrator
`--orch-retry-interval`	`./asoc scan start --orch-retry-interval=10s`	`10s`	Установить интервал ожидания между попытками подключения к ASOC Orchestrator
`--orch-skip-verify`	`./asoc scan start --orch-skip-verify`	`-`	Пропустить проверку SSL сертификата для ASOC Orchestrator
`--orch-timeout`	`./asoc scan start --orch-timeout=30s`	`30s`	Установить тайм-аут для соединений с ASOC Orchestrator
`--point`	`./asoc scan start --point=build-point`	`build-point`	Указание точки интеграции для сканирования
`--project`	`./asoc scan start --project=ASOC`	`ASOC`	Указание ключа проекта для сканирования
`--store-auth-basic-password`	`./asoc scan start --store-auth-basic-password=<your_store_password>`	`<your_store_password>`	Указание пароля для базисной аутентификации в ASOC Project Store
`--store-auth-basic-username`	`./asoc scan start --store-auth-basic-username=<your_store_username>`	`<your_store_username>`	Указание имени пользователя для базисной аутентификации в ASOC Project Store
`--store-auth-header-scheme`	`./asoc scan start --store-auth-header-scheme=Bearer`	`Bearer`	Указание схемы аутентификации для заголовка в ASOC Project Store
`--store-auth-header-token`	`./asoc scan start --store-auth-header-token=<your_store_token>`	`<your_store_token>`	Указание токена для аутентификации в заголовке в ASOC Project Store
`--store-host`	`./asoc scan start --store-host=https://project-store-asoc.example.com`	`https://project-store-asoc.example.com`	Указание адреса сервера ASOC Project Store
`--store-http-debug`	`./asoc scan start --store-http-debug`	`-`	Включить HTTP отладку для ASOC Project Store
`--store-retry-count`	`./asoc scan start --store-retry-count=5`	`5`	Установить количество попыток подключения к ASOC Project Store
`--store-retry-interval`	`./asoc scan start --store-retry-interval=10s`	`10s`	Установить интервал ожидания между попытками подключения к ASOC Project Store
`--store-skip-verify`	`./asoc scan start --store-skip-verify`	`-`	Пропустить проверку SSL сертификата для ASOC Project Store
`--store-timeout`	`./asoc scan start --store-timeout=30s`	`30s`	Установить тайм-аут для соединений с ASOC Project Store
`--tenant`	`./asoc scan start --tenant=mycompany`	`mycompany`	Указание ключа тенанта для сканирования
`--version`	`./asoc scan start --version=test-kse-excl-1`	`test-kse-excl-1`	Указание версии сканирования

Пример справки утилиты ASOC CLI с описанием флагов и команд.

Пример вывода справки команды ./asoc scan -h

Пример вывода справки команды ./asoc scan view -h

Пример вывода справки команды ./asoc scan start -h

Пример вывода глобальной справки утилиты asoc

Пример вывода справки команды ./asoc init -h