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

   1 package org.asamk.signal.manager.helper;
   2
   3 import org.asamk.signal.manager.SignalDependencies;
   4 import org.asamk.signal.manager.api.PhoneNumberSharingMode;
   5 import org.asamk.signal.manager.api.TrustLevel;
   6 import org.asamk.signal.manager.groups.GroupId;
   7 import org.asamk.signal.manager.storage.SignalAccount;
   8 import org.asamk.signal.manager.storage.recipients.Contact;
   9 import org.asamk.signal.manager.storage.recipients.Profile;
  10 import org.asamk.signal.manager.storage.recipients.RecipientAddress;
  11 import org.signal.libsignal.protocol.IdentityKey;
  12 import org.signal.libsignal.protocol.InvalidKeyException;
  13 import org.signal.libsignal.zkgroup.InvalidInputException;
  14 import org.signal.libsignal.zkgroup.groups.GroupMasterKey;
  15 import org.signal.libsignal.zkgroup.profiles.ProfileKey;
  16 import org.slf4j.Logger;
  17 import org.slf4j.LoggerFactory;
  18 import org.whispersystems.signalservice.api.storage.SignalAccountRecord;
  19 import org.whispersystems.signalservice.api.storage.SignalStorageManifest;
  20 import org.whispersystems.signalservice.api.storage.SignalStorageRecord;
  21 import org.whispersystems.signalservice.api.storage.StorageId;
  22 import org.whispersystems.signalservice.internal.storage.protos.AccountRecord;
  23 import org.whispersystems.signalservice.internal.storage.protos.ManifestRecord;
  24
  25 import java.io.IOException;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.Collections;
  29 import java.util.List;
  30 import java.util.Optional;
  31 import java.util.stream.Collectors;
  32
  33 public class StorageHelper {
  34
  35     private final static Logger logger = LoggerFactory.getLogger(StorageHelper.class);
  36
  37     private final SignalAccount account;
  38     private final SignalDependencies dependencies;
  39     private final Context context;
  40
  41     public StorageHelper(final Context context) {
  42         this.account = context.getAccount();
  43         this.dependencies = context.getDependencies();
  44         this.context = context;
  45     }
  46
  47     public void readDataFromStorage() throws IOException {
  48         final var storageKey = account.getOrCreateStorageKey();
  49         if (storageKey == null) {
  50             logger.debug("Storage key unknown, requesting from primary device.");
  51             context.getSyncHelper().requestSyncKeys();
  52             return;
  53         }
  54
  55         logger.debug("Reading data from remote storage");
  56         Optional<SignalStorageManifest> manifest;
  57         try {
  58             manifest = dependencies.getAccountManager()
  59                     .getStorageManifestIfDifferentVersion(storageKey, account.getStorageManifestVersion());
  60         } catch (InvalidKeyException e) {
  61             logger.warn("Manifest couldn't be decrypted, ignoring.");
  62             return;
  63         }
  64
  65         if (manifest.isEmpty()) {
  66             logger.debug("Manifest is up to date, does not exist or couldn't be decrypted, ignoring.");
  67             return;
  68         }
  69
  70         logger.trace("Remote storage manifest has {} records", manifest.get().getStorageIds().size());
  71         final var storageIds = manifest.get()
  72                 .getStorageIds()
  73                 .stream()
  74                 .filter(id -> !id.isUnknown())
  75                 .collect(Collectors.toSet());
  76
  77         Optional<SignalStorageManifest> localManifest = account.getStorageManifest();
  78         localManifest.ifPresent(m -> m.getStorageIds().forEach(storageIds::remove));
  79
  80         logger.trace("Reading {} new records", manifest.get().getStorageIds().size());
  81         for (final var record : getSignalStorageRecords(storageIds)) {
  82             logger.debug("Reading record of type {}", record.getType());
  83             if (record.getType() == ManifestRecord.Identifier.Type.ACCOUNT_VALUE) {
  84                 readAccountRecord(record);
  85             } else if (record.getType() == ManifestRecord.Identifier.Type.GROUPV2_VALUE) {
  86                 readGroupV2Record(record);
  87             } else if (record.getType() == ManifestRecord.Identifier.Type.GROUPV1_VALUE) {
  88                 readGroupV1Record(record);
  89             } else if (record.getType() == ManifestRecord.Identifier.Type.CONTACT_VALUE) {
  90                 readContactRecord(record);
  91             }
  92         }
  93         account.setStorageManifestVersion(manifest.get().getVersion());
  94         account.setStorageManifest(manifest.get());
  95         logger.debug("Done reading data from remote storage");
  96     }
  97
  98     private void readContactRecord(final SignalStorageRecord record) {
  99         if (record == null || record.getContact().isEmpty()) {
 100             return;
 101         }
 102
 103         final var contactRecord = record.getContact().get();
 104         final var address = new RecipientAddress(contactRecord.getServiceId().uuid(),
 105                 contactRecord.getNumber().orElse(null));
 106         final var recipientId = account.getRecipientResolver().resolveRecipient(address);
 107
 108         final var contact = account.getContactStore().getContact(recipientId);
 109         final var blocked = contact != null && contact.isBlocked();
 110         final var profileShared = contact != null && contact.isProfileSharingEnabled();
 111         final var archived = contact != null && contact.isArchived();
 112         if (blocked != contactRecord.isBlocked()
 113                 || profileShared != contactRecord.isProfileSharingEnabled()
 114                 || archived != contactRecord.isArchived()) {
 115             logger.debug("Storing new or updated contact {}", recipientId);
 116             final var contactBuilder = contact == null ? Contact.newBuilder() : Contact.newBuilder(contact);
 117             final var newContact = contactBuilder.withBlocked(contactRecord.isBlocked())
 118                     .withProfileSharingEnabled(contactRecord.isProfileSharingEnabled())
 119                     .withArchived(contactRecord.isArchived())
 120                     .build();
 121             account.getContactStore().storeContact(recipientId, newContact);
 122         }
 123
 124         final var profile = account.getProfileStore().getProfile(recipientId);
 125         final var givenName = profile == null ? null : profile.getGivenName();
 126         final var familyName = profile == null ? null : profile.getFamilyName();
 127         if ((contactRecord.getGivenName().isPresent() && !contactRecord.getGivenName().get().equals(givenName)) || (
 128                 contactRecord.getFamilyName().isPresent() && !contactRecord.getFamilyName().get().equals(familyName)
 129         )) {
 130             final var profileBuilder = profile == null ? Profile.newBuilder() : Profile.newBuilder(profile);
 131             final var newProfile = profileBuilder.withGivenName(contactRecord.getGivenName().orElse(null))
 132                     .withFamilyName(contactRecord.getFamilyName().orElse(null))
 133                     .build();
 134             account.getProfileStore().storeProfile(recipientId, newProfile);
 135         }
 136         if (contactRecord.getProfileKey().isPresent()) {
 137             try {
 138                 logger.trace("Storing profile key {}", recipientId);
 139                 final var profileKey = new ProfileKey(contactRecord.getProfileKey().get());
 140                 account.getProfileStore().storeProfileKey(recipientId, profileKey);
 141             } catch (InvalidInputException e) {
 142                 logger.warn("Received invalid contact profile key from storage");
 143             }
 144         }
 145         if (contactRecord.getIdentityKey().isPresent()) {
 146             try {
 147                 logger.trace("Storing identity key {}", recipientId);
 148                 final var identityKey = new IdentityKey(contactRecord.getIdentityKey().get());
 149                 account.getIdentityKeyStore().saveIdentity(address.getServiceId(), identityKey);
 150
 151                 final var trustLevel = TrustLevel.fromIdentityState(contactRecord.getIdentityState());
 152                 if (trustLevel != null) {
 153                     account.getIdentityKeyStore()
 154                             .setIdentityTrustLevel(address.getServiceId(), identityKey, trustLevel);
 155                 }
 156             } catch (InvalidKeyException e) {
 157                 logger.warn("Received invalid contact identity key from storage");
 158             }
 159         }
 160     }
 161
 162     private void readGroupV1Record(final SignalStorageRecord record) {
 163         if (record == null || record.getGroupV1().isEmpty()) {
 164             return;
 165         }
 166
 167         final var groupV1Record = record.getGroupV1().get();
 168         final var groupIdV1 = GroupId.v1(groupV1Record.getGroupId());
 169
 170         var group = account.getGroupStore().getGroup(groupIdV1);
 171         if (group == null) {
 172             try {
 173                 context.getGroupHelper().sendGroupInfoRequest(groupIdV1, account.getSelfRecipientId());
 174             } catch (Throwable e) {
 175                 logger.warn("Failed to send group request", e);
 176             }
 177             group = account.getGroupStore().getOrCreateGroupV1(groupIdV1);
 178         }
 179         if (group != null && group.isBlocked() != groupV1Record.isBlocked()) {
 180             group.setBlocked(groupV1Record.isBlocked());
 181             account.getGroupStore().updateGroup(group);
 182         }
 183     }
 184
 185     private void readGroupV2Record(final SignalStorageRecord record) {
 186         if (record == null || record.getGroupV2().isEmpty()) {
 187             return;
 188         }
 189
 190         final var groupV2Record = record.getGroupV2().get();
 191         if (groupV2Record.isArchived()) {
 192             return;
 193         }
 194
 195         final GroupMasterKey groupMasterKey;
 196         try {
 197             groupMasterKey = new GroupMasterKey(groupV2Record.getMasterKeyBytes());
 198         } catch (InvalidInputException e) {
 199             logger.warn("Received invalid group master key from storage");
 200             return;
 201         }
 202
 203         final var group = context.getGroupHelper().getOrMigrateGroup(groupMasterKey, 0, null);
 204         if (group.isBlocked() != groupV2Record.isBlocked()) {
 205             group.setBlocked(groupV2Record.isBlocked());
 206             account.getGroupStore().updateGroup(group);
 207         }
 208     }
 209
 210     private void readAccountRecord(final SignalStorageRecord record) throws IOException {
 211         if (record == null) {
 212             logger.warn("Could not find account record, even though we had an ID, ignoring.");
 213             return;
 214         }
 215
 216         SignalAccountRecord accountRecord = record.getAccount().orElse(null);
 217         if (accountRecord == null) {
 218             logger.warn("The storage record didn't actually have an account, ignoring.");
 219             return;
 220         }
 221
 222         if (!accountRecord.getE164().equals(account.getNumber())) {
 223             context.getAccountHelper().checkWhoAmiI();
 224         }
 225
 226         account.getConfigurationStore().setReadReceipts(accountRecord.isReadReceiptsEnabled());
 227         account.getConfigurationStore().setTypingIndicators(accountRecord.isTypingIndicatorsEnabled());
 228         account.getConfigurationStore()
 229                 .setUnidentifiedDeliveryIndicators(accountRecord.isSealedSenderIndicatorsEnabled());
 230         account.getConfigurationStore().setLinkPreviews(accountRecord.isLinkPreviewsEnabled());
 231         if (accountRecord.getPhoneNumberSharingMode() != AccountRecord.PhoneNumberSharingMode.UNRECOGNIZED) {
 232             account.getConfigurationStore()
 233                     .setPhoneNumberSharingMode(switch (accountRecord.getPhoneNumberSharingMode()) {
 234                         case EVERYBODY -> PhoneNumberSharingMode.EVERYBODY;
 235                         case NOBODY -> PhoneNumberSharingMode.NOBODY;
 236                         default -> PhoneNumberSharingMode.CONTACTS;
 237                     });
 238         }
 239         account.getConfigurationStore().setPhoneNumberUnlisted(accountRecord.isPhoneNumberUnlisted());
 240
 241         if (accountRecord.getProfileKey().isPresent()) {
 242             ProfileKey profileKey;
 243             try {
 244                 profileKey = new ProfileKey(accountRecord.getProfileKey().get());
 245             } catch (InvalidInputException e) {
 246                 logger.warn("Received invalid profile key from storage");
 247                 profileKey = null;
 248             }
 249             if (profileKey != null) {
 250                 account.setProfileKey(profileKey);
 251                 final var avatarPath = accountRecord.getAvatarUrlPath().orElse(null);
 252                 context.getProfileHelper().downloadProfileAvatar(account.getSelfRecipientId(), avatarPath, profileKey);
 253             }
 254         }
 255
 256         context.getProfileHelper()
 257                 .setProfile(false,
 258                         false,
 259                         accountRecord.getGivenName().orElse(null),
 260                         accountRecord.getFamilyName().orElse(null),
 261                         null,
 262                         null,
 263                         null,
 264                         null);
 265     }
 266
 267     private SignalStorageRecord getSignalStorageRecord(final StorageId accountId) throws IOException {
 268         List<SignalStorageRecord> records;
 269         try {
 270             records = dependencies.getAccountManager()
 271                     .readStorageRecords(account.getStorageKey(), Collections.singletonList(accountId));
 272         } catch (InvalidKeyException e) {
 273             logger.warn("Failed to read storage records, ignoring.");
 274             return null;
 275         }
 276         return records.size() > 0 ? records.get(0) : null;
 277     }
 278
 279     private List<SignalStorageRecord> getSignalStorageRecords(final Collection<StorageId> storageIds) throws IOException {
 280         List<SignalStorageRecord> records;
 281         try {
 282             records = dependencies.getAccountManager()
 283                     .readStorageRecords(account.getStorageKey(), new ArrayList<>(storageIds));
 284         } catch (InvalidKeyException e) {
 285             logger.warn("Failed to read storage records, ignoring.");
 286             return List.of();
 287         }
 288         return records;
 289     }
 290 }