@azure/msal-common 14.0.3 → 14.1.0-alpha.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 (296) hide show
  1. package/dist/account/AccountInfo.d.ts +32 -32
  2. package/dist/account/AuthToken.d.ts +17 -17
  3. package/dist/account/AuthToken.d.ts.map +1 -1
  4. package/dist/account/AuthToken.mjs +60 -59
  5. package/dist/account/AuthToken.mjs.map +1 -1
  6. package/dist/account/CcsCredential.d.ts +9 -9
  7. package/dist/account/CcsCredential.mjs +8 -8
  8. package/dist/account/ClientCredentials.d.ts +14 -14
  9. package/dist/account/ClientInfo.d.ts +19 -19
  10. package/dist/account/ClientInfo.d.ts.map +1 -1
  11. package/dist/account/ClientInfo.mjs +39 -38
  12. package/dist/account/ClientInfo.mjs.map +1 -1
  13. package/dist/account/TokenClaims.d.ts +65 -65
  14. package/dist/authority/Authority.d.ts +235 -235
  15. package/dist/authority/Authority.d.ts.map +1 -1
  16. package/dist/authority/Authority.mjs +743 -765
  17. package/dist/authority/Authority.mjs.map +1 -1
  18. package/dist/authority/AuthorityFactory.d.ts +31 -31
  19. package/dist/authority/AuthorityFactory.d.ts.map +1 -1
  20. package/dist/authority/AuthorityFactory.mjs +52 -50
  21. package/dist/authority/AuthorityFactory.mjs.map +1 -1
  22. package/dist/authority/AuthorityMetadata.d.ts +623 -623
  23. package/dist/authority/AuthorityMetadata.mjs +884 -884
  24. package/dist/authority/AuthorityOptions.d.ts +21 -21
  25. package/dist/authority/AuthorityOptions.mjs +18 -18
  26. package/dist/authority/AuthorityType.d.ts +10 -10
  27. package/dist/authority/AuthorityType.mjs +13 -13
  28. package/dist/authority/AzureRegion.d.ts +1 -1
  29. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  30. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  31. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  32. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  33. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  34. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  35. package/dist/authority/ImdsOptions.d.ts +5 -5
  36. package/dist/authority/OIDCOptions.d.ts +8 -8
  37. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  38. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  39. package/dist/authority/ProtocolMode.d.ts +8 -8
  40. package/dist/authority/ProtocolMode.mjs +11 -11
  41. package/dist/authority/RegionDiscovery.d.ts +32 -30
  42. package/dist/authority/RegionDiscovery.d.ts.map +1 -1
  43. package/dist/authority/RegionDiscovery.mjs +107 -108
  44. package/dist/authority/RegionDiscovery.mjs.map +1 -1
  45. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  46. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  47. package/dist/cache/CacheManager.d.ts +446 -446
  48. package/dist/cache/CacheManager.d.ts.map +1 -1
  49. package/dist/cache/CacheManager.mjs +1000 -1024
  50. package/dist/cache/CacheManager.mjs.map +1 -1
  51. package/dist/cache/entities/AccessTokenEntity.d.ts +56 -56
  52. package/dist/cache/entities/AccessTokenEntity.d.ts.map +1 -1
  53. package/dist/cache/entities/AccessTokenEntity.mjs +111 -110
  54. package/dist/cache/entities/AccessTokenEntity.mjs.map +1 -1
  55. package/dist/cache/entities/AccountEntity.d.ts +101 -101
  56. package/dist/cache/entities/AccountEntity.d.ts.map +1 -1
  57. package/dist/cache/entities/AccountEntity.mjs +222 -221
  58. package/dist/cache/entities/AccountEntity.mjs.map +1 -1
  59. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  60. package/dist/cache/entities/AppMetadataEntity.mjs +66 -66
  61. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +48 -48
  62. package/dist/cache/entities/AuthorityMetadataEntity.mjs +78 -78
  63. package/dist/cache/entities/CacheRecord.d.ts +14 -14
  64. package/dist/cache/entities/CacheRecord.mjs +14 -14
  65. package/dist/cache/entities/CredentialEntity.d.ts +88 -88
  66. package/dist/cache/entities/CredentialEntity.d.ts.map +1 -1
  67. package/dist/cache/entities/CredentialEntity.mjs +138 -137
  68. package/dist/cache/entities/CredentialEntity.mjs.map +1 -1
  69. package/dist/cache/entities/IdTokenEntity.d.ts +34 -34
  70. package/dist/cache/entities/IdTokenEntity.mjs +56 -56
  71. package/dist/cache/entities/RefreshTokenEntity.d.ts +36 -36
  72. package/dist/cache/entities/RefreshTokenEntity.mjs +59 -59
  73. package/dist/cache/entities/ServerTelemetryEntity.d.ts +12 -12
  74. package/dist/cache/entities/ServerTelemetryEntity.mjs +27 -27
  75. package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
  76. package/dist/cache/entities/ThrottlingEntity.mjs +23 -23
  77. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  78. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  79. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  80. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  81. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  82. package/dist/cache/utils/CacheTypes.d.ts +69 -69
  83. package/dist/client/AuthorizationCodeClient.d.ts +73 -73
  84. package/dist/client/AuthorizationCodeClient.d.ts.map +1 -1
  85. package/dist/client/AuthorizationCodeClient.mjs +411 -410
  86. package/dist/client/AuthorizationCodeClient.mjs.map +1 -1
  87. package/dist/client/BaseClient.d.ts +51 -51
  88. package/dist/client/BaseClient.d.ts.map +1 -1
  89. package/dist/client/BaseClient.mjs +100 -99
  90. package/dist/client/BaseClient.mjs.map +1 -1
  91. package/dist/client/RefreshTokenClient.d.ts +35 -35
  92. package/dist/client/RefreshTokenClient.d.ts.map +1 -1
  93. package/dist/client/RefreshTokenClient.mjs +185 -234
  94. package/dist/client/RefreshTokenClient.mjs.map +1 -1
  95. package/dist/client/SilentFlowClient.d.ts +26 -25
  96. package/dist/client/SilentFlowClient.d.ts.map +1 -1
  97. package/dist/client/SilentFlowClient.mjs +127 -103
  98. package/dist/client/SilentFlowClient.mjs.map +1 -1
  99. package/dist/config/AppTokenProvider.d.ts +38 -38
  100. package/dist/config/ClientConfiguration.d.ts +150 -150
  101. package/dist/config/ClientConfiguration.d.ts.map +1 -1
  102. package/dist/config/ClientConfiguration.mjs +99 -100
  103. package/dist/config/ClientConfiguration.mjs.map +1 -1
  104. package/dist/crypto/ICrypto.d.ts +62 -62
  105. package/dist/crypto/ICrypto.d.ts.map +1 -1
  106. package/dist/crypto/ICrypto.mjs +35 -43
  107. package/dist/crypto/ICrypto.mjs.map +1 -1
  108. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  109. package/dist/crypto/JoseHeader.d.ts +22 -22
  110. package/dist/crypto/JoseHeader.d.ts.map +1 -1
  111. package/dist/crypto/JoseHeader.mjs +39 -38
  112. package/dist/crypto/JoseHeader.mjs.map +1 -1
  113. package/dist/crypto/PopTokenGenerator.d.ts +60 -59
  114. package/dist/crypto/PopTokenGenerator.d.ts.map +1 -1
  115. package/dist/crypto/PopTokenGenerator.mjs +83 -83
  116. package/dist/crypto/PopTokenGenerator.mjs.map +1 -1
  117. package/dist/crypto/SignedHttpRequest.d.ts +11 -11
  118. package/dist/error/AuthError.d.ts +44 -47
  119. package/dist/error/AuthError.d.ts.map +1 -1
  120. package/dist/error/AuthError.mjs +50 -52
  121. package/dist/error/AuthError.mjs.map +1 -1
  122. package/dist/error/AuthErrorCodes.d.ts +6 -0
  123. package/dist/error/AuthErrorCodes.d.ts.map +1 -0
  124. package/dist/error/AuthErrorCodes.mjs +14 -0
  125. package/dist/error/AuthErrorCodes.mjs.map +1 -0
  126. package/dist/error/ClientAuthError.d.ts +232 -412
  127. package/dist/error/ClientAuthError.d.ts.map +1 -1
  128. package/dist/error/ClientAuthError.mjs +248 -520
  129. package/dist/error/ClientAuthError.mjs.map +1 -1
  130. package/dist/error/ClientAuthErrorCodes.d.ts +44 -0
  131. package/dist/error/ClientAuthErrorCodes.d.ts.map +1 -0
  132. package/dist/error/ClientAuthErrorCodes.mjs +52 -0
  133. package/dist/error/ClientAuthErrorCodes.mjs.map +1 -0
  134. package/dist/error/ClientConfigurationError.d.ts +128 -222
  135. package/dist/error/ClientConfigurationError.d.ts.map +1 -1
  136. package/dist/error/ClientConfigurationError.mjs +140 -281
  137. package/dist/error/ClientConfigurationError.mjs.map +1 -1
  138. package/dist/error/ClientConfigurationErrorCodes.d.ts +23 -0
  139. package/dist/error/ClientConfigurationErrorCodes.d.ts.map +1 -0
  140. package/dist/error/ClientConfigurationErrorCodes.mjs +31 -0
  141. package/dist/error/ClientConfigurationErrorCodes.mjs.map +1 -0
  142. package/dist/error/InteractionRequiredAuthError.d.ts +57 -59
  143. package/dist/error/InteractionRequiredAuthError.d.ts.map +1 -1
  144. package/dist/error/InteractionRequiredAuthError.mjs +80 -79
  145. package/dist/error/InteractionRequiredAuthError.mjs.map +1 -1
  146. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +6 -0
  147. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts.map +1 -0
  148. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +16 -0
  149. package/dist/error/InteractionRequiredAuthErrorCodes.mjs.map +1 -0
  150. package/dist/error/JoseHeaderError.d.ts +15 -28
  151. package/dist/error/JoseHeaderError.d.ts.map +1 -1
  152. package/dist/error/JoseHeaderError.mjs +24 -40
  153. package/dist/error/JoseHeaderError.mjs.map +1 -1
  154. package/dist/error/JoseHeaderErrorCodes.d.ts +3 -0
  155. package/dist/error/JoseHeaderErrorCodes.d.ts.map +1 -0
  156. package/dist/error/JoseHeaderErrorCodes.mjs +11 -0
  157. package/dist/error/JoseHeaderErrorCodes.mjs.map +1 -0
  158. package/dist/error/ServerError.d.ts +7 -7
  159. package/dist/error/ServerError.mjs +14 -14
  160. package/dist/index.cjs +8715 -9047
  161. package/dist/index.cjs.map +1 -1
  162. package/dist/index.d.ts +96 -96
  163. package/dist/index.d.ts.map +1 -1
  164. package/dist/index.mjs +13 -5
  165. package/dist/index.mjs.map +1 -1
  166. package/dist/logger/Logger.d.ts +95 -95
  167. package/dist/logger/Logger.mjs +188 -188
  168. package/dist/network/INetworkModule.d.ts +29 -29
  169. package/dist/network/INetworkModule.d.ts.map +1 -1
  170. package/dist/network/INetworkModule.mjs +14 -15
  171. package/dist/network/INetworkModule.mjs.map +1 -1
  172. package/dist/network/NetworkManager.d.ts +33 -33
  173. package/dist/network/NetworkManager.d.ts.map +1 -1
  174. package/dist/network/NetworkManager.mjs +36 -35
  175. package/dist/network/NetworkManager.mjs.map +1 -1
  176. package/dist/network/RequestThumbprint.d.ts +16 -16
  177. package/dist/network/ThrottlingUtils.d.ts +42 -42
  178. package/dist/network/ThrottlingUtils.mjs +95 -95
  179. package/dist/packageMetadata.d.ts +2 -2
  180. package/dist/packageMetadata.mjs +3 -3
  181. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  182. package/dist/request/AuthenticationHeaderParser.d.ts.map +1 -1
  183. package/dist/request/AuthenticationHeaderParser.mjs +58 -57
  184. package/dist/request/AuthenticationHeaderParser.mjs.map +1 -1
  185. package/dist/request/BaseAuthRequest.d.ts +40 -40
  186. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  187. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  188. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  189. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  190. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  191. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  192. package/dist/request/CommonRefreshTokenRequest.d.ts +19 -19
  193. package/dist/request/CommonSilentFlowRequest.d.ts +18 -18
  194. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  195. package/dist/request/NativeRequest.d.ts +19 -19
  196. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  197. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  198. package/dist/request/RequestParameterBuilder.d.ts.map +1 -1
  199. package/dist/request/RequestParameterBuilder.mjs +383 -382
  200. package/dist/request/RequestParameterBuilder.mjs.map +1 -1
  201. package/dist/request/RequestValidator.d.ts +33 -33
  202. package/dist/request/RequestValidator.d.ts.map +1 -1
  203. package/dist/request/RequestValidator.mjs +83 -82
  204. package/dist/request/RequestValidator.mjs.map +1 -1
  205. package/dist/request/ScopeSet.d.ts +88 -88
  206. package/dist/request/ScopeSet.d.ts.map +1 -1
  207. package/dist/request/ScopeSet.mjs +201 -199
  208. package/dist/request/ScopeSet.mjs.map +1 -1
  209. package/dist/request/StoreInCache.d.ts +8 -8
  210. package/dist/response/AuthenticationResult.d.ts +41 -41
  211. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  212. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  213. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  214. package/dist/response/IMDSBadResponse.d.ts +4 -4
  215. package/dist/response/ResponseHandler.d.ts +67 -67
  216. package/dist/response/ResponseHandler.d.ts.map +1 -1
  217. package/dist/response/ResponseHandler.mjs +314 -313
  218. package/dist/response/ResponseHandler.mjs.map +1 -1
  219. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  220. package/dist/response/ServerAuthorizationTokenResponse.d.ts +46 -46
  221. package/dist/telemetry/performance/IPerformanceClient.d.ts +51 -51
  222. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  223. package/dist/telemetry/performance/PerformanceClient.d.ts +191 -191
  224. package/dist/telemetry/performance/PerformanceClient.d.ts.map +1 -1
  225. package/dist/telemetry/performance/PerformanceClient.mjs +409 -408
  226. package/dist/telemetry/performance/PerformanceClient.mjs.map +1 -1
  227. package/dist/telemetry/performance/PerformanceEvent.d.ts +433 -433
  228. package/dist/telemetry/performance/PerformanceEvent.mjs +234 -234
  229. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  230. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  231. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  232. package/dist/telemetry/server/ServerTelemetryManager.d.ts.map +1 -1
  233. package/dist/telemetry/server/ServerTelemetryManager.mjs +197 -197
  234. package/dist/telemetry/server/ServerTelemetryManager.mjs.map +1 -1
  235. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  236. package/dist/url/IUri.d.ts +12 -12
  237. package/dist/url/UrlString.d.ts +83 -83
  238. package/dist/url/UrlString.d.ts.map +1 -1
  239. package/dist/url/UrlString.mjs +283 -281
  240. package/dist/url/UrlString.mjs.map +1 -1
  241. package/dist/utils/Constants.d.ts +366 -363
  242. package/dist/utils/Constants.d.ts.map +1 -1
  243. package/dist/utils/Constants.mjs +376 -368
  244. package/dist/utils/Constants.mjs.map +1 -1
  245. package/dist/utils/FunctionWrappers.d.ts +27 -27
  246. package/dist/utils/FunctionWrappers.mjs +85 -85
  247. package/dist/utils/MsalTypes.d.ts +6 -6
  248. package/dist/utils/ProtocolUtils.d.ts +42 -42
  249. package/dist/utils/ProtocolUtils.d.ts.map +1 -1
  250. package/dist/utils/ProtocolUtils.mjs +71 -70
  251. package/dist/utils/ProtocolUtils.mjs.map +1 -1
  252. package/dist/utils/StringUtils.d.ts +40 -40
  253. package/dist/utils/StringUtils.mjs +95 -95
  254. package/dist/utils/TimeUtils.d.ts +27 -27
  255. package/dist/utils/TimeUtils.mjs +45 -45
  256. package/package.json +1 -1
  257. package/src/account/AuthToken.ts +8 -7
  258. package/src/account/ClientInfo.ts +9 -6
  259. package/src/authority/Authority.ts +76 -94
  260. package/src/authority/AuthorityFactory.ts +21 -9
  261. package/src/authority/RegionDiscovery.ts +21 -18
  262. package/src/cache/CacheManager.ts +37 -77
  263. package/src/cache/entities/AccessTokenEntity.ts +7 -2
  264. package/src/cache/entities/AccountEntity.ts +7 -2
  265. package/src/cache/entities/CredentialEntity.ts +7 -2
  266. package/src/client/AuthorizationCodeClient.ts +32 -10
  267. package/src/client/BaseClient.ts +7 -4
  268. package/src/client/RefreshTokenClient.ts +81 -124
  269. package/src/client/SilentFlowClient.ts +72 -19
  270. package/src/config/ClientConfiguration.ts +6 -7
  271. package/src/crypto/ICrypto.ts +13 -28
  272. package/src/crypto/JoseHeader.ts +6 -3
  273. package/src/crypto/PopTokenGenerator.ts +10 -5
  274. package/src/error/AuthError.ts +24 -26
  275. package/src/error/AuthErrorCodes.ts +10 -0
  276. package/src/error/ClientAuthError.ts +227 -632
  277. package/src/error/ClientAuthErrorCodes.ts +51 -0
  278. package/src/error/ClientConfigurationError.ts +146 -332
  279. package/src/error/ClientConfigurationErrorCodes.ts +28 -0
  280. package/src/error/InteractionRequiredAuthError.ts +60 -55
  281. package/src/error/InteractionRequiredAuthErrorCodes.ts +13 -0
  282. package/src/error/JoseHeaderError.ts +11 -31
  283. package/src/error/JoseHeaderErrorCodes.ts +7 -0
  284. package/src/index.ts +12 -1
  285. package/src/network/INetworkModule.ts +10 -7
  286. package/src/network/NetworkManager.ts +5 -5
  287. package/src/request/AuthenticationHeaderParser.ts +11 -8
  288. package/src/request/RequestParameterBuilder.ts +10 -3
  289. package/src/request/RequestValidator.ts +19 -6
  290. package/src/request/ScopeSet.ts +23 -7
  291. package/src/response/ResponseHandler.ts +37 -17
  292. package/src/telemetry/performance/PerformanceClient.ts +2 -1
  293. package/src/telemetry/server/ServerTelemetryManager.ts +1 -1
  294. package/src/url/UrlString.ts +26 -16
  295. package/src/utils/Constants.ts +11 -3
  296. package/src/utils/ProtocolUtils.ts +8 -12
@@ -1,4 +1,4 @@
1
- /*! @azure/msal-common v14.0.3 2023-09-05 */
1
+ /*! @azure/msal-common v14.1.0-alpha.0 2023-09-20 */
2
2
  'use strict';
3
3
  import { BaseClient } from './BaseClient.mjs';
4
4
  import { RequestParameterBuilder } from '../request/RequestParameterBuilder.mjs';
@@ -6,424 +6,425 @@ import { Separators, AADServerParamKeys, GrantType, AuthenticationScheme, Prompt
6
6
  import { isOidcProtocolMode } from '../config/ClientConfiguration.mjs';
7
7
  import { ResponseHandler } from '../response/ResponseHandler.mjs';
8
8
  import { StringUtils } from '../utils/StringUtils.mjs';
9
- import { ClientAuthError } from '../error/ClientAuthError.mjs';
9
+ import { createClientAuthError } from '../error/ClientAuthError.mjs';
10
10
  import { UrlString } from '../url/UrlString.mjs';
11
11
  import { PopTokenGenerator } from '../crypto/PopTokenGenerator.mjs';
12
12
  import { TimeUtils } from '../utils/TimeUtils.mjs';
13
13
  import { buildClientInfo, buildClientInfoFromHomeAccountId } from '../account/ClientInfo.mjs';
14
14
  import { CcsCredentialType } from '../account/CcsCredential.mjs';
15
- import { ClientConfigurationError } from '../error/ClientConfigurationError.mjs';
15
+ import { createClientConfigurationError } from '../error/ClientConfigurationError.mjs';
16
16
  import { RequestValidator } from '../request/RequestValidator.mjs';
17
17
  import { PerformanceEvents } from '../telemetry/performance/PerformanceEvent.mjs';
18
18
  import { invokeAsync } from '../utils/FunctionWrappers.mjs';
19
+ import { requestCannotBeMade, authorizationCodeMissingFromServerResponse } from '../error/ClientAuthErrorCodes.mjs';
20
+ import { logoutRequestEmpty, missingSshJwk } from '../error/ClientConfigurationErrorCodes.mjs';
19
21
 
20
- /*
21
- * Copyright (c) Microsoft Corporation. All rights reserved.
22
- * Licensed under the MIT License.
23
- */
24
- /**
25
- * Oauth2.0 Authorization Code client
26
- * @internal
27
- */
28
- class AuthorizationCodeClient extends BaseClient {
29
- constructor(configuration, performanceClient) {
30
- super(configuration, performanceClient);
31
- // Flag to indicate if client is for hybrid spa auth code redemption
32
- this.includeRedirectUri = true;
33
- this.oidcDefaultScopes =
34
- this.config.authOptions.authority.options.OIDCOptions?.defaultScopes;
35
- }
36
- /**
37
- * Creates the URL of the authorization request letting the user input credentials and consent to the
38
- * application. The URL target the /authorize endpoint of the authority configured in the
39
- * application object.
40
- *
41
- * Once the user inputs their credentials and consents, the authority will send a response to the redirect URI
42
- * sent in the request and should contain an authorization code, which can then be used to acquire tokens via
43
- * acquireToken(AuthorizationCodeRequest)
44
- * @param request
45
- */
46
- async getAuthCodeUrl(request) {
47
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.GetAuthCodeUrl, request.correlationId);
48
- const queryString = await invokeAsync(this.createAuthCodeUrlQueryString.bind(this), PerformanceEvents.AuthClientCreateQueryString, this.logger, this.performanceClient, request.correlationId)(request);
49
- return UrlString.appendQueryString(this.authority.authorizationEndpoint, queryString);
50
- }
51
- /**
52
- * API to acquire a token in exchange of 'authorization_code` acquired by the user in the first leg of the
53
- * authorization_code_grant
54
- * @param request
55
- */
56
- async acquireToken(request, authCodePayload) {
57
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientAcquireToken, request.correlationId);
58
- if (!request.code) {
59
- throw ClientAuthError.createTokenRequestCannotBeMadeError();
60
- }
61
- const reqTimestamp = TimeUtils.nowSeconds();
62
- const response = await invokeAsync(this.executeTokenRequest.bind(this), PerformanceEvents.AuthClientExecuteTokenRequest, this.logger, this.performanceClient, request.correlationId)(this.authority, request);
63
- // Retrieve requestId from response headers
64
- const requestId = response.headers?.[HeaderNames.X_MS_REQUEST_ID];
65
- const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin, this.performanceClient);
66
- // Validate response. This function throws a server error if an error is returned by the server.
67
- responseHandler.validateTokenResponse(response.body);
68
- return invokeAsync(responseHandler.handleServerTokenResponse.bind(responseHandler), PerformanceEvents.HandleServerTokenResponse, this.logger, this.performanceClient, request.correlationId)(response.body, this.authority, reqTimestamp, request, authCodePayload, undefined, undefined, undefined, requestId);
69
- }
70
- /**
71
- * Handles the hash fragment response from public client code request. Returns a code response used by
72
- * the client to exchange for a token in acquireToken.
73
- * @param hashFragment
74
- */
75
- handleFragmentResponse(hashFragment, cachedState) {
76
- // Handle responses.
77
- const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, null, null);
78
- const serverParams = UrlString.getDeserializedCodeResponse(this.config.authOptions.authority.options.OIDCOptions
79
- ?.serverResponseType, hashFragment);
80
- // Get code response
81
- responseHandler.validateServerAuthorizationCodeResponse(serverParams, cachedState, this.cryptoUtils);
82
- // throw when there is no auth code in the response
83
- if (!serverParams.code) {
84
- throw ClientAuthError.createNoAuthCodeInServerResponseError();
85
- }
86
- return {
87
- ...serverParams,
88
- // Code param is optional in ServerAuthorizationCodeResponse but required in AuthorizationCodePaylod
89
- code: serverParams.code,
90
- };
91
- }
92
- /**
93
- * Used to log out the current user, and redirect the user to the postLogoutRedirectUri.
94
- * Default behaviour is to redirect the user to `window.location.href`.
95
- * @param authorityUri
96
- */
97
- getLogoutUri(logoutRequest) {
98
- // Throw error if logoutRequest is null/undefined
99
- if (!logoutRequest) {
100
- throw ClientConfigurationError.createEmptyLogoutRequestError();
101
- }
102
- const queryString = this.createLogoutUrlQueryString(logoutRequest);
103
- // Construct logout URI
104
- return UrlString.appendQueryString(this.authority.endSessionEndpoint, queryString);
105
- }
106
- /**
107
- * Executes POST request to token endpoint
108
- * @param authority
109
- * @param request
110
- */
111
- async executeTokenRequest(authority, request) {
112
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientExecuteTokenRequest, request.correlationId);
113
- const queryParametersString = this.createTokenQueryParameters(request);
114
- const endpoint = UrlString.appendQueryString(authority.tokenEndpoint, queryParametersString);
115
- const requestBody = await invokeAsync(this.createTokenRequestBody.bind(this), PerformanceEvents.AuthClientCreateTokenRequestBody, this.logger, this.performanceClient, request.correlationId)(request);
116
- let ccsCredential = undefined;
117
- if (request.clientInfo) {
118
- try {
119
- const clientInfo = buildClientInfo(request.clientInfo, this.cryptoUtils);
120
- ccsCredential = {
121
- credential: `${clientInfo.uid}${Separators.CLIENT_INFO_SEPARATOR}${clientInfo.utid}`,
122
- type: CcsCredentialType.HOME_ACCOUNT_ID,
123
- };
124
- }
125
- catch (e) {
126
- this.logger.verbose("Could not parse client info for CCS Header: " + e);
127
- }
128
- }
129
- const headers = this.createTokenRequestHeaders(ccsCredential || request.ccsCredential);
130
- const thumbprint = {
131
- clientId: this.config.authOptions.clientId,
132
- authority: authority.canonicalAuthority,
133
- scopes: request.scopes,
134
- claims: request.claims,
135
- authenticationScheme: request.authenticationScheme,
136
- resourceRequestMethod: request.resourceRequestMethod,
137
- resourceRequestUri: request.resourceRequestUri,
138
- shrClaims: request.shrClaims,
139
- sshKid: request.sshKid,
140
- };
141
- return invokeAsync(this.executePostToTokenEndpoint.bind(this), PerformanceEvents.BaseClientExecutePostToTokenEndpoint, this.logger, this.performanceClient, request.correlationId)(endpoint, requestBody, headers, thumbprint, request.correlationId);
142
- }
143
- /**
144
- * Generates a map for all the params to be sent to the service
145
- * @param request
146
- */
147
- async createTokenRequestBody(request) {
148
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientCreateTokenRequestBody, request.correlationId);
149
- const parameterBuilder = new RequestParameterBuilder();
150
- parameterBuilder.addClientId(request.tokenBodyParameters?.[AADServerParamKeys.CLIENT_ID] ||
151
- this.config.authOptions.clientId);
152
- /*
153
- * For hybrid spa flow, there will be a code but no verifier
154
- * In this scenario, don't include redirect uri as auth code will not be bound to redirect URI
155
- */
156
- if (!this.includeRedirectUri) {
157
- // Just validate
158
- RequestValidator.validateRedirectUri(request.redirectUri);
159
- }
160
- else {
161
- // Validate and include redirect uri
162
- parameterBuilder.addRedirectUri(request.redirectUri);
163
- }
164
- // Add scope array, parameter builder will add default scopes and dedupe
165
- parameterBuilder.addScopes(request.scopes, true, this.oidcDefaultScopes);
166
- // add code: user set, not validated
167
- parameterBuilder.addAuthorizationCode(request.code);
168
- // Add library metadata
169
- parameterBuilder.addLibraryInfo(this.config.libraryInfo);
170
- parameterBuilder.addApplicationTelemetry(this.config.telemetry.application);
171
- parameterBuilder.addThrottling();
172
- if (this.serverTelemetryManager && !isOidcProtocolMode(this.config)) {
173
- parameterBuilder.addServerTelemetry(this.serverTelemetryManager);
174
- }
175
- // add code_verifier if passed
176
- if (request.codeVerifier) {
177
- parameterBuilder.addCodeVerifier(request.codeVerifier);
178
- }
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
- parameterBuilder.addGrantType(GrantType.AUTHORIZATION_CODE_GRANT);
188
- parameterBuilder.addClientInfo();
189
- if (request.authenticationScheme === AuthenticationScheme.POP) {
190
- const popTokenGenerator = new PopTokenGenerator(this.cryptoUtils, this.performanceClient);
191
- this.performanceClient?.setPreQueueTime(PerformanceEvents.PopTokenGenerateCnf, request.correlationId);
192
- const reqCnfData = await popTokenGenerator.generateCnf(request);
193
- // SPA PoP requires full Base64Url encoded req_cnf string (unhashed)
194
- parameterBuilder.addPopToken(reqCnfData.reqCnfString);
195
- }
196
- else if (request.authenticationScheme === AuthenticationScheme.SSH) {
197
- if (request.sshJwk) {
198
- parameterBuilder.addSshJwk(request.sshJwk);
199
- }
200
- else {
201
- throw ClientConfigurationError.createMissingSshJwkError();
202
- }
203
- }
204
- const correlationId = request.correlationId ||
205
- this.config.cryptoInterface.createNewGuid();
206
- parameterBuilder.addCorrelationId(correlationId);
207
- if (!StringUtils.isEmptyObj(request.claims) ||
208
- (this.config.authOptions.clientCapabilities &&
209
- this.config.authOptions.clientCapabilities.length > 0)) {
210
- parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities);
211
- }
212
- let ccsCred = undefined;
213
- if (request.clientInfo) {
214
- try {
215
- const clientInfo = buildClientInfo(request.clientInfo, this.cryptoUtils);
216
- ccsCred = {
217
- credential: `${clientInfo.uid}${Separators.CLIENT_INFO_SEPARATOR}${clientInfo.utid}`,
218
- type: CcsCredentialType.HOME_ACCOUNT_ID,
219
- };
220
- }
221
- catch (e) {
222
- this.logger.verbose("Could not parse client info for CCS Header: " + e);
223
- }
224
- }
225
- else {
226
- ccsCred = request.ccsCredential;
227
- }
228
- // Adds these as parameters in the request instead of headers to prevent CORS preflight request
229
- if (this.config.systemOptions.preventCorsPreflight && ccsCred) {
230
- switch (ccsCred.type) {
231
- case CcsCredentialType.HOME_ACCOUNT_ID:
232
- try {
233
- const clientInfo = buildClientInfoFromHomeAccountId(ccsCred.credential);
234
- parameterBuilder.addCcsOid(clientInfo);
235
- }
236
- catch (e) {
237
- this.logger.verbose("Could not parse home account ID for CCS Header: " +
238
- e);
239
- }
240
- break;
241
- case CcsCredentialType.UPN:
242
- parameterBuilder.addCcsUpn(ccsCred.credential);
243
- break;
244
- }
245
- }
246
- if (request.tokenBodyParameters) {
247
- parameterBuilder.addExtraQueryParameters(request.tokenBodyParameters);
248
- }
249
- // Add hybrid spa parameters if not already provided
250
- if (request.enableSpaAuthorizationCode &&
251
- (!request.tokenBodyParameters ||
252
- !request.tokenBodyParameters[AADServerParamKeys.RETURN_SPA_CODE])) {
253
- parameterBuilder.addExtraQueryParameters({
254
- [AADServerParamKeys.RETURN_SPA_CODE]: "1",
255
- });
256
- }
257
- return parameterBuilder.createQueryString();
258
- }
259
- /**
260
- * This API validates the `AuthorizationCodeUrlRequest` and creates a URL
261
- * @param request
262
- */
263
- async createAuthCodeUrlQueryString(request) {
264
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientCreateQueryString, request.correlationId);
265
- const parameterBuilder = new RequestParameterBuilder();
266
- parameterBuilder.addClientId(request.extraQueryParameters?.[AADServerParamKeys.CLIENT_ID] ||
267
- this.config.authOptions.clientId);
268
- const requestScopes = [
269
- ...(request.scopes || []),
270
- ...(request.extraScopesToConsent || []),
271
- ];
272
- parameterBuilder.addScopes(requestScopes, true, this.oidcDefaultScopes);
273
- // validate the redirectUri (to be a non null value)
274
- parameterBuilder.addRedirectUri(request.redirectUri);
275
- // generate the correlationId if not set by the user and add
276
- const correlationId = request.correlationId ||
277
- this.config.cryptoInterface.createNewGuid();
278
- parameterBuilder.addCorrelationId(correlationId);
279
- // add response_mode. If not passed in it defaults to query.
280
- parameterBuilder.addResponseMode(request.responseMode);
281
- // add response_type = code
282
- parameterBuilder.addResponseTypeCode();
283
- // add library info parameters
284
- parameterBuilder.addLibraryInfo(this.config.libraryInfo);
285
- if (!isOidcProtocolMode(this.config)) {
286
- parameterBuilder.addApplicationTelemetry(this.config.telemetry.application);
287
- }
288
- // add client_info=1
289
- parameterBuilder.addClientInfo();
290
- if (request.codeChallenge && request.codeChallengeMethod) {
291
- parameterBuilder.addCodeChallengeParams(request.codeChallenge, request.codeChallengeMethod);
292
- }
293
- if (request.prompt) {
294
- parameterBuilder.addPrompt(request.prompt);
295
- }
296
- if (request.domainHint) {
297
- parameterBuilder.addDomainHint(request.domainHint);
298
- }
299
- // Add sid or loginHint with preference for login_hint claim (in request) -> sid -> loginHint (upn/email) -> username of AccountInfo object
300
- if (request.prompt !== PromptValue.SELECT_ACCOUNT) {
301
- // AAD will throw if prompt=select_account is passed with an account hint
302
- if (request.sid && request.prompt === PromptValue.NONE) {
303
- // SessionID is only used in silent calls
304
- this.logger.verbose("createAuthCodeUrlQueryString: Prompt is none, adding sid from request");
305
- parameterBuilder.addSid(request.sid);
306
- }
307
- else if (request.account) {
308
- const accountSid = this.extractAccountSid(request.account);
309
- const accountLoginHintClaim = this.extractLoginHint(request.account);
310
- // If login_hint claim is present, use it over sid/username
311
- if (accountLoginHintClaim) {
312
- this.logger.verbose("createAuthCodeUrlQueryString: login_hint claim present on account");
313
- parameterBuilder.addLoginHint(accountLoginHintClaim);
314
- try {
315
- const clientInfo = buildClientInfoFromHomeAccountId(request.account.homeAccountId);
316
- parameterBuilder.addCcsOid(clientInfo);
317
- }
318
- catch (e) {
319
- this.logger.verbose("createAuthCodeUrlQueryString: Could not parse home account ID for CCS Header");
320
- }
321
- }
322
- else if (accountSid && request.prompt === PromptValue.NONE) {
323
- /*
324
- * If account and loginHint are provided, we will check account first for sid before adding loginHint
325
- * SessionId is only used in silent calls
326
- */
327
- this.logger.verbose("createAuthCodeUrlQueryString: Prompt is none, adding sid from account");
328
- parameterBuilder.addSid(accountSid);
329
- try {
330
- const clientInfo = buildClientInfoFromHomeAccountId(request.account.homeAccountId);
331
- parameterBuilder.addCcsOid(clientInfo);
332
- }
333
- catch (e) {
334
- this.logger.verbose("createAuthCodeUrlQueryString: Could not parse home account ID for CCS Header");
335
- }
336
- }
337
- else if (request.loginHint) {
338
- this.logger.verbose("createAuthCodeUrlQueryString: Adding login_hint from request");
339
- parameterBuilder.addLoginHint(request.loginHint);
340
- parameterBuilder.addCcsUpn(request.loginHint);
341
- }
342
- else if (request.account.username) {
343
- // Fallback to account username if provided
344
- this.logger.verbose("createAuthCodeUrlQueryString: Adding login_hint from account");
345
- parameterBuilder.addLoginHint(request.account.username);
346
- try {
347
- const clientInfo = buildClientInfoFromHomeAccountId(request.account.homeAccountId);
348
- parameterBuilder.addCcsOid(clientInfo);
349
- }
350
- catch (e) {
351
- this.logger.verbose("createAuthCodeUrlQueryString: Could not parse home account ID for CCS Header");
352
- }
353
- }
354
- }
355
- else if (request.loginHint) {
356
- this.logger.verbose("createAuthCodeUrlQueryString: No account, adding login_hint from request");
357
- parameterBuilder.addLoginHint(request.loginHint);
358
- parameterBuilder.addCcsUpn(request.loginHint);
359
- }
360
- }
361
- else {
362
- this.logger.verbose("createAuthCodeUrlQueryString: Prompt is select_account, ignoring account hints");
363
- }
364
- if (request.nonce) {
365
- parameterBuilder.addNonce(request.nonce);
366
- }
367
- if (request.state) {
368
- parameterBuilder.addState(request.state);
369
- }
370
- if (request.claims ||
371
- (this.config.authOptions.clientCapabilities &&
372
- this.config.authOptions.clientCapabilities.length > 0)) {
373
- parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities);
374
- }
375
- if (request.extraQueryParameters) {
376
- parameterBuilder.addExtraQueryParameters(request.extraQueryParameters);
377
- }
378
- if (request.nativeBroker) {
379
- // signal ests that this is a WAM call
380
- parameterBuilder.addNativeBroker();
381
- // pass the req_cnf for POP
382
- if (request.authenticationScheme === AuthenticationScheme.POP) {
383
- const popTokenGenerator = new PopTokenGenerator(this.cryptoUtils);
384
- // to reduce the URL length, it is recommended to send the hash of the req_cnf instead of the whole string
385
- const reqCnfData = await popTokenGenerator.generateCnf(request);
386
- parameterBuilder.addPopToken(reqCnfData.reqCnfHash);
387
- }
388
- }
389
- return parameterBuilder.createQueryString();
390
- }
391
- /**
392
- * This API validates the `EndSessionRequest` and creates a URL
393
- * @param request
394
- */
395
- createLogoutUrlQueryString(request) {
396
- const parameterBuilder = new RequestParameterBuilder();
397
- if (request.postLogoutRedirectUri) {
398
- parameterBuilder.addPostLogoutRedirectUri(request.postLogoutRedirectUri);
399
- }
400
- if (request.correlationId) {
401
- parameterBuilder.addCorrelationId(request.correlationId);
402
- }
403
- if (request.idTokenHint) {
404
- parameterBuilder.addIdTokenHint(request.idTokenHint);
405
- }
406
- if (request.state) {
407
- parameterBuilder.addState(request.state);
408
- }
409
- if (request.logoutHint) {
410
- parameterBuilder.addLogoutHint(request.logoutHint);
411
- }
412
- if (request.extraQueryParameters) {
413
- parameterBuilder.addExtraQueryParameters(request.extraQueryParameters);
414
- }
415
- return parameterBuilder.createQueryString();
416
- }
417
- /**
418
- * Helper to get sid from account. Returns null if idTokenClaims are not present or sid is not present.
419
- * @param account
420
- */
421
- extractAccountSid(account) {
422
- return account.idTokenClaims?.sid || null;
423
- }
424
- extractLoginHint(account) {
425
- return account.idTokenClaims?.login_hint || null;
426
- }
22
+ /*
23
+ * Copyright (c) Microsoft Corporation. All rights reserved.
24
+ * Licensed under the MIT License.
25
+ */
26
+ /**
27
+ * Oauth2.0 Authorization Code client
28
+ * @internal
29
+ */
30
+ class AuthorizationCodeClient extends BaseClient {
31
+ constructor(configuration, performanceClient) {
32
+ super(configuration, performanceClient);
33
+ // Flag to indicate if client is for hybrid spa auth code redemption
34
+ this.includeRedirectUri = true;
35
+ this.oidcDefaultScopes =
36
+ this.config.authOptions.authority.options.OIDCOptions?.defaultScopes;
37
+ }
38
+ /**
39
+ * Creates the URL of the authorization request letting the user input credentials and consent to the
40
+ * application. The URL target the /authorize endpoint of the authority configured in the
41
+ * application object.
42
+ *
43
+ * Once the user inputs their credentials and consents, the authority will send a response to the redirect URI
44
+ * sent in the request and should contain an authorization code, which can then be used to acquire tokens via
45
+ * acquireToken(AuthorizationCodeRequest)
46
+ * @param request
47
+ */
48
+ async getAuthCodeUrl(request) {
49
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.GetAuthCodeUrl, request.correlationId);
50
+ const queryString = await invokeAsync(this.createAuthCodeUrlQueryString.bind(this), PerformanceEvents.AuthClientCreateQueryString, this.logger, this.performanceClient, request.correlationId)(request);
51
+ return UrlString.appendQueryString(this.authority.authorizationEndpoint, queryString);
52
+ }
53
+ /**
54
+ * API to acquire a token in exchange of 'authorization_code` acquired by the user in the first leg of the
55
+ * authorization_code_grant
56
+ * @param request
57
+ */
58
+ async acquireToken(request, authCodePayload) {
59
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientAcquireToken, request.correlationId);
60
+ if (!request.code) {
61
+ throw createClientAuthError(requestCannotBeMade);
62
+ }
63
+ const reqTimestamp = TimeUtils.nowSeconds();
64
+ const response = await invokeAsync(this.executeTokenRequest.bind(this), PerformanceEvents.AuthClientExecuteTokenRequest, this.logger, this.performanceClient, request.correlationId)(this.authority, request);
65
+ // Retrieve requestId from response headers
66
+ const requestId = response.headers?.[HeaderNames.X_MS_REQUEST_ID];
67
+ const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin, this.performanceClient);
68
+ // Validate response. This function throws a server error if an error is returned by the server.
69
+ responseHandler.validateTokenResponse(response.body);
70
+ return invokeAsync(responseHandler.handleServerTokenResponse.bind(responseHandler), PerformanceEvents.HandleServerTokenResponse, this.logger, this.performanceClient, request.correlationId)(response.body, this.authority, reqTimestamp, request, authCodePayload, undefined, undefined, undefined, requestId);
71
+ }
72
+ /**
73
+ * Handles the hash fragment response from public client code request. Returns a code response used by
74
+ * the client to exchange for a token in acquireToken.
75
+ * @param hashFragment
76
+ */
77
+ handleFragmentResponse(hashFragment, cachedState) {
78
+ // Handle responses.
79
+ const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, null, null);
80
+ const serverParams = UrlString.getDeserializedCodeResponse(this.config.authOptions.authority.options.OIDCOptions
81
+ ?.serverResponseType, hashFragment);
82
+ // Get code response
83
+ responseHandler.validateServerAuthorizationCodeResponse(serverParams, cachedState, this.cryptoUtils);
84
+ // throw when there is no auth code in the response
85
+ if (!serverParams.code) {
86
+ throw createClientAuthError(authorizationCodeMissingFromServerResponse);
87
+ }
88
+ return {
89
+ ...serverParams,
90
+ // Code param is optional in ServerAuthorizationCodeResponse but required in AuthorizationCodePaylod
91
+ code: serverParams.code,
92
+ };
93
+ }
94
+ /**
95
+ * Used to log out the current user, and redirect the user to the postLogoutRedirectUri.
96
+ * Default behaviour is to redirect the user to `window.location.href`.
97
+ * @param authorityUri
98
+ */
99
+ getLogoutUri(logoutRequest) {
100
+ // Throw error if logoutRequest is null/undefined
101
+ if (!logoutRequest) {
102
+ throw createClientConfigurationError(logoutRequestEmpty);
103
+ }
104
+ const queryString = this.createLogoutUrlQueryString(logoutRequest);
105
+ // Construct logout URI
106
+ return UrlString.appendQueryString(this.authority.endSessionEndpoint, queryString);
107
+ }
108
+ /**
109
+ * Executes POST request to token endpoint
110
+ * @param authority
111
+ * @param request
112
+ */
113
+ async executeTokenRequest(authority, request) {
114
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientExecuteTokenRequest, request.correlationId);
115
+ const queryParametersString = this.createTokenQueryParameters(request);
116
+ const endpoint = UrlString.appendQueryString(authority.tokenEndpoint, queryParametersString);
117
+ const requestBody = await invokeAsync(this.createTokenRequestBody.bind(this), PerformanceEvents.AuthClientCreateTokenRequestBody, this.logger, this.performanceClient, request.correlationId)(request);
118
+ let ccsCredential = undefined;
119
+ if (request.clientInfo) {
120
+ try {
121
+ const clientInfo = buildClientInfo(request.clientInfo, this.cryptoUtils);
122
+ ccsCredential = {
123
+ credential: `${clientInfo.uid}${Separators.CLIENT_INFO_SEPARATOR}${clientInfo.utid}`,
124
+ type: CcsCredentialType.HOME_ACCOUNT_ID,
125
+ };
126
+ }
127
+ catch (e) {
128
+ this.logger.verbose("Could not parse client info for CCS Header: " + e);
129
+ }
130
+ }
131
+ const headers = this.createTokenRequestHeaders(ccsCredential || request.ccsCredential);
132
+ const thumbprint = {
133
+ clientId: this.config.authOptions.clientId,
134
+ authority: authority.canonicalAuthority,
135
+ scopes: request.scopes,
136
+ claims: request.claims,
137
+ authenticationScheme: request.authenticationScheme,
138
+ resourceRequestMethod: request.resourceRequestMethod,
139
+ resourceRequestUri: request.resourceRequestUri,
140
+ shrClaims: request.shrClaims,
141
+ sshKid: request.sshKid,
142
+ };
143
+ return invokeAsync(this.executePostToTokenEndpoint.bind(this), PerformanceEvents.BaseClientExecutePostToTokenEndpoint, this.logger, this.performanceClient, request.correlationId)(endpoint, requestBody, headers, thumbprint, request.correlationId);
144
+ }
145
+ /**
146
+ * Generates a map for all the params to be sent to the service
147
+ * @param request
148
+ */
149
+ async createTokenRequestBody(request) {
150
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientCreateTokenRequestBody, request.correlationId);
151
+ const parameterBuilder = new RequestParameterBuilder();
152
+ parameterBuilder.addClientId(request.tokenBodyParameters?.[AADServerParamKeys.CLIENT_ID] ||
153
+ this.config.authOptions.clientId);
154
+ /*
155
+ * For hybrid spa flow, there will be a code but no verifier
156
+ * In this scenario, don't include redirect uri as auth code will not be bound to redirect URI
157
+ */
158
+ if (!this.includeRedirectUri) {
159
+ // Just validate
160
+ RequestValidator.validateRedirectUri(request.redirectUri);
161
+ }
162
+ else {
163
+ // Validate and include redirect uri
164
+ parameterBuilder.addRedirectUri(request.redirectUri);
165
+ }
166
+ // Add scope array, parameter builder will add default scopes and dedupe
167
+ parameterBuilder.addScopes(request.scopes, true, this.oidcDefaultScopes);
168
+ // add code: user set, not validated
169
+ parameterBuilder.addAuthorizationCode(request.code);
170
+ // Add library metadata
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
+ // add code_verifier if passed
178
+ if (request.codeVerifier) {
179
+ parameterBuilder.addCodeVerifier(request.codeVerifier);
180
+ }
181
+ if (this.config.clientCredentials.clientSecret) {
182
+ parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret);
183
+ }
184
+ if (this.config.clientCredentials.clientAssertion) {
185
+ const clientAssertion = this.config.clientCredentials.clientAssertion;
186
+ parameterBuilder.addClientAssertion(clientAssertion.assertion);
187
+ parameterBuilder.addClientAssertionType(clientAssertion.assertionType);
188
+ }
189
+ parameterBuilder.addGrantType(GrantType.AUTHORIZATION_CODE_GRANT);
190
+ parameterBuilder.addClientInfo();
191
+ if (request.authenticationScheme === AuthenticationScheme.POP) {
192
+ const popTokenGenerator = new PopTokenGenerator(this.cryptoUtils, this.performanceClient);
193
+ const reqCnfData = await invokeAsync(popTokenGenerator.generateCnf.bind(popTokenGenerator), PerformanceEvents.PopTokenGenerateCnf, this.logger, this.performanceClient, request.correlationId)(request, this.logger);
194
+ // SPA PoP requires full Base64Url encoded req_cnf string (unhashed)
195
+ parameterBuilder.addPopToken(reqCnfData.reqCnfString);
196
+ }
197
+ else if (request.authenticationScheme === AuthenticationScheme.SSH) {
198
+ if (request.sshJwk) {
199
+ parameterBuilder.addSshJwk(request.sshJwk);
200
+ }
201
+ else {
202
+ throw createClientConfigurationError(missingSshJwk);
203
+ }
204
+ }
205
+ const correlationId = request.correlationId ||
206
+ this.config.cryptoInterface.createNewGuid();
207
+ parameterBuilder.addCorrelationId(correlationId);
208
+ if (!StringUtils.isEmptyObj(request.claims) ||
209
+ (this.config.authOptions.clientCapabilities &&
210
+ this.config.authOptions.clientCapabilities.length > 0)) {
211
+ parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities);
212
+ }
213
+ let ccsCred = undefined;
214
+ if (request.clientInfo) {
215
+ try {
216
+ const clientInfo = buildClientInfo(request.clientInfo, this.cryptoUtils);
217
+ ccsCred = {
218
+ credential: `${clientInfo.uid}${Separators.CLIENT_INFO_SEPARATOR}${clientInfo.utid}`,
219
+ type: CcsCredentialType.HOME_ACCOUNT_ID,
220
+ };
221
+ }
222
+ catch (e) {
223
+ this.logger.verbose("Could not parse client info for CCS Header: " + e);
224
+ }
225
+ }
226
+ else {
227
+ ccsCred = request.ccsCredential;
228
+ }
229
+ // Adds these as parameters in the request instead of headers to prevent CORS preflight request
230
+ if (this.config.systemOptions.preventCorsPreflight && ccsCred) {
231
+ switch (ccsCred.type) {
232
+ case CcsCredentialType.HOME_ACCOUNT_ID:
233
+ try {
234
+ const clientInfo = buildClientInfoFromHomeAccountId(ccsCred.credential);
235
+ parameterBuilder.addCcsOid(clientInfo);
236
+ }
237
+ catch (e) {
238
+ this.logger.verbose("Could not parse home account ID for CCS Header: " +
239
+ e);
240
+ }
241
+ break;
242
+ case CcsCredentialType.UPN:
243
+ parameterBuilder.addCcsUpn(ccsCred.credential);
244
+ break;
245
+ }
246
+ }
247
+ if (request.tokenBodyParameters) {
248
+ parameterBuilder.addExtraQueryParameters(request.tokenBodyParameters);
249
+ }
250
+ // Add hybrid spa parameters if not already provided
251
+ if (request.enableSpaAuthorizationCode &&
252
+ (!request.tokenBodyParameters ||
253
+ !request.tokenBodyParameters[AADServerParamKeys.RETURN_SPA_CODE])) {
254
+ parameterBuilder.addExtraQueryParameters({
255
+ [AADServerParamKeys.RETURN_SPA_CODE]: "1",
256
+ });
257
+ }
258
+ return parameterBuilder.createQueryString();
259
+ }
260
+ /**
261
+ * This API validates the `AuthorizationCodeUrlRequest` and creates a URL
262
+ * @param request
263
+ */
264
+ async createAuthCodeUrlQueryString(request) {
265
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientCreateQueryString, request.correlationId);
266
+ const parameterBuilder = new RequestParameterBuilder();
267
+ parameterBuilder.addClientId(request.extraQueryParameters?.[AADServerParamKeys.CLIENT_ID] ||
268
+ this.config.authOptions.clientId);
269
+ const requestScopes = [
270
+ ...(request.scopes || []),
271
+ ...(request.extraScopesToConsent || []),
272
+ ];
273
+ parameterBuilder.addScopes(requestScopes, true, this.oidcDefaultScopes);
274
+ // validate the redirectUri (to be a non null value)
275
+ parameterBuilder.addRedirectUri(request.redirectUri);
276
+ // generate the correlationId if not set by the user and add
277
+ const correlationId = request.correlationId ||
278
+ this.config.cryptoInterface.createNewGuid();
279
+ parameterBuilder.addCorrelationId(correlationId);
280
+ // add response_mode. If not passed in it defaults to query.
281
+ parameterBuilder.addResponseMode(request.responseMode);
282
+ // add response_type = code
283
+ parameterBuilder.addResponseTypeCode();
284
+ // add library info parameters
285
+ parameterBuilder.addLibraryInfo(this.config.libraryInfo);
286
+ if (!isOidcProtocolMode(this.config)) {
287
+ parameterBuilder.addApplicationTelemetry(this.config.telemetry.application);
288
+ }
289
+ // add client_info=1
290
+ parameterBuilder.addClientInfo();
291
+ if (request.codeChallenge && request.codeChallengeMethod) {
292
+ parameterBuilder.addCodeChallengeParams(request.codeChallenge, request.codeChallengeMethod);
293
+ }
294
+ if (request.prompt) {
295
+ parameterBuilder.addPrompt(request.prompt);
296
+ }
297
+ if (request.domainHint) {
298
+ parameterBuilder.addDomainHint(request.domainHint);
299
+ }
300
+ // Add sid or loginHint with preference for login_hint claim (in request) -> sid -> loginHint (upn/email) -> username of AccountInfo object
301
+ if (request.prompt !== PromptValue.SELECT_ACCOUNT) {
302
+ // AAD will throw if prompt=select_account is passed with an account hint
303
+ if (request.sid && request.prompt === PromptValue.NONE) {
304
+ // SessionID is only used in silent calls
305
+ this.logger.verbose("createAuthCodeUrlQueryString: Prompt is none, adding sid from request");
306
+ parameterBuilder.addSid(request.sid);
307
+ }
308
+ else if (request.account) {
309
+ const accountSid = this.extractAccountSid(request.account);
310
+ const accountLoginHintClaim = this.extractLoginHint(request.account);
311
+ // If login_hint claim is present, use it over sid/username
312
+ if (accountLoginHintClaim) {
313
+ this.logger.verbose("createAuthCodeUrlQueryString: login_hint claim present on account");
314
+ parameterBuilder.addLoginHint(accountLoginHintClaim);
315
+ try {
316
+ const clientInfo = buildClientInfoFromHomeAccountId(request.account.homeAccountId);
317
+ parameterBuilder.addCcsOid(clientInfo);
318
+ }
319
+ catch (e) {
320
+ this.logger.verbose("createAuthCodeUrlQueryString: Could not parse home account ID for CCS Header");
321
+ }
322
+ }
323
+ else if (accountSid && request.prompt === PromptValue.NONE) {
324
+ /*
325
+ * If account and loginHint are provided, we will check account first for sid before adding loginHint
326
+ * SessionId is only used in silent calls
327
+ */
328
+ this.logger.verbose("createAuthCodeUrlQueryString: Prompt is none, adding sid from account");
329
+ parameterBuilder.addSid(accountSid);
330
+ try {
331
+ const clientInfo = buildClientInfoFromHomeAccountId(request.account.homeAccountId);
332
+ parameterBuilder.addCcsOid(clientInfo);
333
+ }
334
+ catch (e) {
335
+ this.logger.verbose("createAuthCodeUrlQueryString: Could not parse home account ID for CCS Header");
336
+ }
337
+ }
338
+ else if (request.loginHint) {
339
+ this.logger.verbose("createAuthCodeUrlQueryString: Adding login_hint from request");
340
+ parameterBuilder.addLoginHint(request.loginHint);
341
+ parameterBuilder.addCcsUpn(request.loginHint);
342
+ }
343
+ else if (request.account.username) {
344
+ // Fallback to account username if provided
345
+ this.logger.verbose("createAuthCodeUrlQueryString: Adding login_hint from account");
346
+ parameterBuilder.addLoginHint(request.account.username);
347
+ try {
348
+ const clientInfo = buildClientInfoFromHomeAccountId(request.account.homeAccountId);
349
+ parameterBuilder.addCcsOid(clientInfo);
350
+ }
351
+ catch (e) {
352
+ this.logger.verbose("createAuthCodeUrlQueryString: Could not parse home account ID for CCS Header");
353
+ }
354
+ }
355
+ }
356
+ else if (request.loginHint) {
357
+ this.logger.verbose("createAuthCodeUrlQueryString: No account, adding login_hint from request");
358
+ parameterBuilder.addLoginHint(request.loginHint);
359
+ parameterBuilder.addCcsUpn(request.loginHint);
360
+ }
361
+ }
362
+ else {
363
+ this.logger.verbose("createAuthCodeUrlQueryString: Prompt is select_account, ignoring account hints");
364
+ }
365
+ if (request.nonce) {
366
+ parameterBuilder.addNonce(request.nonce);
367
+ }
368
+ if (request.state) {
369
+ parameterBuilder.addState(request.state);
370
+ }
371
+ if (request.claims ||
372
+ (this.config.authOptions.clientCapabilities &&
373
+ this.config.authOptions.clientCapabilities.length > 0)) {
374
+ parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities);
375
+ }
376
+ if (request.extraQueryParameters) {
377
+ parameterBuilder.addExtraQueryParameters(request.extraQueryParameters);
378
+ }
379
+ if (request.nativeBroker) {
380
+ // signal ests that this is a WAM call
381
+ parameterBuilder.addNativeBroker();
382
+ // pass the req_cnf for POP
383
+ if (request.authenticationScheme === AuthenticationScheme.POP) {
384
+ const popTokenGenerator = new PopTokenGenerator(this.cryptoUtils);
385
+ // to reduce the URL length, it is recommended to send the hash of the req_cnf instead of the whole string
386
+ const reqCnfData = await invokeAsync(popTokenGenerator.generateCnf.bind(popTokenGenerator), PerformanceEvents.PopTokenGenerateCnf, this.logger, this.performanceClient, request.correlationId)(request, this.logger);
387
+ parameterBuilder.addPopToken(reqCnfData.reqCnfHash);
388
+ }
389
+ }
390
+ return parameterBuilder.createQueryString();
391
+ }
392
+ /**
393
+ * This API validates the `EndSessionRequest` and creates a URL
394
+ * @param request
395
+ */
396
+ createLogoutUrlQueryString(request) {
397
+ const parameterBuilder = new RequestParameterBuilder();
398
+ if (request.postLogoutRedirectUri) {
399
+ parameterBuilder.addPostLogoutRedirectUri(request.postLogoutRedirectUri);
400
+ }
401
+ if (request.correlationId) {
402
+ parameterBuilder.addCorrelationId(request.correlationId);
403
+ }
404
+ if (request.idTokenHint) {
405
+ parameterBuilder.addIdTokenHint(request.idTokenHint);
406
+ }
407
+ if (request.state) {
408
+ parameterBuilder.addState(request.state);
409
+ }
410
+ if (request.logoutHint) {
411
+ parameterBuilder.addLogoutHint(request.logoutHint);
412
+ }
413
+ if (request.extraQueryParameters) {
414
+ parameterBuilder.addExtraQueryParameters(request.extraQueryParameters);
415
+ }
416
+ return parameterBuilder.createQueryString();
417
+ }
418
+ /**
419
+ * Helper to get sid from account. Returns null if idTokenClaims are not present or sid is not present.
420
+ * @param account
421
+ */
422
+ extractAccountSid(account) {
423
+ return account.idTokenClaims?.sid || null;
424
+ }
425
+ extractLoginHint(account) {
426
+ return account.idTokenClaims?.login_hint || null;
427
+ }
427
428
  }
428
429
 
429
430
  export { AuthorizationCodeClient };