-
Notifications
You must be signed in to change notification settings - Fork 597
docs: add provisional GEP for Gateway API Firewall Support #4148
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
# GEP-3614: Firewall | ||
|
||
* Issue: [#3614](https://github.com/kubernetes-sigs/gateway-api/issues/3614) | ||
* Status: Provisional | ||
|
||
## TLDR | ||
|
||
The ability to attach firewall rules for ingress L3, L4 and L7 Gateway traffic. | ||
|
||
## Motivation | ||
|
||
`Gateways` are commonly exposed to the internet, which puts them as risk of | ||
attack. Internal networks can become compromised as well. We should provide | ||
tooling, documentation and best-practices for users to restrict and control | ||
access to their `Gateways`. | ||
|
||
### Definitions | ||
|
||
* "Firewall Engine" - A processor of request payloads and applies rulesets to | ||
the contents to identify malicious, anomalous or otherwise unwanted traffic. | ||
These are generally at the front of the request path, and may be attached to a | ||
`Gateway` as a sidecar, integrated natively as part of the `Gateway`, or | ||
deployed in front of the `Gateway` as part of the networking path. | ||
|
||
### User Stories | ||
shaneutt marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I am concerned about the ability to actually fulfill the goals in this GEP. Just from reading the title, I was worried about running into the lowest-common-denominator problem: that there is almost no overlap between each firewall configuration surface, so we end up with an API that is not useful (or, we end up debating the API surface indefinitely). Gateway API actually does already have a solution for this, with policy attachment. I suspect you may disagree, but when we are faced with a problem set that doesn't have much overlap, policy attachment of implementation specific policies is a much better experience for users than attempting to make an API that doesn't work. After reading the GEP, my concerns are far greater, though. This set of goals is impossible to reasonable tackle. While the title if "Firewall", in typical products the feature set here actually spans 3-4 API surfaces: WAF, Authorization (typically separate from WAF!!), rate limiting, auditing, DLP. And I saw in the AI WG, LLM guardrails was also something of interest as part of this effort (which, again, differs from traditional WAF). I am very worried we are biting off way to much work with this effort and it will make it impossible to proceed. Just as an anecdote, even just rate limiting is ridiculously complex to design an API around. I suspect it would be harder than BackendTLSPolicy was... There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I am anticipating that we wont actually try to add significant API surface for this, see this conversation for some context. In any case, I'm open to the possibility that this GEP moves to
This is getting into the "How?" we do things, which we're not ready for yet.
I will make sure you are considered a stakeholder for reviews, and that your concerns are incorporated 👍
Agreed. This is getting into the "How?", which we will get stuck on if we discuss this now. The important thing for this iteration is to align on the motivation and goals at a high level. If we do that, and then we move to the implementation details and we simply can not produce something that's effective within a reasonable scope, and is supported by multiple stakeholders, it is OK to consider this There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
In this case, I'm also wondering how this provides value that is not already available through HTTPRoute extensionRef custom filters or policy attachment, or what is missing from the current extension points to support this use case? Something like first-class support for OWASP CRS configuration rules to provide WAF functionality in Gateway API might feel contentious and a scope stretch, but would at least feel more aligned with standardizing functionality within the Gateway API specification. This does feel like it could be a valuable proprietary feature or product positioning for a Gateway API implementation, but I don't really see a purpose-built extension point enabling this as appropriate for the spec, when existing generic extension points may be sufficient (and potentially support the same or related use cases, such as using WASM modules to mutate or drop requests or responses as @jcchavezs mentioned in #4148 (comment)). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Filters could be viable, we need to decide. This is an important part of the exercise of this GEP. There could be challenges. One challenge is the should language around the order of processing filters, which is not conducive to security systems.
Policy Attachment could be viable, we need to decide. This too is an important part of the exercise. There will be challenges, as it comes with many caveats. Ordering policies is one thing that can be challenging to get right, among others. We are into implementation details however. I want to be extra clear that if we get to the "How?" and there is no consensus, I am not shy about slapping a If possible however, the bare minimum I would like for this effort to result in a memorandum that provides some guidance to implementations that want to integrate firewalls with their |
||
|
||
* As an application developer, I want to allow specific IPs to access my | ||
application. | ||
* As an application developer, I want to block or allow requests based on | ||
headers; e.g. allow or deny specific user-agents. | ||
* As a gateway operator I want to be able to identify and block and log | ||
malformed HTTP requests before they reach backend applications. | ||
* As a gateway operator I want to be able to provide my own signature-based | ||
shaneutt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
detection rulesets to spot patterns of known malicious traffic and block and | ||
log them, updating those rules dynamically over time. | ||
* As a gateway operator I want to attach complete rulesets maintained by | ||
upstream standards bodies to block well known common threats and dynamically | ||
update for new threats over time. | ||
shaneutt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* As a gateway operator I want to detect anomalies in traffic (which may or | ||
may not be conclusively malicious) and log the requests with the option to | ||
block them as well. | ||
* As a cluster operator I want to be able to block traffic to gateways from | ||
specific geographical regions, or only allow specific regions. | ||
* As a cluster operator I want to be able to rate limit traffic to gateways to | ||
avoid overuse and abuse that could decrease stability and/or spike costs. | ||
* As a compliance officer I want to mutate (or block) and log responses that may | ||
contain personally identifiable information (PII). | ||
* As a gateway operator and in the context of a request I want information about | ||
the request (e.g. headers) to be defined as triggers for changes in the | ||
subsequent rules that apply to the request (modifying, or even disabling those | ||
rules based on the trigger). | ||
## Goals | ||
|
||
* Enable attaching firewall engines to a `Gateway` | ||
* Enable `Gateway`-level firewall rule enforcement | ||
* Enable `HTTPRoute`-level firewall rule enforcement | ||
* Enable processing of both requests _and_ responses | ||
* Provide documentation and best practices for implementations which describe | ||
how firewall engines and rules can best be integrated into a Gateway API | ||
implementation. | ||
|
||
## Non-Goals | ||
|
||
* Building a firewall implementation | ||
* Mesh-level support | ||
|
||
## API | ||
|
||
**TODO**: First PR will not include any implementation details, in favor of | ||
building consensus on the motivation, goals and non-goals first. _"How?"_ we | ||
implement shall be left open-ended until _"What?"_ and _"Why?"_ are solid. | ||
|
||
## Alternatives Considered | ||
|
||
### NetworkPolicy | ||
|
||
When discussing this originally the obvious question whether `NetworkPolicy` | ||
is sufficient, or should have some role in this, was asked. We do not consider | ||
it sufficient to resolve the goals unto itself. For the purposes of this GEP, | ||
we consider `NetworkPolicy` as an implementation detail at most: implementations | ||
_may_ choose how they enforce firewall rules, whether some of that is | ||
implemented with `NetworkPolicy` under the hood or not is up to them. | ||
|
||
## References | ||
|
||
* [GEP-1767: CORS](https://github.com/kubernetes-sigs/gateway-api/issues/1767) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
apiVersion: internal.gateway.networking.k8s.io/v1alpha1 | ||
kind: GEPDetails | ||
number: 3614 | ||
name: Gateway Firewall Support | ||
status: Provisional | ||
authors: | ||
- shaneutt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
QQ: I'm not 100% familiar with the naming used, but does "payloads" in this context include everything from the corresponding layer? E.g. layer7/http would include headers and not only body, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, correct.