maulin-vasavada commented on a change in pull request #1027: URL: https://github.com/apache/cassandra/pull/1027#discussion_r688283660
########## File path: src/java/org/apache/cassandra/security/DefaultSslContextFactoryImpl.java ########## @@ -0,0 +1,369 @@ +/* + * 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.security; + +import java.io.File; +import java.io.InputStream; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.security.KeyStore; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.Date; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import javax.net.ssl.KeyManagerFactory; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLException; +import javax.net.ssl.TrustManager; +import javax.net.ssl.TrustManagerFactory; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.collect.ImmutableList; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import io.netty.handler.ssl.CipherSuiteFilter; +import io.netty.handler.ssl.ClientAuth; +import io.netty.handler.ssl.SslContext; +import io.netty.handler.ssl.SslContextBuilder; +import io.netty.handler.ssl.SslProvider; + +/** + * Cassandra's default implementation class for the configuration key {@code ssl_context_factory}. It uses + * file based keystores. + */ +public final class DefaultSslContextFactoryImpl implements ISslContextFactory +{ + private static final Logger logger = LoggerFactory.getLogger(DefaultSslContextFactoryImpl.class); + + @VisibleForTesting + volatile boolean checkedExpiry = false; + + /** + * List of files that trigger hot reloading of SSL certificates + */ + private volatile List<HotReloadableFile> hotReloadableFiles = new ArrayList<>(); + + /* This list is substituted in configurations that have explicitly specified the original "TLS" default, + * by extracting it from the default "TLS" SSL Context instance + */ + static private final List<String> TLS_PROTOCOL_SUBSTITUTION = SSLFactory.tlsInstanceProtocolSubstitution(); + + private final Map<String,Object> parameters; + private final String keystore; + private final String keystore_password; + private final String truststore; + private final String truststore_password; + private final List<String> cipher_suites; + private String protocol; + private List<String> accepted_protocols; + private final String algorithm; + private final String store_type; + private final boolean require_client_auth; + private final boolean require_endpoint_verification; + // ServerEncryptionOptions does not use the enabled flag at all instead using the existing + // internode_encryption option. So we force this private and expose through isEnabled + // so users of ServerEncryptionOptions can't accidentally use this when they should use isEnabled + // Long term we need to refactor ClientEncryptionOptions and ServerEncyrptionOptions to be separate + // classes so we can choose appropriate configuration for each. + // See CASSANDRA-15262 and CASSANDRA-15146 + protected Boolean enabled; + protected Boolean optional; + + /* For test only */ + DefaultSslContextFactoryImpl(){ + parameters = new HashMap<>(); + keystore = "conf/.keystore"; + keystore_password = "cassandra"; + truststore = "conf/.truststore"; + truststore_password = "cassandra"; + cipher_suites = null; + protocol = null; + accepted_protocols = null; + algorithm = null; + store_type = "JKS"; + require_client_auth = false; + require_endpoint_verification = false; + enabled = null; + optional = null; + } + + public DefaultSslContextFactoryImpl(Map<String,Object> parameters) { + this.parameters = parameters; + keystore = getString("keystore"); + keystore_password = getString("keystore_password"); + truststore = getString("truststore"); + truststore_password = getString("truststore_password"); + cipher_suites = getStringList("cipher_suites"); + protocol = getString("protocol"); + accepted_protocols = getStringList("accepted_protocols"); + algorithm = getString("algorithm"); + store_type = getString("store_type", "JKS"); + require_client_auth = getBoolean("require_client_auth", false); + require_endpoint_verification = getBoolean("require_endpoint_verification", false); + enabled = getBoolean("enabled"); + this.optional = getBoolean("optional"); + } + + private String getString(String key, String defaultValue) { + return this.parameters.get(key) == null ? defaultValue : (String)this.parameters.get(key); + } + + private String getString(String key) { + return (String)this.parameters.get(key); + } + + private List<String> getStringList(String key) { + return (List<String>)this.parameters.get(key); + } + + private Boolean getBoolean(String key, boolean defaultValue) { + return this.parameters.get(key) == null ? defaultValue : (Boolean)this.parameters.get(key); + } + + private Boolean getBoolean(String key) { + return (Boolean)this.parameters.get(key); + } + + @Override + public SSLContext createJSSESslContext(boolean buildTruststore) throws SSLException + { + TrustManager[] trustManagers = null; + if (buildTruststore) + trustManagers = buildTrustManagerFactory().getTrustManagers(); + + KeyManagerFactory kmf = buildKeyManagerFactory(); + + try + { + SSLContext ctx = SSLContext.getInstance("TLS"); + ctx.init(kmf.getKeyManagers(), trustManagers, null); + return ctx; + } + catch (Exception e) + { + throw new SSLException("Error creating/initializing the SSL Context", e); + } + } + + @Override + public SslContext createNettySslContext(boolean buildTruststore, SocketType socketType, boolean useOpenSsl, + CipherSuiteFilter cipherFilter) throws SSLException + { + /* + There is a case where the netty/openssl combo might not support using KeyManagerFactory. Specifically, + I've seen this with the netty-tcnative dynamic openssl implementation. Using the netty-tcnative + static-boringssl works fine with KeyManagerFactory. If we want to support all of the netty-tcnative + options, we would need to fall back to passing in a file reference for both a x509 and PKCS#8 private + key file in PEM format (see {@link SslContextBuilder#forServer(File, File, String)}). However, we are + not supporting that now to keep the config/yaml API simple. + */ + KeyManagerFactory kmf = buildKeyManagerFactory(); + SslContextBuilder builder; + if (socketType == SocketType.SERVER) + { + builder = SslContextBuilder.forServer(kmf).clientAuth(this.require_client_auth ? ClientAuth.REQUIRE : + ClientAuth.NONE); + } + else + { + builder = SslContextBuilder.forClient().keyManager(kmf); + } + + builder.sslProvider(useOpenSsl ? SslProvider.OPENSSL : SslProvider.JDK).protocols(getAcceptedProtocols()); + + // only set the cipher suites if the opertor has explicity configured values for it; else, use the default + // for each ssl implemention (jdk or openssl) + if (cipher_suites != null && !cipher_suites.isEmpty()) + builder.ciphers(cipher_suites, cipherFilter); + + if (buildTruststore) + builder.trustManager(buildTrustManagerFactory()); + + try + { + return builder.build(); + } + catch (SSLException e) + { + throw new SSLException("failed to build the final SslContext object for secure connections", e); + } + } + + @Override + public synchronized void initHotReloading() throws SSLException { + boolean hasKeystore = hasKeystore(); + boolean hasTruststore = hasTruststore(); + + if ( hasKeystore || hasTruststore ) { + List<HotReloadableFile> fileList = new ArrayList<>(); + if ( hasKeystore ) + { + fileList.add(new HotReloadableFile(keystore)); + } + if ( hasTruststore ) { + fileList.add(new HotReloadableFile(truststore)); + } + hotReloadableFiles = fileList; + } + } + + @Override + public boolean shouldReload() + { + return hotReloadableFiles.stream().anyMatch(HotReloadableFile::shouldReload); Review comment: The `initHotReloading` happens during the initialization from the DatabaseDescriptor. Let us say keystore and truststore both files exists at that time. Now the question is - what happens when one of those files is removed and `shouldReload` is called? Since Java APIs doesn't throw any errors for [file.lastModified() ](https://docs.oracle.com/javase/8/docs/api/java/io/File.html#lastModified--) in case file doesn't exist, it would think it should reload the file and [log error](https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/security/SSLFactory.java#L366) silently and continue. However, based on the current code (with or without this PR) when it actually tries to build the key/trust manager factory it would fail. This is the existing behavior in SSLFactory. Since we are not changing that behavior I am not sure if we need to change anything here. -- 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]
