Merge pull request #337 from tls-attacker/feat/independent-scanner-config

TrueSkrillor · web-flow · commit feba378afcf1 · 2023-06-14T18:08:15.000+02:00
feat: Make ScannerConfig independent from TLS-Attacker
diff --git a/Scanner-Core/src/main/java/de/rub/nds/scanner/core/config/ExecutorConfig.java b/Scanner-Core/src/main/java/de/rub/nds/scanner/core/config/ExecutorConfig.java
@@ -11,12 +11,10 @@
 import com.beust.jcommander.Parameter;
 import de.rub.nds.scanner.core.constants.ProbeType;
 import de.rub.nds.scanner.core.constants.ScannerDetail;
-import de.rub.nds.tlsattacker.core.config.TLSDelegateConfig;
-import de.rub.nds.tlsattacker.core.config.delegate.GeneralDelegate;
 import java.util.Arrays;
 import java.util.List;
 
-public abstract class ScannerConfig extends TLSDelegateConfig {
+public final class ExecutorConfig {
 
     @Parameter(
             names = "-noColor",
@@ -48,11 +46,21 @@ public abstract class ScannerConfig extends TLSDelegateConfig {
             description = "The timeout for each probe in ms (default 1800000)")
     private int probeTimeout = 1800000;
 
-    protected List<ProbeType> probes = null;
+    @Parameter(
+            names = "-parallelProbes",
+            required = false,
+            description =
+                    "Defines the number of threads responsible for different probes. If set to 1, only one specific probe can be run in time.")
+    private int parallelProbes = 1;
 
-    public ScannerConfig(GeneralDelegate delegate) {
-        super(delegate);
-    }
+    @Parameter(
+            names = "-threads",
+            required = false,
+            description =
+                    "The maximum number of threads used to execute probes located in the queue.")
+    private int overallThreads = 1;
+
+    private List<ProbeType> probes = null;
 
     public ScannerDetail getScanDetail() {
         return scanDetail;
@@ -109,4 +117,24 @@ public String getOutputFile() {
     public void setOutputFile(String outputFile) {
         this.outputFile = outputFile;
     }
+
+    public int getParallelProbes() {
+        return parallelProbes;
+    }
+
+    public void setParallelProbes(int parallelProbes) {
+        this.parallelProbes = parallelProbes;
+    }
+
+    public int getOverallThreads() {
+        return overallThreads;
+    }
+
+    public void setOverallThreads(int overallThreads) {
+        this.overallThreads = overallThreads;
+    }
+
+    public boolean isMultithreaded() {
+        return (parallelProbes > 1 || overallThreads > 1);
+    }
 }
diff --git a/Scanner-Core/src/main/java/de/rub/nds/scanner/core/execution/ThreadedScanJobExecutor.java b/Scanner-Core/src/main/java/de/rub/nds/scanner/core/execution/ThreadedScanJobExecutor.java
@@ -9,7 +9,7 @@
 package de.rub.nds.scanner.core.execution;
 
 import de.rub.nds.scanner.core.afterprobe.AfterProbe;
-import de.rub.nds.scanner.core.config.ScannerConfig;
+import de.rub.nds.scanner.core.config.ExecutorConfig;
 import de.rub.nds.scanner.core.passive.ExtractedValueContainer;
 import de.rub.nds.scanner.core.passive.TrackableValue;
 import de.rub.nds.scanner.core.probe.ScannerProbe;
@@ -34,7 +34,7 @@ public class ThreadedScanJobExecutor<Report extends ScanReport> extends ScanJobE
 
     private static final Logger LOGGER = LogManager.getLogger();
 
-    private final ScannerConfig config;
+    private final ExecutorConfig config;
 
     private final ScanJob scanJob;
 
@@ -48,7 +48,7 @@ public class ThreadedScanJobExecutor<Report extends ScanReport> extends ScanJobE
     private final Semaphore semaphore = new Semaphore(0);
 
     public ThreadedScanJobExecutor(
-            ScannerConfig config, ScanJob scanJob, int threadCount, String prefix) {
+            ExecutorConfig config, ScanJob scanJob, int threadCount, String prefix) {
         long probeTimeout = config.getProbeTimeout();
         executor =
                 new ScannerThreadPoolExecutor(
@@ -58,7 +58,7 @@ public ThreadedScanJobExecutor(
     }
 
     public ThreadedScanJobExecutor(
-            ScannerConfig config, ScanJob scanJob, ThreadPoolExecutor executor) {
+            ExecutorConfig config, ScanJob scanJob, ThreadPoolExecutor executor) {
         this.executor = executor;
         this.config = config;
         this.scanJob = scanJob;
diff --git a/TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/Main.java b/TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/Main.java
@@ -47,9 +47,10 @@ public static void main(String[] args) throws IOException {
                                 + ((System.currentTimeMillis() - time) / 1000)
                                 + "s\n"
                                 + report.getFullReport(
-                                        config.getReportDetail(), !config.isNoColor()));
-                if (config.isWriteReportToFile()) {
-                    File outputFile = new File(config.getOutputFile());
+                                        config.getExecutorConfig().getReportDetail(),
+                                        !config.getExecutorConfig().isNoColor()));
+                if (config.getExecutorConfig().isWriteReportToFile()) {
+                    File outputFile = new File(config.getExecutorConfig().getOutputFile());
                     ClientReportSerializer.serialize(outputFile, report);
                 }
             } catch (ConfigurationException e) {
diff --git a/TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/execution/TlsClientScanner.java b/TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/execution/TlsClientScanner.java
@@ -67,16 +67,16 @@ public final class TlsClientScanner extends TlsScanner {
     private boolean closeAfterFinishParallel;
 
     public TlsClientScanner(ClientScannerConfig config) {
-        super(config.getProbes());
+        super(config.getExecutorConfig().getProbes());
         this.config = config;
-        parallelExecutor = new ParallelExecutor(config.getOverallThreads(), 3);
+        parallelExecutor = new ParallelExecutor(config.getExecutorConfig().getOverallThreads(), 3);
         closeAfterFinishParallel = true;
         setCallbacks();
         fillProbeLists();
     }
 
     public TlsClientScanner(ClientScannerConfig config, ParallelExecutor parallelExecutor) {
-        super(config.getProbes());
+        super(config.getExecutorConfig().getProbes());
         this.config = config;
         this.parallelExecutor = parallelExecutor;
         closeAfterFinishParallel = false;
@@ -142,7 +142,11 @@ public ClientReport scan() {
         ClientReport clientReport = new ClientReport();
         ScanJob job = new ScanJob(probeList, afterList);
         ThreadedScanJobExecutor<ClientReport> executor =
-                new ThreadedScanJobExecutor(config, job, config.getParallelProbes(), "");
+                new ThreadedScanJobExecutor(
+                        config.getExecutorConfig(),
+                        job,
+                        config.getExecutorConfig().getParallelProbes(),
+                        "");
         long scanStartTime = System.currentTimeMillis();
         clientReport = executor.execute(clientReport);
         long scanEndTime = System.currentTimeMillis();
@@ -159,7 +163,8 @@ public ClientReport scan() {
     }
 
     private void adjustServerPort() {
-        if (config.isMultithreaded() && config.getServerDelegate().getPort() != 0) {
+        if (config.getExecutorConfig().isMultithreaded()
+                && config.getServerDelegate().getPort() != 0) {
             LOGGER.warn(
                     "Configured explicit server port, but also multithreaded execution. Ignoring explicit port.");
             config.getServerDelegate().setPort(0);
diff --git a/TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/probe/CipherSuiteProbe.java b/TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/probe/CipherSuiteProbe.java
@@ -193,7 +193,7 @@ private List<CipherSuite> getToTestCipherSuitesByVersion(ProtocolVersion version
                 Arrays.asList(CipherSuite.values()).stream()
                         .filter(suite -> suite.isRealCipherSuite())
                         .collect(Collectors.toList());
-        switch (scannerConfig.getScanDetail()) {
+        switch (scannerConfig.getExecutorConfig().getScanDetail()) {
             case QUICK:
             case NORMAL:
                 return filterPskCipherSuites(filterForVersionSupported(realCipherSuites, version));
diff --git a/TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/probe/PaddingOracleProbe.java b/TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/probe/PaddingOracleProbe.java
@@ -54,7 +54,7 @@ public class PaddingOracleProbe extends TlsClientProbe<ClientScannerConfig, Clie
     public PaddingOracleProbe(
             ParallelExecutor parallelExecutor, ClientScannerConfig scannerConfig) {
         super(parallelExecutor, TlsProbeType.PADDING_ORACLE, scannerConfig);
-        this.scanDetail = scannerConfig.getScanDetail();
+        this.scanDetail = scannerConfig.getExecutorConfig().getScanDetail();
         this.numberOfIterations =
                 scanDetail.isGreaterEqualTo(ScannerDetail.NORMAL)
                         ? NUMBER_OF_ITERATIONS
diff --git a/TLS-Scanner-Core/src/main/java/de/rub/nds/tlsscanner/core/config/TlsScannerConfig.java b/TLS-Scanner-Core/src/main/java/de/rub/nds/tlsscanner/core/config/TlsScannerConfig.java
@@ -10,46 +10,36 @@
 
 import com.beust.jcommander.Parameter;
 import com.beust.jcommander.ParametersDelegate;
-import de.rub.nds.scanner.core.config.ScannerConfig;
+import de.rub.nds.scanner.core.config.ExecutorConfig;
+import de.rub.nds.tlsattacker.core.config.TLSDelegateConfig;
 import de.rub.nds.tlsattacker.core.config.delegate.GeneralDelegate;
 import de.rub.nds.tlsattacker.core.config.delegate.StarttlsDelegate;
 import de.rub.nds.tlsscanner.core.config.delegate.CallbackDelegate;
 import de.rub.nds.tlsscanner.core.config.delegate.DtlsDelegate;
 
-public class TlsScannerConfig extends ScannerConfig {
+public class TlsScannerConfig extends TLSDelegateConfig {
 
     @Parameter(
             names = "-timeout",
             required = false,
             description = "The timeout used for the scans in ms (default 1000)")
     private int timeout = 1000;
 
-    @Parameter(
-            names = "-parallelProbes",
-            required = false,
-            description =
-                    "Defines the number of threads responsible for different TLS probes. If set to 1, only one specific TLS probe (e.g., TLS version scan) can be run in time.")
-    private int parallelProbes = 1;
-
-    @Parameter(
-            names = "-threads",
-            required = false,
-            description =
-                    "The maximum number of threads used to execute TLS probes located in the scanning queue. This is also the maximum number of threads communicating with the analyzed peer.")
-    private int overallThreads = 1;
-
     @ParametersDelegate private DtlsDelegate dtlsDelegate;
 
     @ParametersDelegate private StarttlsDelegate startTlsDelegate;
 
     @ParametersDelegate private CallbackDelegate callbackDelegate;
 
+    @ParametersDelegate private ExecutorConfig executorConfig;
+
     public TlsScannerConfig(GeneralDelegate delegate) {
         super(delegate);
 
         this.dtlsDelegate = new DtlsDelegate();
         this.startTlsDelegate = new StarttlsDelegate();
         this.callbackDelegate = new CallbackDelegate();
+        this.executorConfig = new ExecutorConfig();
 
         addDelegate(dtlsDelegate);
         addDelegate(startTlsDelegate);
@@ -68,31 +58,15 @@ public CallbackDelegate getCallbackDelegate() {
         return callbackDelegate;
     }
 
-    public int getTimeout() {
-        return timeout;
+    public ExecutorConfig getExecutorConfig() {
+        return executorConfig;
     }
 
-    public int getParallelProbes() {
-        return parallelProbes;
-    }
-
-    public int getOverallThreads() {
-        return overallThreads;
-    }
-
-    public boolean isMultithreaded() {
-        return (parallelProbes > 1 || overallThreads > 1);
+    public int getTimeout() {
+        return timeout;
     }
 
     public void setTimeout(int timeout) {
         this.timeout = timeout;
     }
-
-    public void setParallelProbes(int parallelProbes) {
-        this.parallelProbes = parallelProbes;
-    }
-
-    public void setOverallThreads(int overallThreads) {
-        this.overallThreads = overallThreads;
-    }
 }
diff --git a/TLS-Scanner-Core/src/test/java/de/rub/nds/tlsscanner/core/probe/requirements/TestProbeAlpn.java b/TLS-Scanner-Core/src/test/java/de/rub/nds/tlsscanner/core/probe/requirements/TestProbeAlpn.java
@@ -1,7 +1,7 @@
 /*
  * TLS-Scanner - A TLS configuration and analysis tool based on TLS-Attacker
  *
- * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, and Hackmanit GmbH
+ * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, Technology Innovation Institute, and Hackmanit GmbH
  *
  * Licensed under Apache License, Version 2.0
  * http://www.apache.org/licenses/LICENSE-2.0.txt
diff --git a/TLS-Scanner-Core/src/test/java/de/rub/nds/tlsscanner/core/probe/requirements/TestProbeBasic.java b/TLS-Scanner-Core/src/test/java/de/rub/nds/tlsscanner/core/probe/requirements/TestProbeBasic.java
@@ -1,7 +1,7 @@
 /*
  * TLS-Scanner - A TLS configuration and analysis tool based on TLS-Attacker
  *
- * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, and Hackmanit GmbH
+ * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, Technology Innovation Institute, and Hackmanit GmbH
  *
  * Licensed under Apache License, Version 2.0
  * http://www.apache.org/licenses/LICENSE-2.0.txt
diff --git a/TLS-Scanner-Core/src/test/java/de/rub/nds/tlsscanner/core/probe/requirements/TestProbeCca.java b/TLS-Scanner-Core/src/test/java/de/rub/nds/tlsscanner/core/probe/requirements/TestProbeCca.java
@@ -1,7 +1,7 @@
 /*
  * TLS-Scanner - A TLS configuration and analysis tool based on TLS-Attacker
  *
- * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, and Hackmanit GmbH
+ * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, Technology Innovation Institute, and Hackmanit GmbH
  *
  * Licensed under Apache License, Version 2.0
  * http://www.apache.org/licenses/LICENSE-2.0.txt
diff --git a/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/Main.java b/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/Main.java
@@ -47,9 +47,10 @@ public static void main(String[] args) throws IOException {
                                 + ((System.currentTimeMillis() - time) / 1000)
                                 + "s\n"
                                 + report.getFullReport(
-                                        config.getReportDetail(), !config.isNoColor()));
-                if (config.isWriteReportToFile()) {
-                    File outputFile = new File(config.getOutputFile());
+                                        config.getExecutorConfig().getReportDetail(),
+                                        !config.getExecutorConfig().isNoColor()));
+                if (config.getExecutorConfig().isWriteReportToFile()) {
+                    File outputFile = new File(config.getExecutorConfig().getOutputFile());
                     ServerReportSerializer.serialize(outputFile, report);
                 }
             } catch (ConfigurationException e) {
diff --git a/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/execution/TlsServerScanner.java b/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/execution/TlsServerScanner.java
@@ -118,12 +118,12 @@ public final class TlsServerScanner extends TlsScanner {
     private boolean closeAfterFinishParallel;
 
     public TlsServerScanner(ServerScannerConfig config) {
-        super(config.getProbes());
+        super(config.getExecutorConfig().getProbes());
         this.config = config;
         closeAfterFinishParallel = true;
         parallelExecutor =
                 new ParallelExecutor(
-                        config.getOverallThreads(),
+                        config.getExecutorConfig().getOverallThreads(),
                         3,
                         new NamedThreadFactory(config.getClientDelegate().getHost() + "-Worker"));
         this.configSelector = new ConfigSelector(config, parallelExecutor);
@@ -132,7 +132,7 @@ public TlsServerScanner(ServerScannerConfig config) {
     }
 
     public TlsServerScanner(ServerScannerConfig config, ParallelExecutor parallelExecutor) {
-        super(config.getProbes());
+        super(config.getExecutorConfig().getProbes());
         this.config = config;
         this.configSelector = new ConfigSelector(config, parallelExecutor);
         this.parallelExecutor = parallelExecutor;
@@ -307,9 +307,9 @@ public ServerReport scan() {
                     ScanJob job = new ScanJob(probeList, afterList);
                     executor =
                             new ThreadedScanJobExecutor<>(
-                                    config,
+                                    config.getExecutorConfig(),
                                     job,
-                                    config.getParallelProbes(),
+                                    config.getExecutorConfig().getParallelProbes(),
                                     config.getClientDelegate().getHost());
                     long scanStartTime = System.currentTimeMillis();
                     serverReport = executor.execute(serverReport);
diff --git a/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/BleichenbacherProbe.java b/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/BleichenbacherProbe.java
@@ -52,7 +52,7 @@ public class BleichenbacherProbe extends TlsServerProbe<ConfigSelector, ServerRe
 
     public BleichenbacherProbe(ConfigSelector configSelector, ParallelExecutor parallelExecutor) {
         super(parallelExecutor, TlsProbeType.BLEICHENBACHER, configSelector);
-        scanDetail = configSelector.getScannerConfig().getScanDetail();
+        scanDetail = configSelector.getScannerConfig().getExecutorConfig().getScanDetail();
         numberOfIterations =
                 scanDetail.isGreaterEqualTo(ScannerDetail.NORMAL)
                         ? NUMBER_OF_ITERATIONS
diff --git a/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/CcaProbe.java b/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/CcaProbe.java
@@ -225,6 +225,7 @@ private List<VersionSuiteListPair> getNonDetailedVersionSuitePairList(
         List<VersionSuiteListPair> versionSuiteListPairList = new LinkedList<>();
         if (configSelector
                 .getScannerConfig()
+                .getExecutorConfig()
                 .getScanDetail()
                 .isGreaterEqualTo(ScannerDetail.DETAILED)) {
             for (VersionSuiteListPair versionSuiteListPair : versionSuiteListPairs) {
diff --git a/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/HandshakeSimulationProbe.java b/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/HandshakeSimulationProbe.java
@@ -58,6 +58,7 @@ public HandshakeSimulationProbe(
                                 RESOURCE_FOLDER + "/" + configFileName);
                 if (configSelector
                         .getScannerConfig()
+                        .getExecutorConfig()
                         .getScanDetail()
                         .isGreaterEqualTo(ScannerDetail.DETAILED)) {
                     simulationRequestList.add(new SimulationRequest(tlsClientConfig));
@@ -80,7 +81,9 @@ public void executeTest() {
         List<State> clientStateList = new LinkedList<>();
         simulatedClientList = new LinkedList<>();
         for (SimulationRequest request : simulationRequestList) {
-            State state = request.getExecutableState(configSelector.getScannerConfig());
+            State state =
+                    request.getExecutableState(
+                            configSelector.getScannerConfig().getExecutorConfig());
             clientStateList.add(state);
         }
         executeState(clientStateList);
diff --git a/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/InvalidCurveProbe.java b/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/InvalidCurveProbe.java
@@ -83,7 +83,7 @@ public class InvalidCurveProbe extends TlsServerProbe<ConfigSelector, ServerRepo
 
     public InvalidCurveProbe(ConfigSelector configSelector, ParallelExecutor parallelExecutor) {
         super(parallelExecutor, TlsProbeType.INVALID_CURVE, configSelector);
-        scanDetail = configSelector.getScannerConfig().getScanDetail();
+        scanDetail = configSelector.getScannerConfig().getExecutorConfig().getScanDetail();
         register(
                 TlsAnalyzedProperty.VULNERABLE_TO_INVALID_CURVE,
                 TlsAnalyzedProperty.VULNERABLE_TO_INVALID_CURVE_EPHEMERAL,
diff --git a/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/PaddingOracleProbe.java b/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/PaddingOracleProbe.java
@@ -52,7 +52,7 @@ public class PaddingOracleProbe extends TlsServerProbe<ConfigSelector, ServerRep
 
     public PaddingOracleProbe(ConfigSelector configSelector, ParallelExecutor parallelExecutor) {
         super(parallelExecutor, TlsProbeType.PADDING_ORACLE, configSelector);
-        scanDetail = configSelector.getScannerConfig().getScanDetail();
+        scanDetail = configSelector.getScannerConfig().getExecutorConfig().getScanDetail();
         numberOfIterations =
                 scanDetail.isGreaterEqualTo(ScannerDetail.NORMAL)
                         ? NUMBER_OF_ITERATIONS
diff --git a/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/handshakesimulation/SimulationRequest.java b/TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/handshakesimulation/SimulationRequest.java

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`/*`
`2`	`2`	`* TLS-Scanner - A TLS configuration and analysis tool based on TLS-Attacker`
`3`	`3`	`*`
`4`		`- * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, and Hackmanit GmbH`
	`4`	`+ * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, Technology Innovation Institute, and Hackmanit GmbH`
`5`	`5`	`*`
`6`	`6`	`* Licensed under Apache License, Version 2.0`
`7`	`7`	`* http://www.apache.org/licenses/LICENSE-2.0.txt`