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.

Sign up for GitHub

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

Jump to bottom

Fix the ability to disable ModSecurity at location level #5276

Merged
merged 1 commit into from
Mar 22, 2020
Merged

Fix the ability to disable ModSecurity at location level #5276

merged 1 commit into from
Mar 22, 2020

Conversation

bhavin192
Copy link
Contributor

What this PR does / why we need it:

  • Adds modsecurity off; to the nginx config if the enable-modsecurity annotation is set to false.
  • Update tests accordingly

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Which issue/s this PR fixes

fixes #5005

How Has This Been Tested?

  • Built container image
  • Modified the ConfigMap to enable ModSecurity
  • Applied an Ingress with enable-modsecurity: false annotation
  • Checked if nginx.conf is getting update correctly, (if it has the modsecurity off; config in location)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@k8s-ci-robot
Copy link
Contributor

Welcome @bhavin192!

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
Copy link
Contributor

Hi @bhavin192. 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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 21, 2020
@aledbf
Copy link
Member

aledbf commented Mar 21, 2020

/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 Mar 21, 2020
@aledbf
Copy link
Member

aledbf commented Mar 21, 2020 •
edited
Loading

@bhavin192 please add e2e tests to avoid regressions.

@bhavin192
Fix the ability to disable ModSecurity at location level
380ef3a 
- Adds 'modsecurity off;' to the nginx config if the
  'enable-modsecurity' annotation is set to false.
- Update tests and e2e tests accordingly

Signed-off-by: Bhavin Gandhi <bhavin7392@gmail.com>
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 22, 2020
@codecov-io
Copy link

Codecov Report

Merging #5276 into master will increase coverage by 0.03%.
The diff coverage is 67.64%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5276      +/-   ##
==========================================
+ Coverage   58.58%   58.61%   +0.03%     
==========================================
  Files          88       88              
  Lines        6879     6901      +22     
==========================================
+ Hits         4030     4045      +15     
- Misses       2407     2412       +5     
- Partials      442      444       +2
Impacted Files Coverage Δ
internal/ingress/controller/controller.go 49.40% <ø> (ø)
internal/ingress/annotations/modsecurity/main.go 61.11% <50.00%> (-1.39%) ⬇️
internal/ingress/annotations/rewrite/main.go 50.00% <57.14%> (+1.61%) ⬆️
cmd/nginx/flags.go 83.08% <66.66%> (+0.76%) ⬆️
internal/ingress/controller/template/template.go 80.10% <75.00%> (+0.02%) ⬆️
internal/ingress/controller/nginx.go 29.72% <100.00%> (+0.10%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8f4d5f8...380ef3a. Read the comment docs.

@bhavin192
Copy link
Contributor Author

/retest

@aledbf
Copy link
Member

aledbf commented Mar 22, 2020

/approve
/lgtm

@aledbf
Copy link
Member

aledbf commented Mar 22, 2020

@bhavin192 thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 22, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, bhavin192

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 Mar 22, 2020
@k8s-ci-robot k8s-ci-robot merged commit 4fc37ea into kubernetes:master Mar 22, 2020
@aledbf aledbf mentioned this pull request Mar 28, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aledbf aledbf Awaiting requested review from aledbf

@ElvinEfendi ElvinEfendi Awaiting requested review from ElvinEfendi

Assignees

@aledbf aledbf

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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Not able to disable ModSecurity per Ingress using annotations
4 participants
@bhavin192 @k8s-ci-robot @aledbf @codecov-io