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

Add partitioned cookie support for cookie-affinity #11242

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

avif
Copy link

@avif avif commented Apr 9, 2024

What this PR does / why we need it:

This adds the option of making the session cookie "partitioned" via an annotation nginx.ingress.kubernetes.io/session-cookie-partitioned, this is needed to support Cookies Having Independent Partitioned State (CHIPS) (See #10428).

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

Which issue/s this PR fixes

fixes #10428

How Has This Been Tested?

  • Unit tests

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed. - (Could not run all unit tests successfully before the changes [something about storing a fake SSL cert], so they still failed after the changes)

Copy link

linux-foundation-easycla bot commented Apr 9, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. area/docs needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. area/lua Issues or PRs related to lua code labels Apr 9, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @avif!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. 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-nginx 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-kind Indicates a PR lacks a `kind/foo` label and requires one. label Apr 9, 2024
@k8s-ci-robot k8s-ci-robot requested a review from puerco April 9, 2024 22:48
@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 Apr 9, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @avif. 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/test-infra repository.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: avif
Once this PR has been reviewed and has the lgtm label, please assign puerco for approval. For more information see the Kubernetes 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 added needs-priority size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 9, 2024
Copy link

netlify bot commented Apr 9, 2024

Deploy Preview for kubernetes-ingress-nginx ready!

Name Link
🔨 Latest commit 03c5ce5
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/6703d0643ae0b30008336335
😎 Deploy Preview https://deploy-preview-11242--kubernetes-ingress-nginx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@k8s-ci-robot k8s-ci-robot added 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 Apr 9, 2024
# Check for recent changes: https://github.com/utix/lua-resty-cookie/compare/9533f47...master
export LUA_RESTY_COOKIE_VERSION=9533f479371663107b515590fc9daf00d61ebf11
# Check for recent changes: https://github.com/utix/lua-resty-cookie/compare/12136f5...master
export LUA_RESTY_COOKIE_VERSION=12136f546ec4222e198c2d7c73dd83fc3539df32
Copy link
Contributor

Choose a reason for hiding this comment

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

can you please update nginx-1.25 folder as well please?

Copy link
Author

Choose a reason for hiding this comment

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

Done, i'll note that it was still using the cloudflare build so this change bumps it several versions up.

@@ -99,6 +99,7 @@ function _M.set_cookie(self, value)
httponly = true,
samesite = cookie_samesite,
secure = cookie_secure,
partitioned = self.cookie_session_affinity.partitioned,
Copy link
Contributor

Choose a reason for hiding this comment

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

@tao12345666333 need someone with lua knowledge here :)

@rikatz
Copy link
Contributor

rikatz commented Apr 15, 2024

/ok-to-test

From go side lgtm, I'm wondering if there's no release on lua cookies module yet, instead of tracking a commit.

Thanks

@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 Apr 15, 2024
@avif
Copy link
Author

avif commented Apr 16, 2024

/ok-to-test

From go side lgtm, I'm wondering if there's no release on lua cookies module yet, instead of tracking a commit.

Thanks

Switched to tags instead of commits.

@avif avif requested a review from rikatz April 16, 2024 12:07
@avif
Copy link
Author

avif commented May 8, 2024

Any chance to get a review? :)
@tao12345666333
@rikatz

@longwuyuan
Copy link
Contributor

/triage accepted
/kind feature

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. kind/feature Categorizes issue or PR as related to a new feature. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels May 8, 2024
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 19, 2024
@miskr-instructure
Copy link

Hey, is there any chance someone can resurrect this PR?

@longwuyuan
Copy link
Contributor

CC @Gacko @rikatz @tao12345666333 if/when possible, please review.

@avif @miskr-instructure this needs rebase

Copy link
Member

@Gacko Gacko left a comment

Choose a reason for hiding this comment

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

I cannot give a lot of review regarding the actual change, but I definitely have serious doubts about changing the Lua Resty Cookie module.

Could you please elaborate on why this is needed? Normally we discourage such bumps and changes to the modules being built into NGINX in PRs and would prefer having a discussion first.

Sorry to say, but I can remember serious issues in the past and therefore we're just a bit more cautious when it comes to such changes.

@avif avif force-pushed the partitioned-cookie-support branch from e7fcfed to 8777f34 Compare October 2, 2024 20:07
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 2, 2024
@avif
Copy link
Author

avif commented Oct 7, 2024

@Gacko

I cannot give a lot of review regarding the actual change, but I definitely have serious doubts about changing the Lua Resty Cookie module.

Actually it was already changed from cloudflare/lua-resty-cookie@0.1.0 to utix/lua-resty-cookie#9533f47 by this change and was reverted (possibly by mistake) by this change, I just bumped the version.

Could you please elaborate on why this is needed? Normally we discourage such bumps and changes to the modules being built into NGINX in PRs and would prefer having a discussion first.

Sure, the cloudflare repo is archived and so has no newer versions.
As for the bump in version, Partitioned is new cookie semantics and did not exist in the currently used package (pre or post revert).

Sorry to say, but I can remember serious issues in the past and therefore we're just a bit more cautious when it comes to such changes.

No need to apologize, I for one appreciate the cautious approach.

@avif avif requested a review from Gacko October 8, 2024 06:28
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 5, 2024
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs area/lua Issues or PRs related to lua code cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. needs-priority needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support Partitioned attribute in sticky cookies
6 participants