diff --git a/xml/art-compliance-scans.xml b/xml/art-compliance-scans.xml index 4276b75..1992b03 100644 --- a/xml/art-compliance-scans.xml +++ b/xml/art-compliance-scans.xml @@ -323,7 +323,7 @@ SLES Expanded Support platform
Choosing an &openscap; compliance profile - TODO: Add an intro para about choosing a profile to run scans with + TODO: Add an intro para about choosing a profile to run scans with, mention rules The &ssg; installs the compliance content under the path @@ -472,7 +472,7 @@ Result fail Fetching remote resources during a compliance scan - Make sure the machine where you run the scan has access to + Make sure the machine you run the scan from has access to : &prompt.root;ping ftp.suse.com @@ -492,7 +492,7 @@ Result fail - Fetches the remote resources from for use in the + Fetches remote resources from for use in the compliance scan. @@ -524,7 +524,7 @@ Result fail Downloading and saving remote resources for a compliance scan - Create a directory for storing the downloaded resources: + Create a directory for storing downloaded resources: &prompt.root;mkdir /tmp/scap-files @@ -600,79 +600,131 @@ Result fail
Reviewing the &openscap; evaluation report - The HTML formatted OpenSCAP reports contain information collected off a target system and evaluation of the latter against the selected profile. + The HTML-formatted &openscap; report contains information collected from the target system + and evaluated against the rules set by the selected compliance profile. The examples below + show the main features of the report. - - In the following screenshot, a typical header of a HTML report is displayed, containing information about the chosen security profile. + + + Report header + + + The header of the report shows information about the chosen compliance profile.
Header of a typical HTML-formatted report generated by OpenSCAP - + - The header of a typical HTML-formatted report generated by OpenSCAP. This example report is titled "Guide to the Secure Configuration of SUSE Liberty Linux 7" and uses the profile "CIS Benchmark for Level 2 - Server". + + The header of a typical HTML-formatted report generated by OpenSCAP. This example + report is titled "Guide to the Secure Configuration of SUSE Liberty Linux 7" and + uses the profile "CIS Benchmark for Level 2 - Server". +
- - The report itself contains a summary of passed and failed tests, information about the tested system, and a list of rules included with the security profile, along with test results for each rule. - - - The report is interactive: it is possible to click rule names for more detail, check and uncheck filter options, etc. - - - To receive detailed information on each test result, including remediations, please click “Show all result details” button at the very bottom of the report. - - - Below screenshots show some of the functionality of a HTML report generated by OpenSCAP. + + + + Compliance and Scoring + + + The Compliance and Scoring section shows a summary of the + compliance scan's results, including the number of passed and failed rules, as well + as the severity of the failures.
Summary of results in a typical HTML-formatted report generated by OpenSCAP - + - + + The Compliance and Scoring section shows a green and red color-coded bar indicating + the number of passed and failed rules. It also shows a color-coded bar indicating the + severity of the failed rules, in this case mostly blue (low) and yellow (medium). + There is also a percentage score of passed rules. This example shows 68.72%. +
+ + + + Rule Overview + + + The Rule Overview section shows a list of rules included with the + compliance profile, along with the severity and test result of each rule. This section is + interactive. You can check and uncheck filter options, group rules by different criteria, + search the list with a search bar, and click the rule names to see more details. +
List of rules in a typical HTML-formatted report generated by OpenSCAP - + - + + The Rule Overview section shows the full list of rules along with their + severity and test results. Above the list is a group of check boxes for filtering + the rule list, a search bar to search the list, and a drop-down list of different + ways to group the rules in the list. +
+ + + + Rule details and remediation + + + Clicking the name of a rule opens a window showing detailed information about that rule. + Depending on the rule, the detail window might also include multiple remediation options. + Click (show) to expand each remediation option. +
Detailed information about a rule - + - + + This example shows details about the rule Ensure /home Located On Separate + Partition, including the result, the time the test ran, the severity of the + rule, clickable references, a description of the rule, and a rationale for the rule. + The bottom of the window has an expandable Remediation script and + Remediation Anaconda snippet. +
+ + + + + You can also expand the details for every rule by clicking + Show all result details at the bottom of the report. +