Restrict policies to non-duplicate routes #2318
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2318 +/- ##
==========================================
+ Coverage 87.77% 88.07% +0.29%
==========================================
Files 96 97 +1
Lines 6847 6993 +146
Branches 50 50
==========================================
+ Hits 6010 6159 +149
+ Misses 780 777 -3
Partials 57 57 ☔ View full report in Codecov by Sentry. |
sjberman
force-pushed
the
fix/policy-restriction
branch
2 times, most recently
from
273d0ab to
34b6db7
Compare
github-actions
bot
added
the
documentation
sjberman
force-pushed
the
fix/policy-restriction
branch
from
34b6db7 to
dece2b5
Compare
ADubhlaoich
approved these changes
Aug 2, 2024
kate-osborn
requested changes
Aug 2, 2024
internal/mode/static/nginx/config/policies/clientsettings/generator.go
Outdated
Show resolved
Hide resolved
internal/mode/static/nginx/config/policies/clientsettings/generator.go
Outdated
Show resolved
Hide resolved
internal/mode/static/nginx/config/policies/clientsettings/generator_test.go
Outdated
Show resolved
Hide resolved
sjberman
force-pushed
the
fix/policy-restriction
branch
from
dece2b5 to
cb06d8a
Compare
kate-osborn
approved these changes
Aug 5, 2024
bjee19
requested changes
Aug 6, 2024
internal/mode/static/nginx/config/policies/observability/generator.go
Outdated
Show resolved
Hide resolved
Problem: Some NGINX directives are not applied or enforced when configured in an internal location. This occurs when redirecting or rewriting a request from an external location to an internal location. Solution: Only accept a policy if the Route it targets is the only Route that matches the hostname, port, and path combination. If other Routes overlap, the policy will be rejected. This allows us to apply policy configuration to the external location instead of the internal locations. We would limit the policies we accept rather than limiting which Routes we accept. This is possible because, with the policy restriction, a policy cannot be applied to a Route that shares an external location with another Route. However, for the otel module, we still require some internal location directives to be specified, so the policy generator has been refactored to account for this. Finally, revert named locations back to internal locations. As part of this process, we've learned that named locations do not behave as expected. Co-authored-by: Kate Osborn <[email protected]>
sjberman
force-pushed
the
fix/policy-restriction
branch
from
8509c3b to
8fdf3a4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem: Some NGINX directives are not applied or enforced when configured in an internal location. This occurs when redirecting or rewriting a request from an external location to an internal location.
Solution: Only accept a policy if the Route it targets is the only Route that matches the hostname, port, and path combination. If other Routes overlap, the policy will be rejected.
This allows us to apply policy configuration to the external location instead of the internal locations. We would limit the policies we accept rather than limiting which Routes we accept.
This is possible because, with the policy restriction, a policy cannot be applied to a Route that shares an external location with another Route.
However, for the otel module, we still require some internal location directives to be specified, so the policy generator has been refactored to account for this.
Finally, revert named locations back to internal locations. As part of this process, we've learned that named locations do not behave as expected.
Testing: Manual verification that policies work with matching conditions, as well as Condition is set properly when overlapping routes exist in relation to a policy.
Closes #2308
Checklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes
If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.