broker-core/src/test/java/org/apache/qpid/server/security/auth/database/AbstractPasswordFilePrincipalDatabaseTest.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.qpid.server.security.auth.database;

import static org.junit.Assert.fail;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.security.Principal;
import java.util.ArrayList;
import java.util.List;

import org.junit.After;
import org.junit.Test;

import org.apache.qpid.server.security.auth.UsernamePrincipal;
import org.apache.qpid.test.utils.UnitTestBase;


public abstract class AbstractPasswordFilePrincipalDatabaseTest extends UnitTestBase
{
    protected static final String TEST_COMMENT = "# Test Comment";
    protected static final String TEST_USERNAME = "testUser";
    protected static final String TEST_PASSWORD = "testPassword";
    protected static final char[] TEST_PASSWORD_CHARS = TEST_PASSWORD.toCharArray();

    private List<File> _testPwdFiles = new ArrayList<File>();
    private Principal _principal = new UsernamePrincipal(TEST_USERNAME, null);

    protected abstract AbstractPasswordFilePrincipalDatabase getDatabase();

    @After
    public void tearDown() throws Exception
    {
        try
        {
            //clean up any additional files and their backups
            for (File f : _testPwdFiles)
            {
                File oldPwdFile = new File(f.getAbsolutePath() + ".old");
                if (oldPwdFile.exists())
                {
                    oldPwdFile.delete();
                }

                f.delete();
            }
        }
        finally
        {
        }
    }

    protected File createPasswordFile(int commentLines, int users)
    {
        try
        {
            File testFile = File.createTempFile(getTestName(), "tmp");
            testFile.deleteOnExit();

            BufferedWriter writer = new BufferedWriter(new FileWriter(testFile));

            for (int i = 0; i < commentLines; i++)
            {
                writer.write(TEST_COMMENT);
                writer.newLine();
            }

            for (int i = 0; i < users; i++)
            {
                writer.write(TEST_USERNAME + i + ":Password");
                writer.newLine();
            }

            writer.flush();
            writer.close();

            _testPwdFiles.add(testFile);

            return testFile;

        }
        catch (IOException e)
        {
            fail("Unable to create test password file." + e.getMessage());
        }

        return null;
    }


    protected void loadPasswordFile(File file)
    {
        try
        {
            getDatabase().open(file);
        }
        catch (IOException e)
        {
            fail("Password File was not created." + e.getMessage());
        }
    }


    @Test
    public void testRejectUsernameWithColon() throws Exception
    {
        String usernameWithColon = "user:name";
        Principal principal = new UsernamePrincipal(usernameWithColon, null);

        File testFile = createPasswordFile(0, 0);
        loadPasswordFile(testFile);

        try
        {
            getDatabase().createPrincipal(principal, TEST_PASSWORD_CHARS);
            fail("Username with colon should be rejected");
        }
        catch (IllegalArgumentException e)
        {
            // pass
        }
    }

    @Test
    public void testRejectPasswordWithColon() throws Exception
    {
        String username = "username";
        String passwordWithColon = "pass:word";
        Principal principal = new UsernamePrincipal(username, null);

        File testFile = createPasswordFile(0, 0);
        loadPasswordFile(testFile);

        try
        {
            getDatabase().createPrincipal(principal, passwordWithColon.toCharArray());
            fail("Password with colon should be rejected");
        }
        catch (IllegalArgumentException e)
        {
            // pass
        }

        getDatabase().createPrincipal(_principal, TEST_PASSWORD_CHARS);
        try
        {
            getDatabase().updatePassword(_principal, passwordWithColon.toCharArray());
            fail("Password with colon should be rejected");
        }
        catch (IllegalArgumentException e)
        {
            // pass
        }
    }

}