1 .. _xml: 2 3 XML Processing Modules 4 ====================== 5 6 .. module:: xml 7 :synopsis: Package containing XML processing modules 8 9 .. sectionauthor:: Christian Heimes <christian (a] python.org> 10 .. sectionauthor:: Georg Brandl <georg (a] python.org> 11 12 **Source code:** :source:`Lib/xml/` 13 14 -------------- 15 16 Python's interfaces for processing XML are grouped in the ``xml`` package. 17 18 .. warning:: 19 20 The XML modules are not secure against erroneous or maliciously 21 constructed data. If you need to parse untrusted or 22 unauthenticated data see the :ref:`xml-vulnerabilities` and 23 :ref:`defused-packages` sections. 24 25 It is important to note that modules in the :mod:`xml` package require that 26 there be at least one SAX-compliant XML parser available. The Expat parser is 27 included with Python, so the :mod:`xml.parsers.expat` module will always be 28 available. 29 30 The documentation for the :mod:`xml.dom` and :mod:`xml.sax` packages are the 31 definition of the Python bindings for the DOM and SAX interfaces. 32 33 The XML handling submodules are: 34 35 * :mod:`xml.etree.ElementTree`: the ElementTree API, a simple and lightweight 36 XML processor 37 38 .. 39 40 * :mod:`xml.dom`: the DOM API definition 41 * :mod:`xml.dom.minidom`: a minimal DOM implementation 42 * :mod:`xml.dom.pulldom`: support for building partial DOM trees 43 44 .. 45 46 * :mod:`xml.sax`: SAX2 base classes and convenience functions 47 * :mod:`xml.parsers.expat`: the Expat parser binding 48 49 50 .. _xml-vulnerabilities: 51 52 XML vulnerabilities 53 ------------------- 54 55 The XML processing modules are not secure against maliciously constructed data. 56 An attacker can abuse XML features to carry out denial of service attacks, 57 access local files, generate network connections to other machines, or 58 circumvent firewalls. 59 60 The following table gives an overview of the known attacks and whether 61 the various modules are vulnerable to them. 62 63 ========================= ============== =============== ============== ============== ============== 64 kind sax etree minidom pulldom xmlrpc 65 ========================= ============== =============== ============== ============== ============== 66 billion laughs **Vulnerable** **Vulnerable** **Vulnerable** **Vulnerable** **Vulnerable** 67 quadratic blowup **Vulnerable** **Vulnerable** **Vulnerable** **Vulnerable** **Vulnerable** 68 external entity expansion Safe (4) Safe (1) Safe (2) Safe (4) Safe (3) 69 `DTD`_ retrieval Safe (4) Safe Safe Safe (4) Safe 70 decompression bomb Safe Safe Safe Safe **Vulnerable** 71 ========================= ============== =============== ============== ============== ============== 72 73 1. :mod:`xml.etree.ElementTree` doesn't expand external entities and raises a 74 :exc:`ParserError` when an entity occurs. 75 2. :mod:`xml.dom.minidom` doesn't expand external entities and simply returns 76 the unexpanded entity verbatim. 77 3. :mod:`xmlrpclib` doesn't expand external entities and omits them. 78 4. Since Python 3.7.1, external general entities are no longer processed by 79 default. 80 81 82 billion laughs / exponential entity expansion 83 The `Billion Laughs`_ attack -- also known as exponential entity expansion -- 84 uses multiple levels of nested entities. Each entity refers to another entity 85 several times, and the final entity definition contains a small string. 86 The exponential expansion results in several gigabytes of text and 87 consumes lots of memory and CPU time. 88 89 quadratic blowup entity expansion 90 A quadratic blowup attack is similar to a `Billion Laughs`_ attack; it abuses 91 entity expansion, too. Instead of nested entities it repeats one large entity 92 with a couple of thousand chars over and over again. The attack isn't as 93 efficient as the exponential case but it avoids triggering parser countermeasures 94 that forbid deeply-nested entities. 95 96 external entity expansion 97 Entity declarations can contain more than just text for replacement. They can 98 also point to external resources or local files. The XML 99 parser accesses the resource and embeds the content into the XML document. 100 101 `DTD`_ retrieval 102 Some XML libraries like Python's :mod:`xml.dom.pulldom` retrieve document type 103 definitions from remote or local locations. The feature has similar 104 implications as the external entity expansion issue. 105 106 decompression bomb 107 Decompression bombs (aka `ZIP bomb`_) apply to all XML libraries 108 that can parse compressed XML streams such as gzipped HTTP streams or 109 LZMA-compressed 110 files. For an attacker it can reduce the amount of transmitted data by three 111 magnitudes or more. 112 113 The documentation for `defusedxml`_ on PyPI has further information about 114 all known attack vectors with examples and references. 115 116 .. _defused-packages: 117 118 The :mod:`defusedxml` and :mod:`defusedexpat` Packages 119 ------------------------------------------------------ 120 121 `defusedxml`_ is a pure Python package with modified subclasses of all stdlib 122 XML parsers that prevent any potentially malicious operation. Use of this 123 package is recommended for any server code that parses untrusted XML data. The 124 package also ships with example exploits and extended documentation on more 125 XML exploits such as XPath injection. 126 127 `defusedexpat`_ provides a modified libexpat and a patched 128 :mod:`pyexpat` module that have countermeasures against entity expansion 129 DoS attacks. The :mod:`defusedexpat` module still allows a sane and configurable amount of entity 130 expansions. The modifications may be included in some future release of Python, 131 but will not be included in any bugfix releases of 132 Python because they break backward compatibility. 133 134 135 .. _defusedxml: https://pypi.org/project/defusedxml/ 136 .. _defusedexpat: https://pypi.org/project/defusedexpat/ 137 .. _Billion Laughs: https://en.wikipedia.org/wiki/Billion_laughs 138 .. _ZIP bomb: https://en.wikipedia.org/wiki/Zip_bomb 139 .. _DTD: https://en.wikipedia.org/wiki/Document_type_definition 140
