/*
*
* 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.encryption;
import static org.mockito.Matchers.anyMap;
import static org.mockito.Matchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.nio.file.attribute.PosixFilePermission;
import java.security.NoSuchAlgorithmException;
import java.util.Collections;
import java.util.EnumSet;
import java.util.Map;
import java.util.UUID;
import javax.crypto.Cipher;
import org.mockito.ArgumentCaptor;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.apache.qpid.server.BrokerOptions;
import org.apache.qpid.server.model.Broker;
import org.apache.qpid.test.utils.QpidTestCase;
public class AESKeyFileEncrypterFactoryTest extends QpidTestCase
{
private Broker _broker;
private Path _tmpDir;
private AESKeyFileEncrypterFactory _factory;
@Override
public void setUp() throws Exception
{
super.setUp();
_broker = mock(Broker.class);
_tmpDir = Files.createTempDirectory(getTestName());
when(_broker.getContextKeys(eq(false))).thenReturn(Collections.<String>emptySet());
when(_broker.getContextValue(eq(String.class), eq(BrokerOptions.QPID_WORK_DIR))).thenReturn(_tmpDir.toString());
when(_broker.getCategoryClass()).thenReturn(Broker.class);
when(_broker.getName()).thenReturn(getName());
final ArgumentCaptor<Map> contextCaptor = ArgumentCaptor.forClass(Map.class);
when(_broker.setAttribute(eq("context"), anyMap(), contextCaptor.capture() )).thenAnswer(new Answer<Void>() {
@Override
public Void answer(final InvocationOnMock invocationOnMock) throws Throwable
{
Map replacementContext = contextCaptor.getValue();
when(_broker.getContext()).thenReturn(replacementContext);
return null;
}
});
_factory = new AESKeyFileEncrypterFactory();
}
public void testCreateKeyInDefaultLocation() throws Exception
{
if(isStrongEncryptionEnabled())
{
ConfigurationSecretEncrypter encrypter = _factory.createEncrypter(_broker);
KeyFilePathChecker keyFilePathChecker = new KeyFilePathChecker();
doChecks(encrypter, keyFilePathChecker);
String pathName = (String) _broker.getContext().get(AESKeyFileEncrypterFactory.ENCRYPTER_KEY_FILE);
// check the context variable was set
assertEquals(keyFilePathChecker.getKeyFile().toString(), pathName);
}
}
private void doChecks(final ConfigurationSecretEncrypter encrypter,
final KeyFilePathChecker keyFilePathChecker) throws IOException
{
// walk the directory to find the file
Files.walkFileTree(_tmpDir, keyFilePathChecker);
// check the file was actually found
assertNotNull(keyFilePathChecker.getKeyFile());
String secret = "notasecret";
// check the encrypter works
assertEquals(secret, encrypter.decrypt(encrypter.encrypt(secret)));
}
public void testSettingContextKeyLeadsToFileCreation() throws Exception
{
if(isStrongEncryptionEnabled())
{
String filename = UUID.randomUUID().toString() + ".key";
String subdirName = getTestName() + File.separator + "test";
String fileLocation = _tmpDir.toString() + File.separator + subdirName + File.separator + filename;
when(_broker.getContextKeys(eq(false))).thenReturn(Collections.singleton(AESKeyFileEncrypterFactory.ENCRYPTER_KEY_FILE));
when(_broker.getContextValue(eq(String.class),
eq(AESKeyFileEncrypterFactory.ENCRYPTER_KEY_FILE))).thenReturn(fileLocation);
ConfigurationSecretEncrypter encrypter = _factory.createEncrypter(_broker);
KeyFilePathChecker keyFilePathChecker = new KeyFilePathChecker(subdirName, filename);
doChecks(encrypter, keyFilePathChecker);
}
}
public void testUnableToCreateFileInSpecifiedLocation() throws Exception
{
if(isStrongEncryptionEnabled())
{
String filename = UUID.randomUUID().toString() + ".key";
String subdirName = getTestName() + File.separator + "test";
String fileLocation = _tmpDir.toString() + File.separator + subdirName + File.separator + filename;
when(_broker.getContextKeys(eq(false))).thenReturn(Collections.singleton(AESKeyFileEncrypterFactory.ENCRYPTER_KEY_FILE));
when(_broker.getContextValue(eq(String.class),
eq(AESKeyFileEncrypterFactory.ENCRYPTER_KEY_FILE))).thenReturn(fileLocation);
Files.createDirectories(Paths.get(fileLocation));
try
{
ConfigurationSecretEncrypter encrypter = _factory.createEncrypter(_broker);
fail("should not be able to create a key file where a directory currently is");
}
catch (IllegalArgumentException e)
{
// pass
}
}
}
public void testPermissionsAreChecked() throws Exception
{
if(isStrongEncryptionEnabled())
{
String filename = UUID.randomUUID().toString() + ".key";
String subdirName = getTestName() + File.separator + "test";
String fileLocation = _tmpDir.toString() + File.separator + subdirName + File.separator + filename;
when(_broker.getContextKeys(eq(false))).thenReturn(Collections.singleton(AESKeyFileEncrypterFactory.ENCRYPTER_KEY_FILE));
when(_broker.getContextValue(eq(String.class),
eq(AESKeyFileEncrypterFactory.ENCRYPTER_KEY_FILE))).thenReturn(fileLocation);
Files.createDirectories(Paths.get(_tmpDir.toString(), subdirName));
File file = new File(fileLocation);
file.createNewFile();
Files.setPosixFilePermissions(file.toPath(),
EnumSet.of(PosixFilePermission.OWNER_READ, PosixFilePermission.GROUP_READ));
try
{
ConfigurationSecretEncrypter encrypter = _factory.createEncrypter(_broker);
fail("should not be able to create a key file where the file is readable");
}
catch (IllegalArgumentException e)
{
// pass
}
}
}
public void testInvalidKey() throws Exception
{
if(isStrongEncryptionEnabled())
{
String filename = UUID.randomUUID().toString() + ".key";
String subdirName = getTestName() + File.separator + "test";
String fileLocation = _tmpDir.toString() + File.separator + subdirName + File.separator + filename;
when(_broker.getContextKeys(eq(false))).thenReturn(Collections.singleton(AESKeyFileEncrypterFactory.ENCRYPTER_KEY_FILE));
when(_broker.getContextValue(eq(String.class),
eq(AESKeyFileEncrypterFactory.ENCRYPTER_KEY_FILE))).thenReturn(fileLocation);
Files.createDirectories(Paths.get(_tmpDir.toString(), subdirName));
File file = new File(fileLocation);
try (FileOutputStream fos = new FileOutputStream(file))
{
fos.write("This is not an AES key. It is a string saying it is not an AES key".getBytes(
StandardCharsets.US_ASCII));
}
Files.setPosixFilePermissions(file.toPath(), EnumSet.of(PosixFilePermission.OWNER_READ));
try
{
ConfigurationSecretEncrypter encrypter = _factory.createEncrypter(_broker);
fail("should not be able to start where the key is not a valid key");
}
catch (IllegalArgumentException e)
{
// pass
}
}
}
@Override
public void tearDown() throws Exception
{
Files.walkFileTree(_tmpDir,
new SimpleFileVisitor<Path>()
{
@Override
public FileVisitResult visitFile(final Path file, final BasicFileAttributes attrs)
throws IOException
{
Files.delete(file);
return FileVisitResult.CONTINUE;
}
@Override
public FileVisitResult postVisitDirectory(final Path dir, final IOException exc)
throws IOException
{
Files.delete(dir);
return FileVisitResult.CONTINUE;
}
});
super.tearDown();
}
private boolean isStrongEncryptionEnabled() throws NoSuchAlgorithmException
{
return Cipher.getMaxAllowedKeyLength("AES")>=256;
}
private class KeyFilePathChecker extends SimpleFileVisitor<Path>
{
private final String _fileName;
private final String _subdirName;
private Path _keyFile;
private boolean _inKeysSubdir;
public KeyFilePathChecker()
{
this(AESKeyFileEncrypterFactory.DEFAULT_KEYS_SUBDIR_NAME, "Broker_" + AESKeyFileEncrypterFactoryTest.this.getName() + ".key");
}
public KeyFilePathChecker(final String subdirName, final String fileName)
{
_subdirName = subdirName;
_fileName = fileName;
}
@Override
public FileVisitResult preVisitDirectory(final Path dir, final BasicFileAttributes attrs) throws IOException
{
if(!_inKeysSubdir && dir.endsWith(_subdirName))
{
_inKeysSubdir = true;
assertFalse(Files.getPosixFilePermissions(dir).contains(PosixFilePermission.OTHERS_READ));
assertFalse(Files.getPosixFilePermissions(dir).contains(PosixFilePermission.OTHERS_WRITE));
assertFalse(Files.getPosixFilePermissions(dir).contains(PosixFilePermission.OTHERS_EXECUTE));
assertFalse(Files.getPosixFilePermissions(dir).contains(PosixFilePermission.GROUP_READ));
assertFalse(Files.getPosixFilePermissions(dir).contains(PosixFilePermission.GROUP_WRITE));
assertFalse(Files.getPosixFilePermissions(dir).contains(PosixFilePermission.GROUP_EXECUTE));
return FileVisitResult.CONTINUE;
}
else
{
return _inKeysSubdir ? FileVisitResult.SKIP_SUBTREE : FileVisitResult.CONTINUE;
}
}
@Override
public FileVisitResult visitFile(final Path file, final BasicFileAttributes attrs) throws IOException
{
if(_inKeysSubdir)
{
if(file.endsWith(_fileName))
{
_keyFile = file;
assertFalse(Files.getPosixFilePermissions(file).contains(PosixFilePermission.OTHERS_READ));
assertFalse(Files.getPosixFilePermissions(file).contains(PosixFilePermission.OTHERS_WRITE));
assertFalse(Files.getPosixFilePermissions(file).contains(PosixFilePermission.OTHERS_EXECUTE));
assertFalse(Files.getPosixFilePermissions(file).contains(PosixFilePermission.GROUP_READ));
assertFalse(Files.getPosixFilePermissions(file).contains(PosixFilePermission.GROUP_WRITE));
assertFalse(Files.getPosixFilePermissions(file).contains(PosixFilePermission.GROUP_EXECUTE));
return FileVisitResult.TERMINATE;
}
}
return FileVisitResult.CONTINUE;
}
@Override
public FileVisitResult postVisitDirectory(final Path dir, final IOException exc) throws IOException
{
_inKeysSubdir = false;
return FileVisitResult.CONTINUE;
}
public Path getKeyFile()
{
return _keyFile;
}
}
}