Skip to content

harden SOAPPart.setContent xml parser against xxe #1221

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.

Sign up for GitHub

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

Open
digi-scrypt wants to merge 1 commit into
base: master
Choose a base branch
from
Open

harden SOAPPart.setContent xml parser against xxe #1221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions modules/saaj/src/org/apache/axis2/saaj/SOAPPartImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,11 @@ public void setContent(Source source) throws SOAPException {
ByteArrayOutputStream baos = new ByteArrayOutputStream();

XMLInputFactory inputFactory = XMLInputFactory.newInstance();
// Reject DTDs and external entities so a StreamSource carrying a
// DOCTYPE cannot pull in local files or remote URLs (XXE).
inputFactory.setProperty(XMLInputFactory.SUPPORT_DTD, false);
inputFactory.setProperty(
XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false);
XMLStreamReader reader;

if (source instanceof StreamSource) {
Expand Down
34 changes: 34 additions & 0 deletions modules/saaj/test/org/apache/axis2/saaj/SOAPPartTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,15 @@
import jakarta.xml.soap.SOAPHeader;
import jakarta.xml.soap.SOAPHeaderElement;
import jakarta.xml.soap.SOAPMessage;
import jakarta.xml.soap.SOAPException;
import jakarta.xml.soap.SOAPPart;
import jakarta.xml.soap.Text;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamSource;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileWriter;
import java.io.StringReader;
import java.util.Iterator;

/**
Expand Down Expand Up @@ -82,6 +87,35 @@ public void testAddSource() throws Exception {
getContents(iter2, "");
}

@Test
public void testSetContentRejectsExternalEntity() throws Exception {
File secret = File.createTempFile("saaj-xxe", ".txt");
secret.deleteOnExit();
String marker = "SAAJ_XXE_SECRET_MARKER";
try (FileWriter w = new FileWriter(secret)) {
w.write(marker);
}
String xml =
"<?xml version=\"1.0\"?>\n" +
"<!DOCTYPE x [ <!ENTITY xxe SYSTEM \"" + secret.toURI() + "\"> ]>\n" +
"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\">" +
"<soapenv:Body><item>&xxe;</item></soapenv:Body></soapenv:Envelope>";

SOAPMessage message = MessageFactory.newInstance().createMessage();
SOAPPart soapPart = message.getSOAPPart();
try {
soapPart.setContent(new StreamSource(new StringReader(xml)));
message.saveChanges();
} catch (SOAPException expected) {
// DTD rejected outright is also fine
return;
}
ByteArrayOutputStream out = new ByteArrayOutputStream();
message.writeTo(out);
assertFalse("external entity must not be expanded into the message",
out.toString("UTF-8").contains(marker));
}

public void getContents(Iterator iterator, String indent) {
while (iterator.hasNext()) {
Node node = (Node)iterator.next();
Expand Down