You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by GitBox <gi...@apache.org> on 2021/12/16 01:07:43 UTC
[GitHub] [cassandra] jonmeredith commented on a change in pull request #1316: CASSANDRA-17031: Add support for PEM formatted key material for the SSL context
jonmeredith commented on a change in pull request #1316:
URL: https://github.com/apache/cassandra/pull/1316#discussion_r770141328
##########
File path: src/java/org/apache/cassandra/security/PEMReader.java
##########
@@ -0,0 +1,252 @@
+/*
+ * 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.ByteArrayInputStream;
+import java.io.IOException;
+import java.security.AlgorithmParameters;
+import java.security.GeneralSecurityException;
+import java.security.Key;
+import java.security.KeyFactory;
+import java.security.PrivateKey;
+import java.security.cert.Certificate;
+import java.security.cert.CertificateFactory;
+import java.security.cert.X509Certificate;
+import java.security.spec.PKCS8EncodedKeySpec;
+import java.util.ArrayList;
+import java.util.Base64;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import javax.crypto.Cipher;
+import javax.crypto.EncryptedPrivateKeyInfo;
+import javax.crypto.SecretKeyFactory;
+import javax.crypto.spec.PBEKeySpec;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static java.util.regex.Pattern.CASE_INSENSITIVE;
+
+/**
+ * This is a helper class to read private keys and X509 certifificates encoded based on <a href="https://datatracker.ietf.org/doc/html/rfc1421">PEM (RFC 1421)</a>
+ * format. It can read Password Based Encrypted (PBE henceforth) private keys as well as non-encrypted private keys
+ * along with the X509 certificates/cert-chain based on the textual encoding defined in the <a href="https://datatracker.ietf.org/doc/html/rfc7468">RFC 7468</a>
+ * <p>
+ * The input private key must be in PKCS#8 format.
+ * <p>
+ * It returns PKCS#8 formatted private key and X509 certificates.
+ */
+public final class PEMReader
+{
+ /**
+ * The private key can be with any of these algorithms in order for this read to successfully parse it.
+ * Currently supported algorithms are,
+ * <pre>
+ * RSA, DSA or EC
+ * </pre>
+ * The first one to be evaluated is RSA, being the most common for private keys.
+ */
+ public static final String[] SUPPORTED_PRIVATE_KEY_ALGORITHMS = new String[]{ "RSA", "DSA", "EC" };
+ private static final Logger logger = LoggerFactory.getLogger(PEMReader.class);
+ private static final Pattern CERT_PATTERN = Pattern.compile("-+BEGIN\\s+.*CERTIFICATE[^-]*-+(?:\\s|\\r|\\n)+([a-z0-9+/=\\r\\n]+)-+END\\s+.*CERTIFICATE[^-]*-+", CASE_INSENSITIVE);
+ private static final Pattern KEY_PATTERN = Pattern.compile("-+BEGIN\\s+.*PRIVATE\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+([a-z0-9+/=\\r\\n]+)-+END\\s+.*PRIVATE\\s+KEY[^-]*-+", CASE_INSENSITIVE);
+
+ /**
+ * Extracts private key from the PEM content for the private key, assuming its not PBE.
+ *
+ * @param unencryptedPEMKey private key stored as PEM content
+ * @return {@link PrivateKey} upon successful reading of the private key
+ * @throws IOException in case PEM reading fails
+ * @throws GeneralSecurityException in case any issue encountered while reading the private key
+ */
+ public static PrivateKey extractPrivateKey(String unencryptedPEMKey) throws IOException, GeneralSecurityException
+ {
+ return extractPrivateKey(unencryptedPEMKey, null);
+ }
+
+ /**
+ * Extracts private key from the Password Based Encrypted PEM content for the private key.
+ *
+ * @param pemKey PBE private key stored as PEM content
+ * @param keyPassword password to be used for the private key decryption
+ * @return {@link PrivateKey} upon successful reading of the private key
+ * @throws IOException in case PEM reading fails
+ * @throws GeneralSecurityException in case any issue encountered while reading the private key
+ */
+ public static PrivateKey extractPrivateKey(String pemKey, String keyPassword) throws IOException,
+ GeneralSecurityException
+ {
+ PKCS8EncodedKeySpec keySpec;
+ String base64EncodedKey = extractBase64EncodedKey(pemKey);
+ byte[] derKeyBytes = Base64.getDecoder().decode(base64EncodedKey);
Review comment:
If the base64 encoded key is found but is invalid it will throw an `IllegalArgumentException` which would make it up to the KeyManagerFactory.
Is it worth helping the user out with a nicer message that the base64 encoding was bad vs the contents of the certificate? If so, probably worth adding a test case to make sure you hit it.
##########
File path: src/java/org/apache/cassandra/security/PEMReader.java
##########
@@ -0,0 +1,252 @@
+/*
+ * 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.ByteArrayInputStream;
+import java.io.IOException;
+import java.security.AlgorithmParameters;
+import java.security.GeneralSecurityException;
+import java.security.Key;
+import java.security.KeyFactory;
+import java.security.PrivateKey;
+import java.security.cert.Certificate;
+import java.security.cert.CertificateFactory;
+import java.security.cert.X509Certificate;
+import java.security.spec.PKCS8EncodedKeySpec;
+import java.util.ArrayList;
+import java.util.Base64;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import javax.crypto.Cipher;
+import javax.crypto.EncryptedPrivateKeyInfo;
+import javax.crypto.SecretKeyFactory;
+import javax.crypto.spec.PBEKeySpec;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static java.util.regex.Pattern.CASE_INSENSITIVE;
+
+/**
+ * This is a helper class to read private keys and X509 certifificates encoded based on <a href="https://datatracker.ietf.org/doc/html/rfc1421">PEM (RFC 1421)</a>
+ * format. It can read Password Based Encrypted (PBE henceforth) private keys as well as non-encrypted private keys
+ * along with the X509 certificates/cert-chain based on the textual encoding defined in the <a href="https://datatracker.ietf.org/doc/html/rfc7468">RFC 7468</a>
+ * <p>
+ * The input private key must be in PKCS#8 format.
+ * <p>
+ * It returns PKCS#8 formatted private key and X509 certificates.
+ */
+public final class PEMReader
+{
+ /**
+ * The private key can be with any of these algorithms in order for this read to successfully parse it.
+ * Currently supported algorithms are,
+ * <pre>
+ * RSA, DSA or EC
+ * </pre>
+ * The first one to be evaluated is RSA, being the most common for private keys.
+ */
+ public static final String[] SUPPORTED_PRIVATE_KEY_ALGORITHMS = new String[]{ "RSA", "DSA", "EC" };
Review comment:
Although the array is final, the contents can be changed.
```
@Test
public void tamperWithPRivateKeyAlgorithms()
{
String[] original = PEMReader.SUPPORTED_PRIVATE_KEY_ALGORITHMS.clone();
for (int i = 0; i < PEMReader.SUPPORTED_PRIVATE_KEY_ALGORITHMS.length; i++)
{
PEMReader.SUPPORTED_PRIVATE_KEY_ALGORITHMS[i] = "TAMPERED";
}
Assert.assertArrayEquals(original, PEMReader.SUPPORTED_PRIVATE_KEY_ALGORITHMS); // Fail
}
```
An attacker with the ability to run arbitrary code in theJVM could prevent certificate loading by emptying this array or restricting to vulnerable ones. Seems like they could also do all kinds of other bad things too, but just in case would you mind replacing this with an ImmutableList instead? e.g. using `ImmutableList.of(...)`
##########
File path: src/java/org/apache/cassandra/security/PEMBasedSslContextFactory.java
##########
@@ -0,0 +1,339 @@
+/*
+ * 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.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.security.GeneralSecurityException;
+import java.security.KeyStore;
+import java.security.PrivateKey;
+import java.security.cert.Certificate;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import javax.net.ssl.KeyManagerFactory;
+import javax.net.ssl.SSLException;
+import javax.net.ssl.TrustManagerFactory;
+
+import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+/**
+ * SslContextFactory for the <a href="">PEM standard</a> encoded PKCS#8 private keys and X509 certificates/public-keys.
+ * It parses the key material based on the standard defined in the <a href="https://datatracker.ietf.org/doc/html/rfc7468">RFC 7468</a>.
+ * It creates <a href="https://datatracker.ietf.org/doc/html/rfc5208">PKCS# 8</a> based private key and X509 certificate(s)
+ * for the public key to build the required keystore and the truststore managers that are used for the SSL context creation.
+ * Internally it builds Java {@link KeyStore} with <a href="https://datatracker.ietf.org/doc/html/rfc7292">PKCS# 12</a> <a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#keystore-types">store type</a>
+ * to be used for keystore and the truststore managers.
+ * <p>
+ * This factory also supports 'hot reloading' of the key material, the same way as defined by {@link FileBasedSslContextFactory},
+ * if it is file based. This factory ignores the existing 'store_type' configuration used for other file based store
+ * types like JKS.
+ * <p>
+ * You can configure this factory with either inline PEM data or with the files having the required PEM data as shown
+ * below,
+ *
+ * <b>Configuration: PEM keys/certs defined inline (mind the spaces in the YAML!)</b>
+ * <pre>
+ * client/server_encryption_options:
+ * ssl_context_factory:
+ * class_name: org.apache.cassandra.security.PEMBasedSslContextFactory
+ * parameters:
+ * private_key: |
+ * -----BEGIN ENCRYPTED PRIVATE KEY----- OR -----BEGIN PRIVATE KEY-----
+ * <your base64 encoded private key>
+ * -----END ENCRYPTED PRIVATE KEY----- OR -----END PRIVATE KEY-----
+ * -----BEGIN CERTIFICATE-----
+ * <your base64 encoded certificate chain>
+ * -----END CERTIFICATE-----
+ *
+ * private_key_password: "<your password if the private key is encrypted with a password>"
+ *
+ * trusted_certificates: |
+ * -----BEGIN CERTIFICATE-----
+ * <your base64 encoded certificate>
+ * -----END CERTIFICATE-----
+ * </pre>
+ *
+ * <b>Configuration: PEM keys/certs defined in files</b>
+ * <pre>
+ * client/server_encryption_options:
+ * ssl_context_factory:
+ * class_name: org.apache.cassandra.security.PEMBasedSslContextFactory
+ * keystore: <file path to the keystore file in the PEM format with the private key and the certificate chain>
+ * keystore_password: "<your password if the private key is encrypted with a password>"
+ * truststore: <file path to the truststore file in the PEM format>
+ * </pre>
+ */
+public final class PEMBasedSslContextFactory extends FileBasedSslContextFactory
+{
+ public static final String DEFAULT_TARGET_STORETYPE = "PKCS12";
+ private static final Logger logger = LoggerFactory.getLogger(PEMBasedSslContextFactory.class);
+ private String targetStoreType;
+ private String pemEncodedKey;
+ private String keyPassword;
+ private String pemEncodedCertificates;
+ private boolean maybeFileBasedPrivateKey;
+ private boolean maybeFileBasedTrustedCertificates;
+
+ public PEMBasedSslContextFactory()
+ {
+ targetStoreType = DEFAULT_TARGET_STORETYPE;
+ }
+
+ public PEMBasedSslContextFactory(Map<String, Object> parameters)
+ {
+ super(parameters);
+ targetStoreType = DEFAULT_TARGET_STORETYPE;
+ pemEncodedKey = getString(ConfigKey.ENCODED_KEY.getKeyName());
+ keyPassword = getString(ConfigKey.KEY_PASSWORD.getKeyName());
+ if (StringUtils.isEmpty(keyPassword))
+ {
+ keyPassword = keystore_password;
+ }
+ else if (!StringUtils.isEmpty(keystore_password) && !keyPassword.equals(keystore_password))
+ {
+ throw new IllegalArgumentException("'keystore_password' and 'key_password' both configurations are given and the " +
+ "values do not match");
+ }
+ else
+ {
+ logger.warn("'keystore_password' and 'key_password' both are configured but since the values match it's " +
+ "okay. Ideally you should only specify one of them.");
+ }
+
+ if (!StringUtils.isEmpty(truststore_password))
+ {
+ logger.warn("PEM based truststore should not be using password. Ignoring the given value in " +
+ "'truststore_password' configuration.");
+ }
+
+ pemEncodedCertificates = getString(ConfigKey.ENCODED_CERTIFICATES.getKeyName());
+
+ maybeFileBasedPrivateKey = StringUtils.isEmpty(pemEncodedKey);
+ maybeFileBasedTrustedCertificates = StringUtils.isEmpty(pemEncodedCertificates);
+ }
+
+ /**
+ * Decides if this factory has a keystore defined - key material specified in files or inline to the configuration.
+ *
+ * @return {@code true} if there is a keystore defined; {@code false} otherwise
+ */
+ @Override
+ public boolean hasKeystore()
+ {
+ return maybeFileBasedPrivateKey ? (keystore != null && new File(keystore).exists()) :
+ !StringUtils.isEmpty(pemEncodedKey);
+ }
+
+ /**
+ * Decides if this factory has a truststore defined - key material specified in files or inline to the
+ * configuration.
+ *
+ * @return {@code true} if there is a truststore defined; {@code false} otherwise
+ */
+ private boolean hasTruststore()
+ {
+ return maybeFileBasedTrustedCertificates ? (truststore != null && new File(truststore).exists()) :
+ !StringUtils.isEmpty(pemEncodedCertificates);
+ }
+
+ /**
+ * This enables 'hot' reloading of the key/trust stores based on the last updated timestamps if they are file based.
+ */
+ @Override
+ public synchronized void initHotReloading()
+ {
+ List<HotReloadableFile> fileList = new ArrayList<>();
+ if (maybeFileBasedPrivateKey && hasKeystore())
+ {
+ fileList.add(new HotReloadableFile(keystore));
+ }
+ if (maybeFileBasedTrustedCertificates && hasTruststore())
+ {
+ fileList.add(new HotReloadableFile(truststore));
+ }
+ if (!fileList.isEmpty())
+ {
+ hotReloadableFiles = fileList;
+ }
+ }
+
+ /**
+ * Builds required KeyManagerFactory from the PEM based keystore. It also checks for the PrivateKey's certificate's
+ * expiry and logs {@code warning} for each expired PrivateKey's certitificate.
+ *
+ * @return KeyManagerFactory built from the PEM based keystore.
+ * @throws SSLException if any issues encountered during the build process
+ */
+ @Override
+ protected KeyManagerFactory buildKeyManagerFactory() throws SSLException
+ {
+ try
+ {
+ if (hasKeystore())
+ {
+ if (maybeFileBasedPrivateKey)
+ {
+ pemEncodedKey = readPEMFile(keystore); // read PEM from the file
+ }
+
+ KeyManagerFactory kmf = KeyManagerFactory.getInstance(
+ algorithm == null ? KeyManagerFactory.getDefaultAlgorithm() : algorithm);
+ KeyStore ks = buildKeyStore();
+ if (!checkedExpiry)
+ {
+ checkExpiredCerts(ks);
+ checkedExpiry = true;
+ }
+ kmf.init(ks, keyPassword != null ? keyPassword.toCharArray() : null);
+ return kmf;
+ }
+ else
+ {
+ throw new SSLException("Can not build KeyManagerFactory in absence of the Private Key");
+ }
+ }
+ catch (Exception e)
+ {
+ throw new SSLException("Failed to build key manager store for secure connections", e);
Review comment:
looks good.
##########
File path: src/java/org/apache/cassandra/security/PEMReader.java
##########
@@ -0,0 +1,252 @@
+/*
+ * 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.ByteArrayInputStream;
+import java.io.IOException;
+import java.security.AlgorithmParameters;
+import java.security.GeneralSecurityException;
+import java.security.Key;
+import java.security.KeyFactory;
+import java.security.PrivateKey;
+import java.security.cert.Certificate;
+import java.security.cert.CertificateFactory;
+import java.security.cert.X509Certificate;
+import java.security.spec.PKCS8EncodedKeySpec;
+import java.util.ArrayList;
+import java.util.Base64;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import javax.crypto.Cipher;
+import javax.crypto.EncryptedPrivateKeyInfo;
+import javax.crypto.SecretKeyFactory;
+import javax.crypto.spec.PBEKeySpec;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static java.util.regex.Pattern.CASE_INSENSITIVE;
+
+/**
+ * This is a helper class to read private keys and X509 certifificates encoded based on <a href="https://datatracker.ietf.org/doc/html/rfc1421">PEM (RFC 1421)</a>
+ * format. It can read Password Based Encrypted (PBE henceforth) private keys as well as non-encrypted private keys
+ * along with the X509 certificates/cert-chain based on the textual encoding defined in the <a href="https://datatracker.ietf.org/doc/html/rfc7468">RFC 7468</a>
+ * <p>
+ * The input private key must be in PKCS#8 format.
+ * <p>
+ * It returns PKCS#8 formatted private key and X509 certificates.
+ */
+public final class PEMReader
+{
+ /**
+ * The private key can be with any of these algorithms in order for this read to successfully parse it.
+ * Currently supported algorithms are,
+ * <pre>
+ * RSA, DSA or EC
+ * </pre>
+ * The first one to be evaluated is RSA, being the most common for private keys.
+ */
+ public static final String[] SUPPORTED_PRIVATE_KEY_ALGORITHMS = new String[]{ "RSA", "DSA", "EC" };
+ private static final Logger logger = LoggerFactory.getLogger(PEMReader.class);
+ private static final Pattern CERT_PATTERN = Pattern.compile("-+BEGIN\\s+.*CERTIFICATE[^-]*-+(?:\\s|\\r|\\n)+([a-z0-9+/=\\r\\n]+)-+END\\s+.*CERTIFICATE[^-]*-+", CASE_INSENSITIVE);
+ private static final Pattern KEY_PATTERN = Pattern.compile("-+BEGIN\\s+.*PRIVATE\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+([a-z0-9+/=\\r\\n]+)-+END\\s+.*PRIVATE\\s+KEY[^-]*-+", CASE_INSENSITIVE);
+
+ /**
+ * Extracts private key from the PEM content for the private key, assuming its not PBE.
+ *
+ * @param unencryptedPEMKey private key stored as PEM content
+ * @return {@link PrivateKey} upon successful reading of the private key
+ * @throws IOException in case PEM reading fails
+ * @throws GeneralSecurityException in case any issue encountered while reading the private key
+ */
+ public static PrivateKey extractPrivateKey(String unencryptedPEMKey) throws IOException, GeneralSecurityException
+ {
+ return extractPrivateKey(unencryptedPEMKey, null);
+ }
+
+ /**
+ * Extracts private key from the Password Based Encrypted PEM content for the private key.
+ *
+ * @param pemKey PBE private key stored as PEM content
+ * @param keyPassword password to be used for the private key decryption
+ * @return {@link PrivateKey} upon successful reading of the private key
+ * @throws IOException in case PEM reading fails
+ * @throws GeneralSecurityException in case any issue encountered while reading the private key
+ */
+ public static PrivateKey extractPrivateKey(String pemKey, String keyPassword) throws IOException,
+ GeneralSecurityException
+ {
+ PKCS8EncodedKeySpec keySpec;
+ String base64EncodedKey = extractBase64EncodedKey(pemKey);
+ byte[] derKeyBytes = Base64.getDecoder().decode(base64EncodedKey);
+
+ if (keyPassword != null)
+ {
+ logger.debug("Encrypted key's length: {}", derKeyBytes.length);
+ logger.debug("Key's password length: {}", keyPassword.length());
+
+ EncryptedPrivateKeyInfo epki = new EncryptedPrivateKeyInfo(derKeyBytes);
+ logger.debug("Encrypted private key info's algorithm name: {}", epki.getAlgName());
+
+ AlgorithmParameters params = epki.getAlgParameters();
+ PBEKeySpec pbeKeySpec = new PBEKeySpec(keyPassword.toCharArray());
+ Key encryptionKey = SecretKeyFactory.getInstance(epki.getAlgName()).generateSecret(pbeKeySpec);
+ pbeKeySpec.clearPassword();
+ logger.debug("Key algorithm: {}", encryptionKey.getAlgorithm());
+ logger.debug("Key format: {}", encryptionKey.getFormat());
+
+ Cipher cipher = Cipher.getInstance(epki.getAlgName());
+ cipher.init(Cipher.DECRYPT_MODE, encryptionKey, params);
+ byte[] rawKeyBytes = cipher.doFinal(epki.getEncryptedData());
Review comment:
Ugly exception here if the password is incorrect
```javax.crypto.BadPaddingException: Given final block not properly padded. Such issues can arise if a bad key is used during decryption.
at java.base/com.sun.crypto.provider.CipherCore.unpad(CipherCore.java:975)
at java.base/com.sun.crypto.provider.CipherCore.fillOutputBuffer(CipherCore.java:1056)
at java.base/com.sun.crypto.provider.CipherCore.doFinal(CipherCore.java:853)
at java.base/com.sun.crypto.provider.PBES1Core.doFinal(PBES1Core.java:432)
at java.base/com.sun.crypto.provider.PBEWithMD5AndDESCipher.engineDoFinal(PBEWithMD5AndDESCipher.java:316)
at java.base/javax.crypto.Cipher.doFinal(Cipher.java:2202)
at org.apache.cassandra.security.PEMReader.extractPrivateKey(PEMReader.java:117)
at org.apache.cassandra.security.PEMReaderTest.readEncryptedDSAKey(PEMReaderTest.java:305)
```
It does suggest the bad key which would give the user a hint that it's the password that is the issue.
##########
File path: src/java/org/apache/cassandra/security/PEMBasedSslContextFactory.java
##########
@@ -0,0 +1,355 @@
+/*
+ * 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.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.security.GeneralSecurityException;
+import java.security.KeyStore;
+import java.security.PrivateKey;
+import java.security.cert.Certificate;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import javax.net.ssl.KeyManagerFactory;
+import javax.net.ssl.SSLException;
+import javax.net.ssl.TrustManagerFactory;
+
+import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+/**
+ * SslContextFactory for the <a href="">PEM standard</a> encoded PKCS#8 private keys and X509 certificates/public-keys.
+ * It parses the key material based on the standard defined in the <a href="https://datatracker.ietf.org/doc/html/rfc7468">RFC 7468</a>.
+ * It creates <a href="https://datatracker.ietf.org/doc/html/rfc5208">PKCS# 8</a> based private key and X509 certificate(s)
+ * for the public key to build the required keystore and the truststore managers that are used for the SSL context creation.
+ * Internally it builds Java {@link KeyStore} with <a href="https://datatracker.ietf.org/doc/html/rfc7292">PKCS# 12</a> <a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#keystore-types">store type</a>
+ * to be used for keystore and the truststore managers.
+ * <p>
+ * This factory also supports 'hot reloading' of the key material, the same way as defined by {@link FileBasedSslContextFactory},
+ * <b>if it is file based</b>. This factory ignores the existing 'store_type' configuration used for other file based store
+ * types like JKS.
+ * <p>
+ * You can configure this factory with either inline PEM data or with the files having the required PEM data as shown
+ * below,
+ *
+ * <b>Configuration: PEM keys/certs defined inline (mind the spaces in the YAML!)</b>
+ * <pre>
+ * client/server_encryption_options:
+ * ssl_context_factory:
+ * class_name: org.apache.cassandra.security.PEMBasedSslContextFactory
+ * parameters:
+ * private_key: |
+ * -----BEGIN ENCRYPTED PRIVATE KEY----- OR -----BEGIN PRIVATE KEY-----
+ * <your base64 encoded private key>
+ * -----END ENCRYPTED PRIVATE KEY----- OR -----END PRIVATE KEY-----
+ * -----BEGIN CERTIFICATE-----
+ * <your base64 encoded certificate chain>
+ * -----END CERTIFICATE-----
+ *
+ * private_key_password: "<your password if the private key is encrypted with a password>"
+ *
+ * trusted_certificates: |
+ * -----BEGIN CERTIFICATE-----
+ * <your base64 encoded certificate>
+ * -----END CERTIFICATE-----
+ * </pre>
+ *
+ * <b>Configuration: PEM keys/certs defined in files</b>
+ * <pre>
+ * client/server_encryption_options:
+ * ssl_context_factory:
+ * class_name: org.apache.cassandra.security.PEMBasedSslContextFactory
+ * keystore: <file path to the keystore file in the PEM format with the private key and the certificate chain>
+ * keystore_password: "<your password if the private key is encrypted with a password>"
+ * truststore: <file path to the truststore file in the PEM format>
+ * </pre>
+ */
+public final class PEMBasedSslContextFactory extends FileBasedSslContextFactory
+{
+ public static final String DEFAULT_TARGET_STORETYPE = "PKCS12";
+ private static final Logger logger = LoggerFactory.getLogger(PEMBasedSslContextFactory.class);
+ private String pemEncodedKey;
+ private String keyPassword;
+ private String pemEncodedCertificates;
+ private boolean maybeFileBasedPrivateKey;
+ private boolean maybeFileBasedTrustedCertificates;
+
+ public PEMBasedSslContextFactory()
+ {
+ }
+
+ public PEMBasedSslContextFactory(Map<String, Object> parameters)
+ {
+ super(parameters);
+ pemEncodedKey = getString(ConfigKey.ENCODED_KEY.getKeyName());
+ keyPassword = getString(ConfigKey.KEY_PASSWORD.getKeyName());
+ if (StringUtils.isEmpty(keyPassword))
+ {
+ keyPassword = keystore_password;
+ }
+ else if (!StringUtils.isEmpty(keystore_password) && !keyPassword.equals(keystore_password))
+ {
+ throw new IllegalArgumentException("'keystore_password' and 'key_password' both configurations are given and the " +
+ "values do not match");
+ }
+ else
+ {
+ logger.warn("'keystore_password' and 'key_password' both are configured but since the values match it's " +
+ "okay. Ideally you should only specify one of them.");
+ }
+
+ if (!StringUtils.isEmpty(truststore_password))
+ {
+ logger.warn("PEM based truststore should not be using password. Ignoring the given value in " +
+ "'truststore_password' configuration.");
+ }
+
+ pemEncodedCertificates = getString(ConfigKey.ENCODED_CERTIFICATES.getKeyName());
+
+ maybeFileBasedPrivateKey = StringUtils.isEmpty(pemEncodedKey);
+ maybeFileBasedTrustedCertificates = StringUtils.isEmpty(pemEncodedCertificates);
+
+ enforceSinglePrivateKeySource();
+ enforceSingleTurstedCertificatesSource();
+ }
+
+ /**
+ * Decides if this factory has a keystore defined - key material specified in files or inline to the configuration.
+ *
+ * @return {@code true} if there is a keystore defined; {@code false} otherwise
+ */
+ @Override
+ public boolean hasKeystore()
+ {
+ return maybeFileBasedPrivateKey ? (keystore != null && new File(keystore).exists()) :
Review comment:
Could an attacker with access to the filesystem write a file named after the contents of `keystore` and substitute with an alternate certificate without the operator knowing? It would be a horrible filename, but maybe possible based on the allowed regex
`-+BEGIN\\s+.*CERTIFICATE[^-]*-+(?:\\s|\\r|\\n)+([a-z0-9+/=\\r\\n]+)-+END\\s+.*CERTIFICATE[^-]*-+`
Spaces are allowed between the BEGIN/END certificates instead of CR/LF so you could be very unlucky and have a base64 encoded cert without a / to prevent an illegal filename.
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org