-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[Feature] Add shared credential-refresh lifecycle to AWSCredentialsProvider #3930
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
kai-ion
wants to merge
1
commit into
main
Choose a base branch
from
refresh
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
57 changes: 57 additions & 0 deletions
57
src/aws-cpp-sdk-core/include/aws/core/auth/CredentialsRefreshProvider.h
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /** | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0. | ||
| */ | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <aws/core/Core_EXPORTS.h> | ||
| #include <aws/core/auth/AWSCredentialsProvider.h> | ||
| #include <aws/core/auth/CredentialsRefreshResult.h> | ||
| #include <aws/core/utils/DateTime.h> | ||
| #include <memory> | ||
|
|
||
| namespace Aws | ||
| { | ||
| namespace Internal { class CredentialsRefreshStateImpl; } | ||
| namespace Auth | ||
| { | ||
| /** | ||
| * A single credential fetch against the underlying source, classified fresh/recoverable/ | ||
| * non-recoverable. Providers implement this to be wrapped by CredentialsRefreshProvider; | ||
| * the classification drives serve-last-good and backoff. | ||
| */ | ||
| class AWS_CORE_API CredentialsSource | ||
| { | ||
| public: | ||
| virtual ~CredentialsSource() = default; | ||
| virtual Aws::Auth::RefreshResult<AWSCredentials> FetchCredentials() = 0; | ||
| }; | ||
|
|
||
| /** | ||
| * Wraps a CredentialsSource with the shared credentials-refresh lifecycle (caching, | ||
| * advisory/mandatory windows, jittered backoff, serve-last-good, single in-flight refresh, | ||
| * invalidation). The wrap is applied only when AWS_NEW_CREDENTIAL_REFRESH_2026 is on; when | ||
| * off the source provider is used directly, preserving legacy behavior. | ||
| */ | ||
| class AWS_CORE_API CredentialsRefreshProvider : public AWSCredentialsProvider | ||
| { | ||
| public: | ||
| explicit CredentialsRefreshProvider(std::shared_ptr<CredentialsSource> source); | ||
| ~CredentialsRefreshProvider() override; | ||
|
|
||
| AWSCredentials GetAWSCredentials() override; | ||
|
|
||
| // Marks cached credentials for refresh after a service rejects them (ExpiredToken/InvalidToken). | ||
| virtual void Invalidate(); | ||
|
|
||
| protected: | ||
| // Clock for the refresh windows/backoff; defaults to the system clock, overridable for tests. | ||
| virtual Aws::Utils::DateTime CurrentTime() const; | ||
|
|
||
| private: | ||
| std::shared_ptr<CredentialsSource> m_source; | ||
| std::unique_ptr<Aws::Internal::CredentialsRefreshStateImpl> m_refreshState; | ||
| }; | ||
| } // namespace Auth | ||
| } // namespace Aws | ||
58 changes: 58 additions & 0 deletions
58
src/aws-cpp-sdk-core/include/aws/core/auth/CredentialsRefreshResult.h
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /** | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0. | ||
| */ | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <aws/core/Core_EXPORTS.h> | ||
| #include <aws/core/utils/DateTime.h> | ||
| #include <aws/core/utils/memory/stl/AWSString.h> | ||
| #include <aws/crt/Optional.h> | ||
| #include <utility> | ||
|
|
||
| namespace Aws | ||
| { | ||
| namespace Auth | ||
| { | ||
| // Result of one credential-source fetch: the return type of CredentialsSource::FetchCredentials(), | ||
| // so it is public (the refresh engine that consumes it stays internal). | ||
| template<typename CredentialsT> | ||
| class RefreshResult | ||
| { | ||
| public: | ||
| enum class Status | ||
| { | ||
| Success, // fresh credentials obtained | ||
| Recoverable, // transient failure: back off and keep serving cache | ||
| NonRecoverable // will not succeed without customer action: raise + briefly cache the error | ||
| }; | ||
|
|
||
| RefreshResult() = default; | ||
| RefreshResult(Status status, CredentialsT credentials, Aws::Crt::Optional<Aws::Utils::DateTime> expiration, | ||
| Aws::String errorMessage) | ||
| : status(status), credentials(std::move(credentials)), | ||
| expiration(std::move(expiration)), errorMessage(std::move(errorMessage)) {} | ||
|
|
||
| // Named constructors. Only Fresh() carries an expiration. | ||
| static RefreshResult Fresh(CredentialsT credentials, Aws::Utils::DateTime expiration) | ||
| { | ||
| return RefreshResult(Status::Success, std::move(credentials), | ||
| Aws::Crt::Optional<Aws::Utils::DateTime>(expiration), {}); | ||
| } | ||
| static RefreshResult Recoverable(Aws::String errorMessage = {}) | ||
| { | ||
| return RefreshResult(Status::Recoverable, CredentialsT{}, {}, std::move(errorMessage)); | ||
| } | ||
| static RefreshResult NonRecoverable(Aws::String errorMessage) | ||
| { | ||
| return RefreshResult(Status::NonRecoverable, CredentialsT{}, {}, std::move(errorMessage)); | ||
| } | ||
|
|
||
| Status status{Status::Recoverable}; | ||
| CredentialsT credentials{}; | ||
| Aws::Crt::Optional<Aws::Utils::DateTime> expiration; // engaged only when status == Success | ||
| Aws::String errorMessage; | ||
| }; | ||
| } // namespace Auth | ||
| } // namespace Aws |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so lets think about this constructor and the new interface
CredentialsSource. credentials refresh provider is meant to be like other SDKs where we wrap a existing credentials provider and cache that. there are however several issues with thisCredentialsSource is not a AWSCredentialsProvider
in the default chain we do something like
now all of our implementations of AWSCredentialsProvider specifically in this example SomeCredentialsProvider how have to implement these functions. and implement a new interface. im not strictly against this we just need to weigh whether we want to do this or not.
this approach has two problems:
double caching/no caching
what about wrapping credentials provider that already cache like all of the CRT credentials providers. you are more or less unwrapping those, and making a parallel caching API which is a lot of surface area. additionally if you remove the caching layer, existing users of the credentials provider now have no caching.
_direct usage of the crednetials provider has no caching
directly constructing a credentials provider has no caching necessarily because only in the chain we wrap it.
before we do this, we need to evaluate how and where this caching will be added, and answer these questions.