ruby-baileys 0.0.0-stage → 1.5.17

package/src/Utils/noise-handler.js

@@ -0,0 +1,201 @@
+/* Elaina Baileys maintained distribution. Upstream notices and license are preserved in LICENSE and NOTICE.md. */
+import { Boom } from '@hapi/boom';
+import { proto } from '../../WAProto/index.js';
+import { NOISE_MODE, WA_CERT_DETAILS } from '../Defaults/index.js';
+import { decodeBinaryNode } from '../WABinary/index.js';
+import { aesDecryptGCM, aesEncryptGCM, Curve, hkdf, sha256 } from './crypto.js';
+const IV_LENGTH = 12;
+const EMPTY_BUFFER = Buffer.alloc(0);
+const generateIV = (counter) => {
+    const iv = new ArrayBuffer(IV_LENGTH);
+    new DataView(iv).setUint32(8, counter);
+    return new Uint8Array(iv);
+};
+class TransportState {
+    constructor(encKey, decKey) {
+        this.encKey = encKey;
+        this.decKey = decKey;
+        this.readCounter = 0;
+        this.writeCounter = 0;
+        this.iv = new Uint8Array(IV_LENGTH);
+    }
+    encrypt(plaintext) {
+        const c = this.writeCounter++;
+        this.iv[8] = (c >>> 24) & 0xff;
+        this.iv[9] = (c >>> 16) & 0xff;
+        this.iv[10] = (c >>> 8) & 0xff;
+        this.iv[11] = c & 0xff;
+        return aesEncryptGCM(plaintext, this.encKey, this.iv, EMPTY_BUFFER);
+    }
+    decrypt(ciphertext) {
+        const c = this.readCounter++;
+        this.iv[8] = (c >>> 24) & 0xff;
+        this.iv[9] = (c >>> 16) & 0xff;
+        this.iv[10] = (c >>> 8) & 0xff;
+        this.iv[11] = c & 0xff;
+        return aesDecryptGCM(ciphertext, this.decKey, this.iv, EMPTY_BUFFER);
+    }
+}
+export const makeNoiseHandler = ({ keyPair: { private: privateKey, public: publicKey }, NOISE_HEADER, logger, routingInfo }) => {
+    logger = logger.child({ class: 'ns' });
+    const data = Buffer.from(NOISE_MODE);
+    let hash = data.byteLength === 32 ? data : sha256(data);
+    let salt = hash;
+    let encKey = hash;
+    let decKey = hash;
+    let counter = 0;
+    let sentIntro = false;
+    let inBytes = Buffer.alloc(0);
+    let transport = null;
+    let isWaitingForTransport = false;
+    let pendingOnFrame = null;
+    let introHeader;
+    if (routingInfo) {
+        introHeader = Buffer.alloc(7 + routingInfo.byteLength + NOISE_HEADER.length);
+        introHeader.write('ED', 0, 'utf8');
+        introHeader.writeUint8(0, 2);
+        introHeader.writeUint8(1, 3);
+        introHeader.writeUint8(routingInfo.byteLength >> 16, 4);
+        introHeader.writeUint16BE(routingInfo.byteLength & 65535, 5);
+        introHeader.set(routingInfo, 7);
+        introHeader.set(NOISE_HEADER, 7 + routingInfo.byteLength);
+    }
+    else {
+        introHeader = Buffer.from(NOISE_HEADER);
+    }
+    const authenticate = (data) => {
+        if (!transport) {
+            hash = sha256(Buffer.concat([hash, data]));
+        }
+    };
+    const encrypt = (plaintext) => {
+        if (transport) {
+            return transport.encrypt(plaintext);
+        }
+        const result = aesEncryptGCM(plaintext, encKey, generateIV(counter++), hash);
+        authenticate(result);
+        return result;
+    };
+    const decrypt = (ciphertext) => {
+        if (transport) {
+            return transport.decrypt(ciphertext);
+        }
+        const result = aesDecryptGCM(ciphertext, decKey, generateIV(counter++), hash);
+        authenticate(ciphertext);
+        return result;
+    };
+    const localHKDF = (data) => {
+        const key = hkdf(Buffer.from(data), 64, { salt, info: '' });
+        return [key.subarray(0, 32), key.subarray(32)];
+    };
+    const mixIntoKey = (data) => {
+        const [write, read] = localHKDF(data);
+        salt = write;
+        encKey = read;
+        decKey = read;
+        counter = 0;
+    };
+    const finishInit = async () => {
+        isWaitingForTransport = true;
+        const [write, read] = localHKDF(new Uint8Array(0));
+        transport = new TransportState(write, read);
+        isWaitingForTransport = false;
+        logger.trace('Noise handler transitioned to Transport state');
+        if (pendingOnFrame) {
+            logger.trace({ length: inBytes.length }, 'Flushing buffered frames after transport ready');
+            await processData(pendingOnFrame);
+            pendingOnFrame = null;
+        }
+    };
+    const processData = async (onFrame) => {
+        let size;
+        while (true) {
+            if (inBytes.length < 3)
+                return;
+            size = (inBytes[0] << 16) | (inBytes[1] << 8) | inBytes[2];
+            if (inBytes.length < size + 3)
+                return;
+            let frame = inBytes.subarray(3, size + 3);
+            inBytes = inBytes.subarray(size + 3);
+            if (transport) {
+                const result = transport.decrypt(frame);
+                frame = await decodeBinaryNode(result);
+            }
+            if (logger.level === 'trace') {
+                logger.trace({ msg: frame?.attrs?.id }, 'recv frame');
+            }
+            onFrame(frame);
+        }
+    };
+    authenticate(NOISE_HEADER);
+    authenticate(publicKey);
+    return {
+        encrypt,
+        decrypt,
+        authenticate,
+        mixIntoKey,
+        finishInit,
+        processHandshake: ({ serverHello }, noiseKey) => {
+            authenticate(serverHello.ephemeral);
+            mixIntoKey(Curve.sharedKey(privateKey, serverHello.ephemeral));
+            const decStaticContent = decrypt(serverHello.static);
+            mixIntoKey(Curve.sharedKey(privateKey, decStaticContent));
+            const certDecoded = decrypt(serverHello.payload);
+            const { intermediate: certIntermediate, leaf } = proto.CertChain.decode(certDecoded);
+
+            if (!leaf?.details || !leaf?.signature) {
+                throw new Boom('invalid noise leaf certificate', { statusCode: 400 });
+            }
+            if (!certIntermediate?.details || !certIntermediate?.signature) {
+                throw new Boom('invalid noise intermediate certificate', { statusCode: 400 });
+            }
+            const details = proto.CertChain.NoiseCertificate.Details.decode(certIntermediate.details);
+            const { issuerSerial } = details;
+            const verify = Curve.verify(details.key, leaf.details, leaf.signature);
+            const verifyIntermediate = Curve.verify(WA_CERT_DETAILS.PUBLIC_KEY, certIntermediate.details, certIntermediate.signature);
+            if (!verify) {
+                throw new Boom('noise certificate signature invalid', { statusCode: 400 });
+            }
+            if (!verifyIntermediate) {
+                throw new Boom('noise intermediate certificate signature invalid', { statusCode: 400 });
+            }
+            if (issuerSerial !== WA_CERT_DETAILS.SERIAL) {
+                throw new Boom('certification match failed', { statusCode: 400 });
+            }
+            const keyEnc = encrypt(noiseKey.public);
+            mixIntoKey(Curve.sharedKey(noiseKey.private, serverHello.ephemeral));
+            return keyEnc;
+        },
+        encodeFrame: (data) => {
+            if (transport) {
+                data = transport.encrypt(data);
+            }
+            const dataLen = data.byteLength;
+            const introSize = sentIntro ? 0 : introHeader.length;
+            const frame = Buffer.allocUnsafe(introSize + 3 + dataLen);
+            if (!sentIntro) {
+                frame.set(introHeader);
+                sentIntro = true;
+            }
+            frame[introSize] = (dataLen >>> 16) & 0xff;
+            frame[introSize + 1] = (dataLen >>> 8) & 0xff;
+            frame[introSize + 2] = dataLen & 0xff;
+            frame.set(data, introSize + 3);
+            return frame;
+        },
+        decodeFrame: async (newData, onFrame) => {
+            if (isWaitingForTransport) {
+                inBytes = Buffer.concat([inBytes, newData]);
+                pendingOnFrame = onFrame;
+                return;
+            }
+            if (inBytes.length === 0) {
+                inBytes = Buffer.from(newData);
+            }
+            else {
+                inBytes = Buffer.concat([inBytes, newData]);
+            }
+            await processData(onFrame);
+        }
+    };
+};

package/src/Utils/offline-node-processor.d.ts

@@ -0,0 +1,10 @@
+/* Elaina Baileys maintained distribution. Upstream notices and license are preserved in LICENSE and NOTICE.md. */
+/**
+ * Creates a processor for offline stanza nodes that:
+ * - Queues nodes for sequential processing
+ * - Yields to the event loop periodically to avoid blocking
+ * - Catches handler errors to prevent the processing loop from crashing
+ */
+export function makeOfflineNodeProcessor(nodeProcessorMap: any, deps: any, batchSize?: number): {
+    enqueue: (type: any, node: any) => void;
+};

package/src/Utils/offline-node-processor.js

@@ -0,0 +1,34 @@
+/* Elaina Baileys maintained distribution. Upstream notices and license are preserved in LICENSE and NOTICE.md. */
+
+export function makeOfflineNodeProcessor(nodeProcessorMap, deps, batchSize = 10) {
+    const nodes = [];
+    let isProcessing = false;
+    const enqueue = (type, node) => {
+        nodes.push({ type, node });
+        if (isProcessing) {
+            return;
+        }
+        isProcessing = true;
+        const promise = async () => {
+            let processedInBatch = 0;
+            while (nodes.length && deps.isWsOpen()) {
+                const { type, node } = nodes.shift();
+                const nodeProcessor = nodeProcessorMap.get(type);
+                if (!nodeProcessor) {
+                    deps.onUnexpectedError(new Error(`unknown offline node type: ${type}`), 'processing offline node');
+                    continue;
+                }
+                await nodeProcessor(node).catch(err => deps.onUnexpectedError(err, `processing offline ${type}`));
+                processedInBatch++;
+
+                if (processedInBatch >= batchSize) {
+                    processedInBatch = 0;
+                    await deps.yieldToEventLoop();
+                }
+            }
+            isProcessing = false;
+        };
+        promise().catch(error => deps.onUnexpectedError(error, 'processing offline nodes'));
+    };
+    return { enqueue };
+}

package/src/Utils/optional-media.d.ts

@@ -0,0 +1,3 @@
+export declare function loadSharp(): Promise<any>
+export declare function loadFfmpeg(): Promise<any>
+export declare function hasOptionalMedia(name: 'sharp' | 'fluent-ffmpeg'): Promise<boolean>

package/src/Utils/optional-media.js

@@ -0,0 +1,46 @@
+/* Elaina Baileys maintained distribution. Upstream notices and license are preserved in LICENSE and NOTICE.md. */
+const cache = new Map()
+
+const MESSAGES = {
+    sharp: 'sharp is an optional dependency. Install it with: npm i sharp',
+    'fluent-ffmpeg': 'fluent-ffmpeg is an optional dependency. Install it with: npm i fluent-ffmpeg'
+}
+
+const isMissingModule = (error, name) => {
+    const code = error?.code
+    if (code !== 'ERR_MODULE_NOT_FOUND' && code !== 'MODULE_NOT_FOUND') {
+        return false
+    }
+    const message = String(error?.message ?? '')
+    return message.includes(`'${name}'`) || message.includes(`"${name}"`)
+}
+
+const loadOptional = (name) => {
+    if (!cache.has(name)) {
+        cache.set(name, import(name).then(
+            loaded => loaded?.default ?? loaded,
+            error => {
+                cache.delete(name)
+                if (isMissingModule(error, name)) {
+                    throw new Error(MESSAGES[name] ?? `${name} is an optional dependency. Install it with: npm i ${name}`)
+                }
+                throw error
+            }
+        ))
+    }
+    return cache.get(name)
+}
+
+export const loadSharp = () => loadOptional('sharp')
+
+export const loadFfmpeg = () => loadOptional('fluent-ffmpeg')
+
+export const hasOptionalMedia = async (name) => {
+    try {
+        await loadOptional(name)
+        return true
+    }
+    catch {
+        return false
+    }
+}

package/src/Utils/payment-messages.d.ts

@@ -0,0 +1,66 @@
+import type { proto } from '../../WAProto/index.js';
+
+export declare const SplitPaymentStatus: Readonly<{ PENDING: 0; PAID: 1 }>;
+export declare const ReminderFrequency: Readonly<Record<string, number>>;
+export declare const ReminderStatus: Readonly<Record<string, number>>;
+export declare const MONEY_OFFSET: 1000;
+
+/** Takes the human amount; the wire value is amount * offset. */
+export declare function money(amount: number, currencyCode: string, offset?: number): proto.IMoney;
+export declare function readMoney(value?: proto.IMoney | null): { amount: number; currencyCode?: string } | undefined;
+
+export interface SplitPaymentParticipantOptions {
+    jid: string;
+    amount?: number;
+    currency?: string;
+    status?: number;
+}
+
+export declare function buildSplitPayment(options: {
+    splitId: string | number;
+    total?: number;
+    currency?: string;
+    description?: string;
+    requesterJid?: string;
+    participants: SplitPaymentParticipantOptions[];
+    createdAt?: number;
+}): proto.Message.ISplitPaymentMessage;
+
+export declare function buildSplitPaymentUpdate(options: {
+    splitId: string | number;
+    participantJid: string;
+}): proto.Message.ISplitPaymentUpdateMessage;
+
+export declare function buildPaymentReminder(options: {
+    reminderId: string | number;
+    instanceId?: string | number;
+    description?: string;
+    frequency?: number;
+    status?: number;
+    amount?: number;
+    currency?: string;
+    payeeVpa?: string;
+    payeeJid?: string;
+    payerJid?: string;
+}): proto.Message.IPaymentReminderMessage;
+
+export declare function readSplitPayment(msg: any): {
+    splitId?: string;
+    total?: { amount: number; currencyCode?: string };
+    description?: string;
+    requesterJid?: string;
+    createdAtMs?: number;
+    participants: { jid?: string; amount?: { amount: number; currencyCode?: string }; status?: number }[];
+} | null;
+
+export declare function readPaymentReminder(msg: any): {
+    reminderId?: string;
+    instanceId?: string;
+    description?: string;
+    frequency?: number;
+    status?: number;
+    amount?: { amount: number; currencyCode?: string };
+    payeeVpa?: string;
+    payeeJid?: string;
+    payerJid?: string;
+} | null;

package/src/Utils/payment-messages.js

@@ -0,0 +1,161 @@
+/* Elaina Baileys maintained distribution. Upstream notices and license are preserved in LICENSE and NOTICE.md. */
+
+export const SplitPaymentStatus = Object.freeze({ PENDING: 0, PAID: 1 })
+
+export const ReminderFrequency = Object.freeze({
+    REMINDER_FREQUENCY_UNKNOWN: 0,
+    WEEKLY: 1,
+    BI_WEEKLY: 2,
+    MONTHLY: 3,
+    QUARTERLY: 4
+})
+
+export const ReminderStatus = Object.freeze({
+    REMINDER_STATUS_UNKNOWN: 0,
+    ACTIVE: 1,
+    CANCELLED_BY_CREATOR: 2,
+    STOPPED_BY_RECEIVER: 3,
+    EXPIRED: 4,
+    PAID: 5
+})
+
+export const MONEY_OFFSET = 1000
+
+const drop = (object) => {
+    for (const key of Object.keys(object)) {
+        if (object[key] === undefined || object[key] === null) {
+            delete object[key]
+        }
+    }
+    return object
+}
+
+/**
+ * Money travels as an integer scaled by offset, so 50000 rupiah at the usual
+ * offset of 1000 goes on the wire as 50000000. Passing the scaled value by
+ * mistake overcharges by three orders of magnitude, so the amount here is
+ * always the human one.
+ */
+export const money = (amount, currencyCode, offset = MONEY_OFFSET) => {
+    const value = Number(amount)
+    if (!Number.isFinite(value) || value < 0) {
+        throw new TypeError('money needs a non-negative amount')
+    }
+    if (typeof currencyCode !== 'string' || currencyCode.length !== 3) {
+        throw new TypeError('money needs a three letter currency code, like IDR or USD')
+    }
+    if (!Number.isInteger(offset) || offset <= 0) {
+        throw new TypeError('money offset must be a positive integer')
+    }
+    return { value: Math.round(value * offset), offset, currencyCode: currencyCode.toUpperCase() }
+}
+
+export const readMoney = (value) => {
+    if (!value?.offset) {
+        return undefined
+    }
+    return {
+        amount: Number(value.value) / Number(value.offset),
+        currencyCode: value.currencyCode
+    }
+}
+
+export const buildSplitPayment = ({ splitId, total, currency, description, requesterJid, participants = [], createdAt } = {}) => {
+    if (!splitId) {
+        throw new TypeError('buildSplitPayment needs a splitId, the update message is keyed on it')
+    }
+    if (!participants.length) {
+        throw new TypeError('buildSplitPayment needs at least one participant')
+    }
+    return drop({
+        splitId: String(splitId),
+        totalAmount: total === undefined ? undefined : money(total, currency),
+        description,
+        requesterJid,
+        participants: participants.map((participant, index) => {
+            if (!participant?.jid) {
+                throw new TypeError(`participant ${index} needs a jid`)
+            }
+            return drop({
+                jid: participant.jid,
+                amount: participant.amount === undefined ? undefined : money(participant.amount, participant.currency ?? currency),
+                status: participant.status ?? SplitPaymentStatus.PENDING
+            })
+        }),
+        createdAtMs: createdAt === undefined ? Date.now() : Number(createdAt)
+    })
+}
+
+export const buildSplitPaymentUpdate = ({ splitId, participantJid } = {}) => {
+    if (!splitId || !participantJid) {
+        throw new TypeError('buildSplitPaymentUpdate needs both splitId and participantJid')
+    }
+    return { splitId: String(splitId), participantJid }
+}
+
+export const buildPaymentReminder = ({
+    reminderId,
+    instanceId,
+    description,
+    frequency = ReminderFrequency.MONTHLY,
+    status = ReminderStatus.ACTIVE,
+    amount,
+    currency,
+    payeeVpa,
+    payeeJid,
+    payerJid
+} = {}) => {
+    if (!reminderId) {
+        throw new TypeError('buildPaymentReminder needs a reminderId')
+    }
+    return drop({
+        reminderId: String(reminderId),
+        instanceId: instanceId === undefined ? undefined : String(instanceId),
+        description,
+        frequency,
+        status,
+        amount: amount === undefined ? undefined : money(amount, currency),
+        payeeVpa,
+        payeeJid,
+        payerJid
+    })
+}
+
+export const readSplitPayment = (msg) => {
+    const message = msg?.message ?? msg
+    const split = message?.splitPaymentMessage
+    if (!split) {
+        return null
+    }
+    return drop({
+        splitId: split.splitId,
+        total: readMoney(split.totalAmount),
+        description: split.description,
+        requesterJid: split.requesterJid,
+        createdAtMs: split.createdAtMs === undefined ? undefined : Number(split.createdAtMs),
+        participants: (split.participants ?? []).map(participant => drop({
+            jid: participant.jid,
+            amount: readMoney(participant.amount),
+            status: participant.status
+        }))
+    })
+}
+
+export const readPaymentReminder = (msg) => {
+    const message = msg?.message ?? msg
+    const reminder = message?.paymentReminderMessage
+    if (!reminder) {
+        return null
+    }
+    return drop({
+        reminderId: reminder.reminderId,
+        instanceId: reminder.instanceId,
+        description: reminder.description,
+        frequency: reminder.frequency,
+        status: reminder.status,
+        amount: readMoney(reminder.amount),
+        payeeVpa: reminder.payeeVpa,
+        payeeJid: reminder.payeeJid,
+        payerJid: reminder.payerJid
+    })
+}

package/src/Utils/pre-key-manager.d.ts

@@ -0,0 +1,26 @@
+/* Elaina Baileys maintained distribution. Upstream notices and license are preserved in LICENSE and NOTICE.md. */
+/**
+ * Manages pre-key operations with proper concurrency control
+ */
+export class PreKeyManager {
+    constructor(store: any, logger: any);
+    store: any;
+    logger: any;
+    queues: Map<any, any>;
+    /**
+     * Get or create a queue for a specific key type
+     */
+    getQueue(keyType: any): any;
+    /**
+     * Process pre-key operations (updates and deletions)
+     */
+    processOperations(data: any, keyType: any, transactionCache: any, mutations: any, isInTransaction: any): Promise<any>;
+    /**
+     * Process deletions with validation
+     */
+    processDeletions(keyType: any, ids: any, transactionCache: any, mutations: any, isInTransaction: any): Promise<void>;
+    /**
+     * Validate and process pre-key deletions outside transactions
+     */
+    validateDeletions(data: any, keyType: any): Promise<any>;
+}

package/src/Utils/pre-key-manager.js

@@ -0,0 +1,96 @@
+/* Elaina Baileys maintained distribution. Upstream notices and license are preserved in LICENSE and NOTICE.md. */
+import PQueue from 'p-queue';
+
+export class PreKeyManager {
+    constructor(store, logger) {
+        this.store = store;
+        this.logger = logger;
+        this.queues = new Map();
+    }
+
+    getQueue(keyType) {
+        if (!this.queues.has(keyType)) {
+            this.queues.set(keyType, new PQueue({ concurrency: 1 }));
+        }
+        return this.queues.get(keyType);
+    }
+
+    async processOperations(data, keyType, transactionCache, mutations, isInTransaction) {
+        const keyData = data[keyType];
+        if (!keyData)
+            return;
+        return this.getQueue(keyType).add(async () => {
+
+            transactionCache[keyType] = transactionCache[keyType] || {};
+            mutations[keyType] = mutations[keyType] || {};
+
+            const deletions = [];
+            const updates = {};
+            for (const keyId in keyData) {
+                if (keyData[keyId] === null) {
+                    deletions.push(keyId);
+                }
+                else {
+                    updates[keyId] = keyData[keyId];
+                }
+            }
+
+            if (Object.keys(updates).length > 0) {
+                Object.assign(transactionCache[keyType], updates);
+                Object.assign(mutations[keyType], updates);
+            }
+
+            if (deletions.length > 0) {
+                await this.processDeletions(keyType, deletions, transactionCache, mutations, isInTransaction);
+            }
+        });
+    }
+
+    async processDeletions(keyType, ids, transactionCache, mutations, isInTransaction) {
+        if (isInTransaction) {
+
+            for (const keyId of ids) {
+                if (transactionCache[keyType]?.[keyId]) {
+                    transactionCache[keyType][keyId] = null;
+                    mutations[keyType][keyId] = null;
+                }
+                else {
+                    this.logger.warn(`Skipping deletion of non-existent ${keyType} in transaction: ${keyId}`);
+                }
+            }
+        }
+        else {
+
+            const existingKeys = await this.store.get(keyType, ids);
+            for (const keyId of ids) {
+                if (existingKeys[keyId]) {
+                    transactionCache[keyType][keyId] = null;
+                    mutations[keyType][keyId] = null;
+                }
+                else {
+                    this.logger.warn(`Skipping deletion of non-existent ${keyType}: ${keyId}`);
+                }
+            }
+        }
+    }
+
+    async validateDeletions(data, keyType) {
+        const keyData = data[keyType];
+        if (!keyData)
+            return;
+        return this.getQueue(keyType).add(async () => {
+
+            const deletionIds = Object.keys(keyData).filter(id => keyData[id] === null);
+            if (deletionIds.length === 0)
+                return;
+
+            const existingKeys = await this.store.get(keyType, deletionIds);
+            for (const keyId of deletionIds) {
+                if (!existingKeys[keyId]) {
+                    this.logger.warn(`Skipping deletion of non-existent ${keyType}: ${keyId}`);
+                    delete data[keyType][keyId];
+                }
+            }
+        });
+    }
+}