Migrate SSL Labs integration from API v3 to v4

docs/modules/plugins/pages/plugin-web-app-to-rest-api.adoc

@@ -467,6 +467,11 @@ Then SSL rating for URL `$url` is $comparisonRule `$gradeName`
 |`https://api.ssllabs.com`
 |SSL Labs endpoint.
 
+|`ssl-labs.email`
+|`string`
+|`<empty>`
+|*Required.* The registered email address to use for SSL Labs API v4 authentication. Must be registered via the https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs-v4.md#register-for-scan-api-initiation-and-result-fetching-[SSL Labs registration API].
+
 |===
 
 .Validate SSL rating for `https://www.google.com`

vividus-plugin-web-app-to-rest-api/src/main/java/org/vividus/ssllabs/SslLabsClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,8 @@
 import java.util.List;
 import java.util.Optional;
 
+import org.apache.commons.lang3.Validate;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
 import org.apache.hc.core5.http.HttpStatus;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -37,7 +39,7 @@
     private static final String SSL_SCAN_FAILURE =
             "SSL scan has not been performed successfully during specified waiting period";
     private static final String ERROR_MESSAGE = "Status message '{}' received for host {}";
-    private static final String API_VERSION = "/api/v3";
+    private static final String API_VERSION = "/api/v4";
     private static final String ANALYZE_CALL = "/analyze?host=%s&fromCache=on&maxAge=1";
     private static final int SERVICE_IS_OVERLOADED = 529;
     private static final DurationBasedWaiter WAITER = new DurationBasedWaiter(Duration.ofMinutes(10),
@@ -46,12 +48,15 @@
     private final IHttpClient httpClient;
     private final JsonUtils jsonUtils;
     private final String sslLabHost;
+    private final String email;
 
-    public SslLabsClient(IHttpClient httpClient, JsonUtils jsonUtils, String sslLabHost)
+    public SslLabsClient(IHttpClient httpClient, JsonUtils jsonUtils, String sslLabHost, String email)
     {
         this.httpClient = httpClient;
         this.jsonUtils = jsonUtils;
         this.sslLabHost = sslLabHost;
+        this.email = Validate.notBlank(email,
+                "SSL Labs API v4 requires a registered email address. Please set the 'ssl-labs.email' property.");
     }
 
     public Optional<Grade> performSslScan(String host)
@@ -89,8 +94,10 @@
         {
             try
             {
-                HttpResponse response = httpClient.doHttpGet(URI.create(
+                HttpGet httpGet = new HttpGet(URI.create(
                         String.format("%s%s%s", sslLabHost, API_VERSION, String.format(ANALYZE_CALL, host))));
+                httpGet.addHeader("email", email);
+                HttpResponse response = httpClient.execute(httpGet);
                 return Optional.of(response);
             }
             catch (IOException e)

vividus-plugin-web-app-to-rest-api/src/main/resources/properties/defaults/default.properties

@@ -22,3 +22,4 @@ resource-checker.uri-to-ignore-regex=
 resource-checker.attributes-to-check=href,src
 
 ssl-labs.api-endpoint=https://api.ssllabs.com
+ssl-labs.email=

vividus-plugin-web-app-to-rest-api/src/main/resources/vividus-plugin/spring.xml

@@ -18,8 +18,9 @@
         <property name="uriToIgnoreRegex" value="${resource-checker.uri-to-ignore-regex}" />
     </bean>
 
     <bean id="sslLabsClient" class="org.vividus.ssllabs.SslLabsClient">
         <constructor-arg index="2" value="${ssl-labs.api-endpoint}"/>
+        <constructor-arg index="3" value="${ssl-labs.email}"/>
     </bean>
 
     <bean id="sslLabsSteps" class="org.vividus.ssllabs.SslLabsSteps" />

vividus-plugin-web-app-to-rest-api/src/test/java/org/vividus/ssllabs/SslLabsClientTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@
 import static org.hamcrest.Matchers.hasItems;
 import static org.hamcrest.Matchers.is;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.mock;
@@ -30,7 +31,6 @@
 import static org.mockito.Mockito.when;
 
 import java.io.IOException;
-import java.net.URI;
 import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.util.List;
@@ -41,6 +41,7 @@
 import com.github.valfirst.slf4jtest.TestLoggerFactory;
 import com.github.valfirst.slf4jtest.TestLoggerFactoryExtension;
 
+import org.apache.hc.core5.http.ClassicHttpRequest;
 import org.apache.hc.core5.http.HttpStatus;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -57,6 +58,7 @@
 class SslLabsClientTests
 {
     private static final String SSL_LABS_HOST = "https://api.ssllabs.com";
+    private static final String SSL_LABS_EMAIL = "test@example.com";
     private static final String ANALYZED_HOST = "www.example.com";
     private static final int SERVICE_IS_OVERLOADED = 529;
 
@@ -75,7 +77,7 @@ public void beforeEach()
         {
             duration.when(() -> Duration.ofMinutes(10)).thenReturn(Duration.ZERO);
             duration.when(() -> Duration.ofSeconds(30)).thenReturn(Duration.ZERO);
-            client = new SslLabsClient(httpClient, new JsonUtils(), SSL_LABS_HOST);
+            client = new SslLabsClient(httpClient, new JsonUtils(), SSL_LABS_HOST, SSL_LABS_EMAIL);
         }
     }
 
@@ -95,7 +97,7 @@ void shouldPerformSslScanWithIOException() throws IOException
         try (var grade = mockStatic(Grade.class))
         {
             var ioException = mock(IOException.class);
-            when(httpClient.doHttpGet(any(URI.class))).thenThrow(ioException);
+            when(httpClient.execute(any(ClassicHttpRequest.class))).thenThrow(ioException);
             assertEquals(Optional.empty(), client.performSslScan(ANALYZED_HOST));
             grade.verify(() -> Grade.fromString(anyString()), never());
             assertThat(logger.getLoggingEvents(),
@@ -119,7 +121,7 @@ void testPerformSslScanWithUnexpectedStatus(int statusCode) throws IOException
             HttpResponse httpResponse = new HttpResponse();
             httpResponse.setStatusCode(statusCode);
             httpResponse.setResponseBody(response.getBytes(StandardCharsets.UTF_8));
-            when(httpClient.doHttpGet(any(URI.class))).thenReturn(httpResponse);
+            when(httpClient.execute(any(ClassicHttpRequest.class))).thenReturn(httpResponse);
             assertEquals(Optional.empty(), client.performSslScan(ANALYZED_HOST));
             grade.verify(() -> Grade.fromString(anyString()), never());
             assertThat(logger.getLoggingEvents(), hasItems(
@@ -170,11 +172,26 @@ void shouldPerformSslScanEmptyEndpoints() throws IOException
         }
     }
 
+    @Test
+    void shouldThrowExceptionWhenEmailIsBlank()
+    {
+        try (var duration = mockStatic(Duration.class))
+        {
+            duration.when(() -> Duration.ofMinutes(10)).thenReturn(Duration.ZERO);
+            duration.when(() -> Duration.ofSeconds(30)).thenReturn(Duration.ZERO);
+            var exception = assertThrows(IllegalArgumentException.class,
+                    () -> new SslLabsClient(httpClient, new JsonUtils(), SSL_LABS_HOST, ""));
+            assertEquals(
+                    "SSL Labs API v4 requires a registered email address. Please set the 'ssl-labs.email' property.",
+                    exception.getMessage());
+        }
+    }
+
     private void mockResponse(String response) throws IOException
     {
         HttpResponse httpResponse = new HttpResponse();
         httpResponse.setStatusCode(HttpStatus.SC_OK);
         httpResponse.setResponseBody(response.getBytes(StandardCharsets.UTF_8));
-        when(httpClient.doHttpGet(any(URI.class))).thenReturn(httpResponse);
+        when(httpClient.execute(any(ClassicHttpRequest.class))).thenReturn(httpResponse);
     }
 }