From fce86989f0b3992cea3e94ca9fef1dada2b709c6 Mon Sep 17 00:00:00 2001 From: audric Date: Tue, 27 Jul 2021 16:41:15 +1000 Subject: [PATCH] make sure profileKey is a hex string in all convos --- js/modules/types/conversation.js | 56 --------------------- ts/interactions/conversationInteractions.ts | 15 +++--- ts/models/conversation.ts | 31 +++++++++--- ts/receiver/configMessage.ts | 5 -- ts/receiver/dataMessage.ts | 21 ++++---- ts/receiver/queuedJob.ts | 15 ++---- ts/receiver/receiver.ts | 36 ------------- ts/session/utils/User.ts | 7 +-- ts/session/utils/syncUtils.ts | 21 +++++--- 9 files changed, 69 insertions(+), 138 deletions(-) diff --git a/js/modules/types/conversation.js b/js/modules/types/conversation.js index cf2123151..fc66a6e7a 100644 --- a/js/modules/types/conversation.js +++ b/js/modules/types/conversation.js @@ -55,60 +55,6 @@ function buildAvatarUpdater({ field }) { } const maybeUpdateAvatar = buildAvatarUpdater({ field: 'avatar' }); -const maybeUpdateProfileAvatar = buildAvatarUpdater({ - field: 'profileAvatar', -}); - -async function upgradeToVersion2(conversation, options) { - if (conversation.version >= 2) { - return conversation; - } - - const { writeNewAttachmentData } = options; - if (!isFunction(writeNewAttachmentData)) { - throw new Error('Conversation.upgradeToVersion2: writeNewAttachmentData must be a function'); - } - - let { avatar, profileAvatar, profileKey } = conversation; - - if (avatar && avatar.data) { - avatar = { - hash: await computeHash(avatar.data), - path: await writeNewAttachmentData(avatar.data), - }; - } - - if (profileAvatar && profileAvatar.data) { - profileAvatar = { - hash: await computeHash(profileAvatar.data), - path: await writeNewAttachmentData(profileAvatar.data), - }; - } - - if (profileKey && profileKey.byteLength) { - profileKey = arrayBufferToBase64(profileKey); - } - - return { - ...conversation, - version: 2, - avatar, - profileAvatar, - profileKey, - }; -} - -async function migrateConversation(conversation, options = {}) { - if (!conversation) { - return conversation; - } - if (!isNumber(conversation.version)) { - // eslint-disable-next-line no-param-reassign - conversation.version = 1; - } - - return upgradeToVersion2(conversation, options); -} async function deleteExternalFiles(conversation, options = {}) { if (!conversation) { @@ -133,9 +79,7 @@ async function deleteExternalFiles(conversation, options = {}) { module.exports = { deleteExternalFiles, - migrateConversation, maybeUpdateAvatar, - maybeUpdateProfileAvatar, createLastMessageUpdate, arrayBufferToBase64, }; diff --git a/ts/interactions/conversationInteractions.ts b/ts/interactions/conversationInteractions.ts index 6a11be9e9..0e9fb3964 100644 --- a/ts/interactions/conversationInteractions.ts +++ b/ts/interactions/conversationInteractions.ts @@ -41,7 +41,7 @@ import { import { getDecryptedMediaUrl } from '../session/crypto/DecryptedAttachmentsManager'; import { IMAGE_JPEG } from '../types/MIME'; import { FSv2 } from '../fileserver'; -import { fromBase64ToArray, toHex } from '../session/utils/String'; +import { fromBase64ToArray, fromHexToArray, toHex } from '../session/utils/String'; import { SessionButtonColor } from '../components/session/SessionButton'; import { perfEnd, perfStart } from '../session/utils/Performance'; import { ReplyingToMessageProps } from '../components/session/conversation/SessionCompositionBox'; @@ -350,17 +350,21 @@ export async function uploadOurAvatar(newAvatarDecrypted?: ArrayBuffer) { return; } - let profileKey; + let profileKey: Uint8Array | null; let decryptedAvatarData; if (newAvatarDecrypted) { // Encrypt with a new key every time - profileKey = window.libsignal.crypto.getRandomBytes(32); + profileKey = window.libsignal.crypto.getRandomBytes(32) as Uint8Array; decryptedAvatarData = newAvatarDecrypted; } else { // this is a reupload. no need to generate a new profileKey - profileKey = window.textsecure.storage.get('profileKey'); + const ourConvoProfileKey = + getConversationController() + .get(UserUtils.getOurPubKeyStrFromCache()) + ?.get('profileKey') || null; + profileKey = ourConvoProfileKey ? fromHexToArray(ourConvoProfileKey) : null; if (!profileKey) { - window.log.info('our profileKey not found'); + window.log.info('our profileKey not found. Not reuploading our avatar'); return; } const currentAttachmentPath = ourConvo.getAvatarPath(); @@ -412,7 +416,6 @@ export async function uploadOurAvatar(newAvatarDecrypted?: ArrayBuffer) { const displayName = ourConvo.get('profileName'); // write the profileKey even if it did not change - window.storage.put('profileKey', profileKey); ourConvo.set({ profileKey: toHex(profileKey) }); // Replace our temporary image with the attachment pointer from the server: // this commits already diff --git a/ts/models/conversation.ts b/ts/models/conversation.ts index ab3c6f25e..9670791ab 100644 --- a/ts/models/conversation.ts +++ b/ts/models/conversation.ts @@ -20,7 +20,7 @@ import { saveMessages, updateConversation, } from '../../ts/data/data'; -import { fromArrayBufferToBase64, fromBase64ToArrayBuffer } from '../session/utils/String'; +import { fromArrayBufferToBase64, fromBase64ToArrayBuffer, toHex } from '../session/utils/String'; import { actions as conversationActions, conversationChanged, @@ -91,6 +91,9 @@ export interface ConversationAttributes { nickname?: string; profile?: any; profileAvatar?: any; + /** + * Consider this being a hex string if it set + */ profileKey?: string; triggerNotificationsFor: ConversationNotificationSettingType; isTrustedForAttachmentDownload: boolean; @@ -128,6 +131,9 @@ export interface ConversationAttributesOptionals { nickname?: string; profile?: any; profileAvatar?: any; + /** + * Consider this being a hex string if it set + */ profileKey?: string; triggerNotificationsFor?: ConversationNotificationSettingType; isTrustedForAttachmentDownload?: boolean; @@ -1194,15 +1200,28 @@ export class ConversationModel extends Backbone.Model { await this.commit(); } } - public async setProfileKey(profileKey: string) { + /** + * profileKey MUST be a hex string + * @param profileKey MUST be a hex string + */ + public async setProfileKey(profileKey?: Uint8Array, autoCommit = true) { + const re = /[0-9A-Fa-f]*/g; + + if (!profileKey) { + return; + } + + const profileKeyHex = toHex(profileKey); + // profileKey is a string so we can compare it directly - if (this.get('profileKey') !== profileKey) { + if (this.get('profileKey') !== profileKeyHex) { this.set({ - profileKey, + profileKey: profileKeyHex, }); - - await this.commit(); + if (autoCommit) { + await this.commit(); + } } } diff --git a/ts/receiver/configMessage.ts b/ts/receiver/configMessage.ts index 54ea9cc50..63590efcc 100644 --- a/ts/receiver/configMessage.ts +++ b/ts/receiver/configMessage.ts @@ -34,11 +34,6 @@ async function handleOurProfileUpdate( return; } - if (profileKey?.length) { - window?.log?.info('Saving our profileKey from configuration message'); - // TODO not sure why we keep our profileKey in storage AND in our conversaio - window.textsecure.storage.put('profileKey', profileKey); - } const lokiProfile = { displayName, profilePicture, diff --git a/ts/receiver/dataMessage.ts b/ts/receiver/dataMessage.ts index deacbe123..c82f78d55 100644 --- a/ts/receiver/dataMessage.ts +++ b/ts/receiver/dataMessage.ts @@ -20,11 +20,12 @@ import { } from '../../ts/data/data'; import { ConversationModel, ConversationTypeEnum } from '../models/conversation'; import { allowOnlyOneAtATime } from '../session/utils/Promise'; +import { toHex } from '../session/utils/String'; export async function updateProfileOneAtATime( conversation: ConversationModel, profile: SignalService.DataMessage.ILokiProfile, - profileKey: any + profileKey?: Uint8Array | null // was any ) { if (!conversation?.id) { window?.log?.warn('Cannot update profile with empty convoid'); @@ -39,13 +40,18 @@ export async function updateProfileOneAtATime( async function updateProfile( conversation: ConversationModel, profile: SignalService.DataMessage.ILokiProfile, - profileKey: any + profileKey?: Uint8Array | null // was any ) { const { dcodeIO, textsecure, Signal } = window; // Retain old values unless changed: const newProfile = conversation.get('profile') || {}; + if (!profileKey) { + window.log.warn("No need to try to update profile. We don't have a profile key"); + return; + } + newProfile.displayName = profile.displayName; if (profile.profilePicture) { @@ -79,7 +85,7 @@ async function updateProfile( }); // Only update the convo if the download and decrypt is a success conversation.set('avatarPointer', profile.profilePicture); - conversation.set('profileKey', profileKey); + conversation.set('profileKey', toHex(profileKey)); ({ path } = upgraded); } catch (e) { window?.log?.error(`Could not decrypt profile image: ${e}`); @@ -422,18 +428,15 @@ export const isDuplicate = ( async function handleProfileUpdate( profileKeyBuffer: Uint8Array, convoId: string, - convoType: ConversationTypeEnum, isIncoming: boolean ) { - const profileKey = StringUtils.decode(profileKeyBuffer, 'base64'); - if (!isIncoming) { // We update our own profileKey if it's different from what we have const ourNumber = UserUtils.getOurPubKeyStrFromCache(); const me = getConversationController().getOrCreate(ourNumber, ConversationTypeEnum.PRIVATE); // Will do the save for us if needed - await me.setProfileKey(profileKey); + await me.setProfileKey(profileKeyBuffer); } else { const sender = await getConversationController().getOrCreateAndWait( convoId, @@ -441,7 +444,7 @@ async function handleProfileUpdate( ); // Will do the save for us - await sender.setProfileKey(profileKey); + await sender.setProfileKey(profileKeyBuffer); } } @@ -582,7 +585,7 @@ export async function handleMessageEvent(event: MessageEvent): Promise { return; } if (message.profileKey?.length) { - await handleProfileUpdate(message.profileKey, conversationId, type, isIncoming); + await handleProfileUpdate(message.profileKey, conversationId, isIncoming); } const msg = createMessage(data, isIncoming); diff --git a/ts/receiver/queuedJob.ts b/ts/receiver/queuedJob.ts index 809025a57..940d1b3bc 100644 --- a/ts/receiver/queuedJob.ts +++ b/ts/receiver/queuedJob.ts @@ -204,16 +204,14 @@ function handleLinkPreviews(messageBody: string, messagePreview: any, message: M } async function processProfileKey( - source: string, conversation: ConversationModel, sendingDeviceConversation: ConversationModel, - profileKeyBuffer: Uint8Array + profileKeyBuffer?: Uint8Array ) { - const profileKey = StringUtils.decode(profileKeyBuffer, 'base64'); if (conversation.isPrivate()) { - await conversation.setProfileKey(profileKey); + await conversation.setProfileKey(profileKeyBuffer); } else { - await sendingDeviceConversation.setProfileKey(profileKey); + await sendingDeviceConversation.setProfileKey(profileKeyBuffer); } } @@ -360,12 +358,7 @@ async function handleRegularMessage( } if (dataMessage.profileKey) { - await processProfileKey( - source, - conversation, - sendingDeviceConversation, - dataMessage.profileKey - ); + await processProfileKey(conversation, sendingDeviceConversation, dataMessage.profileKey); } // we just received a message from that user so we reset the typing indicator for this convo diff --git a/ts/receiver/receiver.ts b/ts/receiver/receiver.ts index f41e3d05e..b2ad6aa5b 100644 --- a/ts/receiver/receiver.ts +++ b/ts/receiver/receiver.ts @@ -273,42 +273,6 @@ async function handleDecryptedEnvelope(envelope: EnvelopePlus, plaintext: ArrayB } } -/** - * Only used for opengroupv1 it seems. - * To be removed soon - */ -export async function handlePublicMessage(messageData: any) { - const { source } = messageData; - const { group, profile, profileKey } = messageData.message; - - const isMe = UserUtils.isUsFromCache(source); - - if (!isMe && profile) { - const conversation = await getConversationController().getOrCreateAndWait( - source, - ConversationTypeEnum.PRIVATE - ); - await updateProfileOneAtATime(conversation, profile, profileKey); - } - - const isPublicVisibleMessage = group && group.id && !!group.id.match(openGroupPrefixRegex); - - if (!isPublicVisibleMessage) { - throw new Error('handlePublicMessage Should only be called with public message groups'); - } - - const ev = { - // Public chat messages from ourselves should be outgoing - type: isMe ? 'sent' : 'message', - data: messageData, - confirm: () => { - /* do nothing */ - }, - }; - - await handleMessageEvent(ev); // open groups v1 -} - export async function handleOpenGroupV2Message( message: OpenGroupMessageV2, roomInfos: OpenGroupRequestCommonType diff --git a/ts/session/utils/User.ts b/ts/session/utils/User.ts index 38644b5fc..8cd1eb545 100644 --- a/ts/session/utils/User.ts +++ b/ts/session/utils/User.ts @@ -3,7 +3,7 @@ import { UserUtils } from '.'; import { getItemById } from '../../../ts/data/data'; import { KeyPair } from '../../../libtextsecure/libsignal-protocol'; import { PubKey } from '../types'; -import { toHex } from './String'; +import { fromHexToArray, toHex } from './String'; import { getConversationController } from '../conversations'; export type HexKeyPair = { @@ -97,14 +97,15 @@ export function getOurProfile(): OurLokiProfile | undefined { // in their primary device's conversation const ourNumber = window.storage.get('primaryDevicePubKey'); const ourConversation = getConversationController().get(ourNumber); - const profileKey = new Uint8Array(window.storage.get('profileKey')); + const ourProfileKeyHex = ourConversation.get('profileKey'); + const profileKeyAsBytes = ourProfileKeyHex ? fromHexToArray(ourProfileKeyHex) : null; const avatarPointer = ourConversation.get('avatarPointer'); const { displayName } = ourConversation.getLokiProfile(); return { displayName, avatarPointer, - profileKey: profileKey.length ? profileKey : null, + profileKey: profileKeyAsBytes?.length ? profileKeyAsBytes : null, }; } catch (e) { window?.log?.error(`Failed to get our profile: ${e}`); diff --git a/ts/session/utils/syncUtils.ts b/ts/session/utils/syncUtils.ts index a40be7046..affe3a963 100644 --- a/ts/session/utils/syncUtils.ts +++ b/ts/session/utils/syncUtils.ts @@ -14,7 +14,7 @@ import { ConfigurationMessageContact, } from '../messages/outgoing/controlMessage/ConfigurationMessage'; import { ConversationModel } from '../../models/conversation'; -import { fromBase64ToArray } from './String'; +import { fromBase64ToArray, fromHexToArray } from './String'; import { SignalService } from '../../protobuf'; import _ from 'lodash'; import { @@ -160,9 +160,14 @@ const getValidContacts = (convos: Array) => { const contacts = contactsModels.map(c => { try { - const profileKeyForContact = c.get('profileKey') - ? fromBase64ToArray(c.get('profileKey') as string) - : undefined; + const profileKey = c.get('profileKey'); + let profileKeyForContact; + if (typeof profileKey === 'string') { + profileKeyForContact = fromHexToArray(profileKey); + } else if (profileKey) { + console.warn('AUDRIC migration todo'); + debugger; + } return new ConfigurationMessageContact({ publicKey: c.id, @@ -189,8 +194,12 @@ export const getCurrentConfigurationMessage = async (convos: Array