@azure/msal-browser 3.20.0 → 3.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (208) hide show
  1. package/dist/app/IPublicClientApplication.d.ts +53 -53
  2. package/dist/app/IPublicClientApplication.mjs +105 -105
  3. package/dist/app/PublicClientApplication.d.ts +293 -293
  4. package/dist/app/PublicClientApplication.mjs +364 -364
  5. package/dist/app/PublicClientNext.d.ts +276 -276
  6. package/dist/app/PublicClientNext.mjs +354 -354
  7. package/dist/broker/nativeBroker/NativeMessageHandler.d.ts +62 -62
  8. package/dist/broker/nativeBroker/NativeMessageHandler.mjs +254 -254
  9. package/dist/broker/nativeBroker/NativeRequest.d.ts +45 -45
  10. package/dist/broker/nativeBroker/NativeResponse.d.ts +48 -48
  11. package/dist/broker/nativeBroker/NativeStatusCodes.d.ts +7 -7
  12. package/dist/broker/nativeBroker/NativeStatusCodes.mjs +11 -11
  13. package/dist/cache/AccountManager.d.ts +48 -48
  14. package/dist/cache/AccountManager.mjs +126 -126
  15. package/dist/cache/AsyncMemoryStorage.d.ts +50 -50
  16. package/dist/cache/AsyncMemoryStorage.mjs +131 -131
  17. package/dist/cache/BrowserCacheManager.d.ts +410 -385
  18. package/dist/cache/BrowserCacheManager.d.ts.map +1 -1
  19. package/dist/cache/BrowserCacheManager.mjs +1364 -1294
  20. package/dist/cache/BrowserCacheManager.mjs.map +1 -1
  21. package/dist/cache/BrowserStorage.d.ts +11 -11
  22. package/dist/cache/BrowserStorage.mjs +32 -32
  23. package/dist/cache/DatabaseStorage.d.ts +56 -56
  24. package/dist/cache/DatabaseStorage.mjs +200 -200
  25. package/dist/cache/IAsyncStorage.d.ts +27 -27
  26. package/dist/cache/ITokenCache.d.ts +11 -11
  27. package/dist/cache/IWindowStorage.d.ts +27 -27
  28. package/dist/cache/MemoryStorage.d.ts +11 -11
  29. package/dist/cache/MemoryStorage.mjs +31 -31
  30. package/dist/cache/TokenCache.d.ts +77 -77
  31. package/dist/cache/TokenCache.mjs +195 -195
  32. package/dist/config/Configuration.d.ts +213 -208
  33. package/dist/config/Configuration.d.ts.map +1 -1
  34. package/dist/config/Configuration.mjs +128 -128
  35. package/dist/config/Configuration.mjs.map +1 -1
  36. package/dist/controllers/ControllerFactory.d.ts +5 -5
  37. package/dist/controllers/ControllerFactory.mjs +25 -25
  38. package/dist/controllers/IController.d.ts +60 -60
  39. package/dist/controllers/NestedAppAuthController.d.ts +202 -202
  40. package/dist/controllers/NestedAppAuthController.mjs +473 -473
  41. package/dist/controllers/StandardController.d.ts +405 -405
  42. package/dist/controllers/StandardController.d.ts.map +1 -1
  43. package/dist/controllers/StandardController.mjs +1334 -1316
  44. package/dist/controllers/StandardController.mjs.map +1 -1
  45. package/dist/controllers/UnknownOperatingContextController.d.ts +86 -86
  46. package/dist/controllers/UnknownOperatingContextController.mjs +256 -256
  47. package/dist/crypto/BrowserCrypto.d.ts +52 -52
  48. package/dist/crypto/BrowserCrypto.mjs +151 -151
  49. package/dist/crypto/CryptoOps.d.ts +74 -74
  50. package/dist/crypto/CryptoOps.mjs +176 -176
  51. package/dist/crypto/PkceGenerator.d.ts +8 -8
  52. package/dist/crypto/PkceGenerator.mjs +54 -54
  53. package/dist/crypto/SignedHttpRequest.d.ts +30 -30
  54. package/dist/crypto/SignedHttpRequest.mjs +39 -39
  55. package/dist/encode/Base64Decode.d.ts +9 -9
  56. package/dist/encode/Base64Decode.mjs +36 -36
  57. package/dist/encode/Base64Encode.d.ts +19 -19
  58. package/dist/encode/Base64Encode.mjs +43 -43
  59. package/dist/error/BrowserAuthError.d.ts +256 -255
  60. package/dist/error/BrowserAuthError.d.ts.map +1 -1
  61. package/dist/error/BrowserAuthError.mjs +265 -264
  62. package/dist/error/BrowserAuthError.mjs.map +1 -1
  63. package/dist/error/BrowserAuthErrorCodes.d.ts +47 -46
  64. package/dist/error/BrowserAuthErrorCodes.d.ts.map +1 -1
  65. package/dist/error/BrowserAuthErrorCodes.mjs +53 -52
  66. package/dist/error/BrowserAuthErrorCodes.mjs.map +1 -1
  67. package/dist/error/BrowserConfigurationAuthError.d.ts +33 -33
  68. package/dist/error/BrowserConfigurationAuthError.mjs +40 -40
  69. package/dist/error/BrowserConfigurationAuthError.mjs.map +1 -1
  70. package/dist/error/BrowserConfigurationAuthErrorCodes.d.ts +3 -3
  71. package/dist/error/BrowserConfigurationAuthErrorCodes.mjs +7 -7
  72. package/dist/error/NativeAuthError.d.ts +29 -29
  73. package/dist/error/NativeAuthError.mjs +60 -60
  74. package/dist/error/NativeAuthErrorCodes.d.ts +2 -2
  75. package/dist/error/NativeAuthErrorCodes.mjs +6 -6
  76. package/dist/error/NestedAppAuthError.d.ts +14 -14
  77. package/dist/error/NestedAppAuthError.mjs +23 -23
  78. package/dist/event/EventHandler.d.ts +41 -41
  79. package/dist/event/EventHandler.mjs +125 -125
  80. package/dist/event/EventMessage.d.ts +25 -25
  81. package/dist/event/EventMessage.mjs +68 -68
  82. package/dist/event/EventType.d.ts +29 -29
  83. package/dist/event/EventType.mjs +32 -32
  84. package/dist/index.d.ts +40 -40
  85. package/dist/index.mjs +1 -1
  86. package/dist/interaction_client/BaseInteractionClient.d.ts +50 -50
  87. package/dist/interaction_client/BaseInteractionClient.mjs +106 -106
  88. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.d.ts +4 -4
  89. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.mjs +10 -10
  90. package/dist/interaction_client/NativeInteractionClient.d.ts +151 -151
  91. package/dist/interaction_client/NativeInteractionClient.mjs +621 -621
  92. package/dist/interaction_client/PopupClient.d.ts +118 -105
  93. package/dist/interaction_client/PopupClient.d.ts.map +1 -1
  94. package/dist/interaction_client/PopupClient.mjs +460 -434
  95. package/dist/interaction_client/PopupClient.mjs.map +1 -1
  96. package/dist/interaction_client/RedirectClient.d.ts +50 -50
  97. package/dist/interaction_client/RedirectClient.d.ts.map +1 -1
  98. package/dist/interaction_client/RedirectClient.mjs +349 -317
  99. package/dist/interaction_client/RedirectClient.mjs.map +1 -1
  100. package/dist/interaction_client/SilentAuthCodeClient.d.ts +23 -23
  101. package/dist/interaction_client/SilentAuthCodeClient.mjs +57 -57
  102. package/dist/interaction_client/SilentCacheClient.d.ts +16 -16
  103. package/dist/interaction_client/SilentCacheClient.mjs +42 -42
  104. package/dist/interaction_client/SilentIframeClient.d.ts +32 -32
  105. package/dist/interaction_client/SilentIframeClient.d.ts.map +1 -1
  106. package/dist/interaction_client/SilentIframeClient.mjs +111 -101
  107. package/dist/interaction_client/SilentIframeClient.mjs.map +1 -1
  108. package/dist/interaction_client/SilentRefreshClient.d.ts +20 -20
  109. package/dist/interaction_client/SilentRefreshClient.mjs +47 -47
  110. package/dist/interaction_client/StandardInteractionClient.d.ts +48 -48
  111. package/dist/interaction_client/StandardInteractionClient.mjs +199 -199
  112. package/dist/interaction_handler/InteractionHandler.d.ts +33 -33
  113. package/dist/interaction_handler/InteractionHandler.mjs +93 -93
  114. package/dist/interaction_handler/RedirectHandler.d.ts +32 -32
  115. package/dist/interaction_handler/RedirectHandler.d.ts.map +1 -1
  116. package/dist/interaction_handler/RedirectHandler.mjs +135 -134
  117. package/dist/interaction_handler/RedirectHandler.mjs.map +1 -1
  118. package/dist/interaction_handler/SilentHandler.d.ts +13 -13
  119. package/dist/interaction_handler/SilentHandler.mjs +134 -134
  120. package/dist/naa/AccountInfo.d.ts +11 -11
  121. package/dist/naa/AuthBridge.d.ts +8 -8
  122. package/dist/naa/AuthResult.d.ts +6 -6
  123. package/dist/naa/BridgeAccountContext.d.ts +12 -12
  124. package/dist/naa/BridgeCapabilities.d.ts +3 -3
  125. package/dist/naa/BridgeError.d.ts +9 -9
  126. package/dist/naa/BridgeError.mjs +7 -7
  127. package/dist/naa/BridgeProxy.d.ts +67 -67
  128. package/dist/naa/BridgeProxy.d.ts.map +1 -1
  129. package/dist/naa/BridgeProxy.mjs +153 -148
  130. package/dist/naa/BridgeProxy.mjs.map +1 -1
  131. package/dist/naa/BridgeRequest.d.ts +7 -7
  132. package/dist/naa/BridgeRequestEnvelope.d.ts +12 -12
  133. package/dist/naa/BridgeResponseEnvelope.d.ts +13 -13
  134. package/dist/naa/BridgeStatusCode.d.ts +11 -11
  135. package/dist/naa/BridgeStatusCode.mjs +14 -14
  136. package/dist/naa/IBridgeProxy.d.ts +10 -10
  137. package/dist/naa/InitContext.d.ts +8 -8
  138. package/dist/naa/TokenRequest.d.ts +18 -18
  139. package/dist/naa/TokenResponse.d.ts +13 -13
  140. package/dist/naa/mapping/NestedAppAuthAdapter.d.ts +35 -35
  141. package/dist/naa/mapping/NestedAppAuthAdapter.mjs +179 -179
  142. package/dist/navigation/INavigationClient.d.ts +16 -16
  143. package/dist/navigation/NavigationClient.d.ts +22 -22
  144. package/dist/navigation/NavigationClient.mjs +40 -40
  145. package/dist/navigation/NavigationOptions.d.ts +12 -12
  146. package/dist/network/FetchClient.d.ts +26 -26
  147. package/dist/network/FetchClient.mjs +99 -99
  148. package/dist/operatingcontext/BaseOperatingContext.d.ts +41 -41
  149. package/dist/operatingcontext/BaseOperatingContext.mjs +94 -94
  150. package/dist/operatingcontext/NestedAppOperatingContext.d.ts +34 -34
  151. package/dist/operatingcontext/NestedAppOperatingContext.mjs +71 -71
  152. package/dist/operatingcontext/StandardOperatingContext.d.ts +25 -25
  153. package/dist/operatingcontext/StandardOperatingContext.mjs +43 -43
  154. package/dist/operatingcontext/UnknownOperatingContext.d.ts +25 -25
  155. package/dist/operatingcontext/UnknownOperatingContext.mjs +42 -42
  156. package/dist/packageMetadata.d.ts +2 -2
  157. package/dist/packageMetadata.mjs +4 -4
  158. package/dist/request/AuthorizationCodeRequest.d.ts +8 -8
  159. package/dist/request/AuthorizationUrlRequest.d.ts +8 -8
  160. package/dist/request/ClearCacheRequest.d.ts +10 -10
  161. package/dist/request/EndSessionPopupRequest.d.ts +18 -18
  162. package/dist/request/EndSessionRequest.d.ts +15 -15
  163. package/dist/request/InitializeApplicationRequest.d.ts +8 -8
  164. package/dist/request/PopupRequest.d.ts +34 -34
  165. package/dist/request/PopupWindowAttributes.d.ts +15 -15
  166. package/dist/request/RedirectRequest.d.ts +40 -35
  167. package/dist/request/RedirectRequest.d.ts.map +1 -1
  168. package/dist/request/RequestHelpers.d.ts +13 -13
  169. package/dist/request/RequestHelpers.mjs +53 -53
  170. package/dist/request/SilentRequest.d.ts +33 -33
  171. package/dist/request/SsoSilentRequest.d.ts +29 -29
  172. package/dist/response/AuthenticationResult.d.ts +4 -4
  173. package/dist/response/ResponseHandler.d.ts +7 -7
  174. package/dist/response/ResponseHandler.mjs +36 -36
  175. package/dist/telemetry/BrowserPerformanceClient.d.ts +38 -34
  176. package/dist/telemetry/BrowserPerformanceClient.d.ts.map +1 -1
  177. package/dist/telemetry/BrowserPerformanceClient.mjs +163 -163
  178. package/dist/telemetry/BrowserPerformanceClient.mjs.map +1 -1
  179. package/dist/telemetry/BrowserPerformanceMeasurement.d.ts +21 -21
  180. package/dist/telemetry/BrowserPerformanceMeasurement.mjs +92 -92
  181. package/dist/utils/BrowserConstants.d.ts +182 -180
  182. package/dist/utils/BrowserConstants.d.ts.map +1 -1
  183. package/dist/utils/BrowserConstants.mjs +214 -212
  184. package/dist/utils/BrowserConstants.mjs.map +1 -1
  185. package/dist/utils/BrowserProtocolUtils.d.ts +11 -11
  186. package/dist/utils/BrowserProtocolUtils.mjs +21 -21
  187. package/dist/utils/BrowserUtils.d.ts +75 -75
  188. package/dist/utils/BrowserUtils.mjs +157 -157
  189. package/lib/msal-browser.cjs +19027 -18857
  190. package/lib/msal-browser.cjs.map +1 -1
  191. package/lib/msal-browser.js +19027 -18857
  192. package/lib/msal-browser.js.map +1 -1
  193. package/lib/msal-browser.min.js +62 -62
  194. package/package.json +2 -2
  195. package/src/cache/BrowserCacheManager.ts +95 -0
  196. package/src/config/Configuration.ts +9 -1
  197. package/src/controllers/StandardController.ts +30 -12
  198. package/src/error/BrowserAuthError.ts +2 -0
  199. package/src/error/BrowserAuthErrorCodes.ts +1 -0
  200. package/src/interaction_client/PopupClient.ts +202 -117
  201. package/src/interaction_client/RedirectClient.ts +62 -2
  202. package/src/interaction_client/SilentIframeClient.ts +41 -3
  203. package/src/interaction_handler/RedirectHandler.ts +1 -0
  204. package/src/naa/BridgeProxy.ts +7 -2
  205. package/src/packageMetadata.ts +1 -1
  206. package/src/request/RedirectRequest.ts +5 -0
  207. package/src/telemetry/BrowserPerformanceClient.ts +1 -1
  208. package/src/utils/BrowserConstants.ts +2 -0
@@ -1,4 +1,4 @@
1
- /*! @azure/msal-browser v3.20.0 2024-07-23 */
1
+ /*! @azure/msal-browser v3.21.0 2024-08-13 */
2
2
  'use strict';
3
3
  import { PerformanceEvents, JoseHeader } from '@azure/msal-common';
4
4
  import { base64Encode, urlEncode, urlEncodeArr } from '../encode/Base64Encode.mjs';
@@ -8,181 +8,181 @@ import { createBrowserAuthError } from '../error/BrowserAuthError.mjs';
8
8
  import { AsyncMemoryStorage } from '../cache/AsyncMemoryStorage.mjs';
9
9
  import { cryptoKeyNotFound } from '../error/BrowserAuthErrorCodes.mjs';
10
10
 
11
- /*
12
- * Copyright (c) Microsoft Corporation. All rights reserved.
13
- * Licensed under the MIT License.
14
- */
15
- /**
16
- * This class implements MSAL's crypto interface, which allows it to perform base64 encoding and decoding, generating cryptographically random GUIDs and
17
- * implementing Proof Key for Code Exchange specs for the OAuth Authorization Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636).
18
- */
19
- class CryptoOps {
20
- constructor(logger, performanceClient) {
21
- this.logger = logger;
22
- // Browser crypto needs to be validated first before any other classes can be set.
23
- validateCryptoAvailable(logger);
24
- this.cache = new AsyncMemoryStorage(this.logger);
25
- this.performanceClient = performanceClient;
26
- }
27
- /**
28
- * Creates a new random GUID - used to populate state and nonce.
29
- * @returns string (GUID)
30
- */
31
- createNewGuid() {
32
- return createNewGuid();
33
- }
34
- /**
35
- * Encodes input string to base64.
36
- * @param input
37
- */
38
- base64Encode(input) {
39
- return base64Encode(input);
40
- }
41
- /**
42
- * Decodes input string from base64.
43
- * @param input
44
- */
45
- base64Decode(input) {
46
- return base64Decode(input);
47
- }
48
- /**
49
- * Encodes input string to base64 URL safe string.
50
- * @param input
51
- */
52
- base64UrlEncode(input) {
53
- return urlEncode(input);
54
- }
55
- /**
56
- * Stringifies and base64Url encodes input public key
57
- * @param inputKid
58
- * @returns Base64Url encoded public key
59
- */
60
- encodeKid(inputKid) {
61
- return this.base64UrlEncode(JSON.stringify({ kid: inputKid }));
62
- }
63
- /**
64
- * Generates a keypair, stores it and returns a thumbprint
65
- * @param request
66
- */
67
- async getPublicKeyThumbprint(request) {
68
- const publicKeyThumbMeasurement = this.performanceClient?.startMeasurement(PerformanceEvents.CryptoOptsGetPublicKeyThumbprint, request.correlationId);
69
- // Generate Keypair
70
- const keyPair = await generateKeyPair(CryptoOps.EXTRACTABLE, CryptoOps.POP_KEY_USAGES);
71
- // Generate Thumbprint for Public Key
72
- const publicKeyJwk = await exportJwk(keyPair.publicKey);
73
- const pubKeyThumprintObj = {
74
- e: publicKeyJwk.e,
75
- kty: publicKeyJwk.kty,
76
- n: publicKeyJwk.n,
77
- };
78
- const publicJwkString = getSortedObjectString(pubKeyThumprintObj);
79
- const publicJwkHash = await this.hashString(publicJwkString);
80
- // Generate Thumbprint for Private Key
81
- const privateKeyJwk = await exportJwk(keyPair.privateKey);
82
- // Re-import private key to make it unextractable
83
- const unextractablePrivateKey = await importJwk(privateKeyJwk, false, ["sign"]);
84
- // Store Keypair data in keystore
85
- await this.cache.setItem(publicJwkHash, {
86
- privateKey: unextractablePrivateKey,
87
- publicKey: keyPair.publicKey,
88
- requestMethod: request.resourceRequestMethod,
89
- requestUri: request.resourceRequestUri,
90
- });
91
- if (publicKeyThumbMeasurement) {
92
- publicKeyThumbMeasurement.end({
93
- success: true,
94
- });
95
- }
96
- return publicJwkHash;
97
- }
98
- /**
99
- * Removes cryptographic keypair from key store matching the keyId passed in
100
- * @param kid
101
- */
102
- async removeTokenBindingKey(kid) {
103
- await this.cache.removeItem(kid);
104
- const keyFound = await this.cache.containsKey(kid);
105
- return !keyFound;
106
- }
107
- /**
108
- * Removes all cryptographic keys from IndexedDB storage
109
- */
110
- async clearKeystore() {
111
- // Delete in-memory keystores
112
- this.cache.clearInMemory();
113
- /**
114
- * There is only one database, so calling clearPersistent on asymmetric keystore takes care of
115
- * every persistent keystore
116
- */
117
- try {
118
- await this.cache.clearPersistent();
119
- return true;
120
- }
121
- catch (e) {
122
- if (e instanceof Error) {
123
- this.logger.error(`Clearing keystore failed with error: ${e.message}`);
124
- }
125
- else {
126
- this.logger.error("Clearing keystore failed with unknown error");
127
- }
128
- return false;
129
- }
130
- }
131
- /**
132
- * Signs the given object as a jwt payload with private key retrieved by given kid.
133
- * @param payload
134
- * @param kid
135
- */
136
- async signJwt(payload, kid, shrOptions, correlationId) {
137
- const signJwtMeasurement = this.performanceClient?.startMeasurement(PerformanceEvents.CryptoOptsSignJwt, correlationId);
138
- const cachedKeyPair = await this.cache.getItem(kid);
139
- if (!cachedKeyPair) {
140
- throw createBrowserAuthError(cryptoKeyNotFound);
141
- }
142
- // Get public key as JWK
143
- const publicKeyJwk = await exportJwk(cachedKeyPair.publicKey);
144
- const publicKeyJwkString = getSortedObjectString(publicKeyJwk);
145
- // Base64URL encode public key thumbprint with keyId only: BASE64URL({ kid: "FULL_PUBLIC_KEY_HASH" })
146
- const encodedKeyIdThumbprint = urlEncode(JSON.stringify({ kid: kid }));
147
- // Generate header
148
- const shrHeader = JoseHeader.getShrHeaderString({
149
- ...shrOptions?.header,
150
- alg: publicKeyJwk.alg,
151
- kid: encodedKeyIdThumbprint,
152
- });
153
- const encodedShrHeader = urlEncode(shrHeader);
154
- // Generate payload
155
- payload.cnf = {
156
- jwk: JSON.parse(publicKeyJwkString),
157
- };
158
- const encodedPayload = urlEncode(JSON.stringify(payload));
159
- // Form token string
160
- const tokenString = `${encodedShrHeader}.${encodedPayload}`;
161
- // Sign token
162
- const encoder = new TextEncoder();
163
- const tokenBuffer = encoder.encode(tokenString);
164
- const signatureBuffer = await sign(cachedKeyPair.privateKey, tokenBuffer);
165
- const encodedSignature = urlEncodeArr(new Uint8Array(signatureBuffer));
166
- const signedJwt = `${tokenString}.${encodedSignature}`;
167
- if (signJwtMeasurement) {
168
- signJwtMeasurement.end({
169
- success: true,
170
- });
171
- }
172
- return signedJwt;
173
- }
174
- /**
175
- * Returns the SHA-256 hash of an input string
176
- * @param plainText
177
- */
178
- async hashString(plainText) {
179
- return hashString(plainText);
180
- }
181
- }
182
- CryptoOps.POP_KEY_USAGES = ["sign", "verify"];
183
- CryptoOps.EXTRACTABLE = true;
184
- function getSortedObjectString(obj) {
185
- return JSON.stringify(obj, Object.keys(obj).sort());
11
+ /*
12
+ * Copyright (c) Microsoft Corporation. All rights reserved.
13
+ * Licensed under the MIT License.
14
+ */
15
+ /**
16
+ * This class implements MSAL's crypto interface, which allows it to perform base64 encoding and decoding, generating cryptographically random GUIDs and
17
+ * implementing Proof Key for Code Exchange specs for the OAuth Authorization Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636).
18
+ */
19
+ class CryptoOps {
20
+ constructor(logger, performanceClient) {
21
+ this.logger = logger;
22
+ // Browser crypto needs to be validated first before any other classes can be set.
23
+ validateCryptoAvailable(logger);
24
+ this.cache = new AsyncMemoryStorage(this.logger);
25
+ this.performanceClient = performanceClient;
26
+ }
27
+ /**
28
+ * Creates a new random GUID - used to populate state and nonce.
29
+ * @returns string (GUID)
30
+ */
31
+ createNewGuid() {
32
+ return createNewGuid();
33
+ }
34
+ /**
35
+ * Encodes input string to base64.
36
+ * @param input
37
+ */
38
+ base64Encode(input) {
39
+ return base64Encode(input);
40
+ }
41
+ /**
42
+ * Decodes input string from base64.
43
+ * @param input
44
+ */
45
+ base64Decode(input) {
46
+ return base64Decode(input);
47
+ }
48
+ /**
49
+ * Encodes input string to base64 URL safe string.
50
+ * @param input
51
+ */
52
+ base64UrlEncode(input) {
53
+ return urlEncode(input);
54
+ }
55
+ /**
56
+ * Stringifies and base64Url encodes input public key
57
+ * @param inputKid
58
+ * @returns Base64Url encoded public key
59
+ */
60
+ encodeKid(inputKid) {
61
+ return this.base64UrlEncode(JSON.stringify({ kid: inputKid }));
62
+ }
63
+ /**
64
+ * Generates a keypair, stores it and returns a thumbprint
65
+ * @param request
66
+ */
67
+ async getPublicKeyThumbprint(request) {
68
+ const publicKeyThumbMeasurement = this.performanceClient?.startMeasurement(PerformanceEvents.CryptoOptsGetPublicKeyThumbprint, request.correlationId);
69
+ // Generate Keypair
70
+ const keyPair = await generateKeyPair(CryptoOps.EXTRACTABLE, CryptoOps.POP_KEY_USAGES);
71
+ // Generate Thumbprint for Public Key
72
+ const publicKeyJwk = await exportJwk(keyPair.publicKey);
73
+ const pubKeyThumprintObj = {
74
+ e: publicKeyJwk.e,
75
+ kty: publicKeyJwk.kty,
76
+ n: publicKeyJwk.n,
77
+ };
78
+ const publicJwkString = getSortedObjectString(pubKeyThumprintObj);
79
+ const publicJwkHash = await this.hashString(publicJwkString);
80
+ // Generate Thumbprint for Private Key
81
+ const privateKeyJwk = await exportJwk(keyPair.privateKey);
82
+ // Re-import private key to make it unextractable
83
+ const unextractablePrivateKey = await importJwk(privateKeyJwk, false, ["sign"]);
84
+ // Store Keypair data in keystore
85
+ await this.cache.setItem(publicJwkHash, {
86
+ privateKey: unextractablePrivateKey,
87
+ publicKey: keyPair.publicKey,
88
+ requestMethod: request.resourceRequestMethod,
89
+ requestUri: request.resourceRequestUri,
90
+ });
91
+ if (publicKeyThumbMeasurement) {
92
+ publicKeyThumbMeasurement.end({
93
+ success: true,
94
+ });
95
+ }
96
+ return publicJwkHash;
97
+ }
98
+ /**
99
+ * Removes cryptographic keypair from key store matching the keyId passed in
100
+ * @param kid
101
+ */
102
+ async removeTokenBindingKey(kid) {
103
+ await this.cache.removeItem(kid);
104
+ const keyFound = await this.cache.containsKey(kid);
105
+ return !keyFound;
106
+ }
107
+ /**
108
+ * Removes all cryptographic keys from IndexedDB storage
109
+ */
110
+ async clearKeystore() {
111
+ // Delete in-memory keystores
112
+ this.cache.clearInMemory();
113
+ /**
114
+ * There is only one database, so calling clearPersistent on asymmetric keystore takes care of
115
+ * every persistent keystore
116
+ */
117
+ try {
118
+ await this.cache.clearPersistent();
119
+ return true;
120
+ }
121
+ catch (e) {
122
+ if (e instanceof Error) {
123
+ this.logger.error(`Clearing keystore failed with error: ${e.message}`);
124
+ }
125
+ else {
126
+ this.logger.error("Clearing keystore failed with unknown error");
127
+ }
128
+ return false;
129
+ }
130
+ }
131
+ /**
132
+ * Signs the given object as a jwt payload with private key retrieved by given kid.
133
+ * @param payload
134
+ * @param kid
135
+ */
136
+ async signJwt(payload, kid, shrOptions, correlationId) {
137
+ const signJwtMeasurement = this.performanceClient?.startMeasurement(PerformanceEvents.CryptoOptsSignJwt, correlationId);
138
+ const cachedKeyPair = await this.cache.getItem(kid);
139
+ if (!cachedKeyPair) {
140
+ throw createBrowserAuthError(cryptoKeyNotFound);
141
+ }
142
+ // Get public key as JWK
143
+ const publicKeyJwk = await exportJwk(cachedKeyPair.publicKey);
144
+ const publicKeyJwkString = getSortedObjectString(publicKeyJwk);
145
+ // Base64URL encode public key thumbprint with keyId only: BASE64URL({ kid: "FULL_PUBLIC_KEY_HASH" })
146
+ const encodedKeyIdThumbprint = urlEncode(JSON.stringify({ kid: kid }));
147
+ // Generate header
148
+ const shrHeader = JoseHeader.getShrHeaderString({
149
+ ...shrOptions?.header,
150
+ alg: publicKeyJwk.alg,
151
+ kid: encodedKeyIdThumbprint,
152
+ });
153
+ const encodedShrHeader = urlEncode(shrHeader);
154
+ // Generate payload
155
+ payload.cnf = {
156
+ jwk: JSON.parse(publicKeyJwkString),
157
+ };
158
+ const encodedPayload = urlEncode(JSON.stringify(payload));
159
+ // Form token string
160
+ const tokenString = `${encodedShrHeader}.${encodedPayload}`;
161
+ // Sign token
162
+ const encoder = new TextEncoder();
163
+ const tokenBuffer = encoder.encode(tokenString);
164
+ const signatureBuffer = await sign(cachedKeyPair.privateKey, tokenBuffer);
165
+ const encodedSignature = urlEncodeArr(new Uint8Array(signatureBuffer));
166
+ const signedJwt = `${tokenString}.${encodedSignature}`;
167
+ if (signJwtMeasurement) {
168
+ signJwtMeasurement.end({
169
+ success: true,
170
+ });
171
+ }
172
+ return signedJwt;
173
+ }
174
+ /**
175
+ * Returns the SHA-256 hash of an input string
176
+ * @param plainText
177
+ */
178
+ async hashString(plainText) {
179
+ return hashString(plainText);
180
+ }
181
+ }
182
+ CryptoOps.POP_KEY_USAGES = ["sign", "verify"];
183
+ CryptoOps.EXTRACTABLE = true;
184
+ function getSortedObjectString(obj) {
185
+ return JSON.stringify(obj, Object.keys(obj).sort());
186
186
  }
187
187
 
188
188
  export { CryptoOps };
@@ -1,9 +1,9 @@
1
- import { IPerformanceClient, Logger, PkceCodes } from "@azure/msal-common";
2
- /**
3
- * This file defines APIs to generate PKCE codes and code verifiers.
4
- */
5
- /**
6
- * Generates PKCE Codes. See the RFC for more information: https://tools.ietf.org/html/rfc7636
7
- */
8
- export declare function generatePkceCodes(performanceClient: IPerformanceClient, logger: Logger, correlationId: string): Promise<PkceCodes>;
1
+ import { IPerformanceClient, Logger, PkceCodes } from "@azure/msal-common";
2
+ /**
3
+ * This file defines APIs to generate PKCE codes and code verifiers.
4
+ */
5
+ /**
6
+ * Generates PKCE Codes. See the RFC for more information: https://tools.ietf.org/html/rfc7636
7
+ */
8
+ export declare function generatePkceCodes(performanceClient: IPerformanceClient, logger: Logger, correlationId: string): Promise<PkceCodes>;
9
9
  //# sourceMappingURL=PkceGenerator.d.ts.map
@@ -1,4 +1,4 @@
1
- /*! @azure/msal-browser v3.20.0 2024-07-23 */
1
+ /*! @azure/msal-browser v3.21.0 2024-08-13 */
2
2
  'use strict';
3
3
  import { PerformanceEvents, invoke, invokeAsync } from '@azure/msal-common';
4
4
  import { createBrowserAuthError } from '../error/BrowserAuthError.mjs';
@@ -6,59 +6,59 @@ import { urlEncodeArr } from '../encode/Base64Encode.mjs';
6
6
  import { getRandomValues, sha256Digest } from './BrowserCrypto.mjs';
7
7
  import { pkceNotCreated } from '../error/BrowserAuthErrorCodes.mjs';
8
8
 
9
- /*
10
- * Copyright (c) Microsoft Corporation. All rights reserved.
11
- * Licensed under the MIT License.
12
- */
13
- // Constant byte array length
14
- const RANDOM_BYTE_ARR_LENGTH = 32;
15
- /**
16
- * This file defines APIs to generate PKCE codes and code verifiers.
17
- */
18
- /**
19
- * Generates PKCE Codes. See the RFC for more information: https://tools.ietf.org/html/rfc7636
20
- */
21
- async function generatePkceCodes(performanceClient, logger, correlationId) {
22
- performanceClient.addQueueMeasurement(PerformanceEvents.GeneratePkceCodes, correlationId);
23
- const codeVerifier = invoke(generateCodeVerifier, PerformanceEvents.GenerateCodeVerifier, logger, performanceClient, correlationId)(performanceClient, logger, correlationId);
24
- const codeChallenge = await invokeAsync(generateCodeChallengeFromVerifier, PerformanceEvents.GenerateCodeChallengeFromVerifier, logger, performanceClient, correlationId)(codeVerifier, performanceClient, logger, correlationId);
25
- return {
26
- verifier: codeVerifier,
27
- challenge: codeChallenge,
28
- };
29
- }
30
- /**
31
- * Generates a random 32 byte buffer and returns the base64
32
- * encoded string to be used as a PKCE Code Verifier
33
- */
34
- function generateCodeVerifier(performanceClient, logger, correlationId) {
35
- try {
36
- // Generate random values as utf-8
37
- const buffer = new Uint8Array(RANDOM_BYTE_ARR_LENGTH);
38
- invoke(getRandomValues, PerformanceEvents.GetRandomValues, logger, performanceClient, correlationId)(buffer);
39
- // encode verifier as base64
40
- const pkceCodeVerifierB64 = urlEncodeArr(buffer);
41
- return pkceCodeVerifierB64;
42
- }
43
- catch (e) {
44
- throw createBrowserAuthError(pkceNotCreated);
45
- }
46
- }
47
- /**
48
- * Creates a base64 encoded PKCE Code Challenge string from the
49
- * hash created from the PKCE Code Verifier supplied
50
- */
51
- async function generateCodeChallengeFromVerifier(pkceCodeVerifier, performanceClient, logger, correlationId) {
52
- performanceClient.addQueueMeasurement(PerformanceEvents.GenerateCodeChallengeFromVerifier, correlationId);
53
- try {
54
- // hashed verifier
55
- const pkceHashedCodeVerifier = await invokeAsync(sha256Digest, PerformanceEvents.Sha256Digest, logger, performanceClient, correlationId)(pkceCodeVerifier, performanceClient, correlationId);
56
- // encode hash as base64
57
- return urlEncodeArr(new Uint8Array(pkceHashedCodeVerifier));
58
- }
59
- catch (e) {
60
- throw createBrowserAuthError(pkceNotCreated);
61
- }
9
+ /*
10
+ * Copyright (c) Microsoft Corporation. All rights reserved.
11
+ * Licensed under the MIT License.
12
+ */
13
+ // Constant byte array length
14
+ const RANDOM_BYTE_ARR_LENGTH = 32;
15
+ /**
16
+ * This file defines APIs to generate PKCE codes and code verifiers.
17
+ */
18
+ /**
19
+ * Generates PKCE Codes. See the RFC for more information: https://tools.ietf.org/html/rfc7636
20
+ */
21
+ async function generatePkceCodes(performanceClient, logger, correlationId) {
22
+ performanceClient.addQueueMeasurement(PerformanceEvents.GeneratePkceCodes, correlationId);
23
+ const codeVerifier = invoke(generateCodeVerifier, PerformanceEvents.GenerateCodeVerifier, logger, performanceClient, correlationId)(performanceClient, logger, correlationId);
24
+ const codeChallenge = await invokeAsync(generateCodeChallengeFromVerifier, PerformanceEvents.GenerateCodeChallengeFromVerifier, logger, performanceClient, correlationId)(codeVerifier, performanceClient, logger, correlationId);
25
+ return {
26
+ verifier: codeVerifier,
27
+ challenge: codeChallenge,
28
+ };
29
+ }
30
+ /**
31
+ * Generates a random 32 byte buffer and returns the base64
32
+ * encoded string to be used as a PKCE Code Verifier
33
+ */
34
+ function generateCodeVerifier(performanceClient, logger, correlationId) {
35
+ try {
36
+ // Generate random values as utf-8
37
+ const buffer = new Uint8Array(RANDOM_BYTE_ARR_LENGTH);
38
+ invoke(getRandomValues, PerformanceEvents.GetRandomValues, logger, performanceClient, correlationId)(buffer);
39
+ // encode verifier as base64
40
+ const pkceCodeVerifierB64 = urlEncodeArr(buffer);
41
+ return pkceCodeVerifierB64;
42
+ }
43
+ catch (e) {
44
+ throw createBrowserAuthError(pkceNotCreated);
45
+ }
46
+ }
47
+ /**
48
+ * Creates a base64 encoded PKCE Code Challenge string from the
49
+ * hash created from the PKCE Code Verifier supplied
50
+ */
51
+ async function generateCodeChallengeFromVerifier(pkceCodeVerifier, performanceClient, logger, correlationId) {
52
+ performanceClient.addQueueMeasurement(PerformanceEvents.GenerateCodeChallengeFromVerifier, correlationId);
53
+ try {
54
+ // hashed verifier
55
+ const pkceHashedCodeVerifier = await invokeAsync(sha256Digest, PerformanceEvents.Sha256Digest, logger, performanceClient, correlationId)(pkceCodeVerifier, performanceClient, correlationId);
56
+ // encode hash as base64
57
+ return urlEncodeArr(new Uint8Array(pkceHashedCodeVerifier));
58
+ }
59
+ catch (e) {
60
+ throw createBrowserAuthError(pkceNotCreated);
61
+ }
62
62
  }
63
63
 
64
64
  export { generatePkceCodes };
@@ -1,31 +1,31 @@
1
- import { LoggerOptions, SignedHttpRequestParameters } from "@azure/msal-common";
2
- export type SignedHttpRequestOptions = {
3
- loggerOptions: LoggerOptions;
4
- };
5
- export declare class SignedHttpRequest {
6
- private popTokenGenerator;
7
- private cryptoOps;
8
- private shrParameters;
9
- private logger;
10
- constructor(shrParameters: SignedHttpRequestParameters, shrOptions?: SignedHttpRequestOptions);
11
- /**
12
- * Generates and caches a keypair for the given request options.
13
- * @returns Public key digest, which should be sent to the token issuer.
14
- */
15
- generatePublicKeyThumbprint(): Promise<string>;
16
- /**
17
- * Generates a signed http request for the given payload with the given key.
18
- * @param payload Payload to sign (e.g. access token)
19
- * @param publicKeyThumbprint Public key digest (from generatePublicKeyThumbprint API)
20
- * @param claims Additional claims to include/override in the signed JWT
21
- * @returns Pop token signed with the corresponding private key
22
- */
23
- signRequest(payload: string, publicKeyThumbprint: string, claims?: object): Promise<string>;
24
- /**
25
- * Removes cached keys from browser for given public key thumbprint
26
- * @param publicKeyThumbprint Public key digest (from generatePublicKeyThumbprint API)
27
- * @returns If keys are properly deleted
28
- */
29
- removeKeys(publicKeyThumbprint: string): Promise<boolean>;
30
- }
1
+ import { LoggerOptions, SignedHttpRequestParameters } from "@azure/msal-common";
2
+ export type SignedHttpRequestOptions = {
3
+ loggerOptions: LoggerOptions;
4
+ };
5
+ export declare class SignedHttpRequest {
6
+ private popTokenGenerator;
7
+ private cryptoOps;
8
+ private shrParameters;
9
+ private logger;
10
+ constructor(shrParameters: SignedHttpRequestParameters, shrOptions?: SignedHttpRequestOptions);
11
+ /**
12
+ * Generates and caches a keypair for the given request options.
13
+ * @returns Public key digest, which should be sent to the token issuer.
14
+ */
15
+ generatePublicKeyThumbprint(): Promise<string>;
16
+ /**
17
+ * Generates a signed http request for the given payload with the given key.
18
+ * @param payload Payload to sign (e.g. access token)
19
+ * @param publicKeyThumbprint Public key digest (from generatePublicKeyThumbprint API)
20
+ * @param claims Additional claims to include/override in the signed JWT
21
+ * @returns Pop token signed with the corresponding private key
22
+ */
23
+ signRequest(payload: string, publicKeyThumbprint: string, claims?: object): Promise<string>;
24
+ /**
25
+ * Removes cached keys from browser for given public key thumbprint
26
+ * @param publicKeyThumbprint Public key digest (from generatePublicKeyThumbprint API)
27
+ * @returns If keys are properly deleted
28
+ */
29
+ removeKeys(publicKeyThumbprint: string): Promise<boolean>;
30
+ }
31
31
  //# sourceMappingURL=SignedHttpRequest.d.ts.map
@@ -1,47 +1,47 @@
1
- /*! @azure/msal-browser v3.20.0 2024-07-23 */
1
+ /*! @azure/msal-browser v3.21.0 2024-08-13 */
2
2
  'use strict';
3
3
  import { CryptoOps } from './CryptoOps.mjs';
4
4
  import { Logger, PopTokenGenerator } from '@azure/msal-common';
5
5
  import { name, version } from '../packageMetadata.mjs';
6
6
 
7
- /*
8
- * Copyright (c) Microsoft Corporation. All rights reserved.
9
- * Licensed under the MIT License.
10
- */
11
- class SignedHttpRequest {
12
- constructor(shrParameters, shrOptions) {
13
- const loggerOptions = (shrOptions && shrOptions.loggerOptions) || {};
14
- this.logger = new Logger(loggerOptions, name, version);
15
- this.cryptoOps = new CryptoOps(this.logger);
16
- this.popTokenGenerator = new PopTokenGenerator(this.cryptoOps);
17
- this.shrParameters = shrParameters;
18
- }
19
- /**
20
- * Generates and caches a keypair for the given request options.
21
- * @returns Public key digest, which should be sent to the token issuer.
22
- */
23
- async generatePublicKeyThumbprint() {
24
- const { kid } = await this.popTokenGenerator.generateKid(this.shrParameters);
25
- return kid;
26
- }
27
- /**
28
- * Generates a signed http request for the given payload with the given key.
29
- * @param payload Payload to sign (e.g. access token)
30
- * @param publicKeyThumbprint Public key digest (from generatePublicKeyThumbprint API)
31
- * @param claims Additional claims to include/override in the signed JWT
32
- * @returns Pop token signed with the corresponding private key
33
- */
34
- async signRequest(payload, publicKeyThumbprint, claims) {
35
- return this.popTokenGenerator.signPayload(payload, publicKeyThumbprint, this.shrParameters, claims);
36
- }
37
- /**
38
- * Removes cached keys from browser for given public key thumbprint
39
- * @param publicKeyThumbprint Public key digest (from generatePublicKeyThumbprint API)
40
- * @returns If keys are properly deleted
41
- */
42
- async removeKeys(publicKeyThumbprint) {
43
- return this.cryptoOps.removeTokenBindingKey(publicKeyThumbprint);
44
- }
7
+ /*
8
+ * Copyright (c) Microsoft Corporation. All rights reserved.
9
+ * Licensed under the MIT License.
10
+ */
11
+ class SignedHttpRequest {
12
+ constructor(shrParameters, shrOptions) {
13
+ const loggerOptions = (shrOptions && shrOptions.loggerOptions) || {};
14
+ this.logger = new Logger(loggerOptions, name, version);
15
+ this.cryptoOps = new CryptoOps(this.logger);
16
+ this.popTokenGenerator = new PopTokenGenerator(this.cryptoOps);
17
+ this.shrParameters = shrParameters;
18
+ }
19
+ /**
20
+ * Generates and caches a keypair for the given request options.
21
+ * @returns Public key digest, which should be sent to the token issuer.
22
+ */
23
+ async generatePublicKeyThumbprint() {
24
+ const { kid } = await this.popTokenGenerator.generateKid(this.shrParameters);
25
+ return kid;
26
+ }
27
+ /**
28
+ * Generates a signed http request for the given payload with the given key.
29
+ * @param payload Payload to sign (e.g. access token)
30
+ * @param publicKeyThumbprint Public key digest (from generatePublicKeyThumbprint API)
31
+ * @param claims Additional claims to include/override in the signed JWT
32
+ * @returns Pop token signed with the corresponding private key
33
+ */
34
+ async signRequest(payload, publicKeyThumbprint, claims) {
35
+ return this.popTokenGenerator.signPayload(payload, publicKeyThumbprint, this.shrParameters, claims);
36
+ }
37
+ /**
38
+ * Removes cached keys from browser for given public key thumbprint
39
+ * @param publicKeyThumbprint Public key digest (from generatePublicKeyThumbprint API)
40
+ * @returns If keys are properly deleted
41
+ */
42
+ async removeKeys(publicKeyThumbprint) {
43
+ return this.cryptoOps.removeTokenBindingKey(publicKeyThumbprint);
44
+ }
45
45
  }
46
46
 
47
47
  export { SignedHttpRequest };