openrmf-api-read 镜像文档

概述

openrmf-api-read是openRMF的Read API，用于读取检查清单及其存储的所有元数据，提供多个GET接口，支持检查清单、系统数据的查询、下载与导出等操作。

核心功能和特性

API端点列表

该API提供以下GET接口：

检查清单相关

• GET /：列出所有记录
• GET /artifact/{id}：获取检查清单记录
• GET /download/{id}：下载检查清单的CKL文件（用于STIG查看器）
• GET /export/{id}：将检查清单导出为彩色编码的XLSX格式
• GET /{id}/control/{control}：获取特定控制类型的所有漏洞ID（用于合规生成视图）

系统相关

• GET /systems：获取所有系统列表
• GET /systems/{systemGroupId}：获取系统的所有检查清单
• GET /system/{systemGroupId}：获取系统记录
• GET /system/export/{systemGroupId}：获取系统所有检查清单的XLSX列表
• GET /system/{systemGroupId}/downloadnessus：下载NESSUS ACAS结果文件
• GET /system/{systemGroupId}/nessuspatchsummary：下载Nessus ACAS补丁摘要XLSX
• GET /system/{systemGroupId}/exportnessus：导出NESSUS ACAS结果文件
• GET /system/{systemGroupId}/testplanexport：创建XLSX格式的测试计划
• GET /system/{systemGroupId}/poamexport：导出POAM（计划、行动、里程碑）
• GET /system/{systemGroupId}/rarexport：导出风险评估报告（RAR）

统计相关

• GET /count/artifacts：获取所有系统检查清单的总数
• GET /count/systems：获取所有系统的数量

消息平台

使用Synadia的NATS作为消息 backbone，支持最终一致性，当前发布以下主题：

• openrmf.score.read：获取检查清单的分数
• openrmf.compliance.cci.control：返回基于控制的漏洞ID列表
• openrmf.scores.system：获取系统中所有检查清单的分数
• openrmf.compliance.cci：获取所有CCI项目列表

可观测性

集成Jaeger Client（[***]

使用场景

适用于OpenRMF工具用户需要读取、查询、下载或导出检查清单、系统数据、合规报告等场景，满足安全合规审计、系统状态监控等需求。

使用方法

制作本地Docker镜像

make build
make latest

创建MongoDB用户

1. 连接MongoDB：

   ~/mongodb/bin/mongo 'mongodb://root:myp2ssw0rd@localhost'
   

2. 切换到admin数据库：

   use admin
   

3. 创建openrmf用户：

   db.createUser({ user: "openrmf" , pwd: "openrmf1234!", roles: ["readWriteAnyDatabase"]});
   

4. 切换到openrmf数据库并创建集合：

   use openrmf
   db.createCollection("Artifacts");
   

连接数据库集合

~/mongodb/bin/mongo 'mongodb://openrmf:openrmf1234!@localhost/openrmf?authSource=admin'

运行NATS服务器

docker run --rm --name nats-main -p 4222:4222 -p 6222:6222 -p 8222:8222 nats

注：默认运行内存模式的NATS服务器（版本1.2.0，截至2018年8月），不包含流处理功能。

环境要求

• 运行时依赖：至少使用mcr.microsoft.com/dotnet/core/aspnet:3.1镜像
• 消息中间件：NATS服务器（用于消息通信）
• 数据库：MongoDB（存储检查清单及元数据）