Present references in a table

We will sort and show the references grouped by reference target. The well-known references will be labeled. This makes the "References" section of rule detail actually useful. Fixes: #154
OpenSCAP · Nov 3, 2023 · 510a456 · 510a456
1 parent 3745f7f
commit 510a456
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 25 deletions.
diff --git a/openscap_report/report_generators/html_templates/rule_detail.html b/openscap_report/report_generators/html_templates/rule_detail.html
@@ -136,20 +136,21 @@
             <tr role="row">
                 <th class="pf-m-fit-content" role="rowheader" scope="row"><p class="pf-c-table__text"><b>References:</b></p></th>
                 <td role="cell">
-                    <div class="pf-l-flex pf-m-column"><div class="pf-l-flex__item">
-                    <p class="pf-c-table__text">
-                    <div>
+                    <table>
                         {%- for reference in rule.references -%}
-                        {%- if reference.href -%}
-                            <a href="{{ reference.href | replace('&', ';') }}">{{ reference.text }}</a>
-                        {%- else -%}
-                            <span>{{ reference.text }}</span>
-                        {%- endif -%}
-                        {{- ", " if not loop.last else "" -}}
+                            <tr>
+                                <td>
+                                    <a href="{{ reference.href | replace('&', ';') }}">{{ reference.name }}</a>:
+                                </td>
+                                <td>
+                                    {%- for ref_id in reference.ref_ids -%}
+                                    {{ ref_id }}
+                                    {{- ", " if not loop.last else "" -}}
+                                    {%- endfor -%}
+                                </td>
+                            </tr>
                         {%- endfor -%}
-                    </div>
-                    </p>
-                    </div></div>
+                    </table>
                 </td>
             </tr>
             {% endif %}

diff --git a/openscap_report/scap_results_parser/data_structures/json_transformation.py b/openscap_report/scap_results_parser/data_structures/json_transformation.py
@@ -5,11 +5,8 @@
 def rearrange_references(dictionary_json):
     global_references = {}
     for rule in dictionary_json["rules"].values():
-        new_rule_references = []
         for ref in rule["references"]:
-            global_references[ref["text"]] = ref["href"]
-            new_rule_references.append(ref["text"])
-        rule["references"] = new_rule_references
+            global_references[ref["name"]] = ref["href"]
     dictionary_json["references"] = global_references
 
 

diff --git a/openscap_report/scap_results_parser/data_structures/reference.py b/openscap_report/scap_results_parser/data_structures/reference.py
@@ -2,17 +2,20 @@
 # SPDX-License-Identifier: LGPL-2.1-or-later
 
 from dataclasses import asdict, dataclass
+from typing import List
 
 REFERENCE_JSON_KEYS = [
+    "name",
     "href",
-    "text",
+    "ref_ids",
 ]
 
 
 @dataclass
 class Reference:
+    name: str
     href: str
-    text: str
+    ref_ids: List[str]
 
     def as_dict(self):
         return asdict(self)
diff --git a/openscap_report/scap_results_parser/parsers/rule_parser.py b/openscap_report/scap_results_parser/parsers/rule_parser.py
@@ -1,13 +1,41 @@
 # Copyright 2022, Red Hat, Inc.
 # SPDX-License-Identifier: LGPL-2.1-or-later
 
+import collections
 from dataclasses import replace
 
 from ..data_structures import Identifier, Reference, Rule, RuleWarning
 from ..namespaces import NAMESPACES
 from .full_text_parser import FullTextParser
 from .remediation_parser import RemediationParser
 
+KNOWN_REFERENCES = {
+    "http://www.ssi.gouv.fr/administration/bonnes-pratiques/": "ANSSI",
+    "https://public.cyber.mil/stigs/cci/": "CCI",
+    "https://www.ccn-cert.cni.es/pdf/guias/series-ccn-stic/guias-de-acceso-publico-ccn-stic/6768-ccn-stic-610a22-perfilado-de-seguridad-red-hat-enterprise-linux-9-0/file.html": "CCN for RHEL 9",
+    "https://www.cisecurity.org/controls/": "CIS",
+    "https://www.cisecurity.org/benchmark/red_hat_linux/": "CIS for RHEL",
+    "https://www.fbi.gov/file-repository/cjis-security-policy-v5_5_20160601-2-1.pdf": "CJIS",
+    "http://www.cnss.gov/Assets/pdf/CNSSI-1253.pdf": "CNSS",
+    "https://www.isaca.org/resources/cobit": "COBIT",
+    "http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-171.pdf": "CUI",
+    "https://www.gpo.gov/fdsys/pkg/CFR-2007-title45-vol1/pdf/CFR-2007-title45-vol1-chapA-subchapC.pdf": "HIPAA",
+    "https://www.isa.org/products/ansi-isa-62443-3-3-99-03-03-2013-security-for-indu": "ISA-62443-2013",
+    "https://www.isa.org/products/isa-62443-2-1-2009-security-for-industrial-automat": "ISA-62443-2009",
+    "https://www.cyber.gov.au/acsc/view-all-content/ism": "ISM",
+    "https://www.iso.org/standard/54534.html": "ISO 27001-2013",
+    "https://www.nerc.com/pa/Stand/Standard%20Purpose%20Statement%20DL/US_Standard_One-Stop-Shop.xlsx": "NERC-CIP",
+    "http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-53r4.pdf": "NIST 800-53",
+    "https://nvlpubs.nist.gov/nistpubs/CSWP/NIST.CSWP.04162018.pdf": "NIST CSF",
+    "https://www.niap-ccevs.org/Profile/PP.cfm": "OSPP",
+    "https://www.pcisecuritystandards.org/documents/PCI_DSS_v3-2-1.pdf": "PCI-DSS v3",
+    "https://docs-prv.pcisecuritystandards.org/PCI%20DSS/Standard/PCI-DSS-v4_0.pdf": "PCI-DSS v4",
+    "https://public.cyber.mil/stigs/downloads/?_dl_facet_stigs=application-servers": "SRG-APP",
+    "https://public.cyber.mil/stigs/downloads/?_dl_facet_stigs=operating-systems%2Cgeneral-purpose-os": "SRG-OS",
+    "https://public.cyber.mil/stigs/downloads/?_dl_facet_stigs=operating-systems%2Cunix-linux": "STIG ID",
+    "https://public.cyber.mil/stigs/srg-stig-tools/": "STIG ref",
+}
+
 
 class RuleParser():
     def __init__(self, root, test_results, ref_values):
@@ -20,10 +48,16 @@ def __init__(self, root, test_results, ref_values):
 
     @staticmethod
     def _get_references(rule):
+        url_to_ref_ids = collections.defaultdict(list)
+        for reference_el in rule.findall(".//xccdf:reference", NAMESPACES):
+            url = reference_el.get("href")
+            ref_id = reference_el.text
+            url_to_ref_ids[url].append(ref_id)
         references = []
-        for referenc in rule.findall(".//xccdf:reference", NAMESPACES):
-            references.append(Reference(referenc.get("href"), referenc.text))
-        return references
+        for url, ref_ids in url_to_ref_ids.items():
+            name = KNOWN_REFERENCES.get(url, url)
+            references.append(Reference(name, url, sorted(ref_ids)))
+        return sorted(references, key=lambda x: x.name)
 
     @staticmethod
     def _get_identifiers(rule):

diff --git a/tests/json_schema_of_report.json b/tests/json_schema_of_report.json
@@ -244,7 +244,24 @@
                     "title": "References",
                     "type": "array",
                     "items": {
-                        "type": "string"
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "title": "Name",
+                                "type": "string"
+                            },
+                            "href": {
+                                "title": "Href",
+                                "type": "string"
+                            },
+                            "ref_ids": {
+                                "title": "IDs",
+                                "type": "array",
+                                "items": {
+                                    "type": "string"
+                                }
+                            }
+                        }
                     }
                 },
                 "description": {

diff --git a/tests/unit_tests/test_json_transitions.py b/tests/unit_tests/test_json_transitions.py
@@ -26,8 +26,9 @@
                         ],
                         "references": [
                             {
-                                "text": "11",
+                                "name": "IDK",
                                 "href": "idk-link.com",
+                                "ref_ids": ["11"],
                             }
                         ],
                     }
@@ -44,11 +45,15 @@
                             }
                         ],
                         "references": [
-                            "11",
+                            {
+                                "name": "IDK",
+                                "href": "idk-link.com",
+                                "ref_ids": ["11"],
+                            }
                         ],
                     }
                 },
-                "references": {"11": "idk-link.com"},
+                "references": {"IDK": "idk-link.com"},
             },
         )
     ],