@azure/msal-common 14.1.0 → 14.3.0

package/src/authority/AuthorityMetadata.ts

@@ -3,6 +3,12 @@
  * Licensed under the MIT License.
  */
 
+import { Logger } from "../logger/Logger";
+import { UrlString } from "../url/UrlString";
+import { AuthorityMetadataSource } from "../utils/Constants";
+import { StaticAuthorityOptions } from "./AuthorityOptions";
+import { CloudDiscoveryMetadata } from "./CloudDiscoveryMetadata";
+
 export const rawMetdataJSON = {
     endpointMetadata: {
         "https://login.microsoftonline.com/common/": {
@@ -549,393 +555,47 @@ export const rawMetdataJSON = {
         },
     },
     instanceDiscoveryMetadata: {
-        "https://login.microsoftonline.com/common/": {
-            tenant_discovery_endpoint:
-                "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration",
-            "api-version": "1.1",
-            metadata: [
-                {
-                    preferred_network: "login.microsoftonline.com",
-                    preferred_cache: "login.windows.net",
-                    aliases: [
-                        "login.microsoftonline.com",
-                        "login.windows.net",
-                        "login.microsoft.com",
-                        "sts.windows.net",
-                    ],
-                },
-                {
-                    preferred_network: "login.partner.microsoftonline.cn",
-                    preferred_cache: "login.partner.microsoftonline.cn",
-                    aliases: [
-                        "login.partner.microsoftonline.cn",
-                        "login.chinacloudapi.cn",
-                    ],
-                },
-                {
-                    preferred_network: "login.microsoftonline.de",
-                    preferred_cache: "login.microsoftonline.de",
-                    aliases: ["login.microsoftonline.de"],
-                },
-                {
-                    preferred_network: "login.microsoftonline.us",
-                    preferred_cache: "login.microsoftonline.us",
-                    aliases: [
-                        "login.microsoftonline.us",
-                        "login.usgovcloudapi.net",
-                    ],
-                },
-                {
-                    preferred_network: "login-us.microsoftonline.com",
-                    preferred_cache: "login-us.microsoftonline.com",
-                    aliases: ["login-us.microsoftonline.com"],
-                },
-            ],
-        },
-        "https://login.chinacloudapi.cn/common/": {
-            tenant_discovery_endpoint:
-                "https://login.chinacloudapi.cn/common/v2.0/.well-known/openid-configuration",
-            "api-version": "1.1",
-            metadata: [
-                {
-                    preferred_network: "login.microsoftonline.com",
-                    preferred_cache: "login.windows.net",
-                    aliases: [
-                        "login.microsoftonline.com",
-                        "login.windows.net",
-                        "login.microsoft.com",
-                        "sts.windows.net",
-                    ],
-                },
-                {
-                    preferred_network: "login.partner.microsoftonline.cn",
-                    preferred_cache: "login.partner.microsoftonline.cn",
-                    aliases: [
-                        "login.partner.microsoftonline.cn",
-                        "login.chinacloudapi.cn",
-                    ],
-                },
-                {
-                    preferred_network: "login.microsoftonline.de",
-                    preferred_cache: "login.microsoftonline.de",
-                    aliases: ["login.microsoftonline.de"],
-                },
-                {
-                    preferred_network: "login.microsoftonline.us",
-                    preferred_cache: "login.microsoftonline.us",
-                    aliases: [
-                        "login.microsoftonline.us",
-                        "login.usgovcloudapi.net",
-                    ],
-                },
-                {
-                    preferred_network: "login-us.microsoftonline.com",
-                    preferred_cache: "login-us.microsoftonline.com",
-                    aliases: ["login-us.microsoftonline.com"],
-                },
-            ],
-        },
-        "https://login.microsoftonline.us/common/": {
-            tenant_discovery_endpoint:
-                "https://login.microsoftonline.us/common/v2.0/.well-known/openid-configuration",
-            "api-version": "1.1",
-            metadata: [
-                {
-                    preferred_network: "login.microsoftonline.com",
-                    preferred_cache: "login.windows.net",
-                    aliases: [
-                        "login.microsoftonline.com",
-                        "login.windows.net",
-                        "login.microsoft.com",
-                        "sts.windows.net",
-                    ],
-                },
-                {
-                    preferred_network: "login.partner.microsoftonline.cn",
-                    preferred_cache: "login.partner.microsoftonline.cn",
-                    aliases: [
-                        "login.partner.microsoftonline.cn",
-                        "login.chinacloudapi.cn",
-                    ],
-                },
-                {
-                    preferred_network: "login.microsoftonline.de",
-                    preferred_cache: "login.microsoftonline.de",
-                    aliases: ["login.microsoftonline.de"],
-                },
-                {
-                    preferred_network: "login.microsoftonline.us",
-                    preferred_cache: "login.microsoftonline.us",
-                    aliases: [
-                        "login.microsoftonline.us",
-                        "login.usgovcloudapi.net",
-                    ],
-                },
-                {
-                    preferred_network: "login-us.microsoftonline.com",
-                    preferred_cache: "login-us.microsoftonline.com",
-                    aliases: ["login-us.microsoftonline.com"],
-                },
-            ],
-        },
-        "https://login.microsoftonline.com/consumers/": {
-            tenant_discovery_endpoint:
-                "https://login.microsoftonline.com/consumers/v2.0/.well-known/openid-configuration",
-            "api-version": "1.1",
-            metadata: [
-                {
-                    preferred_network: "login.microsoftonline.com",
-                    preferred_cache: "login.windows.net",
-                    aliases: [
-                        "login.microsoftonline.com",
-                        "login.windows.net",
-                        "login.microsoft.com",
-                        "sts.windows.net",
-                    ],
-                },
-                {
-                    preferred_network: "login.partner.microsoftonline.cn",
-                    preferred_cache: "login.partner.microsoftonline.cn",
-                    aliases: [
-                        "login.partner.microsoftonline.cn",
-                        "login.chinacloudapi.cn",
-                    ],
-                },
-                {
-                    preferred_network: "login.microsoftonline.de",
-                    preferred_cache: "login.microsoftonline.de",
-                    aliases: ["login.microsoftonline.de"],
-                },
-                {
-                    preferred_network: "login.microsoftonline.us",
-                    preferred_cache: "login.microsoftonline.us",
-                    aliases: [
-                        "login.microsoftonline.us",
-                        "login.usgovcloudapi.net",
-                    ],
-                },
-                {
-                    preferred_network: "login-us.microsoftonline.com",
-                    preferred_cache: "login-us.microsoftonline.com",
-                    aliases: ["login-us.microsoftonline.com"],
-                },
-            ],
-        },
-        "https://login.chinacloudapi.cn/consumers/": {
-            tenant_discovery_endpoint:
-                "https://login.chinacloudapi.cn/consumers/v2.0/.well-known/openid-configuration",
-            "api-version": "1.1",
-            metadata: [
-                {
-                    preferred_network: "login.microsoftonline.com",
-                    preferred_cache: "login.windows.net",
-                    aliases: [
-                        "login.microsoftonline.com",
-                        "login.windows.net",
-                        "login.microsoft.com",
-                        "sts.windows.net",
-                    ],
-                },
-                {
-                    preferred_network: "login.partner.microsoftonline.cn",
-                    preferred_cache: "login.partner.microsoftonline.cn",
-                    aliases: [
-                        "login.partner.microsoftonline.cn",
-                        "login.chinacloudapi.cn",
-                    ],
-                },
-                {
-                    preferred_network: "login.microsoftonline.de",
-                    preferred_cache: "login.microsoftonline.de",
-                    aliases: ["login.microsoftonline.de"],
-                },
-                {
-                    preferred_network: "login.microsoftonline.us",
-                    preferred_cache: "login.microsoftonline.us",
-                    aliases: [
-                        "login.microsoftonline.us",
-                        "login.usgovcloudapi.net",
-                    ],
-                },
-                {
-                    preferred_network: "login-us.microsoftonline.com",
-                    preferred_cache: "login-us.microsoftonline.com",
-                    aliases: ["login-us.microsoftonline.com"],
-                },
-            ],
-        },
-        "https://login.microsoftonline.us/consumers/": {
-            tenant_discovery_endpoint:
-                "https://login.microsoftonline.us/consumers/v2.0/.well-known/openid-configuration",
-            "api-version": "1.1",
-            metadata: [
-                {
-                    preferred_network: "login.microsoftonline.com",
-                    preferred_cache: "login.windows.net",
-                    aliases: [
-                        "login.microsoftonline.com",
-                        "login.windows.net",
-                        "login.microsoft.com",
-                        "sts.windows.net",
-                    ],
-                },
-                {
-                    preferred_network: "login.partner.microsoftonline.cn",
-                    preferred_cache: "login.partner.microsoftonline.cn",
-                    aliases: [
-                        "login.partner.microsoftonline.cn",
-                        "login.chinacloudapi.cn",
-                    ],
-                },
-                {
-                    preferred_network: "login.microsoftonline.de",
-                    preferred_cache: "login.microsoftonline.de",
-                    aliases: ["login.microsoftonline.de"],
-                },
-                {
-                    preferred_network: "login.microsoftonline.us",
-                    preferred_cache: "login.microsoftonline.us",
-                    aliases: [
-                        "login.microsoftonline.us",
-                        "login.usgovcloudapi.net",
-                    ],
-                },
-                {
-                    preferred_network: "login-us.microsoftonline.com",
-                    preferred_cache: "login-us.microsoftonline.com",
-                    aliases: ["login-us.microsoftonline.com"],
-                },
-            ],
-        },
-        "https://login.microsoftonline.com/organizations/": {
-            tenant_discovery_endpoint:
-                "https://login.microsoftonline.com/organizations/v2.0/.well-known/openid-configuration",
-            "api-version": "1.1",
-            metadata: [
-                {
-                    preferred_network: "login.microsoftonline.com",
-                    preferred_cache: "login.windows.net",
-                    aliases: [
-                        "login.microsoftonline.com",
-                        "login.windows.net",
-                        "login.microsoft.com",
-                        "sts.windows.net",
-                    ],
-                },
-                {
-                    preferred_network: "login.partner.microsoftonline.cn",
-                    preferred_cache: "login.partner.microsoftonline.cn",
-                    aliases: [
-                        "login.partner.microsoftonline.cn",
-                        "login.chinacloudapi.cn",
-                    ],
-                },
-                {
-                    preferred_network: "login.microsoftonline.de",
-                    preferred_cache: "login.microsoftonline.de",
-                    aliases: ["login.microsoftonline.de"],
-                },
-                {
-                    preferred_network: "login.microsoftonline.us",
-                    preferred_cache: "login.microsoftonline.us",
-                    aliases: [
-                        "login.microsoftonline.us",
-                        "login.usgovcloudapi.net",
-                    ],
-                },
-                {
-                    preferred_network: "login-us.microsoftonline.com",
-                    preferred_cache: "login-us.microsoftonline.com",
-                    aliases: ["login-us.microsoftonline.com"],
-                },
-            ],
-        },
-        "https://login.chinacloudapi.cn/organizations/": {
-            tenant_discovery_endpoint:
-                "https://login.chinacloudapi.cn/organizations/v2.0/.well-known/openid-configuration",
-            "api-version": "1.1",
-            metadata: [
-                {
-                    preferred_network: "login.microsoftonline.com",
-                    preferred_cache: "login.windows.net",
-                    aliases: [
-                        "login.microsoftonline.com",
-                        "login.windows.net",
-                        "login.microsoft.com",
-                        "sts.windows.net",
-                    ],
-                },
-                {
-                    preferred_network: "login.partner.microsoftonline.cn",
-                    preferred_cache: "login.partner.microsoftonline.cn",
-                    aliases: [
-                        "login.partner.microsoftonline.cn",
-                        "login.chinacloudapi.cn",
-                    ],
-                },
-                {
-                    preferred_network: "login.microsoftonline.de",
-                    preferred_cache: "login.microsoftonline.de",
-                    aliases: ["login.microsoftonline.de"],
-                },
-                {
-                    preferred_network: "login.microsoftonline.us",
-                    preferred_cache: "login.microsoftonline.us",
-                    aliases: [
-                        "login.microsoftonline.us",
-                        "login.usgovcloudapi.net",
-                    ],
-                },
-                {
-                    preferred_network: "login-us.microsoftonline.com",
-                    preferred_cache: "login-us.microsoftonline.com",
-                    aliases: ["login-us.microsoftonline.com"],
-                },
-            ],
-        },
-        "https://login.microsoftonline.us/organizations/": {
-            tenant_discovery_endpoint:
-                "https://login.microsoftonline.us/organizations/v2.0/.well-known/openid-configuration",
-            "api-version": "1.1",
-            metadata: [
-                {
-                    preferred_network: "login.microsoftonline.com",
-                    preferred_cache: "login.windows.net",
-                    aliases: [
-                        "login.microsoftonline.com",
-                        "login.windows.net",
-                        "login.microsoft.com",
-                        "sts.windows.net",
-                    ],
-                },
-                {
-                    preferred_network: "login.partner.microsoftonline.cn",
-                    preferred_cache: "login.partner.microsoftonline.cn",
-                    aliases: [
-                        "login.partner.microsoftonline.cn",
-                        "login.chinacloudapi.cn",
-                    ],
-                },
-                {
-                    preferred_network: "login.microsoftonline.de",
-                    preferred_cache: "login.microsoftonline.de",
-                    aliases: ["login.microsoftonline.de"],
-                },
-                {
-                    preferred_network: "login.microsoftonline.us",
-                    preferred_cache: "login.microsoftonline.us",
-                    aliases: [
-                        "login.microsoftonline.us",
-                        "login.usgovcloudapi.net",
-                    ],
-                },
-                {
-                    preferred_network: "login-us.microsoftonline.com",
-                    preferred_cache: "login-us.microsoftonline.com",
-                    aliases: ["login-us.microsoftonline.com"],
-                },
-            ],
-        },
+        tenant_discovery_endpoint:
+            "https://{canonicalAuthority}/v2.0/.well-known/openid-configuration",
+        "api-version": "1.1",
+        metadata: [
+            {
+                preferred_network: "login.microsoftonline.com",
+                preferred_cache: "login.windows.net",
+                aliases: [
+                    "login.microsoftonline.com",
+                    "login.windows.net",
+                    "login.microsoft.com",
+                    "sts.windows.net",
+                ],
+            },
+            {
+                preferred_network: "login.partner.microsoftonline.cn",
+                preferred_cache: "login.partner.microsoftonline.cn",
+                aliases: [
+                    "login.partner.microsoftonline.cn",
+                    "login.chinacloudapi.cn",
+                ],
+            },
+            {
+                preferred_network: "login.microsoftonline.de",
+                preferred_cache: "login.microsoftonline.de",
+                aliases: ["login.microsoftonline.de"],
+            },
+            {
+                preferred_network: "login.microsoftonline.us",
+                preferred_cache: "login.microsoftonline.us",
+                aliases: [
+                    "login.microsoftonline.us",
+                    "login.usgovcloudapi.net",
+                ],
+            },
+            {
+                preferred_network: "login-us.microsoftonline.com",
+                preferred_cache: "login-us.microsoftonline.com",
+                aliases: ["login-us.microsoftonline.com"],
+            },
+        ],
     },
 };
 
@@ -944,10 +604,111 @@ export const InstanceDiscoveryMetadata =
     rawMetdataJSON.instanceDiscoveryMetadata;
 
 export const InstanceDiscoveryMetadataAliases: Set<String> = new Set();
-for (const key in InstanceDiscoveryMetadata) {
-    for (const metadata of InstanceDiscoveryMetadata[key].metadata) {
-        for (const alias of metadata.aliases) {
+InstanceDiscoveryMetadata.metadata.forEach(
+    (metadataEntry: CloudDiscoveryMetadata) => {
+        metadataEntry.aliases.forEach((alias: string) => {
             InstanceDiscoveryMetadataAliases.add(alias);
+        });
+    }
+);
+
+/**
+ * Attempts to get an aliases array from the static authority metadata sources based on the canonical authority host
+ * @param staticAuthorityOptions
+ * @param logger
+ * @returns
+ */
+export function getAliasesFromStaticSources(
+    staticAuthorityOptions: StaticAuthorityOptions,
+    logger?: Logger
+): string[] {
+    let staticAliases: string[] | undefined;
+    const canonicalAuthority = staticAuthorityOptions.canonicalAuthority;
+    if (canonicalAuthority) {
+        const authorityHost = new UrlString(
+            canonicalAuthority
+        ).getUrlComponents().HostNameAndPort;
+        staticAliases =
+            getAliasesFromMetadata(
+                authorityHost,
+                staticAuthorityOptions.cloudDiscoveryMetadata?.metadata,
+                AuthorityMetadataSource.CONFIG,
+                logger
+            ) ||
+            getAliasesFromMetadata(
+                authorityHost,
+                InstanceDiscoveryMetadata.metadata,
+                AuthorityMetadataSource.HARDCODED_VALUES,
+                logger
+            ) ||
+            staticAuthorityOptions.knownAuthorities;
+    }
+
+    return staticAliases || [];
+}
+
+/**
+ * Returns aliases for from the raw cloud discovery metadata passed in
+ * @param authorityHost
+ * @param rawCloudDiscoveryMetadata
+ * @returns
+ */
+export function getAliasesFromMetadata(
+    authorityHost?: string,
+    cloudDiscoveryMetadata?: CloudDiscoveryMetadata[],
+    source?: AuthorityMetadataSource,
+    logger?: Logger
+): string[] | null {
+    logger?.trace(`getAliasesFromMetadata called with source: ${source}`);
+    if (authorityHost && cloudDiscoveryMetadata) {
+        const metadata = getCloudDiscoveryMetadataFromNetworkResponse(
+            cloudDiscoveryMetadata,
+            authorityHost
+        );
+
+        if (metadata) {
+            logger?.trace(
+                `getAliasesFromMetadata: found cloud discovery metadata in ${source}, returning aliases`
+            );
+            return metadata.aliases;
+        } else {
+            logger?.trace(
+                `getAliasesFromMetadata: did not find cloud discovery metadata in ${source}`
+            );
         }
     }
+
+    return null;
+}
+
+/**
+ * Get cloud discovery metadata for common authorities
+ */
+export function getCloudDiscoveryMetadataFromHardcodedValues(
+    authorityHost: string
+): CloudDiscoveryMetadata | null {
+    const metadata = getCloudDiscoveryMetadataFromNetworkResponse(
+        InstanceDiscoveryMetadata.metadata,
+        authorityHost
+    );
+    return metadata;
+}
+
+/**
+ * Searches instance discovery network response for the entry that contains the host in the aliases list
+ * @param response
+ * @param authority
+ */
+export function getCloudDiscoveryMetadataFromNetworkResponse(
+    response: CloudDiscoveryMetadata[],
+    authorityHost: string
+): CloudDiscoveryMetadata | null {
+    for (let i = 0; i < response.length; i++) {
+        const metadata = response[i];
+        if (metadata.aliases.includes(authorityHost)) {
+            return metadata;
+        }
+    }
+
+    return null;
 }

package/src/authority/AuthorityOptions.ts

@@ -6,6 +6,7 @@
 import { ProtocolMode } from "./ProtocolMode";
 import { OIDCOptions } from "./OIDCOptions";
 import { AzureRegionConfiguration } from "./AzureRegionConfiguration";
+import { CloudInstanceDiscoveryResponse } from "./CloudInstanceDiscoveryResponse";
 
 export type AuthorityOptions = {
     protocolMode: ProtocolMode;
@@ -15,6 +16,14 @@ export type AuthorityOptions = {
     authorityMetadata: string;
     skipAuthorityMetadataCache?: boolean;
     azureRegionConfiguration?: AzureRegionConfiguration;
+    authority?: string;
+};
+
+export type StaticAuthorityOptions = Partial<
+    Pick<AuthorityOptions, "knownAuthorities">
+> & {
+    canonicalAuthority?: string;
+    cloudDiscoveryMetadata?: CloudInstanceDiscoveryResponse;
 };
 
 export const AzureCloudInstance = {