Early Header Mutation

Makefile

@@ -54,7 +54,7 @@ SOURCES := $(shell find . -name "*.go" | grep -v test.go)
 # for more information, see https://github.com/solo-io/gloo/pull/9633
 # and
 # https://soloio.slab.com/posts/extended-http-methods-design-doc-40j7pjeu
-ENVOY_GLOO_IMAGE ?= quay.io/solo-io/envoy-gloo:1.31.2-patch1
+ENVOY_GLOO_IMAGE ?= quay.io/solo-io/envoy-gloo:1.31.2-patch3
 LDFLAGS := "-X github.com/solo-io/gloo/pkg/version.Version=$(VERSION)"
 GCFLAGS ?=
 

changelog/v1.18.0-beta34/early-header-manipulation.yaml

@@ -0,0 +1,22 @@
+changelog:
+  - type: NEW_FEATURE
+    issueLink: https://github.com/solo-io/gloo/issues/9604
+    description: >-
+      Added support for early header manipulation on Gateways.
+      This feature allows headers to be manipulated before significant processing 
+      and routing decisions.
+      It affords the ability to add or remove headers that affect request processing
+      and can be used to implement override headers.
+      This can be configured by setting the
+      `gateway.spec.httpGateway.options.httpConnectionManagerSettings.earlyHeaderMutation` field.
+      The headersToAdd field will add key-value pair headers to the request if not already 
+      present or overwrite them unless append is set to true.
+      The headersToRemove field removes the specified headers and is processed after 
+      the headers have been added.
+  - type: DEPENDENCY_BUMP
+    dependencyOwner: solo-io
+    dependencyRepo: envoy-gloo
+    dependencyTag: 1.31.2-patch3
+    description: >
+      Bumped the Envoy version to 1.31.2-patch3.
+      Needed the Early Header Manipulation extensions enabled.

docs/content/static/content/osa_provided.md

@@ -34,6 +34,7 @@ Name|Version|License
 [inconshreveable/go-update](https://github.com/inconshreveable/go-update)|v0.0.0-20160112193335-8152e7eb6ccf|UNKNOWN
 [jhump/protoreflect](https://github.com/jhump/protoreflect)|v1.15.3|Apache License 2.0
 [kelseyhightower/envconfig](https://github.com/kelseyhightower/envconfig)|v1.4.0|MIT License
+[go-httpbin/v2](https://github.com/mccutchen/go-httpbin)|v2.15.0|MIT License
 [olekukonko/tablewriter](https://github.com/olekukonko/tablewriter)|v0.0.5|MIT License
 [ginkgo/v2](https://github.com/onsi/ginkgo)|v2.20.1|MIT License
 [onsi/gomega](https://github.com/onsi/gomega)|v1.34.2|MIT License

docs/data/ProtoMap.yaml

@@ -1262,6 +1262,9 @@ apis:
   header_validation.options.gloo.solo.io.HeaderValidationSettings:
     relativepath: reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/options/header_validation/header_validation.proto.sk/#HeaderValidationSettings
     package: header_validation.options.gloo.solo.io
+  headers.options.gloo.solo.io.EarlyHeaderManipulation:
+    relativepath: reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/options/headers/headers.proto.sk/#EarlyHeaderManipulation
+    package: headers.options.gloo.solo.io
   headers.options.gloo.solo.io.HeaderManipulation:
     relativepath: reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/options/headers/headers.proto.sk/#HeaderManipulation
     package: headers.options.gloo.solo.io

go.mod

@@ -97,6 +97,7 @@ require (
 	github.com/golang/mock v1.6.0
 	github.com/google/go-cmp v0.6.0
 	github.com/google/uuid v1.6.0
+	github.com/mccutchen/go-httpbin/v2 v2.15.0
 	github.com/quasilyte/go-ruleguard/dsl v0.3.22
 	github.com/stretchr/testify v1.9.0
 	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56

go.sum

@@ -2374,6 +2374,8 @@ github.com/mattn/go-zglob v0.0.6/go.mod h1:MxxjyoXXnMxfIpxTK2GAkw1w8glPsQILx3N5w
 github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
 github.com/matttproud/golang_protobuf_extensions v1.0.4/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4=
 github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0/go.mod h1:QUyp042oQthUoa9bqDv0ER0wrtXnBruoNd7aNjkbP+k=
+github.com/mccutchen/go-httpbin/v2 v2.15.0 h1:3b2s8LMRR2aFd+8U+1Bx2kdgHNQ5ZQkQOiW8e52Jj9A=
+github.com/mccutchen/go-httpbin/v2 v2.15.0/go.mod h1:GBy5I7XwZ4ZLhT3hcq39I4ikwN9x4QUt6EAxNiR8Jus=
 github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b h1:j7+1HpAFS1zy5+Q4qx1fWh90gTKwiN4QCGoY9TWyyO4=
 github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE=
 github.com/miekg/dns v1.0.14/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg=

install/helm/gloo/crds/gateway.solo.io_v1_Gateway.yaml

@@ -853,6 +853,35 @@ spec:
                             type: string
                           drainTimeout:
                             type: string
+                          earlyHeaderManipulation:
+                            properties:
+                              headersToAdd:
+                                items:
+                                  properties:
+                                    append:
+                                      nullable: true
+                                      type: boolean
+                                    header:
+                                      properties:
+                                        key:
+                                          type: string
+                                        value:
+                                          type: string
+                                      type: object
+                                    headerSecretRef:
+                                      properties:
+                                        name:
+                                          type: string
+                                        namespace:
+                                          type: string
+                                      type: object
+                                  type: object
+                                type: array
+                              headersToRemove:
+                                items:
+                                  type: string
+                                type: array
+                            type: object
                           enableTrailers:
                             nullable: true
                             type: boolean
@@ -1502,6 +1531,35 @@ spec:
                             type: string
                           drainTimeout:
                             type: string
+                          earlyHeaderManipulation:
+                            properties:
+                              headersToAdd:
+                                items:
+                                  properties:
+                                    append:
+                                      nullable: true
+                                      type: boolean
+                                    header:
+                                      properties:
+                                        key:
+                                          type: string
+                                        value:
+                                          type: string
+                                      type: object
+                                    headerSecretRef:
+                                      properties:
+                                        name:
+                                          type: string
+                                        namespace:
+                                          type: string
+                                      type: object
+                                  type: object
+                                type: array
+                              headersToRemove:
+                                items:
+                                  type: string
+                                type: array
+                            type: object
                           enableTrailers:
                             nullable: true
                             type: boolean
@@ -2817,6 +2875,35 @@ spec:
                                       type: string
                                     drainTimeout:
                                       type: string
+                                    earlyHeaderManipulation:
+                                      properties:
+                                        headersToAdd:
+                                          items:
+                                            properties:
+                                              append:
+                                                nullable: true
+                                                type: boolean
+                                              header:
+                                                properties:
+                                                  key:
+                                                    type: string
+                                                  value:
+                                                    type: string
+                                                type: object
+                                              headerSecretRef:
+                                                properties:
+                                                  name:
+                                                    type: string
+                                                  namespace:
+                                                    type: string
+                                                type: object
+                                            type: object
+                                          type: array
+                                        headersToRemove:
+                                          items:
+                                            type: string
+                                          type: array
+                                      type: object
                                     enableTrailers:
                                       nullable: true
                                       type: boolean

install/helm/gloo/crds/gateway.solo.io_v1_HttpListenerOption.yaml

@@ -844,6 +844,35 @@ spec:
                         type: string
                       drainTimeout:
                         type: string
+                      earlyHeaderManipulation:
+                        properties:
+                          headersToAdd:
+                            items:
+                              properties:
+                                append:
+                                  nullable: true
+                                  type: boolean
+                                header:
+                                  properties:
+                                    key:
+                                      type: string
+                                    value:
+                                      type: string
+                                  type: object
+                                headerSecretRef:
+                                  properties:
+                                    name:
+                                      type: string
+                                    namespace:
+                                      type: string
+                                  type: object
+                              type: object
+                            type: array
+                          headersToRemove:
+                            items:
+                              type: string
+                            type: array
+                        type: object
                       enableTrailers:
                         nullable: true
                         type: boolean

install/helm/gloo/crds/gateway.solo.io_v1_MatchableHttpGateway.yaml

@@ -847,6 +847,35 @@ spec:
                             type: string
                           drainTimeout:
                             type: string
+                          earlyHeaderManipulation:
+                            properties:
+                              headersToAdd:
+                                items:
+                                  properties:
+                                    append:
+                                      nullable: true
+                                      type: boolean
+                                    header:
+                                      properties:
+                                        key:
+                                          type: string
+                                        value:
+                                          type: string
+                                      type: object
+                                    headerSecretRef:
+                                      properties:
+                                        name:
+                                          type: string
+                                        namespace:
+                                          type: string
+                                      type: object
+                                  type: object
+                                type: array
+                              headersToRemove:
+                                items:
+                                  type: string
+                                type: array
+                            type: object
                           enableTrailers:
                             nullable: true
                             type: boolean

projects/gloo/api/v1/options/hcm/hcm.proto

@@ -10,6 +10,7 @@ import "google/protobuf/any.proto";
 import "github.com/solo-io/gloo/projects/gloo/api/v1/options/tracing/tracing.proto";
 import "github.com/solo-io/gloo/projects/gloo/api/v1/options/protocol_upgrade/protocol_upgrade.proto";
 import "github.com/solo-io/gloo/projects/gloo/api/v1/options/protocol/protocol.proto";
+import "github.com/solo-io/gloo/projects/gloo/api/v1/options/headers/headers.proto";
 
 
 import "extproto/ext.proto";
@@ -240,4 +241,7 @@ message HttpConnectionManagerSettings {
     InternalAddressConfig internal_address_config = 38;
     // If true, configure Envoy to set the x-fowarded-port header to allow services to find Envoy's listener port.
     google.protobuf.BoolValue append_x_forwarded_port = 40;
+
+    // Configuration for early header manipulation
+    headers.options.gloo.solo.io.EarlyHeaderManipulation early_header_manipulation = 41;
 }

projects/gloo/api/v1/options/headers/headers.proto

@@ -40,6 +40,23 @@ message HeaderManipulation {
     repeated string response_headers_to_remove = 4;
 }
 
+// EarlyHeaderManipulation can be specified on Gateways to manipulate headers before significant processing
+// has happened and routing decisions are made.
+// Early header manipulation allows adding/removing headers that affect request processing
+// and can be used to implement override headers.
+// Note: The adding of headers happens before the removal of headers.
+message EarlyHeaderManipulation {
+    // Specifies a list of HTTP headers that should be added to each request
+    // handled by this gateway. For more information, including
+    // details on header value syntax, see the
+    // [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/headers.html#) .
+    repeated .solo.io.envoy.api.v2.core.HeaderValueOption headers_to_add = 1;
+
+
+    // Specifies a list of HTTP headers that should be removed from each request
+    // handled by this gateway.
+    repeated string headers_to_remove = 2;
+}
 
 // Header name/value pair plus option to control append behavior.
 message HeaderValueOption {