@interop/minimal-cipher 7.4.0 → 7.5.0

package/README.md

@@ -3,8 +3,8 @@
 [![Node.js CI](https://github.com/interop-alliance/minimal-cipher/workflows/CI/badge.svg)](https://github.com/interop-alliance/minimal-cipher/actions?query=workflow%3A%22CI%22)
 [![NPM Version](https://img.shields.io/npm/v/@interop/minimal-cipher.svg)](https://npm.im/@interop/minimal-cipher)
 
-Minimal encryption/decryption [JWE](https://tools.ietf.org/html/rfc7516)
-library, secure algs only, browser-compatible.
+> Minimal TypeScript/JS encryption/decryption [JWE](https://tools.ietf.org/html/rfc7516)
+library, secure algs only, for Node.js, browsers and React Native.
 
 ## Table of Contents
 
@@ -123,9 +123,10 @@ import { X25519KeyAgreementKey2020 } from '@interop/x25519-key-agreement-key'
 import { Ed25519VerificationKey } from '@interop/ed25519-verification-key'
 const keyPair = await Ed25519VerificationKey.generate()
 
-const keyAgreementKey = X25519KeyAgreementKey2020.fromEd25519VerificationKey2020({
-  keyPair
-})
+const keyAgreementKey =
+  X25519KeyAgreementKey2020.fromEd25519VerificationKey2020({
+    keyPair
+  })
 // If the source key pair didn't have a controller set, don't forget to set one:
 keyAgreementKey.controller = did // The controller's DID
 keyAgreementKey.id = `${did}#${keyAgreementKey.fingerprint()}`
@@ -136,9 +137,10 @@ const authnKey = didDoc.getVerificationMethod({
   proofPurpose: 'authentication'
 })
 const edKeyPair = await Ed25519VerificationKey.from(authnKey)
-const keyAgreementKey = X25519KeyAgreementKey2020.fromEd25519VerificationKey2020({
-  keyPair: edKeyPair
-})
+const keyAgreementKey =
+  X25519KeyAgreementKey2020.fromEd25519VerificationKey2020({
+    keyPair: edKeyPair
+  })
 
 const recipient = {
   header: {

package/dist/algorithms/aeskw.d.ts

@@ -1,5 +1,18 @@
 import type { KEK as KEKInterface } from '../types.js';
-export declare function createKek({ keyData }: {
+/**
+ * Creates a KEK, selecting the backend by capability: the WebCrypto `AES-KW`
+ * path when the runtime provides the key-wrap ops, otherwise the pure-JS
+ * RFC 3394 fallback. Both backends produce identical wrapped bytes.
+ *
+ * @param {object} options - The options to use.
+ * @param {Uint8Array} options.keyData - The 256-bit KEK material.
+ * @param {Crypto} [options.crypto] - WebCrypto instance to probe and use;
+ *   defaults to the module's WebCrypto. Overridable for testing the fallback.
+ *
+ * @returns {Promise<KEKInterface>} - The KEK backend.
+ */
+export declare function createKek({ keyData, crypto: cryptoObj }: {
     keyData: Uint8Array;
+    crypto?: Crypto;
 }): Promise<KEKInterface>;
 //# sourceMappingURL=aeskw.d.ts.map

package/dist/algorithms/aeskw.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aeskw.d.ts","sourceRoot":"","sources":["../../src/algorithms/aeskw.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,GAAG,IAAI,YAAY,EAAE,MAAM,aAAa,CAAA;AAyFtD,wBAAsB,SAAS,CAAC,EAC9B,OAAO,EACR,EAAE;IACD,OAAO,EAAE,UAAU,CAAA;CACpB,GAAG,OAAO,CAAC,YAAY,CAAC,CAUxB"}
+{"version":3,"file":"aeskw.d.ts","sourceRoot":"","sources":["../../src/algorithms/aeskw.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,GAAG,IAAI,YAAY,EAAE,MAAM,aAAa,CAAA;AA0KtD;;;;;;;;;;;GAWG;AACH,wBAAsB,SAAS,CAAC,EAC9B,OAAO,EACP,MAAM,EAAE,SAAkB,EAC3B,EAAE;IACD,OAAO,EAAE,UAAU,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,GAAG,OAAO,CAAC,YAAY,CAAC,CAaxB"}

package/dist/algorithms/aeskw.js

@@ -1,8 +1,28 @@
 /*!
  * Copyright (c) 2019-2026 Digital Bazaar, Inc.
  */
+import { aeskw } from '@noble/ciphers/aes.js';
 import { base64url } from '../baseX.js';
 import crypto from '../crypto.js';
+/**
+ * Feature-detects whether the given WebCrypto instance provides the AES-KW
+ * key-wrap subset. Browsers and Node (>=24) do; React Native / Hermes shims
+ * that only expose `subtle.digest` do not, so we fall back to the pure-JS
+ * RFC 3394 backend below.
+ *
+ * @param {Crypto} [cryptoObj] - A WebCrypto instance to probe.
+ *
+ * @returns {boolean} - True when `importKey`, `wrapKey`, `unwrapKey`, and
+ *   `exportKey` are all available.
+ */
+function hasWebCryptoKeyWrap(cryptoObj) {
+    const subtle = cryptoObj?.subtle;
+    return !!(subtle &&
+        typeof subtle.importKey === 'function' &&
+        typeof subtle.wrapKey === 'function' &&
+        typeof subtle.unwrapKey === 'function' &&
+        typeof subtle.exportKey === 'function');
+}
 class Kek {
     // `CryptoKey` is the Web Crypto API key type, sourced from the DOM lib.
     key;
@@ -61,9 +81,72 @@ class Kek {
         }
     }
 }
-export async function createKek({ keyData }) {
+/**
+ * Pure-JS RFC 3394 AES Key Wrap (A256KW) backend, used as a fallback on
+ * runtimes such as React Native / Hermes whose WebCrypto lacks the key-wrap
+ * ops. Uses `@noble/ciphers`' `aeskw`, which implements RFC 3394 with the
+ * default IV `A6A6A6A6A6A6A6A6` and therefore produces byte-identical wrapped
+ * output to WebCrypto `AES-KW` for the same KEK and key material.
+ */
+class PureJsKek {
+    _keyData;
+    algorithm;
+    constructor(keyData) {
+        this._keyData = keyData;
+        this.algorithm = { name: 'A256KW' };
+    }
+    /**
+     * Wraps a cryptographic key.
+     *
+     * @param {object} options - The options to use.
+     * @param {Uint8Array} options.unwrappedKey - The key material as a
+     *   `Uint8Array`.
+     *
+     * @returns {Promise<string>} - The base64url-encoded wrapped key bytes.
+     */
+    async wrapKey({ unwrappedKey }) {
+        const wrappedKey = aeskw(this._keyData).encrypt(unwrappedKey);
+        return base64url.encode(wrappedKey);
+    }
+    /**
+     * Unwraps a cryptographic key.
+     *
+     * @param {object} options - The options to use.
+     * @param {string} options.wrappedKey - The wrapped key material as a
+     *   base64url-encoded string.
+     *
+     * @returns {Promise<Uint8Array>} - Resolves to the key bytes or null if
+     *   the unwrapping fails because the key does not match.
+     */
+    async unwrapKey({ wrappedKey }) {
+        const wrappedKeyBytes = base64url.decode(wrappedKey);
+        try {
+            return aeskw(this._keyData).decrypt(wrappedKeyBytes);
+        }
+        catch {
+            // integrity check failed -- KEK does not match
+            return null;
+        }
+    }
+}
+/**
+ * Creates a KEK, selecting the backend by capability: the WebCrypto `AES-KW`
+ * path when the runtime provides the key-wrap ops, otherwise the pure-JS
+ * RFC 3394 fallback. Both backends produce identical wrapped bytes.
+ *
+ * @param {object} options - The options to use.
+ * @param {Uint8Array} options.keyData - The 256-bit KEK material.
+ * @param {Crypto} [options.crypto] - WebCrypto instance to probe and use;
+ *   defaults to the module's WebCrypto. Overridable for testing the fallback.
+ *
+ * @returns {Promise<KEKInterface>} - The KEK backend.
+ */
+export async function createKek({ keyData, crypto: cryptoObj = crypto }) {
+    if (!hasWebCryptoKeyWrap(cryptoObj)) {
+        return new PureJsKek(keyData);
+    }
     const extractable = true;
-    const key = await crypto.subtle.importKey('raw', keyData, { name: 'AES-KW', length: 256 }, extractable, ['wrapKey', 'unwrapKey']);
+    const key = await cryptoObj.subtle.importKey('raw', keyData, { name: 'AES-KW', length: 256 }, extractable, ['wrapKey', 'unwrapKey']);
     return new Kek(key);
 }
 //# sourceMappingURL=aeskw.js.map

package/dist/algorithms/aeskw.js.map

@@ -1 +1 @@
-{"version":3,"file":"aeskw.js","sourceRoot":"","sources":["../../src/algorithms/aeskw.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,MAAM,MAAM,cAAc,CAAA;AAGjC,MAAM,GAAG;IACP,wEAAwE;IACxE,GAAG,CAAW;IACd,SAAS,CAAkB;IAE3B,YAAY,GAAc;QACxB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;IACrC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,CAAC,EACZ,YAAY,EAGb;QACC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;QACpB,uEAAuE;QACvE,MAAM,WAAW,GAAG,IAAI,CAAA;QAExB,MAAM,kBAAkB,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CACtD,KAAK,EACL,YAA4B,EAC5B,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE;QAChC,qEAAqE;QACrE,qEAAqE;QACrE,aAAa;QACb,WAAW,EACX,CAAC,SAAS,CAAC,CACZ,CAAA;QACD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAC5C,KAAK,EACL,kBAAkB,EAClB,GAAG,EACH,GAAG,CAAC,SAAS,CACd,CAAA;QACD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,SAAS,CAAC,EACd,UAAU,EAGX;QACC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;QACpB,uEAAuE;QACvE,MAAM,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QACpD,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,CAAA;YACxB,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CACvC,KAAK,EACL,eAA+B,EAC/B,GAAG,EACH,GAAG,CAAC,SAAS;YACb,oEAAoE;YACpE,gEAAgE;YAChE,EAAE,IAAI,EAAE,SAAS,EAAE,EACnB,WAAW,EACX,CAAC,SAAS,CAAC,CACZ,CAAA;YACD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YAC1D,OAAO,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAA;QACjC,CAAC;QAAC,MAAM,CAAC;YACP,wBAAwB;YACxB,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,EAC9B,OAAO,EAGR;IACC,MAAM,WAAW,GAAG,IAAI,CAAA;IACxB,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CACvC,KAAK,EACL,OAAuB,EACvB,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,EAC/B,WAAW,EACX,CAAC,SAAS,EAAE,WAAW,CAAC,CACzB,CAAA;IACD,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;AACrB,CAAC"}
+{"version":3,"file":"aeskw.js","sourceRoot":"","sources":["../../src/algorithms/aeskw.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,MAAM,MAAM,cAAc,CAAA;AAGjC;;;;;;;;;;GAUG;AACH,SAAS,mBAAmB,CAAC,SAAkB;IAC7C,MAAM,MAAM,GAAG,SAAS,EAAE,MAAM,CAAA;IAChC,OAAO,CAAC,CAAC,CACP,MAAM;QACN,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU;QACtC,OAAO,MAAM,CAAC,OAAO,KAAK,UAAU;QACpC,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU;QACtC,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU,CACvC,CAAA;AACH,CAAC;AAED,MAAM,GAAG;IACP,wEAAwE;IACxE,GAAG,CAAW;IACd,SAAS,CAAkB;IAE3B,YAAY,GAAc;QACxB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;IACrC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,CAAC,EACZ,YAAY,EAGb;QACC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;QACpB,uEAAuE;QACvE,MAAM,WAAW,GAAG,IAAI,CAAA;QAExB,MAAM,kBAAkB,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CACtD,KAAK,EACL,YAA4B,EAC5B,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE;QAChC,qEAAqE;QACrE,qEAAqE;QACrE,aAAa;QACb,WAAW,EACX,CAAC,SAAS,CAAC,CACZ,CAAA;QACD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAC5C,KAAK,EACL,kBAAkB,EAClB,GAAG,EACH,GAAG,CAAC,SAAS,CACd,CAAA;QACD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,SAAS,CAAC,EACd,UAAU,EAGX;QACC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;QACpB,uEAAuE;QACvE,MAAM,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QACpD,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,CAAA;YACxB,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CACvC,KAAK,EACL,eAA+B,EAC/B,GAAG,EACH,GAAG,CAAC,SAAS;YACb,oEAAoE;YACpE,gEAAgE;YAChE,EAAE,IAAI,EAAE,SAAS,EAAE,EACnB,WAAW,EACX,CAAC,SAAS,CAAC,CACZ,CAAA;YACD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YAC1D,OAAO,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAA;QACjC,CAAC;QAAC,MAAM,CAAC;YACP,wBAAwB;YACxB,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,SAAS;IACb,QAAQ,CAAY;IACpB,SAAS,CAAkB;IAE3B,YAAY,OAAmB;QAC7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,IAAI,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;IACrC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,CAAC,EACZ,YAAY,EAGb;QACC,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAC7D,OAAO,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;IACrC,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,SAAS,CAAC,EACd,UAAU,EAGX;QACC,MAAM,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QACpD,IAAI,CAAC;YACH,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;QACtD,CAAC;QAAC,MAAM,CAAC;YACP,+CAA+C;YAC/C,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,EAC9B,OAAO,EACP,MAAM,EAAE,SAAS,GAAG,MAAM,EAI3B;IACC,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC;QACpC,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;IAC/B,CAAC;IACD,MAAM,WAAW,GAAG,IAAI,CAAA;IACxB,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,SAAS,CAC1C,KAAK,EACL,OAAuB,EACvB,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,EAC/B,WAAW,EACX,CAAC,SAAS,EAAE,WAAW,CAAC,CACzB,CAAA;IACD,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;AACrB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@interop/minimal-cipher",
-  "version": "7.4.0",
+  "version": "7.5.0",
   "description": "Minimal encryption/decryption JWE library.",
   "license": "BSD-3-Clause",
   "type": "module",
@@ -40,8 +40,9 @@
     "test:coverage": "vitest run --coverage"
   },
   "dependencies": {
-    "@interop/data-integrity-core": "^8.0.0",
-    "@interop/ecdsa-multikey": "^2.3.1",
+    "@interop/data-integrity-core": "^8.1.0",
+    "@interop/ecdsa-multikey": "^2.3.2",
+    "@noble/ciphers": "^2.2.0",
     "@noble/curves": "^2.2.0",
     "@scure/base": "^2.2.0",
     "@stablelib/chacha": "^2.0.1",
@@ -49,9 +50,9 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@interop/did-io": "^4.0.5",
-    "@interop/did-method-key": "^7.3.2",
-    "@interop/ed25519-verification-key": "^8.0.0",
+    "@interop/did-io": "^4.0.6",
+    "@interop/did-method-key": "^7.3.3",
+    "@interop/ed25519-verification-key": "^8.0.2",
     "@interop/x25519-key-agreement-key": "^5.1.0",
     "@playwright/test": "^1.60.0",
     "@types/node": "^25.9.1",