naruyaizumi
Version:
A WebSockets library for interacting with WhatsApp Web
1,157 lines • 64.3 kB
JavaScript
import NodeCache from "@cacheable/node-cache";
import { Boom } from "@hapi/boom";
import { randomBytes } from "crypto";
import Long from "long";
import { proto } from "../../WAProto/index.js";
import { DEFAULT_CACHE_TTLS, KEY_BUNDLE_TYPE, MIN_PREKEY_COUNT } from "../Defaults/index.js";
import { WAMessageStatus, WAMessageStubType } from "../Types/index.js";
import {
aesDecryptCTR,
aesEncryptGCM,
cleanMessage,
Curve,
decodeMediaRetryNode,
decodeMessageNode,
decryptMessageNode,
delay,
derivePairingCodeKey,
encodeBigEndian,
encodeSignedDeviceIdentity,
extractAddressingContext,
getCallStatusFromNode,
getHistoryMsg,
getNextPreKeys,
getStatusFromReceiptType,
hkdf,
MISSING_KEYS_ERROR_TEXT,
NACK_REASONS,
NO_MESSAGE_FOUND_ERROR_TEXT,
unixTimestampSeconds,
xmppPreKey,
xmppSignedPreKey,
} from "../Utils/index.js";
import { makeMutex } from "../Utils/make-mutex.js";
import {
areJidsSameUser,
binaryNodeToString,
getAllBinaryNodeChildren,
getBinaryNodeChild,
getBinaryNodeChildBuffer,
getBinaryNodeChildren,
getBinaryNodeChildString,
isJidGroup,
isJidNewsletter,
isJidStatusBroadcast,
isLidUser,
isPnUser,
jidDecode,
jidNormalizedUser,
S_WHATSAPP_NET,
} from "../WABinary/index.js";
import { extractGroupMetadata } from "./groups.js";
import { makeMessagesSocket } from "./messages-send.js";
export const makeMessagesRecvSocket = (config) => {
const {
logger,
retryRequestDelayMs,
maxMsgRetryCount,
getMessage,
shouldIgnoreJid,
enableAutoSessionRecreation,
} = config;
const sock = makeMessagesSocket(config);
const {
ev,
authState,
ws,
processingMutex,
signalRepository,
query,
upsertMessage,
resyncAppState,
onUnexpectedError,
assertSessions,
sendNode,
relayMessage,
sendReceipt,
uploadPreKeys,
sendPeerDataOperationMessage,
messageRetryManager,
} = sock;
/** this mutex ensures that each retryRequest will wait for the previous one to finish */
const retryMutex = makeMutex();
const msgRetryCache =
config.msgRetryCounterCache ||
new NodeCache({
stdTTL: DEFAULT_CACHE_TTLS.MSG_RETRY, // 1 hour
useClones: false,
});
const callOfferCache =
config.callOfferCache ||
new NodeCache({
stdTTL: DEFAULT_CACHE_TTLS.CALL_OFFER, // 5 mins
useClones: false,
});
const placeholderResendCache =
config.placeholderResendCache ||
new NodeCache({
stdTTL: DEFAULT_CACHE_TTLS.MSG_RETRY, // 1 hour
useClones: false,
});
// Debounce identity-change session refreshes per JID to avoid bursts
const identityAssertDebounce = new NodeCache({ stdTTL: 5, useClones: false });
let sendActiveReceipts = false;
const fetchMessageHistory = async (count, oldestMsgKey, oldestMsgTimestamp) => {
if (!authState.creds.me?.id) {
throw new Boom("Not authenticated");
}
const pdoMessage = {
historySyncOnDemandRequest: {
chatJid: oldestMsgKey.remoteJid,
oldestMsgFromMe: oldestMsgKey.fromMe,
oldestMsgId: oldestMsgKey.id,
oldestMsgTimestampMs: oldestMsgTimestamp,
onDemandMsgCount: count,
},
peerDataOperationRequestType:
proto.Message.PeerDataOperationRequestType.HISTORY_SYNC_ON_DEMAND,
};
return sendPeerDataOperationMessage(pdoMessage);
};
const requestPlaceholderResend = async (messageKey) => {
if (!authState.creds.me?.id) {
throw new Boom("Not authenticated");
}
if (placeholderResendCache.get(messageKey?.id)) {
logger.debug({ messageKey }, "already requested resend");
return;
} else {
await placeholderResendCache.set(messageKey?.id, true);
}
await delay(5000);
if (!placeholderResendCache.get(messageKey?.id)) {
logger.debug({ messageKey }, "message received while resend requested");
return "RESOLVED";
}
const pdoMessage = {
placeholderMessageResendRequest: [
{
messageKey,
},
],
peerDataOperationRequestType:
proto.Message.PeerDataOperationRequestType.PLACEHOLDER_MESSAGE_RESEND,
};
setTimeout(async () => {
if (placeholderResendCache.get(messageKey?.id)) {
logger.debug(
{ messageKey },
"PDO message without response after 15 seconds. Phone possibly offline"
);
await placeholderResendCache.del(messageKey?.id);
}
}, 15000);
return sendPeerDataOperationMessage(pdoMessage);
};
// Handles mex newsletter notifications
const handleMexNewsletterNotification = async (node) => {
const mexNode = getBinaryNodeChild(node, "mex");
if (!mexNode?.content) {
logger.warn({ node }, "Invalid mex newsletter notification");
return;
}
let data;
try {
data = JSON.parse(mexNode.content.toString());
} catch (error) {
logger.error({ err: error, node }, "Failed to parse mex newsletter notification");
return;
}
const operation = data?.operation;
const updates = data?.updates;
if (!updates || !operation) {
logger.warn({ data }, "Invalid mex newsletter notification content");
return;
}
logger.info({ operation, updates }, "got mex newsletter notification");
switch (operation) {
case "NotificationNewsletterUpdate":
for (const update of updates) {
if (update.jid && update.settings && Object.keys(update.settings).length > 0) {
ev.emit("newsletter-settings.update", {
id: update.jid,
update: update.settings,
});
}
}
break;
case "NotificationNewsletterAdminPromote":
for (const update of updates) {
if (update.jid && update.user) {
ev.emit("newsletter-participants.update", {
id: update.jid,
author: node.attrs.from,
user: update.user,
new_role: "ADMIN",
action: "promote",
});
}
}
break;
default:
logger.info({ operation, data }, "Unhandled mex newsletter notification");
break;
}
};
// Handles newsletter notifications
const handleNewsletterNotification = async (node) => {
const from = node.attrs.from;
const child = getAllBinaryNodeChildren(node)[0];
const author = node.attrs.participant;
logger.info({ from, child }, "got newsletter notification");
switch (child.tag) {
case "reaction":
const reactionUpdate = {
id: from,
server_id: child.attrs.message_id,
reaction: {
code: getBinaryNodeChildString(child, "reaction"),
count: 1,
},
};
ev.emit("newsletter.reaction", reactionUpdate);
break;
case "view":
const viewUpdate = {
id: from,
server_id: child.attrs.message_id,
count: parseInt(child.content?.toString() || "0", 10),
};
ev.emit("newsletter.view", viewUpdate);
break;
case "participant":
const participantUpdate = {
id: from,
author,
user: child.attrs.jid,
action: child.attrs.action,
new_role: child.attrs.role,
};
ev.emit("newsletter-participants.update", participantUpdate);
break;
case "update":
const settingsNode = getBinaryNodeChild(child, "settings");
if (settingsNode) {
const update = {};
const nameNode = getBinaryNodeChild(settingsNode, "name");
if (nameNode?.content) update.name = nameNode.content.toString();
const descriptionNode = getBinaryNodeChild(settingsNode, "description");
if (descriptionNode?.content)
update.description = descriptionNode.content.toString();
ev.emit("newsletter-settings.update", {
id: from,
update,
});
}
break;
case "message":
const plaintextNode = getBinaryNodeChild(child, "plaintext");
if (plaintextNode?.content) {
try {
const contentBuf =
typeof plaintextNode.content === "string"
? Buffer.from(plaintextNode.content, "binary")
: Buffer.from(plaintextNode.content);
const messageProto = proto.Message.decode(contentBuf).toJSON();
const fullMessage = proto.WebMessageInfo.fromObject({
key: {
remoteJid: from,
id: child.attrs.message_id || child.attrs.server_id,
fromMe: false, // TODO: is this really true though
},
message: messageProto,
messageTimestamp: +child.attrs.t,
}).toJSON();
await upsertMessage(fullMessage, "append");
logger.info("Processed plaintext newsletter message");
} catch (error) {
logger.error({ error }, "Failed to decode plaintext newsletter message");
}
}
break;
default:
logger.warn({ node }, "Unknown newsletter notification");
break;
}
};
const sendMessageAck = async ({ tag, attrs, content }, errorCode) => {
const stanza = {
tag: "ack",
attrs: {
id: attrs.id,
to: attrs.from,
class: tag,
},
};
if (!!errorCode) {
stanza.attrs.error = errorCode.toString();
}
if (!!attrs.participant) {
stanza.attrs.participant = attrs.participant;
}
if (!!attrs.recipient) {
stanza.attrs.recipient = attrs.recipient;
}
if (
!!attrs.type &&
(tag !== "message" ||
getBinaryNodeChild({ tag, attrs, content }, "unavailable") ||
errorCode !== 0)
) {
stanza.attrs.type = attrs.type;
}
if (tag === "message" && getBinaryNodeChild({ tag, attrs, content }, "unavailable")) {
stanza.attrs.from = authState.creds.me.id;
}
logger.debug({ recv: { tag, attrs }, sent: stanza.attrs }, "sent ack");
await sendNode(stanza);
};
const rejectCall = async (callId, callFrom) => {
const stanza = {
tag: "call",
attrs: {
from: authState.creds.me.id,
to: callFrom,
},
content: [
{
tag: "reject",
attrs: {
"call-id": callId,
"call-creator": callFrom,
count: "0",
},
content: undefined,
},
],
};
await query(stanza);
};
const sendRetryRequest = async (node, forceIncludeKeys = false) => {
const { fullMessage } = decodeMessageNode(
node,
authState.creds.me.id,
authState.creds.me.lid || ""
);
const { key: msgKey } = fullMessage;
const msgId = msgKey.id;
if (messageRetryManager) {
// Check if we've exceeded max retries using the new system
if (messageRetryManager.hasExceededMaxRetries(msgId)) {
logger.debug({ msgId }, "reached retry limit with new retry manager, clearing");
messageRetryManager.markRetryFailed(msgId);
return;
}
// Increment retry count using new system
const retryCount = messageRetryManager.incrementRetryCount(msgId);
// Use the new retry count for the rest of the logic
const key = `${msgId}:${msgKey?.participant}`;
await msgRetryCache.set(key, retryCount);
} else {
// Fallback to old system
const key = `${msgId}:${msgKey?.participant}`;
let retryCount = (await msgRetryCache.get(key)) || 0;
if (retryCount >= maxMsgRetryCount) {
logger.debug({ retryCount, msgId }, "reached retry limit, clearing");
await msgRetryCache.del(key);
return;
}
retryCount += 1;
await msgRetryCache.set(key, retryCount);
}
const key = `${msgId}:${msgKey?.participant}`;
const retryCount = (await msgRetryCache.get(key)) || 1;
const { account, signedPreKey, signedIdentityKey: identityKey } = authState.creds;
const fromJid = node.attrs.from;
// Check if we should recreate the session
let shouldRecreateSession = false;
let recreateReason = "";
if (enableAutoSessionRecreation && messageRetryManager) {
try {
// Check if we have a session with this JID
const sessionId = signalRepository.jidToSignalProtocolAddress(fromJid);
const hasSession = await signalRepository.validateSession(fromJid);
const result = messageRetryManager.shouldRecreateSession(
fromJid,
retryCount,
hasSession.exists
);
shouldRecreateSession = result.recreate;
recreateReason = result.reason;
if (shouldRecreateSession) {
logger.debug(
{ fromJid, retryCount, reason: recreateReason },
"recreating session for retry"
);
// Delete existing session to force recreation
await authState.keys.set({ session: { [sessionId]: null } });
forceIncludeKeys = true;
}
} catch (error) {
logger.warn({ error, fromJid }, "failed to check session recreation");
}
}
if (retryCount <= 2) {
// Use new retry manager for phone requests if available
if (messageRetryManager) {
// Schedule phone request with delay (like whatsmeow)
messageRetryManager.schedulePhoneRequest(msgId, async () => {
try {
const requestId = await requestPlaceholderResend(msgKey);
logger.debug(
`sendRetryRequest: requested placeholder resend (${requestId}) for message ${msgId} (scheduled)`
);
} catch (error) {
logger.warn({ error, msgId }, "failed to send scheduled phone request");
}
});
} else {
// Fallback to immediate request
const msgId = await requestPlaceholderResend(msgKey);
logger.debug(`sendRetryRequest: requested placeholder resend for message ${msgId}`);
}
}
const deviceIdentity = encodeSignedDeviceIdentity(account, true);
await authState.keys.transaction(async () => {
const receipt = {
tag: "receipt",
attrs: {
id: msgId,
type: "retry",
to: node.attrs.from,
},
content: [
{
tag: "retry",
attrs: {
count: retryCount.toString(),
id: node.attrs.id,
t: node.attrs.t,
v: "1",
// ADD ERROR FIELD
error: "0",
},
},
{
tag: "registration",
attrs: {},
content: encodeBigEndian(authState.creds.registrationId),
},
],
};
if (node.attrs.recipient) {
receipt.attrs.recipient = node.attrs.recipient;
}
if (node.attrs.participant) {
receipt.attrs.participant = node.attrs.participant;
}
if (retryCount > 1 || forceIncludeKeys || shouldRecreateSession) {
const { update, preKeys } = await getNextPreKeys(authState, 1);
const [keyId] = Object.keys(preKeys);
const key = preKeys[+keyId];
const content = receipt.content;
content.push({
tag: "keys",
attrs: {},
content: [
{ tag: "type", attrs: {}, content: Buffer.from(KEY_BUNDLE_TYPE) },
{ tag: "identity", attrs: {}, content: identityKey.public },
xmppPreKey(key, +keyId),
xmppSignedPreKey(signedPreKey),
{ tag: "device-identity", attrs: {}, content: deviceIdentity },
],
});
ev.emit("creds.update", update);
}
await sendNode(receipt);
logger.info({ msgAttrs: node.attrs, retryCount }, "sent retry receipt");
}, authState?.creds?.me?.id || "sendRetryRequest");
};
const handleEncryptNotification = async (node) => {
const from = node.attrs.from;
if (from === S_WHATSAPP_NET) {
const countChild = getBinaryNodeChild(node, "count");
const count = +countChild.attrs.value;
const shouldUploadMorePreKeys = count < MIN_PREKEY_COUNT;
logger.debug({ count, shouldUploadMorePreKeys }, "recv pre-key count");
if (shouldUploadMorePreKeys) {
await uploadPreKeys();
}
} else {
const identityNode = getBinaryNodeChild(node, "identity");
if (identityNode) {
logger.info({ jid: from }, "identity changed");
if (identityAssertDebounce.get(from)) {
logger.debug({ jid: from }, "skipping identity assert (debounced)");
return;
}
identityAssertDebounce.set(from, true);
try {
await assertSessions([from], true);
} catch (error) {
logger.warn(
{ error, jid: from },
"failed to assert sessions after identity change"
);
}
} else {
logger.info({ node }, "unknown encrypt notification");
}
}
};
const handleGroupNotification = (fullNode, child, msg) => {
// TODO: Support PN/LID (Here is only LID now)
const actingParticipantLid = fullNode.attrs.participant;
const actingParticipantPn = fullNode.attrs.participant_pn;
const affectedParticipantLid =
getBinaryNodeChild(child, "participant")?.attrs?.jid || actingParticipantLid;
const affectedParticipantPn =
getBinaryNodeChild(child, "participant")?.attrs?.phone_number || actingParticipantPn;
switch (child?.tag) {
case "create":
const metadata = extractGroupMetadata(child);
msg.messageStubType = WAMessageStubType.GROUP_CREATE;
msg.messageStubParameters = [metadata.subject];
msg.key = { participant: metadata.owner, participantAlt: metadata.ownerPn };
ev.emit("chats.upsert", [
{
id: metadata.id,
name: metadata.subject,
conversationTimestamp: metadata.creation,
},
]);
ev.emit("groups.upsert", [
{
...metadata,
author: actingParticipantLid,
authorPn: actingParticipantPn,
},
]);
break;
case "ephemeral":
case "not_ephemeral":
msg.message = {
protocolMessage: {
type: proto.Message.ProtocolMessage.Type.EPHEMERAL_SETTING,
ephemeralExpiration: +(child.attrs.expiration || 0),
},
};
break;
case "modify":
const oldNumber = getBinaryNodeChildren(child, "participant").map(
(p) => p.attrs.jid
);
msg.messageStubParameters = oldNumber || [];
msg.messageStubType = WAMessageStubType.GROUP_PARTICIPANT_CHANGE_NUMBER;
break;
case "promote":
case "demote":
case "remove":
case "add":
case "leave":
const stubType = `GROUP_PARTICIPANT_${child.tag.toUpperCase()}`;
msg.messageStubType = WAMessageStubType[stubType];
const participants = getBinaryNodeChildren(child, "participant").map(
({ attrs }) => {
// TODO: Store LID MAPPINGS
return {
id: attrs.jid,
phoneNumber:
isLidUser(attrs.jid) && isPnUser(attrs.phone_number)
? attrs.phone_number
: undefined,
lid:
isPnUser(attrs.jid) && isLidUser(attrs.lid) ? attrs.lid : undefined,
admin: attrs.type || null,
};
}
);
if (
participants.length === 1 &&
// if recv. "remove" message and sender removed themselves
// mark as left
(areJidsSameUser(participants[0].id, actingParticipantLid) ||
areJidsSameUser(participants[0].id, actingParticipantPn)) &&
child.tag === "remove"
) {
msg.messageStubType = WAMessageStubType.GROUP_PARTICIPANT_LEAVE;
}
msg.messageStubParameters = participants.map((a) => JSON.stringify(a));
break;
case "subject":
msg.messageStubType = WAMessageStubType.GROUP_CHANGE_SUBJECT;
msg.messageStubParameters = [child.attrs.subject];
break;
case "description":
const description = getBinaryNodeChild(child, "body")?.content?.toString();
msg.messageStubType = WAMessageStubType.GROUP_CHANGE_DESCRIPTION;
msg.messageStubParameters = description ? [description] : undefined;
break;
case "announcement":
case "not_announcement":
msg.messageStubType = WAMessageStubType.GROUP_CHANGE_ANNOUNCE;
msg.messageStubParameters = [child.tag === "announcement" ? "on" : "off"];
break;
case "locked":
case "unlocked":
msg.messageStubType = WAMessageStubType.GROUP_CHANGE_RESTRICT;
msg.messageStubParameters = [child.tag === "locked" ? "on" : "off"];
break;
case "invite":
msg.messageStubType = WAMessageStubType.GROUP_CHANGE_INVITE_LINK;
msg.messageStubParameters = [child.attrs.code];
break;
case "member_add_mode":
const addMode = child.content;
if (addMode) {
msg.messageStubType = WAMessageStubType.GROUP_MEMBER_ADD_MODE;
msg.messageStubParameters = [addMode.toString()];
}
break;
case "membership_approval_mode":
const approvalMode = getBinaryNodeChild(child, "group_join");
if (approvalMode) {
msg.messageStubType = WAMessageStubType.GROUP_MEMBERSHIP_JOIN_APPROVAL_MODE;
msg.messageStubParameters = [approvalMode.attrs.state];
}
break;
case "created_membership_requests":
msg.messageStubType =
WAMessageStubType.GROUP_MEMBERSHIP_JOIN_APPROVAL_REQUEST_NON_ADMIN_ADD;
msg.messageStubParameters = [
JSON.stringify({ lid: affectedParticipantLid, pn: affectedParticipantPn }),
"created",
child.attrs.request_method,
];
break;
case "revoked_membership_requests":
const isDenied = areJidsSameUser(affectedParticipantLid, actingParticipantLid);
// TODO: LIDMAPPING SUPPORT
msg.messageStubType =
WAMessageStubType.GROUP_MEMBERSHIP_JOIN_APPROVAL_REQUEST_NON_ADMIN_ADD;
msg.messageStubParameters = [
JSON.stringify({ lid: affectedParticipantLid, pn: affectedParticipantPn }),
isDenied ? "revoked" : "rejected",
];
break;
}
};
const processNotification = async (node) => {
const result = {};
const [child] = getAllBinaryNodeChildren(node);
const nodeType = node.attrs.type;
const from = jidNormalizedUser(node.attrs.from);
switch (nodeType) {
case "newsletter":
await handleNewsletterNotification(node);
break;
case "mex":
await handleMexNewsletterNotification(node);
break;
case "w:gp2":
// TODO: HANDLE PARTICIPANT_PN
handleGroupNotification(node, child, result);
break;
case "mediaretry":
const event = decodeMediaRetryNode(node);
ev.emit("messages.media-update", [event]);
break;
case "encrypt":
await handleEncryptNotification(node);
break;
case "devices":
const devices = getBinaryNodeChildren(child, "device");
if (
areJidsSameUser(child.attrs.jid, authState.creds.me.id) ||
areJidsSameUser(child.attrs.lid, authState.creds.me.lid)
) {
const deviceData = devices.map((d) => ({ id: d.attrs.jid, lid: d.attrs.lid }));
logger.info({ deviceData }, "my own devices changed");
}
//TODO: drop a new event, add hashes
break;
case "server_sync":
const update = getBinaryNodeChild(node, "collection");
if (update) {
const name = update.attrs.name;
await resyncAppState([name], false);
}
break;
case "picture":
const setPicture = getBinaryNodeChild(node, "set");
const delPicture = getBinaryNodeChild(node, "delete");
ev.emit("contacts.update", [
{
id:
jidNormalizedUser(node?.attrs?.from) ||
(setPicture || delPicture)?.attrs?.hash ||
"",
imgUrl: setPicture ? "changed" : "removed",
},
]);
if (isJidGroup(from)) {
const node = setPicture || delPicture;
result.messageStubType = WAMessageStubType.GROUP_CHANGE_ICON;
if (setPicture) {
result.messageStubParameters = [setPicture.attrs.id];
}
result.participant = node?.attrs.author;
result.key = {
...(result.key || {}),
participant: setPicture?.attrs.author,
};
}
break;
case "account_sync":
if (child.tag === "disappearing_mode") {
const newDuration = +child.attrs.duration;
const timestamp = +child.attrs.t;
logger.info({ newDuration }, "updated account disappearing mode");
ev.emit("creds.update", {
accountSettings: {
...authState.creds.accountSettings,
defaultDisappearingMode: {
ephemeralExpiration: newDuration,
ephemeralSettingTimestamp: timestamp,
},
},
});
} else if (child.tag === "blocklist") {
const blocklists = getBinaryNodeChildren(child, "item");
for (const { attrs } of blocklists) {
const blocklist = [attrs.jid];
const type = attrs.action === "block" ? "add" : "remove";
ev.emit("blocklist.update", { blocklist, type });
}
}
break;
case "link_code_companion_reg":
const linkCodeCompanionReg = getBinaryNodeChild(node, "link_code_companion_reg");
const ref = toRequiredBuffer(
getBinaryNodeChildBuffer(linkCodeCompanionReg, "link_code_pairing_ref")
);
const primaryIdentityPublicKey = toRequiredBuffer(
getBinaryNodeChildBuffer(linkCodeCompanionReg, "primary_identity_pub")
);
const primaryEphemeralPublicKeyWrapped = toRequiredBuffer(
getBinaryNodeChildBuffer(
linkCodeCompanionReg,
"link_code_pairing_wrapped_primary_ephemeral_pub"
)
);
const codePairingPublicKey = await decipherLinkPublicKey(
primaryEphemeralPublicKeyWrapped
);
const companionSharedKey = Curve.sharedKey(
authState.creds.pairingEphemeralKeyPair.private,
codePairingPublicKey
);
const random = randomBytes(32);
const linkCodeSalt = randomBytes(32);
const linkCodePairingExpanded = await hkdf(companionSharedKey, 32, {
salt: linkCodeSalt,
info: "link_code_pairing_key_bundle_encryption_key",
});
const encryptPayload = Buffer.concat([
Buffer.from(authState.creds.signedIdentityKey.public),
primaryIdentityPublicKey,
random,
]);
const encryptIv = randomBytes(12);
const encrypted = aesEncryptGCM(
encryptPayload,
linkCodePairingExpanded,
encryptIv,
Buffer.alloc(0)
);
const encryptedPayload = Buffer.concat([linkCodeSalt, encryptIv, encrypted]);
const identitySharedKey = Curve.sharedKey(
authState.creds.signedIdentityKey.private,
primaryIdentityPublicKey
);
const identityPayload = Buffer.concat([
companionSharedKey,
identitySharedKey,
random,
]);
authState.creds.advSecretKey = (
await hkdf(identityPayload, 32, { info: "adv_secret" })
).toString("base64");
await query({
tag: "iq",
attrs: {
to: S_WHATSAPP_NET,
type: "set",
id: sock.generateMessageTag(),
xmlns: "md",
},
content: [
{
tag: "link_code_companion_reg",
attrs: {
jid: authState.creds.me.id,
stage: "companion_finish",
},
content: [
{
tag: "link_code_pairing_wrapped_key_bundle",
attrs: {},
content: encryptedPayload,
},
{
tag: "companion_identity_public",
attrs: {},
content: authState.creds.signedIdentityKey.public,
},
{
tag: "link_code_pairing_ref",
attrs: {},
content: ref,
},
],
},
],
});
authState.creds.registered = true;
ev.emit("creds.update", authState.creds);
break;
case "privacy_token":
await handlePrivacyTokenNotification(node);
break;
}
if (Object.keys(result).length) {
return result;
}
};
const handlePrivacyTokenNotification = async (node) => {
const tokensNode = getBinaryNodeChild(node, "tokens");
const from = jidNormalizedUser(node.attrs.from);
if (!tokensNode) return;
const tokenNodes = getBinaryNodeChildren(tokensNode, "token");
for (const tokenNode of tokenNodes) {
const { attrs, content } = tokenNode;
const type = attrs.type;
const timestamp = attrs.t;
if (type === "trusted_contact" && content instanceof Buffer) {
logger.debug(
{
from,
timestamp,
tcToken: content,
},
"received trusted contact token"
);
await authState.keys.set({
tctoken: { [from]: { token: content, timestamp } },
});
}
}
};
async function decipherLinkPublicKey(data) {
const buffer = toRequiredBuffer(data);
const salt = buffer.slice(0, 32);
const secretKey = await derivePairingCodeKey(authState.creds.pairingCode, salt);
const iv = buffer.slice(32, 48);
const payload = buffer.slice(48, 80);
return aesDecryptCTR(payload, secretKey, iv);
}
function toRequiredBuffer(data) {
if (data === undefined) {
throw new Boom("Invalid buffer", { statusCode: 400 });
}
return data instanceof Buffer ? data : Buffer.from(data);
}
const willSendMessageAgain = async (id, participant) => {
const key = `${id}:${participant}`;
const retryCount = (await msgRetryCache.get(key)) || 0;
return retryCount < maxMsgRetryCount;
};
const updateSendMessageAgainCount = async (id, participant) => {
const key = `${id}:${participant}`;
const newValue = ((await msgRetryCache.get(key)) || 0) + 1;
await msgRetryCache.set(key, newValue);
};
const sendMessagesAgain = async (key, ids, retryNode) => {
const remoteJid = key.remoteJid;
const participant = key.participant || remoteJid;
const retryCount = +retryNode.attrs.count || 1;
// Try to get messages from cache first, then fallback to getMessage
const msgs = [];
for (const id of ids) {
let msg;
// Try to get from retry cache first if enabled
if (messageRetryManager) {
const cachedMsg = messageRetryManager.getRecentMessage(remoteJid, id);
if (cachedMsg) {
msg = cachedMsg.message;
logger.debug({ jid: remoteJid, id }, "found message in retry cache");
// Mark retry as successful since we found the message
messageRetryManager.markRetrySuccess(id);
}
}
// Fallback to getMessage if not found in cache
if (!msg) {
msg = await getMessage({ ...key, id });
if (msg) {
logger.debug({ jid: remoteJid, id }, "found message via getMessage");
// Also mark as successful if found via getMessage
if (messageRetryManager) {
messageRetryManager.markRetrySuccess(id);
}
}
}
msgs.push(msg);
}
// if it's the primary jid sending the request
// just re-send the message to everyone
// prevents the first message decryption failure
const sendToAll = !jidDecode(participant)?.device;
// Check if we should recreate session for this retry
let shouldRecreateSession = false;
let recreateReason = "";
if (enableAutoSessionRecreation && messageRetryManager) {
try {
const sessionId = signalRepository.jidToSignalProtocolAddress(participant);
const hasSession = await signalRepository.validateSession(participant);
const result = messageRetryManager.shouldRecreateSession(
participant,
retryCount,
hasSession.exists
);
shouldRecreateSession = result.recreate;
recreateReason = result.reason;
if (shouldRecreateSession) {
logger.debug(
{ participant, retryCount, reason: recreateReason },
"recreating session for outgoing retry"
);
await authState.keys.set({ session: { [sessionId]: null } });
}
} catch (error) {
logger.warn(
{ error, participant },
"failed to check session recreation for outgoing retry"
);
}
}
await assertSessions([participant], true);
if (isJidGroup(remoteJid)) {
await authState.keys.set({ "sender-key-memory": { [remoteJid]: null } });
}
logger.debug(
{ participant, sendToAll, shouldRecreateSession, recreateReason },
"forced new session for retry recp"
);
for (const [i, msg] of msgs.entries()) {
if (!ids[i]) continue;
if (msg && (await willSendMessageAgain(ids[i], participant))) {
await updateSendMessageAgainCount(ids[i], participant);
const msgRelayOpts = { messageId: ids[i] };
if (sendToAll) {
msgRelayOpts.useUserDevicesCache = false;
} else {
msgRelayOpts.participant = {
jid: participant,
count: +retryNode.attrs.count,
};
}
await relayMessage(key.remoteJid, msg, msgRelayOpts);
} else {
logger.debug(
{ jid: key.remoteJid, id: ids[i] },
"recv retry request, but message not available"
);
}
}
};
const handleReceipt = async (node) => {
const { attrs, content } = node;
const isLid = attrs.from.includes("lid");
const isNodeFromMe = areJidsSameUser(
attrs.participant || attrs.from,
isLid ? authState.creds.me?.lid : authState.creds.me?.id
);
const remoteJid = !isNodeFromMe || isJidGroup(attrs.from) ? attrs.from : attrs.recipient;
const fromMe =
!attrs.recipient ||
((attrs.type === "retry" || attrs.type === "sender") && isNodeFromMe);
const key = {
remoteJid,
id: "",
fromMe,
participant: attrs.participant,
};
if (shouldIgnoreJid(remoteJid) && remoteJid !== S_WHATSAPP_NET) {
logger.debug({ remoteJid }, "ignoring receipt from jid");
await sendMessageAck(node);
return;
}
const ids = [attrs.id];
if (Array.isArray(content)) {
const items = getBinaryNodeChildren(content[0], "item");
ids.push(...items.map((i) => i.attrs.id));
}
try {
await Promise.all([
processingMutex.mutex(async () => {
const status = getStatusFromReceiptType(attrs.type);
if (
typeof status !== "undefined" &&
// basically, we only want to know when a message from us has been delivered to/read by the other person
// or another device of ours has read some messages
(status >= proto.WebMessageInfo.Status.SERVER_ACK || !isNodeFromMe)
) {
if (isJidGroup(remoteJid) || isJidStatusBroadcast(remoteJid)) {
if (attrs.participant) {
const updateKey =
status === proto.WebMessageInfo.Status.DELIVERY_ACK
? "receiptTimestamp"
: "readTimestamp";
ev.emit(
"message-receipt.update",
ids.map((id) => ({
key: { ...key, id },
receipt: {
userJid: jidNormalizedUser(attrs.participant),
[updateKey]: +attrs.t,
},
}))
);
}
} else {
ev.emit(
"messages.update",
ids.map((id) => ({
key: { ...key, id },
update: { status },
}))
);
}
}
if (attrs.type === "retry") {
// correctly set who is asking for the retry
key.participant = key.participant || attrs.from;
const retryNode = getBinaryNodeChild(node, "retry");
if (
ids[0] &&
key.participant &&
(await willSendMessageAgain(ids[0], key.participant))
) {
if (key.fromMe) {
try {
await updateSendMessageAgainCount(ids[0], key.participant);
logger.debug({ attrs, key }, "recv retry request");
await sendMessagesAgain(key, ids, retryNode);
} catch (error) {
logger.error(
{
key,
ids,
trace:
error instanceof Error
? error.stack
: "Unknown error",
},
"error in sending message again"
);
}
} else {
logger.info({ attrs, key }, "recv retry for not fromMe message");
}
} else {
logger.info(
{ attrs, key },
"will not send message again, as sent too many times"
);
}
}
}),
]);
} finally {
await sendMessageAck(node);
}
};
const handleNotification = async (node) => {
const remoteJid = node.attrs.from;
if (shouldIgnoreJid(remoteJid) && remoteJid !== S_WHATSAPP_NET) {
logger.debug({ remoteJid, id: node.attrs.id }, "ignored notification");
await sendMessageAck(node);
return;
}
try {
await Promise.all([
processingMutex.mutex(async () => {
const msg = await processNotification(node);
if (msg) {
const fromMe = areJidsSameUser(
node.attrs.participant || remoteJid,
authState.creds.me.id
);
const { senderAlt: participantAlt, addressingMode } =
extractAddressingContext(node);
msg.key = {
remoteJid,
fromMe,
participant: node.attrs.participant,
participantAlt,
addressingMode,
id: node.attrs.id,
...(msg.key || {}),
};
msg.participant ?? (msg.participant = node.attrs.participant);
msg.messageTimestamp = +node.attrs.t;
const fullMsg = proto.WebMessageInfo.fromObject(msg);
await upsertMessage(fullMsg, "append");
}
}),
]);
} finally {
await sendMessageAck(node);
}
};
const handleMessage = async (node) => {
if (shouldIgnoreJid(node.attrs.from) && node.attrs.from !== S_WHATSAPP_NET) {
logger.debug({ key: node.attrs.key }, "ignored message");
await sendMessageAck(node, NACK_REASONS.UnhandledError);
return;
}
const encNode = getBinaryNodeChild(node, "enc");
// TODO: temporary fix for crashes and issues resulting of failed msmsg decryption
if (encNode && encNode.attrs.type === "msmsg") {
logger.debug({ key: node.attrs.key }, "ignored msmsg");
await sendMessageAck(node, NACK_REASONS.MissingMessageSecret);
return;
}
const {
fullMessage: msg,
category,
author,
decrypt,
} = decryptMessageNode(
node,
authState.creds.me.id,
authState.creds.me.lid || "",
signalRepository,
logger
);
const alt = msg.key.participantAlt || msg.key.remoteJidAlt;
// store new mappings we didn't have before
if (!!alt) {
const altServer = jidDecode(alt)?.server;
const primaryJid = msg.key.participant || msg.key.remoteJid;
if (altServer === "lid") {
if (!(await signalRepository.lidMapping.getPNForLID(alt))) {
await signalRepository.lidMapping.storeLIDPNMappings([
{ lid: alt, pn: primaryJid },
]);
await signalRepository.migrateSession(prim