quantum-resistant-rustykey 0.6.3 → 0.6.5

package/README.md

@@ -2,11 +2,9 @@
 
 Fast, secure WebAssembly implementations of useful post-quantum-resistant tools both for backend (node) and frontend web.
 
-## Implementation status
-
-- This package is in pre-production, functionally complete and stable for integration testing.
-- We recommend waiting for the v1.0.0 release - which will follow our security audit - before deploying any variant for production, healthcare or government workloads.
+## Implementation status: Pre-production (stable for testing)
 
+- ***Recommendation***: Await v1.0.0 (following security audit) for production/regulated deployment.
 - includes NIST approved as well as riskier NIST 'on-ramp' variants eg SQISign
 - *signature algorithms (coming soon):*
   - *FN-DSA (Falcon-512, Falcon-1024)*
@@ -15,6 +13,11 @@ Fast, secure WebAssembly implementations of useful post-quantum-resistant tools
 - module-lattice-based key-encapsulation mechanism
   - **ML-KEM-512**, **ML-KEM-768**, and **ML-KEM-1024** using the same stack: [mlkem-native](https://github.com/pq-code-package/mlkem-native) built with **Emscripten**.
 
+## user-friendly live example testbed and playground
+
+- live test environment (NEW!) where users can encrypt and descrypt, using all 3 varients of KEM and a test WebAuthn implementation so users can learn how signature algorithms are used to keep logins safe
+- lattice-based key encapsulation mechanism: run tests to see if Montgomery constant tim runs are good enough for your use case. Suggest improvements, see how PQC works under the hood!
+
 ## Security assurance and verification
 
 This project relies on upstream `mlkem-native` for arithmetic/security properties.
@@ -213,15 +216,6 @@ See `examples/browser-demo/README.md` for details.
 
 ML-KEM logic comes from **mlkem-native** (C), compiled with **Emscripten** under `wasm/`, wrapped by TypeScript in `mlkem-src/`, then bundled into `src/vendor/mlkem*.js`.
 
-## Publishing
-
-The package is published from the npm package root (`dist/`). To publish a new version:
-1. make a new branch locally from main
-2. edit and test your changes
-3. pnpm changeset
-4. `pnpm lint && pnpm test && pnpm build`
-5. merge to main; CI publishes when the version changed
-
 ## Security Considerations
 
 This implementation includes patches to withstand side-channel attacks. For more information about the security improvements, see: [RaspberryPi recovers secret keys from NIST winner implementation...within minutes](https://kannwischer.eu/papers/2024_kyberslash_preprint20240628.pdf)
@@ -248,3 +242,13 @@ This project was generously supported by:
   <img src="./logo-rustykey.png" width="60" alt="RustyKey Logo" />
   <img src="./logo-buzzybee.ai.png" width="60" alt="BuzzyBee Logo" />
 </div>
+
+## How we work (aka Conduct)
+**"You are very welcome to our house: It must appear in other ways than words!" - W. Shakespeare**
+- do you think of yourself as total n00b...or seasoned and cynical Cryptologic Scientist. WELCOME one and all!
+- consider helping us build a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic.
+- please avoid aliases or nicknames that might detract from a friendly, safe and welcoming environment.
+- getting annoyed? First try being kind and courteous: someone may simply have had a bad day.
+- people have differences of opinion, usually every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer.
+- go light on unstructured critique, encourage others!
+- if you feel you have been or are being harassed or made uncomfortable by a community member, contact BuzzyBee our friendly multi-LLM on the chat widget on our testbed site

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quantum-resistant-rustykey",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "WebAssembly post-quantum-resistant tools for web",
   "author": "Antony R Mott <a@auditcanary.com> (https://rustykey.app)",
   "license": "ISC",