Skip to content

fix(LicenseInfo): harden XML parsers against XXE in SPDXParser and AbstractCLIParser #3891

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
saiteja-in wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(LicenseInfo): harden XML parsers against XXE in SPDXParser and AbstractCLIParser #3891

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
2 changes: 2 additions & 0 deletions ...nd/licenseinfo/src/main/java/org/eclipse/sw360/licenseinfo/parsers/AbstractCLIParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ private Stream<Node> streamFromNodeList(NodeList nodes) {

protected <T> boolean hasThisXMLRootElement(AttachmentContent content, String rootElementNamespace, String rootElementName, User user, T context) throws TException {
XMLInputFactory xmlif = XMLInputFactory.newFactory();
xmlif.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false);
xmlif.setProperty(XMLInputFactory.SUPPORT_DTD, false);
XMLStreamReader xmlStreamReader = null;
InputStream attachmentStream = null;
try {
Expand Down
8 changes: 7 additions & 1 deletion backend/licenseinfo/src/main/java/org/eclipse/sw360/licenseinfo/parsers/SPDXParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,14 @@ protected String getUriOfAttachment(AttachmentContent attachmentContent) throws

protected <T> Optional<Document> openAsSpdx(AttachmentContent attachmentContent, User user, T context) throws SW360Exception {
try (InputStream attachmentStream = attachmentConnector.getAttachmentStream(attachmentContent, user, context)) {
DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newDefaultInstance();
dbFactory.setNamespaceAware(true);
dbFactory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
dbFactory.setFeature("http://xml.org/sax/features/external-general-entities", false);
dbFactory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
dbFactory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
dbFactory.setXIncludeAware(false);
dbFactory.setExpandEntityReferences(false);
DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
Document doc = dBuilder.parse(attachmentStream);
doc.getDocumentElement().normalize();
Expand Down
64 changes: 63 additions & 1 deletion backend/licenseinfo/src/test/java/org/eclipse/sw360/licenseinfo/parsers/SPDXParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@
import org.eclipse.sw360.datahandler.common.SW360Constants;
import org.eclipse.sw360.datahandler.common.SW360Utils;
import org.eclipse.sw360.datahandler.couchdb.AttachmentConnector;
import org.eclipse.sw360.datahandler.thrift.SW360Exception;
import org.eclipse.sw360.datahandler.thrift.Visibility;
import org.eclipse.sw360.datahandler.thrift.attachments.Attachment;
import org.eclipse.sw360.datahandler.thrift.attachments.AttachmentContent;
import org.eclipse.sw360.datahandler.thrift.attachments.AttachmentType;
import org.eclipse.sw360.datahandler.thrift.licenseinfo.LicenseInfo;
import org.eclipse.sw360.datahandler.thrift.licenseinfo.LicenseInfoParsingResult;
import org.eclipse.sw360.datahandler.thrift.licenseinfo.LicenseInfoRequestStatus;
import org.eclipse.sw360.datahandler.thrift.licenseinfo.LicenseNameWithText;
import org.eclipse.sw360.datahandler.thrift.projects.Project;
import org.eclipse.sw360.datahandler.thrift.users.User;
Expand All @@ -41,7 +43,9 @@
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.*;

import static org.eclipse.sw360.licenseinfo.TestHelper.*;
Expand Down Expand Up @@ -138,8 +142,14 @@ public void testAddSPDXContentToCLI(String exampleFile, List<String> expectedLic
.setFilename(exampleFile);

InputStream input = makeAttachmentContentStream(exampleFile);
DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newDefaultInstance();
dbFactory.setNamespaceAware(true);
dbFactory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
dbFactory.setFeature("http://xml.org/sax/features/external-general-entities", false);
dbFactory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
dbFactory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
dbFactory.setXIncludeAware(false);
dbFactory.setExpandEntityReferences(false);
DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
Document spdxDocument = dBuilder.parse(input);
spdxDocument.getDocumentElement().normalize();
Expand Down Expand Up @@ -177,4 +187,56 @@ public void testGetLicenseInfo(String exampleFile, List<String> expectedLicenses
exampleCopyright, exampleConcludedLicenseIds);
}
}

@Test
public void testXXEAttackIsBlocked() throws Exception {
String xxePayload = "<?xml version=\"1.0\"?>\n" +
"<!DOCTYPE foo [\n" +
" <!ENTITY xxe SYSTEM \"file:///etc/passwd\">\n" +
"]>\n" +
"<rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"\n" +
" xmlns:spdx=\"http://spdx.org/rdf/terms#\">\n" +
" <spdx:SpdxDocument>\n" +
" <spdx:name>&xxe;</spdx:name>\n" +
" </spdx:SpdxDocument>\n" +
"</rdf:RDF>";

AttachmentContent attachmentContent = new AttachmentContent()
.setId("xxe-test")
.setFilename("malicious.rdf");

// Register content in the store (so AttachmentContentProvider can resolve it),
// then override the mock to return our XXE payload instead of a file resource.
attachmentContentStore.put(attachmentContent);
InputStream xxeStream = new ByteArrayInputStream(xxePayload.getBytes(StandardCharsets.UTF_8));
Mockito.when(connector.getAttachmentStream(Mockito.eq(attachmentContent), Mockito.any(), Mockito.any()))
.thenReturn(xxeStream);

// With disallow-doctype-decl=true, the parser rejects DOCTYPE declarations.
// openAsSpdx catches SAXException and throws SW360Exception, but
// getLicenseInfo wraps it and returns FAILURE status.
Attachment attachment = new Attachment()
.setAttachmentContentId("xxe-test")
.setFilename("malicious.rdf")
.setAttachmentType(AttachmentType.COMPONENT_LICENSE_INFO_XML);

// The parser should reject the XXE payload. With disallow-doctype-decl=true,
// openAsSpdx throws SW360Exception (wrapping SAXException) when it encounters DOCTYPE.
try {
LicenseInfoParsingResult result = parser.getLicenseInfos(attachment, dummyUser,
new Project()
.setVisbility(Visibility.ME_AND_MODERATORS)
.setCreatedBy(dummyUser.getEmail())
.setAttachments(Collections.singleton(new Attachment().setAttachmentContentId("xxe-test"))))
.stream()
.findFirst()
.orElse(null);

// If no exception, result must not be SUCCESS
assertTrue("XXE payload should not be parsed successfully",
result == null || result.getStatus() != LicenseInfoRequestStatus.SUCCESS);
} catch (SW360Exception e) {
// Expected — parser rejects DOCTYPE declaration and throws SW360Exception
}
}
}
Loading