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.api.Contact;
   4 import org.asamk.signal.manager.api.GroupId;
   5 import org.asamk.signal.manager.api.PhoneNumberSharingMode;
   6 import org.asamk.signal.manager.api.Profile;
   7 import org.asamk.signal.manager.api.TrustLevel;
   8 import org.asamk.signal.manager.internal.SignalDependencies;
   9 import org.asamk.signal.manager.storage.SignalAccount;
  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 serviceId = contactRecord.getServiceId();
 105         if (contactRecord.getNumber().isEmpty() && serviceId.isUnknown()) {
 106             return;
 107         }
 108         final var address = new RecipientAddress(serviceId, contactRecord.getNumber().orElse(null));
 109         var recipientId = account.getRecipientResolver().resolveRecipient(address);
 110         if (serviceId.isValid() && contactRecord.getUsername().isPresent()) {
 111             recipientId = account.getRecipientTrustedResolver()
 112                     .resolveRecipientTrusted(serviceId, contactRecord.getUsername().get());
 113         }
 114
 115         final var contact = account.getContactStore().getContact(recipientId);
 116         final var blocked = contact != null && contact.isBlocked();
 117         final var profileShared = contact != null && contact.isProfileSharingEnabled();
 118         final var archived = contact != null && contact.isArchived();
 119         final var contactGivenName = contact == null ? null : contact.getGivenName();
 120         final var contactFamilyName = contact == null ? null : contact.getFamilyName();
 121         if (blocked != contactRecord.isBlocked()
 122                 || profileShared != contactRecord.isProfileSharingEnabled()
 123                 || archived != contactRecord.isArchived()
 124                 || (
 125                 contactRecord.getSystemGivenName().isPresent() && !contactRecord.getSystemGivenName()
 126                         .get()
 127                         .equals(contactGivenName)
 128         )
 129                 || (
 130                 contactRecord.getSystemFamilyName().isPresent() && !contactRecord.getSystemFamilyName()
 131                         .get()
 132                         .equals(contactFamilyName)
 133         )) {
 134             logger.debug("Storing new or updated contact {}", recipientId);
 135             final var contactBuilder = contact == null ? Contact.newBuilder() : Contact.newBuilder(contact);
 136             final var newContact = contactBuilder.withBlocked(contactRecord.isBlocked())
 137                     .withProfileSharingEnabled(contactRecord.isProfileSharingEnabled())
 138                     .withArchived(contactRecord.isArchived());
 139             if (contactRecord.getSystemGivenName().isPresent() || contactRecord.getSystemFamilyName().isPresent()) {
 140                 newContact.withGivenName(contactRecord.getSystemGivenName().orElse(null))
 141                         .withFamilyName(contactRecord.getSystemFamilyName().orElse(null));
 142             }
 143             account.getContactStore().storeContact(recipientId, newContact.build());
 144         }
 145
 146         final var profile = account.getProfileStore().getProfile(recipientId);
 147         final var profileGivenName = profile == null ? null : profile.getGivenName();
 148         final var profileFamilyName = profile == null ? null : profile.getFamilyName();
 149         if ((
 150                 contactRecord.getProfileGivenName().isPresent() && !contactRecord.getProfileGivenName()
 151                         .get()
 152                         .equals(profileGivenName)
 153         ) || (
 154                 contactRecord.getProfileFamilyName().isPresent() && !contactRecord.getProfileFamilyName()
 155                         .get()
 156                         .equals(profileFamilyName)
 157         )) {
 158             final var profileBuilder = profile == null ? Profile.newBuilder() : Profile.newBuilder(profile);
 159             final var newProfile = profileBuilder.withGivenName(contactRecord.getProfileGivenName().orElse(null))
 160                     .withFamilyName(contactRecord.getProfileFamilyName().orElse(null))
 161                     .build();
 162             account.getProfileStore().storeProfile(recipientId, newProfile);
 163         }
 164         if (contactRecord.getProfileKey().isPresent()) {
 165             try {
 166                 logger.trace("Storing profile key {}", recipientId);
 167                 final var profileKey = new ProfileKey(contactRecord.getProfileKey().get());
 168                 account.getProfileStore().storeProfileKey(recipientId, profileKey);
 169             } catch (InvalidInputException e) {
 170                 logger.warn("Received invalid contact profile key from storage");
 171             }
 172         }
 173         if (contactRecord.getIdentityKey().isPresent() && serviceId.isValid()) {
 174             try {
 175                 logger.trace("Storing identity key {}", recipientId);
 176                 final var identityKey = new IdentityKey(contactRecord.getIdentityKey().get());
 177                 account.getIdentityKeyStore().saveIdentity(serviceId, identityKey);
 178
 179                 final var trustLevel = TrustLevel.fromIdentityState(contactRecord.getIdentityState());
 180                 if (trustLevel != null) {
 181                     account.getIdentityKeyStore().setIdentityTrustLevel(serviceId, identityKey, trustLevel);
 182                 }
 183             } catch (InvalidKeyException e) {
 184                 logger.warn("Received invalid contact identity key from storage");
 185             }
 186         }
 187     }
 188
 189     private void readGroupV1Record(final SignalStorageRecord record) {
 190         if (record == null || record.getGroupV1().isEmpty()) {
 191             return;
 192         }
 193
 194         final var groupV1Record = record.getGroupV1().get();
 195         final var groupIdV1 = GroupId.v1(groupV1Record.getGroupId());
 196
 197         var group = account.getGroupStore().getGroup(groupIdV1);
 198         if (group == null) {
 199             try {
 200                 context.getGroupHelper().sendGroupInfoRequest(groupIdV1, account.getSelfRecipientId());
 201             } catch (Throwable e) {
 202                 logger.warn("Failed to send group request", e);
 203             }
 204             group = account.getGroupStore().getOrCreateGroupV1(groupIdV1);
 205         }
 206         if (group != null && group.isBlocked() != groupV1Record.isBlocked()) {
 207             group.setBlocked(groupV1Record.isBlocked());
 208             account.getGroupStore().updateGroup(group);
 209         }
 210     }
 211
 212     private void readGroupV2Record(final SignalStorageRecord record) {
 213         if (record == null || record.getGroupV2().isEmpty()) {
 214             return;
 215         }
 216
 217         final var groupV2Record = record.getGroupV2().get();
 218         if (groupV2Record.isArchived()) {
 219             return;
 220         }
 221
 222         final GroupMasterKey groupMasterKey;
 223         try {
 224             groupMasterKey = new GroupMasterKey(groupV2Record.getMasterKeyBytes());
 225         } catch (InvalidInputException e) {
 226             logger.warn("Received invalid group master key from storage");
 227             return;
 228         }
 229
 230         final var group = context.getGroupHelper().getOrMigrateGroup(groupMasterKey, 0, null);
 231         if (group.isBlocked() != groupV2Record.isBlocked()) {
 232             group.setBlocked(groupV2Record.isBlocked());
 233             account.getGroupStore().updateGroup(group);
 234         }
 235     }
 236
 237     private void readAccountRecord(final SignalStorageRecord record) throws IOException {
 238         if (record == null) {
 239             logger.warn("Could not find account record, even though we had an ID, ignoring.");
 240             return;
 241         }
 242
 243         SignalAccountRecord accountRecord = record.getAccount().orElse(null);
 244         if (accountRecord == null) {
 245             logger.warn("The storage record didn't actually have an account, ignoring.");
 246             return;
 247         }
 248
 249         if (!accountRecord.getE164().equals(account.getNumber())) {
 250             context.getAccountHelper().checkWhoAmiI();
 251         }
 252
 253         account.getConfigurationStore().setReadReceipts(accountRecord.isReadReceiptsEnabled());
 254         account.getConfigurationStore().setTypingIndicators(accountRecord.isTypingIndicatorsEnabled());
 255         account.getConfigurationStore()
 256                 .setUnidentifiedDeliveryIndicators(accountRecord.isSealedSenderIndicatorsEnabled());
 257         account.getConfigurationStore().setLinkPreviews(accountRecord.isLinkPreviewsEnabled());
 258         if (accountRecord.getPhoneNumberSharingMode() != AccountRecord.PhoneNumberSharingMode.UNRECOGNIZED) {
 259             account.getConfigurationStore()
 260                     .setPhoneNumberSharingMode(switch (accountRecord.getPhoneNumberSharingMode()) {
 261                         case EVERYBODY -> PhoneNumberSharingMode.EVERYBODY;
 262                         case NOBODY -> PhoneNumberSharingMode.NOBODY;
 263                         default -> PhoneNumberSharingMode.CONTACTS;
 264                     });
 265         }
 266         account.getConfigurationStore().setPhoneNumberUnlisted(accountRecord.isPhoneNumberUnlisted());
 267         account.setUsername(accountRecord.getUsername());
 268
 269         if (accountRecord.getProfileKey().isPresent()) {
 270             ProfileKey profileKey;
 271             try {
 272                 profileKey = new ProfileKey(accountRecord.getProfileKey().get());
 273             } catch (InvalidInputException e) {
 274                 logger.warn("Received invalid profile key from storage");
 275                 profileKey = null;
 276             }
 277             if (profileKey != null) {
 278                 account.setProfileKey(profileKey);
 279                 final var avatarPath = accountRecord.getAvatarUrlPath().orElse(null);
 280                 context.getProfileHelper().downloadProfileAvatar(account.getSelfRecipientId(), avatarPath, profileKey);
 281             }
 282         }
 283
 284         context.getProfileHelper()
 285                 .setProfile(false,
 286                         false,
 287                         accountRecord.getGivenName().orElse(null),
 288                         accountRecord.getFamilyName().orElse(null),
 289                         null,
 290                         null,
 291                         null,
 292                         null);
 293     }
 294
 295     private SignalStorageRecord getSignalStorageRecord(final StorageId accountId) throws IOException {
 296         List<SignalStorageRecord> records;
 297         try {
 298             records = dependencies.getAccountManager()
 299                     .readStorageRecords(account.getStorageKey(), Collections.singletonList(accountId));
 300         } catch (InvalidKeyException e) {
 301             logger.warn("Failed to read storage records, ignoring.");
 302             return null;
 303         }
 304         return records.size() > 0 ? records.get(0) : null;
 305     }
 306
 307     private List<SignalStorageRecord> getSignalStorageRecords(final Collection<StorageId> storageIds) throws IOException {
 308         List<SignalStorageRecord> records;
 309         try {
 310             records = dependencies.getAccountManager()
 311                     .readStorageRecords(account.getStorageKey(), new ArrayList<>(storageIds));
 312         } catch (InvalidKeyException e) {
 313             logger.warn("Failed to read storage records, ignoring.");
 314             return List.of();
 315         }
 316         return records;
 317     }
 318 }