-
Notifications
You must be signed in to change notification settings - Fork 865
/
Copy pathSharedCredentialsFile.cs
1079 lines (983 loc) · 54 KB
/
SharedCredentialsFile.cs
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 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.Runtime.CredentialManagement.Internal;
using Amazon.Runtime.Internal.Util;
using Amazon.Runtime;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Diagnostics.CodeAnalysis;
using Amazon.Runtime.Internal;
namespace Amazon.Runtime.CredentialManagement
{
/// <summary>
/// Provides access to read and write to the shared credentials INI file.
/// The file is read, parsed, and validated at construction time.
/// Changes can be made using the RegisterProfile() and
/// UnregisterProfile() methods.
///
/// This class is not threadsafe.
/// </summary>
public class SharedCredentialsFile : ICredentialProfileStore
{
public const string DefaultProfileName = "default";
public const string SharedCredentialsFileEnvVar = "AWS_SHARED_CREDENTIALS_FILE";
public const string SharedConfigFileEnvVar = "AWS_CONFIG_FILE";
private const string ToolkitArtifactGuidField = "toolkit_artifact_guid";
private const string RegionField = "region";
private const string EndpointDiscoveryEnabledField = "endpoint_discovery_enabled";
private const string ConfigFileName = "config";
private const string DefaultDirectoryName = ".aws";
private const string DefaultFileName = "credentials";
private const string DefaultConfigurationModeField = "defaults_mode";
private const string CredentialProcess = "credential_process";
private const string StsRegionalEndpointsField = "sts_regional_endpoints";
private const string S3UseArnRegionField = "s3_use_arn_region";
private const string S3DisableExpressSessionAuthField = "s3_disable_express_session_auth";
private const string S3RegionalEndpointField = "s3_us_east_1_regional_endpoint";
private const string S3DisableMultiRegionAccessPointsField = "s3_disable_multiregion_access_points";
private const string RetryModeField = "retry_mode";
private const string MaxAttemptsField = "max_attempts";
private const string SsoAccountId = "sso_account_id";
private const string SsoRegion = "sso_region";
private const string SsoRegistrationScopes = "sso_registration_scopes";
private const string SsoRoleName = "sso_role_name";
private const string SsoStartUrl = "sso_start_url";
private const string SsoSession = "sso_session";
private const string EC2MetadataServiceEndpointField = "ec2_metadata_service_endpoint";
private const string EC2MetadataServiceEndpointModeField = "ec2_metadata_service_endpoint_mode";
private const string EC2MetadataV1DisabledField = "ec2_metadata_v1_disabled";
private const string UseDualstackEndpointField = "use_dualstack_endpoint";
private const string UseFIPSEndpointField = "use_fips_endpoint";
private const string EndpointUrlField = "endpoint_url";
private const string ServicesField = "services";
private const string IgnoreConfiguredEndpointUrlsField = "ignore_configured_endpoint_urls";
private const string DisableRequestCompressionField = "disable_request_compression";
private const string RequestMinCompressionSizeBytesField = "request_min_compression_size_bytes";
private const string ClientAppIdField = "sdk_ua_app_id";
private const string AccountIdEndpointModeField = "account_id_endpoint_mode";
private const string S3ForcePathStyleField = "s3_force_path_style";
private readonly Logger _logger = Logger.GetLogger(typeof(SharedCredentialsFile));
private static readonly HashSet<string> ReservedPropertyNames = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
{
ToolkitArtifactGuidField,
RegionField,
EndpointDiscoveryEnabledField,
CredentialProcess,
StsRegionalEndpointsField,
S3UseArnRegionField,
S3DisableExpressSessionAuthField,
S3RegionalEndpointField,
S3DisableMultiRegionAccessPointsField,
RetryModeField,
MaxAttemptsField,
SsoAccountId,
SsoRegion,
SsoRegistrationScopes,
SsoRoleName,
SsoStartUrl,
SsoSession,
EC2MetadataServiceEndpointField,
EC2MetadataServiceEndpointModeField,
EC2MetadataV1DisabledField,
UseDualstackEndpointField,
UseFIPSEndpointField,
DefaultConfigurationModeField,
EndpointUrlField,
ServicesField,
IgnoreConfiguredEndpointUrlsField,
DisableRequestCompressionField,
RequestMinCompressionSizeBytesField,
ClientAppIdField,
AccountIdEndpointModeField,
S3ForcePathStyleField
};
/// <summary>
/// To maintain compatibility with the CLI,
/// SharedCredentialsFile doesn't support the SAML profileTypes.
/// </summary>
private static readonly HashSet<CredentialProfileType> ProfileTypeWhitelist =
new HashSet<CredentialProfileType>()
{
CredentialProfileType.AssumeRole,
CredentialProfileType.AssumeRoleWithServices,
CredentialProfileType.AssumeRoleWithGlobalEndpoint,
CredentialProfileType.AssumeRoleWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleCredentialSource,
CredentialProfileType.AssumeRoleCredentialSourceWithGlobalEndpoint,
CredentialProfileType.AssumeRoleCredentialSourceWithServices,
CredentialProfileType.AssumeRoleCredentialSourceWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleExternal,
CredentialProfileType.AssumeRoleExternalWithServices,
CredentialProfileType.AssumeRoleExternalWithGlobalEndpoint,
CredentialProfileType.AssumeRoleExternalWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleExternalMFA,
CredentialProfileType.AssumeRoleExternalMFAWithServices,
CredentialProfileType.AssumeRoleExternalMFAWithGlobalEndpoint,
CredentialProfileType.AssumeRoleExternalMFAWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleMFA,
CredentialProfileType.AssumeRoleMFAWithServices,
CredentialProfileType.AssumeRoleMFAWithGlobalEndpoint,
CredentialProfileType.AssumeRoleMFAWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleWithWebIdentity,
CredentialProfileType.AssumeRoleWithWebIdentityWithServices,
CredentialProfileType.AssumeRoleWithWebIdentityWithGlobalEndpoint,
CredentialProfileType.AssumeRoleWithWebIdentityWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleWithWebIdentitySessionName,
CredentialProfileType.AssumeRoleWithWebIdentitySessionNameWithServices,
CredentialProfileType.AssumeRoleWithWebIdentitySessionNameWithGlobalEndpoint,
CredentialProfileType.AssumeRoleWithWebIdentitySessionNameWithServicesAndGlobalEndpoint,
CredentialProfileType.Basic,
CredentialProfileType.Session,
CredentialProfileType.SessionWithServices,
CredentialProfileType.SessionWithGlobalEndpoint,
CredentialProfileType.SessionWithServicesAndGlobalEndpoint,
CredentialProfileType.CredentialProcess,
CredentialProfileType.AssumeRoleSessionName,
CredentialProfileType.AssumeRoleSessionNameWithServices,
CredentialProfileType.AssumeRoleSessionNameWithGlobalEndpoint,
CredentialProfileType.AssumeRoleSessionNameWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleCredentialSourceSessionName,
CredentialProfileType.AssumeRoleCredentialSourceSessionNameWithServices,
CredentialProfileType.AssumeRoleCredentialSourceSessionNameWithGlobalEndpoint,
CredentialProfileType.AssumeRoleCredentialSourceSessionNameWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleExternalSessionName,
CredentialProfileType.AssumeRoleExternalSessionNameWithServices,
CredentialProfileType.AssumeRoleExternalSessionNameWithGlobalEndpoint,
CredentialProfileType.AssumeRoleExternalSessionNameWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleExternalMFASessionName,
CredentialProfileType.AssumeRoleExternalMFASessionNameWithServices,
CredentialProfileType.AssumeRoleExternalMFASessionNameWithGlobalEndpoint,
CredentialProfileType.AssumeRoleExternalMFASessionNameWithServicesAndGlobalEndpoint,
CredentialProfileType.AssumeRoleMFASessionName,
CredentialProfileType.AssumeRoleMFASessionNameWithServices,
CredentialProfileType.AssumeRoleMFASessionNameWithGlobalEndpoint,
CredentialProfileType.AssumeRoleMFASessionNameWithServicesAndGlobalEndpoint,
CredentialProfileType.BasicWithGlobalEndpoint,
CredentialProfileType.BasicWithServices,
CredentialProfileType.BasicWithServicesAndGlobalEndpoint,
#if !BCL35
CredentialProfileType.SSO,
#endif
};
private static readonly CredentialProfilePropertyMapping PropertyMapping =
new CredentialProfilePropertyMapping(
new Dictionary<string, string>()
{
{ "AccessKey", "aws_access_key_id" },
{ "CredentialSource", "credential_source" },
{ "EndpointName", null },
{ "ExternalID", "external_id" },
{ "MfaSerial", "mfa_serial" },
{ "RoleArn", "role_arn" },
{ "RoleSessionName", "role_session_name" },
{ "SecretKey", "aws_secret_access_key" },
{ "SourceProfile", "source_profile" },
{ "Token", "aws_session_token" },
{ "UserIdentity", null },
{ "CredentialProcess" , "credential_process" },
{ "WebIdentityTokenFile", "web_identity_token_file" },
{ "Services", "services" },
{ "EndpointUrl", "endpoint_url" },
#if !BCL35
{ nameof(CredentialProfileOptions.SsoAccountId), SsoAccountId },
{ nameof(CredentialProfileOptions.SsoRegion), SsoRegion },
{ nameof(CredentialProfileOptions.SsoRegistrationScopes), SsoRegistrationScopes },
{ nameof(CredentialProfileOptions.SsoRoleName), SsoRoleName },
{ nameof(CredentialProfileOptions.SsoSession), SsoSession },
{ nameof(CredentialProfileOptions.SsoStartUrl), SsoStartUrl },
#endif
}
);
/// <summary>
/// The default directory for the credentials file. By default it searches in ~/.aws. This behavior can be overridden.
/// </summary>
public static readonly string DefaultDirectory;
/// <summary>
/// The default file path for the credentials file. By default it searches for ~/.aws/credentials. This behavior can be overriden.
/// </summary>
public static string DefaultFilePath { get; private set; }
/// <summary>
/// The default directory for the config file. By default it searches in ~/.aws This behavior can be overriden.
/// </summary>
public static readonly string DefaultConfigDirectory;
/// <summary>
/// The default file path for the config file. By default it searches in ~/.aws/config
/// </summary>
public static string DefaultConfigFilePath { get; private set; }
static SharedCredentialsFile()
{
var awsCredentialsEnvironmentPath = Environment.GetEnvironmentVariable(SharedCredentialsFileEnvVar);
var awsConfigEnvironmentPath = Environment.GetEnvironmentVariable(SharedConfigFileEnvVar);
if (!string.IsNullOrEmpty(awsConfigEnvironmentPath))
{
if (File.Exists(awsConfigEnvironmentPath))
{
DefaultConfigDirectory = Directory.GetParent(awsConfigEnvironmentPath).FullName;
DefaultConfigFilePath = awsConfigEnvironmentPath;
}
}
if (!string.IsNullOrEmpty(awsCredentialsEnvironmentPath))
{
if (File.Exists(awsCredentialsEnvironmentPath))
{
DefaultDirectory = Directory.GetParent(awsCredentialsEnvironmentPath).FullName;
DefaultFilePath = awsCredentialsEnvironmentPath;
}
}
if (DefaultFilePath == null || DefaultConfigFilePath == null)
{
var baseDirectory = Environment.GetEnvironmentVariable("HOME");
if (string.IsNullOrEmpty(baseDirectory))
baseDirectory = Environment.GetEnvironmentVariable("USERPROFILE");
if (string.IsNullOrEmpty(baseDirectory))
#if NETSTANDARD
baseDirectory = Directory.GetCurrentDirectory();
#else
baseDirectory = Environment.CurrentDirectory;
#endif
if (DefaultFilePath == null)
{
DefaultDirectory = Path.Combine(baseDirectory, DefaultDirectoryName);
DefaultFilePath = Path.Combine(DefaultDirectory, DefaultFileName);
}
if (DefaultConfigFilePath == null)
{
DefaultConfigDirectory = Path.Combine(baseDirectory, DefaultDirectoryName);
DefaultConfigFilePath = Path.Combine(DefaultConfigDirectory, ConfigFileName);
}
}
}
private ProfileIniFile _credentialsFile;
private ProfileIniFile _configFile;
/// <summary>
/// The path to the credentials file
/// </summary>
public string FilePath { get; private set; }
/// <summary>
/// The path to the config file
/// </summary>
public string ConfigFilePath { get; private set; }
/// <summary>
/// Construct a new SharedCredentialsFile in the default location.
/// </summary>
public SharedCredentialsFile()
{
SetUpFilePath(null);
Refresh();
}
/// <summary>
/// Construct a new SharedCredentialsFile.
/// </summary>
/// <param name="filePath">The path of the shared credentials file.</param>
public SharedCredentialsFile(string filePath)
{
SetUpFilePath(filePath);
Refresh();
}
/// <summary>
/// SetUpFilePath sets FilePath and ConfigFilePath using the DefaultFilePath and DefaultConfigFilePath set in
/// the static constructor. If AWSConfigs.AWSProfilesLocation is provided, FilePath supercedes DefaultFilePath
/// </summary>
/// <param name="filePath"></param>
private void SetUpFilePath(string filePath)
{
if (string.IsNullOrEmpty(filePath))
{
if (string.IsNullOrEmpty(AWSConfigs.AWSProfilesLocation))
{
FilePath = DefaultFilePath;
ConfigFilePath = DefaultConfigFilePath;
}
else
{
FilePath = AWSConfigs.AWSProfilesLocation;
ConfigFilePath = DefaultConfigFilePath;
}
}
else
{
FilePath = filePath;
ConfigFilePath = DefaultConfigFilePath;
}
}
public List<string> ListProfileNames()
{
Refresh();
return ListProfiles().Select(p => p.Name).ToList();
}
public List<CredentialProfile> ListProfiles()
{
Refresh();
var profiles = new List<CredentialProfile>();
foreach (var profileName in ListAllProfileNames())
{
CredentialProfile profile = null;
if (TryGetProfile(profileName, doRefresh: false, isSsoSession: false,isServicesSection: false, out profile) && profile.CanCreateAWSCredentials)
{
profiles.Add(profile);
}
}
return profiles;
}
public bool TryGetProfile(string profileName, out CredentialProfile profile)
{
return TryGetProfile(profileName, doRefresh: true, isSsoSession: false, isServicesSection: false, out profile);
}
/// <summary>
/// Add the profile given. If the profile already exists, update it.
/// </summary>
/// <param name="profile">The profile to be written.</param>
public void RegisterProfile(CredentialProfile profile)
{
Refresh();
if (profile.CanCreateAWSCredentials || profile.Options.IsEmpty)
{
if (!IsSupportedProfileType(profile.ProfileType))
{
throw new ArgumentException(string.Format(CultureInfo.InvariantCulture,
"Unable to update profile {0}. The CredentialProfile object provided represents a " +
"{1} profile but {2} does not support the {1} profile type.",
profile.Name, profile.ProfileType, GetType().Name));
}
RegisterProfileInternal(profile);
}
else
{
throw new ArgumentException(String.Format(CultureInfo.InvariantCulture,
"Unable to update profile {0}. The CredentialProfile provided is not a valid profile.", profile.Name));
}
}
/// <summary>
/// Update the profile on disk regardless of the profile type.
/// </summary>
/// <param name="profile"></param>
[SuppressMessage("Microsoft.Globalization", "CA1308", Justification = "Value is not surfaced to user. Booleans have been lowercased by SDK precedent.")]
private void RegisterProfileInternal(CredentialProfile profile)
{
var reservedProperties = new Dictionary<string, string>();
if (profile.UniqueKey != null)
reservedProperties[ToolkitArtifactGuidField] = profile.UniqueKey.Value.ToString("D");
if (profile.Region != null)
reservedProperties[RegionField] = profile.Region.SystemName;
if (profile.EndpointDiscoveryEnabled != null)
reservedProperties[EndpointDiscoveryEnabledField] = profile.EndpointDiscoveryEnabled.Value.ToString().ToLowerInvariant();
if (profile.StsRegionalEndpoints != null)
reservedProperties[StsRegionalEndpointsField] = profile.StsRegionalEndpoints.ToString().ToLowerInvariant();
if (profile.S3UseArnRegion != null)
reservedProperties[S3UseArnRegionField] = profile.S3UseArnRegion.Value.ToString().ToLowerInvariant();
if (profile.S3DisableExpressSessionAuth != null)
reservedProperties[S3DisableExpressSessionAuthField] = profile.S3DisableExpressSessionAuth.Value.ToString().ToLowerInvariant();
if (profile.S3RegionalEndpoint != null)
reservedProperties[S3RegionalEndpointField] = profile.S3RegionalEndpoint.ToString().ToLowerInvariant();
if (profile.S3DisableMultiRegionAccessPoints != null)
reservedProperties[S3DisableMultiRegionAccessPointsField] = profile.S3DisableMultiRegionAccessPoints.ToString().ToLowerInvariant();
if (profile.RetryMode != null)
reservedProperties[RetryModeField] = profile.RetryMode.ToString().ToLowerInvariant();
if (profile.MaxAttempts != null)
reservedProperties[MaxAttemptsField] = profile.MaxAttempts.ToString().ToLowerInvariant();
if (profile.EC2MetadataServiceEndpoint != null)
reservedProperties[EC2MetadataServiceEndpointField] = profile.EC2MetadataServiceEndpoint.ToString().ToLowerInvariant();
if (profile.EC2MetadataServiceEndpointMode != null)
reservedProperties[EC2MetadataServiceEndpointModeField] = profile.EC2MetadataServiceEndpointMode.ToString().ToLowerInvariant();
if (profile.EC2MetadataV1Disabled != null)
reservedProperties[EC2MetadataV1DisabledField] = profile.EC2MetadataV1Disabled.ToString().ToLowerInvariant();
if (profile.UseDualstackEndpoint != null)
reservedProperties[UseDualstackEndpointField] = profile.UseDualstackEndpoint.ToString().ToLowerInvariant();
if (profile.UseFIPSEndpoint != null)
reservedProperties[UseFIPSEndpointField] = profile.UseFIPSEndpoint.ToString().ToLowerInvariant();
if(profile.IgnoreConfiguredEndpointUrls != null)
reservedProperties[IgnoreConfiguredEndpointUrlsField] = profile.IgnoreConfiguredEndpointUrls.ToString().ToLowerInvariant();
if(profile.EndpointUrl != null)
reservedProperties[EndpointUrlField] = profile.EndpointUrl.ToString().ToLowerInvariant();
if (profile.DisableRequestCompression != null)
reservedProperties[DisableRequestCompressionField] = profile.DisableRequestCompression.ToString().ToLowerInvariant();
if (profile.RequestMinCompressionSizeBytes != null)
reservedProperties[RequestMinCompressionSizeBytesField] = profile.RequestMinCompressionSizeBytes.ToString().ToLowerInvariant();
if (profile.ClientAppId != null)
reservedProperties[ClientAppIdField] = profile.ClientAppId;
if (profile.AccountIdEndpointMode != null)
reservedProperties[AccountIdEndpointModeField] = profile.AccountIdEndpointMode.ToString().ToLowerInvariant();
if (profile.S3ForcePathStyle != null)
reservedProperties[S3ForcePathStyleField] = profile.S3ForcePathStyle.ToString().ToLowerInvariant();
var profileDictionary = PropertyMapping.CombineProfileParts(
profile.Options, ReservedPropertyNames, reservedProperties, profile.Properties);
// The config file might contain parts of the profile
// These parts are updated at the config file and removed from profileDictionary to avoid duplication
UpdateConfigSectionsFromProfile(profile, profileDictionary);
_credentialsFile.EditSection(profile.Name, new SortedDictionary<string, string>(profileDictionary));
_credentialsFile.Persist();
profile.CredentialProfileStore = this;
}
private void UpdateConfigSectionsFromProfile(CredentialProfile profile, Dictionary<string, string> profileDictionary)
{
if (_configFile == null || !_configFile.TryGetSection(profile.Name, out var configProperties))
return;
var configPropertiesNames = configProperties.Keys.ToArray();
foreach (var propertyName in configPropertiesNames)
{
if (profileDictionary.ContainsKey(propertyName))
{
configProperties[propertyName] = profileDictionary[propertyName];
profileDictionary.Remove(propertyName); // Remove the property from profileDictionary as we updated it in the config
}
else
{
configProperties[propertyName] = null;
}
}
_configFile.EditSection(profile.Name, new SortedDictionary<string, string>(configProperties));
_configFile.Persist();
if (configProperties.TryGetValue(SsoSession, out var session)
&& _configFile.TryGetSection(session, true, false, out var ssoSessionProperties, out _))
{
// Skip SsoSession properties as it might be used by other profiles
var ssoSessionPropertiesNames = ssoSessionProperties.Keys.ToArray();
foreach (var propertyName in ssoSessionPropertiesNames)
{
profileDictionary.Remove(propertyName);
}
}
}
/// <summary>
/// Deletes the section with the given ProfileName from the SharedCredentialsFile, if one exists.
/// </summary>
/// <param name="profileName">The ProfileName of the section to delete.</param>
public void UnregisterProfile(string profileName)
{
Refresh();
_credentialsFile.DeleteSection(profileName);
_credentialsFile.Persist();
}
/// <summary>
/// Rename the profile with oldProfileName to newProfileName.
/// </summary>
/// <param name="oldProfileName">The profile to rename.</param>
/// <param name="newProfileName">The new name for the profile.</param>
public void RenameProfile(string oldProfileName, string newProfileName)
{
RenameProfile(oldProfileName, newProfileName, false);
}
/// <summary>
/// Rename the profile with oldProfileName to newProfileName.
/// </summary>
/// <param name="oldProfileName">The profile to rename.</param>
/// <param name="newProfileName">The new name for the profile.</param>
/// <param name="force">If true and the destination profile exists it will be overwritten.</param>
public void RenameProfile(string oldProfileName, string newProfileName, bool force)
{
Refresh();
_credentialsFile.RenameSection(oldProfileName, newProfileName, force);
_credentialsFile.Persist();
}
/// <summary>
/// Make a copy of the profile with fromProfileName called toProfileName.
/// </summary>
/// <param name="fromProfileName">The name of the profile to copy from.</param>
/// <param name="toProfileName">The name of the new profile.</param>
public void CopyProfile(string fromProfileName, string toProfileName)
{
CopyProfile(fromProfileName, toProfileName, false);
}
/// <summary>
/// Make a copy of the profile with fromProfileName called toProfileName.
/// </summary>
/// <param name="fromProfileName">The name of the profile to copy from.</param>
/// <param name="toProfileName">The name of the new profile.</param>
/// <param name="force">If true and the destination profile exists it will be overwritten.</param>
public void CopyProfile(string fromProfileName, string toProfileName, bool force)
{
Refresh();
// Do the copy but make sure to replace the toolkitArtifactGuid with a new one, if it's there.
_credentialsFile.CopySection(fromProfileName, toProfileName,
new Dictionary<string, string> { { ToolkitArtifactGuidField, Guid.NewGuid().ToString() } }, force);
_credentialsFile.Persist();
}
private void Refresh()
{
_credentialsFile = new ProfileIniFile(FilePath, false);
//Re-check if they set an explicit config file path, use that if it's set
var awsConfigEnvironmentPath = Environment.GetEnvironmentVariable(SharedConfigFileEnvVar);
if (!string.IsNullOrEmpty(awsConfigEnvironmentPath))
{
_configFile = new ProfileIniFile(ConfigFilePath, true);
}
// If a config file exists in the same location as the credentials file and no env vars are set
// load it for use as a read-only source of profile properties.
else
{
var configPath = Path.Combine(Path.GetDirectoryName(FilePath), ConfigFileName);
if (File.Exists(configPath))
{
_configFile = new ProfileIniFile(configPath, true);
}
}
}
private HashSet<string> ListAllProfileNames()
{
var profileNames = _credentialsFile.ListSectionNames();
if (_configFile != null)
{
profileNames.UnionWith(_configFile.ListSectionNames());
}
return profileNames;
}
private bool TryGetProfile(string profileName, bool doRefresh, bool isSsoSession, bool isServicesSection, out CredentialProfile profile)
{
if (doRefresh)
{
Refresh();
}
Dictionary<string, Dictionary<string, string>> nestedProperties = null;
Dictionary<string, string> profileDictionary = null;
if (TryGetSection(profileName, isSsoSession, isServicesSection, out profileDictionary, out nestedProperties))
{
CredentialProfileOptions profileOptions;
Dictionary<string, string> reservedProperties;
Dictionary<string, string> userProperties;
PropertyMapping.ExtractProfileParts(
profileDictionary,
ReservedPropertyNames,
out profileOptions,
out reservedProperties,
out userProperties);
string toolkitArtifactGuidStr;
Guid? toolkitArtifactGuid = null;
if (reservedProperties.TryGetValue(ToolkitArtifactGuidField, out toolkitArtifactGuidStr))
{
if (!GuidUtils.TryParseNullableGuid(toolkitArtifactGuidStr, out toolkitArtifactGuid))
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. GUID expected.", toolkitArtifactGuidStr, ToolkitArtifactGuidField, profileName);
profile = null;
return false;
}
}
string ignoreConfiguredEndpointUrlsString;
bool? ignoreConfiguredEndpointUrls = false;
if(reservedProperties.TryGetValue(IgnoreConfiguredEndpointUrlsField, out ignoreConfiguredEndpointUrlsString))
{
bool ignoreConfiguredEndpointUrlsOut;
if(!bool.TryParse(ignoreConfiguredEndpointUrlsString, out ignoreConfiguredEndpointUrlsOut))
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A boolean true/false is expected", ignoreConfiguredEndpointUrlsString, IgnoreConfiguredEndpointUrlsField, profileName);
profile = null;
return false;
}
else
{
ignoreConfiguredEndpointUrls = ignoreConfiguredEndpointUrlsOut;
}
}
string endpointUrlString = null;
if (ignoreConfiguredEndpointUrls == false)
{
string services;
if (profileDictionary.TryGetValue(ServicesField, out services))
{
_configFile.TryGetSection(services, isSsoSession: false, isServicesSection: true, out userProperties, out nestedProperties);
}
else
{
string endpointUrlTemp;
if (profileDictionary.TryGetValue(EndpointUrlField, out endpointUrlTemp))
endpointUrlString = endpointUrlTemp;
}
}
string regionString;
RegionEndpoint region = null;
if (reservedProperties.TryGetValue(RegionField, out regionString))
{
region = RegionEndpoint.GetBySystemName(regionString);
}
string endpointDiscoveryEnabledString;
bool? endpointDiscoveryEnabled = null;
if (reservedProperties.TryGetValue(EndpointDiscoveryEnabledField, out endpointDiscoveryEnabledString))
{
bool endpointDiscoveryEnabledOut;
if (!bool.TryParse(endpointDiscoveryEnabledString, out endpointDiscoveryEnabledOut))
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A boolean true/false is expected.", endpointDiscoveryEnabledString, EndpointDiscoveryEnabledField, profileName);
profile = null;
return false;
}
endpointDiscoveryEnabled = endpointDiscoveryEnabledOut;
}
StsRegionalEndpointsValue? stsRegionalEndpoints = null;
if (reservedProperties.TryGetValue(StsRegionalEndpointsField, out var stsRegionalEndpointsString))
{
#if BCL35
try
{
stsRegionalEndpoints = (StsRegionalEndpointsValue) Enum.Parse(typeof(StsRegionalEndpointsValue), stsRegionalEndpointsString, true);
}
catch (Exception)
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string regional/legacy is expected.", stsRegionalEndpointsString, StsRegionalEndpointsField, profileName);
profile = null;
return false;
}
#else
if (!Enum.TryParse<StsRegionalEndpointsValue>(stsRegionalEndpointsString, true, out var stsRegionalEndpointsTemp))
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string regional/legacy is expected.", stsRegionalEndpointsString, StsRegionalEndpointsField, profileName);
profile = null;
return false;
}
stsRegionalEndpoints = stsRegionalEndpointsTemp;
#endif
}
string s3UseArnRegionString;
bool? s3UseArnRegion = null;
if (reservedProperties.TryGetValue(S3UseArnRegionField, out s3UseArnRegionString))
{
bool s3UseArnRegionOut;
if (!bool.TryParse(s3UseArnRegionString, out s3UseArnRegionOut))
{
profile = null;
return false;
}
s3UseArnRegion = s3UseArnRegionOut;
}
string s3DisableExpressSessionAuthString;
bool? s3DisableExpressSessionAuth = null;
if (reservedProperties.TryGetValue(S3DisableExpressSessionAuthField, out s3DisableExpressSessionAuthString))
{
bool s3DisableExpressSessionAuthOut;
if (!bool.TryParse(s3DisableExpressSessionAuthString, out s3DisableExpressSessionAuthOut))
{
profile = null;
return false;
}
s3DisableExpressSessionAuth = s3DisableExpressSessionAuthOut;
}
S3UsEast1RegionalEndpointValue? s3RegionalEndpoint = null;
if (reservedProperties.TryGetValue(S3RegionalEndpointField, out var s3RegionalEndpointString))
{
#if BCL35
try
{
s3RegionalEndpoint = (S3UsEast1RegionalEndpointValue) Enum.Parse(typeof(S3UsEast1RegionalEndpointValue), s3RegionalEndpointString, true);
}
catch (Exception)
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string regional/legacy is expected.", s3RegionalEndpointString, S3RegionalEndpointField, profileName);
profile = null;
return false;
}
#else
if (!Enum.TryParse<S3UsEast1RegionalEndpointValue>(s3RegionalEndpointString, true, out var s3RegionalEndpointTemp))
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string regional/legacy is expected.", s3RegionalEndpointString, S3RegionalEndpointField, profileName);
profile = null;
return false;
}
s3RegionalEndpoint = s3RegionalEndpointTemp;
#endif
}
string s3DisableMultiRegionAccessPointsString;
bool? s3DisableMultiRegionAccessPoints = null;
if (reservedProperties.TryGetValue(S3DisableMultiRegionAccessPointsField, out s3DisableMultiRegionAccessPointsString))
{
bool s3DisableMultiRegionAccessPointsOut;
if (!bool.TryParse(s3DisableMultiRegionAccessPointsString, out s3DisableMultiRegionAccessPointsOut))
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A boolean true/false is expected.", s3DisableMultiRegionAccessPointsString, S3DisableMultiRegionAccessPointsField, profileName);
profile = null;
return false;
}
s3DisableMultiRegionAccessPoints = s3DisableMultiRegionAccessPointsOut;
}
RequestRetryMode? requestRetryMode = null;
if (reservedProperties.TryGetValue(RetryModeField, out var retryModeString))
{
#if BCL35
try
{
requestRetryMode = (RequestRetryMode) Enum.Parse(typeof(RequestRetryMode), retryModeString, true);
}
catch (Exception)
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string legacy/standard/adaptive is expected.", retryModeString, RetryModeField, profileName);
profile = null;
return false;
}
#else
if (!Enum.TryParse<RequestRetryMode>(retryModeString, true, out var retryModeTemp))
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string legacy/standard/adaptive is expected.", retryModeString, RetryModeField, profileName);
profile = null;
return false;
}
requestRetryMode = retryModeTemp;
#endif
}
int? maxAttempts = null;
if (reservedProperties.TryGetValue(MaxAttemptsField, out var maxAttemptsString))
{
if (!int.TryParse(maxAttemptsString, out var maxAttemptsTemp) || maxAttemptsTemp <= 0)
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A positive integer is expected.", maxAttemptsString, MaxAttemptsField, profileName);
profile = null;
return false;
}
maxAttempts = maxAttemptsTemp;
}
string defaultConfigurationModeName;
reservedProperties.TryGetValue(DefaultConfigurationModeField, out defaultConfigurationModeName);
string ec2MetadataServiceEndpoint;
if (reservedProperties.TryGetValue(EC2MetadataServiceEndpointField, out ec2MetadataServiceEndpoint))
{
if (!Uri.IsWellFormedUriString(ec2MetadataServiceEndpoint, UriKind.Absolute))
{
throw new AmazonClientException($"Invalid value {ec2MetadataServiceEndpoint} for {EC2MetadataServiceEndpointField} in profile {profileName}. A well-formed Uri is expected.");
}
}
EC2MetadataServiceEndpointMode? ec2MetadataServiceEndpointMode = null;
if (reservedProperties.TryGetValue(EC2MetadataServiceEndpointModeField, out var ec2MetadataServiceEndpointModeString))
{
#if BCL35
try
{
ec2MetadataServiceEndpointMode = (EC2MetadataServiceEndpointMode)Enum.Parse(typeof(EC2MetadataServiceEndpointMode), ec2MetadataServiceEndpointModeString, true);
}
catch (Exception)
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string IPv4 or IPV6 is expected.", ec2MetadataServiceEndpointModeString, EC2MetadataServiceEndpointModeField, profileName);
profile = null;
return false;
}
#else
if (!Enum.TryParse<EC2MetadataServiceEndpointMode>(ec2MetadataServiceEndpointModeString, true, out var ec2MetadataServiceEndpointModeTemp))
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string IPv4 or IPV6 is expected.", ec2MetadataServiceEndpointModeString, EC2MetadataServiceEndpointModeField, profileName);
profile = null;
return false;
}
ec2MetadataServiceEndpointMode = ec2MetadataServiceEndpointModeTemp;
#endif
}
#if !BCL35
if (profileDictionary.TryGetValue(SsoSession, out var session))
{
profileOptions.SsoSession = session;
if (TryGetProfile(session, doRefresh: false, isSsoSession: true, isServicesSection:false, out var sessionProfile))
{
profileOptions.SsoRegion = sessionProfile.Options.SsoRegion;
profileOptions.SsoRegistrationScopes = sessionProfile.Options.SsoRegistrationScopes;
profileOptions.SsoStartUrl = sessionProfile.Options.SsoStartUrl;
}
else
{
_logger.InfoFormat($"Failed to find {SsoSession} [{session}]");
throw new AmazonClientException($"Invalid Configuration. Failed to find {SsoSession} [{session}]");
}
}
#endif
string ec2MetadataV1DisabledString;
bool? ec2MetadataV1Disabled = null;
if (reservedProperties.TryGetValue(EC2MetadataV1DisabledField, out ec2MetadataV1DisabledString))
{
bool ec2MetadataV1DisabledOut;
if (!bool.TryParse(ec2MetadataV1DisabledString, out ec2MetadataV1DisabledOut))
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A boolean true/false is expected.", ec2MetadataV1DisabledString, EC2MetadataV1DisabledField, profileName);
profile = null;
return false;
}
ec2MetadataV1Disabled = ec2MetadataV1DisabledOut;
}
string useDualstackEndpointString;
bool? useDualstackEndpoint = null;
if (reservedProperties.TryGetValue(UseDualstackEndpointField, out useDualstackEndpointString))
{
bool useDualstackEndpointOut;
if (!bool.TryParse(useDualstackEndpointString, out useDualstackEndpointOut))
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A boolean true/false is expected.", useDualstackEndpointString, UseDualstackEndpointField, profileName);
profile = null;
return false;
}
useDualstackEndpoint = useDualstackEndpointOut;
}
string useFIPSEndpointString;
bool? useFIPSEndpoint = null;
if (reservedProperties.TryGetValue(UseFIPSEndpointField, out useFIPSEndpointString))
{
bool useFIPSEndpointOut;
if (!bool.TryParse(useFIPSEndpointString, out useFIPSEndpointOut))
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A boolean true/false is expected.", useFIPSEndpointString, UseFIPSEndpointField, profileName);
profile = null;
return false;
}
useFIPSEndpoint = useFIPSEndpointOut;
}
string disableRequestCompressionString;
bool? disableRequestCompression = null;
if (reservedProperties.TryGetValue(DisableRequestCompressionField, out disableRequestCompressionString))
{
bool disableRequestCompressionOut;
if (!bool.TryParse(disableRequestCompressionString, out disableRequestCompressionOut))
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A boolean true/false is expected.", disableRequestCompressionString, DisableRequestCompressionField, profileName);
profile = null;
return false;
}
disableRequestCompression = disableRequestCompressionOut;
}
string requestMinCompressionSizeBytesString;
long? requestMinCompressionSizeBytes = null;
if (reservedProperties.TryGetValue(RequestMinCompressionSizeBytesField, out requestMinCompressionSizeBytesString))
{
long requestMinCompressionSizeBytesOut;
if (!long.TryParse(requestMinCompressionSizeBytesString, out requestMinCompressionSizeBytesOut)
|| requestMinCompressionSizeBytesOut < 0 || requestMinCompressionSizeBytesOut > ClientConfig.UpperLimitCompressionSizeBytes)
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A long value between 0 and {3} bytes inclusive is expected.",
requestMinCompressionSizeBytesString, RequestMinCompressionSizeBytesField, profileName, ClientConfig.UpperLimitCompressionSizeBytes);
profile = null;
return false;
}
requestMinCompressionSizeBytes = requestMinCompressionSizeBytesOut;
}
string clientAppId = null;
if (reservedProperties.TryGetValue(ClientAppIdField, out clientAppId))
{
if (clientAppId != null && clientAppId.Length > EnvironmentVariableInternalConfiguration.AWS_SDK_UA_APP_ID_MAX_LENGTH)
{
Logger.GetLogger(GetType()).InfoFormat("Warning: Client app id in profile {0} exceeds recommended maximum length of {1} characters: \"{2}\"",
profileName, EnvironmentVariableInternalConfiguration.AWS_SDK_UA_APP_ID_MAX_LENGTH, clientAppId);
}
}
AccountIdEndpointMode? accountIdEndpointMode = null;
if (reservedProperties.TryGetValue(AccountIdEndpointModeField, out var accountIdEndpointModeString))
{
#if BCL35
try
{
accountIdEndpointMode = (AccountIdEndpointMode)Enum.Parse(typeof(AccountIdEndpointMode), accountIdEndpointModeString, true);
}
catch (Exception)
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string preferred/disabled/required is expected.", accountIdEndpointModeString, AccountIdEndpointModeField, profileName);
profile = null;
return false;
}
#else
if (!Enum.TryParse<AccountIdEndpointMode>(accountIdEndpointModeString, true, out var accountIdEndpointModeTemp))
{
_logger.InfoFormat("Invalid value {0} for {1} in profile {2}. A string preferred/disabled/required is expected.", accountIdEndpointModeString, AccountIdEndpointModeField, profileName);
profile = null;
return false;
}
accountIdEndpointMode = accountIdEndpointModeTemp;
#endif
}
string s3ForcePathStyleString;
bool? s3ForcePathStyle = null;
if (reservedProperties.TryGetValue(S3ForcePathStyleField, out s3ForcePathStyleString))
{
bool s3ForcePathStyleOut;
if (!bool.TryParse(s3ForcePathStyleString, out s3ForcePathStyleOut))
{
Logger.GetLogger(GetType()).InfoFormat("Invalid value {0} for {1} in profile {2}. A boolean true/false is expected.", s3ForcePathStyleString, S3ForcePathStyleField, profileName);
profile = null;
return false;
}
s3ForcePathStyle = s3ForcePathStyleOut;
}
profile = new CredentialProfile(profileName, profileOptions)
{
UniqueKey = toolkitArtifactGuid,
Properties = userProperties,
Region = region,
CredentialProfileStore = this,
DefaultConfigurationModeName = defaultConfigurationModeName,
EndpointDiscoveryEnabled = endpointDiscoveryEnabled,
StsRegionalEndpoints = stsRegionalEndpoints,
S3UseArnRegion = s3UseArnRegion,
S3DisableExpressSessionAuth = s3DisableExpressSessionAuth,