Merge pull request #1611 from marklogic/feature/ssl-test-renaming

Renamed some things in SSL tests to improve clarity

Author: rjrudin

marklogic-client-api/src/test/java/com/marklogic/client/test/junit5/RequireSSLExtension.java

@@ -61,9 +61,10 @@ public void afterAll(ExtensionContext context) {
 
 	/**
 	 * @return a trust manager that accepts the public certificate associated with the certificate template created
-	 * by this class.
+	 * by this class. "secure" is meant to imply that this provides some level of security by only accepting the
+	 * one issuer, as opposed to a "trust everything" approach.
 	 */
-	public static X509TrustManager newTrustManager() {
+	public static X509TrustManager newSecureTrustManager() {
 		return new X509TrustManager() {
 			@Override
 			public void checkClientTrusted(X509Certificate[] chain, String authType) {

marklogic-client-api/src/test/java/com/marklogic/client/test/ssl/CheckSSLConnectionTest.java renamed to marklogic-client-api/src/test/java/com/marklogic/client/test/ssl/OneWaySSLTest.java

@@ -13,13 +13,16 @@
 import javax.net.ssl.SSLException;
 import javax.net.ssl.TrustManager;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertNull;
-import static org.junit.jupiter.api.Assertions.assertThrows;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
+import static org.junit.jupiter.api.Assertions.*;
+
+/**
+ * Verifies scenarios for "one-way SSL" - i.e. the MarkLogic app server is configured with a certificate template to
+ * require an SSL connection, but the client only needs to trust the server - the client does not present its own
+ * certificate. See TwoWaySSLTest for scenarios where the client presents its own certificate which the server must
+ * trust.
+ */
 @ExtendWith(RequireSSLExtension.class)
-class CheckSSLConnectionTest {
+class OneWaySSLTest {
 
 	/**
 	 * Simple check for ensuring that an SSL connection can be made when the app server requires SSL to be used. This
@@ -59,14 +62,14 @@ void trustAllManager() throws Exception {
 	 * with the certificate template created via RequireSSLExtension.
 	 */
 	@Test
-	void customTrustManager() {
+	void trustManagerThatOnlyTrustsTheCertificateFromTheCertificateTemplate() {
 		if (Common.USE_REVERSE_PROXY_SERVER) {
 			return;
 		}
 
 		DatabaseClient client = Common.newClientBuilder()
 			.withSSLProtocol("TLSv1.2")
-			.withTrustManager(RequireSSLExtension.newTrustManager())
+			.withTrustManager(RequireSSLExtension.newSecureTrustManager())
 			.withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier.ANY)
 			.build();
 

marklogic-client-api/src/test/java/com/marklogic/client/test/ssl/TwoWaySSLTest.java

@@ -105,7 +105,7 @@ void digestAuthentication() throws Exception {
 		DatabaseClient clientWithCert = Common.newClientBuilder()
 			.withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier.ANY)
 			.withSSLContext(createSSLContextWithClientCertificate(keyStoreFile))
-			.withTrustManager(RequireSSLExtension.newTrustManager())
+			.withTrustManager(RequireSSLExtension.newSecureTrustManager())
 			.build();
 
 		verifyTestDocumentCanBeRead(clientWithCert);
@@ -114,7 +114,7 @@ void digestAuthentication() throws Exception {
 		DatabaseClient clientWithoutCert = Common.newClientBuilder()
 			.withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier.ANY)
 			.withSSLProtocol("TLSv1.2")
-			.withTrustManager(RequireSSLExtension.newTrustManager())
+			.withTrustManager(RequireSSLExtension.newSecureTrustManager())
 			.build();
 
 		// The type of SSL failure varies across Java versions, so not asserting on a particular error message.
@@ -142,7 +142,7 @@ void certificateAuthenticationWithSSLContext() throws Exception {
 		try {
 			SSLContext sslContext = createSSLContextWithClientCertificate(keyStoreFile);
 			DatabaseClient client = Common.newClientBuilder()
-				.withCertificateAuth(sslContext, RequireSSLExtension.newTrustManager())
+				.withCertificateAuth(sslContext, RequireSSLExtension.newSecureTrustManager())
 				.withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier.ANY)
 				.build();
 
@@ -166,7 +166,7 @@ void certificateAuthenticationWithCertificateFileAndPassword() {
 		try {
 			DatabaseClient client = Common.newClientBuilder()
 				.withCertificateAuth(p12File.getAbsolutePath(), KEYSTORE_PASSWORD)
-				.withTrustManager(RequireSSLExtension.newTrustManager())
+				.withTrustManager(RequireSSLExtension.newSecureTrustManager())
 				.withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier.ANY)
 				.build();
 
@@ -200,7 +200,7 @@ private SSLContext createSSLContextWithClientCertificate(File keystoreFile) thro
 		SSLContext sslContext = SSLContext.getInstance("TLSv1.2");
 		sslContext.init(
 			keyManagerFactory.getKeyManagers(),
-			new X509TrustManager[]{RequireSSLExtension.newTrustManager()},
+			new X509TrustManager[]{RequireSSLExtension.newSecureTrustManager()},
 			null);
 		return sslContext;
 	}