@genuxofficial/baileys 1.0.0

package/lib/Utils/crypto.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { KeyPair } from '../Types';
+/** prefix version byte to the pub keys, required for some curve crypto functions */
+export declare const generateSignalPubKey: (pubKey: Uint8Array | Buffer) => Uint8Array | Buffer;
+export declare const Curve: {
+    generateKeyPair: () => KeyPair;
+    sharedKey: (privateKey: Uint8Array, publicKey: Uint8Array) => Buffer;
+    sign: (privateKey: Uint8Array, buf: Uint8Array) => any;
+    verify: (pubKey: Uint8Array, message: Uint8Array, signature: Uint8Array) => boolean;
+};
+export declare const signedKeyPair: (identityKeyPair: KeyPair, keyId: number) => {
+    keyPair: KeyPair;
+    signature: any;
+    keyId: number;
+};
+/**
+ * encrypt AES 256 GCM;
+ * where the tag tag is suffixed to the ciphertext
+ * */
+export declare function aesEncryptGCM(plaintext: Uint8Array, key: Uint8Array, iv: Uint8Array, additionalData: Uint8Array): Buffer;
+/**
+ * decrypt AES 256 GCM;
+ * where the auth tag is suffixed to the ciphertext
+ * */
+export declare function aesDecryptGCM(ciphertext: Uint8Array, key: Uint8Array, iv: Uint8Array, additionalData: Uint8Array): Buffer;
+export declare function aesEncryptCTR(plaintext: Uint8Array, key: Uint8Array, iv: Uint8Array): Buffer;
+export declare function aesDecryptCTR(ciphertext: Uint8Array, key: Uint8Array, iv: Uint8Array): Buffer;
+/** decrypt AES 256 CBC; where the IV is prefixed to the buffer */
+export declare function aesDecrypt(buffer: Buffer, key: Buffer): Buffer;
+/** decrypt AES 256 CBC */
+export declare function aesDecryptWithIV(buffer: Buffer, key: Buffer, IV: Buffer): Buffer;
+export declare function aesEncrypt(buffer: Buffer | Uint8Array, key: Buffer): Buffer;
+export declare function aesEncrypWithIV(buffer: Buffer, key: Buffer, IV: Buffer): Buffer;
+export declare function hmacSign(buffer: Buffer | Uint8Array, key: Buffer | Uint8Array, variant?: 'sha256' | 'sha512'): Buffer;
+export declare function sha256(buffer: Buffer): Buffer;
+export declare function md5(buffer: Buffer): Buffer;
+export declare function hkdf(buffer: Uint8Array | Buffer, expandedLength: number, info: {
+    salt?: Buffer;
+    info?: string;
+}): Promise<Buffer>;
+export declare function derivePairingCodeKey(pairingCode: string, salt: Buffer): Promise<Buffer>;

package/lib/Utils/crypto.js

@@ -0,0 +1,181 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.derivePairingCodeKey = exports.hkdf = exports.md5 = exports.sha256 = exports.hmacSign = exports.aesEncrypWithIV = exports.aesEncrypt = exports.aesDecryptWithIV = exports.aesDecrypt = exports.aesDecryptCTR = exports.aesEncryptCTR = exports.aesDecryptGCM = exports.aesEncryptGCM = exports.signedKeyPair = exports.Curve = exports.generateSignalPubKey = void 0;
+const crypto_1 = require("crypto");
+const libsignal = __importStar(require("libsignal"));
+const Defaults_1 = require("../Defaults");
+/** prefix version byte to the pub keys, required for some curve crypto functions */
+const generateSignalPubKey = (pubKey) => (pubKey.length === 33
+    ? pubKey
+    : Buffer.concat([Defaults_1.KEY_BUNDLE_TYPE, pubKey]));
+exports.generateSignalPubKey = generateSignalPubKey;
+exports.Curve = {
+    generateKeyPair: () => {
+        const { pubKey, privKey } = libsignal.curve.generateKeyPair();
+        return {
+            private: Buffer.from(privKey),
+            // remove version byte
+            public: Buffer.from(pubKey.slice(1))
+        };
+    },
+    sharedKey: (privateKey, publicKey) => {
+        const shared = libsignal.curve.calculateAgreement((0, exports.generateSignalPubKey)(publicKey), privateKey);
+        return Buffer.from(shared);
+    },
+    sign: (privateKey, buf) => (libsignal.curve.calculateSignature(privateKey, buf)),
+    verify: (pubKey, message, signature) => {
+        try {
+            libsignal.curve.verifySignature((0, exports.generateSignalPubKey)(pubKey), message, signature);
+            return true;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+};
+const signedKeyPair = (identityKeyPair, keyId) => {
+    const preKey = exports.Curve.generateKeyPair();
+    const pubKey = (0, exports.generateSignalPubKey)(preKey.public);
+    const signature = exports.Curve.sign(identityKeyPair.private, pubKey);
+    return { keyPair: preKey, signature, keyId };
+};
+exports.signedKeyPair = signedKeyPair;
+const GCM_TAG_LENGTH = 128 >> 3;
+/**
+ * encrypt AES 256 GCM;
+ * where the tag tag is suffixed to the ciphertext
+ * */
+function aesEncryptGCM(plaintext, key, iv, additionalData) {
+    const cipher = (0, crypto_1.createCipheriv)('aes-256-gcm', key, iv);
+    cipher.setAAD(additionalData);
+    return Buffer.concat([cipher.update(plaintext), cipher.final(), cipher.getAuthTag()]);
+}
+exports.aesEncryptGCM = aesEncryptGCM;
+/**
+ * decrypt AES 256 GCM;
+ * where the auth tag is suffixed to the ciphertext
+ * */
+function aesDecryptGCM(ciphertext, key, iv, additionalData) {
+    const decipher = (0, crypto_1.createDecipheriv)('aes-256-gcm', key, iv);
+    // decrypt additional adata
+    const enc = ciphertext.slice(0, ciphertext.length - GCM_TAG_LENGTH);
+    const tag = ciphertext.slice(ciphertext.length - GCM_TAG_LENGTH);
+    // set additional data
+    decipher.setAAD(additionalData);
+    decipher.setAuthTag(tag);
+    return Buffer.concat([decipher.update(enc), decipher.final()]);
+}
+exports.aesDecryptGCM = aesDecryptGCM;
+function aesEncryptCTR(plaintext, key, iv) {
+    const cipher = (0, crypto_1.createCipheriv)('aes-256-ctr', key, iv);
+    return Buffer.concat([cipher.update(plaintext), cipher.final()]);
+}
+exports.aesEncryptCTR = aesEncryptCTR;
+function aesDecryptCTR(ciphertext, key, iv) {
+    const decipher = (0, crypto_1.createDecipheriv)('aes-256-ctr', key, iv);
+    return Buffer.concat([decipher.update(ciphertext), decipher.final()]);
+}
+exports.aesDecryptCTR = aesDecryptCTR;
+/** decrypt AES 256 CBC; where the IV is prefixed to the buffer */
+function aesDecrypt(buffer, key) {
+    return aesDecryptWithIV(buffer.slice(16, buffer.length), key, buffer.slice(0, 16));
+}
+exports.aesDecrypt = aesDecrypt;
+/** decrypt AES 256 CBC */
+function aesDecryptWithIV(buffer, key, IV) {
+    const aes = (0, crypto_1.createDecipheriv)('aes-256-cbc', key, IV);
+    return Buffer.concat([aes.update(buffer), aes.final()]);
+}
+exports.aesDecryptWithIV = aesDecryptWithIV;
+// encrypt AES 256 CBC; where a random IV is prefixed to the buffer
+function aesEncrypt(buffer, key) {
+    const IV = (0, crypto_1.randomBytes)(16);
+    const aes = (0, crypto_1.createCipheriv)('aes-256-cbc', key, IV);
+    return Buffer.concat([IV, aes.update(buffer), aes.final()]); // prefix IV to the buffer
+}
+exports.aesEncrypt = aesEncrypt;
+// encrypt AES 256 CBC with a given IV
+function aesEncrypWithIV(buffer, key, IV) {
+    const aes = (0, crypto_1.createCipheriv)('aes-256-cbc', key, IV);
+    return Buffer.concat([aes.update(buffer), aes.final()]); // prefix IV to the buffer
+}
+exports.aesEncrypWithIV = aesEncrypWithIV;
+// sign HMAC using SHA 256
+function hmacSign(buffer, key, variant = 'sha256') {
+    return (0, crypto_1.createHmac)(variant, key).update(buffer).digest();
+}
+exports.hmacSign = hmacSign;
+function sha256(buffer) {
+    return (0, crypto_1.createHash)('sha256').update(buffer).digest();
+}
+exports.sha256 = sha256;
+function md5(buffer) {
+    return (0, crypto_1.createHash)('md5').update(buffer).digest();
+}
+exports.md5 = md5;
+// HKDF key expansion
+async function hkdf(buffer, expandedLength, info) {
+    // Ensure we have a Uint8Array for the key material
+    const inputKeyMaterial = buffer instanceof Uint8Array
+        ? buffer
+        : new Uint8Array(buffer);
+    // Set default values if not provided
+    const salt = info.salt ? new Uint8Array(info.salt) : new Uint8Array(0);
+    const infoBytes = info.info
+        ? new TextEncoder().encode(info.info)
+        : new Uint8Array(0);
+    // Import the input key material
+    const importedKey = await crypto.subtle.importKey('raw', inputKeyMaterial, { name: 'HKDF' }, false, ['deriveBits']);
+    // Derive bits using HKDF
+    const derivedBits = await crypto.subtle.deriveBits({
+        name: 'HKDF',
+        hash: 'SHA-256',
+        salt: salt,
+        info: infoBytes
+    }, importedKey, expandedLength * 8 // Convert bytes to bits
+    );
+    return Buffer.from(derivedBits);
+}
+exports.hkdf = hkdf;
+async function derivePairingCodeKey(pairingCode, salt) {
+    // Convert inputs to formats Web Crypto API can work with
+    const encoder = new TextEncoder();
+    const pairingCodeBuffer = encoder.encode(pairingCode);
+    const saltBuffer = salt instanceof Uint8Array ? salt : new Uint8Array(salt);
+    // Import the pairing code as key material
+    const keyMaterial = await crypto.subtle.importKey('raw', pairingCodeBuffer, { name: 'PBKDF2' }, false, ['deriveBits']);
+    // Derive bits using PBKDF2 with the same parameters
+    // 2 << 16 = 131,072 iterations
+    const derivedBits = await crypto.subtle.deriveBits({
+        name: 'PBKDF2',
+        salt: saltBuffer,
+        iterations: 2 << 16,
+        hash: 'SHA-256'
+    }, keyMaterial, 32 * 8 // 32 bytes * 8 = 256 bits
+    );
+    return Buffer.from(derivedBits);
+}
+exports.derivePairingCodeKey = derivePairingCodeKey;

package/lib/Utils/decode-wa-message.d.ts

@@ -0,0 +1,36 @@
+import { proto } from '../../WAProto';
+import { SignalRepository } from '../Types';
+import { BinaryNode } from '../WABinary';
+import { ILogger } from './logger';
+export declare const NO_MESSAGE_FOUND_ERROR_TEXT = "Message absent from node";
+export declare const MISSING_KEYS_ERROR_TEXT = "Key used already or never filled";
+export declare const NACK_REASONS: {
+    ParsingError: number;
+    UnrecognizedStanza: number;
+    UnrecognizedStanzaClass: number;
+    UnrecognizedStanzaType: number;
+    InvalidProtobuf: number;
+    InvalidHostedCompanionStanza: number;
+    MissingMessageSecret: number;
+    SignalErrorOldCounter: number;
+    MessageDeletedOnPeer: number;
+    UnhandledError: number;
+    UnsupportedAdminRevoke: number;
+    UnsupportedLIDGroup: number;
+    DBOperationFailed: number;
+};
+/**
+ * Decode the received node as a message.
+ * @note this will only parse the message, not decrypt it
+ */
+export declare function decodeMessageNode(stanza: BinaryNode, meId: string, meLid: string): {
+    fullMessage: proto.IWebMessageInfo;
+    author: string;
+    sender: string;
+};
+export declare const decryptMessageNode: (stanza: BinaryNode, meId: string, meLid: string, repository: SignalRepository, logger: ILogger) => {
+    fullMessage: proto.IWebMessageInfo;
+    category: string;
+    author: string;
+    decrypt(): Promise<void>;
+};

package/lib/Utils/decode-wa-message.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decryptMessageNode = exports.decodeMessageNode = exports.NACK_REASONS = exports.MISSING_KEYS_ERROR_TEXT = exports.NO_MESSAGE_FOUND_ERROR_TEXT = void 0;
+const boom_1 = require("@hapi/boom");
+const WAProto_1 = require("../../WAProto");
+const WABinary_1 = require("../WABinary");
+const generics_1 = require("./generics");
+exports.NO_MESSAGE_FOUND_ERROR_TEXT = 'Message absent from node';
+exports.MISSING_KEYS_ERROR_TEXT = 'Key used already or never filled';
+exports.NACK_REASONS = {
+    ParsingError: 487,
+    UnrecognizedStanza: 488,
+    UnrecognizedStanzaClass: 489,
+    UnrecognizedStanzaType: 490,
+    InvalidProtobuf: 491,
+    InvalidHostedCompanionStanza: 493,
+    MissingMessageSecret: 495,
+    SignalErrorOldCounter: 496,
+    MessageDeletedOnPeer: 499,
+    UnhandledError: 500,
+    UnsupportedAdminRevoke: 550,
+    UnsupportedLIDGroup: 551,
+    DBOperationFailed: 552
+};
+/**
+ * Decode the received node as a message.
+ * @note this will only parse the message, not decrypt it
+ */
+function decodeMessageNode(stanza, meId, meLid) {
+    var _a;
+    let msgType;
+    let chatId;
+    let author;
+    const msgId = stanza.attrs.id;
+    const from = stanza.attrs.from;
+    const participant = stanza.attrs.participant;
+    const recipient = stanza.attrs.recipient;
+    const isMe = (jid) => (0, WABinary_1.areJidsSameUser)(jid, meId);
+    const isMeLid = (jid) => (0, WABinary_1.areJidsSameUser)(jid, meLid);
+    if ((0, WABinary_1.isJidUser)(from)) {
+        if (recipient) {
+            if (!isMe(from)) {
+                throw new boom_1.Boom('receipient present, but msg not from me', { data: stanza });
+            }
+            chatId = recipient;
+        }
+        else {
+            chatId = from;
+        }
+        msgType = 'chat';
+        author = from;
+    }
+    else if ((0, WABinary_1.isLidUser)(from)) {
+        if (recipient) {
+            if (!isMeLid(from)) {
+                throw new boom_1.Boom('receipient present, but msg not from me', { data: stanza });
+            }
+            chatId = recipient;
+        }
+        else {
+            chatId = from;
+        }
+        msgType = 'chat';
+        author = from;
+    }
+    else if ((0, WABinary_1.isJidGroup)(from)) {
+        if (!participant) {
+            throw new boom_1.Boom('No participant in group message');
+        }
+        msgType = 'group';
+        author = participant;
+        chatId = from;
+    }
+    else if ((0, WABinary_1.isJidBroadcast)(from)) {
+        if (!participant) {
+            throw new boom_1.Boom('No participant in group message');
+        }
+        const isParticipantMe = isMe(participant);
+        if ((0, WABinary_1.isJidStatusBroadcast)(from)) {
+            msgType = isParticipantMe ? 'direct_peer_status' : 'other_status';
+        }
+        else {
+            msgType = isParticipantMe ? 'peer_broadcast' : 'other_broadcast';
+        }
+        chatId = from;
+        author = participant;
+    }
+    else if ((0, WABinary_1.isJidNewsletter)(from)) {
+        msgType = 'newsletter';
+        chatId = from;
+        author = from;
+    }
+    else {
+        throw new boom_1.Boom('Unknown message type', { data: stanza });
+    }
+    const fromMe = ((0, WABinary_1.isLidUser)(from) ? isMeLid : isMe)(stanza.attrs.participant || stanza.attrs.from);
+    const pushname = (_a = stanza === null || stanza === void 0 ? void 0 : stanza.attrs) === null || _a === void 0 ? void 0 : _a.notify;
+    const key = {
+        remoteJid: chatId,
+        fromMe,
+        id: msgId,
+        participant
+    };
+    const fullMessage = {
+        key,
+        messageTimestamp: +stanza.attrs.t,
+        pushName: pushname,
+        broadcast: (0, WABinary_1.isJidBroadcast)(from)
+    };
+    if (key.fromMe) {
+        fullMessage.status = WAProto_1.proto.WebMessageInfo.Status.SERVER_ACK;
+    }
+    return {
+        fullMessage,
+        author,
+        sender: msgType === 'chat' ? author : chatId
+    };
+}
+exports.decodeMessageNode = decodeMessageNode;
+const decryptMessageNode = (stanza, meId, meLid, repository, logger) => {
+    const { fullMessage, author, sender } = decodeMessageNode(stanza, meId, meLid);
+    return {
+        fullMessage,
+        category: stanza.attrs.category,
+        author,
+        async decrypt() {
+            var _a;
+            let decryptables = 0;
+            if (Array.isArray(stanza.content)) {
+                for (const { tag, attrs, content } of stanza.content) {
+                    if (tag === 'verified_name' && content instanceof Uint8Array) {
+                        const cert = WAProto_1.proto.VerifiedNameCertificate.decode(content);
+                        const details = WAProto_1.proto.VerifiedNameCertificate.Details.decode(cert.details);
+                        fullMessage.verifiedBizName = details.verifiedName;
+                    }
+                    if (tag !== 'enc' && tag !== 'plaintext') {
+                        continue;
+                    }
+                    if (!(content instanceof Uint8Array)) {
+                        continue;
+                    }
+                    decryptables += 1;
+                    let msgBuffer;
+                    try {
+                        const e2eType = tag === 'plaintext' ? 'plaintext' : attrs.type;
+                        switch (e2eType) {
+                            case 'skmsg':
+                                msgBuffer = await repository.decryptGroupMessage({
+                                    group: sender,
+                                    authorJid: author,
+                                    msg: content
+                                });
+                                break;
+                            case 'pkmsg':
+                            case 'msg':
+                                const user = (0, WABinary_1.isJidUser)(sender) ? sender : author;
+                                msgBuffer = await repository.decryptMessage({
+                                    jid: user,
+                                    type: e2eType,
+                                    ciphertext: content
+                                });
+                                break;
+                            case 'plaintext':
+                                msgBuffer = content;
+                                break;
+                            default:
+                                throw new Error(`Unknown e2e type: ${e2eType}`);
+                        }
+                        let msg = WAProto_1.proto.Message.decode(e2eType !== 'plaintext' ? (0, generics_1.unpadRandomMax16)(msgBuffer) : msgBuffer);
+                        msg = ((_a = msg.deviceSentMessage) === null || _a === void 0 ? void 0 : _a.message) || msg;
+                        if (msg.senderKeyDistributionMessage) {
+                            //eslint-disable-next-line max-depth
+                            try {
+                                await repository.processSenderKeyDistributionMessage({
+                                    authorJid: author,
+                                    item: msg.senderKeyDistributionMessage
+                                });
+                            }
+                            catch (err) {
+                                logger.error({ key: fullMessage.key, err }, 'failed to decrypt message');
+                            }
+                        }
+                        if (fullMessage.message) {
+                            Object.assign(fullMessage.message, msg);
+                        }
+                        else {
+                            fullMessage.message = msg;
+                        }
+                    }
+                    catch (err) {
+                        logger.error({ key: fullMessage.key, err }, 'failed to decrypt message');
+                        fullMessage.messageStubType = WAProto_1.proto.WebMessageInfo.StubType.CIPHERTEXT;
+                        fullMessage.messageStubParameters = [err.message];
+                    }
+                }
+            }
+            // if nothing was found to decrypt
+            if (!decryptables) {
+                fullMessage.messageStubType = WAProto_1.proto.WebMessageInfo.StubType.CIPHERTEXT;
+                fullMessage.messageStubParameters = [exports.NO_MESSAGE_FOUND_ERROR_TEXT];
+            }
+        }
+    };
+};
+exports.decryptMessageNode = decryptMessageNode;

package/lib/Utils/event-buffer.d.ts

@@ -0,0 +1,35 @@
+import { BaileysEventEmitter, BaileysEventMap } from '../Types';
+import { ILogger } from './logger';
+/**
+ * A map that contains a list of all events that have been triggered
+ *
+ * Note, this can contain different type of events
+ * this can make processing events extremely efficient -- since everything
+ * can be done in a single transaction
+ */
+type BaileysEventData = Partial<BaileysEventMap>;
+type BaileysBufferableEventEmitter = BaileysEventEmitter & {
+    /** Use to process events in a batch */
+    process(handler: (events: BaileysEventData) => void | Promise<void>): (() => void);
+    /**
+     * starts buffering events, call flush() to release them
+     * */
+    buffer(): void;
+    /** buffers all events till the promise completes */
+    createBufferedFunction<A extends any[], T>(work: (...args: A) => Promise<T>): ((...args: A) => Promise<T>);
+    /**
+     * flushes all buffered events
+     * @param force if true, will flush all data regardless of any pending buffers
+     * @returns returns true if the flush actually happened, otherwise false
+     */
+    flush(force?: boolean): boolean;
+    /** is there an ongoing buffer */
+    isBuffering(): boolean;
+};
+/**
+ * The event buffer logically consolidates different events into a single event
+ * making the data processing more efficient.
+ * @param ev the baileys event emitter
+ */
+export declare const makeEventBuffer: (logger: ILogger) => BaileysBufferableEventEmitter;
+export {};