Skip to content

Fix IAP OAuth credentials not being fetched when IAP is disabled #2939

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
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sysedwinistrator
Copy link

The behavior in validateIAP() of treating .spec.iap.enabled=false as equivalent to .spec.iap=nil and abort all validation is incongruent with that in pkg/backends/features/iap.go, where a full sync of the IAP configuration is triggered as long as .spec.iap!=nil.

The latter behavior is the correct one, as it allows disabling IAP on an ingress where it was previously enabled by setting .spec.spec.enabled=false in the BackendConfig.

However, because pkg/backendconfig/validation.go skips the entire validation and with that the lookup of the OAuth credentials referenced in .spec.iap.oauthclientCredentials.secretName, the desired BackendConfig's OAuth Client ID will be uninitialized and interpreted as empty (""). And in the case that IAP was previously configured with a non-default Client ID, this will trigger a switchingToDefaultError.

TL;DR: This allows disabling IAP on BackendConfig when a non-default OAuth Client has been configured before. It's still necessary to keep the OAuth client credentials in the BackendConfig while IAP is being disabled.

The behavior in validateIAP() of treating .spec.iap.enabled=false as
equivalent to .spec.iap=nil and abort all validation is incongruent with
that in pkg/backends/features/iap.go, where a full sync of the IAP
configuration is triggered as long as .spec.iap!=nil.

The latter behavior is the correct one, as it allows disabling IAP on an
ingress where it was previously enabled by setting
.spec.spec.enabled=false in the BackendConfig.

However, because pkg/backendconfig/validation.go skips the entire
validation and with that the lookup of the OAuth credentials referenced
in .spec.iap.oauthclientCredentials.secretName, the desired
BackendConfig's OAuth Client ID will be uninitialized and interpreted
as empty (""). And in the case that IAP was previously configured with a
non-default Client ID, this will trigger a switchingToDefaultError.
Copy link

linux-foundation-easycla bot commented Jul 29, 2025

CLA Signed

  • ✅login: sysedwinistrator / (a1f477f)

The committers listed above are authorized under a signed CLA.

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

Welcome @sysedwinistrator!

It looks like this is your first PR to kubernetes/ingress-gce 🎉. 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/ingress-gce 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 k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 29, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @sysedwinistrator. Thanks for your PR.

I'm waiting for a kubernetes 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
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sysedwinistrator
Once this PR has been reviewed and has the lgtm label, please assign code-elinka for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 requested review from aojea and sawsa307 July 29, 2025 15:06
@k8s-ci-robot k8s-ci-robot added 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 Jul 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants