Skip to content

Профили сканирований

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

Внимание

Профили сканирования доступны только в Enterprise версии Vampy.

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

Для того чтобы увидеть список профилей для сканирования, перейдите в раздел "Оркестрация" в левой панели

Создание профиля сканирования

Для того чтобы создать профиль сканирования, необходимо нажать кнопку "Создать" и ввести имя профиля

Теперь можно добавлять сканеры в профиль сканирования. Для этого нажмите кнопку "Добавить сканер" и в поле "Сканер" выберете сканер, который необходимо запускать

Сканер успешно добавлен. Если вам необходимо добавить еще один сканер в профиль сканирования, повторите вышеописанные действия.

Для того чтобы сохранить созданный профиль, необходимо нажать "Сохранить"

Теперь вы можете использовать созданный профиль и запускать сканирования из web интерфейса, API или Vampy Cli, используя slug профиля

Кастомизация профиля и параметров сканирований

Если вам необходимо отредактировать предустановленные настройки для предустановленных сканеров, то вы можете сделать это, изменив:

  • Используемый образ сканера
  • Команду запуска и параметры работы
  • Определить дополнительные переменные окружения

Для того чтобы изменения применились, не забудтьте нажать кнопку "Сохранить"

Добавление в профиль сканирований комерческих сканеров

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

Внимание

Для этого необходимо в первую очередь, настроить интеграцию с выбранным сканером

Для добавления коммерческого сканера в профиль сканирования нажмите "Добавить сканер" и в меню "Сканер" выберете необходимую интеграцию:

Вы так же, как и для для предустановленных сканеров можете настроить параметры запуска сканера

Профиль по умолчанию

По-умолчанию в Vampy есть профиль сканирований Initial Profile, который последовательно запустит:

  • semgrep
  • Trivy FileSystem
  • Trufflehog
  • Gitleaks

  • [semgrep]: semgrep scan --disable-version-check --json --output "${RESULTS_FILE}" --config=p/owasp-top-ten --metrics=off "${CURRENT_DIR}"

  • [Trivy FileSystem]: ivy fs --scanners vuln,secret,misconfig -f json --output "${RESULTS_FILE}" --cache-dir "${CACHE_DIR}" --db-repository "${HW_REGISTRY}/trivy/trivy-db:2" --no-progress "${SRC_DIR}"
  • [Trufflehog]: trufflehog --no-update --json filesystem "${CURRENT_DIR}" > "${RESULTS_FILE}"
  • [Gitleaks]: gitleaks dir "${CURRENT_DIR}" --report-format json --report-path "${RESULTS_FILE}" --exit-code 0

Оркестрация кастомного сканера

Механизм оркестрации позволяет запустить и автоматически отправить результаты сканирований произвольных утилит. Это может быть даже ваш самописный сканер.

Для того чтобы это сделать необходимо:

  1. Добавить в профиль сканер с типом "Custom"
  2. Указать путь до докер образа с этим сканером
  3. Указать команду на запуск
  4. Выбрать какой парсер должен использовать Vampy, чтоб распарсить результаты. Например, SARIF или SBOM

Сохранить изменения

Требования к Docker образу

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

  • curl
  • tar
  • пустой ENTRYPOINT []