Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new feature: create OSCAL json report from compliance operator evidence #49

Open
degenaro opened this issue Jan 28, 2021 · 0 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request harvest report Add or maintain a Harvest Report

Comments

@degenaro
Copy link

Overview

Provide a harvest report to transform Kubernetes compliance operator evidence from cluster_resource fetcher into a NIST OSCAL Assessment Results collection of Observations in JSON format.

Rationale: standardized version of evidence for multi-cloud and to facilitate creation of NIST OSCAL Assessment Results.

Requirements

  • The cluster_resource fetcher produces evidence comprising a JSON file with embedded XML in non-OSCAL format.
  • The harvest report is to produce a JSON file comprising NIST OSCAL Assessment Results Observations.
  • The harvest report is to produce an enhanced JSON file with additional Observation data when an optional oscal-metadata YAML file is specified.
  • Employ transformation technology available from compliance-trestle open source project.

Approach

Write a harvest report that consumes cluster_resource evidence and optional oscal-metadata.yaml to produce compliance_oscal_observations.json.

Steps:

  • read evidence from cluster_resource.json.
  • read enhancement data from oscal_metadata.yaml, if exists.
  • employ trestle transformer to create list of trestle Observations.
  • write trestle Observations JSON as compliance_oscal_observations.json.

Security and Privacy

N/A

Test Plan

Employ unit tests comprising representative cluster_resource.json and oscal-metadata.yaml.

@alfinkel alfinkel added documentation Improvements or additions to documentation enhancement New feature or request harvest report Add or maintain a Harvest Report labels Mar 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request harvest report Add or maintain a Harvest Report
Projects
None yet
Development

No branches or pull requests

2 participants