cyberchef 9.48.0 → 9.49.0

package/CHANGELOG.md

@@ -13,6 +13,9 @@ All major and minor version changes will be documented in this file. Details of
 
 ## Details
 
+### [9.49.0] - 2022-11-11
+- Added 'LZ4 Compress' and 'LZ4 Decompress' operations [@n1474335] | [31a7f83]
+
 ### [9.48.0] - 2022-10-14
 - Added 'LM Hash' and 'NT Hash' operations [@n1474335] [@brun0ne] | [#1427]
 
@@ -321,6 +324,7 @@ All major and minor version changes will be documented in this file. Details of
 
 
 
+[9.49.0]: https://github.com/gchq/CyberChef/releases/tag/v9.49.0
 [9.48.0]: https://github.com/gchq/CyberChef/releases/tag/v9.48.0
 [9.47.0]: https://github.com/gchq/CyberChef/releases/tag/v9.47.0
 [9.46.0]: https://github.com/gchq/CyberChef/releases/tag/v9.46.0
@@ -466,6 +470,7 @@ All major and minor version changes will be documented in this file. Details of
 [e9ca4dc]: https://github.com/gchq/CyberChef/commit/e9ca4dc9caf98f33fd986431cd400c88082a42b8
 [dd18e52]: https://github.com/gchq/CyberChef/commit/dd18e529939078b89867297b181a584e8b2cc7da
 [a895d1d]: https://github.com/gchq/CyberChef/commit/a895d1d82a2f92d440a0c5eca2bc7c898107b737
+[31a7f83]: https://github.com/gchq/CyberChef/commit/31a7f83b82e78927f89689f323fcb9185144d6ff
 
 [#95]: https://github.com/gchq/CyberChef/pull/299
 [#173]: https://github.com/gchq/CyberChef/pull/173

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyberchef",
-  "version": "9.48.0",
+  "version": "9.49.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",
@@ -134,6 +134,7 @@
     "loglevel": "^1.8.0",
     "loglevel-message-prefix": "^3.0.0",
     "lz-string": "^1.4.4",
+    "lz4js": "^0.2.0",
     "markdown-it": "^13.0.1",
     "moment": "^2.29.3",
     "moment-timezone": "^0.5.34",

package/src/core/config/Categories.json

@@ -333,7 +333,9 @@
             "LZString Decompress",
             "LZString Compress",
             "LZMA Decompress",
-            "LZMA Compress"
+            "LZMA Compress",
+            "LZ4 Decompress",
+            "LZ4 Compress"
         ]
     },
     {

package/src/core/config/OperationConfig.json

@@ -8067,6 +8067,26 @@
             }
         ]
     },
+    "LZ4 Compress": {
+        "module": "Compression",
+        "description": "LZ4 is a lossless data compression algorithm that is focused on compression and decompression speed. It belongs to the LZ77 family of byte-oriented compression schemes.",
+        "infoURL": "https://wikipedia.org/wiki/LZ4_(compression_algorithm)",
+        "inputType": "ArrayBuffer",
+        "outputType": "ArrayBuffer",
+        "flowControl": false,
+        "manualBake": false,
+        "args": []
+    },
+    "LZ4 Decompress": {
+        "module": "Compression",
+        "description": "LZ4 is a lossless data compression algorithm that is focused on compression and decompression speed. It belongs to the LZ77 family of byte-oriented compression schemes.",
+        "infoURL": "https://wikipedia.org/wiki/LZ4_(compression_algorithm)",
+        "inputType": "ArrayBuffer",
+        "outputType": "ArrayBuffer",
+        "flowControl": false,
+        "manualBake": false,
+        "args": []
+    },
     "LZMA Compress": {
         "module": "Compression",
         "description": "Compresses data using the Lempel–Ziv–Markov chain algorithm. Compression mode determines the speed and effectiveness of the compression: 1 is fastest and less effective, 9 is slowest and most effective",

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

@@ -9,6 +9,8 @@ import Bzip2Compress from "../../operations/Bzip2Compress.mjs";
 import Bzip2Decompress from "../../operations/Bzip2Decompress.mjs";
 import Gunzip from "../../operations/Gunzip.mjs";
 import Gzip from "../../operations/Gzip.mjs";
+import LZ4Compress from "../../operations/LZ4Compress.mjs";
+import LZ4Decompress from "../../operations/LZ4Decompress.mjs";
 import LZMACompress from "../../operations/LZMACompress.mjs";
 import LZMADecompress from "../../operations/LZMADecompress.mjs";
 import LZStringCompress from "../../operations/LZStringCompress.mjs";
@@ -29,6 +31,8 @@ OpModules.Compression = {
     "Bzip2 Decompress": Bzip2Decompress,
     "Gunzip": Gunzip,
     "Gzip": Gzip,
+    "LZ4 Compress": LZ4Compress,
+    "LZ4 Decompress": LZ4Decompress,
     "LZMA Compress": LZMACompress,
     "LZMA Decompress": LZMADecompress,
     "LZString Compress": LZStringCompress,

package/src/core/operations/LZ4Compress.mjs

@@ -0,0 +1,43 @@
+/**
+ * @author n1474335 [n1474335@gmail.com]
+ * @copyright Crown Copyright 2022
+ * @license Apache-2.0
+ */
+
+import Operation from "../Operation.mjs";
+import lz4 from "lz4js";
+
+/**
+ * LZ4 Compress operation
+ */
+class LZ4Compress extends Operation {
+
+    /**
+     * LZ4Compress constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "LZ4 Compress";
+        this.module = "Compression";
+        this.description = "LZ4 is a lossless data compression algorithm that is focused on compression and decompression speed. It belongs to the LZ77 family of byte-oriented compression schemes.";
+        this.infoURL = "https://wikipedia.org/wiki/LZ4_(compression_algorithm)";
+        this.inputType = "ArrayBuffer";
+        this.outputType = "ArrayBuffer";
+        this.args = [];
+    }
+
+    /**
+     * @param {ArrayBuffer} input
+     * @param {Object[]} args
+     * @returns {ArrayBuffer}
+     */
+    run(input, args) {
+        const inBuf = new Uint8Array(input);
+        const compressed = lz4.compress(inBuf);
+        return compressed.buffer;
+    }
+
+}
+
+export default LZ4Compress;

package/src/core/operations/LZ4Decompress.mjs

@@ -0,0 +1,43 @@
+/**
+ * @author n1474335 [n1474335@gmail.com]
+ * @copyright Crown Copyright 2022
+ * @license Apache-2.0
+ */
+
+import Operation from "../Operation.mjs";
+import lz4 from "lz4js";
+
+/**
+ * LZ4 Decompress operation
+ */
+class LZ4Decompress extends Operation {
+
+    /**
+     * LZ4Decompress constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "LZ4 Decompress";
+        this.module = "Compression";
+        this.description = "LZ4 is a lossless data compression algorithm that is focused on compression and decompression speed. It belongs to the LZ77 family of byte-oriented compression schemes.";
+        this.infoURL = "https://wikipedia.org/wiki/LZ4_(compression_algorithm)";
+        this.inputType = "ArrayBuffer";
+        this.outputType = "ArrayBuffer";
+        this.args = [];
+    }
+
+    /**
+     * @param {ArrayBuffer} input
+     * @param {Object[]} args
+     * @returns {ArrayBuffer}
+     */
+    run(input, args) {
+        const inBuf = new Uint8Array(input);
+        const decompressed = lz4.decompress(inBuf);
+        return decompressed.buffer;
+    }
+
+}
+
+export default LZ4Decompress;

package/src/core/operations/index.mjs

@@ -197,6 +197,8 @@ import Keccak from "./Keccak.mjs";
 import LMHash from "./LMHash.mjs";
 import LS47Decrypt from "./LS47Decrypt.mjs";
 import LS47Encrypt from "./LS47Encrypt.mjs";
+import LZ4Compress from "./LZ4Compress.mjs";
+import LZ4Decompress from "./LZ4Decompress.mjs";
 import LZMACompress from "./LZMACompress.mjs";
 import LZMADecompress from "./LZMADecompress.mjs";
 import LZStringCompress from "./LZStringCompress.mjs";
@@ -586,6 +588,8 @@ export {
     LMHash,
     LS47Decrypt,
     LS47Encrypt,
+    LZ4Compress,
+    LZ4Decompress,
     LZMACompress,
     LZMADecompress,
     LZStringCompress,

package/src/node/index.mjs

@@ -200,6 +200,8 @@ import {
     LMHash as core_LMHash,
     LS47Decrypt as core_LS47Decrypt,
     LS47Encrypt as core_LS47Encrypt,
+    LZ4Compress as core_LZ4Compress,
+    LZ4Decompress as core_LZ4Decompress,
     LZMACompress as core_LZMACompress,
     LZMADecompress as core_LZMADecompress,
     LZStringCompress as core_LZStringCompress,
@@ -589,6 +591,8 @@ function generateChef() {
         "LMHash": _wrap(core_LMHash),
         "LS47Decrypt": _wrap(core_LS47Decrypt),
         "LS47Encrypt": _wrap(core_LS47Encrypt),
+        "LZ4Compress": _wrap(core_LZ4Compress),
+        "LZ4Decompress": _wrap(core_LZ4Decompress),
         "LZMACompress": _wrap(core_LZMACompress),
         "LZMADecompress": _wrap(core_LZMADecompress),
         "LZStringCompress": _wrap(core_LZStringCompress),
@@ -993,6 +997,8 @@ const keccak = chef.keccak;
 const LMHash = chef.LMHash;
 const LS47Decrypt = chef.LS47Decrypt;
 const LS47Encrypt = chef.LS47Encrypt;
+const LZ4Compress = chef.LZ4Compress;
+const LZ4Decompress = chef.LZ4Decompress;
 const LZMACompress = chef.LZMACompress;
 const LZMADecompress = chef.LZMADecompress;
 const LZStringCompress = chef.LZStringCompress;
@@ -1384,6 +1390,8 @@ const operations = [
     LMHash,
     LS47Decrypt,
     LS47Encrypt,
+    LZ4Compress,
+    LZ4Decompress,
     LZMACompress,
     LZMADecompress,
     LZStringCompress,
@@ -1779,6 +1787,8 @@ export {
     LMHash,
     LS47Decrypt,
     LS47Encrypt,
+    LZ4Compress,
+    LZ4Decompress,
     LZMACompress,
     LZMADecompress,
     LZStringCompress,

package/tests/operations/tests/Compress.mjs

@@ -75,4 +75,34 @@ TestRegister.addTests([
             }
         ],
     },
+    {
+        name: "LZ4 Compress",
+        input: "The cat sat on the mat.",
+        expectedOutput: "04224d184070df170000805468652063617420736174206f6e20746865206d61742e00000000",
+        recipeConfig: [
+            {
+                "op": "LZ4 Compress",
+                "args": []
+            },
+            {
+                "op": "To Hex",
+                "args": ["None", 0]
+            }
+        ],
+    },
+    {
+        name: "LZ4 Decompress",
+        input: "04224d184070df170000805468652063617420736174206f6e20746865206d61742e00000000",
+        expectedOutput: "The cat sat on the mat.",
+        recipeConfig: [
+            {
+                "op": "From Hex",
+                "args": ["None"]
+            },
+            {
+                "op": "LZ4 Decompress",
+                "args": []
+            }
+        ],
+    },
 ]);