Skip to content

Commit

Permalink
Revert the #844 (#1132)
Browse files Browse the repository at this point in the history
This commit partially reverts changes introduced in #844 as they breaks the
functionality (property names are case-sensitive in the TLS/SSL configuration).
  • Loading branch information
kwart authored Jun 10, 2024
1 parent 44ba3a5 commit a70724d
Showing 1 changed file with 40 additions and 40 deletions.
80 changes: 40 additions & 40 deletions docs/modules/security/pages/tls-ssl.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,12 @@ XML::
<properties>
<property name="protocol">TLSv1.2</property>
<property name="mutualAuthentication">REQUIRED</property>
<property name="keystore">/opt/hazelcast-keystore.p12</property>
<property name="keystorePassword">secret.123</property>
<property name="keystoreType">PKCS12</property>
<property name="truststore">/opt/hazelcast-truststore.p12</property>
<property name="truststorePassword">changeit</property>
<property name="truststoreType">PKCS12</property>
<property name="keyStore">/opt/hazelcast-keystore.p12</property>
<property name="keyStorePassword">secret.123</property>
<property name="keyStoreType">PKCS12</property>
<property name="trustStore">/opt/hazelcast-truststore.p12</property>
<property name="trustStorePassword">changeit</property>
<property name="trustStoreType">PKCS12</property>
<property name="keyMaterialDuration">PT10M</property>
</properties>
</ssl>
Expand All @@ -130,33 +130,33 @@ hazelcast:
properties:
protocol: TLSv1.2
mutualAuthentication: REQUIRED
keystore: /opt/hazelcast-keystore.p12
keystorePassword: secret.123
keystoreType: PKCS12
truststore: /opt/hazelcast-truststore.p12
truststorePassword: changeit
truststoreType: PKCS12
keyStore: /opt/hazelcast-keystore.p12
keyStorePassword: secret.123
keyStoreType: PKCS12
trustStore: /opt/hazelcast-truststore.p12
trustStorePassword: changeit
trustStoreType: PKCS12
keyMaterialDuration: PT10M
----
====

The following are the descriptions of the properties:

* `keystore`: Path of your keystore file.
* `keystorePassword`: Password to access the key from your
* `keyStore`: Path of your keystore file.
* `keyStorePassword`: Password to access the key from your
keystore file.
* `keyManagerAlgorithm`: Name of the algorithm based on which
the authentication keys are provided.
* `keystoreType`: Type of the keystore. Its default value is `JKS`.
* `keyStoreType`: Type of the keystore. Its default value is `JKS`.
Another commonly used type is the `PKCS12`. Available keystore/truststore
types depend on your Operating system and the Java runtime.
* `truststore`: Path of your truststore file. The file truststore is a
* `trustStore`: Path of your truststore file. The file truststore is a
keystore file that contains a collection of certificates trusted by your
application.
* `truststorePassword`: Password to unlock the truststore file.
* `trustStorePassword`: Password to unlock the truststore file.
* `trustManagerAlgorithm`: Name of the algorithm based on which the
trust managers are provided.
* `truststoreType`: Type of the truststore. Its default value is `JKS`.
* `trustStoreType`: Type of the truststore. Its default value is `JKS`.
Another commonly used type is the `PKCS12`. Available keystore/truststore
types depend on your Operating system and the Java runtime.
* `mutualAuthentication`: Mutual authentication configuration. It's empty
Expand Down Expand Up @@ -210,14 +210,14 @@ XML::
</factory-class-name>
<properties>
<property name="protocol">TLSv1.2</property>
<property name="truststore">/opt/hazelcast-client.truststore</property>
<property name="truststorePassword">changeit</property>
<property name="truststoreType">JKS</property>
<property name="trustStore">/opt/hazelcast-client.truststore</property>
<property name="trustStorePassword">changeit</property>
<property name="trustStoreType">JKS</property>
<!-- Following properties are only needed when the mutual authentication is used. -->
<property name="keystore">/opt/hazelcast-client.keystore</property>
<property name="keystorePassword">clientsSecret</property>
<property name="keystoreType">JKS</property>
<property name="keyStore">/opt/hazelcast-client.keystore</property>
<property name="keyStorePassword">clientsSecret</property>
<property name="keyStoreType">JKS</property>
</properties>
</ssl>
</network>
Expand All @@ -238,14 +238,14 @@ hazelcast-client:
properties:
protocol: TLSv1.2
truststore: /opt/hazelcast-client.truststore
truststorePassword: changeit
truststoreType: JKS
trustStore: /opt/hazelcast-client.truststore
trustStorePassword: changeit
trustStoreType: JKS
# Following properties are only needed when the mutual authentication is used.
keystore: /opt/hazelcast-client.keystore
keystorePassword: clientsSecret
keystoreType: JKS
keyStore: /opt/hazelcast-client.keystore
keyStorePassword: clientsSecret
keyStoreType: JKS
----
====

Expand Down Expand Up @@ -288,10 +288,10 @@ Config cfg = new Config();
Properties props = new Properties();
props.setProperty("mutualAuthentication", "REQUIRED");
props.setProperty("keystore", "/opt/hazelcast.keystore");
props.setProperty("keystorePassword", "123456");
props.setProperty("truststore", "/opt/hazelcast.truststore");
props.setProperty("truststorePassword", "123456");
props.setProperty("keyStore", "/opt/hazelcast.keystore");
props.setProperty("keyStorePassword", "123456");
props.setProperty("trustStore", "/opt/hazelcast.truststore");
props.setProperty("trustStorePassword", "123456");
cfg.getNetworkConfig().setSSLConfig(new SSLConfig().setEnabled(true).setProperties(props));
Hazelcast.newHazelcastInstance(cfg);
Expand All @@ -302,8 +302,8 @@ by providing the keystore:

[source,java]
----
clientSslProps.setProperty("keystore", "/opt/client.keystore");
clientSslProps.setProperty("keystorePassword", "123456");
clientSslProps.setProperty("keyStore", "/opt/client.keystore");
clientSslProps.setProperty("keyStorePassword", "123456");
----

The property `mutualAuthentication` has the following options:
Expand All @@ -325,10 +325,10 @@ client side:
----
ClientConfig config = new ClientConfig();
Properties clientSslProps = new Properties();
clientSslProps.setProperty("keystore", "/opt/client.keystore");
clientSslProps.setProperty("keystorePassword", "123456");
clientSslProps.setProperty("truststore", "/opt/client.truststore");
clientSslProps.setProperty("truststorePassword", "123456");
clientSslProps.setProperty("keyStore", "/opt/client.keystore");
clientSslProps.setProperty("keyStorePassword", "123456");
clientSslProps.setProperty("trustStore", "/opt/client.truststore");
clientSslProps.setProperty("trustStorePassword", "123456");
config.getNetworkConfig().setSSLConfig(new SSLConfig().setEnabled(true).setProperties(clientSslProps));
HazelcastClient.newHazelcastClient(config);
Expand Down

0 comments on commit a70724d

Please sign in to comment.