9.14.0

CHANGELOG.md

@@ -2,6 +2,9 @@
 All major and minor version changes will be documented in this file. Details of patch-level version changes can be found in [commit messages](https://github.com/gchq/CyberChef/commits/master).
 
 
+### [9.14.0] - 2020-03-05
+- 'Luhn Checksum' operation added [@n1073645] | [#965]
+
 ### [9.13.0] - 2020-02-13
 - 'Rail Fence Cipher Encode' and 'Rail Fence Cipher Decode' operations added [@Flavsditz] | [#948]
 
@@ -203,6 +206,7 @@ All major and minor version changes will be documented in this file. Details of
 
 
 
+[9.14.0]: https://github.com/gchq/CyberChef/releases/tag/v9.14.0
 [9.13.0]: https://github.com/gchq/CyberChef/releases/tag/v9.13.0
 [9.12.0]: https://github.com/gchq/CyberChef/releases/tag/v9.12.0
 [9.11.0]: https://github.com/gchq/CyberChef/releases/tag/v9.11.0
@@ -265,6 +269,7 @@ All major and minor version changes will be documented in this file. Details of
 [@n1474335]: https://github.com/n1474335
 [@d98762625]: https://github.com/d98762625
 [@j433866]: https://github.com/j433866
+[@n1073645]: https://github.com/n1073645
 [@GCHQ77703]: https://github.com/GCHQ77703
 [@h345983745]: https://github.com/h345983745
 [@s2224834]: https://github.com/s2224834
@@ -356,3 +361,4 @@ All major and minor version changes will be documented in this file. Details of
 [#865]: https://github.com/gchq/CyberChef/pull/865
 [#912]: https://github.com/gchq/CyberChef/pull/912
 [#948]: https://github.com/gchq/CyberChef/pull/948
+[#965]: https://github.com/gchq/CyberChef/pull/965

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "cyberchef",
-  "version": "9.13.2",
+  "version": "9.14.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyberchef",
-  "version": "9.13.2",
+  "version": "9.14.0",
   "description": "The Cyber Swiss Army Knife for encryption, encoding, compression and data analysis.",
   "author": "n1474335 <n1474335@gmail.com>",
   "homepage": "https://gchq.github.io/CyberChef",

src/core/config/Categories.json

@@ -332,6 +332,7 @@
             "Fletcher-32 Checksum",
             "Fletcher-64 Checksum",
             "Adler-32 Checksum",
+            "Luhn Checksum",
             "CRC-8 Checksum",
             "CRC-16 Checksum",
             "CRC-32 Checksum",

src/core/operations/LuhnChecksum.mjs

@@ -0,0 +1,62 @@
+/**
+ * @author n1073645 [n1073645@gmail.com]
+ * @copyright Crown Copyright 2020
+ * @license Apache-2.0
+ */
+
+import Operation from "../Operation.mjs";
+import OperationError from "../errors/OperationError.mjs";
+
+/**
+ * Luhn Checksum operation
+ */
+class LuhnChecksum extends Operation {
+
+    /**
+     * LuhnChecksum constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "Luhn Checksum";
+        this.module = "Default";
+        this.description = "The Luhn algorithm, also known as the modulus 10 or mod 10 algorithm, is a simple checksum formula used to validate a variety of identification numbers, such as credit card numbers, IMEI numbers and Canadian Social Insurance Numbers.";
+        this.infoURL = "https://wikipedia.org/wiki/Luhn_algorithm";
+        this.inputType = "string";
+        this.outputType = "number";
+        this.args = [];
+    }
+
+    /**
+     * @param {string} input
+     * @param {Object[]} args
+     * @returns {number}
+     */
+    run(input, args) {
+        let even = false;
+        return input.split("").reverse().reduce((acc, elem) => {
+
+            // Convert element to integer.
+            let temp = parseInt(elem, 10);
+
+            // If element is not an integer.
+            if (isNaN(temp))
+                throw new OperationError("Character: " + elem + " is not a digit.");
+
+            // If element is in an even position
+            if (even) {
+
+                // Double the element and add the quotient and remainder together.
+                temp = 2 * elem;
+                temp = Math.floor(temp/10) + (temp % 10);
+            }
+
+            even = !even;
+            return acc + temp;
+
+        }, 0)  % 10;
+    }
+
+}
+
+export default LuhnChecksum;

tests/operations/index.mjs

@@ -97,6 +97,7 @@ import "./tests/DefangIP.mjs";
 import "./tests/ParseUDP.mjs";
 import "./tests/AvroToJSON.mjs";
 import "./tests/Lorenz.mjs";
+import "./tests/LuhnChecksum.mjs";
 
 
 // Cannot test operations that use the File type yet

tests/operations/tests/LuhnChecksum.mjs

@@ -0,0 +1,44 @@
+/**
+ * From Decimal tests
+ *
+ * @author n1073645 [n1073645@gmail.com]
+ * @copyright Crown Copyright 2020
+ * @licence Apache-2.0
+ */
+import TestRegister from "../../lib/TestRegister.mjs";
+
+TestRegister.addTests([
+    {
+        name: "Luhn Checksum on standard data",
+        input: "35641709012469",
+        expectedOutput: "7",
+        recipeConfig: [
+            {
+                op: "Luhn Checksum",
+                args: []
+            },
+        ],
+    },
+    {
+        name: "Luhn Checksum on invalid data",
+        input: "35641709b012469",
+        expectedOutput: "Character: b is not a digit.",
+        recipeConfig: [
+            {
+                op: "Luhn Checksum",
+                args: []
+            },
+        ],
+    },
+    {
+        name: "Luhn Checksum on empty data",
+        input: "",
+        expectedOutput: "0",
+        recipeConfig: [
+            {
+                op: "Luhn Checksum",
+                args: []
+            },
+        ],
+    }
+]);