Merge pull request #2035 from jg42526/checksum/xor

XOR Checksum operation added

Author: jg42526

src/core/config/Categories.json

@@ -448,7 +448,8 @@
             "Adler-32 Checksum",
             "Luhn Checksum",
             "CRC Checksum",
-            "TCP/IP Checksum"
+            "TCP/IP Checksum",
+            "XOR Checksum"
         ]
     },
     {

src/core/operations/XORChecksum.mjs

@@ -0,0 +1,59 @@
+/**
+ * @author Thomas Weißschuh [[email protected]]
+ * @copyright Crown Copyright 2023
+ * @license Apache-2.0
+ */
+
+import Operation from "../Operation.mjs";
+import Utils from "../Utils.mjs";
+import { toHex } from "../lib/Hex.mjs";
+
+/**
+ * XOR Checksum operation
+ */
+class XORChecksum extends Operation {
+
+    /**
+     * XORChecksum constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "XOR Checksum";
+        this.module = "Crypto";
+        this.description = "XOR Checksum splits the input into blocks of a configurable size and performs the XOR operation on these blocks.";
+        this.infoURL = "https://wikipedia.org/wiki/XOR";
+        this.inputType = "ArrayBuffer";
+        this.outputType = "string";
+        this.args = [
+            {
+                name: "Blocksize",
+                type: "number",
+                value: 4
+            },
+        ];
+    }
+
+    /**
+     * @param {ArrayBuffer} input
+     * @param {Object[]} args
+     * @returns {string}
+     */
+    run(input, args) {
+        const blocksize = args[0];
+        input = new Uint8Array(input);
+
+        const res = Array(blocksize);
+        res.fill(0);
+
+        for (const chunk of Utils.chunked(input, blocksize)) {
+            for (let i = 0; i < blocksize; i++) {
+                res[i] ^= chunk[i];
+            }
+        }
+
+        return toHex(res, "");
+    }
+}
+
+export default XORChecksum;

tests/operations/tests/XORChecksum.mjs

@@ -0,0 +1,120 @@
+/**
+ * Checksum tests.
+ *
+ * @author n1474335 [[email protected]]
+ * @copyright Crown Copyright 2018
+ * @license Apache-2.0
+ */
+import TestRegister from "../../lib/TestRegister.mjs";
+
+const BASIC_STRING = "The ships hung in the sky in much the same way that bricks don't.";
+const UTF8_STR = "ნუ პანიკას";
+const ALL_BYTES = [
+    "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f",
+    "\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f",
+    "\x20\x21\x22\x23\x24\x25\x26\x27\x28\x29\x2a\x2b\x2c\x2d\x2e\x2f",
+    "\x30\x31\x32\x33\x34\x35\x36\x37\x38\x39\x3a\x3b\x3c\x3d\x3e\x3f",
+    "\x40\x41\x42\x43\x44\x45\x46\x47\x48\x49\x4a\x4b\x4c\x4d\x4e\x4f",
+    "\x50\x51\x52\x53\x54\x55\x56\x57\x58\x59\x5a\x5b\x5c\x5d\x5e\x5f",
+    "\x60\x61\x62\x63\x64\x65\x66\x67\x68\x69\x6a\x6b\x6c\x6d\x6e\x6f",
+    "\x70\x71\x72\x73\x74\x75\x76\x77\x78\x79\x7a\x7b\x7c\x7d\x7e\x7f",
+    "\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f",
+    "\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f",
+    "\xa0\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf",
+    "\xb0\xb1\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf",
+    "\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf",
+    "\xd0\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf",
+    "\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef",
+    "\xf0\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff",
+].join("");
+
+TestRegister.addTests([
+    {
+        name: "XOR Checksum (1): nothing",
+        input: "",
+        expectedOutput: "00",
+        recipeConfig: [
+            {
+                "op": "XOR Checksum",
+                "args": [1]
+            }
+        ]
+    },
+    {
+        name: "XOR Checksum (1): basic string",
+        input: BASIC_STRING,
+        expectedOutput: "08",
+        recipeConfig: [
+            {
+                "op": "XOR Checksum",
+                "args": [1]
+            }
+        ]
+    },
+    {
+        name: "XOR Checksum (1): UTF-8",
+        input: UTF8_STR,
+        expectedOutput: "df",
+        recipeConfig: [
+            {
+                "op": "XOR Checksum",
+                "args": [1]
+            }
+        ]
+    },
+    {
+        name: "XOR Checksum (1): all bytes",
+        input: ALL_BYTES,
+        expectedOutput: "00",
+        recipeConfig: [
+            {
+                "op": "XOR Checksum",
+                "args": [1]
+            }
+        ]
+    },
+    {
+        name: "XOR Checksum (4): nothing",
+        input: "",
+        expectedOutput: "00000000",
+        recipeConfig: [
+            {
+                "op": "XOR Checksum",
+                "args": [4]
+            }
+        ]
+    },
+    {
+        name: "XOR Checksum (4): basic string",
+        input: BASIC_STRING,
+        expectedOutput: "4918421b",
+        recipeConfig: [
+            {
+                "op": "XOR Checksum",
+                "args": [4]
+            }
+        ]
+    },
+    {
+        name: "XOR Checksum (4): UTF-8",
+        input: UTF8_STR,
+        expectedOutput: "83a424dc",
+        recipeConfig: [
+            {
+                "op": "XOR Checksum",
+                "args": [4]
+            }
+        ]
+    },
+    {
+        name: "XOR Checksum (4): all bytes",
+        input: ALL_BYTES,
+        expectedOutput: "00000000",
+        recipeConfig: [
+            {
+                "op": "XOR Checksum",
+                "args": [4]
+            }
+        ]
+    },
+]);