Online Informative References Validation Tool and Focal Document Templates

Download: IR8278A Validation Tool (Download 15 MB)

SHA3-256:  c28ea36409680a200e66927b2735551dba9f432a4950438086bff7533c136b81

The National Cybersecurity Online Informative References (OLIR) Validation Tool ensures syntactic compliance of the Focal Document templates to the instructions and definitions described within the NIST Interagency Report (IR) 8278A, National Cybersecurity Online Informative References (OLIR) Program: Submission Guidance for OLIR Developers.

Focal Document Templates

• Cybersecurity Framework v1.1 (.xlsx)
• Privacy Framework v1.0 (.xlsx)
• SP 800-53 Rev. 4 (.xlsx)

Focal Document JSON Schema

• Focal Documents Schema (.json)
  This JSON schema is intended for use in developing a JSON file format of an OLIR

Validation Tool Prerequisites

• Java must be installed on your machine. 
• The Validation Tool requires Java version 8 or higher
• The spreadsheet must be in the .xlsx file format
• IR8278A Validation requires that no new columns are added to the template however, new rows can be added as needed detailed in NIST IR 8278A Specification.

Running the Program

Option A – Folder View

1. Download the jar file to a folder (note the output files will be generated in the same folder as the jar file executable.
2. Double click on the jar file to run it.
3. The program will prompt via pop-up dialog box for the file path of the spreadsheet to test.
4. After providing the file path, press ENTER, the dialog box will disappear and the program will begin executing.
5. When the program is complete, two results files will be placed in the same directory as the jar executable: CompleteValidationReport<FN>YYYY-MM-DDTHH:MM:SS.txt and ErrorFileResults<FN>YYYY-MM-DDTHH:MM:SS.txt
6. Two results files will be placed in the same directory as the jar executable named, CompleteValidationReport<FN>YYYY-MM-DDTHH:MM:SS.txt which is a more verbose reporting file and ErrorFileResults<FN>YYYY-MM-DDTHH:MM:SS.txt containing only compliance violations of the IR8278A specification.

Option B – Command Line Interface (CLI)

1. Download the jar file to a folder (note the output files will be generated in the same folder as the jar file executable.
2. Open Terminal or Command Line and navigate to the directory containing the jar file executable.
3. Use the command: java -jar [Program Name].jar [Reference Spreadsheet File Path]
4. Press ENTER and the program will begin running.
5. When the program is finished, the Command Line/Terminal window will display “Program is complete” along with basic statistics totals such as passes, errors and warnings.
6. Two results files will be placed in the same directory as the jar executable: CompleteValidationReport<FN>YYYY-MM-DDTHH:MM:SS.txt which is a more verbose reporting file and ErrorFileResults<FN>YYYY-MM-DDTHH:MM:SS.txt containing only compliance violations of the IR8278 specification.