@azure/msal-browser 3.1.0 → 3.3.0

package/src/broker/nativeBroker/NativeMessageHandler.ts

@@ -10,22 +10,24 @@ import {
 import {
     Logger,
     AuthError,
+    createAuthError,
+    AuthErrorCodes,
     AuthenticationScheme,
     InProgressPerformanceEvent,
     PerformanceEvents,
     IPerformanceClient,
-    ICrypto,
 } from "@azure/msal-common";
 import {
     NativeExtensionRequest,
     NativeExtensionRequestBody,
 } from "./NativeRequest";
-import { NativeAuthError } from "../../error/NativeAuthError";
+import { createNativeAuthError } from "../../error/NativeAuthError";
 import {
     createBrowserAuthError,
     BrowserAuthErrorCodes,
 } from "../../error/BrowserAuthError";
 import { BrowserConfiguration } from "../../config/Configuration";
+import { createNewGuid } from "../../crypto/BrowserCrypto";
 
 type ResponseResolvers<T> = {
     resolve: (value: T | PromiseLike<T>) => void;
@@ -38,7 +40,6 @@ export class NativeMessageHandler {
     private extensionId: string | undefined;
     private extensionVersion: string | undefined;
     private logger: Logger;
-    private crypto: ICrypto;
     private readonly handshakeTimeoutMs: number;
     private timeoutId: number | undefined;
     private resolvers: Map<string, ResponseResolvers<object>>;
@@ -52,7 +53,6 @@ export class NativeMessageHandler {
         logger: Logger,
         handshakeTimeoutMs: number,
         performanceClient: IPerformanceClient,
-        crypto: ICrypto,
         extensionId?: string
     ) {
         this.logger = logger;
@@ -66,7 +66,6 @@ export class NativeMessageHandler {
         this.handshakeEvent = performanceClient.startMeasurement(
             PerformanceEvents.NativeMessageHandlerHandshake
         );
-        this.crypto = crypto;
     }
 
     /**
@@ -78,7 +77,7 @@ export class NativeMessageHandler {
         const req: NativeExtensionRequest = {
             channel: NativeConstants.CHANNEL_ID,
             extensionId: this.extensionId,
-            responseId: this.crypto.createNewGuid(),
+            responseId: createNewGuid(),
             body: body,
         };
 
@@ -107,8 +106,7 @@ export class NativeMessageHandler {
     static async createProvider(
         logger: Logger,
         handshakeTimeoutMs: number,
-        performanceClient: IPerformanceClient,
-        crypto: ICrypto
+        performanceClient: IPerformanceClient
     ): Promise<NativeMessageHandler> {
         logger.trace("NativeMessageHandler - createProvider called.");
         try {
@@ -116,7 +114,6 @@ export class NativeMessageHandler {
                 logger,
                 handshakeTimeoutMs,
                 performanceClient,
-                crypto,
                 NativeConstants.PREFERRED_EXTENSION_ID
             );
             await preferredProvider.sendHandshakeRequest();
@@ -126,8 +123,7 @@ export class NativeMessageHandler {
             const backupProvider = new NativeMessageHandler(
                 logger,
                 handshakeTimeoutMs,
-                performanceClient,
-                crypto
+                performanceClient
             );
             await backupProvider.sendHandshakeRequest();
             return backupProvider;
@@ -147,7 +143,7 @@ export class NativeMessageHandler {
         const req: NativeExtensionRequest = {
             channel: NativeConstants.CHANNEL_ID,
             extensionId: this.extensionId,
-            responseId: this.crypto.createNewGuid(),
+            responseId: createNewGuid(),
             body: {
                 method: NativeExtensionMethod.HandshakeRequest,
             },
@@ -283,7 +279,7 @@ export class NativeMessageHandler {
                 );
                 if (response.status !== "Success") {
                     resolver.reject(
-                        NativeAuthError.createError(
+                        createNativeAuthError(
                             response.code,
                             response.description,
                             response.ext
@@ -295,7 +291,7 @@ export class NativeMessageHandler {
                         response.result["description"]
                     ) {
                         resolver.reject(
-                            NativeAuthError.createError(
+                            createNativeAuthError(
                                 response.result["code"],
                                 response.result["description"],
                                 response.result["ext"]
@@ -305,7 +301,8 @@ export class NativeMessageHandler {
                         resolver.resolve(response.result);
                     }
                 } else {
-                    throw AuthError.createUnexpectedError(
+                    throw createAuthError(
+                        AuthErrorCodes.unexpectedError,
                         "Event does not contain result."
                     );
                 }

package/src/broker/nativeBroker/NativeStatusCodes.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+// Status Codes that can be thrown by WAM
+export const USER_INTERACTION_REQUIRED = "USER_INTERACTION_REQUIRED";
+export const USER_CANCEL = "USER_CANCEL";
+export const NO_NETWORK = "NO_NETWORK";
+export const TRANSIENT_ERROR = "TRANSIENT_ERROR";
+export const PERSISTENT_ERROR = "PERSISTENT_ERROR";
+export const DISABLED = "DISABLED";
+export const ACCOUNT_UNAVAILABLE = "ACCOUNT_UNAVAILABLE";

package/src/cache/BrowserCacheManager.ts

@@ -27,11 +27,15 @@ import {
     CcsCredentialType,
     AuthToken,
     ValidCredentialType,
-    ClientAuthError,
     TokenKeys,
     CredentialType,
     CacheRecord,
     AuthenticationScheme,
+    createClientAuthError,
+    ClientAuthErrorCodes,
+    PerformanceEvents,
+    IPerformanceClient,
+    StaticAuthorityOptions,
 } from "@azure/msal-common";
 import { CacheOptions } from "../config/Configuration";
 import {
@@ -82,9 +86,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();
@@ -614,7 +619,9 @@ export class BrowserCacheManager extends CacheManager {
                 this.logger.error(
                     `BrowserCacheManager:addTokenKey - CredentialType provided invalid. CredentialType: ${type}`
                 );
-                ClientAuthError.createUnexpectedCredentialTypeError();
+                throw createClientAuthError(
+                    ClientAuthErrorCodes.unexpectedCredentialType
+                );
         }
 
         this.setItem(
@@ -685,7 +692,9 @@ export class BrowserCacheManager extends CacheManager {
                 this.logger.error(
                     `BrowserCacheManager:removeTokenKey - CredentialType provided invalid. CredentialType: ${type}`
                 );
-                ClientAuthError.createUnexpectedCredentialTypeError();
+                throw createClientAuthError(
+                    ClientAuthErrorCodes.unexpectedCredentialType
+                );
         }
 
         this.setItem(
@@ -1021,10 +1030,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"
@@ -1044,12 +1052,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"
@@ -1091,92 +1097,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 ClientAuthError.createMultipleMatchingAccountsInCacheError();
-        }
-
-        return null;
-    }
-
     /**
      * fetch throttling entity from the platform cache
      * @param throttlingCacheKey
@@ -1353,10 +1273,16 @@ export class BrowserCacheManager extends CacheManager {
 
     /**
      * Clears all access tokes that have claims prior to saving the current one
-     * @param credential
+     * @param performanceClient {IPerformanceClient}
      * @returns
      */
-    async clearTokensAndKeysWithClaims(): Promise<void> {
+    async clearTokensAndKeysWithClaims(
+        performanceClient: IPerformanceClient
+    ): Promise<void> {
+        performanceClient.addQueueMeasurement(
+            PerformanceEvents.ClearTokensAndKeysWithClaims
+        );
+
         const tokenKeys = this.getTokenKeys();
 
         const removedAccessTokens: Array<Promise<void>> = [];

package/src/cache/BrowserStorage.ts

@@ -3,7 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { BrowserConfigurationAuthError } from "../error/BrowserConfigurationAuthError";
+import {
+    BrowserConfigurationAuthErrorCodes,
+    createBrowserConfigurationAuthError,
+} from "../error/BrowserConfigurationAuthError";
 import { BrowserCacheLocation } from "../utils/BrowserConstants";
 import { IWindowStorage } from "./IWindowStorage";
 
@@ -17,17 +20,12 @@ export class BrowserStorage implements IWindowStorage<string> {
 
     private validateWindowStorage(cacheLocation: string): void {
         if (
-            cacheLocation !== BrowserCacheLocation.LocalStorage &&
-            cacheLocation !== BrowserCacheLocation.SessionStorage
+            (cacheLocation !== BrowserCacheLocation.LocalStorage &&
+                cacheLocation !== BrowserCacheLocation.SessionStorage) ||
+            !window[cacheLocation]
         ) {
-            throw BrowserConfigurationAuthError.createStorageNotSupportedError(
-                cacheLocation
-            );
-        }
-        const storageSupported = !!window[cacheLocation];
-        if (!storageSupported) {
-            throw BrowserConfigurationAuthError.createStorageNotSupportedError(
-                cacheLocation
+            throw createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.storageNotSupported
             );
         }
     }

package/src/config/Configuration.ts

@@ -17,9 +17,11 @@ import {
     AzureCloudInstance,
     AzureCloudOptions,
     ApplicationTelemetry,
-    ClientConfigurationError,
+    createClientConfigurationError,
+    ClientConfigurationErrorCodes,
     IPerformanceClient,
     StubPerformanceClient,
+    Logger,
 } from "@azure/msal-common";
 import {
     BrowserCacheLocation,
@@ -91,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 */
@@ -271,6 +277,7 @@ export function buildConfiguration(
             tenant: Constants.EMPTY_STRING,
         },
         skipAuthorityMetadataCache: false,
+        supportsNestedAppAuth: false,
     };
 
     // Default cache options for browser
@@ -323,7 +330,8 @@ export function buildConfiguration(
         pollIntervalMilliseconds: BrowserConstants.DEFAULT_POLL_INTERVAL_MS,
     };
 
-    const providedSystemOptions: BrowserSystemOptions = {
+    const providedSystemOptions: Required<BrowserSystemOptions> = {
+        ...DEFAULT_BROWSER_SYSTEM_OPTIONS,
         ...userInputSystem,
         loggerOptions: userInputSystem?.loggerOptions || DEFAULT_LOGGER_OPTIONS,
     };
@@ -341,10 +349,13 @@ export function buildConfiguration(
         userInputAuth?.protocolMode !== ProtocolMode.OIDC &&
         userInputAuth?.OIDCOptions
     ) {
-        // Logger has not been created yet
-        // eslint-disable-next-line no-console
-        console.warn(
-            ClientConfigurationError.createCannotSetOIDCOptionsError()
+        const logger = new Logger(providedSystemOptions.loggerOptions);
+        logger.warning(
+            JSON.stringify(
+                createClientConfigurationError(
+                    ClientConfigurationErrorCodes.cannotSetOIDCOptions
+                )
+            )
         );
     }
 
@@ -354,7 +365,9 @@ export function buildConfiguration(
         userInputAuth.protocolMode !== ProtocolMode.AAD &&
         providedSystemOptions?.allowNativeBroker
     ) {
-        throw ClientConfigurationError.createCannotAllowNativeBrokerError();
+        throw createClientConfigurationError(
+            ClientConfigurationErrorCodes.cannotAllowNativeBroker
+        );
     }
 
     const overlayedConfig: BrowserConfiguration = {
@@ -367,7 +380,7 @@ export function buildConfiguration(
             },
         },
         cache: { ...DEFAULT_CACHE_OPTIONS, ...userInputCache },
-        system: { ...DEFAULT_BROWSER_SYSTEM_OPTIONS, ...providedSystemOptions },
+        system: providedSystemOptions,
         telemetry: { ...DEFAULT_TELEMETRY_OPTIONS, ...userInputTelemetry },
     };
 

package/src/controllers/ControllerFactory.ts

@@ -25,31 +25,42 @@ export class ControllerFactory {
         this.logger = new Logger(loggerOptions, name, version);
     }
 
-    async createController(): Promise<IController> {
+    async createV3Controller(): 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.");
-        });
+
+        await standard.initialize();
+
+        const controller = await import("./StandardController");
+        return await controller.StandardController.createController(standard);
+    }
+
+    async createController(): Promise<IController | null> {
+        const standard = new StandardOperatingContext(this.config);
+        const teamsApp = new TeamsAppOperatingContext(this.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

@@ -9,6 +9,7 @@ import {
     PerformanceCallbackFunction,
     IPerformanceClient,
     CommonSilentFlowRequest,
+    AccountFilter,
 } from "@azure/msal-common";
 import { RedirectRequest } from "../request/RedirectRequest";
 import { PopupRequest } from "../request/PopupRequest";
@@ -64,13 +65,15 @@ export interface IController {
 
     disableAccountStorageEvents(): void;
 
+    getAccount(accountFilter: AccountFilter): AccountInfo | null;
+
     getAccountByHomeId(homeAccountId: string): AccountInfo | null;
 
     getAccountByLocalId(localId: string): AccountInfo | null;
 
     getAccountByUsername(userName: string): AccountInfo | null;
 
-    getAllAccounts(): AccountInfo[];
+    getAllAccounts(accountFilter?: AccountFilter): AccountInfo[];
 
     handleRedirectPromise(hash?: string): Promise<AuthenticationResult | null>;