Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id F050C200CFD for ; Wed, 6 Sep 2017 19:14:01 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id EEE831609C5; Wed, 6 Sep 2017 17:14:01 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id C09901609BB for ; Wed, 6 Sep 2017 19:14:00 +0200 (CEST) Received: (qmail 82208 invoked by uid 500); 6 Sep 2017 17:14:00 -0000 Mailing-List: contact commits-help@nifi.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@nifi.apache.org Delivered-To: mailing list commits@nifi.apache.org Received: (qmail 82199 invoked by uid 99); 6 Sep 2017 17:13:59 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 06 Sep 2017 17:13:59 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 3DE59F32D2; Wed, 6 Sep 2017 17:13:58 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mcgilman@apache.org To: commits@nifi.apache.org Message-Id: <8e1df7d7a1124712ad23e424d2f44d0e@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: nifi git commit: NIFI-4353 Implemented new JAXB logic. Added unit test and template test resource. Added RAT exclusion. This closes #2128 Date: Wed, 6 Sep 2017 17:13:58 +0000 (UTC) archived-at: Wed, 06 Sep 2017 17:14:02 -0000 Repository: nifi Updated Branches: refs/heads/master c3754c392 -> 0536c3edf NIFI-4353 Implemented new JAXB logic. Added unit test and template test resource. Added RAT exclusion. This closes #2128 Project: http://git-wip-us.apache.org/repos/asf/nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/0536c3ed Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/0536c3ed Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/0536c3ed Branch: refs/heads/master Commit: 0536c3edf146b27c50e26c026e4cce2c1624acbd Parents: c3754c3 Author: Andy LoPresto Authored: Tue Sep 5 18:50:12 2017 -0700 Committer: Matt Gilman Committed: Wed Sep 6 13:13:24 2017 -0400 ---------------------------------------------------------------------- .../nifi-framework/nifi-framework-core/pom.xml | 1 + .../nifi/persistence/TemplateDeserializer.java | 16 +- .../persistence/TemplateDeserializerTest.groovy | 66 ++++++ .../src/test/resources/xxe_template.xml | 230 +++++++++++++++++++ 4 files changed, 309 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi/blob/0536c3ed/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml index 9d00f49..4989be6 100644 --- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml +++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml @@ -205,6 +205,7 @@ src/test/resources/hello.txt src/test/resources/bye.txt src/test/resources/old-swap-file.swap + src/test/resources/xxe_template.xml http://git-wip-us.apache.org/repos/asf/nifi/blob/0536c3ed/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/persistence/TemplateDeserializer.java ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/persistence/TemplateDeserializer.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/persistence/TemplateDeserializer.java index fef0709..27e9093 100644 --- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/persistence/TemplateDeserializer.java +++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/persistence/TemplateDeserializer.java @@ -17,13 +17,14 @@ package org.apache.nifi.persistence; import java.io.InputStream; - import javax.xml.bind.JAXBContext; import javax.xml.bind.JAXBElement; import javax.xml.bind.JAXBException; import javax.xml.bind.Unmarshaller; +import javax.xml.stream.XMLInputFactory; +import javax.xml.stream.XMLStreamException; +import javax.xml.stream.XMLStreamReader; import javax.xml.transform.stream.StreamSource; - import org.apache.nifi.controller.serialization.FlowSerializationException; import org.apache.nifi.web.api.dto.TemplateDTO; @@ -32,10 +33,17 @@ public class TemplateDeserializer { public static TemplateDTO deserialize(final InputStream inStream) { try { JAXBContext context = JAXBContext.newInstance(TemplateDTO.class); + + // Manually constructing the XIF is necessary to prevent XXE attacks + XMLInputFactory xif = XMLInputFactory.newFactory(); + xif.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false); + xif.setProperty(XMLInputFactory.SUPPORT_DTD, false); + XMLStreamReader xsr = xif.createXMLStreamReader(new StreamSource(inStream)); + Unmarshaller unmarshaller = context.createUnmarshaller(); - JAXBElement templateElement = unmarshaller.unmarshal(new StreamSource(inStream), TemplateDTO.class); + JAXBElement templateElement = unmarshaller.unmarshal(xsr, TemplateDTO.class); return templateElement.getValue(); - } catch (final JAXBException e) { + } catch (final JAXBException | XMLStreamException e) { throw new FlowSerializationException(e); } } http://git-wip-us.apache.org/repos/asf/nifi/blob/0536c3ed/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/test/groovy/org/apache/nifi/persistence/TemplateDeserializerTest.groovy ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/test/groovy/org/apache/nifi/persistence/TemplateDeserializerTest.groovy b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/test/groovy/org/apache/nifi/persistence/TemplateDeserializerTest.groovy new file mode 100644 index 0000000..c90868b --- /dev/null +++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/test/groovy/org/apache/nifi/persistence/TemplateDeserializerTest.groovy @@ -0,0 +1,66 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.persistence + +import org.apache.nifi.web.api.dto.TemplateDTO +import org.junit.After +import org.junit.Before +import org.junit.BeforeClass +import org.junit.Test +import org.junit.runner.RunWith +import org.junit.runners.JUnit4 +import org.slf4j.Logger +import org.slf4j.LoggerFactory + +@RunWith(JUnit4.class) +class TemplateDeserializerTest extends GroovyTestCase { + private static final Logger logger = LoggerFactory.getLogger(TemplateDeserializerTest.class) + + @BeforeClass + static void setUpOnce() throws Exception { + logger.metaClass.methodMissing = { String name, args -> + logger.info("[${name?.toUpperCase()}] ${(args as List).join(" ")}") + } + } + + @Before + void setUp() throws Exception { + + } + + @After + void tearDown() throws Exception { + + } + + @Test + void testShouldHandleXXEInTemplateLoad() { + // Arrange + final String XXE_TEMPLATE_FILEPATH = "src/test/resources/xxe_template.xml" + InputStream templateStream = new File(XXE_TEMPLATE_FILEPATH).newInputStream() + + // Act + def msg = shouldFail() { + TemplateDTO template = TemplateDeserializer.deserialize(templateStream) + logger.info("Deserialized template \"${template.name}\" -- ${template.description}") + } + + // Assert + logger.expected(msg) + assert msg =~ "XMLStreamException: ParseError " + } +} http://git-wip-us.apache.org/repos/asf/nifi/blob/0536c3ed/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/test/resources/xxe_template.xml ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/test/resources/xxe_template.xml b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/test/resources/xxe_template.xml new file mode 100644 index 0000000..82674e0 --- /dev/null +++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/test/resources/xxe_template.xml @@ -0,0 +1,230 @@ +]> +