credentials static web identity credentials not picked up without an explicit profile option
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- aws, ruby
- Domain
- authentication, cloud
Research direction
Start with gems/aws-sdk-core/lib/aws-sdk-core/credential_provider_chain.rb and gems/aws-sdk-core/lib/aws-sdk-core/plugins/credentials_configuration.rb, then review the shared-config behavior described in the reproduction. Use the two Aws::SQS::Client.new calls with web identity configuration to verify the current STS requests. Done means the default shared configuration is used without an explicit profile and repeated clients do not each refresh separately.
Written by the indexing model from the issue text.
Description
Describe the bug
We're using STS web identity token credentials to manage AWS SDK service call authentication via SigV4 (aws-sdk-core (3.211.0), should be the relevant bit). We noticed however, during load testing, some rate limiting happening, which we narrowed down to multiple calls to the STS token refresh endpoint, exacerbated by the scaling up of certain services. After some investigation, we figured out that multiple clients (for SQS, SNS, etc) were instantiated, and the token refresh path was called for each of them. This is not ideal, as there should be a single "refresh" happening, and the token should at best be shared across the multiple clients.
In the process, we found out that the AWS SDKs already support that via "shared config", and we proceeded to change our approach using it, replacing the env var setup using AWS_WEB_IDENTITY_TOKEN_FILE and AWS_ROLE_ARN with a AWS_CONFIG_FILE pointing to a file like this:
[default]
web_identity_token_file = $AWS_WEB_IDENTITY_TOKEN_FILE
role_arn = $AWS_ROLE_ARN
Expected Behavior
This should have worked, as in, when instantiating clients multiple times, there should only be one call to STS. This can be observed using this script:
Aws.config[:http_wire_trace] = true
Aws::SQS::Client.new
# one STS request log
Aws::SQS::Client.new
# no STS request log
Current Behavior
when instantiating two client instances, two STS requests are made.
While we noticed that Aws.shared_config was correctly filled up with the expected values, unfortunately calling i.e. Aws::SQS::Client.new was still going through this strategy and generating a token + refresh loop per client, because of this clause, i.e. the routine expects a profile to be set, however it's nil as per the option setup, although the docs say it's "default".
I believe this is a bug, as if "default", this would have worked. I also tried setting the AWS_PROFILE env var, but that doesn't fill it up either.
FWIW, setting Aws.config[:profile] = "default", or explicit option set a la Aws::SQS::Client.new(profile: "default"), work as expected (shared config is picked up). However, I'm looking for a "no config code" setup that can be rolled out across multiple services.
Reproduction Steps
Aws.config[:http_wire_trace] = true
Aws::SQS::Client.new
# one STS request log
Aws::SQS::Client.new
# no STS request log
Possible Solution
Perhaps initializing the profile option to whatever AWS_PROFILE defines?
Additional Information/Context
No response
Gem name ('aws-sdk', 'aws-sdk-resources' or service gems like 'aws-sdk-s3') and its version
aws-sdk-core 3.211.0
Environment details (Version of Ruby, OS environment)
"ruby 3.3.0 (2023-12-25 revision 5124f9ac75) [x86_64-linux]"
- Dominant language
- Ruby
- Stars
- 3.7k
- Forks
- 1.2k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 25
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aws/aws-sdk-ruby
-
service-api
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
aws/aws-sdk-ruby#3395 · 1 comment ·
Maintainers usually reply within 1 day
-
BedrockAgentCore: invoke_agent_runtime buffers entire response instead of streaming in real-timeOpendocumentation p3 queued
Difficulty 4/5 3-5 days Newbie friendliness 48/100
aws/aws-sdk-ruby#3348 · 6 comments · 1 reaction ·
Maintainers usually reply within 1 day
-
investigating service-api
Difficulty 4/5 3-5 days Newbie friendliness 35/100
aws/aws-sdk-ruby#3217 · 4 comments ·
Maintainers usually reply within 1 day
-
service-api
Difficulty 5/5 Over a week Newbie friendliness 25/100
aws/aws-sdk-ruby#3191 · 1 comment ·
Maintainers usually reply within 1 day
-
feature-request
Difficulty 3/5 1-2 days Newbie friendliness 35/100
aws/aws-sdk-ruby#3190 · 3 comments ·
Maintainers usually reply within 1 day
All issues in aws/aws-sdk-ruby
Similar issues
-
Difficulty 1/5 1-3 hours Newbie friendliness 66/100
betagouv/conseillers-entreprises#4770 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
seek4science/seek#2762 ·
Maintainers usually reply within 5 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
rubyevents/rubyevents#2277 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 92/100
Maintainers usually reply within 2 days