From 8e89e9b9f3fee8bec9f9c605ea4cd39e0ddbf3dc Mon Sep 17 00:00:00 2001 From: Jennifer Power Date: Fri, 9 Feb 2024 14:27:01 -0500 Subject: [PATCH] docs: update the compliance-trestle-fedramp plugin usage Signed-off-by: Jennifer Power --- docs/plugins/compliance-trestle-fedramp.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/plugins/compliance-trestle-fedramp.md b/docs/plugins/compliance-trestle-fedramp.md index 8b5069bb9..843039eef 100644 --- a/docs/plugins/compliance-trestle-fedramp.md +++ b/docs/plugins/compliance-trestle-fedramp.md @@ -4,7 +4,7 @@ This plugin provides functionality for validating an SSP for FedRAMP compliance. ## `trestle fedramp-validate` -This command allows users to validate existing OSCAL SSP file (in JSON or YAML format) for FedRAMP compliance. For example, `trestle fedramp-validate -f /local_dir/ssp.json -o report/` will validate `ssp.json` file for fedramp complaince and store the validation reports in `report` folder. +This command allows users to validate existing OSCAL SSP file (in JSON or YAML format) for FedRAMP compliance. For example, `trestle fedramp-validate -f /local_dir/ssp.json -o report/` will validate `ssp.json` file for fedramp compliance and store the validation reports in `report` folder. The following options are supported: @@ -12,3 +12,15 @@ The following options are supported: - `-o or --output`: specifies the name of the output directory where the validation reports will be stored. It may be an absolute or relative path. The output directory should already exist. This is also a required option. The validation reports are created in XML and HTML format and provide details on which part of the SSP are not complaint as per FedRAMP specification. + +## `trestle fedramp-transform` + +This command allows users to extract information from an OSCAL SSP and transform it into a Word document based on the FedRAMP SSP Appendix A Template. The templates for the High, Moderate, and Low baseline security control requirements were retrieved from this [location](https://www.fedramp.gov/documents-templates/) and are bundled with the application. The `Control Summary Information` tables are populated for each control based on the OSCAL SSP. + +For example, `trestle fedramp-transform -n ssp-name -l 'high' -o my_ssp.docx` will transform the OSCAL SSP file `ssp-name` into a Word document `my_ssp.docx` based on the SSP Appendix A - High FedRAMP Security Controls template. + +The following options are supported: + +- `-n or --ssp-name`: The name of the OSCAL SSP imported into trestle workspace. This is a required option. +- `-l or --level`: The baseline level corresponding to the template. This is high, moderate, low. This is a required option. +- `-o or --output-file`: The output location for the populated Word document. This is also a required option.