Skip to content

Builder now inits SSL context when protocol and trust manager exist #1523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 25, 2023
Merged

Builder now inits SSL context when protocol and trust manager exist #1523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions ...ogic-client-api/src/main/java/com/marklogic/client/impl/DatabaseClientPropertySource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

import javax.net.ssl.SSLContext;
import javax.net.ssl.X509TrustManager;
import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;
import java.util.LinkedHashMap;
import java.util.Map;
Expand Down Expand Up @@ -109,10 +110,12 @@ private DatabaseClientFactory.SecurityContext newSecurityContext() {
}
securityContext = newSecurityContext(type);

SSLContext sslContext = determineSSLContext();
X509TrustManager trustManager = determineTrustManager();
SSLContext sslContext = determineSSLContext(trustManager);
if (sslContext != null) {
securityContext.withSSLContext(sslContext, determineTrustManager());
securityContext.withSSLContext(sslContext, trustManager);
}

securityContext.withSSLHostnameVerifier(determineHostnameVerifier());
return securityContext;
}
Expand Down Expand Up @@ -180,10 +183,10 @@ private DatabaseClientFactory.SecurityContext newSAMLAuthContext() {
);
}

private SSLContext determineSSLContext() {
Object sslContext = propertySource.apply(PREFIX + "sslContext");
if (sslContext instanceof SSLContext) {
return (SSLContext) sslContext;
private SSLContext determineSSLContext(X509TrustManager trustManager) {
SSLContext sslContext = (SSLContext) propertySource.apply(PREFIX + "sslContext");
if (sslContext != null) {
return sslContext;
}
String protocol = (String) propertySource.apply(PREFIX + "sslProtocol");
if (protocol != null) {
Expand All @@ -195,13 +198,21 @@ private SSLContext determineSSLContext() {
}
}
try {
// Note that if only a protocol is specified, and not a TrustManager, an attempt will later be made
// to use the JVM's default TrustManager
return SSLContext.getInstance(protocol);
sslContext = SSLContext.getInstance(protocol);
} catch (NoSuchAlgorithmException e) {
throw new RuntimeException("Unable to get SSLContext instance with protocol: " + protocol
+ "; cause: " + e.getMessage(), e);
}
// Note that if only a protocol is specified, and not a TrustManager, an attempt will later be made
// to use the JVM's default TrustManager
if (trustManager != null) {
try {
sslContext.init(null, new X509TrustManager[]{trustManager}, null);
} catch (KeyManagementException e) {
throw new RuntimeException("Unable to initialize SSLContext; protocol: " + protocol + "; cause: " + e.getMessage(), e);
}
}
return sslContext;
}
return null;
}
Expand Down
11 changes: 11 additions & 0 deletions marklogic-client-api/src/test/java/com/marklogic/client/test/DatabaseClientBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,11 @@ void sslProtocol() {
assertNotNull(bean.getSecurityContext().getSSLContext());
assertNull(bean.getSecurityContext().getTrustManager());
assertNull(bean.getSecurityContext().getSSLHostnameVerifier());

assertThrows(IllegalStateException.class, () -> bean.getSecurityContext().getSSLContext().getSocketFactory(),
"If an SSL protocol is provided with no trust manager, the builder is expected to create an instance of " +
"SSLContext but not to initialize it. Later on - via OkHttpUtil - the Java Client will attempt to " +
"initialize the SSLContext before using it by using the JVM's default trust manager.");
}

@Test
Expand All @@ -190,6 +195,12 @@ void sslProtocolAndTrustManager() {
assertNotNull(bean.getSecurityContext().getTrustManager());
assertEquals(Common.TRUST_ALL_MANAGER, bean.getSecurityContext().getTrustManager());
assertNull(bean.getSecurityContext().getSSLHostnameVerifier());

assertNotNull(bean.getSecurityContext().getSSLContext().getSocketFactory(),
"Since a protocol was provided with a trust manager, the builder is expected to initialize the " +
"SSLContext created via the protocol using the given trust manager. This is primarily intended to " +
"support a use case of providing a custom trust manager (often a 'trust all' one in a development or " +
"test environment) without forcing the user to initialize an SSLContext themselves.");
}

@Test
Expand Down