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

   1 /*
   2   Copyright (C) 2015-2022 AsamK and contributors
   3
   4   This program is free software: you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation, either version 3 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12   GNU General Public License for more details.
  13
  14   You should have received a copy of the GNU General Public License
  15   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.asamk.signal.manager.internal;
  18
  19 import org.asamk.signal.manager.Manager;
  20 import org.asamk.signal.manager.RegistrationManager;
  21 import org.asamk.signal.manager.api.CaptchaRequiredException;
  22 import org.asamk.signal.manager.api.IncorrectPinException;
  23 import org.asamk.signal.manager.api.NonNormalizedPhoneNumberException;
  24 import org.asamk.signal.manager.api.PinLockedException;
  25 import org.asamk.signal.manager.api.RateLimitException;
  26 import org.asamk.signal.manager.api.UpdateProfile;
  27 import org.asamk.signal.manager.api.VerificationMethodNotAvailableException;
  28 import org.asamk.signal.manager.config.ServiceConfig;
  29 import org.asamk.signal.manager.config.ServiceEnvironmentConfig;
  30 import org.asamk.signal.manager.helper.AccountFileUpdater;
  31 import org.asamk.signal.manager.helper.PinHelper;
  32 import org.asamk.signal.manager.storage.SignalAccount;
  33 import org.asamk.signal.manager.util.KeyUtils;
  34 import org.asamk.signal.manager.util.NumberVerificationUtils;
  35 import org.asamk.signal.manager.util.Utils;
  36 import org.signal.libsignal.usernames.BaseUsernameException;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39 import org.whispersystems.signalservice.api.SignalServiceAccountManager;
  40 import org.whispersystems.signalservice.api.account.PreKeyCollection;
  41 import org.whispersystems.signalservice.api.groupsv2.ClientZkOperations;
  42 import org.whispersystems.signalservice.api.groupsv2.GroupsV2Operations;
  43 import org.whispersystems.signalservice.api.kbs.MasterKey;
  44 import org.whispersystems.signalservice.api.push.ServiceId.ACI;
  45 import org.whispersystems.signalservice.api.push.ServiceId.PNI;
  46 import org.whispersystems.signalservice.api.push.ServiceIdType;
  47 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
  48 import org.whispersystems.signalservice.api.push.exceptions.AlreadyVerifiedException;
  49 import org.whispersystems.signalservice.api.push.exceptions.DeprecatedVersionException;
  50 import org.whispersystems.signalservice.api.svr.SecureValueRecovery;
  51 import org.whispersystems.signalservice.internal.push.PushServiceSocket;
  52 import org.whispersystems.signalservice.internal.push.VerifyAccountResponse;
  53
  54 import java.io.IOException;
  55 import java.util.function.Consumer;
  56
  57 import static org.asamk.signal.manager.util.KeyUtils.generatePreKeysForType;
  58
  59 public class RegistrationManagerImpl implements RegistrationManager {
  60
  61     private static final Logger logger = LoggerFactory.getLogger(RegistrationManagerImpl.class);
  62
  63     private SignalAccount account;
  64     private final PathConfig pathConfig;
  65     private final ServiceEnvironmentConfig serviceEnvironmentConfig;
  66     private final String userAgent;
  67     private final Consumer<Manager> newManagerListener;
  68
  69     private final SignalServiceAccountManager unauthenticatedAccountManager;
  70     private final PinHelper pinHelper;
  71     private final AccountFileUpdater accountFileUpdater;
  72
  73     public RegistrationManagerImpl(
  74             SignalAccount account,
  75             PathConfig pathConfig,
  76             ServiceEnvironmentConfig serviceEnvironmentConfig,
  77             String userAgent,
  78             Consumer<Manager> newManagerListener,
  79             AccountFileUpdater accountFileUpdater
  80     ) {
  81         this.account = account;
  82         this.pathConfig = pathConfig;
  83         this.accountFileUpdater = accountFileUpdater;
  84         this.serviceEnvironmentConfig = serviceEnvironmentConfig;
  85         this.userAgent = userAgent;
  86         this.newManagerListener = newManagerListener;
  87
  88         this.unauthenticatedAccountManager = SignalServiceAccountManager.createWithStaticCredentials(
  89                 serviceEnvironmentConfig.signalServiceConfiguration(),
  90                 // Using empty UUID, because registering doesn't work otherwise
  91                 null,
  92                 null,
  93                 account.getNumber(),
  94                 SignalServiceAddress.DEFAULT_DEVICE_ID,
  95                 account.getPassword(),
  96                 userAgent,
  97                 ServiceConfig.AUTOMATIC_NETWORK_RETRY,
  98                 ServiceConfig.GROUP_MAX_SIZE);
  99         final var secureValueRecovery = serviceEnvironmentConfig.svr2Mrenclaves()
 100                 .stream()
 101                 .map(mr -> (SecureValueRecovery) this.unauthenticatedAccountManager.getSecureValueRecoveryV2(mr))
 102                 .toList();
 103         this.pinHelper = new PinHelper(secureValueRecovery);
 104     }
 105
 106     @Override
 107     public void register(
 108             boolean voiceVerification,
 109             String captcha,
 110             final boolean forceRegister
 111     ) throws IOException, CaptchaRequiredException, NonNormalizedPhoneNumberException, RateLimitException, VerificationMethodNotAvailableException {
 112         if (account.isRegistered()
 113                 && account.getServiceEnvironment() != null
 114                 && account.getServiceEnvironment() != serviceEnvironmentConfig.type()) {
 115             throw new IOException("Account is registered in another environment: " + account.getServiceEnvironment());
 116         }
 117
 118         try {
 119             if (!forceRegister) {
 120                 if (account.isRegistered()) {
 121                     throw new IOException("Account is already registered");
 122                 }
 123
 124                 if (account.getAci() != null && attemptReactivateAccount()) {
 125                     return;
 126                 }
 127             }
 128
 129             final var recoveryPassword = account.getRecoveryPassword();
 130             if (recoveryPassword != null && account.isPrimaryDevice() && attemptReregisterAccount(recoveryPassword)) {
 131                 return;
 132             }
 133
 134             final var registrationApi = unauthenticatedAccountManager.getRegistrationApi();
 135             String sessionId = NumberVerificationUtils.handleVerificationSession(registrationApi,
 136                     account.getSessionId(account.getNumber()),
 137                     id -> account.setSessionId(account.getNumber(), id),
 138                     voiceVerification,
 139                     captcha);
 140             NumberVerificationUtils.requestVerificationCode(registrationApi, sessionId, voiceVerification);
 141             account.setRegistered(false);
 142         } catch (DeprecatedVersionException e) {
 143             logger.debug("Signal-Server returned deprecated version exception", e);
 144             throw e;
 145         }
 146     }
 147
 148     @Override
 149     public void verifyAccount(
 150             String verificationCode,
 151             String pin
 152     ) throws IOException, PinLockedException, IncorrectPinException {
 153         if (account.isRegistered()) {
 154             throw new IOException("Account is already registered");
 155         }
 156
 157         if (account.getPniIdentityKeyPair() == null) {
 158             account.setPniIdentityKeyPair(KeyUtils.generateIdentityKeyPair());
 159         }
 160
 161         final var aciPreKeys = generatePreKeysForType(account.getAccountData(ServiceIdType.ACI));
 162         final var pniPreKeys = generatePreKeysForType(account.getAccountData(ServiceIdType.PNI));
 163         final var result = NumberVerificationUtils.verifyNumber(account.getSessionId(account.getNumber()),
 164                 verificationCode,
 165                 pin,
 166                 pinHelper,
 167                 (sessionId1, verificationCode1, registrationLock) -> verifyAccountWithCode(sessionId1,
 168                         verificationCode1,
 169                         registrationLock,
 170                         aciPreKeys,
 171                         pniPreKeys));
 172         final var response = result.first();
 173         final var masterKey = result.second();
 174         if (masterKey == null) {
 175             pin = null;
 176         }
 177
 178         finishAccountRegistration(response, pin, masterKey, aciPreKeys, pniPreKeys);
 179     }
 180
 181     @Override
 182     public void deleteLocalAccountData() throws IOException {
 183         account.deleteAccountData();
 184         accountFileUpdater.removeAccount();
 185         account = null;
 186     }
 187
 188     @Override
 189     public boolean isRegistered() {
 190         return account.isRegistered();
 191     }
 192
 193     private boolean attemptReregisterAccount(final String recoveryPassword) {
 194         try {
 195             if (account.getPniIdentityKeyPair() == null) {
 196                 account.setPniIdentityKeyPair(KeyUtils.generateIdentityKeyPair());
 197             }
 198
 199             final var aciPreKeys = generatePreKeysForType(account.getAccountData(ServiceIdType.ACI));
 200             final var pniPreKeys = generatePreKeysForType(account.getAccountData(ServiceIdType.PNI));
 201             final var registrationApi = unauthenticatedAccountManager.getRegistrationApi();
 202             final var response = Utils.handleResponseException(registrationApi.registerAccount(null,
 203                     recoveryPassword,
 204                     account.getAccountAttributes(null),
 205                     aciPreKeys,
 206                     pniPreKeys,
 207                     null,
 208                     true));
 209             finishAccountRegistration(response,
 210                     account.getRegistrationLockPin(),
 211                     account.getPinBackedMasterKey(),
 212                     aciPreKeys,
 213                     pniPreKeys);
 214             logger.info("Reregistered existing account, verify is not necessary.");
 215             return true;
 216         } catch (IOException e) {
 217             logger.debug("Failed to reregister account with recovery password", e);
 218         }
 219         return false;
 220     }
 221
 222     private boolean attemptReactivateAccount() {
 223         try {
 224             final var accountManager = createAuthenticatedSignalServiceAccountManager();
 225             accountManager.setAccountAttributes(account.getAccountAttributes(null));
 226             account.setRegistered(true);
 227             logger.info("Reactivated existing account, verify is not necessary.");
 228             if (newManagerListener != null) {
 229                 final var m = new ManagerImpl(account,
 230                         pathConfig,
 231                         accountFileUpdater,
 232                         serviceEnvironmentConfig,
 233                         userAgent);
 234                 account = null;
 235                 newManagerListener.accept(m);
 236             }
 237             return true;
 238         } catch (IOException e) {
 239             logger.debug("Failed to reactivate account");
 240         }
 241         return false;
 242     }
 243
 244     private SignalServiceAccountManager createAuthenticatedSignalServiceAccountManager() {
 245         final var clientZkOperations = ClientZkOperations.create(serviceEnvironmentConfig.signalServiceConfiguration());
 246         final var pushServiceSocket = new PushServiceSocket(serviceEnvironmentConfig.signalServiceConfiguration(),
 247                 account.getCredentialsProvider(),
 248                 userAgent,
 249                 clientZkOperations.getProfileOperations(),
 250                 ServiceConfig.AUTOMATIC_NETWORK_RETRY);
 251         final var groupsV2Operations = new GroupsV2Operations(clientZkOperations, ServiceConfig.GROUP_MAX_SIZE);
 252         return new SignalServiceAccountManager(pushServiceSocket, null, groupsV2Operations);
 253     }
 254
 255     private VerifyAccountResponse verifyAccountWithCode(
 256             final String sessionId,
 257             final String verificationCode,
 258             final String registrationLock,
 259             final PreKeyCollection aciPreKeys,
 260             final PreKeyCollection pniPreKeys
 261     ) throws IOException {
 262         final var registrationApi = unauthenticatedAccountManager.getRegistrationApi();
 263         try {
 264             Utils.handleResponseException(registrationApi.verifyAccount(sessionId, verificationCode));
 265         } catch (AlreadyVerifiedException e) {
 266             // Already verified so can continue registering
 267         }
 268         return Utils.handleResponseException(registrationApi.registerAccount(sessionId,
 269                 null,
 270                 account.getAccountAttributes(registrationLock),
 271                 aciPreKeys,
 272                 pniPreKeys,
 273                 null,
 274                 true));
 275     }
 276
 277     private void finishAccountRegistration(
 278             final VerifyAccountResponse response,
 279             final String pin,
 280             final MasterKey masterKey,
 281             final PreKeyCollection aciPreKeys,
 282             final PreKeyCollection pniPreKeys
 283     ) throws IOException {
 284         //accountManager.setGcmId(Optional.of(GoogleCloudMessaging.getInstance(this).register(REGISTRATION_ID)));
 285         final var aci = ACI.parseOrThrow(response.getUuid());
 286         final var pni = PNI.parseOrThrow(response.getPni());
 287         account.finishRegistration(aci, pni, masterKey, pin, aciPreKeys, pniPreKeys);
 288         accountFileUpdater.updateAccountIdentifiers(account.getNumber(), aci);
 289
 290         ManagerImpl m = null;
 291         try {
 292             m = new ManagerImpl(account, pathConfig, accountFileUpdater, serviceEnvironmentConfig, userAgent);
 293             account = null;
 294
 295             m.refreshPreKeys();
 296             if (response.isStorageCapable()) {
 297                 m.syncRemoteStorage();
 298             }
 299             // Set an initial empty profile so user can be added to groups
 300             try {
 301                 m.updateProfile(UpdateProfile.newBuilder().build());
 302             } catch (NoClassDefFoundError e) {
 303                 logger.warn("Failed to set default profile: {}", e.getMessage());
 304             }
 305
 306             try {
 307                 m.refreshCurrentUsername();
 308             } catch (IOException | BaseUsernameException e) {
 309                 logger.warn("Failed to refresh current username", e);
 310             }
 311
 312             if (newManagerListener != null) {
 313                 newManagerListener.accept(m);
 314                 m = null;
 315             }
 316         } finally {
 317             if (m != null) {
 318                 m.close();
 319             }
 320         }
 321     }
 322
 323     @Override
 324     public void close() {
 325         if (account != null) {
 326             account.close();
 327             account = null;
 328         }
 329     }
 330 }