/**
* 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.systest.kerberos.wssec.kerberos;
import java.io.File;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import javax.xml.namespace.QName;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.Service;
import org.apache.cxf.Bus;
import org.apache.cxf.bus.spring.SpringBusFactory;
import org.apache.cxf.systest.kerberos.common.SecurityTestUtil;
import org.apache.cxf.systest.kerberos.wssec.sts.STSServer;
import org.apache.cxf.systest.kerberos.wssec.sts.StaxSTSServer;
import org.apache.cxf.testutil.common.AbstractBusClientServerTestBase;
import org.apache.cxf.testutil.common.TestUtil;
import org.apache.directory.server.annotations.CreateKdcServer;
import org.apache.directory.server.annotations.CreateTransport;
import org.apache.directory.server.core.annotations.ApplyLdifFiles;
import org.apache.directory.server.core.annotations.CreateDS;
import org.apache.directory.server.core.annotations.CreateIndex;
import org.apache.directory.server.core.annotations.CreatePartition;
import org.apache.directory.server.core.integ.AbstractLdapTestUnit;
import org.apache.directory.server.core.integ.FrameworkRunner;
import org.apache.directory.server.core.kerberos.KeyDerivationInterceptor;
import org.apache.wss4j.dom.engine.WSSConfig;
import org.example.contract.doubleit.DoubleItPortType;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.runner.RunWith;
/**
* A set of tests for Kerberos Tokens that use an Apache DS instance as the KDC.
*/
@RunWith(FrameworkRunner.class)
//Define the DirectoryService
@CreateDS(name = "AbstractKerberosTest-class",
enableAccessControl = false,
allowAnonAccess = false,
enableChangeLog = true,
partitions = {
@CreatePartition(
name = "example",
suffix = "dc=example,dc=com",
indexes = {
@CreateIndex(attribute = "objectClass"),
@CreateIndex(attribute = "dc"),
@CreateIndex(attribute = "ou")
}
) },
additionalInterceptors = {
KeyDerivationInterceptor.class
}
)
@CreateKdcServer(
transports = {
@CreateTransport(protocol = "KRB", address = "localhost")
},
primaryRealm = "service.ws.apache.org",
kdcPrincipal = "krbtgt/service.ws.apache.org@service.ws.apache.org"
)
//Inject an file containing entries
@ApplyLdifFiles("kerberos.ldif")
public class KerberosTokenTest extends AbstractLdapTestUnit {
static final String PORT = TestUtil.getPortNumber(Server.class);
static final String STAX_PORT = TestUtil.getPortNumber(StaxServer.class);
static final String PORT2 = TestUtil.getPortNumber(Server.class, 2);
static final String STAX_PORT2 = TestUtil.getPortNumber(StaxServer.class, 2);
static final String PORT3 = TestUtil.getPortNumber(Server.class, 3);
static final String STSPORT = TestUtil.getPortNumber(STSServer.class);
static final String STAX_STSPORT = TestUtil.getPortNumber(StaxSTSServer.class);
private static final String NAMESPACE = "http://www.example.org/contract/DoubleIt";
private static final QName SERVICE_QNAME = new QName(NAMESPACE, "DoubleItService");
private static boolean unrestrictedPoliciesInstalled =
SecurityTestUtil.checkUnrestrictedPoliciesInstalled();
private static boolean runTests;
private static boolean portUpdated;
@Before
public void updatePort() throws Exception {
if (!portUpdated) {
String basedir = System.getProperty("basedir");
if (basedir == null) {
basedir = new File(".").getCanonicalPath();
}
// Read in krb5.conf and substitute in the correct port
Path path = FileSystems.getDefault().getPath(basedir, "/src/test/resources/krb5.conf");
String content = new String(Files.readAllBytes(path), StandardCharsets.UTF_8);
content = content.replaceAll("port", "" + super.getKdcServer().getTransports()[0].getPort());
Path path2 = FileSystems.getDefault().getPath(basedir, "/target/test-classes/wssec.kerberos.krb5.conf");
Files.write(path2, content.getBytes());
System.setProperty("java.security.krb5.conf", path2.toString());
portUpdated = true;
}
}
@BeforeClass
public static void startServers() throws Exception {
WSSConfig.init();
//
// This test fails with the IBM JDK
//
if (!"IBM Corporation".equals(System.getProperty("java.vendor"))) {
runTests = true;
String basedir = System.getProperty("basedir");
if (basedir == null) {
basedir = new File(".").getCanonicalPath();
}
// System.setProperty("sun.security.krb5.debug", "true");
System.setProperty("java.security.auth.login.config",
basedir + "/src/test/resources/kerberos.jaas");
}
// Launch servers
org.junit.Assert.assertTrue(
"Server failed to launch",
// run the server in the same process
// set this to false to fork
AbstractBusClientServerTestBase.launchServer(Server.class, true)
);
org.junit.Assert.assertTrue(
"Server failed to launch",
// run the server in the same process
// set this to false to fork
AbstractBusClientServerTestBase.launchServer(StaxServer.class, true)
);
org.junit.Assert.assertTrue(
"Server failed to launch",
// run the server in the same process
// set this to false to fork
AbstractBusClientServerTestBase.launchServer(STSServer.class, true)
);
org.junit.Assert.assertTrue(
"Server failed to launch",
// run the server in the same process
// set this to false to fork
AbstractBusClientServerTestBase.launchServer(StaxSTSServer.class, true)
);
}
@org.junit.AfterClass
public static void cleanup() throws Exception {
SecurityTestUtil.cleanup();
AbstractBusClientServerTestBase.stopAllServers();
}
@org.junit.Test
public void testKerberosOverTransport() throws Exception {
if (!runTests) {
return;
}
String portName = "DoubleItKerberosTransportPort";
runKerberosTest(portName, false, PORT2);
runKerberosTest(portName, false, STAX_PORT2);
runKerberosTest(portName, true, PORT2);
runKerberosTest(portName, true, STAX_PORT2);
}
@org.junit.Test
public void testKerberosOverTransportDifferentConfiguration() throws Exception {
if (!runTests) {
return;
}
String portName = "DoubleItKerberosTransportPort2";
runKerberosTest(portName, false, PORT2);
runKerberosTest(portName, false, STAX_PORT2);
runKerberosTest(portName, true, PORT2);
runKerberosTest(portName, true, STAX_PORT2);
}
@org.junit.Test
public void testKerberosOverSymmetric() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosSymmetricPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
runKerberosTest(portName, true, PORT);
runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverSymmetricSupporting() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosSymmetricSupportingPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
runKerberosTest(portName, true, PORT);
runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosSupporting() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosSupportingPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
runKerberosTest(portName, true, PORT);
runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverAsymmetric() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosAsymmetricPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
runKerberosTest(portName, true, PORT);
runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverTransportEndorsing() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosTransportEndorsingPort";
runKerberosTest(portName, false, PORT2);
runKerberosTest(portName, false, STAX_PORT2);
runKerberosTest(portName, true, PORT2);
runKerberosTest(portName, true, STAX_PORT2);
}
@org.junit.Test
public void testKerberosOverAsymmetricEndorsing() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosAsymmetricEndorsingPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
// TODO Streaming support
// runKerberosTest(portName, true, PORT);
// runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverSymmetricProtection() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosSymmetricProtectionPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
runKerberosTest(portName, true, PORT);
runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverSymmetricDerivedProtection() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosSymmetricDerivedProtectionPort";
runKerberosTest(portName, false, PORT);
// TODO Streaming support
// TODO Kerberos derived regression on streaming inbound
//runKerberosTest(portName, false, STAX_PORT);
//runKerberosTest(portName, true, PORT);
//runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverAsymmetricSignedEndorsing() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosAsymmetricSignedEndorsingPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
// TODO Streaming support
// runKerberosTest(portName, true, PORT);
// runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverAsymmetricSignedEncrypted() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosAsymmetricSignedEncryptedPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
runKerberosTest(portName, true, PORT);
runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverSymmetricEndorsingEncrypted() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosSymmetricEndorsingEncryptedPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
// TODO Streaming support
// runKerberosTest(portName, true, PORT);
// runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverSymmetricSignedEndorsingEncrypted() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosSymmetricSignedEndorsingEncryptedPort";
runKerberosTest(portName, false, PORT);
runKerberosTest(portName, false, STAX_PORT);
// TODO Streaming support
// runKerberosTest(portName, true, PORT);
// runKerberosTest(portName, true, STAX_PORT);
}
@org.junit.Test
public void testKerberosOverSymmetricSecureConversation() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItKerberosSymmetricSecureConversationPort";
runKerberosTest(portName, false, PORT);
// TODO Streaming support
// runKerberosTest(portName, false, STAX_PORT);
// runKerberosTest(portName, true, PORT);
// runKerberosTest(portName, true, STAX_PORT);
}
// In this test, a CXF client requests a SAML2 HOK Assertion from the STS, which has a
// policy of requiring a KerberosToken over the TransportBinding. The CXF client
// retrieves a service ticket from the KDC and inserts it into the security header of
// the request. The STS validates the ticket using the KerberosTokenValidator.
@org.junit.Test
public void testWSTrustKerberosToken() throws Exception {
if (!runTests || !unrestrictedPoliciesInstalled) {
return;
}
String portName = "DoubleItTransportSAML2Port";
runKerberosSTSTest(portName, false, PORT3, STSPORT);
runKerberosSTSTest(portName, true, PORT3, STSPORT);
runKerberosSTSTest(portName, false, PORT3, STAX_STSPORT);
runKerberosSTSTest(portName, true, PORT3, STAX_STSPORT);
}
private void runKerberosTest(String portName, boolean streaming, String portNumber) throws Exception {
SpringBusFactory bf = new SpringBusFactory();
URL busFile = KerberosTokenTest.class.getResource("client.xml");
Bus bus = bf.createBus(busFile.toString());
SpringBusFactory.setDefaultBus(bus);
SpringBusFactory.setThreadDefaultBus(bus);
URL wsdl = KerberosTokenTest.class.getResource("DoubleItKerberos.wsdl");
Service service = Service.create(wsdl, SERVICE_QNAME);
QName portQName = new QName(NAMESPACE, portName);
DoubleItPortType kerberosPort =
service.getPort(portQName, DoubleItPortType.class);
TestUtil.updateAddressPort(kerberosPort, portNumber);
if (streaming) {
SecurityTestUtil.enableStreaming(kerberosPort);
}
Assert.assertEquals(50, kerberosPort.doubleIt(25));
((java.io.Closeable)kerberosPort).close();
bus.shutdown(true);
}
private void runKerberosSTSTest(String portName, boolean streaming, String portNumber,
String stsPortNumber) throws Exception {
SpringBusFactory bf = new SpringBusFactory();
URL busFile = KerberosTokenTest.class.getResource("sts-client.xml");
Bus bus = bf.createBus(busFile.toString());
SpringBusFactory.setDefaultBus(bus);
SpringBusFactory.setThreadDefaultBus(bus);
URL wsdl = KerberosTokenTest.class.getResource("DoubleItKerberos.wsdl");
Service service = Service.create(wsdl, SERVICE_QNAME);
QName portQName = new QName(NAMESPACE, portName);
DoubleItPortType kerberosPort =
service.getPort(portQName, DoubleItPortType.class);
TestUtil.updateAddressPort(kerberosPort, portNumber);
SecurityTestUtil.updateSTSPort((BindingProvider)kerberosPort, stsPortNumber);
if (streaming) {
SecurityTestUtil.enableStreaming(kerberosPort);
}
Assert.assertEquals(50, kerberosPort.doubleIt(25));
((java.io.Closeable)kerberosPort).close();
bus.shutdown(true);
}
}