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