/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import { PublicClientApplication, AccountInfo, Configuration, SilentFlowRequest, AuthenticationResult, InteractiveRequest, LogLevel, RefreshTokenRequest } from '@azure/msal-node'; import { NativeBrokerPlugin } from '@azure/msal-node-extensions'; import { Disposable, Memento, SecretStorage, LogOutputChannel, window, ProgressLocation, l10n, EventEmitter } from 'vscode'; import { raceCancellationAndTimeoutError } from '../common/async'; import { SecretStorageCachePlugin } from '../common/cachePlugin'; import { MsalLoggerOptions } from '../common/loggerOptions'; import { ICachedPublicClientApplication } from '../common/publicClientCache'; import { ScopedAccountAccess } from '../common/accountAccess'; export class CachedPublicClientApplication implements ICachedPublicClientApplication { // Core properties private _pca: PublicClientApplication; private _accounts: AccountInfo[] = []; private _sequencer = new Sequencer(); private readonly _disposable: Disposable; // Cache properties private readonly _secretStorageCachePlugin = new SecretStorageCachePlugin( this._secretStorage, // Include the prefix as a differentiator to other secrets `pca:${JSON.stringify({ clientId: this._clientId, authority: this._authority })}` ); // Broker properties private readonly _accountAccess = new ScopedAccountAccess(this._secretStorage, this._cloudName, this._clientId, this._authority); private readonly _isBrokerAvailable: boolean; //#region Events private readonly _onDidAccountsChangeEmitter = new EventEmitter<{ added: AccountInfo[]; changed: AccountInfo[]; deleted: AccountInfo[] }>; readonly onDidAccountsChange = this._onDidAccountsChangeEmitter.event; private readonly _onDidRemoveLastAccountEmitter = new EventEmitter(); readonly onDidRemoveLastAccount = this._onDidRemoveLastAccountEmitter.event; //#endregion constructor( private readonly _clientId: string, private readonly _authority: string, private readonly _cloudName: string, private readonly _globalMemento: Memento, private readonly _secretStorage: SecretStorage, private readonly _logger: LogOutputChannel ) { // TODO:@TylerLeonhardt clean up old use of memento. Remove this in an iteration this._globalMemento.update(`lastRemoval:${this._clientId}:${this._authority}`, undefined); const loggerOptions = new MsalLoggerOptions(_logger); const nativeBrokerPlugin = new NativeBrokerPlugin(); this._isBrokerAvailable = nativeBrokerPlugin.isBrokerAvailable ?? false; this._pca = new PublicClientApplication({ auth: { clientId: _clientId, authority: _authority }, system: { loggerOptions: { correlationId: `${_clientId}] [${_authority}`, loggerCallback: (level, message, containsPii) => loggerOptions.loggerCallback(level, message, containsPii), logLevel: LogLevel.Trace } }, broker: { nativeBrokerPlugin }, cache: { cachePlugin: this._secretStorageCachePlugin } }); this._disposable = Disposable.from( this._registerOnSecretStorageChanged(), this._onDidAccountsChangeEmitter, this._onDidRemoveLastAccountEmitter ); } get accounts(): AccountInfo[] { return this._accounts; } get clientId(): string { return this._clientId; } get authority(): string { return this._authority; } async initialize(): Promise { if (this._isBrokerAvailable) { await this._accountAccess.initialize(); } await this._sequencer.queue(() => this._update()); } dispose(): void { this._disposable.dispose(); } async acquireTokenSilent(request: SilentFlowRequest): Promise { this._logger.debug(`[acquireTokenSilent] [${this._clientId}] [${this._authority}] [${request.scopes.join(' ')}] [${request.account.username}] starting...`); let result = await this._sequencer.queue(() => this._pca.acquireTokenSilent(request)); this._logger.debug(`[acquireTokenSilent] [${this._clientId}] [${this._authority}] [${request.scopes.join(' ')}] [${request.account.username}] got result`); // Check expiration of id token and if it's 5min before expiration, force a refresh. // this is what MSAL does for access tokens already so we're just adding it for id tokens since we care about those. const idTokenExpirationInSecs = (result.idTokenClaims as { exp?: number }).exp; if (idTokenExpirationInSecs) { const fiveMinutesBefore = new Date( (idTokenExpirationInSecs - 5 * 60) // subtract 5 minutes * 1000 // convert to milliseconds ); if (fiveMinutesBefore < new Date()) { this._logger.debug(`[acquireTokenSilent] [${this._clientId}] [${this._authority}] [${request.scopes.join(' ')}] [${request.account.username}] id token is expired or about to expire. Forcing refresh...`); const newRequest = this._isBrokerAvailable // HACK: Broker doesn't support forceRefresh so we need to pass in claims which will force a refresh ? { ...request, claims: '{ "id_token": {}}' } : { ...request, forceRefresh: true }; result = await this._sequencer.queue(() => this._pca.acquireTokenSilent(newRequest)); this._logger.debug(`[acquireTokenSilent] [${this._clientId}] [${this._authority}] [${request.scopes.join(' ')}] [${request.account.username}] got refreshed result`); } const newIdTokenExpirationInSecs = (result.idTokenClaims as { exp?: number }).exp; if (newIdTokenExpirationInSecs) { if (new Date(newIdTokenExpirationInSecs * 1000) < new Date()) { this._logger.error(`[acquireTokenSilent] [${this._clientId}] [${this._authority}] [${request.scopes.join(' ')}] [${request.account.username}] id token is still expired.`); } } } if (result.account && !result.fromCache && this._verifyIfUsingBroker(result)) { this._logger.debug(`[acquireTokenSilent] [${this._clientId}] [${this._authority}] [${request.scopes.join(' ')}] [${request.account.username}] firing event due to change`); this._onDidAccountsChangeEmitter.fire({ added: [], changed: [result.account], deleted: [] }); } return result; } async acquireTokenInteractive(request: InteractiveRequest): Promise { this._logger.debug(`[acquireTokenInteractive] [${this._clientId}] [${this._authority}] [${request.scopes?.join(' ')}] loopbackClientOverride: ${request.loopbackClient ? 'true' : 'false'}`); const result = await window.withProgress( { location: ProgressLocation.Notification, cancellable: true, title: l10n.t('Signing in to Microsoft...') }, (_process, token) => this._sequencer.queue(() => raceCancellationAndTimeoutError( this._pca.acquireTokenInteractive(request), token, 1000 * 60 * 5 )) ); if (this._isBrokerAvailable) { await this._accountAccess.setAllowedAccess(result.account!, true); } return result; } /** * Allows for passing in a refresh token to get a new access token. This is the migration scenario. * TODO: MSAL Migration. Remove this when we remove the old flow. * @param request a {@link RefreshTokenRequest} object that contains the refresh token and other parameters. * @returns an {@link AuthenticationResult} object that contains the result of the token acquisition operation. */ async acquireTokenByRefreshToken(request: RefreshTokenRequest) { this._logger.debug(`[acquireTokenByRefreshToken] [${this._clientId}] [${this._authority}] [${request.scopes.join(' ')}]`); const result = await this._sequencer.queue(() => this._pca.acquireTokenByRefreshToken(request)); if (result) { // this._setupRefresh(result); if (this._isBrokerAvailable && result.account) { await this._accountAccess.setAllowedAccess(result.account, true); } } return result; } removeAccount(account: AccountInfo): Promise { if (this._isBrokerAvailable) { return this._accountAccess.setAllowedAccess(account, false); } return this._sequencer.queue(() => this._pca.getTokenCache().removeAccount(account)); } private _registerOnSecretStorageChanged() { if (this._isBrokerAvailable) { return this._accountAccess.onDidAccountAccessChange(() => this._sequencer.queue(() => this._update())); } return this._secretStorageCachePlugin.onDidChange(() => this._sequencer.queue(() => this._update())); } private _lastSeen = new Map(); private _verifyIfUsingBroker(result: AuthenticationResult): boolean { // If we're not brokering, we don't need to verify the date // the cache check will be sufficient if (!result.fromNativeBroker) { return true; } const key = result.account!.homeAccountId; const lastSeen = this._lastSeen.get(key); const lastTimeAuthed = result.account!.idTokenClaims!.iat!; if (!lastSeen) { this._lastSeen.set(key, lastTimeAuthed); return true; } if (lastSeen === lastTimeAuthed) { return false; } this._lastSeen.set(key, lastTimeAuthed); return true; } private async _update() { const before = this._accounts; this._logger.debug(`[update] [${this._clientId}] [${this._authority}] CachedPublicClientApplication update before: ${before.length}`); // Clear in-memory cache so we know we're getting account data from the SecretStorage this._pca.clearCache(); let after = await this._pca.getAllAccounts(); if (this._isBrokerAvailable) { after = after.filter(a => this._accountAccess.isAllowedAccess(a)); } this._accounts = after; this._logger.debug(`[update] [${this._clientId}] [${this._authority}] CachedPublicClientApplication update after: ${after.length}`); const beforeSet = new Set(before.map(b => b.homeAccountId)); const afterSet = new Set(after.map(a => a.homeAccountId)); const added = after.filter(a => !beforeSet.has(a.homeAccountId)); const deleted = before.filter(b => !afterSet.has(b.homeAccountId)); if (added.length > 0 || deleted.length > 0) { this._onDidAccountsChangeEmitter.fire({ added, changed: [], deleted }); this._logger.debug(`[update] [${this._clientId}] [${this._authority}] CachedPublicClientApplication accounts changed. added: ${added.length}, deleted: ${deleted.length}`); if (!after.length) { this._logger.debug(`[update] [${this._clientId}] [${this._authority}] CachedPublicClientApplication final account deleted. Firing event.`); this._onDidRemoveLastAccountEmitter.fire(); } } this._logger.debug(`[update] [${this._clientId}] [${this._authority}] CachedPublicClientApplication update complete`); } } export class Sequencer { private current: Promise = Promise.resolve(null); queue(promiseTask: () => Promise): Promise { return this.current = this.current.then(() => promiseTask(), () => promiseTask()); } }