exlim/cyberchef
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' into RenderPDF

Browse Source
This commit is contained in:
Shailendra Singh 2026-06-15 20:33:47 +05:30 committed by GitHub
commit a201ce06bd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
190 changed files with 15997 additions and 8559 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.devcontainer/devcontainer.json
View File

@ -3,7 +3,7 @@
{
"name": "CyberChef",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/javascript-node:1-18-bookworm",
"image": "mcr.microsoft.com/devcontainers/javascript-node:24-trixie",
// Features to add to the dev container. More info: https://containers.dev/features.
"features": {

1
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1 +0,0 @@
<!-- Prefix the title above with 'Misc:' -->

12
.github/ISSUE_TEMPLATE/operation-request.md vendored
View File

@ -7,8 +7,14 @@ assignees: ''
---
## Summary
**Is your operation request related to a problem? Please describe.**
A clear and concise description of what the problem is. E.g. I'm always frustrated when [...]
### Example Input
**Describe the solution you'd like**
A clear and concise description of the new operation you would like.
### Example Output
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Example input and output**
Provide an example input to the operation, along with the output that you would expect.

97
.github/dependabot.yml vendored Normal file
View File

@ -0,0 +1,97 @@
# See the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
version: 2
updates:
#
# Check for minor/patch versions only on a weekly basis - we are likely to be able to
# merge these routinely. Major versions we'll check for and update manually.
#
- package-ecosystem: 'npm'
directory: '/'
versioning-strategy: increase
schedule:
interval: 'weekly'
day: 'friday'
time: '03:00'
timezone: Europe/London
cooldown:
default-days: 2
commit-message:
prefix: 'chore (deps): '
ignore:
# we'll do any major version updates manually
- dependency-name: '*'
update-types: ['version-update:semver-major']
# packages we can't currently update
# see issue #2214 for rationale for each of these
- dependency-name: '@xmldom/xmldom'
versions: [ '>=0.9.0' ]
- dependency-name: 'bootstrap'
versions: [ '>=5.0.0' ]
- dependency-name: 'cbor'
versions: [ '>=10.0.0' ]
- dependency-name: 'eslint'
versions: [ '>=10.0.0' ]
- dependency-name: 'eslint-plugin-jsdoc'
versions: [ '>=51.0.0' ]
- dependency-name: 'fernet'
versions: [ '>=0.4.0' ]
- dependency-name: 'geodesy'
versions: [ '>=2.0.0' ]
- dependency-name: 'jimp'
versions: [ '1.6.1' ]
- dependency-name: 'jq-web'
versions: [ '>=0.6.0' ]
groups:
#
# Grouping so patch version updates are batched together in a single PR
# and similarly with minor version updates
#
patch-updates:
applies-to: version-updates
patterns:
- '*'
update-types:
- 'patch'
minor-updates:
applies-to: version-updates
patterns:
- '*'
update-types:
- 'minor'
# Versioning on Github Actions
- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`; no need to
# specify `/.github/workflows` for `directory`
directory: '/'
schedule:
interval: 'weekly'
day: 'friday'
time: '03:00'
timezone: Europe/London
cooldown:
default-days: 4
commit-message:
prefix: 'chore (deps): '
groups:
actions-dependencies:
patterns:
- "*"
- package-ecosystem: docker
directory: /
schedule:
interval: 'weekly'
day: 'friday'
time: '03:00'
timezone: Europe/London
cooldown:
default-days: 4
commit-message:
prefix: 'chore (deps): '
groups:
docker-dependencies:
patterns:
- "*"

15
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,15 @@
**Description**
Provide a description of the pull request and the changes that it makes.
**Existing Issue**
If this pull request relates to an existing issue in the repository, please link it here.
**Screenshots**
If the pull request changes any visual aspects of CyberChef, please include screenshots.
**AI disclosure**
If you have used any AI tools while creating this code, **you must declare your usage along with the name of the tools that you used**.
Regardless of AI tool usage, you are responsible for any code that you submit, and we expect you to have checked the code and have enough of an understanding of it to answer any questions we might have.
**Test Coverage**
Please ensure you have added test coverage for your changes.

26
.github/workflows/master.yml vendored
View File

@ -1,32 +1,32 @@
name: "Master Build, Test & Deploy"
permissions:
contents: read
on:
workflow_dispatch:
push:
branches:
- master
permissions:
contents: read
jobs:
main:
permissions:
contents: write
pages: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
- name: Set node version
uses: actions/setup-node@v6
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version: 18
node-version: 24
registry-url: "https://registry.npmjs.org"
- name: Install
run: |
export DETECT_CHROMEDRIVER_VERSION=true
npm install
npm ci
npm run setheapsize
- name: Lint
@ -44,9 +44,17 @@ jobs:
- name: Generate sitemap
run: npx grunt exec:sitemap
- name: Setup Chrome
id: setup-chrome
if: success()
run: |
npx @puppeteer/browsers install chrome@148
echo chromedir=$(dirname $(find `pwd`/chrome/* -name chrome -print -quit)) >> $GITHUB_OUTPUT
- name: UI Tests
if: success()
run: |
export PATH=${{ steps.setup-chrome.outputs.chromedir }}:$PATH
sudo apt-get install xvfb
xvfb-run --server-args="-screen 0 1200x800x24" npx grunt testui
@ -56,7 +64,7 @@ jobs:
- name: Deploy to GitHub Pages
if: success() && github.ref == 'refs/heads/master'
uses: crazy-max/ghaction-github-pages@v3
uses: crazy-max/ghaction-github-pages@1d6ee9b181a81033a16bd707a1401afa978daab4 # v5.0.0
with:
target_branch: gh-pages
build_dir: ./build/prod

45
.github/workflows/pull_requests.yml vendored
View File

@ -12,18 +12,17 @@ jobs:
main:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
- name: Set node version
uses: actions/setup-node@v6
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version: 18
node-version: 24
registry-url: "https://registry.npmjs.org"
- name: Install
run: |
export DETECT_CHROMEDRIVER_VERSION=true
npm install
npm ci
npm run setheapsize
- name: Lint
@ -38,20 +37,38 @@ jobs:
if: success()
run: npx grunt prod
- name: Upload Build Artefact
if: success()
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: zipped-build
path: build/prod/*.zip
retention-days: 5
- name: Setup Chrome
id: setup-chrome
if: success()
run: |
npx @puppeteer/browsers install chrome@148
echo chromedir=$(dirname $(find `pwd`/chrome/* -name chrome -print -quit)) >> $GITHUB_OUTPUT
- name: UI Tests
if: success()
run: |
export PATH=${{ steps.setup-chrome.outputs.chromedir }}:$PATH
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
if: success()
uses: docker/setup-buildx-action@d7f5e7f509e45cec5c76c4d5afdd7de93d0b3df5 # v4.1.0
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
uses: docker/setup-qemu-action@06116385d9baf250c9f4dcb4858b16962ea869c3 # v4.1.0
- name: Production Image Build
if: success()
id: build-image
uses: docker/build-push-action@v6
uses: docker/build-push-action@f9f3042f7e2789586610d6e8b85c8f03e5195baf # v7.2.0
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
platforms: linux/amd64,linux/arm64,linux/arm/v7

57
.github/workflows/releases.yml vendored
View File

@ -7,7 +7,6 @@ on:
- "v*"
permissions:
id-token: write
contents: read
env:
@ -18,19 +17,21 @@ env:
jobs:
main:
permissions:
packages: write
contents: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
- name: Set node version
uses: actions/setup-node@v6
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version: 18
node-version: 24
registry-url: "https://registry.npmjs.org"
- name: Install
run: |
export DETECT_CHROMEDRIVER_VERSION=true
npm ci
npm run setheapsize
@ -45,20 +46,29 @@ jobs:
- name: Production Build
run: npx grunt prod
- name: UI Tests
- name: Setup Chrome
id: setup-chrome
if: success()
run: |
npx @puppeteer/browsers install chrome@148
echo chromedir=$(dirname $(find `pwd`/chrome/* -name chrome -print -quit)) >> $GITHUB_OUTPUT
- name: UI Tests
if: success()
run: |
export PATH=${{ steps.setup-chrome.outputs.chromedir }}:$PATH
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
uses: docker/setup-buildx-action@d7f5e7f509e45cec5c76c4d5afdd7de93d0b3df5 # v4.1.0
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
uses: docker/setup-qemu-action@06116385d9baf250c9f4dcb4858b16962ea869c3 # v4.1.0
- name: Image Metadata
id: image-metadata
uses: docker/metadata-action@v4
uses: docker/metadata-action@80c7e94dd9b9319bd5eb7a0e0fe9291e23a2a2e9 # v6.1.0
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
@ -67,24 +77,24 @@ jobs:
type=semver,pattern={{version}}
- name: Log in to GHCR
uses: docker/login-action@v3
uses: docker/login-action@650006c6eb7dba73a995cc03b0b2d7f5ca915bee # v4.2.0
with:
registry: ${{ env.REGISTRY }}
username: ${{ env.REGISTRY_USER }}
password: ${{ env.REGISTRY_PASSWORD }}
- name: Publish to GHCR
uses: docker/build-push-action@v6
uses: docker/build-push-action@f9f3042f7e2789586610d6e8b85c8f03e5195baf # v7.2.0
with:
context: .
push: true
tags: ${{ steps.image-metadata.outputs.tags }}
labels: ${{ steps.image-metadata.outputs.labels }}
platforms: linux/amd64,linux/arm64
platforms: linux/amd64,linux/arm64,linux/arm/v7
- name: Upload Release Assets
id: upload-release-assets
uses: svenstaro/upload-release-action@v2
uses: svenstaro/upload-release-action@29e53e917877a24fad85510ded594ab3c9ca12de # v2
with:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: build/prod/*.zip
@ -93,5 +103,26 @@ jobs:
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."
npm-publish:
permissions:
id-token: write
contents: read
needs: main
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
- name: Set node version
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
with:
node-version: 24
registry-url: "https://registry.npmjs.org"
- name: Install
run: npm ci
- name: Create machine generated files
run: npm run node
- name: Publish to NPM
run: npm publish

2
.gitignore vendored
View File

@ -10,6 +10,8 @@ src/core/config/OperationConfig.json
src/core/operations/index.mjs
src/node/config/OperationConfig.json
src/node/index.mjs
tests/operations/index.mjs
**/*.DS_Store
tests/browser/output/*
.node-version
chrome

2
.nvmrc
View File

@ -1 +1 @@
18
24

425
CHANGELOG.md
View File

@ -13,6 +13,202 @@ All major and minor version changes will be documented in this file. Details of
## Details
### [11.1.0] - 2026-06-13
This release includes a security fix ([#2557])
- Security: Add fix, and tests, for Lorem Ipsum DoS issue [@GCHQDeveloper581] | [#2557]
- chore (deps): bump the patch-updates group with 4 updates | [#2552]
- chore (deps): bump the actions-dependencies group with 2 updates | [#2551]
- chore (deps): bump the docker-dependencies group with 2 updates | [#2550]
- chore (deps): bump protobufjs from 8.5.0 to 8.6.2 in the minor-updates group | [#2553]
- Security Policy Update [@C85297] | [#2547]
- Fix spurious error messages generated during webpack build [@GCHQDeveloper581] | [#2545]
- chore (deps): bump shell-quote from 1.8.3 to 1.8.4 | [#2543]
- Implementing ROR13 feature [@Fufu-btw] | [#2539]
- New operation improvements [@jl5193] [@GCHQDeveloper581] | [#1431]
- Npm and yarn/major version updates [@GCHQDeveloper581] | [#2527]
- Update README to reflect AES Decrypt changes [@andreasrtv] | [#2502]
- feat: add Escape Smart Characters operation [@HarelKatz] | [#2391]
- feat: Get AES IV from input (QoL) [@andreasrtv] | [#2471]
- fix: validate text encoding options [@SyedIshmumAhnaf] | [#2497]
- chore (deps): bump the minor-updates group with 5 updates [@GCHQDeveloper581] | [#2500]
- chore (deps): bump the patch-updates group with 2 updates | [#2499]
- chore (deps): bump nginxinc/nginx-unprivileged from `df0e9ed` to `0a1e718` in the docker-dependencies group | [#2498]
- Add remove ANSI escape codes operation [@Louis-Ladd] [@GCHQDeveloper581] | [#2143]
- Fix option ingredients being overwriten [@C85297] | [#2341]
- chore (deps): bump qs and express | [#2478]
- chore (deps): bump tmp from 0.2.5 to 0.2.7 | [#2479]
- chore (deps): bump the patch-updates group across 1 directory with 6 updates | [#2463]
- chore (deps): bump the docker-dependencies group across 1 directory with 2 updates | [#2468]
- chore (deps): bump terser from 5.46.2 to 5.48.0 | [#2385]
- Make dependabot quieter [@GCHQDeveloper581] | [#2467]
- update sitemap [@Blank0120] | [#2443]
- Bump webpack-dev-server to 5.2.4 [@GCHQDeveloper581] | [#2417]
- Fix pgp tests [@GCHQDeveloper581] [@C85297] | [#2461]
- chore (deps): bump the patch-updates group across 1 directory with 4 updates | [#2438]
- chore (deps): bump docker/setup-buildx-action from 4.0.0 to 4.1.0 | [#2439]
- chore (deps): bump docker/login-action from 4.1.0 to 4.2.0 | [#2441]
- chore (deps): bump docker/metadata-action from 6.0.0 to 6.1.0 | [#2442]
- update bson [@Blank0120] [@GCHQDeveloper581] | [#2425]
- chore (deps): bump webpack from 5.106.2 to 5.107.1 | [#2428]
- chore (deps): bump protobufjs from 7.5.8 to 7.6.0 | [#2429]
- chore (deps): bump sql-formatter from 15.7.4 to 15.8.0 | [#2430]
- chore (deps): bump docker/build-push-action from 7.1.0 to 7.2.0 | [#2431]
- Fix flaky `npm run testui` [@lzandman] | [#2412]
- Include git ref in website download zip name [@C85297] | [#2339]
- Bump nginxinc/nginx-unprivileged from `808f784` to `b9f7ba1` | [#2389]
- Series Chart HTML Formatting fix [@C85297] | [#2403]
- Parse Ethernet Frame HTML formatting fix [@C85297] | [#2402]
- Parse IPv4 Header HTML formatting fix [@C85297] | [#2401]
- Update chromedriver, and install corresponding chrome in workflows (fixes build) [@GCHQDeveloper581] | [#2387]
- chore (deps): bump @codemirror/view from 6.41.1 to 6.43.0 | [#2384]
- chore (deps): bump globals from 17.5.0 to 17.6.0 | [#2386]
- chore (deps): bump the patch-updates group across 1 directory with 3 updates | [#2388]
- [StepSecurity] Apply security best practices [@GCHQDeveloper581] StepSecurity Bot <bot@stepsecurity.io> | [#2378]
- Build docker container for arm v7 as well [@GCHQDeveloper581] | [#2379]
- chore (deps): bump fast-uri from 3.1.0 to 3.1.2 | [#2372]
- update bcryptjs [@C85297] [@GCHQDeveloper581] | [#2368]
- chore (deps): bump picomatch from 2.3.1 to 2.3.2 | [#2370]
- chore (deps): bump ip-address from 10.1.0 to 10.2.0 | [#2371]
- chore (deps): bump axios from 1.15.0 to 1.16.0 | [#2369]
- feat(operation-wrap): add new Wrap operation to format text at specified line width [@0xff1ce] | [#1882]
- chore (deps): bump the patch-updates group across 1 directory with 5 updates | [#2354]
- chore (deps): bump docker/login-action from 3 to 4 | [#2363]
- chore (deps): bump docker/setup-buildx-action from 3 to 4 | [#2364]
- chore (deps): bump crazy-max/ghaction-github-pages from 3 to 5 | [#2365]
- chore (deps): bump docker/metadata-action from 4 to 6 | [#2366]
- chore (deps): bump docker/setup-qemu-action from 3 to 4 | [#2367]
- Update dependabot for Node 24. [@GCHQDeveloper581] | [#2361]
- chore (deps): bump uuid from 13.0.0 to 14.0.0 | [#2332]
- chore (deps): bump webpack-bundle-analyzer from 5.2.0 to 5.3.0 | [#2353]
- Fix all zeros after 16384 bytes with Blake3 [@zachbowden] [@GCHQDeveloper581] | [#2351]
## [11.0.0] - 2026-04-28
- Revert sitemap to v8.0.X to fix build/deploy on master [@GCHQDeveloper581] | [#2348]
- Node version update from 22 to 24 [@lzandman] [@GCHQDeveloper581] | [#2347]
- Fix XSS in Show Base64 offsets [@C85297] | [#2346]
- Make compatible with node >=22 [@GCHQDeveloper581] | [#2273]
- Fix(node): enable asynchronous operation support in Node.js API [@engin0223] [@GCHQDeveloper581] | [#2342]
- Feature: Change to nginx-unprivileged image for better kubernetes support [@hsolberg] | [#1922]
Breaking changes:
- Minimum supported node version - now v24 (was v16)
- Change of exported port on Docker Container - now 8080 (was 80)
- Node API now exports "bake" and "execute" functions as async.
<details>
<summary>Click to expand v10 minor versions</summary>
### [10.24.0] - 2026-04-27
- Update CONTRIBUTING.md [@GCHQDeveloper581] | [#2333]
- Fix, and link, Fernet tests [@GCHQDeveloper581] | [#2335]
- [#927] added parity bit operation [@j83305] | [#1036]
- Feature md link blanks [@BjoernAkAManf] [@GCHQDeveloper581] | [#660]
- Accessibility - Add support for screenreaders in operations search [@mattnotmitt] | [#1862]
- Added metadata extraction for UUID strings. [@ko80240] | [#2322]
- chore (deps): bump the patch-updates group with 6 updates | [#2330]
- chore (deps): bump @codemirror/search from 6.6.0 to 6.7.0 | [#2331]
- (Feature) Improve CI [@GCHQDeveloper581] | [#2328]
- Update dependabot.yml [@GCHQDeveloper581] | [#2326]
- chore (deps): bump lodash, grunt-legacy-log and grunt-legacy-util | [#2327]
- chore (deps): bump the patch-updates group with 6 updates [@GCHQDeveloper581] | [#2323]
- chore (deps): bump autoprefixer from 10.4.27 to 10.5.0 | [#2324]
- chore (deps): bump dompurify from 3.3.3 to 3.4.0 | [#2321]
- chore (deps): bump follow-redirects from 1.15.11 to 1.16.0 | [#2320]
- Regular Expression operation email address regex: Support IPv4 domains [@C85297] [@GCHQDeveloper581] | [#2167]
- Rewriting fixCryptoApiImports and fixSnackbarMarkup to js to make it OS agnostic [@BigYellowHammer] | [#2298]
- chore (deps): bump basic-ftp from 5.2.1 to 5.2.2 | [#2317]
- chore (deps): bump axios from 1.13.6 to 1.15.0 | [#2316]
- chore (deps): bump webpack from 5.105.4 to 5.106.0 | [#2315]
- chore (deps): bump basic-ftp from 5.2.0 to 5.2.1 | [#2313]
- Update vulnerable dependencies [@GCHQDeveloper581] | [#2311]
### [10.23.0] - 2026-04-06
- Properly escape HTML entities in sampleDelim to avoid XSS issue [@GCHQDeveloper581] | [#2307]
- chore (deps): bump lodash from 4.17.23 to 4.18.1 | [#2304]
- chore (deps): bump @codemirror/view from 6.40.0 to 6.41.0 | [#2305]
- chore (deps): bump the patch-updates group with 2 updates | [#2303]
- chore (deps): bump @xmldom/xmldom from 0.8.11 to 0.8.12 | [#2302]
- chore (deps): bump picomatch | [#2299]
- chore (deps): bump node-forge from 1.3.3 to 1.4.0 | [#2297]
- chore (deps): bump the patch-updates group with 3 updates | [#2296]
- chore (deps) bump chromedriver from 130.0.4 to 146.0.6 [@GCHQDeveloper581] | [#2292]
- ParseEthernetFrame - Fix vlan calculation [@Kalkran] | [#2295]
- Add pull request template with AI usage disclosure [@C85297] | [#2279]
- fix: return empty output for zero-length To Modhex input [@saschabuehrle] | [#2249]
- Added tab focus to top banner and navigation to About/Support Modal [@j264415] | [#1733]
- Add Parse Ethernet frame Operation, allow Parse IPv4 Header to cascade [@Kalkran] | [#1722]
- Selection and Deselection of autobake checkbox using keyboard [@j264415] | [#1727]
- chore (deps): bump @babel/runtime from 7.28.6 to 7.29.2 | [#2263]
- Add more helpful error for when numerical ingredient is left empty [@Lamby777] [@C85297] | [#1540]
- chore (deps): bump @codemirror/view from 6.39.17 to 6.40.0 | [#2262]
- Bump flatted from 3.3.2 to 3.4.2 [@GCHQDeveloper581] | [#2266]
- feat: add Raw option for Jq operation [@rtpt-romankarwacik] | [#2237]
- chore (deps): bump core-js from 3.48.0 to 3.49.0 | [#2261]
- chore (deps): bump the patch-updates group with 6 updates | [#2260]
- Add Extract Audio Metadata operation [@d0s1nt] [@GCHQDeveloper581] | [#2170]
- Fix Jq issue [@GCHQDeveloper581] | [#2210]
- Configure dependabot updates [@GCHQDeveloper581] | [#2259]
- fix(A1Z26): return empty string instead of empty array for empty input [@brick-pixel] | [#2257]
- Fix broken Docker link in README [@am-periphery] | [#2250]
- Update some dependencies, including a number causing npm audit warnings [@GCHQDeveloper581] | [#2236]
- Bump axios from 1.7.9 to 1.13.6 | [#2234]
- Bump jws from 3.2.2 to 3.2.3 | [#2235]
- Bump pbkdf2 from 3.1.2 to 3.1.5 | [#2229]
- Bump form-data from 4.0.1 to 4.0.5 | [#2228]
- Bump basic-ftp from 5.0.5 to 5.2.0 | [#2231]
- feat: add ARM disassembler operation [@thomasxm] | [#2156]
- Add Text/Integer Converter operation [@p-leriche] [@GCHQDeveloper581] | [#2213]
- Feat/rc6 add RC6 Encrypt/Decrypt operations [@thomasxm] | [#2163]
- [bugfix] Add Bootstrap form style for CodeMirror editor [@Swonkie] | [#2161]
- Add Flask Session operations (Decode, Sign, Verify) [@ThePlayer372-FR] | [#2208]
- fix: `jq-web` -> `jq-wasm`, includes `jq` version `1.8.1` [@W-Floyd] [@GCHQDeveloper581] | [#2223]
- Bump jsonwebtoken from 8.5.1 to 9.0.0 [@GCHQDeveloper581] | [#2219]
- Bump basic-ftp from 5.0.5 to 5.2.0 | [#2218]
- feat: add random integer generation operation [@cktgh] | [#2151]
- Add BigInt utility functions for number theory operations [@p-leriche] [@GCHQDeveloper581] | [#2205]
- Improve SQL Beautify: use sql-formatter and support bind variables [@aby-jo] [@GCHQDeveloper581] | [#2071]
- update tesseract.js to 6.0.1 [@atsiv1] | [#2133]
- Fix hint tooltip display issues [@bartvanandel] | [#2017]
- Simplify babel dependencies [@GCHQDeveloper581] | [#2204]
- Dependency updates [@GCHQDeveloper581] | [#2201]
- Fix: Move Magic checks from Escape to Unescape Unicode Characters [@fjh1997] | [#2195]
- Paste spreadsheets as text [@C85297] | [#2200]
- Fix Roboto Mono font [@C85297] | [#2199]
- Fix return of buffer for PNG QR image generation [@GCHQDeveloper581] [@C85297] | [#2125]
- Update JIMP [@C85297] | [#2171]
- Overwrite NGINX maintainer label [@C85297] | [#2194]
- Bump v10.22.1 [@GCHQDeveloper581] | [#2193]
- Fix npm publish - Run "npm ci" and "npm run node" under node 18 then switch to node 24.5 [@GCHQDeveloper581] | [#2192]
### [10.22.0] - 2026-02-11
- Separate npm publish out into separate job and run with Node 24.5 [@GCHQDeveloper581] | [#2188]
- Fixed Percent delimiter for hex encoding [@beneri] [@C85297] | [#2137]
- Added the ability to paste one or more Images from the Clipboard [@t-martine] [@a3957273] [@C85297] | [#1876]
- Quoted Printable - consistent reference to 'email' [@wesinator] | [#2186]
- Fix freeze when output text decoding fails [@Raka-loah] | [#1573]
- Update Browserslist DB [@C85297] | [#2183]
- Add contents write permission to releases workflow [@C85297] | [#2182]
- Fix release workflow permissions [@C85297] | [#2181]
### [10.21.0] - 2026-02-05
- Fix import operations with special chars in them [@d98762625] [@jg42526] | [#1040]
- Remove custom CodeQL workflow [@C85297] | [#2176]
- Fix code scanning warnings in workflows [@GCHQDeveloper581] | [#2177]
- Use NPM trusted publishing [@C85297] [@GCHQDeveloper581] | [#2174]
- Fix: Correctly parse xxd odd byte hexdumps [@ThomasNotTom] [@GCHQDeveloper581] | [#2058]
- Update Sitemap URLs to Use Valid Paths in sitemap.mjs [@rbpi] [@C85297] | [#1861]
- Use recommended GitHub Actions to build image [@AlexGustafsson] [@C85297] | [#2055]
- Remove version 10 message from banner [@C85297] | [#2169]
- Bump form-data from 4.0.1 to 4.0.5 | [#2175]
- Bump node-forge from 1.3.1 to 1.3.3 | [#2173]
- Update crypto browserify [@C85297] | [#2172]
- Update kbpgp package (resolves #2135) [@GCHQDeveloper581] | [#2136]
- Fix the processing of ALPNs for JA4 to align with new specification update [@tuliperis] | [#2165]
- Add Bech32 and Bech32m encoding/decoding operations [@thomasxm] | [#2159]
- Exclude Delete character from hex dump output [@mikecat] [@C85297] | [#2086]
- Tiny typo fix in "To Base85" operation [@twostraws] | [#2118]
- Bump jsonpath-plus [@C85297] | [#2166]
### [10.20.0] - 2026-01-28
- Fixed Optical Character Recognition and added tests [@n1474335] | [ab37c1e]
- Fixed JA4 version fallback value [@n1474335] | [7a5225c]
@ -166,6 +362,8 @@ All major and minor version changes will be documented in this file. Details of
- Added 'Levenshtein Distance' operation [@mikecat] | [#1498]
- Added 'Swap case' operation [@mikecat] | [#1499]
</details>
## [10.0.0] - 2023-03-22
- [Full details explained here](https://github.com/gchq/CyberChef/wiki/Character-encoding,-EOL-separators,-and-editor-features)
- Status bars added to the Input and Output [@n1474335] | [#1405]
@ -509,6 +707,12 @@ All major and minor version changes will be documented in this file. Details of
## [4.0.0] - 2016-11-28
- Initial open source commit [@n1474335] | [b1d73a72](https://github.com/gchq/CyberChef/commit/b1d73a725dc7ab9fb7eb789296efd2b7e4b08306)
[11.1.0]: https://github.com/gchq/CyberChef/releases/tag/v11.1.0
[11.0.0]: https://github.com/gchq/CyberChef/releases/tag/v11.0.0
[10.24.0]: https://github.com/gchq/CyberChef/releases/tag/v10.24.0
[10.23.0]: https://github.com/gchq/CyberChef/releases/tag/v10.23.0
[10.22.0]: https://github.com/gchq/CyberChef/releases/tag/v10.22.0
[10.21.0]: https://github.com/gchq/CyberChef/releases/tag/v10.21.0
[10.20.0]: https://github.com/gchq/CyberChef/releases/tag/v10.20.0
[10.19.0]: https://github.com/gchq/CyberChef/releases/tag/v10.19.0
[10.18.0]: https://github.com/gchq/CyberChef/releases/tag/v10.18.0
@ -521,7 +725,7 @@ All major and minor version changes will be documented in this file. Details of
[10.11.0]: https://github.com/gchq/CyberChef/releases/tag/v10.11.0
[10.10.0]: https://github.com/gchq/CyberChef/releases/tag/v10.10.0
[10.9.0]: https://github.com/gchq/CyberChef/releases/tag/v10.9.0
[10.8.0]: https://github.com/gchq/CyberChef/releases/tag/v10.7.0
[10.8.0]: https://github.com/gchq/CyberChef/releases/tag/v10.8.0
[10.7.0]: https://github.com/gchq/CyberChef/releases/tag/v10.7.0
[10.6.0]: https://github.com/gchq/CyberChef/releases/tag/v10.6.0
[10.5.0]: https://github.com/gchq/CyberChef/releases/tag/v10.5.0
@ -754,6 +958,49 @@ All major and minor version changes will be documented in this file. Details of
[@remingtr]: https://github.com/remingtr
[@0xff1ce]: https://github.com/0xff1ce
[@starplanet]: https://github.com/starplanet
[@C85297]: https://github.com/C85297
[@GCHQDeveloper581]: https://github.com/GCHQDeveloper581
[@ThomasNotTom]: https://github.com/ThomasNotTom
[@rbpi]: https://github.com/rbpi
[@AlexGustafsson]: https://github.com/AlexGustafsson
[@tuliperis]: https://github.com/tuliperis
[@thomasxm]: https://github.com/thomasxm
[@twostraws]: https://github.com/twostraws
[@beneri]: https://github.com/beneri
[@t-martine]: https://github.com/t-martine
[@wesinator]: https://github.com/wesinator
[@Raka-loah]: https://github.com/Raka-loah
[@Kalkran]: https://github.com/Kalkran
[@saschabuehrle]: https://github.com/saschabuehrle
[@j264415]: https://github.com/j264415
[@Lamby777]: https://github.com/Lamby777
[@rtpt-romankarwacik]: https://github.com/rtpt-romankarwacik
[@d0s1nt]: https://github.com/d0s1nt
[@brick-pixel]: https://github.com/brick-pixel
[@am-periphery]: https://github.com/am-periphery
[@p-leriche]: https://github.com/p-leriche
[@Swonkie]: https://github.com/Swonkie
[@ThePlayer372-FR]: https://github.com/ThePlayer372-FR
[@W-Floyd]: https://github.com/W-Floyd
[@cktgh]: https://github.com/cktgh
[@aby-jo]: https://github.com/aby-jo
[@atsiv1]: https://github.com/atsiv1
[@fjh1997]: https://github.com/fjh1997
[@j83305]: https://github.com/j83305
[@BjoernAkAManf]: https://github.com/BjoernAkAManf
[@ko80240]: https://github.com/ko80240
[@BigYellowHammer]: https://github.com/BigYellowHammer
[@hsolberg]: https://github.com/hsolberg
[@lzandman]: https://github.com/lzandman
[@engin0223]: https://github.com/engin0223
[@Fufu-btw]: https://github.com/Fufu-btw
[@jl5193]: https://github.com/jl5193
[@andreasrtv]: https://github.com/andreasrtv
[@HarelKatz]: https://github.com/HarelKatz
[@SyedIshmumAhnaf]: https://github.com/SyedIshmumAhnaf
[@Louis-Ladd]: https://github.com/Louis-Ladd
[@Blank0120]: https://github.com/Blank0120
[@zachbowden]: https://github.com/zachbowden
[8ad18b]: https://github.com/gchq/CyberChef/commit/8ad18bc7db6d9ff184ba3518686293a7685bf7b7
@ -942,3 +1189,179 @@ All major and minor version changes will be documented in this file. Details of
[#512]: https://github.com/gchq/CyberChef/issues/512
[#1732]: https://github.com/gchq/CyberChef/issues/1732
[#1789]: https://github.com/gchq/CyberChef/issues/1789
[#1040]: https://github.com/gchq/CyberChef/pull/1040
[#2176]: https://github.com/gchq/CyberChef/pull/2176
[#2177]: https://github.com/gchq/CyberChef/pull/2177
[#2174]: https://github.com/gchq/CyberChef/pull/2174
[#2058]: https://github.com/gchq/CyberChef/pull/2058
[#1861]: https://github.com/gchq/CyberChef/pull/1861
[#2055]: https://github.com/gchq/CyberChef/pull/2055
[#2169]: https://github.com/gchq/CyberChef/pull/2169
[#2175]: https://github.com/gchq/CyberChef/pull/2175
[#2173]: https://github.com/gchq/CyberChef/pull/2173
[#2172]: https://github.com/gchq/CyberChef/pull/2172
[#2136]: https://github.com/gchq/CyberChef/pull/2136
[#2165]: https://github.com/gchq/CyberChef/pull/2165
[#2159]: https://github.com/gchq/CyberChef/pull/2159
[#2086]: https://github.com/gchq/CyberChef/pull/2086
[#2118]: https://github.com/gchq/CyberChef/pull/2118
[#2166]: https://github.com/gchq/CyberChef/pull/2166
[#2188]: https://github.com/gchq/CyberChef/pull/2188
[#2137]: https://github.com/gchq/CyberChef/pull/2137
[#1876]: https://github.com/gchq/CyberChef/pull/1876
[#2186]: https://github.com/gchq/CyberChef/pull/2186
[#1573]: https://github.com/gchq/CyberChef/pull/1573
[#2183]: https://github.com/gchq/CyberChef/pull/2183
[#2182]: https://github.com/gchq/CyberChef/pull/2182
[#2181]: https://github.com/gchq/CyberChef/pull/2181
[#2307]: https://github.com/gchq/CyberChef/pull/2307
[#2304]: https://github.com/gchq/CyberChef/pull/2304
[#2305]: https://github.com/gchq/CyberChef/pull/2305
[#2303]: https://github.com/gchq/CyberChef/pull/2303
[#2302]: https://github.com/gchq/CyberChef/pull/2302
[#2299]: https://github.com/gchq/CyberChef/pull/2299
[#2297]: https://github.com/gchq/CyberChef/pull/2297
[#2296]: https://github.com/gchq/CyberChef/pull/2296
[#2292]: https://github.com/gchq/CyberChef/pull/2292
[#2295]: https://github.com/gchq/CyberChef/pull/2295
[#2279]: https://github.com/gchq/CyberChef/pull/2279
[#2249]: https://github.com/gchq/CyberChef/pull/2249
[#1733]: https://github.com/gchq/CyberChef/pull/1733
[#1722]: https://github.com/gchq/CyberChef/pull/1722
[#1727]: https://github.com/gchq/CyberChef/pull/1727
[#2263]: https://github.com/gchq/CyberChef/pull/2263
[#1540]: https://github.com/gchq/CyberChef/pull/1540
[#2262]: https://github.com/gchq/CyberChef/pull/2262
[#2266]: https://github.com/gchq/CyberChef/pull/2266
[#2237]: https://github.com/gchq/CyberChef/pull/2237
[#2261]: https://github.com/gchq/CyberChef/pull/2261
[#2260]: https://github.com/gchq/CyberChef/pull/2260
[#2170]: https://github.com/gchq/CyberChef/pull/2170
[#2210]: https://github.com/gchq/CyberChef/pull/2210
[#2259]: https://github.com/gchq/CyberChef/pull/2259
[#2257]: https://github.com/gchq/CyberChef/pull/2257
[#2250]: https://github.com/gchq/CyberChef/pull/2250
[#2236]: https://github.com/gchq/CyberChef/pull/2236
[#2234]: https://github.com/gchq/CyberChef/pull/2234
[#2235]: https://github.com/gchq/CyberChef/pull/2235
[#2229]: https://github.com/gchq/CyberChef/pull/2229
[#2228]: https://github.com/gchq/CyberChef/pull/2228
[#2231]: https://github.com/gchq/CyberChef/pull/2231
[#2156]: https://github.com/gchq/CyberChef/pull/2156
[#2213]: https://github.com/gchq/CyberChef/pull/2213
[#2163]: https://github.com/gchq/CyberChef/pull/2163
[#2161]: https://github.com/gchq/CyberChef/pull/2161
[#2208]: https://github.com/gchq/CyberChef/pull/2208
[#2223]: https://github.com/gchq/CyberChef/pull/2223
[#2219]: https://github.com/gchq/CyberChef/pull/2219
[#2218]: https://github.com/gchq/CyberChef/pull/2218
[#2151]: https://github.com/gchq/CyberChef/pull/2151
[#2205]: https://github.com/gchq/CyberChef/pull/2205
[#2071]: https://github.com/gchq/CyberChef/pull/2071
[#2133]: https://github.com/gchq/CyberChef/pull/2133
[#2017]: https://github.com/gchq/CyberChef/pull/2017
[#2204]: https://github.com/gchq/CyberChef/pull/2204
[#2201]: https://github.com/gchq/CyberChef/pull/2201
[#2195]: https://github.com/gchq/CyberChef/pull/2195
[#2200]: https://github.com/gchq/CyberChef/pull/2200
[#2199]: https://github.com/gchq/CyberChef/pull/2199
[#2125]: https://github.com/gchq/CyberChef/pull/2125
[#2171]: https://github.com/gchq/CyberChef/pull/2171
[#2194]: https://github.com/gchq/CyberChef/pull/2194
[#2193]: https://github.com/gchq/CyberChef/pull/2193
[#2192]: https://github.com/gchq/CyberChef/pull/2192
[#2333]: https://github.com/gchq/CyberChef/pull/2333
[#2335]: https://github.com/gchq/CyberChef/pull/2335
[#1036]: https://github.com/gchq/CyberChef/pull/1036
[#660]: https://github.com/gchq/CyberChef/pull/660
[#1862]: https://github.com/gchq/CyberChef/pull/1862
[#2322]: https://github.com/gchq/CyberChef/pull/2322
[#2330]: https://github.com/gchq/CyberChef/pull/2330
[#2331]: https://github.com/gchq/CyberChef/pull/2331
[#2328]: https://github.com/gchq/CyberChef/pull/2328
[#2326]: https://github.com/gchq/CyberChef/pull/2326
[#2327]: https://github.com/gchq/CyberChef/pull/2327
[#2323]: https://github.com/gchq/CyberChef/pull/2323
[#2324]: https://github.com/gchq/CyberChef/pull/2324
[#2321]: https://github.com/gchq/CyberChef/pull/2321
[#2320]: https://github.com/gchq/CyberChef/pull/2320
[#2167]: https://github.com/gchq/CyberChef/pull/2167
[#2298]: https://github.com/gchq/CyberChef/pull/2298
[#2317]: https://github.com/gchq/CyberChef/pull/2317
[#2316]: https://github.com/gchq/CyberChef/pull/2316
[#2315]: https://github.com/gchq/CyberChef/pull/2315
[#2313]: https://github.com/gchq/CyberChef/pull/2313
[#2311]: https://github.com/gchq/CyberChef/pull/2311
[#2348]: https://github.com/gchq/CyberChef/pull/2348
[#2347]: https://github.com/gchq/CyberChef/pull/2347
[#2346]: https://github.com/gchq/CyberChef/pull/2346
[#2273]: https://github.com/gchq/CyberChef/pull/2273
[#2342]: https://github.com/gchq/CyberChef/pull/2342
[#1922]: https://github.com/gchq/CyberChef/pull/1922
[#2557]: https://github.com/gchq/CyberChef/pull/2557
[#2552]: https://github.com/gchq/CyberChef/pull/2552
[#2551]: https://github.com/gchq/CyberChef/pull/2551
[#2550]: https://github.com/gchq/CyberChef/pull/2550
[#2553]: https://github.com/gchq/CyberChef/pull/2553
[#2547]: https://github.com/gchq/CyberChef/pull/2547
[#2545]: https://github.com/gchq/CyberChef/pull/2545
[#2543]: https://github.com/gchq/CyberChef/pull/2543
[#2539]: https://github.com/gchq/CyberChef/pull/2539
[#1431]: https://github.com/gchq/CyberChef/pull/1431
[#2527]: https://github.com/gchq/CyberChef/pull/2527
[#2502]: https://github.com/gchq/CyberChef/pull/2502
[#2391]: https://github.com/gchq/CyberChef/pull/2391
[#2471]: https://github.com/gchq/CyberChef/pull/2471
[#2497]: https://github.com/gchq/CyberChef/pull/2497
[#2500]: https://github.com/gchq/CyberChef/pull/2500
[#2499]: https://github.com/gchq/CyberChef/pull/2499
[#2498]: https://github.com/gchq/CyberChef/pull/2498
[#2143]: https://github.com/gchq/CyberChef/pull/2143
[#2341]: https://github.com/gchq/CyberChef/pull/2341
[#2478]: https://github.com/gchq/CyberChef/pull/2478
[#2479]: https://github.com/gchq/CyberChef/pull/2479
[#2463]: https://github.com/gchq/CyberChef/pull/2463
[#2468]: https://github.com/gchq/CyberChef/pull/2468
[#2385]: https://github.com/gchq/CyberChef/pull/2385
[#2467]: https://github.com/gchq/CyberChef/pull/2467
[#2443]: https://github.com/gchq/CyberChef/pull/2443
[#2417]: https://github.com/gchq/CyberChef/pull/2417
[#2461]: https://github.com/gchq/CyberChef/pull/2461
[#2438]: https://github.com/gchq/CyberChef/pull/2438
[#2439]: https://github.com/gchq/CyberChef/pull/2439
[#2441]: https://github.com/gchq/CyberChef/pull/2441
[#2442]: https://github.com/gchq/CyberChef/pull/2442
[#2425]: https://github.com/gchq/CyberChef/pull/2425
[#2428]: https://github.com/gchq/CyberChef/pull/2428
[#2429]: https://github.com/gchq/CyberChef/pull/2429
[#2430]: https://github.com/gchq/CyberChef/pull/2430
[#2431]: https://github.com/gchq/CyberChef/pull/2431
[#2412]: https://github.com/gchq/CyberChef/pull/2412
[#2339]: https://github.com/gchq/CyberChef/pull/2339
[#2389]: https://github.com/gchq/CyberChef/pull/2389
[#2403]: https://github.com/gchq/CyberChef/pull/2403
[#2402]: https://github.com/gchq/CyberChef/pull/2402
[#2401]: https://github.com/gchq/CyberChef/pull/2401
[#2387]: https://github.com/gchq/CyberChef/pull/2387
[#2384]: https://github.com/gchq/CyberChef/pull/2384
[#2386]: https://github.com/gchq/CyberChef/pull/2386
[#2388]: https://github.com/gchq/CyberChef/pull/2388
[#2378]: https://github.com/gchq/CyberChef/pull/2378
[#2379]: https://github.com/gchq/CyberChef/pull/2379
[#2372]: https://github.com/gchq/CyberChef/pull/2372
[#2368]: https://github.com/gchq/CyberChef/pull/2368
[#2370]: https://github.com/gchq/CyberChef/pull/2370
[#2371]: https://github.com/gchq/CyberChef/pull/2371
[#2369]: https://github.com/gchq/CyberChef/pull/2369
[#1882]: https://github.com/gchq/CyberChef/pull/1882
[#2354]: https://github.com/gchq/CyberChef/pull/2354
[#2363]: https://github.com/gchq/CyberChef/pull/2363
[#2364]: https://github.com/gchq/CyberChef/pull/2364
[#2365]: https://github.com/gchq/CyberChef/pull/2365
[#2366]: https://github.com/gchq/CyberChef/pull/2366
[#2367]: https://github.com/gchq/CyberChef/pull/2367
[#2361]: https://github.com/gchq/CyberChef/pull/2361
[#2332]: https://github.com/gchq/CyberChef/pull/2332
[#2353]: https://github.com/gchq/CyberChef/pull/2353
[#2351]: https://github.com/gchq/CyberChef/pull/2351

5
.github/CONTRIBUTING.md → CONTRIBUTING.md
View File

@ -6,10 +6,13 @@ There are lots of opportunities to contribute to CyberChef. If you want ideas, t
Before your contributions can be accepted, you must:
- Sign the [GCHQ Contributor Licence Agreement](https://cla-assistant.io/gchq/CyberChef)
- Fork the CyberChef repo
- Create a new branch within your fork for the changes
- Push your changes to your fork.
- Sign the [GCHQ Contributor Licence Agreement](https://cla-assistant.io/gchq/CyberChef)
- Submit a pull request.
Please note that we will ***reject*** pull requests from the master branch of your fork owing to the mess it makes of our own working repositories and the extra work entailed.
## Coding conventions

6
Dockerfile
View File

@ -4,7 +4,7 @@
# 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
FROM --platform=$BUILDPLATFORM node:24-alpine@sha256:fb71d01345f11b708a3553c66e7c74074f2d506400ea81973343d915cb64eef0 AS builder
WORKDIR /app
@ -27,6 +27,8 @@ RUN npm run build
#########################################
# Package static build files into nginx #
#########################################
FROM nginx:stable-alpine AS cyberchef
FROM nginxinc/nginx-unprivileged:stable-alpine@sha256:37f356a5eba5d187365b4f59cd6cc29f1f922ad18146d554b576a80983377e6a AS cyberchef
LABEL maintainer="GCHQ <oss@gchq.gov.uk>"
COPY --from=builder /app/build/prod /usr/share/nginx/html/

47
Gruntfile.js
View File

@ -6,7 +6,7 @@ const BundleAnalyzerPlugin = require("webpack-bundle-analyzer").BundleAnalyzerPl
const glob = require("glob");
const path = require("path");
const nodeFlags = "--experimental-modules --experimental-json-modules --experimental-specifier-resolution=node --no-warnings --no-deprecation";
const nodeFlags = "--no-warnings --no-deprecation";
/**
* Grunt configuration for building the app in various formats.
@ -89,6 +89,8 @@ module.exports = function (grunt) {
const compileYear = grunt.template.today("UTC:yyyy"),
compileTime = grunt.template.today("UTC:dd/mm/yyyy HH:MM:ss") + " UTC",
pkg = grunt.file.readJSON("package.json"),
version = process.env.GITHUB_SHA || `v${pkg.version}`,
downloadZipFilename = `CyberChef_${version}.zip`,
webpackConfig = require("./webpack.config.js"),
BUILD_CONSTANTS = {
COMPILE_YEAR: JSON.stringify(compileYear),
@ -129,7 +131,9 @@ module.exports = function (grunt) {
chunks: ["main"],
compileYear: compileYear,
compileTime: compileTime,
version: pkg.version,
version: version,
latestReleaseVersion: pkg.version,
downloadZipFilename: downloadZipFilename,
minify: {
removeComments: true,
collapseWhitespace: true,
@ -140,7 +144,8 @@ module.exports = function (grunt) {
new BundleAnalyzerPlugin({
analyzerMode: "static",
reportFilename: "BundleAnalyzerReport.html",
openAnalyzer: false
openAnalyzer: false,
excludeAssets: /.*Worker.js/
}),
]
};
@ -245,7 +250,7 @@ module.exports = function (grunt) {
"!build/prod/index.html",
"!build/prod/BundleAnalyzerReport.html",
],
dest: `build/prod/CyberChef_v${pkg.version}.zip`
dest: `build/prod/${downloadZipFilename}`
}
},
connect: {
@ -333,12 +338,12 @@ module.exports = function (grunt) {
switch (process.platform) {
case "darwin":
return chainCommands([
`shasum -a 256 build/prod/CyberChef_v${pkg.version}.zip | awk '{print $1;}' > build/prod/sha256digest.txt`,
`shasum -a 256 build/prod/${downloadZipFilename} | awk '{print $1;}' > build/prod/sha256digest.txt`,
`sed -i '' -e "s/DOWNLOAD_HASH_PLACEHOLDER/$(cat build/prod/sha256digest.txt)/" build/prod/index.html`
]);
default:
return chainCommands([
`sha256sum build/prod/CyberChef_v${pkg.version}.zip | awk '{print $1;}' > build/prod/sha256digest.txt`,
`sha256sum build/prod/${downloadZipFilename} | awk '{print $1;}' > build/prod/sha256digest.txt`,
`sed -i -e "s/DOWNLOAD_HASH_PLACEHOLDER/$(cat build/prod/sha256digest.txt)/" build/prod/index.html`
]);
}
@ -411,39 +416,13 @@ module.exports = function (grunt) {
stdout: false,
},
fixCryptoApiImports: {
command: function () {
switch (process.platform) {
case "darwin":
return `find ./node_modules/crypto-api/src/ \\( -type d -name .git -prune \\) -o -type f -print0 | xargs -0 sed -i '' -e '/\\.mjs/!s/\\(from "\\.[^"]*\\)";/\\1.mjs";/g'`;
default:
return `find ./node_modules/crypto-api/src/ \\( -type d -name .git -prune \\) -o -type f -print0 | xargs -0 sed -i -e '/\\.mjs/!s/\\(from "\\.[^"]*\\)";/\\1.mjs";/g'`;
}
},
command: `node ${nodeFlags} src/core/config/scripts/fixCryptoApiImports.mjs`,
stdout: false
},
fixSnackbarMarkup: {
command: function () {
switch (process.platform) {
case "darwin":
return `sed -i '' 's/<div id=snackbar-container\\/>/<div id=snackbar-container>/g' ./node_modules/snackbarjs/src/snackbar.js`;
default:
return `sed -i 's/<div id=snackbar-container\\/>/<div id=snackbar-container>/g' ./node_modules/snackbarjs/src/snackbar.js`;
}
},
command: `node ${nodeFlags} src/core/config/scripts/fixSnackBarMarkup.mjs`,
stdout: false
},
fixJimpModule: {
command: function () {
switch (process.platform) {
case "darwin":
// Space added before comma to prevent multiple modifications
return `sed -i '' 's/"es\\/index.js",/"es\\/index.js" ,\\n "type": "module",/' ./node_modules/jimp/package.json`;
default:
return `sed -i 's/"es\\/index.js",/"es\\/index.js" ,\\n "type": "module",/' ./node_modules/jimp/package.json`;
}
},
stdout: false
}
},
});
};

12
README.md
View File

@ -24,7 +24,7 @@ Cryptographic operations in CyberChef should not be relied upon to provide secur
**Prerequisites**
- [Docker](hhttps://www.docker.com/products/docker-desktop/)
- [Docker](https://www.docker.com/products/docker-desktop/)
- Docker Desktop must be open and running on your machine
@ -36,7 +36,7 @@ docker build --tag cyberchef --ulimit nofile=10000 .
```
2. Run the docker container
```bash
docker run -it -p 8080:80 cyberchef
docker run -it -p 8080:8080 cyberchef
```
3. Navigate to `http://localhost:8080` in your browser
@ -45,7 +45,7 @@ docker run -it -p 8080:80 cyberchef
If you prefer to skip the build process, you can use the pre-built image
```bash
docker run -it -p 8080:80 ghcr.io/gchq/cyberchef:latest
docker run -it -p 8080:8080 ghcr.io/gchq/cyberchef:latest
```
Just like before, navigate to `http://localhost:8080` in your browser.
@ -72,6 +72,7 @@ You can use as many operations as you like in simple or complex ways. Some examp
- [Carry out different operations on data of different types][8]
- [Use parts of the input as arguments to operations][9]
- [Perform AES decryption, extracting the IV from the beginning of the cipher stream][10]
- [A simpler way to perform the same AES Decryption][13]
- [Automagically detect several layers of nested encoding][12]
@ -120,7 +121,7 @@ CyberChef is built to support
## Node.js support
CyberChef is built to fully support Node.js `v16`. For more information, see the ["Node API" wiki page](https://github.com/gchq/CyberChef/wiki/Node-API)
CyberChef is built to fully support Node.js `v24`. For more information, see the ["Node API" wiki page](https://github.com/gchq/CyberChef/wiki/Node-API)
## Contributing
@ -147,6 +148,7 @@ CyberChef is released under the [Apache 2.0 Licence](https://www.apache.org/lice
[7]: https://gchq.github.io/CyberChef/#recipe=Fork('%5C%5Cn','%5C%5Cn',false)From_UNIX_Timestamp('Seconds%20(s)')&input=OTc4MzQ2ODAwCjEwMTI2NTEyMDAKMTA0NjY5NjQwMAoxMDgxMDg3MjAwCjExMTUzMDUyMDAKMTE0OTYwOTYwMA
[8]: https://gchq.github.io/CyberChef/#recipe=Fork('%5C%5Cn','%5C%5Cn',false)Conditional_Jump('1',false,'base64',10)To_Hex('Space')Return()Label('base64')To_Base64('A-Za-z0-9%2B/%3D')&input=U29tZSBkYXRhIHdpdGggYSAxIGluIGl0ClNvbWUgZGF0YSB3aXRoIGEgMiBpbiBpdA
[9]: https://gchq.github.io/CyberChef/#recipe=Register('key%3D(%5B%5C%5Cda-f%5D*)',true,false)Find_/_Replace(%7B'option':'Regex','string':'.*data%3D(.*)'%7D,'$1',true,false,true)RC4(%7B'option':'Hex','string':'$R0'%7D,'Hex','Latin1')&input=aHR0cDovL21hbHdhcmV6LmJpei9iZWFjb24ucGhwP2tleT0wZTkzMmE1YyZkYXRhPThkYjdkNWViZTM4NjYzYTU0ZWNiYjMzNGUzZGIxMQ
[10]: https://gchq.github.io/CyberChef/#recipe=Register('(.%7B32%7D)',true,false)Drop_bytes(0,32,false)AES_Decrypt(%7B'option':'Hex','string':'1748e7179bd56570d51fa4ba287cc3e5'%7D,%7B'option':'Hex','string':'$R0'%7D,'CTR','Hex','Raw',%7B'option':'Hex','string':''%7D)&input=NTFlMjAxZDQ2MzY5OGVmNWY3MTdmNzFmNWI0NzEyYWYyMGJlNjc0YjNiZmY1M2QzODU0NjM5NmVlNjFkYWFjNDkwOGUzMTljYTNmY2Y3MDg5YmZiNmIzOGVhOTllNzgxZDI2ZTU3N2JhOWRkNmYzMTFhMzk0MjBiODk3OGU5MzAxNGIwNDJkNDQ3MjZjYWVkZjU0MzZlYWY2NTI0MjljMGRmOTRiNTIxNjc2YzdjMmNlODEyMDk3YzI3NzI3M2M3YzcyY2Q4OWFlYzhkOWZiNGEyNzU4NmNjZjZhYTBhZWUyMjRjMzRiYTNiZmRmN2FlYjFkZGQ0Nzc2MjJiOTFlNzJjOWU3MDlhYjYwZjhkYWY3MzFlYzBjYzg1Y2UwZjc0NmZmMTU1NGE1YTNlYzI5MWNhNDBmOWU2MjlhODcyNTkyZDk4OGZkZDgzNDUzNGFiYTc5YzFhZDE2NzY3NjlhN2MwMTBiZjA0NzM5ZWNkYjY1ZDk1MzAyMzcxZDYyOWQ5ZTM3ZTdiNGEzNjFkYTQ2OGYxZWQ1MzU4OTIyZDJlYTc1MmRkMTFjMzY2ZjMwMTdiMTRhYTAxMWQyYWYwM2M0NGY5NTU3OTA5OGExNWUzY2Y5YjQ0ODZmOGZmZTljMjM5ZjM0ZGU3MTUxZjZjYTY1MDBmZTRiODUwYzNmMWMwMmU4MDFjYWYzYTI0NDY0NjE0ZTQyODAxNjE1YjhmZmFhMDdhYzgyNTE0OTNmZmRhN2RlNWRkZjMzNjg4ODBjMmI5NWIwMzBmNDFmOGYxNTA2NmFkZDA3MWE2NmNmNjBlNWY0NmYzYTIzMGQzOTdiNjUyOTYzYTIxYTUzZg
[10]: https://gchq.github.io/CyberChef/#recipe=Register('(.%7B32%7D)',true,false,false)Drop_bytes(0,32,false)AES_Decrypt(%7B'option':'Hex','string':'1748e7179bd56570d51fa4ba287cc3e5'%7D,%7B'option':'Hex','string':'$R0'%7D,16,'CTR','Hex','Raw',%7B'option':'Hex','string':''%7D,%7B'option':'Hex','string':''%7D,'Off')&input=NTFlMjAxZDQ2MzY5OGVmNWY3MTdmNzFmNWI0NzEyYWYyMGJlNjc0YjNiZmY1M2QzODU0NjM5NmVlNjFkYWFjNDkwOGUzMTljYTNmY2Y3MDg5YmZiNmIzOGVhOTllNzgxZDI2ZTU3N2JhOWRkNmYzMTFhMzk0MjBiODk3OGU5MzAxNGIwNDJkNDQ3MjZjYWVkZjU0MzZlYWY2NTI0MjljMGRmOTRiNTIxNjc2YzdjMmNlODEyMDk3YzI3NzI3M2M3YzcyY2Q4OWFlYzhkOWZiNGEyNzU4NmNjZjZhYTBhZWUyMjRjMzRiYTNiZmRmN2FlYjFkZGQ0Nzc2MjJiOTFlNzJjOWU3MDlhYjYwZjhkYWY3MzFlYzBjYzg1Y2UwZjc0NmZmMTU1NGE1YTNlYzI5MWNhNDBmOWU2MjlhODcyNTkyZDk4OGZkZDgzNDUzNGFiYTc5YzFhZDE2NzY3NjlhN2MwMTBiZjA0NzM5ZWNkYjY1ZDk1MzAyMzcxZDYyOWQ5ZTM3ZTdiNGEzNjFkYTQ2OGYxZWQ1MzU4OTIyZDJlYTc1MmRkMTFjMzY2ZjMwMTdiMTRhYTAxMWQyYWYwM2M0NGY5NTU3OTA5OGExNWUzY2Y5YjQ0ODZmOGZmZTljMjM5ZjM0ZGU3MTUxZjZjYTY1MDBmZTRiODUwYzNmMWMwMmU4MDFjYWYzYTI0NDY0NjE0ZTQyODAxNjE1YjhmZmFhMDdhYzgyNTE0OTNmZmRhN2RlNWRkZjMzNjg4ODBjMmI5NWIwMzBmNDFmOGYxNTA2NmFkZDA3MWE2NmNmNjBlNWY0NmYzYTIzMGQzOTdiNjUyOTYzYTIxYTUzZg
[11]: https://gchq.github.io/CyberChef/#recipe=XOR(%7B'option':'Hex','string':'3a'%7D,'Standard',false)To_Hexdump(16,false,false)&input=VGhlIGFuc3dlciB0byB0aGUgdWx0aW1hdGUgcXVlc3Rpb24gb2YgbGlmZSwgdGhlIFVuaXZlcnNlLCBhbmQgZXZlcnl0aGluZyBpcyA0Mi4
[12]: https://gchq.github.io/CyberChef/#recipe=Magic(3,false,false)&input=V1VhZ3dzaWFlNm1QOGdOdENDTFVGcENwQ0IyNlJtQkRvREQ4UGFjZEFtekF6QlZqa0syUXN0RlhhS2hwQzZpVVM3UkhxWHJKdEZpc29SU2dvSjR3aGptMWFybTg2NHFhTnE0UmNmVW1MSHJjc0FhWmM1VFhDWWlmTmRnUzgzZ0RlZWpHWDQ2Z2FpTXl1QlY2RXNrSHQxc2NnSjg4eDJ0TlNvdFFEd2JHWTFtbUNvYjJBUkdGdkNLWU5xaU45aXBNcTFaVTFtZ2tkYk51R2NiNzZhUnRZV2hDR1VjOGc5M1VKdWRoYjhodHNoZVpud1RwZ3FoeDgzU1ZKU1pYTVhVakpUMnptcEM3dVhXdHVtcW9rYmRTaTg4WXRrV0RBYzFUb291aDJvSDRENGRkbU5LSldVRHBNd21uZ1VtSzE0eHdtb21jY1BRRTloTTE3MkFQblNxd3hkS1ExNzJSa2NBc3lzbm1qNWdHdFJtVk5OaDJzMzU5d3I2bVMyUVJQ
[13]: https://gchq.github.io/CyberChef/#recipe=AES_Decrypt(%7B'option':'Hex','string':'1748e7179bd56570d51fa4ba287cc3e5'%7D,%7B'option':'Hex','string':'$R0'%7D,16,'CTR','Hex','Raw',%7B'option':'Hex','string':''%7D,%7B'option':'Hex','string':''%7D,'From%20start')&input=NTFlMjAxZDQ2MzY5OGVmNWY3MTdmNzFmNWI0NzEyYWYyMGJlNjc0YjNiZmY1M2QzODU0NjM5NmVlNjFkYWFjNDkwOGUzMTljYTNmY2Y3MDg5YmZiNmIzOGVhOTllNzgxZDI2ZTU3N2JhOWRkNmYzMTFhMzk0MjBiODk3OGU5MzAxNGIwNDJkNDQ3MjZjYWVkZjU0MzZlYWY2NTI0MjljMGRmOTRiNTIxNjc2YzdjMmNlODEyMDk3YzI3NzI3M2M3YzcyY2Q4OWFlYzhkOWZiNGEyNzU4NmNjZjZhYTBhZWUyMjRjMzRiYTNiZmRmN2FlYjFkZGQ0Nzc2MjJiOTFlNzJjOWU3MDlhYjYwZjhkYWY3MzFlYzBjYzg1Y2UwZjc0NmZmMTU1NGE1YTNlYzI5MWNhNDBmOWU2MjlhODcyNTkyZDk4OGZkZDgzNDUzNGFiYTc5YzFhZDE2NzY3NjlhN2MwMTBiZjA0NzM5ZWNkYjY1ZDk1MzAyMzcxZDYyOWQ5ZTM3ZTdiNGEzNjFkYTQ2OGYxZWQ1MzU4OTIyZDJlYTc1MmRkMTFjMzY2ZjMwMTdiMTRhYTAxMWQyYWYwM2M0NGY5NTU3OTA5OGExNWUzY2Y5YjQ0ODZmOGZmZTljMjM5ZjM0ZGU3MTUxZjZjYTY1MDBmZTRiODUwYzNmMWMwMmU4MDFjYWYzYTI0NDY0NjE0ZTQyODAxNjE1YjhmZmFhMDdhYzgyNTE0OTNmZmRhN2RlNWRkZjMzNjg4ODBjMmI5NWIwMzBmNDFmOGYxNTA2NmFkZDA3MWE2NmNmNjBlNWY0NmYzYTIzMGQzOTdiNjUyOTYzYTIxYTUzZg

26
SECURITY.md
View File

@ -2,25 +2,15 @@
## Supported Versions
CyberChef is supported on a best endeavours basis. Patches will be applied to
the latest version rather than retroactively to older versions. To ensure you
are using the most secure version of CyberChef, please make sure you have the
[latest release](https://github.com/gchq/CyberChef/releases/latest). The
official [live demo](https://gchq.github.io/CyberChef/) is always up to date.
CyberChef is supported on a best endeavours basis.
Patches will be applied to the latest version rather than retroactively to older versions.
To ensure you are using the most secure version of CyberChef, please make sure you have the [latest release](https://github.com/gchq/CyberChef/releases/latest). [The official website](https://gchq.github.io/CyberChef/) is always up to date.
## Reporting a Vulnerability
In most scenarios, the most appropriate way to report a vulnerability is to
[raise a new issue](https://github.com/gchq/CyberChef/issues/new/choose)
describing the problem in as much detail as possible, ideally with examples.
This will obviously be public. If you feel that the vulnerability is
significant enough to warrant a private disclosure, please email
[oss@gchq.gov.uk](mailto:oss@gchq.gov.uk) and
[n1474335@gmail.com](mailto:n1474335@gmail.com).
If you discover a vulnerability in CyberChef, please do not publicly disclose it, and do not create a GitHub issue.
Disclosures of vulnerabilities in CyberChef are always welcomed. Whilst we aim
to write clean and secure code free from bugs, we recognise that this is an open
source project written by analysts in their spare time, relying on dozens of
open source libraries that are modified and updated on a regular basis. We hope
that the community will continue to support us as we endeavour to maintain and
develop this tool together.
Instead, send an email as soon as possible to [CyberChefSecurity@gchq.gov.uk](mailto:CyberChefSecurity@gchq.gov.uk).
The report will be acknowledged and actioned urgently by the CyberChef maintainers.
If you do not receive a timely acknowledgement, please notify [oss@gchq.gov.uk](mailto:oss@gchq.gov.uk) and [CyberChef@gchq.gov.uk](mailto:CyberChef@gchq.gov.uk) of your vulnerability report.

11
babel.config.js
View File

@ -10,18 +10,15 @@ module.exports = function(api) {
}]
],
"plugins": [
"dynamic-import-node",
"@babel/plugin-syntax-import-assertions",
[
"babel-plugin-transform-builtin-extend", {
"globals": ["Error"]
}
],
[
"@babel/plugin-transform-runtime", {
"regenerator": true
}
]
]
],
"generatorOpts": {
"importAttributesKeyword": "with"
}
};
};

9627
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

165
package.json
View File

@ -1,8 +1,8 @@
{
"name": "cyberchef",
"version": "10.20.0",
"version": "11.1.0",
"description": "The Cyber Swiss Army Knife for encryption, encoding, compression and data analysis.",
"author": "n1474335 <n1474335@gmail.com>",
"author": "GCHQ <CyberChef@gchq.gov.uk>",
"homepage": "https://gchq.github.io/CyberChef",
"copyright": "Crown copyright 2016",
"license": "Apache-2.0",
@ -36,84 +36,84 @@
"browserslist": [
"Chrome >= 50",
"Firefox >= 38",
"node >= 16"
"node >= 24"
],
"devDependencies": {
"@babel/core": "^7.24.7",
"@babel/eslint-parser": "^7.24.7",
"@babel/plugin-syntax-import-assertions": "^7.24.7",
"@babel/plugin-transform-runtime": "^7.24.7",
"@babel/preset-env": "^7.24.7",
"@babel/runtime": "^7.24.7",
"@codemirror/commands": "^6.6.0",
"@codemirror/language": "^6.10.2",
"@codemirror/search": "^6.5.6",
"@codemirror/state": "^6.4.1",
"@codemirror/view": "^6.28.0",
"autoprefixer": "^10.4.19",
"babel-loader": "^9.1.3",
"babel-plugin-dynamic-import-node": "^2.3.3",
"babel-plugin-transform-builtin-extend": "1.1.2",
"@babel/eslint-parser": "^7.29.7",
"@babel/plugin-syntax-import-assertions": "^7.28.6",
"@babel/plugin-transform-runtime": "^7.29.7",
"@babel/preset-env": "^7.29.7",
"@babel/runtime": "^7.29.7",
"@codemirror/commands": "^6.10.3",
"@codemirror/language": "^6.12.3",
"@codemirror/search": "^6.7.0",
"@codemirror/state": "^6.5.4",
"@codemirror/view": "^6.43.1",
"@puppeteer/browsers": "3.0.4",
"autoprefixer": "^10.5.0",
"babel-loader": "^10.1.1",
"base64-loader": "^1.0.0",
"chromedriver": "^130.0.0",
"chromedriver": "^148.0.4",
"cli-progress": "^3.12.0",
"colors": "^1.4.0",
"compression-webpack-plugin": "^11.1.0",
"copy-webpack-plugin": "^12.0.2",
"core-js": "^3.37.1",
"cspell": "^8.17.3",
"css-loader": "7.1.2",
"eslint": "^9.4.0",
"eslint-plugin-jsdoc": "^48.2.9",
"globals": "^15.4.0",
"grunt": "^1.6.1",
"compression-webpack-plugin": "^12.0.0",
"copy-webpack-plugin": "^14.0.0",
"core-js": "^3.49.0",
"cspell": "^10.0.1",
"css-loader": "^7.1.4",
"eslint": "^9.39.4",
"eslint-plugin-jsdoc": "^50.8.0",
"globals": "^17.6.0",
"grunt": "^1.6.2",
"grunt-chmod": "~1.1.1",
"grunt-concurrent": "^3.0.0",
"grunt-contrib-clean": "~2.0.1",
"grunt-contrib-connect": "^4.0.0",
"grunt-contrib-connect": "^5.0.1",
"grunt-contrib-copy": "~1.0.0",
"grunt-contrib-watch": "^1.1.0",
"grunt-eslint": "^25.0.0",
"grunt-eslint": "^26.0.0",
"grunt-exec": "~3.0.0",
"grunt-webpack": "^6.0.0",
"grunt-webpack": "^8.0.0",
"grunt-zip": "^1.0.0",
"html-webpack-plugin": "^5.6.0",
"html-webpack-plugin": "^5.6.7",
"imports-loader": "^5.0.0",
"mini-css-extract-plugin": "2.9.0",
"mini-css-extract-plugin": "2.10.2",
"modify-source-webpack-plugin": "^4.1.0",
"nightwatch": "^3.6.3",
"postcss": "^8.4.38",
"nightwatch": "^3.16.0",
"postcss": "^8.5.15",
"postcss-css-variables": "^0.19.0",
"postcss-import": "^16.1.0",
"postcss-loader": "^8.1.1",
"postcss-import": "^16.1.1",
"postcss-loader": "^8.2.1",
"prompt": "^1.3.0",
"sitemap": "^8.0.0",
"terser": "^5.31.1",
"webpack": "^5.91.0",
"webpack-bundle-analyzer": "^4.10.2",
"webpack-dev-server": "5.0.4",
"sitemap": "^9.0.1",
"terser": "^5.48.0",
"webpack": "^5.107.2",
"webpack-bundle-analyzer": "^5.3.0",
"webpack-dev-server": "^5.2.4",
"webpack-node-externals": "^3.0.0",
"worker-loader": "^3.0.8"
},
"dependencies": {
"@alexaltea/capstone-js": "^3.0.5",
"@astronautlabs/amf": "^0.0.6",
"@babel/polyfill": "^7.12.1",
"@blu3r4y/lzma": "^2.3.3",
"@noble/hashes": "2.2.0",
"@wavesenterprise/crypto-gost-js": "^2.1.0-RC1",
"@xmldom/xmldom": "^0.8.10",
"@xmldom/xmldom": "^0.8.13",
"argon2-browser": "^1.18.0",
"arrive": "^2.4.1",
"avsc": "^5.7.7",
"bcryptjs": "^2.4.3",
"bignumber.js": "^9.1.2",
"arrive": "^2.5.3",
"assert": "^2.1.0",
"avsc": "^5.7.9",
"bcryptjs": "^3.0.3",
"bignumber.js": "^11.1.3",
"blakejs": "^1.2.1",
"bootstrap": "4.6.2",
"bootstrap-colorpicker": "^3.4.0",
"bootstrap-material-design": "^4.1.3",
"browserify-zlib": "^0.2.0",
"bson": "^4.7.2",
"bson": "^7.2.0",
"buffer": "^6.0.3",
"cbor": "9.0.2",
"cbor": "10.0.12",
"chi-squared": "^1.1.0",
"codepage": "^1.15.0",
"crypto-api": "^0.8.5",
@ -122,88 +122,95 @@
"ctph.js": "0.0.5",
"d3": "7.9.0",
"d3-hexbin": "^0.2.2",
"diff": "^5.2.0",
"dompurify": "^3.2.5",
"diff": "^9.0.0",
"dompurify": "^3.4.8",
"es6-promisify": "^7.0.0",
"escodegen": "^2.1.0",
"esprima": "^4.0.1",
"events": "^3.3.0",
"exif-parser": "^0.1.12",
"fernet": "^0.4.0",
"fernet": "^0.3.3",
"file-saver": "^2.0.5",
"flat": "^6.0.1",
"geodesy": "1.1.3",
"handlebars": "^4.7.8",
"hash-wasm": "^4.12.0",
"highlight.js": "^11.9.0",
"handlebars": "^4.7.9",
"highlight.js": "^11.11.1",
"ieee754": "^1.2.1",
"jimp": "^0.22.12",
"jimp": "1.6.0",
"jq-web": "^0.5.1",
"jquery": "3.7.1",
"js-sha3": "^0.9.3",
"jsesc": "^3.0.2",
"jsesc": "^3.1.0",
"json5": "^2.2.3",
"jsonata": "^2.0.3",
"jsonpath-plus": "^10.3.0",
"jsonwebtoken": "8.5.1",
"jsonata": "^2.2.1",
"jsonpath-plus": "^10.4.0",
"jsonwebtoken": "9.0.3",
"jsqr": "^1.4.0",
"jsrsasign": "^11.1.0",
"jsrsasign": "^11.1.3",
"kbpgp": "^2.1.17",
"libbzip2-wasm": "0.0.4",
"libyara-wasm": "^1.2.1",
"lodash": "^4.17.21",
"loglevel": "^1.9.1",
"lodash": "^4.18.1",
"loglevel": "^1.9.2",
"loglevel-message-prefix": "^3.0.0",
"lz-string": "^1.5.0",
"lz4js": "^0.2.0",
"markdown-it": "^14.1.0",
"markdown-it": "^14.2.0",
"moment": "^2.30.1",
"moment-timezone": "^0.5.45",
"moment-timezone": "^0.6.2",
"ngeohash": "^0.6.3",
"node-forge": "^1.3.1",
"node-forge": "^1.4.0",
"node-md6": "^0.1.0",
"nodom": "^2.4.0",
"notepack.io": "^3.0.1",
"ntlm": "^0.1.3",
"nwmatcher": "^1.4.4",
"otpauth": "9.3.6",
"otpauth": "^9.5.0",
"path": "^0.12.7",
"popper.js": "^1.16.1",
"process": "^0.11.10",
"protobufjs": "^7.3.1",
"protobufjs": "^8.6.2",
"punycode.js": "^2.3.1",
"qr-image": "^3.2.0",
"reflect-metadata": "^0.2.2",
"rison": "^0.1.1",
"scryptsy": "^2.1.0",
"snackbarjs": "^1.1.0",
"sortablejs": "^1.15.2",
"sortablejs": "^1.15.7",
"split.js": "^1.6.5",
"sql-formatter": "^15.8.1",
"ssdeep.js": "0.0.3",
"stream-browserify": "^3.0.0",
"tesseract.js": "5.1.0",
"ua-parser-js": "^1.0.38",
"tesseract.js": "^7.0.0",
"ua-parser-js": "^2.0.10",
"unorm": "^1.6.0",
"url": "^0.11.4",
"utf8": "^3.0.0",
"uuid": "^11.1.0",
"uuid": "^14.0.0",
"vkbeautify": "^0.99.3",
"xpath": "0.0.34",
"xregexp": "^5.1.1",
"xregexp": "^5.1.2",
"zlibjs": "^0.3.1"
},
"scripts": {
"start": "npx grunt dev",
"build": "npx grunt prod",
"node": "npx grunt node",
"repl": "node --experimental-modules --experimental-json-modules --experimental-specifier-resolution=node --no-experimental-fetch --no-warnings src/node/repl.mjs",
"test": "npx grunt configTests && node --experimental-modules --experimental-json-modules --no-warnings --no-deprecation --openssl-legacy-provider --no-experimental-fetch tests/node/index.mjs && node --experimental-modules --experimental-json-modules --no-warnings --no-deprecation --openssl-legacy-provider --no-experimental-fetch --trace-uncaught tests/operations/index.mjs",
"repl": "node --no-warnings src/node/repl.mjs",
"test": "npx grunt configTests && node --no-warnings --no-deprecation --openssl-legacy-provider tests/node/index.mjs && node --no-warnings --no-deprecation --openssl-legacy-provider --trace-uncaught tests/operations/index.mjs",
"testnodeconsumer": "npx grunt testnodeconsumer",
"testui": "npx grunt testui",
"testuidev": "npx nightwatch --env=dev",
"lint": "npx grunt lint",
"lint:grammar": "cspell ./src",
"postinstall": "npx grunt exec:fixCryptoApiImports && npx grunt exec:fixSnackbarMarkup && npx grunt exec:fixJimpModule",
"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",
"postinstall": "npx grunt exec:fixCryptoApiImports && npx grunt exec:fixSnackbarMarkup",
"newop": "node src/core/config/scripts/newOperation.mjs",
"minor": "node src/core/config/scripts/newMinorVersion.mjs && npm version minor --git-tag-version=false && echo \"Updated to version v$(npm pkg get version | xargs), please create a pull request and once merged use 'npm run tag'\"",
"tag": "git tag -s \"v$(npm pkg get version | xargs)\" -m \"$(npm pkg get version | xargs)\" && echo \"Created v$(npm pkg get version | xargs), now check and push the tag\"",
"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"
},
"engines": {
"node": ">=24 <25"
}
}

11
src/core/Chef.mjs
View File

@ -55,8 +55,15 @@ class Chef {
progress = await recipe.execute(this.dish, progress);
} catch (err) {
log.error(err);
let displayStr;
if ("displayStr" in err) {
displayStr = err.displayStr;
} else {
displayStr = err.toString();
}
error = {
displayStr: err.displayStr,
displayStr: displayStr,
};
progress = err.progress;
}
@ -131,6 +138,8 @@ class Chef {
if (!highlights) return false;
if (direction === "reverse") highlights.reverse();
for (let i = 0; i < highlights.length; i++) {
// Remove multiple highlights before processing again
pos = [pos[0]];

2
src/core/ChefWorker.js
View File

@ -7,7 +7,7 @@
*/
import Chef from "./Chef.mjs";
import OperationConfig from "./config/OperationConfig.json" assert {type: "json"};
import OperationConfig from "./config/OperationConfig.json" with { type: "json" };
import OpModules from "./config/modules/OpModules.mjs";
import loglevelMessagePrefix from "loglevel-message-prefix";

7
src/core/Ingredient.mjs Executable file → Normal file
View File

@ -5,7 +5,8 @@
*/
import Utils from "./Utils.mjs";
import {fromHex} from "./lib/Hex.mjs";
import { fromHex } from "./lib/Hex.mjs";
import OperationError from "./errors/OperationError.mjs";
/**
* The arguments to operations.
@ -119,7 +120,9 @@ class Ingredient {
number = parseFloat(data);
if (isNaN(number)) {
const sample = Utils.truncate(data.toString(), 10);
throw "Invalid ingredient value. Not a number: " + sample;
throw new OperationError(
"Invalid ingredient value. Not a number: " + sample,
);
}
return number;
default:

7
src/core/Operation.mjs
View File

@ -5,6 +5,7 @@
*/
import Dish from "./Dish.mjs";
import OperationError from "./errors/OperationError.mjs";
import Ingredient from "./Ingredient.mjs";
/**
@ -223,7 +224,11 @@ class Operation {
*/
set ingValues(ingValues) {
ingValues.forEach((val, i) => {
this._ingList[i].value = val;
try {
this._ingList[i].value = val;
} catch (err) {
throw new OperationError(`Failed to set value of ingredient '${this._ingList[i].name}': ${err}`);
}
});
}

17
src/core/Recipe.mjs
View File

@ -4,7 +4,7 @@
* @license Apache-2.0
*/
import OperationConfig from "./config/OperationConfig.json" assert {type: "json"};
import OperationConfig from "./config/OperationConfig.json" with { type: "json" };
import OperationError from "./errors/OperationError.mjs";
import Operation from "./Operation.mjs";
import DishError from "./errors/DishError.mjs";
@ -70,11 +70,15 @@ class Recipe {
if (o instanceof Operation) {
return o;
} else {
const op = new modules[o.module][o.name]();
op.ingValues = o.ingValues;
op.breakpoint = o.breakpoint;
op.disabled = o.disabled;
return op;
try {
const op = new modules[o.module][o.name]();
op.ingValues = o.ingValues;
op.breakpoint = o.breakpoint;
op.disabled = o.disabled;
return op;
} catch (err) {
throw new Error(`Failed to hydrate operation '${o.name}': ${err}`);
}
}
});
}
@ -229,6 +233,7 @@ class Recipe {
}
this.lastRunOp = op;
} catch (err) {
log.error(err);
// Return expected errors as output
if (err instanceof OperationError || err?.type === "OperationError") {
// Cannot rely on `err instanceof OperationError` here as extending

28
src/core/config/Categories.json
View File

@ -41,6 +41,7 @@
"From Base",
"To BCD",
"From BCD",
"Text-Integer Conversion",
"To HTML Entity",
"From HTML Entity",
"URL Encode",
@ -48,6 +49,7 @@
"Escape Unicode Characters",
"Unescape Unicode Characters",
"Normalise Unicode",
"Escape Smart Characters",
"To Quoted Printable",
"From Quoted Printable",
"To Punycode",
@ -109,12 +111,15 @@
"Rabbit",
"SM4 Encrypt",
"SM4 Decrypt",
"RC6 Encrypt",
"RC6 Decrypt",
"GOST Encrypt",
"GOST Decrypt",
"GOST Sign",
"GOST Verify",
"GOST Key Wrap",
"GOST Key Unwrap",
"ROR13",
"ROT13",
"ROT13 Brute Force",
"ROT47",
@ -164,7 +169,10 @@
"Typex",
"Lorenz",
"Colossus",
"SIGABA"
"SIGABA",
"Flask Session Decode",
"Flask Session Sign",
"Flask Session Verify"
]
},
{
@ -182,6 +190,7 @@
"Generate PGP Key Pair",
"PGP Encrypt",
"PGP Decrypt",
"PGP Sign",
"PGP Verify",
"PGP Encrypt and Sign",
"PGP Decrypt and Verify",
@ -222,6 +231,9 @@
"Subtract",
"Multiply",
"Divide",
"Modular Exponentiation",
"Modular Inverse",
"Extended GCD",
"Mean",
"Median",
"Standard Deviation",
@ -229,6 +241,7 @@
"Bit shift right",
"Rotate left",
"Rotate right",
"ROR13",
"ROT13",
"ROT8000"
]
@ -240,6 +253,7 @@
"DNS over HTTPS",
"Strip HTTP headers",
"Dechunk HTTP response",
"Parse Ethernet frame",
"Parse User Agent",
"Parse IP range",
"Parse IPv6 address",
@ -293,6 +307,7 @@
"Diff",
"Remove whitespace",
"Remove null bytes",
"Remove ANSI Escape Codes",
"To Upper case",
"To Lower case",
"Swap case",
@ -338,6 +353,7 @@
"Pseudo-Random Number Generator",
"Sleep",
"File Tree",
"Wrap",
"Take nth bytes",
"Drop nth bytes"
]
@ -376,6 +392,7 @@
"CSS selector",
"Extract EXIF",
"Extract ID3",
"Extract Audio Metadata",
"Extract Files",
"RAKE",
"Template"
@ -454,7 +471,8 @@
"Luhn Checksum",
"CRC Checksum",
"TCP/IP Checksum",
"XOR Checksum"
"XOR Checksum",
"Parity Bit"
]
},
{
@ -505,7 +523,8 @@
"View Bit Plane",
"Randomize Colour Palette",
"Extract LSB",
"ELF Info"
"ELF Info",
"Extract Audio Metadata"
]
},
{
@ -540,6 +559,7 @@
"Series chart",
"Heatmap chart",
"Render PDF"
"Extract Audio Metadata"
]
},
{
@ -551,7 +571,9 @@
"Chi Square",
"P-list Viewer",
"Disassemble x86",
"Disassemble ARM",
"Pseudo-Random Number Generator",
"Pseudo-Random Integer Generator",
"Generate De Bruijn Sequence",
"Generate UUID",
"Analyse UUID",

54
src/core/config/scripts/fixCryptoApiImports.mjs Normal file
View File

@ -0,0 +1,54 @@
/**
* This script updates crypto-api package
* It adds .mjs to local imports where its missing
*
* before:
* import foo from "./bar";
* after
* import foo from "./bar.mjs";
*
*/
/* eslint no-console: ["off"] */
import { readdirSync, readFileSync, writeFileSync } from "fs";
import { join } from "path";
// Base directory of crypto-api source
const baseDir = join(process.cwd(), "node_modules/crypto-api/src");
/**
* Recursively walk a directory, updating import statements
* to include ".mjs" if missing
*/
function walk(dir) {
const entries = readdirSync(dir, { withFileTypes: true });
for (const entry of entries) {
if (entry.name === ".git") continue;
const fullPath = join(dir, entry.name);
if (entry.isDirectory()) {
walk(fullPath);
} else if (entry.isFile()) {
const content = readFileSync(fullPath, "utf8");
// Add .mjs to imports if not present
const updated = content.replace(
/from "(\.[^"]*)";/g,
(match, p1) => {
if (p1.endsWith(".mjs")) return match;
return `from "${p1}.mjs";`;
}
);
if (updated !== content) {
writeFileSync(fullPath, updated, "utf8");
}
}
}
}
// Run the walker
walk(baseDir);

28
src/core/config/scripts/fixSnackBarMarkup.mjs Normal file
View File

@ -0,0 +1,28 @@
/**
* This script updates snackbarjs package
* Replaces self-closing div with standard opening div
*
* before:
* <div id=snackbar-container/>
* after:
* <div id=snackbar-container>
*
*/
/* eslint no-console: ["off"] */
import { readFileSync, writeFileSync } from "fs";
import { join } from "path";
// Base directory of snackbarjs source
const filePath = join(process.cwd(), "node_modules/snackbarjs/src/snackbar.js");
const content = readFileSync(filePath, "utf8");
// Replace self-closing div with standard opening div
const updated = content.replace(
/<div id=snackbar-container\/>/g,
"<div id=snackbar-container>"
);
writeFileSync(filePath, updated, "utf8");

63
src/core/config/scripts/generateOpsIndex.mjs
View File

@ -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.");

289
src/core/config/scripts/newMinorVersion.mjs
View File

@ -7,138 +7,197 @@
*/
/* eslint no-console: ["off"] */
/* eslint jsdoc/require-jsdoc: ["off"] */
import prompt from "prompt";
import colors from "colors";
import path from "path";
import fs from "fs";
import fs from "fs";
import process from "process";
import { execSync } from "child_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);
}
const ignoredAuthors = ["github-advanced-security[bot]", "dependabot[bot]"];
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
];
async function main() {
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 knownContributors = changelogData.match(/^\[@([^\]]+)\]/gm);
knownContributors = knownContributors.map(c => c.slice(2, -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,
];
const date = (new Date()).toISOString().split("T")[0];
let knownContributors = changelogData.match(/^\[@([^\]]+)\]/gm);
knownContributors = knownContributors.map((c) => c.slice(2, -1));
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,
const date = new Date().toISOString().split("T")[0];
const lastVersionSha = execSync(
`git rev-list -n 1 v${lastVersion[1]}.${lastVersion[2]}.${lastVersion[3]}`,
{
encoding: "utf8",
},
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]$/,
).trim();
if (lastVersionSha.length !== 40) {
throw new Error(
`Unexpected output from git rev-list: ${lastVersionSha}`,
);
}
const features = [];
const commits = await (
await fetch(`https://api.github.com/repos/gchq/cyberchef/commits`)
).json();
let foundLast = false;
for (const commit of commits) {
if (commit.sha === lastVersionSha) {
foundLast = true;
break;
} else {
const feature = {
message: "",
authors: [],
id: "",
};
const msgparts = commit.commit.message.split("\n\n");
feature.message = msgparts[0];
const prIdMatch = feature.message.match(/\(#(\d+)\)$/);
if (prIdMatch !== null) {
feature.message = feature.message
.replace(prIdMatch[0], "")
.trim();
feature.id = prIdMatch[1];
}
if (!ignoredAuthors.includes(commit.author.login)) {
feature.authors.push(commit.author.login);
}
if (msgparts.length > 1) {
msgparts[1]
.split("\n")
.filter((line) => line.startsWith("Co-authored-by: "))
.forEach((line) => {
let coAuthor = line.slice("Co-authored-by: ".length);
if (coAuthor.indexOf(">") !== -1) {
const email = coAuthor.slice(
coAuthor.indexOf("<") + 1,
coAuthor.indexOf(">"),
);
if (email.endsWith("@users.noreply.github.com")) {
coAuthor = email.slice(
email.indexOf("+") + 1,
-"@users.noreply.github.com".length,
);
} else {
throw new Error(
"Could not get ID of co-author: " +
coAuthor,
);
}
} else {
throw new Error(
"Could not get email of co-author: " + coAuthor,
);
}
if (!ignoredAuthors.includes(coAuthor)) {
feature.authors.push(coAuthor);
}
});
}
features.push(feature);
}
}
};
if (!foundLast) {
throw new Error(
`Could not find last version commit: ${lastVersionSha} - need to add paging functionality`,
);
}
// 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);
}
let message = `### [${newVersion[0]}.${newVersion[1]}.${newVersion[2]}] - ${date}\n`;
prompt.message = "";
prompt.delimiter = ":".green;
const authors = [];
const prIDs = [];
const commitIDs = [];
const features = [];
const authors = [];
const prIDs = [];
const commitIDs = [];
features.forEach((feature) => {
const id =
feature.id.length > 10 ? feature.id.slice(0, 7) : "#" + feature.id;
message += `- ${feature.message} ${feature.authors.map((a) => `[@${a}]`).join(" ")} | [${id}]\n`;
prompt.start();
feature.authors.forEach((author) => {
if (!knownContributors.includes(author)) {
knownContributors.push(author);
authors.push(`[@${author}]: https://github.com/${author}`);
}
});
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();
if (feature.id.length > 10) {
commitIDs.push(
`[${id}]: https://github.com/gchq/CyberChef/commit/${feature.id}`,
);
} 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\nCommit changes and then run `npm version minor`.");
prIDs.push(
`[#${feature.id}]: https://github.com/gchq/CyberChef/pull/${feature.id}`,
);
}
});
};
getFeature();
// 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|issues)\/[^\n]+\n)\n*$/,
"$1" + prID + "\n\n",
);
});
fs.writeFileSync(path.join(process.cwd(), "CHANGELOG.md"), changelogData);
}
main().catch(console.error);

35
src/core/config/scripts/newOperation.mjs
View File

@ -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.`);
});

2
src/core/dishTypes/DishType.mjs
View File

@ -11,7 +11,7 @@
class DishType {
/**
* Warn translations dont work without value from bind
* Warn translations don't work without value from bind
*/
static checkForValue(value) {
if (value === undefined) {

2
src/core/errors/ExcludedOperationError.mjs
View File

@ -1,5 +1,5 @@
/**
* Custom error type for handling operation that isnt included in node.js API
* Custom error type for handling operation that isn't included in node.js API
*
* @author d98762625 [d98762625@gmail.com]
* @copyright Crown Copyright 2018

103
src/core/lib/AudioBytes.mjs Normal file
View File

@ -0,0 +1,103 @@
/**
* Byte-reading and text-decoding utilities for audio metadata parsing.
*
* @author d0s1nt [d0s1nt@cyberchefaudio]
* @copyright Crown Copyright 2025
* @license Apache-2.0
*/
/** @returns {string} 4-byte ASCII at offset, or "" if out of bounds. */
export function ascii4(b, off) {
if (off + 4 > b.length) return "";
return String.fromCharCode(b[off], b[off + 1], b[off + 2], b[off + 3]);
}
/** @returns {number} Byte offset of ASCII needle `s`, or -1. */
export function indexOfAscii(b, s, start, end) {
const limit = Math.max(0, Math.min(end, b.length) - s.length);
for (let i = start; i <= limit; i++) {
let ok = true;
for (let j = 0; j < s.length; j++) {
if (b[i + j] !== s.charCodeAt(j)) {
ok = false;
break;
}
}
if (ok) return i;
}
return -1;
}
/** @returns {number} Unsigned 32-bit big-endian read. */
export function u32be(bytes, off) {
return ((bytes[off] << 24) >>> 0) | (bytes[off + 1] << 16) | (bytes[off + 2] << 8) | bytes[off + 3];
}
/** @returns {number} Unsigned 32-bit little-endian read. */
export function u32le(bytes, off) {
return (bytes[off] | (bytes[off + 1] << 8) | (bytes[off + 2] << 16) | (bytes[off + 3] << 24)) >>> 0;
}
/** @returns {number} Unsigned 16-bit little-endian read. */
export function u16le(bytes, off) {
return bytes[off] | (bytes[off + 1] << 8);
}
/** @returns {BigInt} Unsigned 64-bit little-endian read. */
export function u64le(bytes, off) {
return BigInt(u32le(bytes, off)) | (BigInt(u32le(bytes, off + 4)) << 32n);
}
/** @returns {number} Decoded ID3v2 synchsafe integer from four 7-bit bytes. */
export function synchsafeToInt(b0, b1, b2, b3) {
return ((b0 & 0x7f) << 21) | ((b1 & 0x7f) << 14) | ((b2 & 0x7f) << 7) | (b3 & 0x7f);
}
/** @returns {string} Decoded UTF-16LE byte range, nulls stripped. */
export function decodeUtf16LE(b, off, len) {
if (len <= 0 || off + len > b.length) return "";
try {
return new TextDecoder("utf-16le").decode(b.slice(off, off + len)).replace(/\u0000/g, "").trim();
} catch {
return "";
}
}
/** @returns {{valueBytes: Uint8Array, next: number}} Bytes until null terminator, UTF-16 aware. */
export function readNullTerminated(bytes, start, encoding) {
const isUtf16 = encoding === 1 || encoding === 2;
if (!isUtf16) {
let i = start;
while (i < bytes.length && bytes[i] !== 0x00) i++;
return { valueBytes: bytes.slice(start, i), next: i + 1 };
}
let i = start;
while (i + 1 < bytes.length && !(bytes[i] === 0x00 && bytes[i + 1] === 0x00)) i += 2;
return { valueBytes: bytes.slice(start, i), next: i + 2 };
}
const ID3_ENCODINGS = ["iso-8859-1", "utf-16", "utf-16be", "utf-8"];
/** @returns {string} Text decoded using ID3v2 encoding byte (0=latin1, 1=utf16, 2=utf16be, 3=utf8). */
export function decodeText(bytes, encoding) {
if (!bytes || bytes.length === 0) return "";
try {
return new TextDecoder(ID3_ENCODINGS[encoding] || "utf-16").decode(bytes);
} catch {
return safeUtf8(bytes);
}
}
/** @returns {string} UTF-8 decode with replacement (never throws). */
export function safeUtf8(bytes) {
try {
return new TextDecoder("utf-8", { fatal: false }).decode(bytes);
} catch {
return "";
}
}
/** @returns {string} ISO-8859-1 decode, nulls stripped, trimmed. */
export function decodeLatin1Trim(bytes) {
return decodeText(bytes, 0).replace(/\u0000/g, "").trim();
}

82
src/core/lib/AudioMetaSchema.mjs Normal file
View File

@ -0,0 +1,82 @@
/**
* Report skeleton and container detection for audio metadata extraction.
*
* @author d0s1nt [d0s1nt@cyberchefaudio]
* @copyright Crown Copyright 2025
* @license Apache-2.0
*/
/* eslint-disable camelcase */
import { ascii4, indexOfAscii } from "./AudioBytes.mjs";
/** Builds the empty report skeleton ready for a format parser to populate. */
export function makeEmptyReport(filename, byteLength, container) {
return {
schema_version: "audio-meta-1.0",
artifact: {
filename,
byte_length: byteLength,
container: { type: container.type, brand: container.brand || null, mime: container.mime || null },
},
detections: { metadata_systems: [], provenance_systems: [] },
tags: {
common: {
title: null, artist: null, album: null, date: null, track: null,
genre: null, comment: null, composer: null, copyright: null, language: null,
},
raw: {},
},
embedded: [],
provenance: {
c2pa: {
present: false,
embedding: [],
manifest_store: { active_manifest_urn: null, instance_id: null, claim_generator: null },
assertions: [],
signature: {
algorithm: null, signing_time: null,
certificate: { subject_cn: null, issuer_cn: null, serial_number: null },
},
validation: { validation_state: "Unknown", reasons: [], details_raw: null },
},
},
errors: [],
};
}
/** Detects the audio container format from magic bytes. */
export function sniffContainer(b) {
if (b.length >= 3 && b[0] === 0x49 && b[1] === 0x44 && b[2] === 0x33)
return { type: "mp3", mime: "audio/mpeg" };
if (b.length >= 2 && b[0] === 0xff && (b[1] & 0xe0) === 0xe0) {
if ((b[1] & 0x06) === 0x00) return { type: "aac", mime: "audio/aac" };
return { type: "mp3", mime: "audio/mpeg" };
}
if (b.length >= 8 && b[0] === 0x0b && b[1] === 0x77)
return { type: "ac3", mime: "audio/ac3" };
if (b.length >= 16 &&
b[0] === 0x30 && b[1] === 0x26 && b[2] === 0xb2 && b[3] === 0x75 &&
b[4] === 0x8e && b[5] === 0x66 && b[6] === 0xcf && b[7] === 0x11)
return { type: "wma", mime: "audio/x-ms-wma" };
if (b.length >= 12 && ascii4(b, 0) === "RIFF" && ascii4(b, 8) === "WAVE")
return { type: "wav", mime: "audio/wav" };
if (b.length >= 12 && ascii4(b, 0) === "BW64" && ascii4(b, 8) === "WAVE")
return { type: "bw64", mime: "audio/wav" };
if (b.length >= 4 && ascii4(b, 0) === "fLaC")
return { type: "flac", mime: "audio/flac" };
if (b.length >= 4 && ascii4(b, 0) === "OggS") {
const idx = indexOfAscii(b, "OpusHead", 0, Math.min(b.length, 65536));
return idx >= 0 ? { type: "opus", mime: "audio/ogg" } : { type: "ogg", mime: "audio/ogg" };
}
if (b.length >= 12 && ascii4(b, 4) === "ftyp") {
const brand = ascii4(b, 8);
const isM4A = brand === "M4A " || brand === "M4B " || brand === "M4P ";
return { type: isM4A ? "m4a" : "mp4", mime: isM4A ? "audio/mp4" : "video/mp4", brand };
}
if (b.length >= 12 && ascii4(b, 0) === "FORM") {
const formType = ascii4(b, 8);
if (formType === "AIFF" || formType === "AIFC") return { type: "aiff", mime: "audio/aiff", brand: formType };
}
return { type: "unknown", mime: null };
}

630
src/core/lib/AudioParsers.mjs Normal file
View File

@ -0,0 +1,630 @@
/**
* Format-specific audio metadata parsers.
*
* @author d0s1nt [d0s1nt@cyberchefaudio]
* @copyright Crown Copyright 2025
* @license Apache-2.0
*/
/* eslint-disable camelcase */
import {
ascii4, indexOfAscii,
u32be, u32le, u16le, u64le, synchsafeToInt,
decodeUtf16LE, readNullTerminated, decodeText,
safeUtf8, decodeLatin1Trim,
} from "./AudioBytes.mjs";
/** Parses MP3 metadata: ID3v2 frames, ID3v1 footer, APEv2 tags. */
export function parseMp3(b, report) {
processId3v2(b, report);
processId3v1(b, report);
const ape = parseApeV2BestEffort(b);
if (ape) {
report.detections.metadata_systems.push("apev2");
report.tags.raw.apev2 = ape;
}
}
/** Iterates ID3v2 frames and populates the report. */
function processId3v2(b, report) {
report.detections.metadata_systems.push("id3v2");
const id3 = parseId3v2(b);
report.tags.raw.id3v2 = id3 ? { header: id3.header, frames: [] } : null;
if (id3) {
for (const f of id3.frames) {
const entry = { id: f.id, size: f.size, description: ID3_FRAME_DESCRIPTIONS[f.id] || null };
if (f.id[0] === "T" && f.id !== "TXXX") {
const text = f.data?.length >= 1 ?
decodeText(f.data.slice(1), f.data[0]).replace(/\u0000/g, "").trim() :
"";
entry.decoded = text;
if (f.id === "TLEN") {
const ms = normalizeTlen(text);
if (ms !== null) entry.normalized_ms = ms;
}
mapCommonId3(report, f.id, text);
} else if (f.id === "TXXX") {
const txxx = decodeTxxx(f.data);
entry.decoded = txxx;
if (!report.tags.raw.id3v2.txxx) report.tags.raw.id3v2.txxx = [];
report.tags.raw.id3v2.txxx.push(txxx);
} else if (f.id === "COMM") {
const comm = decodeCommFrame(f.data);
entry.decoded = comm;
if (comm?.text && !report.tags.common.comment) report.tags.common.comment = comm.text;
} else if (f.id === "GEOB") {
processGeobFrame(f, entry, report);
}
report.tags.raw.id3v2.frames.push(entry);
}
} else {
report.detections.metadata_systems = report.detections.metadata_systems.filter((x) => x !== "id3v2");
}
}
/** Parses GEOB frame contents, populates entry, embedded objects, and C2PA provenance. */
function processGeobFrame(f, entry, report) {
const d = f.data, enc = d[0];
let off = 1;
const mime = readNullTerminated(d, off, 0);
const mimeType = decodeLatin1Trim(mime.valueBytes);
off = mime.next;
const file = readNullTerminated(d, off, enc);
const filename = decodeText(file.valueBytes, enc).replace(/\u0000/g, "").trim();
off = file.next;
const desc = readNullTerminated(d, off, enc);
const description = decodeText(desc.valueBytes, enc).replace(/\u0000/g, "").trim();
off = desc.next;
const objLen = d.length - off;
entry.geob = { mimeType, filename, description, object_bytes: objLen };
const geobId = `geob_${report.embedded.filter((x) => x.source === "id3v2:GEOB").length}`;
report.embedded.push({
id: geobId, source: "id3v2:GEOB",
content_type: mimeType || null, byte_length: objLen,
description: description || null, filename: filename || null,
});
const mt = (mimeType || "").toLowerCase();
if (mt.includes("c2pa") || mt.includes("jumbf") || mt.includes("application/x-c2pa-manifest-store")) {
report.provenance.c2pa.present = true;
report.provenance.c2pa.embedding.push({
carrier: "id3v2:GEOB", content_type: mimeType || null, byte_length: objLen,
});
}
}
/** Processes the 128-byte ID3v1 footer tag. */
function processId3v1(b, report) {
const id3v1 = parseId3v1(b);
if (!id3v1) return;
report.detections.metadata_systems.push("id3v1");
report.tags.raw.id3v1 = id3v1;
mapCommon(report, id3v1, ID3V1_TO_COMMON);
}
/** Parses WAV/BWF/BW64 RIFF chunks: LIST/INFO, bext, iXML, axml, ds64. */
export function parseRiffWave(b, report, maxTextBytes) {
report.detections.metadata_systems.push("riff_info");
const chunks = enumerateChunks(b, 12, b.length, 50000);
const riff = { chunks: [], info: null, bext: null, ixml: null, axml: null, ds64: null };
const info = {};
for (const c of chunks) {
riff.chunks.push({ id: c.id, size: c.size, offset: c.dataOff });
processRiffChunk(b, c, riff, info, report, maxTextBytes);
}
riff.info = Object.keys(info).length ? info : null;
report.tags.raw.riff = riff;
if (riff.info) mapCommon(report, riff.info, RIFF_TO_COMMON);
}
/** Processes a single RIFF chunk, updating riff state and the report. */
function processRiffChunk(b, c, riff, info, report, maxTextBytes) {
if (c.id === "ds64") {
riff.ds64 = { present: true, size: c.size };
if (!report.detections.metadata_systems.includes("bw64_ds64")) report.detections.metadata_systems.push("bw64_ds64");
if (report.artifact.container.type === "wav") report.artifact.container.type = "bw64";
}
if (c.id === "LIST" && ascii4(b, c.dataOff) === "INFO") {
for (const s of enumerateChunks(b, c.dataOff + 4, c.dataOff + c.size, 10000))
info[s.id] = decodeLatin1Trim(b.slice(s.dataOff, s.dataOff + s.size));
}
if (c.id === "bext") {
if (!report.detections.metadata_systems.includes("bwf_bext")) report.detections.metadata_systems.push("bwf_bext");
riff.bext = parseBext(b, c.dataOff, c.size);
}
if (c.id === "iXML" || c.id === "axml") {
const key = c.id === "iXML" ? "ixml" : "axml";
if (!report.detections.metadata_systems.includes(key)) report.detections.metadata_systems.push(key);
const payload = b.slice(c.dataOff, c.dataOff + c.size);
riff[key] = { xml: safeUtf8(payload.slice(0, Math.min(payload.length, maxTextBytes))), truncated: payload.length > maxTextBytes };
report.embedded.push({
id: `${key}_0`, source: `riff:${c.id}`, content_type: "application/xml",
byte_length: payload.length, description: `${c.id} chunk`, filename: null,
});
}
}
/** Parses FLAC metablocks: STREAMINFO, Vorbis Comment, PICTURE. */
export function parseFlac(b, report, maxTextBytes) {
report.detections.metadata_systems.push("flac_metablocks");
const blocks = parseFlacMetaBlocks(b);
report.tags.raw.flac = { blocks: [] };
for (const blk of blocks) {
report.tags.raw.flac.blocks.push({ type: blk.typeName, length: blk.length });
if (blk.typeName === "VORBIS_COMMENT") {
if (!report.detections.metadata_systems.includes("vorbis_comments")) report.detections.metadata_systems.push("vorbis_comments");
const vc = parseVorbisComment(blk.data);
report.tags.raw.vorbis_comments = vc;
mapVorbisCommon(report, vc);
} else if (blk.typeName === "PICTURE") {
const pic = parseFlacPicture(blk.data, maxTextBytes);
report.embedded.push({
id: `cover_art_${report.embedded.filter((x) => x.id.startsWith("cover_art_")).length}`,
source: "flac:PICTURE", content_type: pic.mime || null,
byte_length: pic.dataLength, description: pic.description || null, filename: null,
});
}
}
}
/** Parses OGG/Opus Vorbis comments. */
export function parseOgg(b, report) {
if (!report.detections.metadata_systems.includes("ogg_opus_tags")) report.detections.metadata_systems.push("ogg_opus_tags");
const scanEnd = Math.min(b.length, 1024 * 1024);
let tags = null;
const opusTagsIdx = indexOfAscii(b, "OpusTags", 0, scanEnd);
if (opusTagsIdx >= 0) {
report.artifact.container.type = "opus";
tags = parseVorbisComment(b.slice(opusTagsIdx + 8, scanEnd));
} else {
const vorbisIdx = indexOfAscii(b, "\x03vorbis", 0, scanEnd);
if (vorbisIdx >= 0) tags = parseVorbisComment(b.slice(vorbisIdx + 7, scanEnd));
}
report.tags.raw.ogg = { has_opustags: opusTagsIdx >= 0, has_vorbis_comment: !!tags };
if (tags) {
if (!report.detections.metadata_systems.includes("vorbis_comments")) report.detections.metadata_systems.push("vorbis_comments");
report.tags.raw.vorbis_comments = tags;
mapVorbisCommon(report, tags);
}
}
/** Best-effort top-level atom scan for MP4/M4A. */
export function parseMp4BestEffort(b, report) {
report.detections.metadata_systems.push("mp4_atoms");
const atoms = [];
let off = 0;
while (off + 8 <= b.length && atoms.length < 2000) {
const size = u32be(b, off);
const type = ascii4(b, off + 4);
if (size < 8) break;
atoms.push({ type, size, offset: off });
off += size;
}
report.tags.raw.mp4 = {
top_level_atoms: atoms.slice(0, 200),
hints: {
hasMoov: atoms.some((a) => a.type === "moov"),
hasUdta: atoms.some((a) => a.type === "udta"),
hasMeta: atoms.some((a) => a.type === "meta"),
hasIlst: atoms.some((a) => a.type === "ilst"),
},
};
}
/** Best-effort AIFF/AIFC chunk scanning for NAME, AUTH, ANNO. */
export function parseAiffBestEffort(b, report, maxTextBytes) {
report.detections.metadata_systems.push("aiff_chunks");
let off = 12;
const chunks = [];
while (off + 8 <= b.length && chunks.length < 2000) {
const id = ascii4(b, off);
const size = u32be(b, off + 4);
const dataOff = off + 8;
chunks.push({ id, size, offset: off });
if (["NAME", "AUTH", "ANNO", "(c) "].includes(id)) {
const txt = safeUtf8(b.slice(dataOff, dataOff + Math.min(size, maxTextBytes)));
if (!report.tags.raw.aiff) report.tags.raw.aiff = { chunks: [] };
report.tags.raw.aiff.chunks.push({ id, value: txt, truncated: size > maxTextBytes });
}
off = dataOff + size + (size % 2);
}
if (!report.tags.raw.aiff) report.tags.raw.aiff = {};
report.tags.raw.aiff.chunk_index = chunks.slice(0, 500);
const nameChunk = report.tags.raw.aiff?.chunks?.find((ch) => ch.id === "NAME")?.value;
if (nameChunk) report.tags.common.title = report.tags.common.title || nameChunk;
}
const AAC_SAMPLE_RATES = [96000, 88200, 64000, 48000, 44100, 32000, 24000, 22050, 16000, 12000, 11025, 8000, 7350];
const AAC_PROFILES = ["Main", "LC", "SSR", "LTP"];
const AAC_CHANNELS = ["defined in AOT", "mono", "stereo", "3.0", "4.0", "5.0", "5.1", "7.1"];
/** Parses AAC ADTS frame header for audio parameters. */
export function parseAacAdts(b, report) {
report.detections.metadata_systems.push("adts_header");
if (b.length < 7) return;
const id = (b[1] >> 3) & 0x01;
const profile = (b[2] >> 6) & 0x03;
const freqIdx = (b[2] >> 2) & 0x0f;
const chanCfg = ((b[2] & 0x01) << 2) | ((b[3] >> 6) & 0x03);
report.tags.raw.aac = {
mpeg_version: id === 1 ? "MPEG-2" : "MPEG-4",
profile: AAC_PROFILES[profile] || `Profile ${profile}`,
sample_rate: AAC_SAMPLE_RATES[freqIdx] || null,
sample_rate_index: freqIdx,
channel_configuration: chanCfg,
channel_description: AAC_CHANNELS[chanCfg] || null,
};
}
const AC3_SAMPLE_RATES = [48000, 44100, 32000];
const AC3_BITRATES = [32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 384, 448, 512, 576, 640];
const AC3_ACMODES = [
"2.0 (Ch1+Ch2)", "1.0 (C)", "2.0 (L R)", "3.0 (L C R)",
"2.1 (L R S)", "3.1 (L C R S)", "2.2 (L R SL SR)", "3.2 (L C R SL SR)",
];
/** Parses AC3 (Dolby Digital) bitstream info. */
export function parseAc3(b, report) {
report.detections.metadata_systems.push("ac3_bsi");
if (b.length < 8) return;
const fscod = (b[4] >> 6) & 0x03;
const frmsizecod = b[4] & 0x3f;
const bsid = (b[5] >> 3) & 0x1f;
const bsmod = b[5] & 0x07;
const acmod = (b[6] >> 5) & 0x07;
report.tags.raw.ac3 = {
sample_rate: AC3_SAMPLE_RATES[fscod] || null,
fscod,
bitrate_kbps: AC3_BITRATES[frmsizecod >> 1] || null,
frmsizecod, bsid, bsmod, acmod,
channel_layout: AC3_ACMODES[acmod] || null,
};
}
/** Parses WMA files (ASF container) for content description metadata. */
export function parseWmaAsf(b, report) {
report.detections.metadata_systems.push("asf_header");
if (b.length < 30) return;
const headerSize = Number(u64le(b, 16));
const numObjects = u32le(b, 24);
const headerEnd = Math.min(b.length, headerSize);
const objects = [];
let off = 30;
for (let i = 0; i < numObjects && off + 24 <= headerEnd; i++) {
const guid4 = [b[off], b[off + 1], b[off + 2], b[off + 3]];
const objSize = Number(u64le(b, off + 16));
if (objSize < 24 || off + objSize > headerEnd) break;
const dataOff = off + 24;
const dataLen = objSize - 24;
if (guid4[0] === 0x33 && guid4[1] === 0x26 && guid4[2] === 0xb2 && guid4[3] === 0x75 && dataLen >= 10) {
const cd = parseAsfContentDescription(b, dataOff);
if (!report.detections.metadata_systems.includes("asf_content_desc"))
report.detections.metadata_systems.push("asf_content_desc");
if (!report.tags.raw.asf) report.tags.raw.asf = {};
report.tags.raw.asf.content_description = cd;
mapCommon(report, cd, ASF_CD_TO_COMMON);
}
if (guid4[0] === 0x40 && guid4[1] === 0xa4 && guid4[2] === 0xd0 && guid4[3] === 0xd2 && dataLen >= 2) {
const ext = parseAsfExtContentDescription(b, dataOff, dataOff + dataLen);
if (!report.detections.metadata_systems.includes("asf_ext_content_desc"))
report.detections.metadata_systems.push("asf_ext_content_desc");
if (!report.tags.raw.asf) report.tags.raw.asf = {};
report.tags.raw.asf.extended_content = ext;
const c = report.tags.common;
for (const d of ext) {
const field = WMA_TO_COMMON[(d.name || "").toUpperCase()];
if (field && d.value) c[field] = c[field] || d.value;
}
}
objects.push({ guid_prefix: guid4.map(x => x.toString(16).padStart(2, "0")).join(""), size: objSize });
off += objSize;
}
if (!report.tags.raw.asf) report.tags.raw.asf = {};
report.tags.raw.asf.header_objects = objects;
}
const ID3_FRAME_DESCRIPTIONS = {
TIT2: "Title/songname/content description", TPE1: "Lead performer(s)/Soloist(s)",
TRCK: "Track number/Position in set", TALB: "Album/Movie/Show title",
TDRC: "Recording time", TYER: "Year", TCON: "Content type",
TPE2: "Band/orchestra/accompaniment", TLEN: "Length (ms)", TCOM: "Composer",
COMM: "Comments", APIC: "Attached picture", GEOB: "General encapsulated object",
TXXX: "User defined text information frame", UFID: "Unique file identifier", PRIV: "Private frame",
};
const ID3_TO_COMMON = {
TIT2: "title", TPE1: "artist", TALB: "album", TDRC: "date", TYER: "date",
TRCK: "track", TCON: "genre", COMM: "comment", TCOM: "composer", TCOP: "copyright", TLAN: "language",
};
const VORBIS_TO_COMMON = {
TITLE: "title", ARTIST: "artist", ALBUM: "album", DATE: "date",
TRACKNUMBER: "track", GENRE: "genre", COMMENT: "comment", COMPOSER: "composer", LANGUAGE: "language",
};
const WMA_TO_COMMON = {
"WM/ALBUMTITLE": "album", "WM/GENRE": "genre", "WM/YEAR": "date",
"WM/TRACKNUMBER": "track", "WM/COMPOSER": "composer", "WM/LANGUAGE": "language",
};
const ID3V1_TO_COMMON = { title: "title", artist: "artist", album: "album", year: "date", comment: "comment", genre: "genre", track: "track" };
const RIFF_TO_COMMON = { INAM: "title", IART: "artist", ICMT: "comment", IGNR: "genre", ICRD: "date", ICOP: "copyright" };
const ASF_CD_TO_COMMON = { title: "title", author: "artist", copyright: "copyright", description: "comment" };
/** Maps source object fields to the common tags layer via a mapping table. */
function mapCommon(report, source, mapping) {
const c = report.tags.common;
for (const [sk, ck] of Object.entries(mapping))
c[ck] = c[ck] || source[sk] || null;
}
/** Maps an ID3v2 frame value to the common tags layer. */
function mapCommonId3(report, frameId, text) {
const field = ID3_TO_COMMON[frameId];
if (field) report.tags.common[field] = report.tags.common[field] || text || null;
}
/** Decodes an ID3v2 COMM (Comments) frame. */
function decodeCommFrame(data) {
if (!data || data.length < 5) return null;
const enc = data[0];
const language = String.fromCharCode(data[1], data[2], data[3]);
const { valueBytes: descBytes, next } = readNullTerminated(data, 4, enc);
const short_description = decodeText(descBytes, enc).replace(/\u0000/g, "").trim() || null;
const text = decodeText(data.slice(next), enc).replace(/\u0000/g, "").trim() || null;
return { language, short_description, text };
}
/** Normalizes TLEN to integer milliseconds. */
function normalizeTlen(s) {
if (!s) return null;
if (/^\s*\d+\s*$/.test(s)) return parseInt(s.trim(), 10);
const f = Number(s);
if (Number.isFinite(f) && f > 0 && f < 100000) return Math.round(f * 1000);
return null;
}
/** Parses the ID3v2 tag header and frames. */
function parseId3v2(mp3) {
if (mp3.length < 10 || mp3[0] !== 0x49 || mp3[1] !== 0x44 || mp3[2] !== 0x33) return null;
const major = mp3[3], minor = mp3[4], flags = mp3[5];
const tagSize = synchsafeToInt(mp3[6], mp3[7], mp3[8], mp3[9]);
let offset = 10;
const end = 10 + tagSize;
const frames = [];
while (offset + 10 <= end) {
const id = String.fromCharCode(mp3[offset], mp3[offset + 1], mp3[offset + 2], mp3[offset + 3]);
if (!/^[A-Z0-9]{4}$/.test(id)) break;
const size = major === 4 ?
synchsafeToInt(mp3[offset + 4], mp3[offset + 5], mp3[offset + 6], mp3[offset + 7]) :
u32be(mp3, offset + 4);
offset += 10;
if (size <= 0 || offset + size > mp3.length) break;
frames.push({ id, size, data: mp3.slice(offset, offset + size) });
offset += size;
}
return { header: { version: `${major}.${minor}`, flags, tag_size: tagSize }, frames };
}
/** Parses the 128-byte ID3v1 tag at the end of the file. */
function parseId3v1(b) {
if (b.length < 128) return null;
const off = b.length - 128;
if (b[off] !== 0x54 || b[off + 1] !== 0x41 || b[off + 2] !== 0x47) return null;
let track = null;
if (b[off + 125] === 0x00 && b[off + 126] !== 0x00) track = String(b[off + 126]);
return {
title: decodeLatin1Trim(b.slice(off + 3, off + 33)),
artist: decodeLatin1Trim(b.slice(off + 33, off + 63)),
album: decodeLatin1Trim(b.slice(off + 63, off + 93)),
year: decodeLatin1Trim(b.slice(off + 93, off + 97)),
comment: decodeLatin1Trim(b.slice(off + 97, off + 127)),
track, genre: String(b[off + 127]),
};
}
/** Decodes an ID3v2 TXXX (user-defined text) frame. */
function decodeTxxx(data) {
if (!data || data.length < 2) return null;
const enc = data[0];
const { valueBytes: descBytes, next } = readNullTerminated(data, 1, enc);
const desc = decodeText(descBytes, enc).replace(/\u0000/g, "").trim();
const val = decodeText(data.slice(next), enc).replace(/\u0000/g, "").trim();
return { description: desc || null, value: val || null };
}
/** Best-effort APEv2 tag parser scanning the last 32 KB. */
function parseApeV2BestEffort(b) {
const scanStart = Math.max(0, b.length - 32768);
const idx = indexOfAscii(b, "APETAGEX", scanStart, b.length);
if (idx < 0) return null;
if (idx + 32 > b.length) return { present: true, warning: "APETAGEX found but footer truncated." };
const ver = u32le(b, idx + 8), size = u32le(b, idx + 12);
const count = u32le(b, idx + 16), flags = u32le(b, idx + 20);
const tagStart = idx + 32 - size;
if (tagStart < 0 || tagStart >= b.length)
return { present: true, version: ver, size, count, flags, warning: "APEv2 bounds invalid (non-standard placement)." };
const items = [];
let off = tagStart + 32;
const end = Math.min(b.length, idx);
while (off + 8 < end && items.length < 5000) {
const valueSize = u32le(b, off), itemFlags = u32le(b, off + 4);
off += 8;
let keyEnd = off;
while (keyEnd < end && b[keyEnd] !== 0x00) keyEnd++;
const key = decodeLatin1Trim(b.slice(off, keyEnd));
off = keyEnd + 1;
if (!key || off + valueSize > end) break;
const value = safeUtf8(b.slice(off, off + valueSize)).replace(/\u0000/g, "").trim();
off += valueSize;
items.push({ key, value, flags: itemFlags });
}
return { present: true, version: ver, size, count, flags, items };
}
/** Enumerates RIFF-style chunks (id + LE32 size) within a byte range, padding to even. */
function enumerateChunks(b, start, end, maxCount) {
const chunks = [];
let off = start;
while (off + 8 <= end && chunks.length < maxCount) {
const id = ascii4(b, off);
const size = u32le(b, off + 4);
const dataOff = off + 8;
if (dataOff + size > end) break;
chunks.push({ id, size, dataOff });
off = dataOff + size + (size % 2);
}
return chunks;
}
/** Parses a BWF bext chunk. */
function parseBext(b, off, size) {
const slice = b.slice(off, off + size);
const timeRefLow = u32le(slice, 338), timeRefHigh = u32le(slice, 342);
return {
description: decodeLatin1Trim(slice.slice(0, 256)) || null,
originator: decodeLatin1Trim(slice.slice(256, 288)) || null,
originator_reference: decodeLatin1Trim(slice.slice(288, 320)) || null,
origination_date: decodeLatin1Trim(slice.slice(320, 330)) || null,
origination_time: decodeLatin1Trim(slice.slice(330, 338)) || null,
time_reference_samples: ((BigInt(timeRefHigh) << 32n) | BigInt(timeRefLow)).toString(),
};
}
const FLAC_TYPE_NAMES = { 0: "STREAMINFO", 1: "PADDING", 2: "APPLICATION", 3: "SEEKTABLE", 4: "VORBIS_COMMENT", 5: "CUESHEET", 6: "PICTURE" };
/** Parses FLAC metadata blocks following the "fLaC" marker. */
function parseFlacMetaBlocks(b) {
const blocks = [];
let off = 4;
while (off + 4 <= b.length && blocks.length < 10000) {
const header = b[off];
const isLast = (header & 0x80) !== 0;
const type = header & 0x7f;
const len = (b[off + 1] << 16) | (b[off + 2] << 8) | b[off + 3];
off += 4;
if (off + len > b.length) break;
blocks.push({ type, typeName: FLAC_TYPE_NAMES[type] || `TYPE_${type}`, length: len, data: b.slice(off, off + len) });
off += len;
if (isLast) break;
}
return blocks;
}
/** Parses a Vorbis Comment block (used by FLAC and OGG). */
function parseVorbisComment(buf) {
let off = 0;
const vendorLen = u32le(buf, off); off += 4;
if (off + vendorLen > buf.length) return { vendor: null, comments: [], warning: "vendor_len out of bounds" };
const vendor = safeUtf8(buf.slice(off, off + vendorLen)); off += vendorLen;
const count = u32le(buf, off); off += 4;
const comments = [];
for (let i = 0; i < count && off + 4 <= buf.length && comments.length < 20000; i++) {
const l = u32le(buf, off); off += 4;
if (off + l > buf.length) break;
const s = safeUtf8(buf.slice(off, off + l)); off += l;
const eq = s.indexOf("=");
if (eq > 0) comments.push({ key: s.slice(0, eq).toUpperCase(), value: s.slice(eq + 1) });
}
return { vendor, comments };
}
/** Maps Vorbis Comment fields to the common tags layer. */
function mapVorbisCommon(report, vc) {
const c = report.tags.common;
for (const [vk, ck] of Object.entries(VORBIS_TO_COMMON))
c[ck] = c[ck] || vc.comments?.find((x) => x.key === vk)?.value || null;
}
/** Parses a FLAC PICTURE metadata block (extracts mime, description, data length). */
function parseFlacPicture(data, maxTextBytes) {
let off = 4;
const mimeLen = u32be(data, off); off += 4;
const mime = safeUtf8(data.slice(off, off + Math.min(mimeLen, maxTextBytes))); off += mimeLen;
const descLen = u32be(data, off); off += 4;
const description = safeUtf8(data.slice(off, off + Math.min(descLen, maxTextBytes))); off += descLen + 16;
return { mime, description, dataLength: u32be(data, off) };
}
/** Parses the ASF Content Description Object fields. */
function parseAsfContentDescription(b, off) {
const titleLen = u16le(b, off), authorLen = u16le(b, off + 2);
const copyrightLen = u16le(b, off + 4), descLen = u16le(b, off + 6), ratingLen = u16le(b, off + 8);
let pos = off + 10;
const title = decodeUtf16LE(b, pos, titleLen); pos += titleLen;
const author = decodeUtf16LE(b, pos, authorLen); pos += authorLen;
const copyright = decodeUtf16LE(b, pos, copyrightLen); pos += copyrightLen;
const description = decodeUtf16LE(b, pos, descLen); pos += descLen;
const rating = decodeUtf16LE(b, pos, ratingLen);
return { title, author, copyright, description, rating };
}
/** Parses the ASF Extended Content Description Object descriptors. */
function parseAsfExtContentDescription(b, off, end) {
const count = u16le(b, off);
let pos = off + 2;
const descriptors = [];
for (let i = 0; i < count && pos + 6 <= end && descriptors.length < 5000; i++) {
const nameLen = u16le(b, pos); pos += 2;
if (pos + nameLen > end) break;
const name = decodeUtf16LE(b, pos, nameLen); pos += nameLen;
const valueType = u16le(b, pos); pos += 2;
const valueLen = u16le(b, pos); pos += 2;
if (pos + valueLen > end) break;
let value;
if (valueType === 0) value = decodeUtf16LE(b, pos, valueLen);
else if (valueType === 3) value = u32le(b, pos);
else if (valueType === 5) value = u16le(b, pos);
else if (valueType === 2) value = u32le(b, pos) !== 0;
else value = `(${valueLen} bytes, type ${valueType})`;
pos += valueLen;
descriptors.push({ name, value_type: valueType, value });
}
return descriptors;
}

73
src/core/lib/BigIntUtils.mjs Normal file
View File

@ -0,0 +1,73 @@
/**
* @author p-leriche [philip.leriche@cantab.net]
* @copyright Crown Copyright 2025
* @license Apache-2.0
*/
import OperationError from "../errors/OperationError.mjs";
/**
* Number theory utilities used by cryptographic operations.
*
* Currently provides:
* - parseBigInt
* - Extended Euclidean Algorithm
* - Modular Exponentiation
*
* Additional algorithms may be added as required.
*/
/**
* parseBigInt helper operation
*/
export function parseBigInt(value, param) {
const v = (value ?? "").trim();
if (/^0x[0-9a-f]+$/i.test(v)) return BigInt(v);
if (/^[+-]?[0-9]+$/.test(v)) return BigInt(v);
throw new OperationError(param + " must be decimal or hex (0x...)");
}
/**
* Extended Euclidean Algorithm
*
* Returns [g, x, y] such that:
* a*x + b*y = g = gcd(a, b)
*
* (Uses an iterative algorithm to avoid possible stack overflow)
*/
export function egcd(a, b) {
let oldR = a, r = b;
let oldS = 1n, s = 0n;
let oldT = 0n, t = 1n;
while (r !== 0n) {
const quotient = oldR / r;
[oldR, r] = [r, oldR - quotient * r];
[oldS, s] = [s, oldS - quotient * s];
[oldT, t] = [t, oldT - quotient * t];
}
// oldR is the gcd
// oldS and oldT are the Bézout coefficients
return [oldR, oldS, oldT];
}
/**
* Modular exponentiation
*/
export function modPow(base, exponent, modulus) {
let result = 1n;
base %= modulus;
while (exponent > 0n) {
if (exponent & 1n) {
result = (result * base) % modulus;
}
base = (base * base) % modulus;
exponent >>= 1n;
}
return result;
}

5
src/core/lib/Extract.mjs
View File

@ -45,6 +45,11 @@ export function search(input, searchRegex, removeRegex=null, sortBy=null, unique
return results;
}
/**
* Email regular expression
*/
export const EMAIL_REGEX = /(?:[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9](?:[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9-]*[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9])?\.)+[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9](?:[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9-]*[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\])/ig;
/**
* URL regular expression

2
src/core/lib/Hex.mjs
View File

@ -33,7 +33,7 @@ export function toHex(data, delim=" ", padding=2, extraDelim="", lineSize=0) {
if (data instanceof ArrayBuffer) data = new Uint8Array(data);
let output = "";
const prepend = (delim === "0x" || delim === "\\x");
const prepend = (delim === "0x" || delim === "\\x" || delim === "%");
for (let i = 0; i < data.length; i++) {
const hex = data[i].toString(16).padStart(padding, "0");

251
src/core/lib/ImageManipulation.mjs
View File

@ -1,251 +0,0 @@
/**
* Image manipulation resources
*
* @author j433866 [j433866@gmail.com]
* @copyright Crown Copyright 2019
* @license Apache-2.0
*/
import OperationError from "../errors/OperationError.mjs";
/**
* Gaussian blurs an image.
*
* @param {jimp} input
* @param {number} radius
* @param {boolean} fast
* @returns {jimp}
*/
export function gaussianBlur (input, radius) {
try {
// From http://blog.ivank.net/fastest-gaussian-blur.html
const boxes = boxesForGauss(radius, 3);
for (let i = 0; i < 3; i++) {
input = boxBlur(input, (boxes[i] - 1) / 2);
}
} catch (err) {
throw new OperationError(`Error blurring image. (${err})`);
}
return input;
}
/**
*
* @param {number} radius
* @param {number} numBoxes
* @returns {Array}
*/
function boxesForGauss(radius, numBoxes) {
const idealWidth = Math.sqrt((12 * radius * radius / numBoxes) + 1);
let wl = Math.floor(idealWidth);
if (wl % 2 === 0) {
wl--;
}
const wu = wl + 2;
const mIdeal = (12 * radius * radius - numBoxes * wl * wl - 4 * numBoxes * wl - 3 * numBoxes) / (-4 * wl - 4);
const m = Math.round(mIdeal);
const sizes = [];
for (let i = 0; i < numBoxes; i++) {
sizes.push(i < m ? wl : wu);
}
return sizes;
}
/**
* Applies a box blur effect to the image
*
* @param {jimp} source
* @param {number} radius
* @returns {jimp}
*/
function boxBlur (source, radius) {
const width = source.bitmap.width;
const height = source.bitmap.height;
let output = source.clone();
output = boxBlurH(source, output, width, height, radius);
source = boxBlurV(output, source, width, height, radius);
return source;
}
/**
* Applies the horizontal blur
*
* @param {jimp} source
* @param {jimp} output
* @param {number} width
* @param {number} height
* @param {number} radius
* @returns {jimp}
*/
function boxBlurH (source, output, width, height, radius) {
const iarr = 1 / (radius + radius + 1);
for (let i = 0; i < height; i++) {
let ti = 0,
li = ti,
ri = ti + radius;
const idx = source.getPixelIndex(ti, i);
const firstValRed = source.bitmap.data[idx],
firstValGreen = source.bitmap.data[idx + 1],
firstValBlue = source.bitmap.data[idx + 2],
firstValAlpha = source.bitmap.data[idx + 3];
const lastIdx = source.getPixelIndex(width - 1, i),
lastValRed = source.bitmap.data[lastIdx],
lastValGreen = source.bitmap.data[lastIdx + 1],
lastValBlue = source.bitmap.data[lastIdx + 2],
lastValAlpha = source.bitmap.data[lastIdx + 3];
let red = (radius + 1) * firstValRed;
let green = (radius + 1) * firstValGreen;
let blue = (radius + 1) * firstValBlue;
let alpha = (radius + 1) * firstValAlpha;
for (let j = 0; j < radius; j++) {
const jIdx = source.getPixelIndex(ti + j, i);
red += source.bitmap.data[jIdx];
green += source.bitmap.data[jIdx + 1];
blue += source.bitmap.data[jIdx + 2];
alpha += source.bitmap.data[jIdx + 3];
}
for (let j = 0; j <= radius; j++) {
const jIdx = source.getPixelIndex(ri++, i);
red += source.bitmap.data[jIdx] - firstValRed;
green += source.bitmap.data[jIdx + 1] - firstValGreen;
blue += source.bitmap.data[jIdx + 2] - firstValBlue;
alpha += source.bitmap.data[jIdx + 3] - firstValAlpha;
const tiIdx = source.getPixelIndex(ti++, i);
output.bitmap.data[tiIdx] = Math.round(red * iarr);
output.bitmap.data[tiIdx + 1] = Math.round(green * iarr);
output.bitmap.data[tiIdx + 2] = Math.round(blue * iarr);
output.bitmap.data[tiIdx + 3] = Math.round(alpha * iarr);
}
for (let j = radius + 1; j < width - radius; j++) {
const riIdx = source.getPixelIndex(ri++, i);
const liIdx = source.getPixelIndex(li++, i);
red += source.bitmap.data[riIdx] - source.bitmap.data[liIdx];
green += source.bitmap.data[riIdx + 1] - source.bitmap.data[liIdx + 1];
blue += source.bitmap.data[riIdx + 2] - source.bitmap.data[liIdx + 2];
alpha += source.bitmap.data[riIdx + 3] - source.bitmap.data[liIdx + 3];
const tiIdx = source.getPixelIndex(ti++, i);
output.bitmap.data[tiIdx] = Math.round(red * iarr);
output.bitmap.data[tiIdx + 1] = Math.round(green * iarr);
output.bitmap.data[tiIdx + 2] = Math.round(blue * iarr);
output.bitmap.data[tiIdx + 3] = Math.round(alpha * iarr);
}
for (let j = width - radius; j < width; j++) {
const liIdx = source.getPixelIndex(li++, i);
red += lastValRed - source.bitmap.data[liIdx];
green += lastValGreen - source.bitmap.data[liIdx + 1];
blue += lastValBlue - source.bitmap.data[liIdx + 2];
alpha += lastValAlpha - source.bitmap.data[liIdx + 3];
const tiIdx = source.getPixelIndex(ti++, i);
output.bitmap.data[tiIdx] = Math.round(red * iarr);
output.bitmap.data[tiIdx + 1] = Math.round(green * iarr);
output.bitmap.data[tiIdx + 2] = Math.round(blue * iarr);
output.bitmap.data[tiIdx + 3] = Math.round(alpha * iarr);
}
}
return output;
}
/**
* Applies the vertical blur
*
* @param {jimp} source
* @param {jimp} output
* @param {number} width
* @param {number} height
* @param {number} radius
* @returns {jimp}
*/
function boxBlurV (source, output, width, height, radius) {
const iarr = 1 / (radius + radius + 1);
for (let i = 0; i < width; i++) {
let ti = 0,
li = ti,
ri = ti + radius;
const idx = source.getPixelIndex(i, ti);
const firstValRed = source.bitmap.data[idx],
firstValGreen = source.bitmap.data[idx + 1],
firstValBlue = source.bitmap.data[idx + 2],
firstValAlpha = source.bitmap.data[idx + 3];
const lastIdx = source.getPixelIndex(i, height - 1),
lastValRed = source.bitmap.data[lastIdx],
lastValGreen = source.bitmap.data[lastIdx + 1],
lastValBlue = source.bitmap.data[lastIdx + 2],
lastValAlpha = source.bitmap.data[lastIdx + 3];
let red = (radius + 1) * firstValRed;
let green = (radius + 1) * firstValGreen;
let blue = (radius + 1) * firstValBlue;
let alpha = (radius + 1) * firstValAlpha;
for (let j = 0; j < radius; j++) {
const jIdx = source.getPixelIndex(i, ti + j);
red += source.bitmap.data[jIdx];
green += source.bitmap.data[jIdx + 1];
blue += source.bitmap.data[jIdx + 2];
alpha += source.bitmap.data[jIdx + 3];
}
for (let j = 0; j <= radius; j++) {
const riIdx = source.getPixelIndex(i, ri++);
red += source.bitmap.data[riIdx] - firstValRed;
green += source.bitmap.data[riIdx + 1] - firstValGreen;
blue += source.bitmap.data[riIdx + 2] - firstValBlue;
alpha += source.bitmap.data[riIdx + 3] - firstValAlpha;
const tiIdx = source.getPixelIndex(i, ti++);
output.bitmap.data[tiIdx] = Math.round(red * iarr);
output.bitmap.data[tiIdx + 1] = Math.round(green * iarr);
output.bitmap.data[tiIdx + 2] = Math.round(blue * iarr);
output.bitmap.data[tiIdx + 3] = Math.round(alpha * iarr);
}
for (let j = radius + 1; j < height - radius; j++) {
const riIdx = source.getPixelIndex(i, ri++);
const liIdx = source.getPixelIndex(i, li++);
red += source.bitmap.data[riIdx] - source.bitmap.data[liIdx];
green += source.bitmap.data[riIdx + 1] - source.bitmap.data[liIdx + 1];
blue += source.bitmap.data[riIdx + 2] - source.bitmap.data[liIdx + 2];
alpha += source.bitmap.data[riIdx + 3] - source.bitmap.data[liIdx + 3];
const tiIdx = source.getPixelIndex(i, ti++);
output.bitmap.data[tiIdx] = Math.round(red * iarr);
output.bitmap.data[tiIdx + 1] = Math.round(green * iarr);
output.bitmap.data[tiIdx + 2] = Math.round(blue * iarr);
output.bitmap.data[tiIdx + 3] = Math.round(alpha * iarr);
}
for (let j = height - radius; j < height; j++) {
const liIdx = source.getPixelIndex(i, li++);
red += lastValRed - source.bitmap.data[liIdx];
green += lastValGreen - source.bitmap.data[liIdx + 1];
blue += lastValBlue - source.bitmap.data[liIdx + 2];
alpha += lastValAlpha - source.bitmap.data[liIdx + 3];
const tiIdx = source.getPixelIndex(i, ti++);
output.bitmap.data[tiIdx] = Math.round(red * iarr);
output.bitmap.data[tiIdx + 1] = Math.round(green * iarr);
output.bitmap.data[tiIdx + 2] = Math.round(blue * iarr);
output.bitmap.data[tiIdx + 3] = Math.round(alpha * iarr);
}
}
return output;
}

2
src/core/lib/Magic.mjs
View File

@ -1,4 +1,4 @@
import OperationConfig from "../config/OperationConfig.json" assert {type: "json"};
import OperationConfig from "../config/OperationConfig.json" with { type: "json" };
import Utils, { isWorkerEnvironment } from "../Utils.mjs";
import Recipe from "../Recipe.mjs";
import Dish from "../Dish.mjs";

2
src/core/lib/Modhex.mjs
View File

@ -50,6 +50,7 @@ const HEX_ALPHABET_MAP = HEX_ALPHABET.split("");
export function toModhex(data, delim=" ", padding=2, extraDelim="", lineSize=0) {
if (!data) return "";
if (data instanceof ArrayBuffer) data = new Uint8Array(data);
if (data.length === 0) return "";
const regularHexString = toHex(data, "", padding, "", 0);
@ -100,6 +101,7 @@ export function toModhex(data, delim=" ", padding=2, extraDelim="", lineSize=0)
export function toModhexFast(data) {
if (!data) return "";
if (data instanceof ArrayBuffer) data = new Uint8Array(data);
if (data.length === 0) return "";
const output = [];

50
src/core/lib/ParityBit.mjs Normal file
View File

@ -0,0 +1,50 @@
/**
* Parity Bit functions.
*
* @author j83305 [awz22@protonmail.com]
* @copyright Crown Copyright 2020
* @license Apache-2.0
*
*/
import OperationError from "../errors/OperationError.mjs";
/**
* Function to take the user input and encode using the given arguments
* @param input string of binary
* @param args array
*/
export function calculateParityBit(input, args) {
let count1s = 0;
for (let i = 0; i < input.length; i++) {
const character = input.charAt(i);
if (character === "1") {
count1s++;
} else if (character !== args[3] && character !== "0" && character !== " ") {
throw new OperationError("unexpected character encountered: \"" + character + "\"");
}
}
let parityBit = "1";
const flipflop = args[0] === "Even Parity" ? 0 : 1;
if (count1s % 2 === flipflop) {
parityBit = "0";
}
if (args[1] === "End") {
return input + parityBit;
} else {
return parityBit + input;
}
}
/**
* just removes the parity bit to return the original data
* @param input string of binary, encoded
* @param args array
*/
export function decodeParityBit(input, args) {
if (args[1] === "End") {
return input.slice(0, -1);
} else {
return input.slice(1);
}
}

40
src/core/lib/QRCode.mjs
View File

@ -10,7 +10,7 @@ import OperationError from "../errors/OperationError.mjs";
import jsQR from "jsqr";
import qr from "qr-image";
import Utils from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Parses a QR code image from an image
@ -29,18 +29,31 @@ export async function parseQrCode(input, normalise) {
try {
if (normalise) {
image.rgba(false);
image.background(0xFFFFFFFF);
image.normalize();
image.greyscale();
image = await image.getBufferAsync(Jimp.MIME_JPEG);
image = await Jimp.read(image);
image.normalize();
}
} catch (err) {
throw new OperationError(`Error normalising image. (${err})`);
}
const qrData = jsQR(image.bitmap.data, image.getWidth(), image.getHeight());
// Remove transparency which jsQR cannot handle
image.scan((x, y, idx) => {
// If pixel is fully transparent, make it opaque white
if (image.bitmap.data[idx + 3] === 0x00) {
image.bitmap.data[idx + 0] = 0xff;
image.bitmap.data[idx + 1] = 0xff;
image.bitmap.data[idx + 2] = 0xff;
}
// Otherwise, make it fully opaque at its existing colour
image.bitmap.data[idx + 3] = 0xff;
});
image = await Jimp.read(await image.getBuffer(JimpMime.jpeg));
const qrData = jsQR(
new Uint8ClampedArray(image.bitmap.data),
image.width,
image.height,
);
if (qrData) {
return qrData.data;
} else {
@ -58,7 +71,13 @@ export async function parseQrCode(input, normalise) {
* @param {string} errorCorrection
* @returns {ArrayBuffer}
*/
export function generateQrCode(input, format, moduleSize, margin, errorCorrection) {
export function generateQrCode(
input,
format,
moduleSize,
margin,
errorCorrection,
) {
const formats = ["SVG", "EPS", "PDF", "PNG"];
if (!formats.includes(format.toUpperCase())) {
throw new OperationError("Unsupported QR code format.");
@ -70,7 +89,8 @@ export function generateQrCode(input, format, moduleSize, margin, errorCorrectio
type: format,
size: moduleSize,
margin: margin,
"ec_level": errorCorrection.charAt(0).toUpperCase()
// eslint-disable-next-line camelcase
ec_level: errorCorrection.charAt(0).toUpperCase(),
});
} catch (err) {
throw new OperationError(`Error generating QR code. (${err})`);
@ -86,7 +106,7 @@ export function generateQrCode(input, format, moduleSize, margin, errorCorrectio
case "PDF":
return Utils.strToArrayBuffer(qrImage);
case "PNG":
return qrImage.buffer;
return qrImage.buffer.slice(qrImage.byteOffset, qrImage.byteLength + qrImage.byteOffset);
default:
throw new OperationError("Unsupported QR code format.");
}

625
src/core/lib/RC6.mjs Normal file
View File

@ -0,0 +1,625 @@
/**
* Complete implementation of RC6 block cipher encryption/decryption with
* configurable word size (w), rounds (r), and key length (b).
*
* RC6 was an AES finalist designed by Ron Rivest, Matt Robshaw, Ray Sidney, and Yiqun Lisa Yin.
* Reference: https://en.wikipedia.org/wiki/RC6
* Test Vectors: https://datatracker.ietf.org/doc/html/draft-krovetz-rc6-rc5-vectors-00
*
* The P and Q constants are derived from mathematical constants e (Euler's number) and
* φ (golden ratio) as specified in the IETF draft. Master 256-bit values are scaled to
* any word size.
*
* @author Medjedtxm
* @copyright Crown Copyright 2026
* @license Apache-2.0
*/
import OperationError from "../errors/OperationError.mjs";
/**
* Master P constant (256-bit) from IETF draft-krovetz-rc6-rc5-vectors-00
* Derived from Odd((e-2) * 2^256) where e = 2.71828...
*/
const P_256 = 0xb7e151628aed2a6abf7158809cf4f3c762e7160f38b4da56a784d9045190cfefn;
/**
* Master Q constant (256-bit) from IETF draft-krovetz-rc6-rc5-vectors-00
* Derived from Odd((φ-1) * 2^256) where φ = 1.61803... (golden ratio)
*/
const Q_256 = 0x9e3779b97f4a7c15f39cc0605cedc8341082276bf3a27251f86c6a11d0c18e95n;
/**
* Get P constant for given word size by scaling the 256-bit master constant
* @param {number} w - Word size in bits
* @returns {bigint} - P constant for word size w
*/
function getP(w) {
return (P_256 >> BigInt(256 - w)) | 1n; // Ensure odd
}
/**
* Get Q constant for given word size by scaling the 256-bit master constant
* @param {number} w - Word size in bits
* @returns {bigint} - Q constant for word size w
*/
function getQ(w) {
return (Q_256 >> BigInt(256 - w)) | 1n; // Ensure odd
}
/**
* Get block size in bytes for given word size
* Block size = 4 words = 4 * (w/8) bytes
* @param {number} w - Word size in bits
* @returns {number} - Block size in bytes
*/
export function getBlockSize(w) {
return 4 * (w / 8);
}
/**
* Get recommended number of rounds for given word size
* @param {number} w - Word size in bits
* @returns {number} - Recommended rounds
*/
export function getDefaultRounds(w) {
if (w <= 16) return 16;
if (w <= 32) return 20;
if (w <= 64) return 24;
return 28;
}
/**
* Create mask for w-bit word
* @param {number} w - Word size in bits
* @returns {bigint} - Mask with w bits set
*/
function wordMask(w) {
return (1n << BigInt(w)) - 1n;
}
/**
* Rotate left for arbitrary word size using BigInt
* Uses lower lg(w) bits of n for rotation amount (RC6 spec)
* @param {bigint} x - Value to rotate
* @param {bigint} n - Rotation amount
* @param {number} w - Word size in bits
* @param {bigint} lgMask - Mask for lower lg(w) bits
* @returns {bigint} - Rotated value
*/
function ROL(x, n, w, lgMask) {
const mask = wordMask(w);
// Mask to lg(w) bits, then mod w for non-power-of-2 word sizes
// For power-of-2, (n & lgMask) < w always, so mod w is no-op
const shift = (n & lgMask) % BigInt(w);
return ((x << shift) | (x >> (BigInt(w) - shift))) & mask;
}
/**
* Rotate right for arbitrary word size using BigInt
* Uses lower lg(w) bits of n for rotation amount (RC6 spec)
* @param {bigint} x - Value to rotate
* @param {bigint} n - Rotation amount
* @param {number} w - Word size in bits
* @param {bigint} lgMask - Mask for lower lg(w) bits
* @returns {bigint} - Rotated value
*/
function ROR(x, n, w, lgMask) {
const mask = wordMask(w);
// Mask to lg(w) bits, then mod w for non-power-of-2 word sizes
// For power-of-2, (n & lgMask) < w always, so mod w is no-op
const shift = (n & lgMask) % BigInt(w);
return ((x >> shift) | (x << (BigInt(w) - shift))) & mask;
}
/**
* Convert byte array to word array (little-endian) using BigInt
* @param {number[]} bytes - Input byte array
* @param {number} w - Word size in bits
* @returns {bigint[]} - Array of w-bit words as BigInt
*/
function bytesToWords(bytes, w) {
const bytesPerWord = w / 8;
const words = [];
for (let i = 0; i < bytes.length; i += bytesPerWord) {
let word = 0n;
for (let j = 0; j < bytesPerWord && (i + j) < bytes.length; j++) {
word |= BigInt(bytes[i + j] || 0) << BigInt(j * 8);
}
words.push(word);
}
return words;
}
/**
* Convert word array to byte array (little-endian) using BigInt
* @param {bigint[]} words - Array of words
* @param {number} w - Word size in bits
* @returns {number[]} - Output byte array
*/
function wordsToBytes(words, w) {
const bytesPerWord = w / 8;
const bytes = [];
for (const word of words) {
for (let j = 0; j < bytesPerWord; j++) {
bytes.push(Number((word >> BigInt(j * 8)) & 0xFFn));
}
}
return bytes;
}
/**
* Generate round subkeys from user key
*
* @param {number[]} key - User key as byte array
* @param {number} rounds - Number of rounds
* @param {number} w - Word size in bits
* @returns {bigint[]} - Array of 2r+4 subkeys as BigInt
*/
function generateSubkeys(key, rounds, w) {
const bytesPerWord = w / 8;
const b = key.length;
const c = Math.max(Math.ceil(b / bytesPerWord), 1);
// Convert key bytes to words, pad with zeros if needed
const paddedKey = [...key];
while (paddedKey.length < c * bytesPerWord) {
paddedKey.push(0);
}
const L = bytesToWords(paddedKey, w);
// Number of subkeys: 2*r + 4
const t = 2 * rounds + 4;
// Get P and Q for this word size
const P = getP(w);
const Q = getQ(w);
const mask = wordMask(w);
// lg(w) mask for rotation amounts (floor of log2(w), per RC6 spec)
const lgw = Math.floor(Math.log2(w));
const lgMask = (1n << BigInt(lgw)) - 1n;
// Initialise S array with magic constants
const S = new Array(t);
S[0] = P;
for (let i = 1; i < t; i++) {
S[i] = (S[i - 1] + Q) & mask;
}
// Mix key into S
let A = 0n, B = 0n;
let i = 0, j = 0;
const v = 3 * Math.max(c, t);
for (let s = 0; s < v; s++) {
A = S[i] = ROL((S[i] + A + B) & mask, 3n, w, lgMask);
B = L[j] = ROL((L[j] + A + B) & mask, A + B, w, lgMask);
i = (i + 1) % t;
j = (j + 1) % c;
}
return S;
}
/**
* Encrypt a single block using RC6
*
* @param {number[]} block - Plaintext block (4*w/8 bytes)
* @param {bigint[]} S - Subkeys array
* @param {number} rounds - Number of rounds
* @param {number} w - Word size in bits
* @returns {number[]} - Ciphertext block
*/
function encryptBlock(block, S, rounds, w) {
const mask = wordMask(w);
const lgw = BigInt(Math.floor(Math.log2(w)));
const lgMask = (1n << lgw) - 1n;
// Convert block to 4 words (A, B, C, D)
let [A, B, C, D] = bytesToWords(block, w);
// Pre-whitening
B = (B + S[0]) & mask;
D = (D + S[1]) & mask;
// Main rounds
for (let i = 1; i <= rounds; i++) {
// t = ROL(B * (2B + 1), lg(w))
const t = ROL((B * ((2n * B + 1n) & mask)) & mask, lgw, w, lgMask);
// u = ROL(D * (2D + 1), lg(w))
const u = ROL((D * ((2n * D + 1n) & mask)) & mask, lgw, w, lgMask);
// A = ROL(A ^ t, u) + S[2i]
A = (ROL(A ^ t, u, w, lgMask) + S[2 * i]) & mask;
// C = ROL(C ^ u, t) + S[2i + 1]
C = (ROL(C ^ u, t, w, lgMask) + S[2 * i + 1]) & mask;
// Rotate registers: (A, B, C, D) = (B, C, D, A)
const temp = A;
A = B;
B = C;
C = D;
D = temp;
}
// Post-whitening
A = (A + S[2 * rounds + 2]) & mask;
C = (C + S[2 * rounds + 3]) & mask;
// Convert words back to bytes
return wordsToBytes([A, B, C, D], w);
}
/**
* Decrypt a single block using RC6
*
* @param {number[]} block - Ciphertext block (4*w/8 bytes)
* @param {bigint[]} S - Subkeys array
* @param {number} rounds - Number of rounds
* @param {number} w - Word size in bits
* @returns {number[]} - Plaintext block
*/
function decryptBlock(block, S, rounds, w) {
const mask = wordMask(w);
const lgw = BigInt(Math.floor(Math.log2(w)));
const lgMask = (1n << lgw) - 1n;
// Convert block to 4 words (A, B, C, D)
let [A, B, C, D] = bytesToWords(block, w);
// Reverse post-whitening
C = (C - S[2 * rounds + 3] + (1n << BigInt(w))) & mask;
A = (A - S[2 * rounds + 2] + (1n << BigInt(w))) & mask;
// Main rounds in reverse
for (let i = rounds; i >= 1; i--) {
// Reverse rotate registers: (A, B, C, D) = (D, A, B, C)
const temp = D;
D = C;
C = B;
B = A;
A = temp;
// u = ROL(D * (2D + 1), lg(w))
const u = ROL((D * ((2n * D + 1n) & mask)) & mask, lgw, w, lgMask);
// t = ROL(B * (2B + 1), lg(w))
const t = ROL((B * ((2n * B + 1n) & mask)) & mask, lgw, w, lgMask);
// C = ROR(C - S[2i + 1], t) ^ u
C = ROR((C - S[2 * i + 1] + (1n << BigInt(w))) & mask, t, w, lgMask) ^ u;
// A = ROR(A - S[2i], u) ^ t
A = ROR((A - S[2 * i] + (1n << BigInt(w))) & mask, u, w, lgMask) ^ t;
}
// Reverse pre-whitening
D = (D - S[1] + (1n << BigInt(w))) & mask;
B = (B - S[0] + (1n << BigInt(w))) & mask;
// Convert words back to bytes
return wordsToBytes([A, B, C, D], w);
}
/**
* XOR two blocks
* @param {number[]} a - First block
* @param {number[]} b - Second block
* @returns {number[]} - XOR result
*/
function xorBlocks(a, b) {
const result = new Array(a.length);
for (let i = 0; i < a.length; i++) {
result[i] = a[i] ^ b[i];
}
return result;
}
/**
* Increment counter (little-endian)
* @param {number[]} counter - Counter block
* @returns {number[]} - Incremented counter
*/
function incrementCounter(counter) {
const result = [...counter];
for (let i = 0; i < result.length; i++) {
result[i]++;
if (result[i] <= 255) break;
result[i] = 0;
}
return result;
}
/**
* Apply padding to message
* @param {number[]} message - Original message
* @param {string} padding - Padding type ("NO", "PKCS5", "ZERO", "RANDOM", "BIT")
* @param {number} blockSize - Block size in bytes
* @returns {number[]} - Padded message
*/
function applyPadding(message, padding, blockSize) {
const remainder = message.length % blockSize;
let nPadding = remainder === 0 ? 0 : blockSize - remainder;
// For PKCS5, always add at least one byte (full block if already aligned)
if (padding === "PKCS5" && remainder === 0) {
nPadding = blockSize;
}
if (nPadding === 0) return [...message];
const paddedMessage = [...message];
switch (padding) {
case "NO":
throw new OperationError(`No padding requested but input is not a ${blockSize}-byte multiple.`);
case "PKCS5":
for (let i = 0; i < nPadding; i++) {
paddedMessage.push(nPadding);
}
break;
case "ZERO":
for (let i = 0; i < nPadding; i++) {
paddedMessage.push(0);
}
break;
case "RANDOM":
for (let i = 0; i < nPadding; i++) {
paddedMessage.push(Math.floor(Math.random() * 256));
}
break;
case "BIT":
paddedMessage.push(0x80);
for (let i = 1; i < nPadding; i++) {
paddedMessage.push(0);
}
break;
default:
throw new OperationError(`Unknown padding type: ${padding}`);
}
return paddedMessage;
}
/**
* Remove padding from message
* @param {number[]} message - Padded message
* @param {string} padding - Padding type ("NO", "PKCS5", "ZERO", "RANDOM", "BIT")
* @param {number} blockSize - Block size in bytes
* @returns {number[]} - Unpadded message
*/
function removePadding(message, padding, blockSize) {
if (message.length === 0) return message;
switch (padding) {
case "NO":
case "ZERO":
case "RANDOM":
// These padding types cannot be reliably removed
return message;
case "PKCS5": {
const padByte = message[message.length - 1];
if (padByte > 0 && padByte <= blockSize) {
// Verify padding
for (let i = 0; i < padByte; i++) {
if (message[message.length - 1 - i] !== padByte) {
throw new OperationError("Invalid PKCS#5 padding.");
}
}
return message.slice(0, message.length - padByte);
}
throw new OperationError("Invalid PKCS#5 padding.");
}
case "BIT": {
// Find 0x80 byte working backwards, skipping zeros
for (let i = message.length - 1; i >= 0; i--) {
if (message[i] === 0x80) {
return message.slice(0, i);
} else if (message[i] !== 0) {
throw new OperationError("Invalid BIT padding.");
}
}
throw new OperationError("Invalid BIT padding.");
}
default:
throw new OperationError(`Unknown padding type: ${padding}`);
}
}
/**
* Encrypt using RC6 cipher with specified block mode
*
* @param {number[]} message - Plaintext as byte array
* @param {number[]} key - Key as byte array
* @param {number[]} iv - IV (block size bytes, not used for ECB)
* @param {string} mode - Block cipher mode ("ECB", "CBC", "CFB", "OFB", "CTR")
* @param {string} padding - Padding type ("NO", "PKCS5", "ZERO", "RANDOM", "BIT")
* @param {number} rounds - Number of rounds (default: 20)
* @param {number} w - Word size in bits (default: 32)
* @returns {number[]} - Ciphertext as byte array
*/
export function encryptRC6(message, key, iv, mode = "ECB", padding = "PKCS5", rounds = 20, w = 32) {
const blockSize = getBlockSize(w);
const messageLength = message.length;
if (messageLength === 0) return [];
const S = generateSubkeys(key, rounds, w);
// Apply padding for ECB/CBC modes
let paddedMessage;
if (mode === "ECB" || mode === "CBC") {
paddedMessage = applyPadding(message, padding, blockSize);
} else {
// Stream modes (CFB, OFB, CTR) don't need padding
paddedMessage = [...message];
}
const cipherText = [];
switch (mode) {
case "ECB":
for (let i = 0; i < paddedMessage.length; i += blockSize) {
const block = paddedMessage.slice(i, i + blockSize);
cipherText.push(...encryptBlock(block, S, rounds, w));
}
break;
case "CBC": {
let ivBlock = [...iv];
for (let i = 0; i < paddedMessage.length; i += blockSize) {
const block = paddedMessage.slice(i, i + blockSize);
const xored = xorBlocks(block, ivBlock);
ivBlock = encryptBlock(xored, S, rounds, w);
cipherText.push(...ivBlock);
}
break;
}
case "CFB": {
let ivBlock = [...iv];
for (let i = 0; i < paddedMessage.length; i += blockSize) {
const encrypted = encryptBlock(ivBlock, S, rounds, w);
const block = paddedMessage.slice(i, i + blockSize);
// Pad block if shorter than blockSize
while (block.length < blockSize) block.push(0);
ivBlock = xorBlocks(encrypted, block);
cipherText.push(...ivBlock);
}
return cipherText.slice(0, messageLength);
}
case "OFB": {
let ivBlock = [...iv];
for (let i = 0; i < paddedMessage.length; i += blockSize) {
ivBlock = encryptBlock(ivBlock, S, rounds, w);
const block = paddedMessage.slice(i, i + blockSize);
// Pad block if shorter than blockSize
while (block.length < blockSize) block.push(0);
cipherText.push(...xorBlocks(ivBlock, block));
}
return cipherText.slice(0, messageLength);
}
case "CTR": {
let counter = [...iv];
for (let i = 0; i < paddedMessage.length; i += blockSize) {
const encrypted = encryptBlock(counter, S, rounds, w);
const block = paddedMessage.slice(i, i + blockSize);
// Pad block if shorter than blockSize
while (block.length < blockSize) block.push(0);
cipherText.push(...xorBlocks(encrypted, block));
counter = incrementCounter(counter);
}
return cipherText.slice(0, messageLength);
}
default:
throw new OperationError(`Invalid block cipher mode: ${mode}`);
}
return cipherText;
}
/**
* Decrypt using RC6 cipher with specified block mode
*
* @param {number[]} cipherText - Ciphertext as byte array
* @param {number[]} key - Key as byte array
* @param {number[]} iv - IV (block size bytes, not used for ECB)
* @param {string} mode - Block cipher mode ("ECB", "CBC", "CFB", "OFB", "CTR")
* @param {string} padding - Padding type ("NO", "PKCS5", "ZERO", "RANDOM", "BIT")
* @param {number} rounds - Number of rounds (default: 20)
* @param {number} w - Word size in bits (default: 32)
* @returns {number[]} - Plaintext as byte array
*/
export function decryptRC6(cipherText, key, iv, mode = "ECB", padding = "PKCS5", rounds = 20, w = 32) {
const blockSize = getBlockSize(w);
const originalLength = cipherText.length;
if (originalLength === 0) return [];
const S = generateSubkeys(key, rounds, w);
if (mode === "ECB" || mode === "CBC") {
if ((originalLength % blockSize) !== 0)
throw new OperationError(`Invalid ciphertext length: ${originalLength} bytes. Must be a multiple of ${blockSize}.`);
} else {
// Pad for stream modes
while ((cipherText.length % blockSize) !== 0)
cipherText.push(0);
}
const plainText = [];
switch (mode) {
case "ECB":
for (let i = 0; i < cipherText.length; i += blockSize) {
const block = cipherText.slice(i, i + blockSize);
plainText.push(...decryptBlock(block, S, rounds, w));
}
break;
case "CBC": {
let ivBlock = [...iv];
for (let i = 0; i < cipherText.length; i += blockSize) {
const block = cipherText.slice(i, i + blockSize);
const decrypted = decryptBlock(block, S, rounds, w);
plainText.push(...xorBlocks(decrypted, ivBlock));
ivBlock = block;
}
break;
}
case "CFB": {
let ivBlock = [...iv];
for (let i = 0; i < cipherText.length; i += blockSize) {
const encrypted = encryptBlock(ivBlock, S, rounds, w);
const block = cipherText.slice(i, i + blockSize);
plainText.push(...xorBlocks(encrypted, block));
ivBlock = block;
}
return plainText.slice(0, originalLength);
}
case "OFB": {
let ivBlock = [...iv];
for (let i = 0; i < cipherText.length; i += blockSize) {
ivBlock = encryptBlock(ivBlock, S, rounds, w);
const block = cipherText.slice(i, i + blockSize);
plainText.push(...xorBlocks(ivBlock, block));
}
return plainText.slice(0, originalLength);
}
case "CTR": {
let counter = [...iv];
for (let i = 0; i < cipherText.length; i += blockSize) {
const encrypted = encryptBlock(counter, S, rounds, w);
const block = cipherText.slice(i, i + blockSize);
plainText.push(...xorBlocks(encrypted, block));
counter = incrementCounter(counter);
}
return plainText.slice(0, originalLength);
}
default:
throw new OperationError(`Invalid block cipher mode: ${mode}`);
}
// Remove padding for ECB/CBC modes
if (mode === "ECB" || mode === "CBC") {
return removePadding(plainText, padding, blockSize);
}
return plainText.slice(0, originalLength);
}

2
src/core/operations/A1Z26CipherDecode.mjs
View File

@ -76,7 +76,7 @@ class A1Z26CipherDecode extends Operation {
const delim = Utils.charRep(args[0] || "Space");
if (input.length === 0) {
return [];
return "";
}
const bites = input.split(delim);

77
src/core/operations/AESDecrypt.mjs
View File

@ -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;
};
}

37
src/core/operations/AESEncrypt.mjs
View File

@ -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;
}
}

180
src/core/operations/AddTextToImage.mjs
View File

@ -9,13 +9,19 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import {
Jimp,
JimpMime,
ResizeStrategy,
measureText,
measureTextHeight,
loadFont,
} from "jimp";
/**
* Add Text To Image operation
*/
class AddTextToImage extends Operation {
/**
* AddTextToImage constructor
*/
@ -24,7 +30,8 @@ class AddTextToImage extends Operation {
this.name = "Add Text To Image";
this.module = "Image";
this.description = "Adds text onto an image.<br><br>Text can be horizontally or vertically aligned, or the position can be manually specified.<br>Variants of the Roboto font face are available in any size or colour.";
this.description =
"Adds text onto an image.<br><br>Text can be horizontally or vertically aligned, or the position can be manually specified.<br>Variants of the Roboto font face are available in any size or colour.";
this.infoURL = "";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
@ -33,72 +40,67 @@ class AddTextToImage extends Operation {
{
name: "Text",
type: "string",
value: ""
value: "",
},
{
name: "Horizontal align",
type: "option",
value: ["None", "Left", "Center", "Right"]
value: ["None", "Left", "Center", "Right"],
},
{
name: "Vertical align",
type: "option",
value: ["None", "Top", "Middle", "Bottom"]
value: ["None", "Top", "Middle", "Bottom"],
},
{
name: "X position",
type: "number",
value: 0
value: 0,
},
{
name: "Y position",
type: "number",
value: 0
value: 0,
},
{
name: "Size",
type: "number",
value: 32,
min: 8
min: 8,
},
{
name: "Font face",
type: "option",
value: [
"Roboto",
"Roboto Black",
"Roboto Mono",
"Roboto Slab"
]
value: ["Roboto", "Roboto Black", "Roboto Mono", "Roboto Slab"],
},
{
name: "Red",
type: "number",
value: 255,
min: 0,
max: 255
max: 255,
},
{
name: "Green",
type: "number",
value: 255,
min: 0,
max: 255
max: 255,
},
{
name: "Blue",
type: "number",
value: 255,
min: 0,
max: 255
max: 255,
},
{
name: "Alpha",
type: "number",
value: 255,
min: 0,
max: 255
}
max: 255,
},
];
}
@ -131,41 +133,60 @@ class AddTextToImage extends Operation {
} catch (err) {
throw new OperationError(`Error loading image. (${err})`);
}
try {
if (isWorkerEnvironment())
self.sendStatusMessage("Adding text to image...");
const fontsMap = {};
if (isWorkerEnvironment())
self.sendStatusMessage("Adding text to image...");
const fontsMap = {};
try {
const fonts = [
import(/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/Roboto72White.fnt"),
import(/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoBlack72White.fnt"),
import(/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoMono72White.fnt"),
import(/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoSlab72White.fnt")
import(
/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/Roboto72White.fnt"
),
import(
/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoBlack72White.fnt"
),
import(
/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoMono72White.fnt"
),
import(
/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoSlab72White.fnt"
),
];
await Promise.all(fonts)
.then(fonts => {
fontsMap.Roboto = fonts[0];
fontsMap["Roboto Black"] = fonts[1];
fontsMap["Roboto Mono"] = fonts[2];
fontsMap["Roboto Slab"] = fonts[3];
});
await Promise.all(fonts).then((fonts) => {
fontsMap.Roboto = fonts[0];
fontsMap["Roboto Black"] = fonts[1];
fontsMap["Roboto Mono"] = fonts[2];
fontsMap["Roboto Slab"] = fonts[3];
});
// Make Webpack load the png font images
await Promise.all([
import(/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/Roboto72White.png"),
import(/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoSlab72White.png"),
import(/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoMono72White.png"),
import(/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoBlack72White.png")
import(
/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/Roboto72White.png"
),
import(
/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoSlab72White.png"
),
import(
/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoMono72White.png"
),
import(
/* webpackMode: "eager" */ "../../web/static/fonts/bmfonts/RobotoBlack72White.png"
),
]);
} catch (err) {
throw new OperationError(`Error preparing fonts. (${err})`);
}
let jimpFont;
try {
const font = fontsMap[fontFace];
// LoadFont needs an absolute url, so append the font name to self.docURL
const jimpFont = await Jimp.loadFont(self.docURL + "/" + font.default);
jimpFont = await loadFont(self.docURL + "/" + font.default);
jimpFont.pages.forEach(function(page) {
jimpFont.pages.forEach(function (page) {
if (page.bitmap) {
// Adjust the RGB values of the image pages to change the font colour.
const pageWidth = page.bitmap.width;
@ -175,32 +196,56 @@ class AddTextToImage extends Operation {
const idx = (iy * pageWidth + ix) << 2;
const newRed = page.bitmap.data[idx] - (255 - red);
const newGreen = page.bitmap.data[idx + 1] - (255 - green);
const newBlue = page.bitmap.data[idx + 2] - (255 - blue);
const newAlpha = page.bitmap.data[idx + 3] - (255 - alpha);
const newGreen =
page.bitmap.data[idx + 1] - (255 - green);
const newBlue =
page.bitmap.data[idx + 2] - (255 - blue);
const newAlpha =
page.bitmap.data[idx + 3] - (255 - alpha);
// Make sure the bitmap values don't go below 0 as that makes jimp very unhappy
page.bitmap.data[idx] = (newRed > 0) ? newRed : 0;
page.bitmap.data[idx + 1] = (newGreen > 0) ? newGreen : 0;
page.bitmap.data[idx + 2] = (newBlue > 0) ? newBlue : 0;
page.bitmap.data[idx + 3] = (newAlpha > 0) ? newAlpha : 0;
page.bitmap.data[idx] = newRed > 0 ? newRed : 0;
page.bitmap.data[idx + 1] =
newGreen > 0 ? newGreen : 0;
page.bitmap.data[idx + 2] =
newBlue > 0 ? newBlue : 0;
page.bitmap.data[idx + 3] =
newAlpha > 0 ? newAlpha : 0;
}
}
}
});
} catch (err) {
throw new OperationError(`Error loading font. (${err})`);
}
try {
// Create a temporary image to hold the rendered text
const textImage = new Jimp(Jimp.measureText(jimpFont, text), Jimp.measureTextHeight(jimpFont, text));
textImage.print(jimpFont, 0, 0, text);
const textImage = new Jimp({
width: measureText(jimpFont, text),
height: measureTextHeight(jimpFont, text),
});
textImage.print({
font: jimpFont,
x: 0,
y: 0,
text,
});
// Scale the rendered text image to the correct size
const scaleFactor = size / 72;
if (size !== 1) {
// Use bicubic for decreasing size
if (size > 1) {
textImage.scale(scaleFactor, Jimp.RESIZE_BICUBIC);
textImage.scale({
f: scaleFactor,
mode: ResizeStrategy.BICUBIC,
});
} else {
textImage.scale(scaleFactor, Jimp.RESIZE_BILINEAR);
textImage.scale({
f: scaleFactor,
mode: ResizeStrategy.BILINEAR,
});
}
}
@ -210,10 +255,10 @@ class AddTextToImage extends Operation {
xPos = 0;
break;
case "Center":
xPos = (image.getWidth() / 2) - (textImage.getWidth() / 2);
xPos = image.width / 2 - textImage.width / 2;
break;
case "Right":
xPos = image.getWidth() - textImage.getWidth();
xPos = image.width - textImage.width;
break;
}
@ -222,25 +267,33 @@ class AddTextToImage extends Operation {
yPos = 0;
break;
case "Middle":
yPos = (image.getHeight() / 2) - (textImage.getHeight() / 2);
yPos = image.height / 2 - textImage.height / 2;
break;
case "Bottom":
yPos = image.getHeight() - textImage.getHeight();
yPos = image.height - textImage.height;
break;
}
// Blit the rendered text image onto the original source image
image.blit(textImage, xPos, yPos);
image.blit({
src: textImage,
x: xPos,
y: yPos,
});
} catch (err) {
throw new OperationError(`Error adding text to image. (${err})`);
}
try {
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
throw new OperationError(`Error adding text to image. (${err})`);
throw new OperationError(`Error exporting image. (${err})`);
}
}
@ -261,7 +314,6 @@ class AddTextToImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default AddTextToImage;

115
src/core/operations/AnalyseUUID.mjs
View File

@ -1,5 +1,6 @@
/**
* @author n1474335 [n1474335@gmail.com]
* @author ko80240 [csk.dev@proton.me]
* @copyright Crown Copyright 2023
* @license Apache-2.0
*/
@ -8,6 +9,7 @@ import * as uuid from "uuid";
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import { toHex } from "../lib/Hex.mjs";
/**
* Analyse UUID operation
@ -22,27 +24,128 @@ class AnalyseUUID extends Operation {
this.name = "Analyse UUID";
this.module = "Crypto";
this.description = "Tries to determine information about a given UUID and suggests which version may have been used to generate it";
this.description = "Operation for extracting metadata and detecting the version of a given UUID.";
this.infoURL = "https://wikipedia.org/wiki/Universally_unique_identifier";
this.inputType = "string";
this.outputType = "string";
this.args = [];
this.args = [
{
name: "Include Metadata",
type: "boolean",
value: true
}
];
}
/**
* @param {string} input
* @param {string} input - Expects a valid UUID string
* @param {Object[]} args
* @returns {string}
*/
run(input, args) {
input = input.trim();
let uuidVersion, uuidBytes;
try {
const uuidVersion = uuid.version(input);
return "UUID version: " + uuidVersion;
uuidVersion = uuid.version(input); // Re-using the uuid library to extract version
uuidBytes = uuid.parse(input); // Re-using the uuid library to parse bytes
} catch (error) {
throw new OperationError("Invalid UUID");
}
}
const [includeMetadata] = args;
const dv = new DataView(uuidBytes.buffer, uuidBytes.byteOffset, uuidBytes.byteLength); // Dataview helps handle the multi-byte ints
const uuidInteger = (dv.getBigUint64(0) << 64n) | dv.getBigUint64(8);
const sections = [`Version:\n${uuidVersion}`];
if (includeMetadata) {
const parser = UUID_PARSERS[uuidVersion];
const decoded = parser?.(uuidBytes, dv);
sections.push(formatDecoded(decoded));
}
sections.push(`UUID Integer:\n${uuidInteger}`);
return sections.filter(Boolean).join("\n\n");
}
}
export default AnalyseUUID;
/**
* Metadata can be extracted for versions 1, 6, and 7.
* Enum-like frozen mapping of UUID version to parser function.
*/
const UUID_PARSERS = Object.freeze({
1: parsev1v6,
6: parsev1v6,
7: parsev7,
});
/**
* Versions 1 and 6. Note 6 is a re-order of 1.
* Version 1 == layout: timeLow(32) | timeMid(16) | timeHi(12)
* Version 6 == layout: timeHi(32) | timeMid(16) | timeLow(12)
*/
function parsev1v6(uuidBytes, dv) {
const isV1 = (uuidBytes[6] >> 4) === 1;
const timeStamp =
isV1 ? (
(BigInt(dv.getUint16(6) & 0x0fff) << 48n) | // mask off version bits
(BigInt(dv.getUint16(4)) << 32n) |
BigInt(dv.getUint32(0))
) : (
(BigInt(dv.getUint32(0)) << 28n) |
(BigInt(dv.getUint16(4)) << 12n) |
(BigInt(dv.getUint16(6) & 0x0fff))
);
// Convert to Unix time
const milliseconds =
Number(
(timeStamp - 122192928000000000n) / 10000n
);
return {
timestamp: milliseconds,
isoTimestamp: new Date(milliseconds).toISOString(),
clock: ((uuidBytes[8] & 0x3f) << 8) | uuidBytes[9],
node: toHex(uuidBytes.slice(10), ":").toUpperCase()
};
}
/** Version 7 */
function parsev7(uuidBytes, dv) {
const milliseconds = Number((BigInt(dv.getUint32(0)) << 16n) | BigInt(dv.getUint16(4)));
return {
timestamp: milliseconds,
isoTimestamp: new Date(milliseconds).toISOString(),
randA: ((uuidBytes[6] & 0x0f) << 8) | uuidBytes[7],
randB: toHex(uuidBytes.slice(8), "").toUpperCase()
};
}
/**
* Formats metadata
*
* @param {Object|undefined} decoded
* @returns {string}
*/
function formatDecoded(decoded) {
if (!decoded) return "No metadata available. Only versions 1, 6, 7 are supported.";
return Object.entries({
"Timestamp": decoded.timestamp,
"Timestamp (ISO)": decoded.isoTimestamp,
"Node": decoded.node,
"Clock": decoded.clock,
"Rand A": decoded.randA,
"Rand B": decoded.randB
})
.filter(([, value]) => value !== undefined)
.map(([label, value]) => `${label}:\n${value}`)
.join("\n\n");
}

20
src/core/operations/BLAKE3.mjs
View File

@ -6,7 +6,10 @@
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import { blake3 } from "hash-wasm";
import Utils from "../Utils.mjs";
import { blake3 } from "@noble/hashes/blake3.js";
import { bytesToHex } from "@noble/hashes/utils.js";
/**
* BLAKE3 operation
*/
@ -44,13 +47,16 @@ class BLAKE3 extends Operation {
run(input, args) {
const key = args[1];
const size = args[0];
// Check if the user want a key hash or not
if (key === "") {
return blake3(input, size*8);
} if (key.length !== 32) {
throw new OperationError("The key must be exactly 32 bytes long");
const opts = { dkLen: size };
const inputBytes = new Uint8Array(Utils.strToArrayBuffer(input));
if (key !== "") {
const keyBytes = new Uint8Array(Utils.strToArrayBuffer(key));
if (keyBytes.length !== 32) {
throw new OperationError("The key must be exactly 32 bytes long");
}
opts.key = keyBytes;
}
return blake3(input, size*8, key);
return bytesToHex(blake3(inputBytes, opts));
}
}

4
src/core/operations/BSONDeserialise.mjs
View File

@ -5,7 +5,7 @@
*/
import Operation from "../Operation.mjs";
import bson from "bson";
import { deserialize } from "bson";
import OperationError from "../errors/OperationError.mjs";
/**
@ -37,7 +37,7 @@ class BSONDeserialise extends Operation {
if (!input.byteLength) return "";
try {
const data = bson.deserialize(new Buffer(input));
const data = deserialize(new Uint8Array(input));
return JSON.stringify(data, null, 2);
} catch (err) {
throw new OperationError(err.toString());

5
src/core/operations/BSONSerialise.mjs
View File

@ -5,7 +5,7 @@
*/
import Operation from "../Operation.mjs";
import bson from "bson";
import { serialize } from "bson";
import OperationError from "../errors/OperationError.mjs";
/**
@ -38,7 +38,8 @@ class BSONSerialise extends Operation {
try {
const data = JSON.parse(input);
return bson.serialize(data).buffer;
const result = serialize(data);
return result.buffer.slice(result.byteOffset, result.byteOffset + result.byteLength);
} catch (err) {
throw new OperationError(err.toString());
}

2
src/core/operations/Bcrypt.mjs
View File

@ -43,7 +43,7 @@ class Bcrypt extends Operation {
const rounds = args[0];
const salt = await bcrypt.genSalt(rounds);
return await bcrypt.hash(input, salt, null, p => {
return await bcrypt.hash(input, salt, undefined, p => {
// Progress callback
if (isWorkerEnvironment())
self.sendStatusMessage(`Progress: ${(p * 100).toFixed(0)}%`);

2
src/core/operations/BcryptCompare.mjs
View File

@ -43,7 +43,7 @@ class BcryptCompare extends Operation {
async run(input, args) {
const hash = args[0];
const match = await bcrypt.compare(input, hash, null, p => {
const match = await bcrypt.compare(input, hash, undefined, p => {
// Progress callback
if (isWorkerEnvironment())
self.sendStatusMessage(`Progress: ${(p * 100).toFixed(0)}%`);

22
src/core/operations/BlurImage.mjs
View File

@ -9,14 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { gaussianBlur } from "../lib/ImageManipulation.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Blur Image operation
*/
class BlurImage extends Operation {
/**
* BlurImage constructor
*/
@ -25,7 +23,8 @@ class BlurImage extends Operation {
this.name = "Blur Image";
this.module = "Image";
this.description = "Applies a blur effect to the image.<br><br>Gaussian blur is much slower than fast blur, but produces better results.";
this.description =
"Applies a blur effect to the image.<br><br>Gaussian blur is much slower than fast blur, but produces better results.";
this.infoURL = "https://wikipedia.org/wiki/Gaussian_blur";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
@ -35,13 +34,13 @@ class BlurImage extends Operation {
name: "Amount",
type: "number",
value: 5,
min: 1
min: 1,
},
{
name: "Type",
type: "option",
value: ["Fast", "Gaussian"]
}
value: ["Fast", "Gaussian"],
},
];
}
@ -73,15 +72,15 @@ class BlurImage extends Operation {
case "Gaussian":
if (isWorkerEnvironment())
self.sendStatusMessage("Gaussian blurring image...");
image = gaussianBlur(image, blurAmount);
image.gaussian(blurAmount);
break;
}
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
@ -106,7 +105,6 @@ class BlurImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default BlurImage;

90
src/core/operations/ContainImage.mjs
View File

@ -9,13 +9,18 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import {
Jimp,
JimpMime,
ResizeStrategy,
HorizontalAlign,
VerticalAlign,
} from "jimp";
/**
* Contain Image operation
*/
class ContainImage extends Operation {
/**
* ContainImage constructor
*/
@ -24,7 +29,8 @@ class ContainImage extends Operation {
this.name = "Contain Image";
this.module = "Image";
this.description = "Scales an image to the specified width and height, maintaining the aspect ratio. The image may be letterboxed.";
this.description =
"Scales an image to the specified width and height, maintaining the aspect ratio. The image may be letterboxed.";
this.infoURL = "";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
@ -34,33 +40,25 @@ class ContainImage extends Operation {
name: "Width",
type: "number",
value: 100,
min: 1
min: 1,
},
{
name: "Height",
type: "number",
value: 100,
min: 1
min: 1,
},
{
name: "Horizontal align",
type: "option",
value: [
"Left",
"Center",
"Right"
],
defaultIndex: 1
value: ["Left", "Center", "Right"],
defaultIndex: 1,
},
{
name: "Vertical align",
type: "option",
value: [
"Top",
"Middle",
"Bottom"
],
defaultIndex: 1
value: ["Top", "Middle", "Bottom"],
defaultIndex: 1,
},
{
name: "Resizing algorithm",
@ -70,15 +68,15 @@ class ContainImage extends Operation {
"Bilinear",
"Bicubic",
"Hermite",
"Bezier"
"Bezier",
],
defaultIndex: 1
defaultIndex: 1,
},
{
name: "Opaque background",
type: "boolean",
value: true
}
value: true,
},
];
}
@ -91,20 +89,20 @@ class ContainImage extends Operation {
const [width, height, hAlign, vAlign, alg, opaqueBg] = args;
const resizeMap = {
"Nearest Neighbour": Jimp.RESIZE_NEAREST_NEIGHBOR,
"Bilinear": Jimp.RESIZE_BILINEAR,
"Bicubic": Jimp.RESIZE_BICUBIC,
"Hermite": Jimp.RESIZE_HERMITE,
"Bezier": Jimp.RESIZE_BEZIER
"Nearest Neighbour": ResizeStrategy.NEAREST_NEIGHBOR,
Bilinear: ResizeStrategy.BILINEAR,
Bicubic: ResizeStrategy.BICUBIC,
Hermite: ResizeStrategy.HERMITE,
Bezier: ResizeStrategy.BEZIER,
};
const alignMap = {
"Left": Jimp.HORIZONTAL_ALIGN_LEFT,
"Center": Jimp.HORIZONTAL_ALIGN_CENTER,
"Right": Jimp.HORIZONTAL_ALIGN_RIGHT,
"Top": Jimp.VERTICAL_ALIGN_TOP,
"Middle": Jimp.VERTICAL_ALIGN_MIDDLE,
"Bottom": Jimp.VERTICAL_ALIGN_BOTTOM
Left: HorizontalAlign.LEFT,
Center: HorizontalAlign.CENTER,
Right: HorizontalAlign.RIGHT,
Top: VerticalAlign.TOP,
Middle: VerticalAlign.MIDDLE,
Bottom: VerticalAlign.BOTTOM,
};
if (!isImage(input)) {
@ -117,22 +115,35 @@ class ContainImage extends Operation {
} catch (err) {
throw new OperationError(`Error loading image. (${err})`);
}
const originalMime = image.mime;
try {
if (isWorkerEnvironment())
self.sendStatusMessage("Containing image...");
image.contain(width, height, alignMap[hAlign] | alignMap[vAlign], resizeMap[alg]);
image.contain({
w: width,
h: height,
align: alignMap[hAlign] | alignMap[vAlign],
mode: resizeMap[alg],
});
if (opaqueBg) {
const newImage = await Jimp.read(width, height, 0x000000FF);
newImage.blit(image, 0, 0);
image = newImage;
const newImage = new Jimp({
width,
height,
color: 0x000000ff,
});
image = newImage.blit({
src: image,
x: 0,
y: 0,
});
}
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (originalMime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(originalMime);
}
return imageBuffer.buffer;
} catch (err) {
@ -156,7 +167,6 @@ class ContainImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default ContainImage;

72
src/core/operations/ConvertImageFormat.mjs
View File

@ -8,13 +8,12 @@ import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime, PNGFilterType } from "jimp";
/**
* Convert Image Format operation
*/
class ConvertImageFormat extends Operation {
/**
* ConvertImageFormat constructor
*/
@ -23,7 +22,8 @@ class ConvertImageFormat extends Operation {
this.name = "Convert Image Format";
this.module = "Image";
this.description = "Converts an image between different formats. Supported formats:<br><ul><li>Joint Photographic Experts Group (JPEG)</li><li>Portable Network Graphics (PNG)</li><li>Bitmap (BMP)</li><li>Tagged Image File Format (TIFF)</li></ul><br>Note: GIF files are supported for input, but cannot be outputted.";
this.description =
"Converts an image between different formats. Supported formats:<br><ul><li>Joint Photographic Experts Group (JPEG)</li><li>Portable Network Graphics (PNG)</li><li>Bitmap (BMP)</li><li>Tagged Image File Format (TIFF)</li></ul><br>Note: GIF files are supported for input, but cannot be outputted.";
this.infoURL = "https://wikipedia.org/wiki/Image_file_formats";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
@ -32,39 +32,27 @@ class ConvertImageFormat extends Operation {
{
name: "Output Format",
type: "option",
value: [
"JPEG",
"PNG",
"BMP",
"TIFF"
]
value: ["JPEG", "PNG", "BMP", "TIFF"],
},
{
name: "JPEG Quality",
type: "number",
value: 80,
min: 1,
max: 100
max: 100,
},
{
name: "PNG Filter Type",
type: "option",
value: [
"Auto",
"None",
"Sub",
"Up",
"Average",
"Paeth"
]
value: ["Auto", "None", "Sub", "Up", "Average", "Paeth"],
},
{
name: "PNG Deflate Level",
type: "number",
value: 9,
min: 0,
max: 9
}
max: 9,
},
];
}
@ -76,19 +64,19 @@ class ConvertImageFormat extends Operation {
async run(input, args) {
const [format, jpegQuality, pngFilterType, pngDeflateLevel] = args;
const formatMap = {
"JPEG": Jimp.MIME_JPEG,
"PNG": Jimp.MIME_PNG,
"BMP": Jimp.MIME_BMP,
"TIFF": Jimp.MIME_TIFF
JPEG: JimpMime.jpeg,
PNG: JimpMime.png,
BMP: JimpMime.bmp,
TIFF: JimpMime.tiff,
};
const pngFilterMap = {
"Auto": Jimp.PNG_FILTER_AUTO,
"None": Jimp.PNG_FILTER_NONE,
"Sub": Jimp.PNG_FILTER_SUB,
"Up": Jimp.PNG_FILTER_UP,
"Average": Jimp.PNG_FILTER_AVERAGE,
"Paeth": Jimp.PNG_FILTER_PATH
Auto: PNGFilterType.AUTO,
None: PNGFilterType.NONE,
Sub: PNGFilterType.SUB,
Up: PNGFilterType.UP,
Average: PNGFilterType.AVERAGE,
Paeth: PNGFilterType.PATH,
};
const mime = formatMap[format];
@ -103,18 +91,25 @@ class ConvertImageFormat extends Operation {
throw new OperationError(`Error opening image file. (${err})`);
}
try {
switch (format) {
case "JPEG":
image.quality(jpegQuality);
let buffer;
switch (mime) {
case JimpMime.jpeg:
buffer = await image.getBuffer(mime, {
quality: jpegQuality,
});
break;
case "PNG":
image.filterType(pngFilterMap[pngFilterType]);
image.deflateLevel(pngDeflateLevel);
case JimpMime.png:
buffer = await image.getBuffer(mime, {
filterType: pngFilterMap[pngFilterType],
deflateLevel: pngDeflateLevel,
});
break;
default:
buffer = await image.getBuffer(mime);
break;
}
const imageBuffer = await image.getBufferAsync(mime);
return imageBuffer.buffer;
return buffer.buffer;
} catch (err) {
throw new OperationError(`Error converting image format. (${err})`);
}
@ -137,7 +132,6 @@ class ConvertImageFormat extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default ConvertImageFormat;

76
src/core/operations/CoverImage.mjs
View File

@ -9,13 +9,18 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import jimp from "jimp/es/index.js";
import {
Jimp,
JimpMime,
ResizeStrategy,
HorizontalAlign,
VerticalAlign,
} from "jimp";
/**
* Cover Image operation
*/
class CoverImage extends Operation {
/**
* CoverImage constructor
*/
@ -24,7 +29,8 @@ class CoverImage extends Operation {
this.name = "Cover Image";
this.module = "Image";
this.description = "Scales the image to the given width and height, keeping the aspect ratio. The image may be clipped.";
this.description =
"Scales the image to the given width and height, keeping the aspect ratio. The image may be clipped.";
this.infoURL = "";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
@ -34,33 +40,25 @@ class CoverImage extends Operation {
name: "Width",
type: "number",
value: 100,
min: 1
min: 1,
},
{
name: "Height",
type: "number",
value: 100,
min: 1
min: 1,
},
{
name: "Horizontal align",
type: "option",
value: [
"Left",
"Center",
"Right"
],
defaultIndex: 1
value: ["Left", "Center", "Right"],
defaultIndex: 1,
},
{
name: "Vertical align",
type: "option",
value: [
"Top",
"Middle",
"Bottom"
],
defaultIndex: 1
value: ["Top", "Middle", "Bottom"],
defaultIndex: 1,
},
{
name: "Resizing algorithm",
@ -70,10 +68,10 @@ class CoverImage extends Operation {
"Bilinear",
"Bicubic",
"Hermite",
"Bezier"
"Bezier",
],
defaultIndex: 1
}
defaultIndex: 1,
},
];
}
@ -86,20 +84,20 @@ class CoverImage extends Operation {
const [width, height, hAlign, vAlign, alg] = args;
const resizeMap = {
"Nearest Neighbour": jimp.RESIZE_NEAREST_NEIGHBOR,
"Bilinear": jimp.RESIZE_BILINEAR,
"Bicubic": jimp.RESIZE_BICUBIC,
"Hermite": jimp.RESIZE_HERMITE,
"Bezier": jimp.RESIZE_BEZIER
"Nearest Neighbour": ResizeStrategy.NEAREST_NEIGHBOR,
Bilinear: ResizeStrategy.BILINEAR,
Bicubic: ResizeStrategy.BICUBIC,
Hermite: ResizeStrategy.HERMITE,
Bezier: ResizeStrategy.BEZIER,
};
const alignMap = {
"Left": jimp.HORIZONTAL_ALIGN_LEFT,
"Center": jimp.HORIZONTAL_ALIGN_CENTER,
"Right": jimp.HORIZONTAL_ALIGN_RIGHT,
"Top": jimp.VERTICAL_ALIGN_TOP,
"Middle": jimp.VERTICAL_ALIGN_MIDDLE,
"Bottom": jimp.VERTICAL_ALIGN_BOTTOM
Left: HorizontalAlign.LEFT,
Center: HorizontalAlign.CENTER,
Right: HorizontalAlign.RIGHT,
Top: VerticalAlign.TOP,
Middle: VerticalAlign.MIDDLE,
Bottom: VerticalAlign.BOTTOM,
};
if (!isImage(input)) {
@ -108,19 +106,24 @@ class CoverImage extends Operation {
let image;
try {
image = await jimp.read(input);
image = await Jimp.read(input);
} catch (err) {
throw new OperationError(`Error loading image. (${err})`);
}
try {
if (isWorkerEnvironment())
self.sendStatusMessage("Covering image...");
image.cover(width, height, alignMap[hAlign] | alignMap[vAlign], resizeMap[alg]);
image.cover({
w: width,
h: height,
align: alignMap[hAlign] | alignMap[vAlign],
mode: resizeMap[alg],
});
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
@ -144,7 +147,6 @@ class CoverImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default CoverImage;

56
src/core/operations/CropImage.mjs
View File

@ -9,13 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Crop Image operation
*/
class CropImage extends Operation {
/**
* CropImage constructor
*/
@ -24,7 +23,8 @@ class CropImage extends Operation {
this.name = "Crop Image";
this.module = "Image";
this.description = "Crops an image to the specified region, or automatically crops edges.<br><br><b><u>Autocrop</u></b><br>Automatically crops same-colour borders from the image.<br><br><u>Autocrop tolerance</u><br>A percentage value for the tolerance of colour difference between pixels.<br><br><u>Only autocrop frames</u><br>Only crop real frames (all sides must have the same border)<br><br><u>Symmetric autocrop</u><br>Force autocrop to be symmetric (top/bottom and left/right are cropped by the same amount)<br><br><u>Autocrop keep border</u><br>The number of pixels of border to leave around the image.";
this.description =
"Crops an image to the specified region, or automatically crops edges.<br><br><b><u>Autocrop</u></b><br>Automatically crops same-colour borders from the image.<br><br><u>Autocrop tolerance</u><br>A percentage value for the tolerance of colour difference between pixels.<br><br><u>Only autocrop frames</u><br>Only crop real frames (all sides must have the same border)<br><br><u>Symmetric autocrop</u><br>Force autocrop to be symmetric (top/bottom and left/right are cropped by the same amount)<br><br><u>Autocrop keep border</u><br>The number of pixels of border to leave around the image.";
this.infoURL = "https://wikipedia.org/wiki/Cropping_(image)";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
@ -34,30 +34,30 @@ class CropImage extends Operation {
name: "X Position",
type: "number",
value: 0,
min: 0
min: 0,
},
{
name: "Y Position",
type: "number",
value: 0,
min: 0
min: 0,
},
{
name: "Width",
type: "number",
value: 10,
min: 1
min: 1,
},
{
name: "Height",
type: "number",
value: 10,
min: 1
min: 1,
},
{
name: "Autocrop",
type: "boolean",
value: false
value: false,
},
{
name: "Autocrop tolerance (%)",
@ -65,24 +65,24 @@ class CropImage extends Operation {
value: 0.02,
min: 0,
max: 100,
step: 0.01
step: 0.01,
},
{
name: "Only autocrop frames",
type: "boolean",
value: true
value: true,
},
{
name: "Symmetric autocrop",
type: "boolean",
value: false
value: false,
},
{
name: "Autocrop keep border (px)",
type: "number",
value: 0,
min: 0
}
min: 0,
},
];
}
@ -92,7 +92,17 @@ class CropImage extends Operation {
* @returns {byteArray}
*/
async run(input, args) {
const [xPos, yPos, width, height, autocrop, autoTolerance, autoFrames, autoSymmetric, autoBorder] = args;
const [
xPos,
yPos,
width,
height,
autocrop,
autoTolerance,
autoFrames,
autoSymmetric,
autoBorder,
] = args;
if (!isImage(input)) {
throw new OperationError("Invalid file type.");
}
@ -108,20 +118,25 @@ class CropImage extends Operation {
self.sendStatusMessage("Cropping image...");
if (autocrop) {
image.autocrop({
tolerance: (autoTolerance / 100),
tolerance: autoTolerance / 100,
cropOnlyFrames: autoFrames,
cropSymmetric: autoSymmetric,
leaveBorder: autoBorder
leaveBorder: autoBorder,
});
} else {
image.crop(xPos, yPos, width, height);
image.crop({
x: xPos,
y: yPos,
w: width,
h: height,
});
}
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
@ -145,7 +160,6 @@ class CropImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default CropImage;

4
src/core/operations/DecodeText.mjs
View File

@ -5,6 +5,7 @@
*/
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import cptable from "codepage";
import {CHR_ENC_CODE_PAGES} from "../lib/ChrEnc.mjs";
@ -48,6 +49,9 @@ class DecodeText extends Operation {
*/
run(input, args) {
const format = CHR_ENC_CODE_PAGES[args[0]];
if (!format) {
throw new OperationError("Invalid encoding");
}
return cptable.utils.decode(format, new Uint8Array(input));
}

193
src/core/operations/DisassembleARM.mjs Normal file
View File

@ -0,0 +1,193 @@
/**
* @author MedjedThomasXM
* @copyright Crown Copyright 2024
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import cs from "@alexaltea/capstone-js/dist/capstone.min.js";
/**
* Disassemble ARM operation
*/
class DisassembleARM extends Operation {
/**
* DisassembleARM constructor
*/
constructor() {
super();
this.name = "Disassemble ARM";
this.module = "Shellcode";
this.description = "Disassembles ARM machine code into assembly language.<br><br>Supports ARM (32-bit), Thumb, and ARM64 (AArch64) architectures using the Capstone disassembly framework.<br><br>Input should be in hexadecimal.";
this.infoURL = "https://wikipedia.org/wiki/ARM_architecture_family";
this.inputType = "string";
this.outputType = "string";
this.args = [
{
"name": "Architecture",
"type": "option",
"value": ["ARM (32-bit)", "ARM64 (AArch64)"]
},
{
"name": "Mode",
"type": "option",
"value": ["ARM", "Thumb", "Thumb + Cortex-M", "ARMv8"]
},
{
"name": "Endianness",
"type": "option",
"value": ["Little Endian", "Big Endian"]
},
{
"name": "Starting address (hex)",
"type": "number",
"value": 0
},
{
"name": "Show instruction hex",
"type": "boolean",
"value": true
},
{
"name": "Show instruction position",
"type": "boolean",
"value": true
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
async run(input, args) {
const [
architecture,
mode,
endianness,
startAddress,
showHex,
showPosition
] = args;
// Remove whitespace from input
const hexInput = input.replace(/\s/g, "");
// Validate hex input
if (!/^[0-9a-fA-F]*$/.test(hexInput)) {
throw new OperationError("Invalid hexadecimal input. Please provide valid hex characters only.");
}
if (hexInput.length === 0) {
return "";
}
if (hexInput.length % 2 !== 0) {
throw new OperationError("Invalid hexadecimal input. Length must be even.");
}
// Convert hex string to byte array
const bytes = [];
for (let i = 0; i < hexInput.length; i += 2) {
bytes.push(parseInt(hexInput.substr(i, 2), 16));
}
// Determine architecture constant
let arch;
if (architecture === "ARM64 (AArch64)") {
arch = cs.ARCH_ARM64;
} else {
arch = cs.ARCH_ARM;
}
// Determine mode constant
let modeValue = cs.MODE_LITTLE_ENDIAN;
if (architecture === "ARM (32-bit)") {
switch (mode) {
case "ARM":
modeValue = cs.MODE_ARM;
break;
case "Thumb":
modeValue = cs.MODE_THUMB;
break;
case "Thumb + Cortex-M":
modeValue = cs.MODE_THUMB | cs.MODE_MCLASS;
break;
case "ARMv8":
modeValue = cs.MODE_ARM | cs.MODE_V8;
break;
default:
modeValue = cs.MODE_ARM;
}
} else {
// ARM64 only has one mode (ARM mode is default for ARM64)
modeValue = cs.MODE_ARM;
}
// Add endianness
if (endianness === "Big Endian") {
modeValue |= cs.MODE_BIG_ENDIAN;
}
if (isWorkerEnvironment()) {
self.sendStatusMessage("Disassembling...");
}
let disassembler;
try {
disassembler = new cs.Capstone(arch, modeValue);
} catch (e) {
throw new OperationError(`Failed to initialise Capstone disassembler: ${e}`);
}
let instructions;
try {
instructions = disassembler.disasm(bytes, startAddress);
} catch (e) {
disassembler.close();
// Check if it's a "no valid instructions" error (code 0 means OK but nothing decoded)
if (e && e.includes && e.includes("code 0:")) {
throw new OperationError(`No valid ${architecture} instructions found in input. The bytes may be for a different architecture or mode.`);
}
throw new OperationError(`Disassembly failed: ${e}`);
}
// Format output
const output = [];
for (const insn of instructions) {
let line = "";
if (showPosition) {
// Format address as hex with 0x prefix
const addrHex = "0x" + insn.address.toString(16).padStart(8, "0");
line += addrHex + " ";
}
if (showHex) {
// Format instruction bytes as hex
const bytesHex = insn.bytes.map(b => b.toString(16).padStart(2, "0")).join("");
line += bytesHex.padEnd(16, " ") + " ";
}
line += insn.mnemonic;
if (insn.op_str) {
line += " " + insn.op_str;
}
output.push(line);
}
disassembler.close();
return output.join("\n");
}
}
export default DisassembleARM;

16
src/core/operations/DitherImage.mjs
View File

@ -9,13 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Image Dither operation
*/
class DitherImage extends Operation {
/**
* DitherImage constructor
*/
@ -51,17 +50,19 @@ class DitherImage extends Operation {
try {
if (isWorkerEnvironment())
self.sendStatusMessage("Applying dither to image...");
image.dither565();
image.dither();
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
throw new OperationError(`Error applying dither to image. (${err})`);
throw new OperationError(
`Error applying dither to image. (${err})`,
);
}
}
@ -81,7 +82,6 @@ class DitherImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default DitherImage;

4
src/core/operations/EncodeText.mjs
View File

@ -5,6 +5,7 @@
*/
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import cptable from "codepage";
import {CHR_ENC_CODE_PAGES} from "../lib/ChrEnc.mjs";
@ -48,6 +49,9 @@ class EncodeText extends Operation {
*/
run(input, args) {
const format = CHR_ENC_CODE_PAGES[args[0]];
if (!format) {
throw new OperationError("Invalid encoding");
}
const encoded = cptable.utils.encode(format, input);
return new Uint8Array(encoded).buffer;
}

129
src/core/operations/EscapeSmartCharacters.mjs Normal file
View File

@ -0,0 +1,129 @@
/**
* @author HarelKatz [github.com/HarelKatz]
* @copyright Crown Copyright 2026
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
/**
* Escape Smart Characters operation
*/
class EscapeSmartCharacters extends Operation {
/**
* EscapeSmartCharacters constructor
*/
constructor() {
super();
this.name = "Escape Smart Characters";
this.module = "Default";
this.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>";
this.infoURL = "";
this.inputType = "string";
this.outputType = "string";
this.args = [
{
name: "Unmappable characters",
type: "option",
value: ["Include", "Remove", "Replace with '.'"]
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run(input, args) {
const [unmappable] = args;
let result = "";
for (const ch of input) {
if (ch.codePointAt(0) < 128) {
result += ch;
} else if (Object.prototype.hasOwnProperty.call(SMART_MAP, ch)) {
result += SMART_MAP[ch];
} else {
switch (unmappable) {
case "Remove":
break;
case "Replace with '.'":
result += ".";
break;
case "Include":
default:
result += ch;
break;
}
}
}
return result;
}
}
const SMART_MAP = {
// Smart double quotes
"“": "\"", // “ left double quotation mark
"”": "\"", // ” right double quotation mark
"„": "\"", // „ double low-9 quotation mark
"‟": "\"", // ‟ double high-reversed-9 quotation mark
"″": "\"", // ″ double prime
// Smart single quotes / apostrophes
"‘": "'", // ‘ left single quotation mark
"’": "'", // ’ right single quotation mark / apostrophe
"‚": "'", // ‚ single low-9 quotation mark
"‛": "'", // ‛ single high-reversed-9 quotation mark
"′": "'", // ′ prime
// Dashes & hyphens
"‐": "-", // ‐ hyphen
"‑": "-", // ‑ non-breaking hyphen
"‒": "-", // ‒ figure dash
"–": "-", // – en dash
"—": "--", // — em dash
"―": "--", // ― horizontal bar
// Ellipsis
"…": "...", // …
// Trademark / copyright symbols
"©": "(c)", // ©
"®": "(r)", // ®
"™": "(tm)", // ™
// Arrows
"←": "<--", // ←
"→": "-->", // →
"↑": "^", // ↑
"↓": "v", // ↓
"↔": "<->", // ↔
"⇐": "<==", // ⇐
"⇒": "==>", // ⇒
"⇔": "<=>", // ⇔
// Guillemets
"«": "<<", // «
"»": ">>", // »
"‹": "<", // ‹
"›": ">", // ›
// Math & misc symbols
"×": "x", // ×
"÷": "/", // ÷
"±": "+/-", // ±
"•": "*", // •
"·": ".", // ·
// Non-ASCII spaces
"\u00A0": " ", // NBSP
"\u2002": " ", // en space
"\u2003": " ", // em space
"\u2009": " ", // thin space
"\u200A": " " // hair space
};
export default EscapeSmartCharacters;

17
src/core/operations/EscapeUnicodeCharacters.mjs
View File

@ -44,23 +44,6 @@ class EscapeUnicodeCharacters extends Operation {
"value": true
}
];
this.checks = [
{
pattern: "\\\\u(?:[\\da-f]{4,6})",
flags: "i",
args: ["\\u"]
},
{
pattern: "%u(?:[\\da-f]{4,6})",
flags: "i",
args: ["%u"]
},
{
pattern: "U\\+(?:[\\da-f]{4,6})",
flags: "i",
args: ["U+"]
}
];
}
/**

175
src/core/operations/ExtractAudioMetadata.mjs Normal file
View File

@ -0,0 +1,175 @@
/**
* @author d0s1nt [d0s1nt@cyberchefaudio]
* @copyright Crown Copyright 2025
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import Utils from "../Utils.mjs";
import { makeEmptyReport, sniffContainer } from "../lib/AudioMetaSchema.mjs";
import {
parseMp3, parseRiffWave, parseFlac, parseOgg,
parseMp4BestEffort, parseAiffBestEffort,
parseAacAdts, parseAc3, parseWmaAsf,
} from "../lib/AudioParsers.mjs";
/**
* Extract Audio Metadata operation.
*/
class ExtractAudioMetadata extends Operation {
/** Creates the Extract Audio Metadata operation. */
constructor() {
super();
this.name = "Extract Audio Metadata";
this.module = "Default";
this.description =
"Extract common audio metadata across MP3 (ID3v2/ID3v1/GEOB), WAV/BWF/BW64 (INFO/bext/iXML/axml), FLAC (Vorbis Comment/Picture), OGG (Vorbis/OpusTags), AAC (ADTS), AC3 (Dolby Digital), WMA (ASF), plus best-effort MP4/M4A and AIFF scanning. Outputs normalized JSON.";
this.infoURL = "https://wikipedia.org/wiki/Audio_file_format";
this.inputType = "ArrayBuffer";
this.outputType = "JSON";
this.presentType = "html";
this.args = [
{ name: "Filename (optional)", type: "string", value: "" },
{ name: "Max embedded text bytes (iXML/axml/etc)", type: "number", value: 1024 * 512 },
];
}
/**
* @param {ArrayBuffer} input
* @param {Object[]} args
* @returns {Object}
*/
run(input, args) {
const filename = (args?.[0] || "").trim() || null;
const maxTextBytes = Number.isFinite(args?.[1]) ? Math.max(1024, args[1]) : 1024 * 512;
if (!(input instanceof ArrayBuffer) || input.byteLength === 0)
throw new OperationError("No input data. Load an audio file (drag/drop or use the open file button).");
const bytes = new Uint8Array(input);
const container = sniffContainer(bytes);
const report = makeEmptyReport(filename, bytes.length, container);
try {
const parsers = {
mp3: () => parseMp3(bytes, report),
wav: () => parseRiffWave(bytes, report, maxTextBytes),
bw64: () => parseRiffWave(bytes, report, maxTextBytes),
flac: () => parseFlac(bytes, report, maxTextBytes),
ogg: () => parseOgg(bytes, report),
opus: () => parseOgg(bytes, report),
mp4: () => parseMp4BestEffort(bytes, report),
m4a: () => parseMp4BestEffort(bytes, report),
aiff: () => parseAiffBestEffort(bytes, report, maxTextBytes),
aac: () => parseAacAdts(bytes, report),
ac3: () => parseAc3(bytes, report),
wma: () => parseWmaAsf(bytes, report),
};
if (parsers[container.type]) {
parsers[container.type]();
} else {
report.errors.push({ stage: "sniff", message: "Unknown/unsupported container (best-effort scan not implemented)." });
}
} catch (e) {
report.errors.push({ stage: "parse", message: String(e?.message || e) });
}
return report;
}
/** Renders the extracted metadata as an HTML table. */
present(data) {
if (!data || typeof data !== "object") return JSON.stringify(data, null, 4);
const esc = Utils.escapeHtml;
const row = (k, v) => `<tr><td>${esc(String(k))}</td><td>${esc(String(v ?? ""))}</td></tr>\n`;
const section = (title) => `<tr><th colspan="2" style="background:#e9ecef;text-align:center">${esc(title)}</th></tr>\n`;
const objRows = (obj, filter = (v) => v !== null) => {
for (const [k, v] of Object.entries(obj)) {
if (filter(v)) html += row(k, v);
}
};
const objSection = (obj, title, filter) => {
if (!obj) return;
html += section(title);
objRows(obj, filter);
};
const listSection = (arr, title, fmt) => {
if (!arr?.length) return;
html += section(title);
for (const item of arr) html += fmt(item);
};
let html = `<table class="table table-hover table-sm table-bordered table-nonfluid">\n`;
html += section("Artifact");
html += row("Filename", data.artifact?.filename || "(none)");
html += row("Size", `${(data.artifact?.byte_length ?? 0).toLocaleString()} bytes`);
html += row("Container", data.artifact?.container?.type);
html += row("MIME", data.artifact?.container?.mime);
if (data.artifact?.container?.brand) html += row("Brand", data.artifact.container.brand);
html += section("Detections");
html += row("Metadata systems", (data.detections?.metadata_systems || []).join(", ") || "None");
html += row("Provenance systems", (data.detections?.provenance_systems || []).join(", ") || "None");
const common = data.tags?.common || {};
html += section("Common Tags");
if (Object.values(common).some((v) => v !== null)) {
for (const [key, val] of Object.entries(common)) {
if (val !== null) html += row(key.charAt(0).toUpperCase() + key.slice(1), val);
}
} else {
html += row("(none)", "No common tags found");
}
listSection(data.tags?.raw?.id3v2?.frames, "ID3v2 Frames", (f) => {
const val = typeof f.decoded === "object" ? JSON.stringify(f.decoded) : (f.decoded ?? `(${f.size} bytes)`);
return row(f.id + (f.description ? ` \u2014 ${f.description}` : ""), val);
});
objSection(data.tags?.raw?.id3v1, "ID3v1", (v) => !!v);
listSection(data.tags?.raw?.apev2?.items, "APEv2 Tags", (i) => row(i.key, i.value));
if (data.tags?.raw?.vorbis_comments?.comments?.length) {
html += section("Vorbis Comments");
html += row("Vendor", data.tags.raw.vorbis_comments.vendor);
for (const c of data.tags.raw.vorbis_comments.comments) html += row(c.key, c.value);
}
objSection(data.tags?.raw?.riff?.info, "RIFF INFO", () => true);
objSection(data.tags?.raw?.riff?.bext, "BWF bext");
listSection(data.tags?.raw?.riff?.chunks, "RIFF Chunks", (c) => row(c.id, `${c.size} bytes @ offset ${c.offset}`));
listSection(data.tags?.raw?.flac?.blocks, "FLAC Metadata Blocks", (b) => row(b.type, `${b.length} bytes`));
if (data.tags?.raw?.mp4?.top_level_atoms?.length) {
html += section("MP4 Top-Level Atoms");
const atoms = data.tags.raw.mp4.top_level_atoms;
for (const a of atoms.slice(0, 50)) html += row(a.type, `${a.size} bytes @ offset ${a.offset}`);
if (atoms.length > 50) html += row("...", `${atoms.length - 50} more atoms`);
}
listSection(data.tags?.raw?.aiff?.chunks, "AIFF Chunks", (c) => row(c.id, c.value));
objSection(data.tags?.raw?.aac, "AAC ADTS");
objSection(data.tags?.raw?.ac3, "AC3 (Dolby Digital)");
objSection(data.tags?.raw?.asf?.content_description, "ASF Content Description", (v) => !!v);
listSection(data.tags?.raw?.asf?.extended_content, "ASF Extended Content", (d) => row(d.name, d.value));
listSection(data.embedded, "Embedded Objects", (e) => row(e.id, `${e.content_type || "unknown"} \u2014 ${(e.byte_length ?? 0).toLocaleString()} bytes`));
if (data.provenance?.c2pa?.present) {
html += section("C2PA Provenance");
html += row("Present", "Yes");
for (const emb of (data.provenance.c2pa.embedding || []))
html += row("Carrier", `${emb.carrier} \u2014 ${(emb.byte_length ?? 0).toLocaleString()} bytes`);
}
listSection(data.errors, "Errors", (e) => row(e.stage, e.message));
html += "</table>";
return html;
}
}
export default ExtractAudioMetadata;

5
src/core/operations/ExtractEmailAddresses.mjs
View File

@ -5,7 +5,7 @@
*/
import Operation from "../Operation.mjs";
import { search } from "../lib/Extract.mjs";
import { EMAIL_REGEX, search } from "../lib/Extract.mjs";
import { caseInsensitiveSort } from "../lib/Sort.mjs";
/**
@ -50,8 +50,7 @@ class ExtractEmailAddresses extends Operation {
*/
run(input, args) {
const [displayTotal, sort, unique] = args,
// email regex from: https://www.regextester.com/98066
regex = /(?:[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9](?:[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9-]*[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9])?\.)+[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9](?:[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9-]*[\u00A0-\uD7FF\uE000-\uFFFFa-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\])/ig;
regex = EMAIL_REGEX;
const results = search(
input,

28
src/core/operations/ExtractLSB.mjs
View File

@ -9,13 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import Utils from "../Utils.mjs";
import { fromBinary } from "../lib/Binary.mjs";
import { isImage } from "../lib/FileType.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp } from "jimp";
/**
* Extract LSB operation
*/
class ExtractLSB extends Operation {
/**
* ExtractLSB constructor
*/
@ -24,8 +23,10 @@ class ExtractLSB extends Operation {
this.name = "Extract LSB";
this.module = "Image";
this.description = "Extracts the Least Significant Bit data from each pixel in an image. This is a common way to hide data in Steganography.";
this.infoURL = "https://wikipedia.org/wiki/Bit_numbering#Least_significant_bit_in_digital_steganography";
this.description =
"Extracts the Least Significant Bit data from each pixel in an image. This is a common way to hide data in Steganography.";
this.infoURL =
"https://wikipedia.org/wiki/Bit_numbering#Least_significant_bit_in_digital_steganography";
this.inputType = "ArrayBuffer";
this.outputType = "byteArray";
this.args = [
@ -57,8 +58,8 @@ class ExtractLSB extends Operation {
{
name: "Bit",
type: "number",
value: 0
}
value: 0,
},
];
}
@ -68,21 +69,27 @@ class ExtractLSB extends Operation {
* @returns {byteArray}
*/
async run(input, args) {
if (!isImage(input)) throw new OperationError("Please enter a valid image file.");
if (!isImage(input))
throw new OperationError("Please enter a valid image file.");
const bit = 7 - args.pop(),
pixelOrder = args.pop(),
colours = args.filter(option => option !== "").map(option => COLOUR_OPTIONS.indexOf(option)),
colours = args
.filter((option) => option !== "")
.map((option) => COLOUR_OPTIONS.indexOf(option)),
parsedImage = await Jimp.read(input),
width = parsedImage.bitmap.width,
height = parsedImage.bitmap.height,
rgba = parsedImage.bitmap.data;
if (bit < 0 || bit > 7) {
throw new OperationError("Error: Bit argument must be between 0 and 7");
throw new OperationError(
"Error: Bit argument must be between 0 and 7",
);
}
let i, combinedBinary = "";
let i,
combinedBinary = "";
if (pixelOrder === "Row") {
for (i = 0; i < rgba.length; i += 4) {
@ -106,7 +113,6 @@ class ExtractLSB extends Operation {
return fromBinary(combinedBinary);
}
}
const COLOUR_OPTIONS = ["R", "G", "B", "A"];

22
src/core/operations/ExtractRGBA.mjs
View File

@ -7,15 +7,14 @@
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp } from "jimp";
import {RGBA_DELIM_OPTIONS} from "../lib/Delim.mjs";
import { RGBA_DELIM_OPTIONS } from "../lib/Delim.mjs";
/**
* Extract RGBA operation
*/
class ExtractRGBA extends Operation {
/**
* ExtractRGBA constructor
*/
@ -24,7 +23,8 @@ class ExtractRGBA extends Operation {
this.name = "Extract RGBA";
this.module = "Image";
this.description = "Extracts each pixel's RGBA value in an image. These are sometimes used in Steganography to hide text or data.";
this.description =
"Extracts each pixel's RGBA value in an image. These are sometimes used in Steganography to hide text or data.";
this.infoURL = "https://wikipedia.org/wiki/RGBA_color_space";
this.inputType = "ArrayBuffer";
this.outputType = "string";
@ -32,13 +32,13 @@ class ExtractRGBA extends Operation {
{
name: "Delimiter",
type: "editableOption",
value: RGBA_DELIM_OPTIONS
value: RGBA_DELIM_OPTIONS,
},
{
name: "Include Alpha",
type: "boolean",
value: true
}
value: true,
},
];
}
@ -48,18 +48,20 @@ class ExtractRGBA extends Operation {
* @returns {string}
*/
async run(input, args) {
if (!isImage(input)) throw new OperationError("Please enter a valid image file.");
if (!isImage(input))
throw new OperationError("Please enter a valid image file.");
const delimiter = args[0],
includeAlpha = args[1],
parsedImage = await Jimp.read(input);
let bitmap = parsedImage.bitmap.data;
bitmap = includeAlpha ? bitmap : bitmap.filter((val, idx) => idx % 4 !== 3);
bitmap = includeAlpha ?
bitmap :
bitmap.filter((val, idx) => idx % 4 !== 3);
return bitmap.join(delimiter);
}
}
export default ExtractRGBA;

80
src/core/operations/FlaskSessionDecode.mjs Normal file
View File

@ -0,0 +1,80 @@
/**
* @author ThePlayer372-FR []
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import { fromBase64 } from "../lib/Base64.mjs";
/**
* Flask Session Decode operation
*/
class FlaskSessionDecode extends Operation {
/**
* FlaskSessionDecode constructor
*/
constructor() {
super();
this.name = "Flask Session Decode";
this.module = "Crypto";
this.description = "Decodes the payload of a Flask session cookie (itsdangerous) into JSON.";
this.inputType = "string";
this.outputType = "JSON";
this.args = [
{
name: "View TimeStamp",
type: "boolean",
value: false
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {Object[]}
*/
run(input, args) {
input = input.trim();
const parts = input.split(".");
if (parts.length !== 3) {
throw new OperationError("Invalid Flask token format. Expected payload.timestamp.signature");
}
const payloadB64 = parts[0];
const time = parts[1];
const timeB64 = time.replace(/-/g, "+").replace(/_/g, "/");
const binary = fromBase64(timeB64);
const bytes = new Uint8Array(4);
for (let i = 0; i < 4; i++) {
bytes[i] = binary.charCodeAt(i);
}
const view = new DataView(bytes.buffer);
const timestamp = view.getInt32(0, false);
const base64 = payloadB64.replace(/-/g, "+").replace(/_/g, "/");
const padded = base64.padEnd(Math.ceil(base64.length / 4) * 4, "=");
let payloadJson;
try {
payloadJson = fromBase64(padded);
} catch (e) {
throw new OperationError("Invalid Base64 payload");
}
try {
let data = JSON.parse(payloadJson);
if (args[0]) {
data = {payload: data, timestamp: timestamp};
}
return data;
} catch (e) {
throw new OperationError("Unable to decode JSON payload: " + e.message);
}
}
}
export default FlaskSessionDecode;

89
src/core/operations/FlaskSessionSign.mjs Normal file
View File

@ -0,0 +1,89 @@
/**
* @author ThePlayer372-FR []
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import CryptoApi from "crypto-api/src/crypto-api.mjs";
import Utils from "../Utils.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import OperationError from "../errors/OperationError.mjs";
/**
* Flask Session Sign operation
*/
class FlaskSessionSign extends Operation {
/**
* FlaskSessionSign constructor
*/
constructor() {
super();
this.name = "Flask Session Sign";
this.module = "Crypto";
this.description = "Signs a JSON payload to produce a Flask session cookie (itsdangerous HMAC).";
this.inputType = "JSON";
this.outputType = "string";
this.args = [
{
name: "Key",
type: "toggleString",
value: "",
toggleValues: ["Hex", "Decimal", "Binary", "Base64", "UTF8", "Latin1"]
},
{
name: "Salt",
type: "toggleString",
value: "cookie-session",
toggleValues: ["UTF8", "Hex", "Decimal", "Binary", "Base64", "Latin1"]
},
{
name: "Algorithm",
type: "option",
value: ["sha1", "sha256"],
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run(input, args) {
if (!args[0].string) {
throw new OperationError("Secret key required");
}
const key = Utils.convertToByteString(args[0].string, args[0].option);
const salt = Utils.convertToByteString(args[1].string || "cookie-session", args[1].option);
const algorithm = args[2] || "sha1";
const payloadB64 = toBase64(Utils.strToByteArray(JSON.stringify(input)));
const payload = payloadB64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "");
const derivedKey = CryptoApi.getHmac(key, CryptoApi.getHasher(algorithm));
derivedKey.update(salt);
const currentTimeStamp = Math.ceil(Date.now() / 1000);
const buffer = new ArrayBuffer(4);
const view = new DataView(buffer);
view.setInt32(0, currentTimeStamp, false);
const bytes = new Uint8Array(buffer);
let binary = "";
bytes.forEach(b => binary += String.fromCharCode(b));
const timeB64 = toBase64(Utils.strToByteArray(binary));
const time = timeB64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "");
const data = Utils.convertToByteString(payload + "." + time, "utf8");
const sign = CryptoApi.getHmac(derivedKey.finalize(), CryptoApi.getHasher(algorithm));
sign.update(data);
const signB64 = toBase64(sign.finalize());
const sign64 = signB64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "");
return payload + "." + time + "." + sign64;
}
}
export default FlaskSessionSign;

136
src/core/operations/FlaskSessionVerify.mjs Normal file
View File

@ -0,0 +1,136 @@
/**
* @author ThePlayer372-FR []
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import CryptoApi from "crypto-api/src/crypto-api.mjs";
import Utils from "../Utils.mjs";
import { toBase64, fromBase64 } from "../lib/Base64.mjs";
/**
* Flask Session Verify operation
*/
class FlaskSessionVerify extends Operation {
/**
* FlaskSessionVerify constructor
*/
constructor() {
super();
this.name = "Flask Session Verify";
this.module = "Crypto";
this.description = "Verifies the HMAC signature of a Flask session cookie (itsdangerous) generated.";
this.inputType = "string";
this.outputType = "JSON";
this.args = [
{
name: "Key",
type: "toggleString",
value: "",
toggleValues: ["Hex", "Decimal", "Binary", "Base64", "UTF8", "Latin1"]
},
{
name: "Salt",
type: "toggleString",
value: "cookie-session",
toggleValues: ["UTF8", "Hex", "Decimal", "Binary", "Base64", "Latin1"]
},
{
name: "Algorithm",
type: "option",
value: ["sha1", "sha256"],
},
{
name: "View TimeStamp",
type: "boolean",
value: true
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run(input, args) {
if (!args[0].string) {
throw new OperationError("Secret key required");
}
const key = Utils.convertToByteString(args[0].string, args[0].option);
const salt = Utils.convertToByteString(args[1].string || "cookie-session", args[1].option);
const algorithm = args[2] || "sha1";
input = input.trim();
const parts = input.split(".");
if (parts.length !== 3) {
throw new OperationError("Invalid Flask token format. Expected payload.timestamp.signature");
}
const data = Utils.convertToByteString(parts[0] + "." + parts[1], "utf8");
const derivedKey = CryptoApi.getHmac(key, CryptoApi.getHasher(algorithm));
derivedKey.update(salt);
const sign = CryptoApi.getHmac(derivedKey.finalize(), CryptoApi.getHasher(algorithm));
sign.update(data);
const payloadB64 = parts[0];
const base64 = payloadB64.replace(/-/g, "+").replace(/_/g, "/");
const padded = base64.padEnd(Math.ceil(base64.length / 4) * 4, "=");
const time = parts[1];
const timeB64 = time.replace(/-/g, "+").replace(/_/g, "/");
const binary = fromBase64(timeB64);
const bytes = new Uint8Array(4);
for (let i = 0; i < 4; i++) {
bytes[i] = binary.charCodeAt(i);
}
const view = new DataView(bytes.buffer);
const timestamp = view.getInt32(0, false);
let payloadJson;
try {
payloadJson = fromBase64(padded);
} catch (e) {
throw new OperationError("Invalid Base64 payload");
}
const signB64 = toBase64(sign.finalize());
const sign64 = signB64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "");
if (sign64 !== parts[2]) {
throw new OperationError("Invalid signature!");
}
try {
const decoded = JSON.parse(payloadJson);
if (!args[3]) {
return {
valid: true,
payload: decoded,
};
} else {
return {
valid: true,
payload: decoded,
timestamp: timestamp
};
}
} catch (e) {
throw new OperationError("Unable to decode JSON payload: " + e.message);
}
}
}
export default FlaskSessionVerify;

24
src/core/operations/FlipImage.mjs
View File

@ -9,13 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Flip Image operation
*/
class FlipImage extends Operation {
/**
* FlipImage constructor
*/
@ -33,8 +32,8 @@ class FlipImage extends Operation {
{
name: "Axis",
type: "option",
value: ["Horizontal", "Vertical"]
}
value: ["Horizontal", "Vertical"],
},
];
}
@ -60,18 +59,24 @@ class FlipImage extends Operation {
self.sendStatusMessage("Flipping image...");
switch (flipAxis) {
case "Horizontal":
image.flip(true, false);
image.flip({
horizontal: true,
vertical: false,
});
break;
case "Vertical":
image.flip(false, true);
image.flip({
horizontal: false,
vertical: true,
});
break;
}
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
@ -95,7 +100,6 @@ class FlipImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default FlipImage;

2
src/core/operations/FromPunycode.mjs
View File

@ -5,7 +5,7 @@
*/
import Operation from "../Operation.mjs";
import punycode from "punycode";
import punycode from "punycode.js";
/**
* From Punycode operation

2
src/core/operations/FromQuotedPrintable.mjs
View File

@ -23,7 +23,7 @@ class FromQuotedPrintable extends Operation {
this.name = "From Quoted Printable";
this.module = "Default";
this.description = "Converts QP-encoded text back to standard text.<br><br>e.g. The quoted-printable encoded string <code>hello=20world</code> becomes <code>hello world</code>";
this.description = "Converts QP-encoded text back to standard text. This format is a content transfer encoding common in email messages.<br><br>e.g. The quoted-printable encoded string <code>hello=20world</code> becomes <code>hello world</code>";
this.infoURL = "https://wikipedia.org/wiki/Quoted-printable";
this.inputType = "string";
this.outputType = "byteArray";

8
src/core/operations/GenerateDeBruijnSequence.mjs
View File

@ -50,6 +50,14 @@ class GenerateDeBruijnSequence extends Operation {
throw new OperationError("Invalid alphabet size, required to be between 2 and 9 (inclusive).");
}
if (!Number.isInteger(k)) {
throw new OperationError("Invalid alphabet size, required to be integer.");
}
if (!Number.isInteger(n)) {
throw new OperationError("Invalid key length, required to be integer.");
}
if (n < 2) {
throw new OperationError("Invalid key length, required to be at least 2.");
}

71
src/core/operations/GenerateImage.mjs
View File

@ -7,16 +7,15 @@
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import Utils from "../Utils.mjs";
import {isImage} from "../lib/FileType.mjs";
import {toBase64} from "../lib/Base64.mjs";
import {isWorkerEnvironment} from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import { Jimp, JimpMime, ResizeStrategy, rgbaToInt } from "jimp";
/**
* Generate Image operation
*/
class GenerateImage extends Operation {
/**
* GenerateImage constructor
*/
@ -25,27 +24,28 @@ class GenerateImage extends Operation {
this.name = "Generate Image";
this.module = "Image";
this.description = "Generates an image using the input as pixel values.";
this.description =
"Generates an image using the input as pixel values.";
this.infoURL = "";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
this.presentType = "html";
this.args = [
{
"name": "Mode",
"type": "option",
"value": ["Greyscale", "RG", "RGB", "RGBA", "Bits"]
name: "Mode",
type: "option",
value: ["Greyscale", "RG", "RGB", "RGBA", "Bits"],
},
{
"name": "Pixel Scale Factor",
"type": "number",
"value": 8,
name: "Pixel Scale Factor",
type: "number",
value: 8,
},
{
"name": "Pixels per row",
"type": "number",
"value": 64,
}
name: "Pixels per row",
type: "number",
value: 64,
},
];
}
@ -67,21 +67,23 @@ class GenerateImage extends Operation {
}
const bytePerPixelMap = {
"Greyscale": 1,
"RG": 2,
"RGB": 3,
"RGBA": 4,
"Bits": 1/8,
Greyscale: 1,
RG: 2,
RGB: 3,
RGBA: 4,
Bits: 1 / 8,
};
const bytesPerPixel = bytePerPixelMap[mode];
if (bytesPerPixel > 0 && input.length % bytesPerPixel !== 0) {
throw new OperationError(`Number of bytes is not a divisor of ${bytesPerPixel}`);
if (bytesPerPixel > 0 && input.length % bytesPerPixel !== 0) {
throw new OperationError(
`Number of bytes is not a divisor of ${bytesPerPixel}`,
);
}
const height = Math.ceil(input.length / bytesPerPixel / width);
const image = await new Jimp(width, height, (err, image) => {});
const image = new Jimp({ width, height });
if (isWorkerEnvironment())
self.sendStatusMessage("Generating image from data...");
@ -94,8 +96,8 @@ class GenerateImage extends Operation {
const x = index % width;
const y = Math.floor(index / width);
const value = curByte[k] === "0" ? 0xFF : 0x00;
const pixel = Jimp.rgbaToInt(value, value, value, 0xFF);
const value = curByte[k] === "0" ? 0xff : 0x00;
const pixel = rgbaToInt(value, value, value, 0xff);
image.setPixelColor(pixel, x, y);
}
}
@ -109,7 +111,7 @@ class GenerateImage extends Operation {
let red = 0x00;
let green = 0x00;
let blue = 0x00;
let alpha = 0xFF;
let alpha = 0xff;
switch (mode) {
case "Greyscale":
@ -139,10 +141,12 @@ class GenerateImage extends Operation {
}
try {
const pixel = Jimp.rgbaToInt(red, green, blue, alpha);
const pixel = rgbaToInt(red, green, blue, alpha);
image.setPixelColor(pixel, x, y);
} catch (err) {
throw new OperationError(`Error while generating image from pixel values. (${err})`);
throw new OperationError(
`Error while generating image from pixel values. (${err})`,
);
}
}
}
@ -151,11 +155,15 @@ class GenerateImage extends Operation {
if (isWorkerEnvironment())
self.sendStatusMessage("Scaling image...");
image.scaleToFit(width*scale, height*scale, Jimp.RESIZE_NEAREST_NEIGHBOR);
image.scaleToFit({
w: width * scale,
h: height * scale,
mode: ResizeStrategy.NEAREST_NEIGHBOR,
});
}
try {
const imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
const imageBuffer = await image.getBuffer(JimpMime.png);
return imageBuffer.buffer;
} catch (err) {
throw new OperationError(`Error generating image. (${err})`);
@ -178,7 +186,6 @@ class GenerateImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default GenerateImage;

37
src/core/operations/GenerateLoremIpsum.mjs
View File

@ -8,6 +8,10 @@ import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import { GenerateParagraphs, GenerateSentences, GenerateWords, GenerateBytes } from "../lib/LoremIpsum.mjs";
// arbitrary limits set to avoid DoS by requesting ridiculous amounts of data
const maxLoremWords = 100_000; // same limit also used for paragraphs/sentences
const maxLoremCharacters = 1_000_000;
/**
* Generate Lorem Ipsum operation
*/
@ -47,9 +51,7 @@ class GenerateLoremIpsum extends Operation {
*/
run(input, args) {
const [length, lengthType] = args;
if (length < 1) {
throw new OperationError("Length must be greater than 0");
}
checkLimits(lengthType, length);
switch (lengthType) {
case "Paragraphs":
return GenerateParagraphs(length);
@ -68,3 +70,32 @@ class GenerateLoremIpsum extends Operation {
}
export default GenerateLoremIpsum;
/**
* check combined validity of lengthType and length arguments
* @param {string} lengthType
* @param {number} length
* @throws {OperationError}
*/
function checkLimits(lengthType, length) {
if (length < 1) {
throw new OperationError("Length must be greater than 0");
}
switch (lengthType) {
case "Paragraphs":
case "Sentences":
case "Words":
if (length > maxLoremWords) {
throw new OperationError("Length must be less than " + maxLoremWords);
}
break;
case "Bytes":
if (length > maxLoremCharacters) {
throw new OperationError("Length must be less than " + maxLoremCharacters);
}
break;
default:
throw new OperationError("Invalid length type");
}
}

15
src/core/operations/GeneratePGPKeyPair.mjs
View File

@ -12,6 +12,7 @@ import { getSubkeySize, ASP } from "../lib/PGP.mjs";
import { cryptNotice } from "../lib/Crypt.mjs";
import * as es6promisify from "es6-promisify";
const promisify = es6promisify.default ? es6promisify.default.promisify : es6promisify.promisify;
const KEY_FLAGS = kbpgp.const.openpgp.key_flags;
/**
@ -73,11 +74,11 @@ class GeneratePGPKeyPair extends Operation {
if (name) userIdentifier += name;
if (email) userIdentifier += ` <${email}>`;
let flags = kbpgp.const.openpgp.certify_keys;
flags |= kbpgp.const.openpgp.sign_data;
flags |= kbpgp.const.openpgp.auth;
flags |= kbpgp.const.openpgp.encrypt_comm;
flags |= kbpgp.const.openpgp.encrypt_storage;
let flags = KEY_FLAGS.certify_keys;
flags |= KEY_FLAGS.sign_data;
flags |= KEY_FLAGS.auth;
flags |= KEY_FLAGS.encrypt_comm;
flags |= KEY_FLAGS.encrypt_storage;
const keyGenerationOptions = {
userid: userIdentifier,
@ -89,11 +90,11 @@ class GeneratePGPKeyPair extends Operation {
},
subkeys: [{
"nbits": getSubkeySize(keySize),
"flags": kbpgp.const.openpgp.sign_data,
"flags": KEY_FLAGS.sign_data,
"expire_in": 86400 * 365 * 8
}, {
"nbits": getSubkeySize(keySize),
"flags": kbpgp.const.openpgp.encrypt_comm | kbpgp.const.openpgp.encrypt_storage,
"flags": KEY_FLAGS.encrypt_comm | KEY_FLAGS.encrypt_storage,
"expire_in": 86400 * 365 * 2
}],
asp: ASP

20
src/core/operations/ImageBrightnessContrast.mjs
View File

@ -9,13 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Image Brightness / Contrast operation
*/
class ImageBrightnessContrast extends Operation {
/**
* ImageBrightnessContrast constructor
*/
@ -35,15 +34,15 @@ class ImageBrightnessContrast extends Operation {
type: "number",
value: 0,
min: -100,
max: 100
max: 100,
},
{
name: "Contrast",
type: "number",
value: 0,
min: -100,
max: 100
}
max: 100,
},
];
}
@ -77,14 +76,16 @@ class ImageBrightnessContrast extends Operation {
}
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
throw new OperationError(`Error adjusting image brightness or contrast. (${err})`);
throw new OperationError(
`Error adjusting image brightness or contrast. (${err})`,
);
}
}
@ -104,7 +105,6 @@ class ImageBrightnessContrast extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default ImageBrightnessContrast;

27
src/core/operations/ImageFilter.mjs
View File

@ -9,13 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Image Filter operation
*/
class ImageFilter extends Operation {
/**
* ImageFilter constructor
*/
@ -33,11 +32,8 @@ class ImageFilter extends Operation {
{
name: "Filter type",
type: "option",
value: [
"Greyscale",
"Sepia"
]
}
value: ["Greyscale", "Sepia"],
},
];
}
@ -60,7 +56,11 @@ class ImageFilter extends Operation {
}
try {
if (isWorkerEnvironment())
self.sendStatusMessage("Applying " + filterType.toLowerCase() + " filter to image...");
self.sendStatusMessage(
"Applying " +
filterType.toLowerCase() +
" filter to image...",
);
if (filterType === "Greyscale") {
image.greyscale();
} else {
@ -68,14 +68,16 @@ class ImageFilter extends Operation {
}
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
throw new OperationError(`Error applying filter to image. (${err})`);
throw new OperationError(
`Error applying filter to image. (${err})`,
);
}
}
@ -95,7 +97,6 @@ class ImageFilter extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default ImageFilter;

42
src/core/operations/ImageHueSaturationLightness.mjs
View File

@ -9,13 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Image Hue/Saturation/Lightness operation
*/
class ImageHueSaturationLightness extends Operation {
/**
* ImageHueSaturationLightness constructor
*/
@ -24,7 +23,8 @@ class ImageHueSaturationLightness extends Operation {
this.name = "Image Hue/Saturation/Lightness";
this.module = "Image";
this.description = "Adjusts the hue / saturation / lightness (HSL) values of an image.";
this.description =
"Adjusts the hue / saturation / lightness (HSL) values of an image.";
this.infoURL = "";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
@ -35,22 +35,22 @@ class ImageHueSaturationLightness extends Operation {
type: "number",
value: 0,
min: -360,
max: 360
max: 360,
},
{
name: "Saturation",
type: "number",
value: 0,
min: -100,
max: 100
max: 100,
},
{
name: "Lightness",
type: "number",
value: 0,
min: -100,
max: 100
}
max: 100,
},
];
}
@ -76,43 +76,45 @@ class ImageHueSaturationLightness extends Operation {
if (hue !== 0) {
if (isWorkerEnvironment())
self.sendStatusMessage("Changing image hue...");
image.colour([
image.color([
{
apply: "hue",
params: [hue]
}
params: [hue],
},
]);
}
if (saturation !== 0) {
if (isWorkerEnvironment())
self.sendStatusMessage("Changing image saturation...");
image.colour([
image.color([
{
apply: "saturate",
params: [saturation]
}
params: [saturation],
},
]);
}
if (lightness !== 0) {
if (isWorkerEnvironment())
self.sendStatusMessage("Changing image lightness...");
image.colour([
image.color([
{
apply: "lighten",
params: [lightness]
}
params: [lightness],
},
]);
}
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
throw new OperationError(`Error adjusting image hue / saturation / lightness. (${err})`);
throw new OperationError(
`Error adjusting image hue / saturation / lightness. (${err})`,
);
}
}

14
src/core/operations/ImageOpacity.mjs
View File

@ -9,13 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Image Opacity operation
*/
class ImageOpacity extends Operation {
/**
* ImageOpacity constructor
*/
@ -35,8 +34,8 @@ class ImageOpacity extends Operation {
type: "number",
value: 100,
min: 0,
max: 100
}
max: 100,
},
];
}
@ -63,10 +62,10 @@ class ImageOpacity extends Operation {
image.opacity(opacity / 100);
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
@ -90,7 +89,6 @@ class ImageOpacity extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default ImageOpacity;

10
src/core/operations/InvertImage.mjs
View File

@ -9,13 +9,12 @@ import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import { isWorkerEnvironment } from "../Utils.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Invert Image operation
*/
class InvertImage extends Operation {
/**
* InvertImage constructor
*/
@ -54,10 +53,10 @@ class InvertImage extends Operation {
image.invert();
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
@ -81,7 +80,6 @@ class InvertImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default InvertImage;

16
src/core/operations/Jq.mjs
View File

@ -30,7 +30,12 @@ class Jq extends Operation {
name: "Query",
type: "string",
value: ""
}
},
{
name: "Raw",
type: "boolean",
value: false
},
];
}
@ -40,7 +45,7 @@ class Jq extends Operation {
* @returns {string}
*/
run(input, args) {
const [query] = args;
const [query, raw] = args;
let result;
try {
@ -48,8 +53,11 @@ class Jq extends Operation {
} catch (err) {
throw new OperationError(`Invalid jq expression: ${err.message}`);
}
return JSON.stringify(result);
if (raw && typeof result === "string") {
return result;
} else {
return JSON.stringify(result);
}
}
}

12
src/core/operations/NormaliseImage.mjs
View File

@ -8,13 +8,12 @@ import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import { isImage } from "../lib/FileType.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp, JimpMime } from "jimp";
/**
* Normalise Image operation
*/
class NormaliseImage extends Operation {
/**
* NormaliseImage constructor
*/
@ -27,7 +26,7 @@ class NormaliseImage extends Operation {
this.infoURL = "";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
this.presentType= "html";
this.presentType = "html";
this.args = [];
}
@ -52,10 +51,10 @@ class NormaliseImage extends Operation {
image.normalize();
let imageBuffer;
if (image.getMIME() === "image/gif") {
imageBuffer = await image.getBufferAsync(Jimp.MIME_PNG);
if (image.mime === "image/gif") {
imageBuffer = await image.getBuffer(JimpMime.png);
} else {
imageBuffer = await image.getBufferAsync(Jimp.AUTO);
imageBuffer = await image.getBuffer(image.mime);
}
return imageBuffer.buffer;
} catch (err) {
@ -79,7 +78,6 @@ class NormaliseImage extends Operation {
return `<img src="data:${type};base64,${toBase64(dataArray)}">`;
}
}
export default NormaliseImage;

2
src/core/operations/OffsetChecker.mjs
View File

@ -99,7 +99,7 @@ class OffsetChecker extends Operation {
}
}
return outputs.join(sampleDelim);
return outputs.join(Utils.escapeHtml(sampleDelim));
}
}

83
src/core/operations/PGPSign.mjs Normal file
View File

@ -0,0 +1,83 @@
/**
* @author GCHQDeveloper581
* @copyright Crown Copyright 2026
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import kbpgp from "kbpgp";
import { ASP, importPrivateKey } from "../lib/PGP.mjs";
import OperationError from "../errors/OperationError.mjs";
import * as es6promisify from "es6-promisify";
const promisify = es6promisify.default ? es6promisify.default.promisify : es6promisify.promisify;
/**
* PGP Sign operation
*/
class PGPSign extends Operation {
/**
* PGPSign constructor
*/
constructor() {
super();
this.name = "PGP Sign";
this.module = "PGP";
this.description = [
"Input: the message you want to sign",
"<br><br>",
"Arguments: the ASCII-armoured PGP private key of the sender.",
"<br><br>",
"Pretty Good Privacy is an encryption standard (OpenPGP) used for encrypting, decrypting, and signing messages.",
"<br><br>",
"This function uses the Keybase implementation of PGP.",
].join("\n");
this.infoURL = "https://wikipedia.org/wiki/Pretty_Good_Privacy"; // Usually a Wikipedia link. Remember to remove localisation (i.e. https://wikipedia.org/etc rather than https://en.wikipedia.org/etc)
this.inputType = "string";
this.outputType = "string";
this.args = [
{
"name": "Private key of signer",
"type": "text",
"value": ""
},
{
"name": "Private key passphrase (optional)",
"type": "string",
"value": ""
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*
* @throws {OperationError} if failed private key import or failed encryption
*/
async run(input, args) {
const message = input,
[privateKey, passphrase] = args;
let signedMessage;
if (!privateKey) throw new OperationError("Enter the private key of the signer.");
const privKey = await importPrivateKey(privateKey, passphrase);
try {
signedMessage = await promisify(kbpgp.box)({
"msg": message,
"sign_with": privKey,
"asp": ASP
});
} catch (err) {
throw new OperationError(`Couldn't sign message: ${err}`);
}
return signedMessage;
}
}
export default PGPSign;

128
src/core/operations/ParityBit.mjs Normal file
View File

@ -0,0 +1,128 @@
/**
* @author j83305 [awz22@protonmail.com]
* @copyright Crown Copyright 2020
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import { calculateParityBit, decodeParityBit } from "../lib/ParityBit.mjs";
/**
* Parity Bit operation
*/
class ParityBit extends Operation {
/**
* ParityBit constructor
*/
constructor() {
super();
this.name = "Parity Bit";
this.module = "Default";
this.description = "A parity bit, or check bit, is the simplest form of error detection. It is a bit which is added to a string of bits and represents if the number of 1's in the binary string is an even number or odd number.<br><br>If a delimiter is specified, the parity bit calculation will be performed on each 'block' of the input data, where the blocks are created by slicing the input at each occurrence of the delimiter character";
this.infoURL = "https://wikipedia.org/wiki/Parity_bit";
this.inputType = "string";
this.outputType = "string";
this.args = [
{
name: "Mode",
type: "option",
value: [
"Even Parity",
"Odd Parity"
]
},
{
name: "Postion",
type: "option",
value: [
"Start",
"End"
]
},
{
name: "Encode or Decode",
type: "option",
value: [
"Encode",
"Decode"
]
},
{
name: "Delimiter",
type: "shortString",
value: ""
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run(input, args) {
if (input.length === 0) {
return input;
}
/**
* determines weather to use the encode or decode method based off args[2]
* @param input input to be encoded or decoded
* @param args array
*/
const method = (input, args) => args[2] === "Encode" ? calculateParityBit(input, args) : decodeParityBit(input, args);
if (args[3].length > 0) {
const byteStrings = input.split(args[3]);
for (let byteStringsArrayIndex = 0; byteStringsArrayIndex < byteStrings.length; byteStringsArrayIndex++) {
byteStrings[byteStringsArrayIndex] = method(byteStrings[byteStringsArrayIndex], args);
}
return byteStrings.join(args[3]);
}
return method(input, args);
}
/**
* Highlight Parity Bit
*
* @param {Object[]} pos
* @param {number} pos[].start
* @param {number} pos[].end
* @param {Object[]} args
* @returns {Object[]} pos
*/
highlight(pos, args) {
if (args[3].length === 0) {
if (args[1] === "Prepend") {
pos[0].start += 1;
pos[0].end += 1;
}
return pos;
}
// need to be able to read input to do the highlighting when there is a delimiter
}
/**
* Highlight Parity Bit in reverse
*
* @param {Object[]} pos
* @param {number} pos[].start
* @param {number} pos[].end
* @param {Object[]} args
* @returns {Object[]} pos
*/
highlightReverse(pos, args) {
if (args[3].length === 0) {
if (args[1] === "Prepend") {
if (pos[0].start > 0) {
pos[0].start -= 1;
}
pos[0].end -= 1;
}
return pos;
}
}
}
export default ParityBit;

112
src/core/operations/ParseEthernetFrame.mjs Normal file
View File

@ -0,0 +1,112 @@
/**
* @author tedk [tedk@ted.do]
* @copyright Crown Copyright 2024
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import Utils from "../Utils.mjs";
import {fromHex, toHex} from "../lib/Hex.mjs";
/**
* Parse Ethernet frame operation
*/
class ParseEthernetFrame extends Operation {
/**
* ParseEthernetFrame constructor
*/
constructor() {
super();
this.name = "Parse Ethernet frame";
this.module = "Default";
this.description = "Parses an Ethernet frame and either shows the deduced values (Source and destination MAC, VLANs) or returns the packet data.<br /><br />Good for use in conjunction with the Parse IPv4, and Parse TCP/UDP recipes.";
this.infoURL = "https://en.wikipedia.org/wiki/Ethernet_frame#Frame_%E2%80%93_data_link_layer";
this.inputType = "string";
this.outputType = "html";
this.args = [
{
name: "Input type",
type: "option",
value: [
"Raw", "Hex"
],
defaultIndex: 0,
},
{
name: "Return type",
type: "option",
value: [
"Text output", "Packet data", "Packet data (hex)",
],
defaultIndex: 0,
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {html}
*/
run(input, args) {
const format = args[0];
const outputFormat = args[1];
if (format === "Hex") {
input = fromHex(input);
} else if (format === "Raw") {
input = new Uint8Array(Utils.strToArrayBuffer(input));
} else {
throw new OperationError("Invalid input format selected.");
}
const destinationMac = input.slice(0, 6);
const sourceMac = input.slice(6, 12);
let offset = 12;
const vlans = [];
while (offset < input.length) {
const ethType = Utils.byteArrayToChars(input.slice(offset, offset+2));
offset += 2;
if (ethType === "\x81\x00" || ethType === "\x88\xA8") {
// Parse the VLAN tag:
// [0000] 0000 0000 0000
// ^^^ PRIO - Ignored
// ^ DEI - Ignored
// ^^^^ ^^^^ ^^^^ VLAN ID
const vlanTag = input.slice(offset, offset+2);
vlans.push(((vlanTag[0] & 0b00001111) << 8) | vlanTag[1]);
offset += 2;
} else {
break;
}
}
const packetData = input.slice(offset);
if (outputFormat === "Packet data") {
return Utils.escapeHtml(Utils.byteArrayToChars(packetData));
} else if (outputFormat === "Packet data (hex)") {
return toHex(packetData);
} else if (outputFormat === "Text output") {
let retval = `Source MAC: ${toHex(sourceMac, ":")}\nDestination MAC: ${toHex(destinationMac, ":")}\n`;
if (vlans.length > 0) {
retval += `VLAN: ${vlans.join(", ")}\n`;
}
retval += `Data:\n${toHex(packetData)}`;
return retval;
}
}
}
export default ParseEthernetFrame;

31
src/core/operations/ParseIPv4Header.mjs
View File

@ -33,6 +33,12 @@ class ParseIPv4Header extends Operation {
"name": "Input format",
"type": "option",
"value": ["Hex", "Raw"]
},
{
"name": "Output format",
"type": "option",
"value": ["Table", "Data (hex)", "Data (raw)"],
defaultIndex: 0,
}
];
}
@ -44,6 +50,8 @@ class ParseIPv4Header extends Operation {
*/
run(input, args) {
const format = args[0];
const outputFormat = args[1];
let output;
if (format === "Hex") {
@ -66,7 +74,7 @@ class ParseIPv4Header extends Operation {
checksum = input[10] << 8 | input[11],
srcIP = input[12] << 24 | input[13] << 16 | input[14] << 8 | input[15],
dstIP = input[16] << 24 | input[17] << 16 | input[18] << 8 | input[19],
checksumHeader = input.slice(0, 10).concat([0, 0]).concat(input.slice(12, 20));
checksumHeader = [...input.slice(0, 10), 0, 0, ...input.slice(12, 20)];
let version = (input[0] >>> 4) & 0x0f,
options = [];
@ -98,7 +106,10 @@ class ParseIPv4Header extends Operation {
checksumResult = givenChecksum + " (incorrect, should be " + correctChecksum + ")";
}
output = `<table class='table table-hover table-sm table-bordered table-nonfluid'><tr><th>Field</th><th>Value</th></tr>
const data = input.slice(ihl * 4);
if (outputFormat === "Table") {
output = `<table class='table table-hover table-sm table-bordered table-nonfluid'><tr><th>Field</th><th>Value</th></tr>
<tr><td>Version</td><td>${version}</td></tr>
<tr><td>Internet Header Length (IHL)</td><td>${ihl} (${ihl * 4} bytes)</td></tr>
<tr><td>Differentiated Services Code Point (DSCP)</td><td>${dscp}</td></tr>
@ -116,13 +127,19 @@ class ParseIPv4Header extends Operation {
<tr><td>Protocol</td><td>${protocol}, ${protocolInfo.protocol} (${protocolInfo.keyword})</td></tr>
<tr><td>Header checksum</td><td>${checksumResult}</td></tr>
<tr><td>Source IP address</td><td>${ipv4ToStr(srcIP)}</td></tr>
<tr><td>Destination IP address</td><td>${ipv4ToStr(dstIP)}</td></tr>`;
<tr><td>Destination IP address</td><td>${ipv4ToStr(dstIP)}</td></tr>
<tr><td>Data (hex)</td><td>${toHex(data)}</td></tr>`;
if (ihl > 5) {
output += `<tr><td>Options</td><td>${toHex(options)}</td></tr>`;
if (ihl > 5) {
output += `<tr><td>Options</td><td>${toHex(options)}</td></tr>`;
}
return output + "</table>";
} else if (outputFormat === "Data (hex)") {
return toHex(data);
} else if (outputFormat === "Data (raw)") {
return Utils.escapeHtml(Utils.byteArrayToChars(data));
}
return output + "</table>";
}
}

4
src/core/operations/ParseObjectIDTimestamp.mjs
View File

@ -6,7 +6,7 @@
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import BSON from "bson";
import { ObjectId } from "bson";
/**
* Parse ObjectID timestamp operation
@ -35,7 +35,7 @@ class ParseObjectIDTimestamp extends Operation {
*/
run(input, args) {
try {
const objectId = new BSON.ObjectID(input);
const objectId = new ObjectId(input);
return objectId.getTimestamp().toISOString();
} catch (err) {
throw new OperationError(err);

26
src/core/operations/ParseQRCode.mjs
View File

@ -13,7 +13,6 @@ import { parseQrCode } from "../lib/QRCode.mjs";
* Parse QR Code operation
*/
class ParseQRCode extends Operation {
/**
* ParseQRCode constructor
*/
@ -22,24 +21,26 @@ class ParseQRCode extends Operation {
this.name = "Parse QR Code";
this.module = "Image";
this.description = "Reads an image file and attempts to detect and read a Quick Response (QR) code from the image.<br><br><u>Normalise Image</u><br>Attempts to normalise the image before parsing it to improve detection of a QR code.";
this.description =
"Reads an image file and attempts to detect and read a Quick Response (QR) code from the image.<br><br><u>Normalise Image</u><br>Attempts to normalise the image before parsing it to improve detection of a QR code.";
this.infoURL = "https://wikipedia.org/wiki/QR_code";
this.inputType = "ArrayBuffer";
this.outputType = "string";
this.args = [
{
"name": "Normalise image",
"type": "boolean",
"value": false
}
name: "Normalise image",
type: "boolean",
value: false,
},
];
this.checks = [
{
"pattern": "^(?:\\xff\\xd8\\xff|\\x89\\x50\\x4e\\x47|\\x47\\x49\\x46|.{8}\\x57\\x45\\x42\\x50|\\x42\\x4d)",
"flags": "",
"args": [false],
"useful": true
}
pattern:
"^(?:\\xff\\xd8\\xff|\\x89\\x50\\x4e\\x47|\\x47\\x49\\x46|.{8}\\x57\\x45\\x42\\x50|\\x42\\x4d)",
flags: "",
args: [false],
useful: true,
},
];
}
@ -54,9 +55,8 @@ class ParseQRCode extends Operation {
if (!isImage(input)) {
throw new OperationError("Invalid file type.");
}
return await parseQrCode(input, normalise);
return parseQrCode(input, normalise);
}
}
export default ParseQRCode;

2
src/core/operations/ParseUserAgent.mjs
View File

@ -5,7 +5,7 @@
*/
import Operation from "../Operation.mjs";
import UAParser from "ua-parser-js";
import { UAParser } from "ua-parser-js";
/**
* Parse User Agent operation

164
src/core/operations/PseudoRandomIntegerGenerator.mjs Normal file
View File

@ -0,0 +1,164 @@
/**
* @author cktgh [chankaitung@gmail.com]
* @copyright Crown Copyright 2026
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import OperationError from "../errors/OperationError.mjs";
import forge from "node-forge";
import Utils, { isWorkerEnvironment } from "../Utils.mjs";
import { DELIM_OPTIONS } from "../lib/Delim.mjs";
/**
* Pseudo-Random Integer Generator operation
*/
class PseudoRandomIntegerGenerator extends Operation {
// in theory 2**53 is the max range, but we use Number.MAX_SAFE_INTEGER (2**53 - 1) as it is more consistent.
static MAX_RANGE = Number.MAX_SAFE_INTEGER;
// arbitrary choice
static BUFFER_SIZE = 1024;
/**
* PseudoRandomIntegerGenerator constructor
*/
constructor() {
super();
this.name = "Pseudo-Random Integer Generator";
this.module = "Ciphers";
this.description = "A cryptographically-secure pseudo-random number generator (PRNG).<br><br>Generates random integers within a specified range using the browser's built-in <code>crypto.getRandomValues()</code> method if available.<br><br>The supported range of integers is from <code>-(2^53 - 1)</code> to <code>(2^53 - 1)</code>.";
this.infoURL = "https://wikipedia.org/wiki/Pseudorandom_number_generator";
this.inputType = "string";
this.outputType = "string";
this.args = [
{
"name": "Number of Integers",
"type": "number",
"value": 1,
"min": 1
},
{
"name": "Min Value",
"type": "number",
"value": 0,
"min": Number.MIN_SAFE_INTEGER,
"max": Number.MAX_SAFE_INTEGER
},
{
"name": "Max Value",
"type": "number",
"value": 99,
"min": Number.MIN_SAFE_INTEGER,
"max": Number.MAX_SAFE_INTEGER
},
{
"name": "Delimiter",
"type": "option",
"value": DELIM_OPTIONS
},
{
"name": "Output",
"type": "option",
"value": ["Raw", "Hex", "Decimal"]
}
];
// not using BigUint64Array to avoid BigInt handling overhead
this.randomBuffer = new Uint32Array(PseudoRandomIntegerGenerator.BUFFER_SIZE);
this.randomBufferOffset = PseudoRandomIntegerGenerator.BUFFER_SIZE;
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run(input, args) {
const [numInts, minInt, maxInt, delimiter, outputType] = args;
if (minInt === null || maxInt === null) return "";
const min = Math.ceil(minInt);
const max = Math.floor(maxInt);
const delim = Utils.charRep(delimiter || "Space");
if (!Number.isSafeInteger(min) || !Number.isSafeInteger(max)) {
throw new OperationError("Min and Max must be between `-(2^53 - 1)` and `2^53 - 1`.");
}
if (min > max) {
throw new OperationError("Min cannot be larger than Max.");
}
const range = max - min + 1; // inclusive range
if (range > PseudoRandomIntegerGenerator.MAX_RANGE) {
throw new OperationError("Range between Min and Max cannot be larger than `2^53`");
}
// as large as possible while divisible by range
const rejectionThreshold = PseudoRandomIntegerGenerator.MAX_RANGE - (PseudoRandomIntegerGenerator.MAX_RANGE % range);
const output = [];
for (let i = 0; i < numInts; i++) {
const result = this._generateRandomValue(rejectionThreshold);
const intValue = min + (result % range);
switch (outputType) {
case "Hex":
output.push(intValue.toString(16));
break;
case "Decimal":
output.push(intValue.toString(10));
break;
case "Raw":
default:
output.push(Utils.chr(intValue));
}
}
if (outputType === "Raw") {
return output.join("");
}
return output.join(delim);
}
/**
* Generate a random value, result will be less than the rejection threshold (exclusive).
*
* @param {number} rejectionThreshold
* @returns {number}
*/
_generateRandomValue(rejectionThreshold) {
let result;
do {
if (this.randomBufferOffset + 2 > this.randomBuffer.length) {
this._resetRandomBuffer();
}
// stitching a 53 bit number; not using BigUint64Array to avoid BigInt handling overhead
result = (this.randomBuffer[this.randomBufferOffset++] & 0x1f_ffff) * 0x1_0000_0000 +
this.randomBuffer[this.randomBufferOffset++];
} while (result >= rejectionThreshold);
return result;
}
/**
* Fill random buffer with new random values and rseet the offset.
*/
_resetRandomBuffer() {
if (isWorkerEnvironment() && self.crypto) {
self.crypto.getRandomValues(this.randomBuffer);
} else {
const bytes = forge.random.getBytesSync(this.randomBuffer.length * 4);
for (let j = 0; j < this.randomBuffer.length; j++) {
this.randomBuffer[j] = (bytes.charCodeAt(j * 4) << 24) |
(bytes.charCodeAt(j * 4 + 1) << 16) |
(bytes.charCodeAt(j * 4 + 2) << 8) |
bytes.charCodeAt(j * 4 + 3);
}
}
this.randomBufferOffset = 0;
}
}
export default PseudoRandomIntegerGenerator;

119
src/core/operations/RC6Decrypt.mjs Normal file
View File

@ -0,0 +1,119 @@
/**
* @author Medjedtxm
* @copyright Crown Copyright 2026
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import Utils from "../Utils.mjs";
import OperationError from "../errors/OperationError.mjs";
import { toHex } from "../lib/Hex.mjs";
import { decryptRC6, getBlockSize, getDefaultRounds } from "../lib/RC6.mjs";
/**
* RC6 Decrypt operation
*/
class RC6Decrypt extends Operation {
/**
* RC6Decrypt constructor
*/
constructor() {
super();
this.name = "RC6 Decrypt";
this.module = "Ciphers";
this.description = "RC6 is a symmetric key block cipher derived from RC5. It was designed by Ron Rivest, Matt Robshaw, Ray Sidney, and Yiqun Lisa Yin to meet the requirements of the AES competition, and was one of the five finalists.<br><br>RC6 is parameterised as RC6-w/r/b where w is word size in bits (any multiple of 8 from 8-256), r is the number of rounds (1-255), and b is the key length in bytes. The standard AES submission uses w=32, r=20. Common word sizes: 8, 16, 32 (standard), 64, 128.<br><br><b>IV:</b> The Initialisation Vector should be 4*w/8 bytes (e.g. 16 bytes for w=32). If not entered, it will default to null bytes.<br><br><b>Padding:</b> In CBC and ECB mode, the PKCS#7 padding scheme is used.";
this.infoURL = "https://wikipedia.org/wiki/RC6";
this.inputType = "string";
this.outputType = "string";
this.args = [
{
"name": "Key",
"type": "toggleString",
"value": "",
"toggleValues": ["Hex", "UTF8", "Latin1", "Base64"]
},
{
"name": "IV",
"type": "toggleString",
"value": "",
"toggleValues": ["Hex", "UTF8", "Latin1", "Base64"]
},
{
"name": "Mode",
"type": "option",
"value": ["CBC", "CFB", "OFB", "CTR", "ECB"]
},
{
"name": "Input",
"type": "option",
"value": ["Hex", "Raw"]
},
{
"name": "Output",
"type": "option",
"value": ["Raw", "Hex"]
},
{
"name": "Padding",
"type": "option",
"value": ["PKCS5", "NO", "ZERO", "RANDOM", "BIT"]
},
{
"name": "Word Size",
"type": "number",
"value": 32,
"min": 8,
"max": 256,
"step": 8
},
{
"name": "Rounds",
"type": "number",
"value": 20,
"min": 1,
"max": 255
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run(input, args) {
const key = Utils.convertToByteArray(args[0].string, args[0].option),
iv = Utils.convertToByteArray(args[1].string, args[1].option),
[,, mode, inputType, outputType, padding, wordSize, rounds] = args;
// Validate word size
if (!Number.isInteger(wordSize) || wordSize < 8 || wordSize > 256 || wordSize % 8 !== 0)
throw new OperationError(`Invalid word size: ${wordSize}. Must be a multiple of 8 between 8 and 256.`);
const blockSize = getBlockSize(wordSize);
const defaultRounds = getDefaultRounds(wordSize);
if (iv.length !== blockSize && iv.length !== 0 && mode !== "ECB")
throw new OperationError(`Invalid IV length: ${iv.length} bytes
RC6-${wordSize} uses an IV length of ${blockSize} bytes (${blockSize * 8} bits).
Make sure you have specified the type correctly (e.g. Hex vs UTF8).`);
if (!Number.isInteger(rounds) || rounds < 1 || rounds > 255)
throw new OperationError(`Invalid number of rounds: ${rounds}
Rounds must be an integer between 1 and 255. Standard for w=${wordSize} is ${defaultRounds}.`);
// Default IV to null bytes if empty (like AES)
const actualIv = iv.length === 0 ? new Array(blockSize).fill(0) : iv;
input = Utils.convertToByteArray(input, inputType);
const output = decryptRC6(input, key, actualIv, mode, padding, rounds, wordSize);
return outputType === "Hex" ? toHex(output, "") : Utils.byteArrayToUtf8(output);
}
}
export default RC6Decrypt;

119
src/core/operations/RC6Encrypt.mjs Normal file
View File

@ -0,0 +1,119 @@
/**
* @author Medjedtxm
* @copyright Crown Copyright 2026
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
import Utils from "../Utils.mjs";
import OperationError from "../errors/OperationError.mjs";
import { toHex } from "../lib/Hex.mjs";
import { encryptRC6, getBlockSize, getDefaultRounds } from "../lib/RC6.mjs";
/**
* RC6 Encrypt operation
*/
class RC6Encrypt extends Operation {
/**
* RC6Encrypt constructor
*/
constructor() {
super();
this.name = "RC6 Encrypt";
this.module = "Ciphers";
this.description = "RC6 is a symmetric key block cipher derived from RC5. It was designed by Ron Rivest, Matt Robshaw, Ray Sidney, and Yiqun Lisa Yin to meet the requirements of the AES competition, and was one of the five finalists.<br><br>RC6 is parameterised as RC6-w/r/b where w is word size in bits (any multiple of 8 from 8-256), r is the number of rounds (1-255), and b is the key length in bytes. The standard AES submission uses w=32, r=20. Common word sizes: 8, 16, 32 (standard), 64, 128.<br><br><b>IV:</b> The Initialisation Vector should be 4*w/8 bytes (e.g. 16 bytes for w=32). If not entered, it will default to null bytes.<br><br><b>Padding:</b> In CBC and ECB mode, the PKCS#7 padding scheme is used.";
this.infoURL = "https://wikipedia.org/wiki/RC6";
this.inputType = "string";
this.outputType = "string";
this.args = [
{
"name": "Key",
"type": "toggleString",
"value": "",
"toggleValues": ["Hex", "UTF8", "Latin1", "Base64"]
},
{
"name": "IV",
"type": "toggleString",
"value": "",
"toggleValues": ["Hex", "UTF8", "Latin1", "Base64"]
},
{
"name": "Mode",
"type": "option",
"value": ["CBC", "CFB", "OFB", "CTR", "ECB"]
},
{
"name": "Input",
"type": "option",
"value": ["Raw", "Hex"]
},
{
"name": "Output",
"type": "option",
"value": ["Hex", "Raw"]
},
{
"name": "Padding",
"type": "option",
"value": ["PKCS5", "NO", "ZERO", "RANDOM", "BIT"]
},
{
"name": "Word Size",
"type": "number",
"value": 32,
"min": 8,
"max": 256,
"step": 8
},
{
"name": "Rounds",
"type": "number",
"value": 20,
"min": 1,
"max": 255
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run(input, args) {
const key = Utils.convertToByteArray(args[0].string, args[0].option),
iv = Utils.convertToByteArray(args[1].string, args[1].option),
[,, mode, inputType, outputType, padding, wordSize, rounds] = args;
// Validate word size
if (!Number.isInteger(wordSize) || wordSize < 8 || wordSize > 256 || wordSize % 8 !== 0)
throw new OperationError(`Invalid word size: ${wordSize}. Must be a multiple of 8 between 8 and 256.`);
const blockSize = getBlockSize(wordSize);
const defaultRounds = getDefaultRounds(wordSize);
if (iv.length !== blockSize && iv.length !== 0 && mode !== "ECB")
throw new OperationError(`Invalid IV length: ${iv.length} bytes
RC6-${wordSize} uses an IV length of ${blockSize} bytes (${blockSize * 8} bits).
Make sure you have specified the type correctly (e.g. Hex vs UTF8).`);
if (!Number.isInteger(rounds) || rounds < 1 || rounds > 255)
throw new OperationError(`Invalid number of rounds: ${rounds}
Rounds must be an integer between 1 and 255. Standard for w=${wordSize} is ${defaultRounds}.`);
// Default IV to null bytes if empty (like AES)
const actualIv = iv.length === 0 ? new Array(blockSize).fill(0) : iv;
input = Utils.convertToByteArray(input, inputType);
const output = encryptRC6(input, key, actualIv, mode, padding, rounds, wordSize);
return outputType === "Hex" ? toHex(output, "") : Utils.byteArrayToUtf8(output);
}
}
export default RC6Encrypt;

83
src/core/operations/ROR13.mjs Normal file
View File

@ -0,0 +1,83 @@
/**
* ROR13 Hash operation (Windows API hashing convention)
* @author fufu_btw
* @license Apache-2.0
*/
import Operation from "../Operation.mjs";
/**
* Implements a ROR13 hash used for API name hashing techniques.
*/
class ROR13 extends Operation {
/**
* Constructor
*/
constructor() {
super();
this.name = "ROR13";
this.module = "Default";
this.description = "Computes a ROR13 hash used in API hashing techniques.";
this.infoURL = "";
this.inputType = "byteArray";
this.outputType = "string";
this.args = [];
}
/**
* Rotate right (32-bit)
*
* @param {number} value - input value
* @param {number} bits - rotation bits
* @returns {number} rotated value
*/
ror(value, bits) {
return ((value >>> bits) | (value << (32 - bits))) >>> 0;
}
/**
* Execute ROR13 hash
*
* @param {byteArray} input - input bytes
* @param {Object[]} args - operation arguments
* @returns {string} hex hash
*/
run(input, args) {
let hash = 0;
for (let i = 0; i < input.length; i++) {
const chr = input[i] & 0xFF;
hash = this.ror(hash, 13);
hash = (hash + chr) >>> 0;
}
return "0x" + hash.toString(16).padStart(8, "0").toUpperCase();
}
/**
* Highlight input
*
* @param {Object[]} pos
* @param {Object[]} args
* @returns {Object[]}
*/
highlight(pos, args) {
return pos;
}
/**
* Reverse highlight
*
* @param {Object[]} pos
* @param {Object[]} args
* @returns {Object[]}
*/
highlightReverse(pos, args) {
return pos;
}
}
export default ROR13;

22
src/core/operations/RandomizeColourPalette.mjs
View File

@ -10,13 +10,12 @@ import Utils from "../Utils.mjs";
import { isImage } from "../lib/FileType.mjs";
import { runHash } from "../lib/Hash.mjs";
import { toBase64 } from "../lib/Base64.mjs";
import Jimp from "jimp/es/index.js";
import { Jimp } from "jimp";
/**
* Randomize Colour Palette operation
*/
class RandomizeColourPalette extends Operation {
/**
* RandomizeColourPalette constructor
*/
@ -25,7 +24,8 @@ class RandomizeColourPalette extends Operation {
this.name = "Randomize Colour Palette";
this.module = "Image";
this.description = "Randomizes each colour in an image's colour palette. This can often reveal text or symbols that were previously a very similar colour to their surroundings, a technique sometimes used in Steganography.";
this.description =
"Randomizes each colour in an image's colour palette. This can often reveal text or symbols that were previously a very similar colour to their surroundings, a technique sometimes used in Steganography.";
this.infoURL = "https://wikipedia.org/wiki/Indexed_color";
this.inputType = "ArrayBuffer";
this.outputType = "ArrayBuffer";
@ -34,8 +34,8 @@ class RandomizeColourPalette extends Operation {
{
name: "Seed",
type: "string",
value: ""
}
value: "",
},
];
}
@ -45,23 +45,24 @@ class RandomizeColourPalette extends Operation {
* @returns {ArrayBuffer}
*/
async run(input, args) {
if (!isImage(input)) throw new OperationError("Please enter a valid image file.");
if (!isImage(input))
throw new OperationError("Please enter a valid image file.");
const seed = args[0] || (Math.random().toString().substr(2)),
const seed = args[0] || Math.random().toString().substr(2),
parsedImage = await Jimp.read(input),
width = parsedImage.bitmap.width,
height = parsedImage.bitmap.height;
let rgbString, rgbHash, rgbHex;
parsedImage.scan(0, 0, width, height, function(x, y, idx) {
rgbString = this.bitmap.data.slice(idx, idx+3).join(".");
parsedImage.scan(0, 0, width, height, function (x, y, idx) {
rgbString = this.bitmap.data.slice(idx, idx + 3).join(".");
rgbHash = runHash("md5", Utils.strToArrayBuffer(seed + rgbString));
rgbHex = rgbHash.substr(0, 6) + "ff";
parsedImage.setPixelColor(parseInt(rgbHex, 16), x, y);
});
const imageBuffer = await parsedImage.getBufferAsync(Jimp.AUTO);
const imageBuffer = await parsedImage.getBuffer(parsedImage.mime);
return new Uint8Array(imageBuffer).buffer;
}
@ -77,7 +78,6 @@ class RandomizeColourPalette extends Operation {
return `<img src="data:${type};base64,${toBase64(data)}">`;
}
}
export default RandomizeColourPalette;

3
src/core/operations/RegularExpression.mjs
View File

@ -7,6 +7,7 @@
import XRegExp from "xregexp";
import Operation from "../Operation.mjs";
import Utils from "../Utils.mjs";
import { EMAIL_REGEX } from "../lib/Extract.mjs";
import OperationError from "../errors/OperationError.mjs";
/**
@ -45,7 +46,7 @@ class RegularExpression extends Operation {
},
{
name: "Email address",
value: "(?:[\\u00A0-\\uD7FF\\uE000-\\uFFFFa-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[\\u00A0-\\uD7FF\\uE000-\\uFFFFa-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[\\u00A0-\\uD7FF\\uE000-\\uFFFFa-z0-9](?:[\\u00A0-\\uD7FF\\uE000-\\uFFFF-a-z0-9-]*[\\u00A0-\\uD7FF\\uE000-\\uFFFFa-z0-9])?\\.)+[\\u00A0-\\uD7FF\\uE000-\\uFFFFa-z0-9](?:[\\u00A0-\\uD7FF\\uE000-\\uFFFFa-z0-9-]*[\\u00A0-\\uD7FF\\uE000-\\uFFFFa-z0-9])?|\\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\\.){3}\\])"
value: EMAIL_REGEX.source // We use a different regex library, so just take the source regex string here
},
{
name: "URL",

Some files were not shown because too many files have changed in this diff Show More