-
Notifications
You must be signed in to change notification settings - Fork 36
/
login.ts
1203 lines (1143 loc) · 48.5 KB
/
login.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
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
import * as adal from "adal-node";
import * as msRest from "@azure/ms-rest-js";
import { execFile } from "child_process";
import { readFileSync } from "fs";
import { Environment } from "@azure/ms-rest-azure-env";
import { TokenCredentialsBase } from "./credentials/tokenCredentialsBase";
import { ApplicationTokenCredentials } from "./credentials/applicationTokenCredentials";
import { ApplicationTokenCertificateCredentials } from "./credentials/applicationTokenCertificateCredentials";
import { DeviceTokenCredentials } from "./credentials/deviceTokenCredentials";
import { UserTokenCredentials } from "./credentials/userTokenCredentials";
import { AuthConstants, TokenAudience } from "./util/authConstants";
import {
buildTenantList,
getSubscriptionsFromTenants,
LinkedSubscription
} from "./subscriptionManagement/subscriptionUtils";
import { MSIVmTokenCredentials, MSIVmOptions } from "./credentials/msiVmTokenCredentials";
import {
MSIAppServiceTokenCredentials,
MSIAppServiceOptions
} from "./credentials/msiAppServiceTokenCredentials";
import { MSITokenResponse } from "./credentials/msiTokenCredentials";
/**
* Urls for management plane token
* audience across different azure environments.
*/
const managementPlaneTokenAudiences = [
"https://management.core.windows.net/",
"https://management.core.chinacloudapi.cn/",
"https://management.core.usgovcloudapi.net/",
"https://management.core.cloudapi.de/",
"https://management.azure.com/",
"https://management.core.windows.net",
"https://management.core.chinacloudapi.cn",
"https://management.core.usgovcloudapi.net",
"https://management.core.cloudapi.de",
"https://management.azure.com"
];
function turnOnLogging() {
const log = adal.Logging;
log.setLoggingOptions({
level: 3, // Please use log.LOGGING_LEVEL.VERBOSE once AD TypeScript mappings are updated,
log: function (level: any, message: any, error: any) {
level;
console.info(message);
if (error) {
console.error(error);
}
}
});
}
if (process.env["AZURE_ADAL_LOGGING_ENABLED"]) {
turnOnLogging();
}
/**
* Describes optional parameters for servicePrincipal/secret authentication.
*/
export interface AzureTokenCredentialsOptions {
/**
* The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferably in a guid format).
*/
tokenAudience?: TokenAudience;
/**
* The Azure environment to authenticate with.
*/
environment?: Environment;
/**
* The token cache. Default value is MemoryCache from adal.
*/
tokenCache?: adal.TokenCache;
}
/**
* Describes optional parameters for username/password authentication.
*/
export interface LoginWithUsernamePasswordOptions extends AzureTokenCredentialsOptions {
/**
* The active directory application client id.
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for an example.
*/
clientId?: string;
/**
* The domain or tenant Id containing this application. Default value is "common".
*/
domain?: string;
}
/**
* Describes optional parameters for interactive authentication.
*/
export interface InteractiveLoginOptions extends LoginWithUsernamePasswordOptions {
/**
* A logger that logs the user code response message required for interactive login. When
* this option is specified the usercode response message will not be logged to console.
*/
userCodeResponseLogger?: any;
/**
* The language code specifying how the message should be localized to. Default value "en-us".
*/
language?: string;
}
/**
* Describes the authentication response.
*/
export interface AuthResponse<T extends TokenCredentialsBase = TokenCredentialsBase> {
/**
* The credentials object.
*/
credentials: T;
/**
* List of associated subscriptions. It will be empty for personal accounts, unless the login method is called with a tenant Id sent as the `domain` optional parameter.
*/
subscriptions?: LinkedSubscription[];
}
/**
* Describes optional parameters for login withAuthFile.
*/
export interface LoginWithAuthFileOptions {
/**
* Absolute file path to the auth file. If not provided
* then please set the environment variable AZURE_AUTH_LOCATION.
*/
filePath?: string;
/**
* The subscriptionId environment variable
* name. Default is "AZURE_SUBSCRIPTION_ID".
*/
subscriptionEnvVariableName?: string;
}
/**
* Generic callback type definition.
*
* The error occurred if any, while executing the request; otherwise undefined
* Result when call was successful.
*/
export type Callback<TResult> = (error?: Error, result?: TResult) => void;
/**
* Provides a UserTokenCredentials object and the list of subscriptions associated with that userId across all the applicable tenants.
* This method is applicable only for organizational ids that are not 2FA enabled otherwise please use interactive login.
*
* When using personal accounts, the `domain` property in the `options` parameter is required to be set to the Id of a tenant for that account. Otherwise, the resulting credential will not be able to access the account's resources.
*
* @param username - The user name for the Organization Id account.
* @param password - The password for the Organization Id account.
* @param options - Object representing optional parameters.
* @param options.clientId - The active directory application client id.
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for an example.
* @param options.tokenAudience - The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferably in a guid format).
* @param options.domain - The domain or tenant Id containing this application. Default value "common".
* @param options.environment - The azure environment to authenticate with.
* @param options.tokenCache - The token cache. Default value is the MemoryCache object from adal.
*
* @returns A Promise that resolves to AuthResponse, which contains `credentials` and an optional `subscriptions` array, and rejects with an Error.
*/
export async function withUsernamePasswordWithAuthResponse(
username: string,
password: string,
options?: LoginWithUsernamePasswordOptions
): Promise<AuthResponse<UserTokenCredentials>> {
if (!options) {
options = {};
}
if (!options.clientId) {
options.clientId = AuthConstants.DEFAULT_ADAL_CLIENT_ID;
}
if (!options.domain) {
options.domain = AuthConstants.AAD_COMMON_TENANT;
}
if (!options.environment) {
options.environment = Environment.AzureCloud;
}
const creds = new UserTokenCredentials(
options.clientId,
options.domain,
username,
password,
options.tokenAudience,
options.environment,
options.tokenCache
);
const tokenResponse = await creds.getToken();
// The token cache gets propulated for all the tenants as a part of building the tenantList.
let tenantList = await buildTenantList(creds);
if (tenantList.length === 0 && tokenResponse.tenantId) {
tenantList = [tokenResponse.tenantId];
}
const subscriptionList: LinkedSubscription[] = await _getSubscriptions(
creds,
tenantList,
options.tokenAudience
);
return { credentials: creds, subscriptions: subscriptionList };
}
/**
* Provides an ApplicationTokenCredentials object and the list of subscriptions associated with that servicePrincipalId/clientId across all the applicable tenants.
*
* When using personal accounts, the `domain` parameter is required to be set to the Id of a tenant for that account. Otherwise, the resulting credential will not be able to access the account's resources.
*
* @param clientId - The active directory application client Id also known as the SPN (ServicePrincipal Name).
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for an example.
* @param secret - The application secret for the service principal.
* @param domain - The domain or tenant Id containing this application.
* @param options - Object representing optional parameters.
* @param options.tokenAudience - The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferably in a guid format).
* @param options.environment - The azure environment to authenticate with.
* @param options.tokenCache - The token cache. Default value is the MemoryCache object from adal.
*
* @returns A Promise that resolves to AuthResponse, which contains "credentials" and optional "subscriptions" array and rejects with an Error.
*/
export async function withServicePrincipalSecretWithAuthResponse(
clientId: string,
secret: string,
domain: string,
options?: AzureTokenCredentialsOptions
): Promise<AuthResponse<ApplicationTokenCredentials>> {
if (!options) {
options = {};
}
if (!options.environment) {
options.environment = Environment.AzureCloud;
}
const creds = new ApplicationTokenCredentials(
clientId,
domain,
secret,
options.tokenAudience,
options.environment,
options.tokenCache
);
await creds.getToken();
const subscriptionList = await _getSubscriptions(creds, [domain], options.tokenAudience);
return { credentials: creds, subscriptions: subscriptionList };
}
/**
* Provides an ApplicationTokenCertificateCredentials object and the list of subscriptions associated with that servicePrincipalId/clientId across all the applicable tenants.
*
* When using personal accounts, the `domain` parameter is required to be set to the Id of a tenant for that account. Otherwise, the resulting credential will not be able to access the account's resources.
*
* @param clientId - The active directory application client Id also known as the SPN (ServicePrincipal Name).
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for an example.
* @param certificateStringOrFilePath - A PEM encoded certificate and private key OR an absolute filepath to the .pem file containing that information. For example:
* - CertificateString: "-----BEGIN PRIVATE KEY-----\n<xxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n<yyyyy>\n-----END CERTIFICATE-----\n"
* - CertificateFilePath: **Absolute** file path of the .pem file.
* @param domain - The domain or tenant Id containing this application.
* @param options - Object representing optional parameters.
* @param options.tokenAudience - The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferably in a guid format).
* @param options.environment - The azure environment to authenticate with.
* @param options.tokenCache - The token cache. Default value is the MemoryCache object from adal.
*
* @returns A Promise that resolves to AuthResponse, which contains "credentials" and optional "subscriptions" array and rejects with an Error.
*/
export async function withServicePrincipalCertificateWithAuthResponse(
clientId: string,
certificateStringOrFilePath: string,
domain: string,
options?: AzureTokenCredentialsOptions
): Promise<AuthResponse<ApplicationTokenCertificateCredentials>> {
if (!options) {
options = {};
}
if (!options.environment) {
options.environment = Environment.AzureCloud;
}
const creds = ApplicationTokenCertificateCredentials.create(
clientId,
certificateStringOrFilePath,
domain,
options
);
await creds.getToken();
const subscriptionList = await _getSubscriptions(creds, [domain], options.tokenAudience);
return { credentials: creds, subscriptions: subscriptionList };
}
function validateAuthFileContent(credsObj: any, filePath: string) {
if (!credsObj) {
throw new Error("Please provide a credsObj to validate.");
}
if (!filePath) {
throw new Error("Please provide a filePath.");
}
if (!credsObj.clientId) {
throw new Error(`"clientId" is missing from the auth file: ${filePath}.`);
}
if (!credsObj.clientSecret && !credsObj.clientCertificate) {
throw new Error(
`Either "clientSecret" or "clientCertificate" must be present in the auth file: ${filePath}.`
);
}
if (!credsObj.subscriptionId) {
throw new Error(`"subscriptionId" is missing from the auth file: ${filePath}.`);
}
if (!credsObj.tenantId) {
throw new Error(`"tenantId" is missing from the auth file: ${filePath}.`);
}
if (!credsObj.activeDirectoryEndpointUrl) {
throw new Error(`"activeDirectoryEndpointUrl" is missing from the auth file: ${filePath}.`);
}
if (!credsObj.resourceManagerEndpointUrl) {
throw new Error(`"resourceManagerEndpointUrl" is missing from the auth file: ${filePath}.`);
}
if (!credsObj.activeDirectoryGraphResourceId) {
throw new Error(`"activeDirectoryGraphResourceId" is missing from the auth file: ${filePath}.`);
}
if (!credsObj.sqlManagementEndpointUrl) {
throw new Error(`"sqlManagementEndpointUrl" is missing from the auth file: ${filePath}.`);
}
}
function foundManagementEndpointUrl(authFileUrl: string, envUrl: string): boolean {
if (!authFileUrl || (authFileUrl && typeof authFileUrl.valueOf() !== "string")) {
throw new Error("authFileUrl cannot be null or undefined and must be of type string.");
}
if (!envUrl || (envUrl && typeof envUrl.valueOf() !== "string")) {
throw new Error("envUrl cannot be null or undefined and must be of type string.");
}
authFileUrl = authFileUrl.endsWith("/") ? authFileUrl.slice(0, -1) : authFileUrl;
envUrl = envUrl.endsWith("/") ? envUrl.slice(0, -1) : envUrl;
return authFileUrl.toLowerCase() === envUrl.toLowerCase();
}
/**
* Before using this method please install az cli from https://github.com/Azure/azure-cli/releases. Then execute `az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}`.
* If you want to create the sp for a different cloud/environment then please execute:
* 1. az cloud list
* 2. az cloud set –n <name of the environment>
* 3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret
* **OR**
* 3. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate
* If the service principal is already created then login with service principal info:
* 4. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
* 5. az account show --sdk-auth > auth.json
*
* Authenticates using the service principal information provided in the auth file. This method will set
* the subscriptionId from the auth file to the user provided environment variable in the options
* parameter or the default "AZURE_SUBSCRIPTION_ID".
*
* @param options - Optional parameters
* @param options.filePath - Absolute file path to the auth file. If not provided
* then please set the environment variable AZURE_AUTH_LOCATION.
* @param options.subscriptionEnvVariableName - The subscriptionId environment variable
* name. Default is "AZURE_SUBSCRIPTION_ID".
* @param optionalCallback - The optional callback.
*
* @returns A Promise that resolves to AuthResponse, which contains "credentials" and optional "subscriptions" array and rejects with an Error.
*/
export async function withAuthFileWithAuthResponse(
options?: LoginWithAuthFileOptions
): Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>> {
if (!options) options = { filePath: "" };
const filePath = options.filePath || process.env[AuthConstants.AZURE_AUTH_LOCATION];
const subscriptionEnvVariableName =
options.subscriptionEnvVariableName || "AZURE_SUBSCRIPTION_ID";
if (!filePath) {
const msg = `Either provide an absolute file path to the auth file or set/export the environment variable - ${AuthConstants.AZURE_AUTH_LOCATION}.`;
throw new Error(msg);
}
let content: string,
credsObj: any = {};
const optionsForSp: any = {};
content = readFileSync(filePath, { encoding: "utf8" });
credsObj = JSON.parse(content);
validateAuthFileContent(credsObj, filePath);
if (!credsObj.managementEndpointUrl) {
credsObj.managementEndpointUrl = credsObj.resourceManagerEndpointUrl;
}
// setting the subscriptionId from auth file to the environment variable
process.env[subscriptionEnvVariableName] = credsObj.subscriptionId;
// get the AzureEnvironment or create a new AzureEnvironment based on the info provided in the auth file
const envFound: any = {
name: ""
};
const envNames = Object.keys(Environment);
for (let i = 0; i < envNames.length; i++) {
const env = envNames[i];
const environmentObj = (Environment as any)[env];
if (
environmentObj &&
environmentObj.managementEndpointUrl &&
foundManagementEndpointUrl(
credsObj.managementEndpointUrl,
environmentObj.managementEndpointUrl
)
) {
envFound.name = environmentObj.name;
break;
}
}
if (envFound.name) {
optionsForSp.environment = (Environment as any)[envFound.name];
} else {
// create a new environment with provided info.
const envParams: any = {
// try to find a logical name or set the filepath as the env name.
name: credsObj.managementEndpointUrl.match(/.*management\.core\.(.*)\..*/i)[1] || filePath
};
const keys = Object.keys(credsObj);
for (let i = 0; i < keys.length; i++) {
const key = keys[i];
if (
key.match(/^(clientId|clientSecret|clientCertificate|subscriptionId|tenantId)$/gi) === null
) {
if (key === "activeDirectoryEndpointUrl" && !key.endsWith("/")) {
envParams[key] = credsObj[key] + "/";
} else {
envParams[key] = credsObj[key];
}
}
}
if (!envParams.activeDirectoryResourceId) {
envParams.activeDirectoryResourceId = credsObj.managementEndpointUrl;
}
if (!envParams.portalUrl) {
envParams.portalUrl = "https://portal.azure.com";
}
optionsForSp.environment = Environment.add(envParams);
}
if (credsObj.clientSecret) {
return withServicePrincipalSecretWithAuthResponse(
credsObj.clientId,
credsObj.clientSecret,
credsObj.tenantId,
optionsForSp
);
}
return withServicePrincipalCertificateWithAuthResponse(
credsObj.clientId,
credsObj.clientCertificate,
credsObj.tenantId,
optionsForSp
);
}
/**
* Provides a url and code that needs to be copy and pasted in a browser and authenticated over there. If successful, the user will get a DeviceTokenCredentials object and the list of subscriptions associated with that userId across all the applicable tenants.
*
* When using personal accounts, the `domain` property in the `options` parameter is required to be set to the Id of a tenant for that account. Otherwise, the resulting credential will not be able to access the account's resources.
*
* @param options - Object representing optional parameters.
*
* @param options.clientId - The active directory application client id.
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for an example.
*
* @param options.tokenAudience - The audience for which the token is requested. Valid value is "graph".If tokenAudience is provided
* then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferably in a guid format).
*
* @param options.domain - The domain or tenant Id containing this application. Default value is "common".
*
* @param options.environment - The azure environment to authenticate with. Default environment is "Public Azure".
*
* @param options.tokenCache - The token cache. Default value is the MemoryCache object from adal.
*
* @param options.language - The language code specifying how the message should be localized to. Default value "en-us".
*
* @param options.userCodeResponseLogger - A logger that logs the user code response message required for interactive login. When
* this option is specified the usercode response message will not be logged to console.
*
* @param optionalCallback - The optional callback.
*
* @returns A Promise that resolves to AuthResponse, which contains "credentials" and optional "subscriptions" array and rejects with an Error.
*/
export async function withInteractiveWithAuthResponse(
options?: InteractiveLoginOptions
): Promise<AuthResponse<DeviceTokenCredentials>> {
if (!options) {
options = {};
}
if (!options.environment) {
options.environment = Environment.AzureCloud;
}
if (!options.domain) {
options.domain = AuthConstants.AAD_COMMON_TENANT;
}
if (!options.clientId) {
options.clientId = AuthConstants.DEFAULT_ADAL_CLIENT_ID;
}
if (!options.tokenCache) {
options.tokenCache = new adal.MemoryCache();
}
if (!options.language) {
options.language = AuthConstants.DEFAULT_LANGUAGE;
}
if (!options.tokenAudience) {
options.tokenAudience = options.environment.activeDirectoryResourceId;
}
const interactiveOptions: any = {};
interactiveOptions.tokenAudience = options.tokenAudience;
interactiveOptions.environment = options.environment;
interactiveOptions.domain = options.domain;
interactiveOptions.clientId = options.clientId;
interactiveOptions.tokenCache = options.tokenCache;
interactiveOptions.language = options.language;
interactiveOptions.userCodeResponseLogger = options.userCodeResponseLogger;
const authorityUrl: string =
interactiveOptions.environment.activeDirectoryEndpointUrl + interactiveOptions.domain;
const authContext = new adal.AuthenticationContext(
authorityUrl,
interactiveOptions.environment.validateAuthority,
interactiveOptions.tokenCache
);
interactiveOptions.context = authContext;
function tryAcquireToken(interactiveOptions: InteractiveLoginOptions, resolve: any, reject: any) {
authContext.acquireUserCode(
interactiveOptions.tokenAudience!,
interactiveOptions.clientId!,
interactiveOptions.language!,
(err: any, userCodeRes: adal.UserCodeInfo) => {
if (err) {
if (err.error === "authorization_pending") {
setTimeout(() => {
tryAcquireToken(interactiveOptions, resolve, reject);
}, 1000);
} else {
reject(err);
}
return;
}
if (interactiveOptions.userCodeResponseLogger) {
interactiveOptions.userCodeResponseLogger(userCodeRes.message);
} else {
console.log(userCodeRes.message);
}
return resolve(userCodeRes);
}
);
}
const getUserCode = new Promise<adal.UserCodeInfo>((resolve, reject) => {
return tryAcquireToken(interactiveOptions, resolve, reject);
});
const userCodeResponse = await getUserCode;
const creds = await new Promise<DeviceTokenCredentials>((resolve, reject) => {
return authContext.acquireTokenWithDeviceCode(
interactiveOptions.tokenAudience,
interactiveOptions.clientId,
userCodeResponse,
(error, tokenResponse) => {
if (error) {
return reject(error);
}
const response = tokenResponse as adal.TokenResponse;
interactiveOptions.userName = response.userId;
interactiveOptions.authorizationScheme = response.tokenType;
let creds;
try {
creds = new DeviceTokenCredentials(
interactiveOptions.clientId,
interactiveOptions.domain,
interactiveOptions.userName,
interactiveOptions.tokenAudience,
interactiveOptions.environment,
interactiveOptions.tokenCache
);
} catch (err) {
return reject(err);
}
return resolve(creds);
}
);
});
const tenants = await buildTenantList(creds);
const subscriptions = await _getSubscriptions(creds, tenants, interactiveOptions.tokenAudience);
return { credentials: creds, subscriptions: subscriptions };
}
/**
* Before using this method please install az cli from https://github.com/Azure/azure-cli/releases. Then execute `az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}`.
* If you want to create the sp for a different cloud/environment then please execute:
* 1. az cloud list
* 2. az cloud set –n <name of the environment>
* 3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret
* **OR**
* 3. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate
* If the service principal is already created then login with service principal info:
* 4. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
* 5. az account show --sdk-auth > auth.json
*
* Authenticates using the service principal information provided in the auth file. This method will set
* the subscriptionId from the auth file to the user provided environment variable in the options
* parameter or the default "AZURE_SUBSCRIPTION_ID".
*
* @param options - Optional parameters
* @param options.filePath - Absolute file path to the auth file. If not provided
* then please set the environment variable AZURE_AUTH_LOCATION.
* @param options.subscriptionEnvVariableName - The subscriptionId environment variable
* name. Default is "AZURE_SUBSCRIPTION_ID".
* @param optionalCallback - The optional callback.
*
* @returns If a callback was passed as the last parameter then it returns void else returns a Promise.
* The callback is called with the resulting ApplicationTokenCredentials or ApplicationTokenCertificateCredentials
* object and a list of associated subscriptions across all the applicable tenants.
*/
export function withAuthFile(): Promise<
ApplicationTokenCredentials | ApplicationTokenCertificateCredentials
>;
export function withAuthFile(
options: LoginWithAuthFileOptions
): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>;
export function withAuthFile(
options: LoginWithAuthFileOptions,
callback: {
(
err: Error,
credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials,
subscriptions: Array<LinkedSubscription>
): void;
}
): void;
export function withAuthFile(callback: any): void;
export function withAuthFile(
options?: LoginWithAuthFileOptions,
callback?: {
(
err: Error,
credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials,
subscriptions: Array<LinkedSubscription>
): void;
}
): any {
if (!callback && typeof options === "function") {
callback = options;
options = undefined;
}
const cb = callback as Function;
if (!callback) {
return withAuthFileWithAuthResponse(options).then((authRes) => {
return authRes.credentials;
});
} else {
msRest.promiseToCallback(withAuthFileWithAuthResponse(options))(
(
err: Error,
authRes: AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>
) => {
if (err) {
return cb(err);
}
return cb(undefined, authRes.credentials, authRes.subscriptions);
}
);
}
}
/**
* Provides a url and code that needs to be copy and pasted in a browser and authenticated over there. If successful, the user will get a DeviceTokenCredentials object and the list of subscriptions associated with that userId across all the applicable tenants.
*
* When using personal accounts, the `domain` property in the `options` parameter is required to be set to the Id of a tenant for that account. Otherwise, the resulting credential will not be able to access the account's resources.
*
* @param options - Object representing optional parameters.
* @param options.clientId - The active directory application client id.
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for an example.
* @param options.tokenAudience - The audience for which the token is requested. Valid value is "graph".If tokenAudience is provided
* then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferably in a guid format).
* @param options.domain - The domain or tenant Id containing this application. Default value is "common".
* @param options.environment - The azure environment to authenticate with. Default environment is "Public Azure".
* @param options.tokenCache - The token cache. Default value is the MemoryCache object from adal.
* @param options.language - The language code specifying how the message should be localized to. Default value "en-us".
* @param options.userCodeResponseLogger - A logger that logs the user code response message required for interactive login. When
* this option is specified the usercode response message will not be logged to console.
* @param optionalCallback - The optional callback.
*
* @returns If a callback was passed as the last parameter then it returns void else returns a Promise.
* The callback is called with the resulting DeviceTokenCredentials object and a list of
* associated subscriptions across all the applicable tenants.
*/
export function interactive(): Promise<DeviceTokenCredentials>;
export function interactive(options: InteractiveLoginOptions): Promise<DeviceTokenCredentials>;
export function interactive(
options: InteractiveLoginOptions,
callback: {
(
err: Error,
credentials: DeviceTokenCredentials,
subscriptions: Array<LinkedSubscription>
): void;
}
): void;
export function interactive(callback: any): void;
export function interactive(
options?: InteractiveLoginOptions,
callback?: {
(
err: Error,
credentials: DeviceTokenCredentials,
subscriptions: Array<LinkedSubscription>
): void;
}
): any {
if (!callback && typeof options === "function") {
callback = options;
options = undefined;
}
const cb = callback as Function;
if (!callback) {
return withInteractiveWithAuthResponse(options).then((authRes) => {
return authRes.credentials;
});
} else {
msRest.promiseToCallback(withInteractiveWithAuthResponse(options))(
(err: Error, authRes: AuthResponse<DeviceTokenCredentials>) => {
if (err) {
return cb(err);
}
return cb(undefined, authRes.credentials, authRes.subscriptions);
}
);
}
}
/**
* Provides an ApplicationTokenCredentials object and the list of subscriptions associated with that servicePrincipalId/clientId across all the applicable tenants.
*
* When using personal accounts, the `domain` parameter is required to be set to the Id of a tenant for that account. Otherwise, the resulting credential will not be able to access the account's resources.
*
* @param clientId - The active directory application client Id also known as the SPN (ServicePrincipal Name).
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for an example.
* @param secret - The application secret for the service principal.
* @param domain - The domain or tenant Id containing this application.
* @param options - Object representing optional parameters.
* @param options.tokenAudience - The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferably in a guid format).
* @param options.environment - The azure environment to authenticate with.
* @param options.tokenCache - The token cache. Default value is the MemoryCache object from adal.
* @param optionalCallback - The optional callback.
*
* @returns If a callback was passed as the last parameter then it returns void else returns a Promise.
* The callback is called with the resulting ApplicationTokenCredentials object and a list of
* associated subscriptions across all the applicable tenants.
*/
export function withServicePrincipalSecret(
clientId: string,
secret: string,
domain: string
): Promise<ApplicationTokenCredentials>;
export function withServicePrincipalSecret(
clientId: string,
secret: string,
domain: string,
options: AzureTokenCredentialsOptions
): Promise<ApplicationTokenCredentials>;
export function withServicePrincipalSecret(
clientId: string,
secret: string,
domain: string,
options: AzureTokenCredentialsOptions,
callback: {
(
err: Error,
credentials: ApplicationTokenCredentials,
subscriptions: Array<LinkedSubscription>
): void;
}
): void;
export function withServicePrincipalSecret(
clientId: string,
secret: string,
domain: string,
callback: any
): void;
export function withServicePrincipalSecret(
clientId: string,
secret: string,
domain: string,
options?: AzureTokenCredentialsOptions,
callback?: {
(
err: Error,
credentials: ApplicationTokenCredentials,
subscriptions: Array<LinkedSubscription>
): void;
}
): any {
if (!callback && typeof options === "function") {
callback = options;
options = undefined;
}
const cb = callback as Function;
if (!callback) {
return withServicePrincipalSecretWithAuthResponse(clientId, secret, domain, options).then(
(authRes) => {
return authRes.credentials;
}
);
} else {
msRest.promiseToCallback(
withServicePrincipalSecretWithAuthResponse(clientId, secret, domain, options)
)((err: Error, authRes: AuthResponse) => {
if (err) {
return cb(err);
}
return cb(undefined, authRes.credentials, authRes.subscriptions);
});
}
}
/**
* Provides an ApplicationTokenCertificateCredentials object and the list of subscriptions associated with that servicePrincipalId/clientId across all the applicable tenants.
*
* When using personal accounts, the `domain` parameter is required to be set to the Id of a tenant for that account. Otherwise, the resulting credential will not be able to access the account's resources.
*
* @param clientId - The active directory application client Id also known as the SPN (ServicePrincipal Name).
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for an example.
* @param certificateStringOrFilePath - A PEM encoded certificate and private key OR an absolute filepath to the .pem file containing that information. For example:
* - CertificateString: "-----BEGIN PRIVATE KEY-----\n<xxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n<yyyyy>\n-----END CERTIFICATE-----\n"
* - CertificateFilePath: **Absolute** file path of the .pem file.
* @param domain - The domain or tenant Id containing this application.
* @param options - Object representing optional parameters.
* @param options.tokenAudience - The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferably in a guid format).
* @param options.environment - The azure environment to authenticate with.
* @param options.tokenCache - The token cache. Default value is the MemoryCache object from adal.
* @param optionalCallback - The optional callback.
*
* @returns If a callback was passed as the last parameter then it returns void else returns a Promise.
* The callback is called with the resulting ApplicationTokenCertificateCredentials object and a list of
* associated subscriptions across all the applicable tenants.
*/
export function withServicePrincipalCertificate(
clientId: string,
certificateStringOrFilePath: string,
domain: string
): Promise<ApplicationTokenCertificateCredentials>;
export function withServicePrincipalCertificate(
clientId: string,
certificateStringOrFilePath: string,
domain: string,
options: AzureTokenCredentialsOptions
): Promise<ApplicationTokenCertificateCredentials>;
export function withServicePrincipalCertificate(
clientId: string,
certificateStringOrFilePath: string,
domain: string,
options: AzureTokenCredentialsOptions,
callback: {
(
err: Error,
credentials: ApplicationTokenCertificateCredentials,
subscriptions: Array<LinkedSubscription>
): void;
}
): void;
export function withServicePrincipalCertificate(
clientId: string,
certificateStringOrFilePath: string,
domain: string,
callback: any
): void;
export function withServicePrincipalCertificate(
clientId: string,
certificateStringOrFilePath: string,
domain: string,
options?: AzureTokenCredentialsOptions,
callback?: {
(
err: Error,
credentials: ApplicationTokenCertificateCredentials,
subscriptions: Array<LinkedSubscription>
): void;
}
): any {
if (!callback && typeof options === "function") {
callback = options;
options = undefined;
}
const cb = callback as Function;
if (!callback) {
return withServicePrincipalCertificateWithAuthResponse(
clientId,
certificateStringOrFilePath,
domain,
options
).then((authRes) => {
return authRes.credentials;
});
} else {
msRest.promiseToCallback(
withServicePrincipalCertificateWithAuthResponse(
clientId,
certificateStringOrFilePath,
domain,
options
)
)((err: Error, authRes: AuthResponse) => {
if (err) {
return cb(err);
}
return cb(undefined, authRes.credentials, authRes.subscriptions);
});
}
}
/**
* Provides a UserTokenCredentials object and the list of subscriptions associated with that userId across all the applicable tenants.
*
* This method is applicable only for organizational ids that are not 2FA enabled otherwise please use interactive login.
*
* When using personal accounts, the `domain` property in the `options` parameter is required to be set to the Id of a tenant for that account. Otherwise, the resulting credential will not be able to access the account's resources.
*
* @param username - The user name for the Organization Id account.
* @param password - The password for the Organization Id account.
* @param options - Object representing optional parameters.
* @param options.clientId - The active directory application client id.
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
* for an example.
* @param options.tokenAudience - The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferably in a guid format).
* @param options.domain - The domain or tenant Id containing this application. Default value "common".
* @param options.environment - The azure environment to authenticate with.
* @param options.tokenCache - The token cache. Default value is the MemoryCache object from adal.
* @param optionalCallback - The optional callback.
*
* @returns If a callback was passed as the last parameter then it returns void else returns a Promise.
* The callback is called with the resulting UserTokenCredentials object and a list of
* associated subscriptions across all the applicable tenants.
*/
export function withUsernamePassword(
username: string,
password: string
): Promise<UserTokenCredentials>;
export function withUsernamePassword(
username: string,
password: string,
options: LoginWithUsernamePasswordOptions
): Promise<UserTokenCredentials>;
export function withUsernamePassword(username: string, password: string, callback: any): void;
export function withUsernamePassword(
username: string,
password: string,
options: LoginWithUsernamePasswordOptions,
callback: {
(err: Error, credentials: UserTokenCredentials, subscriptions: Array<LinkedSubscription>): void;
}
): void;
export function withUsernamePassword(
username: string,
password: string,
options?: LoginWithUsernamePasswordOptions,
callback?: {
(err: Error, credentials: UserTokenCredentials, subscriptions: Array<LinkedSubscription>): void;
}
): any {
if (!callback && typeof options === "function") {
callback = options;
options = undefined;
}
const cb = callback as Function;