Merge pull request #196 from tls-attacker/TestResultS_new

new testresults

Author: ic0ns

Scanner-Core/src/main/java/de/rub/nds/scanner/core/constants/TestResult.java

@@ -9,20 +9,6 @@
 
 package de.rub.nds.scanner.core.constants;
 
-public enum TestResult {
-    TRUE,
-    FALSE,
-    PARTIALLY,
-    CANNOT_BE_TESTED,
-    COULD_NOT_TEST,
-    ERROR_DURING_TEST,
-    UNCERTAIN,
-    UNSUPPORTED,
-    NOT_TESTED_YET,
-    TIMEOUT;
-
-    public static TestResult of(boolean value) {
-        return value ? TRUE : FALSE;
-    }
-
-}
+public interface TestResult {
+    public abstract String name();
+}

Scanner-Core/src/main/java/de/rub/nds/scanner/core/constants/TestResults.java

@@ -0,0 +1,36 @@
+/**
+ * Scanner-Core - A TLS configuration and analysis tool based on TLS-Attacker
+ *
+ * Copyright 2017-2022 Ruhr University Bochum, Paderborn University, Hackmanit GmbH
+ *
+ * Licensed under Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0.txt
+ */
+
+package de.rub.nds.scanner.core.constants;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
+@XmlRootElement(name = "result")
+@XmlAccessorType(XmlAccessType.FIELD)
+public enum TestResults implements TestResult {
+    TRUE,
+    FALSE,
+    PARTIALLY,
+    CANNOT_BE_TESTED,
+    COULD_NOT_TEST,
+    ERROR_DURING_TEST,
+    UNCERTAIN,
+    UNSUPPORTED,
+    NOT_TESTED_YET,
+    TIMEOUT;
+
+    private TestResults() {
+    }
+
+    public static TestResults of(boolean value) {
+        return value ? TRUE : FALSE;
+    }
+}

Scanner-Core/src/main/java/de/rub/nds/scanner/core/report/ScanReport.java

@@ -13,6 +13,7 @@
 import de.rub.nds.scanner.core.constants.ProbeType;
 import de.rub.nds.scanner.core.constants.ScannerDetail;
 import de.rub.nds.scanner.core.constants.TestResult;
+import de.rub.nds.scanner.core.constants.TestResults;
 import de.rub.nds.scanner.core.passive.ExtractedValueContainer;
 import de.rub.nds.scanner.core.passive.TrackableValue;
 import java.io.Serializable;
@@ -71,7 +72,7 @@ public synchronized TestResult getResult(AnalyzedProperty property) {
 
     public synchronized TestResult getResult(String property) {
         TestResult result = resultMap.get(property);
-        return (result == null) ? TestResult.NOT_TESTED_YET : result;
+        return (result == null) ? TestResults.NOT_TESTED_YET : result;
     }
 
     public synchronized void removeResult(AnalyzedProperty property) {
@@ -83,8 +84,8 @@ public synchronized void putResult(AnalyzedProperty property, TestResult result)
     }
 
     public synchronized void putResult(AnalyzedProperty property, Boolean result) {
-        this.putResult(property, Objects.equals(result, Boolean.TRUE) ? TestResult.TRUE
-            : Objects.equals(result, Boolean.FALSE) ? TestResult.FALSE : TestResult.UNCERTAIN);
+        this.putResult(property, Objects.equals(result, Boolean.TRUE) ? TestResults.TRUE
+            : Objects.equals(result, Boolean.FALSE) ? TestResults.FALSE : TestResults.UNCERTAIN);
     }
 
     public synchronized void markAsChangedAndNotify() {

Scanner-Core/src/main/java/de/rub/nds/scanner/core/report/rating/PropertyResultRatingInfluencer.java

@@ -11,9 +11,11 @@
 
 import de.rub.nds.scanner.core.constants.AnalyzedProperty;
 import de.rub.nds.scanner.core.constants.TestResult;
+import de.rub.nds.scanner.core.constants.TestResults;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlAnyElement;
+import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 import javax.xml.bind.annotation.XmlType;
 
@@ -22,6 +24,7 @@
 @XmlType(propOrder = { "result", "influence", "scoreCap", "referencedProperty", "referencedPropertyResult" })
 public class PropertyResultRatingInfluencer implements Comparable<PropertyResultRatingInfluencer> {
 
+    @XmlElement(type = TestResults.class, name = "result")
     private TestResult result;
 
     private Integer influence;
@@ -31,6 +34,7 @@ public class PropertyResultRatingInfluencer implements Comparable<PropertyResult
     @XmlAnyElement(lax = true)
     private AnalyzedProperty referencedProperty;
 
+    @XmlElement(type = TestResults.class, name = "referencedPropertyResult")
     private TestResult referencedPropertyResult;
 
     public PropertyResultRatingInfluencer() {

Scanner-Core/src/main/java/de/rub/nds/scanner/core/report/rating/PropertyResultRecommendation.java

@@ -10,14 +10,19 @@
 package de.rub.nds.scanner.core.report.rating;
 
 import de.rub.nds.scanner.core.constants.TestResult;
+import de.rub.nds.scanner.core.constants.TestResults;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlType;
+import javax.xml.bind.annotation.XmlAnyElement;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlSeeAlso;
 
-@XmlType(propOrder = { "result", "shortDescription", "handlingRecommendation", "detailedDescription" })
+@XmlRootElement
+@XmlSeeAlso({ TestResults.class })
 @XmlAccessorType(XmlAccessType.FIELD)
 public class PropertyResultRecommendation {
 
+    @XmlAnyElement(lax = true)
     private TestResult result;
 
     private String shortDescription;

Scanner-Core/src/main/java/de/rub/nds/scanner/core/report/rating/RatingInfluencers.java

@@ -18,7 +18,7 @@
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
-@XmlRootElement
+@XmlRootElement(name = "ratingInfluencers")
 @XmlAccessorType(XmlAccessType.FIELD)
 public class RatingInfluencers implements Serializable {
 

Scanner-Core/src/main/java/de/rub/nds/scanner/core/report/rating/Recommendation.java

@@ -17,8 +17,10 @@
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlAnyElement;
+import javax.xml.bind.annotation.XmlRootElement;
 import javax.xml.bind.annotation.XmlType;
 
+@XmlRootElement
 @XmlType(propOrder = { "analyzedProperty", "shortName", "shortDescription", "detailedDescription", "testDocumentation",
     "links", "propertyRecommendations" })
 @XmlAccessorType(XmlAccessType.FIELD)

TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/probe/ClientRecordFragmentationProbe.java

@@ -10,7 +10,7 @@
 package de.rub.nds.tlsscanner.clientscanner.probe;
 
 import de.rub.nds.scanner.core.constants.TestResult;
-import de.rub.nds.tlsscanner.core.probe.TlsProbe;
+import de.rub.nds.scanner.core.constants.TestResults;
 import de.rub.nds.tlsattacker.core.config.Config;
 import de.rub.nds.tlsattacker.core.constants.RunningModeType;
 import de.rub.nds.tlsattacker.core.protocol.message.FinishedMessage;
@@ -20,11 +20,11 @@
 import de.rub.nds.tlsattacker.core.workflow.action.ReceiveTillAction;
 import de.rub.nds.tlsattacker.core.workflow.factory.WorkflowConfigurationFactory;
 import de.rub.nds.tlsattacker.core.workflow.factory.WorkflowTraceType;
-import de.rub.nds.tlsscanner.core.constants.TlsProbeType;
-import de.rub.nds.tlsscanner.clientscanner.report.ClientReport;
 import de.rub.nds.tlsscanner.clientscanner.config.ClientScannerConfig;
-
 import de.rub.nds.tlsscanner.clientscanner.probe.result.ClientRecordFragmentationResult;
+import de.rub.nds.tlsscanner.clientscanner.report.ClientReport;
+import de.rub.nds.tlsscanner.core.constants.TlsProbeType;
+import de.rub.nds.tlsscanner.core.probe.TlsProbe;
 
 public class ClientRecordFragmentationProbe
     extends TlsProbe<ClientScannerConfig, ClientReport, ClientRecordFragmentationResult> {
@@ -47,9 +47,9 @@ public ClientRecordFragmentationResult executeTest() {
 
         TestResult result;
         if (state.getWorkflowTrace().executedAsPlanned()) {
-            result = TestResult.TRUE;
+            result = TestResults.TRUE;
         } else {
-            result = TestResult.FALSE;
+            result = TestResults.FALSE;
         }
 
         return new ClientRecordFragmentationResult(result);
@@ -62,7 +62,7 @@ public boolean canBeExecuted(ClientReport report) {
 
     @Override
     public ClientRecordFragmentationResult getCouldNotExecuteResult() {
-        return new ClientRecordFragmentationResult(TestResult.COULD_NOT_TEST);
+        return new ClientRecordFragmentationResult(TestResults.COULD_NOT_TEST);
     }
 
     @Override

TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/probe/DheParameterProbe.java

@@ -9,7 +9,7 @@
 
 package de.rub.nds.tlsscanner.clientscanner.probe;
 
-import de.rub.nds.scanner.core.constants.TestResult;
+import de.rub.nds.scanner.core.constants.TestResults;
 import de.rub.nds.tlsattacker.core.config.Config;
 import de.rub.nds.tlsattacker.core.constants.AlgorithmResolver;
 import de.rub.nds.tlsattacker.core.constants.CipherSuite;
@@ -21,8 +21,6 @@
 import de.rub.nds.tlsattacker.core.workflow.factory.WorkflowTraceType;
 import de.rub.nds.tlsscanner.clientscanner.config.ClientScannerConfig;
 import de.rub.nds.tlsscanner.clientscanner.constants.CompositeModulusType;
-import static de.rub.nds.tlsscanner.clientscanner.constants.CompositeModulusType.EVEN;
-import static de.rub.nds.tlsscanner.clientscanner.constants.CompositeModulusType.MOD3;
 import de.rub.nds.tlsscanner.clientscanner.constants.SmallSubgroupType;
 import de.rub.nds.tlsscanner.clientscanner.probe.result.DheParameterResult;
 import de.rub.nds.tlsscanner.clientscanner.probe.result.dhe.CompositeModulusResult;
@@ -121,9 +119,9 @@ private List<CompositeModulusResult> createCompositeModulusResultList() {
             State state = new State(config, trace);
             executeState(state);
             if (trace.executedAsPlanned()) {
-                compositeModulusResultList.add(new CompositeModulusResult(TestResult.TRUE, compositeType));
+                compositeModulusResultList.add(new CompositeModulusResult(TestResults.TRUE, compositeType));
             } else {
-                compositeModulusResultList.add(new CompositeModulusResult(TestResult.FALSE, compositeType));
+                compositeModulusResultList.add(new CompositeModulusResult(TestResults.FALSE, compositeType));
                 // TODO add different results based on partial failure
             }
         }
@@ -177,9 +175,9 @@ private List<SmallSubgroupResult> createSmallSubgroupResultList() {
             State state = new State(config, trace);
             executeState(state);
             if (trace.executedAsPlanned()) {
-                smallSubgroupResultList.add(new SmallSubgroupResult(TestResult.TRUE, smallSubgroupType));
+                smallSubgroupResultList.add(new SmallSubgroupResult(TestResults.TRUE, smallSubgroupType));
             } else {
-                smallSubgroupResultList.add(new SmallSubgroupResult(TestResult.FALSE, smallSubgroupType));
+                smallSubgroupResultList.add(new SmallSubgroupResult(TestResults.FALSE, smallSubgroupType));
                 // TODO add different results based on partial failure
             }
         }
@@ -188,18 +186,18 @@ private List<SmallSubgroupResult> createSmallSubgroupResultList() {
 
     @Override
     public boolean canBeExecuted(ClientReport report) {
-        return report.getResult(TlsAnalyzedProperty.SUPPORTS_DHE) == TestResult.TRUE;
+        return report.getResult(TlsAnalyzedProperty.SUPPORTS_DHE) == TestResults.TRUE;
     }
 
     @Override
     public DheParameterResult getCouldNotExecuteResult() {
         List<SmallSubgroupResult> subgroupResultList = new LinkedList<>();
         for (SmallSubgroupType type : SmallSubgroupType.values()) {
-            subgroupResultList.add(new SmallSubgroupResult(TestResult.CANNOT_BE_TESTED, type));
+            subgroupResultList.add(new SmallSubgroupResult(TestResults.CANNOT_BE_TESTED, type));
         }
         List<CompositeModulusResult> compositeResultList = new LinkedList<>();
         for (CompositeModulusType type : CompositeModulusType.values()) {
-            compositeResultList.add(new CompositeModulusResult(TestResult.CANNOT_BE_TESTED, type));
+            compositeResultList.add(new CompositeModulusResult(TestResults.CANNOT_BE_TESTED, type));
         }
         return new DheParameterResult(null, subgroupResultList, compositeResultList);
     }

TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/probe/ForcedCompressionProbe.java

@@ -10,6 +10,7 @@
 package de.rub.nds.tlsscanner.clientscanner.probe;
 
 import de.rub.nds.scanner.core.constants.TestResult;
+import de.rub.nds.scanner.core.constants.TestResults;
 import de.rub.nds.tlsattacker.core.config.Config;
 import de.rub.nds.tlsattacker.core.constants.CompressionMethod;
 import de.rub.nds.tlsattacker.core.constants.RunningModeType;
@@ -45,9 +46,9 @@ public ForcedCompressionResult executeTest() {
         executeState(state);
         TestResult result;
         if (state.getWorkflowTrace().executedAsPlanned()) {
-            result = TestResult.TRUE;
+            result = TestResults.TRUE;
         } else {
-            result = TestResult.FALSE;
+            result = TestResults.FALSE;
         }
         return new ForcedCompressionResult(result);
     }
@@ -59,7 +60,7 @@ public boolean canBeExecuted(ClientReport report) {
 
     @Override
     public ForcedCompressionResult getCouldNotExecuteResult() {
-        return new ForcedCompressionResult(TestResult.COULD_NOT_TEST);
+        return new ForcedCompressionResult(TestResults.COULD_NOT_TEST);
     }
 
     @Override