wurstbrot/collector-confluence

OWASP DSOMM metricCA collector-confluence 镜像文档

1. 镜像概述

OWASP DSOMM metricCA collector-confluence是OWASP DevSecOps成熟度模型（DSOMM）metricCA框架的专用指标收集器，旨在从Confluence协作平台收集与DevSecOps成熟度评估相关的数据指标。该镜像通过标准化接口对接Confluence API，提取系统配置、内容结构、权限设置等关键数据，并将其映射至DSOMM模型的评估维度，为DevSecOps成熟度分析提供基础数据支持。

2. 核心功能与特性

2.1 核心功能

• Confluence数据采集：支持从Confluence实例采集空间（Spaces）、页面（Pages）、权限配置（Permissions）、用户活动（User Activities）等关键数据
• DSOMM指标映射：内置DSOMM评估指标映射规则，可将Confluence数据转换为符合DSOMM模型的成熟度评估指标（如协作流程规范性、文档管理合规性等）
• 标准化数据输出：支持JSON、CSV等标准格式输出，便于对接DSOMM metricCA分析平台或第三方数据可视化工具
• 灵活配置能力：支持自定义采集范围（如指定空间、页面类型）、采集频率及认证方式

2.2 关键特性

• 轻量级部署：基于Alpine Linux构建，镜像体积小，资源占用低
• 安全认证支持：兼容Confluence的基本认证（Basic Auth）和API令牌认证（API Token）
• 错误处理机制：具备数据采集失败重试及异常日志记录功能
• 可扩展性：支持通过配置文件扩展自定义指标映射规则

3. 使用场景

• DevSecOps成熟度评估：作为DSOMM评估体系的数据源之一，为组织DevSecOps成熟度评分提供Confluence协作平台相关数据支撑
• Confluence配置审计：检查Confluence的权限设置、内容管理流程是否符合安全最佳实践
• 团队协作合规性检查：评估团队在Confluence上的文档协作流程是否满足内部合规要求或行业标准
• 持续监控：定期采集数据，跟踪Confluence相关指标随时间的变化趋势，支持成熟度提升的持续改进

4. 使用方法与配置说明

4.1 基本使用（Docker Run）

bash
docker run -d \
  --name dsomm-collector-confluence \
  -e CONFLUENCE_URL="https://your-confluence-instance.com" \
  -e CONFLUENCE_AUTH_TYPE="api_token" \
  -e CONFLUENCE_USERNAME="your-email@example.com" \
  -e CONFLUENCE_API_TOKEN="your-confluence-api-token" \
  -e COLLECTION_SCOPE="space:DEV,SEC" \
  -e COLLECTION_INTERVAL="3600" \
  -v ./output:/app/output \
  owasp/dsomm-metricca-collector-confluence:latest

4.2 环境变量配置

4.3 数据输出

采集完成后，指标数据将以指定格式（JSON/CSV）保存至OUTPUT_PATH路径下，文件名格式为dsomm_confluence_metrics_YYYYMMDD_HHMMSS.<format>。典型JSON输出示例：

json
{
  "collection_time": "2024-05-20T10:30:00Z",
  "confluence_instance": "https://your-confluence-instance.com",
  "metrics": [
    {
      "dsomm_dimension": "Collaboration",
      "dsomm_metric": "M2.1",
      "metric_name": "Documented Security Guidelines Availability",
      "value": 85,
      "unit": "percentage",
      "data_source": "Confluence Space: SECURITY"
    },
    // ... 更多指标
  ]
}

5. 注意事项

• 确保Confluence用户账号具备足够权限（至少需"读取"目标空间及内容的权限）
• API令牌认证需Confluence版本≥7.14.0，低版本请使用基本认证
• 大规模Confluence实例建议通过COLLECTION_SCOPE限制采集范围，避免性能影响
• 采集数据包含潜在敏感信息，建议通过卷挂载方式将输出目录映射至安全存储位置，并限制容器文件系统访问权限