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

Do not expose the AWS role external id in the logs #4706

Merged

Conversation

iul1an
Copy link
Contributor

@iul1an iul1an commented Aug 27, 2024

Description

This change conceals the AWS ExternalId from application logs to mitigate security risks, as exposing this identifier could enable attackers to exploit it for unauthorized cross-account access or privilege escalation.

Fixes #4277

Checklist

  • Unit tests updated
  • End user documentation updated

Copy link

linux-foundation-easycla bot commented Aug 27, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: iul1an / name: Iulian Mandache (90c15d7)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Aug 27, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @iul1an!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/external-dns has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @iul1an. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Aug 27, 2024
provider/aws/session.go Outdated Show resolved Hide resolved
@mloiseleur
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 3, 2024
@mloiseleur
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 4, 2024
@@ -86,7 +86,7 @@ type Config struct {
AWSZoneTagFilter []string
AWSAssumeRole string
AWSProfiles []string
AWSAssumeRoleExternalID string
AWSAssumeRoleExternalID string `secure:"yes"`
Copy link
Contributor

Choose a reason for hiding this comment

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

why do we need this?
I guess we do not need this, so please cleanup

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The label is needed to mask the AWSAssumeRoleExternalID value in the logs.
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

relevant code:

  • const (
    passwordMask = "******"
    )
  • func (cfg *Config) String() string {
    // prevent logging of sensitive information
    temp := *cfg
    t := reflect.TypeOf(temp)
    for i := 0; i < t.NumField(); i++ {
    f := t.Field(i)
    if val, ok := f.Tag.Lookup("secure"); ok && val == "yes" {
    if f.Type.Kind() != reflect.String {
    continue
    }
    v := reflect.ValueOf(&temp).Elem().Field(i)
    if v.String() != "" {
    v.SetString(passwordMask)
    }
    }
    }
    return fmt.Sprintf("%+v", temp)
    }

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 7, 2024
@iul1an iul1an force-pushed the hide-AWSAssumeRoleExternalID branch from f5f7d23 to 454fce1 Compare September 7, 2024 23:10
@k8s-ci-robot k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Sep 7, 2024
@iul1an iul1an force-pushed the hide-AWSAssumeRoleExternalID branch from 454fce1 to 90c15d7 Compare September 7, 2024 23:13
@iul1an
Copy link
Contributor Author

iul1an commented Sep 12, 2024

@mloiseleur Can you review again, please? I had to rebase.

@mloiseleur
Copy link
Contributor

/lgtm
/assign @szuecs
/unassign @mloiseleur

@k8s-ci-robot k8s-ci-robot assigned szuecs and unassigned mloiseleur Sep 13, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 13, 2024
@iul1an iul1an requested a review from szuecs September 30, 2024 13:48
@szuecs
Copy link
Contributor

szuecs commented Oct 10, 2024

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: szuecs

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 10, 2024
@szuecs
Copy link
Contributor

szuecs commented Oct 10, 2024

debug logs enable the user to figure out if the role id is wrong or something like that, so seems fine.
Thanks for the contribution

@k8s-ci-robot k8s-ci-robot merged commit b024fc9 into kubernetes-sigs:master Oct 10, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Hide the AWS assume role ExternalID
4 participants