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