]> nmode's Git Repositories - signal-cli/blob - lib/src/main/java/org/asamk/signal/manager/Manager.java
Prevent updateContact and block commands on linked devices
[signal-cli] / lib / src / main / java / org / asamk / signal / manager / Manager.java
1 /*
2 Copyright (C) 2015-2021 AsamK and contributors
3
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17 package org.asamk.signal.manager;
18
19 import org.asamk.signal.manager.config.ServiceConfig;
20 import org.asamk.signal.manager.config.ServiceEnvironment;
21 import org.asamk.signal.manager.config.ServiceEnvironmentConfig;
22 import org.asamk.signal.manager.groups.GroupId;
23 import org.asamk.signal.manager.groups.GroupIdV1;
24 import org.asamk.signal.manager.groups.GroupInviteLinkUrl;
25 import org.asamk.signal.manager.groups.GroupNotFoundException;
26 import org.asamk.signal.manager.groups.GroupUtils;
27 import org.asamk.signal.manager.groups.NotAGroupMemberException;
28 import org.asamk.signal.manager.helper.GroupHelper;
29 import org.asamk.signal.manager.helper.PinHelper;
30 import org.asamk.signal.manager.helper.ProfileHelper;
31 import org.asamk.signal.manager.helper.UnidentifiedAccessHelper;
32 import org.asamk.signal.manager.storage.SignalAccount;
33 import org.asamk.signal.manager.storage.groups.GroupInfo;
34 import org.asamk.signal.manager.storage.groups.GroupInfoV1;
35 import org.asamk.signal.manager.storage.groups.GroupInfoV2;
36 import org.asamk.signal.manager.storage.identities.IdentityInfo;
37 import org.asamk.signal.manager.storage.messageCache.CachedMessage;
38 import org.asamk.signal.manager.storage.recipients.Contact;
39 import org.asamk.signal.manager.storage.recipients.Profile;
40 import org.asamk.signal.manager.storage.recipients.RecipientId;
41 import org.asamk.signal.manager.storage.stickers.Sticker;
42 import org.asamk.signal.manager.storage.stickers.StickerPackId;
43 import org.asamk.signal.manager.util.AttachmentUtils;
44 import org.asamk.signal.manager.util.IOUtils;
45 import org.asamk.signal.manager.util.KeyUtils;
46 import org.asamk.signal.manager.util.ProfileUtils;
47 import org.asamk.signal.manager.util.StickerUtils;
48 import org.asamk.signal.manager.util.Utils;
49 import org.signal.libsignal.metadata.InvalidMetadataMessageException;
50 import org.signal.libsignal.metadata.InvalidMetadataVersionException;
51 import org.signal.libsignal.metadata.ProtocolDuplicateMessageException;
52 import org.signal.libsignal.metadata.ProtocolInvalidKeyException;
53 import org.signal.libsignal.metadata.ProtocolInvalidKeyIdException;
54 import org.signal.libsignal.metadata.ProtocolInvalidMessageException;
55 import org.signal.libsignal.metadata.ProtocolInvalidVersionException;
56 import org.signal.libsignal.metadata.ProtocolLegacyMessageException;
57 import org.signal.libsignal.metadata.ProtocolNoSessionException;
58 import org.signal.libsignal.metadata.ProtocolUntrustedIdentityException;
59 import org.signal.libsignal.metadata.SelfSendException;
60 import org.signal.libsignal.metadata.certificate.CertificateValidator;
61 import org.signal.storageservice.protos.groups.GroupChange;
62 import org.signal.storageservice.protos.groups.local.DecryptedGroup;
63 import org.signal.zkgroup.InvalidInputException;
64 import org.signal.zkgroup.VerificationFailedException;
65 import org.signal.zkgroup.groups.GroupMasterKey;
66 import org.signal.zkgroup.groups.GroupSecretParams;
67 import org.signal.zkgroup.profiles.ClientZkProfileOperations;
68 import org.signal.zkgroup.profiles.ProfileKey;
69 import org.signal.zkgroup.profiles.ProfileKeyCredential;
70 import org.slf4j.Logger;
71 import org.slf4j.LoggerFactory;
72 import org.whispersystems.libsignal.IdentityKey;
73 import org.whispersystems.libsignal.IdentityKeyPair;
74 import org.whispersystems.libsignal.InvalidKeyException;
75 import org.whispersystems.libsignal.InvalidMessageException;
76 import org.whispersystems.libsignal.ecc.ECPublicKey;
77 import org.whispersystems.libsignal.state.PreKeyRecord;
78 import org.whispersystems.libsignal.state.SignedPreKeyRecord;
79 import org.whispersystems.libsignal.util.Pair;
80 import org.whispersystems.libsignal.util.guava.Optional;
81 import org.whispersystems.signalservice.api.SignalServiceAccountManager;
82 import org.whispersystems.signalservice.api.SignalServiceMessagePipe;
83 import org.whispersystems.signalservice.api.SignalServiceMessageReceiver;
84 import org.whispersystems.signalservice.api.SignalServiceMessageSender;
85 import org.whispersystems.signalservice.api.crypto.SignalServiceCipher;
86 import org.whispersystems.signalservice.api.crypto.UntrustedIdentityException;
87 import org.whispersystems.signalservice.api.groupsv2.ClientZkOperations;
88 import org.whispersystems.signalservice.api.groupsv2.GroupLinkNotActiveException;
89 import org.whispersystems.signalservice.api.groupsv2.GroupsV2Api;
90 import org.whispersystems.signalservice.api.groupsv2.GroupsV2AuthorizationString;
91 import org.whispersystems.signalservice.api.groupsv2.GroupsV2Operations;
92 import org.whispersystems.signalservice.api.messages.SendMessageResult;
93 import org.whispersystems.signalservice.api.messages.SignalServiceAttachment;
94 import org.whispersystems.signalservice.api.messages.SignalServiceAttachmentPointer;
95 import org.whispersystems.signalservice.api.messages.SignalServiceAttachmentRemoteId;
96 import org.whispersystems.signalservice.api.messages.SignalServiceAttachmentStream;
97 import org.whispersystems.signalservice.api.messages.SignalServiceContent;
98 import org.whispersystems.signalservice.api.messages.SignalServiceDataMessage;
99 import org.whispersystems.signalservice.api.messages.SignalServiceEnvelope;
100 import org.whispersystems.signalservice.api.messages.SignalServiceGroup;
101 import org.whispersystems.signalservice.api.messages.SignalServiceGroupV2;
102 import org.whispersystems.signalservice.api.messages.SignalServiceReceiptMessage;
103 import org.whispersystems.signalservice.api.messages.multidevice.BlockedListMessage;
104 import org.whispersystems.signalservice.api.messages.multidevice.ContactsMessage;
105 import org.whispersystems.signalservice.api.messages.multidevice.DeviceContact;
106 import org.whispersystems.signalservice.api.messages.multidevice.DeviceContactsInputStream;
107 import org.whispersystems.signalservice.api.messages.multidevice.DeviceContactsOutputStream;
108 import org.whispersystems.signalservice.api.messages.multidevice.DeviceGroup;
109 import org.whispersystems.signalservice.api.messages.multidevice.DeviceGroupsInputStream;
110 import org.whispersystems.signalservice.api.messages.multidevice.DeviceGroupsOutputStream;
111 import org.whispersystems.signalservice.api.messages.multidevice.DeviceInfo;
112 import org.whispersystems.signalservice.api.messages.multidevice.RequestMessage;
113 import org.whispersystems.signalservice.api.messages.multidevice.SentTranscriptMessage;
114 import org.whispersystems.signalservice.api.messages.multidevice.SignalServiceSyncMessage;
115 import org.whispersystems.signalservice.api.messages.multidevice.StickerPackOperationMessage;
116 import org.whispersystems.signalservice.api.messages.multidevice.VerifiedMessage;
117 import org.whispersystems.signalservice.api.profiles.ProfileAndCredential;
118 import org.whispersystems.signalservice.api.profiles.SignalServiceProfile;
119 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
120 import org.whispersystems.signalservice.api.push.exceptions.MissingConfigurationException;
121 import org.whispersystems.signalservice.api.push.exceptions.UnregisteredUserException;
122 import org.whispersystems.signalservice.api.util.InvalidNumberException;
123 import org.whispersystems.signalservice.api.util.PhoneNumberFormatter;
124 import org.whispersystems.signalservice.api.util.SleepTimer;
125 import org.whispersystems.signalservice.api.util.UptimeSleepTimer;
126 import org.whispersystems.signalservice.api.util.UuidUtil;
127 import org.whispersystems.signalservice.internal.contacts.crypto.Quote;
128 import org.whispersystems.signalservice.internal.contacts.crypto.UnauthenticatedQuoteException;
129 import org.whispersystems.signalservice.internal.contacts.crypto.UnauthenticatedResponseException;
130 import org.whispersystems.signalservice.internal.push.SignalServiceProtos;
131 import org.whispersystems.signalservice.internal.push.UnsupportedDataMessageException;
132 import org.whispersystems.signalservice.internal.util.DynamicCredentialsProvider;
133 import org.whispersystems.signalservice.internal.util.Hex;
134 import org.whispersystems.signalservice.internal.util.Util;
135
136 import java.io.Closeable;
137 import java.io.File;
138 import java.io.FileInputStream;
139 import java.io.FileOutputStream;
140 import java.io.IOException;
141 import java.io.InputStream;
142 import java.io.OutputStream;
143 import java.net.URI;
144 import java.net.URISyntaxException;
145 import java.net.URLEncoder;
146 import java.nio.charset.StandardCharsets;
147 import java.nio.file.Files;
148 import java.security.SignatureException;
149 import java.util.ArrayList;
150 import java.util.Arrays;
151 import java.util.Base64;
152 import java.util.Collection;
153 import java.util.Date;
154 import java.util.HashSet;
155 import java.util.List;
156 import java.util.Map;
157 import java.util.Set;
158 import java.util.UUID;
159 import java.util.concurrent.ExecutorService;
160 import java.util.concurrent.Executors;
161 import java.util.concurrent.TimeUnit;
162 import java.util.concurrent.TimeoutException;
163 import java.util.function.Function;
164 import java.util.stream.Collectors;
165
166 import static org.asamk.signal.manager.config.ServiceConfig.capabilities;
167
168 public class Manager implements Closeable {
169
170 private final static Logger logger = LoggerFactory.getLogger(Manager.class);
171
172 private final CertificateValidator certificateValidator;
173
174 private final ServiceEnvironmentConfig serviceEnvironmentConfig;
175 private final String userAgent;
176
177 private SignalAccount account;
178 private final SignalServiceAccountManager accountManager;
179 private final GroupsV2Api groupsV2Api;
180 private final GroupsV2Operations groupsV2Operations;
181 private final SignalServiceMessageReceiver messageReceiver;
182 private final ClientZkProfileOperations clientZkProfileOperations;
183
184 private final ExecutorService executor = Executors.newCachedThreadPool();
185
186 private SignalServiceMessagePipe messagePipe = null;
187 private SignalServiceMessagePipe unidentifiedMessagePipe = null;
188
189 private final UnidentifiedAccessHelper unidentifiedAccessHelper;
190 private final ProfileHelper profileHelper;
191 private final GroupHelper groupHelper;
192 private final PinHelper pinHelper;
193 private final AvatarStore avatarStore;
194 private final AttachmentStore attachmentStore;
195
196 Manager(
197 SignalAccount account,
198 PathConfig pathConfig,
199 ServiceEnvironmentConfig serviceEnvironmentConfig,
200 String userAgent
201 ) {
202 this.account = account;
203 this.serviceEnvironmentConfig = serviceEnvironmentConfig;
204 this.certificateValidator = new CertificateValidator(serviceEnvironmentConfig.getUnidentifiedSenderTrustRoot());
205 this.userAgent = userAgent;
206 this.groupsV2Operations = capabilities.isGv2() ? new GroupsV2Operations(ClientZkOperations.create(
207 serviceEnvironmentConfig.getSignalServiceConfiguration())) : null;
208 final SleepTimer timer = new UptimeSleepTimer();
209 this.accountManager = new SignalServiceAccountManager(serviceEnvironmentConfig.getSignalServiceConfiguration(),
210 new DynamicCredentialsProvider(account.getUuid(),
211 account.getUsername(),
212 account.getPassword(),
213 account.getDeviceId()),
214 userAgent,
215 groupsV2Operations,
216 ServiceConfig.AUTOMATIC_NETWORK_RETRY,
217 timer);
218 this.groupsV2Api = accountManager.getGroupsV2Api();
219 final var keyBackupService = accountManager.getKeyBackupService(ServiceConfig.getIasKeyStore(),
220 serviceEnvironmentConfig.getKeyBackupConfig().getEnclaveName(),
221 serviceEnvironmentConfig.getKeyBackupConfig().getServiceId(),
222 serviceEnvironmentConfig.getKeyBackupConfig().getMrenclave(),
223 10);
224
225 this.pinHelper = new PinHelper(keyBackupService);
226 this.clientZkProfileOperations = capabilities.isGv2()
227 ? ClientZkOperations.create(serviceEnvironmentConfig.getSignalServiceConfiguration())
228 .getProfileOperations()
229 : null;
230 this.messageReceiver = new SignalServiceMessageReceiver(serviceEnvironmentConfig.getSignalServiceConfiguration(),
231 account.getUuid(),
232 account.getUsername(),
233 account.getPassword(),
234 account.getDeviceId(),
235 userAgent,
236 null,
237 timer,
238 clientZkProfileOperations,
239 ServiceConfig.AUTOMATIC_NETWORK_RETRY);
240
241 this.unidentifiedAccessHelper = new UnidentifiedAccessHelper(account::getProfileKey,
242 account.getProfileStore()::getProfileKey,
243 this::getRecipientProfile,
244 this::getSenderCertificate);
245 this.profileHelper = new ProfileHelper(account.getProfileStore()::getProfileKey,
246 unidentifiedAccessHelper::getAccessFor,
247 unidentified -> unidentified ? getOrCreateUnidentifiedMessagePipe() : getOrCreateMessagePipe(),
248 () -> messageReceiver,
249 this::resolveSignalServiceAddress);
250 this.groupHelper = new GroupHelper(this::getRecipientProfileKeyCredential,
251 this::getRecipientProfile,
252 account::getSelfRecipientId,
253 groupsV2Operations,
254 groupsV2Api,
255 this::getGroupAuthForToday,
256 this::resolveSignalServiceAddress);
257 this.avatarStore = new AvatarStore(pathConfig.getAvatarsPath());
258 this.attachmentStore = new AttachmentStore(pathConfig.getAttachmentsPath());
259 }
260
261 public String getUsername() {
262 return account.getUsername();
263 }
264
265 public SignalServiceAddress getSelfAddress() {
266 return account.getSelfAddress();
267 }
268
269 public RecipientId getSelfRecipientId() {
270 return account.getSelfRecipientId();
271 }
272
273 private IdentityKeyPair getIdentityKeyPair() {
274 return account.getIdentityKeyPair();
275 }
276
277 public int getDeviceId() {
278 return account.getDeviceId();
279 }
280
281 public static Manager init(
282 String username, File settingsPath, ServiceEnvironment serviceEnvironment, String userAgent
283 ) throws IOException, NotRegisteredException {
284 var pathConfig = PathConfig.createDefault(settingsPath);
285
286 if (!SignalAccount.userExists(pathConfig.getDataPath(), username)) {
287 throw new NotRegisteredException();
288 }
289
290 var account = SignalAccount.load(pathConfig.getDataPath(), username);
291
292 if (!account.isRegistered()) {
293 throw new NotRegisteredException();
294 }
295
296 final var serviceEnvironmentConfig = ServiceConfig.getServiceEnvironmentConfig(serviceEnvironment, userAgent);
297
298 return new Manager(account, pathConfig, serviceEnvironmentConfig, userAgent);
299 }
300
301 public static List<String> getAllLocalUsernames(File settingsPath) {
302 var pathConfig = PathConfig.createDefault(settingsPath);
303 final var dataPath = pathConfig.getDataPath();
304 final var files = dataPath.listFiles();
305
306 if (files == null) {
307 return List.of();
308 }
309
310 return Arrays.stream(files)
311 .filter(File::isFile)
312 .map(File::getName)
313 .filter(file -> PhoneNumberFormatter.isValidNumber(file, null))
314 .collect(Collectors.toList());
315 }
316
317 public void checkAccountState() throws IOException {
318 if (accountManager.getPreKeysCount() < ServiceConfig.PREKEY_MINIMUM_COUNT) {
319 refreshPreKeys();
320 }
321 if (account.getUuid() == null) {
322 account.setUuid(accountManager.getOwnUuid());
323 }
324 updateAccountAttributes();
325 }
326
327 /**
328 * This is used for checking a set of phone numbers for registration on Signal
329 *
330 * @param numbers The set of phone number in question
331 * @return A map of numbers to booleans. True if registered, false otherwise. Should never be null
332 * @throws IOException if its unable to get the contacts to check if they're registered
333 */
334 public Map<String, Boolean> areUsersRegistered(Set<String> numbers) throws IOException {
335 // Note "contactDetails" has no optionals. It only gives us info on users who are registered
336 var contactDetails = getRegisteredUsers(numbers);
337
338 var registeredUsers = contactDetails.keySet();
339
340 return numbers.stream().collect(Collectors.toMap(x -> x, registeredUsers::contains));
341 }
342
343 public void updateAccountAttributes() throws IOException {
344 accountManager.setAccountAttributes(null,
345 account.getLocalRegistrationId(),
346 true,
347 // set legacy pin only if no KBS master key is set
348 account.getPinMasterKey() == null ? account.getRegistrationLockPin() : null,
349 account.getPinMasterKey() == null ? null : account.getPinMasterKey().deriveRegistrationLock(),
350 account.getSelfUnidentifiedAccessKey(),
351 account.isUnrestrictedUnidentifiedAccess(),
352 capabilities,
353 account.isDiscoverableByPhoneNumber());
354 }
355
356 /**
357 * @param name if null, the previous name will be kept
358 * @param about if null, the previous about text will be kept
359 * @param aboutEmoji if null, the previous about emoji will be kept
360 * @param avatar if avatar is null the image from the local avatar store is used (if present),
361 * if it's Optional.absent(), the avatar will be removed
362 */
363 public void setProfile(String name, String about, String aboutEmoji, Optional<File> avatar) throws IOException {
364 var profile = getRecipientProfile(account.getSelfRecipientId());
365 var builder = profile == null ? Profile.newBuilder() : Profile.newBuilder(profile);
366 if (name != null) {
367 builder.withGivenName(name);
368 builder.withFamilyName(null);
369 }
370 if (about != null) {
371 builder.withAbout(about);
372 }
373 if (aboutEmoji != null) {
374 builder.withAboutEmoji(aboutEmoji);
375 }
376 var newProfile = builder.build();
377
378 try (final var streamDetails = avatar == null
379 ? avatarStore.retrieveProfileAvatar(getSelfAddress())
380 : avatar.isPresent() ? Utils.createStreamDetailsFromFile(avatar.get()) : null) {
381 accountManager.setVersionedProfile(account.getUuid(),
382 account.getProfileKey(),
383 newProfile.getInternalServiceName(),
384 newProfile.getAbout() == null ? "" : newProfile.getAbout(),
385 newProfile.getAboutEmoji() == null ? "" : newProfile.getAboutEmoji(),
386 streamDetails);
387 }
388
389 if (avatar != null) {
390 if (avatar.isPresent()) {
391 avatarStore.storeProfileAvatar(getSelfAddress(),
392 outputStream -> IOUtils.copyFileToStream(avatar.get(), outputStream));
393 } else {
394 avatarStore.deleteProfileAvatar(getSelfAddress());
395 }
396 }
397 account.getProfileStore().storeProfile(account.getSelfRecipientId(), newProfile);
398
399 try {
400 sendSyncMessage(SignalServiceSyncMessage.forFetchLatest(SignalServiceSyncMessage.FetchType.LOCAL_PROFILE));
401 } catch (UntrustedIdentityException ignored) {
402 }
403 }
404
405 public void unregister() throws IOException {
406 // When setting an empty GCM id, the Signal-Server also sets the fetchesMessages property to false.
407 // If this is the master device, other users can't send messages to this number anymore.
408 // If this is a linked device, other users can still send messages, but this device doesn't receive them anymore.
409 accountManager.setGcmId(Optional.absent());
410
411 account.setRegistered(false);
412 }
413
414 public void deleteAccount() throws IOException {
415 accountManager.deleteAccount();
416
417 account.setRegistered(false);
418 }
419
420 public List<DeviceInfo> getLinkedDevices() throws IOException {
421 var devices = accountManager.getDevices();
422 account.setMultiDevice(devices.size() > 1);
423 return devices;
424 }
425
426 public void removeLinkedDevices(int deviceId) throws IOException {
427 accountManager.removeDevice(deviceId);
428 var devices = accountManager.getDevices();
429 account.setMultiDevice(devices.size() > 1);
430 }
431
432 public void addDeviceLink(URI linkUri) throws IOException, InvalidKeyException {
433 var info = DeviceLinkInfo.parseDeviceLinkUri(linkUri);
434
435 addDevice(info.deviceIdentifier, info.deviceKey);
436 }
437
438 private void addDevice(String deviceIdentifier, ECPublicKey deviceKey) throws IOException, InvalidKeyException {
439 var identityKeyPair = getIdentityKeyPair();
440 var verificationCode = accountManager.getNewDeviceVerificationCode();
441
442 accountManager.addDevice(deviceIdentifier,
443 deviceKey,
444 identityKeyPair,
445 Optional.of(account.getProfileKey().serialize()),
446 verificationCode);
447 account.setMultiDevice(true);
448 }
449
450 public void setRegistrationLockPin(Optional<String> pin) throws IOException, UnauthenticatedResponseException {
451 if (!account.isMasterDevice()) {
452 throw new RuntimeException("Only master device can set a PIN");
453 }
454 if (pin.isPresent()) {
455 final var masterKey = account.getPinMasterKey() != null
456 ? account.getPinMasterKey()
457 : KeyUtils.createMasterKey();
458
459 pinHelper.setRegistrationLockPin(pin.get(), masterKey);
460
461 account.setRegistrationLockPin(pin.get(), masterKey);
462 } else {
463 // Remove legacy registration lock
464 accountManager.removeRegistrationLockV1();
465
466 // Remove KBS Pin
467 pinHelper.removeRegistrationLockPin();
468
469 account.setRegistrationLockPin(null, null);
470 }
471 }
472
473 void refreshPreKeys() throws IOException {
474 var oneTimePreKeys = generatePreKeys();
475 final var identityKeyPair = getIdentityKeyPair();
476 var signedPreKeyRecord = generateSignedPreKey(identityKeyPair);
477
478 accountManager.setPreKeys(identityKeyPair.getPublicKey(), signedPreKeyRecord, oneTimePreKeys);
479 }
480
481 private List<PreKeyRecord> generatePreKeys() {
482 final var offset = account.getPreKeyIdOffset();
483
484 var records = KeyUtils.generatePreKeyRecords(offset, ServiceConfig.PREKEY_BATCH_SIZE);
485 account.addPreKeys(records);
486
487 return records;
488 }
489
490 private SignedPreKeyRecord generateSignedPreKey(IdentityKeyPair identityKeyPair) {
491 final var signedPreKeyId = account.getNextSignedPreKeyId();
492
493 var record = KeyUtils.generateSignedPreKeyRecord(identityKeyPair, signedPreKeyId);
494 account.addSignedPreKey(record);
495
496 return record;
497 }
498
499 private SignalServiceMessagePipe getOrCreateMessagePipe() {
500 if (messagePipe == null) {
501 messagePipe = messageReceiver.createMessagePipe();
502 }
503 return messagePipe;
504 }
505
506 private SignalServiceMessagePipe getOrCreateUnidentifiedMessagePipe() {
507 if (unidentifiedMessagePipe == null) {
508 unidentifiedMessagePipe = messageReceiver.createUnidentifiedMessagePipe();
509 }
510 return unidentifiedMessagePipe;
511 }
512
513 private SignalServiceMessageSender createMessageSender() {
514 return new SignalServiceMessageSender(serviceEnvironmentConfig.getSignalServiceConfiguration(),
515 account.getUuid(),
516 account.getUsername(),
517 account.getPassword(),
518 account.getDeviceId(),
519 account.getSignalProtocolStore(),
520 userAgent,
521 account.isMultiDevice(),
522 Optional.fromNullable(messagePipe),
523 Optional.fromNullable(unidentifiedMessagePipe),
524 Optional.absent(),
525 clientZkProfileOperations,
526 executor,
527 ServiceConfig.MAX_ENVELOPE_SIZE,
528 ServiceConfig.AUTOMATIC_NETWORK_RETRY);
529 }
530
531 public Profile getRecipientProfile(
532 SignalServiceAddress address
533 ) {
534 return getRecipientProfile(resolveRecipient(address), false);
535 }
536
537 public Profile getRecipientProfile(
538 RecipientId recipientId
539 ) {
540 return getRecipientProfile(recipientId, false);
541 }
542
543 private final Set<RecipientId> pendingProfileRequest = new HashSet<>();
544
545 Profile getRecipientProfile(
546 RecipientId recipientId, boolean force
547 ) {
548 var profileKey = account.getProfileStore().getProfileKey(recipientId);
549 if (profileKey == null) {
550 if (force) {
551 // retrieve profile to get identity key
552 retrieveEncryptedProfile(recipientId);
553 }
554 return null;
555 }
556 var profile = account.getProfileStore().getProfile(recipientId);
557
558 var now = new Date().getTime();
559 // Profiles are cached for 24h before retrieving them again, unless forced
560 if (!force && profile != null && now - profile.getLastUpdateTimestamp() < 24 * 60 * 60 * 1000) {
561 return profile;
562 }
563
564 synchronized (pendingProfileRequest) {
565 if (pendingProfileRequest.contains(recipientId)) {
566 return profile;
567 }
568 pendingProfileRequest.add(recipientId);
569 }
570 final SignalServiceProfile encryptedProfile;
571 try {
572 encryptedProfile = retrieveEncryptedProfile(recipientId);
573 } finally {
574 synchronized (pendingProfileRequest) {
575 pendingProfileRequest.remove(recipientId);
576 }
577 }
578 if (encryptedProfile == null) {
579 return null;
580 }
581
582 profile = decryptProfileAndDownloadAvatar(recipientId, profileKey, encryptedProfile);
583 account.getProfileStore().storeProfile(recipientId, profile);
584
585 return profile;
586 }
587
588 private SignalServiceProfile retrieveEncryptedProfile(RecipientId recipientId) {
589 try {
590 return retrieveProfileAndCredential(recipientId, SignalServiceProfile.RequestType.PROFILE).getProfile();
591 } catch (IOException e) {
592 logger.warn("Failed to retrieve profile, ignoring: {}", e.getMessage());
593 return null;
594 }
595 }
596
597 private ProfileAndCredential retrieveProfileAndCredential(
598 final RecipientId recipientId, final SignalServiceProfile.RequestType requestType
599 ) throws IOException {
600 final var profileAndCredential = profileHelper.retrieveProfileSync(recipientId, requestType);
601 final var profile = profileAndCredential.getProfile();
602
603 try {
604 account.getIdentityKeyStore()
605 .saveIdentity(recipientId,
606 new IdentityKey(Base64.getDecoder().decode(profile.getIdentityKey())),
607 new Date());
608 } catch (InvalidKeyException ignored) {
609 logger.warn("Got invalid identity key in profile for {}",
610 resolveSignalServiceAddress(recipientId).getLegacyIdentifier());
611 }
612 return profileAndCredential;
613 }
614
615 private ProfileKeyCredential getRecipientProfileKeyCredential(RecipientId recipientId) {
616 var profileKeyCredential = account.getProfileStore().getProfileKeyCredential(recipientId);
617 if (profileKeyCredential != null) {
618 return profileKeyCredential;
619 }
620
621 ProfileAndCredential profileAndCredential;
622 try {
623 profileAndCredential = retrieveProfileAndCredential(recipientId,
624 SignalServiceProfile.RequestType.PROFILE_AND_CREDENTIAL);
625 } catch (IOException e) {
626 logger.warn("Failed to retrieve profile key credential, ignoring: {}", e.getMessage());
627 return null;
628 }
629
630 profileKeyCredential = profileAndCredential.getProfileKeyCredential().orNull();
631 account.getProfileStore().storeProfileKeyCredential(recipientId, profileKeyCredential);
632
633 var profileKey = account.getProfileStore().getProfileKey(recipientId);
634 if (profileKey != null) {
635 final var profile = decryptProfileAndDownloadAvatar(recipientId,
636 profileKey,
637 profileAndCredential.getProfile());
638 account.getProfileStore().storeProfile(recipientId, profile);
639 }
640
641 return profileKeyCredential;
642 }
643
644 private Profile decryptProfileAndDownloadAvatar(
645 final RecipientId recipientId, final ProfileKey profileKey, final SignalServiceProfile encryptedProfile
646 ) {
647 if (encryptedProfile.getAvatar() != null) {
648 downloadProfileAvatar(resolveSignalServiceAddress(recipientId), encryptedProfile.getAvatar(), profileKey);
649 }
650
651 return ProfileUtils.decryptProfile(profileKey, encryptedProfile);
652 }
653
654 private Optional<SignalServiceAttachmentStream> createGroupAvatarAttachment(GroupId groupId) throws IOException {
655 final var streamDetails = avatarStore.retrieveGroupAvatar(groupId);
656 if (streamDetails == null) {
657 return Optional.absent();
658 }
659
660 return Optional.of(AttachmentUtils.createAttachment(streamDetails, Optional.absent()));
661 }
662
663 private Optional<SignalServiceAttachmentStream> createContactAvatarAttachment(SignalServiceAddress address) throws IOException {
664 final var streamDetails = avatarStore.retrieveContactAvatar(address);
665 if (streamDetails == null) {
666 return Optional.absent();
667 }
668
669 return Optional.of(AttachmentUtils.createAttachment(streamDetails, Optional.absent()));
670 }
671
672 private GroupInfo getGroupForSending(GroupId groupId) throws GroupNotFoundException, NotAGroupMemberException {
673 var g = getGroup(groupId);
674 if (g == null) {
675 throw new GroupNotFoundException(groupId);
676 }
677 if (!g.isMember(account.getSelfRecipientId())) {
678 throw new NotAGroupMemberException(groupId, g.getTitle());
679 }
680 return g;
681 }
682
683 private GroupInfo getGroupForUpdating(GroupId groupId) throws GroupNotFoundException, NotAGroupMemberException {
684 var g = getGroup(groupId);
685 if (g == null) {
686 throw new GroupNotFoundException(groupId);
687 }
688 if (!g.isMember(account.getSelfRecipientId()) && !g.isPendingMember(account.getSelfRecipientId())) {
689 throw new NotAGroupMemberException(groupId, g.getTitle());
690 }
691 return g;
692 }
693
694 public List<GroupInfo> getGroups() {
695 return account.getGroupStore().getGroups();
696 }
697
698 public Pair<Long, List<SendMessageResult>> sendGroupMessage(
699 String messageText, List<String> attachments, GroupId groupId
700 ) throws IOException, GroupNotFoundException, AttachmentInvalidException, NotAGroupMemberException {
701 final var messageBuilder = SignalServiceDataMessage.newBuilder().withBody(messageText);
702 if (attachments != null) {
703 messageBuilder.withAttachments(AttachmentUtils.getSignalServiceAttachments(attachments));
704 }
705
706 return sendGroupMessage(messageBuilder, groupId);
707 }
708
709 public Pair<Long, List<SendMessageResult>> sendGroupMessageReaction(
710 String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, GroupId groupId
711 ) throws IOException, InvalidNumberException, NotAGroupMemberException, GroupNotFoundException {
712 var reaction = new SignalServiceDataMessage.Reaction(emoji,
713 remove,
714 canonicalizeAndResolveSignalServiceAddress(targetAuthor),
715 targetSentTimestamp);
716 final var messageBuilder = SignalServiceDataMessage.newBuilder().withReaction(reaction);
717
718 return sendGroupMessage(messageBuilder, groupId);
719 }
720
721 public Pair<Long, List<SendMessageResult>> sendGroupMessage(
722 SignalServiceDataMessage.Builder messageBuilder, GroupId groupId
723 ) throws IOException, GroupNotFoundException, NotAGroupMemberException {
724 final var g = getGroupForSending(groupId);
725
726 GroupUtils.setGroupContext(messageBuilder, g);
727 messageBuilder.withExpiration(g.getMessageExpirationTime());
728
729 return sendMessage(messageBuilder, g.getMembersWithout(account.getSelfRecipientId()));
730 }
731
732 public Pair<Long, List<SendMessageResult>> sendQuitGroupMessage(GroupId groupId) throws GroupNotFoundException, IOException, NotAGroupMemberException {
733 SignalServiceDataMessage.Builder messageBuilder;
734
735 final var g = getGroupForUpdating(groupId);
736 if (g instanceof GroupInfoV1) {
737 var groupInfoV1 = (GroupInfoV1) g;
738 var group = SignalServiceGroup.newBuilder(SignalServiceGroup.Type.QUIT).withId(groupId.serialize()).build();
739 messageBuilder = SignalServiceDataMessage.newBuilder().asGroupMessage(group);
740 groupInfoV1.removeMember(account.getSelfRecipientId());
741 account.getGroupStore().updateGroup(groupInfoV1);
742 } else {
743 final var groupInfoV2 = (GroupInfoV2) g;
744 final var groupGroupChangePair = groupHelper.leaveGroup(groupInfoV2);
745 groupInfoV2.setGroup(groupGroupChangePair.first(), this::resolveRecipient);
746 messageBuilder = getGroupUpdateMessageBuilder(groupInfoV2, groupGroupChangePair.second().toByteArray());
747 account.getGroupStore().updateGroup(groupInfoV2);
748 }
749
750 return sendMessage(messageBuilder, g.getMembersWithout(account.getSelfRecipientId()));
751 }
752
753 public Pair<GroupId, List<SendMessageResult>> updateGroup(
754 GroupId groupId, String name, List<String> members, File avatarFile
755 ) throws IOException, GroupNotFoundException, AttachmentInvalidException, InvalidNumberException, NotAGroupMemberException {
756 return sendUpdateGroupMessage(groupId,
757 name,
758 members == null ? null : getSignalServiceAddresses(members),
759 avatarFile);
760 }
761
762 private Pair<GroupId, List<SendMessageResult>> sendUpdateGroupMessage(
763 GroupId groupId, String name, Set<RecipientId> members, File avatarFile
764 ) throws IOException, GroupNotFoundException, AttachmentInvalidException, NotAGroupMemberException {
765 GroupInfo g;
766 SignalServiceDataMessage.Builder messageBuilder;
767 if (groupId == null) {
768 // Create new group
769 var gv2Pair = groupHelper.createGroupV2(name == null ? "" : name,
770 members == null ? Set.of() : members,
771 avatarFile);
772 if (gv2Pair == null) {
773 var gv1 = new GroupInfoV1(GroupIdV1.createRandom());
774 gv1.addMembers(List.of(account.getSelfRecipientId()));
775 updateGroupV1(gv1, name, members, avatarFile);
776 messageBuilder = getGroupUpdateMessageBuilder(gv1);
777 g = gv1;
778 } else {
779 final var gv2 = gv2Pair.first();
780 final var decryptedGroup = gv2Pair.second();
781
782 gv2.setGroup(decryptedGroup, this::resolveRecipient);
783 if (avatarFile != null) {
784 avatarStore.storeGroupAvatar(gv2.getGroupId(),
785 outputStream -> IOUtils.copyFileToStream(avatarFile, outputStream));
786 }
787 messageBuilder = getGroupUpdateMessageBuilder(gv2, null);
788 g = gv2;
789 }
790 } else {
791 var group = getGroupForUpdating(groupId);
792 if (group instanceof GroupInfoV2) {
793 final var groupInfoV2 = (GroupInfoV2) group;
794
795 Pair<Long, List<SendMessageResult>> result = null;
796 if (groupInfoV2.isPendingMember(account.getSelfRecipientId())) {
797 var groupGroupChangePair = groupHelper.acceptInvite(groupInfoV2);
798 result = sendUpdateGroupMessage(groupInfoV2,
799 groupGroupChangePair.first(),
800 groupGroupChangePair.second());
801 }
802
803 if (members != null) {
804 final var newMembers = new HashSet<>(members);
805 newMembers.removeAll(group.getMembers());
806 if (newMembers.size() > 0) {
807 var groupGroupChangePair = groupHelper.updateGroupV2(groupInfoV2, newMembers);
808 result = sendUpdateGroupMessage(groupInfoV2,
809 groupGroupChangePair.first(),
810 groupGroupChangePair.second());
811 }
812 }
813 if (result == null || name != null || avatarFile != null) {
814 var groupGroupChangePair = groupHelper.updateGroupV2(groupInfoV2, name, avatarFile);
815 if (avatarFile != null) {
816 avatarStore.storeGroupAvatar(groupInfoV2.getGroupId(),
817 outputStream -> IOUtils.copyFileToStream(avatarFile, outputStream));
818 }
819 result = sendUpdateGroupMessage(groupInfoV2,
820 groupGroupChangePair.first(),
821 groupGroupChangePair.second());
822 }
823
824 return new Pair<>(group.getGroupId(), result.second());
825 } else {
826 var gv1 = (GroupInfoV1) group;
827 updateGroupV1(gv1, name, members, avatarFile);
828 messageBuilder = getGroupUpdateMessageBuilder(gv1);
829 g = gv1;
830 }
831 }
832
833 account.getGroupStore().updateGroup(g);
834
835 final var result = sendMessage(messageBuilder,
836 g.getMembersIncludingPendingWithout(account.getSelfRecipientId()));
837 return new Pair<>(g.getGroupId(), result.second());
838 }
839
840 private void updateGroupV1(
841 final GroupInfoV1 g, final String name, final Collection<RecipientId> members, final File avatarFile
842 ) throws IOException {
843 if (name != null) {
844 g.name = name;
845 }
846
847 if (members != null) {
848 final var newMemberAddresses = members.stream()
849 .filter(member -> !g.isMember(member))
850 .map(this::resolveSignalServiceAddress)
851 .collect(Collectors.toList());
852 final var newE164Members = new HashSet<String>();
853 for (var member : newMemberAddresses) {
854 if (!member.getNumber().isPresent()) {
855 continue;
856 }
857 newE164Members.add(member.getNumber().get());
858 }
859
860 final var registeredUsers = getRegisteredUsers(newE164Members);
861 if (registeredUsers.size() != newE164Members.size()) {
862 // Some of the new members are not registered on Signal
863 newE164Members.removeAll(registeredUsers.keySet());
864 throw new IOException("Failed to add members "
865 + String.join(", ", newE164Members)
866 + " to group: Not registered on Signal");
867 }
868
869 g.addMembers(members);
870 }
871
872 if (avatarFile != null) {
873 avatarStore.storeGroupAvatar(g.getGroupId(),
874 outputStream -> IOUtils.copyFileToStream(avatarFile, outputStream));
875 }
876 }
877
878 public Pair<GroupId, List<SendMessageResult>> joinGroup(
879 GroupInviteLinkUrl inviteLinkUrl
880 ) throws IOException, GroupLinkNotActiveException {
881 return sendJoinGroupMessage(inviteLinkUrl);
882 }
883
884 private Pair<GroupId, List<SendMessageResult>> sendJoinGroupMessage(
885 GroupInviteLinkUrl inviteLinkUrl
886 ) throws IOException, GroupLinkNotActiveException {
887 final var groupJoinInfo = groupHelper.getDecryptedGroupJoinInfo(inviteLinkUrl.getGroupMasterKey(),
888 inviteLinkUrl.getPassword());
889 final var groupChange = groupHelper.joinGroup(inviteLinkUrl.getGroupMasterKey(),
890 inviteLinkUrl.getPassword(),
891 groupJoinInfo);
892 final var group = getOrMigrateGroup(inviteLinkUrl.getGroupMasterKey(),
893 groupJoinInfo.getRevision() + 1,
894 groupChange.toByteArray());
895
896 if (group.getGroup() == null) {
897 // Only requested member, can't send update to group members
898 return new Pair<>(group.getGroupId(), List.of());
899 }
900
901 final var result = sendUpdateGroupMessage(group, group.getGroup(), groupChange);
902
903 return new Pair<>(group.getGroupId(), result.second());
904 }
905
906 private static int currentTimeDays() {
907 return (int) TimeUnit.MILLISECONDS.toDays(System.currentTimeMillis());
908 }
909
910 private GroupsV2AuthorizationString getGroupAuthForToday(
911 final GroupSecretParams groupSecretParams
912 ) throws IOException {
913 final var today = currentTimeDays();
914 // Returns credentials for the next 7 days
915 final var credentials = groupsV2Api.getCredentials(today);
916 // TODO cache credentials until they expire
917 var authCredentialResponse = credentials.get(today);
918 try {
919 return groupsV2Api.getGroupsV2AuthorizationString(account.getUuid(),
920 today,
921 groupSecretParams,
922 authCredentialResponse);
923 } catch (VerificationFailedException e) {
924 throw new IOException(e);
925 }
926 }
927
928 private Pair<Long, List<SendMessageResult>> sendUpdateGroupMessage(
929 GroupInfoV2 group, DecryptedGroup newDecryptedGroup, GroupChange groupChange
930 ) throws IOException {
931 group.setGroup(newDecryptedGroup, this::resolveRecipient);
932 final var messageBuilder = getGroupUpdateMessageBuilder(group, groupChange.toByteArray());
933 account.getGroupStore().updateGroup(group);
934 return sendMessage(messageBuilder, group.getMembersIncludingPendingWithout(account.getSelfRecipientId()));
935 }
936
937 Pair<Long, List<SendMessageResult>> sendGroupInfoMessage(
938 GroupIdV1 groupId, SignalServiceAddress recipient
939 ) throws IOException, NotAGroupMemberException, GroupNotFoundException, AttachmentInvalidException {
940 GroupInfoV1 g;
941 var group = getGroupForSending(groupId);
942 if (!(group instanceof GroupInfoV1)) {
943 throw new RuntimeException("Received an invalid group request for a v2 group!");
944 }
945 g = (GroupInfoV1) group;
946
947 if (!g.isMember(resolveRecipient(recipient))) {
948 throw new NotAGroupMemberException(groupId, g.name);
949 }
950
951 var messageBuilder = getGroupUpdateMessageBuilder(g);
952
953 // Send group message only to the recipient who requested it
954 return sendMessage(messageBuilder, Set.of(resolveRecipient(recipient)));
955 }
956
957 private SignalServiceDataMessage.Builder getGroupUpdateMessageBuilder(GroupInfoV1 g) throws AttachmentInvalidException {
958 var group = SignalServiceGroup.newBuilder(SignalServiceGroup.Type.UPDATE)
959 .withId(g.getGroupId().serialize())
960 .withName(g.name)
961 .withMembers(g.getMembers()
962 .stream()
963 .map(this::resolveSignalServiceAddress)
964 .collect(Collectors.toList()));
965
966 try {
967 final var attachment = createGroupAvatarAttachment(g.getGroupId());
968 if (attachment.isPresent()) {
969 group.withAvatar(attachment.get());
970 }
971 } catch (IOException e) {
972 throw new AttachmentInvalidException(g.getGroupId().toBase64(), e);
973 }
974
975 return SignalServiceDataMessage.newBuilder()
976 .asGroupMessage(group.build())
977 .withExpiration(g.getMessageExpirationTime());
978 }
979
980 private SignalServiceDataMessage.Builder getGroupUpdateMessageBuilder(GroupInfoV2 g, byte[] signedGroupChange) {
981 var group = SignalServiceGroupV2.newBuilder(g.getMasterKey())
982 .withRevision(g.getGroup().getRevision())
983 .withSignedGroupChange(signedGroupChange);
984 return SignalServiceDataMessage.newBuilder()
985 .asGroupMessage(group.build())
986 .withExpiration(g.getMessageExpirationTime());
987 }
988
989 Pair<Long, List<SendMessageResult>> sendGroupInfoRequest(
990 GroupIdV1 groupId, SignalServiceAddress recipient
991 ) throws IOException {
992 var group = SignalServiceGroup.newBuilder(SignalServiceGroup.Type.REQUEST_INFO).withId(groupId.serialize());
993
994 var messageBuilder = SignalServiceDataMessage.newBuilder().asGroupMessage(group.build());
995
996 // Send group info request message to the recipient who sent us a message with this groupId
997 return sendMessage(messageBuilder, Set.of(resolveRecipient(recipient)));
998 }
999
1000 void sendReceipt(
1001 SignalServiceAddress remoteAddress, long messageId
1002 ) throws IOException, UntrustedIdentityException {
1003 var receiptMessage = new SignalServiceReceiptMessage(SignalServiceReceiptMessage.Type.DELIVERY,
1004 List.of(messageId),
1005 System.currentTimeMillis());
1006
1007 createMessageSender().sendReceipt(remoteAddress,
1008 unidentifiedAccessHelper.getAccessFor(resolveRecipient(remoteAddress)),
1009 receiptMessage);
1010 }
1011
1012 public Pair<Long, List<SendMessageResult>> sendMessage(
1013 String messageText, List<String> attachments, List<String> recipients
1014 ) throws IOException, AttachmentInvalidException, InvalidNumberException {
1015 final var messageBuilder = SignalServiceDataMessage.newBuilder().withBody(messageText);
1016 if (attachments != null) {
1017 var attachmentStreams = AttachmentUtils.getSignalServiceAttachments(attachments);
1018
1019 // Upload attachments here, so we only upload once even for multiple recipients
1020 var messageSender = createMessageSender();
1021 var attachmentPointers = new ArrayList<SignalServiceAttachment>(attachmentStreams.size());
1022 for (var attachment : attachmentStreams) {
1023 if (attachment.isStream()) {
1024 attachmentPointers.add(messageSender.uploadAttachment(attachment.asStream()));
1025 } else if (attachment.isPointer()) {
1026 attachmentPointers.add(attachment.asPointer());
1027 }
1028 }
1029
1030 messageBuilder.withAttachments(attachmentPointers);
1031 }
1032 return sendMessage(messageBuilder, getSignalServiceAddresses(recipients));
1033 }
1034
1035 public Pair<Long, SendMessageResult> sendSelfMessage(
1036 String messageText, List<String> attachments
1037 ) throws IOException, AttachmentInvalidException {
1038 final var messageBuilder = SignalServiceDataMessage.newBuilder().withBody(messageText);
1039 if (attachments != null) {
1040 messageBuilder.withAttachments(AttachmentUtils.getSignalServiceAttachments(attachments));
1041 }
1042 return sendSelfMessage(messageBuilder);
1043 }
1044
1045 public Pair<Long, List<SendMessageResult>> sendRemoteDeleteMessage(
1046 long targetSentTimestamp, List<String> recipients
1047 ) throws IOException, InvalidNumberException {
1048 var delete = new SignalServiceDataMessage.RemoteDelete(targetSentTimestamp);
1049 final var messageBuilder = SignalServiceDataMessage.newBuilder().withRemoteDelete(delete);
1050 return sendMessage(messageBuilder, getSignalServiceAddresses(recipients));
1051 }
1052
1053 public Pair<Long, List<SendMessageResult>> sendGroupRemoteDeleteMessage(
1054 long targetSentTimestamp, GroupId groupId
1055 ) throws IOException, NotAGroupMemberException, GroupNotFoundException {
1056 var delete = new SignalServiceDataMessage.RemoteDelete(targetSentTimestamp);
1057 final var messageBuilder = SignalServiceDataMessage.newBuilder().withRemoteDelete(delete);
1058 return sendGroupMessage(messageBuilder, groupId);
1059 }
1060
1061 public Pair<Long, List<SendMessageResult>> sendMessageReaction(
1062 String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, List<String> recipients
1063 ) throws IOException, InvalidNumberException {
1064 var reaction = new SignalServiceDataMessage.Reaction(emoji,
1065 remove,
1066 canonicalizeAndResolveSignalServiceAddress(targetAuthor),
1067 targetSentTimestamp);
1068 final var messageBuilder = SignalServiceDataMessage.newBuilder().withReaction(reaction);
1069 return sendMessage(messageBuilder, getSignalServiceAddresses(recipients));
1070 }
1071
1072 public Pair<Long, List<SendMessageResult>> sendEndSessionMessage(List<String> recipients) throws IOException, InvalidNumberException {
1073 var messageBuilder = SignalServiceDataMessage.newBuilder().asEndSessionMessage();
1074
1075 final var signalServiceAddresses = getSignalServiceAddresses(recipients);
1076 try {
1077 return sendMessage(messageBuilder, signalServiceAddresses);
1078 } catch (Exception e) {
1079 for (var address : signalServiceAddresses) {
1080 handleEndSession(address);
1081 }
1082 throw e;
1083 }
1084 }
1085
1086 public String getContactName(String number) throws InvalidNumberException {
1087 var contact = account.getContactStore().getContact(canonicalizeAndResolveRecipient(number));
1088 return contact == null || contact.getName() == null ? "" : contact.getName();
1089 }
1090
1091 public void setContactName(String number, String name) throws InvalidNumberException, NotMasterDeviceException {
1092 if (!account.isMasterDevice()) {
1093 throw new NotMasterDeviceException();
1094 }
1095 final var recipientId = canonicalizeAndResolveRecipient(number);
1096 var contact = account.getContactStore().getContact(recipientId);
1097 final var builder = contact == null ? Contact.newBuilder() : Contact.newBuilder(contact);
1098 account.getContactStore().storeContact(recipientId, builder.withName(name).build());
1099 }
1100
1101 public void setContactBlocked(
1102 String number, boolean blocked
1103 ) throws InvalidNumberException, NotMasterDeviceException {
1104 if (!account.isMasterDevice()) {
1105 throw new NotMasterDeviceException();
1106 }
1107 setContactBlocked(canonicalizeAndResolveRecipient(number), blocked);
1108 }
1109
1110 private void setContactBlocked(RecipientId recipientId, boolean blocked) {
1111 var contact = account.getContactStore().getContact(recipientId);
1112 final var builder = contact == null ? Contact.newBuilder() : Contact.newBuilder(contact);
1113 account.getContactStore().storeContact(recipientId, builder.withBlocked(blocked).build());
1114 }
1115
1116 public void setGroupBlocked(final GroupId groupId, final boolean blocked) throws GroupNotFoundException {
1117 var group = getGroup(groupId);
1118 if (group == null) {
1119 throw new GroupNotFoundException(groupId);
1120 }
1121
1122 group.setBlocked(blocked);
1123 account.getGroupStore().updateGroup(group);
1124 }
1125
1126 private void setExpirationTimer(RecipientId recipientId, int messageExpirationTimer) {
1127 var contact = account.getContactStore().getContact(recipientId);
1128 if (contact != null && contact.getMessageExpirationTime() == messageExpirationTimer) {
1129 return;
1130 }
1131 final var builder = contact == null ? Contact.newBuilder() : Contact.newBuilder(contact);
1132 account.getContactStore()
1133 .storeContact(recipientId, builder.withMessageExpirationTime(messageExpirationTimer).build());
1134 }
1135
1136 private void sendExpirationTimerUpdate(RecipientId recipientId) throws IOException {
1137 final var messageBuilder = SignalServiceDataMessage.newBuilder().asExpirationUpdate();
1138 sendMessage(messageBuilder, Set.of(recipientId));
1139 }
1140
1141 /**
1142 * Change the expiration timer for a contact
1143 */
1144 public void setExpirationTimer(
1145 String number, int messageExpirationTimer
1146 ) throws IOException, InvalidNumberException {
1147 var recipientId = canonicalizeAndResolveRecipient(number);
1148 setExpirationTimer(recipientId, messageExpirationTimer);
1149 sendExpirationTimerUpdate(recipientId);
1150 }
1151
1152 /**
1153 * Change the expiration timer for a group
1154 */
1155 public void setExpirationTimer(GroupId groupId, int messageExpirationTimer) {
1156 var g = getGroup(groupId);
1157 if (g instanceof GroupInfoV1) {
1158 var groupInfoV1 = (GroupInfoV1) g;
1159 groupInfoV1.messageExpirationTime = messageExpirationTimer;
1160 account.getGroupStore().updateGroup(groupInfoV1);
1161 } else {
1162 throw new RuntimeException("TODO Not implemented!");
1163 }
1164 }
1165
1166 /**
1167 * Upload the sticker pack from path.
1168 *
1169 * @param path Path can be a path to a manifest.json file or to a zip file that contains a manifest.json file
1170 * @return if successful, returns the URL to install the sticker pack in the signal app
1171 */
1172 public String uploadStickerPack(File path) throws IOException, StickerPackInvalidException {
1173 var manifest = StickerUtils.getSignalServiceStickerManifestUpload(path);
1174
1175 var messageSender = createMessageSender();
1176
1177 var packKey = KeyUtils.createStickerUploadKey();
1178 var packId = messageSender.uploadStickerManifest(manifest, packKey);
1179
1180 var sticker = new Sticker(StickerPackId.deserialize(Hex.fromStringCondensed(packId)), packKey);
1181 account.getStickerStore().updateSticker(sticker);
1182
1183 try {
1184 return new URI("https",
1185 "signal.art",
1186 "/addstickers/",
1187 "pack_id=" + URLEncoder.encode(packId, StandardCharsets.UTF_8) + "&pack_key=" + URLEncoder.encode(
1188 Hex.toStringCondensed(packKey),
1189 StandardCharsets.UTF_8)).toString();
1190 } catch (URISyntaxException e) {
1191 throw new AssertionError(e);
1192 }
1193 }
1194
1195 void requestSyncGroups() throws IOException {
1196 var r = SignalServiceProtos.SyncMessage.Request.newBuilder()
1197 .setType(SignalServiceProtos.SyncMessage.Request.Type.GROUPS)
1198 .build();
1199 var message = SignalServiceSyncMessage.forRequest(new RequestMessage(r));
1200 try {
1201 sendSyncMessage(message);
1202 } catch (UntrustedIdentityException e) {
1203 throw new AssertionError(e);
1204 }
1205 }
1206
1207 void requestSyncContacts() throws IOException {
1208 var r = SignalServiceProtos.SyncMessage.Request.newBuilder()
1209 .setType(SignalServiceProtos.SyncMessage.Request.Type.CONTACTS)
1210 .build();
1211 var message = SignalServiceSyncMessage.forRequest(new RequestMessage(r));
1212 try {
1213 sendSyncMessage(message);
1214 } catch (UntrustedIdentityException e) {
1215 throw new AssertionError(e);
1216 }
1217 }
1218
1219 void requestSyncBlocked() throws IOException {
1220 var r = SignalServiceProtos.SyncMessage.Request.newBuilder()
1221 .setType(SignalServiceProtos.SyncMessage.Request.Type.BLOCKED)
1222 .build();
1223 var message = SignalServiceSyncMessage.forRequest(new RequestMessage(r));
1224 try {
1225 sendSyncMessage(message);
1226 } catch (UntrustedIdentityException e) {
1227 throw new AssertionError(e);
1228 }
1229 }
1230
1231 void requestSyncConfiguration() throws IOException {
1232 var r = SignalServiceProtos.SyncMessage.Request.newBuilder()
1233 .setType(SignalServiceProtos.SyncMessage.Request.Type.CONFIGURATION)
1234 .build();
1235 var message = SignalServiceSyncMessage.forRequest(new RequestMessage(r));
1236 try {
1237 sendSyncMessage(message);
1238 } catch (UntrustedIdentityException e) {
1239 throw new AssertionError(e);
1240 }
1241 }
1242
1243 void requestSyncKeys() throws IOException {
1244 var r = SignalServiceProtos.SyncMessage.Request.newBuilder()
1245 .setType(SignalServiceProtos.SyncMessage.Request.Type.KEYS)
1246 .build();
1247 var message = SignalServiceSyncMessage.forRequest(new RequestMessage(r));
1248 try {
1249 sendSyncMessage(message);
1250 } catch (UntrustedIdentityException e) {
1251 throw new AssertionError(e);
1252 }
1253 }
1254
1255 private byte[] getSenderCertificate() {
1256 // TODO support UUID capable sender certificates
1257 // byte[] certificate = accountManager.getSenderCertificateForPhoneNumberPrivacy();
1258 byte[] certificate;
1259 try {
1260 certificate = accountManager.getSenderCertificate();
1261 } catch (IOException e) {
1262 logger.warn("Failed to get sender certificate, ignoring: {}", e.getMessage());
1263 return null;
1264 }
1265 // TODO cache for a day
1266 return certificate;
1267 }
1268
1269 private void sendSyncMessage(SignalServiceSyncMessage message) throws IOException, UntrustedIdentityException {
1270 var messageSender = createMessageSender();
1271 messageSender.sendMessage(message, unidentifiedAccessHelper.getAccessForSync());
1272 }
1273
1274 private Set<RecipientId> getSignalServiceAddresses(Collection<String> numbers) throws InvalidNumberException {
1275 final var signalServiceAddresses = new HashSet<SignalServiceAddress>(numbers.size());
1276 final var addressesMissingUuid = new HashSet<SignalServiceAddress>();
1277
1278 for (var number : numbers) {
1279 final var resolvedAddress = canonicalizeAndResolveSignalServiceAddress(number);
1280 if (resolvedAddress.getUuid().isPresent()) {
1281 signalServiceAddresses.add(resolvedAddress);
1282 } else {
1283 addressesMissingUuid.add(resolvedAddress);
1284 }
1285 }
1286
1287 final var numbersMissingUuid = addressesMissingUuid.stream()
1288 .map(a -> a.getNumber().get())
1289 .collect(Collectors.toSet());
1290 Map<String, UUID> registeredUsers;
1291 try {
1292 registeredUsers = getRegisteredUsers(numbersMissingUuid);
1293 } catch (IOException e) {
1294 logger.warn("Failed to resolve uuids from server, ignoring: {}", e.getMessage());
1295 registeredUsers = Map.of();
1296 }
1297
1298 for (var address : addressesMissingUuid) {
1299 final var number = address.getNumber().get();
1300 if (registeredUsers.containsKey(number)) {
1301 final var newAddress = resolveSignalServiceAddress(resolveRecipientTrusted(new SignalServiceAddress(
1302 registeredUsers.get(number),
1303 number)));
1304 signalServiceAddresses.add(newAddress);
1305 } else {
1306 signalServiceAddresses.add(address);
1307 }
1308 }
1309
1310 return signalServiceAddresses.stream().map(this::resolveRecipient).collect(Collectors.toSet());
1311 }
1312
1313 private RecipientId refreshRegisteredUser(RecipientId recipientId) throws IOException {
1314 final var address = resolveSignalServiceAddress(recipientId);
1315 if (!address.getNumber().isPresent()) {
1316 return recipientId;
1317 }
1318 final var number = address.getNumber().get();
1319 final var uuidMap = getRegisteredUsers(Set.of(number));
1320 return resolveRecipientTrusted(new SignalServiceAddress(uuidMap.getOrDefault(number, null), number));
1321 }
1322
1323 private Map<String, UUID> getRegisteredUsers(final Set<String> numbers) throws IOException {
1324 try {
1325 return accountManager.getRegisteredUsers(ServiceConfig.getIasKeyStore(),
1326 numbers,
1327 serviceEnvironmentConfig.getCdsMrenclave());
1328 } catch (Quote.InvalidQuoteFormatException | UnauthenticatedQuoteException | SignatureException | UnauthenticatedResponseException | InvalidKeyException e) {
1329 throw new IOException(e);
1330 }
1331 }
1332
1333 private Pair<Long, List<SendMessageResult>> sendMessage(
1334 SignalServiceDataMessage.Builder messageBuilder, Set<RecipientId> recipientIds
1335 ) throws IOException {
1336 final var timestamp = System.currentTimeMillis();
1337 messageBuilder.withTimestamp(timestamp);
1338 getOrCreateMessagePipe();
1339 getOrCreateUnidentifiedMessagePipe();
1340 SignalServiceDataMessage message = null;
1341 try {
1342 message = messageBuilder.build();
1343 if (message.getGroupContext().isPresent()) {
1344 try {
1345 var messageSender = createMessageSender();
1346 final var isRecipientUpdate = false;
1347 final var recipientIdList = new ArrayList<>(recipientIds);
1348 final var addresses = recipientIdList.stream()
1349 .map(this::resolveSignalServiceAddress)
1350 .collect(Collectors.toList());
1351 var result = messageSender.sendMessage(addresses,
1352 unidentifiedAccessHelper.getAccessFor(recipientIdList),
1353 isRecipientUpdate,
1354 message);
1355
1356 for (var r : result) {
1357 if (r.getIdentityFailure() != null) {
1358 account.getIdentityKeyStore().
1359 saveIdentity(resolveRecipient(r.getAddress()),
1360 r.getIdentityFailure().getIdentityKey(),
1361 new Date());
1362 }
1363 }
1364
1365 return new Pair<>(timestamp, result);
1366 } catch (UntrustedIdentityException e) {
1367 return new Pair<>(timestamp, List.of());
1368 }
1369 } else {
1370 // Send to all individually, so sync messages are sent correctly
1371 messageBuilder.withProfileKey(account.getProfileKey().serialize());
1372 var results = new ArrayList<SendMessageResult>(recipientIds.size());
1373 for (var recipientId : recipientIds) {
1374 final var contact = account.getContactStore().getContact(recipientId);
1375 final var expirationTime = contact != null ? contact.getMessageExpirationTime() : 0;
1376 messageBuilder.withExpiration(expirationTime);
1377 message = messageBuilder.build();
1378 results.add(sendMessage(resolveSignalServiceAddress(recipientId), message));
1379 }
1380 return new Pair<>(timestamp, results);
1381 }
1382 } finally {
1383 if (message != null && message.isEndSession()) {
1384 for (var recipient : recipientIds) {
1385 handleEndSession(recipient);
1386 }
1387 }
1388 }
1389 }
1390
1391 private Pair<Long, SendMessageResult> sendSelfMessage(
1392 SignalServiceDataMessage.Builder messageBuilder
1393 ) throws IOException {
1394 final var timestamp = System.currentTimeMillis();
1395 messageBuilder.withTimestamp(timestamp);
1396 getOrCreateMessagePipe();
1397 getOrCreateUnidentifiedMessagePipe();
1398 final var recipientId = account.getSelfRecipientId();
1399
1400 final var contact = account.getContactStore().getContact(recipientId);
1401 final var expirationTime = contact != null ? contact.getMessageExpirationTime() : 0;
1402 messageBuilder.withExpiration(expirationTime);
1403
1404 var message = messageBuilder.build();
1405 final var result = sendSelfMessage(message);
1406 return new Pair<>(timestamp, result);
1407 }
1408
1409 private SendMessageResult sendSelfMessage(SignalServiceDataMessage message) throws IOException {
1410 var messageSender = createMessageSender();
1411
1412 var recipient = account.getSelfAddress();
1413
1414 final var unidentifiedAccess = unidentifiedAccessHelper.getAccessFor(resolveRecipient(recipient));
1415 var transcript = new SentTranscriptMessage(Optional.of(recipient),
1416 message.getTimestamp(),
1417 message,
1418 message.getExpiresInSeconds(),
1419 Map.of(recipient, unidentifiedAccess.isPresent()),
1420 false);
1421 var syncMessage = SignalServiceSyncMessage.forSentTranscript(transcript);
1422
1423 try {
1424 var startTime = System.currentTimeMillis();
1425 messageSender.sendMessage(syncMessage, unidentifiedAccess);
1426 return SendMessageResult.success(recipient,
1427 unidentifiedAccess.isPresent(),
1428 false,
1429 System.currentTimeMillis() - startTime);
1430 } catch (UntrustedIdentityException e) {
1431 return SendMessageResult.identityFailure(recipient, e.getIdentityKey());
1432 }
1433 }
1434
1435 private SendMessageResult sendMessage(
1436 SignalServiceAddress address, SignalServiceDataMessage message
1437 ) throws IOException {
1438 var messageSender = createMessageSender();
1439
1440 final var recipientId = resolveRecipient(address);
1441 try {
1442 try {
1443 return messageSender.sendMessage(address, unidentifiedAccessHelper.getAccessFor(recipientId), message);
1444 } catch (UnregisteredUserException e) {
1445 final var newRecipientId = refreshRegisteredUser(recipientId);
1446 return messageSender.sendMessage(resolveSignalServiceAddress(newRecipientId),
1447 unidentifiedAccessHelper.getAccessFor(newRecipientId),
1448 message);
1449 }
1450 } catch (UntrustedIdentityException e) {
1451 return SendMessageResult.identityFailure(address, e.getIdentityKey());
1452 }
1453 }
1454
1455 private SignalServiceContent decryptMessage(SignalServiceEnvelope envelope) throws InvalidMetadataMessageException, ProtocolInvalidMessageException, ProtocolDuplicateMessageException, ProtocolLegacyMessageException, ProtocolInvalidKeyIdException, InvalidMetadataVersionException, ProtocolInvalidVersionException, ProtocolNoSessionException, ProtocolInvalidKeyException, SelfSendException, UnsupportedDataMessageException, org.whispersystems.libsignal.UntrustedIdentityException {
1456 var cipher = new SignalServiceCipher(account.getSelfAddress(),
1457 account.getSignalProtocolStore(),
1458 certificateValidator);
1459 try {
1460 return cipher.decrypt(envelope);
1461 } catch (ProtocolUntrustedIdentityException e) {
1462 if (e.getCause() instanceof org.whispersystems.libsignal.UntrustedIdentityException) {
1463 throw (org.whispersystems.libsignal.UntrustedIdentityException) e.getCause();
1464 }
1465 throw new AssertionError(e);
1466 }
1467 }
1468
1469 private void handleEndSession(RecipientId recipientId) {
1470 account.getSessionStore().deleteAllSessions(recipientId);
1471 }
1472
1473 private List<HandleAction> handleSignalServiceDataMessage(
1474 SignalServiceDataMessage message,
1475 boolean isSync,
1476 SignalServiceAddress source,
1477 SignalServiceAddress destination,
1478 boolean ignoreAttachments
1479 ) {
1480 var actions = new ArrayList<HandleAction>();
1481 if (message.getGroupContext().isPresent()) {
1482 if (message.getGroupContext().get().getGroupV1().isPresent()) {
1483 var groupInfo = message.getGroupContext().get().getGroupV1().get();
1484 var groupId = GroupId.v1(groupInfo.getGroupId());
1485 var group = getGroup(groupId);
1486 if (group == null || group instanceof GroupInfoV1) {
1487 var groupV1 = (GroupInfoV1) group;
1488 switch (groupInfo.getType()) {
1489 case UPDATE: {
1490 if (groupV1 == null) {
1491 groupV1 = new GroupInfoV1(groupId);
1492 }
1493
1494 if (groupInfo.getAvatar().isPresent()) {
1495 var avatar = groupInfo.getAvatar().get();
1496 downloadGroupAvatar(avatar, groupV1.getGroupId());
1497 }
1498
1499 if (groupInfo.getName().isPresent()) {
1500 groupV1.name = groupInfo.getName().get();
1501 }
1502
1503 if (groupInfo.getMembers().isPresent()) {
1504 groupV1.addMembers(groupInfo.getMembers()
1505 .get()
1506 .stream()
1507 .map(this::resolveRecipient)
1508 .collect(Collectors.toSet()));
1509 }
1510
1511 account.getGroupStore().updateGroup(groupV1);
1512 break;
1513 }
1514 case DELIVER:
1515 if (groupV1 == null && !isSync) {
1516 actions.add(new SendGroupInfoRequestAction(source, groupId));
1517 }
1518 break;
1519 case QUIT: {
1520 if (groupV1 != null) {
1521 groupV1.removeMember(resolveRecipient(source));
1522 account.getGroupStore().updateGroup(groupV1);
1523 }
1524 break;
1525 }
1526 case REQUEST_INFO:
1527 if (groupV1 != null && !isSync) {
1528 actions.add(new SendGroupInfoAction(source, groupV1.getGroupId()));
1529 }
1530 break;
1531 }
1532 } else {
1533 // Received a group v1 message for a v2 group
1534 }
1535 }
1536 if (message.getGroupContext().get().getGroupV2().isPresent()) {
1537 final var groupContext = message.getGroupContext().get().getGroupV2().get();
1538 final var groupMasterKey = groupContext.getMasterKey();
1539
1540 getOrMigrateGroup(groupMasterKey,
1541 groupContext.getRevision(),
1542 groupContext.hasSignedGroupChange() ? groupContext.getSignedGroupChange() : null);
1543 }
1544 }
1545
1546 final var conversationPartnerAddress = isSync ? destination : source;
1547 if (conversationPartnerAddress != null && message.isEndSession()) {
1548 handleEndSession(resolveRecipient(conversationPartnerAddress));
1549 }
1550 if (message.isExpirationUpdate() || message.getBody().isPresent()) {
1551 if (message.getGroupContext().isPresent()) {
1552 if (message.getGroupContext().get().getGroupV1().isPresent()) {
1553 var groupInfo = message.getGroupContext().get().getGroupV1().get();
1554 var group = account.getGroupStore().getOrCreateGroupV1(GroupId.v1(groupInfo.getGroupId()));
1555 if (group != null) {
1556 if (group.messageExpirationTime != message.getExpiresInSeconds()) {
1557 group.messageExpirationTime = message.getExpiresInSeconds();
1558 account.getGroupStore().updateGroup(group);
1559 }
1560 }
1561 } else if (message.getGroupContext().get().getGroupV2().isPresent()) {
1562 // disappearing message timer already stored in the DecryptedGroup
1563 }
1564 } else if (conversationPartnerAddress != null) {
1565 setExpirationTimer(resolveRecipient(conversationPartnerAddress), message.getExpiresInSeconds());
1566 }
1567 }
1568 if (!ignoreAttachments) {
1569 if (message.getAttachments().isPresent()) {
1570 for (var attachment : message.getAttachments().get()) {
1571 downloadAttachment(attachment);
1572 }
1573 }
1574 if (message.getSharedContacts().isPresent()) {
1575 for (var contact : message.getSharedContacts().get()) {
1576 if (contact.getAvatar().isPresent()) {
1577 downloadAttachment(contact.getAvatar().get().getAttachment());
1578 }
1579 }
1580 }
1581 }
1582 if (message.getProfileKey().isPresent() && message.getProfileKey().get().length == 32) {
1583 final ProfileKey profileKey;
1584 try {
1585 profileKey = new ProfileKey(message.getProfileKey().get());
1586 } catch (InvalidInputException e) {
1587 throw new AssertionError(e);
1588 }
1589 if (source.matches(account.getSelfAddress())) {
1590 this.account.setProfileKey(profileKey);
1591 }
1592 this.account.getProfileStore().storeProfileKey(resolveRecipient(source), profileKey);
1593 }
1594 if (message.getPreviews().isPresent()) {
1595 final var previews = message.getPreviews().get();
1596 for (var preview : previews) {
1597 if (preview.getImage().isPresent()) {
1598 downloadAttachment(preview.getImage().get());
1599 }
1600 }
1601 }
1602 if (message.getQuote().isPresent()) {
1603 final var quote = message.getQuote().get();
1604
1605 for (var quotedAttachment : quote.getAttachments()) {
1606 final var thumbnail = quotedAttachment.getThumbnail();
1607 if (thumbnail != null) {
1608 downloadAttachment(thumbnail);
1609 }
1610 }
1611 }
1612 if (message.getSticker().isPresent()) {
1613 final var messageSticker = message.getSticker().get();
1614 final var stickerPackId = StickerPackId.deserialize(messageSticker.getPackId());
1615 var sticker = account.getStickerStore().getSticker(stickerPackId);
1616 if (sticker == null) {
1617 sticker = new Sticker(stickerPackId, messageSticker.getPackKey());
1618 account.getStickerStore().updateSticker(sticker);
1619 }
1620 }
1621 return actions;
1622 }
1623
1624 private GroupInfoV2 getOrMigrateGroup(
1625 final GroupMasterKey groupMasterKey, final int revision, final byte[] signedGroupChange
1626 ) {
1627 final var groupSecretParams = GroupSecretParams.deriveFromMasterKey(groupMasterKey);
1628
1629 var groupId = GroupUtils.getGroupIdV2(groupSecretParams);
1630 var groupInfo = getGroup(groupId);
1631 final GroupInfoV2 groupInfoV2;
1632 if (groupInfo instanceof GroupInfoV1) {
1633 // Received a v2 group message for a v1 group, we need to locally migrate the group
1634 account.getGroupStore().deleteGroupV1(((GroupInfoV1) groupInfo).getGroupId());
1635 groupInfoV2 = new GroupInfoV2(groupId, groupMasterKey);
1636 logger.info("Locally migrated group {} to group v2, id: {}",
1637 groupInfo.getGroupId().toBase64(),
1638 groupInfoV2.getGroupId().toBase64());
1639 } else if (groupInfo instanceof GroupInfoV2) {
1640 groupInfoV2 = (GroupInfoV2) groupInfo;
1641 } else {
1642 groupInfoV2 = new GroupInfoV2(groupId, groupMasterKey);
1643 }
1644
1645 if (groupInfoV2.getGroup() == null || groupInfoV2.getGroup().getRevision() < revision) {
1646 DecryptedGroup group = null;
1647 if (signedGroupChange != null
1648 && groupInfoV2.getGroup() != null
1649 && groupInfoV2.getGroup().getRevision() + 1 == revision) {
1650 group = groupHelper.getUpdatedDecryptedGroup(groupInfoV2.getGroup(), signedGroupChange, groupMasterKey);
1651 }
1652 if (group == null) {
1653 group = groupHelper.getDecryptedGroup(groupSecretParams);
1654 }
1655 if (group != null) {
1656 storeProfileKeysFromMembers(group);
1657 final var avatar = group.getAvatar();
1658 if (avatar != null && !avatar.isEmpty()) {
1659 downloadGroupAvatar(groupId, groupSecretParams, avatar);
1660 }
1661 }
1662 groupInfoV2.setGroup(group, this::resolveRecipient);
1663 account.getGroupStore().updateGroup(groupInfoV2);
1664 }
1665
1666 return groupInfoV2;
1667 }
1668
1669 private void storeProfileKeysFromMembers(final DecryptedGroup group) {
1670 for (var member : group.getMembersList()) {
1671 final var address = resolveRecipient(new SignalServiceAddress(UuidUtil.parseOrThrow(member.getUuid()
1672 .toByteArray()), null));
1673 try {
1674 account.getProfileStore()
1675 .storeProfileKey(address, new ProfileKey(member.getProfileKey().toByteArray()));
1676 } catch (InvalidInputException ignored) {
1677 }
1678 }
1679 }
1680
1681 private void retryFailedReceivedMessages(ReceiveMessageHandler handler, boolean ignoreAttachments) {
1682 Set<HandleAction> queuedActions = new HashSet<>();
1683 for (var cachedMessage : account.getMessageCache().getCachedMessages()) {
1684 var actions = retryFailedReceivedMessage(handler, ignoreAttachments, cachedMessage);
1685 if (actions != null) {
1686 queuedActions.addAll(actions);
1687 }
1688 }
1689 for (var action : queuedActions) {
1690 try {
1691 action.execute(this);
1692 } catch (Throwable e) {
1693 logger.warn("Message action failed.", e);
1694 }
1695 }
1696 }
1697
1698 private List<HandleAction> retryFailedReceivedMessage(
1699 final ReceiveMessageHandler handler, final boolean ignoreAttachments, final CachedMessage cachedMessage
1700 ) {
1701 var envelope = cachedMessage.loadEnvelope();
1702 if (envelope == null) {
1703 return null;
1704 }
1705 SignalServiceContent content = null;
1706 List<HandleAction> actions = null;
1707 if (!envelope.isReceipt()) {
1708 try {
1709 content = decryptMessage(envelope);
1710 } catch (org.whispersystems.libsignal.UntrustedIdentityException e) {
1711 if (!envelope.hasSource()) {
1712 final var recipientId = resolveRecipient(((org.whispersystems.libsignal.UntrustedIdentityException) e)
1713 .getName());
1714 try {
1715 account.getMessageCache().replaceSender(cachedMessage, recipientId);
1716 } catch (IOException ioException) {
1717 logger.warn("Failed to move cached message to recipient folder: {}", ioException.getMessage());
1718 }
1719 }
1720 return null;
1721 } catch (Exception er) {
1722 // All other errors are not recoverable, so delete the cached message
1723 cachedMessage.delete();
1724 return null;
1725 }
1726 actions = handleMessage(envelope, content, ignoreAttachments);
1727 }
1728 handler.handleMessage(envelope, content, null);
1729 cachedMessage.delete();
1730 return actions;
1731 }
1732
1733 public void receiveMessages(
1734 long timeout,
1735 TimeUnit unit,
1736 boolean returnOnTimeout,
1737 boolean ignoreAttachments,
1738 ReceiveMessageHandler handler
1739 ) throws IOException {
1740 retryFailedReceivedMessages(handler, ignoreAttachments);
1741
1742 Set<HandleAction> queuedActions = null;
1743
1744 final var messagePipe = getOrCreateMessagePipe();
1745
1746 var hasCaughtUpWithOldMessages = false;
1747
1748 while (true) {
1749 SignalServiceEnvelope envelope;
1750 SignalServiceContent content = null;
1751 Exception exception = null;
1752 final CachedMessage[] cachedMessage = {null};
1753 try {
1754 var result = messagePipe.readOrEmpty(timeout, unit, envelope1 -> {
1755 final var recipientId = envelope1.hasSource()
1756 ? resolveRecipient(envelope1.getSourceIdentifier())
1757 : null;
1758 // store message on disk, before acknowledging receipt to the server
1759 cachedMessage[0] = account.getMessageCache().cacheMessage(envelope1, recipientId);
1760 });
1761 if (result.isPresent()) {
1762 envelope = result.get();
1763 } else {
1764 // Received indicator that server queue is empty
1765 hasCaughtUpWithOldMessages = true;
1766
1767 if (queuedActions != null) {
1768 for (var action : queuedActions) {
1769 try {
1770 action.execute(this);
1771 } catch (Throwable e) {
1772 logger.warn("Message action failed.", e);
1773 }
1774 }
1775 queuedActions.clear();
1776 queuedActions = null;
1777 }
1778
1779 // Continue to wait another timeout for new messages
1780 continue;
1781 }
1782 } catch (TimeoutException e) {
1783 if (returnOnTimeout) return;
1784 continue;
1785 }
1786
1787 if (envelope.hasSource()) {
1788 // Store uuid if we don't have it already
1789 resolveRecipientTrusted(envelope.getSourceAddress());
1790 }
1791 final var notAGroupMember = isNotAGroupMember(envelope, content);
1792 if (!envelope.isReceipt()) {
1793 try {
1794 content = decryptMessage(envelope);
1795 } catch (Exception e) {
1796 exception = e;
1797 }
1798 var actions = handleMessage(envelope, content, ignoreAttachments);
1799 if (hasCaughtUpWithOldMessages) {
1800 for (var action : actions) {
1801 try {
1802 action.execute(this);
1803 } catch (Throwable e) {
1804 logger.warn("Message action failed.", e);
1805 }
1806 }
1807 } else {
1808 if (queuedActions == null) {
1809 queuedActions = new HashSet<>();
1810 }
1811 queuedActions.addAll(actions);
1812 }
1813 }
1814 if (isMessageBlocked(envelope, content)) {
1815 logger.info("Ignoring a message from blocked user/group: {}", envelope.getTimestamp());
1816 } else if (notAGroupMember) {
1817 logger.info("Ignoring a message from a non group member: {}", envelope.getTimestamp());
1818 } else {
1819 handler.handleMessage(envelope, content, exception);
1820 }
1821 if (cachedMessage[0] != null) {
1822 if (exception instanceof org.whispersystems.libsignal.UntrustedIdentityException) {
1823 final var recipientId = resolveRecipient(((org.whispersystems.libsignal.UntrustedIdentityException) exception)
1824 .getName());
1825 queuedActions.add(new RetrieveProfileAction(recipientId));
1826 if (!envelope.hasSource()) {
1827 try {
1828 cachedMessage[0] = account.getMessageCache().replaceSender(cachedMessage[0], recipientId);
1829 } catch (IOException ioException) {
1830 logger.warn("Failed to move cached message to recipient folder: {}",
1831 ioException.getMessage());
1832 }
1833 }
1834 } else {
1835 cachedMessage[0].delete();
1836 }
1837 }
1838 }
1839 }
1840
1841 private boolean isMessageBlocked(
1842 SignalServiceEnvelope envelope, SignalServiceContent content
1843 ) {
1844 SignalServiceAddress source;
1845 if (!envelope.isUnidentifiedSender() && envelope.hasSource()) {
1846 source = envelope.getSourceAddress();
1847 } else if (content != null) {
1848 source = content.getSender();
1849 } else {
1850 return false;
1851 }
1852 final var recipientId = resolveRecipient(source);
1853 if (isContactBlocked(recipientId)) {
1854 return true;
1855 }
1856
1857 if (content != null && content.getDataMessage().isPresent()) {
1858 var message = content.getDataMessage().get();
1859 if (message.getGroupContext().isPresent()) {
1860 var groupId = GroupUtils.getGroupId(message.getGroupContext().get());
1861 var group = getGroup(groupId);
1862 if (group != null && group.isBlocked()) {
1863 return true;
1864 }
1865 }
1866 }
1867 return false;
1868 }
1869
1870 public boolean isContactBlocked(final String identifier) throws InvalidNumberException {
1871 final var recipientId = canonicalizeAndResolveRecipient(identifier);
1872 return isContactBlocked(recipientId);
1873 }
1874
1875 private boolean isContactBlocked(final RecipientId recipientId) {
1876 var sourceContact = account.getContactStore().getContact(recipientId);
1877 return sourceContact != null && sourceContact.isBlocked();
1878 }
1879
1880 private boolean isNotAGroupMember(
1881 SignalServiceEnvelope envelope, SignalServiceContent content
1882 ) {
1883 SignalServiceAddress source;
1884 if (!envelope.isUnidentifiedSender() && envelope.hasSource()) {
1885 source = envelope.getSourceAddress();
1886 } else if (content != null) {
1887 source = content.getSender();
1888 } else {
1889 return false;
1890 }
1891
1892 if (content != null && content.getDataMessage().isPresent()) {
1893 var message = content.getDataMessage().get();
1894 if (message.getGroupContext().isPresent()) {
1895 if (message.getGroupContext().get().getGroupV1().isPresent()) {
1896 var groupInfo = message.getGroupContext().get().getGroupV1().get();
1897 if (groupInfo.getType() == SignalServiceGroup.Type.QUIT) {
1898 return false;
1899 }
1900 }
1901 var groupId = GroupUtils.getGroupId(message.getGroupContext().get());
1902 var group = getGroup(groupId);
1903 if (group != null && !group.isMember(resolveRecipient(source))) {
1904 return true;
1905 }
1906 }
1907 }
1908 return false;
1909 }
1910
1911 private List<HandleAction> handleMessage(
1912 SignalServiceEnvelope envelope, SignalServiceContent content, boolean ignoreAttachments
1913 ) {
1914 var actions = new ArrayList<HandleAction>();
1915 if (content != null) {
1916 final SignalServiceAddress sender;
1917 if (!envelope.isUnidentifiedSender() && envelope.hasSource()) {
1918 sender = envelope.getSourceAddress();
1919 } else {
1920 sender = content.getSender();
1921 }
1922
1923 if (content.getDataMessage().isPresent()) {
1924 var message = content.getDataMessage().get();
1925
1926 if (content.isNeedsReceipt()) {
1927 actions.add(new SendReceiptAction(sender, message.getTimestamp()));
1928 }
1929
1930 actions.addAll(handleSignalServiceDataMessage(message,
1931 false,
1932 sender,
1933 account.getSelfAddress(),
1934 ignoreAttachments));
1935 }
1936 if (content.getSyncMessage().isPresent()) {
1937 account.setMultiDevice(true);
1938 var syncMessage = content.getSyncMessage().get();
1939 if (syncMessage.getSent().isPresent()) {
1940 var message = syncMessage.getSent().get();
1941 final var destination = message.getDestination().orNull();
1942 actions.addAll(handleSignalServiceDataMessage(message.getMessage(),
1943 true,
1944 sender,
1945 destination,
1946 ignoreAttachments));
1947 }
1948 if (syncMessage.getRequest().isPresent() && account.isMasterDevice()) {
1949 var rm = syncMessage.getRequest().get();
1950 if (rm.isContactsRequest()) {
1951 actions.add(SendSyncContactsAction.create());
1952 }
1953 if (rm.isGroupsRequest()) {
1954 actions.add(SendSyncGroupsAction.create());
1955 }
1956 if (rm.isBlockedListRequest()) {
1957 actions.add(SendSyncBlockedListAction.create());
1958 }
1959 // TODO Handle rm.isConfigurationRequest(); rm.isKeysRequest();
1960 }
1961 if (syncMessage.getGroups().isPresent()) {
1962 File tmpFile = null;
1963 try {
1964 tmpFile = IOUtils.createTempFile();
1965 final var groupsMessage = syncMessage.getGroups().get();
1966 try (var attachmentAsStream = retrieveAttachmentAsStream(groupsMessage.asPointer(), tmpFile)) {
1967 var s = new DeviceGroupsInputStream(attachmentAsStream);
1968 DeviceGroup g;
1969 while ((g = s.read()) != null) {
1970 var syncGroup = account.getGroupStore().getOrCreateGroupV1(GroupId.v1(g.getId()));
1971 if (syncGroup != null) {
1972 if (g.getName().isPresent()) {
1973 syncGroup.name = g.getName().get();
1974 }
1975 syncGroup.addMembers(g.getMembers()
1976 .stream()
1977 .map(this::resolveRecipient)
1978 .collect(Collectors.toSet()));
1979 if (!g.isActive()) {
1980 syncGroup.removeMember(account.getSelfRecipientId());
1981 } else {
1982 // Add ourself to the member set as it's marked as active
1983 syncGroup.addMembers(List.of(account.getSelfRecipientId()));
1984 }
1985 syncGroup.blocked = g.isBlocked();
1986 if (g.getColor().isPresent()) {
1987 syncGroup.color = g.getColor().get();
1988 }
1989
1990 if (g.getAvatar().isPresent()) {
1991 downloadGroupAvatar(g.getAvatar().get(), syncGroup.getGroupId());
1992 }
1993 syncGroup.archived = g.isArchived();
1994 account.getGroupStore().updateGroup(syncGroup);
1995 }
1996 }
1997 }
1998 } catch (Exception e) {
1999 logger.warn("Failed to handle received sync groups “{}”, ignoring: {}",
2000 tmpFile,
2001 e.getMessage());
2002 } finally {
2003 if (tmpFile != null) {
2004 try {
2005 Files.delete(tmpFile.toPath());
2006 } catch (IOException e) {
2007 logger.warn("Failed to delete received groups temp file “{}”, ignoring: {}",
2008 tmpFile,
2009 e.getMessage());
2010 }
2011 }
2012 }
2013 }
2014 if (syncMessage.getBlockedList().isPresent()) {
2015 final var blockedListMessage = syncMessage.getBlockedList().get();
2016 for (var address : blockedListMessage.getAddresses()) {
2017 setContactBlocked(resolveRecipient(address), true);
2018 }
2019 for (var groupId : blockedListMessage.getGroupIds()
2020 .stream()
2021 .map(GroupId::unknownVersion)
2022 .collect(Collectors.toSet())) {
2023 try {
2024 setGroupBlocked(groupId, true);
2025 } catch (GroupNotFoundException e) {
2026 logger.warn("BlockedListMessage contained groupID that was not found in GroupStore: {}",
2027 groupId.toBase64());
2028 }
2029 }
2030 }
2031 if (syncMessage.getContacts().isPresent()) {
2032 File tmpFile = null;
2033 try {
2034 tmpFile = IOUtils.createTempFile();
2035 final var contactsMessage = syncMessage.getContacts().get();
2036 try (var attachmentAsStream = retrieveAttachmentAsStream(contactsMessage.getContactsStream()
2037 .asPointer(), tmpFile)) {
2038 var s = new DeviceContactsInputStream(attachmentAsStream);
2039 DeviceContact c;
2040 while ((c = s.read()) != null) {
2041 if (c.getAddress().matches(account.getSelfAddress()) && c.getProfileKey().isPresent()) {
2042 account.setProfileKey(c.getProfileKey().get());
2043 }
2044 final var recipientId = resolveRecipientTrusted(c.getAddress());
2045 var contact = account.getContactStore().getContact(recipientId);
2046 final var builder = contact == null
2047 ? Contact.newBuilder()
2048 : Contact.newBuilder(contact);
2049 if (c.getName().isPresent()) {
2050 builder.withName(c.getName().get());
2051 }
2052 if (c.getColor().isPresent()) {
2053 builder.withColor(c.getColor().get());
2054 }
2055 if (c.getProfileKey().isPresent()) {
2056 account.getProfileStore().storeProfileKey(recipientId, c.getProfileKey().get());
2057 }
2058 if (c.getVerified().isPresent()) {
2059 final var verifiedMessage = c.getVerified().get();
2060 account.getIdentityKeyStore()
2061 .setIdentityTrustLevel(resolveRecipientTrusted(verifiedMessage.getDestination()),
2062 verifiedMessage.getIdentityKey(),
2063 TrustLevel.fromVerifiedState(verifiedMessage.getVerified()));
2064 }
2065 if (c.getExpirationTimer().isPresent()) {
2066 builder.withMessageExpirationTime(c.getExpirationTimer().get());
2067 }
2068 builder.withBlocked(c.isBlocked());
2069 builder.withArchived(c.isArchived());
2070 account.getContactStore().storeContact(recipientId, builder.build());
2071
2072 if (c.getAvatar().isPresent()) {
2073 downloadContactAvatar(c.getAvatar().get(), c.getAddress());
2074 }
2075 }
2076 }
2077 } catch (Exception e) {
2078 logger.warn("Failed to handle received sync contacts “{}”, ignoring: {}",
2079 tmpFile,
2080 e.getMessage());
2081 } finally {
2082 if (tmpFile != null) {
2083 try {
2084 Files.delete(tmpFile.toPath());
2085 } catch (IOException e) {
2086 logger.warn("Failed to delete received contacts temp file “{}”, ignoring: {}",
2087 tmpFile,
2088 e.getMessage());
2089 }
2090 }
2091 }
2092 }
2093 if (syncMessage.getVerified().isPresent()) {
2094 final var verifiedMessage = syncMessage.getVerified().get();
2095 account.getIdentityKeyStore()
2096 .setIdentityTrustLevel(resolveRecipientTrusted(verifiedMessage.getDestination()),
2097 verifiedMessage.getIdentityKey(),
2098 TrustLevel.fromVerifiedState(verifiedMessage.getVerified()));
2099 }
2100 if (syncMessage.getStickerPackOperations().isPresent()) {
2101 final var stickerPackOperationMessages = syncMessage.getStickerPackOperations().get();
2102 for (var m : stickerPackOperationMessages) {
2103 if (!m.getPackId().isPresent()) {
2104 continue;
2105 }
2106 final var stickerPackId = StickerPackId.deserialize(m.getPackId().get());
2107 var sticker = account.getStickerStore().getSticker(stickerPackId);
2108 if (sticker == null) {
2109 if (!m.getPackKey().isPresent()) {
2110 continue;
2111 }
2112 sticker = new Sticker(stickerPackId, m.getPackKey().get());
2113 }
2114 sticker.setInstalled(!m.getType().isPresent()
2115 || m.getType().get() == StickerPackOperationMessage.Type.INSTALL);
2116 account.getStickerStore().updateSticker(sticker);
2117 }
2118 }
2119 if (syncMessage.getFetchType().isPresent()) {
2120 switch (syncMessage.getFetchType().get()) {
2121 case LOCAL_PROFILE:
2122 getRecipientProfile(account.getSelfRecipientId(), true);
2123 case STORAGE_MANIFEST:
2124 // TODO
2125 }
2126 }
2127 if (syncMessage.getKeys().isPresent()) {
2128 final var keysMessage = syncMessage.getKeys().get();
2129 if (keysMessage.getStorageService().isPresent()) {
2130 final var storageKey = keysMessage.getStorageService().get();
2131 account.setStorageKey(storageKey);
2132 }
2133 }
2134 if (syncMessage.getConfiguration().isPresent()) {
2135 // TODO
2136 }
2137 }
2138 }
2139 return actions;
2140 }
2141
2142 private void downloadContactAvatar(SignalServiceAttachment avatar, SignalServiceAddress address) {
2143 try {
2144 avatarStore.storeContactAvatar(address, outputStream -> retrieveAttachment(avatar, outputStream));
2145 } catch (IOException e) {
2146 logger.warn("Failed to download avatar for contact {}, ignoring: {}", address, e.getMessage());
2147 }
2148 }
2149
2150 private void downloadGroupAvatar(SignalServiceAttachment avatar, GroupId groupId) {
2151 try {
2152 avatarStore.storeGroupAvatar(groupId, outputStream -> retrieveAttachment(avatar, outputStream));
2153 } catch (IOException e) {
2154 logger.warn("Failed to download avatar for group {}, ignoring: {}", groupId.toBase64(), e.getMessage());
2155 }
2156 }
2157
2158 private void downloadGroupAvatar(GroupId groupId, GroupSecretParams groupSecretParams, String cdnKey) {
2159 try {
2160 avatarStore.storeGroupAvatar(groupId,
2161 outputStream -> retrieveGroupV2Avatar(groupSecretParams, cdnKey, outputStream));
2162 } catch (IOException e) {
2163 logger.warn("Failed to download avatar for group {}, ignoring: {}", groupId.toBase64(), e.getMessage());
2164 }
2165 }
2166
2167 private void downloadProfileAvatar(
2168 SignalServiceAddress address, String avatarPath, ProfileKey profileKey
2169 ) {
2170 try {
2171 avatarStore.storeProfileAvatar(address,
2172 outputStream -> retrieveProfileAvatar(avatarPath, profileKey, outputStream));
2173 } catch (Throwable e) {
2174 logger.warn("Failed to download profile avatar, ignoring: {}", e.getMessage());
2175 }
2176 }
2177
2178 public File getAttachmentFile(SignalServiceAttachmentRemoteId attachmentId) {
2179 return attachmentStore.getAttachmentFile(attachmentId);
2180 }
2181
2182 private void downloadAttachment(final SignalServiceAttachment attachment) {
2183 if (!attachment.isPointer()) {
2184 logger.warn("Invalid state, can't store an attachment stream.");
2185 }
2186
2187 var pointer = attachment.asPointer();
2188 if (pointer.getPreview().isPresent()) {
2189 final var preview = pointer.getPreview().get();
2190 try {
2191 attachmentStore.storeAttachmentPreview(pointer.getRemoteId(),
2192 outputStream -> outputStream.write(preview, 0, preview.length));
2193 } catch (IOException e) {
2194 logger.warn("Failed to download attachment preview, ignoring: {}", e.getMessage());
2195 }
2196 }
2197
2198 try {
2199 attachmentStore.storeAttachment(pointer.getRemoteId(),
2200 outputStream -> retrieveAttachmentPointer(pointer, outputStream));
2201 } catch (IOException e) {
2202 logger.warn("Failed to download attachment ({}), ignoring: {}", pointer.getRemoteId(), e.getMessage());
2203 }
2204 }
2205
2206 private void retrieveGroupV2Avatar(
2207 GroupSecretParams groupSecretParams, String cdnKey, OutputStream outputStream
2208 ) throws IOException {
2209 var groupOperations = groupsV2Operations.forGroup(groupSecretParams);
2210
2211 var tmpFile = IOUtils.createTempFile();
2212 try (InputStream input = messageReceiver.retrieveGroupsV2ProfileAvatar(cdnKey,
2213 tmpFile,
2214 ServiceConfig.AVATAR_DOWNLOAD_FAILSAFE_MAX_SIZE)) {
2215 var encryptedData = IOUtils.readFully(input);
2216
2217 var decryptedData = groupOperations.decryptAvatar(encryptedData);
2218 outputStream.write(decryptedData);
2219 } finally {
2220 try {
2221 Files.delete(tmpFile.toPath());
2222 } catch (IOException e) {
2223 logger.warn("Failed to delete received group avatar temp file “{}”, ignoring: {}",
2224 tmpFile,
2225 e.getMessage());
2226 }
2227 }
2228 }
2229
2230 private void retrieveProfileAvatar(
2231 String avatarPath, ProfileKey profileKey, OutputStream outputStream
2232 ) throws IOException {
2233 var tmpFile = IOUtils.createTempFile();
2234 try (var input = messageReceiver.retrieveProfileAvatar(avatarPath,
2235 tmpFile,
2236 profileKey,
2237 ServiceConfig.AVATAR_DOWNLOAD_FAILSAFE_MAX_SIZE)) {
2238 // Use larger buffer size to prevent AssertionError: Need: 12272 but only have: 8192 ...
2239 IOUtils.copyStream(input, outputStream, (int) ServiceConfig.AVATAR_DOWNLOAD_FAILSAFE_MAX_SIZE);
2240 } finally {
2241 try {
2242 Files.delete(tmpFile.toPath());
2243 } catch (IOException e) {
2244 logger.warn("Failed to delete received profile avatar temp file “{}”, ignoring: {}",
2245 tmpFile,
2246 e.getMessage());
2247 }
2248 }
2249 }
2250
2251 private void retrieveAttachment(
2252 final SignalServiceAttachment attachment, final OutputStream outputStream
2253 ) throws IOException {
2254 if (attachment.isPointer()) {
2255 var pointer = attachment.asPointer();
2256 retrieveAttachmentPointer(pointer, outputStream);
2257 } else {
2258 var stream = attachment.asStream();
2259 IOUtils.copyStream(stream.getInputStream(), outputStream);
2260 }
2261 }
2262
2263 private void retrieveAttachmentPointer(
2264 SignalServiceAttachmentPointer pointer, OutputStream outputStream
2265 ) throws IOException {
2266 var tmpFile = IOUtils.createTempFile();
2267 try (var input = retrieveAttachmentAsStream(pointer, tmpFile)) {
2268 IOUtils.copyStream(input, outputStream);
2269 } catch (MissingConfigurationException | InvalidMessageException e) {
2270 throw new IOException(e);
2271 } finally {
2272 try {
2273 Files.delete(tmpFile.toPath());
2274 } catch (IOException e) {
2275 logger.warn("Failed to delete received attachment temp file “{}”, ignoring: {}",
2276 tmpFile,
2277 e.getMessage());
2278 }
2279 }
2280 }
2281
2282 private InputStream retrieveAttachmentAsStream(
2283 SignalServiceAttachmentPointer pointer, File tmpFile
2284 ) throws IOException, InvalidMessageException, MissingConfigurationException {
2285 return messageReceiver.retrieveAttachment(pointer, tmpFile, ServiceConfig.MAX_ATTACHMENT_SIZE);
2286 }
2287
2288 void sendGroups() throws IOException, UntrustedIdentityException {
2289 var groupsFile = IOUtils.createTempFile();
2290
2291 try {
2292 try (OutputStream fos = new FileOutputStream(groupsFile)) {
2293 var out = new DeviceGroupsOutputStream(fos);
2294 for (var record : getGroups()) {
2295 if (record instanceof GroupInfoV1) {
2296 var groupInfo = (GroupInfoV1) record;
2297 out.write(new DeviceGroup(groupInfo.getGroupId().serialize(),
2298 Optional.fromNullable(groupInfo.name),
2299 groupInfo.getMembers()
2300 .stream()
2301 .map(this::resolveSignalServiceAddress)
2302 .collect(Collectors.toList()),
2303 createGroupAvatarAttachment(groupInfo.getGroupId()),
2304 groupInfo.isMember(account.getSelfRecipientId()),
2305 Optional.of(groupInfo.messageExpirationTime),
2306 Optional.fromNullable(groupInfo.color),
2307 groupInfo.blocked,
2308 Optional.absent(),
2309 groupInfo.archived));
2310 }
2311 }
2312 }
2313
2314 if (groupsFile.exists() && groupsFile.length() > 0) {
2315 try (var groupsFileStream = new FileInputStream(groupsFile)) {
2316 var attachmentStream = SignalServiceAttachment.newStreamBuilder()
2317 .withStream(groupsFileStream)
2318 .withContentType("application/octet-stream")
2319 .withLength(groupsFile.length())
2320 .build();
2321
2322 sendSyncMessage(SignalServiceSyncMessage.forGroups(attachmentStream));
2323 }
2324 }
2325 } finally {
2326 try {
2327 Files.delete(groupsFile.toPath());
2328 } catch (IOException e) {
2329 logger.warn("Failed to delete groups temp file “{}”, ignoring: {}", groupsFile, e.getMessage());
2330 }
2331 }
2332 }
2333
2334 public void sendContacts() throws IOException, UntrustedIdentityException {
2335 var contactsFile = IOUtils.createTempFile();
2336
2337 try {
2338 try (OutputStream fos = new FileOutputStream(contactsFile)) {
2339 var out = new DeviceContactsOutputStream(fos);
2340 for (var contactPair : account.getContactStore().getContacts()) {
2341 final var recipientId = contactPair.first();
2342 final var contact = contactPair.second();
2343 final var address = resolveSignalServiceAddress(recipientId);
2344
2345 var currentIdentity = account.getIdentityKeyStore().getIdentity(recipientId);
2346 VerifiedMessage verifiedMessage = null;
2347 if (currentIdentity != null) {
2348 verifiedMessage = new VerifiedMessage(address,
2349 currentIdentity.getIdentityKey(),
2350 currentIdentity.getTrustLevel().toVerifiedState(),
2351 currentIdentity.getDateAdded().getTime());
2352 }
2353
2354 var profileKey = account.getProfileStore().getProfileKey(recipientId);
2355 out.write(new DeviceContact(address,
2356 Optional.fromNullable(contact.getName()),
2357 createContactAvatarAttachment(address),
2358 Optional.fromNullable(contact.getColor()),
2359 Optional.fromNullable(verifiedMessage),
2360 Optional.fromNullable(profileKey),
2361 contact.isBlocked(),
2362 Optional.of(contact.getMessageExpirationTime()),
2363 Optional.absent(),
2364 contact.isArchived()));
2365 }
2366
2367 if (account.getProfileKey() != null) {
2368 // Send our own profile key as well
2369 out.write(new DeviceContact(account.getSelfAddress(),
2370 Optional.absent(),
2371 Optional.absent(),
2372 Optional.absent(),
2373 Optional.absent(),
2374 Optional.of(account.getProfileKey()),
2375 false,
2376 Optional.absent(),
2377 Optional.absent(),
2378 false));
2379 }
2380 }
2381
2382 if (contactsFile.exists() && contactsFile.length() > 0) {
2383 try (var contactsFileStream = new FileInputStream(contactsFile)) {
2384 var attachmentStream = SignalServiceAttachment.newStreamBuilder()
2385 .withStream(contactsFileStream)
2386 .withContentType("application/octet-stream")
2387 .withLength(contactsFile.length())
2388 .build();
2389
2390 sendSyncMessage(SignalServiceSyncMessage.forContacts(new ContactsMessage(attachmentStream, true)));
2391 }
2392 }
2393 } finally {
2394 try {
2395 Files.delete(contactsFile.toPath());
2396 } catch (IOException e) {
2397 logger.warn("Failed to delete contacts temp file “{}”, ignoring: {}", contactsFile, e.getMessage());
2398 }
2399 }
2400 }
2401
2402 void sendBlockedList() throws IOException, UntrustedIdentityException {
2403 var addresses = new ArrayList<SignalServiceAddress>();
2404 for (var record : account.getContactStore().getContacts()) {
2405 if (record.second().isBlocked()) {
2406 addresses.add(resolveSignalServiceAddress(record.first()));
2407 }
2408 }
2409 var groupIds = new ArrayList<byte[]>();
2410 for (var record : getGroups()) {
2411 if (record.isBlocked()) {
2412 groupIds.add(record.getGroupId().serialize());
2413 }
2414 }
2415 sendSyncMessage(SignalServiceSyncMessage.forBlocked(new BlockedListMessage(addresses, groupIds)));
2416 }
2417
2418 private void sendVerifiedMessage(
2419 SignalServiceAddress destination, IdentityKey identityKey, TrustLevel trustLevel
2420 ) throws IOException, UntrustedIdentityException {
2421 var verifiedMessage = new VerifiedMessage(destination,
2422 identityKey,
2423 trustLevel.toVerifiedState(),
2424 System.currentTimeMillis());
2425 sendSyncMessage(SignalServiceSyncMessage.forVerified(verifiedMessage));
2426 }
2427
2428 public List<Pair<RecipientId, Contact>> getContacts() {
2429 return account.getContactStore().getContacts();
2430 }
2431
2432 public String getContactOrProfileName(String number) throws InvalidNumberException {
2433 final var recipientId = canonicalizeAndResolveRecipient(number);
2434 final var recipient = account.getRecipientStore().getRecipient(recipientId);
2435 if (recipient == null) {
2436 return null;
2437 }
2438
2439 if (recipient.getContact() != null && !Util.isEmpty(recipient.getContact().getName())) {
2440 return recipient.getContact().getName();
2441 }
2442
2443 if (recipient.getProfile() != null && recipient.getProfile() != null) {
2444 return recipient.getProfile().getDisplayName();
2445 }
2446
2447 return null;
2448 }
2449
2450 public GroupInfo getGroup(GroupId groupId) {
2451 final var group = account.getGroupStore().getGroup(groupId);
2452 if (group instanceof GroupInfoV2 && ((GroupInfoV2) group).getGroup() == null) {
2453 final var groupSecretParams = GroupSecretParams.deriveFromMasterKey(((GroupInfoV2) group).getMasterKey());
2454 ((GroupInfoV2) group).setGroup(groupHelper.getDecryptedGroup(groupSecretParams), this::resolveRecipient);
2455 account.getGroupStore().updateGroup(group);
2456 }
2457 return group;
2458 }
2459
2460 public List<IdentityInfo> getIdentities() {
2461 return account.getIdentityKeyStore().getIdentities();
2462 }
2463
2464 public List<IdentityInfo> getIdentities(String number) throws InvalidNumberException {
2465 final var identity = account.getIdentityKeyStore().getIdentity(canonicalizeAndResolveRecipient(number));
2466 return identity == null ? List.of() : List.of(identity);
2467 }
2468
2469 /**
2470 * Trust this the identity with this fingerprint
2471 *
2472 * @param name username of the identity
2473 * @param fingerprint Fingerprint
2474 */
2475 public boolean trustIdentityVerified(String name, byte[] fingerprint) throws InvalidNumberException {
2476 var recipientId = canonicalizeAndResolveRecipient(name);
2477 return trustIdentity(recipientId,
2478 identityKey -> Arrays.equals(identityKey.serialize(), fingerprint),
2479 TrustLevel.TRUSTED_VERIFIED);
2480 }
2481
2482 /**
2483 * Trust this the identity with this safety number
2484 *
2485 * @param name username of the identity
2486 * @param safetyNumber Safety number
2487 */
2488 public boolean trustIdentityVerifiedSafetyNumber(String name, String safetyNumber) throws InvalidNumberException {
2489 var recipientId = canonicalizeAndResolveRecipient(name);
2490 var address = account.getRecipientStore().resolveServiceAddress(recipientId);
2491 return trustIdentity(recipientId,
2492 identityKey -> safetyNumber.equals(computeSafetyNumber(address, identityKey)),
2493 TrustLevel.TRUSTED_VERIFIED);
2494 }
2495
2496 /**
2497 * Trust all keys of this identity without verification
2498 *
2499 * @param name username of the identity
2500 */
2501 public boolean trustIdentityAllKeys(String name) throws InvalidNumberException {
2502 var recipientId = canonicalizeAndResolveRecipient(name);
2503 return trustIdentity(recipientId, identityKey -> true, TrustLevel.TRUSTED_UNVERIFIED);
2504 }
2505
2506 private boolean trustIdentity(
2507 RecipientId recipientId, Function<IdentityKey, Boolean> verifier, TrustLevel trustLevel
2508 ) {
2509 var identity = account.getIdentityKeyStore().getIdentity(recipientId);
2510 if (identity == null) {
2511 return false;
2512 }
2513
2514 if (!verifier.apply(identity.getIdentityKey())) {
2515 return false;
2516 }
2517
2518 account.getIdentityKeyStore().setIdentityTrustLevel(recipientId, identity.getIdentityKey(), trustLevel);
2519 try {
2520 var address = account.getRecipientStore().resolveServiceAddress(recipientId);
2521 sendVerifiedMessage(address, identity.getIdentityKey(), trustLevel);
2522 } catch (IOException | UntrustedIdentityException e) {
2523 logger.warn("Failed to send verification sync message: {}", e.getMessage());
2524 }
2525
2526 return true;
2527 }
2528
2529 public String computeSafetyNumber(
2530 SignalServiceAddress theirAddress, IdentityKey theirIdentityKey
2531 ) {
2532 return Utils.computeSafetyNumber(ServiceConfig.capabilities.isUuid(),
2533 account.getSelfAddress(),
2534 getIdentityKeyPair().getPublicKey(),
2535 theirAddress,
2536 theirIdentityKey);
2537 }
2538
2539 @Deprecated
2540 public SignalServiceAddress canonicalizeAndResolveSignalServiceAddress(String identifier) throws InvalidNumberException {
2541 var canonicalizedNumber = UuidUtil.isUuid(identifier)
2542 ? identifier
2543 : PhoneNumberFormatter.formatNumber(identifier, account.getUsername());
2544 return resolveSignalServiceAddress(canonicalizedNumber);
2545 }
2546
2547 @Deprecated
2548 public SignalServiceAddress resolveSignalServiceAddress(String identifier) {
2549 var address = Utils.getSignalServiceAddressFromIdentifier(identifier);
2550
2551 return resolveSignalServiceAddress(address);
2552 }
2553
2554 @Deprecated
2555 public SignalServiceAddress resolveSignalServiceAddress(SignalServiceAddress address) {
2556 if (address.matches(account.getSelfAddress())) {
2557 return account.getSelfAddress();
2558 }
2559
2560 return account.getRecipientStore().resolveServiceAddress(address);
2561 }
2562
2563 public SignalServiceAddress resolveSignalServiceAddress(RecipientId recipientId) {
2564 return account.getRecipientStore().resolveServiceAddress(recipientId);
2565 }
2566
2567 public RecipientId canonicalizeAndResolveRecipient(String identifier) throws InvalidNumberException {
2568 var canonicalizedNumber = UuidUtil.isUuid(identifier)
2569 ? identifier
2570 : PhoneNumberFormatter.formatNumber(identifier, account.getUsername());
2571
2572 return resolveRecipient(canonicalizedNumber);
2573 }
2574
2575 private RecipientId resolveRecipient(final String identifier) {
2576 var address = Utils.getSignalServiceAddressFromIdentifier(identifier);
2577
2578 return resolveRecipient(address);
2579 }
2580
2581 public RecipientId resolveRecipient(SignalServiceAddress address) {
2582 return account.getRecipientStore().resolveRecipient(address);
2583 }
2584
2585 private RecipientId resolveRecipientTrusted(SignalServiceAddress address) {
2586 return account.getRecipientStore().resolveRecipientTrusted(address);
2587 }
2588
2589 @Override
2590 public void close() throws IOException {
2591 close(true);
2592 }
2593
2594 void close(boolean closeAccount) throws IOException {
2595 executor.shutdown();
2596
2597 if (messagePipe != null) {
2598 messagePipe.shutdown();
2599 messagePipe = null;
2600 }
2601
2602 if (unidentifiedMessagePipe != null) {
2603 unidentifiedMessagePipe.shutdown();
2604 unidentifiedMessagePipe = null;
2605 }
2606
2607 if (closeAccount && account != null) {
2608 account.close();
2609 }
2610 account = null;
2611 }
2612
2613 public interface ReceiveMessageHandler {
2614
2615 void handleMessage(SignalServiceEnvelope envelope, SignalServiceContent decryptedContent, Throwable e);
2616 }
2617 }