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

   1 package org.asamk.signal.manager.helper;
   2
   3 import org.asamk.signal.manager.api.Contact;
   4 import org.asamk.signal.manager.api.GroupId;
   5 import org.asamk.signal.manager.api.TrustLevel;
   6 import org.asamk.signal.manager.storage.SignalAccount;
   7 import org.asamk.signal.manager.storage.groups.GroupInfoV1;
   8 import org.asamk.signal.manager.storage.recipients.RecipientAddress;
   9 import org.asamk.signal.manager.storage.stickers.StickerPack;
  10 import org.asamk.signal.manager.util.AttachmentUtils;
  11 import org.asamk.signal.manager.util.IOUtils;
  12 import org.asamk.signal.manager.util.MimeUtils;
  13 import org.signal.libsignal.protocol.IdentityKey;
  14 import org.slf4j.Logger;
  15 import org.slf4j.LoggerFactory;
  16 import org.whispersystems.signalservice.api.messages.SendMessageResult;
  17 import org.whispersystems.signalservice.api.messages.SignalServiceAttachment;
  18 import org.whispersystems.signalservice.api.messages.SignalServiceAttachmentStream;
  19 import org.whispersystems.signalservice.api.messages.multidevice.BlockedListMessage;
  20 import org.whispersystems.signalservice.api.messages.multidevice.ConfigurationMessage;
  21 import org.whispersystems.signalservice.api.messages.multidevice.ContactsMessage;
  22 import org.whispersystems.signalservice.api.messages.multidevice.DeviceContact;
  23 import org.whispersystems.signalservice.api.messages.multidevice.DeviceContactsInputStream;
  24 import org.whispersystems.signalservice.api.messages.multidevice.DeviceContactsOutputStream;
  25 import org.whispersystems.signalservice.api.messages.multidevice.DeviceGroup;
  26 import org.whispersystems.signalservice.api.messages.multidevice.DeviceGroupsInputStream;
  27 import org.whispersystems.signalservice.api.messages.multidevice.DeviceGroupsOutputStream;
  28 import org.whispersystems.signalservice.api.messages.multidevice.KeysMessage;
  29 import org.whispersystems.signalservice.api.messages.multidevice.RequestMessage;
  30 import org.whispersystems.signalservice.api.messages.multidevice.SignalServiceSyncMessage;
  31 import org.whispersystems.signalservice.api.messages.multidevice.StickerPackOperationMessage;
  32 import org.whispersystems.signalservice.api.messages.multidevice.VerifiedMessage;
  33 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
  34 import org.whispersystems.signalservice.internal.push.SyncMessage;
  35
  36 import java.io.FileInputStream;
  37 import java.io.FileOutputStream;
  38 import java.io.IOException;
  39 import java.io.InputStream;
  40 import java.io.OutputStream;
  41 import java.nio.file.Files;
  42 import java.util.ArrayList;
  43 import java.util.List;
  44 import java.util.Optional;
  45 import java.util.stream.Collectors;
  46 import java.util.stream.Stream;
  47
  48 public class SyncHelper {
  49
  50     private final static Logger logger = LoggerFactory.getLogger(SyncHelper.class);
  51
  52     private final Context context;
  53     private final SignalAccount account;
  54
  55     public SyncHelper(final Context context) {
  56         this.context = context;
  57         this.account = context.getAccount();
  58     }
  59
  60     public void requestAllSyncData() {
  61         requestSyncData(SyncMessage.Request.Type.GROUPS);
  62         requestSyncData(SyncMessage.Request.Type.CONTACTS);
  63         requestSyncData(SyncMessage.Request.Type.BLOCKED);
  64         requestSyncData(SyncMessage.Request.Type.CONFIGURATION);
  65         requestSyncKeys();
  66         requestSyncPniIdentity();
  67     }
  68
  69     public void requestSyncKeys() {
  70         requestSyncData(SyncMessage.Request.Type.KEYS);
  71     }
  72
  73     public void requestSyncPniIdentity() {
  74         requestSyncData(SyncMessage.Request.Type.PNI_IDENTITY);
  75     }
  76
  77     public SendMessageResult sendSyncFetchProfileMessage() {
  78         return context.getSendHelper()
  79                 .sendSyncMessage(SignalServiceSyncMessage.forFetchLatest(SignalServiceSyncMessage.FetchType.LOCAL_PROFILE));
  80     }
  81
  82     public void sendGroups() throws IOException {
  83         var groupsFile = IOUtils.createTempFile();
  84
  85         try {
  86             try (OutputStream fos = new FileOutputStream(groupsFile)) {
  87                 var out = new DeviceGroupsOutputStream(fos);
  88                 for (var record : account.getGroupStore().getGroups()) {
  89                     if (record instanceof GroupInfoV1 groupInfo) {
  90                         out.write(new DeviceGroup(groupInfo.getGroupId().serialize(),
  91                                 Optional.ofNullable(groupInfo.name),
  92                                 groupInfo.getMembers()
  93                                         .stream()
  94                                         .map(context.getRecipientHelper()::resolveSignalServiceAddress)
  95                                         .toList(),
  96                                 context.getGroupHelper().createGroupAvatarAttachment(groupInfo.getGroupId()),
  97                                 groupInfo.isMember(account.getSelfRecipientId()),
  98                                 Optional.of(groupInfo.messageExpirationTime),
  99                                 Optional.ofNullable(groupInfo.color),
 100                                 groupInfo.blocked,
 101                                 Optional.empty(),
 102                                 groupInfo.archived));
 103                     }
 104                 }
 105             }
 106
 107             if (groupsFile.exists() && groupsFile.length() > 0) {
 108                 try (var groupsFileStream = new FileInputStream(groupsFile)) {
 109                     var attachmentStream = SignalServiceAttachment.newStreamBuilder()
 110                             .withStream(groupsFileStream)
 111                             .withContentType(MimeUtils.OCTET_STREAM)
 112                             .withLength(groupsFile.length())
 113                             .build();
 114
 115                     context.getSendHelper().sendSyncMessage(SignalServiceSyncMessage.forGroups(attachmentStream));
 116                 }
 117             }
 118         } finally {
 119             try {
 120                 Files.delete(groupsFile.toPath());
 121             } catch (IOException e) {
 122                 logger.warn("Failed to delete groups temp file “{}”, ignoring: {}", groupsFile, e.getMessage());
 123             }
 124         }
 125     }
 126
 127     public void sendContacts() throws IOException {
 128         var contactsFile = IOUtils.createTempFile();
 129
 130         try {
 131             try (OutputStream fos = new FileOutputStream(contactsFile)) {
 132                 var out = new DeviceContactsOutputStream(fos);
 133                 for (var contactPair : account.getContactStore().getContacts()) {
 134                     final var recipientId = contactPair.first();
 135                     final var contact = contactPair.second();
 136                     final var address = context.getRecipientHelper().resolveSignalServiceAddress(recipientId);
 137
 138                     var currentIdentity = account.getIdentityKeyStore().getIdentityInfo(address.getServiceId());
 139                     VerifiedMessage verifiedMessage = null;
 140                     if (currentIdentity != null) {
 141                         verifiedMessage = new VerifiedMessage(address,
 142                                 currentIdentity.getIdentityKey(),
 143                                 currentIdentity.getTrustLevel().toVerifiedState(),
 144                                 currentIdentity.getDateAddedTimestamp());
 145                     }
 146
 147                     var profileKey = account.getProfileStore().getProfileKey(recipientId);
 148                     out.write(new DeviceContact(address,
 149                             Optional.ofNullable(contact.getName()),
 150                             createContactAvatarAttachment(new RecipientAddress(address)),
 151                             Optional.ofNullable(contact.getColor()),
 152                             Optional.ofNullable(verifiedMessage),
 153                             Optional.ofNullable(profileKey),
 154                             contact.isBlocked(),
 155                             Optional.of(contact.getMessageExpirationTime()),
 156                             Optional.empty(),
 157                             contact.isArchived()));
 158                 }
 159
 160                 if (account.getProfileKey() != null) {
 161                     // Send our own profile key as well
 162                     out.write(new DeviceContact(account.getSelfAddress(),
 163                             Optional.empty(),
 164                             Optional.empty(),
 165                             Optional.empty(),
 166                             Optional.empty(),
 167                             Optional.of(account.getProfileKey()),
 168                             false,
 169                             Optional.empty(),
 170                             Optional.empty(),
 171                             false));
 172                 }
 173             }
 174
 175             if (contactsFile.exists() && contactsFile.length() > 0) {
 176                 try (var contactsFileStream = new FileInputStream(contactsFile)) {
 177                     var attachmentStream = SignalServiceAttachment.newStreamBuilder()
 178                             .withStream(contactsFileStream)
 179                             .withContentType(MimeUtils.OCTET_STREAM)
 180                             .withLength(contactsFile.length())
 181                             .build();
 182
 183                     context.getSendHelper()
 184                             .sendSyncMessage(SignalServiceSyncMessage.forContacts(new ContactsMessage(attachmentStream,
 185                                     true)));
 186                 }
 187             }
 188         } finally {
 189             try {
 190                 Files.delete(contactsFile.toPath());
 191             } catch (IOException e) {
 192                 logger.warn("Failed to delete contacts temp file “{}”, ignoring: {}", contactsFile, e.getMessage());
 193             }
 194         }
 195     }
 196
 197     public SendMessageResult sendBlockedList() {
 198         var addresses = new ArrayList<SignalServiceAddress>();
 199         for (var record : account.getContactStore().getContacts()) {
 200             if (record.second().isBlocked()) {
 201                 addresses.add(context.getRecipientHelper().resolveSignalServiceAddress(record.first()));
 202             }
 203         }
 204         var groupIds = new ArrayList<byte[]>();
 205         for (var record : account.getGroupStore().getGroups()) {
 206             if (record.isBlocked()) {
 207                 groupIds.add(record.getGroupId().serialize());
 208             }
 209         }
 210         return context.getSendHelper()
 211                 .sendSyncMessage(SignalServiceSyncMessage.forBlocked(new BlockedListMessage(addresses, groupIds)));
 212     }
 213
 214     public SendMessageResult sendVerifiedMessage(
 215             SignalServiceAddress destination, IdentityKey identityKey, TrustLevel trustLevel
 216     ) {
 217         var verifiedMessage = new VerifiedMessage(destination,
 218                 identityKey,
 219                 trustLevel.toVerifiedState(),
 220                 System.currentTimeMillis());
 221         return context.getSendHelper().sendSyncMessage(SignalServiceSyncMessage.forVerified(verifiedMessage));
 222     }
 223
 224     public SendMessageResult sendKeysMessage() {
 225         var keysMessage = new KeysMessage(Optional.ofNullable(account.getStorageKey()),
 226                 Optional.ofNullable(account.getOrCreatePinMasterKey()));
 227         return context.getSendHelper().sendSyncMessage(SignalServiceSyncMessage.forKeys(keysMessage));
 228     }
 229
 230     public SendMessageResult sendStickerOperationsMessage(
 231             List<StickerPack> installStickers, List<StickerPack> removeStickers
 232     ) {
 233         var installStickerMessages = installStickers.stream().map(s -> getStickerPackOperationMessage(s, true));
 234         var removeStickerMessages = removeStickers.stream().map(s -> getStickerPackOperationMessage(s, false));
 235         var stickerMessages = Stream.concat(installStickerMessages, removeStickerMessages).toList();
 236         return context.getSendHelper()
 237                 .sendSyncMessage(SignalServiceSyncMessage.forStickerPackOperations(stickerMessages));
 238     }
 239
 240     private static StickerPackOperationMessage getStickerPackOperationMessage(
 241             final StickerPack s, final boolean installed
 242     ) {
 243         return new StickerPackOperationMessage(s.packId().serialize(),
 244                 s.packKey(),
 245                 installed ? StickerPackOperationMessage.Type.INSTALL : StickerPackOperationMessage.Type.REMOVE);
 246     }
 247
 248     public SendMessageResult sendConfigurationMessage() {
 249         final var config = account.getConfigurationStore();
 250         var configurationMessage = new ConfigurationMessage(Optional.ofNullable(config.getReadReceipts()),
 251                 Optional.ofNullable(config.getUnidentifiedDeliveryIndicators()),
 252                 Optional.ofNullable(config.getTypingIndicators()),
 253                 Optional.ofNullable(config.getLinkPreviews()));
 254         return context.getSendHelper().sendSyncMessage(SignalServiceSyncMessage.forConfiguration(configurationMessage));
 255     }
 256
 257     public void handleSyncDeviceGroups(final InputStream input) {
 258         final var s = new DeviceGroupsInputStream(input);
 259         DeviceGroup g;
 260         while (true) {
 261             try {
 262                 g = s.read();
 263             } catch (IOException e) {
 264                 logger.warn("Sync groups contained invalid group, ignoring: {}", e.getMessage());
 265                 continue;
 266             }
 267             if (g == null) {
 268                 break;
 269             }
 270             var syncGroup = account.getGroupStore().getOrCreateGroupV1(GroupId.v1(g.getId()));
 271             if (syncGroup != null) {
 272                 if (g.getName().isPresent()) {
 273                     syncGroup.name = g.getName().get();
 274                 }
 275                 syncGroup.addMembers(g.getMembers()
 276                         .stream()
 277                         .map(account.getRecipientResolver()::resolveRecipient)
 278                         .collect(Collectors.toSet()));
 279                 if (!g.isActive()) {
 280                     syncGroup.removeMember(account.getSelfRecipientId());
 281                 } else {
 282                     // Add ourself to the member set as it's marked as active
 283                     syncGroup.addMembers(List.of(account.getSelfRecipientId()));
 284                 }
 285                 syncGroup.blocked = g.isBlocked();
 286                 if (g.getColor().isPresent()) {
 287                     syncGroup.color = g.getColor().get();
 288                 }
 289
 290                 if (g.getAvatar().isPresent()) {
 291                     context.getGroupHelper().downloadGroupAvatar(syncGroup.getGroupId(), g.getAvatar().get());
 292                 }
 293                 syncGroup.archived = g.isArchived();
 294                 account.getGroupStore().updateGroup(syncGroup);
 295             }
 296         }
 297     }
 298
 299     public void handleSyncDeviceContacts(final InputStream input) throws IOException {
 300         final var s = new DeviceContactsInputStream(input);
 301         DeviceContact c;
 302         while (true) {
 303             try {
 304                 c = s.read();
 305             } catch (IOException e) {
 306                 if (e.getMessage() != null && e.getMessage().contains("Missing contact address!")) {
 307                     logger.warn("Sync contacts contained invalid contact, ignoring: {}", e.getMessage());
 308                     continue;
 309                 } else {
 310                     throw e;
 311                 }
 312             }
 313             if (c == null) {
 314                 break;
 315             }
 316             if (c.getAddress().matches(account.getSelfAddress()) && c.getProfileKey().isPresent()) {
 317                 account.setProfileKey(c.getProfileKey().get());
 318             }
 319             final var recipientId = account.getRecipientTrustedResolver().resolveRecipientTrusted(c.getAddress());
 320             var contact = account.getContactStore().getContact(recipientId);
 321             final var builder = contact == null ? Contact.newBuilder() : Contact.newBuilder(contact);
 322             if (c.getName().isPresent()) {
 323                 builder.withGivenName(c.getName().get());
 324                 builder.withFamilyName(null);
 325             }
 326             if (c.getColor().isPresent()) {
 327                 builder.withColor(c.getColor().get());
 328             }
 329             if (c.getProfileKey().isPresent()) {
 330                 account.getProfileStore().storeProfileKey(recipientId, c.getProfileKey().get());
 331             }
 332             if (c.getVerified().isPresent()) {
 333                 final var verifiedMessage = c.getVerified().get();
 334                 account.getIdentityKeyStore()
 335                         .setIdentityTrustLevel(verifiedMessage.getDestination().getServiceId(),
 336                                 verifiedMessage.getIdentityKey(),
 337                                 TrustLevel.fromVerifiedState(verifiedMessage.getVerified()));
 338             }
 339             if (c.getExpirationTimer().isPresent()) {
 340                 builder.withMessageExpirationTime(c.getExpirationTimer().get());
 341             }
 342             builder.withBlocked(c.isBlocked());
 343             builder.withArchived(c.isArchived());
 344             account.getContactStore().storeContact(recipientId, builder.build());
 345
 346             if (c.getAvatar().isPresent()) {
 347                 downloadContactAvatar(c.getAvatar().get(), new RecipientAddress(c.getAddress()));
 348             }
 349         }
 350     }
 351
 352     private SendMessageResult requestSyncData(final SyncMessage.Request.Type type) {
 353         var r = new SyncMessage.Request.Builder().type(type).build();
 354         var message = SignalServiceSyncMessage.forRequest(new RequestMessage(r));
 355         return context.getSendHelper().sendSyncMessage(message);
 356     }
 357
 358     private Optional<SignalServiceAttachmentStream> createContactAvatarAttachment(RecipientAddress address) throws IOException {
 359         final var streamDetails = context.getAvatarStore().retrieveContactAvatar(address);
 360         if (streamDetails == null) {
 361             return Optional.empty();
 362         }
 363
 364         return Optional.of(AttachmentUtils.createAttachmentStream(streamDetails, Optional.empty()));
 365     }
 366
 367     private void downloadContactAvatar(SignalServiceAttachment avatar, RecipientAddress address) {
 368         try {
 369             context.getAvatarStore()
 370                     .storeContactAvatar(address,
 371                             outputStream -> context.getAttachmentHelper().retrieveAttachment(avatar, outputStream));
 372         } catch (IOException e) {
 373             logger.warn("Failed to download avatar for contact {}, ignoring: {}", address, e.getMessage());
 374         }
 375     }
 376 }