/
ClientApplication.ts
596 lines (560 loc) · 21.7 KB
/
ClientApplication.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License.
*/
import {
AuthorizationCodeClient,
ClientConfiguration,
RefreshTokenClient,
AuthenticationResult,
Authority,
AuthorityFactory,
BaseAuthRequest,
SilentFlowClient,
Logger,
ServerTelemetryManager,
ServerTelemetryRequest,
CommonSilentFlowRequest,
CommonRefreshTokenRequest,
CommonAuthorizationCodeRequest,
CommonAuthorizationUrlRequest,
CommonUsernamePasswordRequest,
AuthenticationScheme,
ResponseMode,
AuthorityOptions,
OIDC_DEFAULT_SCOPES,
AzureRegionConfiguration,
AuthError,
AzureCloudOptions,
AuthorizationCodePayload,
Constants,
StringUtils,
createClientAuthError,
ClientAuthErrorCodes,
} from "@azure/msal-common";
import {
Configuration,
buildAppConfiguration,
NodeConfiguration,
} from "../config/Configuration.js";
import { CryptoProvider } from "../crypto/CryptoProvider.js";
import { NodeStorage } from "../cache/NodeStorage.js";
import { Constants as NodeConstants, ApiId } from "../utils/Constants.js";
import { TokenCache } from "../cache/TokenCache.js";
import { ClientAssertion } from "./ClientAssertion.js";
import { AuthorizationUrlRequest } from "../request/AuthorizationUrlRequest.js";
import { AuthorizationCodeRequest } from "../request/AuthorizationCodeRequest.js";
import { RefreshTokenRequest } from "../request/RefreshTokenRequest.js";
import { SilentFlowRequest } from "../request/SilentFlowRequest.js";
import { version, name } from "../packageMetadata.js";
import { UsernamePasswordRequest } from "../request/UsernamePasswordRequest.js";
import { NodeAuthError } from "../error/NodeAuthError.js";
import { UsernamePasswordClient } from "./UsernamePasswordClient.js";
/**
* Base abstract class for all ClientApplications - public and confidential
* @public
*/
export abstract class ClientApplication {
protected readonly cryptoProvider: CryptoProvider;
private tokenCache: TokenCache;
/**
* Platform storage object
*/
protected storage: NodeStorage;
/**
* Logger object to log the application flow
*/
protected logger: Logger;
/**
* Platform configuration initialized by the application
*/
protected config: NodeConfiguration;
/**
* Client assertion passed by the user for confidential client flows
*/
protected clientAssertion: ClientAssertion;
/**
* Client secret passed by the user for confidential client flows
*/
protected clientSecret: string;
/**
* Constructor for the ClientApplication
*/
protected constructor(configuration: Configuration) {
this.config = buildAppConfiguration(configuration);
this.cryptoProvider = new CryptoProvider();
this.logger = new Logger(
this.config.system.loggerOptions,
name,
version
);
this.storage = new NodeStorage(
this.logger,
this.config.auth.clientId,
this.cryptoProvider
);
this.tokenCache = new TokenCache(
this.storage,
this.logger,
this.config.cache.cachePlugin
);
}
/**
* Creates the URL of the authorization request, letting the user input credentials and consent to the
* application. The URL targets the /authorize endpoint of the authority configured in the
* application object.
*
* Once the user inputs their credentials and consents, the authority will send a response to the redirect URI
* sent in the request and should contain an authorization code, which can then be used to acquire tokens via
* `acquireTokenByCode(AuthorizationCodeRequest)`.
*/
async getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string> {
this.logger.info("getAuthCodeUrl called", request.correlationId);
const validRequest: CommonAuthorizationUrlRequest = {
...request,
...(await this.initializeBaseRequest(request)),
responseMode: request.responseMode || ResponseMode.QUERY,
authenticationScheme: AuthenticationScheme.BEARER,
};
const authClientConfig = await this.buildOauthClientConfiguration(
validRequest.authority,
validRequest.correlationId,
undefined,
undefined,
request.azureCloudOptions
);
const authorizationCodeClient = new AuthorizationCodeClient(
authClientConfig
);
this.logger.verbose(
"Auth code client created",
validRequest.correlationId
);
return authorizationCodeClient.getAuthCodeUrl(validRequest);
}
/**
* Acquires a token by exchanging the Authorization Code received from the first step of OAuth2.0
* Authorization Code flow.
*
* `getAuthCodeUrl(AuthorizationCodeUrlRequest)` can be used to create the URL for the first step of OAuth2.0
* Authorization Code flow. Ensure that values for redirectUri and scopes in AuthorizationCodeUrlRequest and
* AuthorizationCodeRequest are the same.
*/
async acquireTokenByCode(
request: AuthorizationCodeRequest,
authCodePayLoad?: AuthorizationCodePayload
): Promise<AuthenticationResult> {
this.logger.info("acquireTokenByCode called");
if (request.state && authCodePayLoad) {
this.logger.info("acquireTokenByCode - validating state");
this.validateState(request.state, authCodePayLoad.state || "");
// eslint-disable-next-line no-param-reassign
authCodePayLoad = { ...authCodePayLoad, state: "" };
}
const validRequest: CommonAuthorizationCodeRequest = {
...request,
...(await this.initializeBaseRequest(request)),
authenticationScheme: AuthenticationScheme.BEARER,
};
const serverTelemetryManager = this.initializeServerTelemetryManager(
ApiId.acquireTokenByCode,
validRequest.correlationId
);
try {
const authClientConfig = await this.buildOauthClientConfiguration(
validRequest.authority,
validRequest.correlationId,
serverTelemetryManager,
undefined,
request.azureCloudOptions
);
const authorizationCodeClient = new AuthorizationCodeClient(
authClientConfig
);
this.logger.verbose(
"Auth code client created",
validRequest.correlationId
);
return authorizationCodeClient.acquireToken(
validRequest,
authCodePayLoad
);
} catch (e) {
if (e instanceof AuthError) {
e.setCorrelationId(validRequest.correlationId);
}
serverTelemetryManager.cacheFailedRequest(e);
throw e;
}
}
/**
* Acquires a token by exchanging the refresh token provided for a new set of tokens.
*
* This API is provided only for scenarios where you would like to migrate from ADAL to MSAL. Otherwise, it is
* recommended that you use `acquireTokenSilent()` for silent scenarios. When using `acquireTokenSilent()`, MSAL will
* handle the caching and refreshing of tokens automatically.
*/
async acquireTokenByRefreshToken(
request: RefreshTokenRequest
): Promise<AuthenticationResult | null> {
this.logger.info(
"acquireTokenByRefreshToken called",
request.correlationId
);
const validRequest: CommonRefreshTokenRequest = {
...request,
...(await this.initializeBaseRequest(request)),
authenticationScheme: AuthenticationScheme.BEARER,
};
const serverTelemetryManager = this.initializeServerTelemetryManager(
ApiId.acquireTokenByRefreshToken,
validRequest.correlationId
);
try {
const refreshTokenClientConfig =
await this.buildOauthClientConfiguration(
validRequest.authority,
validRequest.correlationId,
serverTelemetryManager,
undefined,
request.azureCloudOptions
);
const refreshTokenClient = new RefreshTokenClient(
refreshTokenClientConfig
);
this.logger.verbose(
"Refresh token client created",
validRequest.correlationId
);
return refreshTokenClient.acquireToken(validRequest);
} catch (e) {
if (e instanceof AuthError) {
e.setCorrelationId(validRequest.correlationId);
}
serverTelemetryManager.cacheFailedRequest(e);
throw e;
}
}
/**
* Acquires a token silently when a user specifies the account the token is requested for.
*
* This API expects the user to provide an account object and looks into the cache to retrieve the token if present.
* There is also an optional "forceRefresh" boolean the user can send to bypass the cache for access_token and id_token.
* In case the refresh_token is expired or not found, an error is thrown
* and the guidance is for the user to call any interactive token acquisition API (eg: `acquireTokenByCode()`).
*/
async acquireTokenSilent(
request: SilentFlowRequest
): Promise<AuthenticationResult> {
const validRequest: CommonSilentFlowRequest = {
...request,
...(await this.initializeBaseRequest(request)),
forceRefresh: request.forceRefresh || false,
};
const serverTelemetryManager = this.initializeServerTelemetryManager(
ApiId.acquireTokenSilent,
validRequest.correlationId,
validRequest.forceRefresh
);
try {
const silentFlowClientConfig =
await this.buildOauthClientConfiguration(
validRequest.authority,
validRequest.correlationId,
serverTelemetryManager,
undefined,
request.azureCloudOptions
);
const silentFlowClient = new SilentFlowClient(
silentFlowClientConfig
);
this.logger.verbose(
"Silent flow client created",
validRequest.correlationId
);
return silentFlowClient.acquireToken(validRequest);
} catch (e) {
if (e instanceof AuthError) {
e.setCorrelationId(validRequest.correlationId);
}
serverTelemetryManager.cacheFailedRequest(e as AuthError);
throw e;
}
}
/**
* Acquires tokens with password grant by exchanging client applications username and password for credentials
*
* The latest OAuth 2.0 Security Best Current Practice disallows the password grant entirely.
* More details on this recommendation at https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4
* Microsoft's documentation and recommendations are at:
* https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
*
* @param request - UsenamePasswordRequest
*/
async acquireTokenByUsernamePassword(
request: UsernamePasswordRequest
): Promise<AuthenticationResult | null> {
this.logger.info(
"acquireTokenByUsernamePassword called",
request.correlationId
);
const validRequest: CommonUsernamePasswordRequest = {
...request,
...(await this.initializeBaseRequest(request)),
};
const serverTelemetryManager = this.initializeServerTelemetryManager(
ApiId.acquireTokenByUsernamePassword,
validRequest.correlationId
);
try {
const usernamePasswordClientConfig =
await this.buildOauthClientConfiguration(
validRequest.authority,
validRequest.correlationId,
serverTelemetryManager,
undefined,
request.azureCloudOptions
);
const usernamePasswordClient = new UsernamePasswordClient(
usernamePasswordClientConfig
);
this.logger.verbose(
"Username password client created",
validRequest.correlationId
);
return usernamePasswordClient.acquireToken(validRequest);
} catch (e) {
if (e instanceof AuthError) {
e.setCorrelationId(validRequest.correlationId);
}
serverTelemetryManager.cacheFailedRequest(e);
throw e;
}
}
/**
* Gets the token cache for the application.
*/
getTokenCache(): TokenCache {
this.logger.info("getTokenCache called");
return this.tokenCache;
}
/**
* Validates OIDC state by comparing the user cached state with the state received from the server.
*
* This API is provided for scenarios where you would use OAuth2.0 state parameter to mitigate against
* CSRF attacks.
* For more information about state, visit https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.
* @param state
* @param cachedState
*/
protected validateState(state: string, cachedState: string): void {
if (!state) {
throw NodeAuthError.createStateNotFoundError();
}
if (state !== cachedState) {
throw createClientAuthError(ClientAuthErrorCodes.stateMismatch);
}
}
/**
* Returns the logger instance
*/
getLogger(): Logger {
return this.logger;
}
/**
* Replaces the default logger set in configurations with new Logger with new configurations
* @param logger - Logger instance
*/
setLogger(logger: Logger): void {
this.logger = logger;
}
/**
* Builds the common configuration to be passed to the common component based on the platform configurarion
* @param authority - user passed authority in configuration
* @param serverTelemetryManager - initializes servertelemetry if passed
*/
protected async buildOauthClientConfiguration(
authority: string,
requestCorrelationId?: string,
serverTelemetryManager?: ServerTelemetryManager,
azureRegionConfiguration?: AzureRegionConfiguration,
azureCloudOptions?: AzureCloudOptions
): Promise<ClientConfiguration> {
this.logger.verbose(
"buildOauthClientConfiguration called",
requestCorrelationId
);
// precedence - azureCloudInstance + tenant >> authority and request >> config
const userAzureCloudOptions = azureCloudOptions
? azureCloudOptions
: this.config.auth.azureCloudOptions;
// using null assertion operator as we ensure that all config values have default values in buildConfiguration()
this.logger.verbose(
`building oauth client configuration with the authority: ${authority}`,
requestCorrelationId
);
const discoveredAuthority = await this.createAuthority(
authority,
azureRegionConfiguration,
requestCorrelationId,
userAzureCloudOptions
);
serverTelemetryManager?.updateRegionDiscoveryMetadata(
discoveredAuthority.regionDiscoveryMetadata
);
const clientConfiguration: ClientConfiguration = {
authOptions: {
clientId: this.config.auth.clientId,
authority: discoveredAuthority,
clientCapabilities: this.config.auth.clientCapabilities,
},
loggerOptions: {
logLevel: this.config.system.loggerOptions.logLevel,
loggerCallback: this.config.system.loggerOptions.loggerCallback,
piiLoggingEnabled:
this.config.system.loggerOptions.piiLoggingEnabled,
correlationId: requestCorrelationId,
},
cacheOptions: {
claimsBasedCachingEnabled:
this.config.cache.claimsBasedCachingEnabled,
},
cryptoInterface: this.cryptoProvider,
networkInterface: this.config.system.networkClient,
storageInterface: this.storage,
serverTelemetryManager: serverTelemetryManager,
clientCredentials: {
clientSecret: this.clientSecret,
clientAssertion: this.clientAssertion
? this.getClientAssertion(discoveredAuthority)
: undefined,
},
libraryInfo: {
sku: NodeConstants.MSAL_SKU,
version: version,
cpu: process.arch || Constants.EMPTY_STRING,
os: process.platform || Constants.EMPTY_STRING,
},
telemetry: this.config.telemetry,
persistencePlugin: this.config.cache.cachePlugin,
serializableCache: this.tokenCache,
};
return clientConfiguration;
}
private getClientAssertion(authority: Authority): {
assertion: string;
assertionType: string;
} {
return {
assertion: this.clientAssertion.getJwt(
this.cryptoProvider,
this.config.auth.clientId,
authority.tokenEndpoint
),
assertionType: NodeConstants.JWT_BEARER_ASSERTION_TYPE,
};
}
/**
* Generates a request with the default scopes & generates a correlationId.
* @param authRequest - BaseAuthRequest for initialization
*/
protected async initializeBaseRequest(
authRequest: Partial<BaseAuthRequest>
): Promise<BaseAuthRequest> {
this.logger.verbose(
"initializeRequestScopes called",
authRequest.correlationId
);
// Default authenticationScheme to Bearer, log that POP isn't supported yet
if (
authRequest.authenticationScheme &&
authRequest.authenticationScheme === AuthenticationScheme.POP
) {
this.logger.verbose(
"Authentication Scheme 'pop' is not supported yet, setting Authentication Scheme to 'Bearer' for request",
authRequest.correlationId
);
}
authRequest.authenticationScheme = AuthenticationScheme.BEARER;
// Set requested claims hash if claims-based caching is enabled and claims were requested
if (
this.config.cache.claimsBasedCachingEnabled &&
authRequest.claims &&
// Checks for empty stringified object "{}" which doesn't qualify as requested claims
!StringUtils.isEmptyObj(authRequest.claims)
) {
authRequest.requestedClaimsHash =
await this.cryptoProvider.hashString(authRequest.claims);
}
return {
...authRequest,
scopes: [
...((authRequest && authRequest.scopes) || []),
...OIDC_DEFAULT_SCOPES,
],
correlationId:
(authRequest && authRequest.correlationId) ||
this.cryptoProvider.createNewGuid(),
authority: authRequest.authority || this.config.auth.authority,
};
}
/**
* Initializes the server telemetry payload
* @param apiId - Id for a specific request
* @param correlationId - GUID
* @param forceRefresh - boolean to indicate network call
*/
protected initializeServerTelemetryManager(
apiId: number,
correlationId: string,
forceRefresh?: boolean
): ServerTelemetryManager {
const telemetryPayload: ServerTelemetryRequest = {
clientId: this.config.auth.clientId,
correlationId: correlationId,
apiId: apiId,
forceRefresh: forceRefresh || false,
};
return new ServerTelemetryManager(telemetryPayload, this.storage);
}
/**
* Create authority instance. If authority not passed in request, default to authority set on the application
* object. If no authority set in application object, then default to common authority.
* @param authorityString - authority from user configuration
*/
private async createAuthority(
authorityString: string,
azureRegionConfiguration?: AzureRegionConfiguration,
requestCorrelationId?: string,
azureCloudOptions?: AzureCloudOptions
): Promise<Authority> {
this.logger.verbose("createAuthority called", requestCorrelationId);
// build authority string based on auth params - azureCloudInstance is prioritized if provided
const authorityUrl = Authority.generateAuthority(
authorityString,
azureCloudOptions
);
const authorityOptions: AuthorityOptions = {
protocolMode: this.config.auth.protocolMode,
knownAuthorities: this.config.auth.knownAuthorities,
cloudDiscoveryMetadata: this.config.auth.cloudDiscoveryMetadata,
authorityMetadata: this.config.auth.authorityMetadata,
azureRegionConfiguration,
skipAuthorityMetadataCache:
this.config.auth.skipAuthorityMetadataCache,
};
return await AuthorityFactory.createDiscoveredInstance(
authorityUrl,
this.config.system.networkClient,
this.storage,
authorityOptions,
this.logger
);
}
/**
* Clear the cache
*/
clearCache(): void {
void this.storage.clear();
}
}