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.Number numberRecipient) {
  81             final var number = numberRecipient.number();
  82             return account.getRecipientStore().resolveRecipientByNumber(number, () -> {
  83                 try {
  84                     return getRegisteredUserByNumber(number);
  85                 } catch (Exception e) {
  86                     return null;
  87                 }
  88             });
  89         } else if (recipient instanceof RecipientIdentifier.Username usernameRecipient) {
  90             var username = usernameRecipient.username();
  91             return resolveRecipientByUsernameOrLink(username, false);
  92         }
  93         throw new AssertionError("Unexpected RecipientIdentifier: " + recipient);
  94     }
  95
  96     public RecipientId resolveRecipientByUsernameOrLink(
  97             String username, boolean forceRefresh
  98     ) throws UnregisteredRecipientException {
  99         final Username finalUsername;
 100         try {
 101             finalUsername = getUsernameFromUsernameOrLink(username);
 102         } catch (IOException | BaseUsernameException e) {
 103             throw new RuntimeException(e);
 104         }
 105         if (forceRefresh) {
 106             try {
 107                 final var aci = dependencies.getAccountManager().getAciByUsername(finalUsername);
 108                 return account.getRecipientStore().resolveRecipientTrusted(aci, finalUsername.getUsername());
 109             } catch (IOException e) {
 110                 throw new UnregisteredRecipientException(new org.asamk.signal.manager.api.RecipientAddress(null,
 111                         null,
 112                         username));
 113             }
 114         }
 115         return account.getRecipientStore().resolveRecipientByUsername(finalUsername.getUsername(), () -> {
 116             try {
 117                 return dependencies.getAccountManager().getAciByUsername(finalUsername);
 118             } catch (Exception e) {
 119                 return null;
 120             }
 121         });
 122     }
 123
 124     private Username getUsernameFromUsernameOrLink(String username) throws BaseUsernameException, IOException {
 125         try {
 126             final var usernameLinkUrl = UsernameLinkUrl.fromUri(username);
 127             final var components = usernameLinkUrl.getComponents();
 128             final var encryptedUsername = dependencies.getAccountManager()
 129                     .getEncryptedUsernameFromLinkServerId(components.getServerId());
 130             final var link = new Username.UsernameLink(components.getEntropy(), encryptedUsername);
 131
 132             return Username.fromLink(link);
 133         } catch (UsernameLinkUrl.InvalidUsernameLinkException e) {
 134             return new Username(username);
 135         }
 136     }
 137
 138     public Optional<RecipientId> resolveRecipientOptional(final RecipientIdentifier.Single recipient) {
 139         try {
 140             return Optional.of(resolveRecipient(recipient));
 141         } catch (UnregisteredRecipientException e) {
 142             if (recipient instanceof RecipientIdentifier.Number r) {
 143                 return account.getRecipientStore().resolveRecipientByNumberOptional(r.number());
 144             } else {
 145                 return Optional.empty();
 146             }
 147         }
 148     }
 149
 150     public void refreshUsers() throws IOException {
 151         getRegisteredUsers(account.getRecipientStore().getAllNumbers(), false);
 152     }
 153
 154     public RecipientId refreshRegisteredUser(RecipientId recipientId) throws IOException, UnregisteredRecipientException {
 155         final var address = resolveSignalServiceAddress(recipientId);
 156         if (address.getNumber().isEmpty()) {
 157             return recipientId;
 158         }
 159         final var number = address.getNumber().get();
 160         final var serviceId = getRegisteredUserByNumber(number);
 161         return account.getRecipientTrustedResolver()
 162                 .resolveRecipientTrusted(new SignalServiceAddress(serviceId, number));
 163     }
 164
 165     public Map<String, RegisteredUser> getRegisteredUsers(
 166             final Set<String> numbers
 167     ) throws IOException {
 168         if (numbers.size() > MAXIMUM_ONE_OFF_REQUEST_SIZE) {
 169             final var allNumbers = new HashSet<>(account.getRecipientStore().getAllNumbers()) {{
 170                 addAll(numbers);
 171             }};
 172             return getRegisteredUsers(allNumbers, false);
 173         } else {
 174             return getRegisteredUsers(numbers, true);
 175         }
 176     }
 177
 178     private Map<String, RegisteredUser> getRegisteredUsers(
 179             final Set<String> numbers, final boolean isPartialRefresh
 180     ) throws IOException {
 181         Map<String, RegisteredUser> registeredUsers = getRegisteredUsersV2(numbers, isPartialRefresh);
 182
 183         // Store numbers as recipients, so we have the number/uuid association
 184         registeredUsers.forEach((number, u) -> account.getRecipientTrustedResolver()
 185                 .resolveRecipientTrusted(u.aci, u.pni, Optional.of(number)));
 186
 187         final var unregisteredUsers = new HashSet<>(numbers);
 188         unregisteredUsers.removeAll(registeredUsers.keySet());
 189         account.getRecipientStore().markUnregistered(unregisteredUsers);
 190
 191         return registeredUsers;
 192     }
 193
 194     private ServiceId getRegisteredUserByNumber(final String number) throws IOException, UnregisteredRecipientException {
 195         final Map<String, RegisteredUser> aciMap;
 196         try {
 197             aciMap = getRegisteredUsers(Set.of(number), true);
 198         } catch (NumberFormatException e) {
 199             throw new UnregisteredRecipientException(new org.asamk.signal.manager.api.RecipientAddress(null, number));
 200         }
 201         final var user = aciMap.get(number);
 202         if (user == null) {
 203             throw new UnregisteredRecipientException(new org.asamk.signal.manager.api.RecipientAddress(null, number));
 204         }
 205         return user.getServiceId();
 206     }
 207
 208     private Map<String, RegisteredUser> getRegisteredUsersV2(
 209             final Set<String> numbers, boolean isPartialRefresh
 210     ) throws IOException {
 211         final var previousNumbers = isPartialRefresh ? Set.<String>of() : account.getCdsiStore().getAllNumbers();
 212         final var newNumbers = new HashSet<>(numbers) {{
 213             removeAll(previousNumbers);
 214         }};
 215         if (newNumbers.isEmpty() && previousNumbers.isEmpty()) {
 216             logger.debug("No new numbers to query.");
 217             return Map.of();
 218         }
 219         logger.trace("Querying CDSI for {} new numbers ({} previous), isPartialRefresh={}",
 220                 newNumbers.size(),
 221                 previousNumbers.size(),
 222                 isPartialRefresh);
 223         final var token = previousNumbers.isEmpty()
 224                 ? Optional.<byte[]>empty()
 225                 : Optional.ofNullable(account.getCdsiToken());
 226
 227         final CdsiV2Service.Response response;
 228         try {
 229             response = dependencies.getAccountManager()
 230                     .getRegisteredUsersWithCdsi(previousNumbers,
 231                             newNumbers,
 232                             account.getRecipientStore().getServiceIdToProfileKeyMap(),
 233                             token,
 234                             dependencies.getServiceEnvironmentConfig().cdsiMrenclave(),
 235                             null,
 236                             dependencies.getLibSignalNetwork(),
 237                             newToken -> {
 238                                 if (isPartialRefresh) {
 239                                     account.getCdsiStore().updateAfterPartialCdsQuery(newNumbers);
 240                                     // Not storing newToken for partial refresh
 241                                 } else {
 242                                     final var fullNumbers = new HashSet<>(previousNumbers) {{
 243                                         addAll(newNumbers);
 244                                     }};
 245                                     final var seenNumbers = new HashSet<>(numbers) {{
 246                                         addAll(newNumbers);
 247                                     }};
 248                                     account.getCdsiStore().updateAfterFullCdsQuery(fullNumbers, seenNumbers);
 249                                     account.setCdsiToken(newToken);
 250                                     account.setLastRecipientsRefresh(System.currentTimeMillis());
 251                                 }
 252                             });
 253         } catch (CdsiInvalidTokenException e) {
 254             account.setCdsiToken(null);
 255             account.getCdsiStore().clearAll();
 256             throw e;
 257         } catch (NumberFormatException e) {
 258             throw new IOException(e);
 259         }
 260         logger.debug("CDSI request successful, quota used by this request: {}", response.getQuotaUsedDebugOnly());
 261
 262         final var registeredUsers = new HashMap<String, RegisteredUser>();
 263         response.getResults()
 264                 .forEach((key, value) -> registeredUsers.put(key,
 265                         new RegisteredUser(value.getAci(), Optional.of(value.getPni()))));
 266         return registeredUsers;
 267     }
 268
 269     public record RegisteredUser(Optional<ACI> aci, Optional<PNI> pni) {
 270
 271         public RegisteredUser {
 272             aci = aci.isPresent() && aci.get().isUnknown() ? Optional.empty() : aci;
 273             pni = pni.isPresent() && pni.get().isUnknown() ? Optional.empty() : pni;
 274             if (aci.isEmpty() && pni.isEmpty()) {
 275                 throw new AssertionError("Must have either a ACI or PNI!");
 276             }
 277         }
 278
 279         public ServiceId getServiceId() {
 280             return aci.map(a -> (ServiceId) a).or(this::pni).orElse(null);
 281         }
 282     }
 283 }