@azure/msal-common 14.1.0-alpha.0 → 14.1.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 (205) hide show
  1. package/dist/account/AccountInfo.d.ts +31 -32
  2. package/dist/account/AccountInfo.d.ts.map +1 -1
  3. package/dist/account/AuthToken.d.ts +17 -17
  4. package/dist/account/AuthToken.mjs +58 -58
  5. package/dist/account/CcsCredential.d.ts +9 -9
  6. package/dist/account/CcsCredential.mjs +8 -8
  7. package/dist/account/ClientCredentials.d.ts +14 -14
  8. package/dist/account/ClientInfo.d.ts +19 -19
  9. package/dist/account/ClientInfo.mjs +37 -37
  10. package/dist/account/TokenClaims.d.ts +65 -65
  11. package/dist/authority/Authority.d.ts +235 -235
  12. package/dist/authority/Authority.mjs +738 -738
  13. package/dist/authority/AuthorityFactory.d.ts +31 -31
  14. package/dist/authority/AuthorityFactory.mjs +47 -47
  15. package/dist/authority/AuthorityMetadata.d.ts +623 -623
  16. package/dist/authority/AuthorityMetadata.mjs +884 -884
  17. package/dist/authority/AuthorityOptions.d.ts +21 -21
  18. package/dist/authority/AuthorityOptions.mjs +18 -18
  19. package/dist/authority/AuthorityType.d.ts +10 -10
  20. package/dist/authority/AuthorityType.mjs +13 -13
  21. package/dist/authority/AzureRegion.d.ts +1 -1
  22. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  23. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  24. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  25. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  26. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  27. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  28. package/dist/authority/ImdsOptions.d.ts +5 -5
  29. package/dist/authority/OIDCOptions.d.ts +8 -8
  30. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  31. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  32. package/dist/authority/ProtocolMode.d.ts +8 -8
  33. package/dist/authority/ProtocolMode.mjs +11 -11
  34. package/dist/authority/RegionDiscovery.d.ts +32 -32
  35. package/dist/authority/RegionDiscovery.mjs +106 -106
  36. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  37. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  38. package/dist/cache/CacheManager.d.ts +464 -446
  39. package/dist/cache/CacheManager.d.ts.map +1 -1
  40. package/dist/cache/CacheManager.mjs +1049 -998
  41. package/dist/cache/CacheManager.mjs.map +1 -1
  42. package/dist/cache/entities/AccessTokenEntity.d.ts +56 -56
  43. package/dist/cache/entities/AccessTokenEntity.mjs +109 -109
  44. package/dist/cache/entities/AccountEntity.d.ts +101 -101
  45. package/dist/cache/entities/AccountEntity.mjs +220 -220
  46. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  47. package/dist/cache/entities/AppMetadataEntity.mjs +66 -66
  48. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +48 -48
  49. package/dist/cache/entities/AuthorityMetadataEntity.mjs +78 -78
  50. package/dist/cache/entities/CacheRecord.d.ts +14 -14
  51. package/dist/cache/entities/CacheRecord.mjs +14 -14
  52. package/dist/cache/entities/CredentialEntity.d.ts +88 -88
  53. package/dist/cache/entities/CredentialEntity.mjs +136 -136
  54. package/dist/cache/entities/IdTokenEntity.d.ts +34 -34
  55. package/dist/cache/entities/IdTokenEntity.mjs +56 -56
  56. package/dist/cache/entities/RefreshTokenEntity.d.ts +36 -36
  57. package/dist/cache/entities/RefreshTokenEntity.mjs +59 -59
  58. package/dist/cache/entities/ServerTelemetryEntity.d.ts +12 -12
  59. package/dist/cache/entities/ServerTelemetryEntity.mjs +27 -27
  60. package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
  61. package/dist/cache/entities/ThrottlingEntity.mjs +23 -23
  62. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  63. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  64. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  65. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  66. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  67. package/dist/cache/utils/CacheTypes.d.ts +66 -69
  68. package/dist/cache/utils/CacheTypes.d.ts.map +1 -1
  69. package/dist/client/AuthorizationCodeClient.d.ts +73 -73
  70. package/dist/client/AuthorizationCodeClient.d.ts.map +1 -1
  71. package/dist/client/AuthorizationCodeClient.mjs +408 -407
  72. package/dist/client/AuthorizationCodeClient.mjs.map +1 -1
  73. package/dist/client/BaseClient.d.ts +51 -51
  74. package/dist/client/BaseClient.mjs +98 -98
  75. package/dist/client/RefreshTokenClient.d.ts +35 -35
  76. package/dist/client/RefreshTokenClient.d.ts.map +1 -1
  77. package/dist/client/RefreshTokenClient.mjs +187 -179
  78. package/dist/client/RefreshTokenClient.mjs.map +1 -1
  79. package/dist/client/SilentFlowClient.d.ts +26 -26
  80. package/dist/client/SilentFlowClient.mjs +123 -123
  81. package/dist/config/AppTokenProvider.d.ts +38 -38
  82. package/dist/config/ClientConfiguration.d.ts +150 -150
  83. package/dist/config/ClientConfiguration.mjs +97 -97
  84. package/dist/crypto/ICrypto.d.ts +58 -62
  85. package/dist/crypto/ICrypto.d.ts.map +1 -1
  86. package/dist/crypto/ICrypto.mjs +30 -33
  87. package/dist/crypto/ICrypto.mjs.map +1 -1
  88. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  89. package/dist/crypto/JoseHeader.d.ts +22 -22
  90. package/dist/crypto/JoseHeader.mjs +37 -37
  91. package/dist/crypto/PopTokenGenerator.d.ts +60 -60
  92. package/dist/crypto/PopTokenGenerator.mjs +82 -82
  93. package/dist/crypto/SignedHttpRequest.d.ts +11 -11
  94. package/dist/error/AuthError.d.ts +44 -44
  95. package/dist/error/AuthError.mjs +46 -46
  96. package/dist/error/AuthErrorCodes.d.ts +5 -5
  97. package/dist/error/AuthErrorCodes.mjs +9 -9
  98. package/dist/error/ClientAuthError.d.ts +232 -232
  99. package/dist/error/ClientAuthError.mjs +244 -244
  100. package/dist/error/ClientAuthErrorCodes.d.ts +43 -43
  101. package/dist/error/ClientAuthErrorCodes.mjs +47 -47
  102. package/dist/error/ClientConfigurationError.d.ts +128 -128
  103. package/dist/error/ClientConfigurationError.mjs +135 -135
  104. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  105. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  106. package/dist/error/InteractionRequiredAuthError.d.ts +57 -57
  107. package/dist/error/InteractionRequiredAuthError.mjs +76 -76
  108. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +5 -5
  109. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +11 -11
  110. package/dist/error/JoseHeaderError.d.ts +15 -15
  111. package/dist/error/JoseHeaderError.mjs +22 -22
  112. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  113. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  114. package/dist/error/ServerError.d.ts +7 -7
  115. package/dist/error/ServerError.mjs +14 -14
  116. package/dist/index.cjs +8672 -8608
  117. package/dist/index.cjs.map +1 -1
  118. package/dist/index.d.ts +96 -96
  119. package/dist/index.d.ts.map +1 -1
  120. package/dist/index.mjs +1 -1
  121. package/dist/logger/Logger.d.ts +95 -95
  122. package/dist/logger/Logger.mjs +188 -188
  123. package/dist/network/INetworkModule.d.ts +29 -29
  124. package/dist/network/INetworkModule.mjs +12 -12
  125. package/dist/network/NetworkManager.d.ts +33 -33
  126. package/dist/network/NetworkManager.mjs +34 -34
  127. package/dist/network/RequestThumbprint.d.ts +16 -16
  128. package/dist/network/ThrottlingUtils.d.ts +42 -42
  129. package/dist/network/ThrottlingUtils.mjs +95 -95
  130. package/dist/packageMetadata.d.ts +2 -2
  131. package/dist/packageMetadata.mjs +4 -4
  132. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  133. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  134. package/dist/request/BaseAuthRequest.d.ts +40 -40
  135. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  136. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  137. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  138. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  139. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  140. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  141. package/dist/request/CommonRefreshTokenRequest.d.ts +22 -19
  142. package/dist/request/CommonRefreshTokenRequest.d.ts.map +1 -1
  143. package/dist/request/CommonSilentFlowRequest.d.ts +20 -18
  144. package/dist/request/CommonSilentFlowRequest.d.ts.map +1 -1
  145. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  146. package/dist/request/NativeRequest.d.ts +19 -19
  147. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  148. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  149. package/dist/request/RequestParameterBuilder.mjs +381 -381
  150. package/dist/request/RequestValidator.d.ts +33 -33
  151. package/dist/request/RequestValidator.mjs +81 -81
  152. package/dist/request/ScopeSet.d.ts +88 -88
  153. package/dist/request/ScopeSet.mjs +197 -197
  154. package/dist/request/StoreInCache.d.ts +8 -8
  155. package/dist/response/AuthenticationResult.d.ts +41 -41
  156. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  157. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  158. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  159. package/dist/response/IMDSBadResponse.d.ts +4 -4
  160. package/dist/response/ResponseHandler.d.ts +67 -67
  161. package/dist/response/ResponseHandler.mjs +311 -311
  162. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  163. package/dist/response/ServerAuthorizationTokenResponse.d.ts +46 -46
  164. package/dist/telemetry/performance/IPerformanceClient.d.ts +51 -51
  165. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  166. package/dist/telemetry/performance/PerformanceClient.d.ts +191 -191
  167. package/dist/telemetry/performance/PerformanceClient.mjs +409 -409
  168. package/dist/telemetry/performance/PerformanceEvent.d.ts +441 -433
  169. package/dist/telemetry/performance/PerformanceEvent.d.ts.map +1 -1
  170. package/dist/telemetry/performance/PerformanceEvent.mjs +242 -234
  171. package/dist/telemetry/performance/PerformanceEvent.mjs.map +1 -1
  172. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  173. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  174. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  175. package/dist/telemetry/server/ServerTelemetryManager.mjs +197 -197
  176. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  177. package/dist/url/IUri.d.ts +12 -12
  178. package/dist/url/UrlString.d.ts +83 -83
  179. package/dist/url/UrlString.mjs +279 -279
  180. package/dist/utils/Constants.d.ts +366 -366
  181. package/dist/utils/Constants.mjs +376 -376
  182. package/dist/utils/FunctionWrappers.d.ts +27 -27
  183. package/dist/utils/FunctionWrappers.d.ts.map +1 -1
  184. package/dist/utils/FunctionWrappers.mjs +84 -85
  185. package/dist/utils/FunctionWrappers.mjs.map +1 -1
  186. package/dist/utils/MsalTypes.d.ts +6 -6
  187. package/dist/utils/ProtocolUtils.d.ts +42 -42
  188. package/dist/utils/ProtocolUtils.mjs +69 -69
  189. package/dist/utils/StringUtils.d.ts +40 -40
  190. package/dist/utils/StringUtils.mjs +95 -95
  191. package/dist/utils/TimeUtils.d.ts +27 -27
  192. package/dist/utils/TimeUtils.mjs +45 -45
  193. package/package.json +1 -1
  194. package/src/account/AccountInfo.ts +0 -1
  195. package/src/cache/CacheManager.ts +96 -18
  196. package/src/cache/utils/CacheTypes.ts +6 -6
  197. package/src/client/AuthorizationCodeClient.ts +3 -1
  198. package/src/client/RefreshTokenClient.ts +19 -2
  199. package/src/crypto/ICrypto.ts +0 -7
  200. package/src/index.ts +1 -0
  201. package/src/packageMetadata.ts +1 -1
  202. package/src/request/CommonRefreshTokenRequest.ts +3 -0
  203. package/src/request/CommonSilentFlowRequest.ts +2 -0
  204. package/src/telemetry/performance/PerformanceEvent.ts +9 -0
  205. package/src/utils/FunctionWrappers.ts +0 -1
@@ -1,4 +1,4 @@
1
- /*! @azure/msal-common v14.1.0-alpha.0 2023-09-20 */
1
+ /*! @azure/msal-common v14.1.0 2023-10-05 */
2
2
  'use strict';
3
3
  import { BaseClient } from './BaseClient.mjs';
4
4
  import { TimeUtils } from '../utils/TimeUtils.mjs';
@@ -12,128 +12,128 @@ import { extractTokenClaims, checkMaxAge } from '../account/AuthToken.mjs';
12
12
  import { tokenRefreshRequired, noAccountInSilentRequest, authTimeNotFound } from '../error/ClientAuthErrorCodes.mjs';
13
13
  import { tokenRequestEmpty } from '../error/ClientConfigurationErrorCodes.mjs';
14
14
 
15
- /*
16
- * Copyright (c) Microsoft Corporation. All rights reserved.
17
- * Licensed under the MIT License.
18
- */
19
- /** @internal */
20
- class SilentFlowClient extends BaseClient {
21
- constructor(configuration, performanceClient) {
22
- super(configuration, performanceClient);
23
- }
24
- /**
25
- * Retrieves a token from cache if it is still valid, or uses the cached refresh token to renew
26
- * the given token and returns the renewed token
27
- * @param request
28
- */
29
- async acquireToken(request) {
30
- try {
31
- const [authResponse, cacheOutcome] = await this.acquireCachedToken(request);
32
- // if the token is not expired but must be refreshed; get a new one in the background
33
- if (cacheOutcome === CacheOutcome.PROACTIVELY_REFRESHED) {
34
- this.logger.info("SilentFlowClient:acquireCachedToken - Cached access token's refreshOn property has been exceeded'. It's not expired, but must be refreshed.");
35
- // refresh the access token in the background
36
- const refreshTokenClient = new RefreshTokenClient(this.config, this.performanceClient);
37
- refreshTokenClient
38
- .acquireTokenByRefreshToken(request)
39
- .catch(() => {
40
- // do nothing, this is running in the background and no action is to be taken upon success or failure
41
- });
42
- }
43
- // return the cached token
44
- return authResponse;
45
- }
46
- catch (e) {
47
- if (e instanceof ClientAuthError &&
48
- e.errorCode === tokenRefreshRequired) {
49
- const refreshTokenClient = new RefreshTokenClient(this.config, this.performanceClient);
50
- return refreshTokenClient.acquireTokenByRefreshToken(request);
51
- }
52
- else {
53
- throw e;
54
- }
55
- }
56
- }
57
- /**
58
- * Retrieves token from cache or throws an error if it must be refreshed.
59
- * @param request
60
- */
61
- async acquireCachedToken(request) {
62
- let lastCacheOutcome = CacheOutcome.NOT_APPLICABLE;
63
- // Cannot renew token if no request object is given.
64
- if (!request) {
65
- throw createClientConfigurationError(tokenRequestEmpty);
66
- }
67
- if (request.forceRefresh) {
68
- // Must refresh due to present force_refresh flag.
69
- lastCacheOutcome = CacheOutcome.FORCE_REFRESH_OR_CLAIMS;
70
- this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.FORCE_REFRESH_OR_CLAIMS);
71
- this.logger.info("SilentFlowClient:acquireCachedToken - Skipping cache because forceRefresh is true.");
72
- throw createClientAuthError(tokenRefreshRequired);
73
- }
74
- else if (!this.config.cacheOptions.claimsBasedCachingEnabled &&
75
- !StringUtils.isEmptyObj(request.claims)) {
76
- lastCacheOutcome = CacheOutcome.FORCE_REFRESH_OR_CLAIMS;
77
- // Must refresh due to request parameters.
78
- this.logger.info("SilentFlowClient:acquireCachedToken - Skipping cache because claims-based caching is disabled and claims were requested.");
79
- throw createClientAuthError(tokenRefreshRequired);
80
- }
81
- // We currently do not support silent flow for account === null use cases; This will be revisited for confidential flow usecases
82
- if (!request.account) {
83
- throw createClientAuthError(noAccountInSilentRequest);
84
- }
85
- const environment = request.authority || this.authority.getPreferredCache();
86
- const cacheRecord = this.cacheManager.readCacheRecord(request.account, request, environment);
87
- if (!cacheRecord.accessToken) {
88
- // must refresh due to non-existent access_token
89
- lastCacheOutcome = CacheOutcome.NO_CACHED_ACCESS_TOKEN;
90
- this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.NO_CACHED_ACCESS_TOKEN);
91
- this.logger.info("SilentFlowClient:acquireCachedToken - No access token found in cache for the given properties.");
92
- throw createClientAuthError(tokenRefreshRequired);
93
- }
94
- else if (TimeUtils.wasClockTurnedBack(cacheRecord.accessToken.cachedAt) ||
95
- TimeUtils.isTokenExpired(cacheRecord.accessToken.expiresOn, this.config.systemOptions.tokenRenewalOffsetSeconds)) {
96
- // must refresh due to the expires_in value
97
- lastCacheOutcome = CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED;
98
- this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED);
99
- this.logger.info(`SilentFlowClient:acquireCachedToken - Cached access token is expired or will expire within ${this.config.systemOptions.tokenRenewalOffsetSeconds} seconds.`);
100
- throw createClientAuthError(tokenRefreshRequired);
101
- }
102
- else if (cacheRecord.accessToken.refreshOn &&
103
- TimeUtils.isTokenExpired(cacheRecord.accessToken.refreshOn, 0)) {
104
- // must refresh (in the background) due to the refresh_in value
105
- lastCacheOutcome = CacheOutcome.PROACTIVELY_REFRESHED;
106
- this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.PROACTIVELY_REFRESHED);
107
- this.logger.info("SilentFlowClient:acquireCachedToken - Cached access token's refreshOn property has been exceeded'.");
108
- // don't throw ClientAuthError.createRefreshRequiredError(), return cached token instead
109
- }
110
- if (this.config.serverTelemetryManager) {
111
- this.config.serverTelemetryManager.incrementCacheHits();
112
- }
113
- return [
114
- await this.generateResultFromCacheRecord(cacheRecord, request),
115
- lastCacheOutcome,
116
- ];
117
- }
118
- /**
119
- * Helper function to build response object from the CacheRecord
120
- * @param cacheRecord
121
- */
122
- async generateResultFromCacheRecord(cacheRecord, request) {
123
- let idTokenClaims;
124
- if (cacheRecord.idToken) {
125
- idTokenClaims = extractTokenClaims(cacheRecord.idToken.secret, this.config.cryptoInterface.base64Decode);
126
- }
127
- // token max_age check
128
- if (request.maxAge || request.maxAge === 0) {
129
- const authTime = idTokenClaims?.auth_time;
130
- if (!authTime) {
131
- throw createClientAuthError(authTimeNotFound);
132
- }
133
- checkMaxAge(authTime, request.maxAge);
134
- }
135
- return await ResponseHandler.generateAuthenticationResult(this.cryptoUtils, this.authority, cacheRecord, true, request, idTokenClaims);
136
- }
15
+ /*
16
+ * Copyright (c) Microsoft Corporation. All rights reserved.
17
+ * Licensed under the MIT License.
18
+ */
19
+ /** @internal */
20
+ class SilentFlowClient extends BaseClient {
21
+ constructor(configuration, performanceClient) {
22
+ super(configuration, performanceClient);
23
+ }
24
+ /**
25
+ * Retrieves a token from cache if it is still valid, or uses the cached refresh token to renew
26
+ * the given token and returns the renewed token
27
+ * @param request
28
+ */
29
+ async acquireToken(request) {
30
+ try {
31
+ const [authResponse, cacheOutcome] = await this.acquireCachedToken(request);
32
+ // if the token is not expired but must be refreshed; get a new one in the background
33
+ if (cacheOutcome === CacheOutcome.PROACTIVELY_REFRESHED) {
34
+ this.logger.info("SilentFlowClient:acquireCachedToken - Cached access token's refreshOn property has been exceeded'. It's not expired, but must be refreshed.");
35
+ // refresh the access token in the background
36
+ const refreshTokenClient = new RefreshTokenClient(this.config, this.performanceClient);
37
+ refreshTokenClient
38
+ .acquireTokenByRefreshToken(request)
39
+ .catch(() => {
40
+ // do nothing, this is running in the background and no action is to be taken upon success or failure
41
+ });
42
+ }
43
+ // return the cached token
44
+ return authResponse;
45
+ }
46
+ catch (e) {
47
+ if (e instanceof ClientAuthError &&
48
+ e.errorCode === tokenRefreshRequired) {
49
+ const refreshTokenClient = new RefreshTokenClient(this.config, this.performanceClient);
50
+ return refreshTokenClient.acquireTokenByRefreshToken(request);
51
+ }
52
+ else {
53
+ throw e;
54
+ }
55
+ }
56
+ }
57
+ /**
58
+ * Retrieves token from cache or throws an error if it must be refreshed.
59
+ * @param request
60
+ */
61
+ async acquireCachedToken(request) {
62
+ let lastCacheOutcome = CacheOutcome.NOT_APPLICABLE;
63
+ // Cannot renew token if no request object is given.
64
+ if (!request) {
65
+ throw createClientConfigurationError(tokenRequestEmpty);
66
+ }
67
+ if (request.forceRefresh) {
68
+ // Must refresh due to present force_refresh flag.
69
+ lastCacheOutcome = CacheOutcome.FORCE_REFRESH_OR_CLAIMS;
70
+ this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.FORCE_REFRESH_OR_CLAIMS);
71
+ this.logger.info("SilentFlowClient:acquireCachedToken - Skipping cache because forceRefresh is true.");
72
+ throw createClientAuthError(tokenRefreshRequired);
73
+ }
74
+ else if (!this.config.cacheOptions.claimsBasedCachingEnabled &&
75
+ !StringUtils.isEmptyObj(request.claims)) {
76
+ lastCacheOutcome = CacheOutcome.FORCE_REFRESH_OR_CLAIMS;
77
+ // Must refresh due to request parameters.
78
+ this.logger.info("SilentFlowClient:acquireCachedToken - Skipping cache because claims-based caching is disabled and claims were requested.");
79
+ throw createClientAuthError(tokenRefreshRequired);
80
+ }
81
+ // We currently do not support silent flow for account === null use cases; This will be revisited for confidential flow usecases
82
+ if (!request.account) {
83
+ throw createClientAuthError(noAccountInSilentRequest);
84
+ }
85
+ const environment = request.authority || this.authority.getPreferredCache();
86
+ const cacheRecord = this.cacheManager.readCacheRecord(request.account, request, environment);
87
+ if (!cacheRecord.accessToken) {
88
+ // must refresh due to non-existent access_token
89
+ lastCacheOutcome = CacheOutcome.NO_CACHED_ACCESS_TOKEN;
90
+ this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.NO_CACHED_ACCESS_TOKEN);
91
+ this.logger.info("SilentFlowClient:acquireCachedToken - No access token found in cache for the given properties.");
92
+ throw createClientAuthError(tokenRefreshRequired);
93
+ }
94
+ else if (TimeUtils.wasClockTurnedBack(cacheRecord.accessToken.cachedAt) ||
95
+ TimeUtils.isTokenExpired(cacheRecord.accessToken.expiresOn, this.config.systemOptions.tokenRenewalOffsetSeconds)) {
96
+ // must refresh due to the expires_in value
97
+ lastCacheOutcome = CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED;
98
+ this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED);
99
+ this.logger.info(`SilentFlowClient:acquireCachedToken - Cached access token is expired or will expire within ${this.config.systemOptions.tokenRenewalOffsetSeconds} seconds.`);
100
+ throw createClientAuthError(tokenRefreshRequired);
101
+ }
102
+ else if (cacheRecord.accessToken.refreshOn &&
103
+ TimeUtils.isTokenExpired(cacheRecord.accessToken.refreshOn, 0)) {
104
+ // must refresh (in the background) due to the refresh_in value
105
+ lastCacheOutcome = CacheOutcome.PROACTIVELY_REFRESHED;
106
+ this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.PROACTIVELY_REFRESHED);
107
+ this.logger.info("SilentFlowClient:acquireCachedToken - Cached access token's refreshOn property has been exceeded'.");
108
+ // don't throw ClientAuthError.createRefreshRequiredError(), return cached token instead
109
+ }
110
+ if (this.config.serverTelemetryManager) {
111
+ this.config.serverTelemetryManager.incrementCacheHits();
112
+ }
113
+ return [
114
+ await this.generateResultFromCacheRecord(cacheRecord, request),
115
+ lastCacheOutcome,
116
+ ];
117
+ }
118
+ /**
119
+ * Helper function to build response object from the CacheRecord
120
+ * @param cacheRecord
121
+ */
122
+ async generateResultFromCacheRecord(cacheRecord, request) {
123
+ let idTokenClaims;
124
+ if (cacheRecord.idToken) {
125
+ idTokenClaims = extractTokenClaims(cacheRecord.idToken.secret, this.config.cryptoInterface.base64Decode);
126
+ }
127
+ // token max_age check
128
+ if (request.maxAge || request.maxAge === 0) {
129
+ const authTime = idTokenClaims?.auth_time;
130
+ if (!authTime) {
131
+ throw createClientAuthError(authTimeNotFound);
132
+ }
133
+ checkMaxAge(authTime, request.maxAge);
134
+ }
135
+ return await ResponseHandler.generateAuthenticationResult(this.cryptoUtils, this.authority, cacheRecord, true, request, idTokenClaims);
136
+ }
137
137
  }
138
138
 
139
139
  export { SilentFlowClient };
@@ -1,39 +1,39 @@
1
- /**
2
- * Extensibility interface, which allows the app developer to return a token, based on the passed-in parameters, instead of fetching tokens from
3
- * the Identity Provider (AAD).
4
- * Developers need to construct and return an AppTokenProviderResult object back to MSAL. MSAL will cache the token response
5
- * in the same way it would do if the result were comming from AAD.
6
- * This extensibility point is only defined for the client_credential flow, i.e. acquireTokenByClientCredential and
7
- * meant for Azure SDK to enhance Managed Identity support.
8
- */
9
- export interface IAppTokenProvider {
10
- (appTokenProviderParameters: AppTokenProviderParameters): Promise<AppTokenProviderResult>;
11
- }
12
- /**
13
- * Input object for the IAppTokenProvider extensiblity. MSAL will create this object, which can be used
14
- * to help create an AppTokenProviderResult.
15
- *
16
- * - correlationId - the correlation Id associated with the request
17
- * - tenantId - the tenant Id for which the token must be provided
18
- * - scopes - the scopes for which the token must be provided
19
- * - claims - any extra claims that the token must satisfy
20
- */
21
- export type AppTokenProviderParameters = {
22
- readonly correlationId?: string;
23
- readonly tenantId: string;
24
- readonly scopes: Array<string>;
25
- readonly claims?: string;
26
- };
27
- /**
28
- * Output object for IAppTokenProvider extensiblity.
29
- *
30
- * - accessToken - the actual access token, typically in JWT format, that satisfies the request data AppTokenProviderParameters
31
- * - expiresInSeconds - how long the tokens has before expiry, in seconds. Similar to the "expires_in" field in an AAD token response.
32
- * - refreshInSeconds - how long the token has before it should be proactively refreshed. Similar to the "refresh_in" field in an AAD token response.
33
- */
34
- export type AppTokenProviderResult = {
35
- accessToken: string;
36
- expiresInSeconds: number;
37
- refreshInSeconds?: number;
38
- };
1
+ /**
2
+ * Extensibility interface, which allows the app developer to return a token, based on the passed-in parameters, instead of fetching tokens from
3
+ * the Identity Provider (AAD).
4
+ * Developers need to construct and return an AppTokenProviderResult object back to MSAL. MSAL will cache the token response
5
+ * in the same way it would do if the result were comming from AAD.
6
+ * This extensibility point is only defined for the client_credential flow, i.e. acquireTokenByClientCredential and
7
+ * meant for Azure SDK to enhance Managed Identity support.
8
+ */
9
+ export interface IAppTokenProvider {
10
+ (appTokenProviderParameters: AppTokenProviderParameters): Promise<AppTokenProviderResult>;
11
+ }
12
+ /**
13
+ * Input object for the IAppTokenProvider extensiblity. MSAL will create this object, which can be used
14
+ * to help create an AppTokenProviderResult.
15
+ *
16
+ * - correlationId - the correlation Id associated with the request
17
+ * - tenantId - the tenant Id for which the token must be provided
18
+ * - scopes - the scopes for which the token must be provided
19
+ * - claims - any extra claims that the token must satisfy
20
+ */
21
+ export type AppTokenProviderParameters = {
22
+ readonly correlationId?: string;
23
+ readonly tenantId: string;
24
+ readonly scopes: Array<string>;
25
+ readonly claims?: string;
26
+ };
27
+ /**
28
+ * Output object for IAppTokenProvider extensiblity.
29
+ *
30
+ * - accessToken - the actual access token, typically in JWT format, that satisfies the request data AppTokenProviderParameters
31
+ * - expiresInSeconds - how long the tokens has before expiry, in seconds. Similar to the "expires_in" field in an AAD token response.
32
+ * - refreshInSeconds - how long the token has before it should be proactively refreshed. Similar to the "refresh_in" field in an AAD token response.
33
+ */
34
+ export type AppTokenProviderResult = {
35
+ accessToken: string;
36
+ expiresInSeconds: number;
37
+ refreshInSeconds?: number;
38
+ };
39
39
  //# sourceMappingURL=AppTokenProvider.d.ts.map
@@ -1,151 +1,151 @@
1
- import { INetworkModule } from "../network/INetworkModule";
2
- import { ICrypto } from "../crypto/ICrypto";
3
- import { ILoggerCallback, LogLevel } from "../logger/Logger";
4
- import { Authority } from "../authority/Authority";
5
- import { AzureCloudInstance } from "../authority/AuthorityOptions";
6
- import { CacheManager } from "../cache/CacheManager";
7
- import { ServerTelemetryManager } from "../telemetry/server/ServerTelemetryManager";
8
- import { ICachePlugin } from "../cache/interface/ICachePlugin";
9
- import { ISerializableTokenCache } from "../cache/interface/ISerializableTokenCache";
10
- import { ClientCredentials } from "../account/ClientCredentials";
11
- /**
12
- * Use the configuration object to configure MSAL Modules and initialize the base interfaces for MSAL.
13
- *
14
- * This object allows you to configure important elements of MSAL functionality:
15
- * - authOptions - Authentication for application
16
- * - cryptoInterface - Implementation of crypto functions
17
- * - libraryInfo - Library metadata
18
- * - telemetry - Telemetry options and data
19
- * - loggerOptions - Logging for application
20
- * - networkInterface - Network implementation
21
- * - storageInterface - Storage implementation
22
- * - systemOptions - Additional library options
23
- * - clientCredentials - Credentials options for confidential clients
24
- * @internal
25
- */
26
- export type ClientConfiguration = {
27
- authOptions: AuthOptions;
28
- systemOptions?: SystemOptions;
29
- loggerOptions?: LoggerOptions;
30
- cacheOptions?: CacheOptions;
31
- storageInterface?: CacheManager;
32
- networkInterface?: INetworkModule;
33
- cryptoInterface?: ICrypto;
34
- clientCredentials?: ClientCredentials;
35
- libraryInfo?: LibraryInfo;
36
- telemetry?: TelemetryOptions;
37
- serverTelemetryManager?: ServerTelemetryManager | null;
38
- persistencePlugin?: ICachePlugin | null;
39
- serializableCache?: ISerializableTokenCache | null;
40
- };
41
- export type CommonClientConfiguration = {
42
- authOptions: Required<AuthOptions>;
43
- systemOptions: Required<SystemOptions>;
44
- loggerOptions: Required<LoggerOptions>;
45
- cacheOptions: Required<CacheOptions>;
46
- storageInterface: CacheManager;
47
- networkInterface: INetworkModule;
48
- cryptoInterface: Required<ICrypto>;
49
- libraryInfo: LibraryInfo;
50
- telemetry: Required<TelemetryOptions>;
51
- serverTelemetryManager: ServerTelemetryManager | null;
52
- clientCredentials: ClientCredentials;
53
- persistencePlugin: ICachePlugin | null;
54
- serializableCache: ISerializableTokenCache | null;
55
- };
56
- /**
57
- * Use this to configure the auth options in the ClientConfiguration object
58
- *
59
- * - clientId - Client ID of your app registered with our Application registration portal : https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview in Microsoft Identity Platform
60
- * - authority - You can configure a specific authority, defaults to " " or "https://login.microsoftonline.com/common"
61
- * - knownAuthorities - An array of URIs that are known to be valid. Used in B2C scenarios.
62
- * - cloudDiscoveryMetadata - A string containing the cloud discovery response. Used in AAD scenarios.
63
- * - clientCapabilities - Array of capabilities which will be added to the claims.access_token.xms_cc request property on every network request.
64
- * - protocolMode - Enum that represents the protocol that msal follows. Used for configuring proper endpoints.
65
- * - skipAuthorityMetadataCache - A flag to choose whether to use or not use the local metadata cache during authority initialization. Defaults to false.
66
- * @internal
67
- */
68
- export type AuthOptions = {
69
- clientId: string;
70
- authority: Authority;
71
- clientCapabilities?: Array<string>;
72
- azureCloudOptions?: AzureCloudOptions;
73
- skipAuthorityMetadataCache?: boolean;
74
- };
75
- /**
76
- * Use this to configure token renewal info in the Configuration object
77
- *
78
- * - tokenRenewalOffsetSeconds - Sets the window of offset needed to renew the token before expiry
79
- */
80
- export type SystemOptions = {
81
- tokenRenewalOffsetSeconds?: number;
82
- preventCorsPreflight?: boolean;
83
- };
84
- /**
85
- * Use this to configure the logging that MSAL does, by configuring logger options in the Configuration object
86
- *
87
- * - loggerCallback - Callback for logger
88
- * - piiLoggingEnabled - Sets whether pii logging is enabled
89
- * - logLevel - Sets the level at which logging happens
90
- * - correlationId - Sets the correlationId printed by the logger
91
- */
92
- export type LoggerOptions = {
93
- loggerCallback?: ILoggerCallback;
94
- piiLoggingEnabled?: boolean;
95
- logLevel?: LogLevel;
96
- correlationId?: string;
97
- };
98
- /**
99
- * Use this to configure credential cache preferences in the ClientConfiguration object
100
- *
101
- * - claimsBasedCachingEnabled - Sets whether tokens should be cached based on the claims hash. Default is false.
102
- */
103
- export type CacheOptions = {
104
- claimsBasedCachingEnabled?: boolean;
105
- };
106
- /**
107
- * Library-specific options
108
- */
109
- export type LibraryInfo = {
110
- sku: string;
111
- version: string;
112
- cpu: string;
113
- os: string;
114
- };
115
- /**
116
- * AzureCloudInstance specific options
117
- *
118
- * - azureCloudInstance - string enum providing short notation for soverign and public cloud authorities
119
- * - tenant - provision to provide the tenant info
120
- */
121
- export type AzureCloudOptions = {
122
- azureCloudInstance: AzureCloudInstance;
123
- tenant?: string;
124
- };
125
- export type TelemetryOptions = {
126
- application: ApplicationTelemetry;
127
- };
128
- /**
129
- * Telemetry information sent on request
130
- * - appName: Unique string name of an application
131
- * - appVersion: Version of the application using MSAL
132
- */
133
- export type ApplicationTelemetry = {
134
- appName: string;
135
- appVersion: string;
136
- };
137
- export declare const DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>;
138
- /**
139
- * Function that sets the default options when not explicitly configured from app developer
140
- *
141
- * @param Configuration
142
- *
143
- * @returns Configuration
144
- */
145
- export declare function buildClientConfiguration({ authOptions: userAuthOptions, systemOptions: userSystemOptions, loggerOptions: userLoggerOption, cacheOptions: userCacheOptions, storageInterface: storageImplementation, networkInterface: networkImplementation, cryptoInterface: cryptoImplementation, clientCredentials: clientCredentials, libraryInfo: libraryInfo, telemetry: telemetry, serverTelemetryManager: serverTelemetryManager, persistencePlugin: persistencePlugin, serializableCache: serializableCache, }: ClientConfiguration): CommonClientConfiguration;
146
- /**
147
- * Returns true if config has protocolMode set to ProtocolMode.OIDC, false otherwise
148
- * @param ClientConfiguration
149
- */
150
- export declare function isOidcProtocolMode(config: ClientConfiguration): boolean;
1
+ import { INetworkModule } from "../network/INetworkModule";
2
+ import { ICrypto } from "../crypto/ICrypto";
3
+ import { ILoggerCallback, LogLevel } from "../logger/Logger";
4
+ import { Authority } from "../authority/Authority";
5
+ import { AzureCloudInstance } from "../authority/AuthorityOptions";
6
+ import { CacheManager } from "../cache/CacheManager";
7
+ import { ServerTelemetryManager } from "../telemetry/server/ServerTelemetryManager";
8
+ import { ICachePlugin } from "../cache/interface/ICachePlugin";
9
+ import { ISerializableTokenCache } from "../cache/interface/ISerializableTokenCache";
10
+ import { ClientCredentials } from "../account/ClientCredentials";
11
+ /**
12
+ * Use the configuration object to configure MSAL Modules and initialize the base interfaces for MSAL.
13
+ *
14
+ * This object allows you to configure important elements of MSAL functionality:
15
+ * - authOptions - Authentication for application
16
+ * - cryptoInterface - Implementation of crypto functions
17
+ * - libraryInfo - Library metadata
18
+ * - telemetry - Telemetry options and data
19
+ * - loggerOptions - Logging for application
20
+ * - networkInterface - Network implementation
21
+ * - storageInterface - Storage implementation
22
+ * - systemOptions - Additional library options
23
+ * - clientCredentials - Credentials options for confidential clients
24
+ * @internal
25
+ */
26
+ export type ClientConfiguration = {
27
+ authOptions: AuthOptions;
28
+ systemOptions?: SystemOptions;
29
+ loggerOptions?: LoggerOptions;
30
+ cacheOptions?: CacheOptions;
31
+ storageInterface?: CacheManager;
32
+ networkInterface?: INetworkModule;
33
+ cryptoInterface?: ICrypto;
34
+ clientCredentials?: ClientCredentials;
35
+ libraryInfo?: LibraryInfo;
36
+ telemetry?: TelemetryOptions;
37
+ serverTelemetryManager?: ServerTelemetryManager | null;
38
+ persistencePlugin?: ICachePlugin | null;
39
+ serializableCache?: ISerializableTokenCache | null;
40
+ };
41
+ export type CommonClientConfiguration = {
42
+ authOptions: Required<AuthOptions>;
43
+ systemOptions: Required<SystemOptions>;
44
+ loggerOptions: Required<LoggerOptions>;
45
+ cacheOptions: Required<CacheOptions>;
46
+ storageInterface: CacheManager;
47
+ networkInterface: INetworkModule;
48
+ cryptoInterface: Required<ICrypto>;
49
+ libraryInfo: LibraryInfo;
50
+ telemetry: Required<TelemetryOptions>;
51
+ serverTelemetryManager: ServerTelemetryManager | null;
52
+ clientCredentials: ClientCredentials;
53
+ persistencePlugin: ICachePlugin | null;
54
+ serializableCache: ISerializableTokenCache | null;
55
+ };
56
+ /**
57
+ * Use this to configure the auth options in the ClientConfiguration object
58
+ *
59
+ * - clientId - Client ID of your app registered with our Application registration portal : https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview in Microsoft Identity Platform
60
+ * - authority - You can configure a specific authority, defaults to " " or "https://login.microsoftonline.com/common"
61
+ * - knownAuthorities - An array of URIs that are known to be valid. Used in B2C scenarios.
62
+ * - cloudDiscoveryMetadata - A string containing the cloud discovery response. Used in AAD scenarios.
63
+ * - clientCapabilities - Array of capabilities which will be added to the claims.access_token.xms_cc request property on every network request.
64
+ * - protocolMode - Enum that represents the protocol that msal follows. Used for configuring proper endpoints.
65
+ * - skipAuthorityMetadataCache - A flag to choose whether to use or not use the local metadata cache during authority initialization. Defaults to false.
66
+ * @internal
67
+ */
68
+ export type AuthOptions = {
69
+ clientId: string;
70
+ authority: Authority;
71
+ clientCapabilities?: Array<string>;
72
+ azureCloudOptions?: AzureCloudOptions;
73
+ skipAuthorityMetadataCache?: boolean;
74
+ };
75
+ /**
76
+ * Use this to configure token renewal info in the Configuration object
77
+ *
78
+ * - tokenRenewalOffsetSeconds - Sets the window of offset needed to renew the token before expiry
79
+ */
80
+ export type SystemOptions = {
81
+ tokenRenewalOffsetSeconds?: number;
82
+ preventCorsPreflight?: boolean;
83
+ };
84
+ /**
85
+ * Use this to configure the logging that MSAL does, by configuring logger options in the Configuration object
86
+ *
87
+ * - loggerCallback - Callback for logger
88
+ * - piiLoggingEnabled - Sets whether pii logging is enabled
89
+ * - logLevel - Sets the level at which logging happens
90
+ * - correlationId - Sets the correlationId printed by the logger
91
+ */
92
+ export type LoggerOptions = {
93
+ loggerCallback?: ILoggerCallback;
94
+ piiLoggingEnabled?: boolean;
95
+ logLevel?: LogLevel;
96
+ correlationId?: string;
97
+ };
98
+ /**
99
+ * Use this to configure credential cache preferences in the ClientConfiguration object
100
+ *
101
+ * - claimsBasedCachingEnabled - Sets whether tokens should be cached based on the claims hash. Default is false.
102
+ */
103
+ export type CacheOptions = {
104
+ claimsBasedCachingEnabled?: boolean;
105
+ };
106
+ /**
107
+ * Library-specific options
108
+ */
109
+ export type LibraryInfo = {
110
+ sku: string;
111
+ version: string;
112
+ cpu: string;
113
+ os: string;
114
+ };
115
+ /**
116
+ * AzureCloudInstance specific options
117
+ *
118
+ * - azureCloudInstance - string enum providing short notation for soverign and public cloud authorities
119
+ * - tenant - provision to provide the tenant info
120
+ */
121
+ export type AzureCloudOptions = {
122
+ azureCloudInstance: AzureCloudInstance;
123
+ tenant?: string;
124
+ };
125
+ export type TelemetryOptions = {
126
+ application: ApplicationTelemetry;
127
+ };
128
+ /**
129
+ * Telemetry information sent on request
130
+ * - appName: Unique string name of an application
131
+ * - appVersion: Version of the application using MSAL
132
+ */
133
+ export type ApplicationTelemetry = {
134
+ appName: string;
135
+ appVersion: string;
136
+ };
137
+ export declare const DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>;
138
+ /**
139
+ * Function that sets the default options when not explicitly configured from app developer
140
+ *
141
+ * @param Configuration
142
+ *
143
+ * @returns Configuration
144
+ */
145
+ export declare function buildClientConfiguration({ authOptions: userAuthOptions, systemOptions: userSystemOptions, loggerOptions: userLoggerOption, cacheOptions: userCacheOptions, storageInterface: storageImplementation, networkInterface: networkImplementation, cryptoInterface: cryptoImplementation, clientCredentials: clientCredentials, libraryInfo: libraryInfo, telemetry: telemetry, serverTelemetryManager: serverTelemetryManager, persistencePlugin: persistencePlugin, serializableCache: serializableCache, }: ClientConfiguration): CommonClientConfiguration;
146
+ /**
147
+ * Returns true if config has protocolMode set to ProtocolMode.OIDC, false otherwise
148
+ * @param ClientConfiguration
149
+ */
150
+ export declare function isOidcProtocolMode(config: ClientConfiguration): boolean;
151
151
  //# sourceMappingURL=ClientConfiguration.d.ts.map