nifi-commons/nifi-security-utils/src/test/java/org/apache/nifi/security/XXEValidatorTest.java

/*
 * 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.security;

import org.apache.nifi.components.ValidationContext;
import org.apache.nifi.components.ValidationResult;
import org.apache.nifi.security.xml.XXEValidator;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.mock;

public class XXEValidatorTest {
    private String simpleXMLFile = "src/test/resources/no_xxe.xml";
    private String remoteXXEFile = "src/test/resources/remote_xxe_file.xml";
    private String localXXEFile = "src/test/resources/local_xxe_file.xml";
    private String multilineXXEFile = "src/test/resources/multiline_xxe_file.xml";
    private String whitespaceXXEFile = "src/test/resources/whitespace_xxe_file.xml";
    private String configurationKey = "Configuration Name";
    private ValidationContext validationContext;

    @BeforeEach
    public void setUp() throws Exception {
        validationContext = mock(ValidationContext.class);
    }

    @Test
    public void testXmlFileWithNoXXEIsValid() {
        // Arrange
        String parameterKey = configurationKey;
        String parameterInput = simpleXMLFile;
        XXEValidator a = new XXEValidator();

        // Act
        ValidationResult val = a.validate(parameterKey, parameterInput, validationContext);

        //Assert
        assertTrue(val.isValid());
    }


    @Test
    public void testXmlFileWithRemoteXXEIsNotValid() {
        // Arrange
        String parameterKey = configurationKey;
        String parameterInput = remoteXXEFile;
        XXEValidator a = new XXEValidator();

        // Act
        ValidationResult val = a.validate(parameterKey, parameterInput, validationContext);

        //Assert
        assertFalse(val.isValid());
        assertEquals("XML file " + parameterInput + " contained an external entity. To prevent XXE vulnerabilities, NiFi has external entity processing disabled.", val.getExplanation());
    }

    @Test
    public void testXmlFileWithLocalXXEIsNotValid() {
        // Arrange
        String parameterKey = configurationKey;
        String parameterInput = localXXEFile;
        XXEValidator a = new XXEValidator();

        // Act
        ValidationResult val = a.validate(parameterKey, parameterInput, validationContext);

        //Assert
        assertFalse(val.isValid());
        assertEquals("XML file " + parameterInput + " contained an external entity. To prevent XXE vulnerabilities, NiFi has external entity processing disabled.", val.getExplanation());
    }

    @Test
    public void testXmlFileWithMultilineXXEIsInvalid() {
        // Arrange
        String parameterKey = configurationKey;
        String parameterInput = multilineXXEFile;
        XXEValidator a = new XXEValidator();

        // Act
        ValidationResult val = a.validate(parameterKey, parameterInput, validationContext);

        //Assert
        assertFalse(val.isValid());
        assertEquals("XML file " + parameterInput + " contained an external entity. To prevent XXE vulnerabilities, NiFi has external entity processing disabled.", val.getExplanation());
    }

    @Test
    public void testXmlFileWithXXEAndWhitespaceIsInvalid() {
        // Arrange
        String parameterKey = configurationKey;
        String parameterInput = whitespaceXXEFile;
        XXEValidator a = new XXEValidator();

        // Act
        ValidationResult val = a.validate(parameterKey, parameterInput, validationContext);

        //Assert
        assertFalse(val.isValid());
        assertEquals("XML file " + parameterInput + " contained an external entity. To prevent XXE vulnerabilities, NiFi has external entity processing disabled.", val.getExplanation());
    }

    @Test
    public void testMissingXmlFile() {
        // Arrange
        String parameterKey = configurationKey;
        String parameterInput = "missing_file.xml";
        XXEValidator a = new XXEValidator();

        // Act
        ValidationResult val = a.validate(parameterKey, parameterInput, validationContext);

        //Assert
        assertFalse(val.isValid());
        assertEquals("File not found: missing_file.xml could not be found.", val.getExplanation());
    }
}