Merge pull request #1 from teclib-idmef/features/jackson

Features/jackson

Author: fdechelle

.gitignore

@@ -1,3 +1,4 @@
 /.gradle/
 /build/
 /.idea/
+*.json

build.gradle

@@ -13,7 +13,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'net.jimblackler.jsonschemafriend:core:0.11.2'
+    implementation 'com.networknt:json-schema-validator:1.0.64'
     implementation 'com.fasterxml.jackson.core:jackson-databind:2.0.1'
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0'

src/main/java/org/idmef/Analyzer.java

@@ -1,6 +1,8 @@
 package org.idmef;
 
-public class IDMEFException extends Exception {
+import java.io.IOException;
+
+public class IDMEFException extends IOException {
     public IDMEFException(String message) {
         super(message);
     }

src/main/java/org/idmef/IDMEFException.java

@@ -1,35 +1,89 @@
 package org.idmef;
 
+import com.fasterxml.jackson.annotation.JsonAnyGetter;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+
+import java.io.IOException;
 import java.lang.reflect.Array;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
+
+/*
+    TODO:
+    - transform a JsonNode to a Map
+    - for embedded objects, lookup object class using property name (Analyzer -> org.idmef.Analyzer)
+    - for array of objects, use the array property name to lookup object class
+ */
+
 
-class IDMEFObject extends HashMap<String, Object> {
+/**
+ * IDMEF base object.
+ *
+ * This implementation provides property setting/getting.
+ *
+ * Current implementation does not check property keys in put method. Property keys and values are checked
+ * when calling validate() method.
+ */
+@JsonDeserialize(using = IDMEFObjectDeserializer.class)
+public class IDMEFObject {
+
+    private LinkedHashMap<String, Object> properties;
 
     /**
      * Construct an empty IDMEFObject.
-     *
      */
-    IDMEFObject() {
+    public IDMEFObject()
+    {
+        properties = new LinkedHashMap<>();
     }
 
-    /**
-     * Construct an IDMEFObject from a map.
-     *
-     * @param map the map
-     */
-    IDMEFObject(Map<String, Object> map) {
-        putAll(map);
+    private static Object convertField(JsonNode value) throws IDMEFException {
+        if (value.isInt())
+            return value.asInt();
+        else if (value.isTextual())
+            return value.textValue();
+        else if (value.isObject())
+            return new IDMEFObject(value);
+        else if (value.isArray()) {
+            List<Object> l = new ArrayList<>();
+
+            for(int i = 0; i < value.size(); i++)
+                l.add(convertField(value.get(i)));
+
+            return l;
+        } else
+            throw new IDMEFException("Unhandled node type: " + value.getClass().getName());
+    }
+
+    IDMEFObject(JsonNode node) throws IDMEFException {
+        this();
+
+        Iterator<Map.Entry<String, JsonNode>> fields = node.fields();
+
+        while (fields.hasNext()) {
+            Map.Entry<String, JsonNode> field = fields.next();
+
+            put(field.getKey(), convertField(field.getValue()));
+        }
+    }
+
+    @JsonAnyGetter
+    public Map<String, Object> getProperties() {
+        return properties;
+    }
+
+    public Object get(String key) {
+        return properties.get(key);
     }
 
     /**
      * Set a property of the Message. If value is an array, transform it to a List.
      *
      * @param key the property key
      * @param value the property value
-     * @return the value that was set
+     * @return the real value that was set
      */
     public Object put(String key, Object value) {
         Object adaptedValue = value;
@@ -43,8 +97,48 @@ public Object put(String key, Object value) {
             adaptedValue = l;
         }
 
-        super.put(key, adaptedValue);
+        properties.put(key, adaptedValue);
 
         return adaptedValue;
     }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (! (obj instanceof IDMEFObject))
+            return false;
+
+        IDMEFObject idmefObject = (IDMEFObject) obj;
+
+        return properties.equals(idmefObject.properties);
+    }
+
+    /**
+     * Serialize a Message to JSON bytes.
+     *
+     * <b>Note: The method first validates the Message.</b>
+     *
+     * @return the JSON bytes
+     * @throws IDMEFException if the Message is not valid
+     */
+    public byte[] serialize() throws /* IDMEFException,*/ IOException {
+        //validate();
+
+        ObjectMapper objectMapper = new ObjectMapper();
+        objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
+
+        return objectMapper.writeValueAsBytes(this);
+    }
+
+    /**
+     * Deserialize JSON bytes to a Message
+     *
+     * @param json the JSON bytes
+     * @return a Message object with content filled from JSON
+     */
+    public static IDMEFObject deserialize(byte[] json) throws IOException {
+        ObjectMapper objectMapper = new ObjectMapper();
+
+        return objectMapper.readValue(json, IDMEFObject.class);
+    }
+
 }

src/main/java/org/idmef/IDMEFObject.java

@@ -0,0 +1,31 @@
+package org.idmef;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+
+import java.io.IOException;
+
+public class IDMEFObjectDeserializer extends StdDeserializer<IDMEFObject> {
+
+    public IDMEFObjectDeserializer() {
+        this(null);
+    }
+
+    public IDMEFObjectDeserializer(Class<?> vc) {
+        super(vc);
+    }
+
+    @Override
+    public IDMEFObject deserialize(JsonParser jp, DeserializationContext context) throws IOException, JsonProcessingException {
+        JsonNode jsonNode = jp.getCodec().readTree(jp);
+
+        if (!jsonNode.isObject()) {
+            throw new IDMEFException("Invalid JsonNode type: " + jsonNode.getClass().getName());
+        }
+
+        return new IDMEFObject(jsonNode);
+    }
+}

src/main/java/org/idmef/IDMEFObjectAdapter.java

@@ -0,0 +1,58 @@
+package org.idmef;
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.networknt.schema.JsonSchema;
+import com.networknt.schema.JsonSchemaFactory;
+import com.networknt.schema.SpecVersion;
+import com.networknt.schema.ValidationMessage;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Set;
+
+public class IDMEFValidator {
+    private static final String SCHEMA_RESOURCE_PATH = "/IDMEFv2.schema";
+
+    /**
+     * Constructs a Validator.
+     */
+    public IDMEFValidator() {
+    }
+
+    private boolean validateJsonNode(JsonNode jsonNode) throws IDMEFException {
+        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4);
+        InputStream is = IDMEFValidator.class.getResourceAsStream(SCHEMA_RESOURCE_PATH);
+        if (is == null)
+            throw new IDMEFException("cannot load schema");
+
+        JsonSchema schema = factory.getSchema(is);
+
+        Set<ValidationMessage> errors = schema.validate(jsonNode);
+
+        return errors.size() == 0;
+    }
+
+    /**
+     * Validate the object content w.r.t. current IDMEF JSON schema.
+     *
+     */
+    public boolean validate(IDMEFObject idmefObject) throws IDMEFException {
+        ObjectMapper objectMapper = new ObjectMapper();
+        JsonNode jsonNode = objectMapper.valueToTree(idmefObject);
+
+        return validateJsonNode(jsonNode);
+    }
+
+    /**
+     * Validate the bytes w.r.t. current IDMEF JSON schema.
+     *
+     */
+    public boolean validate(byte[] json) throws IOException {
+        ObjectMapper objectMapper = new ObjectMapper();
+        JsonNode jsonNode = objectMapper.readTree(json);
+
+        return validateJsonNode(jsonNode);
+    }
+}