Improper Restriction of XML External Entity Reference

Draft Base
Structure: Simple
Description

The product processes an XML document that can contain XML entities with URIs that resolve to documents outside of the intended sphere of control, causing the product to embed incorrect documents into its output.

Extended Description

XML documents optionally contain a Document Type Definition (DTD), which, among other features, enables the definition of XML entities. It is possible to define an entity by providing a substitution string in the form of a URI. The XML parser can access the contents of this URI and embed these contents back into the XML document for further processing. By submitting an XML file that defines an external entity with a file:// URI, an attacker can cause the processing application to read the contents of a local file. For example, a URI such as "file:///c:/winnt/win.ini" designates (in Windows) the file C:\Winnt\win.ini, or file:///etc/passwd designates the password file in Unix-based systems. Using URIs with other schemes such as http://, the attacker can force the application to make outgoing requests to servers that the attacker cannot reach directly, which can be used to bypass firewall restrictions or hide the source of attacks such as port scanning. Once the content of the URI is read, it is fed back into the application that is processing the XML. This application may echo back the data (e.g. in an error message), thereby exposing the file contents.

Common Consequences 3
Scope: Confidentiality

Impact: Read Application DataRead Files or Directories

If the attacker is able to include a crafted DTD and a default entity resolver is enabled, the attacker may be able to access arbitrary files on the system.

Scope: Integrity

Impact: Bypass Protection Mechanism

The DTD may include arbitrary HTTP requests that the server may execute. This could lead to other attacks leveraging the server's trust relationship with other entities.

Scope: Availability

Impact: DoS: Resource Consumption (CPU)DoS: Resource Consumption (Memory)

The product could consume excessive CPU cycles or memory using a URI that points to a large file, or a device that always returns data such as /dev/random. Alternately, the URI could reference a file that contains many nested or recursive entity references to further slow down parsing.

Detection Methods 1
Automated Static AnalysisHigh
Automated static analysis, commonly referred to as Static Application Security Testing (SAST), can find some instances of this weakness by analyzing source code (or binary/compiled code) without having to execute it. Typically, this is done by building a model of data flow and control flow, then searching for potentially-vulnerable patterns that connect "sources" (origins of input) with "sinks" (destinations where the data interacts with external components, a lower layer such as the OS, etc.)
Potential Mitigations 1
Phase: ImplementationSystem Configuration
Many XML parsers and validators can be configured to disable external entity expansion.
Observed Examples 11
CVE-2022-42745Recruiter software allows reading arbitrary files using XXE
CVE-2005-1306A browser control can allow remote attackers to determine the existence of files via Javascript containing XML script.
CVE-2012-5656XXE during SVG image conversion
CVE-2012-2239XXE in PHP application allows reading the application's configuration file.
CVE-2012-3489XXE in database server
CVE-2012-4399XXE in rapid web application development framework allows reading arbitrary files.
CVE-2012-3363XXE via XML-RPC request.
CVE-2012-0037XXE in office document product using RDF.
CVE-2011-4107XXE in web-based administration tool for database.
CVE-2010-3322XXE in product that performs large-scale data analysis.
CVE-2009-1699XXE in XSL stylesheet functionality in a common library used by some web browsers.
References 6
XML External Entity (XXE) Processing
OWASP
ID: REF-496
XML External Entity Attacks (XXE)
Sascha Herzog
20-10-2010
ID: REF-497
XXE (Xml eXternal Entity) Attack
Gregory Steuck
ID: REF-498
XML External Entities (XXE) Attack
WASC
ID: REF-499
XML Denial of Service Attacks and Defenses
Bryan Sullivan
09-2009
ID: REF-500
Preventing XXE in PHP
Chris Cornutt
ID: REF-501
Applicable Platforms
Languages:
XML : Undetermined
Technologies:
Web Based : Undetermined
Modes of Introduction
Implementation
Related Attack Patterns
Alternate Terms

XXE

An acronym used for the term "XML eXternal Entities"
Taxonomy Mapping
  • WASC
  • Software Fault Patterns
Notes
RelationshipServer-Side Request Forgery (SSRF) (SSRF) and Improper Restriction of XML External Entity Reference (XXE) are closely related, because they both involve web-related technologies and can launch outbound requests to unexpected destinations. However, XXE can be performed client-side, or in other contexts in which the software is not acting directly as a server, so the "Server" portion of the SSRF acronym does not necessarily apply.