From a7771a4ebce47cee44a7a6651f87af06ffb5f230 Mon Sep 17 00:00:00 2001 From: Dominik Richter Date: Tue, 25 Apr 2017 18:59:47 +0200 Subject: [PATCH] describe the value ranges of `impact` Signed-off-by: Dominik Richter --- docs/dsl_inspec.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/dsl_inspec.md b/docs/dsl_inspec.md index 7b39a2d28..f023405f4 100644 --- a/docs/dsl_inspec.md +++ b/docs/dsl_inspec.md @@ -44,7 +44,10 @@ where * `'sshd-8'` is the name of the control * `impact`, `title`, and `desc` define metadata that fully describes the importance of the control, its purpose, with a succinct and complete description -* `impact` is an float that measures the importance of the compliance results and must be a value between `0.0` and `1.0`. +* `impact` is an float that measures the importance of the compliance results and must be a value between `0.0` and `1.0`. The value ranges are: + * `0.0 to <0.4` these are controls with minor criticality + * `0.4 to <0.7` these are controls with major criticality + * `0.7 to 1.0` these are critical controls * `tag` is optional meta-information with with key or key-value pairs * `ref` is a reference to an external document * `describe` is a block that contains at least one test. A `control` block must contain at least one `describe` block, but may contain as many as required