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.config.ServiceEnvironmentConfig;
   7 import org.asamk.signal.manager.internal.SignalDependencies;
   8 import org.asamk.signal.manager.storage.SignalAccount;
   9 import org.asamk.signal.manager.storage.recipients.RecipientId;
  10 import org.signal.libsignal.usernames.BaseUsernameException;
  11 import org.signal.libsignal.usernames.Username;
  12 import org.slf4j.Logger;
  13 import org.slf4j.LoggerFactory;
  14 import org.whispersystems.signalservice.api.push.ServiceId;
  15 import org.whispersystems.signalservice.api.push.ServiceId.ACI;
  16 import org.whispersystems.signalservice.api.push.ServiceId.PNI;
  17 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
  18 import org.whispersystems.signalservice.api.push.exceptions.CdsiInvalidTokenException;
  19 import org.whispersystems.signalservice.api.services.CdsiV2Service;
  20
  21 import java.io.IOException;
  22 import java.util.Collection;
  23 import java.util.HashMap;
  24 import java.util.HashSet;
  25 import java.util.Map;
  26 import java.util.Optional;
  27 import java.util.Set;
  28
  29 import static org.asamk.signal.manager.config.ServiceConfig.MAXIMUM_ONE_OFF_REQUEST_SIZE;
  30
  31 public class RecipientHelper {
  32
  33     private static final Logger logger = LoggerFactory.getLogger(RecipientHelper.class);
  34
  35     private final SignalAccount account;
  36     private final SignalDependencies dependencies;
  37     private final ServiceEnvironmentConfig serviceEnvironmentConfig;
  38
  39     public RecipientHelper(final Context context) {
  40         this.account = context.getAccount();
  41         this.dependencies = context.getDependencies();
  42         this.serviceEnvironmentConfig = dependencies.getServiceEnvironmentConfig();
  43     }
  44
  45     public SignalServiceAddress resolveSignalServiceAddress(RecipientId recipientId) {
  46         final var address = account.getRecipientAddressResolver().resolveRecipientAddress(recipientId);
  47         if (address.number().isEmpty() || address.serviceId().isPresent()) {
  48             return address.toSignalServiceAddress();
  49         }
  50
  51         // Address in recipient store doesn't have a uuid, this shouldn't happen
  52         // Try to retrieve the uuid from the server
  53         final var number = address.number().get();
  54         final ServiceId serviceId;
  55         try {
  56             serviceId = getRegisteredUserByNumber(number);
  57         } catch (UnregisteredRecipientException e) {
  58             logger.warn("Failed to get uuid for e164 number: {}", number);
  59             // Return SignalServiceAddress with unknown UUID
  60             return address.toSignalServiceAddress();
  61         } catch (IOException e) {
  62             logger.warn("Failed to get uuid for e164 number: {}", number, e);
  63             // Return SignalServiceAddress with unknown UUID
  64             return address.toSignalServiceAddress();
  65         }
  66         return account.getRecipientAddressResolver()
  67                 .resolveRecipientAddress(account.getRecipientResolver().resolveRecipient(serviceId))
  68                 .toSignalServiceAddress();
  69     }
  70
  71     public Set<RecipientId> resolveRecipients(Collection<RecipientIdentifier.Single> recipients) throws UnregisteredRecipientException {
  72         final var recipientIds = new HashSet<RecipientId>(recipients.size());
  73         for (var number : recipients) {
  74             final var recipientId = resolveRecipient(number);
  75             recipientIds.add(recipientId);
  76         }
  77         return recipientIds;
  78     }
  79
  80     public RecipientId resolveRecipient(final RecipientIdentifier.Single recipient) throws UnregisteredRecipientException {
  81         if (recipient instanceof RecipientIdentifier.Uuid uuidRecipient) {
  82             return account.getRecipientResolver().resolveRecipient(ACI.from(uuidRecipient.uuid()));
  83         } else if (recipient instanceof RecipientIdentifier.Number numberRecipient) {
  84             final var number = numberRecipient.number();
  85             return account.getRecipientStore().resolveRecipientByNumber(number, () -> {
  86                 try {
  87                     return getRegisteredUserByNumber(number);
  88                 } catch (Exception e) {
  89                     return null;
  90                 }
  91             });
  92         } else if (recipient instanceof RecipientIdentifier.Username usernameRecipient) {
  93             var username = usernameRecipient.username();
  94             return resolveRecipientByUsernameOrLink(username, false);
  95         }
  96         throw new AssertionError("Unexpected RecipientIdentifier: " + recipient);
  97     }
  98
  99     public RecipientId resolveRecipientByUsernameOrLink(
 100             String username, boolean forceRefresh
 101     ) throws UnregisteredRecipientException {
 102         final Username finalUsername;
 103         try {
 104             finalUsername = getUsernameFromUsernameOrLink(username);
 105         } catch (IOException | BaseUsernameException e) {
 106             throw new RuntimeException(e);
 107         }
 108         if (forceRefresh) {
 109             try {
 110                 final var aci = dependencies.getAccountManager().getAciByUsername(finalUsername);
 111                 return account.getRecipientStore().resolveRecipientTrusted(aci, finalUsername.getUsername());
 112             } catch (IOException e) {
 113                 throw new UnregisteredRecipientException(new org.asamk.signal.manager.api.RecipientAddress(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().markUnregistered(unregisteredUsers);
 193
 194         return registeredUsers;
 195     }
 196
 197     private ServiceId getRegisteredUserByNumber(final String number) throws IOException, UnregisteredRecipientException {
 198         final Map<String, RegisteredUser> aciMap;
 199         try {
 200             aciMap = getRegisteredUsers(Set.of(number), true);
 201         } catch (NumberFormatException e) {
 202             throw new UnregisteredRecipientException(new org.asamk.signal.manager.api.RecipientAddress(null, number));
 203         }
 204         final var user = aciMap.get(number);
 205         if (user == null) {
 206             throw new UnregisteredRecipientException(new org.asamk.signal.manager.api.RecipientAddress(null, number));
 207         }
 208         return user.getServiceId();
 209     }
 210
 211     private Map<String, RegisteredUser> getRegisteredUsersV2(
 212             final Set<String> numbers, boolean isPartialRefresh
 213     ) throws IOException {
 214         final var previousNumbers = isPartialRefresh ? Set.<String>of() : account.getCdsiStore().getAllNumbers();
 215         final var newNumbers = new HashSet<>(numbers) {{
 216             removeAll(previousNumbers);
 217         }};
 218         if (newNumbers.isEmpty() && previousNumbers.isEmpty()) {
 219             logger.debug("No new numbers to query.");
 220             return Map.of();
 221         }
 222         logger.trace("Querying CDSI for {} new numbers ({} previous), isPartialRefresh={}",
 223                 newNumbers.size(),
 224                 previousNumbers.size(),
 225                 isPartialRefresh);
 226         final var token = previousNumbers.isEmpty()
 227                 ? Optional.<byte[]>empty()
 228                 : Optional.ofNullable(account.getCdsiToken());
 229
 230         final CdsiV2Service.Response response;
 231         try {
 232             response = dependencies.getAccountManager()
 233                     .getRegisteredUsersWithCdsi(previousNumbers,
 234                             newNumbers,
 235                             account.getRecipientStore().getServiceIdToProfileKeyMap(),
 236                             token,
 237                             serviceEnvironmentConfig.cdsiMrenclave(),
 238                             null,
 239                             dependencies.getServiceEnvironmentConfig().netEnvironment(),
 240                             newToken -> {
 241                                 if (isPartialRefresh) {
 242                                     account.getCdsiStore().updateAfterPartialCdsQuery(newNumbers);
 243                                     // Not storing newToken for partial refresh
 244                                 } else {
 245                                     final var fullNumbers = new HashSet<>(previousNumbers) {{
 246                                         addAll(newNumbers);
 247                                     }};
 248                                     final var seenNumbers = new HashSet<>(numbers) {{
 249                                         addAll(newNumbers);
 250                                     }};
 251                                     account.getCdsiStore().updateAfterFullCdsQuery(fullNumbers, seenNumbers);
 252                                     account.setCdsiToken(newToken);
 253                                     account.setLastRecipientsRefresh(System.currentTimeMillis());
 254                                 }
 255                             });
 256         } catch (CdsiInvalidTokenException e) {
 257             account.setCdsiToken(null);
 258             account.getCdsiStore().clearAll();
 259             throw e;
 260         } catch (NumberFormatException e) {
 261             throw new IOException(e);
 262         }
 263         logger.debug("CDSI request successful, quota used by this request: {}", response.getQuotaUsedDebugOnly());
 264
 265         final var registeredUsers = new HashMap<String, RegisteredUser>();
 266         response.getResults()
 267                 .forEach((key, value) -> registeredUsers.put(key,
 268                         new RegisteredUser(value.getAci(), Optional.of(value.getPni()))));
 269         return registeredUsers;
 270     }
 271
 272     public record RegisteredUser(Optional<ACI> aci, Optional<PNI> pni) {
 273
 274         public RegisteredUser {
 275             aci = aci.isPresent() && aci.get().isUnknown() ? Optional.empty() : aci;
 276             pni = pni.isPresent() && pni.get().isUnknown() ? Optional.empty() : pni;
 277             if (aci.isEmpty() && pni.isEmpty()) {
 278                 throw new AssertionError("Must have either a ACI or PNI!");
 279             }
 280         }
 281
 282         public ServiceId getServiceId() {
 283             return aci.map(a -> (ServiceId) a).or(this::pni).orElse(null);
 284         }
 285     }
 286 }