@azure/msal-common 6.0.0 → 6.1.0

package/dist/index.cjs.js

@@ -1,4 +1,4 @@
-/*! @azure/msal-common v6.0.0 2022-01-04 */
+/*! @azure/msal-common v6.1.0 2022-02-08 */
 'use strict';
 'use strict';
 
@@ -102,6 +102,7 @@ var Constants = {
     // default authority
     DEFAULT_AUTHORITY: "https://login.microsoftonline.com/common/",
     DEFAULT_AUTHORITY_HOST: "login.microsoftonline.com",
+    DEFAULT_COMMON_TENANT: "common",
     // ADFS String
     ADFS: "adfs",
     // Default AAD Instance Discovery Endpoint
@@ -226,6 +227,7 @@ var AADServerParamKeys;
     AADServerParamKeys["FOCI"] = "foci";
     AADServerParamKeys["CCS_HEADER"] = "X-AnchorMailbox";
     AADServerParamKeys["RETURN_SPA_CODE"] = "return_spa_code";
+    AADServerParamKeys["LOGOUT_HINT"] = "logout_hint";
 })(AADServerParamKeys || (AADServerParamKeys = {}));
 /**
  * Claims request keys
@@ -1335,7 +1337,25 @@ var Logger = /** @class */ (function () {
 
 /* eslint-disable header/header */
 var name = "@azure/msal-common";
-var version = "6.0.0";
+var version = "6.1.0";
+
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+exports.AzureCloudInstance = void 0;
+(function (AzureCloudInstance) {
+    // AzureCloudInstance is not specified.
+    AzureCloudInstance[AzureCloudInstance["None"] = 0] = "None";
+    // Microsoft Azure public cloud
+    AzureCloudInstance["AzurePublic"] = "https://login.microsoftonline.com";
+    // Microsoft Chinese national cloud
+    AzureCloudInstance["AzureChina"] = "https://login.chinacloudapi.cn";
+    // Microsoft German national cloud ("Black Forest")
+    AzureCloudInstance["AzureGermany"] = "https://login.microsoftonline.de";
+    // US Government cloud
+    AzureCloudInstance["AzureUsGovernment"] = "https://login.microsoftonline.us";
+})(exports.AzureCloudInstance || (exports.AzureCloudInstance = {}));
 
 /*
  * Copyright (c) Microsoft Corporation. All rights reserved.
@@ -1574,6 +1594,10 @@ var ClientConfigurationErrorMessage = {
         code: "untrusted_authority",
         desc: "The provided authority is not a trusted authority. Please include this authority in the knownAuthorities config parameter."
     },
+    invalidAzureCloudInstance: {
+        code: "invalid_azure_cloud_instance",
+        desc: "Invalid AzureCloudInstance provided. Please refer MSAL JS docs: aks.ms/msaljs/azure_cloud_instance for valid values"
+    },
     missingSshJwk: {
         code: "missing_ssh_jwk",
         desc: "Missing sshJwk in SSH certificate request. A stringified JSON Web Key is required when using the SSH authentication scheme."
@@ -1710,7 +1734,13 @@ var ClientConfigurationError = /** @class */ (function (_super) {
     ClientConfigurationError.createUntrustedAuthorityError = function () {
         return new ClientConfigurationError(ClientConfigurationErrorMessage.untrustedAuthority.code, ClientConfigurationErrorMessage.untrustedAuthority.desc);
     };
-    /*
+    /**
+     * Throws error when the AzureCloudInstance is set to an invalid value
+     */
+    ClientConfigurationError.createInvalidAzureCloudInstanceError = function () {
+        return new ClientConfigurationError(ClientConfigurationErrorMessage.invalidAzureCloudInstance.code, ClientConfigurationErrorMessage.invalidAzureCloudInstance.desc);
+    };
+    /**
      * Throws an error when the authentication scheme is set to SSH but the SSH public key is omitted from the request
      */
     ClientConfigurationError.createMissingSshJwkError = function () {
@@ -3084,7 +3114,8 @@ var DefaultStorageClass = /** @class */ (function (_super) {
 var DEFAULT_TOKEN_RENEWAL_OFFSET_SEC = 300;
 var DEFAULT_SYSTEM_OPTIONS = {
     tokenRenewalOffsetSeconds: DEFAULT_TOKEN_RENEWAL_OFFSET_SEC,
-    preventCorsPreflight: false
+    preventCorsPreflight: false,
+    proxyUrl: "",
 };
 var DEFAULT_LOGGER_IMPLEMENTATION = {
     loggerCallback: function () {
@@ -3124,6 +3155,10 @@ var DEFAULT_CLIENT_CREDENTIALS = {
     clientSecret: "",
     clientAssertion: undefined
 };
+var DEFAULT_AZURE_CLOUD_OPTIONS = {
+    azureCloudInstance: exports.AzureCloudInstance.None,
+    tenant: "" + Constants.DEFAULT_COMMON_TENANT
+};
 /**
  * Function that sets the default options when not explicitly configured from app developer
  *
@@ -3153,7 +3188,7 @@ function buildClientConfiguration(_a) {
  * @param authOptions
  */
 function buildAuthOptions(authOptions) {
-    return __assign({ clientCapabilities: [] }, authOptions);
+    return __assign({ clientCapabilities: [], azureCloudOptions: DEFAULT_AZURE_CLOUD_OPTIONS }, authOptions);
 }
 
 /*
@@ -3387,7 +3422,7 @@ var BaseClient = /** @class */ (function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.networkManager.sendPostRequest(thumbprint, tokenEndpoint, { body: queryString, headers: headers })];
+                    case 0: return [4 /*yield*/, this.networkManager.sendPostRequest(thumbprint, tokenEndpoint, { body: queryString, headers: headers, proxyUrl: this.config.systemOptions.proxyUrl })];
                     case 1:
                         response = _a.sent();
                         if (this.config.serverTelemetryManager && response.status < 500 && response.status !== 429) {
@@ -3821,6 +3856,12 @@ var RequestParameterBuilder = /** @class */ (function () {
     RequestParameterBuilder.prototype.addThrottling = function () {
         this.parameters.set(AADServerParamKeys.X_MS_LIB_CAPABILITY, ThrottlingConstants.X_MS_LIB_CAPABILITY_VALUE);
     };
+    /**
+     * Adds logout_hint parameter for "silent" logout which prevent server account picker
+     */
+    RequestParameterBuilder.prototype.addLogoutHint = function (logoutHint) {
+        this.parameters.set(AADServerParamKeys.LOGOUT_HINT, encodeURIComponent(logoutHint));
+    };
     /**
      * Utility to create a URL from the params map
      */
@@ -5294,6 +5335,9 @@ var AuthorizationCodeClient = /** @class */ (function (_super) {
         if (request.state) {
             parameterBuilder.addState(request.state);
         }
+        if (request.logoutHint) {
+            parameterBuilder.addLogoutHint(request.logoutHint);
+        }
         if (request.extraQueryParameters) {
             parameterBuilder.addExtraQueryParameters(request.extraQueryParameters);
         }
@@ -5390,7 +5434,8 @@ var DeviceCodeClient = /** @class */ (function (_super) {
                 switch (_b.label) {
                     case 0: return [4 /*yield*/, this.networkManager.sendPostRequest(thumbprint, deviceCodeEndpoint, {
                             body: queryString,
-                            headers: headers
+                            headers: headers,
+                            proxyUrl: this.config.systemOptions.proxyUrl
                         })];
                     case 1:
                         _a = (_b.sent()).body, userCode = _a.user_code, deviceCode = _a.device_code, verificationUri = _a.verification_uri, expiresIn = _a.expires_in, interval = _a.interval, message = _a.message;
@@ -6432,18 +6477,22 @@ var RegionDiscovery = /** @class */ (function () {
      *
      * @returns Promise<string | null>
      */
-    RegionDiscovery.prototype.detectRegion = function (environmentRegion, regionDiscoveryMetadata) {
+    RegionDiscovery.prototype.detectRegion = function (environmentRegion, regionDiscoveryMetadata, proxyUrl) {
         return __awaiter(this, void 0, void 0, function () {
-            var autodetectedRegionName, localIMDSVersionResponse, currentIMDSVersion, currentIMDSVersionResponse;
+            var autodetectedRegionName, options, localIMDSVersionResponse, currentIMDSVersion, currentIMDSVersionResponse;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         autodetectedRegionName = environmentRegion;
                         if (!!autodetectedRegionName) return [3 /*break*/, 8];
+                        options = RegionDiscovery.IMDS_OPTIONS;
+                        if (proxyUrl) {
+                            options.proxyUrl = proxyUrl;
+                        }
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 6, , 7]);
-                        return [4 /*yield*/, this.getRegionFromIMDS(Constants.IMDS_VERSION)];
+                        return [4 /*yield*/, this.getRegionFromIMDS(Constants.IMDS_VERSION, options)];
                     case 2:
                         localIMDSVersionResponse = _a.sent();
                         if (localIMDSVersionResponse.status === ResponseCodes.httpSuccess) {
@@ -6451,14 +6500,14 @@ var RegionDiscovery = /** @class */ (function () {
                             regionDiscoveryMetadata.region_source = RegionDiscoverySources.IMDS;
                         }
                         if (!(localIMDSVersionResponse.status === ResponseCodes.httpBadRequest)) return [3 /*break*/, 5];
-                        return [4 /*yield*/, this.getCurrentVersion()];
+                        return [4 /*yield*/, this.getCurrentVersion(options)];
                     case 3:
                         currentIMDSVersion = _a.sent();
                         if (!currentIMDSVersion) {
                             regionDiscoveryMetadata.region_source = RegionDiscoverySources.FAILED_AUTO_DETECTION;
                             return [2 /*return*/, null];
                         }
-                        return [4 /*yield*/, this.getRegionFromIMDS(currentIMDSVersion)];
+                        return [4 /*yield*/, this.getRegionFromIMDS(currentIMDSVersion, options)];
                     case 4:
                         currentIMDSVersionResponse = _a.sent();
                         if (currentIMDSVersionResponse.status === ResponseCodes.httpSuccess) {
@@ -6491,10 +6540,10 @@ var RegionDiscovery = /** @class */ (function () {
      * @param imdsEndpointUrl
      * @returns Promise<NetworkResponse<string>>
      */
-    RegionDiscovery.prototype.getRegionFromIMDS = function (version) {
+    RegionDiscovery.prototype.getRegionFromIMDS = function (version, options) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.networkInterface.sendGetRequestAsync(Constants.IMDS_ENDPOINT + "?api-version=" + version + "&format=text", RegionDiscovery.IMDS_OPTIONS, Constants.IMDS_TIMEOUT)];
+                return [2 /*return*/, this.networkInterface.sendGetRequestAsync(Constants.IMDS_ENDPOINT + "?api-version=" + version + "&format=text", options, Constants.IMDS_TIMEOUT)];
             });
         });
     };
@@ -6503,14 +6552,14 @@ var RegionDiscovery = /** @class */ (function () {
      *
      * @returns Promise<string | null>
      */
-    RegionDiscovery.prototype.getCurrentVersion = function () {
+    RegionDiscovery.prototype.getCurrentVersion = function (options) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
-                        return [4 /*yield*/, this.networkInterface.sendGetRequestAsync(Constants.IMDS_ENDPOINT + "?format=json", RegionDiscovery.IMDS_OPTIONS)];
+                        return [4 /*yield*/, this.networkInterface.sendGetRequestAsync(Constants.IMDS_ENDPOINT + "?format=json", options)];
                     case 1:
                         response = _a.sent();
                         // When IMDS endpoint is called without the api version query param, bad request response comes back with latest version.
@@ -6527,7 +6576,11 @@ var RegionDiscovery = /** @class */ (function () {
         });
     };
     // Options for the IMDS endpoint request
-    RegionDiscovery.IMDS_OPTIONS = { headers: { "Metadata": "true" } };
+    RegionDiscovery.IMDS_OPTIONS = {
+        headers: {
+            Metadata: "true",
+        },
+    };
     return RegionDiscovery;
 }());
 
@@ -6540,7 +6593,7 @@ var RegionDiscovery = /** @class */ (function () {
  * endpoint. It will store the pertinent config data in this object for use during token calls.
  */
 var Authority = /** @class */ (function () {
-    function Authority(authority, networkInterface, cacheManager, authorityOptions) {
+    function Authority(authority, networkInterface, cacheManager, authorityOptions, proxyUrl) {
         this.canonicalAuthority = authority;
         this._canonicalAuthority.validateAsUri();
         this.networkInterface = networkInterface;
@@ -6548,6 +6601,7 @@ var Authority = /** @class */ (function () {
         this.authorityOptions = authorityOptions;
         this.regionDiscovery = new RegionDiscovery(networkInterface);
         this.regionDiscoveryMetadata = { region_used: undefined, region_source: undefined, region_outcome: undefined };
+        this.proxyUrl = proxyUrl || Constants.EMPTY_STRING;
     }
     Object.defineProperty(Authority.prototype, "authorityType", {
         // See above for AuthorityType
@@ -6816,7 +6870,7 @@ var Authority = /** @class */ (function () {
                         metadata = _b.sent();
                         if (!metadata) return [3 /*break*/, 4];
                         if (!((_a = this.authorityOptions.azureRegionConfiguration) === null || _a === void 0 ? void 0 : _a.azureRegion)) return [3 /*break*/, 3];
-                        return [4 /*yield*/, this.regionDiscovery.detectRegion(this.authorityOptions.azureRegionConfiguration.environmentRegion, this.regionDiscoveryMetadata)];
+                        return [4 /*yield*/, this.regionDiscovery.detectRegion(this.authorityOptions.azureRegionConfiguration.environmentRegion, this.regionDiscoveryMetadata, this.proxyUrl)];
                     case 2:
                         autodetectedRegionName = _b.sent();
                         azureRegion = this.authorityOptions.azureRegionConfiguration.azureRegion === Constants.AZURE_REGION_AUTO_DISCOVER_FLAG
@@ -6879,19 +6933,25 @@ var Authority = /** @class */ (function () {
      */
     Authority.prototype.getEndpointMetadataFromNetwork = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var response;
+            var options, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        return [4 /*yield*/, this.networkInterface.sendGetRequestAsync(this.defaultOpenIdConfigurationEndpoint)];
+                        options = {};
+                        if (this.proxyUrl) {
+                            options.proxyUrl = this.proxyUrl;
+                        }
+                        _a.label = 1;
                     case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.networkInterface.sendGetRequestAsync(this.defaultOpenIdConfigurationEndpoint, options)];
+                    case 2:
                         response = _a.sent();
                         return [2 /*return*/, isOpenIdConfigResponse(response.body) ? response.body : null];
-                    case 2:
+                    case 3:
                         _a.sent();
                         return [2 /*return*/, null];
-                    case 3: return [2 /*return*/];
+                    case 4: return [2 /*return*/];
                 }
             });
         });
@@ -6961,16 +7021,20 @@ var Authority = /** @class */ (function () {
      */
     Authority.prototype.getCloudDiscoveryMetadataFromNetwork = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var instanceDiscoveryEndpoint, match, response, metadata;
+            var instanceDiscoveryEndpoint, options, match, response, metadata;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         instanceDiscoveryEndpoint = "" + Constants.AAD_INSTANCE_DISCOVERY_ENDPT + this.canonicalAuthority + "oauth2/v2.0/authorize";
+                        options = {};
+                        if (this.proxyUrl) {
+                            options.proxyUrl = this.proxyUrl;
+                        }
                         match = null;
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, this.networkInterface.sendGetRequestAsync(instanceDiscoveryEndpoint)];
+                        return [4 /*yield*/, this.networkInterface.sendGetRequestAsync(instanceDiscoveryEndpoint, options)];
                     case 2:
                         response = _a.sent();
                         metadata = isCloudInstanceDiscoveryResponse(response.body) ? response.body.metadata : [];
@@ -6985,7 +7049,7 @@ var Authority = /** @class */ (function () {
                         return [2 /*return*/, null];
                     case 4:
                         if (!match) {
-                            // Custom Domain scenario, host is trusted because Instance Discovery call succeeded 
+                            // Custom Domain scenario, host is trusted because Instance Discovery call succeeded
                             match = Authority.createCloudDiscoveryMetadataFromHost(this.hostnameAndPort);
                         }
                         return [2 /*return*/, match];
@@ -7003,6 +7067,19 @@ var Authority = /** @class */ (function () {
         });
         return matches.length > 0;
     };
+    /**
+     * helper function to populate the authority based on azureCloudOptions
+     * @param authorityString
+     * @param azureCloudOptions
+     */
+    Authority.generateAuthority = function (authorityString, azureCloudOptions) {
+        var authorityAzureCloudInstance;
+        if (azureCloudOptions && azureCloudOptions.azureCloudInstance !== exports.AzureCloudInstance.None) {
+            var tenant = azureCloudOptions.tenant ? azureCloudOptions.tenant : Constants.DEFAULT_COMMON_TENANT;
+            authorityAzureCloudInstance = azureCloudOptions.azureCloudInstance + "/" + tenant + "/";
+        }
+        return authorityAzureCloudInstance ? authorityAzureCloudInstance : authorityString;
+    };
     /**
      * Creates cloud discovery metadata object from a given host
      * @param host
@@ -7112,13 +7189,13 @@ var AuthorityFactory = /** @class */ (function () {
      * @param networkClient
      * @param protocolMode
      */
-    AuthorityFactory.createDiscoveredInstance = function (authorityUri, networkClient, cacheManager, authorityOptions) {
+    AuthorityFactory.createDiscoveredInstance = function (authorityUri, networkClient, cacheManager, authorityOptions, proxyUrl) {
         return __awaiter(this, void 0, void 0, function () {
             var acquireTokenAuthority, e_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        acquireTokenAuthority = AuthorityFactory.createInstance(authorityUri, networkClient, cacheManager, authorityOptions);
+                        acquireTokenAuthority = AuthorityFactory.createInstance(authorityUri, networkClient, cacheManager, authorityOptions, proxyUrl);
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
@@ -7144,12 +7221,12 @@ var AuthorityFactory = /** @class */ (function () {
      * @param networkInterface
      * @param protocolMode
      */
-    AuthorityFactory.createInstance = function (authorityUrl, networkInterface, cacheManager, authorityOptions) {
+    AuthorityFactory.createInstance = function (authorityUrl, networkInterface, cacheManager, authorityOptions, proxyUrl) {
         // Throw error if authority url is empty
         if (StringUtils.isEmpty(authorityUrl)) {
             throw ClientConfigurationError.createUrlEmptyError();
         }
-        return new Authority(authorityUrl, networkInterface, cacheManager, authorityOptions);
+        return new Authority(authorityUrl, networkInterface, cacheManager, authorityOptions, proxyUrl);
     };
     return AuthorityFactory;
 }());