@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 { AADServerParamKeys, Constants, ResponseMode, OIDC_DEFAULT_SCOPES, SSOTypes, HeaderNames, CLIENT_INFO, ClaimsRequestKeys, PasswordGrantConstants, AuthenticationScheme, ThrottlingConstants } from '../utils/Constants.mjs';
4
4
  import { ScopeSet } from './ScopeSet.mjs';
@@ -6,386 +6,386 @@ import { createClientConfigurationError } from '../error/ClientConfigurationErro
6
6
  import { RequestValidator } from './RequestValidator.mjs';
7
7
  import { pkceParamsMissing, invalidClaims } from '../error/ClientConfigurationErrorCodes.mjs';
8
8
 
9
- /*
10
- * Copyright (c) Microsoft Corporation. All rights reserved.
11
- * Licensed under the MIT License.
12
- */
13
- /** @internal */
14
- class RequestParameterBuilder {
15
- constructor() {
16
- this.parameters = new Map();
17
- }
18
- /**
19
- * add response_type = code
20
- */
21
- addResponseTypeCode() {
22
- this.parameters.set(AADServerParamKeys.RESPONSE_TYPE, encodeURIComponent(Constants.CODE_RESPONSE_TYPE));
23
- }
24
- /**
25
- * add response_type = token id_token
26
- */
27
- addResponseTypeForTokenAndIdToken() {
28
- this.parameters.set(AADServerParamKeys.RESPONSE_TYPE, encodeURIComponent(`${Constants.TOKEN_RESPONSE_TYPE} ${Constants.ID_TOKEN_RESPONSE_TYPE}`));
29
- }
30
- /**
31
- * add response_mode. defaults to query.
32
- * @param responseMode
33
- */
34
- addResponseMode(responseMode) {
35
- this.parameters.set(AADServerParamKeys.RESPONSE_MODE, encodeURIComponent(responseMode ? responseMode : ResponseMode.QUERY));
36
- }
37
- /**
38
- * Add flag to indicate STS should attempt to use WAM if available
39
- */
40
- addNativeBroker() {
41
- this.parameters.set(AADServerParamKeys.NATIVE_BROKER, encodeURIComponent("1"));
42
- }
43
- /**
44
- * add scopes. set addOidcScopes to false to prevent default scopes in non-user scenarios
45
- * @param scopeSet
46
- * @param addOidcScopes
47
- */
48
- addScopes(scopes, addOidcScopes = true, defaultScopes = OIDC_DEFAULT_SCOPES) {
49
- // Always add openid to the scopes when adding OIDC scopes
50
- if (addOidcScopes &&
51
- !defaultScopes.includes("openid") &&
52
- !scopes.includes("openid")) {
53
- defaultScopes.push("openid");
54
- }
55
- const requestScopes = addOidcScopes
56
- ? [...(scopes || []), ...defaultScopes]
57
- : scopes || [];
58
- const scopeSet = new ScopeSet(requestScopes);
59
- this.parameters.set(AADServerParamKeys.SCOPE, encodeURIComponent(scopeSet.printScopes()));
60
- }
61
- /**
62
- * add clientId
63
- * @param clientId
64
- */
65
- addClientId(clientId) {
66
- this.parameters.set(AADServerParamKeys.CLIENT_ID, encodeURIComponent(clientId));
67
- }
68
- /**
69
- * add redirect_uri
70
- * @param redirectUri
71
- */
72
- addRedirectUri(redirectUri) {
73
- RequestValidator.validateRedirectUri(redirectUri);
74
- this.parameters.set(AADServerParamKeys.REDIRECT_URI, encodeURIComponent(redirectUri));
75
- }
76
- /**
77
- * add post logout redirectUri
78
- * @param redirectUri
79
- */
80
- addPostLogoutRedirectUri(redirectUri) {
81
- RequestValidator.validateRedirectUri(redirectUri);
82
- this.parameters.set(AADServerParamKeys.POST_LOGOUT_URI, encodeURIComponent(redirectUri));
83
- }
84
- /**
85
- * add id_token_hint to logout request
86
- * @param idTokenHint
87
- */
88
- addIdTokenHint(idTokenHint) {
89
- this.parameters.set(AADServerParamKeys.ID_TOKEN_HINT, encodeURIComponent(idTokenHint));
90
- }
91
- /**
92
- * add domain_hint
93
- * @param domainHint
94
- */
95
- addDomainHint(domainHint) {
96
- this.parameters.set(SSOTypes.DOMAIN_HINT, encodeURIComponent(domainHint));
97
- }
98
- /**
99
- * add login_hint
100
- * @param loginHint
101
- */
102
- addLoginHint(loginHint) {
103
- this.parameters.set(SSOTypes.LOGIN_HINT, encodeURIComponent(loginHint));
104
- }
105
- /**
106
- * Adds the CCS (Cache Credential Service) query parameter for login_hint
107
- * @param loginHint
108
- */
109
- addCcsUpn(loginHint) {
110
- this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`UPN:${loginHint}`));
111
- }
112
- /**
113
- * Adds the CCS (Cache Credential Service) query parameter for account object
114
- * @param loginHint
115
- */
116
- addCcsOid(clientInfo) {
117
- this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`Oid:${clientInfo.uid}@${clientInfo.utid}`));
118
- }
119
- /**
120
- * add sid
121
- * @param sid
122
- */
123
- addSid(sid) {
124
- this.parameters.set(SSOTypes.SID, encodeURIComponent(sid));
125
- }
126
- /**
127
- * add claims
128
- * @param claims
129
- */
130
- addClaims(claims, clientCapabilities) {
131
- const mergedClaims = this.addClientCapabilitiesToClaims(claims, clientCapabilities);
132
- RequestValidator.validateClaims(mergedClaims);
133
- this.parameters.set(AADServerParamKeys.CLAIMS, encodeURIComponent(mergedClaims));
134
- }
135
- /**
136
- * add correlationId
137
- * @param correlationId
138
- */
139
- addCorrelationId(correlationId) {
140
- this.parameters.set(AADServerParamKeys.CLIENT_REQUEST_ID, encodeURIComponent(correlationId));
141
- }
142
- /**
143
- * add library info query params
144
- * @param libraryInfo
145
- */
146
- addLibraryInfo(libraryInfo) {
147
- // Telemetry Info
148
- this.parameters.set(AADServerParamKeys.X_CLIENT_SKU, libraryInfo.sku);
149
- this.parameters.set(AADServerParamKeys.X_CLIENT_VER, libraryInfo.version);
150
- if (libraryInfo.os) {
151
- this.parameters.set(AADServerParamKeys.X_CLIENT_OS, libraryInfo.os);
152
- }
153
- if (libraryInfo.cpu) {
154
- this.parameters.set(AADServerParamKeys.X_CLIENT_CPU, libraryInfo.cpu);
155
- }
156
- }
157
- /**
158
- * Add client telemetry parameters
159
- * @param appTelemetry
160
- */
161
- addApplicationTelemetry(appTelemetry) {
162
- if (appTelemetry?.appName) {
163
- this.parameters.set(AADServerParamKeys.X_APP_NAME, appTelemetry.appName);
164
- }
165
- if (appTelemetry?.appVersion) {
166
- this.parameters.set(AADServerParamKeys.X_APP_VER, appTelemetry.appVersion);
167
- }
168
- }
169
- /**
170
- * add prompt
171
- * @param prompt
172
- */
173
- addPrompt(prompt) {
174
- RequestValidator.validatePrompt(prompt);
175
- this.parameters.set(`${AADServerParamKeys.PROMPT}`, encodeURIComponent(prompt));
176
- }
177
- /**
178
- * add state
179
- * @param state
180
- */
181
- addState(state) {
182
- if (state) {
183
- this.parameters.set(AADServerParamKeys.STATE, encodeURIComponent(state));
184
- }
185
- }
186
- /**
187
- * add nonce
188
- * @param nonce
189
- */
190
- addNonce(nonce) {
191
- this.parameters.set(AADServerParamKeys.NONCE, encodeURIComponent(nonce));
192
- }
193
- /**
194
- * add code_challenge and code_challenge_method
195
- * - throw if either of them are not passed
196
- * @param codeChallenge
197
- * @param codeChallengeMethod
198
- */
199
- addCodeChallengeParams(codeChallenge, codeChallengeMethod) {
200
- RequestValidator.validateCodeChallengeParams(codeChallenge, codeChallengeMethod);
201
- if (codeChallenge && codeChallengeMethod) {
202
- this.parameters.set(AADServerParamKeys.CODE_CHALLENGE, encodeURIComponent(codeChallenge));
203
- this.parameters.set(AADServerParamKeys.CODE_CHALLENGE_METHOD, encodeURIComponent(codeChallengeMethod));
204
- }
205
- else {
206
- throw createClientConfigurationError(pkceParamsMissing);
207
- }
208
- }
209
- /**
210
- * add the `authorization_code` passed by the user to exchange for a token
211
- * @param code
212
- */
213
- addAuthorizationCode(code) {
214
- this.parameters.set(AADServerParamKeys.CODE, encodeURIComponent(code));
215
- }
216
- /**
217
- * add the `authorization_code` passed by the user to exchange for a token
218
- * @param code
219
- */
220
- addDeviceCode(code) {
221
- this.parameters.set(AADServerParamKeys.DEVICE_CODE, encodeURIComponent(code));
222
- }
223
- /**
224
- * add the `refreshToken` passed by the user
225
- * @param refreshToken
226
- */
227
- addRefreshToken(refreshToken) {
228
- this.parameters.set(AADServerParamKeys.REFRESH_TOKEN, encodeURIComponent(refreshToken));
229
- }
230
- /**
231
- * add the `code_verifier` passed by the user to exchange for a token
232
- * @param codeVerifier
233
- */
234
- addCodeVerifier(codeVerifier) {
235
- this.parameters.set(AADServerParamKeys.CODE_VERIFIER, encodeURIComponent(codeVerifier));
236
- }
237
- /**
238
- * add client_secret
239
- * @param clientSecret
240
- */
241
- addClientSecret(clientSecret) {
242
- this.parameters.set(AADServerParamKeys.CLIENT_SECRET, encodeURIComponent(clientSecret));
243
- }
244
- /**
245
- * add clientAssertion for confidential client flows
246
- * @param clientAssertion
247
- */
248
- addClientAssertion(clientAssertion) {
249
- if (clientAssertion) {
250
- this.parameters.set(AADServerParamKeys.CLIENT_ASSERTION, encodeURIComponent(clientAssertion));
251
- }
252
- }
253
- /**
254
- * add clientAssertionType for confidential client flows
255
- * @param clientAssertionType
256
- */
257
- addClientAssertionType(clientAssertionType) {
258
- if (clientAssertionType) {
259
- this.parameters.set(AADServerParamKeys.CLIENT_ASSERTION_TYPE, encodeURIComponent(clientAssertionType));
260
- }
261
- }
262
- /**
263
- * add OBO assertion for confidential client flows
264
- * @param clientAssertion
265
- */
266
- addOboAssertion(oboAssertion) {
267
- this.parameters.set(AADServerParamKeys.OBO_ASSERTION, encodeURIComponent(oboAssertion));
268
- }
269
- /**
270
- * add grant type
271
- * @param grantType
272
- */
273
- addRequestTokenUse(tokenUse) {
274
- this.parameters.set(AADServerParamKeys.REQUESTED_TOKEN_USE, encodeURIComponent(tokenUse));
275
- }
276
- /**
277
- * add grant type
278
- * @param grantType
279
- */
280
- addGrantType(grantType) {
281
- this.parameters.set(AADServerParamKeys.GRANT_TYPE, encodeURIComponent(grantType));
282
- }
283
- /**
284
- * add client info
285
- *
286
- */
287
- addClientInfo() {
288
- this.parameters.set(CLIENT_INFO, "1");
289
- }
290
- /**
291
- * add extraQueryParams
292
- * @param eQParams
293
- */
294
- addExtraQueryParameters(eQParams) {
295
- const sanitizedEQParams = RequestValidator.sanitizeEQParams(eQParams, this.parameters);
296
- Object.keys(sanitizedEQParams).forEach((key) => {
297
- this.parameters.set(key, eQParams[key]);
298
- });
299
- }
300
- addClientCapabilitiesToClaims(claims, clientCapabilities) {
301
- let mergedClaims;
302
- // Parse provided claims into JSON object or initialize empty object
303
- if (!claims) {
304
- mergedClaims = {};
305
- }
306
- else {
307
- try {
308
- mergedClaims = JSON.parse(claims);
309
- }
310
- catch (e) {
311
- throw createClientConfigurationError(invalidClaims);
312
- }
313
- }
314
- if (clientCapabilities && clientCapabilities.length > 0) {
315
- if (!mergedClaims.hasOwnProperty(ClaimsRequestKeys.ACCESS_TOKEN)) {
316
- // Add access_token key to claims object
317
- mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN] = {};
318
- }
319
- // Add xms_cc claim with provided clientCapabilities to access_token key
320
- mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN][ClaimsRequestKeys.XMS_CC] = {
321
- values: clientCapabilities,
322
- };
323
- }
324
- return JSON.stringify(mergedClaims);
325
- }
326
- /**
327
- * adds `username` for Password Grant flow
328
- * @param username
329
- */
330
- addUsername(username) {
331
- this.parameters.set(PasswordGrantConstants.username, encodeURIComponent(username));
332
- }
333
- /**
334
- * adds `password` for Password Grant flow
335
- * @param password
336
- */
337
- addPassword(password) {
338
- this.parameters.set(PasswordGrantConstants.password, encodeURIComponent(password));
339
- }
340
- /**
341
- * add pop_jwk to query params
342
- * @param cnfString
343
- */
344
- addPopToken(cnfString) {
345
- if (cnfString) {
346
- this.parameters.set(AADServerParamKeys.TOKEN_TYPE, AuthenticationScheme.POP);
347
- this.parameters.set(AADServerParamKeys.REQ_CNF, encodeURIComponent(cnfString));
348
- }
349
- }
350
- /**
351
- * add SSH JWK and key ID to query params
352
- */
353
- addSshJwk(sshJwkString) {
354
- if (sshJwkString) {
355
- this.parameters.set(AADServerParamKeys.TOKEN_TYPE, AuthenticationScheme.SSH);
356
- this.parameters.set(AADServerParamKeys.REQ_CNF, encodeURIComponent(sshJwkString));
357
- }
358
- }
359
- /**
360
- * add server telemetry fields
361
- * @param serverTelemetryManager
362
- */
363
- addServerTelemetry(serverTelemetryManager) {
364
- this.parameters.set(AADServerParamKeys.X_CLIENT_CURR_TELEM, serverTelemetryManager.generateCurrentRequestHeaderValue());
365
- this.parameters.set(AADServerParamKeys.X_CLIENT_LAST_TELEM, serverTelemetryManager.generateLastRequestHeaderValue());
366
- }
367
- /**
368
- * Adds parameter that indicates to the server that throttling is supported
369
- */
370
- addThrottling() {
371
- this.parameters.set(AADServerParamKeys.X_MS_LIB_CAPABILITY, ThrottlingConstants.X_MS_LIB_CAPABILITY_VALUE);
372
- }
373
- /**
374
- * Adds logout_hint parameter for "silent" logout which prevent server account picker
375
- */
376
- addLogoutHint(logoutHint) {
377
- this.parameters.set(AADServerParamKeys.LOGOUT_HINT, encodeURIComponent(logoutHint));
378
- }
379
- /**
380
- * Utility to create a URL from the params map
381
- */
382
- createQueryString() {
383
- const queryParameterArray = new Array();
384
- this.parameters.forEach((value, key) => {
385
- queryParameterArray.push(`${key}=${value}`);
386
- });
387
- return queryParameterArray.join("&");
388
- }
9
+ /*
10
+ * Copyright (c) Microsoft Corporation. All rights reserved.
11
+ * Licensed under the MIT License.
12
+ */
13
+ /** @internal */
14
+ class RequestParameterBuilder {
15
+ constructor() {
16
+ this.parameters = new Map();
17
+ }
18
+ /**
19
+ * add response_type = code
20
+ */
21
+ addResponseTypeCode() {
22
+ this.parameters.set(AADServerParamKeys.RESPONSE_TYPE, encodeURIComponent(Constants.CODE_RESPONSE_TYPE));
23
+ }
24
+ /**
25
+ * add response_type = token id_token
26
+ */
27
+ addResponseTypeForTokenAndIdToken() {
28
+ this.parameters.set(AADServerParamKeys.RESPONSE_TYPE, encodeURIComponent(`${Constants.TOKEN_RESPONSE_TYPE} ${Constants.ID_TOKEN_RESPONSE_TYPE}`));
29
+ }
30
+ /**
31
+ * add response_mode. defaults to query.
32
+ * @param responseMode
33
+ */
34
+ addResponseMode(responseMode) {
35
+ this.parameters.set(AADServerParamKeys.RESPONSE_MODE, encodeURIComponent(responseMode ? responseMode : ResponseMode.QUERY));
36
+ }
37
+ /**
38
+ * Add flag to indicate STS should attempt to use WAM if available
39
+ */
40
+ addNativeBroker() {
41
+ this.parameters.set(AADServerParamKeys.NATIVE_BROKER, encodeURIComponent("1"));
42
+ }
43
+ /**
44
+ * add scopes. set addOidcScopes to false to prevent default scopes in non-user scenarios
45
+ * @param scopeSet
46
+ * @param addOidcScopes
47
+ */
48
+ addScopes(scopes, addOidcScopes = true, defaultScopes = OIDC_DEFAULT_SCOPES) {
49
+ // Always add openid to the scopes when adding OIDC scopes
50
+ if (addOidcScopes &&
51
+ !defaultScopes.includes("openid") &&
52
+ !scopes.includes("openid")) {
53
+ defaultScopes.push("openid");
54
+ }
55
+ const requestScopes = addOidcScopes
56
+ ? [...(scopes || []), ...defaultScopes]
57
+ : scopes || [];
58
+ const scopeSet = new ScopeSet(requestScopes);
59
+ this.parameters.set(AADServerParamKeys.SCOPE, encodeURIComponent(scopeSet.printScopes()));
60
+ }
61
+ /**
62
+ * add clientId
63
+ * @param clientId
64
+ */
65
+ addClientId(clientId) {
66
+ this.parameters.set(AADServerParamKeys.CLIENT_ID, encodeURIComponent(clientId));
67
+ }
68
+ /**
69
+ * add redirect_uri
70
+ * @param redirectUri
71
+ */
72
+ addRedirectUri(redirectUri) {
73
+ RequestValidator.validateRedirectUri(redirectUri);
74
+ this.parameters.set(AADServerParamKeys.REDIRECT_URI, encodeURIComponent(redirectUri));
75
+ }
76
+ /**
77
+ * add post logout redirectUri
78
+ * @param redirectUri
79
+ */
80
+ addPostLogoutRedirectUri(redirectUri) {
81
+ RequestValidator.validateRedirectUri(redirectUri);
82
+ this.parameters.set(AADServerParamKeys.POST_LOGOUT_URI, encodeURIComponent(redirectUri));
83
+ }
84
+ /**
85
+ * add id_token_hint to logout request
86
+ * @param idTokenHint
87
+ */
88
+ addIdTokenHint(idTokenHint) {
89
+ this.parameters.set(AADServerParamKeys.ID_TOKEN_HINT, encodeURIComponent(idTokenHint));
90
+ }
91
+ /**
92
+ * add domain_hint
93
+ * @param domainHint
94
+ */
95
+ addDomainHint(domainHint) {
96
+ this.parameters.set(SSOTypes.DOMAIN_HINT, encodeURIComponent(domainHint));
97
+ }
98
+ /**
99
+ * add login_hint
100
+ * @param loginHint
101
+ */
102
+ addLoginHint(loginHint) {
103
+ this.parameters.set(SSOTypes.LOGIN_HINT, encodeURIComponent(loginHint));
104
+ }
105
+ /**
106
+ * Adds the CCS (Cache Credential Service) query parameter for login_hint
107
+ * @param loginHint
108
+ */
109
+ addCcsUpn(loginHint) {
110
+ this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`UPN:${loginHint}`));
111
+ }
112
+ /**
113
+ * Adds the CCS (Cache Credential Service) query parameter for account object
114
+ * @param loginHint
115
+ */
116
+ addCcsOid(clientInfo) {
117
+ this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`Oid:${clientInfo.uid}@${clientInfo.utid}`));
118
+ }
119
+ /**
120
+ * add sid
121
+ * @param sid
122
+ */
123
+ addSid(sid) {
124
+ this.parameters.set(SSOTypes.SID, encodeURIComponent(sid));
125
+ }
126
+ /**
127
+ * add claims
128
+ * @param claims
129
+ */
130
+ addClaims(claims, clientCapabilities) {
131
+ const mergedClaims = this.addClientCapabilitiesToClaims(claims, clientCapabilities);
132
+ RequestValidator.validateClaims(mergedClaims);
133
+ this.parameters.set(AADServerParamKeys.CLAIMS, encodeURIComponent(mergedClaims));
134
+ }
135
+ /**
136
+ * add correlationId
137
+ * @param correlationId
138
+ */
139
+ addCorrelationId(correlationId) {
140
+ this.parameters.set(AADServerParamKeys.CLIENT_REQUEST_ID, encodeURIComponent(correlationId));
141
+ }
142
+ /**
143
+ * add library info query params
144
+ * @param libraryInfo
145
+ */
146
+ addLibraryInfo(libraryInfo) {
147
+ // Telemetry Info
148
+ this.parameters.set(AADServerParamKeys.X_CLIENT_SKU, libraryInfo.sku);
149
+ this.parameters.set(AADServerParamKeys.X_CLIENT_VER, libraryInfo.version);
150
+ if (libraryInfo.os) {
151
+ this.parameters.set(AADServerParamKeys.X_CLIENT_OS, libraryInfo.os);
152
+ }
153
+ if (libraryInfo.cpu) {
154
+ this.parameters.set(AADServerParamKeys.X_CLIENT_CPU, libraryInfo.cpu);
155
+ }
156
+ }
157
+ /**
158
+ * Add client telemetry parameters
159
+ * @param appTelemetry
160
+ */
161
+ addApplicationTelemetry(appTelemetry) {
162
+ if (appTelemetry?.appName) {
163
+ this.parameters.set(AADServerParamKeys.X_APP_NAME, appTelemetry.appName);
164
+ }
165
+ if (appTelemetry?.appVersion) {
166
+ this.parameters.set(AADServerParamKeys.X_APP_VER, appTelemetry.appVersion);
167
+ }
168
+ }
169
+ /**
170
+ * add prompt
171
+ * @param prompt
172
+ */
173
+ addPrompt(prompt) {
174
+ RequestValidator.validatePrompt(prompt);
175
+ this.parameters.set(`${AADServerParamKeys.PROMPT}`, encodeURIComponent(prompt));
176
+ }
177
+ /**
178
+ * add state
179
+ * @param state
180
+ */
181
+ addState(state) {
182
+ if (state) {
183
+ this.parameters.set(AADServerParamKeys.STATE, encodeURIComponent(state));
184
+ }
185
+ }
186
+ /**
187
+ * add nonce
188
+ * @param nonce
189
+ */
190
+ addNonce(nonce) {
191
+ this.parameters.set(AADServerParamKeys.NONCE, encodeURIComponent(nonce));
192
+ }
193
+ /**
194
+ * add code_challenge and code_challenge_method
195
+ * - throw if either of them are not passed
196
+ * @param codeChallenge
197
+ * @param codeChallengeMethod
198
+ */
199
+ addCodeChallengeParams(codeChallenge, codeChallengeMethod) {
200
+ RequestValidator.validateCodeChallengeParams(codeChallenge, codeChallengeMethod);
201
+ if (codeChallenge && codeChallengeMethod) {
202
+ this.parameters.set(AADServerParamKeys.CODE_CHALLENGE, encodeURIComponent(codeChallenge));
203
+ this.parameters.set(AADServerParamKeys.CODE_CHALLENGE_METHOD, encodeURIComponent(codeChallengeMethod));
204
+ }
205
+ else {
206
+ throw createClientConfigurationError(pkceParamsMissing);
207
+ }
208
+ }
209
+ /**
210
+ * add the `authorization_code` passed by the user to exchange for a token
211
+ * @param code
212
+ */
213
+ addAuthorizationCode(code) {
214
+ this.parameters.set(AADServerParamKeys.CODE, encodeURIComponent(code));
215
+ }
216
+ /**
217
+ * add the `authorization_code` passed by the user to exchange for a token
218
+ * @param code
219
+ */
220
+ addDeviceCode(code) {
221
+ this.parameters.set(AADServerParamKeys.DEVICE_CODE, encodeURIComponent(code));
222
+ }
223
+ /**
224
+ * add the `refreshToken` passed by the user
225
+ * @param refreshToken
226
+ */
227
+ addRefreshToken(refreshToken) {
228
+ this.parameters.set(AADServerParamKeys.REFRESH_TOKEN, encodeURIComponent(refreshToken));
229
+ }
230
+ /**
231
+ * add the `code_verifier` passed by the user to exchange for a token
232
+ * @param codeVerifier
233
+ */
234
+ addCodeVerifier(codeVerifier) {
235
+ this.parameters.set(AADServerParamKeys.CODE_VERIFIER, encodeURIComponent(codeVerifier));
236
+ }
237
+ /**
238
+ * add client_secret
239
+ * @param clientSecret
240
+ */
241
+ addClientSecret(clientSecret) {
242
+ this.parameters.set(AADServerParamKeys.CLIENT_SECRET, encodeURIComponent(clientSecret));
243
+ }
244
+ /**
245
+ * add clientAssertion for confidential client flows
246
+ * @param clientAssertion
247
+ */
248
+ addClientAssertion(clientAssertion) {
249
+ if (clientAssertion) {
250
+ this.parameters.set(AADServerParamKeys.CLIENT_ASSERTION, encodeURIComponent(clientAssertion));
251
+ }
252
+ }
253
+ /**
254
+ * add clientAssertionType for confidential client flows
255
+ * @param clientAssertionType
256
+ */
257
+ addClientAssertionType(clientAssertionType) {
258
+ if (clientAssertionType) {
259
+ this.parameters.set(AADServerParamKeys.CLIENT_ASSERTION_TYPE, encodeURIComponent(clientAssertionType));
260
+ }
261
+ }
262
+ /**
263
+ * add OBO assertion for confidential client flows
264
+ * @param clientAssertion
265
+ */
266
+ addOboAssertion(oboAssertion) {
267
+ this.parameters.set(AADServerParamKeys.OBO_ASSERTION, encodeURIComponent(oboAssertion));
268
+ }
269
+ /**
270
+ * add grant type
271
+ * @param grantType
272
+ */
273
+ addRequestTokenUse(tokenUse) {
274
+ this.parameters.set(AADServerParamKeys.REQUESTED_TOKEN_USE, encodeURIComponent(tokenUse));
275
+ }
276
+ /**
277
+ * add grant type
278
+ * @param grantType
279
+ */
280
+ addGrantType(grantType) {
281
+ this.parameters.set(AADServerParamKeys.GRANT_TYPE, encodeURIComponent(grantType));
282
+ }
283
+ /**
284
+ * add client info
285
+ *
286
+ */
287
+ addClientInfo() {
288
+ this.parameters.set(CLIENT_INFO, "1");
289
+ }
290
+ /**
291
+ * add extraQueryParams
292
+ * @param eQParams
293
+ */
294
+ addExtraQueryParameters(eQParams) {
295
+ const sanitizedEQParams = RequestValidator.sanitizeEQParams(eQParams, this.parameters);
296
+ Object.keys(sanitizedEQParams).forEach((key) => {
297
+ this.parameters.set(key, eQParams[key]);
298
+ });
299
+ }
300
+ addClientCapabilitiesToClaims(claims, clientCapabilities) {
301
+ let mergedClaims;
302
+ // Parse provided claims into JSON object or initialize empty object
303
+ if (!claims) {
304
+ mergedClaims = {};
305
+ }
306
+ else {
307
+ try {
308
+ mergedClaims = JSON.parse(claims);
309
+ }
310
+ catch (e) {
311
+ throw createClientConfigurationError(invalidClaims);
312
+ }
313
+ }
314
+ if (clientCapabilities && clientCapabilities.length > 0) {
315
+ if (!mergedClaims.hasOwnProperty(ClaimsRequestKeys.ACCESS_TOKEN)) {
316
+ // Add access_token key to claims object
317
+ mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN] = {};
318
+ }
319
+ // Add xms_cc claim with provided clientCapabilities to access_token key
320
+ mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN][ClaimsRequestKeys.XMS_CC] = {
321
+ values: clientCapabilities,
322
+ };
323
+ }
324
+ return JSON.stringify(mergedClaims);
325
+ }
326
+ /**
327
+ * adds `username` for Password Grant flow
328
+ * @param username
329
+ */
330
+ addUsername(username) {
331
+ this.parameters.set(PasswordGrantConstants.username, encodeURIComponent(username));
332
+ }
333
+ /**
334
+ * adds `password` for Password Grant flow
335
+ * @param password
336
+ */
337
+ addPassword(password) {
338
+ this.parameters.set(PasswordGrantConstants.password, encodeURIComponent(password));
339
+ }
340
+ /**
341
+ * add pop_jwk to query params
342
+ * @param cnfString
343
+ */
344
+ addPopToken(cnfString) {
345
+ if (cnfString) {
346
+ this.parameters.set(AADServerParamKeys.TOKEN_TYPE, AuthenticationScheme.POP);
347
+ this.parameters.set(AADServerParamKeys.REQ_CNF, encodeURIComponent(cnfString));
348
+ }
349
+ }
350
+ /**
351
+ * add SSH JWK and key ID to query params
352
+ */
353
+ addSshJwk(sshJwkString) {
354
+ if (sshJwkString) {
355
+ this.parameters.set(AADServerParamKeys.TOKEN_TYPE, AuthenticationScheme.SSH);
356
+ this.parameters.set(AADServerParamKeys.REQ_CNF, encodeURIComponent(sshJwkString));
357
+ }
358
+ }
359
+ /**
360
+ * add server telemetry fields
361
+ * @param serverTelemetryManager
362
+ */
363
+ addServerTelemetry(serverTelemetryManager) {
364
+ this.parameters.set(AADServerParamKeys.X_CLIENT_CURR_TELEM, serverTelemetryManager.generateCurrentRequestHeaderValue());
365
+ this.parameters.set(AADServerParamKeys.X_CLIENT_LAST_TELEM, serverTelemetryManager.generateLastRequestHeaderValue());
366
+ }
367
+ /**
368
+ * Adds parameter that indicates to the server that throttling is supported
369
+ */
370
+ addThrottling() {
371
+ this.parameters.set(AADServerParamKeys.X_MS_LIB_CAPABILITY, ThrottlingConstants.X_MS_LIB_CAPABILITY_VALUE);
372
+ }
373
+ /**
374
+ * Adds logout_hint parameter for "silent" logout which prevent server account picker
375
+ */
376
+ addLogoutHint(logoutHint) {
377
+ this.parameters.set(AADServerParamKeys.LOGOUT_HINT, encodeURIComponent(logoutHint));
378
+ }
379
+ /**
380
+ * Utility to create a URL from the params map
381
+ */
382
+ createQueryString() {
383
+ const queryParameterArray = new Array();
384
+ this.parameters.forEach((value, key) => {
385
+ queryParameterArray.push(`${key}=${value}`);
386
+ });
387
+ return queryParameterArray.join("&");
388
+ }
389
389
  }
390
390
 
391
391
  export { RequestParameterBuilder };