@azure/msal-common 6.3.0 → 6.4.0

package/dist/index.cjs.js

@@ -1,4 +1,4 @@
-/*! @azure/msal-common v6.3.0 2022-05-02 */
+/*! @azure/msal-common v6.4.0 2022-06-06 */
 'use strict';
 'use strict';
 
@@ -462,7 +462,12 @@ var CacheOutcome;
     CacheOutcome["NO_CACHED_ACCESS_TOKEN"] = "2";
     CacheOutcome["CACHED_ACCESS_TOKEN_EXPIRED"] = "3";
     CacheOutcome["REFRESH_CACHED_ACCESS_TOKEN"] = "4";
-})(CacheOutcome || (CacheOutcome = {}));
+})(CacheOutcome || (CacheOutcome = {}));
+var JsonTypes;
+(function (JsonTypes) {
+    JsonTypes["Jwt"] = "JWT";
+    JsonTypes["Jwk"] = "JWK";
+})(JsonTypes || (JsonTypes = {}));
 
 /*
  * Copyright (c) Microsoft Corporation. All rights reserved.
@@ -767,6 +772,10 @@ var ClientAuthErrorMessage = {
     logoutNotSupported: {
         code: "end_session_endpoint_not_supported",
         desc: "Provided authority does not support logout."
+    },
+    keyIdMissing: {
+        code: "key_id_missing",
+        desc: "A keyId value is missing from the requested bound token's cache record and is required to match the token to it's stored binding key."
     }
 };
 /**
@@ -1036,6 +1045,12 @@ var ClientAuthError = /** @class */ (function (_super) {
     ClientAuthError.createLogoutNotSupportedError = function () {
         return new ClientAuthError(ClientAuthErrorMessage.logoutNotSupported.code, ClientAuthErrorMessage.logoutNotSupported.desc);
     };
+    /**
+     * Create an error when kid attribute is missing from a PoP token's cache record
+     */
+    ClientAuthError.createKeyIdMissingError = function () {
+        return new ClientAuthError(ClientAuthErrorMessage.keyIdMissing.code, ClientAuthErrorMessage.keyIdMissing.desc);
+    };
     return ClientAuthError;
 }(AuthError));
 
@@ -1342,7 +1357,7 @@ var Logger = /** @class */ (function () {
 
 /* eslint-disable header/header */
 var name = "@azure/msal-common";
-var version = "6.3.0";
+var version = "6.4.0";
 
 /*
  * Copyright (c) Microsoft Corporation. All rights reserved.
@@ -3860,14 +3875,14 @@ var RequestParameterBuilder = /** @class */ (function () {
      * @param username
      */
     RequestParameterBuilder.prototype.addUsername = function (username) {
-        this.parameters.set(PasswordGrantConstants.username, username);
+        this.parameters.set(PasswordGrantConstants.username, encodeURIComponent(username));
     };
     /**
      * adds `password` for Password Grant flow
      * @param password
      */
     RequestParameterBuilder.prototype.addPassword = function (password) {
-        this.parameters.set(PasswordGrantConstants.password, password);
+        this.parameters.set(PasswordGrantConstants.password, encodeURIComponent(password));
     };
     /**
      * add pop_jwk to query params
@@ -4570,34 +4585,30 @@ var PopTokenGenerator = /** @class */ (function () {
     }
     /**
      * Generates the req_cnf validated at the RP in the POP protocol for SHR parameters
+     * and returns an object containing the keyid, the full req_cnf string and the req_cnf string hash
      * @param request
      * @returns
      */
     PopTokenGenerator.prototype.generateCnf = function (request) {
         return __awaiter(this, void 0, void 0, function () {
-            var reqCnf;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var reqCnf, reqCnfString, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0: return [4 /*yield*/, this.generateKid(request)];
                     case 1:
-                        reqCnf = _a.sent();
-                        return [2 /*return*/, this.cryptoUtils.base64Encode(JSON.stringify(reqCnf))];
+                        reqCnf = _b.sent();
+                        reqCnfString = this.cryptoUtils.base64Encode(JSON.stringify(reqCnf));
+                        _a = {
+                            kid: reqCnf.kid,
+                            reqCnfString: reqCnfString
+                        };
+                        return [4 /*yield*/, this.cryptoUtils.hashString(reqCnfString)];
+                    case 2: return [2 /*return*/, (_a.reqCnfHash = _b.sent(),
+                            _a)];
                 }
             });
         });
     };
-    /**
-     * Generates the hash of the req_cnf
-     * @param cnf
-     * @returns
-     */
-    PopTokenGenerator.prototype.generateCnfHash = function (cnf) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, this.cryptoUtils.hashString(cnf)];
-            });
-        });
-    };
     /**
      * Generates key_id for a SHR token request
      * @param request
@@ -4625,16 +4636,10 @@ var PopTokenGenerator = /** @class */ (function () {
      * @param request
      * @returns
      */
-    PopTokenGenerator.prototype.signPopToken = function (accessToken, request) {
-        var _a;
+    PopTokenGenerator.prototype.signPopToken = function (accessToken, keyId, request) {
         return __awaiter(this, void 0, void 0, function () {
-            var tokenClaims;
-            return __generator(this, function (_b) {
-                tokenClaims = AuthToken.extractTokenClaims(accessToken, this.cryptoUtils);
-                if (!((_a = tokenClaims === null || tokenClaims === void 0 ? void 0 : tokenClaims.cnf) === null || _a === void 0 ? void 0 : _a.kid)) {
-                    throw ClientAuthError.createTokenClaimsRequiredError();
-                }
-                return [2 /*return*/, this.signPayload(accessToken, tokenClaims.cnf.kid, request)];
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.signPayload(accessToken, keyId, request)];
             });
         });
     };
@@ -4646,7 +4651,7 @@ var PopTokenGenerator = /** @class */ (function () {
      * @param claims
      * @returns
      */
-    PopTokenGenerator.prototype.signPayload = function (payload, kid, request, claims) {
+    PopTokenGenerator.prototype.signPayload = function (payload, keyId, request, claims) {
         return __awaiter(this, void 0, void 0, function () {
             var resourceRequestMethod, resourceRequestUri, shrClaims, shrNonce, resourceUrlString, resourceUrlComponents;
             return __generator(this, function (_a) {
@@ -4655,7 +4660,7 @@ var PopTokenGenerator = /** @class */ (function () {
                         resourceRequestMethod = request.resourceRequestMethod, resourceRequestUri = request.resourceRequestUri, shrClaims = request.shrClaims, shrNonce = request.shrNonce;
                         resourceUrlString = (resourceRequestUri) ? new UrlString(resourceRequestUri) : undefined;
                         resourceUrlComponents = resourceUrlString === null || resourceUrlString === void 0 ? void 0 : resourceUrlString.getUrlComponents();
-                        return [4 /*yield*/, this.cryptoUtils.signJwt(__assign({ at: payload, ts: TimeUtils.nowSeconds(), m: resourceRequestMethod === null || resourceRequestMethod === void 0 ? void 0 : resourceRequestMethod.toUpperCase(), u: resourceUrlComponents === null || resourceUrlComponents === void 0 ? void 0 : resourceUrlComponents.HostNameAndPort, nonce: shrNonce || this.cryptoUtils.createNewGuid(), p: resourceUrlComponents === null || resourceUrlComponents === void 0 ? void 0 : resourceUrlComponents.AbsolutePath, q: (resourceUrlComponents === null || resourceUrlComponents === void 0 ? void 0 : resourceUrlComponents.QueryString) ? [[], resourceUrlComponents.QueryString] : undefined, client_claims: shrClaims || undefined }, claims), kid, request.correlationId)];
+                        return [4 /*yield*/, this.cryptoUtils.signJwt(__assign({ at: payload, ts: TimeUtils.nowSeconds(), m: resourceRequestMethod === null || resourceRequestMethod === void 0 ? void 0 : resourceRequestMethod.toUpperCase(), u: resourceUrlComponents === null || resourceUrlComponents === void 0 ? void 0 : resourceUrlComponents.HostNameAndPort, nonce: shrNonce || this.cryptoUtils.createNewGuid(), p: resourceUrlComponents === null || resourceUrlComponents === void 0 ? void 0 : resourceUrlComponents.AbsolutePath, q: (resourceUrlComponents === null || resourceUrlComponents === void 0 ? void 0 : resourceUrlComponents.QueryString) ? [[], resourceUrlComponents.QueryString] : undefined, client_claims: shrClaims || undefined }, claims), keyId, request.correlationId)];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
@@ -4974,9 +4979,9 @@ var ResponseHandler = /** @class */ (function () {
     ResponseHandler.generateAuthenticationResult = function (cryptoObj, authority, cacheRecord, fromTokenCache, request, idTokenObj, requestState, code) {
         var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function () {
-            var accessToken, responseScopes, expiresOn, extExpiresOn, familyId, popTokenGenerator, uid, tid;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
+            var accessToken, responseScopes, expiresOn, extExpiresOn, familyId, popTokenGenerator, _d, secret, keyId, uid, tid;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
                     case 0:
                         accessToken = Constants.EMPTY_STRING;
                         responseScopes = [];
@@ -4985,18 +4990,22 @@ var ResponseHandler = /** @class */ (function () {
                         if (!cacheRecord.accessToken) return [3 /*break*/, 4];
                         if (!(cacheRecord.accessToken.tokenType === exports.AuthenticationScheme.POP)) return [3 /*break*/, 2];
                         popTokenGenerator = new PopTokenGenerator(cryptoObj);
-                        return [4 /*yield*/, popTokenGenerator.signPopToken(cacheRecord.accessToken.secret, request)];
+                        _d = cacheRecord.accessToken, secret = _d.secret, keyId = _d.keyId;
+                        if (!keyId) {
+                            throw ClientAuthError.createKeyIdMissingError();
+                        }
+                        return [4 /*yield*/, popTokenGenerator.signPopToken(secret, keyId, request)];
                     case 1:
-                        accessToken = _d.sent();
+                        accessToken = _e.sent();
                         return [3 /*break*/, 3];
                     case 2:
                         accessToken = cacheRecord.accessToken.secret;
-                        _d.label = 3;
+                        _e.label = 3;
                     case 3:
                         responseScopes = ScopeSet.fromString(cacheRecord.accessToken.target).asArray();
                         expiresOn = new Date(Number(cacheRecord.accessToken.expiresOn) * 1000);
                         extExpiresOn = new Date(Number(cacheRecord.accessToken.extendedExpiresOn) * 1000);
-                        _d.label = 4;
+                        _e.label = 4;
                     case 4:
                         if (cacheRecord.appMetadata) {
                             familyId = cacheRecord.appMetadata.familyId === THE_FAMILY_ID ? THE_FAMILY_ID : Constants.EMPTY_STRING;
@@ -5196,7 +5205,7 @@ var AuthorizationCodeClient = /** @class */ (function (_super) {
      */
     AuthorizationCodeClient.prototype.createTokenRequestBody = function (request) {
         return __awaiter(this, void 0, void 0, function () {
-            var parameterBuilder, clientAssertion, popTokenGenerator, cnfString, correlationId, ccsCred, clientInfo, clientInfo;
+            var parameterBuilder, clientAssertion, popTokenGenerator, reqCnfData, correlationId, ccsCred, clientInfo, clientInfo;
             var _a;
             return __generator(this, function (_b) {
                 switch (_b.label) {
@@ -5233,8 +5242,8 @@ var AuthorizationCodeClient = /** @class */ (function (_super) {
                         if (this.config.clientCredentials.clientSecret) {
                             parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret);
                         }
-                        if (this.config.clientCredentials.clientAssertion) {
-                            clientAssertion = this.config.clientCredentials.clientAssertion;
+                        clientAssertion = request.clientAssertion || this.config.clientCredentials.clientAssertion;
+                        if (clientAssertion) {
                             parameterBuilder.addClientAssertion(clientAssertion.assertion);
                             parameterBuilder.addClientAssertionType(clientAssertion.assertionType);
                         }
@@ -5244,8 +5253,9 @@ var AuthorizationCodeClient = /** @class */ (function (_super) {
                         popTokenGenerator = new PopTokenGenerator(this.cryptoUtils);
                         return [4 /*yield*/, popTokenGenerator.generateCnf(request)];
                     case 1:
-                        cnfString = _b.sent();
-                        parameterBuilder.addPopToken(cnfString);
+                        reqCnfData = _b.sent();
+                        // SPA PoP requires full Base64Url encoded req_cnf string (unhashed)
+                        parameterBuilder.addPopToken(reqCnfData.reqCnfString);
                         return [3 /*break*/, 3];
                     case 2:
                         if (request.authenticationScheme === exports.AuthenticationScheme.SSH) {
@@ -5316,7 +5326,7 @@ var AuthorizationCodeClient = /** @class */ (function (_super) {
      */
     AuthorizationCodeClient.prototype.createAuthCodeUrlQueryString = function (request) {
         return __awaiter(this, void 0, void 0, function () {
-            var parameterBuilder, requestScopes, correlationId, accountSid, clientInfo, clientInfo, popTokenGenerator, cnf, cnfHash;
+            var parameterBuilder, requestScopes, correlationId, accountSid, clientInfo, clientInfo, popTokenGenerator, reqCnfData;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -5408,20 +5418,17 @@ var AuthorizationCodeClient = /** @class */ (function (_super) {
                         if (request.extraQueryParameters) {
                             parameterBuilder.addExtraQueryParameters(request.extraQueryParameters);
                         }
-                        if (!request.nativeBroker) return [3 /*break*/, 3];
+                        if (!request.nativeBroker) return [3 /*break*/, 2];
                         // signal ests that this is a WAM call
                         parameterBuilder.addNativeBroker();
-                        if (!(request.authenticationScheme === exports.AuthenticationScheme.POP)) return [3 /*break*/, 3];
+                        if (!(request.authenticationScheme === exports.AuthenticationScheme.POP)) return [3 /*break*/, 2];
                         popTokenGenerator = new PopTokenGenerator(this.cryptoUtils);
                         return [4 /*yield*/, popTokenGenerator.generateCnf(request)];
                     case 1:
-                        cnf = _a.sent();
-                        return [4 /*yield*/, popTokenGenerator.generateCnfHash(cnf)];
-                    case 2:
-                        cnfHash = _a.sent();
-                        parameterBuilder.addPopToken(cnfHash);
-                        _a.label = 3;
-                    case 3: return [2 /*return*/, parameterBuilder.createQueryString()];
+                        reqCnfData = _a.sent();
+                        parameterBuilder.addPopToken(reqCnfData.reqCnfHash);
+                        _a.label = 2;
+                    case 2: return [2 /*return*/, parameterBuilder.createQueryString()];
                 }
             });
         });
@@ -5818,7 +5825,7 @@ var RefreshTokenClient = /** @class */ (function (_super) {
      */
     RefreshTokenClient.prototype.createTokenRequestBody = function (request) {
         return __awaiter(this, void 0, void 0, function () {
-            var parameterBuilder, correlationId, clientAssertion, popTokenGenerator, cnfString, clientInfo;
+            var parameterBuilder, correlationId, clientAssertion, popTokenGenerator, reqCnfData, clientInfo;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -5839,8 +5846,8 @@ var RefreshTokenClient = /** @class */ (function (_super) {
                         if (this.config.clientCredentials.clientSecret) {
                             parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret);
                         }
-                        if (this.config.clientCredentials.clientAssertion) {
-                            clientAssertion = this.config.clientCredentials.clientAssertion;
+                        clientAssertion = request.clientAssertion || this.config.clientCredentials.clientAssertion;
+                        if (clientAssertion) {
                             parameterBuilder.addClientAssertion(clientAssertion.assertion);
                             parameterBuilder.addClientAssertionType(clientAssertion.assertionType);
                         }
@@ -5848,8 +5855,9 @@ var RefreshTokenClient = /** @class */ (function (_super) {
                         popTokenGenerator = new PopTokenGenerator(this.cryptoUtils);
                         return [4 /*yield*/, popTokenGenerator.generateCnf(request)];
                     case 1:
-                        cnfString = _a.sent();
-                        parameterBuilder.addPopToken(cnfString);
+                        reqCnfData = _a.sent();
+                        // SPA PoP requires full Base64Url encoded req_cnf string (unhashed)
+                        parameterBuilder.addPopToken(reqCnfData.reqCnfString);
                         return [3 /*break*/, 3];
                     case 2:
                         if (request.authenticationScheme === exports.AuthenticationScheme.SSH) {
@@ -6038,8 +6046,9 @@ var ClientCredentialClient = /** @class */ (function (_super) {
         if (this.config.clientCredentials.clientSecret) {
             parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret);
         }
-        if (this.config.clientCredentials.clientAssertion) {
-            var clientAssertion = this.config.clientCredentials.clientAssertion;
+        // Use clientAssertion from request, fallback to client assertion in base configuration
+        var clientAssertion = request.clientAssertion || this.config.clientCredentials.clientAssertion;
+        if (clientAssertion) {
             parameterBuilder.addClientAssertion(clientAssertion.assertion);
             parameterBuilder.addClientAssertionType(clientAssertion.assertionType);
         }
@@ -6243,8 +6252,9 @@ var OnBehalfOfClient = /** @class */ (function (_super) {
         if (this.config.clientCredentials.clientSecret) {
             parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret);
         }
-        if (this.config.clientCredentials.clientAssertion) {
-            var clientAssertion = this.config.clientCredentials.clientAssertion;
+        // Use clientAssertion from request, fallback to client assertion in base configuration
+        var clientAssertion = request.clientAssertion || this.config.clientCredentials.clientAssertion;
+        if (clientAssertion) {
             parameterBuilder.addClientAssertion(clientAssertion.assertion);
             parameterBuilder.addClientAssertionType(clientAssertion.assertionType);
         }
@@ -6458,8 +6468,9 @@ var UsernamePasswordClient = /** @class */ (function (_super) {
         if (this.config.clientCredentials.clientSecret) {
             parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret);
         }
-        if (this.config.clientCredentials.clientAssertion) {
-            var clientAssertion = this.config.clientCredentials.clientAssertion;
+        // Use clientAssertion from request, fallback to client assertion in base configuration
+        var clientAssertion = request.clientAssertion || this.config.clientCredentials.clientAssertion;
+        if (clientAssertion) {
             parameterBuilder.addClientAssertion(clientAssertion.assertion);
             parameterBuilder.addClientAssertionType(clientAssertion.assertionType);
         }
@@ -7416,6 +7427,87 @@ var StubbedNetworkModule = {
     }
 };
 
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * ClientAuthErrorMessage class containing string constants used by error codes and messages.
+ */
+var JoseHeaderErrorMessage = {
+    missingKidError: {
+        code: "missing_kid_error",
+        desc: "The JOSE Header for the requested JWT, JWS or JWK object requires a keyId to be configured as the 'kid' header claim. No 'kid' value was provided."
+    },
+    missingAlgError: {
+        code: "missing_alg_error",
+        desc: "The JOSE Header for the requested JWT, JWS or JWK object requires an algorithm to be specified as the 'alg' header claim. No 'alg' value was provided."
+    },
+};
+/**
+ * Error thrown when there is an error in the client code running on the browser.
+ */
+var JoseHeaderError = /** @class */ (function (_super) {
+    __extends(JoseHeaderError, _super);
+    function JoseHeaderError(errorCode, errorMessage) {
+        var _this = _super.call(this, errorCode, errorMessage) || this;
+        _this.name = "JoseHeaderError";
+        Object.setPrototypeOf(_this, JoseHeaderError.prototype);
+        return _this;
+    }
+    /**
+     * Creates an error thrown when keyId isn't set on JOSE header.
+     */
+    JoseHeaderError.createMissingKidError = function () {
+        return new JoseHeaderError(JoseHeaderErrorMessage.missingKidError.code, JoseHeaderErrorMessage.missingKidError.desc);
+    };
+    /**
+     * Creates an error thrown when algorithm isn't set on JOSE header.
+     */
+    JoseHeaderError.createMissingAlgError = function () {
+        return new JoseHeaderError(JoseHeaderErrorMessage.missingAlgError.code, JoseHeaderErrorMessage.missingAlgError.desc);
+    };
+    return JoseHeaderError;
+}(AuthError));
+
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var JoseHeader = /** @class */ (function () {
+    function JoseHeader(options) {
+        this.typ = options.typ;
+        this.alg = options.alg;
+        this.kid = options.kid;
+    }
+    /**
+     * Builds SignedHttpRequest formatted JOSE Header from the
+     * JOSE Header options provided or previously set on the object and returns
+     * the stringified header object.
+     * Throws if keyId or algorithm aren't provided since they are required for Access Token Binding.
+     * @param shrHeaderOptions
+     * @returns
+     */
+    JoseHeader.getShrHeaderString = function (shrHeaderOptions) {
+        // KeyID is required on the SHR header
+        if (!shrHeaderOptions.kid) {
+            throw JoseHeaderError.createMissingKidError();
+        }
+        // Alg is required on the SHR header
+        if (!shrHeaderOptions.alg) {
+            throw JoseHeaderError.createMissingAlgError();
+        }
+        var shrHeader = new JoseHeader({
+            // Access Token PoP headers must have type JWT, but the type header can be overriden for special cases
+            typ: shrHeaderOptions.typ || JsonTypes.Jwt,
+            kid: shrHeaderOptions.kid,
+            alg: shrHeaderOptions.alg
+        });
+        return JSON.stringify(shrHeader);
+    };
+    return JoseHeader;
+}());
+
 /*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
@@ -8054,6 +8146,7 @@ exports.IdToken = AuthToken;
 exports.IdTokenEntity = IdTokenEntity;
 exports.InteractionRequiredAuthError = InteractionRequiredAuthError;
 exports.InteractionRequiredAuthErrorMessage = InteractionRequiredAuthErrorMessage;
+exports.JoseHeader = JoseHeader;
 exports.Logger = Logger;
 exports.NetworkManager = NetworkManager;
 exports.OIDC_DEFAULT_SCOPES = OIDC_DEFAULT_SCOPES;