cyberchef 9.34.2 → 9.35.0

package/CHANGELOG.md

@@ -13,6 +13,9 @@ All major and minor version changes will be documented in this file. Details of
 
 ## Details
 
+### [9.35.0] - 2022-03-28
+- 'To Base45' and 'From Base45' operations added [@t-8ch] | [#1242]
+
 ### [9.34.0] - 2022-03-28
 - 'Get All Casings' operation added [@n1073645] | [#1065]
 
@@ -278,6 +281,7 @@ All major and minor version changes will be documented in this file. Details of
 
 
 
+[9.35.0]: https://github.com/gchq/CyberChef/releases/tag/v9.35.0
 [9.34.0]: https://github.com/gchq/CyberChef/releases/tag/v9.34.0
 [9.33.0]: https://github.com/gchq/CyberChef/releases/tag/v9.33.0
 [9.32.0]: https://github.com/gchq/CyberChef/releases/tag/v9.32.0
@@ -482,6 +486,7 @@ All major and minor version changes will be documented in this file. Details of
 [#1049]: https://github.com/gchq/CyberChef/pull/1049
 [#1065]: https://github.com/gchq/CyberChef/pull/1065
 [#1083]: https://github.com/gchq/CyberChef/pull/1083
+[#1242]: https://github.com/gchq/CyberChef/pull/1242
 [#1244]: https://github.com/gchq/CyberChef/pull/1244
 [#1313]: https://github.com/gchq/CyberChef/pull/1313
 [#1326]: https://github.com/gchq/CyberChef/pull/1326

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyberchef",
-  "version": "9.34.2",
+  "version": "9.35.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",

package/src/core/Utils.mjs

@@ -1207,6 +1207,30 @@ class Utils {
         }[token];
     }
 
+    /**
+     * Iterate object in chunks of given size.
+     *
+     * @param {Iterable} iterable
+     * @param {number} chunksize
+     */
+    static* chunked(iterable, chunksize) {
+        const iterator = iterable[Symbol.iterator]();
+        while (true) {
+            const res = [];
+            for (let i = 0; i < chunksize; i++) {
+                const next = iterator.next();
+                if (next.done) {
+                    break;
+                }
+                res.push(next.value);
+            }
+            if (res.length) {
+                yield res;
+            } else {
+                return;
+            }
+        }
+    }
 }
 
 /**

package/src/core/config/Categories.json

@@ -20,6 +20,8 @@
             "From Octal",
             "To Base32",
             "From Base32",
+            "To Base45",
+            "From Base45",
             "To Base58",
             "From Base58",
             "To Base62",

package/src/core/config/OperationConfig.json

@@ -5548,6 +5548,22 @@
             }
         ]
     },
+    "From Base45": {
+        "module": "Default",
+        "description": "Base45 is a notation for encoding arbitrary byte data using a restricted set of symbols that can be conveniently used by humans and processed by computers. The high number base results in shorter strings than with the decimal or hexadecimal system. Base45 is optimized for usage with QR codes.",
+        "infoURL": "https://wikipedia.org/wiki/List_of_numeral_systems",
+        "inputType": "string",
+        "outputType": "byteArray",
+        "flowControl": false,
+        "manualBake": false,
+        "args": [
+            {
+                "name": "Alphabet",
+                "type": "string",
+                "value": "0-9A-Z $%*+\\-./:"
+            }
+        ]
+    },
     "From Base58": {
         "module": "Default",
         "description": "Base58 (similar to Base64) is a notation for encoding arbitrary byte data. It differs from Base64 by removing easily misread characters (i.e. l, I, 0 and O) to improve human readability.<br><br>This operation decodes data from an ASCII string (with an alphabet of your choosing, presets included) back into its raw form.<br><br>e.g. <code>StV1DL6CwTryKyV</code> becomes <code>hello world</code><br><br>Base58 is commonly used in cryptocurrencies (Bitcoin, Ripple, etc).",
@@ -12083,6 +12099,22 @@
             }
         ]
     },
+    "To Base45": {
+        "module": "Default",
+        "description": "Base45 is a notation for encoding arbitrary byte data using a restricted set of symbols that can be conveniently used by humans and processed by computers. The high number base results in shorter strings than with the decimal or hexadecimal system. Base45 is optimized for usage with QR codes.",
+        "infoURL": "https://wikipedia.org/wiki/List_of_numeral_systems",
+        "inputType": "ArrayBuffer",
+        "outputType": "string",
+        "flowControl": false,
+        "manualBake": false,
+        "args": [
+            {
+                "name": "Alphabet",
+                "type": "string",
+                "value": "0-9A-Z $%*+\\-./:"
+            }
+        ]
+    },
     "To Base58": {
         "module": "Default",
         "description": "Base58 (similar to Base64) is a notation for encoding arbitrary byte data. It differs from Base64 by removing easily misread characters (i.e. l, I, 0 and O) to improve human readability.<br><br>This operation encodes data in an ASCII string (with an alphabet of your choosing, presets included).<br><br>e.g. <code>hello world</code> becomes <code>StV1DL6CwTryKyV</code><br><br>Base58 is commonly used in cryptocurrencies (Bitcoin, Ripple, etc).",

package/src/core/config/modules/Default.mjs

@@ -45,6 +45,7 @@ import FrequencyDistribution from "../../operations/FrequencyDistribution.mjs";
 import FromBCD from "../../operations/FromBCD.mjs";
 import FromBase from "../../operations/FromBase.mjs";
 import FromBase32 from "../../operations/FromBase32.mjs";
+import FromBase45 from "../../operations/FromBase45.mjs";
 import FromBase58 from "../../operations/FromBase58.mjs";
 import FromBase62 from "../../operations/FromBase62.mjs";
 import FromBase64 from "../../operations/FromBase64.mjs";
@@ -134,6 +135,7 @@ import TakeBytes from "../../operations/TakeBytes.mjs";
 import ToBCD from "../../operations/ToBCD.mjs";
 import ToBase from "../../operations/ToBase.mjs";
 import ToBase32 from "../../operations/ToBase32.mjs";
+import ToBase45 from "../../operations/ToBase45.mjs";
 import ToBase58 from "../../operations/ToBase58.mjs";
 import ToBase62 from "../../operations/ToBase62.mjs";
 import ToBase64 from "../../operations/ToBase64.mjs";
@@ -209,6 +211,7 @@ OpModules.Default = {
     "From BCD": FromBCD,
     "From Base": FromBase,
     "From Base32": FromBase32,
+    "From Base45": FromBase45,
     "From Base58": FromBase58,
     "From Base62": FromBase62,
     "From Base64": FromBase64,
@@ -298,6 +301,7 @@ OpModules.Default = {
     "To BCD": ToBCD,
     "To Base": ToBase,
     "To Base32": ToBase32,
+    "To Base45": ToBase45,
     "To Base58": ToBase58,
     "To Base62": ToBase62,
     "To Base64": ToBase64,

package/src/core/lib/Base45.mjs

@@ -0,0 +1,27 @@
+/**
+ * Base45 resources.
+ *
+ * @author Thomas Weißschuh [thomas@t-8ch.de]
+ * @copyright Crown Copyright 2021
+ * @license Apache-2.0
+ */
+
+/**
+ * Highlight to Base45
+ */
+export function highlightToBase45(pos, args) {
+    pos[0].start = Math.floor(pos[0].start / 2) * 3;
+    pos[0].end = Math.ceil(pos[0].end / 2) * 3;
+    return pos;
+}
+
+/**
+ * Highlight from Base45
+ */
+export function highlightFromBase45(pos, args) {
+    pos[0].start = Math.floor(pos[0].start / 3) * 2;
+    pos[0].end = Math.ceil(pos[0].end / 3) * 2;
+    return pos;
+}
+
+export const ALPHABET = "0-9A-Z $%*+\\-./:";

package/src/core/operations/FromBase45.mjs

@@ -0,0 +1,89 @@
+/**
+ * @author Thomas Weißschuh [thomas@t-8ch.de]
+ * @copyright Crown Copyright 2021
+ * @license Apache-2.0
+ */
+
+import {ALPHABET, highlightToBase45, highlightFromBase45} from "../lib/Base45.mjs";
+import Operation from "../Operation.mjs";
+import OperationError from "../errors/OperationError.mjs";
+import Utils from "../Utils.mjs";
+
+
+/**
+ * From Base45 operation
+ */
+class FromBase45 extends Operation {
+
+    /**
+     * FromBase45 constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "From Base45";
+        this.module = "Default";
+        this.description = "Base45 is a notation for encoding arbitrary byte data using a restricted set of symbols that can be conveniently used by humans and processed by computers. The high number base results in shorter strings than with the decimal or hexadecimal system. Base45 is optimized for usage with QR codes.";
+        this.infoURL = "https://wikipedia.org/wiki/List_of_numeral_systems";
+        this.inputType = "string";
+        this.outputType = "byteArray";
+        this.args = [
+            {
+                name: "Alphabet",
+                type: "string",
+                value: ALPHABET
+            }
+        ];
+
+        this.highlight = highlightFromBase45;
+        this.highlightReverse = highlightToBase45;
+    }
+
+    /**
+     * @param {string} input
+     * @param {Object[]} args
+     * @returns {byteArray}
+     */
+    run(input, args) {
+        if (!input) return [];
+        const alphabet = Utils.expandAlphRange(args[0]);
+
+        const res = [];
+
+        for (const triple of Utils.chunked(input, 3)) {
+            triple.reverse();
+            let b = 0;
+            for (const c of triple) {
+                const idx = alphabet.indexOf(c);
+                if (idx === -1) {
+                    throw new OperationError(`Character not in alphabet: '${c}'`);
+                }
+                b *= 45;
+                b += idx;
+            }
+
+            if (b > 65535) {
+                throw new OperationError(`Triplet too large: '${triple.join("")}'`);
+            }
+
+            if (triple.length > 2) {
+                /**
+                 * The last triple may only have 2 bytes so we push the MSB when we got 3 bytes
+                 * Pushing MSB
+                 */
+                res.push(b >> 8);
+            }
+
+            /**
+             * Pushing LSB
+             */
+            res.push(b & 0xff);
+
+        }
+
+        return res;
+    }
+
+}
+
+export default FromBase45;

package/src/core/operations/ToBase45.mjs

@@ -0,0 +1,78 @@
+/**
+ * @author Thomas Weißschuh [thomas@t-8ch.de]
+ * @copyright Crown Copyright 2021
+ * @license Apache-2.0
+ */
+
+import {ALPHABET, highlightToBase45, highlightFromBase45} from "../lib/Base45.mjs";
+import Operation from "../Operation.mjs";
+import Utils from "../Utils.mjs";
+
+/**
+ * To Base45 operation
+ */
+class ToBase45 extends Operation {
+
+    /**
+     * ToBase45 constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "To Base45";
+        this.module = "Default";
+        this.description = "Base45 is a notation for encoding arbitrary byte data using a restricted set of symbols that can be conveniently used by humans and processed by computers. The high number base results in shorter strings than with the decimal or hexadecimal system. Base45 is optimized for usage with QR codes.";
+        this.infoURL = "https://wikipedia.org/wiki/List_of_numeral_systems";
+        this.inputType = "ArrayBuffer";
+        this.outputType = "string";
+        this.args = [
+            {
+                name: "Alphabet",
+                type: "string",
+                value: ALPHABET
+            }
+        ];
+
+        this.highlight = highlightToBase45;
+        this.highlightReverse = highlightFromBase45;
+    }
+
+    /**
+     * @param {ArrayBuffer} input
+     * @param {Object[]} args
+     * @returns {string}
+     */
+    run(input, args) {
+        input = new Uint8Array(input);
+        const alphabet = Utils.expandAlphRange(args[0]);
+        if (!input) return "";
+
+        const res = [];
+
+        for (const pair of Utils.chunked(input, 2)) {
+            let b = 0;
+            for (const e of pair) {
+                b *= 256;
+                b += e;
+            }
+
+            let chars = 0;
+            do {
+                res.push(alphabet[b % 45]);
+                chars++;
+                b = Math.floor(b / 45);
+            } while (b > 0);
+
+            if (chars < 2) {
+                res.push("0");
+            }
+        }
+
+
+        return res.join("");
+
+    }
+
+}
+
+export default ToBase45;

package/src/core/operations/index.mjs

@@ -120,6 +120,7 @@ import FrequencyDistribution from "./FrequencyDistribution.mjs";
 import FromBCD from "./FromBCD.mjs";
 import FromBase from "./FromBase.mjs";
 import FromBase32 from "./FromBase32.mjs";
+import FromBase45 from "./FromBase45.mjs";
 import FromBase58 from "./FromBase58.mjs";
 import FromBase62 from "./FromBase62.mjs";
 import FromBase64 from "./FromBase64.mjs";
@@ -315,6 +316,7 @@ import TextEncodingBruteForce from "./TextEncodingBruteForce.mjs";
 import ToBCD from "./ToBCD.mjs";
 import ToBase from "./ToBase.mjs";
 import ToBase32 from "./ToBase32.mjs";
+import ToBase45 from "./ToBase45.mjs";
 import ToBase58 from "./ToBase58.mjs";
 import ToBase62 from "./ToBase62.mjs";
 import ToBase64 from "./ToBase64.mjs";
@@ -487,6 +489,7 @@ export {
     FromBCD,
     FromBase,
     FromBase32,
+    FromBase45,
     FromBase58,
     FromBase62,
     FromBase64,
@@ -682,6 +685,7 @@ export {
     ToBCD,
     ToBase,
     ToBase32,
+    ToBase45,
     ToBase58,
     ToBase62,
     ToBase64,

package/src/node/index.mjs

@@ -127,6 +127,7 @@ import {
     FromBCD as core_FromBCD,
     FromBase as core_FromBase,
     FromBase32 as core_FromBase32,
+    FromBase45 as core_FromBase45,
     FromBase58 as core_FromBase58,
     FromBase62 as core_FromBase62,
     FromBase64 as core_FromBase64,
@@ -315,6 +316,7 @@ import {
     ToBCD as core_ToBCD,
     ToBase as core_ToBase,
     ToBase32 as core_ToBase32,
+    ToBase45 as core_ToBase45,
     ToBase58 as core_ToBase58,
     ToBase62 as core_ToBase62,
     ToBase64 as core_ToBase64,
@@ -494,6 +496,7 @@ function generateChef() {
         "fromBCD": _wrap(core_FromBCD),
         "fromBase": _wrap(core_FromBase),
         "fromBase32": _wrap(core_FromBase32),
+        "fromBase45": _wrap(core_FromBase45),
         "fromBase58": _wrap(core_FromBase58),
         "fromBase62": _wrap(core_FromBase62),
         "fromBase64": _wrap(core_FromBase64),
@@ -682,6 +685,7 @@ function generateChef() {
         "toBCD": _wrap(core_ToBCD),
         "toBase": _wrap(core_ToBase),
         "toBase32": _wrap(core_ToBase32),
+        "toBase45": _wrap(core_ToBase45),
         "toBase58": _wrap(core_ToBase58),
         "toBase62": _wrap(core_ToBase62),
         "toBase64": _wrap(core_ToBase64),
@@ -872,6 +876,7 @@ const frequencyDistribution = chef.frequencyDistribution;
 const fromBCD = chef.fromBCD;
 const fromBase = chef.fromBase;
 const fromBase32 = chef.fromBase32;
+const fromBase45 = chef.fromBase45;
 const fromBase58 = chef.fromBase58;
 const fromBase62 = chef.fromBase62;
 const fromBase64 = chef.fromBase64;
@@ -1067,6 +1072,7 @@ const textEncodingBruteForce = chef.textEncodingBruteForce;
 const toBCD = chef.toBCD;
 const toBase = chef.toBase;
 const toBase32 = chef.toBase32;
+const toBase45 = chef.toBase45;
 const toBase58 = chef.toBase58;
 const toBase62 = chef.toBase62;
 const toBase64 = chef.toBase64;
@@ -1241,6 +1247,7 @@ const operations = [
     fromBCD,
     fromBase,
     fromBase32,
+    fromBase45,
     fromBase58,
     fromBase62,
     fromBase64,
@@ -1436,6 +1443,7 @@ const operations = [
     toBCD,
     toBase,
     toBase32,
+    toBase45,
     toBase58,
     toBase62,
     toBase64,
@@ -1614,6 +1622,7 @@ export {
     fromBCD,
     fromBase,
     fromBase32,
+    fromBase45,
     fromBase58,
     fromBase62,
     fromBase64,
@@ -1809,6 +1818,7 @@ export {
     toBCD,
     toBase,
     toBase32,
+    toBase45,
     toBase58,
     toBase62,
     toBase64,

package/tests/operations/index.mjs

@@ -20,6 +20,7 @@ import TestRegister from "../lib/TestRegister.mjs";
 import "./tests/BCD.mjs";
 import "./tests/BSON.mjs";
 import "./tests/BaconCipher.mjs";
+import "./tests/Base45.mjs";
 import "./tests/Base58.mjs";
 import "./tests/Base64.mjs";
 import "./tests/Base62.mjs";

package/tests/operations/tests/Base45.mjs

@@ -0,0 +1,103 @@
+/**
+ * Base45 tests.
+ *
+ * @author Thomas Weißschuh [thomas@t-8ch.de]
+ *
+ * @copyright Crown Copyright 2021
+ * @license Apache-2.0
+ */
+
+import TestRegister from "../../lib/TestRegister.mjs";
+
+const defaultB45Alph = "0-9A-Z $%*+\\-./:";
+
+TestRegister.addTests([
+    {
+        name: "To Base45: nothing",
+        input: "",
+        expectedOutput: "",
+        recipeConfig: [
+            {
+                op: "To Base45",
+                args: [defaultB45Alph],
+            },
+        ],
+    },
+    {
+        name: "To Base45: Spec encoding example 1",
+        input: "AB",
+        expectedOutput: "BB8",
+        recipeConfig: [
+            {
+                op: "To Base45",
+                args: [defaultB45Alph],
+            },
+        ],
+    },
+    {
+        name: "To Base45: Spec encoding example 2",
+        input: "Hello!!",
+        expectedOutput: "%69 VD92EX0",
+        recipeConfig: [
+            {
+                op: "To Base45",
+                args: [defaultB45Alph],
+            },
+        ],
+    },
+    {
+        name: "To Base45: Spec encoding example 3",
+        input: "base-45",
+        expectedOutput: "UJCLQE7W581",
+        recipeConfig: [
+            {
+                op: "To Base45",
+                args: [defaultB45Alph],
+            },
+        ],
+    },
+    {
+        name: "From Base45: nothing",
+        input: "",
+        expectedOutput: "",
+        recipeConfig: [
+            {
+                op: "From Base45",
+                args: [defaultB45Alph],
+            },
+        ],
+    },
+    {
+        name: "From Base45: Spec decoding example 1",
+        input: "QED8WEX0",
+        expectedOutput: "ietf!",
+        recipeConfig: [
+            {
+                op: "From Base45",
+                args: [defaultB45Alph],
+            },
+        ],
+    },
+    {
+        name: "From Base45: Invalid character",
+        input: "!",
+        expectedOutput: "Character not in alphabet: '!'",
+        recipeConfig: [
+            {
+                op: "From Base45",
+                args: [defaultB45Alph],
+            },
+        ],
+    },
+    {
+        name: "From Base45: Invalid triplet value",
+        input: "ZZZ",
+        expectedOutput: "Triplet too large: 'ZZZ'",
+        recipeConfig: [
+            {
+                op: "From Base45",
+                args: [defaultB45Alph],
+            },
+        ],
+    },
+]);