Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 2.19 KB

Review.md

File metadata and controls

26 lines (21 loc) · 2.19 KB
Check Sub-check Who Completion Date *** Issue #'s
Logical checks Proper profile directory structure [1] Mo 04/17/2019 *
JSON output review (e.g., pass/fail on ,
hardened, not hardened, edge cases, etc.)
Mo #12
InSpec syntax checker Mo 04/24/2019 #10
Local commands focused on target not the runner [2]
Quality checks Alignment (including tagging) to original
standard (i.e. STIG, CIS Benchmark, NIST Tags)
Mo 04/17/2019 *
Control robustness (can the control be improved to make it less brittle - not necessarily a blocker on initial releases) Mo 04/18/2019 *
Descriptive output for findings details (review JSON for findings information that may be confusing to SCA like NilCLass, etc.) Mo #12
Documentation quality (i.e. README)
novice level instructions including prerequisites
Mo 05/08/2019 #5
Consistency across other profile conventions Mo 04/24/2019 #9
Spelling, grammar,linting (e.g., rubocop, etc.) Mo 04/24/2019 #11
Removing debugging documentation and code Mo 04/18/2019 *
Error handling “Profile Error” containment: “null” responses
should only happen if InSpec is run with incorrect privileges (e.g., code fails to reach a describe statement for every control. inspec check can do this. It will say no defined tests)
Mo #12
Slowing the target (e.g. filling up disk, CPU spikes) Mo 04/18/2019 *
Check for risky commands (e.g. rm, del, purge, etc.) Mo 04/18/2019 *
Check for “stuck” situations (e.g., profile goes on forever due to infinite loop, very large data sets, etc.) Mo 04/18/2019 *

[1] https://www.inspec.io/docs/reference/profiles/

[2] https://www.inspec.io/docs/reference/style/ (see "Avoid Shelling Out")

Another tip is to cat all the controls into a single file so you don't have to open every individaul file and try to keep track of where you are and which one is next.

*** A completion date is entered in a row when all non-enhancement issues are resolved for that review row.