@azure/msal-common 14.6.0-alpha.0 → 14.6.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 (203) hide show
  1. package/dist/account/AccountInfo.d.ts +58 -58
  2. package/dist/account/AccountInfo.mjs +59 -59
  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 +18 -18
  9. package/dist/account/ClientInfo.mjs +37 -37
  10. package/dist/account/TokenClaims.d.ts +83 -83
  11. package/dist/account/TokenClaims.mjs +20 -20
  12. package/dist/authority/Authority.d.ts +253 -254
  13. package/dist/authority/Authority.d.ts.map +1 -1
  14. package/dist/authority/Authority.mjs +827 -816
  15. package/dist/authority/Authority.mjs.map +1 -1
  16. package/dist/authority/AuthorityFactory.d.ts +31 -31
  17. package/dist/authority/AuthorityFactory.mjs +47 -47
  18. package/dist/authority/AuthorityMetadata.d.ts +503 -503
  19. package/dist/authority/AuthorityMetadata.mjs +603 -603
  20. package/dist/authority/AuthorityOptions.d.ts +27 -27
  21. package/dist/authority/AuthorityOptions.mjs +18 -18
  22. package/dist/authority/AuthorityType.d.ts +10 -10
  23. package/dist/authority/AuthorityType.mjs +13 -13
  24. package/dist/authority/AzureRegion.d.ts +1 -1
  25. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  26. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  27. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  28. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  29. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  30. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  31. package/dist/authority/ImdsOptions.d.ts +5 -5
  32. package/dist/authority/OIDCOptions.d.ts +8 -8
  33. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  34. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  35. package/dist/authority/ProtocolMode.d.ts +8 -8
  36. package/dist/authority/ProtocolMode.mjs +11 -11
  37. package/dist/authority/RegionDiscovery.d.ts +32 -32
  38. package/dist/authority/RegionDiscovery.mjs +106 -106
  39. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  40. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  41. package/dist/cache/CacheManager.d.ts +508 -508
  42. package/dist/cache/CacheManager.mjs +1237 -1237
  43. package/dist/cache/entities/AccessTokenEntity.d.ts +25 -25
  44. package/dist/cache/entities/AccountEntity.d.ts +106 -106
  45. package/dist/cache/entities/AccountEntity.mjs +244 -244
  46. package/dist/cache/entities/AppMetadataEntity.d.ts +11 -39
  47. package/dist/cache/entities/AppMetadataEntity.d.ts.map +1 -1
  48. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +15 -48
  49. package/dist/cache/entities/AuthorityMetadataEntity.d.ts.map +1 -1
  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 +30 -30
  53. package/dist/cache/entities/IdTokenEntity.d.ts +8 -8
  54. package/dist/cache/entities/RefreshTokenEntity.d.ts +7 -7
  55. package/dist/cache/entities/ServerTelemetryEntity.d.ts +5 -5
  56. package/dist/cache/entities/ThrottlingEntity.d.ts +7 -7
  57. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  58. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  59. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  60. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  61. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  62. package/dist/cache/utils/CacheHelpers.d.ts +94 -70
  63. package/dist/cache/utils/CacheHelpers.d.ts.map +1 -1
  64. package/dist/cache/utils/CacheHelpers.mjs +326 -252
  65. package/dist/cache/utils/CacheHelpers.mjs.map +1 -1
  66. package/dist/cache/utils/CacheTypes.d.ts +69 -69
  67. package/dist/client/AuthorizationCodeClient.d.ts +74 -74
  68. package/dist/client/AuthorizationCodeClient.mjs +402 -402
  69. package/dist/client/BaseClient.d.ts +51 -51
  70. package/dist/client/BaseClient.mjs +100 -100
  71. package/dist/client/RefreshTokenClient.d.ts +35 -35
  72. package/dist/client/RefreshTokenClient.mjs +204 -204
  73. package/dist/client/SilentFlowClient.d.ts +27 -27
  74. package/dist/client/SilentFlowClient.mjs +128 -128
  75. package/dist/config/AppTokenProvider.d.ts +38 -38
  76. package/dist/config/ClientConfiguration.d.ts +150 -150
  77. package/dist/config/ClientConfiguration.d.ts.map +1 -1
  78. package/dist/config/ClientConfiguration.mjs +98 -96
  79. package/dist/config/ClientConfiguration.mjs.map +1 -1
  80. package/dist/constants/AADServerParamKeys.d.ts +52 -52
  81. package/dist/constants/AADServerParamKeys.mjs +56 -56
  82. package/dist/crypto/ICrypto.d.ts +58 -58
  83. package/dist/crypto/ICrypto.mjs +30 -30
  84. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  85. package/dist/crypto/JoseHeader.d.ts +22 -22
  86. package/dist/crypto/JoseHeader.mjs +37 -37
  87. package/dist/crypto/PopTokenGenerator.d.ts +60 -60
  88. package/dist/crypto/PopTokenGenerator.mjs +82 -82
  89. package/dist/crypto/SignedHttpRequest.d.ts +15 -15
  90. package/dist/error/AuthError.d.ts +44 -44
  91. package/dist/error/AuthError.mjs +46 -46
  92. package/dist/error/AuthErrorCodes.d.ts +5 -5
  93. package/dist/error/AuthErrorCodes.mjs +9 -9
  94. package/dist/error/ClientAuthError.d.ts +237 -237
  95. package/dist/error/ClientAuthError.mjs +249 -249
  96. package/dist/error/ClientAuthErrorCodes.d.ts +44 -44
  97. package/dist/error/ClientAuthErrorCodes.mjs +48 -48
  98. package/dist/error/ClientConfigurationError.d.ts +128 -128
  99. package/dist/error/ClientConfigurationError.mjs +135 -135
  100. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  101. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  102. package/dist/error/InteractionRequiredAuthError.d.ts +61 -61
  103. package/dist/error/InteractionRequiredAuthError.mjs +84 -84
  104. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +7 -7
  105. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +13 -13
  106. package/dist/error/JoseHeaderError.d.ts +15 -15
  107. package/dist/error/JoseHeaderError.mjs +22 -22
  108. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  109. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  110. package/dist/error/ServerError.d.ts +7 -7
  111. package/dist/error/ServerError.mjs +14 -14
  112. package/dist/index.cjs +8557 -8611
  113. package/dist/index.cjs.map +1 -1
  114. package/dist/index.d.ts +99 -99
  115. package/dist/index.d.ts.map +1 -1
  116. package/dist/index.mjs +2 -4
  117. package/dist/index.mjs.map +1 -1
  118. package/dist/logger/Logger.d.ts +95 -95
  119. package/dist/logger/Logger.mjs +188 -188
  120. package/dist/network/INetworkModule.d.ts +29 -29
  121. package/dist/network/INetworkModule.mjs +12 -12
  122. package/dist/network/NetworkManager.d.ts +33 -33
  123. package/dist/network/NetworkManager.mjs +34 -34
  124. package/dist/network/RequestThumbprint.d.ts +18 -18
  125. package/dist/network/ThrottlingUtils.d.ts +42 -42
  126. package/dist/network/ThrottlingUtils.mjs +95 -95
  127. package/dist/packageMetadata.d.ts +2 -2
  128. package/dist/packageMetadata.d.ts.map +1 -1
  129. package/dist/packageMetadata.mjs +4 -4
  130. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  131. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  132. package/dist/request/BaseAuthRequest.d.ts +43 -43
  133. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  134. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  135. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  136. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  137. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  138. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  139. package/dist/request/CommonRefreshTokenRequest.d.ts +22 -22
  140. package/dist/request/CommonSilentFlowRequest.d.ts +27 -27
  141. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  142. package/dist/request/NativeRequest.d.ts +19 -19
  143. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  144. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  145. package/dist/request/RequestParameterBuilder.mjs +381 -381
  146. package/dist/request/RequestValidator.d.ts +33 -33
  147. package/dist/request/RequestValidator.mjs +81 -81
  148. package/dist/request/ScopeSet.d.ts +88 -88
  149. package/dist/request/ScopeSet.mjs +197 -197
  150. package/dist/request/StoreInCache.d.ts +8 -8
  151. package/dist/response/AuthenticationResult.d.ts +41 -41
  152. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  153. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  154. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  155. package/dist/response/IMDSBadResponse.d.ts +4 -4
  156. package/dist/response/ResponseHandler.d.ts +69 -69
  157. package/dist/response/ResponseHandler.mjs +350 -347
  158. package/dist/response/ResponseHandler.mjs.map +1 -1
  159. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  160. package/dist/response/ServerAuthorizationTokenResponse.d.ts +47 -47
  161. package/dist/telemetry/performance/IPerformanceClient.d.ts +57 -57
  162. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  163. package/dist/telemetry/performance/PerformanceClient.d.ts +198 -198
  164. package/dist/telemetry/performance/PerformanceClient.mjs +412 -412
  165. package/dist/telemetry/performance/PerformanceEvent.d.ts +464 -464
  166. package/dist/telemetry/performance/PerformanceEvent.mjs +253 -253
  167. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  168. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  169. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  170. package/dist/telemetry/server/ServerTelemetryManager.mjs +201 -201
  171. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  172. package/dist/url/IUri.d.ts +12 -12
  173. package/dist/url/UrlString.d.ts +48 -48
  174. package/dist/url/UrlString.mjs +161 -161
  175. package/dist/utils/Constants.d.ts +296 -298
  176. package/dist/utils/Constants.d.ts.map +1 -1
  177. package/dist/utils/Constants.mjs +310 -313
  178. package/dist/utils/Constants.mjs.map +1 -1
  179. package/dist/utils/FunctionWrappers.d.ts +27 -27
  180. package/dist/utils/FunctionWrappers.mjs +84 -84
  181. package/dist/utils/MsalTypes.d.ts +6 -6
  182. package/dist/utils/ProtocolUtils.d.ts +42 -42
  183. package/dist/utils/ProtocolUtils.mjs +69 -69
  184. package/dist/utils/StringUtils.d.ts +40 -40
  185. package/dist/utils/StringUtils.mjs +95 -95
  186. package/dist/utils/TimeUtils.d.ts +27 -27
  187. package/dist/utils/TimeUtils.mjs +45 -45
  188. package/dist/utils/UrlUtils.d.ts +10 -10
  189. package/dist/utils/UrlUtils.mjs +44 -44
  190. package/package.json +1 -1
  191. package/src/authority/Authority.ts +58 -25
  192. package/src/cache/entities/AppMetadataEntity.ts +6 -81
  193. package/src/cache/entities/AuthorityMetadataEntity.ts +2 -94
  194. package/src/cache/utils/CacheHelpers.ts +111 -0
  195. package/src/config/ClientConfiguration.ts +4 -4
  196. package/src/index.ts +0 -1
  197. package/src/packageMetadata.ts +1 -1
  198. package/src/response/ResponseHandler.ts +5 -5
  199. package/src/utils/Constants.ts +0 -4
  200. package/dist/cache/entities/AppMetadataEntity.mjs +0 -73
  201. package/dist/cache/entities/AppMetadataEntity.mjs.map +0 -1
  202. package/dist/cache/entities/AuthorityMetadataEntity.mjs +0 -86
  203. package/dist/cache/entities/AuthorityMetadataEntity.mjs.map +0 -1
@@ -1,4 +1,4 @@
1
- /*! @azure/msal-common v14.6.0-alpha.0 2023-12-15 */
1
+ /*! @azure/msal-common v14.6.0 2024-01-09 */
2
2
  'use strict';
3
3
  import { isOidcProtocolMode } from '../config/ClientConfiguration.mjs';
4
4
  import { BaseClient } from './BaseClient.mjs';
@@ -23,209 +23,209 @@ import { tokenRequestEmpty, missingSshJwk } from '../error/ClientConfigurationEr
23
23
  import { noAccountInSilentRequest } from '../error/ClientAuthErrorCodes.mjs';
24
24
  import { noTokensFound, refreshTokenExpired, badToken } from '../error/InteractionRequiredAuthErrorCodes.mjs';
25
25
 
26
- /*
27
- * Copyright (c) Microsoft Corporation. All rights reserved.
28
- * Licensed under the MIT License.
29
- */
30
- const DEFAULT_REFRESH_TOKEN_EXPIRATION_OFFSET_SECONDS = 300; // 5 Minutes
31
- /**
32
- * OAuth2.0 refresh token client
33
- * @internal
34
- */
35
- class RefreshTokenClient extends BaseClient {
36
- constructor(configuration, performanceClient) {
37
- super(configuration, performanceClient);
38
- }
39
- async acquireToken(request) {
40
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientAcquireToken, request.correlationId);
41
- const reqTimestamp = TimeUtils.nowSeconds();
42
- const response = await invokeAsync(this.executeTokenRequest.bind(this), PerformanceEvents.RefreshTokenClientExecuteTokenRequest, this.logger, this.performanceClient, request.correlationId)(request, this.authority);
43
- // Retrieve requestId from response headers
44
- const requestId = response.headers?.[HeaderNames.X_MS_REQUEST_ID];
45
- const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin);
46
- responseHandler.validateTokenResponse(response.body);
47
- return invokeAsync(responseHandler.handleServerTokenResponse.bind(responseHandler), PerformanceEvents.HandleServerTokenResponse, this.logger, this.performanceClient, request.correlationId)(response.body, this.authority, reqTimestamp, request, undefined, undefined, true, request.forceCache, requestId);
48
- }
49
- /**
50
- * Gets cached refresh token and attaches to request, then calls acquireToken API
51
- * @param request
52
- */
53
- async acquireTokenByRefreshToken(request) {
54
- // Cannot renew token if no request object is given.
55
- if (!request) {
56
- throw createClientConfigurationError(tokenRequestEmpty);
57
- }
58
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientAcquireTokenByRefreshToken, request.correlationId);
59
- // We currently do not support silent flow for account === null use cases; This will be revisited for confidential flow usecases
60
- if (!request.account) {
61
- throw createClientAuthError(noAccountInSilentRequest);
62
- }
63
- // try checking if FOCI is enabled for the given application
64
- const isFOCI = this.cacheManager.isAppMetadataFOCI(request.account.environment);
65
- // if the app is part of the family, retrive a Family refresh token if present and make a refreshTokenRequest
66
- if (isFOCI) {
67
- try {
68
- return await invokeAsync(this.acquireTokenWithCachedRefreshToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, this.logger, this.performanceClient, request.correlationId)(request, true);
69
- }
70
- catch (e) {
71
- const noFamilyRTInCache = e instanceof InteractionRequiredAuthError &&
72
- e.errorCode ===
73
- noTokensFound;
74
- const clientMismatchErrorWithFamilyRT = e instanceof ServerError &&
75
- e.errorCode === Errors.INVALID_GRANT_ERROR &&
76
- e.subError === Errors.CLIENT_MISMATCH_ERROR;
77
- // if family Refresh Token (FRT) cache acquisition fails or if client_mismatch error is seen with FRT, reattempt with application Refresh Token (ART)
78
- if (noFamilyRTInCache || clientMismatchErrorWithFamilyRT) {
79
- return invokeAsync(this.acquireTokenWithCachedRefreshToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, this.logger, this.performanceClient, request.correlationId)(request, false);
80
- // throw in all other cases
81
- }
82
- else {
83
- throw e;
84
- }
85
- }
86
- }
87
- // fall back to application refresh token acquisition
88
- return invokeAsync(this.acquireTokenWithCachedRefreshToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, this.logger, this.performanceClient, request.correlationId)(request, false);
89
- }
90
- /**
91
- * makes a network call to acquire tokens by exchanging RefreshToken available in userCache; throws if refresh token is not cached
92
- * @param request
93
- */
94
- async acquireTokenWithCachedRefreshToken(request, foci) {
95
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, request.correlationId);
96
- // fetches family RT or application RT based on FOCI value
97
- const refreshToken = invoke(this.cacheManager.getRefreshToken.bind(this.cacheManager), PerformanceEvents.CacheManagerGetRefreshToken, this.logger, this.performanceClient, request.correlationId)(request.account, foci, undefined, this.performanceClient, request.correlationId);
98
- if (!refreshToken) {
99
- throw createInteractionRequiredAuthError(noTokensFound);
100
- }
101
- if (refreshToken.expiresOn &&
102
- TimeUtils.isTokenExpired(refreshToken.expiresOn, request.refreshTokenExpirationOffsetSeconds ||
103
- DEFAULT_REFRESH_TOKEN_EXPIRATION_OFFSET_SECONDS)) {
104
- throw createInteractionRequiredAuthError(refreshTokenExpired);
105
- }
106
- // attach cached RT size to the current measurement
107
- const refreshTokenRequest = {
108
- ...request,
109
- refreshToken: refreshToken.secret,
110
- authenticationScheme: request.authenticationScheme || AuthenticationScheme.BEARER,
111
- ccsCredential: {
112
- credential: request.account.homeAccountId,
113
- type: CcsCredentialType.HOME_ACCOUNT_ID,
114
- },
115
- };
116
- try {
117
- return await invokeAsync(this.acquireToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireToken, this.logger, this.performanceClient, request.correlationId)(refreshTokenRequest);
118
- }
119
- catch (e) {
120
- if (e instanceof InteractionRequiredAuthError &&
121
- e.subError === badToken) {
122
- // Remove bad refresh token from cache
123
- this.logger.verbose("acquireTokenWithRefreshToken: bad refresh token, removing from cache");
124
- const badRefreshTokenKey = generateCredentialKey(refreshToken);
125
- this.cacheManager.removeRefreshToken(badRefreshTokenKey);
126
- }
127
- throw e;
128
- }
129
- }
130
- /**
131
- * Constructs the network message and makes a NW call to the underlying secure token service
132
- * @param request
133
- * @param authority
134
- */
135
- async executeTokenRequest(request, authority) {
136
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientExecuteTokenRequest, request.correlationId);
137
- const queryParametersString = this.createTokenQueryParameters(request);
138
- const endpoint = UrlString.appendQueryString(authority.tokenEndpoint, queryParametersString);
139
- const requestBody = await invokeAsync(this.createTokenRequestBody.bind(this), PerformanceEvents.RefreshTokenClientCreateTokenRequestBody, this.logger, this.performanceClient, request.correlationId)(request);
140
- const headers = this.createTokenRequestHeaders(request.ccsCredential);
141
- const thumbprint = {
142
- clientId: request.tokenBodyParameters?.clientId ||
143
- this.config.authOptions.clientId,
144
- authority: authority.canonicalAuthority,
145
- scopes: request.scopes,
146
- claims: request.claims,
147
- authenticationScheme: request.authenticationScheme,
148
- resourceRequestMethod: request.resourceRequestMethod,
149
- resourceRequestUri: request.resourceRequestUri,
150
- shrClaims: request.shrClaims,
151
- sshKid: request.sshKid,
152
- };
153
- return invokeAsync(this.executePostToTokenEndpoint.bind(this), PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint, this.logger, this.performanceClient, request.correlationId)(endpoint, requestBody, headers, thumbprint, request.correlationId, PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint);
154
- }
155
- /**
156
- * Helper function to create the token request body
157
- * @param request
158
- */
159
- async createTokenRequestBody(request) {
160
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientCreateTokenRequestBody, request.correlationId);
161
- const correlationId = request.correlationId;
162
- const parameterBuilder = new RequestParameterBuilder();
163
- parameterBuilder.addClientId(request.tokenBodyParameters?.[CLIENT_ID] ||
164
- this.config.authOptions.clientId);
165
- if (request.redirectUri) {
166
- parameterBuilder.addRedirectUri(request.redirectUri);
167
- }
168
- parameterBuilder.addScopes(request.scopes, true, this.config.authOptions.authority.options.OIDCOptions?.defaultScopes);
169
- parameterBuilder.addGrantType(GrantType.REFRESH_TOKEN_GRANT);
170
- parameterBuilder.addClientInfo();
171
- parameterBuilder.addLibraryInfo(this.config.libraryInfo);
172
- parameterBuilder.addApplicationTelemetry(this.config.telemetry.application);
173
- parameterBuilder.addThrottling();
174
- if (this.serverTelemetryManager && !isOidcProtocolMode(this.config)) {
175
- parameterBuilder.addServerTelemetry(this.serverTelemetryManager);
176
- }
177
- parameterBuilder.addCorrelationId(correlationId);
178
- parameterBuilder.addRefreshToken(request.refreshToken);
179
- if (this.config.clientCredentials.clientSecret) {
180
- parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret);
181
- }
182
- if (this.config.clientCredentials.clientAssertion) {
183
- const clientAssertion = this.config.clientCredentials.clientAssertion;
184
- parameterBuilder.addClientAssertion(clientAssertion.assertion);
185
- parameterBuilder.addClientAssertionType(clientAssertion.assertionType);
186
- }
187
- if (request.authenticationScheme === AuthenticationScheme.POP) {
188
- const popTokenGenerator = new PopTokenGenerator(this.cryptoUtils, this.performanceClient);
189
- const reqCnfData = await invokeAsync(popTokenGenerator.generateCnf.bind(popTokenGenerator), PerformanceEvents.PopTokenGenerateCnf, this.logger, this.performanceClient, request.correlationId)(request, this.logger);
190
- // SPA PoP requires full Base64Url encoded req_cnf string (unhashed)
191
- parameterBuilder.addPopToken(reqCnfData.reqCnfString);
192
- }
193
- else if (request.authenticationScheme === AuthenticationScheme.SSH) {
194
- if (request.sshJwk) {
195
- parameterBuilder.addSshJwk(request.sshJwk);
196
- }
197
- else {
198
- throw createClientConfigurationError(missingSshJwk);
199
- }
200
- }
201
- if (!StringUtils.isEmptyObj(request.claims) ||
202
- (this.config.authOptions.clientCapabilities &&
203
- this.config.authOptions.clientCapabilities.length > 0)) {
204
- parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities);
205
- }
206
- if (this.config.systemOptions.preventCorsPreflight &&
207
- request.ccsCredential) {
208
- switch (request.ccsCredential.type) {
209
- case CcsCredentialType.HOME_ACCOUNT_ID:
210
- try {
211
- const clientInfo = buildClientInfoFromHomeAccountId(request.ccsCredential.credential);
212
- parameterBuilder.addCcsOid(clientInfo);
213
- }
214
- catch (e) {
215
- this.logger.verbose("Could not parse home account ID for CCS Header: " +
216
- e);
217
- }
218
- break;
219
- case CcsCredentialType.UPN:
220
- parameterBuilder.addCcsUpn(request.ccsCredential.credential);
221
- break;
222
- }
223
- }
224
- if (request.tokenBodyParameters) {
225
- parameterBuilder.addExtraQueryParameters(request.tokenBodyParameters);
226
- }
227
- return parameterBuilder.createQueryString();
228
- }
26
+ /*
27
+ * Copyright (c) Microsoft Corporation. All rights reserved.
28
+ * Licensed under the MIT License.
29
+ */
30
+ const DEFAULT_REFRESH_TOKEN_EXPIRATION_OFFSET_SECONDS = 300; // 5 Minutes
31
+ /**
32
+ * OAuth2.0 refresh token client
33
+ * @internal
34
+ */
35
+ class RefreshTokenClient extends BaseClient {
36
+ constructor(configuration, performanceClient) {
37
+ super(configuration, performanceClient);
38
+ }
39
+ async acquireToken(request) {
40
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientAcquireToken, request.correlationId);
41
+ const reqTimestamp = TimeUtils.nowSeconds();
42
+ const response = await invokeAsync(this.executeTokenRequest.bind(this), PerformanceEvents.RefreshTokenClientExecuteTokenRequest, this.logger, this.performanceClient, request.correlationId)(request, this.authority);
43
+ // Retrieve requestId from response headers
44
+ const requestId = response.headers?.[HeaderNames.X_MS_REQUEST_ID];
45
+ const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin);
46
+ responseHandler.validateTokenResponse(response.body);
47
+ return invokeAsync(responseHandler.handleServerTokenResponse.bind(responseHandler), PerformanceEvents.HandleServerTokenResponse, this.logger, this.performanceClient, request.correlationId)(response.body, this.authority, reqTimestamp, request, undefined, undefined, true, request.forceCache, requestId);
48
+ }
49
+ /**
50
+ * Gets cached refresh token and attaches to request, then calls acquireToken API
51
+ * @param request
52
+ */
53
+ async acquireTokenByRefreshToken(request) {
54
+ // Cannot renew token if no request object is given.
55
+ if (!request) {
56
+ throw createClientConfigurationError(tokenRequestEmpty);
57
+ }
58
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientAcquireTokenByRefreshToken, request.correlationId);
59
+ // We currently do not support silent flow for account === null use cases; This will be revisited for confidential flow usecases
60
+ if (!request.account) {
61
+ throw createClientAuthError(noAccountInSilentRequest);
62
+ }
63
+ // try checking if FOCI is enabled for the given application
64
+ const isFOCI = this.cacheManager.isAppMetadataFOCI(request.account.environment);
65
+ // if the app is part of the family, retrive a Family refresh token if present and make a refreshTokenRequest
66
+ if (isFOCI) {
67
+ try {
68
+ return await invokeAsync(this.acquireTokenWithCachedRefreshToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, this.logger, this.performanceClient, request.correlationId)(request, true);
69
+ }
70
+ catch (e) {
71
+ const noFamilyRTInCache = e instanceof InteractionRequiredAuthError &&
72
+ e.errorCode ===
73
+ noTokensFound;
74
+ const clientMismatchErrorWithFamilyRT = e instanceof ServerError &&
75
+ e.errorCode === Errors.INVALID_GRANT_ERROR &&
76
+ e.subError === Errors.CLIENT_MISMATCH_ERROR;
77
+ // if family Refresh Token (FRT) cache acquisition fails or if client_mismatch error is seen with FRT, reattempt with application Refresh Token (ART)
78
+ if (noFamilyRTInCache || clientMismatchErrorWithFamilyRT) {
79
+ return invokeAsync(this.acquireTokenWithCachedRefreshToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, this.logger, this.performanceClient, request.correlationId)(request, false);
80
+ // throw in all other cases
81
+ }
82
+ else {
83
+ throw e;
84
+ }
85
+ }
86
+ }
87
+ // fall back to application refresh token acquisition
88
+ return invokeAsync(this.acquireTokenWithCachedRefreshToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, this.logger, this.performanceClient, request.correlationId)(request, false);
89
+ }
90
+ /**
91
+ * makes a network call to acquire tokens by exchanging RefreshToken available in userCache; throws if refresh token is not cached
92
+ * @param request
93
+ */
94
+ async acquireTokenWithCachedRefreshToken(request, foci) {
95
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, request.correlationId);
96
+ // fetches family RT or application RT based on FOCI value
97
+ const refreshToken = invoke(this.cacheManager.getRefreshToken.bind(this.cacheManager), PerformanceEvents.CacheManagerGetRefreshToken, this.logger, this.performanceClient, request.correlationId)(request.account, foci, undefined, this.performanceClient, request.correlationId);
98
+ if (!refreshToken) {
99
+ throw createInteractionRequiredAuthError(noTokensFound);
100
+ }
101
+ if (refreshToken.expiresOn &&
102
+ TimeUtils.isTokenExpired(refreshToken.expiresOn, request.refreshTokenExpirationOffsetSeconds ||
103
+ DEFAULT_REFRESH_TOKEN_EXPIRATION_OFFSET_SECONDS)) {
104
+ throw createInteractionRequiredAuthError(refreshTokenExpired);
105
+ }
106
+ // attach cached RT size to the current measurement
107
+ const refreshTokenRequest = {
108
+ ...request,
109
+ refreshToken: refreshToken.secret,
110
+ authenticationScheme: request.authenticationScheme || AuthenticationScheme.BEARER,
111
+ ccsCredential: {
112
+ credential: request.account.homeAccountId,
113
+ type: CcsCredentialType.HOME_ACCOUNT_ID,
114
+ },
115
+ };
116
+ try {
117
+ return await invokeAsync(this.acquireToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireToken, this.logger, this.performanceClient, request.correlationId)(refreshTokenRequest);
118
+ }
119
+ catch (e) {
120
+ if (e instanceof InteractionRequiredAuthError &&
121
+ e.subError === badToken) {
122
+ // Remove bad refresh token from cache
123
+ this.logger.verbose("acquireTokenWithRefreshToken: bad refresh token, removing from cache");
124
+ const badRefreshTokenKey = generateCredentialKey(refreshToken);
125
+ this.cacheManager.removeRefreshToken(badRefreshTokenKey);
126
+ }
127
+ throw e;
128
+ }
129
+ }
130
+ /**
131
+ * Constructs the network message and makes a NW call to the underlying secure token service
132
+ * @param request
133
+ * @param authority
134
+ */
135
+ async executeTokenRequest(request, authority) {
136
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientExecuteTokenRequest, request.correlationId);
137
+ const queryParametersString = this.createTokenQueryParameters(request);
138
+ const endpoint = UrlString.appendQueryString(authority.tokenEndpoint, queryParametersString);
139
+ const requestBody = await invokeAsync(this.createTokenRequestBody.bind(this), PerformanceEvents.RefreshTokenClientCreateTokenRequestBody, this.logger, this.performanceClient, request.correlationId)(request);
140
+ const headers = this.createTokenRequestHeaders(request.ccsCredential);
141
+ const thumbprint = {
142
+ clientId: request.tokenBodyParameters?.clientId ||
143
+ this.config.authOptions.clientId,
144
+ authority: authority.canonicalAuthority,
145
+ scopes: request.scopes,
146
+ claims: request.claims,
147
+ authenticationScheme: request.authenticationScheme,
148
+ resourceRequestMethod: request.resourceRequestMethod,
149
+ resourceRequestUri: request.resourceRequestUri,
150
+ shrClaims: request.shrClaims,
151
+ sshKid: request.sshKid,
152
+ };
153
+ return invokeAsync(this.executePostToTokenEndpoint.bind(this), PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint, this.logger, this.performanceClient, request.correlationId)(endpoint, requestBody, headers, thumbprint, request.correlationId, PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint);
154
+ }
155
+ /**
156
+ * Helper function to create the token request body
157
+ * @param request
158
+ */
159
+ async createTokenRequestBody(request) {
160
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientCreateTokenRequestBody, request.correlationId);
161
+ const correlationId = request.correlationId;
162
+ const parameterBuilder = new RequestParameterBuilder();
163
+ parameterBuilder.addClientId(request.tokenBodyParameters?.[CLIENT_ID] ||
164
+ this.config.authOptions.clientId);
165
+ if (request.redirectUri) {
166
+ parameterBuilder.addRedirectUri(request.redirectUri);
167
+ }
168
+ parameterBuilder.addScopes(request.scopes, true, this.config.authOptions.authority.options.OIDCOptions?.defaultScopes);
169
+ parameterBuilder.addGrantType(GrantType.REFRESH_TOKEN_GRANT);
170
+ parameterBuilder.addClientInfo();
171
+ parameterBuilder.addLibraryInfo(this.config.libraryInfo);
172
+ parameterBuilder.addApplicationTelemetry(this.config.telemetry.application);
173
+ parameterBuilder.addThrottling();
174
+ if (this.serverTelemetryManager && !isOidcProtocolMode(this.config)) {
175
+ parameterBuilder.addServerTelemetry(this.serverTelemetryManager);
176
+ }
177
+ parameterBuilder.addCorrelationId(correlationId);
178
+ parameterBuilder.addRefreshToken(request.refreshToken);
179
+ if (this.config.clientCredentials.clientSecret) {
180
+ parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret);
181
+ }
182
+ if (this.config.clientCredentials.clientAssertion) {
183
+ const clientAssertion = this.config.clientCredentials.clientAssertion;
184
+ parameterBuilder.addClientAssertion(clientAssertion.assertion);
185
+ parameterBuilder.addClientAssertionType(clientAssertion.assertionType);
186
+ }
187
+ if (request.authenticationScheme === AuthenticationScheme.POP) {
188
+ const popTokenGenerator = new PopTokenGenerator(this.cryptoUtils, this.performanceClient);
189
+ const reqCnfData = await invokeAsync(popTokenGenerator.generateCnf.bind(popTokenGenerator), PerformanceEvents.PopTokenGenerateCnf, this.logger, this.performanceClient, request.correlationId)(request, this.logger);
190
+ // SPA PoP requires full Base64Url encoded req_cnf string (unhashed)
191
+ parameterBuilder.addPopToken(reqCnfData.reqCnfString);
192
+ }
193
+ else if (request.authenticationScheme === AuthenticationScheme.SSH) {
194
+ if (request.sshJwk) {
195
+ parameterBuilder.addSshJwk(request.sshJwk);
196
+ }
197
+ else {
198
+ throw createClientConfigurationError(missingSshJwk);
199
+ }
200
+ }
201
+ if (!StringUtils.isEmptyObj(request.claims) ||
202
+ (this.config.authOptions.clientCapabilities &&
203
+ this.config.authOptions.clientCapabilities.length > 0)) {
204
+ parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities);
205
+ }
206
+ if (this.config.systemOptions.preventCorsPreflight &&
207
+ request.ccsCredential) {
208
+ switch (request.ccsCredential.type) {
209
+ case CcsCredentialType.HOME_ACCOUNT_ID:
210
+ try {
211
+ const clientInfo = buildClientInfoFromHomeAccountId(request.ccsCredential.credential);
212
+ parameterBuilder.addCcsOid(clientInfo);
213
+ }
214
+ catch (e) {
215
+ this.logger.verbose("Could not parse home account ID for CCS Header: " +
216
+ e);
217
+ }
218
+ break;
219
+ case CcsCredentialType.UPN:
220
+ parameterBuilder.addCcsUpn(request.ccsCredential.credential);
221
+ break;
222
+ }
223
+ }
224
+ if (request.tokenBodyParameters) {
225
+ parameterBuilder.addExtraQueryParameters(request.tokenBodyParameters);
226
+ }
227
+ return parameterBuilder.createQueryString();
228
+ }
229
229
  }
230
230
 
231
231
  export { RefreshTokenClient };
@@ -1,28 +1,28 @@
1
- import { BaseClient } from "./BaseClient";
2
- import { ClientConfiguration } from "../config/ClientConfiguration";
3
- import { CommonSilentFlowRequest } from "../request/CommonSilentFlowRequest";
4
- import { AuthenticationResult } from "../response/AuthenticationResult";
5
- import { CacheOutcome } from "../utils/Constants";
6
- import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
7
- /** @internal */
8
- export declare class SilentFlowClient extends BaseClient {
9
- constructor(configuration: ClientConfiguration, performanceClient?: IPerformanceClient);
10
- /**
11
- * Retrieves a token from cache if it is still valid, or uses the cached refresh token to renew
12
- * the given token and returns the renewed token
13
- * @param request
14
- */
15
- acquireToken(request: CommonSilentFlowRequest): Promise<AuthenticationResult>;
16
- /**
17
- * Retrieves token from cache or throws an error if it must be refreshed.
18
- * @param request
19
- */
20
- acquireCachedToken(request: CommonSilentFlowRequest): Promise<[AuthenticationResult, CacheOutcome]>;
21
- private setCacheOutcome;
22
- /**
23
- * Helper function to build response object from the CacheRecord
24
- * @param cacheRecord
25
- */
26
- private generateResultFromCacheRecord;
27
- }
1
+ import { BaseClient } from "./BaseClient";
2
+ import { ClientConfiguration } from "../config/ClientConfiguration";
3
+ import { CommonSilentFlowRequest } from "../request/CommonSilentFlowRequest";
4
+ import { AuthenticationResult } from "../response/AuthenticationResult";
5
+ import { CacheOutcome } from "../utils/Constants";
6
+ import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
7
+ /** @internal */
8
+ export declare class SilentFlowClient extends BaseClient {
9
+ constructor(configuration: ClientConfiguration, performanceClient?: IPerformanceClient);
10
+ /**
11
+ * Retrieves a token from cache if it is still valid, or uses the cached refresh token to renew
12
+ * the given token and returns the renewed token
13
+ * @param request
14
+ */
15
+ acquireToken(request: CommonSilentFlowRequest): Promise<AuthenticationResult>;
16
+ /**
17
+ * Retrieves token from cache or throws an error if it must be refreshed.
18
+ * @param request
19
+ */
20
+ acquireCachedToken(request: CommonSilentFlowRequest): Promise<[AuthenticationResult, CacheOutcome]>;
21
+ private setCacheOutcome;
22
+ /**
23
+ * Helper function to build response object from the CacheRecord
24
+ * @param cacheRecord
25
+ */
26
+ private generateResultFromCacheRecord;
27
+ }
28
28
  //# sourceMappingURL=SilentFlowClient.d.ts.map