openrmf-api-template

概述和主要用途

openrmf-api-template是OpenRMF的模板API，用于上传和保存CKL文件作为模板，并提供一系列模板管理功能。该API包含多个端点，支持模板的创建、查询、更新、删除和下载，同时加载XCCDF文件作为系统模板，供后续上传SCAP扫描（XCCDF）文件生成检查清单使用。

核心功能和特性

• 模板管理端点：
  • POST /：保存新检查清单
  • PUT /{id}：更新检查清单内容（保留其他信息）
  • GET /：获取所有模板列表
  • GET /{id}：获取特定模板
  • GET /download/{id}：获取模板的CKL文件
  • DELETE /{id}：删除模板
  • GET /checklistupdate/system/{systemGroupId}/artifact/{artifactId}：检查是否需要更新
  • GET /count/templates：获取所有用户模板数量
  • GET /count/systemtemplates：获取所有系统生成模板数量（来自手动XCCDF文件）
• API结构文档：通过/swagger/访问API结构说明

使用场景和适用范围

适用于OpenRMF工具中需要管理模板的场景，特别是需要通过API上传、保存、查询、更新、删除CKL文件模板，以及统计模板数量的用户。同时支持系统模板（XCCDF文件）的管理，为后续生成SCAP扫描检查清单提供基础。

使用方法和配置说明

本地Docker镜像构建

执行以下命令构建本地Docker镜像：

docker build --rm -t openrmf-api-template:0.13 .

MongoDB用户创建

1. 连接MongoDB（假设MongoDB安装在~/mongodb/目录）：

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

2. 切换到admin数据库：

   use admin
   

3. 创建用户openrmftemplate并授权：

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

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

   use openstigtemplate
   db.createCollection("Templates");
   

直接连接数据库集合

使用以下命令直接连接到数据库集合：

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