-
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
2
commits 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
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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
58 changes: 58 additions & 0 deletions
58
src/aws-cpp-sdk-core/include/aws/core/auth/CredentialRefreshResult.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 the FetchCredentialsFromSource() override | ||
| // contract, 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
FetchCredentialsFromSourceis a protected virtual function onAWSCredentialsProvider. so a inheriting class can override it. butFetchCredentialsFromSourceis not used in theGetAWSCredentialsas that is the method the SDK calls to fetch credentials. so how is the override actually planned on being used?