cyberchef 9.38.0 → 9.38.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyberchef",
-  "version": "9.38.0",
+  "version": "9.38.1",
   "description": "The Cyber Swiss Army Knife for encryption, encoding, compression and data analysis.",
   "author": "n1474335 <n1474335@gmail.com>",
   "homepage": "https://gchq.github.io/CyberChef",
@@ -69,6 +69,7 @@
     "html-webpack-plugin": "^5.5.0",
     "imports-loader": "^3.1.1",
     "mini-css-extract-plugin": "2.6.0",
+    "modify-source-webpack-plugin": "^3.0.0",
     "nightwatch": "^2.0.10",
     "postcss": "^8.4.12",
     "postcss-css-variables": "^0.18.0",
@@ -174,6 +175,7 @@
     "lint": "npx grunt lint",
     "postinstall": "npx grunt exec:fixCryptoApiImports",
     "newop": "node --experimental-modules --experimental-json-modules src/core/config/scripts/newOperation.mjs",
+    "minor": "node --experimental-modules --experimental-json-modules src/core/config/scripts/newMinorVersion.mjs",
     "getheapsize": "node -e 'console.log(`node heap limit = ${require(\"v8\").getHeapStatistics().heap_size_limit / (1024 * 1024)} Mb`)'",
     "setheapsize": "export NODE_OPTIONS=--max_old_space_size=2048"
   }

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

@@ -0,0 +1,144 @@
+/**
+ * This script updates the CHANGELOG when a new minor version is created.
+ *
+ * @author n1474335 [n1474335@gmail.com]
+ * @copyright Crown Copyright 2022
+ * @license Apache-2.0
+ */
+
+/* eslint no-console: ["off"] */
+
+import prompt from "prompt";
+import colors from "colors";
+import path from "path";
+import fs  from "fs";
+import process from "process";
+
+const dir = path.join(process.cwd() + "/src/core/config/");
+if (!fs.existsSync(dir)) {
+    console.log("\nCWD: " + process.cwd());
+    console.log("Error: newMinorVersion.mjs should be run from the project root");
+    console.log("Example> node --experimental-modules src/core/config/scripts/newMinorVersion.mjs");
+    process.exit(1);
+}
+
+let changelogData = fs.readFileSync(path.join(process.cwd(), "CHANGELOG.md"), "utf8");
+const lastVersion = changelogData.match(/## Details\s+### \[(\d+)\.(\d+)\.(\d+)\]/);
+const newVersion = [
+    parseInt(lastVersion[1], 10),
+    parseInt(lastVersion[2], 10) + 1,
+    0
+];
+
+let knownContributors = changelogData.match(/^\[@([^\]]+)\]/gm);
+knownContributors = knownContributors.map(c => c.slice(2, -1));
+
+const date = (new Date()).toISOString().split("T")[0];
+
+const schema = {
+    properties: {
+        message: {
+            description: "A short but descriptive summary of a feature in this version",
+            example: "Added 'Op name' operation",
+            prompt: "Feature description",
+            type: "string",
+            required: true,
+        },
+        author: {
+            description: "The author of the feature (only one supported, edit manually to add more)",
+            example: "n1474335",
+            prompt: "Author",
+            type: "string",
+            default: "n1474335"
+        },
+        id: {
+            description: "The PR number or full commit hash for this feature.",
+            example: "1200",
+            prompt: "Pull request or commit ID",
+            type: "string"
+        },
+        another: {
+            description: "y/n",
+            example: "y",
+            prompt: "Add another feature?",
+            type: "string",
+            pattern: /^[yn]$/,
+        }
+    }
+};
+
+// Build schema
+for (const prop in schema.properties) {
+    const p = schema.properties[prop];
+    p.description = "\n" + colors.white(p.description) + colors.cyan("\nExample: " + p.example) + "\n" + colors.green(p.prompt);
+}
+
+prompt.message = "";
+prompt.delimiter = ":".green;
+
+const features = [];
+const authors = [];
+const prIDs = [];
+const commitIDs = [];
+
+prompt.start();
+
+const getFeature = function() {
+    prompt.get(schema, (err, result) => {
+        if (err) {
+            console.log("\nExiting script.");
+            process.exit(0);
+        }
+
+        features.push(result);
+
+        if (result.another === "y") {
+            getFeature();
+        } else {
+            let message = `### [${newVersion[0]}.${newVersion[1]}.${newVersion[2]}] - ${date}\n`;
+
+            features.forEach(feature => {
+                const id = feature.id.length > 10 ? feature.id.slice(0, 7) : "#" + feature.id;
+                message += `- ${feature.message} [@${feature.author}] | [${id}]\n`;
+
+                if (!knownContributors.includes(feature.author)) {
+                    authors.push(`[@${feature.author}]: https://github.com/${feature.author}`);
+                }
+
+                if (feature.id.length > 10) {
+                    commitIDs.push(`[${id}]: https://github.com/gchq/CyberChef/commit/${feature.id}`);
+                } else {
+                    prIDs.push(`[#${feature.id}]: https://github.com/gchq/CyberChef/pull/${feature.id}`);
+                }
+            });
+
+            // Message
+            changelogData = changelogData.replace(/## Details\n\n/, "## Details\n\n" + message + "\n");
+
+            // Tag
+            const newTag = `[${newVersion[0]}.${newVersion[1]}.${newVersion[2]}]: https://github.com/gchq/CyberChef/releases/tag/v${newVersion[0]}.${newVersion[1]}.${newVersion[2]}\n`;
+            changelogData = changelogData.replace(/\n\n(\[\d+\.\d+\.\d+\]: https)/, "\n\n" + newTag + "$1");
+
+            // Author
+            authors.forEach(author => {
+                changelogData = changelogData.replace(/(\n\[@[^\]]+\]: https:\/\/github\.com\/[^\n]+\n)\n/, "$1" + author + "\n\n");
+            });
+
+            // Commit IDs
+            commitIDs.forEach(commitID => {
+                changelogData = changelogData.replace(/(\n\[[^\].]+\]: https:\/\/github.com\/gchq\/CyberChef\/commit\/[^\n]+\n)\n/, "$1" + commitID + "\n\n");
+            });
+
+            // PR IDs
+            prIDs.forEach(prID => {
+                changelogData = changelogData.replace(/(\n\[#[^\]]+\]: https:\/\/github.com\/gchq\/CyberChef\/pull\/[^\n]+\n)\n/, "$1" + prID + "\n\n");
+            });
+
+            fs.writeFileSync(path.join(process.cwd(), "CHANGELOG.md"), changelogData);
+
+            console.log("Written CHANGELOG.md");
+        }
+    });
+};
+
+getFeature();

package/src/core/operations/ToBase45.mjs

@@ -65,6 +65,10 @@ class ToBase45 extends Operation {
 
             if (chars < 2) {
                 res.push("0");
+                chars++;
+            }
+            if (pair.length > 1 && chars < 3) {
+                res.push("0");
             }
         }
 

package/src/core/operations/ToHex.mjs

@@ -67,7 +67,7 @@ class ToHex extends Operation {
      * @returns {Object[]} pos
      */
     highlight(pos, args) {
-        let delim, commaLen;
+        let delim, commaLen = 0;
         if (args[0] === "0x with comma") {
             delim = "0x";
             commaLen = 1;
@@ -86,7 +86,7 @@ class ToHex extends Operation {
         pos[0].start = pos[0].start * (2 + len) + countLF(pos[0].start);
         pos[0].end = pos[0].end * (2 + len) + countLF(pos[0].end);
 
-        // if the deliminators are not prepended, trim the trailing deliminator
+        // if the delimiters are not prepended, trim the trailing delimiter
         if (!(delim === "0x" || delim === "\\x")) {
             pos[0].end -= delim.length;
         }

package/src/web/App.mjs

@@ -57,7 +57,7 @@ class App {
         this.populateOperationsList();
         this.manager.setup();
         this.manager.output.saveBombe();
-        this.resetLayout();
+        this.adjustComponentSizes();
         this.setCompileMessage();
 
         log.debug("App loaded");
@@ -295,9 +295,7 @@ class App {
             gutterSize: 4,
             expandToMin: true,
             onDrag: debounce(function() {
-                this.manager.recipe.adjustWidth();
-                this.manager.input.calcMaxTabs();
-                this.manager.output.calcMaxTabs();
+                this.adjustComponentSizes();
             }, 50, "dragSplitter", this, [])
         });
 
@@ -307,7 +305,7 @@ class App {
             minSize: minimise ? [0, 0] : [100, 100]
         });
 
-        this.resetLayout();
+        this.adjustComponentSizes();
     }
 
 
@@ -581,6 +579,13 @@ class App {
     resetLayout() {
         this.columnSplitter.setSizes([20, 30, 50]);
         this.ioSplitter.setSizes([50, 50]);
+        this.adjustComponentSizes();
+    }
+
+    /**
+     * Adjust components to fit their containers.
+     */
+    adjustComponentSizes() {
         this.manager.recipe.adjustWidth();
         this.manager.input.calcMaxTabs();
         this.manager.output.calcMaxTabs();

package/src/web/html/index.html

@@ -176,7 +176,7 @@
                 <div id="recipe" class="split split-horizontal no-select">
                     <div class="title no-select">
                         Recipe
-                        <span class="float-right">
+                        <span class="pane-controls hide-on-maximised-output">
                             <button type="button" class="btn btn-primary bmd-btn-icon" id="save" data-toggle="tooltip" title="Save recipe">
                                 <i class="material-icons">save</i>
                             </button>
@@ -190,7 +190,7 @@
                     </div>
                     <ul id="rec-list" class="list-area no-select"></ul>
 
-                    <div id="controls" class="no-select">
+                    <div id="controls" class="no-select hide-on-maximised-output">
                         <div id="controls-content" class="d-flex align-items-center">
                             <button type="button" class="mx-2 btn btn-lg btn-secondary" id="step" data-toggle="tooltip" title="Step through the recipe">
                                 Step
@@ -217,7 +217,10 @@
                     <div id="input" class="split no-select">
                         <div class="title no-select">
                             <label for="input-text">Input</label>
-                            <span class="float-right">
+                            <span class="pane-controls">
+                                <div class="io-info" id="input-files-info"></div>
+                                <div class="io-info" id="input-selection-info"></div>
+                                <div class="io-info" id="input-info"></div>
                                 <button type="button" class="btn btn-primary bmd-btn-icon" id="btn-new-tab" data-toggle="tooltip" title="Add a new input tab">
                                     <i class="material-icons">add</i>
                                 </button>
@@ -236,9 +239,7 @@
                                     <i class="material-icons">view_compact</i>
                                 </button>
                             </span>
-                            <div class="io-info" id="input-files-info"></div>
-                            <div class="io-info" id="input-info"></div>
-                            <div class="io-info" id="input-selection-info"></div>
+
                         </div>
                         <div id="input-tabs-wrapper" style="display: none;" class="no-select">
                             <span id="btn-previous-input-tab" class="input-tab-buttons">
@@ -288,7 +289,10 @@
                     <div id="output" class="split">
                         <div class="title no-select">
                             <label for="output-text">Output</label>
-                            <span class="float-right">
+                            <span class="pane-controls">
+                                <div class="io-info" id="bake-info"></div>
+                                <div class="io-info" id="output-selection-info"></div>
+                                <div class="io-info" id="output-info"></div>
                                 <button type="button" class="btn btn-primary bmd-btn-icon" id="save-all-to-file" data-toggle="tooltip" title="Save all outputs to a zip file" style="display: none">
                                         <i class="material-icons">archive</i>
                                     </button>
@@ -308,9 +312,7 @@
                                     <i class="material-icons">fullscreen</i>
                                 </button>
                             </span>
-                            <div class="io-info" id="bake-info"></div>
-                            <div class="io-info" id="output-info"></div>
-                            <div class="io-info" id="output-selection-info"></div>
+
                             <button type="button" class="btn btn-primary bmd-btn-icon hidden" id="magic" data-toggle="tooltip" title="Magic!" data-html="true">
                                 <svg width="22" height="22" viewBox="0 0 24 24">
                                     <path d="M7.5,5.6L5,7L6.4,4.5L5,2L7.5,3.4L10,2L8.6,4.5L10,7L7.5,5.6M19.5,15.4L22,14L20.6,16.5L22,19L19.5,17.6L17,19L18.4,16.5L17,14L19.5,15.4M22,2L20.6,4.5L22,7L19.5,5.6L17,7L18.4,4.5L17,2L19.5,3.4L22,2M13.34,12.78L15.78,10.34L13.66,8.22L11.22,10.66L13.34,12.78M14.37,7.29L16.71,9.63C17.1,10 17.1,10.65 16.71,11.04L5.04,22.71C4.65,23.1 4,23.1 3.63,22.71L1.29,20.37C0.9,20 0.9,19.35 1.29,18.96L12.96,7.29C13.35,6.9 14,6.9 14.37,7.29Z" />

package/src/web/stylesheets/components/_pane.css

@@ -24,9 +24,16 @@
     line-height: calc(var(--title-height) - 14px);
 }
 
-.title>span,
-.title>.btn {
-    margin-top: -4px;
+.pane-controls {
+    position: absolute;
+    right: 8px;
+    top: 8px;
+    display: flex;
+    flex-direction: row;
+}
+
+.pane-controls .btn {
+    margin-left: 2px;
 }
 
 .list-area {
@@ -107,4 +114,4 @@
 
 #files .card-header .float-right a:hover {
     text-decoration: none;
-}
+}

package/src/web/stylesheets/layout/_controls.css

@@ -58,6 +58,10 @@
     border-radius: 30px;
 }
 
+.output-maximised .hide-on-maximised-output {
+    display: none !important;
+}
+
 .spin {
     animation-name: spin;
     animation-duration: 3s;

package/src/web/stylesheets/layout/_io.css

@@ -280,9 +280,8 @@
 }
 
 .io-info {
-    margin-right: 20px;
+    margin-right: 18px;
     margin-top: 1px;
-    float: right;
     height: 30px;
     text-align: right;
     line-height: 12px;

package/src/web/stylesheets/layout/_structure.css

@@ -39,8 +39,8 @@ div#output {
 
 .split {
     box-sizing: border-box;
-    /* overflow: auto;
-    Removed to enable Background Magic button pulse to overflow.
+    /* overflow: auto; */
+    /* Removed to enable Background Magic button pulse to overflow.
     Replace this rule if it seems to be causing problems. */
     position: relative;
 }

package/src/web/waiters/OutputWaiter.mjs

@@ -1373,6 +1373,7 @@ class OutputWaiter {
         const el = e.target.id === "maximise-output" ? e.target : e.target.parentNode;
 
         if (el.getAttribute("data-original-title").indexOf("Maximise") === 0) {
+            document.body.classList.add("output-maximised");
             this.app.initialiseSplitter(true);
             this.app.columnSplitter.collapse(0);
             this.app.columnSplitter.collapse(1);
@@ -1381,6 +1382,7 @@ class OutputWaiter {
             $(el).attr("data-original-title", "Restore output pane");
             el.querySelector("i").innerHTML = "fullscreen_exit";
         } else {
+            document.body.classList.remove("output-maximised");
             $(el).attr("data-original-title", "Maximise output pane");
             el.querySelector("i").innerHTML = "fullscreen";
             this.app.initialiseSplitter(false);

package/src/web/waiters/WindowWaiter.mjs

@@ -23,11 +23,11 @@ class WindowWaiter {
 
     /**
      * Handler for window resize events.
-     * Resets the layout of CyberChef's panes after 200ms (so that continuous resizing doesn't cause
+     * Resets adjustable component sizes after 200ms (so that continuous resizing doesn't cause
      * continuous resetting).
      */
     windowResize() {
-        debounce(this.app.resetLayout, 200, "windowResize", this.app, [])();
+        debounce(this.app.adjustComponentSizes, 200, "windowResize", this.app, [])();
     }
 
 

package/webpack.config.js

@@ -1,6 +1,7 @@
 const webpack = require("webpack");
 const MiniCssExtractPlugin = require("mini-css-extract-plugin");
 const CopyWebpackPlugin = require("copy-webpack-plugin");
+const { ModifySourcePlugin } = require("modify-source-webpack-plugin");
 const path = require("path");
 
 /**
@@ -82,6 +83,16 @@ module.exports = {
                     to: "assets/forge/"
                 }
             ]
+        }),
+        new ModifySourcePlugin({
+            rules: [
+                {
+                    // Fix toSpare(0) bug in Split.js by avoiding gutter accomodation
+                    test: /split\.es\.js$/,
+                    modify: (src, path) =>
+                        src.replace("if (pixelSize < elementMinSize)", "if (false)")
+                }
+            ]
         })
     ],
     resolve: {