Couple comments on the report layout.
• Rules result breakdown - while the color bar breakdown is nice, it doesn't present precise information at first glance. The user will see 86 passed, 131 failed, and left guessing what that remaining 6 rules are. It'll be nice to see the total number of rules as well. • Failed rules by severity breakdown – similar to rules results, the severity description got cut off even though it’s easy to assume that the two failed rules refer to High severity. • Score – it’ll be nice to have a brief explanation or reference to how the scoring is done for those not familiar with the scoring system. • Section heading – I think the number of “not checked” should also be included in the section heading along with fail and unknown. For example, I could’ve easily missed “Ensure Software Patches Installed” since it was collapsed within Updating Software section.
Regards, Wei
----- Original Message -----
From: "Martin Preisler" <mpreisle@redhat.commailto:mpreisle@redhat.com> To: "SCAP Security Guide" <scap-security-guide@lists.fedorahosted.orgmailto:scap-security-guide@lists.fedorahosted.org> Sent: Thursday, August 28, 2014 7:49:23 PM Subject: New report and guide in openscap 1.1.0
Hi,
as you may know I have been working on a complete rewrite of HTML report and guide for the upcoming openscap 1.1.0 release. It's a feature that will touch almost every user of openscap. I would like to gather feedback from the scap-security-guide community so that we can make sure there aren't any blocker issues in the release. It is natural that there will be small issues that we will iron out in minor releases. Basically we would just like to make sure the new report and guide aren't missing anything crucial that would prevent adoption.
See https://mpreisle.fedorapeople.org/openscap/1.1.0_xslt/ for sample HTML report and guide from SSG for RHEL6.
Looking forward to feedback.
-- Martin Preisler -- SCAP Security Guide mailing list scap-security-guide@lists.fedorahosted.orgmailto:scap-security-guide@lists.fedorahosted.org https://lists.fedorahosted.org/mailman/listinfo/scap-security-guide https://github.com/OpenSCAP/scap-security-guide/
----- Original Message -----
From: "Wei Chen (Contractor)(CFPB)" Wei.Chen@cfpb.gov To: mpreisle@redhat.com Cc: scap-security-guide@lists.fedorahosted.org Sent: Friday, August 29, 2014 3:04:23 PM Subject: RE: New report and guide in openscap 1.1.0
Couple comments on the report layout.
Thanks for your feedback!
• Rules result breakdown - while the color bar breakdown is nice, it doesn't present precise information at first glance. The user will see 86 passed, 131 failed, and left guessing what that remaining 6 rules are. It'll be nice to see the total number of rules as well.
I decided to add @title which provides a tooltip. If you hover your mouse over the progress bar you will get a description what it is and how many rules are there in total.
See 0fab43d278d10bf260314acea11ec7afd3409dbd
• Failed rules by severity breakdown – similar to rules results, the severity description got cut off even though it’s easy to assume that the two failed rules refer to High severity.
Same as above. See a6b216144500bf147eeab2d5152329505ec8ba8f
• Score – it’ll be nice to have a brief explanation or reference to how the scoring is done for those not familiar with the scoring system.
I simply don't have this info in the report. All info I have is the following:
<score system="urn:xccdf:scoring:default" maximum="100.000000">58.458904</score>
While I could add a link to the specification I think it's not necessary, do you agree?
I added a tooltip that hints to look at XCCDF specification, see 1d7b370c3194a9103e3d4c95aa5d0dbd3d011dd9
• Section heading – I think the number of “not checked” should also be included in the section heading along with fail and unknown. For example, I could’ve easily missed “Ensure Software Patches Installed” since it was collapsed within Updating Software section.
Are you sure you mean "notchecked" and not "notselected". We already show notchecked rules by default. Either way I am not sure you mean, sorry.
• Section heading – I think the number of “not checked” should also be included in the section heading along with fail and unknown. For example, I could’ve easily missed “Ensure Software Patches Installed” since it was collapsed within Updating Software section.
Are you sure you mean "notchecked" and not "notselected". We already show notchecked rules by default. Either way I am not sure you mean, sorry.
System Settings->Installing and Maintaining software->Updating Software->Ensure Software Patches Installed It is listed as "notchecked", but it's collapsed within the section when the page initially loads. Unlike "fail" and "unknown", "notchecked" rules don't seem to have a number indicator in the section title, so it was easily skipped over when the section is collapsed.
BTW, are there any significant changes to the report layout under Lynx or other text-based browsers? I don't have the means to check it right now, but it is something I have used for quick reference.
Thank you for the great work!
Wei
-----Original Message----- From: Martin Preisler [mailto:mpreisle@redhat.com] Sent: Monday, September 01, 2014 10:31 AM To: Chen, Wei (Contractor)(CFPB) Cc: scap-security-guide@lists.fedorahosted.org Subject: Re: New report and guide in openscap 1.1.0
----- Original Message -----
From: "Wei Chen (Contractor)(CFPB)" Wei.Chen@cfpb.gov To: mpreisle@redhat.com Cc: scap-security-guide@lists.fedorahosted.org Sent: Friday, August 29, 2014 3:04:23 PM Subject: RE: New report and guide in openscap 1.1.0
Couple comments on the report layout.
Thanks for your feedback!
• Rules result breakdown - while the color bar breakdown is nice, it doesn't present precise information at first glance. The user will see 86 passed, 131 failed, and left guessing what that remaining 6 rules are. It'll be nice to see the total number of rules as well.
I decided to add @title which provides a tooltip. If you hover your mouse over the progress bar you will get a description what it is and how many rules are there in total.
See 0fab43d278d10bf260314acea11ec7afd3409dbd
• Failed rules by severity breakdown – similar to rules results, the severity description got cut off even though it’s easy to assume that the two failed rules refer to High severity.
Same as above. See a6b216144500bf147eeab2d5152329505ec8ba8f
• Score – it’ll be nice to have a brief explanation or reference to how the scoring is done for those not familiar with the scoring system.
I simply don't have this info in the report. All info I have is the following:
<score system="urn:xccdf:scoring:default" maximum="100.000000">58.458904</score>
While I could add a link to the specification I think it's not necessary, do you agree?
I added a tooltip that hints to look at XCCDF specification, see 1d7b370c3194a9103e3d4c95aa5d0dbd3d011dd9
• Section heading – I think the number of “not checked” should also be included in the section heading along with fail and unknown. For example, I could’ve easily missed “Ensure Software Patches Installed” since it was collapsed within Updating Software section.
Are you sure you mean "notchecked" and not "notselected". We already show notchecked rules by default. Either way I am not sure you mean, sorry.
-- Martin Preisler
----- Original Message -----
From: "Wei Chen (Contractor)(CFPB)" Wei.Chen@cfpb.gov To: "Martin Preisler" mpreisle@redhat.com Cc: scap-security-guide@lists.fedorahosted.org Sent: Wednesday, September 3, 2014 2:36:57 PM Subject: RE: New report and guide in openscap 1.1.0
• Section heading – I think the number of “not checked” should also be included in the section heading along with fail and unknown. For example, I could’ve easily missed “Ensure Software Patches Installed” since it was collapsed within Updating Software section.
Are you sure you mean "notchecked" and not "notselected". We already show notchecked rules by default. Either way I am not sure you mean, sorry.
System Settings->Installing and Maintaining software->Updating Software->Ensure Software Patches Installed It is listed as "notchecked", but it's collapsed within the section when the page initially loads. Unlike "fail" and "unknown", "notchecked" rules don't seem to have a number indicator in the section title, so it was easily skipped over when the section is collapsed.
See https://fedorahosted.org/openscap/ticket/393 I hope I can fix this for openscap 1.1.1
BTW, are there any significant changes to the report layout under Lynx or other text-based browsers? I don't have the means to check it right now, but it is something I have used for quick reference.
The new report should be fine for quick references with lynx or links.
scap-security-guide@lists.fedorahosted.org