Merge pull request #1991 from peterc-s/master

Add Base32 Hex Extended Alphabet and Base32 Tests.

.github/workflows/releases.yml

@@ -25,6 +25,7 @@ jobs:
 
     - name: Install
       run: |
+        export DETECT_CHROMEDRIVER_VERSION=true
         npm ci
         npm run setheapsize
 
@@ -61,12 +62,22 @@ jobs:
         tags: ${{ steps.image-metadata.outputs.tags }}
         labels: ${{ steps.image-metadata.outputs.labels }}
         containerfiles: ./Dockerfile
-        platforms: linux/amd64
+        platforms: linux/amd64,linux/arm64
         oci: true
+        # enable build layer caching between platforms
+        layers: true
         # Webpack seems to use a lot of open files, increase the max open file limit to accomodate.
         extra-args: |
           --ulimit nofile=10000
 
+    - name: Publish to GHCR
+      uses: redhat-actions/push-to-registry@v2
+      with:
+        image: ${{ steps.build-image.outputs.image }}
+        tags: ${{ steps.build-image.outputs.tags }}
+        registry: ${{ env.REGISTRY }}
+        username: ${{ env.REGISTRY_USER }}
+        password: ${{ env.REGISTRY_PASSWORD }}
 
     - name: Upload Release Assets
       id: upload-release-assets
@@ -81,13 +92,6 @@ jobs:
 
     - name: Publish to NPM
       uses: JS-DevTools/npm-publish@v1
+      if: false
       with:
-        token: ${{ secrets.NPM_TOKEN }}
-
-    - name: Publish to GHCR
-      uses: redhat-actions/push-to-registry@v2
-      with:
-        tags: ${{ steps.build-image.outputs.tags }}
-        registry: ${{ env.REGISTRY }}
-        username: ${{ env.REGISTRY_USER }}
-        password: ${{ env.REGISTRY_PASSWORD }}
+        token: ${{ secrets.NPM_TOKEN }}

Dockerfile

@@ -1,9 +1,36 @@
-FROM node:18-alpine AS build
+#####################################
+# Build the app to a static website #
+#####################################
+# Modifier --platform=$BUILDPLATFORM limits the platform to "BUILDPLATFORM" during buildx multi-platform builds
+# This is because npm "chromedriver" package is not compatiable with all platforms
+# For more info see: https://docs.docker.com/build/building/multi-platform/#cross-compilation
+FROM --platform=$BUILDPLATFORM node:18-alpine AS builder
 
+WORKDIR /app
+
+COPY package.json .
+COPY package-lock.json .
+
+# Install dependencies
+# --ignore-scripts prevents postinstall script (which runs grunt) as it depends on files other than package.json
+RUN npm ci --ignore-scripts
+
+# Copy files needed for postinstall and build
 COPY . .
-RUN npm ci
+
+# npm postinstall runs grunt, which depends on files other than package.json
+RUN npm run postinstall
+
+# Build the app
 RUN npm run build
 
-FROM nginx:1.25-alpine3.18 AS cyberchef
+#########################################
+# Package static build files into nginx #
+#########################################
+# We are using Github Actions: redhat-actions/buildah-build@v2 which needs manual selection of arch in base image
+# Remove TARGETARCH if docker buildx is supported in the CI release as --platform=$TARGETPLATFORM will be automatically set
+ARG TARGETARCH
+ARG TARGETPLATFORM
+FROM ${TARGETARCH}/nginx:stable-alpine AS cyberchef
 
-COPY --from=build ./build/prod /usr/share/nginx/html/
+COPY --from=builder /app/build/prod /usr/share/nginx/html/

package-lock.json

@@ -37,6 +37,7 @@
         "d3": "7.9.0",
         "d3-hexbin": "^0.2.2",
         "diff": "^5.2.0",
+        "dompurify": "^3.2.5",
         "es6-promisify": "^7.0.0",
         "escodegen": "^2.1.0",
         "esprima": "^4.0.1",
@@ -50,7 +51,6 @@
         "jimp": "^0.22.12",
         "jq-web": "^0.5.1",
         "jquery": "3.7.1",
-        "js-crc": "^0.2.0",
         "js-sha3": "^0.9.3",
         "jsesc": "^3.0.2",
         "json5": "^2.2.3",
@@ -4365,6 +4365,13 @@
         "@types/node": "*"
       }
     },
+    "node_modules/@types/trusted-types": {
+      "version": "2.0.7",
+      "resolved": "https://registry.npmjs.org/@types/trusted-types/-/trusted-types-2.0.7.tgz",
+      "integrity": "sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==",
+      "license": "MIT",
+      "optional": true
+    },
     "node_modules/@types/ws": {
       "version": "8.5.13",
       "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.5.13.tgz",
@@ -8411,6 +8418,15 @@
         "url": "https://github.com/fb55/domhandler?sponsor=1"
       }
     },
+    "node_modules/dompurify": {
+      "version": "3.2.5",
+      "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-3.2.5.tgz",
+      "integrity": "sha512-mLPd29uoRe9HpvwP2TxClGQBzGXeEC/we/q+bFlmPPmj2p2Ugl3r6ATu/UU1v77DXNcehiBg9zsr1dREyA/dJQ==",
+      "license": "(MPL-2.0 OR Apache-2.0)",
+      "optionalDependencies": {
+        "@types/trusted-types": "^2.0.7"
+      }
+    },
     "node_modules/domutils": {
       "version": "2.8.0",
       "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz",
@@ -12303,12 +12319,6 @@
       "integrity": "sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg==",
       "license": "MIT"
     },
-    "node_modules/js-crc": {
-      "version": "0.2.0",
-      "resolved": "https://registry.npmjs.org/js-crc/-/js-crc-0.2.0.tgz",
-      "integrity": "sha512-8DdCSAOACpF8WDAjyDFBC2rj8OS4HUP9mNZBDfl8jCiPCnJG+2bkuycalxwZh6heFy6PrMvoWTp47lp6gzT65A==",
-      "license": "MIT"
-    },
     "node_modules/js-sha3": {
       "version": "0.9.3",
       "resolved": "https://registry.npmjs.org/js-sha3/-/js-sha3-0.9.3.tgz",

package.json

@@ -123,6 +123,7 @@
     "d3": "7.9.0",
     "d3-hexbin": "^0.2.2",
     "diff": "^5.2.0",
+    "dompurify": "^3.2.5",
     "es6-promisify": "^7.0.0",
     "escodegen": "^2.1.0",
     "esprima": "^4.0.1",

src/core/lib/Base32.mjs

@@ -0,0 +1,23 @@
+// import Utils from "../Utils.mjs";
+
+/**
+ * Base32 resources.
+ *
+ * @author Peter C-S [petercs@purelymail.com]
+ * @license Apache-2.0
+ */
+
+/**
+ * Base32 alphabets.
+ */
+export const ALPHABET_OPTIONS = [
+    {
+        name: "Standard", // https://www.rfc-editor.org/rfc/rfc4648#section-6
+        value: "A-Z2-7=",
+    },
+    {
+        name: "Hex Extended", // https://www.rfc-editor.org/rfc/rfc4648#section-7
+        value: "0-9A-V=",
+    },
+];
+

src/core/operations/FromBase32.mjs

@@ -6,6 +6,8 @@
 
 import Operation from "../Operation.mjs";
 import Utils from "../Utils.mjs";
+import {ALPHABET_OPTIONS} from "../lib/Base32.mjs";
+
 
 /**
  * From Base32 operation
@@ -27,8 +29,8 @@ class FromBase32 extends Operation {
         this.args = [
             {
                 name: "Alphabet",
-                type: "binaryString",
-                value: "A-Z2-7="
+                type: "editableOption",
+                value: ALPHABET_OPTIONS
             },
             {
                 name: "Remove non-alphabet chars",
@@ -41,6 +43,11 @@ class FromBase32 extends Operation {
                 pattern: "^(?:[A-Z2-7]{8})+(?:[A-Z2-7]{2}={6}|[A-Z2-7]{4}={4}|[A-Z2-7]{5}={3}|[A-Z2-7]{7}={1})?$",
                 flags: "",
                 args: ["A-Z2-7=", false]
+            },
+            {
+                pattern: "^(?:[0-9A-V]{8})+(?:[0-9A-V]{2}={6}|[0-9A-V]{4}={4}|[0-9A-V]{5}={3}|[0-9A-V]{7}={1})?$",
+                flags: "",
+                args: ["0-9A-V=", false]
             }
         ];
     }
@@ -96,3 +103,4 @@ class FromBase32 extends Operation {
 }
 
 export default FromBase32;
+

src/core/operations/ToBase32.mjs

@@ -6,6 +6,7 @@
 
 import Operation from "../Operation.mjs";
 import Utils from "../Utils.mjs";
+import {ALPHABET_OPTIONS} from "../lib/Base32.mjs";
 
 /**
  * To Base32 operation
@@ -27,8 +28,8 @@ class ToBase32 extends Operation {
         this.args = [
             {
                 name: "Alphabet",
-                type: "binaryString",
-                value: "A-Z2-7="
+                type: "editableOption",
+                value: ALPHABET_OPTIONS
             }
         ];
     }
@@ -83,3 +84,4 @@ class ToBase32 extends Operation {
 }
 
 export default ToBase32;
+

src/web/waiters/RecipeWaiter.mjs

@@ -8,6 +8,7 @@ import HTMLOperation from "../HTMLOperation.mjs";
 import Sortable from "sortablejs";
 import Utils from "../../core/Utils.mjs";
 import {escapeControlChars} from "../utils/editorUtils.mjs";
+import DOMPurify from "dompurify";
 
 
 /**
@@ -435,7 +436,9 @@ class RecipeWaiter {
         const item = document.createElement("li");
 
         item.classList.add("operation");
-        item.innerHTML = name;
+        const clean = DOMPurify.sanitize(name);
+        item.innerHTML = clean;
+
         this.buildRecipeOperation(item);
         document.getElementById("rec-list").appendChild(item);
 

tests/operations/index.mjs

@@ -20,6 +20,7 @@ import TestRegister from "../lib/TestRegister.mjs";
 import "./tests/AESKeyWrap.mjs";
 import "./tests/AvroToJSON.mjs";
 import "./tests/BaconCipher.mjs";
+import "./tests/Base32.mjs";
 import "./tests/Base45.mjs";
 import "./tests/Base58.mjs";
 import "./tests/Base62.mjs";

tests/operations/tests/Base32.mjs

@@ -0,0 +1,176 @@
+/**
+ * Base32 Tests
+ *
+ * @author Peter C-S [petercs@purelymail.com]
+ * @license Apache-2.0
+ */
+
+import TestRegister from "../../lib/TestRegister.mjs";
+import {ALPHABET_OPTIONS} from "../../../src/core/lib/Base32.mjs";
+
+// Example Standard Base32 Tests
+const STANDARD_INP = "HELLO BASE32";
+const STANDARD_OUT = "JBCUYTCPEBBECU2FGMZA====";
+
+// Example Hex Extended Base32 Tests
+const EXTENDED_INP = "HELLO BASE32 EXTENDED";
+const EXTENDED_OUT = "912KOJ2F41142KQ56CP20HAOAH2KSH258G======";
+
+// All Bytes
+const ALL_BYTES = [
+    "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f",
+    "\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f",
+    "\x20\x21\x22\x23\x24\x25\x26\x27\x28\x29\x2a\x2b\x2c\x2d\x2e\x2f",
+    "\x30\x31\x32\x33\x34\x35\x36\x37\x38\x39\x3a\x3b\x3c\x3d\x3e\x3f",
+    "\x40\x41\x42\x43\x44\x45\x46\x47\x48\x49\x4a\x4b\x4c\x4d\x4e\x4f",
+    "\x50\x51\x52\x53\x54\x55\x56\x57\x58\x59\x5a\x5b\x5c\x5d\x5e\x5f",
+    "\x60\x61\x62\x63\x64\x65\x66\x67\x68\x69\x6a\x6b\x6c\x6d\x6e\x6f",
+    "\x70\x71\x72\x73\x74\x75\x76\x77\x78\x79\x7a\x7b\x7c\x7d\x7e\x7f",
+    "\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f",
+    "\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f",
+    "\xa0\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf",
+    "\xb0\xb1\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf",
+    "\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf",
+    "\xd0\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf",
+    "\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef",
+    "\xf0\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff",
+].join("");
+
+const ALL_BYTES_EXTENDED_OUT = "000G40O40K30E209185GO38E1S8124GJ2GAHC5OO34D1M70T3OFI08924CI2A9H750KIKAPC5KN2UC1H68PJ8D9M6SS3IEHR7GUJSFQ085146H258P3KGIAA9D64QJIFA18L4KQKALB5EM2PB9DLONAUBTG62OJ3CHIMCPR8D5L6MR3DDPNN0SBIEDQ7ATJNF1SNKURSFLV7V041GA1O91C6GU48J2KBHI6OT3SGI699754LIQBPH6CQJEE9R7KVK2GQ58T4KMJAFA59LALQPBDELUOB3CLJMIQRDDTON6TBNF5TNQVS1GE2OF2CBHM7P34SLIUCPN7CVK6HQB9T9LEMQVCDJMMRRJETTNV0S7HE7P75SRJUHQFATFMERRNFU3OV5SVKUNRFFU7PVBTVPVFUVS======";
+const ALL_BYTES_STANDARD_OUT = "AAAQEAYEAUDAOCAJBIFQYDIOB4IBCEQTCQKRMFYYDENBWHA5DYPSAIJCEMSCKJRHFAUSUKZMFUXC6MBRGIZTINJWG44DSOR3HQ6T4P2AIFBEGRCFIZDUQSKKJNGE2TSPKBIVEU2UKVLFOWCZLJNVYXK6L5QGCYTDMRSWMZ3INFVGW3DNNZXXA4LSON2HK5TXPB4XU634PV7H7AEBQKBYJBMGQ6EITCULRSGY5D4QSGJJHFEVS2LZRGM2TOOJ3HU7UCQ2FI5EUWTKPKFJVKV2ZLNOV6YLDMVTWS23NN5YXG5LXPF5X274BQOCYPCMLRWHZDE4VS6MZXHM7UGR2LJ5JVOW27MNTWW33TO55X7A4HROHZHF43T6R2PK5PWO33XP6DY7F47U6X3PP6HZ7L57Z7P674======";
+
+TestRegister.addTests([
+    {
+        name: "To Base32 Standard: nothing",
+        input: "",
+        expectedOutput: "",
+        recipeConfig: [
+            {
+                op: "To Base32",
+                args: [ALPHABET_OPTIONS[0].value],
+            },
+        ],
+    },
+    {
+        name: "To Base32 Hex Extended: nothing",
+        input: "",
+        expectedOutput: "",
+        recipeConfig: [
+            {
+                op: "To Base32",
+                args: [ALPHABET_OPTIONS[1].value],
+            },
+        ],
+    },
+    {
+        name: "From Base32 Standard: nothing",
+        input: "",
+        expectedOutput: "",
+        recipeConfig: [
+            {
+                op: "From Base32",
+                args: [ALPHABET_OPTIONS[0].value, false],
+            },
+        ],
+    },
+    {
+        name: "From Base32 Hex Extended: nothing",
+        input: "",
+        expectedOutput: "",
+        recipeConfig: [
+            {
+                op: "From Base32",
+                args: [ALPHABET_OPTIONS[1].value, false],
+            },
+        ],
+    },
+    {
+        name: "To Base32 Standard: " + STANDARD_INP,
+        input: STANDARD_INP,
+        expectedOutput: STANDARD_OUT,
+        recipeConfig: [
+            {
+                op: "To Base32",
+                args: [ALPHABET_OPTIONS[0].value],
+            },
+        ],
+    },
+    {
+        name: "To Base32 Hex Extended: " + EXTENDED_INP,
+        input: EXTENDED_INP,
+        expectedOutput: EXTENDED_OUT,
+        recipeConfig: [
+            {
+                op: "To Base32",
+                args: [ALPHABET_OPTIONS[1].value],
+            },
+        ],
+    },
+    {
+        name: "From Base32 Standard: " + STANDARD_OUT,
+        input: STANDARD_OUT,
+        expectedOutput: STANDARD_INP,
+        recipeConfig: [
+            {
+                op: "From Base32",
+                args: [ALPHABET_OPTIONS[0].value, false],
+            },
+        ],
+    },
+    {
+        name: "From Base32 Hex Extended: " + EXTENDED_OUT,
+        input: EXTENDED_OUT,
+        expectedOutput: EXTENDED_INP,
+        recipeConfig: [
+            {
+                op: "From Base32",
+                args: [ALPHABET_OPTIONS[1].value, false],
+            },
+        ],
+    },
+    {
+        name: "To Base32 Hex Standard: All Bytes",
+        input: ALL_BYTES,
+        expectedOutput: ALL_BYTES_STANDARD_OUT,
+        recipeConfig: [
+            {
+                op: "To Base32",
+                args: [ALPHABET_OPTIONS[0].value],
+            },
+        ],
+    },
+    {
+        name: "To Base32 Hex Extended: All Bytes",
+        input: ALL_BYTES,
+        expectedOutput: ALL_BYTES_EXTENDED_OUT,
+        recipeConfig: [
+            {
+                op: "To Base32",
+                args: [ALPHABET_OPTIONS[1].value],
+            },
+        ],
+    },
+    {
+        name: "From Base32 Hex Standard: All Bytes",
+        input: ALL_BYTES_STANDARD_OUT,
+        expectedOutput: ALL_BYTES,
+        recipeConfig: [
+            {
+                op: "From Base32",
+                args: [ALPHABET_OPTIONS[0].value, false],
+            },
+        ],
+    },
+    {
+        name: "From Base32 Hex Extended: All Bytes",
+        input: ALL_BYTES_EXTENDED_OUT,
+        expectedOutput: ALL_BYTES,
+        recipeConfig: [
+            {
+                op: "From Base32",
+                args: [ALPHABET_OPTIONS[1].value, false],
+            },
+        ],
+    },
+]);
+