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