1 package org
.asamk
.signal
.manager
.helper
;
3 import org
.asamk
.signal
.manager
.JobExecutor
;
4 import org
.asamk
.signal
.manager
.Manager
;
5 import org
.asamk
.signal
.manager
.SignalDependencies
;
6 import org
.asamk
.signal
.manager
.TrustLevel
;
7 import org
.asamk
.signal
.manager
.UntrustedIdentityException
;
8 import org
.asamk
.signal
.manager
.actions
.HandleAction
;
9 import org
.asamk
.signal
.manager
.actions
.RefreshPreKeysAction
;
10 import org
.asamk
.signal
.manager
.actions
.RenewSessionAction
;
11 import org
.asamk
.signal
.manager
.actions
.RetrieveProfileAction
;
12 import org
.asamk
.signal
.manager
.actions
.RetrieveStorageDataAction
;
13 import org
.asamk
.signal
.manager
.actions
.SendGroupInfoAction
;
14 import org
.asamk
.signal
.manager
.actions
.SendGroupInfoRequestAction
;
15 import org
.asamk
.signal
.manager
.actions
.SendReceiptAction
;
16 import org
.asamk
.signal
.manager
.actions
.SendSyncBlockedListAction
;
17 import org
.asamk
.signal
.manager
.actions
.SendSyncContactsAction
;
18 import org
.asamk
.signal
.manager
.actions
.SendSyncGroupsAction
;
19 import org
.asamk
.signal
.manager
.actions
.SendSyncKeysAction
;
20 import org
.asamk
.signal
.manager
.groups
.GroupId
;
21 import org
.asamk
.signal
.manager
.groups
.GroupNotFoundException
;
22 import org
.asamk
.signal
.manager
.groups
.GroupUtils
;
23 import org
.asamk
.signal
.manager
.jobs
.RetrieveStickerPackJob
;
24 import org
.asamk
.signal
.manager
.storage
.SignalAccount
;
25 import org
.asamk
.signal
.manager
.storage
.groups
.GroupInfoV1
;
26 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientId
;
27 import org
.asamk
.signal
.manager
.storage
.recipients
.RecipientResolver
;
28 import org
.asamk
.signal
.manager
.storage
.stickers
.Sticker
;
29 import org
.asamk
.signal
.manager
.storage
.stickers
.StickerPackId
;
30 import org
.signal
.libsignal
.metadata
.ProtocolInvalidMessageException
;
31 import org
.signal
.libsignal
.metadata
.ProtocolUntrustedIdentityException
;
32 import org
.signal
.zkgroup
.InvalidInputException
;
33 import org
.signal
.zkgroup
.profiles
.ProfileKey
;
34 import org
.slf4j
.Logger
;
35 import org
.slf4j
.LoggerFactory
;
36 import org
.whispersystems
.libsignal
.SignalProtocolAddress
;
37 import org
.whispersystems
.libsignal
.util
.Pair
;
38 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceContent
;
39 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceDataMessage
;
40 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceEnvelope
;
41 import org
.whispersystems
.signalservice
.api
.messages
.SignalServiceGroup
;
42 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.SignalServiceSyncMessage
;
43 import org
.whispersystems
.signalservice
.api
.messages
.multidevice
.StickerPackOperationMessage
;
44 import org
.whispersystems
.signalservice
.api
.push
.SignalServiceAddress
;
46 import java
.util
.ArrayList
;
47 import java
.util
.List
;
48 import java
.util
.stream
.Collectors
;
50 public final class IncomingMessageHandler
{
52 private final static Logger logger
= LoggerFactory
.getLogger(IncomingMessageHandler
.class);
54 private final SignalAccount account
;
55 private final SignalDependencies dependencies
;
56 private final RecipientResolver recipientResolver
;
57 private final SignalServiceAddressResolver addressResolver
;
58 private final GroupHelper groupHelper
;
59 private final ContactHelper contactHelper
;
60 private final AttachmentHelper attachmentHelper
;
61 private final SyncHelper syncHelper
;
62 private final JobExecutor jobExecutor
;
64 public IncomingMessageHandler(
65 final SignalAccount account
,
66 final SignalDependencies dependencies
,
67 final RecipientResolver recipientResolver
,
68 final SignalServiceAddressResolver addressResolver
,
69 final GroupHelper groupHelper
,
70 final ContactHelper contactHelper
,
71 final AttachmentHelper attachmentHelper
,
72 final SyncHelper syncHelper
,
73 final JobExecutor jobExecutor
75 this.account
= account
;
76 this.dependencies
= dependencies
;
77 this.recipientResolver
= recipientResolver
;
78 this.addressResolver
= addressResolver
;
79 this.groupHelper
= groupHelper
;
80 this.contactHelper
= contactHelper
;
81 this.attachmentHelper
= attachmentHelper
;
82 this.syncHelper
= syncHelper
;
83 this.jobExecutor
= jobExecutor
;
86 public Pair
<List
<HandleAction
>, Exception
> handleRetryEnvelope(
87 final SignalServiceEnvelope envelope
,
88 final boolean ignoreAttachments
,
89 final Manager
.ReceiveMessageHandler handler
91 final List
<HandleAction
> actions
= new ArrayList
<>();
92 if (envelope
.isPreKeySignalMessage()) {
93 actions
.add(RefreshPreKeysAction
.create());
96 SignalServiceContent content
= null;
97 if (!envelope
.isReceipt()) {
99 content
= dependencies
.getCipher().decrypt(envelope
);
100 } catch (ProtocolUntrustedIdentityException e
) {
101 final var recipientId
= account
.getRecipientStore().resolveRecipient(e
.getSender());
102 final var exception
= new UntrustedIdentityException(addressResolver
.resolveSignalServiceAddress(
103 recipientId
), e
.getSenderDevice());
104 return new Pair
<>(List
.of(), exception
);
105 } catch (Exception e
) {
106 return new Pair
<>(List
.of(), e
);
109 actions
.addAll(checkAndHandleMessage(envelope
, content
, ignoreAttachments
, handler
, null));
110 return new Pair
<>(actions
, null);
113 public Pair
<List
<HandleAction
>, Exception
> handleEnvelope(
114 final SignalServiceEnvelope envelope
,
115 final boolean ignoreAttachments
,
116 final Manager
.ReceiveMessageHandler handler
118 final var actions
= new ArrayList
<HandleAction
>();
119 if (envelope
.hasSourceUuid()) {
120 // Store uuid if we don't have it already
121 // address/uuid in envelope is sent by server
122 account
.getRecipientStore().resolveRecipientTrusted(envelope
.getSourceAddress());
124 SignalServiceContent content
= null;
125 Exception exception
= null;
126 if (!envelope
.isReceipt()) {
128 content
= dependencies
.getCipher().decrypt(envelope
);
129 } catch (ProtocolUntrustedIdentityException e
) {
130 final var recipientId
= account
.getRecipientStore().resolveRecipient(e
.getSender());
131 actions
.add(new RetrieveProfileAction(recipientId
));
132 exception
= new UntrustedIdentityException(addressResolver
.resolveSignalServiceAddress(recipientId
),
133 e
.getSenderDevice());
134 } catch (ProtocolInvalidMessageException e
) {
135 final var sender
= account
.getRecipientStore().resolveRecipient(e
.getSender());
136 logger
.debug("Received invalid message, queuing renew session action.");
137 actions
.add(new RenewSessionAction(sender
));
139 } catch (Exception e
) {
144 actions
.addAll(checkAndHandleMessage(envelope
, content
, ignoreAttachments
, handler
, exception
));
145 return new Pair
<>(actions
, exception
);
148 private List
<HandleAction
> checkAndHandleMessage(
149 final SignalServiceEnvelope envelope
,
150 final SignalServiceContent content
,
151 final boolean ignoreAttachments
,
152 final Manager
.ReceiveMessageHandler handler
,
153 final Exception exception
155 if (!envelope
.hasSourceUuid() && content
!= null) {
156 // Store uuid if we don't have it already
157 // address/uuid is validated by unidentified sender certificate
158 account
.getRecipientStore().resolveRecipientTrusted(content
.getSender());
160 if (isMessageBlocked(envelope
, content
)) {
161 logger
.info("Ignoring a message from blocked user/group: {}", envelope
.getTimestamp());
163 } else if (isNotAllowedToSendToGroup(envelope
, content
)) {
164 logger
.info("Ignoring a group message from an unauthorized sender (no member or admin): {} {}",
165 (envelope
.hasSourceUuid() ? envelope
.getSourceAddress() : content
.getSender()).getIdentifier(),
166 envelope
.getTimestamp());
169 List
<HandleAction
> actions
;
170 if (content
!= null) {
171 actions
= handleMessage(envelope
, content
, ignoreAttachments
);
175 handler
.handleMessage(envelope
, content
, exception
);
180 public List
<HandleAction
> handleMessage(
181 SignalServiceEnvelope envelope
, SignalServiceContent content
, boolean ignoreAttachments
183 var actions
= new ArrayList
<HandleAction
>();
184 final RecipientId sender
;
185 final int senderDeviceId
;
186 if (!envelope
.isUnidentifiedSender() && envelope
.hasSourceUuid()) {
187 sender
= recipientResolver
.resolveRecipient(envelope
.getSourceAddress());
188 senderDeviceId
= envelope
.getSourceDevice();
190 sender
= recipientResolver
.resolveRecipient(content
.getSender());
191 senderDeviceId
= content
.getSenderDevice();
194 if (content
.getSenderKeyDistributionMessage().isPresent()) {
195 final var message
= content
.getSenderKeyDistributionMessage().get();
196 final var protocolAddress
= new SignalProtocolAddress(addressResolver
.resolveSignalServiceAddress(sender
)
197 .getIdentifier(), senderDeviceId
);
198 dependencies
.getMessageSender().processSenderKeyDistributionMessage(protocolAddress
, message
);
201 if (content
.getDataMessage().isPresent()) {
202 var message
= content
.getDataMessage().get();
204 if (content
.isNeedsReceipt()) {
205 actions
.add(new SendReceiptAction(sender
, message
.getTimestamp()));
208 actions
.addAll(handleSignalServiceDataMessage(message
,
211 account
.getSelfRecipientId(),
215 if (content
.getSyncMessage().isPresent()) {
216 var syncMessage
= content
.getSyncMessage().get();
217 actions
.addAll(handleSyncMessage(syncMessage
, sender
, ignoreAttachments
));
223 private List
<HandleAction
> handleSyncMessage(
224 final SignalServiceSyncMessage syncMessage
, final RecipientId sender
, final boolean ignoreAttachments
226 var actions
= new ArrayList
<HandleAction
>();
227 account
.setMultiDevice(true);
228 if (syncMessage
.getSent().isPresent()) {
229 var message
= syncMessage
.getSent().get();
230 final var destination
= message
.getDestination().orNull();
231 actions
.addAll(handleSignalServiceDataMessage(message
.getMessage(),
234 destination
== null ?
null : recipientResolver
.resolveRecipient(destination
),
237 if (syncMessage
.getRequest().isPresent() && account
.isMasterDevice()) {
238 var rm
= syncMessage
.getRequest().get();
239 if (rm
.isContactsRequest()) {
240 actions
.add(SendSyncContactsAction
.create());
242 if (rm
.isGroupsRequest()) {
243 actions
.add(SendSyncGroupsAction
.create());
245 if (rm
.isBlockedListRequest()) {
246 actions
.add(SendSyncBlockedListAction
.create());
248 if (rm
.isKeysRequest()) {
249 actions
.add(SendSyncKeysAction
.create());
251 // TODO Handle rm.isConfigurationRequest();
253 if (syncMessage
.getGroups().isPresent()) {
254 logger
.warn("Received a group v1 sync message, that can't be handled anymore, ignoring.");
256 if (syncMessage
.getBlockedList().isPresent()) {
257 final var blockedListMessage
= syncMessage
.getBlockedList().get();
258 for (var address
: blockedListMessage
.getAddresses()) {
259 contactHelper
.setContactBlocked(recipientResolver
.resolveRecipient(address
), true);
261 for (var groupId
: blockedListMessage
.getGroupIds()
263 .map(GroupId
::unknownVersion
)
264 .collect(Collectors
.toSet())) {
266 groupHelper
.setGroupBlocked(groupId
, true);
267 } catch (GroupNotFoundException e
) {
268 logger
.warn("BlockedListMessage contained groupID that was not found in GroupStore: {}",
273 if (syncMessage
.getContacts().isPresent()) {
275 final var contactsMessage
= syncMessage
.getContacts().get();
276 attachmentHelper
.retrieveAttachment(contactsMessage
.getContactsStream(),
277 syncHelper
::handleSyncDeviceContacts
);
278 } catch (Exception e
) {
279 logger
.warn("Failed to handle received sync contacts, ignoring: {}", e
.getMessage());
282 if (syncMessage
.getVerified().isPresent()) {
283 final var verifiedMessage
= syncMessage
.getVerified().get();
284 account
.getIdentityKeyStore()
285 .setIdentityTrustLevel(account
.getRecipientStore()
286 .resolveRecipientTrusted(verifiedMessage
.getDestination()),
287 verifiedMessage
.getIdentityKey(),
288 TrustLevel
.fromVerifiedState(verifiedMessage
.getVerified()));
290 if (syncMessage
.getStickerPackOperations().isPresent()) {
291 final var stickerPackOperationMessages
= syncMessage
.getStickerPackOperations().get();
292 for (var m
: stickerPackOperationMessages
) {
293 if (!m
.getPackId().isPresent()) {
296 final var stickerPackId
= StickerPackId
.deserialize(m
.getPackId().get());
297 final var installed
= !m
.getType().isPresent()
298 || m
.getType().get() == StickerPackOperationMessage
.Type
.INSTALL
;
300 var sticker
= account
.getStickerStore().getSticker(stickerPackId
);
301 if (m
.getPackKey().isPresent()) {
302 if (sticker
== null) {
303 sticker
= new Sticker(stickerPackId
, m
.getPackKey().get());
306 jobExecutor
.enqueueJob(new RetrieveStickerPackJob(stickerPackId
, m
.getPackKey().get()));
310 if (sticker
!= null) {
311 sticker
.setInstalled(installed
);
312 account
.getStickerStore().updateSticker(sticker
);
316 if (syncMessage
.getFetchType().isPresent()) {
317 switch (syncMessage
.getFetchType().get()) {
319 actions
.add(new RetrieveProfileAction(account
.getSelfRecipientId()));
320 case STORAGE_MANIFEST
:
321 actions
.add(RetrieveStorageDataAction
.create());
324 if (syncMessage
.getKeys().isPresent()) {
325 final var keysMessage
= syncMessage
.getKeys().get();
326 if (keysMessage
.getStorageService().isPresent()) {
327 final var storageKey
= keysMessage
.getStorageService().get();
328 account
.setStorageKey(storageKey
);
329 actions
.add(RetrieveStorageDataAction
.create());
332 if (syncMessage
.getConfiguration().isPresent()) {
338 private boolean isMessageBlocked(SignalServiceEnvelope envelope
, SignalServiceContent content
) {
339 SignalServiceAddress source
;
340 if (!envelope
.isUnidentifiedSender() && envelope
.hasSourceUuid()) {
341 source
= envelope
.getSourceAddress();
342 } else if (content
!= null) {
343 source
= content
.getSender();
347 final var recipientId
= recipientResolver
.resolveRecipient(source
);
348 if (contactHelper
.isContactBlocked(recipientId
)) {
352 if (content
!= null && content
.getDataMessage().isPresent()) {
353 var message
= content
.getDataMessage().get();
354 if (message
.getGroupContext().isPresent()) {
355 var groupId
= GroupUtils
.getGroupId(message
.getGroupContext().get());
356 return groupHelper
.isGroupBlocked(groupId
);
363 private boolean isNotAllowedToSendToGroup(SignalServiceEnvelope envelope
, SignalServiceContent content
) {
364 SignalServiceAddress source
;
365 if (!envelope
.isUnidentifiedSender() && envelope
.hasSourceUuid()) {
366 source
= envelope
.getSourceAddress();
367 } else if (content
!= null) {
368 source
= content
.getSender();
373 if (content
== null || !content
.getDataMessage().isPresent()) {
377 var message
= content
.getDataMessage().get();
378 if (!message
.getGroupContext().isPresent()) {
382 if (message
.getGroupContext().get().getGroupV1().isPresent()) {
383 var groupInfo
= message
.getGroupContext().get().getGroupV1().get();
384 if (groupInfo
.getType() == SignalServiceGroup
.Type
.QUIT
) {
389 var groupId
= GroupUtils
.getGroupId(message
.getGroupContext().get());
390 var group
= groupHelper
.getGroup(groupId
);
395 final var recipientId
= recipientResolver
.resolveRecipient(source
);
396 if (!group
.isMember(recipientId
)) {
400 if (group
.isAnnouncementGroup() && !group
.isAdmin(recipientId
)) {
401 return message
.getBody().isPresent()
402 || message
.getAttachments().isPresent()
403 || message
.getQuote()
405 || message
.getPreviews().isPresent()
406 || message
.getMentions().isPresent()
407 || message
.getSticker().isPresent();
412 private List
<HandleAction
> handleSignalServiceDataMessage(
413 SignalServiceDataMessage message
,
416 RecipientId destination
,
417 boolean ignoreAttachments
419 var actions
= new ArrayList
<HandleAction
>();
420 if (message
.getGroupContext().isPresent()) {
421 if (message
.getGroupContext().get().getGroupV1().isPresent()) {
422 var groupInfo
= message
.getGroupContext().get().getGroupV1().get();
423 var groupId
= GroupId
.v1(groupInfo
.getGroupId());
424 var group
= groupHelper
.getGroup(groupId
);
425 if (group
== null || group
instanceof GroupInfoV1
) {
426 var groupV1
= (GroupInfoV1
) group
;
427 switch (groupInfo
.getType()) {
429 if (groupV1
== null) {
430 groupV1
= new GroupInfoV1(groupId
);
433 if (groupInfo
.getAvatar().isPresent()) {
434 var avatar
= groupInfo
.getAvatar().get();
435 groupHelper
.downloadGroupAvatar(groupV1
.getGroupId(), avatar
);
438 if (groupInfo
.getName().isPresent()) {
439 groupV1
.name
= groupInfo
.getName().get();
442 if (groupInfo
.getMembers().isPresent()) {
443 groupV1
.addMembers(groupInfo
.getMembers()
446 .map(recipientResolver
::resolveRecipient
)
447 .collect(Collectors
.toSet()));
450 account
.getGroupStore().updateGroup(groupV1
);
454 if (groupV1
== null && !isSync
) {
455 actions
.add(new SendGroupInfoRequestAction(source
, groupId
));
459 if (groupV1
!= null) {
460 groupV1
.removeMember(source
);
461 account
.getGroupStore().updateGroup(groupV1
);
466 if (groupV1
!= null && !isSync
) {
467 actions
.add(new SendGroupInfoAction(source
, groupV1
.getGroupId()));
472 // Received a group v1 message for a v2 group
475 if (message
.getGroupContext().get().getGroupV2().isPresent()) {
476 final var groupContext
= message
.getGroupContext().get().getGroupV2().get();
477 final var groupMasterKey
= groupContext
.getMasterKey();
479 groupHelper
.getOrMigrateGroup(groupMasterKey
,
480 groupContext
.getRevision(),
481 groupContext
.hasSignedGroupChange() ? groupContext
.getSignedGroupChange() : null);
485 final var conversationPartnerAddress
= isSync ? destination
: source
;
486 if (conversationPartnerAddress
!= null && message
.isEndSession()) {
487 account
.getSessionStore().deleteAllSessions(conversationPartnerAddress
);
489 if (message
.isExpirationUpdate() || message
.getBody().isPresent()) {
490 if (message
.getGroupContext().isPresent()) {
491 if (message
.getGroupContext().get().getGroupV1().isPresent()) {
492 var groupInfo
= message
.getGroupContext().get().getGroupV1().get();
493 var group
= account
.getGroupStore().getOrCreateGroupV1(GroupId
.v1(groupInfo
.getGroupId()));
495 if (group
.messageExpirationTime
!= message
.getExpiresInSeconds()) {
496 group
.messageExpirationTime
= message
.getExpiresInSeconds();
497 account
.getGroupStore().updateGroup(group
);
500 } else if (message
.getGroupContext().get().getGroupV2().isPresent()) {
501 // disappearing message timer already stored in the DecryptedGroup
503 } else if (conversationPartnerAddress
!= null) {
504 contactHelper
.setExpirationTimer(conversationPartnerAddress
, message
.getExpiresInSeconds());
507 if (!ignoreAttachments
) {
508 if (message
.getAttachments().isPresent()) {
509 for (var attachment
: message
.getAttachments().get()) {
510 attachmentHelper
.downloadAttachment(attachment
);
513 if (message
.getSharedContacts().isPresent()) {
514 for (var contact
: message
.getSharedContacts().get()) {
515 if (contact
.getAvatar().isPresent()) {
516 attachmentHelper
.downloadAttachment(contact
.getAvatar().get().getAttachment());
520 if (message
.getPreviews().isPresent()) {
521 final var previews
= message
.getPreviews().get();
522 for (var preview
: previews
) {
523 if (preview
.getImage().isPresent()) {
524 attachmentHelper
.downloadAttachment(preview
.getImage().get());
528 if (message
.getQuote().isPresent()) {
529 final var quote
= message
.getQuote().get();
531 for (var quotedAttachment
: quote
.getAttachments()) {
532 final var thumbnail
= quotedAttachment
.getThumbnail();
533 if (thumbnail
!= null) {
534 attachmentHelper
.downloadAttachment(thumbnail
);
539 if (message
.getProfileKey().isPresent() && message
.getProfileKey().get().length
== 32) {
540 final ProfileKey profileKey
;
542 profileKey
= new ProfileKey(message
.getProfileKey().get());
543 } catch (InvalidInputException e
) {
544 throw new AssertionError(e
);
546 if (account
.getSelfRecipientId().equals(source
)) {
547 this.account
.setProfileKey(profileKey
);
549 this.account
.getProfileStore().storeProfileKey(source
, profileKey
);
551 if (message
.getSticker().isPresent()) {
552 final var messageSticker
= message
.getSticker().get();
553 final var stickerPackId
= StickerPackId
.deserialize(messageSticker
.getPackId());
554 var sticker
= account
.getStickerStore().getSticker(stickerPackId
);
555 if (sticker
== null) {
556 sticker
= new Sticker(stickerPackId
, messageSticker
.getPackKey());
557 account
.getStickerStore().updateSticker(sticker
);
559 jobExecutor
.enqueueJob(new RetrieveStickerPackJob(stickerPackId
, messageSticker
.getPackKey()));