XML External Entity (XXE) Processing

Last revision (mm/dd/yy): //

Vulnerabilities Table of Contents

Description
Processing of an external entity containing tainted data may lead to disclosure of confidential information and other system impacts.

The XML 1.0 standard defines the structure of an XML document. The standard defines a concept called an entity, which is a storage unit of some type. There exists a specific type of entity, an external general parsed entity often shortened to an external entity, that can access local or remote content via a declared system identifier. The system identifier is assumed to be a URI that can be dereferenced (accessed) by the XML processor when processing the entity. The XML processor then replaces occurrences of the named external entity with the contents dereferenced by the system identifier. If the system identifier contains tainted data and the XML processor dereferences this tainted data, the XML processor may disclose confidential information normally not accessible by the application.

Attacks can include disclosing local files, which may contain sensitive data such as passwords or private user data, using file: schemes or relative paths in the system identifier. Since the attack occurs relative to the application processing the XML document, an attacker may use this trusted application to pivot to other internal systems, possibly disclosing other internal content via http(s) requests. In some situations, an XML processor library that is vulnerable to client-side memory corruption issues may be exploited by dereferencing a malicious URI, possibly allowing arbitrary code execution under the application account. Other attacks can access local resources that may not stop returning data, possibly impacting application availability if too many threads or processes are not released.

Risk Factors

 * The application parses XML documents.
 * Tainted data is allowed within the system identifier portion of the entity, within the document type declaration (DTD).
 * The XML processor is configured to validate and process the DTD.
 * The XML processor is configured to resolve external entities within the DTD.

Examples
The examples below are from Testing for XML Injection (OWASP-DV-008).

Accessing a local resource that may not return
'''  <!DOCTYPE foo > &xxe; '''

Disclosing /etc/passwd or other targeted files
'''  <!DOCTYPE foo > &xxe;

 <!DOCTYPE foo > &xxe;

 <!DOCTYPE foo > &xxe;

 <!DOCTYPE foo [ <!ELEMENT foo ANY > <!ENTITY xxe SYSTEM "http://www.attacker.com/text.txt" >]> &xxe; '''

Related Attacks

 * SQL Injection
 * Blind SQL Injection

Related Vulnerabilities

 * Missing XML Validation

Related Controls
Since the whole XML document is communicated from an untrusted client, it's not usually possible to selectively validate or escape tainted data within the system identifier in the DTD. Therefore, the XML processor should be configured to use a local static DTD and disallow any declared DTD included in the XML document.

Testing ought to occur with specific implementations for any controls documented below.

libxml2
The Enum xmlParserOption should not have the following options defined:


 * XML_PARSE_NOENT: Expands entities and substitutes them with replacement text
 * XML_PARSE_DTDLOAD: Load the external DTD

Java
Java applications using XML libraries are particularly vulnerable to XXE because the default settings for most Java XML parsers is to have XXE enabled. To use these parsers safely, you have to explicitly disable XXE in the parser you use. The following describes how to disable XXE in the most commonly used XML parsers for Java.

JAXP DOM and DocumentBuilderFactory
The DocumentBuilderFactory setFeature method allows a developer to control which implementation-specific XML processor features are enabled or disabled. Each XML processor implementation has its own features that govern how DTDs and external entities are processed.

Xerces 1 Features:
 * Do not include external entities by setting this feature to.

Xerces 2 Features:
 * Disallow an inline DTD by setting this feature to.
 * Do not include external entities by setting this feature to.

JAXP SAX and SAXParserFactory
The SAXParserFactory setFeature method allows a developer to control which implementation-specific XML processor features are enabled or disabled. Each XML processor implementation has its own features that govern how DTDs and external entities are processed.

Xerces 1 Features:
 * Do not include external entities by setting this feature to.

Xerces 2 Features:
 * Disallow an inline DTD by setting this feature to.
 * Do not include external entities by setting this feature to.

StAX and XMLInputFactory
The StAX XMLInputFactory can allow properties and features to be set.

Disallow Resolving of External Entities:
 * Set the "javax.xml.stream.isSupportingExternalEntities" property to.