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.config.ServiceConfig;
  28 import org.asamk.signal.manager.config.ServiceEnvironmentConfig;
  29 import org.asamk.signal.manager.helper.AccountFileUpdater;
  30 import org.asamk.signal.manager.helper.PinHelper;
  31 import org.asamk.signal.manager.storage.SignalAccount;
  32 import org.asamk.signal.manager.util.KeyUtils;
  33 import org.asamk.signal.manager.util.NumberVerificationUtils;
  34 import org.asamk.signal.manager.util.Utils;
  35 import org.signal.libsignal.usernames.BaseUsernameException;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38 import org.whispersystems.signalservice.api.SignalServiceAccountManager;
  39 import org.whispersystems.signalservice.api.account.PreKeyCollection;
  40 import org.whispersystems.signalservice.api.groupsv2.ClientZkOperations;
  41 import org.whispersystems.signalservice.api.groupsv2.GroupsV2Operations;
  42 import org.whispersystems.signalservice.api.push.ServiceId.ACI;
  43 import org.whispersystems.signalservice.api.push.ServiceId.PNI;
  44 import org.whispersystems.signalservice.api.push.ServiceIdType;
  45 import org.whispersystems.signalservice.api.push.SignalServiceAddress;
  46 import org.whispersystems.signalservice.api.push.exceptions.AlreadyVerifiedException;
  47 import org.whispersystems.signalservice.api.push.exceptions.DeprecatedVersionException;
  48 import org.whispersystems.signalservice.api.svr.SecureValueRecoveryV1;
  49 import org.whispersystems.signalservice.internal.push.VerifyAccountResponse;
  50 import org.whispersystems.signalservice.internal.util.DynamicCredentialsProvider;
  51
  52 import java.io.IOException;
  53 import java.util.function.Consumer;
  54
  55 public class RegistrationManagerImpl implements RegistrationManager {
  56
  57     private final static Logger logger = LoggerFactory.getLogger(RegistrationManagerImpl.class);
  58
  59     private SignalAccount account;
  60     private final PathConfig pathConfig;
  61     private final ServiceEnvironmentConfig serviceEnvironmentConfig;
  62     private final String userAgent;
  63     private final Consumer<Manager> newManagerListener;
  64
  65     private final SignalServiceAccountManager accountManager;
  66     private final PinHelper pinHelper;
  67     private final AccountFileUpdater accountFileUpdater;
  68
  69     public RegistrationManagerImpl(
  70             SignalAccount account,
  71             PathConfig pathConfig,
  72             ServiceEnvironmentConfig serviceEnvironmentConfig,
  73             String userAgent,
  74             Consumer<Manager> newManagerListener,
  75             AccountFileUpdater accountFileUpdater
  76     ) {
  77         this.account = account;
  78         this.pathConfig = pathConfig;
  79         this.accountFileUpdater = accountFileUpdater;
  80         this.serviceEnvironmentConfig = serviceEnvironmentConfig;
  81         this.userAgent = userAgent;
  82         this.newManagerListener = newManagerListener;
  83
  84         GroupsV2Operations groupsV2Operations;
  85         try {
  86             groupsV2Operations = new GroupsV2Operations(ClientZkOperations.create(serviceEnvironmentConfig.signalServiceConfiguration()),
  87                     ServiceConfig.GROUP_MAX_SIZE);
  88         } catch (Throwable ignored) {
  89             groupsV2Operations = null;
  90         }
  91         this.accountManager = new SignalServiceAccountManager(serviceEnvironmentConfig.signalServiceConfiguration(),
  92                 new DynamicCredentialsProvider(
  93                         // Using empty UUID, because registering doesn't work otherwise
  94                         null, null, account.getNumber(), account.getPassword(), SignalServiceAddress.DEFAULT_DEVICE_ID),
  95                 userAgent,
  96                 groupsV2Operations,
  97                 ServiceConfig.AUTOMATIC_NETWORK_RETRY);
  98         final var keyBackupService = accountManager.getKeyBackupService(ServiceConfig.getIasKeyStore(),
  99                 serviceEnvironmentConfig.keyBackupConfig().enclaveName(),
 100                 serviceEnvironmentConfig.keyBackupConfig().serviceId(),
 101                 serviceEnvironmentConfig.keyBackupConfig().mrenclave(),
 102                 10);
 103         final var fallbackKeyBackupServices = serviceEnvironmentConfig.fallbackKeyBackupConfigs()
 104                 .stream()
 105                 .map(config -> accountManager.getKeyBackupService(ServiceConfig.getIasKeyStore(),
 106                         config.enclaveName(),
 107                         config.serviceId(),
 108                         config.mrenclave(),
 109                         10))
 110                 .toList();
 111         final var secureValueRecoveryV2 = accountManager.getSecureValueRecoveryV2(serviceEnvironmentConfig.svr2Mrenclave());
 112         this.pinHelper = new PinHelper(new SecureValueRecoveryV1(keyBackupService),
 113                 secureValueRecoveryV2,
 114                 fallbackKeyBackupServices);
 115     }
 116
 117     @Override
 118     public void register(
 119             boolean voiceVerification, String captcha
 120     ) throws IOException, CaptchaRequiredException, NonNormalizedPhoneNumberException, RateLimitException {
 121         if (account.isRegistered()
 122                 && account.getServiceEnvironment() != null
 123                 && account.getServiceEnvironment() != serviceEnvironmentConfig.type()) {
 124             throw new IOException("Account is registered in another environment: " + account.getServiceEnvironment());
 125         }
 126
 127         try {
 128             if (account.getAci() != null && attemptReactivateAccount()) {
 129                 return;
 130             }
 131
 132             String sessionId = NumberVerificationUtils.handleVerificationSession(accountManager,
 133                     account.getSessionId(account.getNumber()),
 134                     id -> account.setSessionId(account.getNumber(), id),
 135                     voiceVerification,
 136                     captcha);
 137             NumberVerificationUtils.requestVerificationCode(accountManager, sessionId, voiceVerification);
 138         } catch (DeprecatedVersionException e) {
 139             logger.debug("Signal-Server returned deprecated version exception", e);
 140             throw e;
 141         }
 142     }
 143
 144     @Override
 145     public void verifyAccount(
 146             String verificationCode, String pin
 147     ) throws IOException, PinLockedException, IncorrectPinException {
 148         if (account.getPniIdentityKeyPair() == null) {
 149             account.setPniIdentityKeyPair(KeyUtils.generateIdentityKeyPair());
 150         }
 151
 152         final var aciPreKeys = generatePreKeysForType(ServiceIdType.ACI);
 153         final var pniPreKeys = generatePreKeysForType(ServiceIdType.PNI);
 154         final var result = NumberVerificationUtils.verifyNumber(account.getSessionId(account.getNumber()),
 155                 verificationCode,
 156                 pin,
 157                 pinHelper,
 158                 (sessionId1, verificationCode1, registrationLock) -> verifyAccountWithCode(sessionId1,
 159                         verificationCode1,
 160                         registrationLock,
 161                         aciPreKeys,
 162                         pniPreKeys));
 163         final var response = result.first();
 164         final var masterKey = result.second();
 165         if (masterKey == null) {
 166             pin = null;
 167         }
 168
 169         //accountManager.setGcmId(Optional.of(GoogleCloudMessaging.getInstance(this).register(REGISTRATION_ID)));
 170         final var aci = ACI.parseOrThrow(response.getUuid());
 171         final var pni = PNI.parseOrThrow(response.getPni());
 172         account.finishRegistration(aci, pni, masterKey, pin, aciPreKeys, pniPreKeys);
 173         accountFileUpdater.updateAccountIdentifiers(account.getNumber(), aci);
 174
 175         ManagerImpl m = null;
 176         try {
 177             m = new ManagerImpl(account, pathConfig, accountFileUpdater, serviceEnvironmentConfig, userAgent);
 178             account = null;
 179
 180             m.refreshPreKeys();
 181             if (response.isStorageCapable()) {
 182                 m.retrieveRemoteStorage();
 183             }
 184             // Set an initial empty profile so user can be added to groups
 185             try {
 186                 m.updateProfile(UpdateProfile.newBuilder().build());
 187             } catch (NoClassDefFoundError e) {
 188                 logger.warn("Failed to set default profile: {}", e.getMessage());
 189             }
 190
 191             try {
 192                 m.refreshCurrentUsername();
 193             } catch (IOException | BaseUsernameException e) {
 194                 logger.warn("Failed to refresh current username", e);
 195             }
 196
 197             if (newManagerListener != null) {
 198                 newManagerListener.accept(m);
 199                 m = null;
 200             }
 201         } finally {
 202             if (m != null) {
 203                 m.close();
 204             }
 205         }
 206     }
 207
 208     @Override
 209     public void deleteLocalAccountData() throws IOException {
 210         account.deleteAccountData();
 211         accountFileUpdater.removeAccount();
 212         account = null;
 213     }
 214
 215     @Override
 216     public boolean isRegistered() {
 217         return account.isRegistered();
 218     }
 219
 220     private boolean attemptReactivateAccount() {
 221         try {
 222             final var accountManager = new SignalServiceAccountManager(serviceEnvironmentConfig.signalServiceConfiguration(),
 223                     account.getCredentialsProvider(),
 224                     userAgent,
 225                     null,
 226                     ServiceConfig.AUTOMATIC_NETWORK_RETRY);
 227             accountManager.setAccountAttributes(account.getAccountAttributes(null));
 228             account.setRegistered(true);
 229             logger.info("Reactivated existing account, verify is not necessary.");
 230             if (newManagerListener != null) {
 231                 final var m = new ManagerImpl(account,
 232                         pathConfig,
 233                         accountFileUpdater,
 234                         serviceEnvironmentConfig,
 235                         userAgent);
 236                 account = null;
 237                 newManagerListener.accept(m);
 238             }
 239             return true;
 240         } catch (IOException e) {
 241             logger.debug("Failed to reactivate account");
 242         }
 243         return false;
 244     }
 245
 246     private VerifyAccountResponse verifyAccountWithCode(
 247             final String sessionId,
 248             final String verificationCode,
 249             final String registrationLock,
 250             final PreKeyCollection aciPreKeys,
 251             final PreKeyCollection pniPreKeys
 252     ) throws IOException {
 253         try {
 254             Utils.handleResponseException(accountManager.verifyAccount(verificationCode, sessionId));
 255         } catch (AlreadyVerifiedException e) {
 256             // Already verified so can continue registering
 257         }
 258         return Utils.handleResponseException(accountManager.registerAccount(sessionId,
 259                 null,
 260                 account.getAccountAttributes(registrationLock),
 261                 aciPreKeys,
 262                 pniPreKeys,
 263                 null,
 264                 true));
 265     }
 266
 267     private PreKeyCollection generatePreKeysForType(ServiceIdType serviceIdType) {
 268         final var accountData = account.getAccountData(serviceIdType);
 269         final var keyPair = accountData.getIdentityKeyPair();
 270         final var preKeyMetadata = accountData.getPreKeyMetadata();
 271
 272         final var nextSignedPreKeyId = preKeyMetadata.getNextSignedPreKeyId();
 273         final var signedPreKey = KeyUtils.generateSignedPreKeyRecord(nextSignedPreKeyId, keyPair.getPrivateKey());
 274
 275         final var privateKey = keyPair.getPrivateKey();
 276         final var kyberPreKeyIdOffset = preKeyMetadata.getNextKyberPreKeyId();
 277         final var lastResortKyberPreKey = KeyUtils.generateKyberPreKeyRecord(kyberPreKeyIdOffset, privateKey);
 278
 279         return new PreKeyCollection(keyPair.getPublicKey(), signedPreKey, lastResortKyberPreKey);
 280     }
 281
 282     @Override
 283     public void close() {
 284         if (account != null) {
 285             account.close();
 286             account = null;
 287         }
 288     }
 289 }