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

aws signing filter: allows dynamic configuration of credentials #36109

Closed
mathetake opened this issue Sep 13, 2024 · 4 comments · Fixed by #36217
Closed

aws signing filter: allows dynamic configuration of credentials #36109

mathetake opened this issue Sep 13, 2024 · 4 comments · Fixed by #36217
Labels
area/aws enhancement Feature requests. Not bugs or questions.

Comments

@mathetake
Copy link
Member

mathetake commented Sep 13, 2024

Title: aws signing filter: allows dynamic configuration of credentials

Description:

Currently, for AssumeRoleWithWebIdentity, AWS singing filter can only extract WebIdentityToken from the local file pointed by AWS_WEB_IDENTITY_TOKEN_FILE environment variable. Also, the role arn can only be configured via AWS_ROLE_ARN.

I would love to configure them via xds.

The dynamically configured token will be passed at

const auto web_token_file_or_error = api_.fileSystem().fileReadToEnd(token_file_path_);

where currently the token read from the local file is passed.

The arn will be passed at

Envoy::Http::Utility::PercentEncoding::encode(role_arn_),

edited: this turned out to be not only about assume role with web identity but about any current configuration in general. So the solution would be to add a general "credential provider" API and allows control plane to provide the credential sources which are currently only configurable via env vars.

@mathetake mathetake added enhancement Feature requests. Not bugs or questions. triage Issue requires triage labels Sep 13, 2024
@mathetake
Copy link
Member Author

mathetake commented Sep 13, 2024

Not only the token but also I would like to dynamically configure AWS_ROLE_ARN as well

edited: modified the title and description accordingly.

@ravenblackx
Copy link
Contributor

cc @suniltheta

@ravenblackx ravenblackx added area/aws and removed triage Issue requires triage labels Sep 13, 2024
@mathetake mathetake changed the title aws signing filter: suport for dynamic configuration of WebIdentityToken aws signing filter: dynamic configuration of WebIdentityToken and RoleARN Sep 14, 2024
@mathetake
Copy link
Member Author

diff --git a/api/envoy/extensions/filters/http/aws_request_signing/v3/aws_request_signing.proto b/api/envoy/extensions/filters/http/aws_request_signing/v3/aws_request_signing.proto
index 5729d7f503..ef23e3b664 100644
--- a/api/envoy/extensions/filters/http/aws_request_signing/v3/aws_request_signing.proto
+++ b/api/envoy/extensions/filters/http/aws_request_signing/v3/aws_request_signing.proto
@@ -107,6 +107,24 @@ message AwsRequestSigning {
   // query_string: {}
   //
   QueryString query_string = 7;
+
+  // The credential provider for signing the request. This is optional and if not set,
+  // it will be retrieved from the procedure described in :ref:`config_http_filters_aws_request_signing`.
+  AwsRequestSigningCredentialProvider credential_provider = 8;
+}
+
+message AwsRequestSigningCredentialProvider {
+  oneof provider {
+    AssumeRoleWithWebIdentity assume_role_with_web_identity = 1;
+  }
+
+  message AssumeRoleWithWebIdentity {
+    // The ARN of the role to assume.
+    string role_arn = 1;
+
+    // The identity token that is provided by the identity provider to assume the role.
+    string identity_token = 2;
+  }
 }

quickly sketched a rough potential API change - wdyt? @suniltheta

@suniltheta
Copy link
Contributor

yes, sounds good to have the configurable option.
cc: @nbaws

@mathetake mathetake changed the title aws signing filter: dynamic configuration of WebIdentityToken and RoleARN aws signing filter: allows dynamic configuration of credentials Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/aws enhancement Feature requests. Not bugs or questions.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants