@azure/msal-common 14.5.0 → 14.6.0

package/dist/utils/TimeUtils.mjs

@@ -1,4 +1,4 @@
-/*! @azure/msal-common v14.5.0 2023-12-01 */
+/*! @azure/msal-common v14.6.0 2024-01-09 */
 'use strict';
 /*
  * Copyright (c) Microsoft Corporation. All rights reserved.

package/dist/utils/UrlUtils.mjs

@@ -1,4 +1,4 @@
-/*! @azure/msal-common v14.5.0 2023-12-01 */
+/*! @azure/msal-common v14.6.0 2024-01-09 */
 'use strict';
 import { createClientAuthError } from '../error/ClientAuthError.mjs';
 import { hashNotDeserialized } from '../error/ClientAuthErrorCodes.mjs';

package/package.json

@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/AzureAD/microsoft-authentication-library-for-js.git"
   },
-  "version": "14.5.0",
+  "version": "14.6.0",
   "description": "Microsoft Authentication Library for js",
   "keywords": [
     "implicit",

package/src/authority/Authority.ts

@@ -57,6 +57,7 @@ import { AuthError } from "../error/AuthError";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
 import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
 import { invokeAsync } from "../utils/FunctionWrappers";
+import * as CacheHelpers from "../cache/utils/CacheHelpers";
 
 /**
  * The authority class validates the authority URIs used by the user, and retrieves the OpenID Configuration Data from the
@@ -429,13 +430,24 @@ export class Authority {
      * @returns
      */
     private getCurrentMetadataEntity(): AuthorityMetadataEntity {
-        let metadataEntity = this.cacheManager.getAuthorityMetadataByAlias(
-            this.hostnameAndPort
-        );
+        let metadataEntity: AuthorityMetadataEntity | null =
+            this.cacheManager.getAuthorityMetadataByAlias(this.hostnameAndPort);
 
         if (!metadataEntity) {
-            metadataEntity = new AuthorityMetadataEntity();
-            metadataEntity.updateCanonicalAuthority(this.canonicalAuthority);
+            metadataEntity = {
+                aliases: [],
+                preferred_cache: this.hostnameAndPort,
+                preferred_network: this.hostnameAndPort,
+                canonical_authority: this.canonicalAuthority,
+                authorization_endpoint: "",
+                token_endpoint: "",
+                end_session_endpoint: "",
+                issuer: "",
+                aliasesFromNetwork: false,
+                endpointsFromNetwork: false,
+                expiresAt: CacheHelpers.generateAuthorityMetadataExpiresAt(),
+                jwks_uri: "",
+            };
         }
         return metadataEntity;
     }
@@ -460,8 +472,9 @@ export class Authority {
             endpointMetadataResult?.source !== AuthorityMetadataSource.CACHE
         ) {
             // Reset the expiration time unless both values came from a successful cache lookup
-            metadataEntity.resetExpiresAt();
-            metadataEntity.updateCanonicalAuthority(this.canonicalAuthority);
+            metadataEntity.expiresAt =
+                CacheHelpers.generateAuthorityMetadataExpiresAt();
+            metadataEntity.canonical_authority = this.canonicalAuthority;
         }
 
         const cacheKey = this.cacheManager.generateAuthorityMetadataCacheKey(
@@ -506,10 +519,13 @@ export class Authority {
                             this.performanceClient,
                             this.correlationId
                         )(localMetadata.metadata);
-                        metadataEntity.updateEndpointMetadata(
+                        CacheHelpers.updateAuthorityEndpointMetadata(
+                            metadataEntity,
                             hardcodedMetadata,
                             false
                         );
+                        metadataEntity.canonical_authority =
+                            this.canonicalAuthority;
                     }
                 }
             }
@@ -536,7 +552,11 @@ export class Authority {
                 )(metadata);
             }
 
-            metadataEntity.updateEndpointMetadata(metadata, true);
+            CacheHelpers.updateAuthorityEndpointMetadata(
+                metadataEntity,
+                metadata,
+                true
+            );
             return AuthorityMetadataSource.NETWORK;
         } else {
             // Metadata could not be obtained from the config, cache, network or hardcoded values
@@ -567,7 +587,11 @@ export class Authority {
             this.logger.verbose(
                 "Found endpoint metadata in authority configuration"
             );
-            metadataEntity.updateEndpointMetadata(configMetadata, false);
+            CacheHelpers.updateAuthorityEndpointMetadata(
+                metadataEntity,
+                configMetadata,
+                false
+            );
             return {
                 source: AuthorityMetadataSource.CONFIG,
             };
@@ -586,7 +610,11 @@ export class Authority {
             const hardcodedMetadata =
                 this.getEndpointMetadataFromHardcodedValues();
             if (hardcodedMetadata) {
-                metadataEntity.updateEndpointMetadata(hardcodedMetadata, false);
+                CacheHelpers.updateAuthorityEndpointMetadata(
+                    metadataEntity,
+                    hardcodedMetadata,
+                    false
+                );
                 return {
                     source: AuthorityMetadataSource.HARDCODED_VALUES,
                     metadata: hardcodedMetadata,
@@ -599,7 +627,8 @@ export class Authority {
         }
 
         // Check cached metadata entity expiration status
-        const metadataEntityExpired = metadataEntity.isExpired();
+        const metadataEntityExpired =
+            CacheHelpers.isAuthorityMetadataExpired(metadataEntity);
         if (
             this.isAuthoritySameType(metadataEntity) &&
             metadataEntity.endpointsFromNetwork &&
@@ -801,7 +830,11 @@ export class Authority {
         )();
 
         if (metadata) {
-            metadataEntity.updateCloudDiscoveryMetadata(metadata, true);
+            CacheHelpers.updateCloudDiscoveryMetadata(
+                metadataEntity,
+                metadata,
+                true
+            );
             return AuthorityMetadataSource.NETWORK;
         }
 
@@ -839,7 +872,11 @@ export class Authority {
             this.logger.verbose(
                 "Found cloud discovery metadata in authority configuration"
             );
-            metadataEntity.updateCloudDiscoveryMetadata(metadata, false);
+            CacheHelpers.updateCloudDiscoveryMetadata(
+                metadataEntity,
+                metadata,
+                false
+            );
             return AuthorityMetadataSource.CONFIG;
         }
 
@@ -861,7 +898,8 @@ export class Authority {
                 this.logger.verbose(
                     "Found cloud discovery metadata from hardcoded values."
                 );
-                metadataEntity.updateCloudDiscoveryMetadata(
+                CacheHelpers.updateCloudDiscoveryMetadata(
+                    metadataEntity,
                     hardcodedMetadata,
                     false
                 );
@@ -873,7 +911,8 @@ export class Authority {
             );
         }
 
-        const metadataEntityExpired = metadataEntity.isExpired();
+        const metadataEntityExpired =
+            CacheHelpers.isAuthorityMetadataExpired(metadataEntity);
         if (
             this.isAuthoritySameType(metadataEntity) &&
             metadataEntity.aliasesFromNetwork &&

package/src/cache/CacheManager.ts

@@ -49,7 +49,6 @@ import { BaseAuthRequest } from "../request/BaseAuthRequest";
 import { Logger } from "../logger/Logger";
 import { name, version } from "../packageMetadata";
 import { StoreInCache } from "../request/StoreInCache";
-import { getTenantFromAuthorityString } from "../authority/Authority";
 import { getAliasesFromStaticSources } from "../authority/AuthorityMetadata";
 import { StaticAuthorityOptions } from "../authority/AuthorityOptions";
 import { TokenClaims } from "../account/TokenClaims";
@@ -1128,59 +1127,6 @@ export abstract class CacheManager implements ICacheManager {
         return true;
     }
 
-    /**
-     * Retrieve the cached credentials into a cacherecord
-     * @param account {AccountInfo}
-     * @param request {BaseAuthRequest}
-     * @param environment {string}
-     * @param performanceClient {?IPerformanceClient}
-     * @param correlationId {?string}
-     */
-    readCacheRecord(
-        account: AccountInfo,
-        request: BaseAuthRequest,
-        environment: string,
-        performanceClient?: IPerformanceClient,
-        correlationId?: string
-    ): CacheRecord {
-        // Use authority tenantId for cache lookup filter if it's defined, otherwise use tenantId from account passed in
-        const requestTenantId =
-            account.tenantId || getTenantFromAuthorityString(request.authority);
-        const tokenKeys = this.getTokenKeys();
-        const cachedAccount = this.readAccountFromCache(account);
-        const cachedIdToken = this.getIdToken(
-            account,
-            tokenKeys,
-            requestTenantId,
-            performanceClient,
-            correlationId
-        );
-        const cachedAccessToken = this.getAccessToken(
-            account,
-            request,
-            tokenKeys,
-            requestTenantId,
-            performanceClient,
-            correlationId
-        );
-        const cachedRefreshToken = this.getRefreshToken(
-            account,
-            false,
-            tokenKeys,
-            performanceClient,
-            correlationId
-        );
-        const cachedAppMetadata = this.readAppMetadataFromCache(environment);
-
-        return {
-            account: cachedAccount,
-            idToken: cachedIdToken,
-            accessToken: cachedAccessToken,
-            refreshToken: cachedRefreshToken,
-            appMetadata: cachedAppMetadata,
-        };
-    }
-
     /**
      * Retrieve AccountEntity from cache
      * @param account

package/src/cache/entities/AppMetadataEntity.ts

@@ -3,89 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import { APP_METADATA, Separators } from "../../utils/Constants";
-
 /**
- * APP_METADATA Cache
- *
- * Key:Value Schema:
- *
- * Key: appmetadata-<environment>-<client_id>
- *
- * Value:
- * {
- *      clientId: client ID of the application
- *      environment: entity that issued the token, represented as a full host
- *      familyId: Family ID identifier, '1' represents Microsoft Family
- * }
+ * App Metadata Cache Type
  */
-export class AppMetadataEntity {
+export type AppMetadataEntity = {
+    /** clientId of the application */
     clientId: string;
+    /** entity that issued the token, represented as a full host */
     environment: string;
+    /** Family identifier, '1' represents Microsoft Family */
     familyId?: string;
-
-    /**
-     * Generate AppMetadata Cache Key as per the schema: appmetadata-<environment>-<client_id>
-     */
-    generateAppMetadataKey(): string {
-        return AppMetadataEntity.generateAppMetadataCacheKey(
-            this.environment,
-            this.clientId
-        );
-    }
-
-    /**
-     * Generate AppMetadata Cache Key
-     */
-    static generateAppMetadataCacheKey(
-        environment: string,
-        clientId: string
-    ): string {
-        const appMetaDataKeyArray: Array<string> = [
-            APP_METADATA,
-            environment,
-            clientId,
-        ];
-        return appMetaDataKeyArray
-            .join(Separators.CACHE_KEY_SEPARATOR)
-            .toLowerCase();
-    }
-
-    /**
-     * Creates AppMetadataEntity
-     * @param clientId
-     * @param environment
-     * @param familyId
-     */
-    static createAppMetadataEntity(
-        clientId: string,
-        environment: string,
-        familyId?: string
-    ): AppMetadataEntity {
-        const appMetadata = new AppMetadataEntity();
-
-        appMetadata.clientId = clientId;
-        appMetadata.environment = environment;
-        if (familyId) {
-            appMetadata.familyId = familyId;
-        }
-
-        return appMetadata;
-    }
-
-    /**
-     * Validates an entity: checks for all expected params
-     * @param entity
-     */
-    static isAppMetadataEntity(key: string, entity: object): boolean {
-        if (!entity) {
-            return false;
-        }
-
-        return (
-            key.indexOf(APP_METADATA) === 0 &&
-            entity.hasOwnProperty("clientId") &&
-            entity.hasOwnProperty("environment")
-        );
-    }
-}
+};

package/src/cache/entities/AuthorityMetadataEntity.ts

@@ -3,13 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { CloudDiscoveryMetadata } from "../../authority/CloudDiscoveryMetadata";
-import { OpenIdConfigResponse } from "../../authority/OpenIdConfigResponse";
-import { AUTHORITY_METADATA_CONSTANTS } from "../../utils/Constants";
-import { TimeUtils } from "../../utils/TimeUtils";
-
 /** @internal */
-export class AuthorityMetadataEntity {
+export type AuthorityMetadataEntity = {
     aliases: Array<string>;
     preferred_cache: string;
     preferred_network: string;
@@ -22,91 +17,4 @@ export class AuthorityMetadataEntity {
     endpointsFromNetwork: boolean;
     expiresAt: number;
     jwks_uri: string;
-
-    constructor() {
-        this.expiresAt =
-            TimeUtils.nowSeconds() +
-            AUTHORITY_METADATA_CONSTANTS.REFRESH_TIME_SECONDS;
-    }
-
-    /**
-     * Update the entity with new aliases, preferred_cache and preferred_network values
-     * @param metadata
-     * @param fromNetwork
-     */
-    updateCloudDiscoveryMetadata(
-        metadata: CloudDiscoveryMetadata,
-        fromNetwork: boolean
-    ): void {
-        this.aliases = metadata.aliases;
-        this.preferred_cache = metadata.preferred_cache;
-        this.preferred_network = metadata.preferred_network;
-        this.aliasesFromNetwork = fromNetwork;
-    }
-
-    /**
-     * Update the entity with new endpoints
-     * @param metadata
-     * @param fromNetwork
-     */
-    updateEndpointMetadata(
-        metadata: OpenIdConfigResponse,
-        fromNetwork: boolean
-    ): void {
-        this.authorization_endpoint = metadata.authorization_endpoint;
-        this.token_endpoint = metadata.token_endpoint;
-        this.end_session_endpoint = metadata.end_session_endpoint;
-        this.issuer = metadata.issuer;
-        this.endpointsFromNetwork = fromNetwork;
-        this.jwks_uri = metadata.jwks_uri;
-    }
-
-    /**
-     * Save the authority that was used to create this cache entry
-     * @param authority
-     */
-    updateCanonicalAuthority(authority: string): void {
-        this.canonical_authority = authority;
-    }
-
-    /**
-     * Reset the exiresAt value
-     */
-    resetExpiresAt(): void {
-        this.expiresAt =
-            TimeUtils.nowSeconds() +
-            AUTHORITY_METADATA_CONSTANTS.REFRESH_TIME_SECONDS;
-    }
-
-    /**
-     * Returns whether or not the data needs to be refreshed
-     */
-    isExpired(): boolean {
-        return this.expiresAt <= TimeUtils.nowSeconds();
-    }
-
-    /**
-     * Validates an entity: checks for all expected params
-     * @param entity
-     */
-    static isAuthorityMetadataEntity(key: string, entity: object): boolean {
-        if (!entity) {
-            return false;
-        }
-
-        return (
-            key.indexOf(AUTHORITY_METADATA_CONSTANTS.CACHE_KEY) === 0 &&
-            entity.hasOwnProperty("aliases") &&
-            entity.hasOwnProperty("preferred_cache") &&
-            entity.hasOwnProperty("preferred_network") &&
-            entity.hasOwnProperty("canonical_authority") &&
-            entity.hasOwnProperty("authorization_endpoint") &&
-            entity.hasOwnProperty("token_endpoint") &&
-            entity.hasOwnProperty("issuer") &&
-            entity.hasOwnProperty("aliasesFromNetwork") &&
-            entity.hasOwnProperty("endpointsFromNetwork") &&
-            entity.hasOwnProperty("expiresAt") &&
-            entity.hasOwnProperty("jwks_uri")
-        );
-    }
-}
+};

package/src/cache/entities/RefreshTokenEntity.ts

@@ -8,4 +8,6 @@ import { CredentialEntity } from "./CredentialEntity";
 /**
  * Refresh Token Cache Type
  */
-export type RefreshTokenEntity = CredentialEntity;
+export type RefreshTokenEntity = CredentialEntity & {
+    expiresOn?: string;
+};

package/src/cache/entities/ThrottlingEntity.ts

@@ -3,9 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ThrottlingConstants } from "../../utils/Constants";
-
-export class ThrottlingEntity {
+export type ThrottlingEntity = {
     // Unix-time value representing the expiration of the throttle
     throttleTime: number;
     // Information provided by the server
@@ -13,24 +11,4 @@ export class ThrottlingEntity {
     errorCodes?: Array<string>;
     errorMessage?: string;
     subError?: string;
-
-    /**
-     * validates if a given cache entry is "Throttling", parses <key,value>
-     * @param key
-     * @param entity
-     */
-    static isThrottlingEntity(key: string, entity?: object): boolean {
-        let validateKey: boolean = false;
-        if (key) {
-            validateKey =
-                key.indexOf(ThrottlingConstants.THROTTLING_PREFIX) === 0;
-        }
-
-        let validateEntity: boolean = true;
-        if (entity) {
-            validateEntity = entity.hasOwnProperty("throttleTime");
-        }
-
-        return validateKey && validateEntity;
-    }
-}
+};

package/src/cache/utils/CacheHelpers.ts

@@ -5,18 +5,25 @@
 
 import { extractTokenClaims } from "../../account/AuthToken";
 import { TokenClaims } from "../../account/TokenClaims";
+import { CloudDiscoveryMetadata } from "../../authority/CloudDiscoveryMetadata";
+import { OpenIdConfigResponse } from "../../authority/OpenIdConfigResponse";
 import {
     ClientAuthErrorCodes,
     createClientAuthError,
 } from "../../error/ClientAuthError";
 import {
+    APP_METADATA,
+    AUTHORITY_METADATA_CONSTANTS,
     AuthenticationScheme,
     CredentialType,
     SERVER_TELEM_CONSTANTS,
     Separators,
+    ThrottlingConstants,
 } from "../../utils/Constants";
 import { TimeUtils } from "../../utils/TimeUtils";
 import { AccessTokenEntity } from "../entities/AccessTokenEntity";
+import { AppMetadataEntity } from "../entities/AppMetadataEntity";
+import { AuthorityMetadataEntity } from "../entities/AuthorityMetadataEntity";
 import { CredentialEntity } from "../entities/CredentialEntity";
 import { IdTokenEntity } from "../entities/IdTokenEntity";
 import { RefreshTokenEntity } from "../entities/RefreshTokenEntity";
@@ -168,7 +175,8 @@ export function createRefreshTokenEntity(
     refreshToken: string,
     clientId: string,
     familyId?: string,
-    userAssertionHash?: string
+    userAssertionHash?: string,
+    expiresOn?: number
 ): RefreshTokenEntity {
     const rtEntity: RefreshTokenEntity = {
         credentialType: CredentialType.REFRESH_TOKEN,
@@ -186,6 +194,10 @@ export function createRefreshTokenEntity(
         rtEntity.familyId = familyId;
     }
 
+    if (expiresOn) {
+        rtEntity.expiresOn = expiresOn.toString();
+    }
+
     return rtEntity;
 }
 
@@ -325,3 +337,127 @@ export function isServerTelemetryEntity(key: string, entity?: object): boolean {
 
     return validateKey && validateEntity;
 }
+
+/**
+ * validates if a given cache entry is "Throttling", parses <key,value>
+ * @param key
+ * @param entity
+ */
+export function isThrottlingEntity(key: string, entity?: object): boolean {
+    let validateKey: boolean = false;
+    if (key) {
+        validateKey = key.indexOf(ThrottlingConstants.THROTTLING_PREFIX) === 0;
+    }
+
+    let validateEntity: boolean = true;
+    if (entity) {
+        validateEntity = entity.hasOwnProperty("throttleTime");
+    }
+
+    return validateKey && validateEntity;
+}
+
+/**
+ * Generate AppMetadata Cache Key as per the schema: appmetadata-<environment>-<client_id>
+ */
+export function generateAppMetadataKey({
+    environment,
+    clientId,
+}: AppMetadataEntity): string {
+    const appMetaDataKeyArray: Array<string> = [
+        APP_METADATA,
+        environment,
+        clientId,
+    ];
+    return appMetaDataKeyArray
+        .join(Separators.CACHE_KEY_SEPARATOR)
+        .toLowerCase();
+}
+
+/*
+ * Validates an entity: checks for all expected params
+ * @param entity
+ */
+export function isAppMetadataEntity(key: string, entity: object): boolean {
+    if (!entity) {
+        return false;
+    }
+
+    return (
+        key.indexOf(APP_METADATA) === 0 &&
+        entity.hasOwnProperty("clientId") &&
+        entity.hasOwnProperty("environment")
+    );
+}
+
+/**
+ * Validates an entity: checks for all expected params
+ * @param entity
+ */
+export function isAuthorityMetadataEntity(
+    key: string,
+    entity: object
+): boolean {
+    if (!entity) {
+        return false;
+    }
+
+    return (
+        key.indexOf(AUTHORITY_METADATA_CONSTANTS.CACHE_KEY) === 0 &&
+        entity.hasOwnProperty("aliases") &&
+        entity.hasOwnProperty("preferred_cache") &&
+        entity.hasOwnProperty("preferred_network") &&
+        entity.hasOwnProperty("canonical_authority") &&
+        entity.hasOwnProperty("authorization_endpoint") &&
+        entity.hasOwnProperty("token_endpoint") &&
+        entity.hasOwnProperty("issuer") &&
+        entity.hasOwnProperty("aliasesFromNetwork") &&
+        entity.hasOwnProperty("endpointsFromNetwork") &&
+        entity.hasOwnProperty("expiresAt") &&
+        entity.hasOwnProperty("jwks_uri")
+    );
+}
+
+/**
+ * Reset the exiresAt value
+ */
+export function generateAuthorityMetadataExpiresAt(): number {
+    return (
+        TimeUtils.nowSeconds() +
+        AUTHORITY_METADATA_CONSTANTS.REFRESH_TIME_SECONDS
+    );
+}
+
+export function updateAuthorityEndpointMetadata(
+    authorityMetadata: AuthorityMetadataEntity,
+    updatedValues: OpenIdConfigResponse,
+    fromNetwork: boolean
+): void {
+    authorityMetadata.authorization_endpoint =
+        updatedValues.authorization_endpoint;
+    authorityMetadata.token_endpoint = updatedValues.token_endpoint;
+    authorityMetadata.end_session_endpoint = updatedValues.end_session_endpoint;
+    authorityMetadata.issuer = updatedValues.issuer;
+    authorityMetadata.endpointsFromNetwork = fromNetwork;
+    authorityMetadata.jwks_uri = updatedValues.jwks_uri;
+}
+
+export function updateCloudDiscoveryMetadata(
+    authorityMetadata: AuthorityMetadataEntity,
+    updatedValues: CloudDiscoveryMetadata,
+    fromNetwork: boolean
+): void {
+    authorityMetadata.aliases = updatedValues.aliases;
+    authorityMetadata.preferred_cache = updatedValues.preferred_cache;
+    authorityMetadata.preferred_network = updatedValues.preferred_network;
+    authorityMetadata.aliasesFromNetwork = fromNetwork;
+}
+
+/**
+ * Returns whether or not the data needs to be refreshed
+ */
+export function isAuthorityMetadataExpired(
+    metadata: AuthorityMetadataEntity
+): boolean {
+    return metadata.expiresAt <= TimeUtils.nowSeconds();
+}