Enhancement Proposal: ExternalAuthFilter #4156
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,23 @@ | ||||||||||
|
|
||||||||||
| # Enhancement Proposal-4052: External AuthFilter | ||||||||||
|
|
||||||||||
| - Issue: https://github.com/nginx/nginx-gateway-fabric/issues/4052 | ||||||||||
| - Status: Provisional | ||||||||||
|
|
||||||||||
| ## Summary | ||||||||||
|
|
||||||||||
| [GEP-1494](https://gateway-api.sigs.k8s.io/geps/gep-1494/) defines an API for HTTPRoute to standardize Authentication and Authorization within the Gateway API. | ||||||||||
|
|
||||||||||
| This proposal aim to provider users of the Gateway API with a native form of Authenticaiton through Gateway API's [HTTPExternalAuthFilter](https://gateway-api.sigs.k8s.io/reference/spec/#httpexternalauthfilter) | ||||||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment.
Suggested change
|
||||||||||
|
|
||||||||||
| ## Goals | ||||||||||
|
|
||||||||||
| - Integrate with the [HTTPExternalAuthFilter](https://gateway-api.sigs.k8s.io/reference/spec/#httpexternalauthfilter) for HTTPRoute in the Gateway API | ||||||||||
| - Ensure this capability is available only when users enable experimental features in NGF | ||||||||||
| - Support only [HTTPAuthConfig](https://gateway-api.sigs.k8s.io/reference/spec/#httpauthconfig) | ||||||||||
| - Provide users with a helm chart to deploy, manage and configure NGINX for Authentication use cases. i.e. the External Service | ||||||||||
| - Allow users to configure an exteranl IdP such as Keycloak or AzureAD | ||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||
|
|
||||||||||
| ## Non-Goals | ||||||||||
|
|
||||||||||
| - Support for [GRPCAuthConfig](https://gateway-api.sigs.k8s.io/reference/spec/#grpcauthconfig) | ||||||||||
|
There was a problem hiding this comment. layer 4 routes are also out of scope here |
||||||||||
Oops, something went wrong.
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.
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.
Reminder: Provisional docs should only have the Goals and non-Goals, no design. This is described in the proposals README.
Once the goals are approved, then we add the design and update to Implementable.