Due to its platform independence, flexibility and relative simplicity, extensible markup language (XML) has been widely adopted in a wide variety of applications, from remote procedure calls to data storage. However, because of its versatility, XML is vulnerable to attacks which change the structure of the document. These attacks can be broadly classified into two types: XML Injection and XPath Injection.
XPath injection occurs when an XML document is Extensible Markup Language (XML) can be used for data storage in a manner similar to a relational database. This way, an XPath injection is similar to an SQL injection attack, where an attack is able to include query logic in a data field in such a way the Data is frequently retrieved from such an XML document using XPaths. XPath injection can occur when data supplied to an XPath retrieval routine to retrieve data from an XML document is used without proper sanitization. This attack is similar to SQL injection or XML injection (see IDS00-J. Sanitize untrusted data passed across a trust boundary). An attacker can enter valid SQL or XML constructs in the data fields of the query in use. In typical attacks, the conditional field of the query resolves as to a tautology or otherwise gives the attacker access to information it should not be entitled to.
...
privileged information.
This guideline is a specific example of the broadly scoped IDS52-J. Prevent code injection.
XML Path Injection Example
Consider the following XML document being used as a databaseschema:
No Formatcode |
---|
<users> <user> <login>Utah<<username>Utah</login>username> <password>test123<<password>e90205372a3b89e2</password> </user> <user> <login>Bohdi<<username>Bohdi</login>username> <password>password<<password>6c16b22029df4ec6</password> </user> <user> <login>Busey<<username>Busey</login>username> <password>abc123<<password>ad39b3c2a4dabc98</password> </user> </users> |
The passwords are hashed in compliance with MSC62-J. Store passwords using a hash function. MD5 hashes are shown here for illustrative purposes; in practice, you should use a safer algorithm such as SHA-256.
Untrusted code may Unsafe code will attempt to retrieve a user details from this file with an XPath statement constructed dynamically from user input.
Code Block |
---|
No Format |
str_query = "//users/user[LoginIDusername/text()= " & login & " '&LOGIN&' and password/text()=" & password & "]" |
Therefore, the user may specify input such as login = "' or 1=1
" and password = "' or 1=1
", yielding the following query string:
'&PASSWORD&' ]
|
If an attacker knows that Utah
is a valid user name, he or she can specify an input such as
Code Block |
---|
Utah' or '1'='1
|
This yields the following query string.
Code Block |
---|
No Format |
//users/user[LoginIDusername/text()='Utah' or '1'='1 ' and password/text()='' or 1=1] |
This will subsequently reveal all the records in the XML file
Noncompliant Code Example
XML Injection may occur when:
- Data is read from an untrusted source (such as user input)
- Data is subsequently written to an XPath query string without proper sanitization.
xxxx']
|
Because the '1'='1'
is automatically true, the password is never validated. Consequently, the attacker is inappropriately authenticated as user Utah
without knowing Utah
's password.
Noncompliant Code Example
This noncompliant code example reads a user name and password from the user and uses them to construct the query string. The password is passed as a char
array and then hashed. This example is vulnerable to the attack described earlier. If the attack string described earlier is passed to evaluate()
, the method call returns the corresponding node in the XML file, causing the doLogin()
method to return true
and bypass any authorizationConsider the following example in which a login and password are read from the user and used to construct the query string, in the context of the attack illustrated above.
Code Block | ||
---|---|---|
| ||
import java.io.IOException; import org.w3c.dom.*; import org.xml.sax.SAXException; import javax.xml.parsers.*; import javax.xml.xpath.*; public class XpathInjectionExample { public private boolean doLogin(String loginIDuserName, Stringchar[] password) throws ParserConfigurationException, SAXException, IOException, XPathExpressionException { DocumentBuilderFactory domFactory = DocumentBuilderFactory.newInstance(); domFactory.setNamespaceAware(true); DocumentBuilder builder = domFactory.newDocumentBuilder(); Document doc = builder.parse("users.xml"); String pwd = hashPassword( password); XPathFactory factory = XPathFactory.newInstance(); XPath xpath = factory.newXPath(); XPathExpression expr = xpath.compile("//users/user[loginusername/text()='"+login+ + userName + "' and password/text()='" +password pwd + "' ]"); Object result = expr.evaluate(doc, XPathConstants.NODESET); NodeList nodes = (NodeList) result; //print Print first names to the console for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i).getChildNodes().item(1).getChildNodes().item(0); System.out.println(nodes.item(i).getNodeValue());} if (nodes.getLength() >= 1) { return true;} else {return false;} } } |
The evaluate function call will return a set of all nodes in the XML file, causing the login function to return true, and bypassing authorization.
Compliant Solution
XPath injection can be prevented with many of the same methods used to prevent SQL injection, and input sanitization in general. These methods include:
- Assume all input may include an attack.
- When validating user input, verify the data type, length, format and contents. For example, construct a regular expression that checks for XML tags and special characters in user input.
- In a client-server application, perform validation at both the client and server.
- Extensively test applications which supply user input.
Code Block | ||
---|---|---|
| ||
//Compliant Solution will go here
|
Risk Assessment
Failing to validate user input may result in a Java application being seriously compromised.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
FIO06-J | medium | probable | high | P4 | L3 |
Automated Detection
TODO
Related Vulnerabilities
MSC37-J. Prevent XML Injection
MSC34-J. Prevent against SQL Injection
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
References
Sun Microsystems Java Developer Network
"Authenticated: " + node.getNodeValue());
}
return (nodes.getLength() >= 1);
}
|
Compliant Solution (XQuery)
XPath injection can be prevented by adopting defenses similar to those used to prevent SQL injection:
- Treat all user input as untrusted, and perform appropriate sanitization.
- When sanitizing user input, verify the correctness of the data type, length, format, and content. For example, use a regular expression that checks for XML tags and special characters in user input. This practice corresponds to input sanitization. See IDS52-J. Prevent code injection for additional details.
- In a client-server application, perform validation at both the client and the server sides.
- Extensively test applications that supply, propagate, or accept user input.
An effective technique for preventing the related issue of SQL injection is parameterization. Parameterization ensures that user-specified data is passed to an API as a parameter such that the data is never interpreted as executable content. Unfortunately, Java SE currently lacks an analogous interface for XPath queries. However, an XPath analog to SQL parameterization can be emulated by using an interface such as XQuery that supports specifying a query statement in a separate file supplied at runtime.
Input File: login.qry
Code Block |
---|
declare variable $userName as xs:string external;
declare variable $password as xs:string external;
//users/user[@userName=$userName and @password=$password]
|
This compliant solution uses a query specified in a text file by reading the file in the required format and then inserting values for the user name and password in a Map
. The XQuery
library constructs the XML query from these inputs.
Code Block | ||
---|---|---|
| ||
private boolean doLogin(String userName, String pwd)
throws ParserConfigurationException, SAXException, IOException, XPathExpressionException {
DocumentBuilderFactory domFactory = DocumentBuilderFactory.newInstance();
domFactory.setNamespaceAware(true);
DocumentBuilder builder = domFactory.newDocumentBuilder();
Document doc = builder.parse("users.xml");
XQuery xquery = new XQueryFactory().createXQuery(new File("login.xq"));
Map queryVars = new HashMap();
queryVars.put("userName", userName);
queryVars.put("password", pwd);
NodeList nodes = xquery.execute(doc, null, queryVars).toNodes();
// Print first names to the console
for (int i = 0; i < nodes.getLength(); i++) {
Node node = nodes.item(i).getChildNodes().item(1).getChildNodes().item(0);
System.out.println(node.getNodeValue());
}
return (nodes.getLength() >= 1);
}
|
Using this method, the data specified in the userName
and password
fields cannot be interpreted as executable content at runtime.
Applicability
Failure to validate user input may result in information disclosure and execution of unprivileged code.
According to OWASP [OWASP 2014],
[Prevention of XPath injection] requires the following characters to be removed (that is, prohibited) or properly escaped:
< > / ' = "
to prevent straight parameter injection.- XPath queries should not contain any meta characters (such as
' = * ? //
or similar).- XSLT expansions should not contain any user input, or if they do, [you should] comprehensively test the existence of the file, and ensure that the files are within the bounds set by the Java 2 Security Policy.
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
The Checker Framework |
| Tainting Checker | Trust and security errors (see Chapter 8) | ||||||
Parasoft Jtest |
| CERT.IDS53.TDJXPATH CERT.IDS53.TDXPATH | Protect against JXPath injection Protect against XPath injection |
Bibliography
[Fortify 2008] | "Input Validation and Representation: XML Injection" |
[Oracle 2011b] | Ensure Data Security |
[OWASP 2014] | Testing for XPath Injection |
[Sen 2007] | Avoid the Dangers of XPath Injection |
[Sun 2006] | Ensure Data Security |
...