684 lines
20 KiB
TypeScript
684 lines
20 KiB
TypeScript
// Copyright 2022 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
import type { ProfileKeyCredentialRequestContext } from '@signalapp/libsignal-client/zkgroup';
|
|
import PQueue from 'p-queue';
|
|
import { isNumber } from 'lodash';
|
|
|
|
import type { ConversationModel } from '../models/conversations';
|
|
import type {
|
|
GetProfileOptionsType,
|
|
GetProfileUnauthOptionsType,
|
|
CapabilitiesType,
|
|
} from '../textsecure/WebAPI';
|
|
import MessageSender from '../textsecure/SendMessage';
|
|
import type { ServiceIdString } from '../types/ServiceId';
|
|
import { DataWriter } from '../sql/Client';
|
|
import * as log from '../logging/log';
|
|
import * as Errors from '../types/errors';
|
|
import * as Bytes from '../Bytes';
|
|
import { explodePromise } from '../util/explodePromise';
|
|
import { isRecord } from '../util/isRecord';
|
|
import { sleep } from '../util/sleep';
|
|
import { MINUTE, SECOND } from '../util/durations';
|
|
import {
|
|
generateProfileKeyCredentialRequest,
|
|
getClientZkProfileOperations,
|
|
handleProfileKeyCredential,
|
|
} from '../util/zkgroup';
|
|
import { isMe } from '../util/whatTypeOfConversation';
|
|
import { getUserLanguages } from '../util/userLanguages';
|
|
import { parseBadgesFromServer } from '../badges/parseBadgesFromServer';
|
|
import { strictAssert } from '../util/assert';
|
|
import { drop } from '../util/drop';
|
|
import { findRetryAfterTimeFromError } from '../jobs/helpers/findRetryAfterTimeFromError';
|
|
import { singleProtoJobQueue } from '../jobs/singleProtoJobQueue';
|
|
import { SEALED_SENDER } from '../types/SealedSender';
|
|
import { HTTPError } from '../textsecure/Errors';
|
|
import { Address } from '../types/Address';
|
|
import { QualifiedAddress } from '../types/QualifiedAddress';
|
|
import { trimForDisplay, verifyAccessKey, decryptProfile } from '../Crypto';
|
|
|
|
type JobType = {
|
|
resolve: () => void;
|
|
reject: (error: Error) => void;
|
|
promise: Promise<void>;
|
|
startTime: number;
|
|
};
|
|
|
|
// Goals for this service:
|
|
// 1. Ensure that when we get a 413/429 from the server, we stop firing off profile
|
|
// fetches for a while.
|
|
// 2. Ensure that all existing profile fetches don't hang in this case; to solve this we
|
|
// cancel all outstanding requests when we hit a 413/429, and throw instead of
|
|
// queueing something new if we're waiting due to a retry-after. Note: It's no worse
|
|
// than what we were doing before, failing all requests and pushing the retry-after
|
|
// time out further.
|
|
// 3. Require no changes to callers.
|
|
|
|
// Potential future goals for this problem area:
|
|
// - Update all getProfiles() callers; make them resilient to longer delays
|
|
// - Keep track of last profile fetch per conversation, reduce unnecessary re-fetches
|
|
// - Enforce a maximum profile fetch frequency
|
|
// - Don't even attempt jobs when offline
|
|
|
|
const OBSERVED_CAPABILITY_KEYS = Object.keys({
|
|
deleteSync: true,
|
|
versionedExpirationTimer: true,
|
|
} satisfies CapabilitiesType) as ReadonlyArray<keyof CapabilitiesType>;
|
|
|
|
export class ProfileService {
|
|
private jobQueue: PQueue;
|
|
|
|
private jobsByConversationId: Map<string, JobType> = new Map();
|
|
|
|
private isPaused = false;
|
|
|
|
constructor(private fetchProfile = doGetProfile) {
|
|
this.jobQueue = new PQueue({ concurrency: 3, timeout: MINUTE * 2 });
|
|
this.jobsByConversationId = new Map();
|
|
|
|
log.info('Profile Service initialized');
|
|
}
|
|
|
|
public async get(conversationId: string): Promise<void> {
|
|
const preCheckConversation =
|
|
window.ConversationController.get(conversationId);
|
|
if (!preCheckConversation) {
|
|
throw new Error(
|
|
`ProfileServices.get: Pre-check conversation ${conversationId} not found`
|
|
);
|
|
}
|
|
|
|
if (window.ConversationController.isSignalConversationId(conversationId)) {
|
|
return;
|
|
}
|
|
|
|
if (this.isPaused) {
|
|
throw new Error(
|
|
`ProfileService.get: Cannot add job to paused queue for conversation ${preCheckConversation.idForLogging()}`
|
|
);
|
|
}
|
|
|
|
const existing = this.jobsByConversationId.get(conversationId);
|
|
if (existing) {
|
|
return existing.promise;
|
|
}
|
|
|
|
const { resolve, reject, promise } = explodePromise<void>();
|
|
const jobData = {
|
|
promise,
|
|
resolve,
|
|
reject,
|
|
startTime: Date.now(),
|
|
};
|
|
|
|
const job = async () => {
|
|
const conversation = window.ConversationController.get(conversationId);
|
|
if (!conversation) {
|
|
throw new Error(
|
|
`ProfileServices.get: Conversation ${conversationId} not found`
|
|
);
|
|
}
|
|
|
|
try {
|
|
await this.fetchProfile(conversation);
|
|
resolve();
|
|
} catch (error) {
|
|
reject(error);
|
|
|
|
if (this.isPaused) {
|
|
return;
|
|
}
|
|
|
|
if (isRecord(error) && 'code' in error) {
|
|
if (error.code === -1) {
|
|
this.clearAll('Failed to connect to the server');
|
|
} else if (error.code === 413 || error.code === 429) {
|
|
this.clearAll(`got ${error.code} from server`);
|
|
const time = findRetryAfterTimeFromError(error);
|
|
void this.pause(time);
|
|
}
|
|
}
|
|
} finally {
|
|
this.jobsByConversationId.delete(conversationId);
|
|
|
|
const now = Date.now();
|
|
const delta = now - jobData.startTime;
|
|
if (delta > 30 * SECOND) {
|
|
log.warn(
|
|
`ProfileServices.get: Job for ${conversation.idForLogging()} finished ${delta}ms after queue`
|
|
);
|
|
}
|
|
const remainingItems = this.jobQueue.size;
|
|
if (remainingItems && remainingItems % 10 === 0) {
|
|
log.info(
|
|
`ProfileServices.get: ${remainingItems} jobs remaining in the queue`
|
|
);
|
|
}
|
|
}
|
|
};
|
|
|
|
this.jobsByConversationId.set(conversationId, jobData);
|
|
drop(this.jobQueue.add(job));
|
|
|
|
return promise;
|
|
}
|
|
|
|
public clearAll(reason: string): void {
|
|
if (this.isPaused) {
|
|
log.warn(
|
|
`ProfileService.clearAll: Already paused; not clearing; reason: '${reason}'`
|
|
);
|
|
return;
|
|
}
|
|
|
|
log.info(`ProfileService.clearAll: Clearing; reason: '${reason}'`);
|
|
|
|
try {
|
|
this.isPaused = true;
|
|
this.jobQueue.pause();
|
|
|
|
this.jobsByConversationId.forEach(job => {
|
|
job.reject(
|
|
new Error(
|
|
`ProfileService.clearAll: job cancelled because '${reason}'`
|
|
)
|
|
);
|
|
});
|
|
|
|
this.jobsByConversationId.clear();
|
|
this.jobQueue.clear();
|
|
|
|
this.jobQueue.start();
|
|
} finally {
|
|
this.isPaused = false;
|
|
log.info('ProfileService.clearAll: Done clearing');
|
|
}
|
|
}
|
|
|
|
public async pause(timeInMS: number): Promise<void> {
|
|
if (this.isPaused) {
|
|
log.warn('ProfileService.pause: Already paused, not pausing again.');
|
|
return;
|
|
}
|
|
|
|
log.info(`ProfileService.pause: Pausing queue for ${timeInMS}ms`);
|
|
|
|
this.isPaused = true;
|
|
this.jobQueue.pause();
|
|
|
|
try {
|
|
await sleep(timeInMS);
|
|
} finally {
|
|
log.info('ProfileService.pause: Restarting queue');
|
|
this.jobQueue.start();
|
|
this.isPaused = false;
|
|
}
|
|
}
|
|
}
|
|
|
|
export const profileService = new ProfileService();
|
|
|
|
async function doGetProfile(c: ConversationModel): Promise<void> {
|
|
const idForLogging = c.idForLogging();
|
|
const { messaging } = window.textsecure;
|
|
strictAssert(
|
|
messaging,
|
|
'getProfile: window.textsecure.messaging not available'
|
|
);
|
|
|
|
const { updatesUrl } = window.SignalContext.config;
|
|
strictAssert(
|
|
typeof updatesUrl === 'string',
|
|
'getProfile: expected updatesUrl to be a defined string'
|
|
);
|
|
|
|
const clientZkProfileCipher = getClientZkProfileOperations(
|
|
window.getServerPublicParams()
|
|
);
|
|
|
|
const userLanguages = getUserLanguages(
|
|
window.SignalContext.getPreferredSystemLocales(),
|
|
window.SignalContext.getResolvedMessagesLocale()
|
|
);
|
|
|
|
let profile;
|
|
|
|
c.deriveAccessKeyIfNeeded();
|
|
|
|
const profileKey = c.get('profileKey');
|
|
const profileKeyVersion = c.deriveProfileKeyVersion();
|
|
const serviceId = c.getCheckedServiceId('getProfile');
|
|
const lastProfile = c.get('lastProfile');
|
|
|
|
let profileCredentialRequestContext:
|
|
| undefined
|
|
| ProfileKeyCredentialRequestContext;
|
|
|
|
let getProfileOptions: GetProfileOptionsType | GetProfileUnauthOptionsType;
|
|
|
|
let accessKey = c.get('accessKey');
|
|
if (profileKey) {
|
|
strictAssert(
|
|
profileKeyVersion != null && accessKey != null,
|
|
'profileKeyVersion and accessKey are derived from profileKey'
|
|
);
|
|
|
|
if (!c.hasProfileKeyCredentialExpired()) {
|
|
getProfileOptions = {
|
|
accessKey,
|
|
profileKeyVersion,
|
|
userLanguages,
|
|
};
|
|
} else {
|
|
log.info(
|
|
'getProfile: generating profile key credential request for ' +
|
|
`conversation ${idForLogging}`
|
|
);
|
|
|
|
let profileKeyCredentialRequestHex: undefined | string;
|
|
({
|
|
requestHex: profileKeyCredentialRequestHex,
|
|
context: profileCredentialRequestContext,
|
|
} = generateProfileKeyCredentialRequest(
|
|
clientZkProfileCipher,
|
|
serviceId,
|
|
profileKey
|
|
));
|
|
|
|
getProfileOptions = {
|
|
accessKey,
|
|
userLanguages,
|
|
profileKeyVersion,
|
|
profileKeyCredentialRequest: profileKeyCredentialRequestHex,
|
|
};
|
|
}
|
|
} else {
|
|
strictAssert(
|
|
!accessKey,
|
|
'accessKey have to be absent because there is no profileKey'
|
|
);
|
|
|
|
if (lastProfile?.profileKeyVersion) {
|
|
getProfileOptions = {
|
|
userLanguages,
|
|
profileKeyVersion: lastProfile.profileKeyVersion,
|
|
};
|
|
} else {
|
|
getProfileOptions = { userLanguages };
|
|
}
|
|
}
|
|
|
|
const isVersioned = Boolean(getProfileOptions.profileKeyVersion);
|
|
log.info(
|
|
`getProfile: getting ${isVersioned ? 'versioned' : 'unversioned'} ` +
|
|
`profile for conversation ${idForLogging}`
|
|
);
|
|
|
|
try {
|
|
if (getProfileOptions.accessKey) {
|
|
try {
|
|
profile = await messaging.getProfile(serviceId, getProfileOptions);
|
|
} catch (error) {
|
|
if (!(error instanceof HTTPError)) {
|
|
throw error;
|
|
}
|
|
if (error.code === 401 || error.code === 403) {
|
|
if (isMe(c.attributes)) {
|
|
throw error;
|
|
}
|
|
|
|
log.warn(
|
|
`getProfile: Got 401/403 when using accessKey for ${idForLogging}, removing profileKey`
|
|
);
|
|
await c.setProfileKey(undefined, {
|
|
reason: 'doGetProfile/accessKey/401+403',
|
|
});
|
|
|
|
// Retry fetch using last known profileKeyVersion or fetch
|
|
// unversioned profile.
|
|
return doGetProfile(c);
|
|
}
|
|
|
|
if (error.code === 404) {
|
|
c.set('profileLastFetchedAt', Date.now());
|
|
await c.removeLastProfile(lastProfile);
|
|
}
|
|
|
|
throw error;
|
|
}
|
|
} else {
|
|
try {
|
|
// We won't get the credential, but lets either fetch:
|
|
// - a versioned profile using last known profileKeyVersion
|
|
// - some basic profile information (capabilities, badges, etc).
|
|
profile = await messaging.getProfile(serviceId, getProfileOptions);
|
|
} catch (error) {
|
|
if (error instanceof HTTPError && error.code === 404) {
|
|
log.info(`getProfile: failed to find a profile for ${idForLogging}`);
|
|
|
|
c.set('profileLastFetchedAt', Date.now());
|
|
await c.removeLastProfile(lastProfile);
|
|
if (!isVersioned) {
|
|
log.info(`getProfile: marking ${idForLogging} as unregistered`);
|
|
c.setUnregistered();
|
|
}
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
if (profile.identityKey) {
|
|
const identityKeyBytes = Bytes.fromBase64(profile.identityKey);
|
|
await updateIdentityKey(identityKeyBytes, serviceId);
|
|
}
|
|
|
|
// Update accessKey to prevent race conditions. Since we run asynchronous
|
|
// requests above - it is possible that someone updates or erases
|
|
// the profile key from under us.
|
|
accessKey = c.get('accessKey');
|
|
|
|
if (profile.unrestrictedUnidentifiedAccess && profile.unidentifiedAccess) {
|
|
log.info(
|
|
`getProfile: setting sealedSender to UNRESTRICTED for conversation ${idForLogging}`
|
|
);
|
|
c.set({
|
|
sealedSender: SEALED_SENDER.UNRESTRICTED,
|
|
});
|
|
} else if (accessKey && profile.unidentifiedAccess) {
|
|
const haveCorrectKey = verifyAccessKey(
|
|
Bytes.fromBase64(accessKey),
|
|
Bytes.fromBase64(profile.unidentifiedAccess)
|
|
);
|
|
|
|
if (haveCorrectKey) {
|
|
log.info(
|
|
`getProfile: setting sealedSender to ENABLED for conversation ${idForLogging}`
|
|
);
|
|
c.set({
|
|
sealedSender: SEALED_SENDER.ENABLED,
|
|
});
|
|
} else {
|
|
log.warn(
|
|
`getProfile: setting sealedSender to DISABLED for conversation ${idForLogging}`
|
|
);
|
|
c.set({
|
|
sealedSender: SEALED_SENDER.DISABLED,
|
|
});
|
|
}
|
|
} else {
|
|
log.info(
|
|
`getProfile: setting sealedSender to DISABLED for conversation ${idForLogging}`
|
|
);
|
|
c.set({
|
|
sealedSender: SEALED_SENDER.DISABLED,
|
|
});
|
|
}
|
|
|
|
const rawDecryptionKey = c.get('profileKey') || lastProfile?.profileKey;
|
|
const decryptionKey = rawDecryptionKey
|
|
? Bytes.fromBase64(rawDecryptionKey)
|
|
: undefined;
|
|
if (profile.about) {
|
|
if (decryptionKey) {
|
|
const decrypted = decryptProfile(
|
|
Bytes.fromBase64(profile.about),
|
|
decryptionKey
|
|
);
|
|
c.set('about', Bytes.toString(trimForDisplay(decrypted)));
|
|
}
|
|
} else {
|
|
c.unset('about');
|
|
}
|
|
|
|
if (profile.aboutEmoji) {
|
|
if (decryptionKey) {
|
|
const decrypted = decryptProfile(
|
|
Bytes.fromBase64(profile.aboutEmoji),
|
|
decryptionKey
|
|
);
|
|
c.set('aboutEmoji', Bytes.toString(trimForDisplay(decrypted)));
|
|
}
|
|
} else {
|
|
c.unset('aboutEmoji');
|
|
}
|
|
|
|
if (profile.phoneNumberSharing) {
|
|
if (decryptionKey) {
|
|
const decrypted = decryptProfile(
|
|
Bytes.fromBase64(profile.phoneNumberSharing),
|
|
decryptionKey
|
|
);
|
|
|
|
// It should be one byte, but be conservative about it and
|
|
// set `sharingPhoneNumber` to `false` in all cases except [0x01].
|
|
c.set(
|
|
'sharingPhoneNumber',
|
|
decrypted.length === 1 && decrypted[0] === 1
|
|
);
|
|
}
|
|
} else {
|
|
c.unset('sharingPhoneNumber');
|
|
}
|
|
|
|
if (profile.paymentAddress && isMe(c.attributes)) {
|
|
await window.storage.put('paymentAddress', profile.paymentAddress);
|
|
}
|
|
|
|
const pastCapabilities = c.get('capabilities');
|
|
if (profile.capabilities) {
|
|
c.set({ capabilities: profile.capabilities });
|
|
} else {
|
|
c.unset('capabilities');
|
|
}
|
|
|
|
if (isMe(c.attributes)) {
|
|
const newCapabilities = c.get('capabilities');
|
|
|
|
let hasChanged = false;
|
|
const observedCapabilities = {
|
|
...window.storage.get('observedCapabilities'),
|
|
};
|
|
const newKeys = new Array<string>();
|
|
for (const key of OBSERVED_CAPABILITY_KEYS) {
|
|
// Already reported
|
|
if (observedCapabilities[key]) {
|
|
continue;
|
|
}
|
|
|
|
if (newCapabilities?.[key]) {
|
|
if (!pastCapabilities?.[key]) {
|
|
hasChanged = true;
|
|
newKeys.push(key);
|
|
}
|
|
observedCapabilities[key] = true;
|
|
}
|
|
}
|
|
|
|
await window.storage.put('observedCapabilities', observedCapabilities);
|
|
if (hasChanged) {
|
|
log.info(
|
|
'getProfile: detected a capability flip, sending fetch profile',
|
|
newKeys
|
|
);
|
|
await singleProtoJobQueue.add(
|
|
MessageSender.getFetchLocalProfileSyncMessage()
|
|
);
|
|
}
|
|
}
|
|
|
|
const badges = parseBadgesFromServer(profile.badges, updatesUrl);
|
|
if (badges.length) {
|
|
await window.reduxActions.badges.updateOrCreate(badges);
|
|
c.set({
|
|
badges: badges.map(badge => ({
|
|
id: badge.id,
|
|
...('expiresAt' in badge
|
|
? {
|
|
expiresAt: badge.expiresAt,
|
|
isVisible: badge.isVisible,
|
|
}
|
|
: {}),
|
|
})),
|
|
});
|
|
} else {
|
|
c.unset('badges');
|
|
}
|
|
|
|
if (profileCredentialRequestContext) {
|
|
if (profile.credential) {
|
|
const {
|
|
credential: profileKeyCredential,
|
|
expiration: profileKeyCredentialExpiration,
|
|
} = handleProfileKeyCredential(
|
|
clientZkProfileCipher,
|
|
profileCredentialRequestContext,
|
|
profile.credential
|
|
);
|
|
c.set({ profileKeyCredential, profileKeyCredentialExpiration });
|
|
} else {
|
|
log.warn(
|
|
'getProfile: Included credential request, but got no credential. Clearing profileKeyCredential.'
|
|
);
|
|
c.unset('profileKeyCredential');
|
|
}
|
|
}
|
|
} catch (error) {
|
|
if (!(error instanceof HTTPError)) {
|
|
throw error;
|
|
}
|
|
|
|
switch (error.code) {
|
|
case 401:
|
|
case 403:
|
|
if (
|
|
c.get('sealedSender') === SEALED_SENDER.ENABLED ||
|
|
c.get('sealedSender') === SEALED_SENDER.UNRESTRICTED
|
|
) {
|
|
log.warn(
|
|
`getProfile: Got 401/403 when using accessKey for ${idForLogging}, removing profileKey`
|
|
);
|
|
if (!isMe(c.attributes)) {
|
|
await c.setProfileKey(undefined, {
|
|
reason: 'doGetProfile/accessKey/401+403',
|
|
});
|
|
}
|
|
}
|
|
if (c.get('sealedSender') === SEALED_SENDER.UNKNOWN) {
|
|
log.warn(
|
|
`getProfile: Got 401/403 when using accessKey for ${idForLogging}, setting sealedSender = DISABLED`
|
|
);
|
|
c.set('sealedSender', SEALED_SENDER.DISABLED);
|
|
}
|
|
return;
|
|
default:
|
|
log.warn(
|
|
'getProfile failure:',
|
|
idForLogging,
|
|
isNumber(error.code)
|
|
? `code: ${error.code}`
|
|
: Errors.toLogFormat(error)
|
|
);
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
const decryptionKeyString = profileKey || lastProfile?.profileKey;
|
|
const decryptionKey = decryptionKeyString
|
|
? Bytes.fromBase64(decryptionKeyString)
|
|
: undefined;
|
|
|
|
let isSuccessfullyDecrypted = true;
|
|
if (profile.name) {
|
|
if (decryptionKey) {
|
|
try {
|
|
await c.setEncryptedProfileName(profile.name, decryptionKey);
|
|
} catch (error) {
|
|
log.warn(
|
|
'getProfile decryption failure:',
|
|
idForLogging,
|
|
Errors.toLogFormat(error)
|
|
);
|
|
isSuccessfullyDecrypted = false;
|
|
await c.set({
|
|
profileName: undefined,
|
|
profileFamilyName: undefined,
|
|
});
|
|
}
|
|
}
|
|
} else {
|
|
c.set({
|
|
profileName: undefined,
|
|
profileFamilyName: undefined,
|
|
});
|
|
}
|
|
|
|
try {
|
|
if (decryptionKey) {
|
|
await c.setProfileAvatar(profile.avatar, decryptionKey);
|
|
}
|
|
} catch (error) {
|
|
if (error instanceof HTTPError) {
|
|
if (error.code === 403 || error.code === 404) {
|
|
log.warn(
|
|
`getProfile: profile avatar is missing for conversation ${idForLogging}`
|
|
);
|
|
}
|
|
} else {
|
|
log.warn(
|
|
`getProfile: failed to decrypt avatar for conversation ${idForLogging}`,
|
|
Errors.toLogFormat(error)
|
|
);
|
|
isSuccessfullyDecrypted = false;
|
|
}
|
|
}
|
|
|
|
c.set('profileLastFetchedAt', Date.now());
|
|
|
|
// After we successfully decrypted - update lastProfile property
|
|
if (
|
|
isSuccessfullyDecrypted &&
|
|
profileKey &&
|
|
getProfileOptions.profileKeyVersion
|
|
) {
|
|
await c.updateLastProfile(lastProfile, {
|
|
profileKey,
|
|
profileKeyVersion: getProfileOptions.profileKeyVersion,
|
|
});
|
|
}
|
|
|
|
await DataWriter.updateConversation(c.attributes);
|
|
}
|
|
|
|
export type UpdateIdentityKeyOptionsType = Readonly<{
|
|
noOverwrite?: boolean;
|
|
}>;
|
|
|
|
export async function updateIdentityKey(
|
|
identityKey: Uint8Array,
|
|
serviceId: ServiceIdString,
|
|
{ noOverwrite = false }: UpdateIdentityKeyOptionsType = {}
|
|
): Promise<boolean> {
|
|
if (!Bytes.isNotEmpty(identityKey)) {
|
|
return false;
|
|
}
|
|
|
|
const changed = await window.textsecure.storage.protocol.saveIdentity(
|
|
new Address(serviceId, 1),
|
|
identityKey,
|
|
false,
|
|
{ noOverwrite }
|
|
);
|
|
if (changed) {
|
|
log.info(`updateIdentityKey(${serviceId}): changed`);
|
|
// save identity will close all sessions except for .1, so we
|
|
// must close that one manually.
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
await window.textsecure.storage.protocol.archiveSession(
|
|
new QualifiedAddress(ourAci, new Address(serviceId, 1))
|
|
);
|
|
}
|
|
|
|
return changed;
|
|
}
|