Skip to content

AssumeRole with AWS EC2 credentials #875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: antalya
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 109 additions & 5 deletions src/IO/S3/Credentials.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,86 @@ void AwsAuthSTSAssumeRoleWebIdentityCredentialsProvider::refreshIfExpired()
Reload();
}

AWSInstanceMetadataAssumeRoleCredentialsProvider::AWSInstanceMetadataAssumeRoleCredentialsProvider(
const Aws::String & role_arn_,
const Aws::String & session_name_,
DB::S3::PocoHTTPClientConfiguration aws_client_configuration,
uint64_t expiration_window_seconds_)
: role_arn(role_arn_)
, session_name(session_name_.empty() ? Aws::String(Aws::Utils::UUID::RandomUUID()) : session_name_)
, logger(getLogger("AWSInstanceMetadataAssumeRoleCredentialsProvider"))
, expiration_window_seconds(expiration_window_seconds_)
{
// Create metadata credentials provider
auto ec2_metadata_client = createEC2MetadataClient(aws_client_configuration);
auto config_loader = std::make_shared<AWSEC2InstanceProfileConfigLoader>(ec2_metadata_client, true);
metadata_provider = std::make_shared<AWSInstanceProfileCredentialsProvider>(config_loader);

aws_client_configuration.scheme = Aws::Http::Scheme::HTTPS;

std::vector<Aws::String> retryable_errors;
retryable_errors.push_back("IDPCommunicationError");
retryable_errors.push_back("InvalidIdentityToken");
aws_client_configuration.retryStrategy = std::make_shared<Aws::Client::SpecifiedRetryableErrorsRetryStrategy>(
retryable_errors, /*maxRetries=*/ 3);

sts_client = std::make_unique<Aws::STS::STSClient>(metadata_provider, aws_client_configuration);

LOG_INFO(logger, "Created STS AssumeRole provider using EC2 instance metadata");
}

Aws::Auth::AWSCredentials AWSInstanceMetadataAssumeRoleCredentialsProvider::GetAWSCredentials()
{
refreshIfExpired();
Aws::Utils::Threading::ReaderLockGuard guard(m_reloadLock);
return credentials;
}

void AWSInstanceMetadataAssumeRoleCredentialsProvider::Reload()
{
// Get fresh metadata credentials
auto metadata_creds = metadata_provider->GetAWSCredentials();
if (metadata_creds.IsEmpty())
{
LOG_ERROR(logger, "Failed to obtain instance metadata credentials");
return;
}

// Perform AssumeRole
Aws::STS::Model::AssumeRoleRequest request;
request.SetRoleArn(role_arn);
request.SetRoleSessionName(session_name);

auto outcome = sts_client->AssumeRole(request);
if (!outcome.IsSuccess())
{
LOG_ERROR(logger, "Failed to assume role: {}", outcome.GetError().GetMessage());
return;
}

const auto & result = outcome.GetResult().GetCredentials();
credentials = Aws::Auth::AWSCredentials(
result.GetAccessKeyId(),
result.GetSecretAccessKey(),
result.GetSessionToken(),
result.GetExpiration().SecondsWithMSPrecision());

LOG_TRACE(logger, "Successfully assumed role using metadata credentials");
}

void AWSInstanceMetadataAssumeRoleCredentialsProvider::refreshIfExpired()
{
Aws::Utils::Threading::ReaderLockGuard guard(m_reloadLock);
if (!areCredentialsEmptyOrExpired(credentials, expiration_window_seconds))
return;

guard.UpgradeToWriterLock();
if (!areCredentialsEmptyOrExpired(credentials, expiration_window_seconds))
return;

Reload();
}


SSOCredentialsProvider::SSOCredentialsProvider(DB::S3::PocoHTTPClientConfiguration aws_client_configuration_, uint64_t expiration_window_seconds_)
: profile_to_use(Aws::Auth::GetConfigProfileName())
Expand Down Expand Up @@ -688,13 +768,17 @@ S3CredentialsProviderChain::S3CredentialsProviderChain(
if (credentials_configuration.no_sign_request)
return;

/// add explicit credentials to the front of the chain
/// because it's manually defined by the user
if (!credentials.IsEmpty())
if (credentials_configuration.role_arn.empty())
{
if (credentials_configuration.role_arn.empty())
if (!credentials.IsEmpty())
{
AddProvider(std::make_shared<Aws::Auth::SimpleAWSCredentialsProvider>(credentials));
else
return;
}
}
else
{
if (!credentials.IsEmpty())
{
auto sts_client_config = Aws::STS::STSClientConfiguration();

Expand All @@ -721,6 +805,26 @@ S3CredentialsProviderChain::S3CredentialsProviderChain(
)
);
}
else
{
DB::S3::PocoHTTPClientConfiguration aws_client_configuration = DB::S3::ClientFactory::instance().createClientConfiguration(
configuration.region,
configuration.remote_host_filter,
configuration.s3_max_redirects,
configuration.s3_retry_attempts,
configuration.enable_s3_requests_logging,
configuration.for_disk_s3,
configuration.get_request_throttler,
configuration.put_request_throttler);

// Use metadata credentials for AssumeRole
AddProvider(std::make_shared<AWSInstanceMetadataAssumeRoleCredentialsProvider>(
Aws::String(credentials_configuration.role_arn),
Aws::String(credentials_configuration.role_session_name),
std::move(aws_client_configuration),
credentials_configuration.expiration_window_seconds)
);
}
return;
}

Expand Down
28 changes: 28 additions & 0 deletions src/IO/S3/Credentials.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
# include <aws/core/config/AWSProfileConfigLoader.h>
# include <aws/core/auth/AWSCredentialsProviderChain.h>
# include <aws/core/auth/bearer-token-provider/SSOBearerTokenProvider.h>
# include <aws/sts/STSClient.h>
# include <aws/sts/model/AssumeRoleRequest.h>

# include <IO/S3/PocoHTTPClient.h>
# include <IO/S3Defines.h>
Expand Down Expand Up @@ -107,6 +109,32 @@ class AWSInstanceProfileCredentialsProvider : public Aws::Auth::AWSCredentialsPr
LoggerPtr logger;
};

class AWSInstanceMetadataAssumeRoleCredentialsProvider : public Aws::Auth::AWSCredentialsProvider
{
public:
explicit AWSInstanceMetadataAssumeRoleCredentialsProvider(
const Aws::String & role_arn_,
const Aws::String & session_name_,
DB::S3::PocoHTTPClientConfiguration aws_client_configuration,
uint64_t expiration_window_seconds_);

Aws::Auth::AWSCredentials GetAWSCredentials() override;

protected:
void Reload() override;

private:
void refreshIfExpired();

std::shared_ptr<AWSInstanceProfileCredentialsProvider> metadata_provider;
std::unique_ptr<Aws::STS::STSClient> sts_client;
Aws::Auth::AWSCredentials credentials;
Aws::String role_arn;
Aws::String session_name;
LoggerPtr logger;
uint64_t expiration_window_seconds;
};

class AwsAuthSTSAssumeRoleWebIdentityCredentialsProvider : public Aws::Auth::AWSCredentialsProvider
{
/// See STSAssumeRoleWebIdentityCredentialsProvider.
Expand Down
1 change: 0 additions & 1 deletion src/Storages/ObjectStorage/S3/Configuration.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,6 @@ void StorageS3Configuration::extractExtraCreds(ASTs & args, ContextPtr context)
}

extra_creds_it = arg_it;
continue;
}
}

Expand Down
Loading