json-seal 0.9.1 → 0.10.1

package/README.md

@@ -1,77 +1,65 @@
-# **json‑seal**
-![npm version](https://img.shields.io/npm/v/json-seal)
-![license](https://img.shields.io/npm/l/json-seal)
-![types](https://img.shields.io/badge/types-TypeScript-blue)
-![bundle size](https://img.shields.io/bundlephobia/minzip/json-seal)
-![crypto](https://img.shields.io/badge/crypto-RSA--PSS-green)
-![npm downloads](https://img.shields.io/npm/dm/json-seal)
+<h1 align="center">json-seal</h1>
 
-Cryptographically signed, tamper‑proof JSON backups for apps - zero dependencies and a tiny footprint under 5 kB.
+<p align="center">
+  <img src="https://github.com/cmyers/json-seal/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI" />
+  <img src="https://img.shields.io/npm/v/json-seal" alt="npm version" />
+  <img src="https://img.shields.io/badge/Deterministic%20JSON-RFC%208785%20Compliant-success" alt="Deterministic JSON" />
+  <img src="https://img.shields.io/badge/dependencies-0-brightgreen" alt="dependencies" />
+  <img src="https://img.shields.io/badge/types-TypeScript-blue" alt="types" />
+  <img src="https://img.shields.io/bundlephobia/minzip/json-seal" alt="bundle size" />
+  <img src="https://img.shields.io/github/license/cmyers/json-seal" alt="license" />
+</p>
 
-json‑seal lets you:
+<h3 align="center">
+  A lightweight, zero‑dependency library for creating cryptographically signed, tamper‑proof JSON backups.
+</h3>
 
-- Canonicalize any JSON object  
-- Sign it with a private key  
-- Embed the public key  
-- Verify integrity later  
-- Detect any tampering - even a single character  
-
-It’s like JWS, but for **arbitrary JSON documents**, without JWT complexity, and designed for **offline‑first apps**, **local backups**, and **portable integrity checks**.
-
----
-
-## **Why json‑seal exists**
-
-Most security libraries focus on:
+## **Why json‑seal**
 
-- encrypted blobs (iron‑webcrypto)  
-- authentication tokens (JOSE/JWS/JWT)  
-- low‑level primitives (WebCrypto, libsodium)  
+Apps often need to store or transmit JSON in a way that guarantees it hasn’t been tampered with — without relying on servers, tokens, or opaque binary formats. Most security libraries focus on encrypted blobs, authentication tokens, or low‑level crypto primitives, but none solve the simple problem:
 
-None of these solves the problem of:
+**“I need to store JSON in a way that guarantees integrity — while keeping it readable, portable, and framework‑agnostic.”**
 
-**“I need to store or transmit JSON in a way that guarantees it hasn’t been tampered with - while keeping it readable, portable, and framework‑agnostic.”**
+json‑seal fills that gap. It lets you:
 
-json‑seal fills that gap.
+- Canonicalize any JSON value  
+- Sign it with a private key  
+- Embed the public key  
+- Verify integrity later  
+- Detect any tampering — even a single character  
 
-It turns any JSON object into a **sealed artifact** that can be verified anywhere, on any device, without servers, shared secrets, or opaque binary formats. The result is a portable, human‑readable, cryptographically signed JSON document that remains trustworthy for years.
+It’s like JWS, but for **arbitrary JSON documents**, without JWT complexity, and designed for **offline‑first apps**, **local backups**, and **portable integrity checks**. It turns any JSON value into a **portable, human‑readable, cryptographically signed artifact** that can be verified anywhere, on any device, with no external dependencies.
 
 ---
 
 ## **Features**
 
-### **Deterministic canonicalization**  
-Stable, cross‑platform byte representation of JSON for reliable signatures.  
-If the JSON changes - even whitespace - verification fails.
+### **RFC 8785 Canonical JSON**
+Deterministic, cross‑runtime canonicalization:
 
-### **RSA‑PSS digital signatures**  
-Modern, secure, asymmetric signing using the WebCrypto API.
-No shared passwords, no symmetric secrets, no server dependency.
+- sorted keys  
+- strict number formatting  
+- ECMAScript string escaping  
+- duplicate‑key rejection  
+- stable UTF‑8 output  
 
-### **Pure JSON seal format**
-Human‑readable, portable, and easy to store, sync, export, or transmit.  
-Everything needed for verification is embedded.
+### **RSA‑PSS Signatures**
+Modern asymmetric signing using WebCrypto.  
+No shared secrets. No servers. No dependencies.
 
-### **Browser + Node support**
-Works anywhere `crypto.subtle` is available - modern browsers, PWAs, Node 18+, Bun, Deno, and edge runtimes.
+### **Portable JSON Backup Format**
+Everything needed for verification is embedded:
 
-### **Framework‑agnostic**
-Angular, React, Vue, Svelte, Ionic, Capacitor, PWAs, Node, Bun, Deno - json‑seal fits everywhere.
+- payload  
+- timestamp  
+- signature  
+- public key  
 
-### **Zero dependencies** 
-Small, auditable, and safe for long‑term use.
-No polyfills, no crypto libraries, no runtime baggage.
+### **Works Everywhere**
+Browsers, PWAs, Node 18+, Bun, Deno, and mobile runtimes.
 
-### **Perfect for offline‑first apps**
-Protects:
-
-- Local storage
-- IndexedDB
-- Sync engines
-- User‑exported backups
-- Cross‑device data portability
-
-json‑seal is built for apps that need **trustworthy, tamper‑proof JSON**, not tokens or encrypted blobs.
+### **Zero Dependencies**
+Small, auditable, and safe for long‑term use.
 
 ---
 
@@ -117,7 +105,7 @@ if (result.valid) {
 
 ---
 
-## **What a signed backup looks like**
+## **Example Backup**
 
 ```json
 {
@@ -132,13 +120,11 @@ if (result.valid) {
 }
 ```
 
-Everything needed to verify the backup is embedded.
-
 ---
 
 ## **Tamper Detection**
 
-Any modification - even deep inside nested objects - invalidates the signature.
+Any modification — even deep inside nested objects — invalidates the signature.
 
 ```ts
 const tampered = { ...backup, payload: { id: 1, data: "hacked" } };
@@ -148,123 +134,44 @@ verifyBackup(tampered).valid; // false
 
 ---
 
-## **Key Management**
-
-`generateKeyPair()` should be called **once**, not on every backup.  
-Apps are expected to generate or receive a keypair during onboarding and store it securely.
-
----
-
-### **App‑generated keys**
-
-Most offline‑first apps generate a keypair on first launch:
-
-```ts
-import { generateKeyPair } from "json-seal";
-
-const { privateKey, publicKey } = await generateKeyPair();
-
-secureStore.set("privateKey", privateKey);
-secureStore.set("publicKey", publicKey);
-```
-
-On subsequent runs:
-
-```ts
-const privateKey = secureStore.get("privateKey");
-const publicKey = secureStore.get("publicKey");
-
-const backup = await signPayload(data, privateKey, publicKey);
-```
-
----
-
-### **Where to store keys**
-
-Storage depends on the platform:
-
-- iOS → Keychain  
-- Android → Keystore  
-- Web → IndexedDB + WebCrypto  
-- Desktop → OS keyring or encrypted local file  
-- Node → environment variables or encrypted file  
-
-json‑seal intentionally does **not** handle storage so it can remain environment‑agnostic.
-
----
-
-### **Server‑generated keys**
-
-Some architectures prefer the backend to generate and manage keys:
-
-1. Server generates keypair  
-2. Server stores private key  
-3. Server sends public key to the app  
-4. App signs backups using the server’s public key  
-5. Server verifies integrity later  
-
-Useful for multi‑device accounts or enterprise systems.
-
----
-
-### **Key rotation**
-
-json‑seal embeds the public key inside each backup, so old backups remain verifiable even after rotation.
-
-Typical strategy:
-
-- generate a new keypair yearly  
-- store the new private key  
-- keep old public keys for verification  
-- continue verifying old backups without breaking anything  
-
----
+## **API**
 
-### **Importing and exporting keys**
+### **`generateKeyPair()`**  
+Generates a 2048‑bit RSA‑PSS keypair.
 
-Keys are standard PEM strings, so they can be:
+### **`signPayload(payload, privateKey, publicKey)`**  
+Canonicalizes the payload, signs it, and returns a sealed backup object.
 
-- backed up  
-- migrated  
-- synced  
-- exported/imported  
+### **`verifyBackup(backup)`**  
+Verifies the signature and returns `{ valid, payload? }`.
 
-Perfect for long‑term, portable backup formats.
+### **`canonicalize(value)`**  
+Full RFC 8785 Canonical JSON implementation.
 
 ---
 
-## **API**
-
-### **`generateKeyPair()`**
-Generates a 2048‑bit RSA‑PSS keypair using WebCrypto.
+## **Prior Art**
 
-### **`signPayload(payload, privateKey, publicKey)`**
-- Canonicalizes the JSON  
-- Signs it using RSA‑PSS SHA‑256  
-- Embeds the public key  
-- Returns a portable backup object  
+json‑seal builds on ideas from:
 
-### **`verifyBackup(backup)`**
-- Re‑canonicalizes the payload  
-- Verifies the signature  
-- Returns `{ valid: boolean, payload?: any }`  
+- **json-canonicalize** — RFC 8785 canonicalization (no signing or backup format)  
+- **rfc8785 (Python)** — pure Python canonicalizer  
+- **jcs (Elixir)** — Elixir implementation of JCS  
+- **JOSE / JWS / JWT** — signing standards focused on tokens, not arbitrary JSON  
 
-### **`canonicalize(obj)`**
-Deterministic JSON serializer with sorted keys.
+json‑seal combines **canonicalization + signing + verification** into a single, zero‑dependency library designed for **offline‑first, portable JSON integrity**.
 
 ---
 
 ## **Testing**
 
-json‑seal ships with a full Vitest suite covering:
+The test suite covers:
 
+- RFC 8785 canonicalization  
+- Unicode and number edge cases  
 - Valid signatures  
-- Shallow tampering  
-- Deep tampering  
-- Missing signature  
-- Wrong public key  
-- Corrupted signature  
-- Canonicalization stability  
+- Shallow and deep tampering  
+- Missing / wrong / corrupted signatures  
 - Large payloads  
 - Arrays and primitives  
 - RSA‑PSS non‑determinism  
@@ -276,11 +183,9 @@ npm test
 ```
 
 ---
-
-Pull Requests welcome.
-
+Pull Requests are welcome.
 ## **License**
 
 MIT
 
----
+---

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "json-seal",
-  "version": "0.9.1",
-  "description": "Cryptographically signed, tamper‑proof JSON backups with deterministic canonicalization and RSA‑PSS signatures.",
+  "version": "0.10.1",
+  "description": "Create cryptographically signed, tamper‑proof JSON backups with zero dependencies.",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",