fix(origin): fall back to ExternalSecure (#7228)

* fix(origin): fall back to ExternalSecure

* avoid middleware.Middleware

* avoid else

* lint
This commit is contained in:
Elio Bischof 2024-01-15 17:44:35 +01:00 committed by GitHub
parent fc34896092
commit 29b386005d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 59 additions and 21 deletions

View File

@ -325,7 +325,7 @@ func startAPIs(
} }
oidcPrefixes := []string{"/.well-known/openid-configuration", "/oidc/v1", "/oauth/v2"} oidcPrefixes := []string{"/.well-known/openid-configuration", "/oidc/v1", "/oauth/v2"}
// always set the origin in the context if available in the http headers, no matter for what protocol // always set the origin in the context if available in the http headers, no matter for what protocol
router.Use(middleware.OriginHandler) router.Use(middleware.WithOrigin(config.ExternalSecure))
systemTokenVerifier, err := internal_authz.StartSystemTokenVerifierFromConfig(http_util.BuildHTTP(config.ExternalDomain, config.ExternalPort, config.ExternalSecure), config.SystemAPIUsers) systemTokenVerifier, err := internal_authz.StartSystemTokenVerifierFromConfig(http_util.BuildHTTP(config.ExternalDomain, config.ExternalPort, config.ExternalSecure), config.SystemAPIUsers)
if err != nil { if err != nil {
return err return err

View File

@ -4,25 +4,28 @@ import (
"fmt" "fmt"
"net/http" "net/http"
"github.com/gorilla/mux"
"github.com/muhlemmer/httpforwarded" "github.com/muhlemmer/httpforwarded"
"github.com/zitadel/logging" "github.com/zitadel/logging"
http_util "github.com/zitadel/zitadel/internal/api/http" http_util "github.com/zitadel/zitadel/internal/api/http"
) )
func OriginHandler(next http.Handler) http.Handler { func WithOrigin(fallBackToHttps bool) mux.MiddlewareFunc {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { return func(next http.Handler) http.Handler {
origin := composeOrigin(r) return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if !http_util.IsOrigin(origin) { origin := composeOrigin(r, fallBackToHttps)
logging.Debugf("extracted origin is not valid: %s", origin) if !http_util.IsOrigin(origin) {
next.ServeHTTP(w, r) logging.Debugf("extracted origin is not valid: %s", origin)
return next.ServeHTTP(w, r)
} return
next.ServeHTTP(w, r.WithContext(http_util.WithComposedOrigin(r.Context(), origin))) }
}) next.ServeHTTP(w, r.WithContext(http_util.WithComposedOrigin(r.Context(), origin)))
})
}
} }
func composeOrigin(r *http.Request) string { func composeOrigin(r *http.Request, fallBackToHttps bool) string {
var proto, host string var proto, host string
fwd, fwdErr := httpforwarded.ParseFromRequest(r) fwd, fwdErr := httpforwarded.ParseFromRequest(r)
if fwdErr == nil { if fwdErr == nil {
@ -36,9 +39,8 @@ func composeOrigin(r *http.Request) string {
host = r.Header.Get("X-Forwarded-Host") host = r.Header.Get("X-Forwarded-Host")
} }
if proto == "" { if proto == "" {
if r.TLS == nil { proto = "http"
proto = "http" if fallBackToHttps {
} else {
proto = "https" proto = "https"
} }
} }

View File

@ -9,7 +9,8 @@ import (
func Test_composeOrigin(t *testing.T) { func Test_composeOrigin(t *testing.T) {
type args struct { type args struct {
h http.Header h http.Header
fallBackToHttps bool
} }
tests := []struct { tests := []struct {
name string name string
@ -24,6 +25,7 @@ func Test_composeOrigin(t *testing.T) {
h: http.Header{ h: http.Header{
"Forwarded": []string{"proto=https"}, "Forwarded": []string{"proto=https"},
}, },
fallBackToHttps: false,
}, },
want: "https://host.header", want: "https://host.header",
}, { }, {
@ -32,6 +34,7 @@ func Test_composeOrigin(t *testing.T) {
h: http.Header{ h: http.Header{
"Forwarded": []string{"host=forwarded.host"}, "Forwarded": []string{"host=forwarded.host"},
}, },
fallBackToHttps: false,
}, },
want: "http://forwarded.host", want: "http://forwarded.host",
}, { }, {
@ -40,6 +43,7 @@ func Test_composeOrigin(t *testing.T) {
h: http.Header{ h: http.Header{
"Forwarded": []string{"proto=https;host=forwarded.host"}, "Forwarded": []string{"proto=https;host=forwarded.host"},
}, },
fallBackToHttps: false,
}, },
want: "https://forwarded.host", want: "https://forwarded.host",
}, { }, {
@ -48,6 +52,7 @@ func Test_composeOrigin(t *testing.T) {
h: http.Header{ h: http.Header{
"Forwarded": []string{"proto=https;host=forwarded.host, proto=http;host=forwarded.host2"}, "Forwarded": []string{"proto=https;host=forwarded.host, proto=http;host=forwarded.host2"},
}, },
fallBackToHttps: false,
}, },
want: "https://forwarded.host", want: "https://forwarded.host",
}, { }, {
@ -56,6 +61,7 @@ func Test_composeOrigin(t *testing.T) {
h: http.Header{ h: http.Header{
"Forwarded": []string{"proto=https;host=forwarded.host, proto=http"}, "Forwarded": []string{"proto=https;host=forwarded.host, proto=http"},
}, },
fallBackToHttps: false,
}, },
want: "https://forwarded.host", want: "https://forwarded.host",
}, { }, {
@ -64,14 +70,37 @@ func Test_composeOrigin(t *testing.T) {
h: http.Header{ h: http.Header{
"Forwarded": []string{"proto=http", "proto=https;host=forwarded.host", "proto=http"}, "Forwarded": []string{"proto=http", "proto=https;host=forwarded.host", "proto=http"},
}, },
fallBackToHttps: true,
}, },
want: "http://forwarded.host", want: "http://forwarded.host",
}, { }, {
name: "x-forwarded-proto", name: "x-forwarded-proto https",
args: args{ args: args{
h: http.Header{ h: http.Header{
"X-Forwarded-Proto": []string{"https"}, "X-Forwarded-Proto": []string{"https"},
}, },
fallBackToHttps: false,
},
want: "https://host.header",
}, {
name: "x-forwarded-proto http",
args: args{
h: http.Header{
"X-Forwarded-Proto": []string{"http"},
},
fallBackToHttps: true,
},
want: "http://host.header",
}, {
name: "fallback to http",
args: args{
fallBackToHttps: false,
},
want: "http://host.header",
}, {
name: "fallback to https",
args: args{
fallBackToHttps: true,
}, },
want: "https://host.header", want: "https://host.header",
}, { }, {
@ -80,6 +109,7 @@ func Test_composeOrigin(t *testing.T) {
h: http.Header{ h: http.Header{
"X-Forwarded-Host": []string{"x-forwarded.host"}, "X-Forwarded-Host": []string{"x-forwarded.host"},
}, },
fallBackToHttps: false,
}, },
want: "http://x-forwarded.host", want: "http://x-forwarded.host",
}, { }, {
@ -89,6 +119,7 @@ func Test_composeOrigin(t *testing.T) {
"X-Forwarded-Proto": []string{"https"}, "X-Forwarded-Proto": []string{"https"},
"X-Forwarded-Host": []string{"x-forwarded.host"}, "X-Forwarded-Host": []string{"x-forwarded.host"},
}, },
fallBackToHttps: false,
}, },
want: "https://x-forwarded.host", want: "https://x-forwarded.host",
}, { }, {
@ -98,6 +129,7 @@ func Test_composeOrigin(t *testing.T) {
"Forwarded": []string{"host=forwarded.host"}, "Forwarded": []string{"host=forwarded.host"},
"X-Forwarded-Host": []string{"x-forwarded.host"}, "X-Forwarded-Host": []string{"x-forwarded.host"},
}, },
fallBackToHttps: false,
}, },
want: "http://forwarded.host", want: "http://forwarded.host",
}, { }, {
@ -107,16 +139,20 @@ func Test_composeOrigin(t *testing.T) {
"Forwarded": []string{"host=forwarded.host"}, "Forwarded": []string{"host=forwarded.host"},
"X-Forwarded-Proto": []string{"https"}, "X-Forwarded-Proto": []string{"https"},
}, },
fallBackToHttps: false,
}, },
want: "https://forwarded.host", want: "https://forwarded.host",
}, },
} }
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
assert.Equalf(t, tt.want, composeOrigin(&http.Request{ assert.Equalf(t, tt.want, composeOrigin(
Host: "host.header", &http.Request{
Header: tt.args.h, Host: "host.header",
}), "headers: %+v", tt.args.h) Header: tt.args.h,
},
tt.args.fallBackToHttps,
), "headers: %+v, fallBackToHttps: %t", tt.args.h, tt.args.fallBackToHttps)
}) })
} }
} }