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.ACI;
  43 import org.whispersystems.signalservice.api.push.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         this.pinHelper = new PinHelper(keyBackupService, fallbackKeyBackupServices);
 111     }
 112
 113     @Override
 114     public void register(
 115             boolean voiceVerification, String captcha
 116     ) throws IOException, CaptchaRequiredException, NonNormalizedPhoneNumberException, RateLimitException {
 117         if (account.isRegistered()
 118                 && account.getServiceEnvironment() != null
 119                 && account.getServiceEnvironment() != serviceEnvironmentConfig.getType()) {
 120             throw new IOException("Account is registered in another environment: " + account.getServiceEnvironment());
 121         }
 122
 123         try {
 124             if (account.getAci() != null && attemptReactivateAccount()) {
 125                 return;
 126             }
 127
 128             String sessionId = NumberVerificationUtils.handleVerificationSession(accountManager,
 129                     account.getSessionId(account.getNumber()),
 130                     id -> account.setSessionId(account.getNumber(), id),
 131                     voiceVerification,
 132                     captcha);
 133             NumberVerificationUtils.requestVerificationCode(accountManager, sessionId, voiceVerification);
 134         } catch (DeprecatedVersionException e) {
 135             logger.debug("Signal-Server returned deprecated version exception", e);
 136             throw e;
 137         }
 138     }
 139
 140     @Override
 141     public void verifyAccount(
 142             String verificationCode, String pin
 143     ) throws IOException, PinLockedException, IncorrectPinException {
 144         if (account.getPniIdentityKeyPair() == null) {
 145             account.setPniIdentityKeyPair(KeyUtils.generateIdentityKeyPair());
 146         }
 147
 148         final var aciPreKeys = generatePreKeysForType(ServiceIdType.ACI);
 149         final var pniPreKeys = generatePreKeysForType(ServiceIdType.PNI);
 150         final var result = NumberVerificationUtils.verifyNumber(account.getSessionId(account.getNumber()),
 151                 verificationCode,
 152                 pin,
 153                 pinHelper,
 154                 (sessionId1, verificationCode1, registrationLock) -> verifyAccountWithCode(sessionId1,
 155                         verificationCode1,
 156                         registrationLock,
 157                         aciPreKeys,
 158                         pniPreKeys));
 159         final var response = result.first();
 160         final var masterKey = result.second();
 161         if (masterKey == null) {
 162             pin = null;
 163         }
 164
 165         //accountManager.setGcmId(Optional.of(GoogleCloudMessaging.getInstance(this).register(REGISTRATION_ID)));
 166         final var aci = ACI.parseOrNull(response.getUuid());
 167         final var pni = PNI.parseOrNull(response.getPni());
 168         account.finishRegistration(aci, pni, masterKey, pin, aciPreKeys, pniPreKeys);
 169         accountFileUpdater.updateAccountIdentifiers(account.getNumber(), aci);
 170
 171         ManagerImpl m = null;
 172         try {
 173             m = new ManagerImpl(account, pathConfig, accountFileUpdater, serviceEnvironmentConfig, userAgent);
 174             account = null;
 175
 176             m.refreshPreKeys();
 177             if (response.isStorageCapable()) {
 178                 m.retrieveRemoteStorage();
 179             }
 180             // Set an initial empty profile so user can be added to groups
 181             try {
 182                 m.updateProfile(UpdateProfile.newBuilder().build());
 183             } catch (NoClassDefFoundError e) {
 184                 logger.warn("Failed to set default profile: {}", e.getMessage());
 185             }
 186
 187             try {
 188                 m.refreshCurrentUsername();
 189             } catch (IOException | BaseUsernameException e) {
 190                 logger.warn("Failed to refresh current username", e);
 191             }
 192
 193             if (newManagerListener != null) {
 194                 newManagerListener.accept(m);
 195                 m = null;
 196             }
 197         } finally {
 198             if (m != null) {
 199                 m.close();
 200             }
 201         }
 202     }
 203
 204     @Override
 205     public void deleteLocalAccountData() throws IOException {
 206         account.deleteAccountData();
 207         accountFileUpdater.removeAccount();
 208         account = null;
 209     }
 210
 211     @Override
 212     public boolean isRegistered() {
 213         return account.isRegistered();
 214     }
 215
 216     private boolean attemptReactivateAccount() {
 217         try {
 218             final var accountManager = new SignalServiceAccountManager(serviceEnvironmentConfig.getSignalServiceConfiguration(),
 219                     account.getCredentialsProvider(),
 220                     userAgent,
 221                     null,
 222                     ServiceConfig.AUTOMATIC_NETWORK_RETRY);
 223             accountManager.setAccountAttributes(account.getAccountAttributes(null));
 224             account.setRegistered(true);
 225             logger.info("Reactivated existing account, verify is not necessary.");
 226             if (newManagerListener != null) {
 227                 final var m = new ManagerImpl(account,
 228                         pathConfig,
 229                         accountFileUpdater,
 230                         serviceEnvironmentConfig,
 231                         userAgent);
 232                 account = null;
 233                 newManagerListener.accept(m);
 234             }
 235             return true;
 236         } catch (IOException e) {
 237             logger.debug("Failed to reactivate account");
 238         }
 239         return false;
 240     }
 241
 242     private VerifyAccountResponse verifyAccountWithCode(
 243             final String sessionId,
 244             final String verificationCode,
 245             final String registrationLock,
 246             final PreKeyCollection aciPreKeys,
 247             final PreKeyCollection pniPreKeys
 248     ) throws IOException {
 249         try {
 250             Utils.handleResponseException(accountManager.verifyAccount(verificationCode, sessionId));
 251         } catch (AlreadyVerifiedException e) {
 252             // Already verified so can continue registering
 253         }
 254         return Utils.handleResponseException(accountManager.registerAccount(sessionId,
 255                 null,
 256                 account.getAccountAttributes(registrationLock),
 257                 aciPreKeys,
 258                 pniPreKeys,
 259                 null,
 260                 true));
 261     }
 262
 263     private PreKeyCollection generatePreKeysForType(ServiceIdType serviceIdType) {
 264         final var accountData = account.getAccountData(serviceIdType);
 265         final var keyPair = accountData.getIdentityKeyPair();
 266         final var preKeyMetadata = accountData.getPreKeyMetadata();
 267
 268         final var nextSignedPreKeyId = preKeyMetadata.getNextSignedPreKeyId();
 269         final var signedPreKey = KeyUtils.generateSignedPreKeyRecord(nextSignedPreKeyId, keyPair);
 270
 271         final var privateKey = keyPair.getPrivateKey();
 272         final var kyberPreKeyIdOffset = preKeyMetadata.getKyberPreKeyIdOffset();
 273         final var lastResortKyberPreKey = KeyUtils.generateKyberPreKeyRecord(kyberPreKeyIdOffset, privateKey);
 274
 275         return new PreKeyCollection(keyPair.getPublicKey(), signedPreKey, lastResortKyberPreKey);
 276     }
 277
 278     @Override
 279     public void close() {
 280         if (account != null) {
 281             account.close();
 282             account = null;
 283         }
 284     }
 285 }