@azure/msal-common 15.13.3 → 16.0.0-beta.0

package/src/authority/AuthorityMetadata.ts

@@ -16,42 +16,40 @@ type RawMetadata = {
     instanceDiscoveryMetadata: CloudInstanceDiscoveryResponse;
 };
 
-export const rawMetdataJSON: RawMetadata = {
-    endpointMetadata: {
-        "login.microsoftonline.com": {
-            token_endpoint:
-                "https://login.microsoftonline.com/{tenantid}/oauth2/v2.0/token",
-            jwks_uri:
-                "https://login.microsoftonline.com/{tenantid}/discovery/v2.0/keys",
-            issuer: "https://login.microsoftonline.com/{tenantid}/v2.0",
-            authorization_endpoint:
-                "https://login.microsoftonline.com/{tenantid}/oauth2/v2.0/authorize",
-            end_session_endpoint:
-                "https://login.microsoftonline.com/{tenantid}/oauth2/v2.0/logout",
-        },
-        "login.chinacloudapi.cn": {
-            token_endpoint:
-                "https://login.chinacloudapi.cn/{tenantid}/oauth2/v2.0/token",
-            jwks_uri:
-                "https://login.chinacloudapi.cn/{tenantid}/discovery/v2.0/keys",
-            issuer: "https://login.partner.microsoftonline.cn/{tenantid}/v2.0",
-            authorization_endpoint:
-                "https://login.chinacloudapi.cn/{tenantid}/oauth2/v2.0/authorize",
-            end_session_endpoint:
-                "https://login.chinacloudapi.cn/{tenantid}/oauth2/v2.0/logout",
-        },
-        "login.microsoftonline.us": {
-            token_endpoint:
-                "https://login.microsoftonline.us/{tenantid}/oauth2/v2.0/token",
-            jwks_uri:
-                "https://login.microsoftonline.us/{tenantid}/discovery/v2.0/keys",
-            issuer: "https://login.microsoftonline.us/{tenantid}/v2.0",
-            authorization_endpoint:
-                "https://login.microsoftonline.us/{tenantid}/oauth2/v2.0/authorize",
-            end_session_endpoint:
-                "https://login.microsoftonline.us/{tenantid}/oauth2/v2.0/logout",
-        },
+// Build endpoint metadata dynamically to avoid string duplication
+const endpointHosts: Array<{ host: string; issuerHost?: string }> = [
+    { host: "login.microsoftonline.com" },
+    {
+        host: "login.chinacloudapi.cn",
+        issuerHost: "login.partner.microsoftonline.cn", // Issuer differs
     },
+    { host: "login.microsoftonline.us" },
+    { host: "login.sovcloud-identity.fr" },
+    { host: "login.sovcloud-identity.de" },
+    { host: "login.sovcloud-identity.sg" },
+];
+
+function buildOpenIdConfig(
+    host: string,
+    issuerHost: string
+): OpenIdConfigResponse {
+    return {
+        token_endpoint: `https://${host}/{tenantid}/oauth2/v2.0/token`,
+        jwks_uri: `https://${host}/{tenantid}/discovery/v2.0/keys`,
+        issuer: `https://${issuerHost}/{tenantid}/v2.0`,
+        authorization_endpoint: `https://${host}/{tenantid}/oauth2/v2.0/authorize`,
+        end_session_endpoint: `https://${host}/{tenantid}/oauth2/v2.0/logout`,
+    };
+}
+
+const dynamicEndpointMetadata: RawMetadata["endpointMetadata"] =
+    endpointHosts.reduce((acc, { host, issuerHost }) => {
+        acc[host] = buildOpenIdConfig(host, issuerHost || host);
+        return acc;
+    }, {} as Record<string, OpenIdConfigResponse>);
+
+export const rawMetdataJSON: RawMetadata = {
+    endpointMetadata: dynamicEndpointMetadata,
     instanceDiscoveryMetadata: {
         tenant_discovery_endpoint:
             "https://{canonicalAuthority}/v2.0/.well-known/openid-configuration",
@@ -117,7 +115,8 @@ InstanceDiscoveryMetadata.metadata.forEach(
  */
 export function getAliasesFromStaticSources(
     staticAuthorityOptions: StaticAuthorityOptions,
-    logger?: Logger
+    logger: Logger,
+    correlationId: string
 ): string[] {
     let staticAliases: string[] | undefined;
     const canonicalAuthority = staticAuthorityOptions.canonicalAuthority;
@@ -127,16 +126,18 @@ export function getAliasesFromStaticSources(
         ).getUrlComponents().HostNameAndPort;
         staticAliases =
             getAliasesFromMetadata(
+                logger,
+                correlationId,
                 authorityHost,
                 staticAuthorityOptions.cloudDiscoveryMetadata?.metadata,
-                AuthorityMetadataSource.CONFIG,
-                logger
+                AuthorityMetadataSource.CONFIG
             ) ||
             getAliasesFromMetadata(
+                logger,
+                correlationId,
                 authorityHost,
                 InstanceDiscoveryMetadata.metadata,
-                AuthorityMetadataSource.HARDCODED_VALUES,
-                logger
+                AuthorityMetadataSource.HARDCODED_VALUES
             ) ||
             staticAuthorityOptions.knownAuthorities;
     }
@@ -151,12 +152,16 @@ export function getAliasesFromStaticSources(
  * @returns
  */
 export function getAliasesFromMetadata(
+    logger: Logger,
+    correlationId: string,
     authorityHost?: string,
     cloudDiscoveryMetadata?: CloudDiscoveryMetadata[],
-    source?: AuthorityMetadataSource,
-    logger?: Logger
+    source?: AuthorityMetadataSource
 ): string[] | null {
-    logger?.trace(`getAliasesFromMetadata called with source: ${source}`);
+    logger.trace(
+        `getAliasesFromMetadata called with source: '${source}'`,
+        correlationId
+    );
     if (authorityHost && cloudDiscoveryMetadata) {
         const metadata = getCloudDiscoveryMetadataFromNetworkResponse(
             cloudDiscoveryMetadata,
@@ -164,13 +169,15 @@ export function getAliasesFromMetadata(
         );
 
         if (metadata) {
-            logger?.trace(
-                `getAliasesFromMetadata: found cloud discovery metadata in ${source}, returning aliases`
+            logger.trace(
+                `getAliasesFromMetadata: found cloud discovery metadata in '${source}', returning aliases`,
+                correlationId
             );
             return metadata.aliases;
         } else {
-            logger?.trace(
-                `getAliasesFromMetadata: did not find cloud discovery metadata in ${source}`
+            logger.trace(
+                `getAliasesFromMetadata: did not find cloud discovery metadata in '${source}'`,
+                correlationId
             );
         }
     }

package/src/authority/AuthorityOptions.ts

@@ -14,7 +14,6 @@ export type AuthorityOptions = {
     knownAuthorities: Array<string>;
     cloudDiscoveryMetadata: string;
     authorityMetadata: string;
-    skipAuthorityMetadataCache?: boolean;
     azureRegionConfiguration?: AzureRegionConfiguration;
     authority?: string;
 };

package/src/authority/OIDCOptions.ts

@@ -3,12 +3,12 @@
  * Licensed under the MIT License.
  */
 
-import { ServerResponseType } from "../utils/Constants.js";
+import { ResponseMode } from "../utils/Constants.js";
 
 /**
  * Options for the OIDC protocol mode.
  */
 export type OIDCOptions = {
-    serverResponseType?: ServerResponseType;
+    responseMode?: ResponseMode;
     defaultScopes?: Array<string>;
 };

package/src/authority/RegionDiscovery.ts

@@ -6,15 +6,11 @@
 import { INetworkModule } from "../network/INetworkModule.js";
 import { NetworkResponse } from "../network/NetworkResponse.js";
 import { IMDSBadResponse } from "../response/IMDSBadResponse.js";
-import {
-    Constants,
-    HttpStatus,
-    RegionDiscoverySources,
-} from "../utils/Constants.js";
+import * as Constants from "../utils/Constants.js";
 import { RegionDiscoveryMetadata } from "./RegionDiscoveryMetadata.js";
 import { ImdsOptions } from "./ImdsOptions.js";
 import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient.js";
-import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent.js";
+import * as PerformanceEvents from "../telemetry/performance/PerformanceEvents.js";
 import { invokeAsync } from "../utils/FunctionWrappers.js";
 import { Logger } from "../logger/Logger.js";
 
@@ -24,9 +20,9 @@ export class RegionDiscovery {
     // Logger
     private logger: Logger;
     // Performance client
-    protected performanceClient: IPerformanceClient | undefined;
+    protected performanceClient: IPerformanceClient;
     // CorrelationId
-    protected correlationId: string | undefined;
+    protected correlationId: string;
     // Options for the IMDS endpoint request
     protected static IMDS_OPTIONS: ImdsOptions = {
         headers: {
@@ -37,8 +33,8 @@ export class RegionDiscovery {
     constructor(
         networkInterface: INetworkModule,
         logger: Logger,
-        performanceClient?: IPerformanceClient,
-        correlationId?: string
+        performanceClient: IPerformanceClient,
+        correlationId: string
     ) {
         this.networkInterface = networkInterface;
         this.logger = logger;
@@ -55,11 +51,6 @@ export class RegionDiscovery {
         environmentRegion: string | undefined,
         regionDiscoveryMetadata: RegionDiscoveryMetadata
     ): Promise<string | null> {
-        this.performanceClient?.addQueueMeasurement(
-            PerformanceEvents.RegionDiscoveryDetectRegion,
-            this.correlationId
-        );
-
         // Initialize auto detected region with the region from the envrionment
         let autodetectedRegionName = environmentRegion;
 
@@ -75,15 +66,18 @@ export class RegionDiscovery {
                     this.performanceClient,
                     this.correlationId
                 )(Constants.IMDS_VERSION, options);
-                if (localIMDSVersionResponse.status === HttpStatus.SUCCESS) {
+                if (
+                    localIMDSVersionResponse.status === Constants.HTTP_SUCCESS
+                ) {
                     autodetectedRegionName = localIMDSVersionResponse.body;
                     regionDiscoveryMetadata.region_source =
-                        RegionDiscoverySources.IMDS;
+                        Constants.RegionDiscoverySources.IMDS;
                 }
 
                 // If the response using the local IMDS version failed, try to fetch the current version of IMDS and retry.
                 if (
-                    localIMDSVersionResponse.status === HttpStatus.BAD_REQUEST
+                    localIMDSVersionResponse.status ===
+                    Constants.HTTP_BAD_REQUEST
                 ) {
                     const currentIMDSVersion = await invokeAsync(
                         this.getCurrentVersion.bind(this),
@@ -94,7 +88,7 @@ export class RegionDiscovery {
                     )(options);
                     if (!currentIMDSVersion) {
                         regionDiscoveryMetadata.region_source =
-                            RegionDiscoverySources.FAILED_AUTO_DETECTION;
+                            Constants.RegionDiscoverySources.FAILED_AUTO_DETECTION;
                         return null;
                     }
 
@@ -106,28 +100,29 @@ export class RegionDiscovery {
                         this.correlationId
                     )(currentIMDSVersion, options);
                     if (
-                        currentIMDSVersionResponse.status === HttpStatus.SUCCESS
+                        currentIMDSVersionResponse.status ===
+                        Constants.HTTP_SUCCESS
                     ) {
                         autodetectedRegionName =
                             currentIMDSVersionResponse.body;
                         regionDiscoveryMetadata.region_source =
-                            RegionDiscoverySources.IMDS;
+                            Constants.RegionDiscoverySources.IMDS;
                     }
                 }
             } catch (e) {
                 regionDiscoveryMetadata.region_source =
-                    RegionDiscoverySources.FAILED_AUTO_DETECTION;
+                    Constants.RegionDiscoverySources.FAILED_AUTO_DETECTION;
                 return null;
             }
         } else {
             regionDiscoveryMetadata.region_source =
-                RegionDiscoverySources.ENVIRONMENT_VARIABLE;
+                Constants.RegionDiscoverySources.ENVIRONMENT_VARIABLE;
         }
 
         // If no region was auto detected from the environment or from the IMDS endpoint, mark the attempt as a FAILED_AUTO_DETECTION
         if (!autodetectedRegionName) {
             regionDiscoveryMetadata.region_source =
-                RegionDiscoverySources.FAILED_AUTO_DETECTION;
+                Constants.RegionDiscoverySources.FAILED_AUTO_DETECTION;
         }
 
         return autodetectedRegionName || null;
@@ -143,10 +138,6 @@ export class RegionDiscovery {
         version: string,
         options: ImdsOptions
     ): Promise<NetworkResponse<string>> {
-        this.performanceClient?.addQueueMeasurement(
-            PerformanceEvents.RegionDiscoveryGetRegionFromIMDS,
-            this.correlationId
-        );
         return this.networkInterface.sendGetRequestAsync<string>(
             `${Constants.IMDS_ENDPOINT}?api-version=${version}&format=text`,
             options,
@@ -162,10 +153,6 @@ export class RegionDiscovery {
     private async getCurrentVersion(
         options: ImdsOptions
     ): Promise<string | null> {
-        this.performanceClient?.addQueueMeasurement(
-            PerformanceEvents.RegionDiscoveryGetCurrentVersion,
-            this.correlationId
-        );
         try {
             const response =
                 await this.networkInterface.sendGetRequestAsync<IMDSBadResponse>(
@@ -175,7 +162,7 @@ export class RegionDiscovery {
 
             // When IMDS endpoint is called without the api version query param, bad request response comes back with latest version.
             if (
-                response.status === HttpStatus.BAD_REQUEST &&
+                response.status === Constants.HTTP_BAD_REQUEST &&
                 response.body &&
                 response.body["newest-versions"] &&
                 response.body["newest-versions"].length > 0