Merge branch 'master' into update-tesseract-version-to-6-0-1

2026-02-06 00:33:06 +00:00 · 2026-02-06 00:33:06 +00:00 · fe18609cc1
commit fe18609cc1
parent a7db40d012 0cf7bcaddc
10 changed files with 211 additions and 190 deletions
--- a/.editorconfig
+++ b/.editorconfig
@ -12,3 +12,7 @@ indent_size = 4
 [{package.json,.travis.yml,nightwatch.json}]
 indent_style = space
 indent_size = 2
+
+[.github/**.yml]
+indent_style = space
+indent_size = 2
--- a/.github/workflows/codeql.yml
+++ b/.github/workflows/codeql.yml
@ -1,40 +0,0 @@
-name: "CodeQL Analysis"
-
-on:
-  workflow_dispatch:
-  push:
-    branches: [ master ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ master ]
-    types: [synchronize, opened, reopened]
-  schedule:
-    - cron: '22 17 * * 5'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"
--- a/.github/workflows/master.yml
+++ b/.github/workflows/master.yml
@ -1,58 +1,64 @@
 name: "Master Build, Test & Deploy"

+permissions:
+  contents: read
+
 on:
  workflow_dispatch:
  push:
    branches:
-    - master
+      - master

 jobs:
  main:
+    permissions:
+      contents: write
    runs-on: ubuntu-latest
    steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v6

-    - name: Set node version
-      uses: actions/setup-node@v3
-      with:
-        node-version: '18.x'
+      - name: Set node version
+        uses: actions/setup-node@v6
+        with:
+          node-version: 18
+          registry-url: "https://registry.npmjs.org"

-    - name: Install
-      run: |
-        export DETECT_CHROMEDRIVER_VERSION=true
-        npm install
-        npm run setheapsize
+      - name: Install
+        run: |
+          export DETECT_CHROMEDRIVER_VERSION=true
+          npm install
+          npm run setheapsize

-    - name: Lint
-      run: npx grunt lint
+      - name: Lint
+        run: npx grunt lint

-    - name: Unit Tests
-      run: |
-        npm test
-        npm run testnodeconsumer
+      - name: Unit Tests
+        run: |
+          npm test
+          npm run testnodeconsumer

-    - name: Production Build
-      if: success()
-      run: npx grunt prod --msg=""
+      - name: Production Build
+        if: success()
+        run: npx grunt prod --msg=""

-    - name: Generate sitemap
-      run: npx grunt exec:sitemap
+      - name: Generate sitemap
+        run: npx grunt exec:sitemap

-    - name: UI Tests
-      if: success()
-      run: |
-        sudo apt-get install xvfb
-        xvfb-run --server-args="-screen 0 1200x800x24" npx grunt testui
+      - name: UI Tests
+        if: success()
+        run: |
+          sudo apt-get install xvfb
+          xvfb-run --server-args="-screen 0 1200x800x24" npx grunt testui

-    - name: Prepare for GitHub Pages
-      if: success()
-      run: npx grunt copy:ghPages
+      - name: Prepare for GitHub Pages
+        if: success()
+        run: npx grunt copy:ghPages

-    - name: Deploy to GitHub Pages
-      if: success() && github.ref == 'refs/heads/master'
-      uses: crazy-max/ghaction-github-pages@v3
-      with:
-        target_branch: gh-pages
-        build_dir: ./build/prod
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Deploy to GitHub Pages
+        if: success() && github.ref == 'refs/heads/master'
+        uses: crazy-max/ghaction-github-pages@v3
+        with:
+          target_branch: gh-pages
+          build_dir: ./build/prod
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
--- a/.github/workflows/pull_requests.yml
+++ b/.github/workflows/pull_requests.yml
@ -1,5 +1,8 @@
 name: "Pull Requests"

+permissions:
+  contents: read
+
 on:
  workflow_dispatch:
  pull_request:
@ -9,47 +12,46 @@ jobs:
  main:
    runs-on: ubuntu-latest
    steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v6

-    - name: Set node version
-      uses: actions/setup-node@v3
-      with:
-        node-version: '18.x'
+      - name: Set node version
+        uses: actions/setup-node@v6
+        with:
+          node-version: 18
+          registry-url: "https://registry.npmjs.org"

-    - name: Install
-      run: |
-        export DETECT_CHROMEDRIVER_VERSION=true
-        npm install
-        npm run setheapsize
+      - name: Install
+        run: |
+          export DETECT_CHROMEDRIVER_VERSION=true
+          npm install
+          npm run setheapsize

-    - name: Lint
-      run: npx grunt lint
+      - name: Lint
+        run: npx grunt lint

-    - name: Unit Tests
-      run: |
-        npm test
-        npm run testnodeconsumer
+      - name: Unit Tests
+        run: |
+          npm test
+          npm run testnodeconsumer

-    - name: Production Build
-      if: success()
-      run: npx grunt prod
+      - name: Production Build
+        if: success()
+        run: npx grunt prod

-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3

-    - name: Set up QEMU
-      uses: docker/setup-qemu-action@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3

-    - name: Production Image Build
-      if: success()
-      id: build-image
-      uses: docker/build-push-action@v6
-      with:
-        # Not being uploaded to any registry, use a simple name to allow Buildah to build correctly.
-        image: cyberchef
-        platforms: linux/amd64,linux/arm64
-    - name: UI Tests
-      if: success()
-      run: |
-        sudo apt-get install xvfb
-        xvfb-run --server-args="-screen 0 1200x800x24" npx grunt testui
+      - name: Production Image Build
+        if: success()
+        id: build-image
+        uses: docker/build-push-action@v6
+        with:
+          platforms: linux/amd64,linux/arm64
+      - name: UI Tests
+        if: success()
+        run: |
+          sudo apt-get install xvfb
+          xvfb-run --server-args="-screen 0 1200x800x24" npx grunt testui
--- a/.github/workflows/releases.yml
+++ b/.github/workflows/releases.yml
@ -4,7 +4,11 @@ on:
  workflow_dispatch:
  push:
    tags:
-    - 'v*'
+      - "v*"
+
+permissions:
+  id-token: write
+  contents: read

 env:
  REGISTRY: ghcr.io
@ -16,79 +20,78 @@ jobs:
  main:
    runs-on: ubuntu-latest
    steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v6

-    - name: Set node version
-      uses: actions/setup-node@v3
-      with:
-        node-version: '18.x'
+      - name: Set node version
+        uses: actions/setup-node@v6
+        with:
+          node-version: 18
+          registry-url: "https://registry.npmjs.org"

-    - name: Install
-      run: |
-        export DETECT_CHROMEDRIVER_VERSION=true
-        npm ci
-        npm run setheapsize
+      - name: Install
+        run: |
+          export DETECT_CHROMEDRIVER_VERSION=true
+          npm ci
+          npm run setheapsize

-    - name: Lint
-      run: npx grunt lint
+      - name: Lint
+        run: npx grunt lint

-    - name: Unit Tests
-      run: |
-        npm test
-        npm run testnodeconsumer
+      - name: Unit Tests
+        run: |
+          npm test
+          npm run testnodeconsumer

-    - name: Production Build
-      run: npx grunt prod
+      - name: Production Build
+        run: npx grunt prod

-    - name: UI Tests
-      run: |
-        sudo apt-get install xvfb
-        xvfb-run --server-args="-screen 0 1200x800x24" npx grunt testui
+      - name: UI Tests
+        run: |
+          sudo apt-get install xvfb
+          xvfb-run --server-args="-screen 0 1200x800x24" npx grunt testui

-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3

-    - name: Set up QEMU
-      uses: docker/setup-qemu-action@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3

-    - name: Image Metadata
-      id: image-metadata
-      uses: docker/metadata-action@v4
-      with:
-        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
-        tags: |
-          type=semver,pattern={{major}}
-          type=semver,pattern={{major}}.{{minor}}
-          type=semver,pattern={{version}}
+      - name: Image Metadata
+        id: image-metadata
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{major}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{version}}

-    - name: Log in to GHCR
-      uses: docker/login-action@v3
-      with:
-        registry: ${{ env.REGISTRY }}
-        username: ${{ env.REGISTRY_USER }}
-        password: ${{ env.REGISTRY_PASSWORD }}
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ env.REGISTRY_USER }}
+          password: ${{ env.REGISTRY_PASSWORD }}

-    - name: Publish to GHCR
-      uses: docker/build-push-action@v6
-      with:
-        context: .
-        push: true
-        tags: ${{ steps.image-metadata.outputs.tags }}
-        labels: ${{ steps.image-metadata.outputs.labels }}
-        platforms: linux/amd64,linux/arm64
+      - name: Publish to GHCR
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.image-metadata.outputs.tags }}
+          labels: ${{ steps.image-metadata.outputs.labels }}
+          platforms: linux/amd64,linux/arm64

-    - name: Upload Release Assets
-      id: upload-release-assets
-      uses: svenstaro/upload-release-action@v2
-      with:
-        repo_token: ${{ secrets.GITHUB_TOKEN }}
-        file: build/prod/*.zip
-        tag: ${{ github.ref }}
-        overwrite: true
-        file_glob: true
-        body: "See the [CHANGELOG](https://github.com/gchq/CyberChef/blob/master/CHANGELOG.md) and [commit messages](https://github.com/gchq/CyberChef/commits/master) for details."
+      - name: Upload Release Assets
+        id: upload-release-assets
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: build/prod/*.zip
+          tag: ${{ github.ref }}
+          overwrite: true
+          file_glob: true
+          body: "See the [CHANGELOG](https://github.com/gchq/CyberChef/blob/master/CHANGELOG.md) and [commit messages](https://github.com/gchq/CyberChef/commits/master) for details."

-    - name: Publish to NPM
-      uses: JS-DevTools/npm-publish@v1
-      with:
-        token: ${{ secrets.NPM_TOKEN }}
+      - name: Publish to NPM
+        run: npm publish
--- a/src/core/operations/FromHexdump.mjs
+++ b/src/core/operations/FromHexdump.mjs
@ -43,7 +43,7 @@ class FromHexdump extends Operation {
     */
    run(input, args) {
        const output = [],
-            regex = /^\s*(?:[\dA-F]{4,16}h?:?)?[ \t]+((?:[\dA-F]{2} ){1,8}(?:[ \t]|[\dA-F]{2}-)(?:[\dA-F]{2} ){1,8}|(?:[\dA-F]{4} )*[\dA-F]{4}|(?:[\dA-F]{2} )*[\dA-F]{2})/igm;
+            regex = /^\s*(?:[\dA-F]{4,16}h?:?)?[ \t]+((?:[\dA-F]{2} ){1,8}(?:[ \t]|[\dA-F]{2}-)(?:[\dA-F]{2} ){1,8}|(?:[\dA-F]{4} )+(?:[\dA-F]{2})?|(?:[\dA-F]{2} )*[\dA-F]{2})/igm;
        let block, line;

        while ((block = regex.exec(input))) {
--- a/src/node/apiUtils.mjs
+++ b/src/node/apiUtils.mjs
@ -66,7 +66,7 @@ export function removeSubheadingsFromArray(array) {
 * @param str
 */
 export function sanitise(str) {
-    return str.replace(/ /g, "").toLowerCase();
+    return str.replace(/[/\s.-]/g, "").toLowerCase();
 }


--- a/src/web/static/sitemap.mjs
+++ b/src/web/static/sitemap.mjs
@ -1,6 +1,5 @@
 import sm from "sitemap";
-import OperationConfig from "../../core/config/OperationConfig.json" assert {type: "json"};
-
+import OperationConfig from "../../core/config/OperationConfig.json" assert { type: "json" };

 /**
 * Generates an XML sitemap for all CyberChef operations and a number of recipes.
@ -10,25 +9,25 @@ import OperationConfig from "../../core/config/OperationConfig.json" assert {typ
 * @license Apache-2.0
 */

-const smStream = new sm.SitemapStream({
-    hostname: "https://gchq.github.io/CyberChef",
-});
+const baseUrl = "https://gchq.github.io/CyberChef/";
+
+const smStream = new sm.SitemapStream({});

 smStream.write({
-    url: "/",
+    url: baseUrl,
    changefreq: "weekly",
-    priority: 1.0
+    priority: 1.0,
 });

 for (const op in OperationConfig) {
    smStream.write({
-        url: `/?op=${encodeURIComponent(op)}`,
+        url: `${baseUrl}?op=${encodeURIComponent(op)}`,
        changeFreq: "yearly",
-        priority: 0.5
+        priority: 0.5,
    });
 }
 smStream.end();

 sm.streamToPromise(smStream).then(
-    buffer => console.log(buffer.toString()) // eslint-disable-line no-console
+    (buffer) => console.log(buffer.toString()), // eslint-disable-line no-console
 );
--- a/tests/node/tests/nodeApi.mjs
+++ b/tests/node/tests/nodeApi.mjs
@ -345,6 +345,42 @@ TestRegister.addApiTests([
        assert.strictEqual(result.toString(), "begin_something_aaaaaaaaaaaaaa_end_something");
    }),

+    it("chef.bake: should accept operation names from Chef Website which contain forward slash", () => {
+        const result = chef.bake("I'll have the test salmon", [
+            { "op": "Find / Replace",
+                "args": [{ "option": "Regex", "string": "test" }, "good", true, false, true, false]}
+        ]);
+        assert.strictEqual(result.toString(), "I'll have the good salmon");
+    }),
+
+    it("chef.bake: should accept operation names from Chef Website which contain a hyphen", () => {
+        const result = chef.bake("I'll have the test salmon", [
+            { "op": "Adler-32 Checksum",
+                "args": [] }
+        ]);
+        assert.strictEqual(result.toString(), "6e4208f8");
+    }),
+
+    it("chef.bake: should accept operation names from Chef Website which contain a period", () => {
+        const result = chef.bake("30 13 02 01 05 16 0e 41 6e 79 62 6f 64 79 20 74 68 65 72 65 3f", [
+            { "op": "Parse ASN.1 hex string",
+                "args": [0, 32] }
+        ]);
+        assert.strictEqual(result.toString(), `SEQUENCE
+  INTEGER 05
+  IA5String 'Anybody there?'
+`);
+    }),
+
+    it("Excluded operations: throw a sensible error when you try and call one", () => {
+        try {
+            chef.fork();
+        } catch (e) {
+            assert.strictEqual(e.type, "ExcludedOperationError");
+            assert.strictEqual(e.message, "Sorry, the Fork operation is not available in the Node.js version of CyberChef.");
+        }
+    }),
+
    it("chef.bake: cannot accept flowControl operations in recipe", () => {
        assert.throws(() => chef.bake("some input", "magic"), {
            name: "TypeError",
--- a/tests/operations/tests/Hexdump.mjs
+++ b/tests/operations/tests/Hexdump.mjs
@ -152,6 +152,17 @@ TestRegister.addTests([
            }
        ],
    },
+    {
+        name: "From Hexdump: xxd format, odd number of bytes",
+        input: "00000000: 6162 6364 65                             abcde",
+        expectedOutput: "abcde",
+        recipeConfig: [
+            {
+                op: "From Hexdump",
+                args: []
+            }
+        ],
+    },
    {
        name: "From Hexdump: Wireshark",
        input: `00000000  00 01 02 03 04 05 06 07  08 09 0a 0b 0c 0d 0e 0f ........ ........