nmode's Git Repositories - signal-cli/blob - lib/src/main/java/org/asamk/signal/manager/storage/recipients/RecipientStore.java

   1 package org.asamk.signal.manager.storage.recipients;
   2
   3 import com.fasterxml.jackson.databind.ObjectMapper;
   4
   5 import org.asamk.signal.manager.api.Pair;
   6 import org.asamk.signal.manager.storage.Utils;
   7 import org.asamk.signal.manager.storage.contacts.ContactsStore;
   8 import org.asamk.signal.manager.storage.profiles.ProfileStore;
   9 import org.signal.zkgroup.InvalidInputException;
  10 import org.signal.zkgroup.profiles.ProfileKey;
  11 import org.signal.zkgroup.profiles.ProfileKeyCredential;
  12 import org.slf4j.Logger;
  13 import org.slf4j.LoggerFactory;
  14 import org.whispersystems.signalservice.api.push.ACI;
  15 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
  16 import org.whispersystems.signalservice.api.push.exceptions.UnregisteredUserException;
  17 import org.whispersystems.signalservice.api.util.UuidUtil;
  18
  19 import java.io.ByteArrayInputStream;
  20 import java.io.ByteArrayOutputStream;
  21 import java.io.File;
  22 import java.io.FileInputStream;
  23 import java.io.FileNotFoundException;
  24 import java.io.FileOutputStream;
  25 import java.io.IOException;
  26 import java.util.ArrayList;
  27 import java.util.Base64;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Objects;
  32 import java.util.Optional;
  33 import java.util.Set;
  34 import java.util.UUID;
  35 import java.util.function.Supplier;
  36 import java.util.stream.Collectors;
  37
  38 public class RecipientStore implements RecipientResolver, ContactsStore, ProfileStore {
  39
  40     private final static Logger logger = LoggerFactory.getLogger(RecipientStore.class);
  41
  42     private final ObjectMapper objectMapper;
  43     private final File file;
  44     private final RecipientMergeHandler recipientMergeHandler;
  45
  46     private final Map<RecipientId, Recipient> recipients;
  47     private final Map<RecipientId, RecipientId> recipientsMerged = new HashMap<>();
  48
  49     private long lastId;
  50
  51     public static RecipientStore load(File file, RecipientMergeHandler recipientMergeHandler) throws IOException {
  52         final var objectMapper = Utils.createStorageObjectMapper();
  53         try (var inputStream = new FileInputStream(file)) {
  54             final var storage = objectMapper.readValue(inputStream, Storage.class);
  55             final var recipients = storage.recipients.stream().map(r -> {
  56                 final var recipientId = new RecipientId(r.id);
  57                 final var address = new RecipientAddress(Optional.ofNullable(r.uuid).map(UuidUtil::parseOrThrow),
  58                         Optional.ofNullable(r.number));
  59
  60                 Contact contact = null;
  61                 if (r.contact != null) {
  62                     contact = new Contact(r.contact.name,
  63                             r.contact.color,
  64                             r.contact.messageExpirationTime,
  65                             r.contact.blocked,
  66                             r.contact.archived);
  67                 }
  68
  69                 ProfileKey profileKey = null;
  70                 if (r.profileKey != null) {
  71                     try {
  72                         profileKey = new ProfileKey(Base64.getDecoder().decode(r.profileKey));
  73                     } catch (InvalidInputException ignored) {
  74                     }
  75                 }
  76
  77                 ProfileKeyCredential profileKeyCredential = null;
  78                 if (r.profileKeyCredential != null) {
  79                     try {
  80                         profileKeyCredential = new ProfileKeyCredential(Base64.getDecoder()
  81                                 .decode(r.profileKeyCredential));
  82                     } catch (Throwable ignored) {
  83                     }
  84                 }
  85
  86                 Profile profile = null;
  87                 if (r.profile != null) {
  88                     profile = new Profile(r.profile.lastUpdateTimestamp,
  89                             r.profile.givenName,
  90                             r.profile.familyName,
  91                             r.profile.about,
  92                             r.profile.aboutEmoji,
  93                             r.profile.avatarUrlPath,
  94                             Profile.UnidentifiedAccessMode.valueOfOrUnknown(r.profile.unidentifiedAccessMode),
  95                             r.profile.capabilities.stream()
  96                                     .map(Profile.Capability::valueOfOrNull)
  97                                     .filter(Objects::nonNull)
  98                                     .collect(Collectors.toSet()));
  99                 }
 100
 101                 return new Recipient(recipientId, address, contact, profileKey, profileKeyCredential, profile);
 102             }).collect(Collectors.toMap(Recipient::getRecipientId, r -> r));
 103
 104             return new RecipientStore(objectMapper, file, recipientMergeHandler, recipients, storage.lastId);
 105         } catch (FileNotFoundException e) {
 106             logger.debug("Creating new recipient store.");
 107             return new RecipientStore(objectMapper, file, recipientMergeHandler, new HashMap<>(), 0);
 108         }
 109     }
 110
 111     private RecipientStore(
 112             final ObjectMapper objectMapper,
 113             final File file,
 114             final RecipientMergeHandler recipientMergeHandler,
 115             final Map<RecipientId, Recipient> recipients,
 116             final long lastId
 117     ) {
 118         this.objectMapper = objectMapper;
 119         this.file = file;
 120         this.recipientMergeHandler = recipientMergeHandler;
 121         this.recipients = recipients;
 122         this.lastId = lastId;
 123     }
 124
 125     public RecipientAddress resolveRecipientAddress(RecipientId recipientId) {
 126         synchronized (recipients) {
 127             return getRecipient(recipientId).getAddress();
 128         }
 129     }
 130
 131     public Recipient getRecipient(RecipientId recipientId) {
 132         synchronized (recipients) {
 133             return getRecipientLocked(recipientId);
 134         }
 135     }
 136
 137     @Override
 138     public RecipientId resolveRecipient(ACI aci) {
 139         return resolveRecipient(new RecipientAddress(aci == null ? null : aci.uuid()), false);
 140     }
 141
 142     @Override
 143     public RecipientId resolveRecipient(final String identifier) {
 144         return resolveRecipient(Utils.getRecipientAddressFromIdentifier(identifier), false);
 145     }
 146
 147     public RecipientId resolveRecipient(
 148             final String number, Supplier<ACI> aciSupplier
 149     ) throws UnregisteredUserException {
 150         final Optional<Recipient> byNumber;
 151         synchronized (recipients) {
 152             byNumber = findByNumberLocked(number);
 153         }
 154         if (byNumber.isEmpty() || byNumber.get().getAddress().getUuid().isEmpty()) {
 155             final var aci = aciSupplier.get();
 156             if (aci == null) {
 157                 throw new UnregisteredUserException(number, null);
 158             }
 159
 160             return resolveRecipient(new RecipientAddress(aci.uuid(), number), false);
 161         }
 162         return byNumber.get().getRecipientId();
 163     }
 164
 165     public RecipientId resolveRecipient(RecipientAddress address) {
 166         return resolveRecipient(address, false);
 167     }
 168
 169     @Override
 170     public RecipientId resolveRecipient(final SignalServiceAddress address) {
 171         return resolveRecipient(new RecipientAddress(address), false);
 172     }
 173
 174     public RecipientId resolveRecipientTrusted(RecipientAddress address) {
 175         return resolveRecipient(address, true);
 176     }
 177
 178     public RecipientId resolveRecipientTrusted(SignalServiceAddress address) {
 179         return resolveRecipient(new RecipientAddress(address), true);
 180     }
 181
 182     public List<RecipientId> resolveRecipientsTrusted(List<RecipientAddress> addresses) {
 183         final List<RecipientId> recipientIds;
 184         final List<Pair<RecipientId, RecipientId>> toBeMerged = new ArrayList<>();
 185         synchronized (recipients) {
 186             recipientIds = addresses.stream().map(address -> {
 187                 final var pair = resolveRecipientLocked(address, true);
 188                 if (pair.second().isPresent()) {
 189                     toBeMerged.add(new Pair<>(pair.first(), pair.second().get()));
 190                 }
 191                 return pair.first();
 192             }).collect(Collectors.toList());
 193         }
 194         for (var pair : toBeMerged) {
 195             recipientMergeHandler.mergeRecipients(pair.first(), pair.second());
 196         }
 197         return recipientIds;
 198     }
 199
 200     @Override
 201     public void storeContact(final RecipientId recipientId, final Contact contact) {
 202         synchronized (recipients) {
 203             final var recipient = recipients.get(recipientId);
 204             storeRecipientLocked(recipientId, Recipient.newBuilder(recipient).withContact(contact).build());
 205         }
 206     }
 207
 208     @Override
 209     public Contact getContact(final RecipientId recipientId) {
 210         final var recipient = getRecipient(recipientId);
 211         return recipient == null ? null : recipient.getContact();
 212     }
 213
 214     @Override
 215     public List<Pair<RecipientId, Contact>> getContacts() {
 216         return recipients.entrySet()
 217                 .stream()
 218                 .filter(e -> e.getValue().getContact() != null)
 219                 .map(e -> new Pair<>(e.getKey(), e.getValue().getContact()))
 220                 .collect(Collectors.toList());
 221     }
 222
 223     @Override
 224     public Profile getProfile(final RecipientId recipientId) {
 225         final var recipient = getRecipient(recipientId);
 226         return recipient == null ? null : recipient.getProfile();
 227     }
 228
 229     @Override
 230     public ProfileKey getProfileKey(final RecipientId recipientId) {
 231         final var recipient = getRecipient(recipientId);
 232         return recipient == null ? null : recipient.getProfileKey();
 233     }
 234
 235     @Override
 236     public ProfileKeyCredential getProfileKeyCredential(final RecipientId recipientId) {
 237         final var recipient = getRecipient(recipientId);
 238         return recipient == null ? null : recipient.getProfileKeyCredential();
 239     }
 240
 241     @Override
 242     public void storeProfile(final RecipientId recipientId, final Profile profile) {
 243         synchronized (recipients) {
 244             final var recipient = recipients.get(recipientId);
 245             storeRecipientLocked(recipientId, Recipient.newBuilder(recipient).withProfile(profile).build());
 246         }
 247     }
 248
 249     @Override
 250     public void storeProfileKey(final RecipientId recipientId, final ProfileKey profileKey) {
 251         synchronized (recipients) {
 252             final var recipient = recipients.get(recipientId);
 253             if (profileKey != null && profileKey.equals(recipient.getProfileKey())) {
 254                 return;
 255             }
 256
 257             final var newRecipient = Recipient.newBuilder(recipient)
 258                     .withProfileKey(profileKey)
 259                     .withProfileKeyCredential(null)
 260                     .withProfile(recipient.getProfile() == null
 261                             ? null
 262                             : Profile.newBuilder(recipient.getProfile()).withLastUpdateTimestamp(0).build())
 263                     .build();
 264             storeRecipientLocked(recipientId, newRecipient);
 265         }
 266     }
 267
 268     @Override
 269     public void storeProfileKeyCredential(
 270             final RecipientId recipientId, final ProfileKeyCredential profileKeyCredential
 271     ) {
 272         synchronized (recipients) {
 273             final var recipient = recipients.get(recipientId);
 274             storeRecipientLocked(recipientId,
 275                     Recipient.newBuilder(recipient).withProfileKeyCredential(profileKeyCredential).build());
 276         }
 277     }
 278
 279     public boolean isEmpty() {
 280         synchronized (recipients) {
 281             return recipients.isEmpty();
 282         }
 283     }
 284
 285     /**
 286      * @param isHighTrust true, if the number/uuid connection was obtained from a trusted source.
 287      *                    Has no effect, if the address contains only a number or a uuid.
 288      */
 289     private RecipientId resolveRecipient(RecipientAddress address, boolean isHighTrust) {
 290         final Pair<RecipientId, Optional<RecipientId>> pair;
 291         synchronized (recipients) {
 292             pair = resolveRecipientLocked(address, isHighTrust);
 293             if (pair.second().isPresent()) {
 294                 recipientsMerged.put(pair.second().get(), pair.first());
 295             }
 296         }
 297
 298         if (pair.second().isPresent()) {
 299             recipientMergeHandler.mergeRecipients(pair.first(), pair.second().get());
 300         }
 301         return pair.first();
 302     }
 303
 304     private Pair<RecipientId, Optional<RecipientId>> resolveRecipientLocked(
 305             RecipientAddress address, boolean isHighTrust
 306     ) {
 307         final var byNumber = address.getNumber().isEmpty()
 308                 ? Optional.<Recipient>empty()
 309                 : findByNumberLocked(address.getNumber().get());
 310         final var byUuid = address.getUuid().isEmpty()
 311                 ? Optional.<Recipient>empty()
 312                 : findByUuidLocked(address.getUuid().get());
 313
 314         if (byNumber.isEmpty() && byUuid.isEmpty()) {
 315             logger.debug("Got new recipient, both uuid and number are unknown");
 316
 317             if (isHighTrust || address.getUuid().isEmpty() || address.getNumber().isEmpty()) {
 318                 return new Pair<>(addNewRecipientLocked(address), Optional.empty());
 319             }
 320
 321             return new Pair<>(addNewRecipientLocked(new RecipientAddress(address.getUuid().get())), Optional.empty());
 322         }
 323
 324         if (!isHighTrust || address.getUuid().isEmpty() || address.getNumber().isEmpty() || byNumber.equals(byUuid)) {
 325             return new Pair<>(byUuid.or(() -> byNumber).map(Recipient::getRecipientId).get(), Optional.empty());
 326         }
 327
 328         if (byNumber.isEmpty()) {
 329             logger.debug("Got recipient existing with uuid, updating with high trust number");
 330             updateRecipientAddressLocked(byUuid.get().getRecipientId(), address);
 331             return new Pair<>(byUuid.get().getRecipientId(), Optional.empty());
 332         }
 333
 334         if (byUuid.isEmpty()) {
 335             if (byNumber.get().getAddress().getUuid().isPresent()) {
 336                 logger.debug(
 337                         "Got recipient existing with number, but different uuid, so stripping its number and adding new recipient");
 338
 339                 updateRecipientAddressLocked(byNumber.get().getRecipientId(),
 340                         new RecipientAddress(byNumber.get().getAddress().getUuid().get()));
 341                 return new Pair<>(addNewRecipientLocked(address), Optional.empty());
 342             }
 343
 344             logger.debug("Got recipient existing with number and no uuid, updating with high trust uuid");
 345             updateRecipientAddressLocked(byNumber.get().getRecipientId(), address);
 346             return new Pair<>(byNumber.get().getRecipientId(), Optional.empty());
 347         }
 348
 349         if (byNumber.get().getAddress().getUuid().isPresent()) {
 350             logger.debug(
 351                     "Got separate recipients for high trust number and uuid, recipient for number has different uuid, so stripping its number");
 352
 353             updateRecipientAddressLocked(byNumber.get().getRecipientId(),
 354                     new RecipientAddress(byNumber.get().getAddress().getUuid().get()));
 355             updateRecipientAddressLocked(byUuid.get().getRecipientId(), address);
 356             return new Pair<>(byUuid.get().getRecipientId(), Optional.empty());
 357         }
 358
 359         logger.debug("Got separate recipients for high trust number and uuid, need to merge them");
 360         updateRecipientAddressLocked(byUuid.get().getRecipientId(), address);
 361         mergeRecipientsLocked(byUuid.get().getRecipientId(), byNumber.get().getRecipientId());
 362         return new Pair<>(byUuid.get().getRecipientId(), byNumber.map(Recipient::getRecipientId));
 363     }
 364
 365     private RecipientId addNewRecipientLocked(final RecipientAddress address) {
 366         final var nextRecipientId = nextIdLocked();
 367         storeRecipientLocked(nextRecipientId, new Recipient(nextRecipientId, address, null, null, null, null));
 368         return nextRecipientId;
 369     }
 370
 371     private void updateRecipientAddressLocked(
 372             final RecipientId recipientId, final RecipientAddress address
 373     ) {
 374         final var recipient = recipients.get(recipientId);
 375         storeRecipientLocked(recipientId, Recipient.newBuilder(recipient).withAddress(address).build());
 376     }
 377
 378     private Recipient getRecipientLocked(RecipientId recipientId) {
 379         while (recipientsMerged.containsKey(recipientId)) {
 380             recipientId = recipientsMerged.get(recipientId);
 381         }
 382         return recipients.get(recipientId);
 383     }
 384
 385     private void storeRecipientLocked(
 386             final RecipientId recipientId, final Recipient recipient
 387     ) {
 388         final var existingRecipient = getRecipientLocked(recipientId);
 389         if (existingRecipient == null || !existingRecipient.equals(recipient)) {
 390             recipients.put(recipientId, recipient);
 391             saveLocked();
 392         }
 393     }
 394
 395     private void mergeRecipientsLocked(RecipientId recipientId, RecipientId toBeMergedRecipientId) {
 396         final var recipient = recipients.get(recipientId);
 397         final var toBeMergedRecipient = recipients.get(toBeMergedRecipientId);
 398         recipients.put(recipientId,
 399                 new Recipient(recipientId,
 400                         recipient.getAddress(),
 401                         recipient.getContact() != null ? recipient.getContact() : toBeMergedRecipient.getContact(),
 402                         recipient.getProfileKey() != null
 403                                 ? recipient.getProfileKey()
 404                                 : toBeMergedRecipient.getProfileKey(),
 405                         recipient.getProfileKeyCredential() != null
 406                                 ? recipient.getProfileKeyCredential()
 407                                 : toBeMergedRecipient.getProfileKeyCredential(),
 408                         recipient.getProfile() != null ? recipient.getProfile() : toBeMergedRecipient.getProfile()));
 409         recipients.remove(toBeMergedRecipientId);
 410         saveLocked();
 411     }
 412
 413     private Optional<Recipient> findByNumberLocked(final String number) {
 414         return recipients.entrySet()
 415                 .stream()
 416                 .filter(entry -> entry.getValue().getAddress().getNumber().isPresent() && number.equals(entry.getValue()
 417                         .getAddress()
 418                         .getNumber()
 419                         .get()))
 420                 .findFirst()
 421                 .map(Map.Entry::getValue);
 422     }
 423
 424     private Optional<Recipient> findByUuidLocked(final UUID uuid) {
 425         return recipients.entrySet()
 426                 .stream()
 427                 .filter(entry -> entry.getValue().getAddress().getUuid().isPresent() && uuid.equals(entry.getValue()
 428                         .getAddress()
 429                         .getUuid()
 430                         .get()))
 431                 .findFirst()
 432                 .map(Map.Entry::getValue);
 433     }
 434
 435     private RecipientId nextIdLocked() {
 436         return new RecipientId(++this.lastId);
 437     }
 438
 439     private void saveLocked() {
 440         final var base64 = Base64.getEncoder();
 441         var storage = new Storage(recipients.entrySet().stream().map(pair -> {
 442             final var recipient = pair.getValue();
 443             final var contact = recipient.getContact() == null
 444                     ? null
 445                     : new Storage.Recipient.Contact(recipient.getContact().getName(),
 446                             recipient.getContact().getColor(),
 447                             recipient.getContact().getMessageExpirationTime(),
 448                             recipient.getContact().isBlocked(),
 449                             recipient.getContact().isArchived());
 450             final var profile = recipient.getProfile() == null
 451                     ? null
 452                     : new Storage.Recipient.Profile(recipient.getProfile().getLastUpdateTimestamp(),
 453                             recipient.getProfile().getGivenName(),
 454                             recipient.getProfile().getFamilyName(),
 455                             recipient.getProfile().getAbout(),
 456                             recipient.getProfile().getAboutEmoji(),
 457                             recipient.getProfile().getAvatarUrlPath(),
 458                             recipient.getProfile().getUnidentifiedAccessMode().name(),
 459                             recipient.getProfile()
 460                                     .getCapabilities()
 461                                     .stream()
 462                                     .map(Enum::name)
 463                                     .collect(Collectors.toSet()));
 464             return new Storage.Recipient(pair.getKey().id(),
 465                     recipient.getAddress().getNumber().orElse(null),
 466                     recipient.getAddress().getUuid().map(UUID::toString).orElse(null),
 467                     recipient.getProfileKey() == null
 468                             ? null
 469                             : base64.encodeToString(recipient.getProfileKey().serialize()),
 470                     recipient.getProfileKeyCredential() == null
 471                             ? null
 472                             : base64.encodeToString(recipient.getProfileKeyCredential().serialize()),
 473                     contact,
 474                     profile);
 475         }).collect(Collectors.toList()), lastId);
 476
 477         // Write to memory first to prevent corrupting the file in case of serialization errors
 478         try (var inMemoryOutput = new ByteArrayOutputStream()) {
 479             objectMapper.writeValue(inMemoryOutput, storage);
 480
 481             var input = new ByteArrayInputStream(inMemoryOutput.toByteArray());
 482             try (var outputStream = new FileOutputStream(file)) {
 483                 input.transferTo(outputStream);
 484             }
 485         } catch (Exception e) {
 486             logger.error("Error saving recipient store file: {}", e.getMessage());
 487         }
 488     }
 489
 490     private record Storage(List<Recipient> recipients, long lastId) {
 491
 492         private record Recipient(
 493                 long id,
 494                 String number,
 495                 String uuid,
 496                 String profileKey,
 497                 String profileKeyCredential,
 498                 Storage.Recipient.Contact contact,
 499                 Storage.Recipient.Profile profile
 500         ) {
 501
 502             private record Contact(
 503                     String name, String color, int messageExpirationTime, boolean blocked, boolean archived
 504             ) {}
 505
 506             private record Profile(
 507                     long lastUpdateTimestamp,
 508                     String givenName,
 509                     String familyName,
 510                     String about,
 511                     String aboutEmoji,
 512                     String avatarUrlPath,
 513                     String unidentifiedAccessMode,
 514                     Set<String> capabilities
 515             ) {}
 516         }
 517     }
 518
 519     public interface RecipientMergeHandler {
 520
 521         void mergeRecipients(RecipientId recipientId, RecipientId toBeMergedRecipientId);
 522     }
 523 }