2 Copyright (C) 2015-2021 AsamK and contributors
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.
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.
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/>.
17 package org
.asamk
.signal
.manager
;
19 import org
.asamk
.signal
.manager
.api
.Device
;
20 import org
.asamk
.signal
.manager
.api
.TypingAction
;
21 import org
.asamk
.signal
.manager
.config
.ServiceConfig
;
22 import org
.asamk
.signal
.manager
.config
.ServiceEnvironment
;
23 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
24 import org
.asamk
.signal
.manager
.groups
.GroupId
;
25 import org
.asamk
.signal
.manager
.groups
.GroupIdV1
;
26 import org
.asamk
.signal
.manager
.groups
.GroupInviteLinkUrl
;
27 import org
.asamk
.signal
.manager
.groups
.GroupLinkState
;
28 import org
.asamk
.signal
.manager
.groups
.GroupNotFoundException
;
29 import org
.asamk
.signal
.manager
.groups
.GroupPermission
;
30 import org
.asamk
.signal
.manager
.groups
.GroupUtils
;
31 import org
.asamk
.signal
.manager
.groups
.LastGroupAdminException
;
32 import org
.asamk
.signal
.manager
.groups
.NotAGroupMemberException
;
33 import org
.asamk
.signal
.manager
.helper
.GroupV2Helper
;
34 import org
.asamk
.signal
.manager
.helper
.PinHelper
;
35 import org
.asamk
.signal
.manager
.helper
.ProfileHelper
;
36 import org
.asamk
.signal
.manager
.helper
.SendHelper
;
37 import org
.asamk
.signal
.manager
.helper
.UnidentifiedAccessHelper
;
38 import org
.asamk
.signal
.manager
.jobs
.Context
;
39 import org
.asamk
.signal
.manager
.jobs
.Job
;
40 import org
.asamk
.signal
.manager
.jobs
.RetrieveStickerPackJob
;
41 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
42 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
43 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfoV1
;
44 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfoV2
;
45 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
46 import org
.asamk
.signal
.manager
.storage
.messageCache
.CachedMessage
;
47 import org
.asamk
.signal
.manager
.storage
.recipients
.Contact
;
48 import org
.asamk
.signal
.manager
.storage
.recipients
.Profile
;
49 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
50 import org
.asamk
.signal
.manager
.storage
.stickers
.Sticker
;
51 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPackId
;
52 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
53 import org
.asamk
.signal
.manager
.util
.IOUtils
;
54 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
55 import org
.asamk
.signal
.manager
.util
.ProfileUtils
;
56 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
57 import org
.asamk
.signal
.manager
.util
.Utils
;
58 import org
.signal
.libsignal
.metadata
.InvalidMetadataMessageException
;
59 import org
.signal
.libsignal
.metadata
.InvalidMetadataVersionException
;
60 import org
.signal
.libsignal
.metadata
.ProtocolDuplicateMessageException
;
61 import org
.signal
.libsignal
.metadata
.ProtocolInvalidKeyException
;
62 import org
.signal
.libsignal
.metadata
.ProtocolInvalidKeyIdException
;
63 import org
.signal
.libsignal
.metadata
.ProtocolInvalidMessageException
;
64 import org
.signal
.libsignal
.metadata
.ProtocolInvalidVersionException
;
65 import org
.signal
.libsignal
.metadata
.ProtocolLegacyMessageException
;
66 import org
.signal
.libsignal
.metadata
.ProtocolNoSessionException
;
67 import org
.signal
.libsignal
.metadata
.ProtocolUntrustedIdentityException
;
68 import org
.signal
.libsignal
.metadata
.SelfSendException
;
69 import org
.signal
.storageservice
.protos
.groups
.GroupChange
;
70 import org
.signal
.storageservice
.protos
.groups
.local
.DecryptedGroup
;
71 import org
.signal
.zkgroup
.InvalidInputException
;
72 import org
.signal
.zkgroup
.VerificationFailedException
;
73 import org
.signal
.zkgroup
.groups
.GroupMasterKey
;
74 import org
.signal
.zkgroup
.groups
.GroupSecretParams
;
75 import org
.signal
.zkgroup
.profiles
.ProfileKey
;
76 import org
.signal
.zkgroup
.profiles
.ProfileKeyCredential
;
77 import org
.slf4j
.Logger
;
78 import org
.slf4j
.LoggerFactory
;
79 import org
.whispersystems
.libsignal
.IdentityKey
;
80 import org
.whispersystems
.libsignal
.IdentityKeyPair
;
81 import org
.whispersystems
.libsignal
.InvalidKeyException
;
82 import org
.whispersystems
.libsignal
.InvalidMessageException
;
83 import org
.whispersystems
.libsignal
.ecc
.ECPublicKey
;
84 import org
.whispersystems
.libsignal
.fingerprint
.Fingerprint
;
85 import org
.whispersystems
.libsignal
.fingerprint
.FingerprintParsingException
;
86 import org
.whispersystems
.libsignal
.fingerprint
.FingerprintVersionMismatchException
;
87 import org
.whispersystems
.libsignal
.state
.PreKeyRecord
;
88 import org
.whispersystems
.libsignal
.state
.SignedPreKeyRecord
;
89 import org
.whispersystems
.libsignal
.util
.Pair
;
90 import org
.whispersystems
.libsignal
.util
.guava
.Optional
;
91 import org
.whispersystems
.signalservice
.api
.InvalidMessageStructureException
;
92 import org
.whispersystems
.signalservice
.api
.SignalSessionLock
;
93 import org
.whispersystems
.signalservice
.api
.crypto
.UntrustedIdentityException
;
94 import org
.whispersystems
.signalservice
.api
.groupsv2
.GroupLinkNotActiveException
;
95 import org
.whispersystems
.signalservice
.api
.groupsv2
.GroupsV2AuthorizationString
;
96 import org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachment
;
98 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachmentPointer
;
99 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachmentRemoteId
;
100 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachmentStream
;
101 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceContent
;
102 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
103 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceEnvelope
;
104 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceGroup
;
105 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceGroupV2
;
106 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
107 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceTypingMessage
;
108 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.BlockedListMessage
;
109 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.ContactsMessage
;
110 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceContact
;
111 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceContactsInputStream
;
112 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceContactsOutputStream
;
113 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceGroup
;
114 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceGroupsInputStream
;
115 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceGroupsOutputStream
;
116 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.RequestMessage
;
117 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.SignalServiceSyncMessage
;
118 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.StickerPackOperationMessage
;
119 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.VerifiedMessage
;
120 import org
.whispersystems
.signalservice
.api
.profiles
.ProfileAndCredential
;
121 import org
.whispersystems
.signalservice
.api
.profiles
.SignalServiceProfile
;
122 import org
.whispersystems
.signalservice
.api
.push
.SignalServiceAddress
;
123 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.ConflictException
;
124 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.MissingConfigurationException
;
125 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
126 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
127 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
128 import org
.whispersystems
.signalservice
.api
.util
.UuidUtil
;
129 import org
.whispersystems
.signalservice
.api
.websocket
.WebSocketUnavailableException
;
130 import org
.whispersystems
.signalservice
.internal
.contacts
.crypto
.Quote
;
131 import org
.whispersystems
.signalservice
.internal
.contacts
.crypto
.UnauthenticatedQuoteException
;
132 import org
.whispersystems
.signalservice
.internal
.contacts
.crypto
.UnauthenticatedResponseException
;
133 import org
.whispersystems
.signalservice
.internal
.push
.SignalServiceProtos
;
134 import org
.whispersystems
.signalservice
.internal
.push
.UnsupportedDataMessageException
;
135 import org
.whispersystems
.signalservice
.internal
.util
.DynamicCredentialsProvider
;
136 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
137 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
139 import java
.io
.Closeable
;
141 import java
.io
.FileInputStream
;
142 import java
.io
.FileOutputStream
;
143 import java
.io
.IOException
;
144 import java
.io
.InputStream
;
145 import java
.io
.OutputStream
;
147 import java
.net
.URISyntaxException
;
148 import java
.net
.URLEncoder
;
149 import java
.nio
.charset
.StandardCharsets
;
150 import java
.nio
.file
.Files
;
151 import java
.security
.SignatureException
;
152 import java
.util
.ArrayList
;
153 import java
.util
.Arrays
;
154 import java
.util
.Base64
;
155 import java
.util
.Collection
;
156 import java
.util
.Date
;
157 import java
.util
.HashSet
;
158 import java
.util
.List
;
159 import java
.util
.Map
;
160 import java
.util
.Set
;
161 import java
.util
.UUID
;
162 import java
.util
.concurrent
.ExecutorService
;
163 import java
.util
.concurrent
.Executors
;
164 import java
.util
.concurrent
.TimeUnit
;
165 import java
.util
.concurrent
.TimeoutException
;
166 import java
.util
.concurrent
.locks
.ReentrantLock
;
167 import java
.util
.function
.Function
;
168 import java
.util
.stream
.Collectors
;
170 import static org
.asamk
.signal
.manager
.config
.ServiceConfig
.capabilities
;
172 public class Manager
implements Closeable
{
174 private final static Logger logger
= LoggerFactory
.getLogger(Manager
.class);
176 private final ServiceEnvironmentConfig serviceEnvironmentConfig
;
177 private final SignalDependencies dependencies
;
179 private SignalAccount account
;
181 private final ExecutorService executor
= Executors
.newCachedThreadPool();
183 private final ProfileHelper profileHelper
;
184 private final GroupV2Helper groupV2Helper
;
185 private final PinHelper pinHelper
;
186 private final SendHelper sendHelper
;
188 private final AvatarStore avatarStore
;
189 private final AttachmentStore attachmentStore
;
190 private final StickerPackStore stickerPackStore
;
191 private final SignalSessionLock sessionLock
= new SignalSessionLock() {
192 private final ReentrantLock LEGACY_LOCK
= new ReentrantLock();
195 public Lock
acquire() {
197 return LEGACY_LOCK
::unlock
;
202 SignalAccount account
,
203 PathConfig pathConfig
,
204 ServiceEnvironmentConfig serviceEnvironmentConfig
,
207 this.account
= account
;
208 this.serviceEnvironmentConfig
= serviceEnvironmentConfig
;
210 final var credentialsProvider
= new DynamicCredentialsProvider(account
.getUuid(),
211 account
.getUsername(),
212 account
.getPassword(),
213 account
.getDeviceId());
214 this.dependencies
= new SignalDependencies(account
.getSelfAddress(),
215 serviceEnvironmentConfig
,
218 account
.getSignalProtocolStore(),
221 this.pinHelper
= new PinHelper(dependencies
.getKeyBackupService());
223 final var unidentifiedAccessHelper
= new UnidentifiedAccessHelper(account
::getProfileKey
,
224 account
.getProfileStore()::getProfileKey
,
225 this::getRecipientProfile
,
226 this::getSenderCertificate
);
227 this.profileHelper
= new ProfileHelper(account
.getProfileStore()::getProfileKey
,
228 unidentifiedAccessHelper
::getAccessFor
,
229 dependencies
::getProfileService
,
230 dependencies
::getMessageReceiver
,
231 this::resolveSignalServiceAddress
);
232 this.groupV2Helper
= new GroupV2Helper(this::getRecipientProfileKeyCredential
,
233 this::getRecipientProfile
,
234 account
::getSelfRecipientId
,
235 dependencies
.getGroupsV2Operations(),
236 dependencies
.getGroupsV2Api(),
237 this::getGroupAuthForToday
,
238 this::resolveSignalServiceAddress
);
239 this.avatarStore
= new AvatarStore(pathConfig
.getAvatarsPath());
240 this.attachmentStore
= new AttachmentStore(pathConfig
.getAttachmentsPath());
241 this.stickerPackStore
= new StickerPackStore(pathConfig
.getStickerPacksPath());
242 this.sendHelper
= new SendHelper(account
,
244 unidentifiedAccessHelper
,
245 this::resolveSignalServiceAddress
,
246 this::resolveRecipient
,
247 this::handleIdentityFailure
,
249 this::refreshRegisteredUser
);
252 public String
getUsername() {
253 return account
.getUsername();
256 public SignalServiceAddress
getSelfAddress() {
257 return account
.getSelfAddress();
260 public RecipientId
getSelfRecipientId() {
261 return account
.getSelfRecipientId();
264 private IdentityKeyPair
getIdentityKeyPair() {
265 return account
.getIdentityKeyPair();
268 public int getDeviceId() {
269 return account
.getDeviceId();
272 public static Manager
init(
273 String username
, File settingsPath
, ServiceEnvironment serviceEnvironment
, String userAgent
274 ) throws IOException
, NotRegisteredException
{
275 var pathConfig
= PathConfig
.createDefault(settingsPath
);
277 if (!SignalAccount
.userExists(pathConfig
.getDataPath(), username
)) {
278 throw new NotRegisteredException();
281 var account
= SignalAccount
.load(pathConfig
.getDataPath(), username
, true);
283 if (!account
.isRegistered()) {
284 throw new NotRegisteredException();
287 final var serviceEnvironmentConfig
= ServiceConfig
.getServiceEnvironmentConfig(serviceEnvironment
, userAgent
);
289 return new Manager(account
, pathConfig
, serviceEnvironmentConfig
, userAgent
);
292 public static List
<String
> getAllLocalUsernames(File settingsPath
) {
293 var pathConfig
= PathConfig
.createDefault(settingsPath
);
294 final var dataPath
= pathConfig
.getDataPath();
295 final var files
= dataPath
.listFiles();
301 return Arrays
.stream(files
)
302 .filter(File
::isFile
)
304 .filter(file
-> PhoneNumberFormatter
.isValidNumber(file
, null))
305 .collect(Collectors
.toList());
308 public void checkAccountState() throws IOException
{
309 if (account
.getLastReceiveTimestamp() == 0) {
310 logger
.warn("The Signal protocol expects that incoming messages are regularly received.");
312 var diffInMilliseconds
= System
.currentTimeMillis() - account
.getLastReceiveTimestamp();
313 long days
= TimeUnit
.DAYS
.convert(diffInMilliseconds
, TimeUnit
.MILLISECONDS
);
316 "Messages have been last received {} days ago. The Signal protocol expects that incoming messages are regularly received.",
320 if (dependencies
.getAccountManager().getPreKeysCount() < ServiceConfig
.PREKEY_MINIMUM_COUNT
) {
323 if (account
.getUuid() == null) {
324 account
.setUuid(dependencies
.getAccountManager().getOwnUuid());
326 updateAccountAttributes();
330 * This is used for checking a set of phone numbers for registration on Signal
332 * @param numbers The set of phone number in question
333 * @return A map of numbers to canonicalized number and uuid. If a number is not registered the uuid is null.
334 * @throws IOException if its unable to get the contacts to check if they're registered
336 public Map
<String
, Pair
<String
, UUID
>> areUsersRegistered(Set
<String
> numbers
) throws IOException
{
337 Map
<String
, String
> canonicalizedNumbers
= numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
339 return canonicalizePhoneNumber(n
);
340 } catch (InvalidNumberException e
) {
345 // Note "contactDetails" has no optionals. It only gives us info on users who are registered
346 var contactDetails
= getRegisteredUsers(canonicalizedNumbers
.values()
348 .filter(s
-> !s
.isEmpty())
349 .collect(Collectors
.toSet()));
351 // Store numbers as recipients so we have the number/uuid association
352 contactDetails
.forEach((number
, uuid
) -> resolveRecipientTrusted(new SignalServiceAddress(uuid
, number
)));
354 return numbers
.stream().collect(Collectors
.toMap(n
-> n
, n
-> {
355 final var number
= canonicalizedNumbers
.get(n
);
356 final var uuid
= contactDetails
.get(number
);
357 return new Pair
<>(number
.isEmpty() ?
null : number
, uuid
);
361 public void updateAccountAttributes() throws IOException
{
362 dependencies
.getAccountManager()
363 .setAccountAttributes(account
.getEncryptedDeviceName(),
365 account
.getLocalRegistrationId(),
367 // set legacy pin only if no KBS master key is set
368 account
.getPinMasterKey() == null ? account
.getRegistrationLockPin() : null,
369 account
.getPinMasterKey() == null ?
null : account
.getPinMasterKey().deriveRegistrationLock(),
370 account
.getSelfUnidentifiedAccessKey(),
371 account
.isUnrestrictedUnidentifiedAccess(),
373 account
.isDiscoverableByPhoneNumber());
377 * @param givenName if null, the previous givenName will be kept
378 * @param familyName if null, the previous familyName will be kept
379 * @param about if null, the previous about text will be kept
380 * @param aboutEmoji if null, the previous about emoji will be kept
381 * @param avatar if avatar is null the image from the local avatar store is used (if present),
383 public void setProfile(
384 String givenName
, final String familyName
, String about
, String aboutEmoji
, Optional
<File
> avatar
385 ) throws IOException
{
386 var profile
= getRecipientProfile(account
.getSelfRecipientId());
387 var builder
= profile
== null ? Profile
.newBuilder() : Profile
.newBuilder(profile
);
388 if (givenName
!= null) {
389 builder
.withGivenName(givenName
);
391 if (familyName
!= null) {
392 builder
.withFamilyName(familyName
);
395 builder
.withAbout(about
);
397 if (aboutEmoji
!= null) {
398 builder
.withAboutEmoji(aboutEmoji
);
400 var newProfile
= builder
.build();
402 try (final var streamDetails
= avatar
== null
403 ? avatarStore
.retrieveProfileAvatar(getSelfAddress())
404 : avatar
.isPresent() ? Utils
.createStreamDetailsFromFile(avatar
.get()) : null) {
405 dependencies
.getAccountManager()
406 .setVersionedProfile(account
.getUuid(),
407 account
.getProfileKey(),
408 newProfile
.getInternalServiceName(),
409 newProfile
.getAbout() == null ?
"" : newProfile
.getAbout(),
410 newProfile
.getAboutEmoji() == null ?
"" : newProfile
.getAboutEmoji(),
415 if (avatar
!= null) {
416 if (avatar
.isPresent()) {
417 avatarStore
.storeProfileAvatar(getSelfAddress(),
418 outputStream
-> IOUtils
.copyFileToStream(avatar
.get(), outputStream
));
420 avatarStore
.deleteProfileAvatar(getSelfAddress());
423 account
.getProfileStore().storeProfile(account
.getSelfRecipientId(), newProfile
);
425 sendHelper
.sendSyncMessage(SignalServiceSyncMessage
.forFetchLatest(SignalServiceSyncMessage
.FetchType
.LOCAL_PROFILE
));
428 public void unregister() throws IOException
{
429 // When setting an empty GCM id, the Signal-Server also sets the fetchesMessages property to false.
430 // If this is the master device, other users can't send messages to this number anymore.
431 // If this is a linked device, other users can still send messages, but this device doesn't receive them anymore.
432 dependencies
.getAccountManager().setGcmId(Optional
.absent());
434 account
.setRegistered(false);
437 public void deleteAccount() throws IOException
{
438 dependencies
.getAccountManager().deleteAccount();
440 account
.setRegistered(false);
443 public List
<Device
> getLinkedDevices() throws IOException
{
444 var devices
= dependencies
.getAccountManager().getDevices();
445 account
.setMultiDevice(devices
.size() > 1);
446 var identityKey
= account
.getIdentityKeyPair().getPrivateKey();
447 return devices
.stream().map(d
-> {
448 String deviceName
= d
.getName();
449 if (deviceName
!= null) {
451 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
452 } catch (IOException e
) {
453 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
456 return new Device(d
.getId(), deviceName
, d
.getCreated(), d
.getLastSeen());
457 }).collect(Collectors
.toList());
460 public void removeLinkedDevices(int deviceId
) throws IOException
{
461 dependencies
.getAccountManager().removeDevice(deviceId
);
462 var devices
= dependencies
.getAccountManager().getDevices();
463 account
.setMultiDevice(devices
.size() > 1);
466 public void addDeviceLink(URI linkUri
) throws IOException
, InvalidKeyException
{
467 var info
= DeviceLinkInfo
.parseDeviceLinkUri(linkUri
);
469 addDevice(info
.deviceIdentifier
, info
.deviceKey
);
472 private void addDevice(String deviceIdentifier
, ECPublicKey deviceKey
) throws IOException
, InvalidKeyException
{
473 var identityKeyPair
= getIdentityKeyPair();
474 var verificationCode
= dependencies
.getAccountManager().getNewDeviceVerificationCode();
476 dependencies
.getAccountManager()
477 .addDevice(deviceIdentifier
,
480 Optional
.of(account
.getProfileKey().serialize()),
482 account
.setMultiDevice(true);
485 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, UnauthenticatedResponseException
{
486 if (!account
.isMasterDevice()) {
487 throw new RuntimeException("Only master device can set a PIN");
489 if (pin
.isPresent()) {
490 final var masterKey
= account
.getPinMasterKey() != null
491 ? account
.getPinMasterKey()
492 : KeyUtils
.createMasterKey();
494 pinHelper
.setRegistrationLockPin(pin
.get(), masterKey
);
496 account
.setRegistrationLockPin(pin
.get(), masterKey
);
499 pinHelper
.removeRegistrationLockPin();
501 account
.setRegistrationLockPin(null, null);
505 void refreshPreKeys() throws IOException
{
506 var oneTimePreKeys
= generatePreKeys();
507 final var identityKeyPair
= getIdentityKeyPair();
508 var signedPreKeyRecord
= generateSignedPreKey(identityKeyPair
);
510 dependencies
.getAccountManager().setPreKeys(identityKeyPair
.getPublicKey(), signedPreKeyRecord
, oneTimePreKeys
);
513 private List
<PreKeyRecord
> generatePreKeys() {
514 final var offset
= account
.getPreKeyIdOffset();
516 var records
= KeyUtils
.generatePreKeyRecords(offset
, ServiceConfig
.PREKEY_BATCH_SIZE
);
517 account
.addPreKeys(records
);
522 private SignedPreKeyRecord
generateSignedPreKey(IdentityKeyPair identityKeyPair
) {
523 final var signedPreKeyId
= account
.getNextSignedPreKeyId();
525 var record = KeyUtils
.generateSignedPreKeyRecord(identityKeyPair
, signedPreKeyId
);
526 account
.addSignedPreKey(record);
531 public Profile
getRecipientProfile(
532 RecipientId recipientId
534 return getRecipientProfile(recipientId
, false);
537 private final Set
<RecipientId
> pendingProfileRequest
= new HashSet
<>();
539 Profile
getRecipientProfile(
540 RecipientId recipientId
, boolean force
542 var profile
= account
.getProfileStore().getProfile(recipientId
);
544 var now
= System
.currentTimeMillis();
545 // Profiles are cached for 24h before retrieving them again, unless forced
546 if (!force
&& profile
!= null && now
- profile
.getLastUpdateTimestamp() < 24 * 60 * 60 * 1000) {
550 synchronized (pendingProfileRequest
) {
551 if (pendingProfileRequest
.contains(recipientId
)) {
554 pendingProfileRequest
.add(recipientId
);
556 final SignalServiceProfile encryptedProfile
;
558 encryptedProfile
= retrieveEncryptedProfile(recipientId
);
560 synchronized (pendingProfileRequest
) {
561 pendingProfileRequest
.remove(recipientId
);
564 if (encryptedProfile
== null) {
568 profile
= decryptProfileIfKeyKnown(recipientId
, encryptedProfile
);
569 account
.getProfileStore().storeProfile(recipientId
, profile
);
574 private Profile
decryptProfileIfKeyKnown(
575 final RecipientId recipientId
, final SignalServiceProfile encryptedProfile
577 var profileKey
= account
.getProfileStore().getProfileKey(recipientId
);
578 if (profileKey
== null) {
579 return new Profile(System
.currentTimeMillis(),
584 ProfileUtils
.getUnidentifiedAccessMode(encryptedProfile
, null),
585 ProfileUtils
.getCapabilities(encryptedProfile
));
588 return decryptProfileAndDownloadAvatar(recipientId
, profileKey
, encryptedProfile
);
591 private SignalServiceProfile
retrieveEncryptedProfile(RecipientId recipientId
) {
593 return retrieveProfileAndCredential(recipientId
, SignalServiceProfile
.RequestType
.PROFILE
).getProfile();
594 } catch (IOException e
) {
595 logger
.warn("Failed to retrieve profile, ignoring: {}", e
.getMessage());
600 private ProfileAndCredential
retrieveProfileAndCredential(
601 final RecipientId recipientId
, final SignalServiceProfile
.RequestType requestType
602 ) throws IOException
{
603 final var profileAndCredential
= profileHelper
.retrieveProfileSync(recipientId
, requestType
);
604 final var profile
= profileAndCredential
.getProfile();
607 var newIdentity
= account
.getIdentityKeyStore()
608 .saveIdentity(recipientId
,
609 new IdentityKey(Base64
.getDecoder().decode(profile
.getIdentityKey())),
613 account
.getSessionStore().archiveSessions(recipientId
);
615 } catch (InvalidKeyException ignored
) {
616 logger
.warn("Got invalid identity key in profile for {}",
617 resolveSignalServiceAddress(recipientId
).getIdentifier());
619 return profileAndCredential
;
622 private ProfileKeyCredential
getRecipientProfileKeyCredential(RecipientId recipientId
) {
623 var profileKeyCredential
= account
.getProfileStore().getProfileKeyCredential(recipientId
);
624 if (profileKeyCredential
!= null) {
625 return profileKeyCredential
;
628 ProfileAndCredential profileAndCredential
;
630 profileAndCredential
= retrieveProfileAndCredential(recipientId
,
631 SignalServiceProfile
.RequestType
.PROFILE_AND_CREDENTIAL
);
632 } catch (IOException e
) {
633 logger
.warn("Failed to retrieve profile key credential, ignoring: {}", e
.getMessage());
637 profileKeyCredential
= profileAndCredential
.getProfileKeyCredential().orNull();
638 account
.getProfileStore().storeProfileKeyCredential(recipientId
, profileKeyCredential
);
640 var profileKey
= account
.getProfileStore().getProfileKey(recipientId
);
641 if (profileKey
!= null) {
642 final var profile
= decryptProfileAndDownloadAvatar(recipientId
,
644 profileAndCredential
.getProfile());
645 account
.getProfileStore().storeProfile(recipientId
, profile
);
648 return profileKeyCredential
;
651 private Profile
decryptProfileAndDownloadAvatar(
652 final RecipientId recipientId
, final ProfileKey profileKey
, final SignalServiceProfile encryptedProfile
654 if (encryptedProfile
.getAvatar() != null) {
655 downloadProfileAvatar(resolveSignalServiceAddress(recipientId
), encryptedProfile
.getAvatar(), profileKey
);
658 return ProfileUtils
.decryptProfile(profileKey
, encryptedProfile
);
661 private Optional
<SignalServiceAttachmentStream
> createGroupAvatarAttachment(GroupId groupId
) throws IOException
{
662 final var streamDetails
= avatarStore
.retrieveGroupAvatar(groupId
);
663 if (streamDetails
== null) {
664 return Optional
.absent();
667 return Optional
.of(AttachmentUtils
.createAttachment(streamDetails
, Optional
.absent()));
670 private Optional
<SignalServiceAttachmentStream
> createContactAvatarAttachment(SignalServiceAddress address
) throws IOException
{
671 final var streamDetails
= avatarStore
.retrieveContactAvatar(address
);
672 if (streamDetails
== null) {
673 return Optional
.absent();
676 return Optional
.of(AttachmentUtils
.createAttachment(streamDetails
, Optional
.absent()));
679 private GroupInfo
getGroupForUpdating(GroupId groupId
) throws GroupNotFoundException
, NotAGroupMemberException
{
680 var g
= getGroup(groupId
);
682 throw new GroupNotFoundException(groupId
);
684 if (!g
.isMember(account
.getSelfRecipientId()) && !g
.isPendingMember(account
.getSelfRecipientId())) {
685 throw new NotAGroupMemberException(groupId
, g
.getTitle());
690 public List
<GroupInfo
> getGroups() {
691 return account
.getGroupStore().getGroups();
694 public Pair
<Long
, List
<SendMessageResult
>> sendGroupMessage(
695 String messageText
, List
<String
> attachments
, GroupId groupId
696 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
{
697 final var messageBuilder
= createMessageBuilder().withBody(messageText
);
698 if (attachments
!= null) {
699 messageBuilder
.withAttachments(AttachmentUtils
.getSignalServiceAttachments(attachments
));
702 return sendHelper
.sendAsGroupMessage(messageBuilder
, groupId
);
705 public Pair
<Long
, List
<SendMessageResult
>> sendGroupMessageReaction(
706 String emoji
, boolean remove
, String targetAuthor
, long targetSentTimestamp
, GroupId groupId
707 ) throws IOException
, InvalidNumberException
, NotAGroupMemberException
, GroupNotFoundException
{
708 var targetAuthorRecipientId
= canonicalizeAndResolveRecipient(targetAuthor
);
709 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
,
711 resolveSignalServiceAddress(targetAuthorRecipientId
),
712 targetSentTimestamp
);
713 final var messageBuilder
= createMessageBuilder().withReaction(reaction
);
715 return sendHelper
.sendAsGroupMessage(messageBuilder
, groupId
);
718 public Pair
<Long
, List
<SendMessageResult
>> sendQuitGroupMessage(
719 GroupId groupId
, Set
<String
> groupAdmins
720 ) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
, InvalidNumberException
, LastGroupAdminException
{
721 var group
= getGroupForUpdating(groupId
);
722 if (group
instanceof GroupInfoV1
) {
723 return quitGroupV1((GroupInfoV1
) group
);
726 final var newAdmins
= getRecipientIds(groupAdmins
);
728 return quitGroupV2((GroupInfoV2
) group
, newAdmins
);
729 } catch (ConflictException e
) {
730 // Detected conflicting update, refreshing group and trying again
731 group
= getGroup(groupId
, true);
732 return quitGroupV2((GroupInfoV2
) group
, newAdmins
);
736 private Pair
<Long
, List
<SendMessageResult
>> quitGroupV1(final GroupInfoV1 groupInfoV1
) throws IOException
{
737 var group
= SignalServiceGroup
.newBuilder(SignalServiceGroup
.Type
.QUIT
)
738 .withId(groupInfoV1
.getGroupId().serialize())
741 var messageBuilder
= createMessageBuilder().asGroupMessage(group
);
742 groupInfoV1
.removeMember(account
.getSelfRecipientId());
743 account
.getGroupStore().updateGroup(groupInfoV1
);
744 return sendHelper
.sendGroupMessage(messageBuilder
.build(),
745 groupInfoV1
.getMembersIncludingPendingWithout(account
.getSelfRecipientId()));
748 private Pair
<Long
, List
<SendMessageResult
>> quitGroupV2(
749 final GroupInfoV2 groupInfoV2
, final Set
<RecipientId
> newAdmins
750 ) throws LastGroupAdminException
, IOException
{
751 final var currentAdmins
= groupInfoV2
.getAdminMembers();
752 newAdmins
.removeAll(currentAdmins
);
753 newAdmins
.retainAll(groupInfoV2
.getMembers());
754 if (currentAdmins
.contains(getSelfRecipientId())
755 && currentAdmins
.size() == 1
756 && groupInfoV2
.getMembers().size() > 1
757 && newAdmins
.size() == 0) {
758 // Last admin can't leave the group, unless she's also the last member
759 throw new LastGroupAdminException(groupInfoV2
.getGroupId(), groupInfoV2
.getTitle());
761 final var groupGroupChangePair
= groupV2Helper
.leaveGroup(groupInfoV2
, newAdmins
);
762 groupInfoV2
.setGroup(groupGroupChangePair
.first(), this::resolveRecipient
);
763 var messageBuilder
= getGroupUpdateMessageBuilder(groupInfoV2
, groupGroupChangePair
.second().toByteArray());
764 account
.getGroupStore().updateGroup(groupInfoV2
);
765 return sendHelper
.sendGroupMessage(messageBuilder
.build(),
766 groupInfoV2
.getMembersIncludingPendingWithout(account
.getSelfRecipientId()));
769 public void deleteGroup(GroupId groupId
) throws IOException
{
770 account
.getGroupStore().deleteGroup(groupId
);
771 avatarStore
.deleteGroupAvatar(groupId
);
774 public Pair
<GroupId
, List
<SendMessageResult
>> createGroup(
775 String name
, List
<String
> members
, File avatarFile
776 ) throws IOException
, AttachmentInvalidException
, InvalidNumberException
{
777 return createGroup(name
, members
== null ?
null : getRecipientIds(members
), avatarFile
);
780 private Pair
<GroupId
, List
<SendMessageResult
>> createGroup(
781 String name
, Set
<RecipientId
> members
, File avatarFile
782 ) throws IOException
, AttachmentInvalidException
{
783 final var selfRecipientId
= account
.getSelfRecipientId();
784 if (members
!= null && members
.contains(selfRecipientId
)) {
785 members
= new HashSet
<>(members
);
786 members
.remove(selfRecipientId
);
789 var gv2Pair
= groupV2Helper
.createGroup(name
== null ?
"" : name
,
790 members
== null ? Set
.of() : members
,
793 SignalServiceDataMessage
.Builder messageBuilder
;
794 if (gv2Pair
== null) {
795 // Failed to create v2 group, creating v1 group instead
796 var gv1
= new GroupInfoV1(GroupIdV1
.createRandom());
797 gv1
.addMembers(List
.of(selfRecipientId
));
798 final var result
= updateGroupV1(gv1
, name
, members
, avatarFile
);
799 return new Pair
<>(gv1
.getGroupId(), result
.second());
802 final var gv2
= gv2Pair
.first();
803 final var decryptedGroup
= gv2Pair
.second();
805 gv2
.setGroup(decryptedGroup
, this::resolveRecipient
);
806 if (avatarFile
!= null) {
807 avatarStore
.storeGroupAvatar(gv2
.getGroupId(),
808 outputStream
-> IOUtils
.copyFileToStream(avatarFile
, outputStream
));
810 messageBuilder
= getGroupUpdateMessageBuilder(gv2
, null);
811 account
.getGroupStore().updateGroup(gv2
);
813 final var result
= sendHelper
.sendGroupMessage(messageBuilder
.build(),
814 gv2
.getMembersIncludingPendingWithout(selfRecipientId
));
815 return new Pair
<>(gv2
.getGroupId(), result
.second());
818 public Pair
<Long
, List
<SendMessageResult
>> updateGroup(
822 List
<String
> members
,
823 List
<String
> removeMembers
,
825 List
<String
> removeAdmins
,
826 boolean resetGroupLink
,
827 GroupLinkState groupLinkState
,
828 GroupPermission addMemberPermission
,
829 GroupPermission editDetailsPermission
,
831 Integer expirationTimer
,
832 Boolean isAnnouncementGroup
833 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, InvalidNumberException
, NotAGroupMemberException
{
834 return updateGroup(groupId
,
837 members
== null ?
null : getRecipientIds(members
),
838 removeMembers
== null ?
null : getRecipientIds(removeMembers
),
839 admins
== null ?
null : getRecipientIds(admins
),
840 removeAdmins
== null ?
null : getRecipientIds(removeAdmins
),
844 editDetailsPermission
,
847 isAnnouncementGroup
);
850 private Pair
<Long
, List
<SendMessageResult
>> updateGroup(
851 final GroupId groupId
,
853 final String description
,
854 final Set
<RecipientId
> members
,
855 final Set
<RecipientId
> removeMembers
,
856 final Set
<RecipientId
> admins
,
857 final Set
<RecipientId
> removeAdmins
,
858 final boolean resetGroupLink
,
859 final GroupLinkState groupLinkState
,
860 final GroupPermission addMemberPermission
,
861 final GroupPermission editDetailsPermission
,
862 final File avatarFile
,
863 final Integer expirationTimer
,
864 final Boolean isAnnouncementGroup
865 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
{
866 var group
= getGroupForUpdating(groupId
);
868 if (group
instanceof GroupInfoV2
) {
870 return updateGroupV2((GroupInfoV2
) group
,
880 editDetailsPermission
,
883 isAnnouncementGroup
);
884 } catch (ConflictException e
) {
885 // Detected conflicting update, refreshing group and trying again
886 group
= getGroup(groupId
, true);
887 return updateGroupV2((GroupInfoV2
) group
,
897 editDetailsPermission
,
900 isAnnouncementGroup
);
904 final var gv1
= (GroupInfoV1
) group
;
905 final var result
= updateGroupV1(gv1
, name
, members
, avatarFile
);
906 if (expirationTimer
!= null) {
907 setExpirationTimer(gv1
, expirationTimer
);
912 private Pair
<Long
, List
<SendMessageResult
>> updateGroupV1(
913 final GroupInfoV1 gv1
, final String name
, final Set
<RecipientId
> members
, final File avatarFile
914 ) throws IOException
, AttachmentInvalidException
{
915 updateGroupV1Details(gv1
, name
, members
, avatarFile
);
916 var messageBuilder
= getGroupUpdateMessageBuilder(gv1
);
918 account
.getGroupStore().updateGroup(gv1
);
920 return sendHelper
.sendGroupMessage(messageBuilder
.build(),
921 gv1
.getMembersIncludingPendingWithout(account
.getSelfRecipientId()));
924 private void updateGroupV1Details(
925 final GroupInfoV1 g
, final String name
, final Collection
<RecipientId
> members
, final File avatarFile
926 ) throws IOException
{
931 if (members
!= null) {
932 final var newMemberAddresses
= members
.stream()
933 .filter(member
-> !g
.isMember(member
))
934 .map(this::resolveSignalServiceAddress
)
935 .collect(Collectors
.toList());
936 final var newE164Members
= new HashSet
<String
>();
937 for (var member
: newMemberAddresses
) {
938 if (!member
.getNumber().isPresent()) {
941 newE164Members
.add(member
.getNumber().get());
944 final var registeredUsers
= getRegisteredUsers(newE164Members
);
945 if (registeredUsers
.size() != newE164Members
.size()) {
946 // Some of the new members are not registered on Signal
947 newE164Members
.removeAll(registeredUsers
.keySet());
948 throw new IOException("Failed to add members "
949 + String
.join(", ", newE164Members
)
950 + " to group: Not registered on Signal");
953 g
.addMembers(members
);
956 if (avatarFile
!= null) {
957 avatarStore
.storeGroupAvatar(g
.getGroupId(),
958 outputStream
-> IOUtils
.copyFileToStream(avatarFile
, outputStream
));
962 private Pair
<Long
, List
<SendMessageResult
>> updateGroupV2(
963 final GroupInfoV2 group
,
965 final String description
,
966 final Set
<RecipientId
> members
,
967 final Set
<RecipientId
> removeMembers
,
968 final Set
<RecipientId
> admins
,
969 final Set
<RecipientId
> removeAdmins
,
970 final boolean resetGroupLink
,
971 final GroupLinkState groupLinkState
,
972 final GroupPermission addMemberPermission
,
973 final GroupPermission editDetailsPermission
,
974 final File avatarFile
,
975 final Integer expirationTimer
,
976 final Boolean isAnnouncementGroup
977 ) throws IOException
{
978 Pair
<Long
, List
<SendMessageResult
>> result
= null;
979 if (group
.isPendingMember(account
.getSelfRecipientId())) {
980 var groupGroupChangePair
= groupV2Helper
.acceptInvite(group
);
981 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
984 if (members
!= null) {
985 final var newMembers
= new HashSet
<>(members
);
986 newMembers
.removeAll(group
.getMembers());
987 if (newMembers
.size() > 0) {
988 var groupGroupChangePair
= groupV2Helper
.addMembers(group
, newMembers
);
989 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
993 if (removeMembers
!= null) {
994 var existingRemoveMembers
= new HashSet
<>(removeMembers
);
995 existingRemoveMembers
.retainAll(group
.getMembers());
996 existingRemoveMembers
.remove(getSelfRecipientId());// self can be removed with sendQuitGroupMessage
997 if (existingRemoveMembers
.size() > 0) {
998 var groupGroupChangePair
= groupV2Helper
.removeMembers(group
, existingRemoveMembers
);
999 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
1002 var pendingRemoveMembers
= new HashSet
<>(removeMembers
);
1003 pendingRemoveMembers
.retainAll(group
.getPendingMembers());
1004 if (pendingRemoveMembers
.size() > 0) {
1005 var groupGroupChangePair
= groupV2Helper
.revokeInvitedMembers(group
, pendingRemoveMembers
);
1006 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
1010 if (admins
!= null) {
1011 final var newAdmins
= new HashSet
<>(admins
);
1012 newAdmins
.retainAll(group
.getMembers());
1013 newAdmins
.removeAll(group
.getAdminMembers());
1014 if (newAdmins
.size() > 0) {
1015 for (var admin
: newAdmins
) {
1016 var groupGroupChangePair
= groupV2Helper
.setMemberAdmin(group
, admin
, true);
1017 result
= sendUpdateGroupV2Message(group
,
1018 groupGroupChangePair
.first(),
1019 groupGroupChangePair
.second());
1024 if (removeAdmins
!= null) {
1025 final var existingRemoveAdmins
= new HashSet
<>(removeAdmins
);
1026 existingRemoveAdmins
.retainAll(group
.getAdminMembers());
1027 if (existingRemoveAdmins
.size() > 0) {
1028 for (var admin
: existingRemoveAdmins
) {
1029 var groupGroupChangePair
= groupV2Helper
.setMemberAdmin(group
, admin
, false);
1030 result
= sendUpdateGroupV2Message(group
,
1031 groupGroupChangePair
.first(),
1032 groupGroupChangePair
.second());
1037 if (resetGroupLink
) {
1038 var groupGroupChangePair
= groupV2Helper
.resetGroupLinkPassword(group
);
1039 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
1042 if (groupLinkState
!= null) {
1043 var groupGroupChangePair
= groupV2Helper
.setGroupLinkState(group
, groupLinkState
);
1044 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
1047 if (addMemberPermission
!= null) {
1048 var groupGroupChangePair
= groupV2Helper
.setAddMemberPermission(group
, addMemberPermission
);
1049 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
1052 if (editDetailsPermission
!= null) {
1053 var groupGroupChangePair
= groupV2Helper
.setEditDetailsPermission(group
, editDetailsPermission
);
1054 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
1057 if (expirationTimer
!= null) {
1058 var groupGroupChangePair
= groupV2Helper
.setMessageExpirationTimer(group
, expirationTimer
);
1059 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
1062 if (isAnnouncementGroup
!= null) {
1063 var groupGroupChangePair
= groupV2Helper
.setIsAnnouncementGroup(group
, isAnnouncementGroup
);
1064 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
1067 if (name
!= null || description
!= null || avatarFile
!= null) {
1068 var groupGroupChangePair
= groupV2Helper
.updateGroup(group
, name
, description
, avatarFile
);
1069 if (avatarFile
!= null) {
1070 avatarStore
.storeGroupAvatar(group
.getGroupId(),
1071 outputStream
-> IOUtils
.copyFileToStream(avatarFile
, outputStream
));
1073 result
= sendUpdateGroupV2Message(group
, groupGroupChangePair
.first(), groupGroupChangePair
.second());
1079 public Pair
<GroupId
, List
<SendMessageResult
>> joinGroup(
1080 GroupInviteLinkUrl inviteLinkUrl
1081 ) throws IOException
, GroupLinkNotActiveException
{
1082 final var groupJoinInfo
= groupV2Helper
.getDecryptedGroupJoinInfo(inviteLinkUrl
.getGroupMasterKey(),
1083 inviteLinkUrl
.getPassword());
1084 final var groupChange
= groupV2Helper
.joinGroup(inviteLinkUrl
.getGroupMasterKey(),
1085 inviteLinkUrl
.getPassword(),
1087 final var group
= getOrMigrateGroup(inviteLinkUrl
.getGroupMasterKey(),
1088 groupJoinInfo
.getRevision() + 1,
1089 groupChange
.toByteArray());
1091 if (group
.getGroup() == null) {
1092 // Only requested member, can't send update to group members
1093 return new Pair
<>(group
.getGroupId(), List
.of());
1096 final var result
= sendUpdateGroupV2Message(group
, group
.getGroup(), groupChange
);
1098 return new Pair
<>(group
.getGroupId(), result
.second());
1101 private Pair
<Long
, List
<SendMessageResult
>> sendUpdateGroupV2Message(
1102 GroupInfoV2 group
, DecryptedGroup newDecryptedGroup
, GroupChange groupChange
1103 ) throws IOException
{
1104 final var selfRecipientId
= account
.getSelfRecipientId();
1105 final var members
= group
.getMembersIncludingPendingWithout(selfRecipientId
);
1106 group
.setGroup(newDecryptedGroup
, this::resolveRecipient
);
1107 members
.addAll(group
.getMembersIncludingPendingWithout(selfRecipientId
));
1109 final var messageBuilder
= getGroupUpdateMessageBuilder(group
, groupChange
.toByteArray());
1110 account
.getGroupStore().updateGroup(group
);
1111 return sendHelper
.sendGroupMessage(messageBuilder
.build(), members
);
1114 private static int currentTimeDays() {
1115 return (int) TimeUnit
.MILLISECONDS
.toDays(System
.currentTimeMillis());
1118 private GroupsV2AuthorizationString
getGroupAuthForToday(
1119 final GroupSecretParams groupSecretParams
1120 ) throws IOException
{
1121 final var today
= currentTimeDays();
1122 // Returns credentials for the next 7 days
1123 final var credentials
= dependencies
.getGroupsV2Api().getCredentials(today
);
1124 // TODO cache credentials until they expire
1125 var authCredentialResponse
= credentials
.get(today
);
1127 return dependencies
.getGroupsV2Api()
1128 .getGroupsV2AuthorizationString(account
.getUuid(),
1131 authCredentialResponse
);
1132 } catch (VerificationFailedException e
) {
1133 throw new IOException(e
);
1137 Pair
<Long
, List
<SendMessageResult
>> sendGroupInfoMessage(
1138 GroupIdV1 groupId
, SignalServiceAddress recipient
1139 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, AttachmentInvalidException
{
1141 var group
= getGroupForUpdating(groupId
);
1142 if (!(group
instanceof GroupInfoV1
)) {
1143 throw new IOException("Received an invalid group request for a v2 group!");
1145 g
= (GroupInfoV1
) group
;
1147 final var recipientId
= resolveRecipient(recipient
);
1148 if (!g
.isMember(recipientId
)) {
1149 throw new NotAGroupMemberException(groupId
, g
.name
);
1152 var messageBuilder
= getGroupUpdateMessageBuilder(g
);
1154 // Send group message only to the recipient who requested it
1155 return sendHelper
.sendGroupMessage(messageBuilder
.build(), Set
.of(recipientId
));
1158 private SignalServiceDataMessage
.Builder
getGroupUpdateMessageBuilder(GroupInfoV1 g
) throws AttachmentInvalidException
{
1159 var group
= SignalServiceGroup
.newBuilder(SignalServiceGroup
.Type
.UPDATE
)
1160 .withId(g
.getGroupId().serialize())
1162 .withMembers(g
.getMembers()
1164 .map(this::resolveSignalServiceAddress
)
1165 .collect(Collectors
.toList()));
1168 final var attachment
= createGroupAvatarAttachment(g
.getGroupId());
1169 if (attachment
.isPresent()) {
1170 group
.withAvatar(attachment
.get());
1172 } catch (IOException e
) {
1173 throw new AttachmentInvalidException(g
.getGroupId().toBase64(), e
);
1176 return createMessageBuilder().asGroupMessage(group
.build()).withExpiration(g
.getMessageExpirationTime());
1179 private SignalServiceDataMessage
.Builder
getGroupUpdateMessageBuilder(GroupInfoV2 g
, byte[] signedGroupChange
) {
1180 var group
= SignalServiceGroupV2
.newBuilder(g
.getMasterKey())
1181 .withRevision(g
.getGroup().getRevision())
1182 .withSignedGroupChange(signedGroupChange
);
1183 return createMessageBuilder().asGroupMessage(group
.build()).withExpiration(g
.getMessageExpirationTime());
1186 Pair
<Long
, List
<SendMessageResult
>> sendGroupInfoRequest(
1187 GroupIdV1 groupId
, SignalServiceAddress recipient
1188 ) throws IOException
{
1189 var group
= SignalServiceGroup
.newBuilder(SignalServiceGroup
.Type
.REQUEST_INFO
).withId(groupId
.serialize());
1191 var messageBuilder
= createMessageBuilder().asGroupMessage(group
.build());
1193 // Send group info request message to the recipient who sent us a message with this groupId
1194 return sendHelper
.sendGroupMessage(messageBuilder
.build(), Set
.of(resolveRecipient(recipient
)));
1197 public void sendReadReceipt(
1198 String sender
, List
<Long
> messageIds
1199 ) throws IOException
, UntrustedIdentityException
, InvalidNumberException
{
1200 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.READ
,
1202 System
.currentTimeMillis());
1204 sendHelper
.sendReceiptMessage(receiptMessage
, canonicalizeAndResolveRecipient(sender
));
1207 public void sendViewedReceipt(
1208 String sender
, List
<Long
> messageIds
1209 ) throws IOException
, UntrustedIdentityException
, InvalidNumberException
{
1210 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.VIEWED
,
1212 System
.currentTimeMillis());
1214 sendHelper
.sendReceiptMessage(receiptMessage
, canonicalizeAndResolveRecipient(sender
));
1217 void sendDeliveryReceipt(
1218 SignalServiceAddress remoteAddress
, List
<Long
> messageIds
1219 ) throws IOException
, UntrustedIdentityException
{
1220 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.DELIVERY
,
1222 System
.currentTimeMillis());
1224 sendHelper
.sendReceiptMessage(receiptMessage
, resolveRecipient(remoteAddress
));
1227 public Pair
<Long
, List
<SendMessageResult
>> sendMessage(
1228 String messageText
, List
<String
> attachments
, List
<String
> recipients
1229 ) throws IOException
, AttachmentInvalidException
, InvalidNumberException
{
1230 final var messageBuilder
= createMessageBuilder().withBody(messageText
);
1231 if (attachments
!= null) {
1232 var attachmentStreams
= AttachmentUtils
.getSignalServiceAttachments(attachments
);
1234 // Upload attachments here, so we only upload once even for multiple recipients
1235 var messageSender
= dependencies
.getMessageSender();
1236 var attachmentPointers
= new ArrayList
<SignalServiceAttachment
>(attachmentStreams
.size());
1237 for (var attachment
: attachmentStreams
) {
1238 if (attachment
.isStream()) {
1239 attachmentPointers
.add(messageSender
.uploadAttachment(attachment
.asStream()));
1240 } else if (attachment
.isPointer()) {
1241 attachmentPointers
.add(attachment
.asPointer());
1245 messageBuilder
.withAttachments(attachmentPointers
);
1247 return sendHelper
.sendMessage(messageBuilder
, getRecipientIds(recipients
));
1250 public Pair
<Long
, SendMessageResult
> sendSelfMessage(
1251 String messageText
, List
<String
> attachments
1252 ) throws IOException
, AttachmentInvalidException
{
1253 final var messageBuilder
= createMessageBuilder().withBody(messageText
);
1254 if (attachments
!= null) {
1255 messageBuilder
.withAttachments(AttachmentUtils
.getSignalServiceAttachments(attachments
));
1257 return sendHelper
.sendSelfMessage(messageBuilder
);
1260 public Pair
<Long
, List
<SendMessageResult
>> sendRemoteDeleteMessage(
1261 long targetSentTimestamp
, List
<String
> recipients
1262 ) throws IOException
, InvalidNumberException
{
1263 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
1264 final var messageBuilder
= createMessageBuilder().withRemoteDelete(delete
);
1265 return sendHelper
.sendMessage(messageBuilder
, getRecipientIds(recipients
));
1268 public Pair
<Long
, List
<SendMessageResult
>> sendGroupRemoteDeleteMessage(
1269 long targetSentTimestamp
, GroupId groupId
1270 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
{
1271 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
1272 final var messageBuilder
= createMessageBuilder().withRemoteDelete(delete
);
1273 return sendHelper
.sendAsGroupMessage(messageBuilder
, groupId
);
1276 public Pair
<Long
, List
<SendMessageResult
>> sendMessageReaction(
1277 String emoji
, boolean remove
, String targetAuthor
, long targetSentTimestamp
, List
<String
> recipients
1278 ) throws IOException
, InvalidNumberException
{
1279 var targetAuthorRecipientId
= canonicalizeAndResolveRecipient(targetAuthor
);
1280 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
,
1282 resolveSignalServiceAddress(targetAuthorRecipientId
),
1283 targetSentTimestamp
);
1284 final var messageBuilder
= createMessageBuilder().withReaction(reaction
);
1285 return sendHelper
.sendMessage(messageBuilder
, getRecipientIds(recipients
));
1288 public Pair
<Long
, List
<SendMessageResult
>> sendEndSessionMessage(List
<String
> recipients
) throws IOException
, InvalidNumberException
{
1289 var messageBuilder
= createMessageBuilder().asEndSessionMessage();
1291 final var recipientIds
= getRecipientIds(recipients
);
1293 return sendHelper
.sendMessage(messageBuilder
, recipientIds
);
1295 for (var recipientId
: recipientIds
) {
1296 handleEndSession(recipientId
);
1301 void renewSession(RecipientId recipientId
) throws IOException
{
1302 account
.getSessionStore().archiveSessions(recipientId
);
1303 if (!recipientId
.equals(getSelfRecipientId())) {
1304 sendHelper
.sendNullMessage(recipientId
);
1308 public void setContactName(String number
, String name
) throws InvalidNumberException
, NotMasterDeviceException
{
1309 if (!account
.isMasterDevice()) {
1310 throw new NotMasterDeviceException();
1312 final var recipientId
= canonicalizeAndResolveRecipient(number
);
1313 var contact
= account
.getContactStore().getContact(recipientId
);
1314 final var builder
= contact
== null ? Contact
.newBuilder() : Contact
.newBuilder(contact
);
1315 account
.getContactStore().storeContact(recipientId
, builder
.withName(name
).build());
1318 public void setContactBlocked(
1319 String number
, boolean blocked
1320 ) throws InvalidNumberException
, NotMasterDeviceException
{
1321 if (!account
.isMasterDevice()) {
1322 throw new NotMasterDeviceException();
1324 setContactBlocked(canonicalizeAndResolveRecipient(number
), blocked
);
1327 private void setContactBlocked(RecipientId recipientId
, boolean blocked
) {
1328 var contact
= account
.getContactStore().getContact(recipientId
);
1329 final var builder
= contact
== null ? Contact
.newBuilder() : Contact
.newBuilder(contact
);
1330 account
.getContactStore().storeContact(recipientId
, builder
.withBlocked(blocked
).build());
1333 public void setGroupBlocked(final GroupId groupId
, final boolean blocked
) throws GroupNotFoundException
{
1334 var group
= getGroup(groupId
);
1335 if (group
== null) {
1336 throw new GroupNotFoundException(groupId
);
1339 group
.setBlocked(blocked
);
1340 account
.getGroupStore().updateGroup(group
);
1343 private void setExpirationTimer(RecipientId recipientId
, int messageExpirationTimer
) {
1344 var contact
= account
.getContactStore().getContact(recipientId
);
1345 if (contact
!= null && contact
.getMessageExpirationTime() == messageExpirationTimer
) {
1348 final var builder
= contact
== null ? Contact
.newBuilder() : Contact
.newBuilder(contact
);
1349 account
.getContactStore()
1350 .storeContact(recipientId
, builder
.withMessageExpirationTime(messageExpirationTimer
).build());
1353 private void sendExpirationTimerUpdate(RecipientId recipientId
) throws IOException
{
1354 final var messageBuilder
= createMessageBuilder().asExpirationUpdate();
1355 sendHelper
.sendMessage(messageBuilder
, Set
.of(recipientId
));
1359 * Change the expiration timer for a contact
1361 public void setExpirationTimer(
1362 String number
, int messageExpirationTimer
1363 ) throws IOException
, InvalidNumberException
{
1364 var recipientId
= canonicalizeAndResolveRecipient(number
);
1365 setExpirationTimer(recipientId
, messageExpirationTimer
);
1366 sendExpirationTimerUpdate(recipientId
);
1370 * Change the expiration timer for a group
1372 private void setExpirationTimer(
1373 GroupInfoV1 groupInfoV1
, int messageExpirationTimer
1374 ) throws NotAGroupMemberException
, GroupNotFoundException
, IOException
{
1375 groupInfoV1
.messageExpirationTime
= messageExpirationTimer
;
1376 account
.getGroupStore().updateGroup(groupInfoV1
);
1377 sendExpirationTimerUpdate(groupInfoV1
.getGroupId());
1380 private void sendExpirationTimerUpdate(GroupIdV1 groupId
) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
{
1381 final var messageBuilder
= createMessageBuilder().asExpirationUpdate();
1382 sendHelper
.sendAsGroupMessage(messageBuilder
, groupId
);
1386 * Upload the sticker pack from path.
1388 * @param path Path can be a path to a manifest.json file or to a zip file that contains a manifest.json file
1389 * @return if successful, returns the URL to install the sticker pack in the signal app
1391 public String
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1392 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1394 var messageSender
= dependencies
.getMessageSender();
1396 var packKey
= KeyUtils
.createStickerUploadKey();
1397 var packIdString
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1398 var packId
= StickerPackId
.deserialize(Hex
.fromStringCondensed(packIdString
));
1400 var sticker
= new Sticker(packId
, packKey
);
1401 account
.getStickerStore().updateSticker(sticker
);
1404 return new URI("https",
1408 + URLEncoder
.encode(Hex
.toStringCondensed(packId
.serialize()), StandardCharsets
.UTF_8
)
1410 + URLEncoder
.encode(Hex
.toStringCondensed(packKey
), StandardCharsets
.UTF_8
)).toString();
1411 } catch (URISyntaxException e
) {
1412 throw new AssertionError(e
);
1416 public void requestAllSyncData() throws IOException
{
1417 requestSyncGroups();
1418 requestSyncContacts();
1419 requestSyncBlocked();
1420 requestSyncConfiguration();
1424 private void requestSyncGroups() throws IOException
{
1425 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1426 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.GROUPS
)
1428 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1429 sendHelper
.sendSyncMessage(message
);
1432 private void requestSyncContacts() throws IOException
{
1433 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1434 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.CONTACTS
)
1436 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1437 sendHelper
.sendSyncMessage(message
);
1440 private void requestSyncBlocked() throws IOException
{
1441 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1442 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.BLOCKED
)
1444 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1445 sendHelper
.sendSyncMessage(message
);
1448 private void requestSyncConfiguration() throws IOException
{
1449 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1450 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.CONFIGURATION
)
1452 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1453 sendHelper
.sendSyncMessage(message
);
1456 private void requestSyncKeys() throws IOException
{
1457 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1458 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.KEYS
)
1460 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1461 sendHelper
.sendSyncMessage(message
);
1464 private byte[] getSenderCertificate() {
1467 if (account
.isPhoneNumberShared()) {
1468 certificate
= dependencies
.getAccountManager().getSenderCertificate();
1470 certificate
= dependencies
.getAccountManager().getSenderCertificateForPhoneNumberPrivacy();
1472 } catch (IOException e
) {
1473 logger
.warn("Failed to get sender certificate, ignoring: {}", e
.getMessage());
1476 // TODO cache for a day
1480 private Set
<RecipientId
> getRecipientIds(Collection
<String
> numbers
) throws InvalidNumberException
{
1481 final var signalServiceAddresses
= new HashSet
<SignalServiceAddress
>(numbers
.size());
1482 final var addressesMissingUuid
= new HashSet
<SignalServiceAddress
>();
1484 for (var number
: numbers
) {
1485 final var resolvedAddress
= resolveSignalServiceAddress(canonicalizeAndResolveRecipient(number
));
1486 if (resolvedAddress
.getUuid().isPresent()) {
1487 signalServiceAddresses
.add(resolvedAddress
);
1489 addressesMissingUuid
.add(resolvedAddress
);
1493 final var numbersMissingUuid
= addressesMissingUuid
.stream()
1494 .map(a
-> a
.getNumber().get())
1495 .collect(Collectors
.toSet());
1496 Map
<String
, UUID
> registeredUsers
;
1498 registeredUsers
= getRegisteredUsers(numbersMissingUuid
);
1499 } catch (IOException e
) {
1500 logger
.warn("Failed to resolve uuids from server, ignoring: {}", e
.getMessage());
1501 registeredUsers
= Map
.of();
1504 for (var address
: addressesMissingUuid
) {
1505 final var number
= address
.getNumber().get();
1506 if (registeredUsers
.containsKey(number
)) {
1507 final var newAddress
= resolveSignalServiceAddress(resolveRecipientTrusted(new SignalServiceAddress(
1508 registeredUsers
.get(number
),
1510 signalServiceAddresses
.add(newAddress
);
1512 signalServiceAddresses
.add(address
);
1516 return signalServiceAddresses
.stream().map(this::resolveRecipient
).collect(Collectors
.toSet());
1519 private RecipientId
refreshRegisteredUser(RecipientId recipientId
) throws IOException
{
1520 final var address
= resolveSignalServiceAddress(recipientId
);
1521 if (!address
.getNumber().isPresent()) {
1524 final var number
= address
.getNumber().get();
1525 final var uuidMap
= getRegisteredUsers(Set
.of(number
));
1526 return resolveRecipientTrusted(new SignalServiceAddress(uuidMap
.getOrDefault(number
, null), number
));
1529 private Map
<String
, UUID
> getRegisteredUsers(final Set
<String
> numbers
) throws IOException
{
1531 return dependencies
.getAccountManager()
1532 .getRegisteredUsers(ServiceConfig
.getIasKeyStore(),
1534 serviceEnvironmentConfig
.getCdsMrenclave());
1535 } catch (Quote
.InvalidQuoteFormatException
| UnauthenticatedQuoteException
| SignatureException
| UnauthenticatedResponseException
| InvalidKeyException e
) {
1536 throw new IOException(e
);
1540 public void sendTypingMessage(
1541 TypingAction action
, Set
<String
> recipients
1542 ) throws IOException
, UntrustedIdentityException
, InvalidNumberException
{
1543 final var timestamp
= System
.currentTimeMillis();
1544 var message
= new SignalServiceTypingMessage(action
.toSignalService(), timestamp
, Optional
.absent());
1545 sendHelper
.sendTypingMessage(message
, getRecipientIds(recipients
));
1548 public void sendGroupTypingMessage(
1549 TypingAction action
, GroupId groupId
1550 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
{
1551 final var timestamp
= System
.currentTimeMillis();
1552 final var message
= new SignalServiceTypingMessage(action
.toSignalService(),
1554 Optional
.of(groupId
.serialize()));
1555 sendHelper
.sendGroupTypingMessage(message
, groupId
);
1558 private SignalServiceDataMessage
.Builder
createMessageBuilder() {
1559 final var timestamp
= System
.currentTimeMillis();
1561 var messageBuilder
= SignalServiceDataMessage
.newBuilder();
1562 messageBuilder
.withTimestamp(timestamp
);
1563 return messageBuilder
;
1566 private SignalServiceContent
decryptMessage(SignalServiceEnvelope envelope
) throws InvalidMetadataMessageException
, ProtocolInvalidMessageException
, ProtocolDuplicateMessageException
, ProtocolLegacyMessageException
, ProtocolInvalidKeyIdException
, InvalidMetadataVersionException
, ProtocolInvalidVersionException
, ProtocolNoSessionException
, ProtocolInvalidKeyException
, SelfSendException
, UnsupportedDataMessageException
, ProtocolUntrustedIdentityException
, InvalidMessageStructureException
{
1567 return dependencies
.getCipher().decrypt(envelope
);
1570 private void handleEndSession(RecipientId recipientId
) {
1571 account
.getSessionStore().deleteAllSessions(recipientId
);
1574 private List
<HandleAction
> handleSignalServiceDataMessage(
1575 SignalServiceDataMessage message
,
1577 SignalServiceAddress source
,
1578 SignalServiceAddress destination
,
1579 boolean ignoreAttachments
1581 var actions
= new ArrayList
<HandleAction
>();
1582 if (message
.getGroupContext().isPresent()) {
1583 if (message
.getGroupContext().get().getGroupV1().isPresent()) {
1584 var groupInfo
= message
.getGroupContext().get().getGroupV1().get();
1585 var groupId
= GroupId
.v1(groupInfo
.getGroupId());
1586 var group
= getGroup(groupId
);
1587 if (group
== null || group
instanceof GroupInfoV1
) {
1588 var groupV1
= (GroupInfoV1
) group
;
1589 switch (groupInfo
.getType()) {
1591 if (groupV1
== null) {
1592 groupV1
= new GroupInfoV1(groupId
);
1595 if (groupInfo
.getAvatar().isPresent()) {
1596 var avatar
= groupInfo
.getAvatar().get();
1597 downloadGroupAvatar(avatar
, groupV1
.getGroupId());
1600 if (groupInfo
.getName().isPresent()) {
1601 groupV1
.name
= groupInfo
.getName().get();
1604 if (groupInfo
.getMembers().isPresent()) {
1605 groupV1
.addMembers(groupInfo
.getMembers()
1608 .map(this::resolveRecipient
)
1609 .collect(Collectors
.toSet()));
1612 account
.getGroupStore().updateGroup(groupV1
);
1616 if (groupV1
== null && !isSync
) {
1617 actions
.add(new SendGroupInfoRequestAction(source
, groupId
));
1621 if (groupV1
!= null) {
1622 groupV1
.removeMember(resolveRecipient(source
));
1623 account
.getGroupStore().updateGroup(groupV1
);
1628 if (groupV1
!= null && !isSync
) {
1629 actions
.add(new SendGroupInfoAction(source
, groupV1
.getGroupId()));
1634 // Received a group v1 message for a v2 group
1637 if (message
.getGroupContext().get().getGroupV2().isPresent()) {
1638 final var groupContext
= message
.getGroupContext().get().getGroupV2().get();
1639 final var groupMasterKey
= groupContext
.getMasterKey();
1641 getOrMigrateGroup(groupMasterKey
,
1642 groupContext
.getRevision(),
1643 groupContext
.hasSignedGroupChange() ? groupContext
.getSignedGroupChange() : null);
1647 final var conversationPartnerAddress
= isSync ? destination
: source
;
1648 if (conversationPartnerAddress
!= null && message
.isEndSession()) {
1649 handleEndSession(resolveRecipient(conversationPartnerAddress
));
1651 if (message
.isExpirationUpdate() || message
.getBody().isPresent()) {
1652 if (message
.getGroupContext().isPresent()) {
1653 if (message
.getGroupContext().get().getGroupV1().isPresent()) {
1654 var groupInfo
= message
.getGroupContext().get().getGroupV1().get();
1655 var group
= account
.getGroupStore().getOrCreateGroupV1(GroupId
.v1(groupInfo
.getGroupId()));
1656 if (group
!= null) {
1657 if (group
.messageExpirationTime
!= message
.getExpiresInSeconds()) {
1658 group
.messageExpirationTime
= message
.getExpiresInSeconds();
1659 account
.getGroupStore().updateGroup(group
);
1662 } else if (message
.getGroupContext().get().getGroupV2().isPresent()) {
1663 // disappearing message timer already stored in the DecryptedGroup
1665 } else if (conversationPartnerAddress
!= null) {
1666 setExpirationTimer(resolveRecipient(conversationPartnerAddress
), message
.getExpiresInSeconds());
1669 if (!ignoreAttachments
) {
1670 if (message
.getAttachments().isPresent()) {
1671 for (var attachment
: message
.getAttachments().get()) {
1672 downloadAttachment(attachment
);
1675 if (message
.getSharedContacts().isPresent()) {
1676 for (var contact
: message
.getSharedContacts().get()) {
1677 if (contact
.getAvatar().isPresent()) {
1678 downloadAttachment(contact
.getAvatar().get().getAttachment());
1683 if (message
.getProfileKey().isPresent() && message
.getProfileKey().get().length
== 32) {
1684 final ProfileKey profileKey
;
1686 profileKey
= new ProfileKey(message
.getProfileKey().get());
1687 } catch (InvalidInputException e
) {
1688 throw new AssertionError(e
);
1690 if (source
.matches(account
.getSelfAddress())) {
1691 this.account
.setProfileKey(profileKey
);
1693 this.account
.getProfileStore().storeProfileKey(resolveRecipient(source
), profileKey
);
1695 if (message
.getPreviews().isPresent()) {
1696 final var previews
= message
.getPreviews().get();
1697 for (var preview
: previews
) {
1698 if (preview
.getImage().isPresent()) {
1699 downloadAttachment(preview
.getImage().get());
1703 if (message
.getQuote().isPresent()) {
1704 final var quote
= message
.getQuote().get();
1706 for (var quotedAttachment
: quote
.getAttachments()) {
1707 final var thumbnail
= quotedAttachment
.getThumbnail();
1708 if (thumbnail
!= null) {
1709 downloadAttachment(thumbnail
);
1713 if (message
.getSticker().isPresent()) {
1714 final var messageSticker
= message
.getSticker().get();
1715 final var stickerPackId
= StickerPackId
.deserialize(messageSticker
.getPackId());
1716 var sticker
= account
.getStickerStore().getSticker(stickerPackId
);
1717 if (sticker
== null) {
1718 sticker
= new Sticker(stickerPackId
, messageSticker
.getPackKey());
1719 account
.getStickerStore().updateSticker(sticker
);
1721 enqueueJob(new RetrieveStickerPackJob(stickerPackId
, messageSticker
.getPackKey()));
1726 private GroupInfoV2
getOrMigrateGroup(
1727 final GroupMasterKey groupMasterKey
, final int revision
, final byte[] signedGroupChange
1729 final var groupSecretParams
= GroupSecretParams
.deriveFromMasterKey(groupMasterKey
);
1731 var groupId
= GroupUtils
.getGroupIdV2(groupSecretParams
);
1732 var groupInfo
= getGroup(groupId
);
1733 final GroupInfoV2 groupInfoV2
;
1734 if (groupInfo
instanceof GroupInfoV1
) {
1735 // Received a v2 group message for a v1 group, we need to locally migrate the group
1736 account
.getGroupStore().deleteGroupV1(((GroupInfoV1
) groupInfo
).getGroupId());
1737 groupInfoV2
= new GroupInfoV2(groupId
, groupMasterKey
);
1738 logger
.info("Locally migrated group {} to group v2, id: {}",
1739 groupInfo
.getGroupId().toBase64(),
1740 groupInfoV2
.getGroupId().toBase64());
1741 } else if (groupInfo
instanceof GroupInfoV2
) {
1742 groupInfoV2
= (GroupInfoV2
) groupInfo
;
1744 groupInfoV2
= new GroupInfoV2(groupId
, groupMasterKey
);
1747 if (groupInfoV2
.getGroup() == null || groupInfoV2
.getGroup().getRevision() < revision
) {
1748 DecryptedGroup group
= null;
1749 if (signedGroupChange
!= null
1750 && groupInfoV2
.getGroup() != null
1751 && groupInfoV2
.getGroup().getRevision() + 1 == revision
) {
1752 group
= groupV2Helper
.getUpdatedDecryptedGroup(groupInfoV2
.getGroup(),
1756 if (group
== null) {
1757 group
= groupV2Helper
.getDecryptedGroup(groupSecretParams
);
1759 if (group
!= null) {
1760 storeProfileKeysFromMembers(group
);
1761 final var avatar
= group
.getAvatar();
1762 if (avatar
!= null && !avatar
.isEmpty()) {
1763 downloadGroupAvatar(groupId
, groupSecretParams
, avatar
);
1766 groupInfoV2
.setGroup(group
, this::resolveRecipient
);
1767 account
.getGroupStore().updateGroup(groupInfoV2
);
1773 private void storeProfileKeysFromMembers(final DecryptedGroup group
) {
1774 for (var member
: group
.getMembersList()) {
1775 final var uuid
= UuidUtil
.parseOrThrow(member
.getUuid().toByteArray());
1776 final var recipientId
= account
.getRecipientStore().resolveRecipient(uuid
);
1778 account
.getProfileStore()
1779 .storeProfileKey(recipientId
, new ProfileKey(member
.getProfileKey().toByteArray()));
1780 } catch (InvalidInputException ignored
) {
1785 private void retryFailedReceivedMessages(ReceiveMessageHandler handler
, boolean ignoreAttachments
) {
1786 Set
<HandleAction
> queuedActions
= new HashSet
<>();
1787 for (var cachedMessage
: account
.getMessageCache().getCachedMessages()) {
1788 var actions
= retryFailedReceivedMessage(handler
, ignoreAttachments
, cachedMessage
);
1789 if (actions
!= null) {
1790 queuedActions
.addAll(actions
);
1793 handleQueuedActions(queuedActions
);
1796 private List
<HandleAction
> retryFailedReceivedMessage(
1797 final ReceiveMessageHandler handler
, final boolean ignoreAttachments
, final CachedMessage cachedMessage
1799 var envelope
= cachedMessage
.loadEnvelope();
1800 if (envelope
== null) {
1803 SignalServiceContent content
= null;
1804 List
<HandleAction
> actions
= null;
1805 if (!envelope
.isReceipt()) {
1807 content
= decryptMessage(envelope
);
1808 } catch (ProtocolUntrustedIdentityException e
) {
1809 if (!envelope
.hasSource()) {
1810 final var identifier
= e
.getSender();
1811 final var recipientId
= resolveRecipient(identifier
);
1813 account
.getMessageCache().replaceSender(cachedMessage
, recipientId
);
1814 } catch (IOException ioException
) {
1815 logger
.warn("Failed to move cached message to recipient folder: {}", ioException
.getMessage());
1819 } catch (Exception er
) {
1820 // All other errors are not recoverable, so delete the cached message
1821 cachedMessage
.delete();
1824 actions
= handleMessage(envelope
, content
, ignoreAttachments
);
1826 handler
.handleMessage(envelope
, content
, null);
1827 cachedMessage
.delete();
1831 public void receiveMessages(
1834 boolean returnOnTimeout
,
1835 boolean ignoreAttachments
,
1836 ReceiveMessageHandler handler
1837 ) throws IOException
{
1838 retryFailedReceivedMessages(handler
, ignoreAttachments
);
1840 Set
<HandleAction
> queuedActions
= new HashSet
<>();
1842 final var signalWebSocket
= dependencies
.getSignalWebSocket();
1843 signalWebSocket
.connect();
1845 var hasCaughtUpWithOldMessages
= false;
1847 while (!Thread
.interrupted()) {
1848 SignalServiceEnvelope envelope
;
1849 SignalServiceContent content
= null;
1850 Exception exception
= null;
1851 final CachedMessage
[] cachedMessage
= {null};
1852 account
.setLastReceiveTimestamp(System
.currentTimeMillis());
1853 logger
.debug("Checking for new message from server");
1855 var result
= signalWebSocket
.readOrEmpty(unit
.toMillis(timeout
), envelope1
-> {
1856 final var recipientId
= envelope1
.hasSource()
1857 ?
resolveRecipient(envelope1
.getSourceIdentifier())
1859 // store message on disk, before acknowledging receipt to the server
1860 cachedMessage
[0] = account
.getMessageCache().cacheMessage(envelope1
, recipientId
);
1862 logger
.debug("New message received from server");
1863 if (result
.isPresent()) {
1864 envelope
= result
.get();
1866 // Received indicator that server queue is empty
1867 hasCaughtUpWithOldMessages
= true;
1869 handleQueuedActions(queuedActions
);
1870 queuedActions
.clear();
1872 // Continue to wait another timeout for new messages
1875 } catch (AssertionError e
) {
1876 if (e
.getCause() instanceof InterruptedException
) {
1877 Thread
.currentThread().interrupt();
1882 } catch (WebSocketUnavailableException e
) {
1883 logger
.debug("Pipe unexpectedly unavailable, connecting");
1884 signalWebSocket
.connect();
1886 } catch (TimeoutException e
) {
1887 if (returnOnTimeout
) return;
1891 if (envelope
.hasSource()) {
1892 // Store uuid if we don't have it already
1893 // address/uuid in envelope is sent by server
1894 resolveRecipientTrusted(envelope
.getSourceAddress());
1896 if (!envelope
.isReceipt()) {
1898 content
= decryptMessage(envelope
);
1899 } catch (Exception e
) {
1902 if (!envelope
.hasSource() && content
!= null) {
1903 // Store uuid if we don't have it already
1904 // address/uuid is validated by unidentified sender certificate
1905 resolveRecipientTrusted(content
.getSender());
1907 var actions
= handleMessage(envelope
, content
, ignoreAttachments
);
1908 if (exception
instanceof ProtocolInvalidMessageException
) {
1909 final var sender
= resolveRecipient(((ProtocolInvalidMessageException
) exception
).getSender());
1910 logger
.debug("Received invalid message, queuing renew session action.");
1911 actions
.add(new RenewSessionAction(sender
));
1913 if (hasCaughtUpWithOldMessages
) {
1914 for (var action
: actions
) {
1916 action
.execute(this);
1917 } catch (Throwable e
) {
1918 if (e
instanceof AssertionError
&& e
.getCause() instanceof InterruptedException
) {
1919 Thread
.currentThread().interrupt();
1921 logger
.warn("Message action failed.", e
);
1925 queuedActions
.addAll(actions
);
1928 final var notAllowedToSendToGroup
= isNotAllowedToSendToGroup(envelope
, content
);
1929 if (isMessageBlocked(envelope
, content
)) {
1930 logger
.info("Ignoring a message from blocked user/group: {}", envelope
.getTimestamp());
1931 } else if (notAllowedToSendToGroup
) {
1932 logger
.info("Ignoring a group message from an unauthorized sender (no member or admin): {} {}",
1933 (envelope
.hasSource() ? envelope
.getSourceAddress() : content
.getSender()).getIdentifier(),
1934 envelope
.getTimestamp());
1936 handler
.handleMessage(envelope
, content
, exception
);
1938 if (cachedMessage
[0] != null) {
1939 if (exception
instanceof ProtocolUntrustedIdentityException
) {
1940 final var identifier
= ((ProtocolUntrustedIdentityException
) exception
).getSender();
1941 final var recipientId
= resolveRecipient(identifier
);
1942 queuedActions
.add(new RetrieveProfileAction(recipientId
));
1943 if (!envelope
.hasSource()) {
1945 cachedMessage
[0] = account
.getMessageCache().replaceSender(cachedMessage
[0], recipientId
);
1946 } catch (IOException ioException
) {
1947 logger
.warn("Failed to move cached message to recipient folder: {}",
1948 ioException
.getMessage());
1952 cachedMessage
[0].delete();
1956 handleQueuedActions(queuedActions
);
1959 private void handleQueuedActions(final Set
<HandleAction
> queuedActions
) {
1960 for (var action
: queuedActions
) {
1962 action
.execute(this);
1963 } catch (Throwable e
) {
1964 if (e
instanceof AssertionError
&& e
.getCause() instanceof InterruptedException
) {
1965 Thread
.currentThread().interrupt();
1967 logger
.warn("Message action failed.", e
);
1972 private boolean isMessageBlocked(
1973 SignalServiceEnvelope envelope
, SignalServiceContent content
1975 SignalServiceAddress source
;
1976 if (!envelope
.isUnidentifiedSender() && envelope
.hasSource()) {
1977 source
= envelope
.getSourceAddress();
1978 } else if (content
!= null) {
1979 source
= content
.getSender();
1983 final var recipientId
= resolveRecipient(source
);
1984 if (isContactBlocked(recipientId
)) {
1988 if (content
!= null && content
.getDataMessage().isPresent()) {
1989 var message
= content
.getDataMessage().get();
1990 if (message
.getGroupContext().isPresent()) {
1991 var groupId
= GroupUtils
.getGroupId(message
.getGroupContext().get());
1992 var group
= getGroup(groupId
);
1993 if (group
!= null && group
.isBlocked()) {
2001 public boolean isContactBlocked(final String identifier
) throws InvalidNumberException
{
2002 final var recipientId
= canonicalizeAndResolveRecipient(identifier
);
2003 return isContactBlocked(recipientId
);
2006 private boolean isContactBlocked(final RecipientId recipientId
) {
2007 var sourceContact
= account
.getContactStore().getContact(recipientId
);
2008 return sourceContact
!= null && sourceContact
.isBlocked();
2011 private boolean isNotAllowedToSendToGroup(
2012 SignalServiceEnvelope envelope
, SignalServiceContent content
2014 SignalServiceAddress source
;
2015 if (!envelope
.isUnidentifiedSender() && envelope
.hasSource()) {
2016 source
= envelope
.getSourceAddress();
2017 } else if (content
!= null) {
2018 source
= content
.getSender();
2023 if (content
== null || !content
.getDataMessage().isPresent()) {
2027 var message
= content
.getDataMessage().get();
2028 if (!message
.getGroupContext().isPresent()) {
2032 if (message
.getGroupContext().get().getGroupV1().isPresent()) {
2033 var groupInfo
= message
.getGroupContext().get().getGroupV1().get();
2034 if (groupInfo
.getType() == SignalServiceGroup
.Type
.QUIT
) {
2039 var groupId
= GroupUtils
.getGroupId(message
.getGroupContext().get());
2040 var group
= getGroup(groupId
);
2041 if (group
== null) {
2045 final var recipientId
= resolveRecipient(source
);
2046 return !group
.isMember(recipientId
) || (
2047 group
.isAnnouncementGroup() && !group
.isAdmin(recipientId
)
2051 private List
<HandleAction
> handleMessage(
2052 SignalServiceEnvelope envelope
, SignalServiceContent content
, boolean ignoreAttachments
2054 var actions
= new ArrayList
<HandleAction
>();
2055 if (content
!= null) {
2056 final SignalServiceAddress sender
;
2057 if (!envelope
.isUnidentifiedSender() && envelope
.hasSource()) {
2058 sender
= envelope
.getSourceAddress();
2060 sender
= content
.getSender();
2063 if (content
.getDataMessage().isPresent()) {
2064 var message
= content
.getDataMessage().get();
2066 if (content
.isNeedsReceipt()) {
2067 actions
.add(new SendReceiptAction(sender
, message
.getTimestamp()));
2070 actions
.addAll(handleSignalServiceDataMessage(message
,
2073 account
.getSelfAddress(),
2074 ignoreAttachments
));
2076 if (content
.getSyncMessage().isPresent()) {
2077 account
.setMultiDevice(true);
2078 var syncMessage
= content
.getSyncMessage().get();
2079 if (syncMessage
.getSent().isPresent()) {
2080 var message
= syncMessage
.getSent().get();
2081 final var destination
= message
.getDestination().orNull();
2082 actions
.addAll(handleSignalServiceDataMessage(message
.getMessage(),
2086 ignoreAttachments
));
2088 if (syncMessage
.getRequest().isPresent() && account
.isMasterDevice()) {
2089 var rm
= syncMessage
.getRequest().get();
2090 if (rm
.isContactsRequest()) {
2091 actions
.add(SendSyncContactsAction
.create());
2093 if (rm
.isGroupsRequest()) {
2094 actions
.add(SendSyncGroupsAction
.create());
2096 if (rm
.isBlockedListRequest()) {
2097 actions
.add(SendSyncBlockedListAction
.create());
2099 // TODO Handle rm.isConfigurationRequest(); rm.isKeysRequest();
2101 if (syncMessage
.getGroups().isPresent()) {
2102 File tmpFile
= null;
2104 tmpFile
= IOUtils
.createTempFile();
2105 final var groupsMessage
= syncMessage
.getGroups().get();
2106 try (var attachmentAsStream
= retrieveAttachmentAsStream(groupsMessage
.asPointer(), tmpFile
)) {
2107 var s
= new DeviceGroupsInputStream(attachmentAsStream
);
2112 } catch (IOException e
) {
2113 logger
.warn("Sync groups contained invalid group, ignoring: {}", e
.getMessage());
2119 var syncGroup
= account
.getGroupStore().getOrCreateGroupV1(GroupId
.v1(g
.getId()));
2120 if (syncGroup
!= null) {
2121 if (g
.getName().isPresent()) {
2122 syncGroup
.name
= g
.getName().get();
2124 syncGroup
.addMembers(g
.getMembers()
2126 .map(this::resolveRecipient
)
2127 .collect(Collectors
.toSet()));
2128 if (!g
.isActive()) {
2129 syncGroup
.removeMember(account
.getSelfRecipientId());
2131 // Add ourself to the member set as it's marked as active
2132 syncGroup
.addMembers(List
.of(account
.getSelfRecipientId()));
2134 syncGroup
.blocked
= g
.isBlocked();
2135 if (g
.getColor().isPresent()) {
2136 syncGroup
.color
= g
.getColor().get();
2139 if (g
.getAvatar().isPresent()) {
2140 downloadGroupAvatar(g
.getAvatar().get(), syncGroup
.getGroupId());
2142 syncGroup
.archived
= g
.isArchived();
2143 account
.getGroupStore().updateGroup(syncGroup
);
2147 } catch (Exception e
) {
2148 logger
.warn("Failed to handle received sync groups “{}”, ignoring: {}",
2152 if (tmpFile
!= null) {
2154 Files
.delete(tmpFile
.toPath());
2155 } catch (IOException e
) {
2156 logger
.warn("Failed to delete received groups temp file “{}”, ignoring: {}",
2163 if (syncMessage
.getBlockedList().isPresent()) {
2164 final var blockedListMessage
= syncMessage
.getBlockedList().get();
2165 for (var address
: blockedListMessage
.getAddresses()) {
2166 setContactBlocked(resolveRecipient(address
), true);
2168 for (var groupId
: blockedListMessage
.getGroupIds()
2170 .map(GroupId
::unknownVersion
)
2171 .collect(Collectors
.toSet())) {
2173 setGroupBlocked(groupId
, true);
2174 } catch (GroupNotFoundException e
) {
2175 logger
.warn("BlockedListMessage contained groupID that was not found in GroupStore: {}",
2176 groupId
.toBase64());
2180 if (syncMessage
.getContacts().isPresent()) {
2181 File tmpFile
= null;
2183 tmpFile
= IOUtils
.createTempFile();
2184 final var contactsMessage
= syncMessage
.getContacts().get();
2185 try (var attachmentAsStream
= retrieveAttachmentAsStream(contactsMessage
.getContactsStream()
2186 .asPointer(), tmpFile
)) {
2187 var s
= new DeviceContactsInputStream(attachmentAsStream
);
2192 } catch (IOException e
) {
2193 logger
.warn("Sync contacts contained invalid contact, ignoring: {}",
2200 if (c
.getAddress().matches(account
.getSelfAddress()) && c
.getProfileKey().isPresent()) {
2201 account
.setProfileKey(c
.getProfileKey().get());
2203 final var recipientId
= resolveRecipientTrusted(c
.getAddress());
2204 var contact
= account
.getContactStore().getContact(recipientId
);
2205 final var builder
= contact
== null
2206 ? Contact
.newBuilder()
2207 : Contact
.newBuilder(contact
);
2208 if (c
.getName().isPresent()) {
2209 builder
.withName(c
.getName().get());
2211 if (c
.getColor().isPresent()) {
2212 builder
.withColor(c
.getColor().get());
2214 if (c
.getProfileKey().isPresent()) {
2215 account
.getProfileStore().storeProfileKey(recipientId
, c
.getProfileKey().get());
2217 if (c
.getVerified().isPresent()) {
2218 final var verifiedMessage
= c
.getVerified().get();
2219 account
.getIdentityKeyStore()
2220 .setIdentityTrustLevel(resolveRecipientTrusted(verifiedMessage
.getDestination()),
2221 verifiedMessage
.getIdentityKey(),
2222 TrustLevel
.fromVerifiedState(verifiedMessage
.getVerified()));
2224 if (c
.getExpirationTimer().isPresent()) {
2225 builder
.withMessageExpirationTime(c
.getExpirationTimer().get());
2227 builder
.withBlocked(c
.isBlocked());
2228 builder
.withArchived(c
.isArchived());
2229 account
.getContactStore().storeContact(recipientId
, builder
.build());
2231 if (c
.getAvatar().isPresent()) {
2232 downloadContactAvatar(c
.getAvatar().get(), c
.getAddress());
2236 } catch (Exception e
) {
2237 logger
.warn("Failed to handle received sync contacts “{}”, ignoring: {}",
2241 if (tmpFile
!= null) {
2243 Files
.delete(tmpFile
.toPath());
2244 } catch (IOException e
) {
2245 logger
.warn("Failed to delete received contacts temp file “{}”, ignoring: {}",
2252 if (syncMessage
.getVerified().isPresent()) {
2253 final var verifiedMessage
= syncMessage
.getVerified().get();
2254 account
.getIdentityKeyStore()
2255 .setIdentityTrustLevel(resolveRecipientTrusted(verifiedMessage
.getDestination()),
2256 verifiedMessage
.getIdentityKey(),
2257 TrustLevel
.fromVerifiedState(verifiedMessage
.getVerified()));
2259 if (syncMessage
.getStickerPackOperations().isPresent()) {
2260 final var stickerPackOperationMessages
= syncMessage
.getStickerPackOperations().get();
2261 for (var m
: stickerPackOperationMessages
) {
2262 if (!m
.getPackId().isPresent()) {
2265 final var stickerPackId
= StickerPackId
.deserialize(m
.getPackId().get());
2266 final var installed
= !m
.getType().isPresent()
2267 || m
.getType().get() == StickerPackOperationMessage
.Type
.INSTALL
;
2269 var sticker
= account
.getStickerStore().getSticker(stickerPackId
);
2270 if (m
.getPackKey().isPresent()) {
2271 if (sticker
== null) {
2272 sticker
= new Sticker(stickerPackId
, m
.getPackKey().get());
2275 enqueueJob(new RetrieveStickerPackJob(stickerPackId
, m
.getPackKey().get()));
2279 if (sticker
!= null) {
2280 sticker
.setInstalled(installed
);
2281 account
.getStickerStore().updateSticker(sticker
);
2285 if (syncMessage
.getFetchType().isPresent()) {
2286 switch (syncMessage
.getFetchType().get()) {
2288 getRecipientProfile(account
.getSelfRecipientId(), true);
2289 case STORAGE_MANIFEST
:
2293 if (syncMessage
.getKeys().isPresent()) {
2294 final var keysMessage
= syncMessage
.getKeys().get();
2295 if (keysMessage
.getStorageService().isPresent()) {
2296 final var storageKey
= keysMessage
.getStorageService().get();
2297 account
.setStorageKey(storageKey
);
2300 if (syncMessage
.getConfiguration().isPresent()) {
2308 private void downloadContactAvatar(SignalServiceAttachment avatar
, SignalServiceAddress address
) {
2310 avatarStore
.storeContactAvatar(address
, outputStream
-> retrieveAttachment(avatar
, outputStream
));
2311 } catch (IOException e
) {
2312 logger
.warn("Failed to download avatar for contact {}, ignoring: {}", address
, e
.getMessage());
2316 private void downloadGroupAvatar(SignalServiceAttachment avatar
, GroupId groupId
) {
2318 avatarStore
.storeGroupAvatar(groupId
, outputStream
-> retrieveAttachment(avatar
, outputStream
));
2319 } catch (IOException e
) {
2320 logger
.warn("Failed to download avatar for group {}, ignoring: {}", groupId
.toBase64(), e
.getMessage());
2324 private void downloadGroupAvatar(GroupId groupId
, GroupSecretParams groupSecretParams
, String cdnKey
) {
2326 avatarStore
.storeGroupAvatar(groupId
,
2327 outputStream
-> retrieveGroupV2Avatar(groupSecretParams
, cdnKey
, outputStream
));
2328 } catch (IOException e
) {
2329 logger
.warn("Failed to download avatar for group {}, ignoring: {}", groupId
.toBase64(), e
.getMessage());
2333 private void downloadProfileAvatar(
2334 SignalServiceAddress address
, String avatarPath
, ProfileKey profileKey
2337 avatarStore
.storeProfileAvatar(address
,
2338 outputStream
-> retrieveProfileAvatar(avatarPath
, profileKey
, outputStream
));
2339 } catch (Throwable e
) {
2340 if (e
instanceof AssertionError
&& e
.getCause() instanceof InterruptedException
) {
2341 Thread
.currentThread().interrupt();
2343 logger
.warn("Failed to download profile avatar, ignoring: {}", e
.getMessage());
2347 public File
getAttachmentFile(SignalServiceAttachmentRemoteId attachmentId
) {
2348 return attachmentStore
.getAttachmentFile(attachmentId
);
2351 private void downloadAttachment(final SignalServiceAttachment attachment
) {
2352 if (!attachment
.isPointer()) {
2353 logger
.warn("Invalid state, can't store an attachment stream.");
2356 var pointer
= attachment
.asPointer();
2357 if (pointer
.getPreview().isPresent()) {
2358 final var preview
= pointer
.getPreview().get();
2360 attachmentStore
.storeAttachmentPreview(pointer
.getRemoteId(),
2361 outputStream
-> outputStream
.write(preview
, 0, preview
.length
));
2362 } catch (IOException e
) {
2363 logger
.warn("Failed to download attachment preview, ignoring: {}", e
.getMessage());
2368 attachmentStore
.storeAttachment(pointer
.getRemoteId(),
2369 outputStream
-> retrieveAttachmentPointer(pointer
, outputStream
));
2370 } catch (IOException e
) {
2371 logger
.warn("Failed to download attachment ({}), ignoring: {}", pointer
.getRemoteId(), e
.getMessage());
2375 private void retrieveGroupV2Avatar(
2376 GroupSecretParams groupSecretParams
, String cdnKey
, OutputStream outputStream
2377 ) throws IOException
{
2378 var groupOperations
= dependencies
.getGroupsV2Operations().forGroup(groupSecretParams
);
2380 var tmpFile
= IOUtils
.createTempFile();
2381 try (InputStream input
= dependencies
.getMessageReceiver()
2382 .retrieveGroupsV2ProfileAvatar(cdnKey
, tmpFile
, ServiceConfig
.AVATAR_DOWNLOAD_FAILSAFE_MAX_SIZE
)) {
2383 var encryptedData
= IOUtils
.readFully(input
);
2385 var decryptedData
= groupOperations
.decryptAvatar(encryptedData
);
2386 outputStream
.write(decryptedData
);
2389 Files
.delete(tmpFile
.toPath());
2390 } catch (IOException e
) {
2391 logger
.warn("Failed to delete received group avatar temp file “{}”, ignoring: {}",
2398 private void retrieveProfileAvatar(
2399 String avatarPath
, ProfileKey profileKey
, OutputStream outputStream
2400 ) throws IOException
{
2401 var tmpFile
= IOUtils
.createTempFile();
2402 try (var input
= dependencies
.getMessageReceiver()
2403 .retrieveProfileAvatar(avatarPath
,
2406 ServiceConfig
.AVATAR_DOWNLOAD_FAILSAFE_MAX_SIZE
)) {
2407 // Use larger buffer size to prevent AssertionError: Need: 12272 but only have: 8192 ...
2408 IOUtils
.copyStream(input
, outputStream
, (int) ServiceConfig
.AVATAR_DOWNLOAD_FAILSAFE_MAX_SIZE
);
2411 Files
.delete(tmpFile
.toPath());
2412 } catch (IOException e
) {
2413 logger
.warn("Failed to delete received profile avatar temp file “{}”, ignoring: {}",
2420 private void retrieveAttachment(
2421 final SignalServiceAttachment attachment
, final OutputStream outputStream
2422 ) throws IOException
{
2423 if (attachment
.isPointer()) {
2424 var pointer
= attachment
.asPointer();
2425 retrieveAttachmentPointer(pointer
, outputStream
);
2427 var stream
= attachment
.asStream();
2428 IOUtils
.copyStream(stream
.getInputStream(), outputStream
);
2432 private void retrieveAttachmentPointer(
2433 SignalServiceAttachmentPointer pointer
, OutputStream outputStream
2434 ) throws IOException
{
2435 var tmpFile
= IOUtils
.createTempFile();
2436 try (var input
= retrieveAttachmentAsStream(pointer
, tmpFile
)) {
2437 IOUtils
.copyStream(input
, outputStream
);
2438 } catch (MissingConfigurationException
| InvalidMessageException e
) {
2439 throw new IOException(e
);
2442 Files
.delete(tmpFile
.toPath());
2443 } catch (IOException e
) {
2444 logger
.warn("Failed to delete received attachment temp file “{}”, ignoring: {}",
2451 private InputStream
retrieveAttachmentAsStream(
2452 SignalServiceAttachmentPointer pointer
, File tmpFile
2453 ) throws IOException
, InvalidMessageException
, MissingConfigurationException
{
2454 return dependencies
.getMessageReceiver()
2455 .retrieveAttachment(pointer
, tmpFile
, ServiceConfig
.MAX_ATTACHMENT_SIZE
);
2458 void sendGroups() throws IOException
{
2459 var groupsFile
= IOUtils
.createTempFile();
2462 try (OutputStream fos
= new FileOutputStream(groupsFile
)) {
2463 var out
= new DeviceGroupsOutputStream(fos
);
2464 for (var record : getGroups()) {
2465 if (record instanceof GroupInfoV1
) {
2466 var groupInfo
= (GroupInfoV1
) record;
2467 out
.write(new DeviceGroup(groupInfo
.getGroupId().serialize(),
2468 Optional
.fromNullable(groupInfo
.name
),
2469 groupInfo
.getMembers()
2471 .map(this::resolveSignalServiceAddress
)
2472 .collect(Collectors
.toList()),
2473 createGroupAvatarAttachment(groupInfo
.getGroupId()),
2474 groupInfo
.isMember(account
.getSelfRecipientId()),
2475 Optional
.of(groupInfo
.messageExpirationTime
),
2476 Optional
.fromNullable(groupInfo
.color
),
2479 groupInfo
.archived
));
2484 if (groupsFile
.exists() && groupsFile
.length() > 0) {
2485 try (var groupsFileStream
= new FileInputStream(groupsFile
)) {
2486 var attachmentStream
= SignalServiceAttachment
.newStreamBuilder()
2487 .withStream(groupsFileStream
)
2488 .withContentType("application/octet-stream")
2489 .withLength(groupsFile
.length())
2492 sendHelper
.sendSyncMessage(SignalServiceSyncMessage
.forGroups(attachmentStream
));
2497 Files
.delete(groupsFile
.toPath());
2498 } catch (IOException e
) {
2499 logger
.warn("Failed to delete groups temp file “{}”, ignoring: {}", groupsFile
, e
.getMessage());
2504 public void sendContacts() throws IOException
{
2505 var contactsFile
= IOUtils
.createTempFile();
2508 try (OutputStream fos
= new FileOutputStream(contactsFile
)) {
2509 var out
= new DeviceContactsOutputStream(fos
);
2510 for (var contactPair
: account
.getContactStore().getContacts()) {
2511 final var recipientId
= contactPair
.first();
2512 final var contact
= contactPair
.second();
2513 final var address
= resolveSignalServiceAddress(recipientId
);
2515 var currentIdentity
= account
.getIdentityKeyStore().getIdentity(recipientId
);
2516 VerifiedMessage verifiedMessage
= null;
2517 if (currentIdentity
!= null) {
2518 verifiedMessage
= new VerifiedMessage(address
,
2519 currentIdentity
.getIdentityKey(),
2520 currentIdentity
.getTrustLevel().toVerifiedState(),
2521 currentIdentity
.getDateAdded().getTime());
2524 var profileKey
= account
.getProfileStore().getProfileKey(recipientId
);
2525 out
.write(new DeviceContact(address
,
2526 Optional
.fromNullable(contact
.getName()),
2527 createContactAvatarAttachment(address
),
2528 Optional
.fromNullable(contact
.getColor()),
2529 Optional
.fromNullable(verifiedMessage
),
2530 Optional
.fromNullable(profileKey
),
2531 contact
.isBlocked(),
2532 Optional
.of(contact
.getMessageExpirationTime()),
2534 contact
.isArchived()));
2537 if (account
.getProfileKey() != null) {
2538 // Send our own profile key as well
2539 out
.write(new DeviceContact(account
.getSelfAddress(),
2544 Optional
.of(account
.getProfileKey()),
2552 if (contactsFile
.exists() && contactsFile
.length() > 0) {
2553 try (var contactsFileStream
= new FileInputStream(contactsFile
)) {
2554 var attachmentStream
= SignalServiceAttachment
.newStreamBuilder()
2555 .withStream(contactsFileStream
)
2556 .withContentType("application/octet-stream")
2557 .withLength(contactsFile
.length())
2560 sendHelper
.sendSyncMessage(SignalServiceSyncMessage
.forContacts(new ContactsMessage(attachmentStream
,
2566 Files
.delete(contactsFile
.toPath());
2567 } catch (IOException e
) {
2568 logger
.warn("Failed to delete contacts temp file “{}”, ignoring: {}", contactsFile
, e
.getMessage());
2573 void sendBlockedList() throws IOException
{
2574 var addresses
= new ArrayList
<SignalServiceAddress
>();
2575 for (var record : account
.getContactStore().getContacts()) {
2576 if (record.second().isBlocked()) {
2577 addresses
.add(resolveSignalServiceAddress(record.first()));
2580 var groupIds
= new ArrayList
<byte[]>();
2581 for (var record : getGroups()) {
2582 if (record.isBlocked()) {
2583 groupIds
.add(record.getGroupId().serialize());
2586 sendHelper
.sendSyncMessage(SignalServiceSyncMessage
.forBlocked(new BlockedListMessage(addresses
, groupIds
)));
2589 private void sendVerifiedMessage(
2590 SignalServiceAddress destination
, IdentityKey identityKey
, TrustLevel trustLevel
2591 ) throws IOException
{
2592 var verifiedMessage
= new VerifiedMessage(destination
,
2594 trustLevel
.toVerifiedState(),
2595 System
.currentTimeMillis());
2596 sendHelper
.sendSyncMessage(SignalServiceSyncMessage
.forVerified(verifiedMessage
));
2599 public List
<Pair
<RecipientId
, Contact
>> getContacts() {
2600 return account
.getContactStore().getContacts();
2603 public String
getContactOrProfileName(String number
) throws InvalidNumberException
{
2604 final var recipientId
= canonicalizeAndResolveRecipient(number
);
2605 final var recipient
= account
.getRecipientStore().getRecipient(recipientId
);
2606 if (recipient
== null) {
2610 if (recipient
.getContact() != null && !Util
.isEmpty(recipient
.getContact().getName())) {
2611 return recipient
.getContact().getName();
2614 if (recipient
.getProfile() != null && recipient
.getProfile() != null) {
2615 return recipient
.getProfile().getDisplayName();
2621 public GroupInfo
getGroup(GroupId groupId
) {
2622 return getGroup(groupId
, false);
2625 public GroupInfo
getGroup(GroupId groupId
, boolean forceUpdate
) {
2626 final var group
= account
.getGroupStore().getGroup(groupId
);
2627 if (group
instanceof GroupInfoV2
&& (forceUpdate
|| ((GroupInfoV2
) group
).getGroup() == null)) {
2628 final var groupSecretParams
= GroupSecretParams
.deriveFromMasterKey(((GroupInfoV2
) group
).getMasterKey());
2629 ((GroupInfoV2
) group
).setGroup(groupV2Helper
.getDecryptedGroup(groupSecretParams
), this::resolveRecipient
);
2630 account
.getGroupStore().updateGroup(group
);
2635 public List
<IdentityInfo
> getIdentities() {
2636 return account
.getIdentityKeyStore().getIdentities();
2639 public List
<IdentityInfo
> getIdentities(String number
) throws InvalidNumberException
{
2640 final var identity
= account
.getIdentityKeyStore().getIdentity(canonicalizeAndResolveRecipient(number
));
2641 return identity
== null ? List
.of() : List
.of(identity
);
2645 * Trust this the identity with this fingerprint
2647 * @param name username of the identity
2648 * @param fingerprint Fingerprint
2650 public boolean trustIdentityVerified(String name
, byte[] fingerprint
) throws InvalidNumberException
{
2651 var recipientId
= canonicalizeAndResolveRecipient(name
);
2652 return trustIdentity(recipientId
,
2653 identityKey
-> Arrays
.equals(identityKey
.serialize(), fingerprint
),
2654 TrustLevel
.TRUSTED_VERIFIED
);
2658 * Trust this the identity with this safety number
2660 * @param name username of the identity
2661 * @param safetyNumber Safety number
2663 public boolean trustIdentityVerifiedSafetyNumber(String name
, String safetyNumber
) throws InvalidNumberException
{
2664 var recipientId
= canonicalizeAndResolveRecipient(name
);
2665 var address
= account
.getRecipientStore().resolveServiceAddress(recipientId
);
2666 return trustIdentity(recipientId
,
2667 identityKey
-> safetyNumber
.equals(computeSafetyNumber(address
, identityKey
)),
2668 TrustLevel
.TRUSTED_VERIFIED
);
2672 * Trust this the identity with this scannable safety number
2674 * @param name username of the identity
2675 * @param safetyNumber Scannable safety number
2677 public boolean trustIdentityVerifiedSafetyNumber(String name
, byte[] safetyNumber
) throws InvalidNumberException
{
2678 var recipientId
= canonicalizeAndResolveRecipient(name
);
2679 var address
= account
.getRecipientStore().resolveServiceAddress(recipientId
);
2680 return trustIdentity(recipientId
, identityKey
-> {
2681 final var fingerprint
= computeSafetyNumberFingerprint(address
, identityKey
);
2683 return fingerprint
!= null && fingerprint
.getScannableFingerprint().compareTo(safetyNumber
);
2684 } catch (FingerprintVersionMismatchException
| FingerprintParsingException e
) {
2687 }, TrustLevel
.TRUSTED_VERIFIED
);
2691 * Trust all keys of this identity without verification
2693 * @param name username of the identity
2695 public boolean trustIdentityAllKeys(String name
) throws InvalidNumberException
{
2696 var recipientId
= canonicalizeAndResolveRecipient(name
);
2697 return trustIdentity(recipientId
, identityKey
-> true, TrustLevel
.TRUSTED_UNVERIFIED
);
2700 private boolean trustIdentity(
2701 RecipientId recipientId
, Function
<IdentityKey
, Boolean
> verifier
, TrustLevel trustLevel
2703 var identity
= account
.getIdentityKeyStore().getIdentity(recipientId
);
2704 if (identity
== null) {
2708 if (!verifier
.apply(identity
.getIdentityKey())) {
2712 account
.getIdentityKeyStore().setIdentityTrustLevel(recipientId
, identity
.getIdentityKey(), trustLevel
);
2714 var address
= account
.getRecipientStore().resolveServiceAddress(recipientId
);
2715 sendVerifiedMessage(address
, identity
.getIdentityKey(), trustLevel
);
2716 } catch (IOException e
) {
2717 logger
.warn("Failed to send verification sync message: {}", e
.getMessage());
2723 private void handleIdentityFailure(
2724 final RecipientId recipientId
, final SendMessageResult
.IdentityFailure identityFailure
2726 final var identityKey
= identityFailure
.getIdentityKey();
2727 if (identityKey
!= null) {
2728 final var newIdentity
= account
.getIdentityKeyStore().saveIdentity(recipientId
, identityKey
, new Date());
2730 account
.getSessionStore().archiveSessions(recipientId
);
2733 // Retrieve profile to get the current identity key from the server
2734 retrieveEncryptedProfile(recipientId
);
2738 public String
computeSafetyNumber(SignalServiceAddress theirAddress
, IdentityKey theirIdentityKey
) {
2739 final Fingerprint fingerprint
= computeSafetyNumberFingerprint(theirAddress
, theirIdentityKey
);
2740 return fingerprint
== null ?
null : fingerprint
.getDisplayableFingerprint().getDisplayText();
2743 public byte[] computeSafetyNumberForScanning(SignalServiceAddress theirAddress
, IdentityKey theirIdentityKey
) {
2744 final Fingerprint fingerprint
= computeSafetyNumberFingerprint(theirAddress
, theirIdentityKey
);
2745 return fingerprint
== null ?
null : fingerprint
.getScannableFingerprint().getSerialized();
2748 private Fingerprint
computeSafetyNumberFingerprint(
2749 final SignalServiceAddress theirAddress
, final IdentityKey theirIdentityKey
2751 return Utils
.computeSafetyNumber(capabilities
.isUuid(),
2752 account
.getSelfAddress(),
2753 getIdentityKeyPair().getPublicKey(),
2759 public SignalServiceAddress
resolveSignalServiceAddress(String identifier
) {
2760 var address
= Utils
.getSignalServiceAddressFromIdentifier(identifier
);
2762 return resolveSignalServiceAddress(address
);
2766 public SignalServiceAddress
resolveSignalServiceAddress(SignalServiceAddress address
) {
2767 if (address
.matches(account
.getSelfAddress())) {
2768 return account
.getSelfAddress();
2771 return account
.getRecipientStore().resolveServiceAddress(address
);
2774 public SignalServiceAddress
resolveSignalServiceAddress(RecipientId recipientId
) {
2775 return account
.getRecipientStore().resolveServiceAddress(recipientId
);
2778 private RecipientId
canonicalizeAndResolveRecipient(String identifier
) throws InvalidNumberException
{
2779 var canonicalizedNumber
= UuidUtil
.isUuid(identifier
) ? identifier
: canonicalizePhoneNumber(identifier
);
2781 return resolveRecipient(canonicalizedNumber
);
2784 private String
canonicalizePhoneNumber(final String number
) throws InvalidNumberException
{
2785 return PhoneNumberFormatter
.formatNumber(number
, account
.getUsername());
2788 private RecipientId
resolveRecipient(final String identifier
) {
2789 var address
= Utils
.getSignalServiceAddressFromIdentifier(identifier
);
2791 return resolveRecipient(address
);
2794 public RecipientId
resolveRecipient(SignalServiceAddress address
) {
2795 return account
.getRecipientStore().resolveRecipient(address
);
2798 private RecipientId
resolveRecipientTrusted(SignalServiceAddress address
) {
2799 return account
.getRecipientStore().resolveRecipientTrusted(address
);
2802 private void enqueueJob(Job job
) {
2803 var context
= new Context(account
,
2804 dependencies
.getAccountManager(),
2805 dependencies
.getMessageReceiver(),
2811 public void close() throws IOException
{
2815 void close(boolean closeAccount
) throws IOException
{
2816 executor
.shutdown();
2818 dependencies
.getSignalWebSocket().disconnect();
2820 if (closeAccount
&& account
!= null) {
2826 public interface ReceiveMessageHandler
{
2828 void handleMessage(SignalServiceEnvelope envelope
, SignalServiceContent decryptedContent
, Throwable e
);