-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathClientConfiguration.cpp
More file actions
653 lines (584 loc) · 29.1 KB
/
ClientConfiguration.cpp
File metadata and controls
653 lines (584 loc) · 29.1 KB
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
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/core/Version.h>
#include <aws/core/auth/AWSCredentialsProvider.h>
#include <aws/core/client/AdaptiveRetryStrategy.h>
#include <aws/core/client/ClientConfiguration.h>
#include <aws/core/client/DefaultRetryStrategy.h>
#include <aws/core/config/AWSProfileConfigLoader.h>
#include <aws/core/config/defaults/ClientConfigurationDefaults.h>
#include <aws/core/platform/Environment.h>
#include <aws/core/platform/OSVersionInfo.h>
#include <aws/core/utils/StringUtils.h>
#include <aws/core/utils/logging/LogMacros.h>
#include <aws/core/utils/memory/AWSMemory.h>
#include <aws/core/utils/memory/stl/AWSStringStream.h>
#include <aws/core/utils/threading/Executor.h>
#include <aws/crt/Config.h>
#include <smithy/tracing/NoopTelemetryProvider.h>
#include <array>
namespace Aws
{
namespace Auth
{
AWS_CORE_API Aws::String GetConfigProfileFilename();
}
namespace Client
{
static const char* CLIENT_CONFIG_TAG = "ClientConfiguration";
static const char* DISABLE_REQUEST_COMPRESSION_ENV_VAR = "DISABLE_REQUEST_COMPRESSION";
static const char* DISABLE_REQUEST_COMPRESSION_CONFIG_VAR = "disable_request_compression";
static const char* REQUEST_MIN_COMPRESSION_SIZE_BYTES_ENV_VAR = "REQUEST_MIN_COMPRESSION_SIZE_BYTES";
static const char* REQUEST_MIN_COMPRESSION_SIZE_BYTES_CONFIG_VAR = "request_min_compression_size_bytes";
static const char* AWS_EXECUTION_ENV = "AWS_EXECUTION_ENV";
static const char* DISABLE_IMDSV1_CONFIG_VAR = "AWS_EC2_METADATA_V1_DISABLED";
static const char* DISABLE_IMDSV1_ENV_VAR = "ec2_metadata_v1_disabled";
static const char* AWS_ACCOUNT_ID_ENDPOINT_MODE_ENVIRONMENT_VARIABLE = "AWS_ACCOUNT_ID_ENDPOINT_MODE";
static const char* AWS_ACCOUNT_ID_ENDPOINT_MODE_CONFIG_FILE_OPTION = "account_id_endpoint_mode";
static const char* AWS_METADATA_SERVICE_TIMEOUT_ENV_VAR = "AWS_METADATA_SERVICE_TIMEOUT";
static const char* AWS_METADATA_SERVICE_TIMEOUT_CONFIG_VAR = "metadata_service_timeout";
static const char* AWS_METADATA_SERVICE_NUM_ATTEMPTS_ENV_VAR = "AWS_METADATA_SERVICE_NUM_ATTEMPTS";
static const char* AWS_METADATA_SERVICE_NUM_ATTEMPTS_CONFIG_VAR = "metadata_service_num_attempts";
static const char* AWS_IAM_ROLE_ARN_ENV_VAR = "AWS_ROLE_ARN";
static const char* AWS_IAM_ROLE_ARN_ENV_VAR_COMPAT = "AWS_IAM_ROLE_ARN";
static const char* AWS_IAM_ROLE_ARN_CONFIG_FILE_OPTION = "role_arn";
static const char* AWS_IAM_ROLE_SESSION_NAME_ENV_VAR = "AWS_ROLE_SESSION_NAME";
static const char* AWS_IAM_ROLE_SESSION_NAME_ENV_VAR_COMPAT = "AWS_IAM_ROLE_SESSION_NAME";
static const char* AWS_IAM_ROLE_SESSION_NAME_CONFIG_FILE_OPTION = "role_session_name";
static const char* AWS_WEB_IDENTITY_TOKEN_FILE_ENV_VAR = "AWS_WEB_IDENTITY_TOKEN_FILE";
static const char* AWS_WEB_IDENTITY_TOKEN_FILE_CONFIG_FILE_OPTION = "web_identity_token_file";
static const char* AWS_LOGIN_SESSION_FILE_OPTION = "login_session";
static const char* AWS_LOGIN_CACHE_DIRECTORY_ENV_VAR = "AWS_LOGIN_CACHE_DIRECTORY";
static const char* AWS_AUTH_SCHEME_PREFERENCE = "AWS_AUTH_SCHEME_PREFERENCE";
static const char* AWS_SIGV4A_SIGNING_REGION_SET_ENV_VAR = "AWS_SIGV4A_SIGNING_REGION_SET";
static const char* AWS_SIGV4A_SIGNING_REGION_SET_CONFIG_VAR = "sigv4a_signing_region_set";
using RequestChecksumConfigurationEnumMapping = std::pair<const char*, RequestChecksumCalculation>;
static const std::array<RequestChecksumConfigurationEnumMapping, 2> REQUEST_CHECKSUM_CONFIG_MAPPING = {{
{"when_supported", RequestChecksumCalculation::WHEN_SUPPORTED},
{"when_required", RequestChecksumCalculation::WHEN_REQUIRED},
}};
using ResponseChecksumConfigurationEnumMapping = std::pair<const char*, ResponseChecksumValidation>;
static const std::array<ResponseChecksumConfigurationEnumMapping, 2> RESPONSE_CHECKSUM_CONFIG_MAPPING = {
{{"when_supported", ResponseChecksumValidation::WHEN_SUPPORTED}, {"when_required", ResponseChecksumValidation::WHEN_REQUIRED}}};
template <typename T, size_t N>
static T LoadEnumFromString(const std::array<std::pair<const char*, T>, N>& mappings, const char* value, const T& defaultValue) {
static_assert(std::is_enum<T>::value, "enum type is required");
const auto mapping = std::find_if(std::begin(mappings), std::end(mappings),
[&value](const std::pair<const char*, T>& entry) -> bool { return strcmp(entry.first, value) == 0; });
if (mapping == std::end(mappings)) {
return defaultValue;
}
return mapping->second;
}
ClientConfiguration::ProviderFactories ClientConfiguration::ProviderFactories::defaultFactories = []()
{
ProviderFactories factories;
factories.retryStrategyCreateFn = [](){return InitRetryStrategy();};
factories.executorCreateFn = [](){return Aws::MakeShared<Aws::Utils::Threading::DefaultExecutor>(CLIENT_CONFIG_TAG);};
factories.writeRateLimiterCreateFn = [](){return nullptr;};
factories.readRateLimiterCreateFn = [](){return nullptr;};
factories.telemetryProviderCreateFn = [](){return smithy::components::tracing::NoopTelemetryProvider::CreateProvider();};
return factories;
}();
Aws::String FilterUserAgentToken(char const * const source)
{
// Tokens are short textual identifiers that do not include whitespace or delimiters.
Aws::String copy;
if(!source)
return copy;
size_t sourceLength = std::min(strlen(source), (size_t) 256); // 256 is arbitrary here
copy.resize(sourceLength);
// "/" is not listed as a valid char per spec, however, it appears to be not replaced.
static const char TOKEN_ALLOWED_CHARACTERS[] = R"(!#$%&'*+-.^_`|~ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890)" R"(/)";
static const size_t TOKEN_ALLOWED_CHARACTERS_SZ = sizeof(TOKEN_ALLOWED_CHARACTERS) - 1;
// replace not allowed with '-', except ' ' to be replaced with '_'
std::transform(source, source + sourceLength, copy.begin(),
[](unsigned char c) -> unsigned char
{
if (c == ' ')
return '_';
if(std::find(TOKEN_ALLOWED_CHARACTERS,
TOKEN_ALLOWED_CHARACTERS + TOKEN_ALLOWED_CHARACTERS_SZ,
c) == TOKEN_ALLOWED_CHARACTERS + TOKEN_ALLOWED_CHARACTERS_SZ)
{
return '-';
}
return c;
});
return copy;
}
Aws::String ComputeUserAgentString(ClientConfiguration const * const pConfig)
{
if (pConfig && !pConfig->userAgent.empty())
{
AWS_LOGSTREAM_INFO(CLIENT_CONFIG_TAG, "User agent is overridden in the config: " << pConfig->userAgent);
return pConfig->userAgent;
}
Aws::StringStream ss;
ss << "aws-sdk-cpp/" << FilterUserAgentToken(Version::GetVersionString()) << " "
<< "ua/2.0 "
<< "md/aws-crt#" << FilterUserAgentToken(AWS_CRT_CPP_VERSION) << " "
<< "os/" << FilterUserAgentToken(Aws::OSVersionInfo::ComputeOSVersionString().c_str());
Aws::String arch = Aws::OSVersionInfo::ComputeOSVersionArch();
if(!arch.empty())
{
ss << " md/arch#" << FilterUserAgentToken(arch.c_str());
}
ss << " lang/c++#" << FilterUserAgentToken(Version::GetCPPStandard()) << " "
<< "md/" << FilterUserAgentToken(Version::GetCompilerVersionString());
if (pConfig && pConfig->retryStrategy && pConfig->retryStrategy->GetStrategyName())
{
ss << " cfg/retry-mode#" << FilterUserAgentToken(pConfig->retryStrategy->GetStrategyName());
}
#if defined(AWS_USER_AGENT_CUSTOMIZATION)
#define XSTR(V) STR(V)
#define STR(V) #V
ss << " " << FilterUserAgentToken(XSTR(AWS_USER_AGENT_CUSTOMIZATION));
#undef STR
#undef XSTR
#endif
Aws::String awsExecEnv = Aws::Environment::GetEnv(AWS_EXECUTION_ENV);
if(!awsExecEnv.empty())
{
ss << " exec-env/" << FilterUserAgentToken(awsExecEnv.c_str());
}
const Aws::String& appId = pConfig ? pConfig->appId :
ClientConfiguration::LoadConfigFromEnvOrProfile("AWS_SDK_UA_APP_ID", "default", "sdk_ua_app_id", {}, "");
if(!appId.empty())
{
ss << " app/" << appId;
}
return ss.str();
}
Aws::String calculateRegion() {
// Automatically determine the AWS region from environment variables, configuration file and EC2 metadata.
auto region = Aws::Environment::GetEnv("AWS_DEFAULT_REGION");
if (!region.empty())
{
return region;
}
region = Aws::Environment::GetEnv("AWS_REGION");
if (!region.empty())
{
return region;
}
region = Aws::Config::GetCachedConfigValue("region");
if (!region.empty())
{
return region;
}
return "";
}
Aws::Vector<Aws::String> calculateAuthPreferences() {
// Automatically determine the auth scheme preferences, based on environment vars.
Aws::Vector<Aws::String> res;
auto prefs = Aws::Environment::GetEnv(AWS_AUTH_SCHEME_PREFERENCE);
Aws::Vector<Aws::String> prefsList = Aws::Utils::StringUtils::Split(prefs, ',');
res.reserve(prefsList.size()); // avoid repeated allocations
for (auto& pref : prefsList) {
res.emplace_back(Aws::Utils::StringUtils::Trim(pref.c_str()));
}
return res;
}
Aws::Vector<Aws::String> calculateSigV4aSigningRegionSet(const Aws::String& profileName) {
Aws::Vector<Aws::String> res;
Aws::String regionSetStr = Aws::Environment::GetEnv(AWS_SIGV4A_SIGNING_REGION_SET_ENV_VAR);
if (regionSetStr.empty()) {
regionSetStr = Aws::Config::GetCachedConfigValue(profileName, AWS_SIGV4A_SIGNING_REGION_SET_CONFIG_VAR);
}
if (regionSetStr.empty()) {
return res;
}
Aws::Vector<Aws::String> regionsList = Aws::Utils::StringUtils::Split(regionSetStr, ',');
res.reserve(regionsList.size());
for (const auto& region : regionsList) {
Aws::String trimmed = Aws::Utils::StringUtils::Trim(region.c_str());
if (!trimmed.empty()) {
res.emplace_back(trimmed);
}
}
return res;
}
void setLegacyClientConfigurationParameters(ClientConfiguration& clientConfig)
{
clientConfig.scheme = Aws::Http::Scheme::HTTPS;
clientConfig.useDualStack = false;
clientConfig.useFIPS = false;
clientConfig.maxConnections = 25;
clientConfig.httpRequestTimeoutMs = 0;
clientConfig.requestTimeoutMs = 3000;
clientConfig.connectTimeoutMs = 1000;
clientConfig.enableTcpKeepAlive = true;
clientConfig.tcpKeepAliveIntervalMs = 30000;
clientConfig.lowSpeedLimit = 1;
clientConfig.proxyScheme = Aws::Http::Scheme::HTTP;
clientConfig.proxyPort = 0;
clientConfig.verifySSL = true;
clientConfig.writeRateLimiter = nullptr;
clientConfig.readRateLimiter = nullptr;
clientConfig.httpLibOverride = Aws::Http::TransferLibType::DEFAULT_CLIENT;
clientConfig.httpClientChunkedMode = HttpClientChunkedMode::CLIENT_IMPLEMENTATION;
clientConfig.followRedirects = FollowRedirectsPolicy::DEFAULT;
clientConfig.disableExpectHeader = false;
clientConfig.enableClockSkewAdjustment = true;
clientConfig.enableHostPrefixInjection = true;
clientConfig.enableHttpClientTrace = false;
if (clientConfig.profileName.empty())
{
clientConfig.profileName = Aws::Auth::GetConfigProfileName();
}
Aws::String disableCompressionConfig = clientConfig.LoadConfigFromEnvOrProfile(
DISABLE_REQUEST_COMPRESSION_ENV_VAR,
clientConfig.profileName,
DISABLE_REQUEST_COMPRESSION_CONFIG_VAR,
{"TRUE", "FALSE", "true", "false"},
"false"
);
if (Aws::Utils::StringUtils::ToLower(disableCompressionConfig.c_str()) == "true") {
clientConfig.requestCompressionConfig.useRequestCompression = Aws::Client::UseRequestCompression::DISABLE;
AWS_LOGSTREAM_DEBUG(CLIENT_CONFIG_TAG, "Request Compression disabled");
} else {
//Using default to true for forward compatibility in case new config is added but SDK is not updated.
clientConfig.requestCompressionConfig.useRequestCompression = Aws::Client::UseRequestCompression::ENABLE;
AWS_LOGSTREAM_DEBUG(CLIENT_CONFIG_TAG, "Request Compression enabled");
}
// Getting min request compression length
Aws::String minRequestCompressionString = Aws::Environment::GetEnv(REQUEST_MIN_COMPRESSION_SIZE_BYTES_ENV_VAR);
if (minRequestCompressionString.empty())
{
minRequestCompressionString = Aws::Config::GetCachedConfigValue(REQUEST_MIN_COMPRESSION_SIZE_BYTES_CONFIG_VAR);
}
if (!minRequestCompressionString.empty()) {
clientConfig.requestCompressionConfig.requestMinCompressionSizeBytes = static_cast<int>(Aws::Utils::StringUtils::ConvertToInt32(minRequestCompressionString.c_str()));
if (clientConfig.requestCompressionConfig.requestMinCompressionSizeBytes > 10485760) {
AWS_LOGSTREAM_ERROR(CLIENT_CONFIG_TAG, "ClientConfiguration for MinReqCompression is unsupported, received: " << clientConfig.requestCompressionConfig.requestMinCompressionSizeBytes);
}
}
AWS_LOGSTREAM_DEBUG(CLIENT_CONFIG_TAG, "ClientConfiguration will use MinReqCompression: " << clientConfig.requestCompressionConfig.requestMinCompressionSizeBytes);
AWS_LOGSTREAM_DEBUG(CLIENT_CONFIG_TAG, "ClientConfiguration will use SDK Auto Resolved profile: [" << clientConfig.profileName << "] if not specified by users.");
clientConfig.region = calculateRegion();
clientConfig.credentialProviderConfig.region = clientConfig.region;
clientConfig.authPreferences = calculateAuthPreferences();
clientConfig.sigV4aSigningRegionSet = calculateSigV4aSigningRegionSet(clientConfig.profileName);
// Set the endpoint to interact with EC2 instance's metadata service
Aws::String ec2MetadataServiceEndpoint = Aws::Environment::GetEnv("AWS_EC2_METADATA_SERVICE_ENDPOINT");
if (! ec2MetadataServiceEndpoint.empty())
{
//By default we use the IPv4 default metadata service address
auto client = Aws::Internal::GetEC2MetadataClient();
if (client != nullptr)
{
client->SetEndpoint(ec2MetadataServiceEndpoint);
}
}
clientConfig.appId = clientConfig.LoadConfigFromEnvOrProfile("AWS_SDK_UA_APP_ID", clientConfig.profileName, "sdk_ua_app_id", {}, "");
clientConfig.checksumConfig.requestChecksumCalculation =
LoadEnumFromString(REQUEST_CHECKSUM_CONFIG_MAPPING,
ClientConfiguration::LoadConfigFromEnvOrProfile("AWS_REQUEST_CHECKSUM_CALCULATION", clientConfig.profileName,
"request_checksum_calculation",
{"when_supported", "when_required"}, "when_supported")
.c_str(),
RequestChecksumCalculation::WHEN_SUPPORTED);
clientConfig.checksumConfig.responseChecksumValidation =
LoadEnumFromString(RESPONSE_CHECKSUM_CONFIG_MAPPING,
ClientConfiguration::LoadConfigFromEnvOrProfile("AWS_RESPONSE_CHECKSUM_VALIDATION", clientConfig.profileName,
"response_checksum_validation",
{"when_supported", "when_required"}, "when_supported")
.c_str(),
ResponseChecksumValidation::WHEN_SUPPORTED);
}
void setConfigFromEnvOrProfile(ClientConfiguration &config)
{
Aws::String disableIMDSv1 = ClientConfiguration::LoadConfigFromEnvOrProfile(DISABLE_IMDSV1_ENV_VAR,
config.profileName,
DISABLE_IMDSV1_CONFIG_VAR,
{"true", "false"},
"false");
if (disableIMDSv1 == "true") {
config.disableImdsV1 = true;
config.credentialProviderConfig.imdsConfig.disableImdsV1 = true;
}
// accountId is intentionally not set here: AWS_ACCOUNT_ID env variable may not match the provided credentials.
// it must be set by an auth provider / identity resolver or by an SDK user.
config.accountIdEndpointMode = ClientConfiguration::LoadConfigFromEnvOrProfile(AWS_ACCOUNT_ID_ENDPOINT_MODE_ENVIRONMENT_VARIABLE,
config.profileName,
AWS_ACCOUNT_ID_ENDPOINT_MODE_CONFIG_FILE_OPTION,
{"required", "disabled", "preferred"}, /* allowed values */
"preferred" /* default value */);
// Load IMDS configuration from environment variables and config file
Aws::String timeoutStr = ClientConfiguration::LoadConfigFromEnvOrProfile(AWS_METADATA_SERVICE_TIMEOUT_ENV_VAR,
config.profileName,
AWS_METADATA_SERVICE_TIMEOUT_CONFIG_VAR,
{}, /* allowed values */
"1" /* default value */);
// Load IMDS configuration from environment variables and config file
Aws::String numAttemptsStr = ClientConfiguration::LoadConfigFromEnvOrProfile(AWS_METADATA_SERVICE_NUM_ATTEMPTS_ENV_VAR,
config.profileName,
AWS_METADATA_SERVICE_NUM_ATTEMPTS_CONFIG_VAR,
{}, /* allowed values */
"1" /* default value */);
// Parse and set IMDS timeout
long timeout = static_cast<long>(Aws::Utils::StringUtils::ConvertToInt32(timeoutStr.c_str()));
config.credentialProviderConfig.imdsConfig.metadataServiceTimeout = timeout;
// Parse and set IMDS num attempts
long attempts = static_cast<long>(Aws::Utils::StringUtils::ConvertToInt32(numAttemptsStr.c_str()));
config.credentialProviderConfig.imdsConfig.metadataServiceNumAttempts = attempts;
// Initialize IMDS-specific retry strategy with configured number of attempts
// Uses default retry mode with the specified max attempts from metadata_service_num_attempts
config.credentialProviderConfig.imdsConfig.imdsRetryStrategy = InitRetryStrategy(attempts, "");
config.credentialProviderConfig.stsCredentialsProviderConfig.roleArn = ClientConfiguration::LoadConfigFromEnvOrProfileCaseSensitive(
AWS_IAM_ROLE_ARN_ENV_VAR_COMPAT, config.profileName, AWS_IAM_ROLE_ARN_CONFIG_FILE_OPTION, {}, /* allowed values */
"" /* default value */, [](const Aws::String& envValue) -> Aws::String { return envValue; });
// there was a typo in the original environment variable, this exists for backwards compatibility
if (config.credentialProviderConfig.stsCredentialsProviderConfig.roleArn.empty()) {
config.credentialProviderConfig.stsCredentialsProviderConfig.roleArn = ClientConfiguration::LoadConfigFromEnvOrProfileCaseSensitive(
AWS_IAM_ROLE_ARN_ENV_VAR, config.profileName, AWS_IAM_ROLE_ARN_CONFIG_FILE_OPTION, {}, /* allowed values */
"" /* default value */, [](const Aws::String& envValue) -> Aws::String { return envValue; });
}
config.credentialProviderConfig.stsCredentialsProviderConfig.sessionName = ClientConfiguration::LoadConfigFromEnvOrProfileCaseSensitive(
AWS_IAM_ROLE_SESSION_NAME_ENV_VAR_COMPAT, config.profileName, AWS_IAM_ROLE_SESSION_NAME_CONFIG_FILE_OPTION, {}, /* allowed values */
"" /* default value */, [](const Aws::String& envValue) -> Aws::String { return envValue; });
// there was a typo in the original environment variable, this exists for backwards compatibility
if (config.credentialProviderConfig.stsCredentialsProviderConfig.sessionName.empty()) {
config.credentialProviderConfig.stsCredentialsProviderConfig.sessionName =
ClientConfiguration::LoadConfigFromEnvOrProfileCaseSensitive(
AWS_IAM_ROLE_SESSION_NAME_ENV_VAR, config.profileName, AWS_IAM_ROLE_SESSION_NAME_CONFIG_FILE_OPTION, {}, /* allowed values */
"" /* default value */, [](const Aws::String& envValue) -> Aws::String { return envValue; });
}
config.credentialProviderConfig.stsCredentialsProviderConfig.tokenFilePath =
ClientConfiguration::LoadConfigFromEnvOrProfileCaseSensitive(
AWS_WEB_IDENTITY_TOKEN_FILE_ENV_VAR, config.profileName, AWS_WEB_IDENTITY_TOKEN_FILE_CONFIG_FILE_OPTION,
{}, /* allowed values */
"" /* default value */, [](const Aws::String& envValue) -> Aws::String { return envValue; });
config.credentialProviderConfig.loginCredentialProviderConfig.loginSession =
Aws::Config::GetCachedConfigValue(config.profileName, AWS_LOGIN_SESSION_FILE_OPTION);
config.credentialProviderConfig.loginCredentialProviderConfig.loginCacheOverride =
Aws::Environment::GetEnv(AWS_LOGIN_CACHE_DIRECTORY_ENV_VAR);
}
ClientConfiguration::ClientConfiguration()
{
this->disableIMDS = false;
this->credentialProviderConfig.imdsConfig.disableImds = false;
setLegacyClientConfigurationParameters(*this);
setConfigFromEnvOrProfile(*this);
this->credentialProviderConfig.profile = this->profileName;
if (!this->disableIMDS &&
region.empty() &&
Aws::Utils::StringUtils::ToLower(Aws::Environment::GetEnv("AWS_EC2_METADATA_DISABLED").c_str()) != "true")
{
auto client = Aws::Internal::GetEC2MetadataClient();
if (client)
{
region = client->GetCurrentRegion();
this->credentialProviderConfig.region = region;
}
}
if (!region.empty())
{
return;
}
region = Aws::String(Aws::Region::US_EAST_1);
this->credentialProviderConfig.region = region;
}
ClientConfiguration::ClientConfiguration(const ClientConfigurationInitValues &configuration)
{
this->disableIMDS = configuration.shouldDisableIMDS;
this->credentialProviderConfig.imdsConfig.disableImds = configuration.shouldDisableIMDS;
setLegacyClientConfigurationParameters(*this);
setConfigFromEnvOrProfile(*this);
this->credentialProviderConfig.profile = this->profileName;
if (!this->disableIMDS &&
region.empty() &&
Aws::Utils::StringUtils::ToLower(Aws::Environment::GetEnv("AWS_EC2_METADATA_DISABLED").c_str()) != "true")
{
auto client = Aws::Internal::GetEC2MetadataClient();
if (client)
{
region = client->GetCurrentRegion();
this->credentialProviderConfig.region = region;
}
}
if (!region.empty())
{
return;
}
region = Aws::String(Aws::Region::US_EAST_1);
this->credentialProviderConfig.region = region;
}
ClientConfiguration::ClientConfiguration(const char* profile, bool shouldDisableIMDS)
{
this->disableIMDS = shouldDisableIMDS;
this->credentialProviderConfig.imdsConfig.disableImds = shouldDisableIMDS;
if (profile && Aws::Config::HasCachedConfigProfile(profile)) {
this->profileName = Aws::String(profile);
}
this->credentialProviderConfig.profile = this->profileName;
setLegacyClientConfigurationParameters(*this);
setConfigFromEnvOrProfile(*this);
// Call EC2 Instance Metadata service only once
Aws::String ec2MetadataRegion;
bool hasEc2MetadataRegion = false;
if (!this->disableIMDS &&
region.empty() &&
Aws::Utils::StringUtils::ToLower(Aws::Environment::GetEnv("AWS_EC2_METADATA_DISABLED").c_str()) != "true") {
auto client = Aws::Internal::GetEC2MetadataClient();
if (client)
{
ec2MetadataRegion = client->GetCurrentRegion();
hasEc2MetadataRegion = true;
region = ec2MetadataRegion;
this->credentialProviderConfig.region = region;
}
}
if(region.empty())
{
region = Aws::String(Aws::Region::US_EAST_1);
this->credentialProviderConfig.region = region;
}
if (profile && Aws::Config::HasCachedConfigProfile(profile)) {
AWS_LOGSTREAM_DEBUG(CLIENT_CONFIG_TAG,
"Use user specified profile: [" << this->profileName << "] for ClientConfiguration.");
auto tmpRegion = Aws::Config::GetCachedConfigProfile(this->profileName).GetRegion();
if (!tmpRegion.empty()) {
region = tmpRegion;
this->credentialProviderConfig.region = region;
}
Aws::String profileDefaultsMode = Aws::Config::GetCachedConfigProfile(this->profileName).GetDefaultsMode();
Aws::Config::Defaults::SetSmartDefaultsConfigurationParameters(*this, profileDefaultsMode,
hasEc2MetadataRegion, ec2MetadataRegion);
return;
}
AWS_LOGSTREAM_WARN(CLIENT_CONFIG_TAG, "User specified profile: [" << profile << "] is not found, will use the SDK resolved one.");
}
ClientConfiguration::ClientConfiguration(bool /*useSmartDefaults*/, const char* defaultMode, bool shouldDisableIMDS)
{
this->disableIMDS = shouldDisableIMDS;
this->credentialProviderConfig.imdsConfig.disableImds = shouldDisableIMDS;
setLegacyClientConfigurationParameters(*this);
setConfigFromEnvOrProfile(*this);
this->credentialProviderConfig.profile = this->profileName;
// Call EC2 Instance Metadata service only once
Aws::String ec2MetadataRegion;
bool hasEc2MetadataRegion = false;
if (!this->disableIMDS &&
region.empty() &&
Aws::Utils::StringUtils::ToLower(Aws::Environment::GetEnv("AWS_EC2_METADATA_DISABLED").c_str()) != "true")
{
auto client = Aws::Internal::GetEC2MetadataClient();
if (client)
{
ec2MetadataRegion = client->GetCurrentRegion();
hasEc2MetadataRegion = true;
region = ec2MetadataRegion;
this->credentialProviderConfig.region = region;
}
}
if (region.empty())
{
region = Aws::String(Aws::Region::US_EAST_1);
this->credentialProviderConfig.region = region;
}
Aws::Config::Defaults::SetSmartDefaultsConfigurationParameters(*this, defaultMode, hasEc2MetadataRegion, ec2MetadataRegion);
}
std::shared_ptr<RetryStrategy> InitRetryStrategy(int maxAttempts, Aws::String retryMode) {
if (retryMode.empty())
{
retryMode = Aws::Environment::GetEnv("AWS_RETRY_MODE");
}
if (retryMode.empty())
{
retryMode = Aws::Config::GetCachedConfigValue("retry_mode");
}
std::shared_ptr<RetryStrategy> retryStrategy;
if (retryMode == "standard")
{
if (maxAttempts < 0)
{
// negative value set above force usage of default max attempts
retryStrategy = Aws::MakeShared<StandardRetryStrategy>(CLIENT_CONFIG_TAG);
}
else
{
retryStrategy = Aws::MakeShared<StandardRetryStrategy>(CLIENT_CONFIG_TAG, maxAttempts);
}
}
else if (retryMode == "adaptive")
{
if (maxAttempts < 0)
{
// negative value set above force usage of default max attempts
retryStrategy = Aws::MakeShared<AdaptiveRetryStrategy>(CLIENT_CONFIG_TAG);
}
else
{
retryStrategy = Aws::MakeShared<AdaptiveRetryStrategy>(CLIENT_CONFIG_TAG, maxAttempts);
}
}
else
{
retryStrategy = Aws::MakeShared<DefaultRetryStrategy>(CLIENT_CONFIG_TAG);
}
return retryStrategy;
}
std::shared_ptr<RetryStrategy> InitRetryStrategy(Aws::String retryMode)
{
int maxAttempts = 0;
Aws::String maxAttemptsString = Aws::Environment::GetEnv("AWS_MAX_ATTEMPTS");
if (maxAttemptsString.empty())
{
maxAttemptsString = Aws::Config::GetCachedConfigValue("max_attempts");
}
// In case users specify 0 explicitly to disable retry.
if (maxAttemptsString == "0")
{
maxAttempts = 0;
}
else
{
maxAttempts = static_cast<int>(Aws::Utils::StringUtils::ConvertToInt32(maxAttemptsString.c_str()));
if (maxAttempts == 0)
{
AWS_LOGSTREAM_INFO(CLIENT_CONFIG_TAG, "Retry Strategy will use the default max attempts.");
maxAttempts = -1;
}
}
return InitRetryStrategy(maxAttempts, retryMode);
}
Aws::String ClientConfiguration::LoadConfigFromEnvOrProfile(const Aws::String& envKey,
const Aws::String& profile,
const Aws::String& profileProperty,
const Aws::Vector<Aws::String>& allowedValues,
const Aws::String& defaultValue)
{
return LoadConfigFromEnvOrProfileCaseSensitive(envKey, profile, profileProperty, allowedValues, defaultValue);
}
Aws::String ClientConfiguration::LoadConfigFromEnvOrProfileCaseSensitive(const Aws::String& envKey, const Aws::String& profile,
const Aws::String& profileProperty,
const Aws::Vector<Aws::String>& allowedValues,
const Aws::String& defaultValue,
const std::function<Aws::String(const char*)>& envValueMapping) {
Aws::String option = Aws::Environment::GetEnv(envKey.c_str());
if (option.empty()) {
option = Aws::Config::GetCachedConfigValue(profile, profileProperty);
}
option = envValueMapping(option.c_str());
if (option.empty()) {
return defaultValue;
}
if (!allowedValues.empty() && std::find(allowedValues.cbegin(), allowedValues.cend(), option) == allowedValues.cend()) {
Aws::OStringStream expectedStr;
expectedStr << "[";
for (const auto& allowed : allowedValues) {
expectedStr << allowed << ";";
}
expectedStr << "]";
AWS_LOGSTREAM_WARN(CLIENT_CONFIG_TAG, "Unrecognised value for " << envKey << ": " << option << ". Using default instead: "
<< defaultValue << ". Expected empty or one of: " << expectedStr.str());
option = defaultValue;
}
return option;
}
} // namespace Client
} // namespace Aws