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
.config
.ServiceConfig
;
21 import org
.asamk
.signal
.manager
.config
.ServiceEnvironment
;
22 import org
.asamk
.signal
.manager
.config
.ServiceEnvironmentConfig
;
23 import org
.asamk
.signal
.manager
.groups
.GroupId
;
24 import org
.asamk
.signal
.manager
.groups
.GroupIdV1
;
25 import org
.asamk
.signal
.manager
.groups
.GroupInviteLinkUrl
;
26 import org
.asamk
.signal
.manager
.groups
.GroupNotFoundException
;
27 import org
.asamk
.signal
.manager
.groups
.GroupUtils
;
28 import org
.asamk
.signal
.manager
.groups
.NotAGroupMemberException
;
29 import org
.asamk
.signal
.manager
.helper
.GroupHelper
;
30 import org
.asamk
.signal
.manager
.helper
.PinHelper
;
31 import org
.asamk
.signal
.manager
.helper
.ProfileHelper
;
32 import org
.asamk
.signal
.manager
.helper
.UnidentifiedAccessHelper
;
33 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
34 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfo
;
35 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfoV1
;
36 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfoV2
;
37 import org
.asamk
.signal
.manager
.storage
.identities
.IdentityInfo
;
38 import org
.asamk
.signal
.manager
.storage
.messageCache
.CachedMessage
;
39 import org
.asamk
.signal
.manager
.storage
.recipients
.Contact
;
40 import org
.asamk
.signal
.manager
.storage
.recipients
.Profile
;
41 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
42 import org
.asamk
.signal
.manager
.storage
.stickers
.Sticker
;
43 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPackId
;
44 import org
.asamk
.signal
.manager
.util
.AttachmentUtils
;
45 import org
.asamk
.signal
.manager
.util
.IOUtils
;
46 import org
.asamk
.signal
.manager
.util
.KeyUtils
;
47 import org
.asamk
.signal
.manager
.util
.ProfileUtils
;
48 import org
.asamk
.signal
.manager
.util
.StickerUtils
;
49 import org
.asamk
.signal
.manager
.util
.Utils
;
50 import org
.signal
.libsignal
.metadata
.InvalidMetadataMessageException
;
51 import org
.signal
.libsignal
.metadata
.InvalidMetadataVersionException
;
52 import org
.signal
.libsignal
.metadata
.ProtocolDuplicateMessageException
;
53 import org
.signal
.libsignal
.metadata
.ProtocolInvalidKeyException
;
54 import org
.signal
.libsignal
.metadata
.ProtocolInvalidKeyIdException
;
55 import org
.signal
.libsignal
.metadata
.ProtocolInvalidMessageException
;
56 import org
.signal
.libsignal
.metadata
.ProtocolInvalidVersionException
;
57 import org
.signal
.libsignal
.metadata
.ProtocolLegacyMessageException
;
58 import org
.signal
.libsignal
.metadata
.ProtocolNoSessionException
;
59 import org
.signal
.libsignal
.metadata
.ProtocolUntrustedIdentityException
;
60 import org
.signal
.libsignal
.metadata
.SelfSendException
;
61 import org
.signal
.libsignal
.metadata
.certificate
.CertificateValidator
;
62 import org
.signal
.storageservice
.protos
.groups
.GroupChange
;
63 import org
.signal
.storageservice
.protos
.groups
.local
.DecryptedGroup
;
64 import org
.signal
.zkgroup
.InvalidInputException
;
65 import org
.signal
.zkgroup
.VerificationFailedException
;
66 import org
.signal
.zkgroup
.groups
.GroupMasterKey
;
67 import org
.signal
.zkgroup
.groups
.GroupSecretParams
;
68 import org
.signal
.zkgroup
.profiles
.ClientZkProfileOperations
;
69 import org
.signal
.zkgroup
.profiles
.ProfileKey
;
70 import org
.signal
.zkgroup
.profiles
.ProfileKeyCredential
;
71 import org
.slf4j
.Logger
;
72 import org
.slf4j
.LoggerFactory
;
73 import org
.whispersystems
.libsignal
.IdentityKey
;
74 import org
.whispersystems
.libsignal
.IdentityKeyPair
;
75 import org
.whispersystems
.libsignal
.InvalidKeyException
;
76 import org
.whispersystems
.libsignal
.InvalidMessageException
;
77 import org
.whispersystems
.libsignal
.ecc
.ECPublicKey
;
78 import org
.whispersystems
.libsignal
.state
.PreKeyRecord
;
79 import org
.whispersystems
.libsignal
.state
.SignedPreKeyRecord
;
80 import org
.whispersystems
.libsignal
.util
.Pair
;
81 import org
.whispersystems
.libsignal
.util
.guava
.Optional
;
82 import org
.whispersystems
.signalservice
.api
.SignalServiceAccountManager
;
83 import org
.whispersystems
.signalservice
.api
.SignalServiceMessagePipe
;
84 import org
.whispersystems
.signalservice
.api
.SignalServiceMessageReceiver
;
85 import org
.whispersystems
.signalservice
.api
.SignalServiceMessageSender
;
86 import org
.whispersystems
.signalservice
.api
.crypto
.SignalServiceCipher
;
87 import org
.whispersystems
.signalservice
.api
.crypto
.UntrustedIdentityException
;
88 import org
.whispersystems
.signalservice
.api
.groupsv2
.ClientZkOperations
;
89 import org
.whispersystems
.signalservice
.api
.groupsv2
.GroupLinkNotActiveException
;
90 import org
.whispersystems
.signalservice
.api
.groupsv2
.GroupsV2Api
;
91 import org
.whispersystems
.signalservice
.api
.groupsv2
.GroupsV2AuthorizationString
;
92 import org
.whispersystems
.signalservice
.api
.groupsv2
.GroupsV2Operations
;
93 import org
.whispersystems
.signalservice
.api
.messages
.SendMessageResult
;
94 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachment
;
95 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachmentPointer
;
96 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachmentRemoteId
;
97 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceAttachmentStream
;
98 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceContent
;
99 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
100 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceEnvelope
;
101 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceGroup
;
102 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceGroupV2
;
103 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceReceiptMessage
;
104 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.BlockedListMessage
;
105 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.ContactsMessage
;
106 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceContact
;
107 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceContactsInputStream
;
108 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceContactsOutputStream
;
109 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceGroup
;
110 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceGroupsInputStream
;
111 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.DeviceGroupsOutputStream
;
112 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.RequestMessage
;
113 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.SentTranscriptMessage
;
114 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.SignalServiceSyncMessage
;
115 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.StickerPackOperationMessage
;
116 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.VerifiedMessage
;
117 import org
.whispersystems
.signalservice
.api
.profiles
.ProfileAndCredential
;
118 import org
.whispersystems
.signalservice
.api
.profiles
.SignalServiceProfile
;
119 import org
.whispersystems
.signalservice
.api
.push
.SignalServiceAddress
;
120 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.MissingConfigurationException
;
121 import org
.whispersystems
.signalservice
.api
.push
.exceptions
.UnregisteredUserException
;
122 import org
.whispersystems
.signalservice
.api
.util
.DeviceNameUtil
;
123 import org
.whispersystems
.signalservice
.api
.util
.InvalidNumberException
;
124 import org
.whispersystems
.signalservice
.api
.util
.PhoneNumberFormatter
;
125 import org
.whispersystems
.signalservice
.api
.util
.SleepTimer
;
126 import org
.whispersystems
.signalservice
.api
.util
.UptimeSleepTimer
;
127 import org
.whispersystems
.signalservice
.api
.util
.UuidUtil
;
128 import org
.whispersystems
.signalservice
.internal
.contacts
.crypto
.Quote
;
129 import org
.whispersystems
.signalservice
.internal
.contacts
.crypto
.UnauthenticatedQuoteException
;
130 import org
.whispersystems
.signalservice
.internal
.contacts
.crypto
.UnauthenticatedResponseException
;
131 import org
.whispersystems
.signalservice
.internal
.push
.SignalServiceProtos
;
132 import org
.whispersystems
.signalservice
.internal
.push
.UnsupportedDataMessageException
;
133 import org
.whispersystems
.signalservice
.internal
.util
.DynamicCredentialsProvider
;
134 import org
.whispersystems
.signalservice
.internal
.util
.Hex
;
135 import org
.whispersystems
.signalservice
.internal
.util
.Util
;
137 import java
.io
.Closeable
;
139 import java
.io
.FileInputStream
;
140 import java
.io
.FileOutputStream
;
141 import java
.io
.IOException
;
142 import java
.io
.InputStream
;
143 import java
.io
.OutputStream
;
145 import java
.net
.URISyntaxException
;
146 import java
.net
.URLEncoder
;
147 import java
.nio
.charset
.StandardCharsets
;
148 import java
.nio
.file
.Files
;
149 import java
.security
.SignatureException
;
150 import java
.util
.ArrayList
;
151 import java
.util
.Arrays
;
152 import java
.util
.Base64
;
153 import java
.util
.Collection
;
154 import java
.util
.Date
;
155 import java
.util
.HashSet
;
156 import java
.util
.List
;
157 import java
.util
.Map
;
158 import java
.util
.Set
;
159 import java
.util
.UUID
;
160 import java
.util
.concurrent
.ExecutorService
;
161 import java
.util
.concurrent
.Executors
;
162 import java
.util
.concurrent
.TimeUnit
;
163 import java
.util
.concurrent
.TimeoutException
;
164 import java
.util
.function
.Function
;
165 import java
.util
.stream
.Collectors
;
167 import static org
.asamk
.signal
.manager
.config
.ServiceConfig
.capabilities
;
169 public class Manager
implements Closeable
{
171 private final static Logger logger
= LoggerFactory
.getLogger(Manager
.class);
173 private final CertificateValidator certificateValidator
;
175 private final ServiceEnvironmentConfig serviceEnvironmentConfig
;
176 private final String userAgent
;
178 private SignalAccount account
;
179 private final SignalServiceAccountManager accountManager
;
180 private final GroupsV2Api groupsV2Api
;
181 private final GroupsV2Operations groupsV2Operations
;
182 private final SignalServiceMessageReceiver messageReceiver
;
183 private final ClientZkProfileOperations clientZkProfileOperations
;
185 private final ExecutorService executor
= Executors
.newCachedThreadPool();
187 private SignalServiceMessagePipe messagePipe
= null;
188 private SignalServiceMessagePipe unidentifiedMessagePipe
= null;
190 private final UnidentifiedAccessHelper unidentifiedAccessHelper
;
191 private final ProfileHelper profileHelper
;
192 private final GroupHelper groupHelper
;
193 private final PinHelper pinHelper
;
194 private final AvatarStore avatarStore
;
195 private final AttachmentStore attachmentStore
;
198 SignalAccount account
,
199 PathConfig pathConfig
,
200 ServiceEnvironmentConfig serviceEnvironmentConfig
,
203 this.account
= account
;
204 this.serviceEnvironmentConfig
= serviceEnvironmentConfig
;
205 this.certificateValidator
= new CertificateValidator(serviceEnvironmentConfig
.getUnidentifiedSenderTrustRoot());
206 this.userAgent
= userAgent
;
207 this.groupsV2Operations
= capabilities
.isGv2() ?
new GroupsV2Operations(ClientZkOperations
.create(
208 serviceEnvironmentConfig
.getSignalServiceConfiguration())) : null;
209 final SleepTimer timer
= new UptimeSleepTimer();
210 this.accountManager
= new SignalServiceAccountManager(serviceEnvironmentConfig
.getSignalServiceConfiguration(),
211 new DynamicCredentialsProvider(account
.getUuid(),
212 account
.getUsername(),
213 account
.getPassword(),
214 account
.getDeviceId()),
217 ServiceConfig
.AUTOMATIC_NETWORK_RETRY
,
219 this.groupsV2Api
= accountManager
.getGroupsV2Api();
220 final var keyBackupService
= accountManager
.getKeyBackupService(ServiceConfig
.getIasKeyStore(),
221 serviceEnvironmentConfig
.getKeyBackupConfig().getEnclaveName(),
222 serviceEnvironmentConfig
.getKeyBackupConfig().getServiceId(),
223 serviceEnvironmentConfig
.getKeyBackupConfig().getMrenclave(),
226 this.pinHelper
= new PinHelper(keyBackupService
);
227 this.clientZkProfileOperations
= capabilities
.isGv2()
228 ? ClientZkOperations
.create(serviceEnvironmentConfig
.getSignalServiceConfiguration())
229 .getProfileOperations()
231 this.messageReceiver
= new SignalServiceMessageReceiver(serviceEnvironmentConfig
.getSignalServiceConfiguration(),
233 account
.getUsername(),
234 account
.getPassword(),
235 account
.getDeviceId(),
239 clientZkProfileOperations
,
240 ServiceConfig
.AUTOMATIC_NETWORK_RETRY
);
242 this.unidentifiedAccessHelper
= new UnidentifiedAccessHelper(account
::getProfileKey
,
243 account
.getProfileStore()::getProfileKey
,
244 this::getRecipientProfile
,
245 this::getSenderCertificate
);
246 this.profileHelper
= new ProfileHelper(account
.getProfileStore()::getProfileKey
,
247 unidentifiedAccessHelper
::getAccessFor
,
248 unidentified
-> unidentified ?
getOrCreateUnidentifiedMessagePipe() : getOrCreateMessagePipe(),
249 () -> messageReceiver
,
250 this::resolveSignalServiceAddress
);
251 this.groupHelper
= new GroupHelper(this::getRecipientProfileKeyCredential
,
252 this::getRecipientProfile
,
253 account
::getSelfRecipientId
,
256 this::getGroupAuthForToday
,
257 this::resolveSignalServiceAddress
);
258 this.avatarStore
= new AvatarStore(pathConfig
.getAvatarsPath());
259 this.attachmentStore
= new AttachmentStore(pathConfig
.getAttachmentsPath());
262 public String
getUsername() {
263 return account
.getUsername();
266 public SignalServiceAddress
getSelfAddress() {
267 return account
.getSelfAddress();
270 public RecipientId
getSelfRecipientId() {
271 return account
.getSelfRecipientId();
274 private IdentityKeyPair
getIdentityKeyPair() {
275 return account
.getIdentityKeyPair();
278 public int getDeviceId() {
279 return account
.getDeviceId();
282 public static Manager
init(
283 String username
, File settingsPath
, ServiceEnvironment serviceEnvironment
, String userAgent
284 ) throws IOException
, NotRegisteredException
{
285 var pathConfig
= PathConfig
.createDefault(settingsPath
);
287 if (!SignalAccount
.userExists(pathConfig
.getDataPath(), username
)) {
288 throw new NotRegisteredException();
291 var account
= SignalAccount
.load(pathConfig
.getDataPath(), username
, true);
293 if (!account
.isRegistered()) {
294 throw new NotRegisteredException();
297 final var serviceEnvironmentConfig
= ServiceConfig
.getServiceEnvironmentConfig(serviceEnvironment
, userAgent
);
299 return new Manager(account
, pathConfig
, serviceEnvironmentConfig
, userAgent
);
302 public static List
<String
> getAllLocalUsernames(File settingsPath
) {
303 var pathConfig
= PathConfig
.createDefault(settingsPath
);
304 final var dataPath
= pathConfig
.getDataPath();
305 final var files
= dataPath
.listFiles();
311 return Arrays
.stream(files
)
312 .filter(File
::isFile
)
314 .filter(file
-> PhoneNumberFormatter
.isValidNumber(file
, null))
315 .collect(Collectors
.toList());
318 public void checkAccountState() throws IOException
{
319 if (accountManager
.getPreKeysCount() < ServiceConfig
.PREKEY_MINIMUM_COUNT
) {
322 if (account
.getUuid() == null) {
323 account
.setUuid(accountManager
.getOwnUuid());
325 updateAccountAttributes();
329 * This is used for checking a set of phone numbers for registration on Signal
331 * @param numbers The set of phone number in question
332 * @return A map of numbers to booleans. True if registered, false otherwise. Should never be null
333 * @throws IOException if its unable to get the contacts to check if they're registered
335 public Map
<String
, Boolean
> areUsersRegistered(Set
<String
> numbers
) throws IOException
{
336 // Note "contactDetails" has no optionals. It only gives us info on users who are registered
337 var contactDetails
= getRegisteredUsers(numbers
);
339 var registeredUsers
= contactDetails
.keySet();
341 return numbers
.stream().collect(Collectors
.toMap(x
-> x
, registeredUsers
::contains
));
344 public void updateAccountAttributes() throws IOException
{
345 accountManager
.setAccountAttributes(account
.getEncryptedDeviceName(),
347 account
.getLocalRegistrationId(),
349 // set legacy pin only if no KBS master key is set
350 account
.getPinMasterKey() == null ? account
.getRegistrationLockPin() : null,
351 account
.getPinMasterKey() == null ?
null : account
.getPinMasterKey().deriveRegistrationLock(),
352 account
.getSelfUnidentifiedAccessKey(),
353 account
.isUnrestrictedUnidentifiedAccess(),
355 account
.isDiscoverableByPhoneNumber());
359 * @param givenName if null, the previous givenName will be kept
360 * @param familyName if null, the previous familyName will be kept
361 * @param about if null, the previous about text will be kept
362 * @param aboutEmoji if null, the previous about emoji will be kept
363 * @param avatar if avatar is null the image from the local avatar store is used (if present),
365 public void setProfile(
366 String givenName
, final String familyName
, String about
, String aboutEmoji
, Optional
<File
> avatar
367 ) throws IOException
{
368 var profile
= getRecipientProfile(account
.getSelfRecipientId());
369 var builder
= profile
== null ? Profile
.newBuilder() : Profile
.newBuilder(profile
);
370 if (givenName
!= null) {
371 builder
.withGivenName(givenName
);
373 if (familyName
!= null) {
374 builder
.withFamilyName(familyName
);
377 builder
.withAbout(about
);
379 if (aboutEmoji
!= null) {
380 builder
.withAboutEmoji(aboutEmoji
);
382 var newProfile
= builder
.build();
384 try (final var streamDetails
= avatar
== null
385 ? avatarStore
.retrieveProfileAvatar(getSelfAddress())
386 : avatar
.isPresent() ? Utils
.createStreamDetailsFromFile(avatar
.get()) : null) {
387 accountManager
.setVersionedProfile(account
.getUuid(),
388 account
.getProfileKey(),
389 newProfile
.getInternalServiceName(),
390 newProfile
.getAbout() == null ?
"" : newProfile
.getAbout(),
391 newProfile
.getAboutEmoji() == null ?
"" : newProfile
.getAboutEmoji(),
395 if (avatar
!= null) {
396 if (avatar
.isPresent()) {
397 avatarStore
.storeProfileAvatar(getSelfAddress(),
398 outputStream
-> IOUtils
.copyFileToStream(avatar
.get(), outputStream
));
400 avatarStore
.deleteProfileAvatar(getSelfAddress());
403 account
.getProfileStore().storeProfile(account
.getSelfRecipientId(), newProfile
);
406 sendSyncMessage(SignalServiceSyncMessage
.forFetchLatest(SignalServiceSyncMessage
.FetchType
.LOCAL_PROFILE
));
407 } catch (UntrustedIdentityException ignored
) {
411 public void unregister() throws IOException
{
412 // When setting an empty GCM id, the Signal-Server also sets the fetchesMessages property to false.
413 // If this is the master device, other users can't send messages to this number anymore.
414 // If this is a linked device, other users can still send messages, but this device doesn't receive them anymore.
415 accountManager
.setGcmId(Optional
.absent());
417 account
.setRegistered(false);
420 public void deleteAccount() throws IOException
{
421 accountManager
.deleteAccount();
423 account
.setRegistered(false);
426 public List
<Device
> getLinkedDevices() throws IOException
{
427 var devices
= accountManager
.getDevices();
428 account
.setMultiDevice(devices
.size() > 1);
429 var identityKey
= account
.getIdentityKeyPair().getPrivateKey();
430 return devices
.stream().map(d
-> {
431 String deviceName
= d
.getName();
432 if (deviceName
!= null) {
434 deviceName
= DeviceNameUtil
.decryptDeviceName(deviceName
, identityKey
);
435 } catch (IOException e
) {
436 logger
.debug("Failed to decrypt device name, maybe plain text?", e
);
439 return new Device(d
.getId(), deviceName
, d
.getCreated(), d
.getLastSeen());
440 }).collect(Collectors
.toList());
443 public void removeLinkedDevices(int deviceId
) throws IOException
{
444 accountManager
.removeDevice(deviceId
);
445 var devices
= accountManager
.getDevices();
446 account
.setMultiDevice(devices
.size() > 1);
449 public void addDeviceLink(URI linkUri
) throws IOException
, InvalidKeyException
{
450 var info
= DeviceLinkInfo
.parseDeviceLinkUri(linkUri
);
452 addDevice(info
.deviceIdentifier
, info
.deviceKey
);
455 private void addDevice(String deviceIdentifier
, ECPublicKey deviceKey
) throws IOException
, InvalidKeyException
{
456 var identityKeyPair
= getIdentityKeyPair();
457 var verificationCode
= accountManager
.getNewDeviceVerificationCode();
459 accountManager
.addDevice(deviceIdentifier
,
462 Optional
.of(account
.getProfileKey().serialize()),
464 account
.setMultiDevice(true);
467 public void setRegistrationLockPin(Optional
<String
> pin
) throws IOException
, UnauthenticatedResponseException
{
468 if (!account
.isMasterDevice()) {
469 throw new RuntimeException("Only master device can set a PIN");
471 if (pin
.isPresent()) {
472 final var masterKey
= account
.getPinMasterKey() != null
473 ? account
.getPinMasterKey()
474 : KeyUtils
.createMasterKey();
476 pinHelper
.setRegistrationLockPin(pin
.get(), masterKey
);
478 account
.setRegistrationLockPin(pin
.get(), masterKey
);
480 // Remove legacy registration lock
481 accountManager
.removeRegistrationLockV1();
484 pinHelper
.removeRegistrationLockPin();
486 account
.setRegistrationLockPin(null, null);
490 void refreshPreKeys() throws IOException
{
491 var oneTimePreKeys
= generatePreKeys();
492 final var identityKeyPair
= getIdentityKeyPair();
493 var signedPreKeyRecord
= generateSignedPreKey(identityKeyPair
);
495 accountManager
.setPreKeys(identityKeyPair
.getPublicKey(), signedPreKeyRecord
, oneTimePreKeys
);
498 private List
<PreKeyRecord
> generatePreKeys() {
499 final var offset
= account
.getPreKeyIdOffset();
501 var records
= KeyUtils
.generatePreKeyRecords(offset
, ServiceConfig
.PREKEY_BATCH_SIZE
);
502 account
.addPreKeys(records
);
507 private SignedPreKeyRecord
generateSignedPreKey(IdentityKeyPair identityKeyPair
) {
508 final var signedPreKeyId
= account
.getNextSignedPreKeyId();
510 var record = KeyUtils
.generateSignedPreKeyRecord(identityKeyPair
, signedPreKeyId
);
511 account
.addSignedPreKey(record);
516 private SignalServiceMessagePipe
getOrCreateMessagePipe() {
517 if (messagePipe
== null) {
518 messagePipe
= messageReceiver
.createMessagePipe();
523 private SignalServiceMessagePipe
getOrCreateUnidentifiedMessagePipe() {
524 if (unidentifiedMessagePipe
== null) {
525 unidentifiedMessagePipe
= messageReceiver
.createUnidentifiedMessagePipe();
527 return unidentifiedMessagePipe
;
530 private SignalServiceMessageSender
createMessageSender() {
531 return new SignalServiceMessageSender(serviceEnvironmentConfig
.getSignalServiceConfiguration(),
533 account
.getUsername(),
534 account
.getPassword(),
535 account
.getDeviceId(),
536 account
.getSignalProtocolStore(),
538 account
.isMultiDevice(),
539 Optional
.fromNullable(messagePipe
),
540 Optional
.fromNullable(unidentifiedMessagePipe
),
542 clientZkProfileOperations
,
544 ServiceConfig
.MAX_ENVELOPE_SIZE
,
545 ServiceConfig
.AUTOMATIC_NETWORK_RETRY
);
548 public Profile
getRecipientProfile(
549 RecipientId recipientId
551 return getRecipientProfile(recipientId
, false);
554 private final Set
<RecipientId
> pendingProfileRequest
= new HashSet
<>();
556 Profile
getRecipientProfile(
557 RecipientId recipientId
, boolean force
559 var profileKey
= account
.getProfileStore().getProfileKey(recipientId
);
560 if (profileKey
== null) {
562 // retrieve profile to get identity key
563 retrieveEncryptedProfile(recipientId
);
567 var profile
= account
.getProfileStore().getProfile(recipientId
);
569 var now
= new Date().getTime();
570 // Profiles are cached for 24h before retrieving them again, unless forced
571 if (!force
&& profile
!= null && now
- profile
.getLastUpdateTimestamp() < 24 * 60 * 60 * 1000) {
575 synchronized (pendingProfileRequest
) {
576 if (pendingProfileRequest
.contains(recipientId
)) {
579 pendingProfileRequest
.add(recipientId
);
581 final SignalServiceProfile encryptedProfile
;
583 encryptedProfile
= retrieveEncryptedProfile(recipientId
);
585 synchronized (pendingProfileRequest
) {
586 pendingProfileRequest
.remove(recipientId
);
589 if (encryptedProfile
== null) {
593 profile
= decryptProfileAndDownloadAvatar(recipientId
, profileKey
, encryptedProfile
);
594 account
.getProfileStore().storeProfile(recipientId
, profile
);
599 private SignalServiceProfile
retrieveEncryptedProfile(RecipientId recipientId
) {
601 return retrieveProfileAndCredential(recipientId
, SignalServiceProfile
.RequestType
.PROFILE
).getProfile();
602 } catch (IOException e
) {
603 logger
.warn("Failed to retrieve profile, ignoring: {}", e
.getMessage());
608 private ProfileAndCredential
retrieveProfileAndCredential(
609 final RecipientId recipientId
, final SignalServiceProfile
.RequestType requestType
610 ) throws IOException
{
611 final var profileAndCredential
= profileHelper
.retrieveProfileSync(recipientId
, requestType
);
612 final var profile
= profileAndCredential
.getProfile();
615 var newIdentity
= account
.getIdentityKeyStore()
616 .saveIdentity(recipientId
,
617 new IdentityKey(Base64
.getDecoder().decode(profile
.getIdentityKey())),
621 account
.getSessionStore().archiveSessions(recipientId
);
623 } catch (InvalidKeyException ignored
) {
624 logger
.warn("Got invalid identity key in profile for {}",
625 resolveSignalServiceAddress(recipientId
).getLegacyIdentifier());
627 return profileAndCredential
;
630 private ProfileKeyCredential
getRecipientProfileKeyCredential(RecipientId recipientId
) {
631 var profileKeyCredential
= account
.getProfileStore().getProfileKeyCredential(recipientId
);
632 if (profileKeyCredential
!= null) {
633 return profileKeyCredential
;
636 ProfileAndCredential profileAndCredential
;
638 profileAndCredential
= retrieveProfileAndCredential(recipientId
,
639 SignalServiceProfile
.RequestType
.PROFILE_AND_CREDENTIAL
);
640 } catch (IOException e
) {
641 logger
.warn("Failed to retrieve profile key credential, ignoring: {}", e
.getMessage());
645 profileKeyCredential
= profileAndCredential
.getProfileKeyCredential().orNull();
646 account
.getProfileStore().storeProfileKeyCredential(recipientId
, profileKeyCredential
);
648 var profileKey
= account
.getProfileStore().getProfileKey(recipientId
);
649 if (profileKey
!= null) {
650 final var profile
= decryptProfileAndDownloadAvatar(recipientId
,
652 profileAndCredential
.getProfile());
653 account
.getProfileStore().storeProfile(recipientId
, profile
);
656 return profileKeyCredential
;
659 private Profile
decryptProfileAndDownloadAvatar(
660 final RecipientId recipientId
, final ProfileKey profileKey
, final SignalServiceProfile encryptedProfile
662 if (encryptedProfile
.getAvatar() != null) {
663 downloadProfileAvatar(resolveSignalServiceAddress(recipientId
), encryptedProfile
.getAvatar(), profileKey
);
666 return ProfileUtils
.decryptProfile(profileKey
, encryptedProfile
);
669 private Optional
<SignalServiceAttachmentStream
> createGroupAvatarAttachment(GroupId groupId
) throws IOException
{
670 final var streamDetails
= avatarStore
.retrieveGroupAvatar(groupId
);
671 if (streamDetails
== null) {
672 return Optional
.absent();
675 return Optional
.of(AttachmentUtils
.createAttachment(streamDetails
, Optional
.absent()));
678 private Optional
<SignalServiceAttachmentStream
> createContactAvatarAttachment(SignalServiceAddress address
) throws IOException
{
679 final var streamDetails
= avatarStore
.retrieveContactAvatar(address
);
680 if (streamDetails
== null) {
681 return Optional
.absent();
684 return Optional
.of(AttachmentUtils
.createAttachment(streamDetails
, Optional
.absent()));
687 private GroupInfo
getGroupForSending(GroupId groupId
) throws GroupNotFoundException
, NotAGroupMemberException
{
688 var g
= getGroup(groupId
);
690 throw new GroupNotFoundException(groupId
);
692 if (!g
.isMember(account
.getSelfRecipientId())) {
693 throw new NotAGroupMemberException(groupId
, g
.getTitle());
698 private GroupInfo
getGroupForUpdating(GroupId groupId
) throws GroupNotFoundException
, NotAGroupMemberException
{
699 var g
= getGroup(groupId
);
701 throw new GroupNotFoundException(groupId
);
703 if (!g
.isMember(account
.getSelfRecipientId()) && !g
.isPendingMember(account
.getSelfRecipientId())) {
704 throw new NotAGroupMemberException(groupId
, g
.getTitle());
709 public List
<GroupInfo
> getGroups() {
710 return account
.getGroupStore().getGroups();
713 public Pair
<Long
, List
<SendMessageResult
>> sendGroupMessage(
714 String messageText
, List
<String
> attachments
, GroupId groupId
715 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
{
716 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withBody(messageText
);
717 if (attachments
!= null) {
718 messageBuilder
.withAttachments(AttachmentUtils
.getSignalServiceAttachments(attachments
));
721 return sendGroupMessage(messageBuilder
, groupId
);
724 public Pair
<Long
, List
<SendMessageResult
>> sendGroupMessageReaction(
725 String emoji
, boolean remove
, String targetAuthor
, long targetSentTimestamp
, GroupId groupId
726 ) throws IOException
, InvalidNumberException
, NotAGroupMemberException
, GroupNotFoundException
{
727 var targetAuthorRecipientId
= canonicalizeAndResolveRecipient(targetAuthor
);
728 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
,
730 resolveSignalServiceAddress(targetAuthorRecipientId
),
731 targetSentTimestamp
);
732 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
734 return sendGroupMessage(messageBuilder
, groupId
);
737 public Pair
<Long
, List
<SendMessageResult
>> sendGroupMessage(
738 SignalServiceDataMessage
.Builder messageBuilder
, GroupId groupId
739 ) throws IOException
, GroupNotFoundException
, NotAGroupMemberException
{
740 final var g
= getGroupForSending(groupId
);
742 GroupUtils
.setGroupContext(messageBuilder
, g
);
743 messageBuilder
.withExpiration(g
.getMessageExpirationTime());
745 return sendMessage(messageBuilder
, g
.getMembersWithout(account
.getSelfRecipientId()));
748 public Pair
<Long
, List
<SendMessageResult
>> sendQuitGroupMessage(GroupId groupId
) throws GroupNotFoundException
, IOException
, NotAGroupMemberException
{
749 SignalServiceDataMessage
.Builder messageBuilder
;
751 final var g
= getGroupForUpdating(groupId
);
752 if (g
instanceof GroupInfoV1
) {
753 var groupInfoV1
= (GroupInfoV1
) g
;
754 var group
= SignalServiceGroup
.newBuilder(SignalServiceGroup
.Type
.QUIT
).withId(groupId
.serialize()).build();
755 messageBuilder
= SignalServiceDataMessage
.newBuilder().asGroupMessage(group
);
756 groupInfoV1
.removeMember(account
.getSelfRecipientId());
757 account
.getGroupStore().updateGroup(groupInfoV1
);
759 final var groupInfoV2
= (GroupInfoV2
) g
;
760 final var groupGroupChangePair
= groupHelper
.leaveGroup(groupInfoV2
);
761 groupInfoV2
.setGroup(groupGroupChangePair
.first(), this::resolveRecipient
);
762 messageBuilder
= getGroupUpdateMessageBuilder(groupInfoV2
, groupGroupChangePair
.second().toByteArray());
763 account
.getGroupStore().updateGroup(groupInfoV2
);
766 return sendMessage(messageBuilder
, g
.getMembersWithout(account
.getSelfRecipientId()));
769 public Pair
<GroupId
, List
<SendMessageResult
>> updateGroup(
770 GroupId groupId
, String name
, List
<String
> members
, File avatarFile
771 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, InvalidNumberException
, NotAGroupMemberException
{
772 return sendUpdateGroupMessage(groupId
,
774 members
== null ?
null : getSignalServiceAddresses(members
),
778 private Pair
<GroupId
, List
<SendMessageResult
>> sendUpdateGroupMessage(
779 GroupId groupId
, String name
, Set
<RecipientId
> members
, File avatarFile
780 ) throws IOException
, GroupNotFoundException
, AttachmentInvalidException
, NotAGroupMemberException
{
782 SignalServiceDataMessage
.Builder messageBuilder
;
783 if (groupId
== null) {
785 var gv2Pair
= groupHelper
.createGroupV2(name
== null ?
"" : name
,
786 members
== null ? Set
.of() : members
,
788 if (gv2Pair
== null) {
789 var gv1
= new GroupInfoV1(GroupIdV1
.createRandom());
790 gv1
.addMembers(List
.of(account
.getSelfRecipientId()));
791 updateGroupV1(gv1
, name
, members
, avatarFile
);
792 messageBuilder
= getGroupUpdateMessageBuilder(gv1
);
795 final var gv2
= gv2Pair
.first();
796 final var decryptedGroup
= gv2Pair
.second();
798 gv2
.setGroup(decryptedGroup
, this::resolveRecipient
);
799 if (avatarFile
!= null) {
800 avatarStore
.storeGroupAvatar(gv2
.getGroupId(),
801 outputStream
-> IOUtils
.copyFileToStream(avatarFile
, outputStream
));
803 messageBuilder
= getGroupUpdateMessageBuilder(gv2
, null);
807 var group
= getGroupForUpdating(groupId
);
808 if (group
instanceof GroupInfoV2
) {
809 final var groupInfoV2
= (GroupInfoV2
) group
;
811 Pair
<Long
, List
<SendMessageResult
>> result
= null;
812 if (groupInfoV2
.isPendingMember(account
.getSelfRecipientId())) {
813 var groupGroupChangePair
= groupHelper
.acceptInvite(groupInfoV2
);
814 result
= sendUpdateGroupMessage(groupInfoV2
,
815 groupGroupChangePair
.first(),
816 groupGroupChangePair
.second());
819 if (members
!= null) {
820 final var newMembers
= new HashSet
<>(members
);
821 newMembers
.removeAll(group
.getMembers());
822 if (newMembers
.size() > 0) {
823 var groupGroupChangePair
= groupHelper
.updateGroupV2(groupInfoV2
, newMembers
);
824 result
= sendUpdateGroupMessage(groupInfoV2
,
825 groupGroupChangePair
.first(),
826 groupGroupChangePair
.second());
829 if (result
== null || name
!= null || avatarFile
!= null) {
830 var groupGroupChangePair
= groupHelper
.updateGroupV2(groupInfoV2
, name
, avatarFile
);
831 if (avatarFile
!= null) {
832 avatarStore
.storeGroupAvatar(groupInfoV2
.getGroupId(),
833 outputStream
-> IOUtils
.copyFileToStream(avatarFile
, outputStream
));
835 result
= sendUpdateGroupMessage(groupInfoV2
,
836 groupGroupChangePair
.first(),
837 groupGroupChangePair
.second());
840 return new Pair
<>(group
.getGroupId(), result
.second());
842 var gv1
= (GroupInfoV1
) group
;
843 updateGroupV1(gv1
, name
, members
, avatarFile
);
844 messageBuilder
= getGroupUpdateMessageBuilder(gv1
);
849 account
.getGroupStore().updateGroup(g
);
851 final var result
= sendMessage(messageBuilder
,
852 g
.getMembersIncludingPendingWithout(account
.getSelfRecipientId()));
853 return new Pair
<>(g
.getGroupId(), result
.second());
856 private void updateGroupV1(
857 final GroupInfoV1 g
, final String name
, final Collection
<RecipientId
> members
, final File avatarFile
858 ) throws IOException
{
863 if (members
!= null) {
864 final var newMemberAddresses
= members
.stream()
865 .filter(member
-> !g
.isMember(member
))
866 .map(this::resolveSignalServiceAddress
)
867 .collect(Collectors
.toList());
868 final var newE164Members
= new HashSet
<String
>();
869 for (var member
: newMemberAddresses
) {
870 if (!member
.getNumber().isPresent()) {
873 newE164Members
.add(member
.getNumber().get());
876 final var registeredUsers
= getRegisteredUsers(newE164Members
);
877 if (registeredUsers
.size() != newE164Members
.size()) {
878 // Some of the new members are not registered on Signal
879 newE164Members
.removeAll(registeredUsers
.keySet());
880 throw new IOException("Failed to add members "
881 + String
.join(", ", newE164Members
)
882 + " to group: Not registered on Signal");
885 g
.addMembers(members
);
888 if (avatarFile
!= null) {
889 avatarStore
.storeGroupAvatar(g
.getGroupId(),
890 outputStream
-> IOUtils
.copyFileToStream(avatarFile
, outputStream
));
894 public Pair
<GroupId
, List
<SendMessageResult
>> joinGroup(
895 GroupInviteLinkUrl inviteLinkUrl
896 ) throws IOException
, GroupLinkNotActiveException
{
897 return sendJoinGroupMessage(inviteLinkUrl
);
900 private Pair
<GroupId
, List
<SendMessageResult
>> sendJoinGroupMessage(
901 GroupInviteLinkUrl inviteLinkUrl
902 ) throws IOException
, GroupLinkNotActiveException
{
903 final var groupJoinInfo
= groupHelper
.getDecryptedGroupJoinInfo(inviteLinkUrl
.getGroupMasterKey(),
904 inviteLinkUrl
.getPassword());
905 final var groupChange
= groupHelper
.joinGroup(inviteLinkUrl
.getGroupMasterKey(),
906 inviteLinkUrl
.getPassword(),
908 final var group
= getOrMigrateGroup(inviteLinkUrl
.getGroupMasterKey(),
909 groupJoinInfo
.getRevision() + 1,
910 groupChange
.toByteArray());
912 if (group
.getGroup() == null) {
913 // Only requested member, can't send update to group members
914 return new Pair
<>(group
.getGroupId(), List
.of());
917 final var result
= sendUpdateGroupMessage(group
, group
.getGroup(), groupChange
);
919 return new Pair
<>(group
.getGroupId(), result
.second());
922 private static int currentTimeDays() {
923 return (int) TimeUnit
.MILLISECONDS
.toDays(System
.currentTimeMillis());
926 private GroupsV2AuthorizationString
getGroupAuthForToday(
927 final GroupSecretParams groupSecretParams
928 ) throws IOException
{
929 final var today
= currentTimeDays();
930 // Returns credentials for the next 7 days
931 final var credentials
= groupsV2Api
.getCredentials(today
);
932 // TODO cache credentials until they expire
933 var authCredentialResponse
= credentials
.get(today
);
935 return groupsV2Api
.getGroupsV2AuthorizationString(account
.getUuid(),
938 authCredentialResponse
);
939 } catch (VerificationFailedException e
) {
940 throw new IOException(e
);
944 private Pair
<Long
, List
<SendMessageResult
>> sendUpdateGroupMessage(
945 GroupInfoV2 group
, DecryptedGroup newDecryptedGroup
, GroupChange groupChange
946 ) throws IOException
{
947 group
.setGroup(newDecryptedGroup
, this::resolveRecipient
);
948 final var messageBuilder
= getGroupUpdateMessageBuilder(group
, groupChange
.toByteArray());
949 account
.getGroupStore().updateGroup(group
);
950 return sendMessage(messageBuilder
, group
.getMembersIncludingPendingWithout(account
.getSelfRecipientId()));
953 Pair
<Long
, List
<SendMessageResult
>> sendGroupInfoMessage(
954 GroupIdV1 groupId
, SignalServiceAddress recipient
955 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
, AttachmentInvalidException
{
957 var group
= getGroupForSending(groupId
);
958 if (!(group
instanceof GroupInfoV1
)) {
959 throw new RuntimeException("Received an invalid group request for a v2 group!");
961 g
= (GroupInfoV1
) group
;
963 final var recipientId
= resolveRecipient(recipient
);
964 if (!g
.isMember(recipientId
)) {
965 throw new NotAGroupMemberException(groupId
, g
.name
);
968 var messageBuilder
= getGroupUpdateMessageBuilder(g
);
970 // Send group message only to the recipient who requested it
971 return sendMessage(messageBuilder
, Set
.of(recipientId
));
974 private SignalServiceDataMessage
.Builder
getGroupUpdateMessageBuilder(GroupInfoV1 g
) throws AttachmentInvalidException
{
975 var group
= SignalServiceGroup
.newBuilder(SignalServiceGroup
.Type
.UPDATE
)
976 .withId(g
.getGroupId().serialize())
978 .withMembers(g
.getMembers()
980 .map(this::resolveSignalServiceAddress
)
981 .collect(Collectors
.toList()));
984 final var attachment
= createGroupAvatarAttachment(g
.getGroupId());
985 if (attachment
.isPresent()) {
986 group
.withAvatar(attachment
.get());
988 } catch (IOException e
) {
989 throw new AttachmentInvalidException(g
.getGroupId().toBase64(), e
);
992 return SignalServiceDataMessage
.newBuilder()
993 .asGroupMessage(group
.build())
994 .withExpiration(g
.getMessageExpirationTime());
997 private SignalServiceDataMessage
.Builder
getGroupUpdateMessageBuilder(GroupInfoV2 g
, byte[] signedGroupChange
) {
998 var group
= SignalServiceGroupV2
.newBuilder(g
.getMasterKey())
999 .withRevision(g
.getGroup().getRevision())
1000 .withSignedGroupChange(signedGroupChange
);
1001 return SignalServiceDataMessage
.newBuilder()
1002 .asGroupMessage(group
.build())
1003 .withExpiration(g
.getMessageExpirationTime());
1006 Pair
<Long
, List
<SendMessageResult
>> sendGroupInfoRequest(
1007 GroupIdV1 groupId
, SignalServiceAddress recipient
1008 ) throws IOException
{
1009 var group
= SignalServiceGroup
.newBuilder(SignalServiceGroup
.Type
.REQUEST_INFO
).withId(groupId
.serialize());
1011 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asGroupMessage(group
.build());
1013 // Send group info request message to the recipient who sent us a message with this groupId
1014 return sendMessage(messageBuilder
, Set
.of(resolveRecipient(recipient
)));
1018 SignalServiceAddress remoteAddress
, long messageId
1019 ) throws IOException
, UntrustedIdentityException
{
1020 var receiptMessage
= new SignalServiceReceiptMessage(SignalServiceReceiptMessage
.Type
.DELIVERY
,
1022 System
.currentTimeMillis());
1024 createMessageSender().sendReceipt(remoteAddress
,
1025 unidentifiedAccessHelper
.getAccessFor(resolveRecipient(remoteAddress
)),
1029 public Pair
<Long
, List
<SendMessageResult
>> sendMessage(
1030 String messageText
, List
<String
> attachments
, List
<String
> recipients
1031 ) throws IOException
, AttachmentInvalidException
, InvalidNumberException
{
1032 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withBody(messageText
);
1033 if (attachments
!= null) {
1034 var attachmentStreams
= AttachmentUtils
.getSignalServiceAttachments(attachments
);
1036 // Upload attachments here, so we only upload once even for multiple recipients
1037 var messageSender
= createMessageSender();
1038 var attachmentPointers
= new ArrayList
<SignalServiceAttachment
>(attachmentStreams
.size());
1039 for (var attachment
: attachmentStreams
) {
1040 if (attachment
.isStream()) {
1041 attachmentPointers
.add(messageSender
.uploadAttachment(attachment
.asStream()));
1042 } else if (attachment
.isPointer()) {
1043 attachmentPointers
.add(attachment
.asPointer());
1047 messageBuilder
.withAttachments(attachmentPointers
);
1049 return sendMessage(messageBuilder
, getSignalServiceAddresses(recipients
));
1052 public Pair
<Long
, SendMessageResult
> sendSelfMessage(
1053 String messageText
, List
<String
> attachments
1054 ) throws IOException
, AttachmentInvalidException
{
1055 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withBody(messageText
);
1056 if (attachments
!= null) {
1057 messageBuilder
.withAttachments(AttachmentUtils
.getSignalServiceAttachments(attachments
));
1059 return sendSelfMessage(messageBuilder
);
1062 public Pair
<Long
, List
<SendMessageResult
>> sendRemoteDeleteMessage(
1063 long targetSentTimestamp
, List
<String
> recipients
1064 ) throws IOException
, InvalidNumberException
{
1065 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
1066 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
1067 return sendMessage(messageBuilder
, getSignalServiceAddresses(recipients
));
1070 public Pair
<Long
, List
<SendMessageResult
>> sendGroupRemoteDeleteMessage(
1071 long targetSentTimestamp
, GroupId groupId
1072 ) throws IOException
, NotAGroupMemberException
, GroupNotFoundException
{
1073 var delete
= new SignalServiceDataMessage
.RemoteDelete(targetSentTimestamp
);
1074 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withRemoteDelete(delete
);
1075 return sendGroupMessage(messageBuilder
, groupId
);
1078 public Pair
<Long
, List
<SendMessageResult
>> sendMessageReaction(
1079 String emoji
, boolean remove
, String targetAuthor
, long targetSentTimestamp
, List
<String
> recipients
1080 ) throws IOException
, InvalidNumberException
{
1081 var targetAuthorRecipientId
= canonicalizeAndResolveRecipient(targetAuthor
);
1082 var reaction
= new SignalServiceDataMessage
.Reaction(emoji
,
1084 resolveSignalServiceAddress(targetAuthorRecipientId
),
1085 targetSentTimestamp
);
1086 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().withReaction(reaction
);
1087 return sendMessage(messageBuilder
, getSignalServiceAddresses(recipients
));
1090 public Pair
<Long
, List
<SendMessageResult
>> sendEndSessionMessage(List
<String
> recipients
) throws IOException
, InvalidNumberException
{
1091 var messageBuilder
= SignalServiceDataMessage
.newBuilder().asEndSessionMessage();
1093 final var signalServiceAddresses
= getSignalServiceAddresses(recipients
);
1095 return sendMessage(messageBuilder
, signalServiceAddresses
);
1096 } catch (Exception e
) {
1097 for (var address
: signalServiceAddresses
) {
1098 handleEndSession(address
);
1104 SendMessageResult
renewSession(RecipientId recipientId
) throws IOException
{
1105 account
.getSessionStore().archiveSessions(recipientId
);
1106 return sendNullMessage(recipientId
);
1109 public String
getContactName(String number
) throws InvalidNumberException
{
1110 var contact
= account
.getContactStore().getContact(canonicalizeAndResolveRecipient(number
));
1111 return contact
== null || contact
.getName() == null ?
"" : contact
.getName();
1114 public void setContactName(String number
, String name
) throws InvalidNumberException
, NotMasterDeviceException
{
1115 if (!account
.isMasterDevice()) {
1116 throw new NotMasterDeviceException();
1118 final var recipientId
= canonicalizeAndResolveRecipient(number
);
1119 var contact
= account
.getContactStore().getContact(recipientId
);
1120 final var builder
= contact
== null ? Contact
.newBuilder() : Contact
.newBuilder(contact
);
1121 account
.getContactStore().storeContact(recipientId
, builder
.withName(name
).build());
1124 public void setContactBlocked(
1125 String number
, boolean blocked
1126 ) throws InvalidNumberException
, NotMasterDeviceException
{
1127 if (!account
.isMasterDevice()) {
1128 throw new NotMasterDeviceException();
1130 setContactBlocked(canonicalizeAndResolveRecipient(number
), blocked
);
1133 private void setContactBlocked(RecipientId recipientId
, boolean blocked
) {
1134 var contact
= account
.getContactStore().getContact(recipientId
);
1135 final var builder
= contact
== null ? Contact
.newBuilder() : Contact
.newBuilder(contact
);
1136 account
.getContactStore().storeContact(recipientId
, builder
.withBlocked(blocked
).build());
1139 public void setGroupBlocked(final GroupId groupId
, final boolean blocked
) throws GroupNotFoundException
{
1140 var group
= getGroup(groupId
);
1141 if (group
== null) {
1142 throw new GroupNotFoundException(groupId
);
1145 group
.setBlocked(blocked
);
1146 account
.getGroupStore().updateGroup(group
);
1149 private void setExpirationTimer(RecipientId recipientId
, int messageExpirationTimer
) {
1150 var contact
= account
.getContactStore().getContact(recipientId
);
1151 if (contact
!= null && contact
.getMessageExpirationTime() == messageExpirationTimer
) {
1154 final var builder
= contact
== null ? Contact
.newBuilder() : Contact
.newBuilder(contact
);
1155 account
.getContactStore()
1156 .storeContact(recipientId
, builder
.withMessageExpirationTime(messageExpirationTimer
).build());
1159 private void sendExpirationTimerUpdate(RecipientId recipientId
) throws IOException
{
1160 final var messageBuilder
= SignalServiceDataMessage
.newBuilder().asExpirationUpdate();
1161 sendMessage(messageBuilder
, Set
.of(recipientId
));
1165 * Change the expiration timer for a contact
1167 public void setExpirationTimer(
1168 String number
, int messageExpirationTimer
1169 ) throws IOException
, InvalidNumberException
{
1170 var recipientId
= canonicalizeAndResolveRecipient(number
);
1171 setExpirationTimer(recipientId
, messageExpirationTimer
);
1172 sendExpirationTimerUpdate(recipientId
);
1176 * Change the expiration timer for a group
1178 public void setExpirationTimer(GroupId groupId
, int messageExpirationTimer
) {
1179 var g
= getGroup(groupId
);
1180 if (g
instanceof GroupInfoV1
) {
1181 var groupInfoV1
= (GroupInfoV1
) g
;
1182 groupInfoV1
.messageExpirationTime
= messageExpirationTimer
;
1183 account
.getGroupStore().updateGroup(groupInfoV1
);
1185 throw new RuntimeException("TODO Not implemented!");
1190 * Upload the sticker pack from path.
1192 * @param path Path can be a path to a manifest.json file or to a zip file that contains a manifest.json file
1193 * @return if successful, returns the URL to install the sticker pack in the signal app
1195 public String
uploadStickerPack(File path
) throws IOException
, StickerPackInvalidException
{
1196 var manifest
= StickerUtils
.getSignalServiceStickerManifestUpload(path
);
1198 var messageSender
= createMessageSender();
1200 var packKey
= KeyUtils
.createStickerUploadKey();
1201 var packId
= messageSender
.uploadStickerManifest(manifest
, packKey
);
1203 var sticker
= new Sticker(StickerPackId
.deserialize(Hex
.fromStringCondensed(packId
)), packKey
);
1204 account
.getStickerStore().updateSticker(sticker
);
1207 return new URI("https",
1210 "pack_id=" + URLEncoder
.encode(packId
, StandardCharsets
.UTF_8
) + "&pack_key=" + URLEncoder
.encode(
1211 Hex
.toStringCondensed(packKey
),
1212 StandardCharsets
.UTF_8
)).toString();
1213 } catch (URISyntaxException e
) {
1214 throw new AssertionError(e
);
1218 public void requestAllSyncData() throws IOException
{
1219 requestSyncGroups();
1220 requestSyncContacts();
1221 requestSyncBlocked();
1222 requestSyncConfiguration();
1226 private void requestSyncGroups() throws IOException
{
1227 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1228 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.GROUPS
)
1230 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1232 sendSyncMessage(message
);
1233 } catch (UntrustedIdentityException e
) {
1234 throw new AssertionError(e
);
1238 private void requestSyncContacts() throws IOException
{
1239 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1240 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.CONTACTS
)
1242 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1244 sendSyncMessage(message
);
1245 } catch (UntrustedIdentityException e
) {
1246 throw new AssertionError(e
);
1250 private void requestSyncBlocked() throws IOException
{
1251 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1252 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.BLOCKED
)
1254 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1256 sendSyncMessage(message
);
1257 } catch (UntrustedIdentityException e
) {
1258 throw new AssertionError(e
);
1262 private void requestSyncConfiguration() throws IOException
{
1263 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1264 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.CONFIGURATION
)
1266 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1268 sendSyncMessage(message
);
1269 } catch (UntrustedIdentityException e
) {
1270 throw new AssertionError(e
);
1274 private void requestSyncKeys() throws IOException
{
1275 var r
= SignalServiceProtos
.SyncMessage
.Request
.newBuilder()
1276 .setType(SignalServiceProtos
.SyncMessage
.Request
.Type
.KEYS
)
1278 var message
= SignalServiceSyncMessage
.forRequest(new RequestMessage(r
));
1280 sendSyncMessage(message
);
1281 } catch (UntrustedIdentityException e
) {
1282 throw new AssertionError(e
);
1286 private byte[] getSenderCertificate() {
1289 if (account
.isPhoneNumberShared()) {
1290 certificate
= accountManager
.getSenderCertificate();
1292 certificate
= accountManager
.getSenderCertificateForPhoneNumberPrivacy();
1294 } catch (IOException e
) {
1295 logger
.warn("Failed to get sender certificate, ignoring: {}", e
.getMessage());
1298 // TODO cache for a day
1302 private void sendSyncMessage(SignalServiceSyncMessage message
) throws IOException
, UntrustedIdentityException
{
1303 var messageSender
= createMessageSender();
1304 messageSender
.sendMessage(message
, unidentifiedAccessHelper
.getAccessForSync());
1307 private Set
<RecipientId
> getSignalServiceAddresses(Collection
<String
> numbers
) throws InvalidNumberException
{
1308 final var signalServiceAddresses
= new HashSet
<SignalServiceAddress
>(numbers
.size());
1309 final var addressesMissingUuid
= new HashSet
<SignalServiceAddress
>();
1311 for (var number
: numbers
) {
1312 final var resolvedAddress
= resolveSignalServiceAddress(canonicalizeAndResolveRecipient(number
));
1313 if (resolvedAddress
.getUuid().isPresent()) {
1314 signalServiceAddresses
.add(resolvedAddress
);
1316 addressesMissingUuid
.add(resolvedAddress
);
1320 final var numbersMissingUuid
= addressesMissingUuid
.stream()
1321 .map(a
-> a
.getNumber().get())
1322 .collect(Collectors
.toSet());
1323 Map
<String
, UUID
> registeredUsers
;
1325 registeredUsers
= getRegisteredUsers(numbersMissingUuid
);
1326 } catch (IOException e
) {
1327 logger
.warn("Failed to resolve uuids from server, ignoring: {}", e
.getMessage());
1328 registeredUsers
= Map
.of();
1331 for (var address
: addressesMissingUuid
) {
1332 final var number
= address
.getNumber().get();
1333 if (registeredUsers
.containsKey(number
)) {
1334 final var newAddress
= resolveSignalServiceAddress(resolveRecipientTrusted(new SignalServiceAddress(
1335 registeredUsers
.get(number
),
1337 signalServiceAddresses
.add(newAddress
);
1339 signalServiceAddresses
.add(address
);
1343 return signalServiceAddresses
.stream().map(this::resolveRecipient
).collect(Collectors
.toSet());
1346 private RecipientId
refreshRegisteredUser(RecipientId recipientId
) throws IOException
{
1347 final var address
= resolveSignalServiceAddress(recipientId
);
1348 if (!address
.getNumber().isPresent()) {
1351 final var number
= address
.getNumber().get();
1352 final var uuidMap
= getRegisteredUsers(Set
.of(number
));
1353 return resolveRecipientTrusted(new SignalServiceAddress(uuidMap
.getOrDefault(number
, null), number
));
1356 private Map
<String
, UUID
> getRegisteredUsers(final Set
<String
> numbers
) throws IOException
{
1358 return accountManager
.getRegisteredUsers(ServiceConfig
.getIasKeyStore(),
1360 serviceEnvironmentConfig
.getCdsMrenclave());
1361 } catch (Quote
.InvalidQuoteFormatException
| UnauthenticatedQuoteException
| SignatureException
| UnauthenticatedResponseException
| InvalidKeyException e
) {
1362 throw new IOException(e
);
1366 private Pair
<Long
, List
<SendMessageResult
>> sendMessage(
1367 SignalServiceDataMessage
.Builder messageBuilder
, Set
<RecipientId
> recipientIds
1368 ) throws IOException
{
1369 final var timestamp
= System
.currentTimeMillis();
1370 messageBuilder
.withTimestamp(timestamp
);
1371 getOrCreateMessagePipe();
1372 getOrCreateUnidentifiedMessagePipe();
1373 SignalServiceDataMessage message
= null;
1375 message
= messageBuilder
.build();
1376 if (message
.getGroupContext().isPresent()) {
1378 var messageSender
= createMessageSender();
1379 final var isRecipientUpdate
= false;
1380 final var recipientIdList
= new ArrayList
<>(recipientIds
);
1381 final var addresses
= recipientIdList
.stream()
1382 .map(this::resolveSignalServiceAddress
)
1383 .collect(Collectors
.toList());
1384 var result
= messageSender
.sendMessage(addresses
,
1385 unidentifiedAccessHelper
.getAccessFor(recipientIdList
),
1389 for (var r
: result
) {
1390 if (r
.getIdentityFailure() != null) {
1391 final var recipientId
= resolveRecipient(r
.getAddress());
1392 final var newIdentity
= account
.getIdentityKeyStore()
1393 .saveIdentity(recipientId
, r
.getIdentityFailure().getIdentityKey(), new Date());
1395 account
.getSessionStore().archiveSessions(recipientId
);
1400 return new Pair
<>(timestamp
, result
);
1401 } catch (UntrustedIdentityException e
) {
1402 return new Pair
<>(timestamp
, List
.of());
1405 // Send to all individually, so sync messages are sent correctly
1406 messageBuilder
.withProfileKey(account
.getProfileKey().serialize());
1407 var results
= new ArrayList
<SendMessageResult
>(recipientIds
.size());
1408 for (var recipientId
: recipientIds
) {
1409 final var contact
= account
.getContactStore().getContact(recipientId
);
1410 final var expirationTime
= contact
!= null ? contact
.getMessageExpirationTime() : 0;
1411 messageBuilder
.withExpiration(expirationTime
);
1412 message
= messageBuilder
.build();
1413 results
.add(sendMessage(recipientId
, message
));
1415 return new Pair
<>(timestamp
, results
);
1418 if (message
!= null && message
.isEndSession()) {
1419 for (var recipient
: recipientIds
) {
1420 handleEndSession(recipient
);
1426 private Pair
<Long
, SendMessageResult
> sendSelfMessage(
1427 SignalServiceDataMessage
.Builder messageBuilder
1428 ) throws IOException
{
1429 final var timestamp
= System
.currentTimeMillis();
1430 messageBuilder
.withTimestamp(timestamp
);
1431 getOrCreateMessagePipe();
1432 getOrCreateUnidentifiedMessagePipe();
1433 final var recipientId
= account
.getSelfRecipientId();
1435 final var contact
= account
.getContactStore().getContact(recipientId
);
1436 final var expirationTime
= contact
!= null ? contact
.getMessageExpirationTime() : 0;
1437 messageBuilder
.withExpiration(expirationTime
);
1439 var message
= messageBuilder
.build();
1440 final var result
= sendSelfMessage(message
);
1441 return new Pair
<>(timestamp
, result
);
1444 private SendMessageResult
sendSelfMessage(SignalServiceDataMessage message
) throws IOException
{
1445 var messageSender
= createMessageSender();
1447 var recipientId
= account
.getSelfRecipientId();
1449 final var unidentifiedAccess
= unidentifiedAccessHelper
.getAccessFor(recipientId
);
1450 var recipient
= resolveSignalServiceAddress(recipientId
);
1451 var transcript
= new SentTranscriptMessage(Optional
.of(recipient
),
1452 message
.getTimestamp(),
1454 message
.getExpiresInSeconds(),
1455 Map
.of(recipient
, unidentifiedAccess
.isPresent()),
1457 var syncMessage
= SignalServiceSyncMessage
.forSentTranscript(transcript
);
1460 var startTime
= System
.currentTimeMillis();
1461 messageSender
.sendMessage(syncMessage
, unidentifiedAccess
);
1462 return SendMessageResult
.success(recipient
,
1463 unidentifiedAccess
.isPresent(),
1465 System
.currentTimeMillis() - startTime
);
1466 } catch (UntrustedIdentityException e
) {
1467 return SendMessageResult
.identityFailure(recipient
, e
.getIdentityKey());
1471 private SendMessageResult
sendMessage(
1472 RecipientId recipientId
, SignalServiceDataMessage message
1473 ) throws IOException
{
1474 var messageSender
= createMessageSender();
1476 final var address
= resolveSignalServiceAddress(recipientId
);
1479 return messageSender
.sendMessage(address
, unidentifiedAccessHelper
.getAccessFor(recipientId
), message
);
1480 } catch (UnregisteredUserException e
) {
1481 final var newRecipientId
= refreshRegisteredUser(recipientId
);
1482 return messageSender
.sendMessage(resolveSignalServiceAddress(newRecipientId
),
1483 unidentifiedAccessHelper
.getAccessFor(newRecipientId
),
1486 } catch (UntrustedIdentityException e
) {
1487 return SendMessageResult
.identityFailure(address
, e
.getIdentityKey());
1491 private SendMessageResult
sendNullMessage(RecipientId recipientId
) throws IOException
{
1492 var messageSender
= createMessageSender();
1494 final var address
= resolveSignalServiceAddress(recipientId
);
1497 return messageSender
.sendNullMessage(address
, unidentifiedAccessHelper
.getAccessFor(recipientId
));
1498 } catch (UnregisteredUserException e
) {
1499 final var newRecipientId
= refreshRegisteredUser(recipientId
);
1500 final var newAddress
= resolveSignalServiceAddress(newRecipientId
);
1501 return messageSender
.sendNullMessage(newAddress
, unidentifiedAccessHelper
.getAccessFor(newRecipientId
));
1503 } catch (UntrustedIdentityException e
) {
1504 return SendMessageResult
.identityFailure(address
, e
.getIdentityKey());
1508 private SignalServiceContent
decryptMessage(SignalServiceEnvelope envelope
) throws InvalidMetadataMessageException
, ProtocolInvalidMessageException
, ProtocolDuplicateMessageException
, ProtocolLegacyMessageException
, ProtocolInvalidKeyIdException
, InvalidMetadataVersionException
, ProtocolInvalidVersionException
, ProtocolNoSessionException
, ProtocolInvalidKeyException
, SelfSendException
, UnsupportedDataMessageException
, org
.whispersystems
.libsignal
.UntrustedIdentityException
{
1509 var cipher
= new SignalServiceCipher(account
.getSelfAddress(),
1510 account
.getSignalProtocolStore(),
1511 certificateValidator
);
1513 return cipher
.decrypt(envelope
);
1514 } catch (ProtocolUntrustedIdentityException e
) {
1515 if (e
.getCause() instanceof org
.whispersystems
.libsignal
.UntrustedIdentityException
) {
1516 throw (org
.whispersystems
.libsignal
.UntrustedIdentityException
) e
.getCause();
1518 throw new AssertionError(e
);
1522 private void handleEndSession(RecipientId recipientId
) {
1523 account
.getSessionStore().deleteAllSessions(recipientId
);
1526 private List
<HandleAction
> handleSignalServiceDataMessage(
1527 SignalServiceDataMessage message
,
1529 SignalServiceAddress source
,
1530 SignalServiceAddress destination
,
1531 boolean ignoreAttachments
1533 var actions
= new ArrayList
<HandleAction
>();
1534 if (message
.getGroupContext().isPresent()) {
1535 if (message
.getGroupContext().get().getGroupV1().isPresent()) {
1536 var groupInfo
= message
.getGroupContext().get().getGroupV1().get();
1537 var groupId
= GroupId
.v1(groupInfo
.getGroupId());
1538 var group
= getGroup(groupId
);
1539 if (group
== null || group
instanceof GroupInfoV1
) {
1540 var groupV1
= (GroupInfoV1
) group
;
1541 switch (groupInfo
.getType()) {
1543 if (groupV1
== null) {
1544 groupV1
= new GroupInfoV1(groupId
);
1547 if (groupInfo
.getAvatar().isPresent()) {
1548 var avatar
= groupInfo
.getAvatar().get();
1549 downloadGroupAvatar(avatar
, groupV1
.getGroupId());
1552 if (groupInfo
.getName().isPresent()) {
1553 groupV1
.name
= groupInfo
.getName().get();
1556 if (groupInfo
.getMembers().isPresent()) {
1557 groupV1
.addMembers(groupInfo
.getMembers()
1560 .map(this::resolveRecipient
)
1561 .collect(Collectors
.toSet()));
1564 account
.getGroupStore().updateGroup(groupV1
);
1568 if (groupV1
== null && !isSync
) {
1569 actions
.add(new SendGroupInfoRequestAction(source
, groupId
));
1573 if (groupV1
!= null) {
1574 groupV1
.removeMember(resolveRecipient(source
));
1575 account
.getGroupStore().updateGroup(groupV1
);
1580 if (groupV1
!= null && !isSync
) {
1581 actions
.add(new SendGroupInfoAction(source
, groupV1
.getGroupId()));
1586 // Received a group v1 message for a v2 group
1589 if (message
.getGroupContext().get().getGroupV2().isPresent()) {
1590 final var groupContext
= message
.getGroupContext().get().getGroupV2().get();
1591 final var groupMasterKey
= groupContext
.getMasterKey();
1593 getOrMigrateGroup(groupMasterKey
,
1594 groupContext
.getRevision(),
1595 groupContext
.hasSignedGroupChange() ? groupContext
.getSignedGroupChange() : null);
1599 final var conversationPartnerAddress
= isSync ? destination
: source
;
1600 if (conversationPartnerAddress
!= null && message
.isEndSession()) {
1601 handleEndSession(resolveRecipient(conversationPartnerAddress
));
1603 if (message
.isExpirationUpdate() || message
.getBody().isPresent()) {
1604 if (message
.getGroupContext().isPresent()) {
1605 if (message
.getGroupContext().get().getGroupV1().isPresent()) {
1606 var groupInfo
= message
.getGroupContext().get().getGroupV1().get();
1607 var group
= account
.getGroupStore().getOrCreateGroupV1(GroupId
.v1(groupInfo
.getGroupId()));
1608 if (group
!= null) {
1609 if (group
.messageExpirationTime
!= message
.getExpiresInSeconds()) {
1610 group
.messageExpirationTime
= message
.getExpiresInSeconds();
1611 account
.getGroupStore().updateGroup(group
);
1614 } else if (message
.getGroupContext().get().getGroupV2().isPresent()) {
1615 // disappearing message timer already stored in the DecryptedGroup
1617 } else if (conversationPartnerAddress
!= null) {
1618 setExpirationTimer(resolveRecipient(conversationPartnerAddress
), message
.getExpiresInSeconds());
1621 if (!ignoreAttachments
) {
1622 if (message
.getAttachments().isPresent()) {
1623 for (var attachment
: message
.getAttachments().get()) {
1624 downloadAttachment(attachment
);
1627 if (message
.getSharedContacts().isPresent()) {
1628 for (var contact
: message
.getSharedContacts().get()) {
1629 if (contact
.getAvatar().isPresent()) {
1630 downloadAttachment(contact
.getAvatar().get().getAttachment());
1635 if (message
.getProfileKey().isPresent() && message
.getProfileKey().get().length
== 32) {
1636 final ProfileKey profileKey
;
1638 profileKey
= new ProfileKey(message
.getProfileKey().get());
1639 } catch (InvalidInputException e
) {
1640 throw new AssertionError(e
);
1642 if (source
.matches(account
.getSelfAddress())) {
1643 this.account
.setProfileKey(profileKey
);
1645 this.account
.getProfileStore().storeProfileKey(resolveRecipient(source
), profileKey
);
1647 if (message
.getPreviews().isPresent()) {
1648 final var previews
= message
.getPreviews().get();
1649 for (var preview
: previews
) {
1650 if (preview
.getImage().isPresent()) {
1651 downloadAttachment(preview
.getImage().get());
1655 if (message
.getQuote().isPresent()) {
1656 final var quote
= message
.getQuote().get();
1658 for (var quotedAttachment
: quote
.getAttachments()) {
1659 final var thumbnail
= quotedAttachment
.getThumbnail();
1660 if (thumbnail
!= null) {
1661 downloadAttachment(thumbnail
);
1665 if (message
.getSticker().isPresent()) {
1666 final var messageSticker
= message
.getSticker().get();
1667 final var stickerPackId
= StickerPackId
.deserialize(messageSticker
.getPackId());
1668 var sticker
= account
.getStickerStore().getSticker(stickerPackId
);
1669 if (sticker
== null) {
1670 sticker
= new Sticker(stickerPackId
, messageSticker
.getPackKey());
1671 account
.getStickerStore().updateSticker(sticker
);
1677 private GroupInfoV2
getOrMigrateGroup(
1678 final GroupMasterKey groupMasterKey
, final int revision
, final byte[] signedGroupChange
1680 final var groupSecretParams
= GroupSecretParams
.deriveFromMasterKey(groupMasterKey
);
1682 var groupId
= GroupUtils
.getGroupIdV2(groupSecretParams
);
1683 var groupInfo
= getGroup(groupId
);
1684 final GroupInfoV2 groupInfoV2
;
1685 if (groupInfo
instanceof GroupInfoV1
) {
1686 // Received a v2 group message for a v1 group, we need to locally migrate the group
1687 account
.getGroupStore().deleteGroupV1(((GroupInfoV1
) groupInfo
).getGroupId());
1688 groupInfoV2
= new GroupInfoV2(groupId
, groupMasterKey
);
1689 logger
.info("Locally migrated group {} to group v2, id: {}",
1690 groupInfo
.getGroupId().toBase64(),
1691 groupInfoV2
.getGroupId().toBase64());
1692 } else if (groupInfo
instanceof GroupInfoV2
) {
1693 groupInfoV2
= (GroupInfoV2
) groupInfo
;
1695 groupInfoV2
= new GroupInfoV2(groupId
, groupMasterKey
);
1698 if (groupInfoV2
.getGroup() == null || groupInfoV2
.getGroup().getRevision() < revision
) {
1699 DecryptedGroup group
= null;
1700 if (signedGroupChange
!= null
1701 && groupInfoV2
.getGroup() != null
1702 && groupInfoV2
.getGroup().getRevision() + 1 == revision
) {
1703 group
= groupHelper
.getUpdatedDecryptedGroup(groupInfoV2
.getGroup(), signedGroupChange
, groupMasterKey
);
1705 if (group
== null) {
1706 group
= groupHelper
.getDecryptedGroup(groupSecretParams
);
1708 if (group
!= null) {
1709 storeProfileKeysFromMembers(group
);
1710 final var avatar
= group
.getAvatar();
1711 if (avatar
!= null && !avatar
.isEmpty()) {
1712 downloadGroupAvatar(groupId
, groupSecretParams
, avatar
);
1715 groupInfoV2
.setGroup(group
, this::resolveRecipient
);
1716 account
.getGroupStore().updateGroup(groupInfoV2
);
1722 private void storeProfileKeysFromMembers(final DecryptedGroup group
) {
1723 for (var member
: group
.getMembersList()) {
1724 final var uuid
= UuidUtil
.parseOrThrow(member
.getUuid().toByteArray());
1725 final var recipientId
= account
.getRecipientStore().resolveRecipient(uuid
);
1727 account
.getProfileStore()
1728 .storeProfileKey(recipientId
, new ProfileKey(member
.getProfileKey().toByteArray()));
1729 } catch (InvalidInputException ignored
) {
1734 private void retryFailedReceivedMessages(ReceiveMessageHandler handler
, boolean ignoreAttachments
) {
1735 Set
<HandleAction
> queuedActions
= new HashSet
<>();
1736 for (var cachedMessage
: account
.getMessageCache().getCachedMessages()) {
1737 var actions
= retryFailedReceivedMessage(handler
, ignoreAttachments
, cachedMessage
);
1738 if (actions
!= null) {
1739 queuedActions
.addAll(actions
);
1742 for (var action
: queuedActions
) {
1744 action
.execute(this);
1745 } catch (Throwable e
) {
1746 logger
.warn("Message action failed.", e
);
1751 private List
<HandleAction
> retryFailedReceivedMessage(
1752 final ReceiveMessageHandler handler
, final boolean ignoreAttachments
, final CachedMessage cachedMessage
1754 var envelope
= cachedMessage
.loadEnvelope();
1755 if (envelope
== null) {
1758 SignalServiceContent content
= null;
1759 List
<HandleAction
> actions
= null;
1760 if (!envelope
.isReceipt()) {
1762 content
= decryptMessage(envelope
);
1763 } catch (org
.whispersystems
.libsignal
.UntrustedIdentityException e
) {
1764 if (!envelope
.hasSource()) {
1765 final var identifier
= ((org
.whispersystems
.libsignal
.UntrustedIdentityException
) e
).getName();
1766 final var recipientId
= resolveRecipient(identifier
);
1768 account
.getMessageCache().replaceSender(cachedMessage
, recipientId
);
1769 } catch (IOException ioException
) {
1770 logger
.warn("Failed to move cached message to recipient folder: {}", ioException
.getMessage());
1774 } catch (Exception er
) {
1775 // All other errors are not recoverable, so delete the cached message
1776 cachedMessage
.delete();
1779 actions
= handleMessage(envelope
, content
, ignoreAttachments
);
1781 handler
.handleMessage(envelope
, content
, null);
1782 cachedMessage
.delete();
1786 public void receiveMessages(
1789 boolean returnOnTimeout
,
1790 boolean ignoreAttachments
,
1791 ReceiveMessageHandler handler
1792 ) throws IOException
{
1793 retryFailedReceivedMessages(handler
, ignoreAttachments
);
1795 Set
<HandleAction
> queuedActions
= null;
1797 final var messagePipe
= getOrCreateMessagePipe();
1799 var hasCaughtUpWithOldMessages
= false;
1802 SignalServiceEnvelope envelope
;
1803 SignalServiceContent content
= null;
1804 Exception exception
= null;
1805 final CachedMessage
[] cachedMessage
= {null};
1807 var result
= messagePipe
.readOrEmpty(timeout
, unit
, envelope1
-> {
1808 final var recipientId
= envelope1
.hasSource()
1809 ?
resolveRecipient(envelope1
.getSourceIdentifier())
1811 // store message on disk, before acknowledging receipt to the server
1812 cachedMessage
[0] = account
.getMessageCache().cacheMessage(envelope1
, recipientId
);
1814 if (result
.isPresent()) {
1815 envelope
= result
.get();
1817 // Received indicator that server queue is empty
1818 hasCaughtUpWithOldMessages
= true;
1820 if (queuedActions
!= null) {
1821 for (var action
: queuedActions
) {
1823 action
.execute(this);
1824 } catch (Throwable e
) {
1825 logger
.warn("Message action failed.", e
);
1828 queuedActions
.clear();
1829 queuedActions
= null;
1832 // Continue to wait another timeout for new messages
1835 } catch (TimeoutException e
) {
1836 if (returnOnTimeout
) return;
1840 if (envelope
.hasSource()) {
1841 // Store uuid if we don't have it already
1842 resolveRecipientTrusted(envelope
.getSourceAddress());
1844 final var notAGroupMember
= isNotAGroupMember(envelope
, content
);
1845 if (!envelope
.isReceipt()) {
1847 content
= decryptMessage(envelope
);
1848 } catch (Exception e
) {
1851 var actions
= handleMessage(envelope
, content
, ignoreAttachments
);
1852 if (exception
instanceof ProtocolInvalidMessageException
) {
1853 final var sender
= resolveRecipient(((ProtocolInvalidMessageException
) exception
).getSender());
1854 logger
.debug("Received invalid message, queuing renew session action.");
1855 actions
.add(new RenewSessionAction(sender
));
1857 if (hasCaughtUpWithOldMessages
) {
1858 for (var action
: actions
) {
1860 action
.execute(this);
1861 } catch (Throwable e
) {
1862 logger
.warn("Message action failed.", e
);
1866 if (queuedActions
== null) {
1867 queuedActions
= new HashSet
<>();
1869 queuedActions
.addAll(actions
);
1872 if (isMessageBlocked(envelope
, content
)) {
1873 logger
.info("Ignoring a message from blocked user/group: {}", envelope
.getTimestamp());
1874 } else if (notAGroupMember
) {
1875 logger
.info("Ignoring a message from a non group member: {}", envelope
.getTimestamp());
1877 handler
.handleMessage(envelope
, content
, exception
);
1879 if (cachedMessage
[0] != null) {
1880 if (exception
instanceof org
.whispersystems
.libsignal
.UntrustedIdentityException
) {
1881 final var identifier
= ((org
.whispersystems
.libsignal
.UntrustedIdentityException
) exception
).getName();
1882 final var recipientId
= resolveRecipient(identifier
);
1883 queuedActions
.add(new RetrieveProfileAction(recipientId
));
1884 if (!envelope
.hasSource()) {
1886 cachedMessage
[0] = account
.getMessageCache().replaceSender(cachedMessage
[0], recipientId
);
1887 } catch (IOException ioException
) {
1888 logger
.warn("Failed to move cached message to recipient folder: {}",
1889 ioException
.getMessage());
1893 cachedMessage
[0].delete();
1899 private boolean isMessageBlocked(
1900 SignalServiceEnvelope envelope
, SignalServiceContent content
1902 SignalServiceAddress source
;
1903 if (!envelope
.isUnidentifiedSender() && envelope
.hasSource()) {
1904 source
= envelope
.getSourceAddress();
1905 } else if (content
!= null) {
1906 source
= content
.getSender();
1910 final var recipientId
= resolveRecipient(source
);
1911 if (isContactBlocked(recipientId
)) {
1915 if (content
!= null && content
.getDataMessage().isPresent()) {
1916 var message
= content
.getDataMessage().get();
1917 if (message
.getGroupContext().isPresent()) {
1918 var groupId
= GroupUtils
.getGroupId(message
.getGroupContext().get());
1919 var group
= getGroup(groupId
);
1920 if (group
!= null && group
.isBlocked()) {
1928 public boolean isContactBlocked(final String identifier
) throws InvalidNumberException
{
1929 final var recipientId
= canonicalizeAndResolveRecipient(identifier
);
1930 return isContactBlocked(recipientId
);
1933 private boolean isContactBlocked(final RecipientId recipientId
) {
1934 var sourceContact
= account
.getContactStore().getContact(recipientId
);
1935 return sourceContact
!= null && sourceContact
.isBlocked();
1938 private boolean isNotAGroupMember(
1939 SignalServiceEnvelope envelope
, SignalServiceContent content
1941 SignalServiceAddress source
;
1942 if (!envelope
.isUnidentifiedSender() && envelope
.hasSource()) {
1943 source
= envelope
.getSourceAddress();
1944 } else if (content
!= null) {
1945 source
= content
.getSender();
1950 if (content
!= null && content
.getDataMessage().isPresent()) {
1951 var message
= content
.getDataMessage().get();
1952 if (message
.getGroupContext().isPresent()) {
1953 if (message
.getGroupContext().get().getGroupV1().isPresent()) {
1954 var groupInfo
= message
.getGroupContext().get().getGroupV1().get();
1955 if (groupInfo
.getType() == SignalServiceGroup
.Type
.QUIT
) {
1959 var groupId
= GroupUtils
.getGroupId(message
.getGroupContext().get());
1960 var group
= getGroup(groupId
);
1961 if (group
!= null && !group
.isMember(resolveRecipient(source
))) {
1969 private List
<HandleAction
> handleMessage(
1970 SignalServiceEnvelope envelope
, SignalServiceContent content
, boolean ignoreAttachments
1972 var actions
= new ArrayList
<HandleAction
>();
1973 if (content
!= null) {
1974 final SignalServiceAddress sender
;
1975 if (!envelope
.isUnidentifiedSender() && envelope
.hasSource()) {
1976 sender
= envelope
.getSourceAddress();
1978 sender
= content
.getSender();
1981 if (content
.getDataMessage().isPresent()) {
1982 var message
= content
.getDataMessage().get();
1984 if (content
.isNeedsReceipt()) {
1985 actions
.add(new SendReceiptAction(sender
, message
.getTimestamp()));
1988 actions
.addAll(handleSignalServiceDataMessage(message
,
1991 account
.getSelfAddress(),
1992 ignoreAttachments
));
1994 if (content
.getSyncMessage().isPresent()) {
1995 account
.setMultiDevice(true);
1996 var syncMessage
= content
.getSyncMessage().get();
1997 if (syncMessage
.getSent().isPresent()) {
1998 var message
= syncMessage
.getSent().get();
1999 final var destination
= message
.getDestination().orNull();
2000 actions
.addAll(handleSignalServiceDataMessage(message
.getMessage(),
2004 ignoreAttachments
));
2006 if (syncMessage
.getRequest().isPresent() && account
.isMasterDevice()) {
2007 var rm
= syncMessage
.getRequest().get();
2008 if (rm
.isContactsRequest()) {
2009 actions
.add(SendSyncContactsAction
.create());
2011 if (rm
.isGroupsRequest()) {
2012 actions
.add(SendSyncGroupsAction
.create());
2014 if (rm
.isBlockedListRequest()) {
2015 actions
.add(SendSyncBlockedListAction
.create());
2017 // TODO Handle rm.isConfigurationRequest(); rm.isKeysRequest();
2019 if (syncMessage
.getGroups().isPresent()) {
2020 File tmpFile
= null;
2022 tmpFile
= IOUtils
.createTempFile();
2023 final var groupsMessage
= syncMessage
.getGroups().get();
2024 try (var attachmentAsStream
= retrieveAttachmentAsStream(groupsMessage
.asPointer(), tmpFile
)) {
2025 var s
= new DeviceGroupsInputStream(attachmentAsStream
);
2027 while ((g
= s
.read()) != null) {
2028 var syncGroup
= account
.getGroupStore().getOrCreateGroupV1(GroupId
.v1(g
.getId()));
2029 if (syncGroup
!= null) {
2030 if (g
.getName().isPresent()) {
2031 syncGroup
.name
= g
.getName().get();
2033 syncGroup
.addMembers(g
.getMembers()
2035 .map(this::resolveRecipient
)
2036 .collect(Collectors
.toSet()));
2037 if (!g
.isActive()) {
2038 syncGroup
.removeMember(account
.getSelfRecipientId());
2040 // Add ourself to the member set as it's marked as active
2041 syncGroup
.addMembers(List
.of(account
.getSelfRecipientId()));
2043 syncGroup
.blocked
= g
.isBlocked();
2044 if (g
.getColor().isPresent()) {
2045 syncGroup
.color
= g
.getColor().get();
2048 if (g
.getAvatar().isPresent()) {
2049 downloadGroupAvatar(g
.getAvatar().get(), syncGroup
.getGroupId());
2051 syncGroup
.archived
= g
.isArchived();
2052 account
.getGroupStore().updateGroup(syncGroup
);
2056 } catch (Exception e
) {
2057 logger
.warn("Failed to handle received sync groups “{}”, ignoring: {}",
2061 if (tmpFile
!= null) {
2063 Files
.delete(tmpFile
.toPath());
2064 } catch (IOException e
) {
2065 logger
.warn("Failed to delete received groups temp file “{}”, ignoring: {}",
2072 if (syncMessage
.getBlockedList().isPresent()) {
2073 final var blockedListMessage
= syncMessage
.getBlockedList().get();
2074 for (var address
: blockedListMessage
.getAddresses()) {
2075 setContactBlocked(resolveRecipient(address
), true);
2077 for (var groupId
: blockedListMessage
.getGroupIds()
2079 .map(GroupId
::unknownVersion
)
2080 .collect(Collectors
.toSet())) {
2082 setGroupBlocked(groupId
, true);
2083 } catch (GroupNotFoundException e
) {
2084 logger
.warn("BlockedListMessage contained groupID that was not found in GroupStore: {}",
2085 groupId
.toBase64());
2089 if (syncMessage
.getContacts().isPresent()) {
2090 File tmpFile
= null;
2092 tmpFile
= IOUtils
.createTempFile();
2093 final var contactsMessage
= syncMessage
.getContacts().get();
2094 try (var attachmentAsStream
= retrieveAttachmentAsStream(contactsMessage
.getContactsStream()
2095 .asPointer(), tmpFile
)) {
2096 var s
= new DeviceContactsInputStream(attachmentAsStream
);
2098 while ((c
= s
.read()) != null) {
2099 if (c
.getAddress().matches(account
.getSelfAddress()) && c
.getProfileKey().isPresent()) {
2100 account
.setProfileKey(c
.getProfileKey().get());
2102 final var recipientId
= resolveRecipientTrusted(c
.getAddress());
2103 var contact
= account
.getContactStore().getContact(recipientId
);
2104 final var builder
= contact
== null
2105 ? Contact
.newBuilder()
2106 : Contact
.newBuilder(contact
);
2107 if (c
.getName().isPresent()) {
2108 builder
.withName(c
.getName().get());
2110 if (c
.getColor().isPresent()) {
2111 builder
.withColor(c
.getColor().get());
2113 if (c
.getProfileKey().isPresent()) {
2114 account
.getProfileStore().storeProfileKey(recipientId
, c
.getProfileKey().get());
2116 if (c
.getVerified().isPresent()) {
2117 final var verifiedMessage
= c
.getVerified().get();
2118 account
.getIdentityKeyStore()
2119 .setIdentityTrustLevel(resolveRecipientTrusted(verifiedMessage
.getDestination()),
2120 verifiedMessage
.getIdentityKey(),
2121 TrustLevel
.fromVerifiedState(verifiedMessage
.getVerified()));
2123 if (c
.getExpirationTimer().isPresent()) {
2124 builder
.withMessageExpirationTime(c
.getExpirationTimer().get());
2126 builder
.withBlocked(c
.isBlocked());
2127 builder
.withArchived(c
.isArchived());
2128 account
.getContactStore().storeContact(recipientId
, builder
.build());
2130 if (c
.getAvatar().isPresent()) {
2131 downloadContactAvatar(c
.getAvatar().get(), c
.getAddress());
2135 } catch (Exception e
) {
2136 logger
.warn("Failed to handle received sync contacts “{}”, ignoring: {}",
2140 if (tmpFile
!= null) {
2142 Files
.delete(tmpFile
.toPath());
2143 } catch (IOException e
) {
2144 logger
.warn("Failed to delete received contacts temp file “{}”, ignoring: {}",
2151 if (syncMessage
.getVerified().isPresent()) {
2152 final var verifiedMessage
= syncMessage
.getVerified().get();
2153 account
.getIdentityKeyStore()
2154 .setIdentityTrustLevel(resolveRecipientTrusted(verifiedMessage
.getDestination()),
2155 verifiedMessage
.getIdentityKey(),
2156 TrustLevel
.fromVerifiedState(verifiedMessage
.getVerified()));
2158 if (syncMessage
.getStickerPackOperations().isPresent()) {
2159 final var stickerPackOperationMessages
= syncMessage
.getStickerPackOperations().get();
2160 for (var m
: stickerPackOperationMessages
) {
2161 if (!m
.getPackId().isPresent()) {
2164 final var stickerPackId
= StickerPackId
.deserialize(m
.getPackId().get());
2165 var sticker
= account
.getStickerStore().getSticker(stickerPackId
);
2166 if (sticker
== null) {
2167 if (!m
.getPackKey().isPresent()) {
2170 sticker
= new Sticker(stickerPackId
, m
.getPackKey().get());
2172 sticker
.setInstalled(!m
.getType().isPresent()
2173 || m
.getType().get() == StickerPackOperationMessage
.Type
.INSTALL
);
2174 account
.getStickerStore().updateSticker(sticker
);
2177 if (syncMessage
.getFetchType().isPresent()) {
2178 switch (syncMessage
.getFetchType().get()) {
2180 getRecipientProfile(account
.getSelfRecipientId(), true);
2181 case STORAGE_MANIFEST
:
2185 if (syncMessage
.getKeys().isPresent()) {
2186 final var keysMessage
= syncMessage
.getKeys().get();
2187 if (keysMessage
.getStorageService().isPresent()) {
2188 final var storageKey
= keysMessage
.getStorageService().get();
2189 account
.setStorageKey(storageKey
);
2192 if (syncMessage
.getConfiguration().isPresent()) {
2200 private void downloadContactAvatar(SignalServiceAttachment avatar
, SignalServiceAddress address
) {
2202 avatarStore
.storeContactAvatar(address
, outputStream
-> retrieveAttachment(avatar
, outputStream
));
2203 } catch (IOException e
) {
2204 logger
.warn("Failed to download avatar for contact {}, ignoring: {}", address
, e
.getMessage());
2208 private void downloadGroupAvatar(SignalServiceAttachment avatar
, GroupId groupId
) {
2210 avatarStore
.storeGroupAvatar(groupId
, outputStream
-> retrieveAttachment(avatar
, outputStream
));
2211 } catch (IOException e
) {
2212 logger
.warn("Failed to download avatar for group {}, ignoring: {}", groupId
.toBase64(), e
.getMessage());
2216 private void downloadGroupAvatar(GroupId groupId
, GroupSecretParams groupSecretParams
, String cdnKey
) {
2218 avatarStore
.storeGroupAvatar(groupId
,
2219 outputStream
-> retrieveGroupV2Avatar(groupSecretParams
, cdnKey
, outputStream
));
2220 } catch (IOException e
) {
2221 logger
.warn("Failed to download avatar for group {}, ignoring: {}", groupId
.toBase64(), e
.getMessage());
2225 private void downloadProfileAvatar(
2226 SignalServiceAddress address
, String avatarPath
, ProfileKey profileKey
2229 avatarStore
.storeProfileAvatar(address
,
2230 outputStream
-> retrieveProfileAvatar(avatarPath
, profileKey
, outputStream
));
2231 } catch (Throwable e
) {
2232 logger
.warn("Failed to download profile avatar, ignoring: {}", e
.getMessage());
2236 public File
getAttachmentFile(SignalServiceAttachmentRemoteId attachmentId
) {
2237 return attachmentStore
.getAttachmentFile(attachmentId
);
2240 private void downloadAttachment(final SignalServiceAttachment attachment
) {
2241 if (!attachment
.isPointer()) {
2242 logger
.warn("Invalid state, can't store an attachment stream.");
2245 var pointer
= attachment
.asPointer();
2246 if (pointer
.getPreview().isPresent()) {
2247 final var preview
= pointer
.getPreview().get();
2249 attachmentStore
.storeAttachmentPreview(pointer
.getRemoteId(),
2250 outputStream
-> outputStream
.write(preview
, 0, preview
.length
));
2251 } catch (IOException e
) {
2252 logger
.warn("Failed to download attachment preview, ignoring: {}", e
.getMessage());
2257 attachmentStore
.storeAttachment(pointer
.getRemoteId(),
2258 outputStream
-> retrieveAttachmentPointer(pointer
, outputStream
));
2259 } catch (IOException e
) {
2260 logger
.warn("Failed to download attachment ({}), ignoring: {}", pointer
.getRemoteId(), e
.getMessage());
2264 private void retrieveGroupV2Avatar(
2265 GroupSecretParams groupSecretParams
, String cdnKey
, OutputStream outputStream
2266 ) throws IOException
{
2267 var groupOperations
= groupsV2Operations
.forGroup(groupSecretParams
);
2269 var tmpFile
= IOUtils
.createTempFile();
2270 try (InputStream input
= messageReceiver
.retrieveGroupsV2ProfileAvatar(cdnKey
,
2272 ServiceConfig
.AVATAR_DOWNLOAD_FAILSAFE_MAX_SIZE
)) {
2273 var encryptedData
= IOUtils
.readFully(input
);
2275 var decryptedData
= groupOperations
.decryptAvatar(encryptedData
);
2276 outputStream
.write(decryptedData
);
2279 Files
.delete(tmpFile
.toPath());
2280 } catch (IOException e
) {
2281 logger
.warn("Failed to delete received group avatar temp file “{}”, ignoring: {}",
2288 private void retrieveProfileAvatar(
2289 String avatarPath
, ProfileKey profileKey
, OutputStream outputStream
2290 ) throws IOException
{
2291 var tmpFile
= IOUtils
.createTempFile();
2292 try (var input
= messageReceiver
.retrieveProfileAvatar(avatarPath
,
2295 ServiceConfig
.AVATAR_DOWNLOAD_FAILSAFE_MAX_SIZE
)) {
2296 // Use larger buffer size to prevent AssertionError: Need: 12272 but only have: 8192 ...
2297 IOUtils
.copyStream(input
, outputStream
, (int) ServiceConfig
.AVATAR_DOWNLOAD_FAILSAFE_MAX_SIZE
);
2300 Files
.delete(tmpFile
.toPath());
2301 } catch (IOException e
) {
2302 logger
.warn("Failed to delete received profile avatar temp file “{}”, ignoring: {}",
2309 private void retrieveAttachment(
2310 final SignalServiceAttachment attachment
, final OutputStream outputStream
2311 ) throws IOException
{
2312 if (attachment
.isPointer()) {
2313 var pointer
= attachment
.asPointer();
2314 retrieveAttachmentPointer(pointer
, outputStream
);
2316 var stream
= attachment
.asStream();
2317 IOUtils
.copyStream(stream
.getInputStream(), outputStream
);
2321 private void retrieveAttachmentPointer(
2322 SignalServiceAttachmentPointer pointer
, OutputStream outputStream
2323 ) throws IOException
{
2324 var tmpFile
= IOUtils
.createTempFile();
2325 try (var input
= retrieveAttachmentAsStream(pointer
, tmpFile
)) {
2326 IOUtils
.copyStream(input
, outputStream
);
2327 } catch (MissingConfigurationException
| InvalidMessageException e
) {
2328 throw new IOException(e
);
2331 Files
.delete(tmpFile
.toPath());
2332 } catch (IOException e
) {
2333 logger
.warn("Failed to delete received attachment temp file “{}”, ignoring: {}",
2340 private InputStream
retrieveAttachmentAsStream(
2341 SignalServiceAttachmentPointer pointer
, File tmpFile
2342 ) throws IOException
, InvalidMessageException
, MissingConfigurationException
{
2343 return messageReceiver
.retrieveAttachment(pointer
, tmpFile
, ServiceConfig
.MAX_ATTACHMENT_SIZE
);
2346 void sendGroups() throws IOException
, UntrustedIdentityException
{
2347 var groupsFile
= IOUtils
.createTempFile();
2350 try (OutputStream fos
= new FileOutputStream(groupsFile
)) {
2351 var out
= new DeviceGroupsOutputStream(fos
);
2352 for (var record : getGroups()) {
2353 if (record instanceof GroupInfoV1
) {
2354 var groupInfo
= (GroupInfoV1
) record;
2355 out
.write(new DeviceGroup(groupInfo
.getGroupId().serialize(),
2356 Optional
.fromNullable(groupInfo
.name
),
2357 groupInfo
.getMembers()
2359 .map(this::resolveSignalServiceAddress
)
2360 .collect(Collectors
.toList()),
2361 createGroupAvatarAttachment(groupInfo
.getGroupId()),
2362 groupInfo
.isMember(account
.getSelfRecipientId()),
2363 Optional
.of(groupInfo
.messageExpirationTime
),
2364 Optional
.fromNullable(groupInfo
.color
),
2367 groupInfo
.archived
));
2372 if (groupsFile
.exists() && groupsFile
.length() > 0) {
2373 try (var groupsFileStream
= new FileInputStream(groupsFile
)) {
2374 var attachmentStream
= SignalServiceAttachment
.newStreamBuilder()
2375 .withStream(groupsFileStream
)
2376 .withContentType("application/octet-stream")
2377 .withLength(groupsFile
.length())
2380 sendSyncMessage(SignalServiceSyncMessage
.forGroups(attachmentStream
));
2385 Files
.delete(groupsFile
.toPath());
2386 } catch (IOException e
) {
2387 logger
.warn("Failed to delete groups temp file “{}”, ignoring: {}", groupsFile
, e
.getMessage());
2392 public void sendContacts() throws IOException
, UntrustedIdentityException
{
2393 var contactsFile
= IOUtils
.createTempFile();
2396 try (OutputStream fos
= new FileOutputStream(contactsFile
)) {
2397 var out
= new DeviceContactsOutputStream(fos
);
2398 for (var contactPair
: account
.getContactStore().getContacts()) {
2399 final var recipientId
= contactPair
.first();
2400 final var contact
= contactPair
.second();
2401 final var address
= resolveSignalServiceAddress(recipientId
);
2403 var currentIdentity
= account
.getIdentityKeyStore().getIdentity(recipientId
);
2404 VerifiedMessage verifiedMessage
= null;
2405 if (currentIdentity
!= null) {
2406 verifiedMessage
= new VerifiedMessage(address
,
2407 currentIdentity
.getIdentityKey(),
2408 currentIdentity
.getTrustLevel().toVerifiedState(),
2409 currentIdentity
.getDateAdded().getTime());
2412 var profileKey
= account
.getProfileStore().getProfileKey(recipientId
);
2413 out
.write(new DeviceContact(address
,
2414 Optional
.fromNullable(contact
.getName()),
2415 createContactAvatarAttachment(address
),
2416 Optional
.fromNullable(contact
.getColor()),
2417 Optional
.fromNullable(verifiedMessage
),
2418 Optional
.fromNullable(profileKey
),
2419 contact
.isBlocked(),
2420 Optional
.of(contact
.getMessageExpirationTime()),
2422 contact
.isArchived()));
2425 if (account
.getProfileKey() != null) {
2426 // Send our own profile key as well
2427 out
.write(new DeviceContact(account
.getSelfAddress(),
2432 Optional
.of(account
.getProfileKey()),
2440 if (contactsFile
.exists() && contactsFile
.length() > 0) {
2441 try (var contactsFileStream
= new FileInputStream(contactsFile
)) {
2442 var attachmentStream
= SignalServiceAttachment
.newStreamBuilder()
2443 .withStream(contactsFileStream
)
2444 .withContentType("application/octet-stream")
2445 .withLength(contactsFile
.length())
2448 sendSyncMessage(SignalServiceSyncMessage
.forContacts(new ContactsMessage(attachmentStream
, true)));
2453 Files
.delete(contactsFile
.toPath());
2454 } catch (IOException e
) {
2455 logger
.warn("Failed to delete contacts temp file “{}”, ignoring: {}", contactsFile
, e
.getMessage());
2460 void sendBlockedList() throws IOException
, UntrustedIdentityException
{
2461 var addresses
= new ArrayList
<SignalServiceAddress
>();
2462 for (var record : account
.getContactStore().getContacts()) {
2463 if (record.second().isBlocked()) {
2464 addresses
.add(resolveSignalServiceAddress(record.first()));
2467 var groupIds
= new ArrayList
<byte[]>();
2468 for (var record : getGroups()) {
2469 if (record.isBlocked()) {
2470 groupIds
.add(record.getGroupId().serialize());
2473 sendSyncMessage(SignalServiceSyncMessage
.forBlocked(new BlockedListMessage(addresses
, groupIds
)));
2476 private void sendVerifiedMessage(
2477 SignalServiceAddress destination
, IdentityKey identityKey
, TrustLevel trustLevel
2478 ) throws IOException
, UntrustedIdentityException
{
2479 var verifiedMessage
= new VerifiedMessage(destination
,
2481 trustLevel
.toVerifiedState(),
2482 System
.currentTimeMillis());
2483 sendSyncMessage(SignalServiceSyncMessage
.forVerified(verifiedMessage
));
2486 public List
<Pair
<RecipientId
, Contact
>> getContacts() {
2487 return account
.getContactStore().getContacts();
2490 public String
getContactOrProfileName(String number
) throws InvalidNumberException
{
2491 final var recipientId
= canonicalizeAndResolveRecipient(number
);
2492 final var recipient
= account
.getRecipientStore().getRecipient(recipientId
);
2493 if (recipient
== null) {
2497 if (recipient
.getContact() != null && !Util
.isEmpty(recipient
.getContact().getName())) {
2498 return recipient
.getContact().getName();
2501 if (recipient
.getProfile() != null && recipient
.getProfile() != null) {
2502 return recipient
.getProfile().getDisplayName();
2508 public GroupInfo
getGroup(GroupId groupId
) {
2509 final var group
= account
.getGroupStore().getGroup(groupId
);
2510 if (group
instanceof GroupInfoV2
&& ((GroupInfoV2
) group
).getGroup() == null) {
2511 final var groupSecretParams
= GroupSecretParams
.deriveFromMasterKey(((GroupInfoV2
) group
).getMasterKey());
2512 ((GroupInfoV2
) group
).setGroup(groupHelper
.getDecryptedGroup(groupSecretParams
), this::resolveRecipient
);
2513 account
.getGroupStore().updateGroup(group
);
2518 public List
<IdentityInfo
> getIdentities() {
2519 return account
.getIdentityKeyStore().getIdentities();
2522 public List
<IdentityInfo
> getIdentities(String number
) throws InvalidNumberException
{
2523 final var identity
= account
.getIdentityKeyStore().getIdentity(canonicalizeAndResolveRecipient(number
));
2524 return identity
== null ? List
.of() : List
.of(identity
);
2528 * Trust this the identity with this fingerprint
2530 * @param name username of the identity
2531 * @param fingerprint Fingerprint
2533 public boolean trustIdentityVerified(String name
, byte[] fingerprint
) throws InvalidNumberException
{
2534 var recipientId
= canonicalizeAndResolveRecipient(name
);
2535 return trustIdentity(recipientId
,
2536 identityKey
-> Arrays
.equals(identityKey
.serialize(), fingerprint
),
2537 TrustLevel
.TRUSTED_VERIFIED
);
2541 * Trust this the identity with this safety number
2543 * @param name username of the identity
2544 * @param safetyNumber Safety number
2546 public boolean trustIdentityVerifiedSafetyNumber(String name
, String safetyNumber
) throws InvalidNumberException
{
2547 var recipientId
= canonicalizeAndResolveRecipient(name
);
2548 var address
= account
.getRecipientStore().resolveServiceAddress(recipientId
);
2549 return trustIdentity(recipientId
,
2550 identityKey
-> safetyNumber
.equals(computeSafetyNumber(address
, identityKey
)),
2551 TrustLevel
.TRUSTED_VERIFIED
);
2555 * Trust all keys of this identity without verification
2557 * @param name username of the identity
2559 public boolean trustIdentityAllKeys(String name
) throws InvalidNumberException
{
2560 var recipientId
= canonicalizeAndResolveRecipient(name
);
2561 return trustIdentity(recipientId
, identityKey
-> true, TrustLevel
.TRUSTED_UNVERIFIED
);
2564 private boolean trustIdentity(
2565 RecipientId recipientId
, Function
<IdentityKey
, Boolean
> verifier
, TrustLevel trustLevel
2567 var identity
= account
.getIdentityKeyStore().getIdentity(recipientId
);
2568 if (identity
== null) {
2572 if (!verifier
.apply(identity
.getIdentityKey())) {
2576 account
.getIdentityKeyStore().setIdentityTrustLevel(recipientId
, identity
.getIdentityKey(), trustLevel
);
2578 var address
= account
.getRecipientStore().resolveServiceAddress(recipientId
);
2579 sendVerifiedMessage(address
, identity
.getIdentityKey(), trustLevel
);
2580 } catch (IOException
| UntrustedIdentityException e
) {
2581 logger
.warn("Failed to send verification sync message: {}", e
.getMessage());
2587 public String
computeSafetyNumber(
2588 SignalServiceAddress theirAddress
, IdentityKey theirIdentityKey
2590 return Utils
.computeSafetyNumber(ServiceConfig
.capabilities
.isUuid(),
2591 account
.getSelfAddress(),
2592 getIdentityKeyPair().getPublicKey(),
2598 public SignalServiceAddress
resolveSignalServiceAddress(String identifier
) {
2599 var address
= Utils
.getSignalServiceAddressFromIdentifier(identifier
);
2601 return resolveSignalServiceAddress(address
);
2605 public SignalServiceAddress
resolveSignalServiceAddress(SignalServiceAddress address
) {
2606 if (address
.matches(account
.getSelfAddress())) {
2607 return account
.getSelfAddress();
2610 return account
.getRecipientStore().resolveServiceAddress(address
);
2613 public SignalServiceAddress
resolveSignalServiceAddress(RecipientId recipientId
) {
2614 return account
.getRecipientStore().resolveServiceAddress(recipientId
);
2617 public RecipientId
canonicalizeAndResolveRecipient(String identifier
) throws InvalidNumberException
{
2618 var canonicalizedNumber
= UuidUtil
.isUuid(identifier
)
2620 : PhoneNumberFormatter
.formatNumber(identifier
, account
.getUsername());
2622 return resolveRecipient(canonicalizedNumber
);
2625 private RecipientId
resolveRecipient(final String identifier
) {
2626 var address
= Utils
.getSignalServiceAddressFromIdentifier(identifier
);
2628 return resolveRecipient(address
);
2631 public RecipientId
resolveRecipient(SignalServiceAddress address
) {
2632 return account
.getRecipientStore().resolveRecipient(address
);
2635 private RecipientId
resolveRecipientTrusted(SignalServiceAddress address
) {
2636 return account
.getRecipientStore().resolveRecipientTrusted(address
);
2640 public void close() throws IOException
{
2644 void close(boolean closeAccount
) throws IOException
{
2645 executor
.shutdown();
2647 if (messagePipe
!= null) {
2648 messagePipe
.shutdown();
2652 if (unidentifiedMessagePipe
!= null) {
2653 unidentifiedMessagePipe
.shutdown();
2654 unidentifiedMessagePipe
= null;
2657 if (closeAccount
&& account
!= null) {
2663 public interface ReceiveMessageHandler
{
2665 void handleMessage(SignalServiceEnvelope envelope
, SignalServiceContent decryptedContent
, Throwable e
);