docker/oscalkit

oscalkit

![CircleCI]([] ![codecov]([] ![GoDoc]([***]

开发中。由于OSCAL标准仍在积极开发中，如果使用包含的CLI工具处理基于不支持的模式迭代开发的OSCAL文档，可能会发生解析错误。oscalkit的各个https://github.com/docker/oscalkit/releases%E5%B0%86%E5%9C%A8%E8%AF%B4%E6%98%8E%E4%B8%AD%E6%8C%87%E5%87%BA%E8%AF%A5%E5%B7%A5%E5%85%B7%E9%92%88%E5%AF%B9usnistgov/OSCAL%E4%BB%93%E5%BA%93%E7%9A%84%E5%93%AA%E4%BA%9B%E6%8F%90%E4%BA%A4%E8%BF%9B%E8%A1%8C%E4%BA%86%E6%B5%8B%E8%AF%95%E3%80%82

用于开放安全控制评估语言（OSCAL）的基础Go SDK，该语言由美国国家标准与技术研究院（NIST）开发。还包含一个CLI工具，用于处理OSCAL文档、在OSCAL格式的XML、JSON和YAML之间转换，以及将OpenControl项目转换为OSCAL。该工具还支持从OSCAL格式的目录和配置文件生成Go源代码。

OSCAL标准的文档可在[***]

支持的OSCAL组件

目前支持以下OSCAL组件：

安装

您可以从https://github.com/docker/oscalkit/releases%E9%A1%B5%E9%9D%A2%E4%B8%8B%E8%BD%BD%E9%80%82%E7%94%A8%E4%BA%8E%E6%82%A8%E7%B3%BB%E7%BB%9F%E7%9A%84%60oscalkit%60%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7%E3%80%82%E5%B0%86%E5%85%B6%E7%A7%BB%E5%8A%A8%E5%88%B0%60$PATH%60%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E4%B8%AD%E5%88%97%E5%87%BA%E7%9A%84%E9%80%82%E5%BD%93%E7%9B%AE%E5%BD%95%E3%80%82macOS%E8%BF%98%E6%8F%90%E4%BE%9BHomebrew%E9%85%8D%E6%96%B9%EF%BC%8C%E5%90%8C%E6%97%B6https://hub.docker.com/r/docker/oscalkit/%E5%B7%B2%E5%8F%91%E5%B8%83%E5%88%B0Docker Hub。

Homebrew

bash
$ brew tap docker/homebrew-oscalkit
$ brew install oscalkit

Docker

运行oscalkit Docker容器需要绑定挂载包含源文件的目录，或通过stdin将文件内容传递给命令。

bash
$ docker pull docker/oscalkit:0.2.0
$ docker run -it --rm -v $PWD:/data -w /data docker/oscalkit:0.2.0 convert oscal-core.xml

通过stdin：

bash
$ docker run -it --rm docker/oscalkit:0.2.0 convert < oscal-core.xml

使用方法

NAME:
   oscalkit - OSCAL工具包

USAGE:
   oscalkit [全局选项] 命令 [命令选项] [参数...]

VERSION:
   0.2.0


COMMANDS:
     convert         在一种或多种OSCAL文件格式之间转换，以及从OpenControl格式转换
     validate        根据OSCAL XML和JSON模式验证文件
     sign            签名OSCAL JSON工件
     generate        根据提供的配置文件生成go代码
     implementation  根据提供的配置文件和Excel表格生成实现的go代码
     help, h         显示命令列表或单个命令的帮助

GLOBAL OPTIONS:
   --debug, -d    启用调试命令输出
   --help, -h     显示帮助
   --version, -v  打印版本

在XML和JSON之间转换

oscalkit可用于将一个或多个源文件在OSCAL格式的XML和JSON之间转换。

NAME:
   oscalkit convert oscal - 在一种或多种OSCAL文件格式之间转换

USAGE:
   oscalkit convert oscal [命令选项] [源文件...]

DESCRIPTION:
   在OSCAL格式的XML和JSON文件之间转换。该命令接受一个或多个源文件路径，也可与通过STDIN管道/重定向的源文件内容一起使用。

OPTIONS:
   --output-path value, -o value  转换文件的输出路径。默认为当前工作目录
   --output-file value, -f value  来自STDIN的转换输出的文件名。默认为"stdin.<json|xml|yaml>"
   --yaml                         如果源文件格式为XML或JSON，也生成等效的YAML输出

示例

将OSCAL格式的NIST 800-53声明从XML转换为JSON：

bash
$ oscalkit convert oscal SP800-53-declarations.xml

通过STDIN将OSCAL格式的NIST 800-53声明从XML转换为JSON（注意使用"-"）：

bash
$ cat SP800-53-declarations.xml | oscalkit convert oscal -

使用JWS签名OSCAL JSON

oscalkit可用于使用JSON Web签名（JWS）对OSCAL格式的JSON工件进行签名。

NAME:
   oscalkit sign - 签名OSCAL JSON工件

USAGE:
   oscalkit sign [命令选项] [文件...]

OPTIONS:
   --key value, -k value  用于签名的私钥文件。必须为PEM或DER格式。支持RSA/EC密钥和包含RSA/EC密钥的X.509证书
   --alg value, -a value  签名算法。支持RSASSA-PKCS#1v1.5、RSASSA-PSS、HMAC、ECDSA和Ed25519

支持以下签名算法：

示例

使用PEM编码的私钥文件和PS256签名算法签名OSCAL格式的JSON：

bash
$ oscalkit sign --key jws-example-key.pem --alg PS256 NIST_SP-800-53_rev4_catalog.json

从OpenControl项目转换为OSCAL [实验性]

此功能已暂时禁用，等待https://github.com/usnistgov/OSCAL/issues/216%E5%92%8Chttps://github.com/usnistgov/OSCAL/issues/215%E8%A7%A3%E5%86%B3

oscalkit还支持将OpenControl项目转换为OSCAL格式的JSON。您需要opencontrol.yaml文件的路径和运行compliance-masonry get命令时创建的opencontrols/目录。

NAME:
   oscalkit convert opencontrol - 从OpenControl格式转换为OSCAL"实现"格式

USAGE:
   oscalkit convert opencontrol [命令选项] [opencontrol.yaml文件路径] [opencontrols目录路径]

DESCRIPTION:
   将OpenControl格式的"组件"和"OpenControl"YAML转换为OSCAL格式的"实现"层JSON

OPTIONS:
   --yaml, -y  除JSON外还生成YAML
   --xml, -x   除JSON外还生成XML

示例

将OpenControl项目转换为OSCAL格式的JSON：

bash
$ oscalkit convert opencontrol ./opencontrol.yaml ./opencontrols/

根据XML和JSON模式验证

该工具支持根据相应的OSCAL XML模式（.xsd）和JSON模式验证OSCAL格式的XML和JSON文件。XML模式验证需要本地机器上的xmllint工具（macOS和Linux包含，Windows安装说明此处）。

NAME:
   oscalkit validate - 根据OSCAL XML和JSON模式验证文件

USAGE:
   oscalkit validate [命令选项] [文件...]

DESCRIPTION:
   根据特定XML模式（.xsd）验证OSCAL格式的XML文件，或根据特定JSON模式验证OSCAL格式的JSON文件

OPTIONS:
   --schema value, -s value  用于验证的模式文件

示例

根据相应的JSON模式验证OSCAL格式JSON中的FedRAMP配置文件：

bash
$ oscalkit validate -s oscal-core.json fedramp-annotated-wrt-SP800-53catalog.json

开发

oscalkit使用Go（1.11+）开发。如果安装了Docker，包含的Makefile可用于运行单元测试并为Linux、macOS和Windows编译应用程序。否则，可使用原生Go工具链。

依赖管理

依赖项使用https://github.com/golang/go/wiki/Modules%E7%AE%A1%E7%90%86%E3%80%82%E5%8C%85%E5%90%AB%E4%BE%9D%E8%B5%96%E9%A1%B9%E7%9A%84%60vendor/%60%E6%96%87%E4%BB%B6%E5%A4%B9%E4%B8%8E%E6%BA%90%E4%BB%A3%E7%A0%81%E4%B8%80%E8%B5%B7%E7%AD%BE%E5%85%A5%EF%BC%8C%E4%BB%A5%E5%90%91%E5%90%8E%E5%85%BC%E5%AE%B9%E6%97%A7%E7%89%88%E6%9C%AC%E7%9A%84Go%E3%80%82%E5%BD%93%E4%BD%BF%E7%94%A8%E5%90%AF%E7%94%A8%60GO111MODULE=on%60%E7%9A%84Go 1.11时，可按如下方式验证依赖项：

bash
$ go mod verify

编译

您可以使用包含的Makefile为您的操作系统生成二进制文件（需要Docker）：

为Linux编译：

bash
$ GOOS=linux GOARCH=amd64 make

为macOS编译：

bash
$ GOOS=darwin GOARCH=amd64 make

为Windows编译：

bash
$ GOOS=windows GOARCH=amd64 make

网站和文档

网站和相应文档均在docs/中开发。内容使用Hugo框架开发。静态内容生成并发布在docs/public中，这是一个独立的Git工作树，绑定到https://github.com/docker/oscalkit/tree/gh-pages%E5%88%86%E6%94%AF%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87https://docker.github.io/oscalkit%E5%85%AC%E5%BC%80%E8%AE%BF%E9%97%AE%E3%80%82

SDK的GoDoc可在此处找到。

发布

GoReleaser工具用于将oscalkit发布到GitHub Releases。目前支持以下发布工件：

• OSX二进制文件
• Linux二进制文件
• Windows二进制文件
• Docker镜像
• Homebrew配方===SHORT_DESC=== 基于Go的NIST OSCAL SDK和CLI工具，支持OSCAL文档在XML、JSON和YAML间转换，将OpenControl项目转为OSCAL格式，以及从OSCAL目录和配置文件生成Go源代码，适用于安全控制评估语言相关文档处理。 ===FULL_DESC===# oscalkit

![CircleCI]([] ![codecov]([] ![GoDoc]([***]

开发中。由于OSCAL标准仍在积极开发中，如果使用包含的CLI工具处理基于不支持的模式迭代开发的OSCAL文档，可能会发生解析错误。oscalkit的各个https://github.com/docker/oscalkit/releases%E5%B0%86%E5%9C%A8%E8%AF%B4%E6%98%8E%E4%B8%AD%E6%8C%87%E5%87%BA%E8%AF%A5%E5%B7%A5%E5%85%B7%E9%92%88%E5%AF%B9usnistgov/OSCAL%E4%BB%93%E5%BA%93%E7%9A%84%E5%93%AA%E4%BA%9B%E6%8F%90%E4%BA%A4%E8%BF%9B%E8%A1%8C%E4%BA%86%E6%B5%8B%E8%AF%95%E3%80%82

用于开放安全控制评估语言（OSCAL）的基础Go SDK，该语言由美国国家标准与技术研究院（NIST）开发。还包含一个CLI工具，用于处理OSCAL文档、在OSCAL格式的XML、JSON和YAML之间转换，以及将OpenControl项目转换为OSCAL。该工具还支持从OSCAL格式的目录和配置文件生成Go源代码。

OSCAL标准的文档可在[***]

支持的OSCAL组件

目前支持以下OSCAL组件：

安装

您可以从https://github.com/docker/oscalkit/releases%E9%A1%B5%E9%9D%A2%E4%B8%8B%E8%BD%BD%E9%80%82%E7%94%A8%E4%BA%8E%E6%82%A8%E7%B3%BB%E7%BB%9F%E7%9A%84%60oscalkit%60%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7%E3%80%82%E5%B0%86%E5%85%B6%E7%A7%BB%E5%8A%A8%E5%88%B0%60$PATH%60%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E4%B8%AD%E5%88%97%E5%87%BA%E7%9A%84%E9%80%82%E5%BD%93%E7%9B%AE%E5%BD%95%E3%80%82macOS%E8%BF%98%E6%8F%90%E4%BE%9BHomebrew%E9%85%8D%E6%96%B9%EF%BC%8C%E5%90%8C%E6%97%B6https://hub.docker.com/r/docker/oscalkit/%E5%B7%B2%E5%8F%91%E5%B8%83%E5%88%B0Docker Hub。

Homebrew

bash
$ brew tap docker/homebrew-oscalkit
$ brew install oscalkit

Docker

运行oscalkit Docker容器需要绑定挂载包含源文件的目录，或通过stdin将文件内容传递给命令。

bash
$ docker pull docker/oscalkit:0.2.0
$ docker run -it --rm -v $PWD:/data -w /data docker/oscalkit:0.2.0 convert oscal-core.xml

通过stdin：

bash
$ docker run -it --rm docker/oscalkit:0.2.0 convert < oscal-core.xml

使用方法

NAME:
   oscalkit - OSCAL工具包

USAGE:
   oscalkit [全局选项] 命令 [命令选项] [参数...]

VERSION:
   0.2.0


COMMANDS:
     convert         在一种或多种OSCAL文件格式之间转换，以及从OpenControl格式转换
     validate        根据OSCAL XML和JSON模式验证文件
     sign            签名OSCAL JSON工件
     generate        根据提供的配置文件生成go代码
     implementation  根据提供的配置文件和Excel表格生成实现的go代码
     help, h         显示命令列表或单个命令的帮助

GLOBAL OPTIONS:
   --debug, -d    启用调试命令输出
   --help, -h     显示帮助
   --version, -v  打印版本

在XML和JSON之间转换

oscalkit可用于将一个或多个源文件在OSCAL格式的XML和JSON之间转换。

NAME:
   oscalkit convert oscal - 在一种或多种OSCAL文件格式之间转换

USAGE:
   oscalkit convert oscal [命令选项] [源文件...]

DESCRIPTION:
   在OSCAL格式的XML和JSON文件之间转换。该命令接受一个或多个源文件