nmode's Git Repositories - signal-cli/blob - lib/src/main/java/org/asamk/signal/manager/helper/IncomingMessageHandler.java

   1 package org.asamk.signal.manager.helper;
   2
   3 import org.asamk.signal.manager.Manager;
   4 import org.asamk.signal.manager.actions.HandleAction;
   5 import org.asamk.signal.manager.actions.RefreshPreKeysAction;
   6 import org.asamk.signal.manager.actions.RenewSessionAction;
   7 import org.asamk.signal.manager.actions.ResendMessageAction;
   8 import org.asamk.signal.manager.actions.RetrieveProfileAction;
   9 import org.asamk.signal.manager.actions.SendGroupInfoAction;
  10 import org.asamk.signal.manager.actions.SendGroupInfoRequestAction;
  11 import org.asamk.signal.manager.actions.SendProfileKeyAction;
  12 import org.asamk.signal.manager.actions.SendReceiptAction;
  13 import org.asamk.signal.manager.actions.SendRetryMessageRequestAction;
  14 import org.asamk.signal.manager.actions.SendSyncBlockedListAction;
  15 import org.asamk.signal.manager.actions.SendSyncConfigurationAction;
  16 import org.asamk.signal.manager.actions.SendSyncContactsAction;
  17 import org.asamk.signal.manager.actions.SendSyncGroupsAction;
  18 import org.asamk.signal.manager.actions.SendSyncKeysAction;
  19 import org.asamk.signal.manager.actions.SyncStorageDataAction;
  20 import org.asamk.signal.manager.actions.UpdateAccountAttributesAction;
  21 import org.asamk.signal.manager.api.GroupId;
  22 import org.asamk.signal.manager.api.GroupNotFoundException;
  23 import org.asamk.signal.manager.api.MessageEnvelope;
  24 import org.asamk.signal.manager.api.Pair;
  25 import org.asamk.signal.manager.api.Profile;
  26 import org.asamk.signal.manager.api.ReceiveConfig;
  27 import org.asamk.signal.manager.api.StickerPackId;
  28 import org.asamk.signal.manager.api.TrustLevel;
  29 import org.asamk.signal.manager.api.UntrustedIdentityException;
  30 import org.asamk.signal.manager.groups.GroupUtils;
  31 import org.asamk.signal.manager.internal.SignalDependencies;
  32 import org.asamk.signal.manager.jobs.RetrieveStickerPackJob;
  33 import org.asamk.signal.manager.storage.SignalAccount;
  34 import org.asamk.signal.manager.storage.groups.GroupInfoV1;
  35 import org.asamk.signal.manager.storage.recipients.RecipientId;
  36 import org.asamk.signal.manager.storage.stickers.StickerPack;
  37 import org.signal.libsignal.metadata.ProtocolInvalidKeyException;
  38 import org.signal.libsignal.metadata.ProtocolInvalidKeyIdException;
  39 import org.signal.libsignal.metadata.ProtocolInvalidMessageException;
  40 import org.signal.libsignal.metadata.ProtocolNoSessionException;
  41 import org.signal.libsignal.metadata.ProtocolUntrustedIdentityException;
  42 import org.signal.libsignal.metadata.SelfSendException;
  43 import org.signal.libsignal.protocol.InvalidMessageException;
  44 import org.signal.libsignal.protocol.groups.GroupSessionBuilder;
  45 import org.signal.libsignal.protocol.message.DecryptionErrorMessage;
  46 import org.signal.libsignal.zkgroup.InvalidInputException;
  47 import org.signal.libsignal.zkgroup.profiles.ProfileKey;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50 import org.whispersystems.signalservice.api.InvalidMessageStructureException;
  51 import org.whispersystems.signalservice.api.crypto.SignalGroupSessionBuilder;
  52 import org.whispersystems.signalservice.api.crypto.SignalServiceCipherResult;
  53 import org.whispersystems.signalservice.api.messages.EnvelopeContentValidator;
  54 import org.whispersystems.signalservice.api.messages.SignalServiceContent;
  55 import org.whispersystems.signalservice.api.messages.SignalServiceDataMessage;
  56 import org.whispersystems.signalservice.api.messages.SignalServiceEnvelope;
  57 import org.whispersystems.signalservice.api.messages.SignalServiceGroup;
  58 import org.whispersystems.signalservice.api.messages.SignalServiceGroupContext;
  59 import org.whispersystems.signalservice.api.messages.SignalServiceGroupV2;
  60 import org.whispersystems.signalservice.api.messages.SignalServicePniSignatureMessage;
  61 import org.whispersystems.signalservice.api.messages.SignalServiceReceiptMessage;
  62 import org.whispersystems.signalservice.api.messages.SignalServiceStoryMessage;
  63 import org.whispersystems.signalservice.api.messages.multidevice.SignalServiceSyncMessage;
  64 import org.whispersystems.signalservice.api.messages.multidevice.StickerPackOperationMessage;
  65 import org.whispersystems.signalservice.api.push.ServiceId;
  66 import org.whispersystems.signalservice.api.push.ServiceId.ACI;
  67 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
  68 import org.whispersystems.signalservice.internal.push.Envelope;
  69 import org.whispersystems.signalservice.internal.push.UnsupportedDataMessageException;
  70
  71 import java.util.ArrayList;
  72 import java.util.List;
  73 import java.util.Optional;
  74 import java.util.stream.Collectors;
  75
  76 public final class IncomingMessageHandler {
  77
  78     private static final Logger logger = LoggerFactory.getLogger(IncomingMessageHandler.class);
  79
  80     private final SignalAccount account;
  81     private final SignalDependencies dependencies;
  82     private final Context context;
  83
  84     public IncomingMessageHandler(final Context context) {
  85         this.account = context.getAccount();
  86         this.dependencies = context.getDependencies();
  87         this.context = context;
  88     }
  89
  90     public Pair<List<HandleAction>, Exception> handleRetryEnvelope(
  91             final SignalServiceEnvelope envelope,
  92             final ReceiveConfig receiveConfig,
  93             final Manager.ReceiveMessageHandler handler
  94     ) {
  95         final List<HandleAction> actions = new ArrayList<>();
  96         if (envelope.isPreKeySignalMessage()) {
  97             actions.add(RefreshPreKeysAction.create());
  98         }
  99
 100         SignalServiceContent content = null;
 101         if (!envelope.isReceipt()) {
 102             account.getIdentityKeyStore().setRetryingDecryption(true);
 103             try {
 104                 final var cipherResult = dependencies.getCipher()
 105                         .decrypt(envelope.getProto(), envelope.getServerDeliveredTimestamp());
 106                 content = validate(envelope.getProto(), cipherResult, envelope.getServerDeliveredTimestamp());
 107                 if (content == null) {
 108                     return new Pair<>(List.of(), null);
 109                 }
 110             } catch (ProtocolUntrustedIdentityException e) {
 111                 final var recipientId = account.getRecipientResolver().resolveRecipient(e.getSender());
 112                 final var exception = new UntrustedIdentityException(account.getRecipientAddressResolver()
 113                         .resolveRecipientAddress(recipientId)
 114                         .toApiRecipientAddress(), e.getSenderDevice());
 115                 return new Pair<>(List.of(), exception);
 116             } catch (Exception e) {
 117                 return new Pair<>(List.of(), e);
 118             } finally {
 119                 account.getIdentityKeyStore().setRetryingDecryption(false);
 120             }
 121         }
 122         actions.addAll(checkAndHandleMessage(envelope, content, receiveConfig, handler, null));
 123         return new Pair<>(actions, null);
 124     }
 125
 126     public Pair<List<HandleAction>, Exception> handleEnvelope(
 127             final SignalServiceEnvelope envelope,
 128             final ReceiveConfig receiveConfig,
 129             final Manager.ReceiveMessageHandler handler
 130     ) {
 131         final var actions = new ArrayList<HandleAction>();
 132         SignalServiceContent content = null;
 133         Exception exception = null;
 134         envelope.getSourceServiceId().map(ServiceId::parseOrNull)
 135                 // Store uuid if we don't have it already
 136                 // uuid in envelope is sent by server
 137                 .ifPresent(serviceId -> account.getRecipientResolver().resolveRecipient(serviceId));
 138         if (!envelope.isReceipt()) {
 139             try {
 140                 final var cipherResult = dependencies.getCipher()
 141                         .decrypt(envelope.getProto(), envelope.getServerDeliveredTimestamp());
 142                 content = validate(envelope.getProto(), cipherResult, envelope.getServerDeliveredTimestamp());
 143                 if (content == null) {
 144                     return new Pair<>(List.of(), null);
 145                 }
 146             } catch (ProtocolUntrustedIdentityException e) {
 147                 final var recipientId = account.getRecipientResolver().resolveRecipient(e.getSender());
 148                 actions.add(new RetrieveProfileAction(recipientId));
 149                 exception = new UntrustedIdentityException(account.getRecipientAddressResolver()
 150                         .resolveRecipientAddress(recipientId)
 151                         .toApiRecipientAddress(), e.getSenderDevice());
 152             } catch (ProtocolInvalidKeyIdException | ProtocolInvalidKeyException | ProtocolNoSessionException |
 153                      ProtocolInvalidMessageException e) {
 154                 logger.debug("Failed to decrypt incoming message", e);
 155                 final var sender = account.getRecipientResolver().resolveRecipient(e.getSender());
 156                 if (context.getContactHelper().isContactBlocked(sender)) {
 157                     logger.debug("Received invalid message from blocked contact, ignoring.");
 158                 } else {
 159                     final var senderProfile = context.getProfileHelper().getRecipientProfile(sender);
 160                     final var selfProfile = context.getProfileHelper().getSelfProfile();
 161                     var serviceId = ServiceId.parseOrNull(e.getSender());
 162                     if (serviceId == null) {
 163                         // Workaround for libsignal-client issue #492
 164                         serviceId = account.getRecipientAddressResolver()
 165                                 .resolveRecipientAddress(sender)
 166                                 .serviceId()
 167                                 .orElse(null);
 168                     }
 169                     if (serviceId != null) {
 170                         final var isSelf = sender.equals(account.getSelfRecipientId())
 171                                 && e.getSenderDevice() == account.getDeviceId();
 172                         final var isSenderSenderKeyCapable = senderProfile != null && senderProfile.getCapabilities()
 173                                 .contains(Profile.Capability.senderKey);
 174                         final var isSelfSenderKeyCapable = selfProfile != null && selfProfile.getCapabilities()
 175                                 .contains(Profile.Capability.senderKey);
 176                         final var destination = getDestination(envelope).serviceId();
 177                         if (!isSelf && isSenderSenderKeyCapable && isSelfSenderKeyCapable) {
 178                             logger.debug("Received invalid message, requesting message resend.");
 179                             actions.add(new SendRetryMessageRequestAction(sender, serviceId, e, envelope, destination));
 180                         } else {
 181                             logger.debug("Received invalid message, queuing renew session action.");
 182                             actions.add(new RenewSessionAction(sender, serviceId, destination));
 183                         }
 184                     } else {
 185                         logger.debug("Received invalid message from invalid sender: {}", e.getSender());
 186                     }
 187                 }
 188                 exception = e;
 189             } catch (SelfSendException e) {
 190                 logger.debug("Dropping unidentified message from self.");
 191                 return new Pair<>(List.of(), null);
 192             } catch (Exception e) {
 193                 logger.debug("Failed to handle incoming message", e);
 194                 exception = e;
 195             }
 196         }
 197
 198         actions.addAll(checkAndHandleMessage(envelope, content, receiveConfig, handler, exception));
 199         return new Pair<>(actions, exception);
 200     }
 201
 202     private SignalServiceContent validate(
 203             Envelope envelope, SignalServiceCipherResult cipherResult, long serverDeliveredTimestamp
 204     ) throws ProtocolInvalidKeyException, ProtocolInvalidMessageException, UnsupportedDataMessageException, InvalidMessageStructureException {
 205         final var content = cipherResult.getContent();
 206         final var envelopeMetadata = cipherResult.getMetadata();
 207         final var validationResult = EnvelopeContentValidator.INSTANCE.validate(envelope, content);
 208
 209         if (validationResult instanceof EnvelopeContentValidator.Result.Invalid v) {
 210             logger.warn("Invalid content! {}", v.getReason(), v.getThrowable());
 211             return null;
 212         }
 213
 214         if (validationResult instanceof EnvelopeContentValidator.Result.UnsupportedDataMessage v) {
 215             logger.warn("Unsupported DataMessage! Our version: {}, their version: {}",
 216                     v.getOurVersion(),
 217                     v.getTheirVersion());
 218             return null;
 219         }
 220
 221         return SignalServiceContent.Companion.createFrom(account.getNumber(),
 222                 envelope,
 223                 envelopeMetadata,
 224                 content,
 225                 serverDeliveredTimestamp);
 226     }
 227
 228     private List<HandleAction> checkAndHandleMessage(
 229             final SignalServiceEnvelope envelope,
 230             final SignalServiceContent content,
 231             final ReceiveConfig receiveConfig,
 232             final Manager.ReceiveMessageHandler handler,
 233             final Exception exception
 234     ) {
 235         if (content != null) {
 236             // Store uuid if we don't have it already
 237             // address/uuid is validated by unidentified sender certificate
 238
 239             boolean handledPniSignature = false;
 240             if (content.getPniSignatureMessage().isPresent()) {
 241                 final var message = content.getPniSignatureMessage().get();
 242                 final var senderAddress = getSenderAddress(envelope, content);
 243                 if (senderAddress != null) {
 244                     handledPniSignature = handlePniSignatureMessage(message, senderAddress);
 245                 }
 246             }
 247             if (!handledPniSignature) {
 248                 account.getRecipientTrustedResolver().resolveRecipientTrusted(content.getSender());
 249             }
 250         }
 251         if (envelope.isReceipt()) {
 252             final var senderDeviceAddress = getSender(envelope, content);
 253             final var sender = senderDeviceAddress.serviceId();
 254             final var senderDeviceId = senderDeviceAddress.deviceId();
 255             account.getMessageSendLogStore().deleteEntryForRecipient(envelope.getTimestamp(), sender, senderDeviceId);
 256         }
 257
 258         var notAllowedToSendToGroup = isNotAllowedToSendToGroup(envelope, content);
 259         final var groupContext = getGroupContext(content);
 260         if (groupContext != null && groupContext.getGroupV2().isPresent()) {
 261             handleGroupV2Context(groupContext.getGroupV2().get());
 262         }
 263         // Check again in case the user just joined the group
 264         notAllowedToSendToGroup = notAllowedToSendToGroup && isNotAllowedToSendToGroup(envelope, content);
 265
 266         if (isMessageBlocked(envelope, content)) {
 267             logger.info("Ignoring a message from blocked user/group: {}", envelope.getTimestamp());
 268             return List.of();
 269         } else if (notAllowedToSendToGroup) {
 270             final var senderAddress = getSenderAddress(envelope, content);
 271             logger.info("Ignoring a group message from an unauthorized sender (no member or admin): {} {}",
 272                     senderAddress == null ? null : senderAddress.getIdentifier(),
 273                     envelope.getTimestamp());
 274             return List.of();
 275         } else {
 276             List<HandleAction> actions;
 277             if (content != null) {
 278                 actions = handleMessage(envelope, content, receiveConfig);
 279             } else {
 280                 actions = List.of();
 281             }
 282             handler.handleMessage(MessageEnvelope.from(envelope,
 283                     content,
 284                     account.getRecipientResolver(),
 285                     account.getRecipientAddressResolver(),
 286                     context.getAttachmentHelper()::getAttachmentFile,
 287                     exception), exception);
 288             return actions;
 289         }
 290     }
 291
 292     public List<HandleAction> handleMessage(
 293             SignalServiceEnvelope envelope, SignalServiceContent content, ReceiveConfig receiveConfig
 294     ) {
 295         var actions = new ArrayList<HandleAction>();
 296         final var senderDeviceAddress = getSender(envelope, content);
 297         final var sender = senderDeviceAddress.recipientId();
 298         final var senderServiceId = senderDeviceAddress.serviceId();
 299         final var senderDeviceId = senderDeviceAddress.deviceId();
 300         final var destination = getDestination(envelope);
 301
 302         if (content.getReceiptMessage().isPresent()) {
 303             final var message = content.getReceiptMessage().get();
 304             if (message.isDeliveryReceipt()) {
 305                 account.getMessageSendLogStore()
 306                         .deleteEntriesForRecipient(message.getTimestamps(), senderServiceId, senderDeviceId);
 307             }
 308         }
 309
 310         if (content.getSenderKeyDistributionMessage().isPresent()) {
 311             final var message = content.getSenderKeyDistributionMessage().get();
 312             final var protocolAddress = senderServiceId.toProtocolAddress(senderDeviceId);
 313             logger.debug("Received a sender key distribution message for distributionId {} from {}",
 314                     message.getDistributionId(),
 315                     protocolAddress);
 316             new SignalGroupSessionBuilder(dependencies.getSessionLock(),
 317                     new GroupSessionBuilder(account.getSenderKeyStore())).process(protocolAddress, message);
 318         }
 319
 320         if (content.getDecryptionErrorMessage().isPresent()) {
 321             var message = content.getDecryptionErrorMessage().get();
 322             logger.debug("Received a decryption error message from {}.{} (resend request for {})",
 323                     sender,
 324                     senderDeviceId,
 325                     message.getTimestamp());
 326             if (message.getDeviceId() == account.getDeviceId()) {
 327                 handleDecryptionErrorMessage(actions,
 328                         sender,
 329                         senderServiceId,
 330                         senderDeviceId,
 331                         message,
 332                         destination.serviceId());
 333             } else {
 334                 logger.debug("Request is for another one of our devices");
 335             }
 336         }
 337
 338         if (content.getDataMessage().isPresent() || content.getEditMessage().isPresent()) {
 339             var message = content.getDataMessage().isPresent()
 340                     ? content.getDataMessage().get()
 341                     : content.getEditMessage().get().getDataMessage();
 342
 343             if (content.isNeedsReceipt()) {
 344                 actions.add(new SendReceiptAction(sender,
 345                         SignalServiceReceiptMessage.Type.DELIVERY,
 346                         message.getTimestamp()));
 347             } else {
 348                 // Message wasn't sent as unidentified sender message
 349                 final var contact = context.getAccount().getContactStore().getContact(sender);
 350                 if (account.isPrimaryDevice()
 351                         && contact != null
 352                         && !contact.isBlocked()
 353                         && contact.isProfileSharingEnabled()) {
 354                     actions.add(UpdateAccountAttributesAction.create());
 355                     actions.add(new SendProfileKeyAction(sender));
 356                 }
 357             }
 358             if (receiveConfig.sendReadReceipts()) {
 359                 actions.add(new SendReceiptAction(sender,
 360                         SignalServiceReceiptMessage.Type.READ,
 361                         message.getTimestamp()));
 362             }
 363
 364             actions.addAll(handleSignalServiceDataMessage(message,
 365                     false,
 366                     senderDeviceAddress,
 367                     destination,
 368                     receiveConfig.ignoreAttachments()));
 369         }
 370
 371         if (content.getStoryMessage().isPresent()) {
 372             final var message = content.getStoryMessage().get();
 373             actions.addAll(handleSignalServiceStoryMessage(message, sender, receiveConfig.ignoreAttachments()));
 374         }
 375
 376         if (content.getSyncMessage().isPresent()) {
 377             var syncMessage = content.getSyncMessage().get();
 378             actions.addAll(handleSyncMessage(envelope,
 379                     syncMessage,
 380                     senderDeviceAddress,
 381                     receiveConfig.ignoreAttachments()));
 382         }
 383
 384         return actions;
 385     }
 386
 387     private boolean handlePniSignatureMessage(
 388             final SignalServicePniSignatureMessage message, final SignalServiceAddress senderAddress
 389     ) {
 390         final var aci = senderAddress.getServiceId();
 391         final var aciIdentity = account.getIdentityKeyStore().getIdentityInfo(aci);
 392         final var pni = message.getPni();
 393         final var pniIdentity = account.getIdentityKeyStore().getIdentityInfo(pni);
 394
 395         if (aciIdentity == null || pniIdentity == null || aci.equals(pni)) {
 396             return false;
 397         }
 398
 399         final var verified = pniIdentity.getIdentityKey()
 400                 .verifyAlternateIdentity(aciIdentity.getIdentityKey(), message.getSignature());
 401
 402         if (!verified) {
 403             logger.debug("Invalid PNI signature of ACI {} with PNI {}", aci, pni);
 404             return false;
 405         }
 406
 407         logger.debug("Verified association of ACI {} with PNI {}", aci, pni);
 408         account.getRecipientTrustedResolver()
 409                 .resolveRecipientTrusted(Optional.of(ACI.from(aci.getRawUuid())),
 410                         Optional.of(pni),
 411                         senderAddress.getNumber());
 412         return true;
 413     }
 414
 415     private void handleDecryptionErrorMessage(
 416             final List<HandleAction> actions,
 417             final RecipientId sender,
 418             final ServiceId senderServiceId,
 419             final int senderDeviceId,
 420             final DecryptionErrorMessage message,
 421             final ServiceId destination
 422     ) {
 423         final var logEntries = account.getMessageSendLogStore()
 424                 .findMessages(senderServiceId,
 425                         senderDeviceId,
 426                         message.getTimestamp(),
 427                         message.getRatchetKey().isEmpty());
 428
 429         for (final var logEntry : logEntries) {
 430             actions.add(new ResendMessageAction(sender, message.getTimestamp(), logEntry));
 431         }
 432
 433         if (message.getRatchetKey().isPresent()) {
 434             final var sessionStore = account.getAccountData(destination).getSessionStore();
 435             if (sessionStore.isCurrentRatchetKey(senderServiceId, senderDeviceId, message.getRatchetKey().get())) {
 436                 if (logEntries.isEmpty()) {
 437                     logger.debug("Renewing the session with sender");
 438                     actions.add(new RenewSessionAction(sender, senderServiceId, destination));
 439                 } else {
 440                     logger.trace("Archiving the session with sender, a resend message has already been queued");
 441                     sessionStore.archiveSessions(senderServiceId);
 442                 }
 443             }
 444             return;
 445         }
 446
 447         var found = false;
 448         for (final var logEntry : logEntries) {
 449             if (logEntry.groupId().isEmpty()) {
 450                 continue;
 451             }
 452             final var group = account.getGroupStore().getGroup(logEntry.groupId().get());
 453             if (group == null) {
 454                 continue;
 455             }
 456             found = true;
 457             logger.trace("Deleting shared sender key with {} ({}): {}",
 458                     sender,
 459                     senderDeviceId,
 460                     group.getDistributionId());
 461             account.getSenderKeyStore().deleteSharedWith(senderServiceId, senderDeviceId, group.getDistributionId());
 462         }
 463         if (!found) {
 464             logger.debug("Reset all shared sender keys with this recipient, no related message found in send log");
 465             account.getSenderKeyStore().deleteSharedWith(senderServiceId);
 466         }
 467     }
 468
 469     private List<HandleAction> handleSyncMessage(
 470             final SignalServiceEnvelope envelope,
 471             final SignalServiceSyncMessage syncMessage,
 472             final DeviceAddress sender,
 473             final boolean ignoreAttachments
 474     ) {
 475         var actions = new ArrayList<HandleAction>();
 476         account.setMultiDevice(true);
 477         if (syncMessage.getSent().isPresent()) {
 478             var message = syncMessage.getSent().get();
 479             final var destination = message.getDestination().orElse(null);
 480             if (message.getDataMessage().isPresent()) {
 481                 actions.addAll(handleSignalServiceDataMessage(message.getDataMessage().get(),
 482                         true,
 483                         sender,
 484                         destination == null
 485                                 ? null
 486                                 : new DeviceAddress(account.getRecipientResolver().resolveRecipient(destination),
 487                                         destination.getServiceId(),
 488                                         0),
 489                         ignoreAttachments));
 490             }
 491             if (message.getStoryMessage().isPresent()) {
 492                 actions.addAll(handleSignalServiceStoryMessage(message.getStoryMessage().get(),
 493                         sender.recipientId(),
 494                         ignoreAttachments));
 495             }
 496         }
 497         if (syncMessage.getRequest().isPresent() && account.isPrimaryDevice()) {
 498             var rm = syncMessage.getRequest().get();
 499             if (rm.isContactsRequest()) {
 500                 actions.add(SendSyncContactsAction.create());
 501             }
 502             if (rm.isGroupsRequest()) {
 503                 actions.add(SendSyncGroupsAction.create());
 504             }
 505             if (rm.isBlockedListRequest()) {
 506                 actions.add(SendSyncBlockedListAction.create());
 507             }
 508             if (rm.isKeysRequest()) {
 509                 actions.add(SendSyncKeysAction.create());
 510             }
 511             if (rm.isConfigurationRequest()) {
 512                 actions.add(SendSyncConfigurationAction.create());
 513             }
 514             actions.add(SyncStorageDataAction.create());
 515         }
 516         if (syncMessage.getGroups().isPresent()) {
 517             try {
 518                 final var groupsMessage = syncMessage.getGroups().get();
 519                 context.getAttachmentHelper()
 520                         .retrieveAttachment(groupsMessage, context.getSyncHelper()::handleSyncDeviceGroups);
 521             } catch (Exception e) {
 522                 logger.warn("Failed to handle received sync groups, ignoring: {}", e.getMessage());
 523             }
 524         }
 525         if (syncMessage.getBlockedList().isPresent()) {
 526             final var blockedListMessage = syncMessage.getBlockedList().get();
 527             for (var address : blockedListMessage.getAddresses()) {
 528                 context.getContactHelper()
 529                         .setContactBlocked(account.getRecipientResolver().resolveRecipient(address), true);
 530             }
 531             for (var groupId : blockedListMessage.getGroupIds()
 532                     .stream()
 533                     .map(GroupId::unknownVersion)
 534                     .collect(Collectors.toSet())) {
 535                 try {
 536                     context.getGroupHelper().setGroupBlocked(groupId, true);
 537                 } catch (GroupNotFoundException e) {
 538                     logger.warn("BlockedListMessage contained groupID that was not found in GroupStore: {}",
 539                             groupId.toBase64());
 540                 }
 541             }
 542         }
 543         if (syncMessage.getContacts().isPresent()) {
 544             try {
 545                 final var contactsMessage = syncMessage.getContacts().get();
 546                 context.getAttachmentHelper()
 547                         .retrieveAttachment(contactsMessage.getContactsStream(),
 548                                 context.getSyncHelper()::handleSyncDeviceContacts);
 549             } catch (Exception e) {
 550                 logger.warn("Failed to handle received sync contacts, ignoring: {}", e.getMessage());
 551             }
 552         }
 553         if (syncMessage.getVerified().isPresent()) {
 554             final var verifiedMessage = syncMessage.getVerified().get();
 555             account.getIdentityKeyStore()
 556                     .setIdentityTrustLevel(verifiedMessage.getDestination().getServiceId(),
 557                             verifiedMessage.getIdentityKey(),
 558                             TrustLevel.fromVerifiedState(verifiedMessage.getVerified()));
 559         }
 560         if (syncMessage.getStickerPackOperations().isPresent()) {
 561             final var stickerPackOperationMessages = syncMessage.getStickerPackOperations().get();
 562             for (var m : stickerPackOperationMessages) {
 563                 if (m.getPackId().isEmpty()) {
 564                     continue;
 565                 }
 566                 final var stickerPackId = StickerPackId.deserialize(m.getPackId().get());
 567                 final var stickerPackKey = m.getPackKey().orElse(null);
 568                 final var installed = m.getType().isEmpty()
 569                         || m.getType().get() == StickerPackOperationMessage.Type.INSTALL;
 570
 571                 final var sticker = context.getStickerHelper()
 572                         .addOrUpdateStickerPack(stickerPackId, stickerPackKey, installed);
 573
 574                 if (sticker != null && installed) {
 575                     context.getJobExecutor().enqueueJob(new RetrieveStickerPackJob(stickerPackId, sticker.packKey()));
 576                 }
 577             }
 578         }
 579         if (syncMessage.getFetchType().isPresent()) {
 580             switch (syncMessage.getFetchType().get()) {
 581                 case LOCAL_PROFILE -> actions.add(new RetrieveProfileAction(account.getSelfRecipientId()));
 582                 case STORAGE_MANIFEST -> actions.add(SyncStorageDataAction.create());
 583             }
 584         }
 585         if (syncMessage.getKeys().isPresent()) {
 586             final var keysMessage = syncMessage.getKeys().get();
 587             if (keysMessage.getStorageService().isPresent()) {
 588                 final var storageKey = keysMessage.getStorageService().get();
 589                 account.setStorageKey(storageKey);
 590                 actions.add(SyncStorageDataAction.create());
 591             }
 592             if (keysMessage.getMaster().isPresent()) {
 593                 final var masterKey = keysMessage.getMaster().get();
 594                 account.setMasterKey(masterKey);
 595                 actions.add(SyncStorageDataAction.create());
 596             }
 597         }
 598         if (syncMessage.getConfiguration().isPresent()) {
 599             final var configurationMessage = syncMessage.getConfiguration().get();
 600             final var configurationStore = account.getConfigurationStore();
 601             if (configurationMessage.getReadReceipts().isPresent()) {
 602                 configurationStore.setReadReceipts(configurationMessage.getReadReceipts().get());
 603             }
 604             if (configurationMessage.getLinkPreviews().isPresent()) {
 605                 configurationStore.setLinkPreviews(configurationMessage.getLinkPreviews().get());
 606             }
 607             if (configurationMessage.getTypingIndicators().isPresent()) {
 608                 configurationStore.setTypingIndicators(configurationMessage.getTypingIndicators().get());
 609             }
 610             if (configurationMessage.getUnidentifiedDeliveryIndicators().isPresent()) {
 611                 configurationStore.setUnidentifiedDeliveryIndicators(configurationMessage.getUnidentifiedDeliveryIndicators()
 612                         .get());
 613             }
 614         }
 615         if (syncMessage.getPniChangeNumber().isPresent()) {
 616             final var pniChangeNumber = syncMessage.getPniChangeNumber().get();
 617             logger.debug("Received PNI change number sync message, applying.");
 618             final var updatedPniString = envelope.getUpdatedPni();
 619             if (updatedPniString != null && !updatedPniString.isEmpty()) {
 620                 final var updatedPni = ServiceId.PNI.parseOrThrow(updatedPniString);
 621                 context.getAccountHelper().handlePniChangeNumberMessage(pniChangeNumber, updatedPni);
 622             }
 623         }
 624         return actions;
 625     }
 626
 627     private SignalServiceGroupContext getGroupContext(SignalServiceContent content) {
 628         if (content == null) {
 629             return null;
 630         }
 631
 632         if (content.getDataMessage().isPresent()) {
 633             var message = content.getDataMessage().get();
 634             if (message.getGroupContext().isPresent()) {
 635                 return message.getGroupContext().get();
 636             }
 637         }
 638
 639         if (content.getStoryMessage().isPresent()) {
 640             var message = content.getStoryMessage().get();
 641             if (message.getGroupContext().isPresent()) {
 642                 try {
 643                     return SignalServiceGroupContext.create(null, message.getGroupContext().get());
 644                 } catch (InvalidMessageException e) {
 645                     throw new AssertionError(e);
 646                 }
 647             }
 648         }
 649
 650         return null;
 651     }
 652
 653     private boolean isMessageBlocked(SignalServiceEnvelope envelope, SignalServiceContent content) {
 654         SignalServiceAddress source = getSenderAddress(envelope, content);
 655         if (source == null) {
 656             return false;
 657         }
 658         final var recipientId = account.getRecipientResolver().resolveRecipient(source);
 659         if (context.getContactHelper().isContactBlocked(recipientId)) {
 660             return true;
 661         }
 662
 663         final var groupContext = getGroupContext(content);
 664         if (groupContext != null) {
 665             var groupId = GroupUtils.getGroupId(groupContext);
 666             return context.getGroupHelper().isGroupBlocked(groupId);
 667         }
 668
 669         return false;
 670     }
 671
 672     private boolean isNotAllowedToSendToGroup(SignalServiceEnvelope envelope, SignalServiceContent content) {
 673         SignalServiceAddress source = getSenderAddress(envelope, content);
 674         if (source == null) {
 675             return false;
 676         }
 677
 678         final var groupContext = getGroupContext(content);
 679         if (groupContext == null) {
 680             return false;
 681         }
 682
 683         if (groupContext.getGroupV1().isPresent()) {
 684             var groupInfo = groupContext.getGroupV1().get();
 685             if (groupInfo.getType() == SignalServiceGroup.Type.QUIT) {
 686                 return false;
 687             }
 688         }
 689
 690         var groupId = GroupUtils.getGroupId(groupContext);
 691         var group = context.getGroupHelper().getGroup(groupId);
 692         if (group == null) {
 693             return false;
 694         }
 695
 696         final var message = content.getDataMessage().orElse(null);
 697
 698         final var recipientId = account.getRecipientResolver().resolveRecipient(source);
 699         if (!group.isMember(recipientId) && !(
 700                 group.isPendingMember(recipientId) && message != null && message.isGroupV2Update()
 701         )) {
 702             return true;
 703         }
 704
 705         if (group.isAnnouncementGroup() && !group.isAdmin(recipientId)) {
 706             return message == null
 707                     || message.getBody().isPresent()
 708                     || message.getAttachments().isPresent()
 709                     || message.getQuote().isPresent()
 710                     || message.getPreviews().isPresent()
 711                     || message.getMentions().isPresent()
 712                     || message.getSticker().isPresent();
 713         }
 714         return false;
 715     }
 716
 717     private List<HandleAction> handleSignalServiceDataMessage(
 718             SignalServiceDataMessage message,
 719             boolean isSync,
 720             DeviceAddress source,
 721             DeviceAddress destination,
 722             boolean ignoreAttachments
 723     ) {
 724         var actions = new ArrayList<HandleAction>();
 725         if (message.getGroupContext().isPresent()) {
 726             final var groupContext = message.getGroupContext().get();
 727             if (groupContext.getGroupV1().isPresent()) {
 728                 var groupInfo = groupContext.getGroupV1().get();
 729                 var groupId = GroupId.v1(groupInfo.getGroupId());
 730                 var group = context.getGroupHelper().getGroup(groupId);
 731                 if (group == null || group instanceof GroupInfoV1) {
 732                     var groupV1 = (GroupInfoV1) group;
 733                     switch (groupInfo.getType()) {
 734                         case UPDATE -> {
 735                             if (groupV1 == null) {
 736                                 groupV1 = new GroupInfoV1(groupId);
 737                             }
 738
 739                             if (groupInfo.getAvatar().isPresent()) {
 740                                 var avatar = groupInfo.getAvatar().get();
 741                                 context.getGroupHelper().downloadGroupAvatar(groupV1.getGroupId(), avatar);
 742                             }
 743
 744                             if (groupInfo.getName().isPresent()) {
 745                                 groupV1.name = groupInfo.getName().get();
 746                             }
 747
 748                             if (groupInfo.getMembers().isPresent()) {
 749                                 final var recipientResolver = account.getRecipientResolver();
 750                                 groupV1.addMembers(groupInfo.getMembers()
 751                                         .get()
 752                                         .stream()
 753                                         .map(recipientResolver::resolveRecipient)
 754                                         .collect(Collectors.toSet()));
 755                             }
 756
 757                             account.getGroupStore().updateGroup(groupV1);
 758                         }
 759                         case DELIVER -> {
 760                             if (groupV1 == null && !isSync) {
 761                                 actions.add(new SendGroupInfoRequestAction(source.recipientId(), groupId));
 762                             }
 763                         }
 764                         case QUIT -> {
 765                             if (groupV1 != null) {
 766                                 groupV1.removeMember(source.recipientId());
 767                                 account.getGroupStore().updateGroup(groupV1);
 768                             }
 769                         }
 770                         case REQUEST_INFO -> {
 771                             if (groupV1 != null && !isSync) {
 772                                 actions.add(new SendGroupInfoAction(source.recipientId(), groupV1.getGroupId()));
 773                             }
 774                         }
 775                     }
 776                 } else {
 777                     // Received a group v1 message for a v2 group
 778                 }
 779             }
 780             if (groupContext.getGroupV2().isPresent()) {
 781                 handleGroupV2Context(groupContext.getGroupV2().get());
 782             }
 783         }
 784
 785         final var selfAddress = isSync ? source : destination;
 786         final var conversationPartnerAddress = isSync ? destination : source;
 787         if (conversationPartnerAddress != null && message.isEndSession()) {
 788             account.getAccountData(selfAddress.serviceId())
 789                     .getSessionStore()
 790                     .deleteAllSessions(conversationPartnerAddress.serviceId());
 791         }
 792         if (message.isExpirationUpdate() || message.getBody().isPresent()) {
 793             if (message.getGroupContext().isPresent()) {
 794                 final var groupContext = message.getGroupContext().get();
 795                 if (groupContext.getGroupV1().isPresent()) {
 796                     var groupInfo = groupContext.getGroupV1().get();
 797                     var group = account.getGroupStore().getOrCreateGroupV1(GroupId.v1(groupInfo.getGroupId()));
 798                     if (group != null) {
 799                         if (group.messageExpirationTime != message.getExpiresInSeconds()) {
 800                             group.messageExpirationTime = message.getExpiresInSeconds();
 801                             account.getGroupStore().updateGroup(group);
 802                         }
 803                     }
 804                 } else if (groupContext.getGroupV2().isPresent()) {
 805                     // disappearing message timer already stored in the DecryptedGroup
 806                 }
 807             } else if (conversationPartnerAddress != null) {
 808                 context.getContactHelper()
 809                         .setExpirationTimer(conversationPartnerAddress.recipientId(), message.getExpiresInSeconds());
 810             }
 811         }
 812         if (!ignoreAttachments) {
 813             if (message.getAttachments().isPresent()) {
 814                 for (var attachment : message.getAttachments().get()) {
 815                     context.getAttachmentHelper().downloadAttachment(attachment);
 816                 }
 817             }
 818             if (message.getSharedContacts().isPresent()) {
 819                 for (var contact : message.getSharedContacts().get()) {
 820                     if (contact.getAvatar().isPresent()) {
 821                         context.getAttachmentHelper().downloadAttachment(contact.getAvatar().get().getAttachment());
 822                     }
 823                 }
 824             }
 825             if (message.getPreviews().isPresent()) {
 826                 final var previews = message.getPreviews().get();
 827                 for (var preview : previews) {
 828                     if (preview.getImage().isPresent()) {
 829                         context.getAttachmentHelper().downloadAttachment(preview.getImage().get());
 830                     }
 831                 }
 832             }
 833             if (message.getQuote().isPresent()) {
 834                 final var quote = message.getQuote().get();
 835
 836                 if (quote.getAttachments() != null) {
 837                     for (var quotedAttachment : quote.getAttachments()) {
 838                         final var thumbnail = quotedAttachment.getThumbnail();
 839                         if (thumbnail != null) {
 840                             context.getAttachmentHelper().downloadAttachment(thumbnail);
 841                         }
 842                     }
 843                 }
 844             }
 845         }
 846         if (message.getGiftBadge().isPresent()) {
 847             handleIncomingGiftBadge(message.getGiftBadge().get());
 848         }
 849         if (message.getProfileKey().isPresent()) {
 850             handleIncomingProfileKey(message.getProfileKey().get(), source.recipientId());
 851         }
 852         if (message.getSticker().isPresent()) {
 853             final var messageSticker = message.getSticker().get();
 854             final var stickerPackId = StickerPackId.deserialize(messageSticker.getPackId());
 855             var sticker = account.getStickerStore().getStickerPack(stickerPackId);
 856             if (sticker == null) {
 857                 sticker = new StickerPack(stickerPackId, messageSticker.getPackKey());
 858                 account.getStickerStore().addStickerPack(sticker);
 859             }
 860             context.getJobExecutor().enqueueJob(new RetrieveStickerPackJob(stickerPackId, messageSticker.getPackKey()));
 861         }
 862         return actions;
 863     }
 864
 865     private void handleIncomingGiftBadge(final SignalServiceDataMessage.GiftBadge giftBadge) {
 866         // TODO
 867     }
 868
 869     private List<HandleAction> handleSignalServiceStoryMessage(
 870             SignalServiceStoryMessage message, RecipientId source, boolean ignoreAttachments
 871     ) {
 872         var actions = new ArrayList<HandleAction>();
 873         if (message.getGroupContext().isPresent()) {
 874             handleGroupV2Context(message.getGroupContext().get());
 875         }
 876
 877         if (!ignoreAttachments) {
 878             if (message.getFileAttachment().isPresent()) {
 879                 context.getAttachmentHelper().downloadAttachment(message.getFileAttachment().get());
 880             }
 881             if (message.getTextAttachment().isPresent()) {
 882                 final var textAttachment = message.getTextAttachment().get();
 883                 if (textAttachment.getPreview().isPresent()) {
 884                     final var preview = textAttachment.getPreview().get();
 885                     if (preview.getImage().isPresent()) {
 886                         context.getAttachmentHelper().downloadAttachment(preview.getImage().get());
 887                     }
 888                 }
 889             }
 890         }
 891
 892         if (message.getProfileKey().isPresent()) {
 893             handleIncomingProfileKey(message.getProfileKey().get(), source);
 894         }
 895
 896         return actions;
 897     }
 898
 899     private void handleGroupV2Context(final SignalServiceGroupV2 groupContext) {
 900         final var groupMasterKey = groupContext.getMasterKey();
 901
 902         context.getGroupHelper()
 903                 .getOrMigrateGroup(groupMasterKey,
 904                         groupContext.getRevision(),
 905                         groupContext.hasSignedGroupChange() ? groupContext.getSignedGroupChange() : null);
 906     }
 907
 908     private void handleIncomingProfileKey(final byte[] profileKeyBytes, final RecipientId source) {
 909         if (profileKeyBytes.length != 32) {
 910             logger.debug("Received invalid profile key of length {}", profileKeyBytes.length);
 911             return;
 912         }
 913         final ProfileKey profileKey;
 914         try {
 915             profileKey = new ProfileKey(profileKeyBytes);
 916         } catch (InvalidInputException e) {
 917             throw new AssertionError(e);
 918         }
 919         if (account.getSelfRecipientId().equals(source)) {
 920             this.account.setProfileKey(profileKey);
 921         }
 922         this.account.getProfileStore().storeProfileKey(source, profileKey);
 923     }
 924
 925     private SignalServiceAddress getSenderAddress(SignalServiceEnvelope envelope, SignalServiceContent content) {
 926         final var serviceId = envelope.getSourceServiceId().map(ServiceId::parseOrNull).orElse(null);
 927         if (!envelope.isUnidentifiedSender() && serviceId != null) {
 928             return new SignalServiceAddress(serviceId);
 929         } else if (content != null) {
 930             return content.getSender();
 931         } else {
 932             return null;
 933         }
 934     }
 935
 936     private DeviceAddress getSender(SignalServiceEnvelope envelope, SignalServiceContent content) {
 937         final var serviceId = envelope.getSourceServiceId().map(ServiceId::parseOrNull).orElse(null);
 938         if (!envelope.isUnidentifiedSender() && serviceId != null) {
 939             return new DeviceAddress(account.getRecipientResolver().resolveRecipient(serviceId),
 940                     serviceId,
 941                     envelope.getSourceDevice());
 942         } else {
 943             return new DeviceAddress(account.getRecipientResolver().resolveRecipient(content.getSender()),
 944                     content.getSender().getServiceId(),
 945                     content.getSenderDevice());
 946         }
 947     }
 948
 949     private DeviceAddress getDestination(SignalServiceEnvelope envelope) {
 950         if (!envelope.hasDestinationUuid()) {
 951             return new DeviceAddress(account.getSelfRecipientId(), account.getAci(), account.getDeviceId());
 952         }
 953         final var addressOptional = SignalServiceAddress.fromRaw(envelope.getDestinationServiceId(), null);
 954         if (addressOptional.isEmpty()) {
 955             return new DeviceAddress(account.getSelfRecipientId(), account.getAci(), account.getDeviceId());
 956         }
 957         final var address = addressOptional.get();
 958         return new DeviceAddress(account.getRecipientResolver().resolveRecipient(address),
 959                 address.getServiceId(),
 960                 account.getDeviceId());
 961     }
 962
 963     private record DeviceAddress(RecipientId recipientId, ServiceId serviceId, int deviceId) {}
 964 }