OSCAL Java Command Line Tool

A Java tool, providing a command line interface, that performs common operations on Open Security Controls Assessment Language (OSCAL) and Metaschema content.

This open-source, tool offers a convenient way to manipulate OSCAL and Metaschema based content supporting the following operations:

• Converting OSCAL content between the OSCAL XML, JSON, and YAML formats.
• Validating an OSCAL resources to ensure it is well-formed and valid.
• Resolving OSCAL Profiles.
• Validating a Metaschema model definition to ensure it is well-formed and valid.
• Generating XML and JSON Schemas from a Metaschema model definition.

This work is intended to make it easier for OSCAL and Metaschema content authors to work with related content.

This tool is based on the Metaschema Java Tools and OSCAL Java Library projects.

Contributing to this code base

Thank you for interest in contributing to the Metaschema Java framework. For complete instructions on how to contribute code, please read through our CONTRIBUTING.md documentation.

Public domain

This project is in the worldwide public domain and as stated in CONTRIBUTING.md.

Building

This project can be built with Apache Maven version 3.8.4 or greater.

The following instructions can be used to clone and build this project.

1. Clone the GitHub repository.

git clone --recurse-submodules https://github.com/usnistgov/oscal-cli.git 

2. Build the project with Maven

mvn install

Installing

Installing pre-built Java package

1. Make a directory to install oscal-cli and cd into it. The example below uses the directory /opt/oscal-cli. Use your preferred directory.

mkdir -p /opt/oscal-cli && cd /opt/oscal-cli

NOTE:

2. Download the zipped oscal-cli Java package. Download your preferred version, but we recommend the latest stable release on the Maven Central repository.

3. Extract oscal-cli into the directory.

unzip cli-core-1.0.1-oscal-cli.zip

4. (Recommended) Add oscal-cli's directory to your path.

# temporarily add oscal-cli to your terminal's instance path
PATH=$PATH:/opt/oscal-cli/bin

# add oscal-cli to your environment (e.g., all terminals)
export PATH=$PATH:/opt/oscal-cli/bin

NOTE: You can also add oscal-cli's directory to your path in shell profile to make oscal-cli permamently available.

Running

Run help to make sure everything work

# if oscal-cli directory added to your path
oscal-cli --help

# if you did not add oscal-cli directory to your path
/opt/oscal-cli/bin/oscal-cli --help

Relationship to prior work

The contents of this repository is based on work from the Metaschema Java repository maintained by the National Institute of Standards and Technology (NIST), the contents of which have been dedicated in the worldwide public domain using the CC0 1.0 Universal public domain dedication. This repository builds on this prior work, maintaining the CCO license on any new works in this repository.