This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 833
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MSC: matrix-org/matrix-spec-proposals#2918 Fixes element-hq/element-web#18698 Fixes element-hq/element-web#20648 **Requires matrix-org/matrix-js-sdk#2178 **Note**: There's a lot of logging in this PR. That is intentional to ensure that if/when something goes wrong we can chase the exact code path. It does not log any tokens - just where the code is going. Overall, it should be fairly low volume spam (and can be relaxed at a later date). ---- This approach uses indexeddb (through a mutex library) to manage which tab actually triggers the refresh, preventing issues where multiple tabs try to update the token. If multiple tabs update the token then the server might consider the account hacked and hard logout all the tokens. If for some reason the timer code gets it wrong, or the user has been offline for too long and the token can't be refreshed, they should be sent to a soft logout screen by the server. This will retain the user's encryption state - they simply need to reauthenticate to get an active access token again. This additionally contains a change to fix soft logout not working, per the issue links above. Of interest may be the IPC approach which was ultimately declined in favour of this change instead: #7803
- Loading branch information
Showing
9 changed files
with
504 additions
and
25 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
Large diffs are not rendered by default.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,233 @@ | ||
| /* | ||
| Copyright 2022 The Matrix.org Foundation C.I.C. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| import { logger } from "matrix-js-sdk/src/logger"; | ||
| import { MatrixClient } from "matrix-js-sdk/src"; | ||
| import { randomString } from "matrix-js-sdk/src/randomstring"; | ||
| import Mutex from "idb-mutex"; | ||
| import { Optional } from "matrix-events-sdk"; | ||
|
|
||
| import { IMatrixClientCreds, MatrixClientPeg } from "./MatrixClientPeg"; | ||
| import { getRenewedStoredSessionVars, hydrateSessionInPlace } from "./Lifecycle"; | ||
| import { IDB_SUPPORTED } from "./utils/StorageManager"; | ||
|
|
||
| export interface IRenewedMatrixClientCreds extends Pick<IMatrixClientCreds, | ||
| "accessToken" | "accessTokenExpiryTs" | "accessTokenRefreshToken"> {} | ||
|
|
||
| const LOCALSTORAGE_UPDATED_BY_KEY = "mx_token_updated_by"; | ||
|
|
||
| const CLIENT_ID = randomString(64); | ||
|
|
||
| export class TokenLifecycle { | ||
| public static readonly instance = new TokenLifecycle(); | ||
|
|
||
| private refreshAtTimerId: number; | ||
| private mutex: Mutex; | ||
|
|
||
| protected constructor() { | ||
| // we only really want one of these floating around, so private-ish | ||
| // constructor. Protected allows for unit tests. | ||
|
|
||
| // Don't try to create a mutex if it'll explode | ||
| if (IDB_SUPPORTED) { | ||
| this.mutex = new Mutex("token_refresh", null, { | ||
| expiry: 120000, // 2 minutes - enough time for the refresh request to time out | ||
| }); | ||
| } | ||
|
|
||
| // Watch for other tabs causing token refreshes, so we can react to them too. | ||
| window.addEventListener("storage", (ev: StorageEvent) => { | ||
| if (ev.key === LOCALSTORAGE_UPDATED_BY_KEY) { | ||
| const updateBy = localStorage.getItem(LOCALSTORAGE_UPDATED_BY_KEY); | ||
| if (!updateBy || updateBy === CLIENT_ID) return; // ignore deletions & echos | ||
|
|
||
| logger.info("TokenLifecycle#storageWatch: Token update received"); | ||
|
|
||
| // noinspection JSIgnoredPromiseFromCall | ||
| this.forceHydration(); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Can the client reasonably support token refreshes? | ||
| */ | ||
| public get isFeasible(): boolean { | ||
| return IDB_SUPPORTED; | ||
| } | ||
|
|
||
| // noinspection JSMethodCanBeStatic | ||
| private get fiveMinutesAgo(): number { | ||
| return Date.now() - 300000; | ||
| } | ||
|
|
||
| // noinspection JSMethodCanBeStatic | ||
| private get fiveMinutesFromNow(): number { | ||
| return Date.now() + 300000; | ||
| } | ||
|
|
||
| public flagNewCredentialsPersisted() { | ||
| logger.info("TokenLifecycle#flagPersisted: Credentials marked as persisted - flagging for other tabs"); | ||
| if (localStorage.getItem(LOCALSTORAGE_UPDATED_BY_KEY) !== CLIENT_ID) { | ||
| localStorage.setItem(LOCALSTORAGE_UPDATED_BY_KEY, CLIENT_ID); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Attempts a token renewal, if renewal is needed/possible. If renewal is not possible | ||
| * then this will return falsy. Otherwise, the new token's details (credentials) will | ||
| * be returned or an error if something went wrong. | ||
| * @param {IMatrixClientCreds} credentials The input credentials. | ||
| * @param {MatrixClient} client A client set up with those credentials. | ||
| * @returns {Promise<Optional<IRenewedMatrixClientCreds>>} Resolves to the new credentials, | ||
| * or falsy if renewal not possible/needed. Throws on error. | ||
| */ | ||
| public async tryTokenExchangeIfNeeded( | ||
| credentials: IMatrixClientCreds, | ||
| client: MatrixClient, | ||
| ): Promise<Optional<IRenewedMatrixClientCreds>> { | ||
| if (!credentials.accessTokenExpiryTs && credentials.accessTokenRefreshToken) { | ||
| logger.warn( | ||
| "TokenLifecycle#tryExchange: Got a refresh token, but no expiration time. The server is " + | ||
| "not compliant with the specification and might result in unexpected logouts.", | ||
| ); | ||
| } | ||
|
|
||
| if (!this.isFeasible) { | ||
| logger.warn("TokenLifecycle#tryExchange: Client cannot do token refreshes reliably"); | ||
| return; | ||
| } | ||
|
|
||
| if (credentials.accessTokenExpiryTs && credentials.accessTokenRefreshToken) { | ||
| if (this.fiveMinutesAgo >= credentials.accessTokenExpiryTs) { | ||
| logger.info("TokenLifecycle#tryExchange: Token has or will expire soon, refreshing"); | ||
| return await this.doTokenRefresh(credentials, client); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // noinspection JSMethodCanBeStatic | ||
| private async doTokenRefresh( | ||
| credentials: IMatrixClientCreds, | ||
| client: MatrixClient, | ||
| ): Promise<Optional<IRenewedMatrixClientCreds>> { | ||
| try { | ||
| logger.info("TokenLifecycle#doRefresh: Acquiring lock"); | ||
| await this.mutex.lock(); | ||
| logger.info("TokenLifecycle#doRefresh: Lock acquired"); | ||
|
|
||
| logger.info("TokenLifecycle#doRefresh: Performing refresh"); | ||
| localStorage.removeItem(LOCALSTORAGE_UPDATED_BY_KEY); | ||
| const newCreds = await client.refreshToken(credentials.accessTokenRefreshToken); | ||
| return { | ||
| // We use the browser's local time to do two things: | ||
| // 1. Avoid having to write code that counts down and stores a "time left" variable | ||
| // 2. Work around any time drift weirdness by assuming the user's local machine will | ||
| // drift consistently with itself. | ||
| // We additionally add our own safety buffer when renewing tokens to avoid cases where | ||
| // the time drift is accelerating. | ||
| accessTokenExpiryTs: Date.now() + newCreds.expires_in_ms, | ||
| accessToken: newCreds.access_token, | ||
| accessTokenRefreshToken: newCreds.refresh_token, | ||
| }; | ||
| } catch (e) { | ||
| logger.error("TokenLifecycle#doRefresh: Error refreshing token: ", e); | ||
| if (e.errcode === "M_UNKNOWN_TOKEN") { | ||
| // Emit the logout manually because the function inhibits it. | ||
| client.emit("Session.logged_out", e); | ||
| } else { | ||
| throw e; // we can't do anything with it, so re-throw | ||
| } | ||
| } finally { | ||
| logger.info("TokenLifecycle#doRefresh: Releasing lock"); | ||
| await this.mutex.unlock(); | ||
| } | ||
| } | ||
|
|
||
| public startTimers(credentials: IMatrixClientCreds) { | ||
| this.stopTimers(); | ||
|
|
||
| if (!credentials.accessTokenExpiryTs && credentials.accessTokenRefreshToken) { | ||
| logger.warn( | ||
| "TokenLifecycle#start: Got a refresh token, but no expiration time. The server is " + | ||
| "not compliant with the specification and might result in unexpected logouts.", | ||
| ); | ||
| } | ||
|
|
||
| if (!this.isFeasible) { | ||
| logger.warn("TokenLifecycle#start: Not starting refresh timers - browser unsupported"); | ||
| } | ||
|
|
||
| if (credentials.accessTokenExpiryTs && credentials.accessTokenRefreshToken) { | ||
| // We schedule the refresh task for 5 minutes before the expiration timestamp as | ||
| // a safety buffer. We assume/hope that servers won't be expiring tokens faster | ||
| // than every 5 minutes, but we do need to consider cases where the expiration is | ||
| // fairly quick (<10 minutes, for example). | ||
| let relativeTime = credentials.accessTokenExpiryTs - this.fiveMinutesFromNow; | ||
| if (relativeTime <= 0) { | ||
| logger.warn(`TokenLifecycle#start: Refresh was set for ${relativeTime}ms - readjusting`); | ||
| relativeTime = Math.floor(Math.random() * 5000) + 30000; // 30 seconds + 5s jitter | ||
| } | ||
| this.refreshAtTimerId = setTimeout(() => { | ||
| // noinspection JSIgnoredPromiseFromCall | ||
| this.forceTokenExchange(); | ||
| }, relativeTime); | ||
| logger.info(`TokenLifecycle#start: Refresh timer set for ${relativeTime}ms from now`); | ||
| } else { | ||
| logger.info("TokenLifecycle#start: Not setting a refresh timer - token not renewable"); | ||
| } | ||
| } | ||
|
|
||
| public stopTimers() { | ||
| clearTimeout(this.refreshAtTimerId); | ||
| logger.info("TokenLifecycle#stop: Stopped refresh timer (if it was running)"); | ||
| } | ||
|
|
||
| private async forceTokenExchange() { | ||
| const credentials = MatrixClientPeg.getCredentials(); | ||
| await this.rehydrate(await this.doTokenRefresh(credentials, MatrixClientPeg.get())); | ||
| this.flagNewCredentialsPersisted(); | ||
| } | ||
|
|
||
| private async forceHydration() { | ||
| const { | ||
| accessToken, | ||
| accessTokenRefreshToken, | ||
| accessTokenExpiryTs, | ||
| } = await getRenewedStoredSessionVars(); | ||
| return this.rehydrate({ accessToken, accessTokenRefreshToken, accessTokenExpiryTs }); | ||
| } | ||
|
|
||
| private async rehydrate(newCreds: IRenewedMatrixClientCreds) { | ||
| const credentials = MatrixClientPeg.getCredentials(); | ||
| try { | ||
| if (!newCreds) { | ||
| logger.error("TokenLifecycle#expireExchange: Expecting new credentials, got nothing. Rescheduling."); | ||
| this.startTimers(credentials); | ||
| } else { | ||
| logger.info("TokenLifecycle#expireExchange: Updating client credentials using rehydration"); | ||
| await hydrateSessionInPlace({ | ||
| ...credentials, | ||
| ...newCreds, // override from credentials | ||
| }); | ||
| // hydrateSessionInPlace will ultimately call back to startTimers() for us, so no need to do it here. | ||
| } | ||
| } catch (e) { | ||
| logger.error("TokenLifecycle#expireExchange: Error getting new credentials. Rescheduling.", e); | ||
| this.startTimers(credentials); | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.