sarankk commented on code in PR #148: URL: https://github.com/apache/cassandra-sidecar/pull/148#discussion_r1853039071
########## server/src/test/integration/org/apache/cassandra/sidecar/cluster/locator/CqlSessionProviderIntegrationTest.java: ########## @@ -0,0 +1,163 @@ +/* + * 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.sidecar.cluster.locator; + +import java.util.Collections; +import java.util.concurrent.TimeUnit; + +import org.junit.jupiter.api.extension.ExtendWith; + +import com.datastax.driver.core.Session; +import io.vertx.ext.web.client.WebClient; +import io.vertx.junit5.VertxExtension; +import io.vertx.junit5.VertxTestContext; +import org.apache.cassandra.sidecar.common.response.ConnectedClientStatsResponse; +import org.apache.cassandra.sidecar.common.response.data.ClientConnectionEntry; +import org.apache.cassandra.sidecar.config.SslConfiguration; +import org.apache.cassandra.sidecar.config.yaml.KeyStoreConfigurationImpl; +import org.apache.cassandra.sidecar.config.yaml.SslConfigurationImpl; +import org.apache.cassandra.sidecar.testing.IntegrationTestBase; +import org.apache.cassandra.testing.CassandraIntegrationTest; +import org.apache.cassandra.testing.ConfigurableCassandraTestContext; +import software.amazon.awssdk.utils.ImmutableMap; + +import static org.apache.cassandra.sidecar.testing.IntegrationTestModule.ADMIN_IDENTITY; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assumptions.assumeThat; + +/** + * Test for authenticated {@link org.apache.cassandra.sidecar.cluster.CQLSessionProviderImpl} + */ +@ExtendWith(VertxExtension.class) +class CqlSessionProviderIntegrationTest extends IntegrationTestBase +{ + private static final int MIN_VERSION_WITH_MTLS = 5; + + @CassandraIntegrationTest(buildCluster = false) + void testWithUsernamePassword(VertxTestContext context, ConfigurableCassandraTestContext cassandraContext) throws Exception + { + cassandraContext.configureAndStartCluster(builder -> { + builder.appendConfig(config -> config.set("authenticator", "org.apache.cassandra.auth.PasswordAuthenticator")); + }); + sidecarTestContext.refreshInstancesConfig(); + waitForSchemaReady(30, TimeUnit.SECONDS); + retrieveClientStats(context, "cassandra", false); + } + + @CassandraIntegrationTest(buildCluster = false) + void testWithSSLOnly(VertxTestContext context, ConfigurableCassandraTestContext cassandraContext) throws Exception + { + cassandraContext.configureAndStartCluster(builder -> { + builder.appendConfig(config -> + // dot-separated options are not supported in 4.0 + config.set("client_encryption_options", ImmutableMap.of("enabled", "true", + "require_client_auth", "false", + "keystore", serverKeystorePath.toAbsolutePath().toString(), + "keystore_password", serverKeystorePassword))); + }); + sidecarTestContext.setSslConfiguration(sslConfigWithTruststore()); + waitForSchemaReady(30, TimeUnit.SECONDS); + // we enable only SSL and do not set any authenticator, hence username is "anonymous" + retrieveClientStats(context, "anonymous", true); + } + + @CassandraIntegrationTest(buildCluster = false) + void testWithMTLS(VertxTestContext context, ConfigurableCassandraTestContext cassandraContext) throws Exception + { + // mTLS authentication was added in Cassandra starting 5.0 version + assumeThat(cassandraContext.version.major) + .withFailMessage("mTLS authentication is not supported in 4.0 Cassandra version") + .isGreaterThanOrEqualTo(MIN_VERSION_WITH_MTLS); + + cassandraContext.configureAndStartCluster(builder -> { + builder.appendConfig(config -> config.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.optional", "true") + .set("client_encryption_options.require_client_auth", "true") + .set("client_encryption_options.require_endpoint_verification", "false") + .set("client_encryption_options.keystore", serverKeystorePath.toAbsolutePath().toString()) + .set("client_encryption_options.keystore_password", serverKeystorePassword) + .set("client_encryption_options.truststore", truststorePath.toAbsolutePath().toString()) + .set("client_encryption_options.truststore_password", truststorePassword)); + }); + waitForSchemaReady(30, TimeUnit.SECONDS); + insertIdentityRole(ADMIN_IDENTITY, "cassandra"); + sidecarTestContext.setSslConfiguration(sslConfigWithKeystoreTruststore()); + retrieveClientStats(context, "cassandra", true); + } + + private SslConfiguration sslConfigWithTruststore() + { + return SslConfigurationImpl.builder() + .enabled(true) + .truststore(new KeyStoreConfigurationImpl(truststorePath.toAbsolutePath().toString(), truststorePassword, "PKCS12")) + .build(); + } + + private SslConfiguration sslConfigWithKeystoreTruststore() + { + return SslConfigurationImpl.builder() + .enabled(true) + .keystore(new KeyStoreConfigurationImpl(clientKeystorePath.toAbsolutePath().toString(), clientKeystorePassword, "PKCS12")) + .truststore(new KeyStoreConfigurationImpl(truststorePath.toAbsolutePath().toString(), truststorePassword, "PKCS12")) + .build(); + } + + private void retrieveClientStats(VertxTestContext context, String expectedUsername, boolean checkSsl) throws Exception + { + String testRoute = "/api/v1/cassandra/stats/connected-clients?summary=false"; + WebClient client = mTLSClient(); + client.get(server.actualPort(), "127.0.0.1", testRoute) + .send(context.succeeding(response -> context.verify(() -> { + ConnectedClientStatsResponse clientStatsResponse = response.bodyAsJson(ConnectedClientStatsResponse.class); + assertThat(clientStatsResponse).isNotNull(); + + for (ClientConnectionEntry entry : clientStatsResponse.clientConnections()) + { + assertThat(entry.username()).isEqualTo(expectedUsername); + if (checkSsl && entry.sslEnabled()) + { + // We expect some connections to be non-SSL (i.e. for identity setup) + // and some connections to be SSL (Sidecar connecting to the cluster) + // so from the list of client connections we should see at least + // two (regular+control) connections. + context.completeNow(); + return; + } + } + if (checkSsl) + { + context.failNow("Did not see any SSL connection"); + return; + } + context.completeNow(); + }))); Review Comment: After moving around looks like it expects all tests to see a sslConnection. But we want to see only if checkSsl is true. Will update it 👍 -- 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]
