Skip to content

fix: replace xml.etree with defusedxml #1793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

fix: replace xml.etree with defusedxml #1793

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbf2644
fix: replace xml.etree with defusedxml
sgoral-splunk Jun 16, 2025
45cfec8
fix: change xml to direct import
sgoral-splunk Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 23 additions & 25 deletions splunk_add_on_ucc_framework/data_ui_generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# It proposed to replace `xml` with `defusedxml` and it does not have such
# import.
# nosemgrep: splunk.use-defused-xml
from xml.etree import ElementTree as ET
from xml.etree.ElementTree import Element, SubElement, tostring
from defusedxml import minidom
from typing import Optional

Expand All @@ -40,7 +40,7 @@ def generate_nav_default_xml(

The validation is being done in `_validate_meta_default_view` function from `global_config_validator.py` file.
"""
nav = ET.Element("nav")
nav = Element("nav")
if default_view is None:
# we do this calculation as all the below properties are now optional
if include_configuration:
Expand All @@ -54,98 +54,96 @@ def generate_nav_default_xml(

if include_inputs:
if default_view == "inputs":
ET.SubElement(nav, "view", attrib={"name": "inputs", "default": "true"})
SubElement(nav, "view", attrib={"name": "inputs", "default": "true"})
else:
ET.SubElement(nav, "view", attrib={"name": "inputs"})
SubElement(nav, "view", attrib={"name": "inputs"})

if include_configuration:
if default_view == "configuration":
ET.SubElement(
nav, "view", attrib={"name": "configuration", "default": "true"}
)
SubElement(nav, "view", attrib={"name": "configuration", "default": "true"})
else:
ET.SubElement(nav, "view", attrib={"name": "configuration"})
SubElement(nav, "view", attrib={"name": "configuration"})
if include_dashboard:
if default_view == "dashboard":
ET.SubElement(nav, "view", attrib={"name": "dashboard", "default": "true"})
SubElement(nav, "view", attrib={"name": "dashboard", "default": "true"})
else:
ET.SubElement(nav, "view", attrib={"name": "dashboard"})
SubElement(nav, "view", attrib={"name": "dashboard"})
if default_view == "search":
ET.SubElement(nav, "view", attrib={"name": "search", "default": "true"})
SubElement(nav, "view", attrib={"name": "search", "default": "true"})
else:
ET.SubElement(nav, "view", attrib={"name": "search"})
SubElement(nav, "view", attrib={"name": "search"})

nav_as_string = ET.tostring(nav, encoding="unicode")
nav_as_string = tostring(nav, encoding="unicode")
return _pretty_print_xml(nav_as_string)


def generate_views_inputs_xml(addon_name: str) -> str:
"""
Generates `default/data/ui/views/inputs.xml` file.
"""
view = ET.Element(
view = Element(
"view",
attrib={
"template": f"{addon_name}:/templates/base.html",
"type": "html",
"isDashboard": "False",
},
)
label = ET.SubElement(view, "label")
label = SubElement(view, "label")
label.text = "Inputs"
view_as_string = ET.tostring(view, encoding="unicode")
view_as_string = tostring(view, encoding="unicode")
return _pretty_print_xml(view_as_string)


def generate_views_configuration_xml(addon_name: str) -> str:
"""
Generates `default/data/ui/views/configuration.xml` file.
"""
view = ET.Element(
view = Element(
"view",
attrib={
"template": f"{addon_name}:/templates/base.html",
"type": "html",
"isDashboard": "False",
},
)
label = ET.SubElement(view, "label")
label = SubElement(view, "label")
label.text = "Configuration"
view_as_string = ET.tostring(view, encoding="unicode")
view_as_string = tostring(view, encoding="unicode")
return _pretty_print_xml(view_as_string)


def generate_views_dashboard_xml(addon_name: str) -> str:
"""
Generates `default/data/ui/views/dashboard.xml` file.
"""
view = ET.Element(
view = Element(
"view",
attrib={
"template": f"{addon_name}:/templates/base.html",
"type": "html",
"isDashboard": "False",
},
)
label = ET.SubElement(view, "label")
label = SubElement(view, "label")
label.text = "Monitoring Dashboard"
view_as_string = ET.tostring(view, encoding="unicode")
view_as_string = tostring(view, encoding="unicode")
return _pretty_print_xml(view_as_string)


def generate_views_redirect_xml(addon_name: str) -> str:
"""
Generates `default/data/ui/views/redirect.xml` file.
"""
view = ET.Element(
view = Element(
"view",
attrib={
"template": f"{addon_name}:templates/{addon_name.lower()}_redirect.html",
"type": "html",
"isDashboard": "False",
},
)
label = ET.SubElement(view, "label")
label = SubElement(view, "label")
label.text = "Redirect"
view_as_string = ET.tostring(view, encoding="unicode")
view_as_string = tostring(view, encoding="unicode")
return _pretty_print_xml(view_as_string)
Loading