管理并自动生成表示OSCAL层/模型的Python对象的工具
项目描述
合规梁(也称为梁
)
梁是一套工具集合,它使人们能够创建、验证和管理合规性文档工件。它利用NIST的OSCAL作为工具和人员之间交换的标准数据格式,并提供了对OSCAL采用的见解方法。
梁被设计为在git
上的合规性工件上运行的CICD管道,为开发人员提供一个友好的环境,以提供合规性状态的透明度。梁将生成的工件传递给协调合规性执行、测量和报告的工具。
它还提供工具,以更人性化的方式管理OSCAL文档。通过将大型OSCAL数据结构拆分为更小且易于编辑的子结构,这些工件的创作和维护可以遵循正常的git
工作流程,包括通过pull request进行同行评审、版本控制和发布/标记。
梁在合规性空间中提供三个独立但相关的功能
- 管理OSCAL文档,允许编辑和操作,同时确保架构得到执行
- 将文档从其他格式转换为OSCAL
- 提供支持和治理,以作者合规性内容为markdown和drawio。
梁提供工具以帮助在多个维度上协调合规性过程
- 通过将大型OSCAL数据结构扩展为更小且易于编辑的子结构,以更人性化的方式管理OSCAL文档,同时确保架构得到执行。
- 将文档从其他格式转换为OSCAL
- 对markdown文档进行治理,并根据指定的模板强制执行格式和内容的一致性
- 工具管理存储库内的markdown和drawio文件的创作和治理。
- 在trestle内部支持,以简化在管理的git环境中的管理。
- 支持开发人员与OSCAL工件交互的底层对象模型。
为什么选择梁
合规性是一个复杂的话题,难以简单表述。它涉及多个学科(例如IT、HR、管理)中多个程序的完整和准确执行,以及对这些程序的控制进行定期验证和审计。
虽然使用通用工具(例如电子表格、文档)以临时方式管理控制描述和组织实施方式是可能的,但对于多个认证来说,这很难维护,至少在IT领域,这会在合规性努力和日常工作人员(DevOps人员)之间形成障碍。
梁旨在通过将控制描述的维护带入DevOps领域来减少或消除这种障碍。目标是使系统更改(例如配置管理的更新)与受影响的控制轻松相关联,并允许在系统更改的同时按需修改这些控制。
梁隐式提供由其管道驱动的核心见解工作流程,允许与其他合规性工具平台进行标准化互锁。
机器可读的合规性格式
在规模上,无论是房地产规模还是认证数量,合规性活动都需要自动化才能成功和可重复。作为标准,OSCAL允许团队在“治理”层和操作工具之间架起桥梁。
通过在OSCAL中构建由人工管理的工件,梁不仅能够验证人们生成的工件的有效性,而且还能使工件重用和共享,并且还可以为自动化操作合规性的工具提供合适的输入。
支持的OSCAL元素和扩展
trestle
隐式支持所有OSCAL架构,用于在对象模型中使用。对于trestle
的开发路线图包括添加围绕特定元素/对象的工作流程,具有见解。
OSCAL 对象支持的文件格式。
OSCAL 支持 xml
、json
和 yaml
格式,并使用其 元架构工具。Trestle 目前原生支持 json
和 yaml
格式。
未来路线图预计将支持 xml 导入 和 上游引用。然而,预计只有 json
和 yaml
将获得完整支持。
需要导入 XML OSCAL 文档的用户建议查看 NIST 的 XML 到 json 转换页面 这里。
Python 代码库,通过 pip 简单安装
Trestle 在几乎所有 Python 平台上运行(例如 Linux、Mac、Windows),可在 PyPi 上找到,并可以通过 pip 简单安装。它处于积极开发中,并且定期发布新版本。
要安装,请运行: pip install compliance-trestle
有关完整安装指南,请参阅 在 Python 虚拟环境中安装 trestle。
完整文档和教程
完整的文档、教程和合规性背景信息可在 这里 找到。
敏捷编写
基于 Trestle 的敏捷编写存储库设置工具、文档和教程可在 这里 找到。
敏捷编写包含以下有益功能
- 基于幕后的 OSCAL 文档
- 使用 GIT 进行文档控制和访问
- 公开文本(markdown)和电子表格(csv),以简化合规性文档的管理
- 实现合规性数字化,以提高审计准备和成本效益
演示
可以在相关项目 compliance-trestle-demos 中找到使用 Trestle 的演示集合。
开发状态
v3:稳定(积极开发中)
- 支持 NIST OSCAL 1.1.2 以及之前的版本
v2:稳定(维护模式)
- 支持 NIST OSCAL 1.0.4 以及之前的版本
社区会议和沟通
请参阅社区 README 以获取沟通细节。
为 Trestle 贡献
我们的项目欢迎外部贡献。有关如何开始,请参阅 贡献。
行为准则
OSCAL Compass 社区的参与受 行为准则 的约束。
许可证 & 作者
如果您想查看详细的 LICENSE,请点击 这里。有关作者列表,请参阅 贡献者,有关核心团队的维护者,请参阅 维护者。
# Copyright (c) 2020 IBM Corp. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://apache.ac.cn/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
项目详情
下载文件
下载适合您平台文件的版本。如果您不确定选择哪个版本,请了解更多关于安装包的信息。
源分布
构建分布
哈希值 for compliance_trestle-3.4.0-py2.py3-none-any.whl
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 7762b3b3ddb7618fb4203feae104bf5de8dff1cd65de4ee5db01f3802cdc1447 |
|
MD5 | 1c7228aa3e59a01a65f27fab8003dc6c |
|
BLAKE2b-256 | 48458c8e4d612ce4d27936e46ecd998979e3a0ab076040ec1fc0d49fe9eee2b8 |