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