cyberchef 11.0.0 → 11.1.0

package/src/core/config/OperationConfig.json

@@ -144,6 +144,11 @@
                     "Base64"
                 ]
             },
+            {
+                "name": "IV Length",
+                "type": "number",
+                "value": 16
+            },
             {
                 "name": "Mode",
                 "type": "argSelector",
@@ -151,57 +156,57 @@
                     {
                         "name": "CBC",
                         "off": [
-                            5,
-                            6
+                            6,
+                            7
                         ]
                     },
                     {
                         "name": "CFB",
                         "off": [
-                            5,
-                            6
+                            6,
+                            7
                         ]
                     },
                     {
                         "name": "OFB",
                         "off": [
-                            5,
-                            6
+                            6,
+                            7
                         ]
                     },
                     {
                         "name": "CTR",
                         "off": [
-                            5,
-                            6
+                            6,
+                            7
                         ]
                     },
                     {
                         "name": "GCM",
                         "on": [
-                            5,
-                            6
+                            6,
+                            7
                         ]
                     },
                     {
                         "name": "ECB",
                         "off": [
-                            5,
-                            6
+                            6,
+                            7
                         ]
                     },
                     {
                         "name": "CBC/NoPadding",
                         "off": [
-                            5,
-                            6
+                            6,
+                            7
                         ]
                     },
                     {
                         "name": "ECB/NoPadding",
                         "off": [
-                            5,
-                            6
+                            6,
+                            7
                         ]
                     }
                 ]
@@ -243,6 +248,39 @@
                     "Latin1",
                     "Base64"
                 ]
+            },
+            {
+                "name": "IV from input",
+                "type": "argSelector",
+                "value": [
+                    {
+                        "name": "Off",
+                        "on": [
+                            1
+                        ],
+                        "off": [
+                            2
+                        ]
+                    },
+                    {
+                        "name": "From start",
+                        "on": [
+                            2
+                        ],
+                        "off": [
+                            1
+                        ]
+                    },
+                    {
+                        "name": "From end",
+                        "on": [
+                            2
+                        ],
+                        "off": [
+                            1
+                        ]
+                    }
+                ]
             }
         ]
     },
@@ -357,6 +395,15 @@
                     "Latin1",
                     "Base64"
                 ]
+            },
+            {
+                "name": "Include IV in output",
+                "type": "option",
+                "value": [
+                    "Off",
+                    "Prepend",
+                    "Append"
+                ]
             }
         ]
     },
@@ -7552,6 +7599,26 @@
             }
         ]
     },
+    "Escape Smart Characters": {
+        "module": "Default",
+        "description": "Converts smart (typographic) Unicode characters — e.g. smart quotes, em/en dashes, ellipses, ©, ®, ™, arrows — into their plain ASCII equivalents.<br><br>Characters with no ASCII mapping (e.g. <code>☣</code>) are handled according to the 'Unmappable characters' option.<br><br>e.g. <code>“Hello” — world…</code> becomes <code>\"Hello\" -- world...</code>",
+        "infoURL": "",
+        "inputType": "string",
+        "outputType": "string",
+        "flowControl": false,
+        "manualBake": false,
+        "args": [
+            {
+                "name": "Unmappable characters",
+                "type": "option",
+                "value": [
+                    "Include",
+                    "Remove",
+                    "Replace with '.'"
+                ]
+            }
+        ]
+    },
     "Escape string": {
         "module": "Default",
         "description": "Escapes special characters in a string so that they do not cause conflicts. For example, <code>Don't stop me now</code> becomes <code>Don\\'t stop me now</code>.<br><br>Supports the following escape sequences:<ul><li><code>\\n</code> (Line feed/newline)</li><li><code>\\r</code> (Carriage return)</li><li><code>\\t</code> (Horizontal tab)</li><li><code>\\b</code> (Backspace)</li><li><code>\\f</code> (Form feed)</li><li><code>\\xnn</code> (Hex, where n is 0-f)</li><li><code>\\\\</code> (Backslash)</li><li><code>\\'</code> (Single quote)</li><li><code>\\&quot;</code> (Double quote)</li><li><code>\\unnnn</code> (Unicode character)</li><li><code>\\u{nnnnnn}</code> (Unicode code point)</li></ul>",
@@ -13143,6 +13210,27 @@
             }
         ]
     },
+    "PGP Sign": {
+        "module": "PGP",
+        "description": "Input: the message you want to sign\n<br><br>\nArguments: the ASCII-armoured PGP private key of the sender.\n<br><br>\nPretty Good Privacy is an encryption standard (OpenPGP) used for encrypting, decrypting, and signing messages.\n<br><br>\nThis function uses the Keybase implementation of PGP.",
+        "infoURL": "https://wikipedia.org/wiki/Pretty_Good_Privacy",
+        "inputType": "string",
+        "outputType": "string",
+        "flowControl": false,
+        "manualBake": false,
+        "args": [
+            {
+                "name": "Private key of signer",
+                "type": "text",
+                "value": ""
+            },
+            {
+                "name": "Private key passphrase (optional)",
+                "type": "string",
+                "value": ""
+            }
+        ]
+    },
     "PGP Verify": {
         "module": "PGP",
         "description": "Input: the ASCII-armoured encrypted PGP message you want to verify.\n<br><br>\nArgument: the ASCII-armoured PGP public key of the signer\n<br><br>\nThis operation uses PGP to decrypt a clearsigned message.\n<br><br>\nPretty Good Privacy is an encryption standard (OpenPGP) used for encrypting, decrypting, and signing messages.\n<br><br>\nThis function uses the Keybase implementation of PGP.",
@@ -14918,6 +15006,16 @@
             }
         ]
     },
+    "ROR13": {
+        "module": "Default",
+        "description": "Computes a ROR13 hash used in API hashing techniques.",
+        "infoURL": "",
+        "inputType": "byteArray",
+        "outputType": "string",
+        "flowControl": false,
+        "manualBake": false,
+        "args": []
+    },
     "ROT13": {
         "module": "Default",
         "description": "A simple caesar substitution cipher which rotates alphabet characters by the specified amount (default 13).",
@@ -15574,6 +15672,16 @@
             }
         ]
     },
+    "Remove ANSI Escape Codes": {
+        "module": "Default",
+        "description": "Removes ANSI Escape Codes.",
+        "infoURL": "https://wikipedia.org/wiki/ANSI_escape_code",
+        "inputType": "string",
+        "outputType": "string",
+        "flowControl": false,
+        "manualBake": false,
+        "args": []
+    },
     "Remove Diacritics": {
         "module": "Default",
         "description": "Replaces accented characters with their latin character equivalent. Accented characters are made up of Unicode combining characters, so unicode text formatting such as strikethroughs and underlines will also be removed.",
@@ -21895,6 +22003,22 @@
             }
         ]
     },
+    "Wrap": {
+        "module": "Default",
+        "description": "Wraps the input text at a specified number of characters per line.",
+        "infoURL": null,
+        "inputType": "string",
+        "outputType": "string",
+        "flowControl": false,
+        "manualBake": false,
+        "args": [
+            {
+                "name": "Line Width",
+                "type": "number",
+                "value": 64
+            }
+        ]
+    },
     "XKCD Random Number": {
         "module": "Default",
         "description": "RFC 1149.5 specifies 4 as the standard IEEE-vetted random number.",

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

@@ -41,6 +41,7 @@ import DropBytes from "../../operations/DropBytes.mjs";
 import DropNthBytes from "../../operations/DropNthBytes.mjs";
 import ELFInfo from "../../operations/ELFInfo.mjs";
 import EncodeNetBIOSName from "../../operations/EncodeNetBIOSName.mjs";
+import EscapeSmartCharacters from "../../operations/EscapeSmartCharacters.mjs";
 import EscapeString from "../../operations/EscapeString.mjs";
 import EscapeUnicodeCharacters from "../../operations/EscapeUnicodeCharacters.mjs";
 import ExpandAlphabetRange from "../../operations/ExpandAlphabetRange.mjs";
@@ -131,11 +132,13 @@ import ParseUNIXFilePermissions from "../../operations/ParseUNIXFilePermissions.
 import PlayMedia from "../../operations/PlayMedia.mjs";
 import PowerSet from "../../operations/PowerSet.mjs";
 import RAKE from "../../operations/RAKE.mjs";
+import ROR13 from "../../operations/ROR13.mjs";
 import ROT13 from "../../operations/ROT13.mjs";
 import ROT13BruteForce from "../../operations/ROT13BruteForce.mjs";
 import ROT47 from "../../operations/ROT47.mjs";
 import ROT47BruteForce from "../../operations/ROT47BruteForce.mjs";
 import ROT8000 from "../../operations/ROT8000.mjs";
+import RemoveANSIEscapeCodes from "../../operations/RemoveANSIEscapeCodes.mjs";
 import RemoveDiacritics from "../../operations/RemoveDiacritics.mjs";
 import RemoveLineNumbers from "../../operations/RemoveLineNumbers.mjs";
 import RemoveNullBytes from "../../operations/RemoveNullBytes.mjs";
@@ -207,6 +210,7 @@ import Unique from "../../operations/Unique.mjs";
 import VarIntDecode from "../../operations/VarIntDecode.mjs";
 import VarIntEncode from "../../operations/VarIntEncode.mjs";
 import WindowsFiletimeToUNIXTimestamp from "../../operations/WindowsFiletimeToUNIXTimestamp.mjs";
+import Wrap from "../../operations/Wrap.mjs";
 import XKCDRandomNumber from "../../operations/XKCDRandomNumber.mjs";
 import XOR from "../../operations/XOR.mjs";
 import XORBruteForce from "../../operations/XORBruteForce.mjs";
@@ -251,6 +255,7 @@ OpModules.Default = {
     "Drop nth bytes": DropNthBytes,
     "ELF Info": ELFInfo,
     "Encode NetBIOS Name": EncodeNetBIOSName,
+    "Escape Smart Characters": EscapeSmartCharacters,
     "Escape string": EscapeString,
     "Escape Unicode Characters": EscapeUnicodeCharacters,
     "Expand alphabet range": ExpandAlphabetRange,
@@ -341,11 +346,13 @@ OpModules.Default = {
     "Play Media": PlayMedia,
     "Power Set": PowerSet,
     "RAKE": RAKE,
+    "ROR13": ROR13,
     "ROT13": ROT13,
     "ROT13 Brute Force": ROT13BruteForce,
     "ROT47": ROT47,
     "ROT47 Brute Force": ROT47BruteForce,
     "ROT8000": ROT8000,
+    "Remove ANSI Escape Codes": RemoveANSIEscapeCodes,
     "Remove Diacritics": RemoveDiacritics,
     "Remove line numbers": RemoveLineNumbers,
     "Remove null bytes": RemoveNullBytes,
@@ -417,6 +424,7 @@ OpModules.Default = {
     "VarInt Decode": VarIntDecode,
     "VarInt Encode": VarIntEncode,
     "Windows Filetime to UNIX Timestamp": WindowsFiletimeToUNIXTimestamp,
+    "Wrap": Wrap,
     "XKCD Random Number": XKCDRandomNumber,
     "XOR": XOR,
     "XOR Brute Force": XORBruteForce,

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

@@ -10,6 +10,7 @@ import PGPDecrypt from "../../operations/PGPDecrypt.mjs";
 import PGPDecryptAndVerify from "../../operations/PGPDecryptAndVerify.mjs";
 import PGPEncrypt from "../../operations/PGPEncrypt.mjs";
 import PGPEncryptAndSign from "../../operations/PGPEncryptAndSign.mjs";
+import PGPSign from "../../operations/PGPSign.mjs";
 import PGPVerify from "../../operations/PGPVerify.mjs";
 
 const OpModules = typeof self === "undefined" ? {} : self.OpModules || {};
@@ -20,6 +21,7 @@ OpModules.PGP = {
     "PGP Decrypt and Verify": PGPDecryptAndVerify,
     "PGP Encrypt": PGPEncrypt,
     "PGP Encrypt and Sign": PGPEncryptAndSign,
+    "PGP Sign": PGPSign,
     "PGP Verify": PGPVerify,
 };
 

package/src/core/config/scripts/generateOpsIndex.mjs

@@ -58,3 +58,66 @@ fs.writeFileSync(
     code
 );
 console.log("Written operation index.");
+
+// find all test files
+const testsDir = path.join(process.cwd() + "/tests/operations/tests/");
+const testObjs = [];
+fs.readdirSync(testsDir).forEach(file => {
+    if (!file.endsWith(".mjs")) return;
+    testObjs.push(file.split(".mjs")[0]);
+});
+
+// Construct test index file
+code = `/**
+* THIS FILE IS AUTOMATICALLY GENERATED BY src/core/config/scripts/generateOpsIndex.mjs
+*
+* @author john [john19696@protonmail.com]
+* @author tlwr [toby@toby.codes]
+* @author n1474335 [n1474335@gmail.com]
+* @copyright Crown Copyright ${new Date().getUTCFullYear()}
+* @license Apache-2.0
+*/
+
+import {
+    setLongTestFailure,
+    logTestReport,
+} from "../lib/utils.mjs";
+
+import "../lib/wasmFetchPolyfill.mjs";
+
+import TestRegister from "../lib/TestRegister.mjs";
+`;
+
+testObjs.forEach(obj => {
+    if (obj !== "SplitColourChannels")
+        code += `import "./tests/${obj}.mjs";\n`;
+    else
+        code += `// Cannot test operations that use the File type yet
+// import "./tests/SplitColourChannels.mjs";\n`;
+});
+
+code += `
+
+const testStatus = {
+    allTestsPassing: true,
+    counts: {
+        total: 0,
+    }
+};
+
+setLongTestFailure();
+
+const logOpsTestReport = logTestReport.bind(null, testStatus);
+
+(async function() {
+    const results = await TestRegister.runTests();
+    logOpsTestReport(results);
+})();
+`;
+
+// Write tests file
+fs.writeFileSync(
+    path.join(testsDir, "../index.mjs"),
+    code
+);
+console.log("Written operation tests index.");

package/src/core/config/scripts/newOperation.mjs

@@ -23,7 +23,7 @@ if (!fs.existsSync(dir)) {
     console.log("Example> node --experimental-modules src/core/config/scripts/newOperation.mjs");
     process.exit(1);
 }
-
+const testDir = path.join(process.cwd() + "/tests/operations/tests/");
 const ioTypes = ["string", "byteArray", "number", "html", "ArrayBuffer", "BigNumber", "JSON", "File", "List<File>"];
 
 const schema = {
@@ -123,6 +123,30 @@ prompt.get(schema, (err, result) => {
         return txt.charAt(0).toUpperCase() + txt.substr(1);
     }).replace(/[\s-()./]/g, "");
 
+    const testTemplate = `/**
+* ${moduleName} tests
+*
+* @author ${result.authorName} [${result.authorEmail}]
+* @copyright Crown Copyright ${(new Date()).getFullYear()}
+* @license Apache-2.0
+*/
+
+import TestRegister from "../../lib/TestRegister.mjs";
+
+TestRegister.addTests([
+    {
+        name: "${result.opName}: test",
+        input: "Example input",
+        expectedOutput: "Expected output",
+        recipeConfig: [
+            {
+                op: "${result.opName}",
+                args: [],
+            },
+        ],
+    },
+]);
+`;
 
     const template = `/**
  * @author ${result.authorName} [${result.authorEmail}]
@@ -218,13 +242,16 @@ export default ${moduleName};
     }
     fs.writeFileSync(filename, template);
 
+    const testFilename = path.join(testDir, `./${moduleName}.mjs`);
+    fs.writeFileSync(testFilename, testTemplate);
+
     console.log(`\nOperation template written to ${colors.green(filename)}`);
+    console.log(`\nOperation test template written to ${colors.green(testFilename)}`);
     console.log(`\nNext steps:
 1. Add your operation to ${colors.green("src/core/config/Categories.json")}
-2. Write your operation code.
-3. Write tests in ${colors.green("tests/operations/tests/")}
+2. Write your operation code in ${colors.green(filename)}
+3. Write your operation test code in ${colors.green(testFilename)}
 4. Run ${colors.cyan("npm run lint")} and ${colors.cyan("npm run test")}
 5. Submit a Pull Request to get your operation added to the official CyberChef repository.`);
 
 });
-

package/src/core/operations/AESDecrypt.mjs

@@ -39,41 +39,46 @@ class AESDecrypt extends Operation {
                 "value": "",
                 "toggleValues": ["Hex", "UTF8", "Latin1", "Base64"]
             },
+            {
+                "name": "IV Length",
+                "type": "number",
+                "value": 16
+            },
             {
                 "name": "Mode",
                 "type": "argSelector",
                 "value": [
                     {
                         name: "CBC",
-                        off: [5, 6]
+                        off: [6, 7]
                     },
                     {
                         name: "CFB",
-                        off: [5, 6]
+                        off: [6, 7]
                     },
                     {
                         name: "OFB",
-                        off: [5, 6]
+                        off: [6, 7]
                     },
                     {
                         name: "CTR",
-                        off: [5, 6]
+                        off: [6, 7]
                     },
                     {
                         name: "GCM",
-                        on: [5, 6]
+                        on: [6, 7]
                     },
                     {
                         name: "ECB",
-                        off: [5, 6]
+                        off: [6, 7]
                     },
                     {
                         name: "CBC/NoPadding",
-                        off: [5, 6]
+                        off: [6, 7]
                     },
                     {
                         name: "ECB/NoPadding",
-                        off: [5, 6]
+                        off: [6, 7]
                     }
                 ]
             },
@@ -98,6 +103,26 @@ class AESDecrypt extends Operation {
                 "type": "toggleString",
                 "value": "",
                 "toggleValues": ["Hex", "UTF8", "Latin1", "Base64"]
+            },
+            {
+                "name": "IV from input",
+                "type": "argSelector",
+                "value": [
+                    {
+                        name: "Off",
+                        on: [1],
+                        off: [2]
+                    },
+                    {
+                        name: "From start",
+                        on: [2],
+                        off: [1]
+                    }, {
+                        name: "From end",
+                        on: [2],
+                        off: [1]
+                    }
+                ]
             }
         ];
     }
@@ -110,14 +135,18 @@ class AESDecrypt extends Operation {
      * @throws {OperationError} if cannot decrypt input or invalid key length
      */
     run(input, args) {
+        let iv;
+
         const key = Utils.convertToByteString(args[0].string, args[0].option),
-            iv = Utils.convertToByteString(args[1].string, args[1].option),
-            mode = args[2].split("/")[0],
-            noPadding = args[2].endsWith("NoPadding"),
-            inputType = args[3],
-            outputType = args[4],
-            gcmTag = Utils.convertToByteString(args[5].string, args[5].option),
-            aad = Utils.convertToByteString(args[6].string, args[6].option);
+            ivLength = args[2],
+            mode = args[3].split("/")[0],
+            noPadding = args[3].endsWith("NoPadding"),
+            inputType = args[4],
+            outputType = args[5],
+            gcmTag = Utils.convertToByteString(args[6].string, args[6].option),
+            aad = Utils.convertToByteString(args[7].string, args[7].option),
+            ivFromInput = args[8];
+
 
         if ([16, 24, 32].indexOf(key.length) < 0) {
             throw new OperationError(`Invalid key length: ${key.length} bytes
@@ -130,11 +159,27 @@ The following algorithms will be used based on the size of the key:
 
         input = Utils.convertToByteString(input, inputType);
 
+        if (ivFromInput !== "Off") {
+            if (input.length <= ivLength) {
+                throw new OperationError(`Input is too short to contain an IV of ${ivLength} bytes.`);
+            }
+
+            if (ivFromInput === "From start") {
+                iv = input.substr(0, ivLength);
+                input = input.substr(ivLength);
+            } else {
+                iv = input.substr(input.length - ivLength);
+                input = input.substr(0, input.length - ivLength);
+            }
+        } else {
+            iv = Utils.convertToByteString(args[1].string, args[1].option);
+        }
+
         const decipher = forge.cipher.createDecipher("AES-" + mode, key);
 
         /* Allow for a "no padding" mode */
         if (noPadding) {
-            decipher.mode.unpad = function(output, options) {
+            decipher.mode.unpad = function (output, options) {
                 return true;
             };
         }

package/src/core/operations/AESEncrypt.mjs

@@ -8,6 +8,7 @@ import Operation from "../Operation.mjs";
 import Utils from "../Utils.mjs";
 import forge from "node-forge";
 import OperationError from "../errors/OperationError.mjs";
+import { toHexFast } from "../lib/Hex.mjs";
 
 /**
  * AES Encrypt operation
@@ -92,6 +93,11 @@ class AESEncrypt extends Operation {
                 "type": "toggleString",
                 "value": "",
                 "toggleValues": ["Hex", "UTF8", "Latin1", "Base64"]
+            },
+            {
+                "name": "Include IV in output",
+                "type": "option",
+                "value": ["Off", "Prepend", "Append"]
             }
         ];
     }
@@ -107,10 +113,11 @@ class AESEncrypt extends Operation {
         const key = Utils.convertToByteString(args[0].string, args[0].option),
             iv = Utils.convertToByteString(args[1].string, args[1].option),
             mode = args[2].split("/")[0],
-            noPadding =  args[2].endsWith("NoPadding"),
+            noPadding = args[2].endsWith("NoPadding"),
             inputType = args[3],
             outputType = args[4],
-            aad = Utils.convertToByteString(args[5].string, args[5].option);
+            aad = Utils.convertToByteString(args[5].string, args[5].option),
+            includeIV = args[6];
 
         if ([16, 24, 32].indexOf(key.length) < 0) {
             throw new OperationError(`Invalid key length: ${key.length} bytes
@@ -133,26 +140,34 @@ The following algorithms will be used based on the size of the key:
             additionalData: mode === "GCM" ? aad : undefined
         });
         if (noPadding) {
-            cipher.mode.pad = function(output, options) {
+            cipher.mode.pad = function (output, options) {
                 return true;
             };
         }
         cipher.update(forge.util.createBuffer(input));
         cipher.finish();
 
+        let output = cipher.output.getBytes();
+
+        if (includeIV === "Prepend") {
+            output = iv + output;
+        } else if (includeIV === "Append") {
+            output = output + iv;
+        }
+
         if (outputType === "Hex") {
+            output = toHexFast(Utils.strToByteArray(output));
+
             if (mode === "GCM") {
-                return cipher.output.toHex() + "\n\n" +
+                return output + "\n\n" +
                     "Tag: " + cipher.mode.tag.toHex();
             }
-            return cipher.output.toHex();
-        } else {
-            if (mode === "GCM") {
-                return cipher.output.getBytes() + "\n\n" +
-                    "Tag: " + cipher.mode.tag.getBytes();
-            }
-            return cipher.output.getBytes();
+        } else if (mode === "GCM") {
+            return output + "\n\n" +
+                "Tag: " + cipher.mode.tag.getBytes();
         }
+
+        return output;
     }
 
 }