@azure/msal-browser 3.2.0 → 3.4.0

package/src/cache/BrowserCacheManager.ts

@@ -35,6 +35,8 @@ import {
     ClientAuthErrorCodes,
     PerformanceEvents,
     IPerformanceClient,
+    StaticAuthorityOptions,
+    CacheHelpers,
 } from "@azure/msal-common";
 import { CacheOptions } from "../config/Configuration";
 import {
@@ -85,9 +87,10 @@ export class BrowserCacheManager extends CacheManager {
         clientId: string,
         cacheConfig: Required<CacheOptions>,
         cryptoImpl: ICrypto,
-        logger: Logger
+        logger: Logger,
+        staticAuthorityOptions?: StaticAuthorityOptions
     ) {
-        super(clientId, cryptoImpl, logger);
+        super(clientId, cryptoImpl, logger, staticAuthorityOptions);
         this.cacheConfig = cacheConfig;
         this.logger = logger;
         this.internalStorage = new MemoryStorage();
@@ -232,17 +235,15 @@ export class BrowserCacheManager extends CacheManager {
                     if (credObj && credObj.hasOwnProperty("credentialType")) {
                         switch (credObj["credentialType"]) {
                             case CredentialType.ID_TOKEN:
-                                if (IdTokenEntity.isIdTokenEntity(credObj)) {
+                                if (CacheHelpers.isIdTokenEntity(credObj)) {
                                     this.logger.trace(
                                         "BrowserCacheManager:createKeyMaps - idToken found, saving key to token key map"
                                     );
                                     this.logger.tracePii(
                                         `BrowserCacheManager:createKeyMaps - idToken with key: ${key} found, saving key to token key map`
                                     );
-                                    const idTokenEntity = CacheManager.toObject(
-                                        new IdTokenEntity(),
-                                        credObj
-                                    );
+                                    const idTokenEntity =
+                                        credObj as IdTokenEntity;
                                     const newKey =
                                         this.updateCredentialCacheKey(
                                             key,
@@ -264,11 +265,7 @@ export class BrowserCacheManager extends CacheManager {
                                 break;
                             case CredentialType.ACCESS_TOKEN:
                             case CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME:
-                                if (
-                                    AccessTokenEntity.isAccessTokenEntity(
-                                        credObj
-                                    )
-                                ) {
+                                if (CacheHelpers.isAccessTokenEntity(credObj)) {
                                     this.logger.trace(
                                         "BrowserCacheManager:createKeyMaps - accessToken found, saving key to token key map"
                                     );
@@ -276,10 +273,7 @@ export class BrowserCacheManager extends CacheManager {
                                         `BrowserCacheManager:createKeyMaps - accessToken with key: ${key} found, saving key to token key map`
                                     );
                                     const accessTokenEntity =
-                                        CacheManager.toObject(
-                                            new AccessTokenEntity(),
-                                            credObj
-                                        );
+                                        credObj as AccessTokenEntity;
                                     const newKey =
                                         this.updateCredentialCacheKey(
                                             key,
@@ -301,9 +295,7 @@ export class BrowserCacheManager extends CacheManager {
                                 break;
                             case CredentialType.REFRESH_TOKEN:
                                 if (
-                                    RefreshTokenEntity.isRefreshTokenEntity(
-                                        credObj
-                                    )
+                                    CacheHelpers.isRefreshTokenEntity(credObj)
                                 ) {
                                     this.logger.trace(
                                         "BrowserCacheManager:createKeyMaps - refreshToken found, saving key to token key map"
@@ -312,10 +304,7 @@ export class BrowserCacheManager extends CacheManager {
                                         `BrowserCacheManager:createKeyMaps - refreshToken with key: ${key} found, saving key to token key map`
                                     );
                                     const refreshTokenEntity =
-                                        CacheManager.toObject(
-                                            new RefreshTokenEntity(),
-                                            credObj
-                                        );
+                                        credObj as RefreshTokenEntity;
                                     const newKey =
                                         this.updateCredentialCacheKey(
                                             key,
@@ -716,7 +705,7 @@ export class BrowserCacheManager extends CacheManager {
         }
 
         const parsedIdToken = this.validateAndParseJson(value);
-        if (!parsedIdToken || !IdTokenEntity.isIdTokenEntity(parsedIdToken)) {
+        if (!parsedIdToken || !CacheHelpers.isIdTokenEntity(parsedIdToken)) {
             this.logger.trace(
                 "BrowserCacheManager.getIdTokenCredential: called, no cache hit"
             );
@@ -727,7 +716,7 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.getIdTokenCredential: cache hit"
         );
-        return CacheManager.toObject(new IdTokenEntity(), parsedIdToken);
+        return parsedIdToken as IdTokenEntity;
     }
 
     /**
@@ -736,7 +725,7 @@ export class BrowserCacheManager extends CacheManager {
      */
     setIdTokenCredential(idToken: IdTokenEntity): void {
         this.logger.trace("BrowserCacheManager.setIdTokenCredential called");
-        const idTokenKey = idToken.generateCredentialKey();
+        const idTokenKey = CacheHelpers.generateCredentialKey(idToken);
 
         this.setItem(idTokenKey, JSON.stringify(idToken));
 
@@ -759,7 +748,7 @@ export class BrowserCacheManager extends CacheManager {
         const parsedAccessToken = this.validateAndParseJson(value);
         if (
             !parsedAccessToken ||
-            !AccessTokenEntity.isAccessTokenEntity(parsedAccessToken)
+            !CacheHelpers.isAccessTokenEntity(parsedAccessToken)
         ) {
             this.logger.trace(
                 "BrowserCacheManager.getAccessTokenCredential: called, no cache hit"
@@ -771,10 +760,7 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.getAccessTokenCredential: cache hit"
         );
-        return CacheManager.toObject(
-            new AccessTokenEntity(),
-            parsedAccessToken
-        );
+        return parsedAccessToken as AccessTokenEntity;
     }
 
     /**
@@ -785,7 +771,7 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.setAccessTokenCredential called"
         );
-        const accessTokenKey = accessToken.generateCredentialKey();
+        const accessTokenKey = CacheHelpers.generateCredentialKey(accessToken);
         this.setItem(accessTokenKey, JSON.stringify(accessToken));
 
         this.addTokenKey(accessTokenKey, CredentialType.ACCESS_TOKEN);
@@ -809,7 +795,7 @@ export class BrowserCacheManager extends CacheManager {
         const parsedRefreshToken = this.validateAndParseJson(value);
         if (
             !parsedRefreshToken ||
-            !RefreshTokenEntity.isRefreshTokenEntity(parsedRefreshToken)
+            !CacheHelpers.isRefreshTokenEntity(parsedRefreshToken)
         ) {
             this.logger.trace(
                 "BrowserCacheManager.getRefreshTokenCredential: called, no cache hit"
@@ -821,10 +807,7 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.getRefreshTokenCredential: cache hit"
         );
-        return CacheManager.toObject(
-            new RefreshTokenEntity(),
-            parsedRefreshToken
-        );
+        return parsedRefreshToken as RefreshTokenEntity;
     }
 
     /**
@@ -835,7 +818,8 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.setRefreshTokenCredential called"
         );
-        const refreshTokenKey = refreshToken.generateCredentialKey();
+        const refreshTokenKey =
+            CacheHelpers.generateCredentialKey(refreshToken);
         this.setItem(refreshTokenKey, JSON.stringify(refreshToken));
 
         this.addTokenKey(refreshTokenKey, CredentialType.REFRESH_TOKEN);
@@ -1028,10 +1012,9 @@ export class BrowserCacheManager extends CacheManager {
                 );
                 return null;
             }
-            const activeAccount =
-                this.getAccountInfoByFilter({
-                    localAccountId: activeAccountValueLocal,
-                })[0] || null;
+            const activeAccount = this.getAccountInfoFilteredBy({
+                localAccountId: activeAccountValueLocal,
+            });
             if (activeAccount) {
                 this.logger.trace(
                     "BrowserCacheManager.getActiveAccount: Legacy active account cache schema found"
@@ -1051,12 +1034,10 @@ export class BrowserCacheManager extends CacheManager {
             this.logger.trace(
                 "BrowserCacheManager.getActiveAccount: Active account filters schema found"
             );
-            return (
-                this.getAccountInfoByFilter({
-                    homeAccountId: activeAccountValueObj.homeAccountId,
-                    localAccountId: activeAccountValueObj.localAccountId,
-                })[0] || null
-            );
+            return this.getAccountInfoFilteredBy({
+                homeAccountId: activeAccountValueObj.homeAccountId,
+                localAccountId: activeAccountValueObj.localAccountId,
+            });
         }
         this.logger.trace(
             "BrowserCacheManager.getActiveAccount: No active account found"
@@ -1098,94 +1079,6 @@ export class BrowserCacheManager extends CacheManager {
         }
     }
 
-    /**
-     * Gets a list of accounts that match all of the filters provided
-     * @param account
-     */
-    getAccountInfoByFilter(
-        accountFilter: Partial<Omit<AccountInfo, "idTokenClaims" | "name">>
-    ): AccountInfo[] {
-        const allAccounts = this.getAllAccounts();
-        this.logger.trace(
-            `BrowserCacheManager.getAccountInfoByFilter: total ${allAccounts.length} accounts found`
-        );
-
-        return allAccounts.filter((accountObj) => {
-            if (
-                accountFilter.username &&
-                accountFilter.username.toLowerCase() !==
-                    accountObj.username.toLowerCase()
-            ) {
-                return false;
-            }
-
-            if (
-                accountFilter.homeAccountId &&
-                accountFilter.homeAccountId !== accountObj.homeAccountId
-            ) {
-                return false;
-            }
-
-            if (
-                accountFilter.localAccountId &&
-                accountFilter.localAccountId !== accountObj.localAccountId
-            ) {
-                return false;
-            }
-
-            if (
-                accountFilter.tenantId &&
-                accountFilter.tenantId !== accountObj.tenantId
-            ) {
-                return false;
-            }
-
-            if (
-                accountFilter.environment &&
-                accountFilter.environment !== accountObj.environment
-            ) {
-                return false;
-            }
-
-            return true;
-        });
-    }
-
-    /**
-     * Checks the cache for accounts matching loginHint or SID
-     * @param loginHint
-     * @param sid
-     */
-    getAccountInfoByHints(
-        loginHint?: string,
-        sid?: string
-    ): AccountInfo | null {
-        const matchingAccounts = this.getAllAccounts().filter((accountInfo) => {
-            if (sid) {
-                const accountSid =
-                    accountInfo.idTokenClaims &&
-                    accountInfo.idTokenClaims["sid"];
-                return sid === accountSid;
-            }
-
-            if (loginHint) {
-                return loginHint === accountInfo.username;
-            }
-
-            return false;
-        });
-
-        if (matchingAccounts.length === 1) {
-            return matchingAccounts[0];
-        } else if (matchingAccounts.length > 1) {
-            throw createClientAuthError(
-                ClientAuthErrorCodes.multipleMatchingAccounts
-            );
-        }
-
-        return null;
-    }
-
     /**
      * fetch throttling entity from the platform cache
      * @param throttlingCacheKey
@@ -1893,7 +1786,7 @@ export class BrowserCacheManager extends CacheManager {
         currentCacheKey: string,
         credential: ValidCredentialType
     ): string {
-        const updatedCacheKey = credential.generateCredentialKey();
+        const updatedCacheKey = CacheHelpers.generateCredentialKey(credential);
 
         if (currentCacheKey !== updatedCacheKey) {
             const cacheItem = this.getItem(currentCacheKey);
@@ -1949,7 +1842,7 @@ export class BrowserCacheManager extends CacheManager {
             | RedirectRequest
             | PopupRequest
     ): Promise<void> {
-        const idTokenEntity = IdTokenEntity.createIdTokenEntity(
+        const idTokenEntity = CacheHelpers.createIdTokenEntity(
             result.account?.homeAccountId,
             result.account?.environment,
             result.idToken,
@@ -1961,7 +1854,7 @@ export class BrowserCacheManager extends CacheManager {
         if (request.claims) {
             claimsHash = await this.cryptoImpl.hashString(request.claims);
         }
-        const accessTokenEntity = AccessTokenEntity.createAccessTokenEntity(
+        const accessTokenEntity = CacheHelpers.createAccessTokenEntity(
             result.account?.homeAccountId,
             result.account.environment,
             result.accessToken,
@@ -1970,7 +1863,7 @@ export class BrowserCacheManager extends CacheManager {
             result.scopes.join(" "),
             result.expiresOn?.getTime() || 0,
             result.extExpiresOn?.getTime() || 0,
-            this.cryptoImpl,
+            base64Decode,
             undefined, // refreshOn
             result.tokenType as AuthenticationScheme,
             undefined, // userAssertionHash

package/src/cache/TokenCache.ts

@@ -18,6 +18,7 @@ import {
     Constants,
     CacheRecord,
     TokenClaims,
+    CacheHelpers,
 } from "@azure/msal-common";
 import { BrowserConfiguration } from "../config/Configuration";
 import { SilentRequest } from "../request/SilentRequest";
@@ -294,7 +295,7 @@ export class TokenCache implements ITokenCache {
         environment: string,
         tenantId: string
     ): IdTokenEntity {
-        const idTokenEntity = IdTokenEntity.createIdTokenEntity(
+        const idTokenEntity = CacheHelpers.createIdTokenEntity(
             homeAccountId,
             environment,
             idToken,
@@ -355,7 +356,7 @@ export class TokenCache implements ITokenCache {
             response.expires_in + new Date().getTime() / 1000;
         const extendedExpiresOn = options.extendedExpiresOn;
 
-        const accessTokenEntity = AccessTokenEntity.createAccessTokenEntity(
+        const accessTokenEntity = CacheHelpers.createAccessTokenEntity(
             homeAccountId,
             environment,
             response.access_token,
@@ -364,7 +365,7 @@ export class TokenCache implements ITokenCache {
             scopes,
             expiresOn,
             extendedExpiresOn,
-            this.cryptoObj
+            base64Decode
         );
 
         if (this.isBrowserEnvironment) {
@@ -399,7 +400,7 @@ export class TokenCache implements ITokenCache {
             return null;
         }
 
-        const refreshTokenEntity = RefreshTokenEntity.createRefreshTokenEntity(
+        const refreshTokenEntity = CacheHelpers.createRefreshTokenEntity(
             homeAccountId,
             environment,
             response.refresh_token,

package/src/config/Configuration.ts

@@ -93,6 +93,10 @@ export type BrowserAuthOptions = {
      * Flag of whether to use the local metadata cache
      */
     skipAuthorityMetadataCache?: boolean;
+    /**
+     * App supports nested app auth or not; defaults to false
+     */
+    supportsNestedAppAuth?: boolean;
 };
 
 /** @internal */
@@ -273,6 +277,7 @@ export function buildConfiguration(
             tenant: Constants.EMPTY_STRING,
         },
         skipAuthorityMetadataCache: false,
+        supportsNestedAppAuth: false,
     };
 
     // Default cache options for browser

package/src/controllers/ControllerFactory.ts

@@ -6,50 +6,42 @@
 import { TeamsAppOperatingContext } from "../operatingcontext/TeamsAppOperatingContext";
 import { StandardOperatingContext } from "../operatingcontext/StandardOperatingContext";
 import { IController } from "./IController";
-import { Logger } from "@azure/msal-common";
 import { Configuration } from "../config/Configuration";
-import { version, name } from "../packageMetadata";
-
-export class ControllerFactory {
-    protected config: Configuration;
-    protected logger: Logger;
-
-    constructor(config: Configuration) {
-        this.config = config;
-        const loggerOptions = {
-            loggerCallback: undefined,
-            piiLoggingEnabled: false,
-            logLevel: undefined,
-            correlationId: undefined,
-        };
-        this.logger = new Logger(loggerOptions, name, version);
-    }
 
-    async createController(): Promise<IController> {
-        const standard = new StandardOperatingContext(this.config);
-        const metaOS = new TeamsAppOperatingContext(this.config);
-
-        const operatingContexts = [standard.initialize(), metaOS.initialize()];
-
-        return Promise.all(operatingContexts).then(async () => {
-            if (metaOS.isAvailable()) {
-                /*
-                 * pull down metaos module
-                 * create associated controller
-                 */
-                // return await StandardController.createController(standard);
-                const controller = await import("./StandardController");
-                return await controller.StandardController.createController(
-                    standard
-                );
-            } else if (standard.isAvailable()) {
-                const controller = await import("./StandardController");
-                return await controller.StandardController.createController(
-                    standard
-                );
-            }
-
-            throw new Error("No controller found.");
-        });
+export async function createV3Controller(
+    config: Configuration
+): Promise<IController> {
+    const standard = new StandardOperatingContext(config);
+
+    await standard.initialize();
+
+    const controller = await import("./StandardController");
+    return await controller.StandardController.createController(standard);
+}
+
+export async function createController(
+    config: Configuration
+): Promise<IController | null> {
+    const standard = new StandardOperatingContext(config);
+    const teamsApp = new TeamsAppOperatingContext(config);
+
+    const operatingContexts = [standard.initialize(), teamsApp.initialize()];
+
+    await Promise.all(operatingContexts);
+
+    if (
+        teamsApp.isAvailable() &&
+        teamsApp.getConfig().auth.supportsNestedAppAuth
+    ) {
+        const controller = await import("./NestedAppAuthController");
+        return await controller.NestedAppAuthController.createController(
+            teamsApp
+        );
+    } else if (standard.isAvailable()) {
+        const controller = await import("./StandardController");
+        return await controller.StandardController.createController(standard);
+    } else {
+        // Since neither of the actual operating contexts are available keep the UnknownOperatingContextController
+        return null;
     }
 }

package/src/controllers/IController.ts

@@ -8,7 +8,6 @@ import {
     Logger,
     PerformanceCallbackFunction,
     IPerformanceClient,
-    CommonSilentFlowRequest,
     AccountFilter,
 } from "@azure/msal-common";
 import { RedirectRequest } from "../request/RedirectRequest";
@@ -48,11 +47,6 @@ export interface IController {
         accountId?: string
     ): Promise<AuthenticationResult>;
 
-    acquireTokenByRefreshToken(
-        commonRequest: CommonSilentFlowRequest,
-        silentRequest: SilentRequest
-    ): Promise<AuthenticationResult>;
-
     addEventCallback(callback: EventCallbackFunction): string | null;
 
     removeEventCallback(callbackId: string): void;