hub-tool-converters

Набор конвертеров/парсеров отчетов о сканировании из формата сканера в формат AppSec.HUB

Содержимое репозитория

1. Модель отчета AppSec.Hub
2. Парсеры форматов инструментов
3. Конфиг файлы
4. Тесты

Документация

1. Общая документация по импорту отчетов
2. Схема отчета AppSec.HUB
3. Пример отчета в формате AppSec.HUB

Параметры запуска

Параметр	Описание	Обязательный
-t; --type	Тип источника (--help для просмотра всех типов)	Да
-s; --scanner	Тип сканера (если задан формат, то сканер может быть любым, иначе совпадать с одним из допустимых форматов)	Да
-f; --filename	Путь до отчета сканера	Да
-o; --output	Путь где будет создан отчет в формате AppSec.HUB	Да
-n; --name	Название репозитория в AppSec.Hub/артефакта/инстанса	Да
-u; --url	Урл репозитория/артефакта/инстанса	Да
--format	Формат входного файла (bandit, burp, checkov, gitleaks, gosec, horusec, mobsf, sarif, semgrep, spotbugs, trufflehog, svace, cyclonedx)	Нет, по умолчанию взято значение из аргумента scanner
-b; --branch	Ветка в репозитории, по которой запускалось сканирование	Нет, по умолчанию master
-c; --commit	Коммит в репозитории, по которому запускалось сканирование	Нет, по умолчанию master
-bt; --build-tool	Сборщик (--help для просмотра всех сборщиков)	Нет, по умолчанию maven
--stage	Стадия экземпляра (ST - System Test, UAT - User Acceptance Test, IAT - Integration Acceptance Test, STG - Stage, PROD - Production)	Нет

Список поддерживаемых форматов

bandit, burp, checkov, gitleaks, gosec, horusec, mobsf, sarif, semgrep, spotbugs, trufflehog, cyclonedx, kaspersky-cs, svace(только .csv, в формате .sarif запускать через sarif)

Пример запуска

1. Создание виртуального окружения и его активация

python -m venv venv && source venv/bin/activate

2. Установка зависимостей

pip install -r requirements.txt

3. Запуск конвертера

python main.py -s trufflehog -t CODEBASE -f tests/codebase/trufflehog/v3_github.json -o trufflehog_hub.json -n hub-tool-converters -u https://github.com/Swordfish-Security/hub-tool-converters.git

4. Запуск конвертера для сканера с форматом

python main.py -s pvs-studio -t CODEBASE --format sarif -f pvs-studio.sarif -o pvs-studio_hub.json -n hub-tool-converters -u https://github.com/Swordfish-Security/hub-tool-converters.git

или

python main.py -s svace -t CODEBASE --format sarif -f tests/codebase/svace/svace.sarif -o svace_hub.json -n hub-tool-converters -u https://github.com/Swordfish-Security/hub-tool-converters.git

python main.py -s kaspersky-cs -t ARTIFACT -f input-file.json -o output-file.json -n artifact_name -u https://artifact-url.rpm

Запуск тестов

1. Создание виртуального окружения и его активация

python -m venv venv && source venv/bin/activate

2. Установка зависимостей

pip install -r requirements.txt

3. Запуск тестов

python -m unittest tests/parsers.py

Вносите свой вклад

Вы можете помочь нашему сообществу внеся вклад. Им могут быть:

1. Скрипты для конвертации отчетов о сканировании для различных инструментов в AppSec.HUB
2. Улучшение документации и примеры к ней

Для этого:

1. Сделайте форк этого репозитория;
2. Внесите в нём необходимые изменения;
3. Откройте Pull Request.

Чеклист для добавления новых скриптов

• Создать файлы скрипта с кодом в уже существующей директории или создать новую (при необходимости)
• Обновить или создать README.md в директории. Необходимо указать всю важную информацию:
  • Назначение кода
  • Необходимые библиотеки
  • Способ установки и настройки