feat: remove individual analytic pages

Author: clemiller

attack-theme/static/scripts/domain_table.js

@@ -32,12 +32,17 @@ function filter_row(selected) {
 $(document).ready(function() {
     let arrow_up = document.getElementById("arrow-up-0");
     let arrow_down = document.getElementById("arrow-down-0");
-    arrow_down.style.display = "inline-block";
-    arrow_up.style.display = "none";
+    if (arrow_up && arrow_down) {
+        arrow_down.style.display = "inline-block";
+        arrow_up.style.display = "none";
+    }
+
     arrow_up = document.getElementById("arrow-up-1");
     arrow_down = document.getElementById("arrow-down-1");
-    arrow_down.style.display = "inline-block";
-    arrow_up.style.display = "none";
+    if (arrow_up && arrow_down) {
+        arrow_down.style.display = "inline-block";
+        arrow_up.style.display = "none";
+    }
     showDomain();
 });
 

modules/analytics/__init__.py

@@ -6,4 +6,4 @@ def get_priority():
 
 
 def run_module():
-    return analytics.generate_analytic(), analytics_config.module_name
+    return analytics.generate_analytic_overview(), analytics_config.module_name

modules/analytics/analytics.py

@@ -4,11 +4,10 @@
 from modules import util
 from loguru import logger
 
-from .. import site_config
 from . import analytics_config
 
 
-def generate_analytic():
+def generate_analytic_overview():
     """Verify analytic directory and generate analytic index markdown."""
     # Create content pages directory if does not already exist
     util.buildhelpers.create_content_pages_dir()
@@ -21,14 +20,13 @@ def generate_analytic():
         os.mkdir(analytics_config.analytic_markdown_path)
 
     # Generate markdown files used for page generation
-    analytic_generated = generate_markdown_files()
+    analytic_generated = generate_markdown_file()
     if not analytic_generated:
         util.buildhelpers.remove_module_from_menu(analytics_config.module_name)
 
 
-def generate_markdown_files():
-    """Generate shared data for all analytics and markdown for analytic pages."""
-    data = {}
+def generate_markdown_file():
+    """Generate table data for all analytics."""
     has_analytics = False
 
     analytics = util.relationshipgetters.get_analytic_list()
@@ -40,24 +38,15 @@ def generate_markdown_files():
         logger.debug("No analytics found")
 
     if has_analytics:
-        notes = util.relationshipgetters.get_objects_using_notes()
-
         # Generate sidebar data
-        sidebar_data = util.buildhelpers.get_side_menu_data(
-            "Analytics", "/analytics/", active_analytics
-        )
-        data["sidebar_data"] = sidebar_data
-
-        data["total_count"] = str(len(active_analytics))
-        data["analytics_table"] = get_analytic_table(active_analytics)
-
+        data = {
+            "sidebar_data": util.buildhelpers.get_side_menu_data("Analytics", "/analytics/", []),
+            "total_count": str(len(active_analytics)),
+            "analytics_table": get_analytic_table(active_analytics),
+        }
         subs = analytics_config.analytic_index_md + json.dumps(data)
         with open(os.path.join(analytics_config.analytic_markdown_path, "overview.md"), "w", encoding="utf8") as md_file:
             md_file.write(subs)
-
-        # Create markdown for analytics
-        for analytic in analytics:
-            generate_analytic_md(analytic, sidebar_data, notes)
 
     return has_analytics
 
@@ -80,54 +69,14 @@ def get_analytic_table(analytics):
             "domains": domain_names,
             "description": analytic.get("description", ""),
             "deprecated": analytic.get("x_mitre_deprecated", False),
+            "detection_strategy": get_related_detection_strategies(analytic["id"]),
             "url": util.buildhelpers.get_analytic_url(analytic),
         }
         analytic_table.append(row)
 
     # sort by id
     return sorted(analytic_table, key=lambda k: k["id"])
 
-def generate_analytic_md(analytic, sidebar_data, notes):
-    """Generate markdown for individual analytic pages."""
-    attack_id = util.buildhelpers.get_attack_id(analytic)
-    if not attack_id:
-        logger.debug(f"No attack ID found on analytic: {analytic['id']}")
-        return
-
-    # build reference list
-    reference_list = { "current_number": 0 }
-    reference_list = util.buildhelpers.update_reference_list(reference_list, analytic)
-
-    dates = util.buildhelpers.get_created_and_modified_dates(analytic)
-    domains = analytic.get("x_mitre_domains", [])
-    domain_names = [util.buildhelpers.get_domain_display_name(domain) for domain in domains]
-
-    data = {
-        "attack_id": attack_id,
-        "name": analytic.get("name"),
-        "notes": notes.get(analytic["id"]),
-        "created": dates.get("created"),
-        "modified": dates.get("modified"),
-        "version": analytic.get("x_mitre_version"),
-        "description": analytic.get("description"),
-        "deprecated": analytic.get("x_mitre_deprecated", False),
-        "detection_strategies": get_related_detection_strategies(analytic["id"]),
-        "mutable_elements": analytic.get("x_mitre_mutable_elements", []),
-        "platforms": analytic.get("x_mitre_platforms", []),
-        "log_sources": build_log_source_table(analytic),
-        "domains": domain_names,
-        "citations": reference_list,
-        "sidebar_data": sidebar_data,
-        "versioning_feature": site_config.check_versions_module(),
-    }
-
-    subs = analytics_config.analytic_md.substitute(data)
-    subs += json.dumps(data)
-
-    # Write the markdown file
-    with open(os.path.join(analytics_config.analytic_markdown_path, attack_id + ".md"), "w", encoding="utf8") as md_file:
-        md_file.write(subs)
-
 
 def get_related_detection_strategies(analytic_ref):
     related_dets = util.stixhelpers.get_related_detection_strategies(analytic_ref)
@@ -138,36 +87,7 @@ def get_related_detection_strategies(analytic_ref):
     for det in related_dets:
         attack_id = util.buildhelpers.get_attack_id(det)
         det_data.append({
-            "attack_id": attack_id,
-            "name": det["name"],
+            "id": attack_id,
             "url": f"/detectionstrategies/{attack_id}"
         })
     return det_data
-
-
-def build_log_source_table(analytic):
-    log_source_table = []
-
-    log_sources = analytic.get("x_mitre_log_source_references")
-    if not log_sources:
-        logger.debug(f"No log source references found on Analytic {analytic['id']}")
-        return log_source_table
-
-    for log_source in log_sources:
-        log_source_data = {
-            "name": log_source.get("name", ""),
-            "channel": log_source.get("channel", ""),
-        }
-        datacomponent_ref = log_source.get("x_mitre_data_component_ref", None)
-        datacomponent = util.stixhelpers.get_datacomponent_from_list(datacomponent_ref)
-        if not datacomponent:
-            logger.debug(f"Log source data component not found: {log_source}")
-            log_source_data["data_component_not_found"] = True
-        else:
-            datacomponent_id = util.buildhelpers.get_attack_id(datacomponent)
-            log_source_data["data_component_name"] = datacomponent.get("name")
-            log_source_data["data_component_id"] = datacomponent_id
-            log_source_data["data_component_url"] = f"/datacomponents/{datacomponent_id}"
-
-        log_source_table.append(log_source_data)
-    return log_source_table

modules/analytics/analytics_config.py

@@ -17,8 +17,3 @@
     "save_as: analytics/index.html\n"
     "data: "
 )
-
-# String template for individual page
-analytic_md = Template(
-    "Title: ${attack_id}\nTemplate: analytics/analytic\nsave_as: analytics/${attack_id}/index.html\ndata: "
-)