dignity.js 0.2.0 → 0.3.0

package/README.md

@@ -13,10 +13,9 @@
 <p align="center">
   <a href="https://www.npmjs.com/package/dignity.js"><img src="https://img.shields.io/npm/v/dignity.js?color=cb3837&label=npm" alt="npm version"></a>
   <a href="https://www.npmjs.com/package/dignity.js"><img src="https://img.shields.io/npm/dm/dignity.js?color=blue" alt="npm downloads"></a>
-  <img src="https://img.shields.io/badge/tests-29%20passing-brightgreen" alt="tests passing">
-  <img src="https://img.shields.io/badge/coverage-88%25-brightgreen" alt="coverage">
-  <img src="https://img.shields.io/badge/license-MIT-black" alt="license">
-  <img src="https://img.shields.io/badge/minified-51KB-purple" alt="bundle size">
+  <img src="https://img.shields.io/badge/tests-122%20passing-brightgreen" alt="tests passing">
+  <img src="https://img.shields.io/badge/coverage-97%25-brightgreen" alt="coverage">
+  <img src="https://img.shields.io/badge/license-Apache%202.0-black" alt="license">
 </p>
 
 REST-like P2P object API for decentralized JavaScript applications.
@@ -35,7 +34,7 @@ REST-like P2P object API for decentralized JavaScript applications.
   - default `powSteps: 22` (calibrated on this machine to about 1000ms)
   - automatic peer ban on invalid signature/PoW (`48h` default)
 - Team/subapp scoped broadcast passwords (`broadcastScope` + `broadcastPasswords`)
-- Browser-first distribution with minified build (`dist/dignity.min.js`)
+- Browser-first: published npm package includes IIFE, ESM, and CJS builds
 
 ## Install
 
@@ -146,15 +145,9 @@ bob.registerPeerPublicKey('alice', alice.getPublicKey());
 await alice.sendDirectMessage('bob', 'dm', { text: 'private payload' });
 ```
 
-## Browser Builds
+## Browser Usage
 
-Generated artifacts:
-
-- `dist/dignity.min.js` (IIFE, global `DignityJS`)
-- `dist/dignity.esm.js` (ESM)
-- `dist/dignity.cjs.js` (CommonJS)
-
-Example with CDN:
+The published npm package includes pre-built bundles (IIFE, ESM, CJS) generated at publish time. The `dist/` folder is not checked into the repository.
 
 ```html
 <script src="https://unpkg.com/dignity.js/dist/dignity.min.js"></script>
@@ -163,6 +156,19 @@ Example with CDN:
 </script>
 ```
 
+## Security Model
+
+`dignity.js` provides two encryption modes:
+
+- **Direct mode** (`targetId` set): true end-to-end encryption using X25519 key exchange between sender and recipient. Only the intended recipient can decrypt.
+- **Broadcast mode** (no `targetId`): symmetric encryption using a shared password. All peers that know the password can decrypt all broadcast traffic in that scope. This is a **group shared-secret cipher**, not end-to-end encryption.
+
+Broadcast encryption uses PBKDF2-SHA256 (default 100,000 iterations) with a random salt per message to derive the symmetric key. This protects against offline brute-force of weak passwords. The iteration count is configurable via `kdfIterations`.
+
+Messages from peers running older versions that used the legacy single-hash KDF are still accepted and decrypted automatically (backward compatible).
+
+**Important:** if the broadcast password leaks, all past captured traffic for that scope is retroactively decryptable. For sensitive data, use direct mode with per-peer public keys.
+
 ## Signaling Servers
 
 Default signaling URLs include PeerJS-compatible public endpoints:
@@ -198,11 +204,11 @@ npm run test:pow-calibrate
 ## Publish
 
 ```bash
-npm test
-npm run build
 npm publish --access public
 ```
 
+The `prepublishOnly` script runs tests and build automatically.
+
 ## License
 
-Apache 2.0
+Apache 2.0 — see [LICENSE](LICENSE).

package/dist/dignity.cjs.js

@@ -2434,7 +2434,8 @@ var require_message_security_service = __commonJS({
       broadcastPasswords: {},
       resolveBroadcastPassword: null,
       powSteps: 22,
-      trustedPeerKeys: {}
+      trustedPeerKeys: {},
+      kdfIterations: 1e5
     };
     function stableStringify(value) {
       if (value === null || typeof value !== "object") {
@@ -2461,6 +2462,33 @@ var require_message_security_service = __commonJS({
     function utf8ToBytes(value) {
       return naclUtil.decodeUTF8(value);
     }
+    async function deriveBroadcastKey(password, salt, iterations) {
+      const subtle = globalThis.crypto && globalThis.crypto.subtle;
+      if (subtle) {
+        const keyMaterial = await subtle.importKey(
+          "raw",
+          utf8ToBytes(password),
+          "PBKDF2",
+          false,
+          ["deriveBits"]
+        );
+        const bits = await subtle.deriveBits(
+          { name: "PBKDF2", salt, iterations, hash: "SHA-256" },
+          keyMaterial,
+          256
+        );
+        return new Uint8Array(bits);
+      }
+      try {
+        const { pbkdf2Sync } = require("crypto");
+        return new Uint8Array(pbkdf2Sync(password, Buffer.from(salt), iterations, 32, "sha256"));
+      } catch (_ignored) {
+        return hash32(concatBytes(utf8ToBytes(password), salt));
+      }
+    }
+    function legacyBroadcastKey(password, salt) {
+      return hash32(concatBytes(utf8ToBytes(password), salt));
+    }
     function normalizePeerPublicKey(publicKey) {
       if (!publicKey || typeof publicKey !== "object") {
         throw new Error("Public key must be an object with signingPublicKey and encryptionPublicKey");
@@ -2621,7 +2649,7 @@ var require_message_security_service = __commonJS({
         if (envelope.security && envelope.security.signing && envelope.security.signing.enabled && this.options.signingEnabled) {
           this.verifySignature(envelope);
         }
-        const payload = this.decryptPayload(envelope);
+        const payload = await this.decryptPayload(envelope);
         return {
           ignored: false,
           messageType: envelope.messageType,
@@ -2686,7 +2714,8 @@ var require_message_security_service = __commonJS({
         const nonce = nacl.randomBytes(nacl.secretbox.nonceLength);
         const salt = nacl.randomBytes(16);
         const password = this.resolveBroadcastPassword(scope);
-        const key = hash32(concatBytes(utf8ToBytes(password), salt));
+        const iterations = this.options.kdfIterations || DEFAULT_SECURITY_OPTIONS2.kdfIterations;
+        const key = await deriveBroadcastKey(password, salt, iterations);
         const encrypted = nacl.secretbox(plainText, nonce, key);
         return {
           payload: naclUtil.encodeBase64(encrypted),
@@ -2695,11 +2724,13 @@ var require_message_security_service = __commonJS({
             mode: "broadcast",
             scope,
             nonce: naclUtil.encodeBase64(nonce),
-            salt: naclUtil.encodeBase64(salt)
+            salt: naclUtil.encodeBase64(salt),
+            kdf: "pbkdf2",
+            kdfIterations: iterations
           }
         };
       }
-      decryptPayload(envelope) {
+      async decryptPayload(envelope) {
         const encryption = envelope.security ? envelope.security.encryption : null;
         if (!encryption || !encryption.enabled || !this.options.encryptionEnabled) {
           return envelope.payload;
@@ -2710,7 +2741,13 @@ var require_message_security_service = __commonJS({
           const password = this.resolveBroadcastPassword(scope);
           const salt = naclUtil.decodeBase64(encryption.salt);
           const nonce = naclUtil.decodeBase64(encryption.nonce);
-          const key = hash32(concatBytes(utf8ToBytes(password), salt));
+          let key;
+          if (encryption.kdf === "pbkdf2") {
+            const iterations = encryption.kdfIterations || DEFAULT_SECURITY_OPTIONS2.kdfIterations;
+            key = await deriveBroadcastKey(password, salt, iterations);
+          } else {
+            key = legacyBroadcastKey(password, salt);
+          }
           const decrypted = nacl.secretbox.open(encryptedBuffer, nonce, key);
           if (!decrypted) {
             throw new Error("Unable to decrypt broadcast payload");
@@ -2804,6 +2841,8 @@ var require_message_security_service = __commonJS({
     module2.exports = {
       MessageSecurityService: MessageSecurityService2,
       stableStringify,
+      deriveBroadcastKey,
+      legacyBroadcastKey,
       DEFAULT_SECURITY_OPTIONS: DEFAULT_SECURITY_OPTIONS2
     };
   }