Fixes JSON Serialization Issues (#448)

* fixed json serialization issue

* updated bom version

* fixed api changes from bom update

* removed duplicate json serialization

* removed duplicate json serialization and fixed duplicate method

Author: ic0ns

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

@@ -17,8 +17,6 @@
 import de.rub.nds.tlsscanner.clientscanner.execution.TlsClientScanner;
 import de.rub.nds.tlsscanner.clientscanner.report.ClientContainerReportCreator;
 import de.rub.nds.tlsscanner.clientscanner.report.ClientReport;
-import de.rub.nds.tlsscanner.clientscanner.report.ClientReportSerializer;
-import java.io.File;
 import java.io.IOException;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -54,10 +52,6 @@ public static void main(String[] args) throws IOException {
                                 + ((System.currentTimeMillis() - time) / 1000)
                                 + "s\n"
                                 + builder);
-                if (config.getExecutorConfig().isWriteReportToFile()) {
-                    File outputFile = new File(config.getExecutorConfig().getOutputFile());
-                    ClientReportSerializer.serialize(outputFile, report);
-                }
             } catch (ConfigurationException e) {
                 LOGGER.error("Encountered a ConfigurationException aborting.", e);
             }

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

@@ -108,8 +108,8 @@ private TestResult supportsFragmentationAfterCookieExchange(
         SendAction action = new SendAction(new CertificateMessage());
         action.setConfiguredDtlsHandshakeMessageFragments(
                 List.of(
-                        new DtlsHandshakeMessageFragment(config, 20),
-                        new DtlsHandshakeMessageFragment(config, 20)));
+                        new DtlsHandshakeMessageFragment(20),
+                        new DtlsHandshakeMessageFragment(20)));
         trace.addTlsAction(action);
         trace.addTlsAction(new SendAction(new CertificateMessage()));
         trace.addTlsAction(new SendDynamicServerKeyExchangeAction());
@@ -144,8 +144,8 @@ private TestResult supportsFragmentationWithExtension(boolean individualTranspor
         SendAction action = new SendAction(new CertificateMessage());
         action.setConfiguredDtlsHandshakeMessageFragments(
                 List.of(
-                        new DtlsHandshakeMessageFragment(config, 20),
-                        new DtlsHandshakeMessageFragment(config, 20)));
+                        new DtlsHandshakeMessageFragment(20),
+                        new DtlsHandshakeMessageFragment(20)));
         trace.addTlsAction(action);
         trace.addTlsAction(new SendAction(new CertificateMessage()));
         trace.addTlsAction(new SendDynamicServerKeyExchangeAction());

TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/report/ClientReport.java

@@ -14,13 +14,21 @@
 import com.fasterxml.jackson.datatype.joda.JodaModule;
 import de.rub.nds.scanner.core.probe.result.ListResult;
 import de.rub.nds.scanner.core.probe.result.SetResult;
-import de.rub.nds.tlsattacker.core.constants.*;
+import de.rub.nds.tlsattacker.core.constants.CipherSuite;
+import de.rub.nds.tlsattacker.core.constants.CompressionMethod;
+import de.rub.nds.tlsattacker.core.constants.ECPointFormat;
+import de.rub.nds.tlsattacker.core.constants.ExtensionType;
+import de.rub.nds.tlsattacker.core.constants.NamedGroup;
+import de.rub.nds.tlsattacker.core.constants.SignatureAndHashAlgorithm;
 import de.rub.nds.tlsscanner.core.constants.TlsAnalyzedProperty;
-import de.rub.nds.tlsscanner.core.converter.*;
+import de.rub.nds.tlsscanner.core.converter.PointSerializer;
+import de.rub.nds.tlsscanner.core.converter.ResponseFingerprintSerializer;
+import de.rub.nds.tlsscanner.core.converter.VectorSerializer;
 import de.rub.nds.tlsscanner.core.report.TlsScanReport;
 import jakarta.xml.bind.annotation.XmlAccessType;
 import jakarta.xml.bind.annotation.XmlAccessorType;
 import jakarta.xml.bind.annotation.XmlRootElement;
+import java.io.OutputStream;
 import java.util.List;
 import java.util.Set;
 
@@ -43,6 +51,11 @@ public ClientReport() {
         super();
     }
 
+    @Override
+    public void serializeToJson(OutputStream outputStream) {
+        ClientReportSerializer.serialize(outputStream, this);
+    }
+
     public synchronized List<CompressionMethod> getClientAdvertisedCompressions() {
         ListResult<CompressionMethod> listResult =
                 getListResult(

TLS-Client-Scanner/src/main/java/de/rub/nds/tlsscanner/clientscanner/report/ClientReportSerializer.java

@@ -13,7 +13,9 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import java.io.File;
+import java.io.FileOutputStream;
 import java.io.IOException;
+import java.io.OutputStream;
 import java.math.BigDecimal;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -26,7 +28,7 @@ private ClientReportSerializer() {
         throw new IllegalStateException("Utility class");
     }
 
-    public static void serialize(File outputFile, ClientReport scanReport) {
+    public static void serialize(OutputStream stream, ClientReport scanReport) {
         try {
             ObjectMapper mapper = new ObjectMapper();
             for (Module modules : ClientReport.getSerializerModules()) {
@@ -35,9 +37,18 @@ public static void serialize(File outputFile, ClientReport scanReport) {
             mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
             mapper.configOverride(BigDecimal.class)
                     .setFormat(JsonFormat.Value.forShape(JsonFormat.Shape.STRING));
-            mapper.writeValue(outputFile, scanReport);
+            mapper.writeValue(stream, scanReport);
         } catch (IOException ex) {
             LOGGER.error(ex);
         }
     }
+
+    public static void serialize(File outputFile, ClientReport scanReport) {
+        try {
+            serialize(new FileOutputStream(outputFile), scanReport);
+        } catch (IOException ex) {
+            throw new RuntimeException(
+                    "Could not serialize report to file: " + outputFile.getAbsolutePath(), ex);
+        }
+    }
 }

TLS-Scanner-Core/src/test/java/de/rub/nds/tlsscanner/core/TlsCoreTestReport.java

@@ -9,5 +9,9 @@
 package de.rub.nds.tlsscanner.core;
 
 import de.rub.nds.tlsscanner.core.report.TlsScanReport;
+import java.io.OutputStream;
 
-public class TlsCoreTestReport extends TlsScanReport {}
+public class TlsCoreTestReport extends TlsScanReport {
+    @Override
+    public void serializeToJson(OutputStream stream) {}
+}

TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/Main.java

@@ -18,8 +18,6 @@
 import de.rub.nds.tlsscanner.serverscanner.execution.TlsServerScanner;
 import de.rub.nds.tlsscanner.serverscanner.report.ServerReport;
 import de.rub.nds.tlsscanner.serverscanner.report.ServerReportPrinter;
-import de.rub.nds.tlsscanner.serverscanner.report.ServerReportSerializer;
-import java.io.File;
 import java.io.IOException;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -53,10 +51,6 @@ public static void main(String[] args) throws IOException {
                                                 DefaultPrintingScheme.getDefaultPrintingScheme(),
                                                 !config.getExecutorConfig().isNoColor())
                                         .getFullReport());
-                if (config.getExecutorConfig().isWriteReportToFile()) {
-                    File outputFile = new File(config.getExecutorConfig().getOutputFile());
-                    ServerReportSerializer.serialize(outputFile, report);
-                }
             } catch (ConfigurationException e) {
                 LOGGER.error("Encountered a ConfigurationException aborting.", e);
             }

TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/probe/DtlsFragmentationProbe.java

@@ -100,8 +100,8 @@ private TestResult supportsFragmentationAfterCookieExchange(
         SendDynamicClientKeyExchangeAction action = new SendDynamicClientKeyExchangeAction();
         action.setConfiguredFragmentList(
                 List.of(
-                        new DtlsHandshakeMessageFragment(config, 20),
-                        new DtlsHandshakeMessageFragment(config, 20)));
+                        new DtlsHandshakeMessageFragment(20),
+                        new DtlsHandshakeMessageFragment(20)));
         trace.addTlsAction(action);
         trace.addTlsAction(new SendAction(new ChangeCipherSpecMessage(), new FinishedMessage()));
         trace.addTlsAction(new ReceiveAction(new ChangeCipherSpecMessage(), new FinishedMessage()));
@@ -131,8 +131,8 @@ private TestResult supportsFragmentationWithExtension(boolean individualTranspor
         SendDynamicClientKeyExchangeAction action = new SendDynamicClientKeyExchangeAction();
         action.setConfiguredFragmentList(
                 List.of(
-                        new DtlsHandshakeMessageFragment(config, 20),
-                        new DtlsHandshakeMessageFragment(config, 20)));
+                        new DtlsHandshakeMessageFragment(20),
+                        new DtlsHandshakeMessageFragment(20)));
         trace.addTlsAction(action);
         trace.addTlsAction(new SendAction(new ChangeCipherSpecMessage(), new FinishedMessage()));
         trace.addTlsAction(new ReceiveAction(new ChangeCipherSpecMessage(), new FinishedMessage()));

TLS-Server-Scanner/src/main/java/de/rub/nds/tlsscanner/serverscanner/report/ServerReport.java

@@ -42,6 +42,7 @@
 import de.rub.nds.tlsscanner.serverscanner.probe.namedgroup.NamedGroupWitness;
 import de.rub.nds.tlsscanner.serverscanner.probe.result.hpkp.HpkpPin;
 import de.rub.nds.tlsscanner.serverscanner.probe.result.raccoonattack.RaccoonAttackProbabilities;
+import java.io.OutputStream;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -91,6 +92,11 @@ public ServerReport(String sniHostname, String host, Integer port) {
         this.port = port;
     }
 
+    @Override
+    public void serializeToJson(OutputStream outputStream) {
+        ServerReportSerializer.serialize(outputStream, this);
+    }
+
     @Override
     public String getRemoteName() {
         if (sniHostname != null) {

pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>de.rub.nds</groupId>
         <artifactId>protocol-toolkit-bom</artifactId>
-        <version>4.2.7</version>
+        <version>4.4.0</version>
     </parent>
 
     <groupId>de.rub.nds.tls.scanner</groupId>