zeronorth/integration-orchestrator

integration-orchestrator 镜像文档

镜像概述和主要用途

integration-orchestrator是运行ZeroNorth本地（OnPremise）解决方案的起点。该客户端包含在本地环境启动扫描器所需的工具，用于在企业内部部署和执行安全扫描任务。通过该镜像，用户可在本地环境处理扫描任务，确保数据安全和合规性。

核心功能和特性

• 本地扫描执行：支持将扫描任务在本地环境运行，而非云端
• 扫描任务管理：能够拾取并处理Fabric门户中处于PENDING状态的扫描任务
• 配置灵活性：支持通过环境变量进行SSL验证、代理、日志等多方面配置
• artifacts挂载：允许挂载客户特定 artifacts（如证书、许可证、ZAP配置文件等）

使用场景和适用范围

适用于需要在企业内部环境（而非云端）执行安全扫描的组织，尤其适合对数据隐私和合规性有严格要求的场景。需配合ZeroNorth Fabric门户使用，完成扫描策略配置、任务管理和结果查看。

依赖环境

本地环境需满足以下最低要求：

• 至少1台Linux主机
• 已安装Docker引擎，版本要求17.12及以上
• 已通过ZeroNorth销售代表获取DockerHub集成账户认证权限

配置与使用方法

1. Fabric门户设置

1. 登录ZeroNorth Fabric门户，完成以下对象的配置：

   • Integration（集成）
   • Scenario（场景）
   • Target（目标）
   • Policy（策略）

2. 创建Integration对象时，需将Scan Execution设置为local，否则策略无法正确运行。

3. 验证配置：

   • 向policies/{policyId}/run发送POST请求，获取有效的jobId
   • 运行integration-orchestrator后，通过GET /onprem/jobs接口应能看到该jobId的任务（状态为PENDING）

2. 应用配置

获取用户令牌

在Fabric门户中，通过Profile → User Tokens部分获取用户令牌（JWT）。

配置env.local文件

创建或编辑env.local文件，设置以下必要参数：

CYBRIC_JWT={YOUR_JWT}  # 替换为从Fabric门户获取的用户令牌
DOCKER_HUB_USERNAME={你的DockerHub用户名}  # 需已加入白名单
DOCKER_HUB_PASSWORD={你的DockerHub密码}  # 需已加入白名单

3. Docker运行命令

使用以下命令启动integration-orchestrator容器：

bash
docker run -it \
  -v /shared:/shared \
  -v /var/run/docker.sock:/var/run/docker.sock \
  --env-file ./env.local \
  zeronorth/integration-orchestrator:latest \
  '/app/run.sh'

说明：若Docker sock文件路径不同，需修改-v /var/run/docker.sock:/var/run/docker.sock中的本地路径。

高级配置

SSL验证设置

默认启用SSL验证，若需禁用，在env.local中添加：

CYBRIC_VERIFY_SSL=0

代理支持

若在代理环境下运行，在env.local中设置以下相关参数（不需要的参数需完全删除）：

HTTP_PROXY=代理服务器地址:端口
HTTPS_PROXY=代理服务器地址:端口
FTP_PROXY=代理服务器地址:端口
NO_PROXY=不需要代理的地址列表（逗号分隔）

日志级别和格式

通过以下环境变量配置日志：

• 日志格式：LOGGER_SERIALIZER

  • 可选值：TEXT、SIMPLE、BUNYAN（默认）

• 日志级别：LOGGER_LEVEL

  • 可选值：DEBUG、INFO（默认）、WARNING、ERROR、CRITICAL

配置示例：

LOGGER_SERIALIZER=TEXT
LOGGER_LEVEL=DEBUG

挂载CUSTOMER_ARTIFACTS_PATH

需挂载包含客户特定 artifacts 的文件夹，文件夹结构需符合以下规范：

客户证书（PEM格式）

customer_artifacts_folder/certificates/certificate  # 证书文件名必须为certificate

工具扫描许可证

customer_artifacts_folder/license/<License Name>  # <License Name>需与ZeroNorth平台上创建的许可证名称一致

ZAP配置文件

customer_artifacts_folder/authScript/<Artifact Name>  # 认证脚本，<Artifact Name>与平台上创建的 artifact 名称一致
customer_artifacts_folder/context/<Artifact Name>     # 上下文文件
customer_artifacts_folder/urlFile/<Artifact Name>     # URL文件

ZAP主机文件

customer_artifacts_folder/hosts/<Hosts file name>  # 文件名需与平台上创建的主机文件名称一致