feat: forward basic auth user

api/v1alpha1/basic_auth_types.go

@@ -5,7 +5,10 @@
 
 package v1alpha1
 
-import gwapiv1b1 "sigs.k8s.io/gateway-api/apis/v1beta1"
+import (
+	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
+	gwapiv1b1 "sigs.k8s.io/gateway-api/apis/v1beta1"
+)
 
 const BasicAuthUsersSecretKey = ".htpasswd"
 
@@ -24,4 +27,10 @@ type BasicAuth struct {
 	//
 	// Note: The secret must be in the same namespace as the SecurityPolicy.
 	Users gwapiv1b1.SecretObjectReference `json:"users"`
+
+	// The name of the HTTP header that will be used to forward the username to the upstream server.
+	// Please note that the header name is a global setting for all the routes in a Gateway.
+	// If multiple routes have different header names, a random one will be chosen.
+	// +optional
+	UserNameToHeader *gwapiv1.HeaderName `json:"userNameToHeader,omitempty"`
 }

charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml

@@ -188,6 +188,15 @@ spec:
                 description: BasicAuth defines the configuration for the HTTP Basic
                   Authentication.
                 properties:
+                  userNameToHeader:
+                    description: |-
+                      The name of the HTTP header that will be used to forward the username to the upstream server.
+                      Please note that the header name is a global setting for all the routes in a Gateway.
+                      If multiple routes have different header names, a random one will be chosen.
+                    maxLength: 256
+                    minLength: 1
+                    pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
+                    type: string
                   users:
                     description: |-
                       The Kubernetes secret which contains the username-password pairs in

internal/gatewayapi/securitypolicy.go

@@ -778,6 +778,7 @@ func (t *Translator) buildBasicAuth(
 	var (
 		basicAuth   = policy.Spec.BasicAuth
 		usersSecret *corev1.Secret
+		userNameToHeader *string
 		err         error
 	)
 
@@ -798,9 +799,14 @@ func (t *Translator) buildBasicAuth(
 			usersSecret.Namespace, usersSecret.Name)
 	}
 
+	if basicAuth.UserNameToHeader != nil {
+		userNameToHeader = (*string)(ptr.To(*basicAuth.UserNameToHeader))
+	}
+
 	return &ir.BasicAuth{
-		Name:  irConfigName(policy),
-		Users: usersSecretBytes,
+		Name:             irConfigName(policy),
+		Users:            usersSecretBytes,
+		UserNameToHeader: userNameToHeader,
 	}, nil
 }
 

internal/gatewayapi/testdata/securitypolicy-with-basic-auth.in.yaml

@@ -87,6 +87,7 @@ securityPolicies:
       basicAuth:
         users:
           name: "users-secret1"
+        userNameToHeader: x-basic-auth-user
   - apiVersion: gateway.envoyproxy.io/v1alpha1
     kind: SecurityPolicy
     metadata:

internal/gatewayapi/testdata/securitypolicy-with-basic-auth.out.yaml

@@ -147,6 +147,7 @@ securityPolicies:
     namespace: default
   spec:
     basicAuth:
+      userNameToHeader: x-basic-auth-user
       users:
         group: null
         kind: null
@@ -250,6 +251,7 @@ xdsIR:
         security:
           basicAuth:
             name: securitypolicy/default/policy-for-http-route-1
+            userNameToHeader: x-basic-auth-user
             users: dXNlcjE6e1NIQX10RVNzQm1FL3lOWTNsYjZhMEw2dlZRRVpOcXc9CnVzZXIyOntTSEF9RUo5TFBGRFhzTjl5blNtYnh2anA3NUJtbHg4PQo=
       - destination:
           name: httproute/default/httproute-1/rule/1
@@ -274,6 +276,7 @@ xdsIR:
         security:
           basicAuth:
             name: securitypolicy/default/policy-for-http-route-1
+            userNameToHeader: x-basic-auth-user
             users: dXNlcjE6e1NIQX10RVNzQm1FL3lOWTNsYjZhMEw2dlZRRVpOcXc9CnVzZXIyOntTSEF9RUo5TFBGRFhzTjl5blNtYnh2anA3NUJtbHg4PQo=
       - destination:
           name: httproute/default/httproute-2/rule/0

internal/ir/xds.go

@@ -842,6 +842,9 @@ type BasicAuth struct {
 
 	// The username-password pairs in htpasswd format.
 	Users []byte `json:"users,omitempty" yaml:"users,omitempty"`
+
+	// The HTTP header field that will be used to send the extracted username to the backend.
+	UserNameToHeader *string `json:"userNameToHeader,omitempty" yaml:"userNameToHeader,omitempty"`
 }
 
 // ExtAuth defines the schema for the external authorization.

internal/xds/translator/basicauth.go

@@ -42,32 +42,37 @@ func (*basicAuth) patchHCM(mgr *hcmv3.HttpConnectionManager, irListener *ir.HTTP
 	}
 
 	var (
-		irBasicAuth *ir.BasicAuth
-		filter      *hcmv3.HttpFilter
-		err         error
+		irBasicAuth      *ir.BasicAuth
+		userNameToHeader *string
+		filter           *hcmv3.HttpFilter
+		err              error
 	)
 
 	for _, route := range irListener.Routes {
 		if route.Security != nil && route.Security.BasicAuth != nil {
 			irBasicAuth = route.Security.BasicAuth
-			break
+			// if any route has a UserNameToHeader set, forward the username to the upstream server.
+			if irBasicAuth.UserNameToHeader != nil {
+				userNameToHeader = irBasicAuth.UserNameToHeader
+				break
+			}
 		}
 	}
 	if irBasicAuth == nil {
 		return nil
 	}
 
-	// We use the first route that contains the basicAuth config to build the filter.
+	// We use a random route that contains the basicAuth config to build the filter.
 	// The HCM-level filter config doesn't matter since it is overridden at the route level.
-	if filter, err = buildHCMBasicAuthFilter(irBasicAuth); err != nil {
+	if filter, err = buildHCMBasicAuthFilter(irBasicAuth, userNameToHeader); err != nil {
 		return err
 	}
 	mgr.HttpFilters = append(mgr.HttpFilters, filter)
 	return err
 }
 
 // buildHCMBasicAuthFilter returns a basic_auth HTTP filter from the provided IR HTTPRoute.
-func buildHCMBasicAuthFilter(basicAuth *ir.BasicAuth) (*hcmv3.HttpFilter, error) {
+func buildHCMBasicAuthFilter(basicAuth *ir.BasicAuth, userNameToHeader *string) (*hcmv3.HttpFilter, error) {
 	var (
 		basicAuthProto *basicauthv3.BasicAuth
 		basicAuthAny   *anypb.Any
@@ -81,6 +86,11 @@ func buildHCMBasicAuthFilter(basicAuth *ir.BasicAuth) (*hcmv3.HttpFilter, error)
 			},
 		},
 	}
+
+	if userNameToHeader != nil {
+		basicAuthProto.ForwardUsernameHeader = *userNameToHeader
+	}
+
 	if err = basicAuthProto.ValidateAll(); err != nil {
 		return nil, err
 	}

internal/xds/translator/testdata/in/xds-ir/basic-auth.yaml

@@ -32,6 +32,7 @@ http:
       basicAuth:
         name: securitypolicy/default/policy-for-http-route-1
         users: dXNlcjE6e1NIQX10RVNzQm1FL3lOWTNsYjZhMEw2dlZRRVpOcXc9CnVzZXIyOntTSEF9RUo5TFBGRFhzTjl5blNtYnh2anA3NUJtbHg4PQo=
+        userNameToHeader: x-basic-auth-user
   - name: httproute/default/httproute-1/rule/1/match/0/www_foo_com
     backendWeights:
     hostname: www.foo.com
@@ -55,6 +56,7 @@ http:
       basicAuth:
         name: securitypolicy/default/policy-for-http-route-1
         users: dXNlcjE6e1NIQX10RVNzQm1FL3lOWTNsYjZhMEw2dlZRRVpOcXc9CnVzZXIyOntTSEF9RUo5TFBGRFhzTjl5blNtYnh2anA3NUJtbHg4PQo=
+        userNameToHeader: x-basic-auth-user
   - name: httproute/default/httproute-2/rule/0/match/0/www_bar_com
     hostname: www.bar.com
     isHTTP2: false

internal/xds/translator/testdata/out/xds-ir/basic-auth.listeners.yaml

@@ -18,6 +18,7 @@
           name: envoy.filters.http.basic_auth
           typedConfig:
             '@type': type.googleapis.com/envoy.extensions.filters.http.basic_auth.v3.BasicAuth
+            forwardUsernameHeader: x-basic-auth-user
             users:
               inlineBytes: dXNlcjE6e1NIQX10RVNzQm1FL3lOWTNsYjZhMEw2dlZRRVpOcXc9CnVzZXIyOntTSEF9RUo5TFBGRFhzTjl5blNtYnh2anA3NUJtbHg4PQo=
         - name: envoy.filters.http.router

site/content/en/latest/api/extension_types.md

@@ -493,7 +493,12 @@ _Appears in:_
 
 | Field | Type | Required | Description |
 | ---   | ---  | ---      | ---         |
+<<<<<<< HEAD
+| `users` | _[SecretObjectReference](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1.SecretObjectReference)_ |  true  | The Kubernetes secret which contains the username-password pairs in<br />htpasswd format, used to verify user credentials in the "Authorization"<br />header.<br /><br />This is an Opaque secret. The username-password pairs should be stored in<br />the key ".htpasswd". As the key name indicates, the value needs to be the<br />htpasswd format, for example: "user1:{SHA}hashed_user1_password".<br />Right now, only SHA hash algorithm is supported.<br />Reference to https://httpd.apache.org/docs/2.4/programs/htpasswd.html<br />for more details.<br /><br />Note: The secret must be in the same namespace as the SecurityPolicy. |
+| `userNameToHeader` | _[HeaderName](#headername)_ |  false  | The name of the HTTP header that will be used to forward the username to the upstream server.<br />Please note that the header name is a global setting for all the routes in a Gateway.<br />If multiple routes have different header names, a random one will be chosen. |
+=======
 | `users` | _[SecretObjectReference](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1.SecretObjectReference)_ |  true  | The Kubernetes secret which contains the username-password pairs in<br />htpasswd format, used to verify user credentials in the "Authorization"<br />header.<br /><br />This is an Opaque secret. The username-password pairs should be stored in<br />the key ".htpasswd". As the key name indicates, the value needs to be the<br />htpasswd format, for example: "user1:\{SHA\}hashed_user1_password".<br />Right now, only SHA hash algorithm is supported.<br />Reference to https://httpd.apache.org/docs/2.4/programs/htpasswd.html<br />for more details.<br /><br />Note: The secret must be in the same namespace as the SecurityPolicy. |
+>>>>>>> upstream/main
 
 
 #### BootstrapType

test/e2e/testdata/basic-auth.yaml

@@ -62,6 +62,7 @@ spec:
   basicAuth:
     users:
       name: "basic-auth-users-secret-1"
+    userNameToHeader: x-basic-auth-user
 ---
 apiVersion: gateway.envoyproxy.io/v1alpha1
 kind: SecurityPolicy

test/e2e/tests/basic_auth.go

@@ -52,6 +52,14 @@ var BasicAuthTest = suite.ConformanceTest{
 						"Authorization": "Basic dXNlcjE6dGVzdDE=", // user1:test1
 					},
 				},
+				ExpectedRequest: &http.ExpectedRequest{
+					Request: http.Request{
+						Path: "/basic-auth-1",
+						Headers: map[string]string{
+							"x-basic-auth-user": "user1",
+						},
+					},
+				},
 				Response: http.Response{
 					StatusCode: 200,
 				},