-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
/v1/accounts and /v2/keys to the WebSocket
- Loading branch information
1 parent
ad6b99b
commit 195f23c
Showing
37 changed files
with
290 additions
and
691 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
142 changes: 136 additions & 6 deletions
142
service/src/main/java/org/whispersystems/textsecuregcm/auth/AccountAuthenticator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,155 @@ | ||
| /* | ||
| * Copyright 2013-2021 Signal Messenger, LLC | ||
| * Copyright 2013 Signal Messenger, LLC | ||
| * SPDX-License-Identifier: AGPL-3.0-only | ||
| */ | ||
|
|
||
| package org.whispersystems.textsecuregcm.auth; | ||
|
|
||
| import static com.codahale.metrics.MetricRegistry.name; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import io.dropwizard.auth.Authenticator; | ||
| import io.dropwizard.auth.basic.BasicCredentials; | ||
| import io.micrometer.core.instrument.Metrics; | ||
| import io.micrometer.core.instrument.Tags; | ||
| import java.time.Clock; | ||
| import java.time.Duration; | ||
| import java.time.temporal.ChronoUnit; | ||
| import java.util.Optional; | ||
| import org.whispersystems.textsecuregcm.experiment.ExperimentEnrollmentManager; | ||
| import java.util.UUID; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.whispersystems.textsecuregcm.storage.Account; | ||
| import org.whispersystems.textsecuregcm.storage.AccountsManager; | ||
| import org.whispersystems.textsecuregcm.storage.Device; | ||
| import org.whispersystems.textsecuregcm.storage.RefreshingAccountAndDeviceSupplier; | ||
| import org.whispersystems.textsecuregcm.util.Pair; | ||
| import org.whispersystems.textsecuregcm.util.Util; | ||
|
|
||
| public class AccountAuthenticator implements Authenticator<BasicCredentials, AuthenticatedAccount> { | ||
|
|
||
| private static final String LEGACY_NAME_PREFIX = "org.whispersystems.textsecuregcm.auth.BaseAccountAuthenticator"; | ||
|
|
||
| public class AccountAuthenticator extends BaseAccountAuthenticator implements | ||
| Authenticator<BasicCredentials, AuthenticatedAccount> { | ||
| private static final String AUTHENTICATION_COUNTER_NAME = name(LEGACY_NAME_PREFIX, "authentication"); | ||
| private static final String AUTHENTICATION_SUCCEEDED_TAG_NAME = "succeeded"; | ||
| private static final String AUTHENTICATION_FAILURE_REASON_TAG_NAME = "reason"; | ||
|
|
||
| private static final String DAYS_SINCE_LAST_SEEN_DISTRIBUTION_NAME = name(LEGACY_NAME_PREFIX, "daysSinceLastSeen"); | ||
| private static final String IS_PRIMARY_DEVICE_TAG = "isPrimary"; | ||
|
|
||
| @VisibleForTesting | ||
| static final char DEVICE_ID_SEPARATOR = '.'; | ||
|
|
||
| private final AccountsManager accountsManager; | ||
| private final Clock clock; | ||
|
|
||
| public AccountAuthenticator(AccountsManager accountsManager) { | ||
| super(accountsManager); | ||
| this(accountsManager, Clock.systemUTC()); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| public AccountAuthenticator(AccountsManager accountsManager, Clock clock) { | ||
| this.accountsManager = accountsManager; | ||
| this.clock = clock; | ||
| } | ||
|
|
||
| static Pair<String, Byte> getIdentifierAndDeviceId(final String basicUsername) { | ||
| final String identifier; | ||
| final byte deviceId; | ||
|
|
||
| final int deviceIdSeparatorIndex = basicUsername.indexOf(DEVICE_ID_SEPARATOR); | ||
|
|
||
| if (deviceIdSeparatorIndex == -1) { | ||
| identifier = basicUsername; | ||
| deviceId = Device.PRIMARY_ID; | ||
| } else { | ||
| identifier = basicUsername.substring(0, deviceIdSeparatorIndex); | ||
| deviceId = Byte.parseByte(basicUsername.substring(deviceIdSeparatorIndex + 1)); | ||
| } | ||
|
|
||
| return new Pair<>(identifier, deviceId); | ||
| } | ||
|
|
||
| @Override | ||
| public Optional<AuthenticatedAccount> authenticate(BasicCredentials basicCredentials) { | ||
| return super.authenticate(basicCredentials, true); | ||
| boolean succeeded = false; | ||
| String failureReason = null; | ||
|
|
||
| try { | ||
| final UUID accountUuid; | ||
| final byte deviceId; | ||
| { | ||
| final Pair<String, Byte> identifierAndDeviceId = getIdentifierAndDeviceId(basicCredentials.getUsername()); | ||
|
|
||
| accountUuid = UUID.fromString(identifierAndDeviceId.first()); | ||
| deviceId = identifierAndDeviceId.second(); | ||
| } | ||
|
|
||
| Optional<Account> account = accountsManager.getByAccountIdentifier(accountUuid); | ||
|
|
||
| if (account.isEmpty()) { | ||
| failureReason = "noSuchAccount"; | ||
| return Optional.empty(); | ||
| } | ||
|
|
||
| Optional<Device> device = account.get().getDevice(deviceId); | ||
|
|
||
| if (device.isEmpty()) { | ||
| failureReason = "noSuchDevice"; | ||
| return Optional.empty(); | ||
| } | ||
|
|
||
| SaltedTokenHash deviceSaltedTokenHash = device.get().getAuthTokenHash(); | ||
| if (deviceSaltedTokenHash.verify(basicCredentials.getPassword())) { | ||
| succeeded = true; | ||
| Account authenticatedAccount = updateLastSeen(account.get(), device.get()); | ||
| if (deviceSaltedTokenHash.getVersion() != SaltedTokenHash.CURRENT_VERSION) { | ||
| authenticatedAccount = accountsManager.updateDeviceAuthentication( | ||
| authenticatedAccount, | ||
| device.get(), | ||
| SaltedTokenHash.generateFor(basicCredentials.getPassword())); // new credentials have current version | ||
| } | ||
| return Optional.of(new AuthenticatedAccount( | ||
| new RefreshingAccountAndDeviceSupplier(authenticatedAccount, device.get().getId(), accountsManager))); | ||
| } | ||
|
|
||
| return Optional.empty(); | ||
| } catch (IllegalArgumentException | InvalidAuthorizationHeaderException iae) { | ||
| failureReason = "invalidHeader"; | ||
| return Optional.empty(); | ||
| } finally { | ||
| Tags tags = Tags.of( | ||
| AUTHENTICATION_SUCCEEDED_TAG_NAME, String.valueOf(succeeded)); | ||
|
|
||
| if (StringUtils.isNotBlank(failureReason)) { | ||
| tags = tags.and(AUTHENTICATION_FAILURE_REASON_TAG_NAME, failureReason); | ||
| } | ||
|
|
||
| Metrics.counter(AUTHENTICATION_COUNTER_NAME, tags).increment(); | ||
| } | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| public Account updateLastSeen(Account account, Device device) { | ||
| // compute a non-negative integer between 0 and 86400. | ||
| long n = Util.ensureNonNegativeLong(account.getUuid().getLeastSignificantBits()); | ||
| final long lastSeenOffsetSeconds = n % ChronoUnit.DAYS.getDuration().toSeconds(); | ||
|
|
||
| // produce a truncated timestamp which is either today at UTC midnight | ||
| // or yesterday at UTC midnight, based on per-user randomized offset used. | ||
| final long todayInMillisWithOffset = Util.todayInMillisGivenOffsetFromNow(clock, | ||
| Duration.ofSeconds(lastSeenOffsetSeconds).negated()); | ||
|
|
||
| // only update the device's last seen time when it falls behind the truncated timestamp. | ||
| // this ensures a few things: | ||
| // (1) each account will only update last-seen at most once per day | ||
| // (2) these updates will occur throughout the day rather than all occurring at UTC midnight. | ||
| if (device.getLastSeen() < todayInMillisWithOffset) { | ||
| Metrics.summary(DAYS_SINCE_LAST_SEEN_DISTRIBUTION_NAME, IS_PRIMARY_DEVICE_TAG, String.valueOf(device.isPrimary())) | ||
| .record(Duration.ofMillis(todayInMillisWithOffset - device.getLastSeen()).toDays()); | ||
|
|
||
| return accountsManager.updateDeviceLastSeen(account, device, Util.todayInMillis(clock)); | ||
| } | ||
|
|
||
| return account; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.