From 6ed76f49481e22b880744cf39f361f4ef51f32e5 Mon Sep 17 00:00:00 2001
From: Alexandre Dulaunoy <a@foo.be>
Date: Mon, 17 Feb 2020 15:07:49 +0100
Subject: [PATCH] add: [iot-firmware] new object template to describe IoT
 firmware

The relationship will be often between iot-device and iot-firmware.

Ref: https://github.com/C00kie-/workshop-materials
---
 objects/iot-firmware/definition.json | 99 ++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)
 create mode 100644 objects/iot-firmware/definition.json

diff --git a/objects/iot-firmware/definition.json b/objects/iot-firmware/definition.json
new file mode 100644
index 0000000..4ba6e67
--- /dev/null
+++ b/objects/iot-firmware/definition.json
@@ -0,0 +1,99 @@
+{
+  "requiredOneOf": [
+    "firmware",
+    "filename",
+    "binwalk-output"
+  ],
+  "attributes": {
+    "firmware": {
+      "description": "Firmware of the IoT device",
+      "ui-priority": 10,
+      "misp-attribute": "attachment",
+      "multiple": true
+    },
+    "version": {
+      "description": "Version of the firmware",
+      "ui-priority": 10,
+      "misp-attribute": "text",
+      "multiple": true
+    },
+    "filename": {
+      "description": "Filename of the firmware",
+      "ui-priority": 10,
+      "misp-attribute": "text"
+    },
+    "boot-log": {
+      "description": "Boot log of the IoT device for this firmware",
+      "ui-priority": 10,
+      "misp-attribute": "attachment",
+      "multiple": true
+    },
+    "binwalk-output": {
+      "description": "Binwalk output of the firmware image",
+      "ui-priority": 10,
+      "misp-attribute": "attachment"
+    },
+    "format": {
+      "description": "Format of the firmware",
+      "ui-priority": 10,
+      "misp-attribute": "text",
+      "sane_default": [
+        "raw",
+        "Intel hex",
+        "Motorola S-Record",
+        "Unknown"
+      ]
+    },
+    "md5": {
+      "description": "[Insecure] MD5 hash (128 bits)",
+      "ui-priority": 1,
+      "misp-attribute": "md5",
+      "recommended": false
+    },
+    "sha1": {
+      "description": "[Insecure] Secure Hash Algorithm 1 (160 bits)",
+      "ui-priority": 1,
+      "misp-attribute": "sha1",
+      "recommended": false
+    },
+    "sha224": {
+      "description": "Secure Hash Algorithm 2 (224 bits)",
+      "ui-priority": 0,
+      "misp-attribute": "sha224",
+      "recommended": false
+    },
+    "sha256": {
+      "description": "Secure Hash Algorithm 2 (256 bits)",
+      "ui-priority": 1,
+      "misp-attribute": "sha256"
+    },
+    "sha384": {
+      "description": "Secure Hash Algorithm 2 (384 bits)",
+      "ui-priority": 0,
+      "misp-attribute": "sha384",
+      "recommended": false
+    },
+    "sha512": {
+      "description": "Secure Hash Algorithm 2 (512 bits)",
+      "ui-priority": 1,
+      "misp-attribute": "sha512"
+    },
+    "size-in-bytes": {
+      "description": "Size of the file, in bytes",
+      "disable_correlation": true,
+      "ui-priority": 0,
+      "misp-attribute": "size-in-bytes"
+    },
+    "binwalk-entropy-graph": {
+      "description": "Entropy graph of the firmware",
+      "disable_correlation": true,
+      "ui-priority": 0,
+      "misp-attribute": "attachment"
+    }
+  },
+  "version": 1,
+  "description": "A firmware for an IoT device.",
+  "meta-category": "iot",
+  "uuid": "8bafb8fc-d986-4a58-b22b-6b8c7c0e8b70",
+  "name": "iot-firmware"
+}