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