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