feat: add companion registration utilities

src/Socket/socket.ts

@@ -1,4 +1,4 @@
 import { Boom } from '@hapi/boom'
 import { randomBytes } from 'crypto'
 import { URL } from 'url'
 import { promisify } from 'util'
@@ -21,12 +21,14 @@
 	aesEncryptCTR,
 	bindWaitForConnectionUpdate,
 	bytesToCrockford,
+	buildPairingQRData,
 	configureSuccessfulPairing,
 	Curve,
 	derivePairingCodeKey,
 	generateLoginNode,
 	generateMdTagPrefix,
 	generateRegistrationNode,
+	getCompanionPlatformId,
 	getCodeFromWSError,
 	getErrorCodeFromStreamError,
 	getNextPreKeysNode,
@@ -36,7 +38,6 @@
 	signedKeyPair,
 	xmppSignedPreKey
 } from '../Utils'
-import { getPlatformId } from '../Utils/browser-utils'
 import {
 	assertNodeErrorFree,
 	type BinaryNode,
@@ -206,7 +207,7 @@
 
 		const msgId = node.attrs.id
 
 		const result = await promiseTimeout<any>(timeoutMs, async (resolve, reject) => {
 			const result = waitForMessage(msgId, timeoutMs).catch(reject)
 			sendNode(node)
 				.then(async () => resolve(await result))
@@ -790,7 +791,7 @@
 						{
 							tag: 'companion_platform_id',
 							attrs: {},
-							content: getPlatformId(browser[1])
+							content: getCompanionPlatformId(browser)
 						},
 						{
 							tag: 'companion_platform_display',
@@ -840,7 +841,7 @@
 	ws.on('open', async () => {
 		try {
 			await validateConnection()
 		} catch (err: any) {
 			logger.error({ err }, 'error in validating connection')
 			void end(err)
 		}
@@ -883,7 +884,7 @@
 			}
 
 			const ref = (refNode.content as Buffer).toString('utf-8')
-			const qr = [ref, noiseKeyB64, identityKeyB64, advB64].join(',')
+			const qr = buildPairingQRData(ref, noiseKeyB64, identityKeyB64, advB64, browser)
 
 			ev.emit('connection.update', { qr })
 
@@ -911,7 +912,7 @@
 
 			await sendNode(reply)
 			void sendUnifiedSession()
 		} catch (error: any) {
 			logger.info({ trace: error.stack }, 'error in pairing')
 			void end(error)
 		}

src/Utils/companion-reg-client-utils.ts

@@ -0,0 +1,45 @@
+import type { WABrowserDescription } from '../Types'
+
+export enum CompanionWebClientType {
+	UNKNOWN = 0,
+	CHROME = 1,
+	EDGE = 2,
+	FIREFOX = 3,
+	IE = 4,
+	OPERA = 5,
+	SAFARI = 6,
+	ELECTRON = 7,
+	UWP = 8,
+	OTHER_WEB_CLIENT = 9
+}
+
+const BROWSER_TO_COMPANION_WEB_CLIENT: Record<string, CompanionWebClientType> = {
+	Chrome: CompanionWebClientType.CHROME,
+	Edge: CompanionWebClientType.EDGE,
+	Firefox: CompanionWebClientType.FIREFOX,
+	IE: CompanionWebClientType.IE,
+	Opera: CompanionWebClientType.OPERA,
+	Safari: CompanionWebClientType.SAFARI
+}
+
+export const getCompanionWebClientType = ([os, browserName]: WABrowserDescription): CompanionWebClientType => {
+	if (browserName === 'Desktop') {
+		return os === 'Windows' ? CompanionWebClientType.UWP : CompanionWebClientType.ELECTRON
+	}
+
+	return BROWSER_TO_COMPANION_WEB_CLIENT[browserName] || CompanionWebClientType.OTHER_WEB_CLIENT
+}
+
+export const getCompanionPlatformId = (browser: WABrowserDescription): string => {
+	return getCompanionWebClientType(browser).toString()
+}
+
+export const buildPairingQRData = (
+	ref: string,
+	noiseKeyB64: string,
+	identityKeyB64: string,
+	advB64: string,
+	browser: WABrowserDescription
+): string => {
+	return [ref, noiseKeyB64, identityKeyB64, advB64, getCompanionPlatformId(browser)].join(',')
+}

src/Utils/index.ts

@@ -16,5 +16,6 @@ export * from './event-buffer'
 export * from './process-message'
 export * from './message-retry-manager'
 export * from './browser-utils'
+export * from './companion-reg-client-utils'
 export * from './identity-change-handler'
 export * from './stanza-ack'