Merge pull request #236 from tls-attacker/feat/json-serialization

feat: Improve JSON serialization with ModifiableVariable

Author: ic0ns

README.md

@@ -67,6 +67,11 @@
     </properties>
 
     <dependencies>
+        <!-- scope: compile -->
+        <dependency>
+            <groupId>com.fasterxml</groupId>
+            <artifactId>classmate</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-annotations</artifactId>
@@ -80,10 +85,13 @@
             <artifactId>jackson-databind</artifactId>
         </dependency>
         <dependency>
-            <groupId>com.fasterxml.jackson.dataformat</groupId>
-            <artifactId>jackson-dataformat-yaml</artifactId>
+            <groupId>com.github.victools</groupId>
+            <artifactId>jsonschema-generator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.github.victools</groupId>
+            <artifactId>jsonschema-module-jackson</artifactId>
         </dependency>
-        <!-- scope: compile -->
         <dependency>
             <groupId>jakarta.xml.bind</groupId>
             <artifactId>jakarta.xml.bind-api</artifactId>
@@ -100,17 +108,16 @@
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-core</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.reflections</groupId>
+            <artifactId>reflections</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.github.spotbugs</groupId>
             <artifactId>spotbugs-annotations</artifactId>
             <scope>provided</scope>
         </dependency>
         <!-- scope: test -->
-        <dependency>
-            <groupId>org.glassfish.jaxb</groupId>
-            <artifactId>jaxb-runtime</artifactId>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
@@ -211,6 +218,28 @@
                     <skipTests>${skip.surefire.tests}</skipTests>
                 </configuration>
             </plugin>
+            <!-- Generate JSON schema from Java classes -->
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>generate-json-schema</id>
+                        <goals>
+                            <goal>java</goal>
+                        </goals>
+                        <phase>prepare-package</phase>
+                        <configuration>
+                            <mainClass>de.rub.nds.modifiablevariable.json.JsonSchemaCliGenerator</mainClass>
+                            <arguments>
+                                <argument>de.rub.nds.modifiablevariable.ModifiableVariable</argument>
+                                <argument>src/main/resources/ModifiableVariable.schema.json</argument>
+                                <argument>de.rub.nds.modifiablevariable.json.ModifiableVariableModule</argument>
+                            </arguments>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <!-- Build jar file -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

pom.xml

@@ -7,7 +7,7 @@
  */
 package de.rub.nds.modifiablevariable;
 
-import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.*;
 import jakarta.xml.bind.annotation.*;
 import java.io.Serializable;
 import java.util.LinkedList;
@@ -32,15 +32,20 @@
  */
 @XmlTransient
 @XmlAccessorType(XmlAccessType.FIELD)
-@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
+@JsonTypeInfo(
+        use = JsonTypeInfo.Id.SIMPLE_NAME,
+        include = JsonTypeInfo.As.PROPERTY,
+        property = "@type")
 public abstract class ModifiableVariable<E> implements Serializable {
 
     /** The list of modifications that will be applied to the original value when accessed */
     @XmlElementWrapper
     @XmlAnyElement(lax = true)
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
     private LinkedList<VariableModification<E>> modifications;
 
     /** The expected value for assertion validation */
+    @JsonInclude(JsonInclude.Include.NON_NULL)
     protected E assertEquals;
 
     /** Default constructor that creates an empty modifiable variable. */

src/main/java/de/rub/nds/modifiablevariable/ModifiableVariable.java

@@ -46,7 +46,10 @@
  */
 @XmlTransient
 @XmlAccessorType(XmlAccessType.FIELD)
-@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
+@JsonTypeInfo(
+        use = JsonTypeInfo.Id.SIMPLE_NAME,
+        include = JsonTypeInfo.As.PROPERTY,
+        property = "@type")
 public abstract class VariableModification<E> implements Serializable {
 
     /** Logger for debugging modification applications */

src/main/java/de/rub/nds/modifiablevariable/VariableModification.java

@@ -7,6 +7,7 @@
  */
 package de.rub.nds.modifiablevariable.biginteger;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import de.rub.nds.modifiablevariable.VariableModification;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import java.math.BigInteger;
@@ -23,6 +24,7 @@
 public class BigIntegerAddModification extends VariableModification<BigInteger> {
 
     /** The value to add to the original BigInteger */
+    @JsonProperty(required = true)
     private BigInteger summand;
 
     /** Default constructor for serialization. */

src/main/java/de/rub/nds/modifiablevariable/biginteger/BigIntegerAddModification.java

@@ -7,6 +7,7 @@
  */
 package de.rub.nds.modifiablevariable.biginteger;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import de.rub.nds.modifiablevariable.VariableModification;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import java.math.BigInteger;
@@ -25,6 +26,7 @@
 public class BigIntegerExplicitValueModification extends VariableModification<BigInteger> {
 
     /** The explicit value that will replace the original value */
+    @JsonProperty(required = true)
     private BigInteger explicitValue;
 
     /** Default constructor for serialization. */

src/main/java/de/rub/nds/modifiablevariable/biginteger/BigIntegerExplicitValueModification.java

@@ -7,6 +7,7 @@
  */
 package de.rub.nds.modifiablevariable.biginteger;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import de.rub.nds.modifiablevariable.VariableModification;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import java.math.BigInteger;
@@ -24,6 +25,7 @@
 public class BigIntegerMultiplyModification extends VariableModification<BigInteger> {
 
     /** The factor to multiply by */
+    @JsonProperty(required = true)
     private BigInteger factor;
 
     /** Default constructor for serialization. */

src/main/java/de/rub/nds/modifiablevariable/biginteger/BigIntegerMultiplyModification.java

@@ -7,6 +7,7 @@
  */
 package de.rub.nds.modifiablevariable.biginteger;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import de.rub.nds.modifiablevariable.VariableModification;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import java.math.BigInteger;
@@ -25,6 +26,7 @@
 public class BigIntegerShiftLeftModification extends VariableModification<BigInteger> {
 
     /** The number of bits to shift left */
+    @JsonProperty(required = true)
     private int shift;
 
     /** Default constructor for serialization. */

src/main/java/de/rub/nds/modifiablevariable/biginteger/BigIntegerShiftLeftModification.java

@@ -7,6 +7,7 @@
  */
 package de.rub.nds.modifiablevariable.biginteger;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import de.rub.nds.modifiablevariable.VariableModification;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import java.math.BigInteger;
@@ -25,6 +26,7 @@
 public class BigIntegerShiftRightModification extends VariableModification<BigInteger> {
 
     /** The number of bit positions to shift right */
+    @JsonProperty(required = true)
     private int shift;
 
     /** Default constructor for serialization. */

src/main/java/de/rub/nds/modifiablevariable/biginteger/BigIntegerShiftRightModification.java

@@ -7,6 +7,7 @@
  */
 package de.rub.nds.modifiablevariable.biginteger;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import de.rub.nds.modifiablevariable.VariableModification;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import java.math.BigInteger;
@@ -24,6 +25,7 @@
 public class BigIntegerSubtractModification extends VariableModification<BigInteger> {
 
     /** The value to subtract from the original BigInteger */
+    @JsonProperty(required = true)
     private BigInteger subtrahend;
 
     /** Default constructor for serialization. */