quantum-resistant-rustykey 0.12.8 → 0.12.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +1 -15
  2. package/package.json +19 -17
package/README.md CHANGED
@@ -77,7 +77,7 @@ The three parameter sets (512/768/1024) use the same implementation family and d
77
77
 
78
78
  ### We predominantly use C, not Rust for our web-assembly (WASM) modules: Why?
79
79
 
80
- - ***we're not cryptanalysts, not the smartypants type. We choose not to 'roll our own' cryptography as it's worrying enough we compile the C into web-assembly...what if our work strips out constant-time protections? Think of us as enthusiastic interweb equivalents of stonemasons, ironworkers, mechanics and logistics crew. Our caps might still have the price tag on, but you'll find us exactly when you need us: well below decks in grubby overalls, keeping the engines humming. Far above us lounge the sharply-dressed engineers who long ago earned their Hugo spritzes. We publish frequently 'into the wild' to guarantee our code is battle-tested, bugs found quickly. It only works because we rely absolutely on vetted, peer-reviewed designs from you and the rest of the research community.***
80
+ - ***we're not cryptanalysts, not the smartypants type. We choose not to 'roll our own' cryptography as it's worrying enough we compile the C into web-assembly...what if our work strips out constant-time protections? Think of us as enthusiastic interweb equivalents of stonemasons, ironworkers, mechanics and logistics crew. If you're OK that we'll definitely break a few things along the way, you know where to find us: well below decks in grubby overalls, keeping the engines humming. Far above us, topside, lounge the elegantly-dressed OG engineers who long ago earned their Hugo spritzes. We publish frequently 'into the wild' to guarantee our code is battle-tested, bugs found quickly. It only works because we rely absolutely on vetted, peer-reviewed designs from you and the rest of the research community.***
81
81
 
82
82
  It seems all the cool cryptanalyst kids nowadays rely on Rust's proven memory and concurrency safety and high performance without a Garbage Collector. Hre it's old-school for the time being: shipped cryptographic WASM modules will continue to be built via Emscripten from vetted C/C++ upstream code. We do love Rust when used at the right time: Rust/TypeScript will be primarily used for package-level ergonomics and integration layers.
83
83
 
@@ -147,18 +147,6 @@ Notes:
147
147
  - ML-KEM
148
148
  - approach adapted from Dmitry Chestnykh's `mlkem-wasm`: https://github.com/dchest/mlkem-wasm
149
149
 
150
- ## Installation
151
-
152
- Install via pnpm, npm or yarn:
153
-
154
- ```bash
155
- pnpm install quantum-resistant-rustykey
156
- # or
157
- npm install quantum-resistant-rustykey
158
- # or
159
- yarn add quantum-resistant-rustykey
160
- ```
161
-
162
150
  ## Usage
163
151
 
164
152
  ### SQISign-webGPU (browser accelerated)
@@ -324,8 +312,6 @@ Security note for web apps:
324
312
 
325
313
  ### Prerequisites
326
314
 
327
- - Node.js >= 25.9.0
328
- - pnpm (or npm)
329
315
  - Emscripten **or** Docker — only needed if you run `pnpm build:vendor` to regenerate `src/vendor/mlkem*.js`
330
316
 
331
317
  ### Build Instructions
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "quantum-resistant-rustykey",
3
- "version": "0.12.8",
3
+ "version": "0.12.10",
4
4
  "description": "WebAssembly post-quantum-resistant tools for web",
5
5
  "author": "Antony R Mott <antony@rustykey.io> (https://rustykey.io)",
6
6
  "license": "ISC",
@@ -45,6 +45,23 @@
45
45
  "files": [
46
46
  "dist"
47
47
  ],
48
+ "scripts": {
49
+ "clean": "rm -rf dist",
50
+ "lint": "biome check --config-path ./biome.json ./src ./scripts ./tsconfig.json ./tsconfig.lint.json ./tsdown.config.ts && tsc --project ./tsconfig.lint.json",
51
+ "lint:fix": "biome check --config-path ./biome.json --write ./src ./scripts ./tsconfig.json ./tsconfig.lint.json ./tsdown.config.ts",
52
+ "build:wasm": "node scripts/build-wasm.mjs",
53
+ "bundle:mlkem": "node scripts/bundle-mlkem.mjs",
54
+ "bundle:signatures": "node scripts/bundle-signatures.mjs",
55
+ "bundle:accel-worker": "node scripts/bundle-accel-worker.mjs",
56
+ "build:vendor": "pnpm build:wasm && pnpm bundle:mlkem && pnpm bundle:signatures",
57
+ "build": "pnpm build:vendor && tsdown && pnpm bundle:accel-worker",
58
+ "test": "pnpm build:vendor && vitest run",
59
+ "verify:dist": "node scripts/verify-dist.mjs",
60
+ "prepack": "pnpm verify:dist",
61
+ "prepublishOnly": "pnpm verify:dist",
62
+ "release": "changeset publish",
63
+ "example:browser": "pnpm --filter browser-demo dev"
64
+ },
48
65
  "devDependencies": {
49
66
  "@biomejs/biome": "2.4.11",
50
67
  "@changesets/cli": "2.30.0",
@@ -60,20 +77,5 @@
60
77
  },
61
78
  "engines": {
62
79
  "node": ">=26.4.0"
63
- },
64
- "scripts": {
65
- "clean": "rm -rf dist",
66
- "lint": "biome check --config-path ./biome.json ./src ./scripts ./tsconfig.json ./tsconfig.lint.json ./tsdown.config.ts && tsc --project ./tsconfig.lint.json",
67
- "lint:fix": "biome check --config-path ./biome.json --write ./src ./scripts ./tsconfig.json ./tsconfig.lint.json ./tsdown.config.ts",
68
- "build:wasm": "node scripts/build-wasm.mjs",
69
- "bundle:mlkem": "node scripts/bundle-mlkem.mjs",
70
- "bundle:signatures": "node scripts/bundle-signatures.mjs",
71
- "bundle:accel-worker": "node scripts/bundle-accel-worker.mjs",
72
- "build:vendor": "pnpm build:wasm && pnpm bundle:mlkem && pnpm bundle:signatures",
73
- "build": "pnpm build:vendor && tsdown && pnpm bundle:accel-worker",
74
- "test": "pnpm build:vendor && vitest run",
75
- "verify:dist": "node scripts/verify-dist.mjs",
76
- "release": "changeset publish",
77
- "example:browser": "pnpm --filter browser-demo dev"
78
80
  }
79
- }
81
+ }