Skip to content

api: Support ForwardUsernameHeader field in the BasicAuth #5342

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

Merged
zirain merged 3 commits into from
Feb 28, 2025
Merged

api: Support ForwardUsernameHeader field in the BasicAuth #5342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e855e64
feat: Support ForwardUsernameHeader field in the BasicAuth
surenraju Feb 24, 2025
26e5e8e
fix: Added +notImplementedHide
surenraju Feb 24, 2025
0ba4d1d
fix: missing changes
surenraju Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions api/v1alpha1/basic_auth_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,13 @@ type BasicAuth struct {
//
// Note: The secret must be in the same namespace as the SecurityPolicy.
Users gwapiv1.SecretObjectReference `json:"users"`

// This field specifies the header name to forward a successfully authenticated user to
// the backend. The header will be added to the request with the username as the value.
//
// If it is not specified, the username will not be forwarded.
//
// +optional
Comment thread
surenraju marked this conversation as resolved.
Outdated
// +notImplementedHide
ForwardUsernameHeader *string `json:"forwardUsernameHeader,omitempty"`
}
5 changes: 5 additions & 0 deletions api/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,13 @@ spec:
description: BasicAuth defines the configuration for the HTTP Basic
Authentication.
properties:
forwardUsernameHeader:
description: |-
This field specifies the header name to forward a successfully authenticated user to
the backend. The header will be added to the request with the username as the value.

If it is not specified, the username will not be forwarded.
type: string
users:
description: |-
The Kubernetes secret which contains the username-password pairs in
Expand Down