zapo-js 0.1.2 → 0.3.0

package/README.md

@@ -1,4 +1,6 @@
-<h1 align="center">zapo</h1>
+<p align="center">
+  <img src=".github/assets/logo.png" alt="zapo" width="400" />
+</p>
 
 <p align="center">
   <strong>High-performance TypeScript implementation of the WhatsApp Web protocol.</strong><br />
@@ -112,6 +114,7 @@ Auth state is persisted in `.auth/state.sqlite`.
 
 ```ts
 import { createPinoLogger, createStore, WaClient } from 'zapo-js'
+import { createSqliteStore } from '@zapo-js/store-sqlite'
 
 const logger = await createPinoLogger({
     level: 'info',
@@ -119,11 +122,20 @@ const logger = await createPinoLogger({
 })
 
 const store = createStore({
-    sqlite: {
-        path: '.auth/state.sqlite',
-        driver: 'auto'
+    backends: {
+        sqlite: createSqliteStore({
+            path: '.auth/state.sqlite',
+            driver: 'auto'
+        })
     },
     providers: {
+        auth: 'sqlite',
+        signal: 'sqlite',
+        preKey: 'sqlite',
+        session: 'sqlite',
+        identity: 'sqlite',
+        senderKey: 'sqlite',
+        appState: 'sqlite',
         messages: 'sqlite',
         threads: 'sqlite',
         contacts: 'sqlite'

package/dist/appstate/WaAppStateCrypto.js

@@ -8,14 +8,17 @@ const random_1 = require("../crypto/core/random");
 const _proto_1 = require("../proto.js");
 const constants_2 = require("../protocol/constants");
 const bytes_1 = require("../util/bytes");
-const bytes_2 = require("../util/bytes");
 const collections_1 = require("../util/collections");
 const primitives_2 = require("../util/primitives");
 const DEFAULT_DERIVED_KEYS_CACHE_MAX_SIZE = 256;
 class WaAppStateCrypto {
-    constructor(derivedKeysCacheMaxSize = DEFAULT_DERIVED_KEYS_CACHE_MAX_SIZE) {
+    constructor(derivedKeysCacheMaxSize = DEFAULT_DERIVED_KEYS_CACHE_MAX_SIZE, skipMacVerification = false) {
         this.derivedKeysCache = new Map();
         this.derivedKeysCacheMaxSize = (0, primitives_2.normalizeNonNegativeInteger)(derivedKeysCacheMaxSize, DEFAULT_DERIVED_KEYS_CACHE_MAX_SIZE);
+        this.skipMacVerification = skipMacVerification;
+    }
+    get isMacVerificationSkipped() {
+        return this.skipMacVerification;
     }
     clearCache() {
         this.derivedKeysCache.clear();
@@ -28,45 +31,50 @@ class WaAppStateCrypto {
             return cached;
         }
         const derived = await (0, hkdf_1.hkdf)(keyData, null, constants_2.WA_APP_STATE_KDF_INFO.MUTATION_KEYS, constants_1.APP_STATE_DERIVED_KEY_LENGTH);
+        const [indexHmacKey, valueEncryptionAesKey, valueMacHmacKey, snapshotMacHmacKey, patchMacHmacKey] = await Promise.all([
+            (0, primitives_1.importHmacKey)(derived.subarray(0, constants_1.APP_STATE_DERIVED_INDEX_KEY_END)),
+            (0, primitives_1.importAesCbcKey)(derived.subarray(constants_1.APP_STATE_DERIVED_INDEX_KEY_END, constants_1.APP_STATE_DERIVED_VALUE_ENCRYPTION_KEY_END)),
+            (0, primitives_1.importHmacSha512Key)(derived.subarray(constants_1.APP_STATE_DERIVED_VALUE_ENCRYPTION_KEY_END, constants_1.APP_STATE_DERIVED_VALUE_MAC_KEY_END)),
+            (0, primitives_1.importHmacKey)(derived.subarray(constants_1.APP_STATE_DERIVED_VALUE_MAC_KEY_END, constants_1.APP_STATE_DERIVED_SNAPSHOT_MAC_KEY_END)),
+            (0, primitives_1.importHmacKey)(derived.subarray(constants_1.APP_STATE_DERIVED_SNAPSHOT_MAC_KEY_END, constants_1.APP_STATE_DERIVED_PATCH_MAC_KEY_END))
+        ]);
         const keys = {
-            indexKey: derived.subarray(0, constants_1.APP_STATE_DERIVED_INDEX_KEY_END),
-            valueEncryptionKey: derived.subarray(constants_1.APP_STATE_DERIVED_INDEX_KEY_END, constants_1.APP_STATE_DERIVED_VALUE_ENCRYPTION_KEY_END),
-            valueMacKey: derived.subarray(constants_1.APP_STATE_DERIVED_VALUE_ENCRYPTION_KEY_END, constants_1.APP_STATE_DERIVED_VALUE_MAC_KEY_END),
-            snapshotMacKey: derived.subarray(constants_1.APP_STATE_DERIVED_VALUE_MAC_KEY_END, constants_1.APP_STATE_DERIVED_SNAPSHOT_MAC_KEY_END),
-            patchMacKey: derived.subarray(constants_1.APP_STATE_DERIVED_SNAPSHOT_MAC_KEY_END, constants_1.APP_STATE_DERIVED_PATCH_MAC_KEY_END)
+            indexHmacKey,
+            valueEncryptionAesKey,
+            valueMacHmacKey,
+            snapshotMacHmacKey,
+            patchMacHmacKey
         };
         this.touchDerivedKeysCacheEntry(cacheKey, keys);
         return keys;
     }
-    async generateIndexMac(indexKey, indexBytes) {
-        const key = await (0, primitives_1.importHmacKey)(indexKey);
-        return (0, primitives_1.hmacSign)(key, indexBytes);
+    async generateIndexMac(indexHmacKey, indexBytes) {
+        return (0, primitives_1.hmacSign)(indexHmacKey, indexBytes);
     }
     async encryptMutation(args) {
         const derivedKeys = await this.deriveKeys(args.keyData);
-        const indexBytes = bytes_2.TEXT_ENCODER.encode(args.index);
+        const indexBytes = bytes_1.TEXT_ENCODER.encode(args.index);
         const encoded = _proto_1.proto.SyncActionData.encode({
             index: indexBytes,
             value: args.value ?? undefined,
-            padding: bytes_2.EMPTY_BYTES,
+            padding: bytes_1.EMPTY_BYTES,
             version: args.version
         }).finish();
         const iv = args.iv ?? (await (0, random_1.randomBytesAsync)(constants_1.APP_STATE_IV_LENGTH));
         if (iv.byteLength !== constants_1.APP_STATE_IV_LENGTH) {
             throw new Error(`invalid IV length ${iv.byteLength}`);
         }
-        const indexMacPromise = this.generateIndexMac(derivedKeys.indexKey, indexBytes);
-        const encryptionKey = await (0, primitives_1.importAesCbcKey)(derivedKeys.valueEncryptionKey);
-        const cipherText = await (0, primitives_1.aesCbcEncrypt)(encryptionKey, iv, encoded);
-        const cipherWithIv = (0, bytes_2.concatBytes)([iv, cipherText]);
+        const indexMacPromise = this.generateIndexMac(derivedKeys.indexHmacKey, indexBytes);
+        const cipherText = await (0, primitives_1.aesCbcEncrypt)(derivedKeys.valueEncryptionAesKey, iv, encoded);
+        const cipherWithIv = (0, bytes_1.concatBytes)([iv, cipherText]);
         const associatedData = this.generateAssociatedData(args.operation, args.keyId);
         const [valueMac, indexMac] = await Promise.all([
-            this.generateValueMac(derivedKeys.valueMacKey, associatedData, cipherWithIv),
+            this.generateValueMac(derivedKeys.valueMacHmacKey, associatedData, cipherWithIv),
             indexMacPromise
         ]);
         return {
             indexMac,
-            valueBlob: (0, bytes_2.concatBytes)([cipherWithIv, valueMac]),
+            valueBlob: (0, bytes_1.concatBytes)([cipherWithIv, valueMac]),
             valueMac
         };
     }
@@ -79,13 +87,14 @@ class WaAppStateCrypto {
         const mac = args.valueBlob.subarray(args.valueBlob.byteLength - constants_1.APP_STATE_VALUE_MAC_LENGTH);
         const cipherText = args.valueBlob.subarray(constants_1.APP_STATE_IV_LENGTH, args.valueBlob.byteLength - constants_1.APP_STATE_VALUE_MAC_LENGTH);
         const cipherWithIv = args.valueBlob.subarray(0, args.valueBlob.byteLength - constants_1.APP_STATE_VALUE_MAC_LENGTH);
-        const associatedData = this.generateAssociatedData(args.operation, args.keyId);
-        const expectedMac = await this.generateValueMac(derivedKeys.valueMacKey, associatedData, cipherWithIv);
-        if (!(0, bytes_2.uint8Equal)(mac, expectedMac)) {
-            throw new Error('mutation value MAC mismatch');
+        if (!this.skipMacVerification) {
+            const associatedData = this.generateAssociatedData(args.operation, args.keyId);
+            const expectedMac = await this.generateValueMac(derivedKeys.valueMacHmacKey, associatedData, cipherWithIv);
+            if (!(0, bytes_1.uint8TimingSafeEqual)(mac, expectedMac)) {
+                throw new Error('mutation value MAC mismatch');
+            }
         }
-        const decryptionKey = await (0, primitives_1.importAesCbcKey)(derivedKeys.valueEncryptionKey);
-        const plaintext = await (0, primitives_1.aesCbcDecrypt)(decryptionKey, iv, cipherText);
+        const plaintext = await (0, primitives_1.aesCbcDecrypt)(derivedKeys.valueEncryptionAesKey, iv, cipherText);
         const syncActionData = _proto_1.proto.SyncActionData.decode(plaintext);
         if (!syncActionData.index) {
             throw new Error('missing sync action index');
@@ -93,12 +102,14 @@ class WaAppStateCrypto {
         if (syncActionData.version === null || syncActionData.version === undefined) {
             throw new Error('missing sync action version');
         }
-        const generatedIndexMac = await this.generateIndexMac(derivedKeys.indexKey, syncActionData.index);
-        if (!(0, bytes_2.uint8Equal)(generatedIndexMac, args.indexMac)) {
-            throw new Error('mutation index MAC mismatch');
+        if (!this.skipMacVerification) {
+            const generatedIndexMac = await this.generateIndexMac(derivedKeys.indexHmacKey, syncActionData.index);
+            if (!(0, bytes_1.uint8TimingSafeEqual)(generatedIndexMac, args.indexMac)) {
+                throw new Error('mutation index MAC mismatch');
+            }
         }
         return {
-            index: bytes_2.TEXT_DECODER.decode(syncActionData.index),
+            index: bytes_1.TEXT_DECODER.decode(syncActionData.index),
             value: syncActionData.value ?? null,
             version: syncActionData.version,
             indexMac: args.indexMac,
@@ -107,24 +118,22 @@ class WaAppStateCrypto {
     }
     async generateSnapshotMac(keyData, ltHash, version, collectionName) {
         const derivedKeys = await this.deriveKeys(keyData);
-        const payload = (0, bytes_2.concatBytes)([
+        const payload = (0, bytes_1.concatBytes)([
             ltHash,
-            (0, bytes_2.intToBytes)(8, version),
-            bytes_2.TEXT_ENCODER.encode(collectionName)
+            (0, bytes_1.intToBytes)(8, version),
+            bytes_1.TEXT_ENCODER.encode(collectionName)
         ]);
-        const key = await (0, primitives_1.importHmacKey)(derivedKeys.snapshotMacKey);
-        return (0, primitives_1.hmacSign)(key, payload);
+        return (0, primitives_1.hmacSign)(derivedKeys.snapshotMacHmacKey, payload);
     }
     async generatePatchMac(keyData, snapshotMac, valueMacs, version, collectionName) {
         const derivedKeys = await this.deriveKeys(keyData);
-        const payload = (0, bytes_2.concatBytes)([
+        const payload = (0, bytes_1.concatBytes)([
             snapshotMac,
             ...valueMacs,
-            (0, bytes_2.intToBytes)(8, version),
-            bytes_2.TEXT_ENCODER.encode(collectionName)
+            (0, bytes_1.intToBytes)(8, version),
+            bytes_1.TEXT_ENCODER.encode(collectionName)
         ]);
-        const key = await (0, primitives_1.importHmacKey)(derivedKeys.patchMacKey);
-        return (0, primitives_1.hmacSign)(key, payload);
+        return (0, primitives_1.hmacSign)(derivedKeys.patchMacHmacKey, payload);
     }
     async ltHashAdd(base, addValues) {
         return this.ltHashApply(base, addValues, (left, right) => left + right);
@@ -178,12 +187,11 @@ class WaAppStateCrypto {
         out.set(keyId, 1);
         return out;
     }
-    async generateValueMac(valueMacKey, associatedData, cipherWithIv) {
+    async generateValueMac(valueMacHmacKey, associatedData, cipherWithIv) {
         const octetLength = new Uint8Array(constants_1.APP_STATE_MAC_OCTET_LENGTH);
         octetLength[octetLength.length - 1] = associatedData.byteLength & 0xff;
-        const key = await (0, primitives_1.importHmacSha512Key)(valueMacKey);
-        const full = await (0, primitives_1.hmacSign)(key, (0, bytes_2.concatBytes)([associatedData, cipherWithIv, octetLength]));
-        return full.slice(0, constants_1.APP_STATE_VALUE_MAC_LENGTH);
+        const full = await (0, primitives_1.hmacSign)(valueMacHmacKey, (0, bytes_1.concatBytes)([associatedData, cipherWithIv, octetLength]));
+        return full.subarray(0, constants_1.APP_STATE_VALUE_MAC_LENGTH);
     }
     touchDerivedKeysCacheEntry(cacheKey, keys) {
         if (this.derivedKeysCacheMaxSize <= 0) {