tolbertam commented on code in PR #4699: URL: https://github.com/apache/cassandra/pull/4699#discussion_r3069681120
########## src/java/org/apache/cassandra/db/guardrails/ClientDriverVersionGuardrail.java: ########## @@ -0,0 +1,160 @@ +/* + * 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.db.guardrails; + +import java.util.Map; +import java.util.function.Function; + +import javax.annotation.Nullable; + +import com.vdurmont.semver4j.Semver; +import com.vdurmont.semver4j.Semver.SemverType; + +import org.apache.cassandra.config.GuardrailsOptions; +import org.apache.cassandra.service.ClientState; + +/** + * A guardrail that warns or rejects client connections whose driver version + * is below a configured minimum per driver name. + * <p> + * The guardrail is configured with maps of driver name to minimum version string. + * Connections that do not report a driver name or version are considered valid + * and are not subject to this guardrail. + * <p> + * Version comparison uses semantic versioning via {@link Semver} with loose parsing + * to handle non-standard version strings reported by drivers. + */ +public class ClientDriverVersionGuardrail extends Predicates<String> +{ + private final Function<ClientState, Map<String, String>> warnVersions; + private final Function<ClientState, Map<String, String>> disallowVersions; + + public ClientDriverVersionGuardrail(Function<ClientState, Map<String, String>> warnVersions, + Function<ClientState, Map<String, String>> disallowVersions) + { + super("minimum_client_driver_versions", null, null, null, null); + this.warnVersions = warnVersions; + this.disallowVersions = disallowVersions; + } + + public void guard(@Nullable String driverName, @Nullable String driverVersion, @Nullable ClientState state) + { + if (!enabled(state)) + return; + + String sanitizedDriverId = driverName == null ? null : driverName.trim(); + if (sanitizedDriverId == null || sanitizedDriverId.isBlank()) + { + logger.debug("minimum_client_driver_versions guardrail identified empty driver " + + "id to check the minimum version of, such connections will be allowed but " + + "an operator should check what kind of clients are connecting to the cluster."); + return; + } + + String sanitizedDriverVersion = GuardrailsOptions.sanitizeVersion(driverVersion); + if (sanitizedDriverVersion == null) + { + logger.debug("minimum_client_driver_versions guardrail identified empty driver " + + "version to check the minimum version of, such connections will be allowed but " + + "an operator should check what kind of clients are connecting to the cluster."); + return; + } + + if (!GuardrailsOptions.isValidVersion(sanitizedDriverVersion)) + { + logger.debug("minimum_client_driver_versions guardrail identified driver " + + "version which is not compliant semver version, such connections will be allowed but " + + "an operator should check what kind of clients are connecting to the cluster."); + return; + } + + Map<String, String> disallowed = disallowVersions.apply(state); + if (disallowed != null && !disallowed.isEmpty()) + { + String minimumVersionFail = disallowed.get(sanitizedDriverId); + if (minimumVersionFail != null && isBelowMinimum(sanitizedDriverVersion, minimumVersionFail)) + { + fail(String.format("Client driver %s is below required minimum version %s, connection rejected", Review Comment: it includes the name provided by the client, but not the version provided currently: e.g.: > Guardrail minimum_client_driver_versions violated: Client driver github.com/apache/cassandra-gocql-driver is below recommended minimum version 2.0.0 > Client driver DataStax Java Driver is below required minimum version 3.11.0, connection rejected -- 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]
