Skip to content
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

Add and test single filter action per header restriction #1497

Merged
merged 4 commits into from
Nov 9, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
13 changes: 8 additions & 5 deletions apis/v1beta1/httproute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -720,8 +720,12 @@ type HTTPHeader struct {
Value string `json:"value"`
}

// HTTPHeaderFilter defines a filter that modifies the headers of an HTTP request
// or response.
// HTTPHeaderFilter defines a filter that modifies the headers of an HTTP
// request or response. Only one action for a given header name is permitted.
// Filters MUST NOT specify multiple actions of the same or different type for
// any one header name. Configuration to set or add multiple values for a
rainest marked this conversation as resolved.
Show resolved Hide resolved
// header MUST use RFC 7230 header value formatting, separating each value with
// a comma.
type HTTPHeaderFilter struct {
// Set overwrites the request with the given header (name, value)
// before the action.
Expand Down Expand Up @@ -756,12 +760,11 @@ type HTTPHeaderFilter struct {
// Config:
// add:
// - name: "my-header"
// value: "bar"
// value: "bar,baz"
//
// Output:
// GET /foo HTTP/1.1
// my-header: foo
// my-header: bar
// my-header: foo,bar,baz
//
// +optional
// +listType=map
Expand Down
42 changes: 42 additions & 0 deletions apis/v1beta1/validation/httproute.go
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,12 @@ func validateHTTPRouteFilters(filters []gatewayv1b1.HTTPRouteFilter, matches []g
if filter.URLRewrite != nil && filter.URLRewrite.Path != nil {
errs = append(errs, validateHTTPPathModifier(*filter.URLRewrite.Path, matches, path.Index(i).Child("urlRewrite", "path"))...)
}
if filter.RequestHeaderModifier != nil {
errs = append(errs, validateHTTPHeaderModifier(*filter.RequestHeaderModifier, path.Index(i).Child("requestHeaderModifier"))...)
}
if filter.ResponseHeaderModifier != nil {
errs = append(errs, validateHTTPHeaderModifier(*filter.ResponseHeaderModifier, path.Index(i).Child("responseHeaderModifier"))...)
}
errs = append(errs, validateHTTPRouteFilterTypeMatchesValue(filter, path.Index(i))...)
}
// custom filters don't have any validation
Expand Down Expand Up @@ -276,6 +282,42 @@ func validateHTTPPathModifier(modifier gatewayv1b1.HTTPPathModifier, matches []g
return errs
}

func validateHTTPHeaderModifier(filter gatewayv1b1.HTTPHeaderFilter, path *field.Path) field.ErrorList {
var errs field.ErrorList
singleAction := make(map[string]bool)
for i, action := range filter.Add {
if needsErr, ok := singleAction[string(action.Name)]; ok {
if needsErr {
errs = append(errs, field.Invalid(path.Child("add"), filter.Add[i], "cannot specify multiple actions for header"))
}
singleAction[string(action.Name)] = false
} else {
singleAction[string(action.Name)] = true
}
}
for i, action := range filter.Set {
if needsErr, ok := singleAction[string(action.Name)]; ok {
if needsErr {
errs = append(errs, field.Invalid(path.Child("set"), filter.Set[i], "cannot specify multiple actions for header"))
}
singleAction[string(action.Name)] = false
} else {
singleAction[string(action.Name)] = true
}
}
for i, action := range filter.Remove {
if needsErr, ok := singleAction[action]; ok {
if needsErr {
errs = append(errs, field.Invalid(path.Child("remove"), filter.Remove[i], "cannot specify multiple actions for header"))
}
singleAction[action] = false
} else {
singleAction[action] = true
}
}
return errs
}

func hasExactlyOnePrefixMatch(matches []gatewayv1b1.HTTPRouteMatch) bool {
if len(matches) != 1 || matches[0].Path == nil {
return false
Expand Down
52 changes: 52 additions & 0 deletions apis/v1beta1/validation/httproute_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,58 @@ func TestValidateHTTPRoute(t *testing.T) {
},
}},
}},
}, {
name: "multiple actions for the same request header (invalid)",
rainest marked this conversation as resolved.
Show resolved Hide resolved
errCount: 2,
rules: []gatewayv1b1.HTTPRouteRule{{
Filters: []gatewayv1b1.HTTPRouteFilter{{
Type: gatewayv1b1.HTTPRouteFilterRequestHeaderModifier,
RequestHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
Add: []gatewayv1b1.HTTPHeader{
{
Name: gatewayv1b1.HTTPHeaderName("x-fruit"),
rainest marked this conversation as resolved.
Show resolved Hide resolved
Value: "apple",
},
{
Name: gatewayv1b1.HTTPHeaderName("x-vegetable"),
Value: "carrot",
},
{
Name: gatewayv1b1.HTTPHeaderName("x-grain"),
Value: "rye",
},
},
Set: []gatewayv1b1.HTTPHeader{
{
Name: gatewayv1b1.HTTPHeaderName("x-fruit"),
Value: "watermelon",
},
{
Name: gatewayv1b1.HTTPHeaderName("x-grain"),
Value: "wheat",
},
},
},
}},
}},
}, {
name: "multiple actions for the same response header (invalid)",
errCount: 1,
rules: []gatewayv1b1.HTTPRouteRule{{
Filters: []gatewayv1b1.HTTPRouteFilter{{
Type: gatewayv1b1.HTTPRouteFilterResponseHeaderModifier,
ResponseHeaderModifier: &gatewayv1b1.HTTPHeaderFilter{
Add: []gatewayv1b1.HTTPHeader{{
Name: gatewayv1b1.HTTPHeaderName("x-example"),
Value: "blueberry",
}},
Set: []gatewayv1b1.HTTPHeader{{
Name: gatewayv1b1.HTTPHeaderName("x-example"),
Value: "turnip",
}},
},
}},
}},
}}

for _, tc := range tests {
Expand Down

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

32 changes: 16 additions & 16 deletions config/crd/experimental/gateway.networking.k8s.io_httproutes.yaml

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

16 changes: 8 additions & 8 deletions config/crd/standard/gateway.networking.k8s.io_httproutes.yaml

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