tolbertam commented on code in PR #3109: URL: https://github.com/apache/cassandra/pull/3109#discussion_r1529380081
########## test/distributed/org/apache/cassandra/distributed/test/auth/MutualTlsCertificateValidityPeriodTest.java: ########## @@ -0,0 +1,329 @@ +/* + * 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.cassandra.distributed.test.auth; + +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.nio.file.Path; +import java.time.Instant; +import java.time.temporal.ChronoUnit; +import java.util.Collections; +import java.util.Map; +import java.util.Optional; +import java.util.function.Consumer; +import java.util.function.Function; +import java.util.stream.StreamSupport; +import javax.net.ssl.SSLException; + +import com.google.common.collect.ImmutableMap; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.ClassRule; +import org.junit.Test; +import org.junit.rules.TemporaryFolder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.datastax.driver.core.PlainTextAuthProvider; +import com.datastax.driver.core.RemoteEndpointAwareJdkSSLOptions; +import com.datastax.driver.core.ResultSet; +import com.datastax.driver.core.Row; +import com.datastax.driver.core.SSLOptions; +import com.datastax.driver.core.Session; +import com.datastax.driver.core.SimpleStatement; +import com.datastax.driver.core.policies.LoadBalancingPolicy; +import org.apache.cassandra.config.EncryptionOptions; +import org.apache.cassandra.distributed.Cluster; +import org.apache.cassandra.distributed.api.Feature; +import org.apache.cassandra.distributed.api.ICluster; +import org.apache.cassandra.distributed.api.IInvokableInstance; +import org.apache.cassandra.distributed.shared.ClusterUtils; +import org.apache.cassandra.distributed.test.JavaDriverUtils; +import org.apache.cassandra.distributed.test.TestBaseImpl; +import org.apache.cassandra.distributed.util.Auth; +import org.apache.cassandra.distributed.util.SingleHostLoadBalancingPolicy; +import org.apache.cassandra.security.ISslContextFactory; +import org.apache.cassandra.transport.SimpleClientSslContextFactory; +import org.apache.cassandra.utils.tls.CertificateBuilder; +import org.apache.cassandra.utils.tls.CertificateBundle; +import org.assertj.core.api.Assertions; +import org.assertj.core.api.InstanceOfAssertFactories; + +import static org.apache.cassandra.auth.CassandraRoleManager.DEFAULT_SUPERUSER_NAME; +import static org.apache.cassandra.auth.CassandraRoleManager.DEFAULT_SUPERUSER_PASSWORD; +import static org.apache.cassandra.transport.TlsTestUtils.CLIENT_TRUSTSTORE_PASSWORD; +import static org.apache.cassandra.transport.TlsTestUtils.SERVER_KEYSTORE_PASSWORD; +import static org.apache.cassandra.transport.TlsTestUtils.SERVER_TRUSTSTORE_PASSWORD; +import static org.assertj.core.api.Assertions.as; +import static org.assertj.core.api.Assertions.fail; + +/** + * Tests mTLS certificate validity period functionality + */ +public class MutualTlsCertificateValidityPeriodTest extends TestBaseImpl +{ + private static final Logger LOGGER = LoggerFactory.getLogger(MutualTlsCertificateValidityPeriodTest.class); + private static final String IDENTITY = "spiffe://test.cassandra.apache.org/dTest/mtls"; + private static ICluster<IInvokableInstance> CLUSTER; + private static final char[] KEYSTORE_PASSWORD = "cassandra".toCharArray(); + + @ClassRule + public static TemporaryFolder tempFolder = new TemporaryFolder(); + + static CertificateBundle CA; + static Path truststorePath; + + @BeforeClass + public static void setupClass() throws Exception + { + LOGGER.info("[test step : @BeforeClass] setupClass"); + Cluster.Builder builder = Cluster.build(1); + + CA = new CertificateBuilder().subject("CN=Apache Cassandra Root CA, OU=Certification Authority, O=Unknown, C=Unknown") + .alias("fakerootca") + .isCertificateAuthority(true) + .buildSelfSigned(); + + truststorePath = CA.toTempKeyStorePath(tempFolder.getRoot().toPath(), + SERVER_TRUSTSTORE_PASSWORD.toCharArray(), + SERVER_TRUSTSTORE_PASSWORD.toCharArray()); + + + CertificateBundle keystore = new CertificateBuilder().subject("CN=Apache Cassandra, OU=ssl_test, O=Unknown, L=Unknown, ST=Unknown, C=Unknown") + .addSanDnsName(InetAddress.getLocalHost().getCanonicalHostName()) + .addSanDnsName(InetAddress.getLocalHost().getHostName()) + .buildIssuedBy(CA); + + Path serverKeystorePath = keystore.toTempKeyStorePath(tempFolder.getRoot().toPath(), + SERVER_KEYSTORE_PASSWORD.toCharArray(), + SERVER_KEYSTORE_PASSWORD.toCharArray()); + + builder.withConfig(c -> c.set("authenticator.class_name", "org.apache.cassandra.auth.MutualTlsWithPasswordFallbackAuthenticator") + .set("authenticator.parameters", Collections.singletonMap("validator_class_name", "org.apache.cassandra.auth.SpiffeCertificateValidator")) + .set("role_manager", "CassandraRoleManager") + .set("authorizer", "CassandraAuthorizer") + .set("client_encryption_options.enabled", "true") + .set("client_encryption_options.require_client_auth", "optional") + .set("client_encryption_options.keystore", serverKeystorePath.toString()) + .set("client_encryption_options.keystore_password", SERVER_KEYSTORE_PASSWORD) + .set("client_encryption_options.truststore", truststorePath.toString()) + .set("client_encryption_options.truststore_password", SERVER_TRUSTSTORE_PASSWORD) + .set("client_encryption_options.require_endpoint_verification", "false") + .set("client_encryption_options.max_certificate_validity_period", "30d") + .set("client_encryption_options.certificate_validity_warn_threshold", "5d") + .with(Feature.NATIVE_PROTOCOL, Feature.GOSSIP)); + CLUSTER = builder.start(); + + configureIdentity(); + } + + @AfterClass + public static void teardown() throws Exception + { + LOGGER.info("[test step : @AfterClass] teardown"); + if (CLUSTER != null) + CLUSTER.close(); + } + + @Test + public void testExpiringCertificate() throws Exception + { + LOGGER.info("[test step : @Test] testExpiringCertificate"); + Path clientKeystorePath = generateClientCertificate(null); + + com.datastax.driver.core.Cluster driver = JavaDriverUtils.create(CLUSTER, null, b -> b.withSSL(getSSLOptions(clientKeystorePath))); + + testWithDriver(driver, (Session session) -> { + ResultSet clientView = session.execute(new SimpleStatement("SELECT * FROM system_views.clients")); + Assertions.assertThat(clientView).isNotNull().isNotEmpty(); + + Optional<Row> thisClient = StreamSupport.stream(clientView.spliterator(), false) + .filter(row -> "cassandra_ssl_test".equals(row.getString("username"))) + .findFirst(); + + Assertions.assertThat(thisClient).isPresent(); + Row row = thisClient.get(); + Map<String, String> authenticationMetadata = row.getMap("authentication_metadata", String.class, String.class); + + Assertions.assertThat(authenticationMetadata).isNotNull().hasSize(1) + .containsKey("identity") + .extractingByKey("identity", as(InstanceOfAssertFactories.STRING)).isEqualTo(IDENTITY); + Assertions.assertThat(row.getString("authentication_mode")).isEqualTo("MutualTls"); + }); + } + + @Test + public void testCertificateReachingMaxValidityPeriod() throws Exception + { + LOGGER.info("[test step : @Test] testCertificateReachingMaxValidityPeriod"); + Path clientKeystorePath = generateClientCertificate(b -> b.notBefore(Instant.now().minus(3, ChronoUnit.DAYS)) + .notAfter(Instant.now().plus(4, ChronoUnit.DAYS))); + + com.datastax.driver.core.Cluster driver = JavaDriverUtils.create(CLUSTER, null, b -> b.withSSL(getSSLOptions(clientKeystorePath))); + + testWithDriver(driver, (Session session) -> { + ResultSet clientView = session.execute(new SimpleStatement("SELECT * FROM system_views.clients")); + Assertions.assertThat(clientView).isNotNull().isNotEmpty(); + + Optional<Row> thisClient = StreamSupport.stream(clientView.spliterator(), false) + .filter(row -> "cassandra_ssl_test".equals(row.getString("username"))) + .findFirst(); + + Assertions.assertThat(thisClient).isPresent(); + Row row = thisClient.get(); + Map<String, String> authenticationMetadata = row.getMap("authentication_metadata", String.class, String.class); + + Assertions.assertThat(authenticationMetadata).isNotNull().hasSize(1) + .containsKey("identity") + .extractingByKey("identity", as(InstanceOfAssertFactories.STRING)).isEqualTo(IDENTITY); + Assertions.assertThat(row.getString("authentication_mode")).isEqualTo("MutualTls"); + }); + } + + @Test + public void testFailsWhenCertificateExceedsMaxAllowedValidityPeriod() throws Exception + { + LOGGER.info("[test step : @Test] testFailsWhenCertificateExceedsMaxAllowedValidityPeriod"); + Path clientKeystorePath = generateClientCertificate(b -> b.notAfter(Instant.now().plus(365, ChronoUnit.DAYS))); + + com.datastax.driver.core.Cluster driver = JavaDriverUtils.create(CLUSTER, null, b -> b.withSSL(getSSLOptions(clientKeystorePath))); + + try + { + testWithDriver(driver, null); + fail("Should not be able to connect when the certificate exceeds the maximum allowed validity period"); + } + catch (com.datastax.driver.core.exceptions.NoHostAvailableException exception) + { + Assertions.assertThat(exception) + .hasMessageContaining("The validity period of the provided certificate (527040 minutes) exceeds the maximum allowed validity period of 43200 minutes"); + } + } + + @Test + public void testFailsWhenCertificateIsExpired() throws Exception + { + LOGGER.info("[test step : @Test] testFailsWhenCertificateIsExpired"); + Path clientKeystorePath = generateClientCertificate(b -> b.notBefore(Instant.now().minus(30, ChronoUnit.DAYS)) Review Comment: One thing I learned recently is that expired certificates will handshake if the certificate is self signed and directly in the trust store. I see you are making certificates signed by another CA so this is failing as expected. Just wondering if you encountered the same :) ########## test/distributed/org/apache/cassandra/distributed/test/auth/MutualTlsCertificateValidityPeriodTest.java: ########## @@ -0,0 +1,329 @@ +/* + * 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.cassandra.distributed.test.auth; + +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.nio.file.Path; +import java.time.Instant; +import java.time.temporal.ChronoUnit; +import java.util.Collections; +import java.util.Map; +import java.util.Optional; +import java.util.function.Consumer; +import java.util.function.Function; +import java.util.stream.StreamSupport; +import javax.net.ssl.SSLException; + +import com.google.common.collect.ImmutableMap; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.ClassRule; +import org.junit.Test; +import org.junit.rules.TemporaryFolder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.datastax.driver.core.PlainTextAuthProvider; +import com.datastax.driver.core.RemoteEndpointAwareJdkSSLOptions; +import com.datastax.driver.core.ResultSet; +import com.datastax.driver.core.Row; +import com.datastax.driver.core.SSLOptions; +import com.datastax.driver.core.Session; +import com.datastax.driver.core.SimpleStatement; +import com.datastax.driver.core.policies.LoadBalancingPolicy; +import org.apache.cassandra.config.EncryptionOptions; +import org.apache.cassandra.distributed.Cluster; +import org.apache.cassandra.distributed.api.Feature; +import org.apache.cassandra.distributed.api.ICluster; +import org.apache.cassandra.distributed.api.IInvokableInstance; +import org.apache.cassandra.distributed.shared.ClusterUtils; +import org.apache.cassandra.distributed.test.JavaDriverUtils; +import org.apache.cassandra.distributed.test.TestBaseImpl; +import org.apache.cassandra.distributed.util.Auth; +import org.apache.cassandra.distributed.util.SingleHostLoadBalancingPolicy; +import org.apache.cassandra.security.ISslContextFactory; +import org.apache.cassandra.transport.SimpleClientSslContextFactory; +import org.apache.cassandra.utils.tls.CertificateBuilder; +import org.apache.cassandra.utils.tls.CertificateBundle; +import org.assertj.core.api.Assertions; +import org.assertj.core.api.InstanceOfAssertFactories; + +import static org.apache.cassandra.auth.CassandraRoleManager.DEFAULT_SUPERUSER_NAME; +import static org.apache.cassandra.auth.CassandraRoleManager.DEFAULT_SUPERUSER_PASSWORD; +import static org.apache.cassandra.transport.TlsTestUtils.CLIENT_TRUSTSTORE_PASSWORD; +import static org.apache.cassandra.transport.TlsTestUtils.SERVER_KEYSTORE_PASSWORD; +import static org.apache.cassandra.transport.TlsTestUtils.SERVER_TRUSTSTORE_PASSWORD; +import static org.assertj.core.api.Assertions.as; +import static org.assertj.core.api.Assertions.fail; + +/** + * Tests mTLS certificate validity period functionality + */ +public class MutualTlsCertificateValidityPeriodTest extends TestBaseImpl +{ + private static final Logger LOGGER = LoggerFactory.getLogger(MutualTlsCertificateValidityPeriodTest.class); + private static final String IDENTITY = "spiffe://test.cassandra.apache.org/dTest/mtls"; + private static ICluster<IInvokableInstance> CLUSTER; + private static final char[] KEYSTORE_PASSWORD = "cassandra".toCharArray(); + + @ClassRule + public static TemporaryFolder tempFolder = new TemporaryFolder(); + + static CertificateBundle CA; + static Path truststorePath; + + @BeforeClass + public static void setupClass() throws Exception + { + LOGGER.info("[test step : @BeforeClass] setupClass"); + Cluster.Builder builder = Cluster.build(1); + + CA = new CertificateBuilder().subject("CN=Apache Cassandra Root CA, OU=Certification Authority, O=Unknown, C=Unknown") + .alias("fakerootca") + .isCertificateAuthority(true) + .buildSelfSigned(); + + truststorePath = CA.toTempKeyStorePath(tempFolder.getRoot().toPath(), + SERVER_TRUSTSTORE_PASSWORD.toCharArray(), + SERVER_TRUSTSTORE_PASSWORD.toCharArray()); + + + CertificateBundle keystore = new CertificateBuilder().subject("CN=Apache Cassandra, OU=ssl_test, O=Unknown, L=Unknown, ST=Unknown, C=Unknown") + .addSanDnsName(InetAddress.getLocalHost().getCanonicalHostName()) + .addSanDnsName(InetAddress.getLocalHost().getHostName()) + .buildIssuedBy(CA); + + Path serverKeystorePath = keystore.toTempKeyStorePath(tempFolder.getRoot().toPath(), + SERVER_KEYSTORE_PASSWORD.toCharArray(), + SERVER_KEYSTORE_PASSWORD.toCharArray()); + + builder.withConfig(c -> c.set("authenticator.class_name", "org.apache.cassandra.auth.MutualTlsWithPasswordFallbackAuthenticator") + .set("authenticator.parameters", Collections.singletonMap("validator_class_name", "org.apache.cassandra.auth.SpiffeCertificateValidator")) + .set("role_manager", "CassandraRoleManager") + .set("authorizer", "CassandraAuthorizer") + .set("client_encryption_options.enabled", "true") + .set("client_encryption_options.require_client_auth", "optional") + .set("client_encryption_options.keystore", serverKeystorePath.toString()) + .set("client_encryption_options.keystore_password", SERVER_KEYSTORE_PASSWORD) + .set("client_encryption_options.truststore", truststorePath.toString()) + .set("client_encryption_options.truststore_password", SERVER_TRUSTSTORE_PASSWORD) + .set("client_encryption_options.require_endpoint_verification", "false") + .set("client_encryption_options.max_certificate_validity_period", "30d") + .set("client_encryption_options.certificate_validity_warn_threshold", "5d") + .with(Feature.NATIVE_PROTOCOL, Feature.GOSSIP)); + CLUSTER = builder.start(); + + configureIdentity(); + } + + @AfterClass + public static void teardown() throws Exception + { + LOGGER.info("[test step : @AfterClass] teardown"); + if (CLUSTER != null) + CLUSTER.close(); + } + + @Test + public void testExpiringCertificate() throws Exception + { + LOGGER.info("[test step : @Test] testExpiringCertificate"); + Path clientKeystorePath = generateClientCertificate(null); + + com.datastax.driver.core.Cluster driver = JavaDriverUtils.create(CLUSTER, null, b -> b.withSSL(getSSLOptions(clientKeystorePath))); + + testWithDriver(driver, (Session session) -> { + ResultSet clientView = session.execute(new SimpleStatement("SELECT * FROM system_views.clients")); + Assertions.assertThat(clientView).isNotNull().isNotEmpty(); + + Optional<Row> thisClient = StreamSupport.stream(clientView.spliterator(), false) + .filter(row -> "cassandra_ssl_test".equals(row.getString("username"))) + .findFirst(); + + Assertions.assertThat(thisClient).isPresent(); + Row row = thisClient.get(); + Map<String, String> authenticationMetadata = row.getMap("authentication_metadata", String.class, String.class); + + Assertions.assertThat(authenticationMetadata).isNotNull().hasSize(1) + .containsKey("identity") + .extractingByKey("identity", as(InstanceOfAssertFactories.STRING)).isEqualTo(IDENTITY); + Assertions.assertThat(row.getString("authentication_mode")).isEqualTo("MutualTls"); + }); + } + + @Test + public void testCertificateReachingMaxValidityPeriod() throws Exception + { + LOGGER.info("[test step : @Test] testCertificateReachingMaxValidityPeriod"); + Path clientKeystorePath = generateClientCertificate(b -> b.notBefore(Instant.now().minus(3, ChronoUnit.DAYS)) + .notAfter(Instant.now().plus(4, ChronoUnit.DAYS))); + + com.datastax.driver.core.Cluster driver = JavaDriverUtils.create(CLUSTER, null, b -> b.withSSL(getSSLOptions(clientKeystorePath))); + + testWithDriver(driver, (Session session) -> { + ResultSet clientView = session.execute(new SimpleStatement("SELECT * FROM system_views.clients")); + Assertions.assertThat(clientView).isNotNull().isNotEmpty(); + + Optional<Row> thisClient = StreamSupport.stream(clientView.spliterator(), false) + .filter(row -> "cassandra_ssl_test".equals(row.getString("username"))) + .findFirst(); + + Assertions.assertThat(thisClient).isPresent(); + Row row = thisClient.get(); + Map<String, String> authenticationMetadata = row.getMap("authentication_metadata", String.class, String.class); + + Assertions.assertThat(authenticationMetadata).isNotNull().hasSize(1) + .containsKey("identity") + .extractingByKey("identity", as(InstanceOfAssertFactories.STRING)).isEqualTo(IDENTITY); + Assertions.assertThat(row.getString("authentication_mode")).isEqualTo("MutualTls"); + }); + } + + @Test + public void testFailsWhenCertificateExceedsMaxAllowedValidityPeriod() throws Exception + { + LOGGER.info("[test step : @Test] testFailsWhenCertificateExceedsMaxAllowedValidityPeriod"); + Path clientKeystorePath = generateClientCertificate(b -> b.notAfter(Instant.now().plus(365, ChronoUnit.DAYS))); + + com.datastax.driver.core.Cluster driver = JavaDriverUtils.create(CLUSTER, null, b -> b.withSSL(getSSLOptions(clientKeystorePath))); + + try + { + testWithDriver(driver, null); + fail("Should not be able to connect when the certificate exceeds the maximum allowed validity period"); + } + catch (com.datastax.driver.core.exceptions.NoHostAvailableException exception) + { + Assertions.assertThat(exception) + .hasMessageContaining("The validity period of the provided certificate (527040 minutes) exceeds the maximum allowed validity period of 43200 minutes"); + } + } + + @Test + public void testFailsWhenCertificateIsExpired() throws Exception + { + LOGGER.info("[test step : @Test] testFailsWhenCertificateIsExpired"); + Path clientKeystorePath = generateClientCertificate(b -> b.notBefore(Instant.now().minus(30, ChronoUnit.DAYS)) Review Comment: One thing I learned recently is that expired certificates will succesfully handshake if the certificate is self signed and directly in the trust store. I see you are making certificates signed by another CA so this is failing as expected. Just wondering if you encountered the same :) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
