Merge pull request #2106 from AzureAD/optimize-knownAuthorities

knownAuthorities enhancements

Author: tnorling

change/@azure-msal-common-2020-08-12-10-27-42-optimize-knownAuthorities.json

@@ -0,0 +1,8 @@
+{
+  "type": "patch",
+  "comment": "knownAuthorities enhancements (#2106)",
+  "packageName": "@azure/msal-common",
+  "email": "[email protected]",
+  "dependentChangeType": "patch",
+  "date": "2020-08-12T17:27:42.806Z"
+}

lib/msal-common/src/authority/TrustedAuthority.ts

@@ -75,10 +75,11 @@ export class TrustedAuthority {
      */
     public static createCloudDiscoveryMetadataFromKnownAuthorities(knownAuthorities: Array<string>): void {
         knownAuthorities.forEach(authority => {
-            this.TrustedHostList[authority.toLowerCase()] = {
-                preferred_cache: authority.toLowerCase(),
-                preferred_network: authority.toLowerCase(),
-                aliases: [authority.toLowerCase()]
+            const authorityDomain = UrlString.getDomainFromUrl(authority).toLowerCase();
+            this.TrustedHostList[authorityDomain] = {
+                preferred_cache: authorityDomain,
+                preferred_network: authorityDomain,
+                aliases: [authorityDomain]
             };
         });
     }

lib/msal-common/src/url/UrlString.ts

@@ -140,6 +140,18 @@ export class UrlString {
         return urlComponents;
     }
 
+    static getDomainFromUrl(url: string): string {
+        const regEx = RegExp("^([^:/?#]+://)?([^/?#]*)");
+
+        const match = url.match(regEx);
+
+        if (!match) {
+            throw ClientConfigurationError.createUrlParseError(`Given url string: ${url}`);
+        }
+
+        return match[2];
+    }
+    
     /**
      * Parses hash string from given string. Returns empty string if no hash symbol is found.
      * @param hashString 

lib/msal-common/test/authority/TrustedAuthority.spec.ts

@@ -126,7 +126,7 @@ describe("TrustedAuthority.ts Class", function () {
             });
         });
 
-        it("createcloudDiscoveryMetadataFromKnownAuthorities creates metadata object for each host passed in", () => {
+        it("createCloudDiscoveryMetadataFromKnownAuthorities creates metadata object for each host passed in", () => {
             const testAuthorities = ["contoso.b2clogin.com"]
             TrustedAuthority.createCloudDiscoveryMetadataFromKnownAuthorities(testAuthorities);
 
@@ -140,6 +140,27 @@ describe("TrustedAuthority.ts Class", function () {
             expect(savedcloudDiscoveryMetadata.preferred_network).to.eq(testAuthorities[0]);
         });
 
+        it("createCloudDiscoveryMetadataFromKnownAuthorities creates metadata object when passed host includes more than just domain", () => {
+            const testDomains = ["contoso1.com", "contoso2.com", "contoso3.com", "contoso4.com", "contoso5.com"]
+            const testAuthorities = ["https://contoso1.com", "contoso2.com/additionalPage", "contoso3.com#customHash", "contoso4.com?customQueryParam", "http://contoso5.com/additionalPage/anotherPage/"];
+            TrustedAuthority.createCloudDiscoveryMetadataFromKnownAuthorities(testAuthorities);
+
+            testDomains.forEach((authority) => {
+                expect(TrustedAuthority.IsInTrustedHostList(authority)).to.be.true;
+                const savedcloudDiscoveryMetadata = TrustedAuthority.getCloudDiscoveryMetadata(authority);
+                savedcloudDiscoveryMetadata.aliases.forEach((alias) => {
+                    expect(alias).to.eq(authority);
+                });
+                expect(savedcloudDiscoveryMetadata.preferred_cache).to.eq(authority);
+                expect(savedcloudDiscoveryMetadata.preferred_network).to.eq(authority);
+            });
+
+            testAuthorities.forEach((authority) => {
+                expect(TrustedAuthority.IsInTrustedHostList(authority)).to.be.false;
+                expect(TrustedAuthority.getCloudDiscoveryMetadata(authority)).to.be.null;
+            });
+        });
+
         it("getTrustedHostList", () => {
             sinon.stub(TrustedAuthority, <any>"TrustedHostList").get(() => {
                 return {"fabrikamb2c.b2clogin.com": cloudDiscoveryMetadata[0]}

lib/msal-common/test/url/UrlString.spec.ts

@@ -4,6 +4,7 @@ import { UrlString } from "../../src/url/UrlString";
 import { ClientConfigurationError, ClientConfigurationErrorMessage } from "../../src/error/ClientConfigurationError";
 import { IUri } from "../../src/url/IUri";
 import sinon from "sinon";
+import { IdToken } from "../../src/account/IdToken";
 
 describe("UrlString.ts Class Unit Tests", () => {
 
@@ -156,4 +157,32 @@ describe("UrlString.ts Class Unit Tests", () => {
         const exampleUnknownHash = "#param1=value1&param2=value2&param3=value3";
         expect(UrlString.hashContainsKnownProperties(exampleUnknownHash)).to.be.false;
     });
+
+    describe("getDomainFromUrl tests", () => {
+        it("tests domain is returned when provided url includes protocol", () => {
+            expect(UrlString.getDomainFromUrl("https://domain.com")).to.eq("domain.com");
+            expect(UrlString.getDomainFromUrl("https://domain.com/")).to.eq("domain.com");
+            expect(UrlString.getDomainFromUrl("http://domain.com")).to.eq("domain.com");
+        });
+
+        it("tests domain is returned when only domain is provided", () => {
+            expect(UrlString.getDomainFromUrl("domain.com/")).to.eq("domain.com");
+            expect(UrlString.getDomainFromUrl("domain.com")).to.eq("domain.com");
+        });
+
+        it("tests domain is returned when provided url is not homepage", () => {
+            expect(UrlString.getDomainFromUrl("domain.com/page")).to.eq("domain.com");
+            expect(UrlString.getDomainFromUrl("domain.com/index.html")).to.eq("domain.com");
+        });
+
+        it("tests domain is returned when provided url includes hash", () => {
+            expect(UrlString.getDomainFromUrl("domain.com#customHash")).to.eq("domain.com");
+            expect(UrlString.getDomainFromUrl("domain.com/#customHash")).to.eq("domain.com");
+        });
+
+        it("tests domain is returned when provided url includes query string", () => {
+            expect(UrlString.getDomainFromUrl("domain.com?queryString=1")).to.eq("domain.com");
+            expect(UrlString.getDomainFromUrl("domain.com/?queryString=1")).to.eq("domain.com");
+        });
+    });
 });