Skip to content
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

feat: account id endpoint resolution support #2884

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

yenfryherrerafeliz
Copy link
Contributor

This change add account_id as part of the identity resolution, from the different credentials provider. It also validates whether an account should have been resolved based on the configure option account_id_endpoint_mode, and when this option is not disabled then, it prepends a middleware that resolves the identity, from the provided credential provider and, it validates the account id based on the account_id_endpoint_mode option. When an identity is resolved by this middleware then, this identity is carry over in a command property bag called @context, which is then reused by the signer middleware, and any other middleware that needs to resolve identity. This is done for avoiding having to resolve identity multiple times in a single request. The property is: $command['@context']['resolved_identity'];

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@yenfryherrerafeliz yenfryherrerafeliz force-pushed the feat_account_id_endpoint_support branch 2 times, most recently from b7ded3e to 5c81b98 Compare February 22, 2024 15:57
src/ClientResolver.php Outdated Show resolved Hide resolved
src/ClientResolver.php Outdated Show resolved Hide resolved
src/Credentials/Credentials.php Outdated Show resolved Hide resolved
src/Credentials/Credentials.php Outdated Show resolved Hide resolved
src/Credentials/CredentialsInterface.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/AccountIdEndpointMiddleware.php Outdated Show resolved Hide resolved
src/AwsClient.php Outdated Show resolved Hide resolved
src/AccountIdEndpointMiddleware.php Outdated Show resolved Hide resolved
@yenfryherrerafeliz yenfryherrerafeliz force-pushed the feat_account_id_endpoint_support branch 6 times, most recently from 90fa5a9 to f732741 Compare February 23, 2024 16:45
This change add account_id as part of the identity resolution, from the different credentials provider. It also validates whether an account should have been resolved based on the configure option account_id_endpoint_mode. The way this is done is by using lazy resolvers. We wrap the credentials provider into a custom lazy resolver that will avoid resolving credentials more than once, which means that in that credentials lazy resolver the value will be resolved once, and it will be returned everytime the credentials provider is consumed/invoked. For accountId builts-in, we also use a lazy resolver which holds the validation for wheter account_id value should have been resolved as part of the resolved identity. This accountId built-ins lazy resolver is resolved from endpoint resolution.
src/AwsClient.php Outdated Show resolved Hide resolved
src/AwsClient.php Show resolved Hide resolved
src/ClientResolver.php Show resolved Hide resolved
src/AwsClient.php Show resolved Hide resolved
For resolving credentials just once per request, and no just once per client initialization, we are adding a middleware that will call forceRefresh method from the CredentialsLazyResolver implementation, and since this middleware will be executed in every request then, the credentials will be fresh per request. We are also fixing here how account_id_endpoint_mode configuration is being resolved.
@yenfryherrerafeliz yenfryherrerafeliz force-pushed the feat_account_id_endpoint_support branch 4 times, most recently from a76722e to bdcb928 Compare February 27, 2024 16:26
@yenfryherrerafeliz yenfryherrerafeliz force-pushed the feat_account_id_endpoint_support branch 3 times, most recently from 1a7ed29 to af2255d Compare February 27, 2024 16:33
src/ClientResolver.php Outdated Show resolved Hide resolved
src/ClientResolver.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
@yenfryherrerafeliz yenfryherrerafeliz force-pushed the feat_account_id_endpoint_support branch 3 times, most recently from 1a13737 to f8cbcde Compare February 28, 2024 14:25
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/Middleware.php Outdated Show resolved Hide resolved
In this change we add AccountId resolution for when AccountId is part of the rulesetParameters and accountIdEndpointMode is not disabled, in EndpointV2Middleware. If AccountId should be resolved then, we will resolve the credentialsProvider, which will resolve an identity from which we will extract the accountId, and if an accountId is not present in that resolved identity then, we will log a warning if accountIdEndpointMode is set to preferred or throw an exception if accountIdEndpointMode is required. Another part of this change is, that if we get up to the point of resolving the credentials provider then, we inject the resolved identity into $command['@context'] as the property 'resolved_identity'. We do this for trying to avoid having to resolve credentials more than once per request.
src/AwsClient.php Outdated Show resolved Hide resolved
src/ClientResolver.php Outdated Show resolved Hide resolved
src/Credentials/CredentialProvider.php Show resolved Hide resolved
src/Credentials/CredentialProvider.php Outdated Show resolved Hide resolved
$credentials = new Credentials(
$result['AccessKeyId'],
$result['SecretAccessKey'],
$result['Token'],
strtotime($result['Expiration'])
strtotime($result['Expiration']),
$accountId
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still applies

src/EndpointV2/EndpointV2Middleware.php Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/Middleware.php Outdated Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Show resolved Hide resolved
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
Addresses feedback for conditionally calling the method resolvingAccountId based on if the parameter is present in the rulesset of the endpoint provider.
Include tests coverage for AssumeRoleCredentialProvider, AssumeRoleWithWebIdentityCredentialProvider, process, shared files, and credentials from environment.
@yenfryherrerafeliz yenfryherrerafeliz force-pushed the feat_account_id_endpoint_support branch 3 times, most recently from cad9477 to c908f46 Compare March 19, 2024 15:25
src/EndpointV2/EndpointV2Middleware.php Outdated Show resolved Hide resolved
src/Credentials/InstanceProfileProvider.php Show resolved Hide resolved
src/Credentials/EcsCredentialProvider.php Outdated Show resolved Hide resolved
The validation of whether account_id should be resolved or not is going to be done by the ruleset, and therefore the validation logic around this needs to be removed.
- Move test cases into a valid existent class. In this case the tests in SourceAccountIdEndpointTest were moved to StsClient class.
- Create test for InstanceProfileProvider
- Create test for EcsCredentialProvider
@stobrien89 stobrien89 marked this pull request as ready for review March 21, 2024 16:52
Copy link
Member

@stobrien89 stobrien89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢 Ready to ship after ruleset testing. Thanks @yenfryherrerafeliz!

Remove null coalescing operator from the CredentialProvider class in order to prevent Docs Build to fail.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants