JndiHelperTest.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.cxf.transport.jms.util;

import java.util.Properties;

import javax.naming.Context;

import org.junit.Assert;
import org.junit.Test;

public class JndiHelperTest {

    // --- validateJndiName ---

    @Test
    public void testValidateJndiNamePlainNamesAllowed() {
        // Ordinary local JNDI names must not be rejected
        JndiHelper.validateJndiName("TransactionManager");
        JndiHelper.validateJndiName("java:comp/env/jms/MyQueue");
        JndiHelper.validateJndiName("java:/TransactionManager");
        JndiHelper.validateJndiName(null);
    }

    @Test
    public void testValidateJndiNameRemoteUrlRejected() {
        for (String malicious : new String[]{
            "ldap://attacker.com/exploit",
            "ldaps://attacker.com/exploit",
            "rmi://attacker.com/exploit",
            "iiop://attacker.com/exploit",
            "corba://attacker.com/exploit",
            "dns://attacker.com/exploit"}) {
            try {
                JndiHelper.validateJndiName(malicious);
                Assert.fail("Expected IllegalArgumentException for: " + malicious);
            } catch (IllegalArgumentException e) {
                Assert.assertTrue(e.getMessage().contains("JNDI name must not contain a URL"));
            }
        }
    }

    // --- constructor: blocked environment keys ---

    @Test
    public void testInitialContextFactoryAllowed() {
        // INITIAL_CONTEXT_FACTORY is a first-class config parameter set by every JNDI-based
        // JMS deployment (e.g. ActiveMQ, Artemis) and must not be blocked.
        Properties env = new Properties();
        env.put(Context.PROVIDER_URL, "vm://localhost");
        env.put(Context.INITIAL_CONTEXT_FACTORY,
                "org.apache.activemq.artemis.jndi.ActiveMQInitialContextFactory");
        new JndiHelper(env); // must not throw
    }

    @Test
    public void testBlockedObjectFactoryRejected() {
        Properties env = new Properties();
        env.put("java.naming.factory.object", "com.attacker.EvilObjectFactory");
        try {
            new JndiHelper(env);
            Assert.fail("Expected IllegalArgumentException for java.naming.factory.object");
        } catch (IllegalArgumentException e) {
            Assert.assertTrue(e.getMessage().contains("Disallowed JNDI environment property"));
            Assert.assertTrue(e.getMessage().contains("java.naming.factory.object"));
        }
    }

    @Test
    public void testBlockedStateFactoryRejected() {
        Properties env = new Properties();
        env.put("java.naming.factory.state", "com.attacker.EvilStateFactory");
        try {
            new JndiHelper(env);
            Assert.fail("Expected IllegalArgumentException for java.naming.factory.state");
        } catch (IllegalArgumentException e) {
            Assert.assertTrue(e.getMessage().contains("Disallowed JNDI environment property"));
            Assert.assertTrue(e.getMessage().contains("java.naming.factory.state"));
        }
    }

    @Test
    public void testBlockedUrlPkgsRejected() {
        Properties env = new Properties();
        env.put("java.naming.factory.url.pkgs", "com.attacker");
        try {
            new JndiHelper(env);
            Assert.fail("Expected IllegalArgumentException for java.naming.factory.url.pkgs");
        } catch (IllegalArgumentException e) {
            Assert.assertTrue(e.getMessage().contains("Disallowed JNDI environment property"));
            Assert.assertTrue(e.getMessage().contains("java.naming.factory.url.pkgs"));
        }
    }

    @Test
    public void testUnsafeProviderUrlRejected() {
        Properties env = new Properties();
        env.put(Context.PROVIDER_URL, "ldap://attacker.com:389");
        try {
            new JndiHelper(env);
            Assert.fail("Expected IllegalArgumentException for unsafe PROVIDER_URL");
        } catch (IllegalArgumentException e) {
            Assert.assertTrue(e.getMessage().contains("Unsafe protocol in JNDI URL"));
        }
    }

    @Test
    public void testSafeProviderUrlAllowed() {
        // Allowed JMS broker protocols must not be rejected
        for (String safe : new String[]{"vm://localhost", "tcp://localhost:61616",
                                        "ssl://localhost:61617", "nio://localhost:61618"}) {
            Properties env = new Properties();
            env.put(Context.PROVIDER_URL, safe);
            new JndiHelper(env); // must not throw
        }
    }

    @Test
    public void testEmptyPropertiesAllowed() {
        new JndiHelper(new Properties()); // must not throw
    }
}