@azure/msal-common 14.6.0-alpha.0 → 14.6.0

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