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