maulin-vasavada commented on a change in pull request #1027: URL: https://github.com/apache/cassandra/pull/1027#discussion_r698755259
########## File path: examples/ssl-factory/src/org/apache/cassandra/security/KubernetesSecretsSslContextFactory.java ########## @@ -0,0 +1,270 @@ +/* + * 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.IOException; +import java.io.InputStream; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.Map; +import java.util.Optional; + +import com.google.common.annotations.VisibleForTesting; +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Custom {@link ISslContextFactory} implementation based on Kubernetes Secrets. It allows the keystore and + * truststore paths to be configured from the K8 secrets via volumeMount and passwords via K8 secrets environment + * variables. The official Kubernetes Secret Spec can be found <a href="https://kubernetes.io/docs/concepts/configuration/secret/ ">here</a>. + * + * When keystore or truststore is updated, this implementation can detect that based on updated K8 secrets + * at the mounted paths ({@code KEYSTORE_UPDATED_TIMESTAMP_PATH} for the keystore and {@code + * TRUSTSTORE_UPDATED_TIMESTAMP_PATH} for the truststore. The values in those paths are expected to be numeric values. + * Most obvious choice might be to just use time in nano/milli-seconds but any other strategy would work + * as well, as far as the comparison of those values can be done in a consistent/predictable manner. Again, those + * values don't have to necessarily reflect actual file's update timestamps, using the actual file's timestamps is + * just one of the valid options to signal updates. + * + * Defaults: + * <pre> + * keystore path = /etc/my-ssl-store/keystore + * keystore password = cassandra + * keystore updated timestamp path = /etc/my-ssl-store/keystore-last-updatedtime + * truststore path = /etc/my-ssl-store/truststore + * truststore password = cassandra + * truststore updated timestamp path = /etc/my-ssl-store/truststore-last-updatedtime + * </pre> + * + * Customization: In order to customize the K8 secret configuration, override appropriate values in the below cassandra + * configuration. The similar configuration can be applied to {@code client_encryption_options}. + * <pre> + * server_encryption_options: + * internode_encryption: none + * ssl_context_factory: + * class_name: org.apache.cassandra.security.K8SecretsSslContextFactory + * parameters: + * KEYSTORE_PATH: /etc/my-ssl-store/keystore + * KEYSTORE_PASSWORD_ENV_VAR: KEYSTORE_PASSWORD + * KEYSTORE_UPDATED_TIMESTAMP_PATH: /etc/my-ssl-store/keystore-last-updatedtime + * TRUSTSTORE_PATH: /etc/my-ssl-store/truststore + * TRUSTSTORE_PASSWORD_ENV_VAR: TRUSTSTORE_PASSWORD + * TRUSTSTORE_UPDATED_TIMESTAMP_PATH: /etc/my-ssl-store/truststore-last-updatedtime + * </pre> + * + * Below is the corresponding sample YAML configuration for K8 env. + * <pre> + * apiVersion: v1 + * kind: Pod + * metadata: + * name: my-pod + * labels: + * app: my-app + * spec: + * containers: + * - name: my-app + * image: my-app:latest + * imagePullPolicy: Always + * env: + * - name: KEYSTORE_PASSWORD + * valueFrom: + * secretKeyRef: + * name: my-ssl-store + * key: keystore-password + * - name: TRUSTSTORE_PASSWORD + * valueFrom: + * secretKeyRef: + * name: my-ssl-store + * key: truststore-password + * volumeMounts: + * - name: my-ssl-store + * mountPath: "/etc/my-ssl-store" + * readOnly: true + * volumes: + * - name: my-ssl-store + * secret: + * secretName: my-ssl-store + * items: + * - key: cassandra_ssl_keystore + * path: keystore + * - key: keystore-last-updatedtime + * path: keystore-last-updatedtime + * - key: cassandra_ssl_truststore + * path: truststore + * - key: truststore-last-updatedtime + * path: truststore-last-updatedtime + * </pre> + */ +public class KubernetesSecretsSslContextFactory extends FileBasedSslContextFactory +{ + private static final Logger logger = LoggerFactory.getLogger(KubernetesSecretsSslContextFactory.class); + + /** + * Use below config-keys to configure this factory. + */ + public interface ConfigKeys { + String KEYSTORE_PATH = "KEYSTORE_PATH"; Review comment: For the keystore/truststore paths I agree we can just use the existing encryption option keys to configure. With the password its different because in the current encryption options the value in that field is the actual password vs with K8s we are asking for yet-another-indirection, a secrets name that will give us the password. However, I will change the paths to come from existing encryption option keys instead of duplicating. -- 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]
