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

   1 package org.asamk.signal.manager.helper;
   2
   3 import com.google.protobuf.ByteString;
   4
   5 import org.asamk.signal.manager.SignalDependencies;
   6 import org.asamk.signal.manager.api.UnregisteredRecipientException;
   7 import org.asamk.signal.manager.groups.GroupId;
   8 import org.asamk.signal.manager.groups.GroupNotFoundException;
   9 import org.asamk.signal.manager.groups.GroupSendingNotAllowedException;
  10 import org.asamk.signal.manager.groups.GroupUtils;
  11 import org.asamk.signal.manager.groups.NotAGroupMemberException;
  12 import org.asamk.signal.manager.storage.SignalAccount;
  13 import org.asamk.signal.manager.storage.groups.GroupInfo;
  14 import org.asamk.signal.manager.storage.recipients.Contact;
  15 import org.asamk.signal.manager.storage.recipients.Profile;
  16 import org.asamk.signal.manager.storage.recipients.RecipientId;
  17 import org.asamk.signal.manager.storage.sendLog.MessageSendLogEntry;
  18 import org.signal.libsignal.protocol.InvalidKeyException;
  19 import org.signal.libsignal.protocol.InvalidRegistrationIdException;
  20 import org.signal.libsignal.protocol.NoSessionException;
  21 import org.signal.libsignal.protocol.SignalProtocolAddress;
  22 import org.signal.libsignal.protocol.message.DecryptionErrorMessage;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25 import org.whispersystems.signalservice.api.SignalServiceMessageSender;
  26 import org.whispersystems.signalservice.api.crypto.ContentHint;
  27 import org.whispersystems.signalservice.api.crypto.UnidentifiedAccess;
  28 import org.whispersystems.signalservice.api.crypto.UnidentifiedAccessPair;
  29 import org.whispersystems.signalservice.api.crypto.UntrustedIdentityException;
  30 import org.whispersystems.signalservice.api.messages.SendMessageResult;
  31 import org.whispersystems.signalservice.api.messages.SignalServiceDataMessage;
  32 import org.whispersystems.signalservice.api.messages.SignalServiceReceiptMessage;
  33 import org.whispersystems.signalservice.api.messages.SignalServiceTypingMessage;
  34 import org.whispersystems.signalservice.api.messages.multidevice.SentTranscriptMessage;
  35 import org.whispersystems.signalservice.api.messages.multidevice.SignalServiceSyncMessage;
  36 import org.whispersystems.signalservice.api.push.DistributionId;
  37 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
  38 import org.whispersystems.signalservice.api.push.exceptions.NotFoundException;
  39 import org.whispersystems.signalservice.api.push.exceptions.ProofRequiredException;
  40 import org.whispersystems.signalservice.api.push.exceptions.RateLimitException;
  41 import org.whispersystems.signalservice.api.push.exceptions.UnregisteredUserException;
  42 import org.whispersystems.signalservice.internal.push.exceptions.InvalidUnidentifiedAccessHeaderException;
  43
  44 import java.io.IOException;
  45 import java.time.Duration;
  46 import java.util.ArrayList;
  47 import java.util.HashSet;
  48 import java.util.List;
  49 import java.util.Map;
  50 import java.util.Optional;
  51 import java.util.Set;
  52 import java.util.concurrent.TimeUnit;
  53 import java.util.concurrent.atomic.AtomicLong;
  54
  55 public class SendHelper {
  56
  57     private final static Logger logger = LoggerFactory.getLogger(SendHelper.class);
  58
  59     private final SignalAccount account;
  60     private final SignalDependencies dependencies;
  61     private final Context context;
  62
  63     public SendHelper(final Context context) {
  64         this.account = context.getAccount();
  65         this.dependencies = context.getDependencies();
  66         this.context = context;
  67     }
  68
  69     /**
  70      * Send a single message to one recipient.
  71      * The message is extended with the current expiration timer.
  72      */
  73     public SendMessageResult sendMessage(
  74             final SignalServiceDataMessage.Builder messageBuilder, final RecipientId recipientId
  75     ) throws IOException {
  76         var contact = account.getContactStore().getContact(recipientId);
  77         if (contact == null || !contact.isProfileSharingEnabled()) {
  78             final var contactBuilder = contact == null ? Contact.newBuilder() : Contact.newBuilder(contact);
  79             contact = contactBuilder.withProfileSharingEnabled(true).build();
  80             account.getContactStore().storeContact(recipientId, contact);
  81         }
  82
  83         final var expirationTime = contact.getMessageExpirationTime();
  84         messageBuilder.withExpiration(expirationTime);
  85
  86         if (!contact.isBlocked()) {
  87             final var profileKey = account.getProfileKey().serialize();
  88             messageBuilder.withProfileKey(profileKey);
  89         }
  90
  91         final var message = messageBuilder.build();
  92         return sendMessage(message, recipientId);
  93     }
  94
  95     /**
  96      * Send a group message to the given group
  97      * The message is extended with the current expiration timer for the group and the group context.
  98      */
  99     public List<SendMessageResult> sendAsGroupMessage(
 100             SignalServiceDataMessage.Builder messageBuilder, GroupId groupId
 101     ) throws IOException, GroupNotFoundException, NotAGroupMemberException, GroupSendingNotAllowedException {
 102         final var g = getGroupForSending(groupId);
 103         return sendAsGroupMessage(messageBuilder, g);
 104     }
 105
 106     /**
 107      * Send a complete group message to the given recipients (should be current/old/new members)
 108      * This method should only be used for create/update/quit group messages.
 109      */
 110     public List<SendMessageResult> sendGroupMessage(
 111             final SignalServiceDataMessage message,
 112             final Set<RecipientId> recipientIds,
 113             final DistributionId distributionId
 114     ) throws IOException {
 115         return sendGroupMessage(message, recipientIds, distributionId, ContentHint.IMPLICIT);
 116     }
 117
 118     public SendMessageResult sendReceiptMessage(
 119             final SignalServiceReceiptMessage receiptMessage, final RecipientId recipientId
 120     ) {
 121         final var messageSendLogStore = account.getMessageSendLogStore();
 122         final var result = handleSendMessage(recipientId,
 123                 (messageSender, address, unidentifiedAccess) -> messageSender.sendReceipt(address,
 124                         unidentifiedAccess,
 125                         receiptMessage,
 126                         false));
 127         messageSendLogStore.insertIfPossible(receiptMessage.getWhen(), result, ContentHint.IMPLICIT, false);
 128         handleSendMessageResult(result);
 129         return result;
 130     }
 131
 132     public SendMessageResult sendProfileKey(RecipientId recipientId) {
 133         logger.debug("Sending updated profile key to recipient: {}", recipientId);
 134         final var profileKey = account.getProfileKey().serialize();
 135         final var message = SignalServiceDataMessage.newBuilder()
 136                 .asProfileKeyUpdate(true)
 137                 .withProfileKey(profileKey)
 138                 .build();
 139         return handleSendMessage(recipientId,
 140                 (messageSender, address, unidentifiedAccess) -> messageSender.sendDataMessage(address,
 141                         unidentifiedAccess,
 142                         ContentHint.IMPLICIT,
 143                         message,
 144                         SignalServiceMessageSender.IndividualSendEvents.EMPTY,
 145                         false,
 146                         false));
 147     }
 148
 149     public SendMessageResult sendRetryReceipt(
 150             DecryptionErrorMessage errorMessage, RecipientId recipientId, Optional<GroupId> groupId
 151     ) {
 152         logger.debug("Sending retry receipt for {} to {}, device: {}",
 153                 errorMessage.getTimestamp(),
 154                 recipientId,
 155                 errorMessage.getDeviceId());
 156         final var result = handleSendMessage(recipientId,
 157                 (messageSender, address, unidentifiedAccess) -> messageSender.sendRetryReceipt(address,
 158                         unidentifiedAccess,
 159                         groupId.map(GroupId::serialize),
 160                         errorMessage));
 161         handleSendMessageResult(result);
 162         return result;
 163     }
 164
 165     public SendMessageResult sendNullMessage(RecipientId recipientId) {
 166         final var result = handleSendMessage(recipientId, SignalServiceMessageSender::sendNullMessage);
 167         handleSendMessageResult(result);
 168         return result;
 169     }
 170
 171     public SendMessageResult sendSelfMessage(
 172             SignalServiceDataMessage.Builder messageBuilder
 173     ) {
 174         final var recipientId = account.getSelfRecipientId();
 175         final var contact = account.getContactStore().getContact(recipientId);
 176         final var expirationTime = contact != null ? contact.getMessageExpirationTime() : 0;
 177         messageBuilder.withExpiration(expirationTime);
 178
 179         var message = messageBuilder.build();
 180         return sendSelfMessage(message);
 181     }
 182
 183     public SendMessageResult sendSyncMessage(SignalServiceSyncMessage message) {
 184         var messageSender = dependencies.getMessageSender();
 185         try {
 186             return messageSender.sendSyncMessage(message, context.getUnidentifiedAccessHelper().getAccessForSync());
 187         } catch (UnregisteredUserException e) {
 188             var address = context.getRecipientHelper().resolveSignalServiceAddress(account.getSelfRecipientId());
 189             return SendMessageResult.unregisteredFailure(address);
 190         } catch (ProofRequiredException e) {
 191             var address = context.getRecipientHelper().resolveSignalServiceAddress(account.getSelfRecipientId());
 192             return SendMessageResult.proofRequiredFailure(address, e);
 193         } catch (RateLimitException e) {
 194             var address = context.getRecipientHelper().resolveSignalServiceAddress(account.getSelfRecipientId());
 195             logger.warn("Sending failed due to rate limiting from the signal server: {}", e.getMessage());
 196             return SendMessageResult.rateLimitFailure(address, e);
 197         } catch (org.whispersystems.signalservice.api.crypto.UntrustedIdentityException e) {
 198             var address = context.getRecipientHelper().resolveSignalServiceAddress(account.getSelfRecipientId());
 199             return SendMessageResult.identityFailure(address, e.getIdentityKey());
 200         } catch (IOException e) {
 201             var address = context.getRecipientHelper().resolveSignalServiceAddress(account.getSelfRecipientId());
 202             logger.warn("Failed to send message due to IO exception: {}", e.getMessage());
 203             logger.debug("Exception", e);
 204             return SendMessageResult.networkFailure(address);
 205         }
 206     }
 207
 208     public SendMessageResult sendTypingMessage(
 209             SignalServiceTypingMessage message, RecipientId recipientId
 210     ) {
 211         final var result = handleSendMessage(recipientId,
 212                 (messageSender, address, unidentifiedAccess) -> messageSender.sendTyping(List.of(address),
 213                         List.of(unidentifiedAccess),
 214                         message,
 215                         null).get(0));
 216         handleSendMessageResult(result);
 217         return result;
 218     }
 219
 220     public List<SendMessageResult> sendGroupTypingMessage(
 221             SignalServiceTypingMessage message, GroupId groupId
 222     ) throws IOException, NotAGroupMemberException, GroupNotFoundException, GroupSendingNotAllowedException {
 223         final var g = getGroupForSending(groupId);
 224         if (g.isAnnouncementGroup() && !g.isAdmin(account.getSelfRecipientId())) {
 225             throw new GroupSendingNotAllowedException(groupId, g.getTitle());
 226         }
 227         final var distributionId = g.getDistributionId();
 228         final var recipientIds = g.getMembersWithout(account.getSelfRecipientId());
 229
 230         return sendGroupTypingMessage(message, recipientIds, distributionId);
 231     }
 232
 233     public SendMessageResult resendMessage(
 234             final RecipientId recipientId, final long timestamp, final MessageSendLogEntry messageSendLogEntry
 235     ) {
 236         logger.trace("Resending message {} to {}", timestamp, recipientId);
 237         if (messageSendLogEntry.groupId().isEmpty()) {
 238             return handleSendMessage(recipientId,
 239                     (messageSender, address, unidentifiedAccess) -> messageSender.resendContent(address,
 240                             unidentifiedAccess,
 241                             timestamp,
 242                             messageSendLogEntry.content(),
 243                             messageSendLogEntry.contentHint(),
 244                             Optional.empty(),
 245                             messageSendLogEntry.urgent()));
 246         }
 247
 248         final var groupId = messageSendLogEntry.groupId().get();
 249         final var group = account.getGroupStore().getGroup(groupId);
 250
 251         if (group == null) {
 252             logger.debug("Could not find a matching group for the groupId {}! Skipping message send.",
 253                     groupId.toBase64());
 254             return null;
 255         } else if (!group.getMembers().contains(recipientId)) {
 256             logger.warn("The target user is no longer in the group {}! Skipping message send.", groupId.toBase64());
 257             return null;
 258         }
 259
 260         final var senderKeyDistributionMessage = dependencies.getMessageSender()
 261                 .getOrCreateNewGroupSession(group.getDistributionId());
 262         final var distributionBytes = ByteString.copyFrom(senderKeyDistributionMessage.serialize());
 263         final var contentToSend = messageSendLogEntry.content()
 264                 .toBuilder()
 265                 .setSenderKeyDistributionMessage(distributionBytes)
 266                 .build();
 267
 268         final var result = handleSendMessage(recipientId,
 269                 (messageSender, address, unidentifiedAccess) -> messageSender.resendContent(address,
 270                         unidentifiedAccess,
 271                         timestamp,
 272                         contentToSend,
 273                         messageSendLogEntry.contentHint(),
 274                         Optional.of(group.getGroupId().serialize()),
 275                         messageSendLogEntry.urgent()));
 276
 277         if (result.isSuccess()) {
 278             final var address = context.getRecipientHelper().resolveSignalServiceAddress(recipientId);
 279             final var addresses = result.getSuccess()
 280                     .getDevices()
 281                     .stream()
 282                     .map(device -> new SignalProtocolAddress(address.getIdentifier(), device))
 283                     .toList();
 284
 285             account.getSenderKeyStore().markSenderKeySharedWith(group.getDistributionId(), addresses);
 286         }
 287
 288         return result;
 289     }
 290
 291     private List<SendMessageResult> sendAsGroupMessage(
 292             final SignalServiceDataMessage.Builder messageBuilder, final GroupInfo g
 293     ) throws IOException, GroupSendingNotAllowedException {
 294         GroupUtils.setGroupContext(messageBuilder, g);
 295         messageBuilder.withExpiration(g.getMessageExpirationTimer());
 296
 297         final var message = messageBuilder.build();
 298         final var recipients = g.getMembersWithout(account.getSelfRecipientId());
 299
 300         if (g.isAnnouncementGroup() && !g.isAdmin(account.getSelfRecipientId())) {
 301             if (message.getBody().isPresent()
 302                     || message.getAttachments().isPresent()
 303                     || message.getQuote().isPresent()
 304                     || message.getPreviews().isPresent()
 305                     || message.getMentions().isPresent()
 306                     || message.getSticker().isPresent()) {
 307                 throw new GroupSendingNotAllowedException(g.getGroupId(), g.getTitle());
 308             }
 309         }
 310
 311         return sendGroupMessage(message, recipients, g.getDistributionId(), ContentHint.RESENDABLE);
 312     }
 313
 314     private List<SendMessageResult> sendGroupMessage(
 315             final SignalServiceDataMessage message,
 316             final Set<RecipientId> recipientIds,
 317             final DistributionId distributionId,
 318             final ContentHint contentHint
 319     ) throws IOException {
 320         final var messageSender = dependencies.getMessageSender();
 321         final var messageSendLogStore = account.getMessageSendLogStore();
 322         final AtomicLong entryId = new AtomicLong(-1);
 323
 324         final var urgent = true;
 325         final LegacySenderHandler legacySender = (recipients, unidentifiedAccess, isRecipientUpdate) -> messageSender.sendDataMessage(
 326                 recipients,
 327                 unidentifiedAccess,
 328                 isRecipientUpdate,
 329                 contentHint,
 330                 message,
 331                 SignalServiceMessageSender.LegacyGroupEvents.EMPTY,
 332                 sendResult -> {
 333                     logger.trace("Partial message send result: {}", sendResult.isSuccess());
 334                     synchronized (entryId) {
 335                         if (entryId.get() == -1) {
 336                             final var newId = messageSendLogStore.insertIfPossible(message.getTimestamp(),
 337                                     sendResult,
 338                                     contentHint,
 339                                     urgent);
 340                             entryId.set(newId);
 341                         } else {
 342                             messageSendLogStore.addRecipientToExistingEntryIfPossible(entryId.get(), sendResult);
 343                         }
 344                     }
 345                 },
 346                 () -> false,
 347                 urgent);
 348         final SenderKeySenderHandler senderKeySender = (distId, recipients, unidentifiedAccess, isRecipientUpdate) -> {
 349             final var res = messageSender.sendGroupDataMessage(distId,
 350                     recipients,
 351                     unidentifiedAccess,
 352                     isRecipientUpdate,
 353                     contentHint,
 354                     message,
 355                     SignalServiceMessageSender.SenderKeyGroupEvents.EMPTY,
 356                     urgent,
 357                     false);
 358             synchronized (entryId) {
 359                 if (entryId.get() == -1) {
 360                     final var newId = messageSendLogStore.insertIfPossible(message.getTimestamp(),
 361                             res,
 362                             contentHint,
 363                             urgent);
 364                     entryId.set(newId);
 365                 } else {
 366                     messageSendLogStore.addRecipientToExistingEntryIfPossible(entryId.get(), res);
 367                 }
 368             }
 369             return res;
 370         };
 371         final var results = sendGroupMessageInternal(legacySender, senderKeySender, recipientIds, distributionId);
 372
 373         for (var r : results) {
 374             handleSendMessageResult(r);
 375         }
 376
 377         return results;
 378     }
 379
 380     private List<SendMessageResult> sendGroupTypingMessage(
 381             final SignalServiceTypingMessage message,
 382             final Set<RecipientId> recipientIds,
 383             final DistributionId distributionId
 384     ) throws IOException {
 385         final var messageSender = dependencies.getMessageSender();
 386         final var results = sendGroupMessageInternal((recipients, unidentifiedAccess, isRecipientUpdate) -> messageSender.sendTyping(
 387                         recipients,
 388                         unidentifiedAccess,
 389                         message,
 390                         () -> false),
 391                 (distId, recipients, unidentifiedAccess, isRecipientUpdate) -> messageSender.sendGroupTyping(distId,
 392                         recipients,
 393                         unidentifiedAccess,
 394                         message),
 395                 recipientIds,
 396                 distributionId);
 397
 398         for (var r : results) {
 399             handleSendMessageResult(r);
 400         }
 401
 402         return results;
 403     }
 404
 405     private GroupInfo getGroupForSending(GroupId groupId) throws GroupNotFoundException, NotAGroupMemberException {
 406         var g = context.getGroupHelper().getGroup(groupId);
 407         if (g == null) {
 408             throw new GroupNotFoundException(groupId);
 409         }
 410         if (!g.isMember(account.getSelfRecipientId())) {
 411             throw new NotAGroupMemberException(groupId, g.getTitle());
 412         }
 413         return g;
 414     }
 415
 416     private List<SendMessageResult> sendGroupMessageInternal(
 417             final LegacySenderHandler legacySender,
 418             final SenderKeySenderHandler senderKeySender,
 419             final Set<RecipientId> recipientIds,
 420             final DistributionId distributionId
 421     ) throws IOException {
 422         long startTime = System.currentTimeMillis();
 423         // isRecipientUpdate is true if we've already sent this message to some recipients in the past, otherwise false.
 424         final var isRecipientUpdate = false;
 425         Set<RecipientId> senderKeyTargets = distributionId == null
 426                 ? Set.of()
 427                 : getSenderKeyCapableRecipientIds(recipientIds);
 428         final var allResults = new ArrayList<SendMessageResult>(recipientIds.size());
 429
 430         if (senderKeyTargets.size() > 0) {
 431             final var results = sendGroupMessageInternalWithSenderKey(senderKeySender,
 432                     senderKeyTargets,
 433                     distributionId,
 434                     isRecipientUpdate);
 435
 436             if (results == null) {
 437                 senderKeyTargets = Set.of();
 438             } else {
 439                 results.stream().filter(SendMessageResult::isSuccess).forEach(allResults::add);
 440                 final var failedTargets = results.stream()
 441                         .filter(r -> !r.isSuccess())
 442                         .map(r -> context.getRecipientHelper().resolveRecipient(r.getAddress()))
 443                         .toList();
 444                 if (failedTargets.size() > 0) {
 445                     senderKeyTargets = new HashSet<>(senderKeyTargets);
 446                     failedTargets.forEach(senderKeyTargets::remove);
 447                 }
 448             }
 449         }
 450
 451         final var legacyTargets = new HashSet<>(recipientIds);
 452         legacyTargets.removeAll(senderKeyTargets);
 453         final boolean onlyTargetIsSelfWithLinkedDevice = recipientIds.isEmpty() && account.isMultiDevice();
 454
 455         if (legacyTargets.size() > 0 || onlyTargetIsSelfWithLinkedDevice) {
 456             if (legacyTargets.size() > 0) {
 457                 logger.debug("Need to do {} legacy sends.", legacyTargets.size());
 458             } else {
 459                 logger.debug("Need to do a legacy send to send a sync message for a group of only ourselves.");
 460             }
 461
 462             final List<SendMessageResult> results = sendGroupMessageInternalWithLegacy(legacySender,
 463                     legacyTargets,
 464                     isRecipientUpdate || allResults.size() > 0);
 465             allResults.addAll(results);
 466         }
 467         final var duration = Duration.ofMillis(System.currentTimeMillis() - startTime);
 468         logger.debug("Sending took {}", duration.toString());
 469         return allResults;
 470     }
 471
 472     private Set<RecipientId> getSenderKeyCapableRecipientIds(final Set<RecipientId> recipientIds) {
 473         final var selfProfile = context.getProfileHelper().getSelfProfile();
 474         if (selfProfile == null || !selfProfile.getCapabilities().contains(Profile.Capability.senderKey)) {
 475             logger.debug("Not all of our devices support sender key. Using legacy.");
 476             return Set.of();
 477         }
 478
 479         final var senderKeyTargets = new HashSet<RecipientId>();
 480         final var recipientList = new ArrayList<>(recipientIds);
 481         final var profiles = context.getProfileHelper().getRecipientProfiles(recipientList).iterator();
 482         for (final var recipientId : recipientList) {
 483             final var profile = profiles.next();
 484             if (profile == null || !profile.getCapabilities().contains(Profile.Capability.senderKey)) {
 485                 continue;
 486             }
 487
 488             final var access = context.getUnidentifiedAccessHelper().getAccessFor(recipientId);
 489             if (access.isEmpty() || access.get().getTargetUnidentifiedAccess().isEmpty()) {
 490                 continue;
 491             }
 492
 493             final var serviceId = account.getRecipientAddressResolver()
 494                     .resolveRecipientAddress(recipientId)
 495                     .serviceId()
 496                     .orElse(null);
 497             if (serviceId == null) {
 498                 continue;
 499             }
 500             final var identity = account.getIdentityKeyStore().getIdentityInfo(serviceId);
 501             if (identity == null || !identity.getTrustLevel().isTrusted()) {
 502                 continue;
 503             }
 504
 505             senderKeyTargets.add(recipientId);
 506         }
 507
 508         if (senderKeyTargets.size() < 2) {
 509             logger.debug("Too few sender-key-capable users ({}). Doing all legacy sends.", senderKeyTargets.size());
 510             return Set.of();
 511         }
 512
 513         logger.debug("Can use sender key for {}/{} recipients.", senderKeyTargets.size(), recipientIds.size());
 514         return senderKeyTargets;
 515     }
 516
 517     private List<SendMessageResult> sendGroupMessageInternalWithLegacy(
 518             final LegacySenderHandler sender, final Set<RecipientId> recipientIds, final boolean isRecipientUpdate
 519     ) throws IOException {
 520         final var recipientIdList = new ArrayList<>(recipientIds);
 521         final var addresses = recipientIdList.stream()
 522                 .map(context.getRecipientHelper()::resolveSignalServiceAddress)
 523                 .toList();
 524         final var unidentifiedAccesses = context.getUnidentifiedAccessHelper().getAccessFor(recipientIdList);
 525         try {
 526             final var results = sender.send(addresses, unidentifiedAccesses, isRecipientUpdate);
 527
 528             final var successCount = results.stream().filter(SendMessageResult::isSuccess).count();
 529             logger.debug("Successfully sent using 1:1 to {}/{} legacy targets.", successCount, recipientIdList.size());
 530             return results;
 531         } catch (org.whispersystems.signalservice.api.crypto.UntrustedIdentityException e) {
 532             return List.of();
 533         }
 534     }
 535
 536     private List<SendMessageResult> sendGroupMessageInternalWithSenderKey(
 537             final SenderKeySenderHandler sender,
 538             final Set<RecipientId> recipientIds,
 539             final DistributionId distributionId,
 540             final boolean isRecipientUpdate
 541     ) throws IOException {
 542         final var recipientIdList = new ArrayList<>(recipientIds);
 543
 544         long keyCreateTime = account.getSenderKeyStore()
 545                 .getCreateTimeForOurKey(account.getAci(), account.getDeviceId(), distributionId);
 546         long keyAge = System.currentTimeMillis() - keyCreateTime;
 547
 548         if (keyCreateTime != -1 && keyAge > TimeUnit.DAYS.toMillis(14)) {
 549             logger.debug("DistributionId {} was created at {} and is {} ms old (~{} days). Rotating.",
 550                     distributionId,
 551                     keyCreateTime,
 552                     keyAge,
 553                     TimeUnit.MILLISECONDS.toDays(keyAge));
 554             account.getSenderKeyStore().deleteOurKey(account.getAci(), distributionId);
 555         }
 556
 557         List<SignalServiceAddress> addresses = recipientIdList.stream()
 558                 .map(context.getRecipientHelper()::resolveSignalServiceAddress)
 559                 .toList();
 560         List<UnidentifiedAccess> unidentifiedAccesses = context.getUnidentifiedAccessHelper()
 561                 .getAccessFor(recipientIdList)
 562                 .stream()
 563                 .map(Optional::get)
 564                 .map(UnidentifiedAccessPair::getTargetUnidentifiedAccess)
 565                 .map(Optional::get)
 566                 .toList();
 567
 568         try {
 569             List<SendMessageResult> results = sender.send(distributionId,
 570                     addresses,
 571                     unidentifiedAccesses,
 572                     isRecipientUpdate);
 573
 574             final var successCount = results.stream().filter(SendMessageResult::isSuccess).count();
 575             logger.debug("Successfully sent using sender key to {}/{} sender key targets.",
 576                     successCount,
 577                     addresses.size());
 578
 579             return results;
 580         } catch (org.whispersystems.signalservice.api.crypto.UntrustedIdentityException e) {
 581             return null;
 582         } catch (InvalidUnidentifiedAccessHeaderException e) {
 583             logger.warn("Someone had a bad UD header. Falling back to legacy sends.", e);
 584             return null;
 585         } catch (NoSessionException e) {
 586             logger.warn("No session. Falling back to legacy sends.", e);
 587             account.getSenderKeyStore().deleteOurKey(account.getAci(), distributionId);
 588             return null;
 589         } catch (InvalidKeyException e) {
 590             logger.warn("Invalid key. Falling back to legacy sends.", e);
 591             account.getSenderKeyStore().deleteOurKey(account.getAci(), distributionId);
 592             return null;
 593         } catch (InvalidRegistrationIdException e) {
 594             logger.warn("Invalid registrationId. Falling back to legacy sends.", e);
 595             return null;
 596         } catch (NotFoundException e) {
 597             logger.warn("Someone was unregistered. Falling back to legacy sends.", e);
 598             return null;
 599         }
 600     }
 601
 602     private SendMessageResult sendMessage(
 603             SignalServiceDataMessage message, RecipientId recipientId
 604     ) {
 605         final var messageSendLogStore = account.getMessageSendLogStore();
 606         final var urgent = true;
 607         final var result = handleSendMessage(recipientId,
 608                 (messageSender, address, unidentifiedAccess) -> messageSender.sendDataMessage(address,
 609                         unidentifiedAccess,
 610                         ContentHint.RESENDABLE,
 611                         message,
 612                         SignalServiceMessageSender.IndividualSendEvents.EMPTY,
 613                         urgent,
 614                         false));
 615         messageSendLogStore.insertIfPossible(message.getTimestamp(), result, ContentHint.RESENDABLE, urgent);
 616         handleSendMessageResult(result);
 617         return result;
 618     }
 619
 620     private SendMessageResult handleSendMessage(RecipientId recipientId, SenderHandler s) {
 621         var messageSender = dependencies.getMessageSender();
 622
 623         var address = context.getRecipientHelper().resolveSignalServiceAddress(recipientId);
 624         try {
 625             try {
 626                 return s.send(messageSender, address, context.getUnidentifiedAccessHelper().getAccessFor(recipientId));
 627             } catch (UnregisteredUserException e) {
 628                 final RecipientId newRecipientId;
 629                 try {
 630                     newRecipientId = context.getRecipientHelper().refreshRegisteredUser(recipientId);
 631                 } catch (UnregisteredRecipientException ex) {
 632                     return SendMessageResult.unregisteredFailure(address);
 633                 }
 634                 address = context.getRecipientHelper().resolveSignalServiceAddress(newRecipientId);
 635                 return s.send(messageSender,
 636                         address,
 637                         context.getUnidentifiedAccessHelper().getAccessFor(newRecipientId));
 638             }
 639         } catch (UnregisteredUserException e) {
 640             return SendMessageResult.unregisteredFailure(address);
 641         } catch (ProofRequiredException e) {
 642             return SendMessageResult.proofRequiredFailure(address, e);
 643         } catch (RateLimitException e) {
 644             logger.warn("Sending failed due to rate limiting from the signal server: {}", e.getMessage());
 645             return SendMessageResult.rateLimitFailure(address, e);
 646         } catch (org.whispersystems.signalservice.api.crypto.UntrustedIdentityException e) {
 647             return SendMessageResult.identityFailure(address, e.getIdentityKey());
 648         } catch (IOException e) {
 649             logger.warn("Failed to send message due to IO exception: {}", e.getMessage());
 650             logger.debug("Exception", e);
 651             return SendMessageResult.networkFailure(address);
 652         }
 653     }
 654
 655     private SendMessageResult sendSelfMessage(SignalServiceDataMessage message) {
 656         var address = account.getSelfAddress();
 657         var transcript = new SentTranscriptMessage(Optional.of(address),
 658                 message.getTimestamp(),
 659                 Optional.of(message),
 660                 message.getExpiresInSeconds(),
 661                 Map.of(address.getServiceId(), true),
 662                 false,
 663                 Optional.empty(),
 664                 Set.of());
 665         var syncMessage = SignalServiceSyncMessage.forSentTranscript(transcript);
 666
 667         return sendSyncMessage(syncMessage);
 668     }
 669
 670     private void handleSendMessageResult(final SendMessageResult r) {
 671         if (r.isSuccess() && !r.getSuccess().isUnidentified()) {
 672             final var recipientId = context.getRecipientHelper().resolveRecipient(r.getAddress());
 673             final var profile = account.getProfileStore().getProfile(recipientId);
 674             if (profile != null && (
 675                     profile.getUnidentifiedAccessMode() == Profile.UnidentifiedAccessMode.ENABLED
 676                             || profile.getUnidentifiedAccessMode() == Profile.UnidentifiedAccessMode.UNRESTRICTED
 677             )) {
 678                 account.getProfileStore()
 679                         .storeProfile(recipientId,
 680                                 Profile.newBuilder(profile)
 681                                         .withUnidentifiedAccessMode(Profile.UnidentifiedAccessMode.UNKNOWN)
 682                                         .build());
 683             }
 684         }
 685         if (r.isUnregisteredFailure()) {
 686             final var recipientId = context.getRecipientHelper().resolveRecipient(r.getAddress());
 687             final var profile = account.getProfileStore().getProfile(recipientId);
 688             if (profile != null && (
 689                     profile.getUnidentifiedAccessMode() == Profile.UnidentifiedAccessMode.ENABLED
 690                             || profile.getUnidentifiedAccessMode() == Profile.UnidentifiedAccessMode.UNRESTRICTED
 691             )) {
 692                 account.getProfileStore()
 693                         .storeProfile(recipientId,
 694                                 Profile.newBuilder(profile)
 695                                         .withUnidentifiedAccessMode(Profile.UnidentifiedAccessMode.UNKNOWN)
 696                                         .build());
 697             }
 698         }
 699         if (r.getIdentityFailure() != null) {
 700             final var recipientId = context.getRecipientHelper().resolveRecipient(r.getAddress());
 701             context.getIdentityHelper()
 702                     .handleIdentityFailure(recipientId, r.getAddress().getServiceId(), r.getIdentityFailure());
 703         }
 704     }
 705
 706     interface SenderHandler {
 707
 708         SendMessageResult send(
 709                 SignalServiceMessageSender messageSender,
 710                 SignalServiceAddress address,
 711                 Optional<UnidentifiedAccessPair> unidentifiedAccess
 712         ) throws IOException, UnregisteredUserException, ProofRequiredException, RateLimitException, org.whispersystems.signalservice.api.crypto.UntrustedIdentityException;
 713     }
 714
 715     interface SenderKeySenderHandler {
 716
 717         List<SendMessageResult> send(
 718                 DistributionId distributionId,
 719                 List<SignalServiceAddress> recipients,
 720                 List<UnidentifiedAccess> unidentifiedAccess,
 721                 boolean isRecipientUpdate
 722         ) throws IOException, UntrustedIdentityException, NoSessionException, InvalidKeyException, InvalidRegistrationIdException;
 723     }
 724
 725     interface LegacySenderHandler {
 726
 727         List<SendMessageResult> send(
 728                 List<SignalServiceAddress> recipients,
 729                 List<Optional<UnidentifiedAccessPair>> unidentifiedAccess,
 730                 boolean isRecipientUpdate
 731         ) throws IOException, UntrustedIdentityException;
 732     }
 733 }