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

   1 package org.asamk.signal.manager.helper;
   2
   3 import org.asamk.signal.manager.api.RecipientIdentifier;
   4 import org.asamk.signal.manager.api.UnregisteredRecipientException;
   5 import org.asamk.signal.manager.api.UsernameLinkUrl;
   6 import org.asamk.signal.manager.internal.SignalDependencies;
   7 import org.asamk.signal.manager.storage.SignalAccount;
   8 import org.asamk.signal.manager.storage.recipients.RecipientId;
   9 import org.signal.libsignal.usernames.BaseUsernameException;
  10 import org.signal.libsignal.usernames.Username;
  11 import org.slf4j.Logger;
  12 import org.slf4j.LoggerFactory;
  13 import org.whispersystems.signalservice.api.push.ServiceId;
  14 import org.whispersystems.signalservice.api.push.ServiceId.ACI;
  15 import org.whispersystems.signalservice.api.push.ServiceId.PNI;
  16 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
  17 import org.whispersystems.signalservice.api.push.exceptions.CdsiInvalidTokenException;
  18 import org.whispersystems.signalservice.api.services.CdsiV2Service;
  19
  20 import java.io.IOException;
  21 import java.util.Collection;
  22 import java.util.HashMap;
  23 import java.util.HashSet;
  24 import java.util.Map;
  25 import java.util.Optional;
  26 import java.util.Set;
  27
  28 import static org.asamk.signal.manager.config.ServiceConfig.MAXIMUM_ONE_OFF_REQUEST_SIZE;
  29
  30 public class RecipientHelper {
  31
  32     private static final Logger logger = LoggerFactory.getLogger(RecipientHelper.class);
  33
  34     private final SignalAccount account;
  35     private final SignalDependencies dependencies;
  36
  37     public RecipientHelper(final Context context) {
  38         this.account = context.getAccount();
  39         this.dependencies = context.getDependencies();
  40     }
  41
  42     public SignalServiceAddress resolveSignalServiceAddress(RecipientId recipientId) {
  43         final var address = account.getRecipientAddressResolver().resolveRecipientAddress(recipientId);
  44         if (address.number().isEmpty() || address.serviceId().isPresent()) {
  45             return address.toSignalServiceAddress();
  46         }
  47
  48         // Address in recipient store doesn't have a uuid, this shouldn't happen
  49         // Try to retrieve the uuid from the server
  50         final var number = address.number().get();
  51         final ServiceId serviceId;
  52         try {
  53             serviceId = getRegisteredUserByNumber(number);
  54         } catch (UnregisteredRecipientException e) {
  55             logger.warn("Failed to get uuid for e164 number: {}", number);
  56             // Return SignalServiceAddress with unknown UUID
  57             return address.toSignalServiceAddress();
  58         } catch (IOException e) {
  59             logger.warn("Failed to get uuid for e164 number: {}", number, e);
  60             // Return SignalServiceAddress with unknown UUID
  61             return address.toSignalServiceAddress();
  62         }
  63         return account.getRecipientAddressResolver()
  64                 .resolveRecipientAddress(account.getRecipientResolver().resolveRecipient(serviceId))
  65                 .toSignalServiceAddress();
  66     }
  67
  68     public Set<RecipientId> resolveRecipients(Collection<RecipientIdentifier.Single> recipients) throws UnregisteredRecipientException {
  69         final var recipientIds = new HashSet<RecipientId>(recipients.size());
  70         for (var number : recipients) {
  71             final var recipientId = resolveRecipient(number);
  72             recipientIds.add(recipientId);
  73         }
  74         return recipientIds;
  75     }
  76
  77     public RecipientId resolveRecipient(final RecipientIdentifier.Single recipient) throws UnregisteredRecipientException {
  78         if (recipient instanceof RecipientIdentifier.Uuid uuidRecipient) {
  79             return account.getRecipientResolver().resolveRecipient(ACI.from(uuidRecipient.uuid()));
  80         } else if (recipient instanceof RecipientIdentifier.Pni pniRecipient) {
  81             return account.getRecipientResolver().resolveRecipient(PNI.parseOrThrow(pniRecipient.pni()));
  82         } else if (recipient instanceof RecipientIdentifier.Number numberRecipient) {
  83             final var number = numberRecipient.number();
  84             return account.getRecipientStore().resolveRecipientByNumber(number, () -> {
  85                 try {
  86                     return getRegisteredUserByNumber(number);
  87                 } catch (Exception e) {
  88                     return null;
  89                 }
  90             });
  91         } else if (recipient instanceof RecipientIdentifier.Username usernameRecipient) {
  92             var username = usernameRecipient.username();
  93             return resolveRecipientByUsernameOrLink(username, false);
  94         }
  95         throw new AssertionError("Unexpected RecipientIdentifier: " + recipient);
  96     }
  97
  98     public RecipientId resolveRecipientByUsernameOrLink(
  99             String username, boolean forceRefresh
 100     ) throws UnregisteredRecipientException {
 101         final Username finalUsername;
 102         try {
 103             finalUsername = getUsernameFromUsernameOrLink(username);
 104         } catch (IOException | BaseUsernameException e) {
 105             throw new RuntimeException(e);
 106         }
 107         if (forceRefresh) {
 108             try {
 109                 final var aci = dependencies.getAccountManager().getAciByUsername(finalUsername);
 110                 return account.getRecipientStore().resolveRecipientTrusted(aci, finalUsername.getUsername());
 111             } catch (IOException e) {
 112                 throw new UnregisteredRecipientException(new org.asamk.signal.manager.api.RecipientAddress(null,
 113                         null,
 114                         null,
 115                         username));
 116             }
 117         }
 118         return account.getRecipientStore().resolveRecipientByUsername(finalUsername.getUsername(), () -> {
 119             try {
 120                 return dependencies.getAccountManager().getAciByUsername(finalUsername);
 121             } catch (Exception e) {
 122                 return null;
 123             }
 124         });
 125     }
 126
 127     private Username getUsernameFromUsernameOrLink(String username) throws BaseUsernameException, IOException {
 128         try {
 129             final var usernameLinkUrl = UsernameLinkUrl.fromUri(username);
 130             final var components = usernameLinkUrl.getComponents();
 131             final var encryptedUsername = dependencies.getAccountManager()
 132                     .getEncryptedUsernameFromLinkServerId(components.getServerId());
 133             final var link = new Username.UsernameLink(components.getEntropy(), encryptedUsername);
 134
 135             return Username.fromLink(link);
 136         } catch (UsernameLinkUrl.InvalidUsernameLinkException e) {
 137             return new Username(username);
 138         }
 139     }
 140
 141     public Optional<RecipientId> resolveRecipientOptional(final RecipientIdentifier.Single recipient) {
 142         try {
 143             return Optional.of(resolveRecipient(recipient));
 144         } catch (UnregisteredRecipientException e) {
 145             if (recipient instanceof RecipientIdentifier.Number r) {
 146                 return account.getRecipientStore().resolveRecipientByNumberOptional(r.number());
 147             } else {
 148                 return Optional.empty();
 149             }
 150         }
 151     }
 152
 153     public void refreshUsers() throws IOException {
 154         getRegisteredUsers(account.getRecipientStore().getAllNumbers(), false);
 155     }
 156
 157     public RecipientId refreshRegisteredUser(RecipientId recipientId) throws IOException, UnregisteredRecipientException {
 158         final var address = resolveSignalServiceAddress(recipientId);
 159         if (address.getNumber().isEmpty()) {
 160             return recipientId;
 161         }
 162         final var number = address.getNumber().get();
 163         final var serviceId = getRegisteredUserByNumber(number);
 164         return account.getRecipientTrustedResolver()
 165                 .resolveRecipientTrusted(new SignalServiceAddress(serviceId, number));
 166     }
 167
 168     public Map<String, RegisteredUser> getRegisteredUsers(
 169             final Set<String> numbers
 170     ) throws IOException {
 171         if (numbers.size() > MAXIMUM_ONE_OFF_REQUEST_SIZE) {
 172             final var allNumbers = new HashSet<>(account.getRecipientStore().getAllNumbers()) {{
 173                 addAll(numbers);
 174             }};
 175             return getRegisteredUsers(allNumbers, false);
 176         } else {
 177             return getRegisteredUsers(numbers, true);
 178         }
 179     }
 180
 181     private Map<String, RegisteredUser> getRegisteredUsers(
 182             final Set<String> numbers, final boolean isPartialRefresh
 183     ) throws IOException {
 184         Map<String, RegisteredUser> registeredUsers = getRegisteredUsersV2(numbers, isPartialRefresh);
 185
 186         // Store numbers as recipients, so we have the number/uuid association
 187         registeredUsers.forEach((number, u) -> account.getRecipientTrustedResolver()
 188                 .resolveRecipientTrusted(u.aci, u.pni, Optional.of(number)));
 189
 190         final var unregisteredUsers = new HashSet<>(numbers);
 191         unregisteredUsers.removeAll(registeredUsers.keySet());
 192         account.getRecipientStore().markUndiscoverablePossiblyUnregistered(unregisteredUsers);
 193         account.getRecipientStore().markDiscoverable(registeredUsers.keySet());
 194
 195         return registeredUsers;
 196     }
 197
 198     private ServiceId getRegisteredUserByNumber(final String number) throws IOException, UnregisteredRecipientException {
 199         final Map<String, RegisteredUser> aciMap;
 200         try {
 201             aciMap = getRegisteredUsers(Set.of(number), true);
 202         } catch (NumberFormatException e) {
 203             throw new UnregisteredRecipientException(new org.asamk.signal.manager.api.RecipientAddress(number));
 204         }
 205         final var user = aciMap.get(number);
 206         if (user == null) {
 207             throw new UnregisteredRecipientException(new org.asamk.signal.manager.api.RecipientAddress(number));
 208         }
 209         return user.getServiceId();
 210     }
 211
 212     private Map<String, RegisteredUser> getRegisteredUsersV2(
 213             final Set<String> numbers, boolean isPartialRefresh
 214     ) throws IOException {
 215         final var previousNumbers = isPartialRefresh ? Set.<String>of() : account.getCdsiStore().getAllNumbers();
 216         final var newNumbers = new HashSet<>(numbers) {{
 217             removeAll(previousNumbers);
 218         }};
 219         if (newNumbers.isEmpty() && previousNumbers.isEmpty()) {
 220             logger.debug("No new numbers to query.");
 221             return Map.of();
 222         }
 223         logger.trace("Querying CDSI for {} new numbers ({} previous), isPartialRefresh={}",
 224                 newNumbers.size(),
 225                 previousNumbers.size(),
 226                 isPartialRefresh);
 227         final var token = previousNumbers.isEmpty()
 228                 ? Optional.<byte[]>empty()
 229                 : Optional.ofNullable(account.getCdsiToken());
 230
 231         final CdsiV2Service.Response response;
 232         try {
 233             response = dependencies.getAccountManager()
 234                     .getRegisteredUsersWithCdsi(previousNumbers,
 235                             newNumbers,
 236                             account.getRecipientStore().getServiceIdToProfileKeyMap(),
 237                             token,
 238                             dependencies.getServiceEnvironmentConfig().cdsiMrenclave(),
 239                             null,
 240                             dependencies.getLibSignalNetwork(),
 241                             newToken -> {
 242                                 if (isPartialRefresh) {
 243                                     account.getCdsiStore().updateAfterPartialCdsQuery(newNumbers);
 244                                     // Not storing newToken for partial refresh
 245                                 } else {
 246                                     final var fullNumbers = new HashSet<>(previousNumbers) {{
 247                                         addAll(newNumbers);
 248                                     }};
 249                                     final var seenNumbers = new HashSet<>(numbers) {{
 250                                         addAll(newNumbers);
 251                                     }};
 252                                     account.getCdsiStore().updateAfterFullCdsQuery(fullNumbers, seenNumbers);
 253                                     account.setCdsiToken(newToken);
 254                                     account.setLastRecipientsRefresh(System.currentTimeMillis());
 255                                 }
 256                             });
 257         } catch (CdsiInvalidTokenException e) {
 258             account.setCdsiToken(null);
 259             account.getCdsiStore().clearAll();
 260             throw e;
 261         } catch (NumberFormatException e) {
 262             throw new IOException(e);
 263         }
 264         logger.debug("CDSI request successful, quota used by this request: {}", response.getQuotaUsedDebugOnly());
 265
 266         final var registeredUsers = new HashMap<String, RegisteredUser>();
 267         response.getResults()
 268                 .forEach((key, value) -> registeredUsers.put(key,
 269                         new RegisteredUser(value.getAci(), Optional.of(value.getPni()))));
 270         return registeredUsers;
 271     }
 272
 273     public record RegisteredUser(Optional<ACI> aci, Optional<PNI> pni) {
 274
 275         public RegisteredUser {
 276             aci = aci.isPresent() && aci.get().isUnknown() ? Optional.empty() : aci;
 277             pni = pni.isPresent() && pni.get().isUnknown() ? Optional.empty() : pni;
 278             if (aci.isEmpty() && pni.isEmpty()) {
 279                 throw new AssertionError("Must have either a ACI or PNI!");
 280             }
 281         }
 282
 283         public ServiceId getServiceId() {
 284             return aci.map(a -> (ServiceId) a).or(this::pni).orElse(null);
 285         }
 286     }
 287 }