@azure/msal-common 15.13.0 → 15.13.2

package/src/cache/interface/ICacheManager.ts

@@ -26,8 +26,14 @@ export interface ICacheManager {
     /**
      * set account entity in the platform cache
      * @param account
+     * @param correlationId
+     * @param kmsi
      */
-    setAccount(account: AccountEntity, correlationId: string): Promise<void>;
+    setAccount(
+        account: AccountEntity,
+        correlationId: string,
+        kmsi: boolean
+    ): Promise<void>;
 
     /**
      * fetch the idToken entity from the platform cache
@@ -41,10 +47,13 @@ export interface ICacheManager {
     /**
      * set idToken entity to the platform cache
      * @param idToken
+     * @param correlationId
+     * @param kmsi
      */
     setIdTokenCredential(
         idToken: IdTokenEntity,
-        correlationId: string
+        correlationId: string,
+        kmsi: boolean
     ): Promise<void>;
 
     /**
@@ -59,10 +68,13 @@ export interface ICacheManager {
     /**
      * set idToken entity to the platform cache
      * @param accessToken
+     * @param correlationId
+     * @param kmsi
      */
     setAccessTokenCredential(
         accessToken: AccessTokenEntity,
-        correlationId: string
+        correlationId: string,
+        kmsi: boolean
     ): Promise<void>;
 
     /**
@@ -77,10 +89,13 @@ export interface ICacheManager {
     /**
      * set idToken entity to the platform cache
      * @param refreshToken
+     * @param correlationId
+     * @param kmsi
      */
     setRefreshTokenCredential(
         refreshToken: RefreshTokenEntity,
-        correlationId: string
+        correlationId: string,
+        kmsi: boolean
     ): Promise<void>;
 
     /**
@@ -172,10 +187,14 @@ export interface ICacheManager {
     /**
      * saves a cache record
      * @param cacheRecord
+     * @param correlationId
+     * @param kmsi
+     * @param storeInCache
      */
     saveCacheRecord(
         cacheRecord: CacheRecord,
         correlationId: string,
+        kmsi: boolean,
         storeInCache?: StoreInCache
     ): Promise<void>;
 

package/src/error/AuthError.ts

@@ -5,6 +5,7 @@
 
 import { Constants } from "../utils/Constants.js";
 import * as AuthErrorCodes from "./AuthErrorCodes.js";
+import type { PlatformBrokerError } from "./PlatformBrokerError.js";
 export { AuthErrorCodes };
 
 export const AuthErrorMessages = {
@@ -52,6 +53,11 @@ export class AuthError extends Error {
      */
     correlationId: string;
 
+    /**
+     * Default PlatformBrokerError from MsalNodeRuntime when broker is enabled
+     */
+    platformBrokerError?: PlatformBrokerError;
+
     constructor(errorCode?: string, errorMessage?: string, suberror?: string) {
         const errorString = errorMessage
             ? `${errorCode}: ${errorMessage}`

package/src/error/ClientAuthError.ts

@@ -91,6 +91,8 @@ export const ClientAuthErrorMessages = {
         "This method has not been implemented",
     [ClientAuthErrorCodes.nestedAppAuthBridgeDisabled]:
         "The nested app auth bridge is disabled",
+    [ClientAuthErrorCodes.platformBrokerError]:
+        "An error occurred in the native broker. See the platformBrokerError property for details.",
 };
 
 /**
@@ -314,6 +316,10 @@ export const ClientAuthErrorMessage = {
             ClientAuthErrorCodes.nestedAppAuthBridgeDisabled
         ],
     },
+    platformBrokerError: {
+        code: ClientAuthErrorCodes.platformBrokerError,
+        desc: ClientAuthErrorMessages[ClientAuthErrorCodes.platformBrokerError],
+    },
 };
 
 /**

package/src/error/ClientAuthErrorCodes.ts

@@ -50,3 +50,4 @@ export const userCanceled = "user_canceled";
 export const missingTenantIdError = "missing_tenant_id_error";
 export const methodNotImplemented = "method_not_implemented";
 export const nestedAppAuthBridgeDisabled = "nested_app_auth_bridge_disabled";
+export const platformBrokerError = "platform_broker_error";

package/src/error/PlatformBrokerError.ts

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AuthError } from "./AuthError.js";
+
+/**
+ * Converts a numeric tag to a string representation
+ * @param tag - The numeric tag to convert
+ * @returns The string representation of the tag
+ */
+function tagToString(tag: number): string {
+    if (tag === 0) {
+        return "UNTAG";
+    }
+
+    const tagSymbolSpace =
+        "abcdefghijklmnopqrstuvwxyz0123456789****************************";
+    let tagBuffer = "*****";
+
+    const chars = [
+        tagSymbolSpace[(tag >> 24) & 0x3f],
+        tagSymbolSpace[(tag >> 18) & 0x3f],
+        tagSymbolSpace[(tag >> 12) & 0x3f],
+        tagSymbolSpace[(tag >> 6) & 0x3f],
+        tagSymbolSpace[(tag >> 0) & 0x3f],
+    ];
+
+    tagBuffer = chars.join("");
+
+    return tagBuffer;
+}
+
+/**
+ * Error class for MSAL Runtime errors that preserves detailed broker information
+ */
+export class PlatformBrokerError extends AuthError {
+    /**
+     * Numeric error code from MSAL Runtime
+     */
+    public statusCode: number;
+
+    /**
+     * Error tag from MSAL Runtime
+     */
+    public tag: string;
+
+    constructor(
+        errorStatus: string,
+        errorContext: string,
+        errorCode: number,
+        errorTag: number
+    ) {
+        const tagString = tagToString(errorTag);
+        const enhancedErrorContext = errorContext
+            ? `${errorContext} (Error Code: ${errorCode}, Tag: ${tagString})`
+            : `(Error Code: ${errorCode}, Tag: ${tagString})`;
+
+        super(errorStatus, enhancedErrorContext);
+        this.name = "PlatformBrokerError";
+        this.statusCode = errorCode;
+        this.tag = tagString;
+        Object.setPrototypeOf(this, PlatformBrokerError.prototype);
+    }
+}

package/src/exports-common.ts

@@ -140,6 +140,7 @@ export {
     AuthErrorCodes,
     createAuthError,
 } from "./error/AuthError.js";
+export { PlatformBrokerError } from "./error/PlatformBrokerError.js";
 export { ServerError } from "./error/ServerError.js";
 export { NetworkError, createNetworkError } from "./error/NetworkError.js";
 export {

package/src/packageMetadata.ts

@@ -1,3 +1,3 @@
 /* eslint-disable header/header */
 export const name = "@azure/msal-common";
-export const version = "15.13.0";
+export const version = "15.13.2";

package/src/response/ResponseHandler.ts

@@ -40,7 +40,11 @@ import { AuthorizationCodePayload } from "./AuthorizationCodePayload.js";
 import { BaseAuthRequest } from "../request/BaseAuthRequest.js";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient.js";
 import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent.js";
-import { checkMaxAge, extractTokenClaims } from "../account/AuthToken.js";
+import {
+    checkMaxAge,
+    extractTokenClaims,
+    isKmsi,
+} from "../account/AuthToken.js";
 import {
     TokenClaims,
     getTenantIdFromIdTokenClaims,
@@ -279,7 +283,7 @@ export class ResponseHandler {
                 cacheRecord.account
             ) {
                 const key = this.cacheStorage.generateAccountKey(
-                    cacheRecord.account.getAccountInfo()
+                    AccountEntity.getAccountInfo(cacheRecord.account)
                 );
                 const account = this.cacheStorage.getAccount(
                     key,
@@ -305,6 +309,7 @@ export class ResponseHandler {
             await this.cacheStorage.saveCacheRecord(
                 cacheRecord,
                 request.correlationId,
+                isKmsi(idTokenClaims || {}),
                 request.storeInCache
             );
         } finally {
@@ -572,7 +577,7 @@ export class ResponseHandler {
 
         const accountInfo: AccountInfo | null = cacheRecord.account
             ? updateAccountTenantProfileData(
-                  cacheRecord.account.getAccountInfo(),
+                  AccountEntity.getAccountInfo(cacheRecord.account),
                   undefined, // tenantProfile optional
                   idTokenClaims,
                   cacheRecord.idToken?.secret