Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-09-20 14:31:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
inspec/docs/waivers.md
Larry Eichenbaum bd173b01e7
Update waivers.md 
Adding DCO
Signed-off-by: Joe Smith  <6776768+larryebaum@users.noreply.github.com>
Edited example to reflect correct input file structure for expiration.
2019-10-22 22:39:10 -07:00

1.6 KiB
Raw Blame History

Waivers (beta)

Waivers is a mechanism to mark controls as "waived" for various reasons, and to control the running and/or reporting of those controls. It uses a YAML input file that identifies:

  1. which controls are waived
  2. a description of why it is waived
  3. (optionally) whether they should be skipped from running
  4. (optionally) an expiration date for the waiver

NOTE: This mechanism is currently in beta and is intended to be ingested and maintained by Chef Automate UI.

Usage

To use waivers, you must have a correctly formatted input file and invoke inspec exec with --waiver-file [path].

% inspec exec --waiver-file waivers.yaml path/to/profile

File Format

Waiver files are input files with a specific format:

control_id:
  expiration_date: YYYY-MM-DD
  run: false
  justification: "reason for waiving this control"
  • expiration_date is optional. Absence means the waiver is permanent.
  • run is optional. If present and true, the control will run and be reported, but failures in it won't make the overall run fail. If absent or false, the control will not be run. You may use any of yes, no, true or false.
  • justification can be any text you want and might include a reason as well as who signed off on the waiver.

Examples:

waiver_control_1_2_3:
  expiration_date: 2019-10-15
  justification: Not needed until Q3. @secteam

xccdf_org.cisecurity.benchmarks_rule_1.1.1.4_Ensure_mounting_of_hfs_filesystems_is_disabled:
  expiration_date: 2020-03-01
  justification: "This might be a bug in the test. @qateam"
  run: false