API Scanner - Самостоятельное развертывание

API Scanner — это автоматизированный инструмент тестирования безопасности API, который сканирует REST и SOAP API на наличие уязвимостей, используя спецификации OpenAPI/Swagger и файлы WSDL.

Предварительные требования

• Docker Engine 20.10+
• Docker Compose v2
• Python 3.6+ (для скрипта установки)
• минимум 8 ГБ ОЗУ (рекомендуется 16 ГБ)
• 20 ГБ дискового пространства

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

1. Клонируйте этот репозиторий

git clone https://github.com/CSPF-Founder/api-scanner-docker.git
cd api-scanner-docker

2. Запустите установку

python3 setup.py

Скрипт выполнит следующие действия:

• Сгенерирует надежные случайные пароли для всех сервисов
• Автоматически определит ваш часовой пояс
• Создаст самоподписанный TLS-сертификат (или использует ваш, если он уже есть в ./certs/)
• Запишет файл конфигурации .env
• Предложит запустить стек Docker Compose

3. Откройте панель

Откройте https://localhost:4455 в вашем браузере.

Если вы используете самоподписанный сертификат, браузер покажет предупреждение безопасности — примите его.

Ручная настройка

Если вы предпочитаете настраивать вручную, а не использовать скрипт установки:

1. Скопируйте пример файла окружения:

cp .env.example .env

2. Отредактируйте .env и обновите:

   • Все пароли change_me_* на надежные случайные значения
   • CSRF_KEY случайной строкой из 32+ символов
   • ZAP_API_KEY случайной строкой
   • TRUSTED_ORIGINS вашим доменом (например, https://scanner.yourcompany.com)
   • Убедитесь, что пароли в DATABASE_URI и MONGO_DATABASE_URI соответствуют отдельным переменным паролей

3. Запустите стек:

docker compose up -d

Архитектура

Конфигурация

Вся конфигурация задается через файл .env. Смотрите .env.example для всех доступных опций.

Ключевые настройки

Постоянство данных

Все данные хранятся в именованных томах Docker:

• mariadb_data — учетные записи, роли, сессии
• mongodb_data — записи сканирований, результаты, отчеты
• scanner_data — рабочие файлы, загруженные спецификации, сгенерированные отчеты

Обновление

docker compose pull
docker compose up -d

Остановка

docker compose down

Чтобы удалить все данные (разрушительное действие):

docker compose down -v

Устранение неполадок

Проверьте логи:

docker compose logs api-scanner
docker compose logs zap

Проверьте состояние сервисов:

docker compose ps

ZAP не запускается: Убедитесь, что имеется как минимум 4 ГБ свободной ОЗУ. ZAP требуется около 3 ГБ.

Панель недоступна: Проверьте, что TLS-сертификаты находятся в ./certs/ и TRUSTED_ORIGINS соответствует вашему URL, включая порт (например, https://localhost:4455).

Ошибки подключения к базе данных: Подождите 30-60 секунд после первого запуска, чтобы базы данных инициализировались.

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

Полное руководство пользователя: https://cspf-founder.github.io/api-scanner-docker/