adevinta/vulcan-results

Vulcan Results Service 镜像文档

镜像概述

Vulcan Results Service是一个用于存储和管理漏洞报告、检查日志的服务，支持通过配置文件或环境变量进行自定义配置，提供HTTP接口，并集成AWS S3存储以持久化报告、日志等数据。该服务适合在漏洞扫描或安全检查系统中使用，用于集中存储和管理扫描结果及相关日志。

核心功能与特性

• 灵活配置：支持TOML格式配置文件和环境变量两种配置方式
• HTTP服务：可自定义监听端口，提供HTTP接口
• 调试模式：支持启用调试模式便于问题排查
• AWS S3集成：支持配置多个S3存储桶，分别用于存储报告、日志等数据
• 链接基础URL：可配置基础URL用于生成报告链接

使用场景

适用于安全扫描平台、漏洞管理系统等场景，用于集中存储、管理和访问漏洞扫描报告、检查日志，确保安全检查结果的可靠存储和便捷访问。

配置说明

配置文件示例（TOML格式）

toml
# 结果日志存储文件路径，留空或删除则输出至STDOUT
LogFile = ""
# HTTP服务监听端口
Port = 8888
# 调试模式开关
Debug = true

[Storage]
# AWS区域
Region = "eu-west-1"
# 漏洞报告存储桶名称
BucketVulnerableReports = "my-vulnerable-reports-bucket"
# 报告存储桶名称
BucketReports = "my-reports-bucket"
# 检查日志存储桶名称
BucketLogs = "my-check-logs-bucket"
# 基础链接URL
LinkBase = "http://example.com/v1"

环境变量说明

Docker部署

构建镜像

bash
docker build . -t vr

运行容器

使用环境变量文件自定义配置

1. 创建环境变量文件 local.env，内容示例：

   PORT=8080
   DEBUG=true
   AWS_REGION=eu-west-1
   BUCKET_REPORTS=bucket-reports
   BUCKET_LOGS=bucket-logs
   LINK_BASE=http://results/v1
   

2. 运行容器：

   bash
   docker run --env-file ./local.env vr
   

使用自定义配置文件

1. 创建自定义配置文件 custom.toml（参考配置文件示例格式）

2. 运行容器并挂载配置文件：

   bash
   docker run -v $(pwd)/custom.toml:/app/config.toml vr