Skip to content

feat(cors): Add wildcard port matching for CORS allowOrigins #8708

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

Open
GajanSoorian wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(cors): Add wildcard port matching for CORS allowOrigins #8708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions api/v1alpha1/cors_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ import gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
// Origin is defined by the scheme (protocol), hostname (domain), and port of
// the URL used to access it. The hostname can be "precise" which is just the
// domain name or "wildcard" which is a domain name prefixed with a single
// wildcard label such as "*.example.com".
// wildcard label such as "*.example.com". The optional port can be a wildcard
// as well to allow all ports.
// In addition to that a single wildcard (with or without scheme) can be
// configured to match any origin.
//
Expand All @@ -19,11 +20,12 @@ import gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
// - https://*.example.com
// - http://foo.example.com:8080
// - http://*.example.com:8080
// - https://localhost:*
// - https://*
//
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=253
// +kubebuilder:validation:Pattern=`^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:\d{1,5})?)$`
// +kubebuilder:validation:Pattern=`^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:(\*|\d{1,5}))?)$`
type Origin string

// CORS defines the configuration for Cross-Origin Resource Sharing (CORS).
Expand Down
6 changes: 4 additions & 2 deletions charts/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_securitypolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,8 @@ spec:
Origin is defined by the scheme (protocol), hostname (domain), and port of
the URL used to access it. The hostname can be "precise" which is just the
domain name or "wildcard" which is a domain name prefixed with a single
wildcard label such as "*.example.com".
wildcard label such as "*.example.com". The optional port can be a wildcard
as well to allow all ports.
In addition to that a single wildcard (with or without scheme) can be
configured to match any origin.

Expand All @@ -596,10 +597,11 @@ spec:
- https://*.example.com
- http://foo.example.com:8080
- http://*.example.com:8080
- https://localhost:*
- https://*
maxLength: 253
minLength: 1
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:\d{1,5})?)$
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:(\*|\d{1,5}))?)$
Comment thread
GajanSoorian marked this conversation as resolved.
type: string
type: array
exposeHeaders:
Expand Down
6 changes: 4 additions & 2 deletions charts/gateway-helm/charts/crds/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,7 +586,8 @@ spec:
Origin is defined by the scheme (protocol), hostname (domain), and port of
the URL used to access it. The hostname can be "precise" which is just the
domain name or "wildcard" which is a domain name prefixed with a single
wildcard label such as "*.example.com".
wildcard label such as "*.example.com". The optional port can be a wildcard
as well to allow all ports.
In addition to that a single wildcard (with or without scheme) can be
configured to match any origin.

Expand All @@ -595,10 +596,11 @@ spec:
- https://*.example.com
- http://foo.example.com:8080
- http://*.example.com:8080
- https://localhost:*
- https://*
maxLength: 253
minLength: 1
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:\d{1,5})?)$
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:(\*|\d{1,5}))?)$
type: string
type: array
exposeHeaders:
Expand Down
24 changes: 24 additions & 0 deletions internal/gatewayapi/securitypolicy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,30 @@ func Test_wildcard2regex(t *testing.T) {
origin: "http://foo.example.com",
want: 1,
},
{
name: "test11",
wildcard: "http://*.example.com:*",
origin: "http://foo.example.com:8080",
want: 1,
},
{
name: "test12",
wildcard: "http://*.example.com:*",
origin: "http://foo.example.com",
want: 0,
},
{
name: "test13",
wildcard: "http://localhost:*",
origin: "http://localhost:1234",
want: 1,
},
{
name: "test14",
wildcard: "http://localhost:*",
origin: "http://localhost",
want: 0,
},
}

for _, tt := range tests {
Expand Down
4 changes: 3 additions & 1 deletion site/content/en/latest/api/extension_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4215,7 +4215,8 @@ _Underlying type:_ _string_
Origin is defined by the scheme (protocol), hostname (domain), and port of
the URL used to access it. The hostname can be "precise" which is just the
domain name or "wildcard" which is a domain name prefixed with a single
wildcard label such as "*.example.com".
wildcard label such as "*.example.com". The optional port can be a wildcard
as well to allow all ports.
In addition to that a single wildcard (with or without scheme) can be
configured to match any origin.

Expand All @@ -4224,6 +4225,7 @@ For example, the following are valid origins:
- https://*.example.com
- http://foo.example.com:8080
- http://*.example.com:8080
- https://localhost:*
- https://*

_Appears in:_
Expand Down
6 changes: 3 additions & 3 deletions test/cel-validation/securitypolicy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ func TestSecurityPolicyTarget(t *testing.T) {
}
},
wantErrors: []string{
"spec.cors.allowOrigins[0]: Invalid value: \"https://foo.*.com\": spec.cors.allowOrigins[0] in body should match '^(\\*|https?:\\/\\/(\\*|(\\*\\.)?(([\\w-]+\\.?)+)?[\\w-]+)(:\\d{1,5})?)$'",
"spec.cors.allowOrigins[0]: Invalid value: \"https://foo.*.com\": spec.cors.allowOrigins[0] in body should match '^(\\*|https?:\\/\\/(\\*|(\\*\\.)?(([\\w-]+\\.?)+)?[\\w-]+)(:(\\*|\\d{1,5}))?)$'",
},
},
{
Expand All @@ -429,7 +429,7 @@ func TestSecurityPolicyTarget(t *testing.T) {
}
},
wantErrors: []string{
"spec.cors.allowOrigins[0]: Invalid value: \"foo.bar.com\": spec.cors.allowOrigins[0] in body should match '^(\\*|https?:\\/\\/(\\*|(\\*\\.)?(([\\w-]+\\.?)+)?[\\w-]+)(:\\d{1,5})?)$'",
"spec.cors.allowOrigins[0]: Invalid value: \"foo.bar.com\": spec.cors.allowOrigins[0] in body should match '^(\\*|https?:\\/\\/(\\*|(\\*\\.)?(([\\w-]+\\.?)+)?[\\w-]+)(:(\\*|\\d{1,5}))?)$'",
},
},
{
Expand All @@ -453,7 +453,7 @@ func TestSecurityPolicyTarget(t *testing.T) {
}
},
wantErrors: []string{
"spec.cors.allowOrigins[0]: Invalid value: \"grpc://foo.bar.com\": spec.cors.allowOrigins[0] in body should match '^(\\*|https?:\\/\\/(\\*|(\\*\\.)?(([\\w-]+\\.?)+)?[\\w-]+)(:\\d{1,5})?)$'",
"spec.cors.allowOrigins[0]: Invalid value: \"grpc://foo.bar.com\": spec.cors.allowOrigins[0] in body should match '^(\\*|https?:\\/\\/(\\*|(\\*\\.)?(([\\w-]+\\.?)+)?[\\w-]+)(:(\\*|\\d{1,5}))?)$'",
},
},

Expand Down
6 changes: 4 additions & 2 deletions test/helm/gateway-crds-helm/all.out.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49982,7 +49982,8 @@ spec:
Origin is defined by the scheme (protocol), hostname (domain), and port of
the URL used to access it. The hostname can be "precise" which is just the
domain name or "wildcard" which is a domain name prefixed with a single
wildcard label such as "*.example.com".
wildcard label such as "*.example.com". The optional port can be a wildcard
as well to allow all ports.
In addition to that a single wildcard (with or without scheme) can be
configured to match any origin.

Expand All @@ -49991,10 +49992,11 @@ spec:
- https://*.example.com
- http://foo.example.com:8080
- http://*.example.com:8080
- https://localhost:*
- https://*
maxLength: 253
minLength: 1
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:\d{1,5})?)$
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:(\*|\d{1,5}))?)$
type: string
type: array
exposeHeaders:
Expand Down
6 changes: 4 additions & 2 deletions test/helm/gateway-crds-helm/e2e.out.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27955,7 +27955,8 @@ spec:
Origin is defined by the scheme (protocol), hostname (domain), and port of
the URL used to access it. The hostname can be "precise" which is just the
domain name or "wildcard" which is a domain name prefixed with a single
wildcard label such as "*.example.com".
wildcard label such as "*.example.com". The optional port can be a wildcard
as well to allow all ports.
In addition to that a single wildcard (with or without scheme) can be
configured to match any origin.

Expand All @@ -27964,10 +27965,11 @@ spec:
- https://*.example.com
- http://foo.example.com:8080
- http://*.example.com:8080
- https://localhost:*
- https://*
maxLength: 253
minLength: 1
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:\d{1,5})?)$
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:(\*|\d{1,5}))?)$
type: string
type: array
exposeHeaders:
Expand Down
6 changes: 4 additions & 2 deletions test/helm/gateway-crds-helm/envoy-gateway-crds.out.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27955,7 +27955,8 @@ spec:
Origin is defined by the scheme (protocol), hostname (domain), and port of
the URL used to access it. The hostname can be "precise" which is just the
domain name or "wildcard" which is a domain name prefixed with a single
wildcard label such as "*.example.com".
wildcard label such as "*.example.com". The optional port can be a wildcard
as well to allow all ports.
In addition to that a single wildcard (with or without scheme) can be
configured to match any origin.

Expand All @@ -27964,10 +27965,11 @@ spec:
- https://*.example.com
- http://foo.example.com:8080
- http://*.example.com:8080
- https://localhost:*
- https://*
maxLength: 253
minLength: 1
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:\d{1,5})?)$
pattern: ^(\*|https?:\/\/(\*|(\*\.)?(([\w-]+\.?)+)?[\w-]+)(:(\*|\d{1,5}))?)$
type: string
type: array
exposeHeaders:
Expand Down
Loading