Use defusedxml for Parsing XML

[pixeebot]

You might be surprised to learn that Python's built-in XML libraries are considered insecure against various kinds of attacks.

In fact, the Python documentation itself recommends the use of defusedxml for parsing untrusted XML data. defusedxml is an open-source, permissively licensed project that is intended as a drop-in replacement for Python's standard library XML parsers.

This codemod updates all relevant uses of the standard library parsers with safe versions from defusedxml. It also adds the defusedxml dependency to your project where possible.

The changes from this codemod look like this:

- from xml.etree.ElementTree import parse
+ import defusedxml.ElementTree

- et = parse('data.xml')
+ et = defusedxml.ElementTree.parse('data.xml')

Dependency Updates

This codemod relies on an external dependency. However, we were unable to automatically add the dependency to your project.

This package is recommended by the Python community to protect against XML vulnerabilities.

There are a number of places where Python project dependencies can be expressed, including setup.py, pyproject.toml, setup.cfg, and requirements.txt files. You may need to manually add this dependency to the proper location in your project.

Manual Installation

For setup.py:

 install_requires=[
+    "defusedxml==0.7.1",
 ],

For pyproject.toml (using setuptools):

 [project]
 dependencies = [
+    "defusedxml==0.7.1",
 ]

For setup.cfg:

 [options]
 install_requires =
+    defusedxml==0.7.1

For requirements.txt:

+defusedxml==0.7.1

For more information on adding dependencies to setuptools projects, see the setuptools documentation.

If you are using another build system, please refer to the documentation for that system to determine how to add dependencies.

More reading

• https://docs.python.org/3/library/xml.html#xml-vulnerabilities
• https://docs.python.org/3/library/xml.html#the-defusedxml-package
• https://pypi.org/project/defusedxml/
• https://cheatsheetseries.owasp.org/cheatsheets/XML_External_Entity_Prevention_Cheat_Sheet.html

I have additional improvements ready for this repo! If you want to see them, leave the comment:

@pixeebot next

... and I will open a new PR right away!

🧚🤖 Powered by Pixeebot

💬Feedback | 👥Community | 📚Docs | Codemod ID: pixee:python/use-defusedxml

[rewtd]

Looks like a solid suggestion

[github-actions]

🤖 Pull request artifacts

The generated Cornucopia cards in this pull request.

file	commit
owasp_cornucopia_webapp_guide_en_1.22_dynamic.docx	06dde29
owasp_cornucopia_webapp_cards_en_1.22_leaflet.idml	06dde29
owasp_cornucopia_webapp_guide_en_1.22_static.docx	06dde29
owasp_cornucopia_webapp_cards_en_1.22_static.idml	06dde29
owasp_cornucopia_webapp_guide_es_1.22_static.docx	06dde29
owasp_cornucopia_webapp_guide_fr_1.22_static.docx	06dde29
owasp_cornucopia_webapp_guide_nl_1.22_static.docx	06dde29
owasp_cornucopia_webapp_guide_no-nb_1.22_static.docx	06dde29
owasp_cornucopia_webapp_guide_pt-br_1.22_static.docx	06dde29
owasp_cornucopia_webapp_guide_en_2.00_dynamic.docx	06dde29
owasp_cornucopia_webapp_guide_en_2.00_static.docx	06dde29
owasp_cornucopia_webapp_cards_en_2.00_leaflet.idml	06dde29
owasp_cornucopia_webapp_cards_en_2.00_static.idml	06dde29
owasp_cornucopia_webapp_guide_es_2.00_static.docx	06dde29
owasp_cornucopia_webapp_guide_fr_2.00_static.docx	06dde29
owasp_cornucopia_webapp_guide_nl_2.00_static.docx	06dde29
owasp_cornucopia_webapp_guide_no-nb_2.00_static.docx	06dde29
owasp_cornucopia_webapp_guide_pt-br_2.00_static.docx	06dde29
owasp_cornucopia_mobileapp_cards_en_1.00_static.idml	06dde29
owasp_cornucopia_mobileapp_cards_en_1.00_leaflet.idml	06dde29