cccs/assemblyline-service-metadefender

MetaDefender Service Docker镜像文档

1. 镜像概述和主要用途

MetaDefender Service是Assemblyline框架的一个组件，用于与MetaDefender Core多引擎防病毒扫描引擎集成。该服务通过MetaDefender Core API将文件发送至用户部署的MetaDefender Core服务器，利用最多30种主流防病毒引擎（取决于许可证类型）对文件进行***软件扫描，并汇总展示各引擎的扫描结果。支持多MetaDefender Core部署架构，以应对高文件负载场景。

2. 核心功能和特性

• 多引擎扫描：集成最多30种防病毒引擎（取决于许可证），提升***软件检测覆盖率。
• 分布式部署支持：支持配置多个MetaDefender Core实例，实现负载均衡，提高扫描吞吐量。
• 扫描结果定制：可配置防病毒引擎屏蔽列表、签名分数修订规则，优化扫描结果展示。
• 灵活的连接控制：支持SSL证书验证开关、连接超时设置，适配不同网络环境。
• 兼容性：兼容MetaDefender Core v3/v4版本，支持在线/离线环境部署。

3. 使用场景和适用范围

• 企业级*软件检测**：需要多引擎协同扫描以降低漏报率的安全运营中心（SOC）。
• 高负载文件处理：通过多MetaDefender Core实例部署，适用于大量文件并发扫描场景（如邮件网关、文件服务器监控）。
• 定制化扫描需求：需对特定防病毒引擎结果进行过滤或分数调整的场景（如排除误报率高的引擎）。
• 混合网络环境：支持在线（自动更新病毒库）和离线（手动更新病毒库）部署模式。

4. 前置要求

• 许可证：需购买MetaDefender Core商业许可证（联系OPSWAT渠道合作伙伴获取）。
• MetaDefender Core部署：需在独立机器/VM上安装MetaDefender Core v4（Windows系统），并完成激活配置。
• 网络连通性：Assemblyline服务所在环境需能访问MetaDefender Core服务器的API端口（默认8008）。
• API密钥：从MetaDefender Core获取API密钥用于服务认证。

5. 详细使用方法和配置说明

5.1 MetaDefender Core安装

以下为MetaDefender Core v4（Windows系统） 的安装步骤：

1. 从OPSWAT Portal下载MetaDefender Core v4安装包。
2. 运行安装程序，按照向导完成安装。
3. 打开浏览器访问http://localhost:8008，通过基础配置向导激活MetaDefender Core（需输入许可证）。

5.2 MetaDefender Core优化配置

为提升扫描效率，推荐以下配置：

• 临时目录优化：将tempdirectory配置为RAMDISK（内存磁盘），参考官方文档。
• 引擎管理：在Inventory > Technologies中禁用以下引擎：
  • 数据清理引擎（Data sanitization engine）
  • 归档引擎（Archive engine）
• 数据库清理：
  • 在Settings > Data Retention中将所有数据保留选项设为最小值。
  • 更新MetaDefender Core至默认使用PostgreSQL数据库的版本，提升性能。

5.3 服务配置参数

5.4 防病毒定义更新

5.4.1 在线部署环境

1. 登录MetaDefender Core管理界面，进入Settings > Update Settings配置自动更新频率。
2. 手动更新：进入Inventory > Technologies，点击UPDATE ALL触发立即更新。

5.4.2 离线部署环境

1. 使用Update Downloader工具在联网环境下载定义更新包。
2. 将更新包传输至离线环境的指定目录。
3. 在MetaDefender Core管理界面进入Settings > Update Settings，设置更新源为FOLDER，并指定本地更新目录路径。

6. 镜像变体和标签

该镜像基于https://hub.docker.com/r/cccs/assemblyline-v4-service-base%E6%9E%84%E5%BB%BA%EF%BC%8C%E5%9F%BA%E7%A1%80%E7%8E%AF%E5%A2%83%E4%B8%BADebian 11 + Python 3.11。标签规则如下：

7. 部署方案示例

7.1 本地测试（Docker Run）

bash
docker run \
  --name assemblyline-metadefender \
  --env SERVICE_API_HOST=http://$(ip addr show docker0 | grep "inet " | awk '{print $2}' | cut -f1 -d"/"):5003 \
  --env api_key="your_metadefender_api_key" \
  --env base_url="http://metadefender-core:8008" \
  --env md_version=4 \
  --network=host \
  cccs/assemblyline-service-metadefender:stable

7.2 集成Assemblyline部署

作为Assemblyline框架的服务组件，需通过Assemblyline的服务管理界面添加，具体步骤参考https://cybercentrecanada.github.io/assemblyline4_docs/developer_manual/services/run_your_service/#add-the-container-to-your-deployment%E3%80%82

8. 相关文档

• https://cybercentrecanada.github.io/assemblyline4_docs/
• MetaDefender Core v4文档
• Update Downloader工具文档