#36 Use new proxy config in import scan service

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>

Author: Weltraumschaf

src/main/java/io/securecodebox/persistence/defectdojo/config/Config.java

@@ -20,6 +20,10 @@ public final class Config {
      * Default for {@link #maxPageCountForGets}
      */
     static final int DEFAULT_MAX_PAGE_COUNT_FOR_GETS = 100;
+    /**
+     * Null pattern object.
+     */
+    public static final Config NULL = new Config("", "", DEFAULT_MAX_PAGE_COUNT_FOR_GETS);
 
     /**
      * URL of the host which serves the DefectDojo API.

src/main/java/io/securecodebox/persistence/defectdojo/http/ProxyConfig.java

@@ -13,11 +13,11 @@
  */
 @Value
 @Builder
-class ProxyConfig {
+public class ProxyConfig {
     /**
      * Null pattern object.
      */
-    static final ProxyConfig NULL = ProxyConfig.builder().build();
+    public static final ProxyConfig NULL = ProxyConfig.builder().build();
     private static final String DEFAULT_STRING = "";
     private static final int DEFAULT_INT = 0;
 
@@ -62,7 +62,7 @@ class ProxyConfig {
      *
      * @return {@code true} if all values are set else {@code false}
      */
-    boolean isComplete() {
+    public boolean isComplete() {
         if (getUser().equals(DEFAULT_STRING)) {
             return false;
         }

src/main/java/io/securecodebox/persistence/defectdojo/http/ProxyConfigFactory.java

@@ -14,10 +14,10 @@
  * port numbers.
  * </p>
  */
-final class ProxyConfigFactory {
+public final class ProxyConfigFactory {
     private final SystemPropertyFinder properties = new SystemPropertyFinder();
 
-    ProxyConfig create() {
+    public ProxyConfig create() {
         final var builder = ProxyConfig.builder();
 
         if (properties.notHasProperty(ProxyConfigNames.HTTP_PROXY_USER)) {
@@ -66,7 +66,7 @@ ProxyConfig create() {
      * </p>
      */
     @Getter
-    enum ProxyConfigNames {
+    public enum ProxyConfigNames {
         /**
          * System property name for the proxy username
          */

src/main/java/io/securecodebox/persistence/defectdojo/service/DefaultImportScanService.java

@@ -7,6 +7,7 @@
 import io.securecodebox.persistence.defectdojo.ScanType;
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.exception.PersistenceException;
+import io.securecodebox.persistence.defectdojo.http.ProxyConfig;
 import io.securecodebox.persistence.defectdojo.model.ScanFile;
 import lombok.Getter;
 import lombok.NonNull;
@@ -44,22 +45,23 @@ class DefaultImportScanService implements ImportScanService {
         new FormHttpMessageConverter(),
         new ResourceHttpMessageConverter(),
         new MappingJackson2HttpMessageConverter());
-    @Deprecated
-    private final SystemPropertyFinder properties = new SystemPropertyFinder();
     @Getter
     private final String defectDojoUrl;
     @Getter
     private final String defectDojoApiKey;
+    private final ProxyConfig proxyConfig;
 
     /**
      * Dedicated constructor.
      *
-     * @param config not {@code null}
+     * @param config      not {@code null}
+     * @param proxyConfig not {@code null}
      */
-    DefaultImportScanService(final @NonNull Config config) {
+    DefaultImportScanService(final @NonNull Config config, @NonNull ProxyConfig proxyConfig) {
         super();
         this.defectDojoUrl = config.getUrl();
         this.defectDojoApiKey = config.getApiKey();
+        this.proxyConfig = proxyConfig;
     }
 
     @Override
@@ -163,8 +165,7 @@ private RestTemplate createRestTemplate() {
     }
 
     boolean shouldConfigureProxySettings() {
-        return properties.hasProperty(ProxyConfigNames.HTTP_PROXY_USER)
-            && properties.hasProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD);
+        return proxyConfig.isComplete();
     }
 
     /**
@@ -184,72 +185,22 @@ boolean shouldConfigureProxySettings() {
      * @return never {@code null}
      */
     ClientHttpRequestFactory createRequestFactoryWithProxyAuthConfig() {
-        if (properties.notHasProperty(ProxyConfigNames.HTTP_PROXY_USER)) {
-            throw new MissingProxyAuthenticationConfig(ProxyConfigNames.HTTP_PROXY_USER);
-        }
-
-        if (properties.notHasProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD)) {
-            throw new MissingProxyAuthenticationConfig(ProxyConfigNames.HTTP_PROXY_PASSWORD);
-        }
-
-        if (properties.notHasProperty(ProxyConfigNames.HTTP_PROXY_HOST)) {
-            throw new MissingProxyAuthenticationConfig(ProxyConfigNames.HTTP_PROXY_HOST);
-        }
-
-        if (properties.notHasProperty(ProxyConfigNames.HTTP_PROXY_PORT)) {
-            throw new MissingProxyAuthenticationConfig(ProxyConfigNames.HTTP_PROXY_PORT);
-        }
-
-        final var proxyHost = properties.getProperty(ProxyConfigNames.HTTP_PROXY_HOST);
-        final int proxyPort;
-        try {
-            proxyPort = Integer.parseInt(properties.getProperty(ProxyConfigNames.HTTP_PROXY_PORT));
-        } catch (final NumberFormatException e) {
-            throw new IllegalArgumentException(
-                String.format("Given port for proxy authentication configuration (property '%s') is not a valid number! Given value wa '%s'.",
-                    ProxyConfigNames.HTTP_PROXY_PORT.getLiterat(),
-                    System.getProperty("http.proxyPort")),
-                e);
-        }
-
         final var credentials = new BasicCredentialsProvider();
         credentials.setCredentials(
-            new AuthScope(proxyHost, proxyPort),
+            new AuthScope(proxyConfig.getHost(), proxyConfig.getPort()),
             new UsernamePasswordCredentials(
-                properties.getProperty(ProxyConfigNames.HTTP_PROXY_USER),
-                properties.getProperty(ProxyConfigNames.HTTP_PROXY_PASSWORD))
+                proxyConfig.getUser(),
+                proxyConfig.getPassword())
         );
 
         final var clientBuilder = HttpClientBuilder.create();
         clientBuilder.useSystemProperties();
-        clientBuilder.setProxy(new HttpHost(proxyHost, proxyPort));
+        clientBuilder.setProxy(new HttpHost(proxyConfig.getHost(), proxyConfig.getPort()));
         clientBuilder.setDefaultCredentialsProvider(credentials);
         clientBuilder.setProxyAuthenticationStrategy(new ProxyAuthenticationStrategy());
 
         final var factory = new HttpComponentsClientHttpRequestFactory();
         factory.setHttpClient(clientBuilder.build());
         return factory;
     }
-
-    @Deprecated
-    private static class SystemPropertyFinder {
-        private boolean hasProperty(@NonNull final ProxyConfigNames name) {
-            return System.getProperty(name.getLiterat()) != null;
-        }
-
-        private boolean notHasProperty(@NonNull final ProxyConfigNames name) {
-            return !hasProperty(name);
-        }
-
-        private String getProperty(@NonNull final ProxyConfigNames name) {
-            return System.getProperty(name.getLiterat());
-        }
-    }
-
-    @Deprecated
-    final static class MissingProxyAuthenticationConfig extends RuntimeException {
-        MissingProxyAuthenticationConfig(ProxyConfigNames name) {
-            super(String.format("Expected System property '%s' not set!", name.getLiterat()));
-        }
-    }
 }

src/main/java/io/securecodebox/persistence/defectdojo/service/ImportScanService.java

@@ -7,9 +7,11 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.securecodebox.persistence.defectdojo.ScanType;
 import io.securecodebox.persistence.defectdojo.config.Config;
+import io.securecodebox.persistence.defectdojo.http.ProxyConfig;
+import io.securecodebox.persistence.defectdojo.http.ProxyConfigFactory;
 import io.securecodebox.persistence.defectdojo.model.ScanFile;
 import lombok.Data;
-import lombok.Getter;
+import lombok.NonNull;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -25,7 +27,18 @@ public interface ImportScanService {
      * @return never {@code null}
      */
     static ImportScanService createDefault(final Config config) {
-        return new DefaultImportScanService(config);
+        return createDefault(config, new ProxyConfigFactory().create());
+    }
+
+    /**
+     * Factory method to create new instance of service default implementation
+     *
+     * @param config      must not be {@code null}
+     * @param proxyConfig must not be {@code null}
+     * @return never {@code null}
+     */
+    static ImportScanService createDefault(@NonNull final Config config, @NonNull final ProxyConfig proxyConfig) {
+        return new DefaultImportScanService(config, proxyConfig);
     }
 
     default ImportScanResponse importScan(ScanFile scanFile, long engagementId, long lead, String currentDate, ScanType scanType, long testType) {
@@ -51,29 +64,4 @@ class ImportScanResponse {
         @JsonProperty("test")
         protected long testId;
     }
-
-    /**
-     * These properties can be configured by passing them to the running Java process w/ flag {@literal -D}
-     * <p>
-     * Example: {@literal java -Dhttp.proxyHost=... -D... -jar ...}
-     * </p>
-     * <p>
-     * <strong>Important</strong>: All four parameters are mandatory. You must set them all
-     * or none of them!
-     * </p>
-     */
-    @Deprecated
-    enum ProxyConfigNames {
-        HTTP_PROXY_HOST("http.proxyHost"),
-        HTTP_PROXY_PORT("http.proxyPort"),
-        HTTP_PROXY_USER("http.proxyUser"),
-        HTTP_PROXY_PASSWORD("http.proxyPassword");
-
-        @Getter
-        private final String literat;
-
-        ProxyConfigNames(String literat) {
-            this.literat = literat;
-        }
-    }
 }