cccs/assemblyline-socketio

Assemblyline 4 - API 和 Socket IO 服务器

镜像概述和主要用途

该组件为 Assemblyline 4 框架提供用户界面(UI)、各类 API 接口以及 SocketIO 端点服务。作为 Assemblyline 框架的核心组件，它是用户与系统交互的主要接口，同时也是系统集成和自动化操作的关键入口点。

核心功能和特性

API 接口

Assemblyline 4 提供了丰富的 API 集合，可提供与 UI 相同甚至更多的信息。所有 API 接口均遵循统一的响应格式，确保交互一致性。API 列表及其功能可在 UI 的帮助部分查看。

所有 API 响应格式统一为：

json
{
  "api_response": {},             // API 的实际响应数据
  "api_error_message": "",        // 错误响应时的错误消息
  "api_server_version": "4.0.0",  // Assemblyline 版本及各组件版本
  "api_status_code": 200          // 响应状态码
}

注意：所有响应代码均返回此输出格式。

SocketIO 端点

Assemblyline 4 还提供一系列 SocketIO 端点，用于实时获取系统信息。这些端点提供对多个 Redis 广播队列的认证访问，使系统能够主动通知用户有关系统变更和健康状态，无需用户主动查询。

可监听的队列包括：

• 新创建的告警
• 已接收的提交任务
• 系统健康状态
• 指定运行中提交任务的状态

镜像变体和标签

使用场景和适用范围

• 安全分析人员：通过 UI 界面访问 Assemblyline 4 功能，监控和分析安全事件
• 系统集成商：利用 API 接口将 Assemblyline 4 集成到现有安全工作流或 SIEM 系统
• 自动化脚本：通过 API 实现自动化提交样本、查询结果和生成报告
• 实时监控：使用 SocketIO 端点构建实时监控仪表板或告警系统

详细使用方法和配置说明

API 响应格式

所有 Assemblyline API 均返回一致的 JSON 响应格式：

json
{
  "api_response": {},             // API 的实际响应数据
   "api_error_message": "",       // 错误响应时的错误消息 
  "api_server_version": "4.0.0", // Assemblyline 版本及组件版本 
  "api_status_code": "200"       // HTTP状态码 
}

注意 :无论响应状态如何，所有 API 调用均返回上述格式

SocketIO 可监听队列

• 告警创建通知
• 文件提交状态更新
• 系统健康状态
• 指定提交任务的实时状态

Docker 部署方案示例

运行 UI 组件

bash
docker run --name assemblyline-ui -d cccs/assemblyline-service-ui:latest

运行 SocketIO 组件

bash
docker run --name assemblyline-socketio -d cccs/assemblyline-service-socketio:latest

Docker Compose配置示例

yaml
version: '3'
services:
 assemblyline-ui:
   image: cccs/assemblyline-service-ui:stable
   container_name: assemblyline-ui
   restart: always
   ports:
     - "80:80"
   environment:
     - LOG_LEVEL=info
 
 assemblyline-socketio:
   image: cccs/assemblyline-service-socketio:stable
   container_name: assemblyline-socketio 
   restart: always
   ports:
     - "8000:8000"
   depends_on:
     - assemblyline-ui

相关文档

有关 Assemblyline 组件的更多信息，请参阅https://cybercentrecanada.github.io/assemblyline4_docs/overview/architecture/%E6%96%87%E6%A1%A3%E3%80%82

相关链接

• https://github.com/CybercentreCanada/assemblyline-ui

• ---

• https://github.com/CybercentreCanada/assemblyline-ui

许可证信息

本组件根据仓库中的 LICENSE.md 文件许可协议发布。