Correctly handle PKCS#11 tokens for system keystore (#33460)
* Correctly handle NONE keyword for system keystore As defined in the PKCS#11 reference guide https://docs.oracle.com/javase/8/docs/technotes/guides/security/p11guide.html PKCS#11 tokens can be used as the JSSE keystore and truststore and the way to indicate this is to set `javax.net.ssl.keyStore` and `javax.net.ssl.trustStore` to `NONE` (case sensitive). This commits ensures that we honor this convention and do not attempt to load the keystore or truststore if the system property is set to NONE. * Handle password protected system truststore When a PKCS#11 token is used as the system truststore, we need to pass a password when loading it, even if only for reading certificate entries. This commit ensures that if `javax.net.ssl.trustStoreType` is set to `PKCS#11` (as it would when a PKCS#11 token is in use) the password specified in `javax.net.ssl.trustStorePassword` is passed when attempting to load the truststore. Relates #33459
This commit is contained in:
parent
95100e05f9
commit
77aeeda275
|
@ -16,6 +16,10 @@ import javax.net.ssl.X509ExtendedTrustManager;
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.nio.file.Path;
|
import java.nio.file.Path;
|
||||||
import java.security.GeneralSecurityException;
|
import java.security.GeneralSecurityException;
|
||||||
|
import java.security.KeyStore;
|
||||||
|
import java.security.KeyStoreException;
|
||||||
|
import java.security.NoSuchAlgorithmException;
|
||||||
|
import java.security.cert.CertificateException;
|
||||||
import java.util.Arrays;
|
import java.util.Arrays;
|
||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
import java.util.Collections;
|
import java.util.Collections;
|
||||||
|
@ -34,7 +38,7 @@ class DefaultJDKTrustConfig extends TrustConfig {
|
||||||
@Override
|
@Override
|
||||||
X509ExtendedTrustManager createTrustManager(@Nullable Environment environment) {
|
X509ExtendedTrustManager createTrustManager(@Nullable Environment environment) {
|
||||||
try {
|
try {
|
||||||
return CertParsingUtils.trustManager(null, TrustManagerFactory.getDefaultAlgorithm());
|
return CertParsingUtils.trustManager(getSystemTrustStore(), TrustManagerFactory.getDefaultAlgorithm());
|
||||||
} catch (Exception e) {
|
} catch (Exception e) {
|
||||||
throw new ElasticsearchException("failed to initialize a TrustManagerFactory", e);
|
throw new ElasticsearchException("failed to initialize a TrustManagerFactory", e);
|
||||||
}
|
}
|
||||||
|
@ -81,4 +85,20 @@ class DefaultJDKTrustConfig extends TrustConfig {
|
||||||
return new CombiningTrustConfig(Arrays.asList(INSTANCE, trustConfig));
|
return new CombiningTrustConfig(Arrays.asList(INSTANCE, trustConfig));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When a PKCS#11 token is used as the system default keystore/truststore, we need to pass the keystore
|
||||||
|
* password when loading, even for reading certificates only ( as opposed to i.e. JKS keystores where
|
||||||
|
* we only need to pass the password for reading Private Key entries ).
|
||||||
|
*
|
||||||
|
* @return the KeyStore used as truststore for PKCS#11 initialized with the password, null otherwise
|
||||||
|
*/
|
||||||
|
private KeyStore getSystemTrustStore() throws KeyStoreException, CertificateException, NoSuchAlgorithmException, IOException {
|
||||||
|
if (System.getProperty("javax.net.ssl.trustStoreType", "").equalsIgnoreCase("PKCS11")) {
|
||||||
|
KeyStore keyStore = KeyStore.getInstance("PKCS11");
|
||||||
|
keyStore.load(null, System.getProperty("javax.net.ssl.trustStorePassword", "").toCharArray());
|
||||||
|
return keyStore;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -192,7 +192,7 @@ public final class SSLConfiguration {
|
||||||
if (global != null) {
|
if (global != null) {
|
||||||
return global.keyConfig();
|
return global.keyConfig();
|
||||||
}
|
}
|
||||||
if (System.getProperty("javax.net.ssl.keyStore") != null) {
|
if (System.getProperty("javax.net.ssl.keyStore") != null && System.getProperty("javax.net.ssl.keyStore").equals("NONE") == false) {
|
||||||
// TODO: we should not support loading a keystore from sysprops...
|
// TODO: we should not support loading a keystore from sysprops...
|
||||||
try (SecureString keystorePassword = new SecureString(System.getProperty("javax.net.ssl.keyStorePassword", ""))) {
|
try (SecureString keystorePassword = new SecureString(System.getProperty("javax.net.ssl.keyStorePassword", ""))) {
|
||||||
return new StoreKeyConfig(System.getProperty("javax.net.ssl.keyStore"), KeyStore.getDefaultType(), keystorePassword,
|
return new StoreKeyConfig(System.getProperty("javax.net.ssl.keyStore"), KeyStore.getDefaultType(), keystorePassword,
|
||||||
|
@ -233,7 +233,8 @@ public final class SSLConfiguration {
|
||||||
String trustStoreAlgorithm = SETTINGS_PARSER.truststoreAlgorithm.get(settings);
|
String trustStoreAlgorithm = SETTINGS_PARSER.truststoreAlgorithm.get(settings);
|
||||||
String trustStoreType = getKeyStoreType(SETTINGS_PARSER.truststoreType, settings, trustStorePath);
|
String trustStoreType = getKeyStoreType(SETTINGS_PARSER.truststoreType, settings, trustStorePath);
|
||||||
return new StoreTrustConfig(trustStorePath, trustStoreType, trustStorePassword, trustStoreAlgorithm);
|
return new StoreTrustConfig(trustStorePath, trustStoreType, trustStorePassword, trustStoreAlgorithm);
|
||||||
} else if (global == null && System.getProperty("javax.net.ssl.trustStore") != null) {
|
} else if (global == null && System.getProperty("javax.net.ssl.trustStore") != null
|
||||||
|
&& System.getProperty("javax.net.ssl.trustStore").equals("NONE") == false) {
|
||||||
try (SecureString truststorePassword = new SecureString(System.getProperty("javax.net.ssl.trustStorePassword", ""))) {
|
try (SecureString truststorePassword = new SecureString(System.getProperty("javax.net.ssl.trustStorePassword", ""))) {
|
||||||
return new StoreTrustConfig(System.getProperty("javax.net.ssl.trustStore"), KeyStore.getDefaultType(), truststorePassword,
|
return new StoreTrustConfig(System.getProperty("javax.net.ssl.trustStore"), KeyStore.getDefaultType(), truststorePassword,
|
||||||
System.getProperty("ssl.TrustManagerFactory.algorithm", TrustManagerFactory.getDefaultAlgorithm()));
|
System.getProperty("ssl.TrustManagerFactory.algorithm", TrustManagerFactory.getDefaultAlgorithm()));
|
||||||
|
|
Loading…
Reference in New Issue