Быстрый старт

См. 00_quick_start.md для пошаговых инструкций.

Назначение инструмента

depalert — это CLI для CI/CD, который:

1. Загружает SBOM в CTWall (POST /api/v1/ingest)
2. Ожидает синхронно вердикта ревизии (GET /api/v1/tests/{testId}/revisions/{revisionId}/depalert-verdict)
3. Возвращает удобный для конвейера результат и код возврата

Инструмент ограничен рамками проекта. Вы можете выбрать целевой проект по:

• project-id (UUID), или
• project-name (разрешается через API).

Если указаны оба, project-id имеет приоритет.

Результаты DepAlert

DepAlert возвращает один результат для ревизии:

• CLEAN — вредоносных программ не обнаружено — exit 0
• MALWARE — обнаружена хотя бы одна вредоносная находка в ревизии — exit 1
• UNKNOWN — анализ ещё не завершён — exit 2 (или exit 0 с fail-on=NONE)

Формат вывода CLI:

Режим JSON доступен через --format json (или CTWALL_OUTPUT=json).

Пример вывода JSON:

Ожидаемый результат

• код возврата 0 = успешно
• код возврата 1 = нарушение политики или ошибка выполнения
• код возврата 2 = окончательный вердикт UNKNOWN и fail-on не равен NONE

Конфигурация CLI и переменные окружения

Правила выбора проекта

• Требуется хотя бы один из параметров project-id или project-name.
• project-name разрешается с помощью GET /api/v1/projects.
• Сопоставление имен происходит без учёта регистра, точное совпадение.
• Если несколько активных проектов имеют одинаковое имя, запуск завершится ошибкой неоднозначности.
• Обязательные значения можно указать либо параметрами, либо переменными окружения; параметры имеют приоритет.

Подключение

• Для нелокальных хостов требуется https.
• Для тестовых/непроизводственных сред можно использовать:
  • --allow-insecure, или
  • CTWALL_ALLOW_INSECURE=true.
• Для самоподписанных HTTPS-сертификатов (только тестовые/непроизводственные) можно использовать:
  • --skip-tls-verify, или
  • CTWALL_SKIP_TLS_VERIFY=true.

Безопасность

Пожалуйста, смотрите

Лицензия

DepAlert лицензирован под лицензией BSD 3-Clause