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