The FedRAMP Program Management Office (PMO) has drafted FedRAMP-specific extensions and guidance to ensure our stakeholders can fully express a FedRAMP Security Authorization Package using NIST's OSCAL SSP syntax.
To accompany these guides, the FedRAMP PMO has also drafted OSCAL files in XML and JSON formats to serve as an example and template for each major deliverable.
The FedRAMP PMO has a release strategy and versioning procedures. FedRAMP has a minimally supported version of OSCAL, unless explicitly noted otherwise in specific documents or source code in this repository. Baselines, guides, templates, and associated tools in this repository will only support OSCAL data with a version number no lower than specified by FedRAMP version tags. A version tag that ends in -oscal1.0.0 will only support data with oscal-version equal to 1.0.0 or newer, it will not support 1.0.1, 1.0.2, 1.0.3, 1.0.4, etc. A future version tag ending in -oscal1.1.0 indicates FedRAMP source code and guides will support data with oscal-version equal to 1.1.0 or newer, but not 1.0.0.
Changes to the minimally supported version and deprecation notices will be made in advance of a release.
This repository is for the development and enhancement of OSCAL artifacts only. For issues with the Word and Excel-based templates and artifacts on the fedramp.gov site, please send requests to info@fedramp.gov.
The FedRAMP PMO is releasing the following OSCAL content:
- FedRAMP Baselines: The FedRAMP rev 5 baselines for High, Moderate, Low, and Tailored for Low Impact-Software as a Service (LI-SaaS) in OSCAL (XML and JSON formats) are available here.
The FedRAMP OSCAL templates, registry, and implementation guides for rev 5 will be released in a few weeks.
-
FedRAMP OSCAL Templates: The template files are pre-populated with FedRAMP extensions, defined-identifiers, and conformity tags where practical. They also include sample data, and are the basis for their respective guidance documents above. The FedRAMP OSCAL SSP, SAP, SAR, and POA&M template are now available here in XML, JSON, and YAML formats.
-
FedRAMP OSCAL Registry This registry is the authoritative source for all FedRAMP extensions to the OSCAL syntax, FedRAMP-defined identifiers, and accepted values. The FedRAMP OSCAL Registry is now available here in XML format.
-
Implementation Guides: These documents help tool developers and content authors ensure any generated OSCAL-based FedRAMP deliverabes are fully compliant with FedRAMP’s extensions, defined identifiers, conformity tags, and acceptable values. The FedRAMP OSCAL implementation guides is now available here in PDF format.
Please ask questions or provide feedback on the items above above either via email to oscal@fedramp.gov, as a comment to an existing issue, or as a new issue.
FedRAMP's work is based on NIST's OSCAL 1.0.4, and requires an understanding of the core OSCAL syntax, as well as NIST-provided resources to function correctly.
IMPORTANT: As NIST makes minor syntax updates and releases new versions, please review the NIST OSCAL release notes in addition to guides here for more information about these changes.
The following NIST resources are available:
-
NIST's Main OSCAL Site: https://pages.nist.gov/OSCAL/
-
NIST's OSCAL GitHub Repository: https://github.com/usnistgov/OSCAL
-
OSCAL Workshop Training Slides: Videos and content from NIST's annual OSCAL Conference and Workshop are available at https://pages.nist.gov/OSCAL/learn/presentations/
-
Content Converters: The converters accurately convert OSCAL catalog, profile, SSP, SAP, SAR, and POA&M content from XML to JSON and JSON to XML.
-
NIST SP 800-53 & 53A Revision 4 in OSCAL: NIST is also providing SP 800-53 and 800-53A, Revision 5 content as well as the NIST High, Moderate, and Low baselines in OSCAL (XML, JSON, and YAML formats) here.
NIST offers a complete package containing the NIST OSCAL converters, syntax validation tools, 800-53 and FedRAMP baselines content is available for download in both ZIP and BZ2 format. Visit the NIST OSCAL Github releases page for more information.
Please ask questions or provide feedback on the above NIST dependencies either via email to oscal@nist.gov, as a comment to an existing issue, or as a new issue via the NIST OSCAL GitHub site.
FedRAMP looks forward to receiving your comments and sharing additional progress.
Complete documentation for each validation rule is available, and is bundled with each official release. The documentation provides a browsable list of each validation rule, as well as the ability to validate FedRAMP OSCAL documents in-browser.
See ./src/web for details on how to build and run locally.
A top-level Makefile is provided to simplify builds.
Build requirements are:
- gnu make
- node.js (as versioned in ./nvmrc)
- Java 8+
- Python 3.9+
- Docker
For usage information, use the default target:
make
If you are developing on Windows, msys2 may be used for the required build tools (make and bash, in particular). Follow all the suggested installation steps on the msys2 home page for a complete environment. Additionally, make sure all the build requirements (above) are available on your path.
FedRAMP automation is composed of the following implementation details:
- Validation rules are implemented in Schematron with xspec test coverage.
- Validation rules web documentation provides a browser of implemented validation rules and may be used to validate FedRAMP OSCAL documents in-browser. A deployed version is available here: FedRAMP ASAP Validation Documentation
- Example code is provided to demonstrate how to apply the validation rules using the compiled-XSLT artifact in selected languages.
ADR 0002 (git release version strategy) outlines the release and versioning system.
Releases must be tagged from the master branch of GSA/fedramp-automation. If your work resides elsewhere, first merge to master via a pull-request.
To produce a release:
- Create a Github Release
- Ensure the tag follows the naming convention defined in ADR 0002
- Monitor running Github Actions for the
build-releaseworkflow's completion (./.github/workflows/create-release.yml)- On completion, artifacts will be attached to the release.