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, String captcha, final boolean forceRegister
 109     ) throws IOException, CaptchaRequiredException, NonNormalizedPhoneNumberException, RateLimitException, VerificationMethodNotAvailableException {
 110         if (account.isRegistered()
 111                 && account.getServiceEnvironment() != null
 112                 && account.getServiceEnvironment() != serviceEnvironmentConfig.type()) {
 113             throw new IOException("Account is registered in another environment: " + account.getServiceEnvironment());
 114         }
 115
 116         try {
 117             if (!forceRegister) {
 118                 if (account.isRegistered()) {
 119                     throw new IOException("Account is already registered");
 120                 }
 121
 122                 if (account.getAci() != null && attemptReactivateAccount()) {
 123                     return;
 124                 }
 125             }
 126
 127             final var recoveryPassword = account.getRecoveryPassword();
 128             if (recoveryPassword != null && account.isPrimaryDevice() && attemptReregisterAccount(recoveryPassword)) {
 129                 return;
 130             }
 131
 132             final var registrationApi = unauthenticatedAccountManager.getRegistrationApi();
 133             String sessionId = NumberVerificationUtils.handleVerificationSession(registrationApi,
 134                     account.getSessionId(account.getNumber()),
 135                     id -> account.setSessionId(account.getNumber(), id),
 136                     voiceVerification,
 137                     captcha);
 138             NumberVerificationUtils.requestVerificationCode(registrationApi, sessionId, voiceVerification);
 139             account.setRegistered(false);
 140         } catch (DeprecatedVersionException e) {
 141             logger.debug("Signal-Server returned deprecated version exception", e);
 142             throw e;
 143         }
 144     }
 145
 146     @Override
 147     public void verifyAccount(
 148             String verificationCode, String pin
 149     ) throws IOException, PinLockedException, IncorrectPinException {
 150         if (account.isRegistered()) {
 151             throw new IOException("Account is already registered");
 152         }
 153
 154         if (account.getPniIdentityKeyPair() == null) {
 155             account.setPniIdentityKeyPair(KeyUtils.generateIdentityKeyPair());
 156         }
 157
 158         final var aciPreKeys = generatePreKeysForType(account.getAccountData(ServiceIdType.ACI));
 159         final var pniPreKeys = generatePreKeysForType(account.getAccountData(ServiceIdType.PNI));
 160         final var result = NumberVerificationUtils.verifyNumber(account.getSessionId(account.getNumber()),
 161                 verificationCode,
 162                 pin,
 163                 pinHelper,
 164                 (sessionId1, verificationCode1, registrationLock) -> verifyAccountWithCode(sessionId1,
 165                         verificationCode1,
 166                         registrationLock,
 167                         aciPreKeys,
 168                         pniPreKeys));
 169         final var response = result.first();
 170         final var masterKey = result.second();
 171         if (masterKey == null) {
 172             pin = null;
 173         }
 174
 175         finishAccountRegistration(response, pin, masterKey, aciPreKeys, pniPreKeys);
 176     }
 177
 178     @Override
 179     public void deleteLocalAccountData() throws IOException {
 180         account.deleteAccountData();
 181         accountFileUpdater.removeAccount();
 182         account = null;
 183     }
 184
 185     @Override
 186     public boolean isRegistered() {
 187         return account.isRegistered();
 188     }
 189
 190     private boolean attemptReregisterAccount(final String recoveryPassword) {
 191         try {
 192             if (account.getPniIdentityKeyPair() == null) {
 193                 account.setPniIdentityKeyPair(KeyUtils.generateIdentityKeyPair());
 194             }
 195
 196             final var aciPreKeys = generatePreKeysForType(account.getAccountData(ServiceIdType.ACI));
 197             final var pniPreKeys = generatePreKeysForType(account.getAccountData(ServiceIdType.PNI));
 198             final var registrationApi = unauthenticatedAccountManager.getRegistrationApi();
 199             final var response = Utils.handleResponseException(registrationApi.registerAccount(null,
 200                     recoveryPassword,
 201                     account.getAccountAttributes(null),
 202                     aciPreKeys,
 203                     pniPreKeys,
 204                     null,
 205                     true));
 206             finishAccountRegistration(response,
 207                     account.getRegistrationLockPin(),
 208                     account.getPinBackedMasterKey(),
 209                     aciPreKeys,
 210                     pniPreKeys);
 211             logger.info("Reregistered existing account, verify is not necessary.");
 212             return true;
 213         } catch (IOException e) {
 214             logger.debug("Failed to reregister account with recovery password", e);
 215         }
 216         return false;
 217     }
 218
 219     private boolean attemptReactivateAccount() {
 220         try {
 221             final var accountManager = createAuthenticatedSignalServiceAccountManager();
 222             accountManager.setAccountAttributes(account.getAccountAttributes(null));
 223             account.setRegistered(true);
 224             logger.info("Reactivated existing account, verify is not necessary.");
 225             if (newManagerListener != null) {
 226                 final var m = new ManagerImpl(account,
 227                         pathConfig,
 228                         accountFileUpdater,
 229                         serviceEnvironmentConfig,
 230                         userAgent);
 231                 account = null;
 232                 newManagerListener.accept(m);
 233             }
 234             return true;
 235         } catch (IOException e) {
 236             logger.debug("Failed to reactivate account");
 237         }
 238         return false;
 239     }
 240
 241     private SignalServiceAccountManager createAuthenticatedSignalServiceAccountManager() {
 242         final var clientZkOperations = ClientZkOperations.create(serviceEnvironmentConfig.signalServiceConfiguration());
 243         final var pushServiceSocket = new PushServiceSocket(serviceEnvironmentConfig.signalServiceConfiguration(),
 244                 account.getCredentialsProvider(),
 245                 userAgent,
 246                 clientZkOperations.getProfileOperations(),
 247                 ServiceConfig.AUTOMATIC_NETWORK_RETRY);
 248         final var groupsV2Operations = new GroupsV2Operations(clientZkOperations, ServiceConfig.GROUP_MAX_SIZE);
 249         return new SignalServiceAccountManager(pushServiceSocket, null, groupsV2Operations);
 250     }
 251
 252     private VerifyAccountResponse verifyAccountWithCode(
 253             final String sessionId,
 254             final String verificationCode,
 255             final String registrationLock,
 256             final PreKeyCollection aciPreKeys,
 257             final PreKeyCollection pniPreKeys
 258     ) throws IOException {
 259         final var registrationApi = unauthenticatedAccountManager.getRegistrationApi();
 260         try {
 261             Utils.handleResponseException(registrationApi.verifyAccount(sessionId, verificationCode));
 262         } catch (AlreadyVerifiedException e) {
 263             // Already verified so can continue registering
 264         }
 265         return Utils.handleResponseException(registrationApi.registerAccount(sessionId,
 266                 null,
 267                 account.getAccountAttributes(registrationLock),
 268                 aciPreKeys,
 269                 pniPreKeys,
 270                 null,
 271                 true));
 272     }
 273
 274     private void finishAccountRegistration(
 275             final VerifyAccountResponse response,
 276             final String pin,
 277             final MasterKey masterKey,
 278             final PreKeyCollection aciPreKeys,
 279             final PreKeyCollection pniPreKeys
 280     ) throws IOException {
 281         //accountManager.setGcmId(Optional.of(GoogleCloudMessaging.getInstance(this).register(REGISTRATION_ID)));
 282         final var aci = ACI.parseOrThrow(response.getUuid());
 283         final var pni = PNI.parseOrThrow(response.getPni());
 284         account.finishRegistration(aci, pni, masterKey, pin, aciPreKeys, pniPreKeys);
 285         accountFileUpdater.updateAccountIdentifiers(account.getNumber(), aci);
 286
 287         ManagerImpl m = null;
 288         try {
 289             m = new ManagerImpl(account, pathConfig, accountFileUpdater, serviceEnvironmentConfig, userAgent);
 290             account = null;
 291
 292             m.refreshPreKeys();
 293             if (response.isStorageCapable()) {
 294                 m.syncRemoteStorage();
 295             }
 296             // Set an initial empty profile so user can be added to groups
 297             try {
 298                 m.updateProfile(UpdateProfile.newBuilder().build());
 299             } catch (NoClassDefFoundError e) {
 300                 logger.warn("Failed to set default profile: {}", e.getMessage());
 301             }
 302
 303             try {
 304                 m.refreshCurrentUsername();
 305             } catch (IOException | BaseUsernameException e) {
 306                 logger.warn("Failed to refresh current username", e);
 307             }
 308
 309             if (newManagerListener != null) {
 310                 newManagerListener.accept(m);
 311                 m = null;
 312             }
 313         } finally {
 314             if (m != null) {
 315                 m.close();
 316             }
 317         }
 318     }
 319
 320     @Override
 321     public void close() {
 322         if (account != null) {
 323             account.close();
 324             account = null;
 325         }
 326     }
 327 }