fb-messenger-e2ee 0.1.0

package/src/e2ee/message/codecs/protobuf-codecs.ts

@@ -0,0 +1,101 @@
+import * as protobuf from "protobufjs";
+import { fileURLToPath } from "node:url";
+import { dirname, join } from "node:path";
+
+// Protobuf Decoders (using protobufjs for simplicity)
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const root = new ((protobuf as any).default?.Root || protobuf.Root)();
+root.resolvePath = (origin: string, target: string) => {
+  return join(__dirname, "../proto", target);
+};
+root.loadSync([
+  "WACommon.proto",
+  "MessageTransport.proto",
+  "WAMediaTransport.proto",
+  "MessageApplication.proto",
+  "ConsumerApplication.proto",
+  "ArmadilloApplication.proto",
+  "ArmadilloICDC.proto"
+]);
+
+const MsgTransportType = root.lookupType("waMsgTransport.MessageTransport");
+const MsgApplicationType = root.lookupType("WAMsgApplication.MessageApplication");
+const ConsumerAppType = root.lookupType("waConsumerApplication.ConsumerApplication");
+const ArmadilloAppType = root.lookupType("waArmadilloApplication.Armadillo");
+const ICDCIdentityListType = root.lookupType("waArmadilloICDC.ICDCIdentityList");
+const SignedICDCIdentityListType = root.lookupType("waArmadilloICDC.SignedICDCIdentityList");
+const ImageTransportType = root.lookupType("WAMediaTransport.ImageTransport");
+const VideoTransportType = root.lookupType("WAMediaTransport.VideoTransport");
+const AudioTransportType = root.lookupType("WAMediaTransport.AudioTransport");
+const DocumentTransportType = root.lookupType("WAMediaTransport.DocumentTransport");
+const StickerTransportType = root.lookupType("WAMediaTransport.StickerTransport");
+
+export function decodeMessageTransport(buffer: Buffer): any {
+  const msg = MsgTransportType.decode(buffer);
+  return MsgTransportType.toObject(msg, { longs: Number, enums: String, bytes: Buffer });
+}
+
+export function decodeMessageApplication(buffer: Buffer): any {
+  const msg = MsgApplicationType.decode(buffer);
+  return MsgApplicationType.toObject(msg, { longs: Number, enums: String, bytes: Buffer });
+}
+
+export function decodeConsumerApplication(buffer: Buffer): any {
+  const msg = ConsumerAppType.decode(buffer);
+  return ConsumerAppType.toObject(msg, { longs: String, enums: String, bytes: Buffer });
+}
+
+export function decodeArmadillo(buffer: Buffer): any {
+  const msg = ArmadilloAppType.decode(buffer);
+  return ArmadilloAppType.toObject(msg, { longs: String, enums: String, bytes: Buffer });
+}
+
+export function decodeImageTransport(buffer: Buffer): any {
+  const msg = ImageTransportType.decode(buffer);
+  return ImageTransportType.toObject(msg, { longs: Number, enums: String, bytes: Buffer });
+}
+
+export function decodeVideoTransport(buffer: Buffer): any {
+  const msg = VideoTransportType.decode(buffer);
+  return VideoTransportType.toObject(msg, { longs: Number, enums: String, bytes: Buffer });
+}
+
+export function decodeAudioTransport(buffer: Buffer): any {
+  const msg = AudioTransportType.decode(buffer);
+  return AudioTransportType.toObject(msg, { longs: Number, enums: String, bytes: Buffer });
+}
+
+export function decodeDocumentTransport(buffer: Buffer): any {
+  const msg = DocumentTransportType.decode(buffer);
+  return DocumentTransportType.toObject(msg, { longs: Number, enums: String, bytes: Buffer });
+}
+
+export function decodeStickerTransport(buffer: Buffer): any {
+  const msg = StickerTransportType.decode(buffer);
+  return StickerTransportType.toObject(msg, { longs: Number, enums: String, bytes: Buffer });
+}
+
+export function encodeICDCIdentityList(data: {
+  seq: number;
+  timestamp: number;
+  devices: Buffer[];
+  signingDeviceIndex: number;
+}): Buffer {
+  const msg = ICDCIdentityListType.create(data);
+  return Buffer.from(ICDCIdentityListType.encode(msg).finish());
+}
+
+export function encodeSignedICDCIdentityList(data: {
+  details: Buffer;
+  signature: Buffer;
+}): Buffer {
+  const msg = SignedICDCIdentityListType.create(data);
+  return Buffer.from(SignedICDCIdentityListType.encode(msg).finish());
+}
+
+export function decodeICDCFetchResponse(buffer: Buffer): any {
+  // Not a proto, but we might need it
+}

package/src/e2ee/message/constants.ts

@@ -0,0 +1,4 @@
+export const FB_MESSAGE_VERSION = 3;
+export const FB_MESSAGE_APPLICATION_VERSION = 2;
+export const FB_CONSUMER_MESSAGE_VERSION = 1;
+export const FB_ARMADILLO_MESSAGE_VERSION = 1;

package/src/e2ee/message/message-builder.ts

@@ -0,0 +1,15 @@
+/**
+ * Message layer public barrel.
+ *
+ * Keep imports here stable while implementations live under proto/, builders/,
+ * and codecs/. The top-level compatibility shim re-exports this barrel.
+ */
+
+export type { MediaFields, MessageTransportOptions } from "../../models/e2ee.ts";
+export * from "./constants.ts";
+export { ProtoWriter } from "./proto/proto-writer.ts";
+export * from "./builders/client-payload.ts";
+export * from "./builders/consumer-application.ts";
+export * from "./builders/message-application.ts";
+export * from "./builders/message-transport.ts";
+export * from "./codecs/protobuf-codecs.ts";

package/src/e2ee/message/proto/ArmadilloApplication.proto

@@ -0,0 +1,281 @@
+syntax = "proto2";
+package waArmadilloApplication;
+
+import "WACommon.proto";
+
+message Armadillo {
+    message Metadata {
+    }
+
+    message Payload {
+        oneof payload {
+            Content content = 1;
+            ApplicationData applicationData = 2;
+            Signal signal = 3;
+            SubProtocolPayload subProtocol = 4;
+        }
+    }
+
+    message SubProtocolPayload {
+        optional WACommon.FutureProofBehavior futureProof = 1;
+    }
+
+    message Signal {
+        message EncryptedBackupsSecrets {
+            message Epoch {
+                enum EpochStatus {
+                    ES_OPEN = 1;
+                    ES_CLOSE = 2;
+                }
+
+                optional uint64 ID = 1;
+                optional bytes anonID = 2;
+                optional bytes rootKey = 3;
+                optional EpochStatus status = 4;
+            }
+
+            optional uint64 backupID = 1;
+            optional uint64 serverDataID = 2;
+            repeated Epoch epoch = 3;
+            optional bytes tempOcmfClientState = 4;
+            optional bytes mailboxRootKey = 5;
+            optional bytes obliviousValidationToken = 6;
+        }
+
+        oneof signal {
+            EncryptedBackupsSecrets encryptedBackupsSecrets = 1;
+        }
+    }
+
+    message ApplicationData {
+        message MessageHistoryDocumentMessage {
+            optional WACommon.SubProtocol document = 1;
+        }
+
+        message AIBotResponseMessage {
+            optional string summonToken = 1;
+            optional string messageText = 2;
+            optional string serializedExtras = 3;
+        }
+
+        message MetadataSyncAction {
+            message SyncAttachmentInterventionAction {
+                enum InterventionType {
+                    UNKNOWN = 0;
+                    NUDE = 1;
+                    NOT_NUDE = 2;
+                }
+
+                optional WACommon.MessageKey messageKey = 1;
+                optional InterventionType interventionType = 2;
+            }
+
+            message SyncSpectraAction {
+                enum SpectraActionType {
+                    TAKEDOWN = 0;
+                    RESTORE = 1;
+                }
+
+                optional WACommon.MessageKey key = 1;
+                optional SpectraActionType actionType = 2;
+                optional int64 takedownActionID = 3;
+                optional string config = 4;
+            }
+
+            message SyncMessageAction {
+                message ActionMessageDelete {
+                }
+
+                oneof action {
+                    ActionMessageDelete messageDelete = 101;
+                }
+
+                optional WACommon.MessageKey key = 1;
+            }
+
+            message SyncChatAction {
+                message ActionChatRead {
+                    optional SyncActionMessageRange messageRange = 1;
+                    optional bool read = 2;
+                }
+
+                message ActionChatDelete {
+                    optional SyncActionMessageRange messageRange = 1;
+                }
+
+                message ActionChatArchive {
+                    optional SyncActionMessageRange messageRange = 1;
+                    optional bool archived = 2;
+                }
+
+                oneof action {
+                    ActionChatArchive chatArchive = 101;
+                    ActionChatDelete chatDelete = 102;
+                    ActionChatRead chatRead = 103;
+                }
+
+                optional string chatID = 1;
+            }
+
+            message SyncActionMessage {
+                optional WACommon.MessageKey key = 1;
+                optional int64 timestamp = 2;
+            }
+
+            message SyncActionMessageRange {
+                optional int64 lastMessageTimestamp = 1;
+                optional int64 lastSystemMessageTimestamp = 2;
+                repeated SyncActionMessage messages = 3;
+            }
+
+            oneof actionType {
+                SyncChatAction chatAction = 101;
+                SyncMessageAction messageAction = 102;
+                SyncSpectraAction spectraAction = 103;
+                SyncAttachmentInterventionAction attachmentInterventionAction = 104;
+            }
+
+            optional int64 actionTimestamp = 1;
+        }
+
+        message MetadataSyncNotification {
+            repeated MetadataSyncAction actions = 2;
+        }
+
+        oneof applicationData {
+            MetadataSyncNotification metadataSync = 1;
+            AIBotResponseMessage aiBotResponse = 2;
+            MessageHistoryDocumentMessage messageHistoryDocumentMessage = 3;
+        }
+    }
+
+    message Content {
+        message PaymentsTransactionMessage {
+            enum PaymentStatus {
+                PAYMENT_UNKNOWN = 0;
+                REQUEST_INITED = 4;
+                REQUEST_DECLINED = 5;
+                REQUEST_TRANSFER_INITED = 6;
+                REQUEST_TRANSFER_COMPLETED = 7;
+                REQUEST_TRANSFER_FAILED = 8;
+                REQUEST_CANCELED = 9;
+                REQUEST_EXPIRED = 10;
+                TRANSFER_INITED = 11;
+                TRANSFER_PENDING = 12;
+                TRANSFER_PENDING_RECIPIENT_VERIFICATION = 13;
+                TRANSFER_CANCELED = 14;
+                TRANSFER_COMPLETED = 15;
+                TRANSFER_NO_RECEIVER_CREDENTIAL_NO_RTS_PENDING_CANCELED = 16;
+                TRANSFER_NO_RECEIVER_CREDENTIAL_NO_RTS_PENDING_OTHER = 17;
+                TRANSFER_REFUNDED = 18;
+                TRANSFER_PARTIAL_REFUND = 19;
+                TRANSFER_CHARGED_BACK = 20;
+                TRANSFER_EXPIRED = 21;
+                TRANSFER_DECLINED = 22;
+                TRANSFER_UNAVAILABLE = 23;
+            }
+
+            optional uint64 transactionID = 1;
+            optional string amount = 2;
+            optional string currency = 3;
+            optional PaymentStatus paymentStatus = 4;
+            // optional waArmadilloXMA.ExtendedContentMessage extendedContentMessage = 5;
+        }
+
+        message NetworkVerificationMessage {
+            optional string codeText = 1;
+        }
+
+        message NoteReplyMessage {
+            oneof noteReplyContent {
+                WACommon.MessageText textContent = 4;
+                WACommon.SubProtocol stickerContent = 5;
+                WACommon.SubProtocol videoContent = 6;
+            }
+
+            optional string noteID = 1;
+            optional WACommon.MessageText noteText = 2;
+            optional int64 noteTimestampMS = 3;
+        }
+
+        message BumpExistingMessage {
+            optional WACommon.MessageKey key = 1;
+        }
+
+        message ImageGalleryMessage {
+            repeated WACommon.SubProtocol images = 1;
+        }
+
+        message ScreenshotAction {
+            enum ScreenshotType {
+                SCREENSHOT_IMAGE = 1;
+                SCREEN_RECORDING = 2;
+            }
+
+            optional ScreenshotType screenshotType = 1;
+        }
+
+        message ExtendedContentMessageWithSear {
+            optional string searID = 1;
+            optional bytes payload = 2;
+            optional string nativeURL = 3;
+            optional WACommon.SubProtocol searAssociatedMessage = 4;
+            optional string searSentWithMessageID = 5;
+        }
+
+        message RavenActionNotifMessage {
+            enum ActionType {
+                PLAYED = 0;
+                SCREENSHOT = 1;
+                FORCE_DISABLE = 2;
+            }
+
+            optional WACommon.MessageKey key = 1;
+            optional int64 actionTimestamp = 2;
+            optional ActionType actionType = 3;
+        }
+
+        message RavenMessage {
+            enum EphemeralType {
+                VIEW_ONCE = 0;
+                ALLOW_REPLAY = 1;
+                KEEP_IN_CHAT = 2;
+            }
+
+            oneof mediaContent {
+                WACommon.SubProtocol imageMessage = 2;
+                WACommon.SubProtocol videoMessage = 3;
+            }
+
+            optional EphemeralType ephemeralType = 1;
+        }
+
+        message CommonSticker {
+            enum StickerType {
+                SMALL_LIKE = 1;
+                MEDIUM_LIKE = 2;
+                LARGE_LIKE = 3;
+            }
+
+            optional StickerType stickerType = 1;
+        }
+
+        oneof content {
+            CommonSticker commonSticker = 1;
+            ScreenshotAction screenshotAction = 3;
+            // waArmadilloXMA.ExtendedContentMessage extendedContentMessage = 4;
+            RavenMessage ravenMessage = 5;
+            RavenActionNotifMessage ravenActionNotifMessage = 6;
+            ExtendedContentMessageWithSear extendedMessageContentWithSear = 7;
+            ImageGalleryMessage imageGalleryMessage = 8;
+            PaymentsTransactionMessage paymentsTransactionMessage = 10;
+            BumpExistingMessage bumpExistingMessage = 11;
+            NoteReplyMessage noteReplyMessage = 13;
+            RavenMessage ravenMessageMsgr = 14;
+            NetworkVerificationMessage networkVerificationMessage = 15;
+        }
+    }
+
+    optional Payload payload = 1;
+    optional Metadata metadata = 2;
+}

package/src/e2ee/message/proto/ArmadilloICDC.proto

@@ -0,0 +1,14 @@
+syntax = "proto2";
+package waArmadilloICDC;
+
+message ICDCIdentityList {
+  optional int32 seq = 1;
+  optional int64 timestamp = 2;
+  repeated bytes devices = 3;
+  optional int32 signingDeviceIndex = 4;
+}
+
+message SignedICDCIdentityList {
+  optional bytes details = 1;
+  optional bytes signature = 2;
+}

package/src/e2ee/message/proto/ConsumerApplication.proto

@@ -0,0 +1,232 @@
+syntax = "proto2";
+package waConsumerApplication;
+
+import "WACommon.proto";
+
+message ConsumerApplication {
+	message Payload {
+		oneof payload {
+			Content content = 1;
+			ApplicationData applicationData = 2;
+			Signal signal = 3;
+			SubProtocolPayload subProtocol = 4;
+		}
+	}
+
+	message SubProtocolPayload {
+		optional WACommon.FutureProofBehavior futureProof = 1;
+	}
+
+	message Metadata {
+		enum SpecialTextSize {
+			SMALL = 1;
+			MEDIUM = 2;
+			LARGE = 3;
+		}
+
+		optional SpecialTextSize specialTextSize = 1;
+	}
+
+	message Signal {
+	}
+
+	message ApplicationData {
+		oneof applicationContent {
+			RevokeMessage revoke = 1;
+		}
+	}
+
+	message Content {
+		oneof content {
+			WACommon.MessageText messageText = 1;
+			ImageMessage imageMessage = 2;
+			ContactMessage contactMessage = 3;
+			LocationMessage locationMessage = 4;
+			ExtendedTextMessage extendedTextMessage = 5;
+			StatusTextMesage statusTextMessage = 6;
+			DocumentMessage documentMessage = 7;
+			AudioMessage audioMessage = 8;
+			VideoMessage videoMessage = 9;
+			ContactsArrayMessage contactsArrayMessage = 10;
+			LiveLocationMessage liveLocationMessage = 11;
+			StickerMessage stickerMessage = 12;
+			GroupInviteMessage groupInviteMessage = 13;
+			ViewOnceMessage viewOnceMessage = 14;
+			ReactionMessage reactionMessage = 16;
+			PollCreationMessage pollCreationMessage = 17;
+			PollUpdateMessage pollUpdateMessage = 18;
+			EditMessage editMessage = 19;
+		}
+	}
+
+	message EditMessage {
+		optional WACommon.MessageKey key = 1;
+		optional WACommon.MessageText message = 2;
+		optional int64 timestampMS = 3;
+	}
+
+	message PollAddOptionMessage {
+		repeated Option pollOption = 1;
+	}
+
+	message PollVoteMessage {
+		repeated bytes selectedOptions = 1;
+		optional int64 senderTimestampMS = 2;
+	}
+
+	message PollEncValue {
+		optional bytes encPayload = 1;
+		optional bytes encIV = 2;
+	}
+
+	message PollUpdateMessage {
+		optional WACommon.MessageKey pollCreationMessageKey = 1;
+		optional PollEncValue vote = 2;
+		optional PollEncValue addOption = 3;
+	}
+
+	message PollCreationMessage {
+		optional bytes encKey = 1;
+		optional string name = 2;
+		repeated Option options = 3;
+		optional uint32 selectableOptionsCount = 4;
+	}
+
+	message Option {
+		optional string optionName = 1;
+	}
+
+	message ReactionMessage {
+		optional WACommon.MessageKey key = 1;
+		optional string text = 2;
+		optional string groupingKey = 3;
+		optional int64 senderTimestampMS = 4;
+		optional string reactionMetadataDataclassData = 5;
+		optional int32 style = 6;
+	}
+
+	message RevokeMessage {
+		optional WACommon.MessageKey key = 1;
+	}
+
+	message ViewOnceMessage {
+		oneof viewOnceContent {
+			ImageMessage imageMessage = 1;
+			VideoMessage videoMessage = 2;
+		}
+	}
+
+	message GroupInviteMessage {
+		optional string groupJID = 1;
+		optional string inviteCode = 2;
+		optional int64 inviteExpiration = 3;
+		optional string groupName = 4;
+		optional bytes JPEGThumbnail = 5;
+		optional WACommon.MessageText caption = 6;
+	}
+
+	message LiveLocationMessage {
+		optional Location location = 1;
+		optional uint32 accuracyInMeters = 2;
+		optional float speedInMps = 3;
+		optional uint32 degreesClockwiseFromMagneticNorth = 4;
+		optional WACommon.MessageText caption = 5;
+		optional int64 sequenceNumber = 6;
+		optional uint32 timeOffset = 7;
+	}
+
+	message ContactsArrayMessage {
+		optional string displayName = 1;
+		repeated ContactMessage contacts = 2;
+	}
+
+	message ContactMessage {
+		optional WACommon.SubProtocol contact = 1;
+	}
+
+	message StatusTextMesage {
+		enum FontType {
+			SANS_SERIF = 0;
+			SERIF = 1;
+			NORICAN_REGULAR = 2;
+			BRYNDAN_WRITE = 3;
+			BEBASNEUE_REGULAR = 4;
+			OSWALD_HEAVY = 5;
+		}
+
+		optional ExtendedTextMessage text = 1;
+		optional fixed32 textArgb = 6;
+		optional fixed32 backgroundArgb = 7;
+		optional FontType font = 8;
+	}
+
+	message ExtendedTextMessage {
+		enum PreviewType {
+			NONE = 0;
+			VIDEO = 1;
+		}
+
+		optional WACommon.MessageText text = 1;
+		optional string matchedText = 2;
+		optional string canonicalURL = 3;
+		optional string description = 4;
+		optional string title = 5;
+		optional WACommon.SubProtocol thumbnail = 6;
+		optional PreviewType previewType = 7;
+	}
+
+	message LocationMessage {
+		optional Location location = 1;
+		optional string address = 2;
+	}
+
+	message StickerMessage {
+		optional WACommon.SubProtocol sticker = 1;
+	}
+
+	message DocumentMessage {
+		optional WACommon.SubProtocol document = 1;
+		optional string fileName = 2;
+	}
+
+	message VideoMessage {
+		optional WACommon.SubProtocol video = 1;
+		optional WACommon.MessageText caption = 2;
+	}
+
+	message AudioMessage {
+		optional WACommon.SubProtocol audio = 1;
+		optional bool PTT = 2;
+	}
+
+	message ImageMessage {
+		optional WACommon.SubProtocol image = 1;
+		optional WACommon.MessageText caption = 2;
+	}
+
+	message InteractiveAnnotation {
+		oneof action {
+			Location location = 2;
+		}
+
+		repeated Point polygonVertices = 1;
+	}
+
+	message Point {
+		optional double x = 1;
+		optional double y = 2;
+	}
+
+	message Location {
+		optional double degreesLatitude = 1;
+		optional double degreesLongitude = 2;
+		optional string name = 3;
+	}
+
+	message MediaPayload {
+		optional WACommon.SubProtocol protocol = 1;
+	}
+
+	optional Payload payload = 1;
+	optional Metadata metadata = 2;
+}