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

Allow LocalURL to be passed in the Host header #32555

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all 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
11 changes: 10 additions & 1 deletion modules/httplib/url.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,21 @@ func GuessCurrentHostURL(ctx context.Context) string {
// There are some cases:
// 1. The reverse proxy is configured correctly, it passes "X-Forwarded-Proto/Host" headers. Perfect, Gitea can handle it correctly.
// 2. The reverse proxy is not configured correctly, doesn't pass "X-Forwarded-Proto/Host" headers, eg: only one "proxy_pass http://gitea:3000" in Nginx.
// 3. There is no reverse proxy.
// 3. There is no reverse proxy. In this case, we allow the configured LocalURL to be passed in the Host header.
// Without an extra config option, Gitea is impossible to distinguish between case 2 and case 3,
// then case 2 would result in wrong guess like guessed AppURL becomes "http://gitea:3000/", which is not accessible by end users.
// So in the future maybe it should introduce a new config option, to let site admin decide how to guess the AppURL.
reqScheme := getRequestScheme(req)
if reqScheme == "" {
if setting.LocalURL != "" {
localURL, err := url.Parse(setting.LocalURL)
if err == nil &&
strings.EqualFold(req.Host, localURL.Host) &&
(req.TLS != nil) == (localURL.Scheme == "https") {
return strings.TrimSuffix(setting.LocalURL, setting.AppSubURL+"/")
}
}

return strings.TrimSuffix(setting.AppURL, setting.AppSubURL+"/")
}
// X-Forwarded-Host has many problems: non-standard, not well-defined (X-Forwarded-Port or not), conflicts with Host header.
Expand Down
28 changes: 28 additions & 0 deletions modules/httplib/url_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package httplib

import (
"context"
"crypto/tls"
"net/http"
"testing"

Expand Down Expand Up @@ -39,6 +40,33 @@ func TestIsRelativeURL(t *testing.T) {
}
}

func TestGuessCurrentHostURL(t *testing.T) {
defer test.MockVariableValue(&setting.AppURL, "http://cfg-host/sub/")()
defer test.MockVariableValue(&setting.LocalURL, "http://localhost:3000/sub/")()
defer test.MockVariableValue(&setting.AppSubURL, "/sub")()

ctx := context.Background()
assert.Equal(t, "http://cfg-host", GuessCurrentHostURL(ctx))

ctx = context.WithValue(ctx, RequestContextKey, &http.Request{
Host: "localhost:3000",
})
assert.Equal(t, "http://localhost:3000", GuessCurrentHostURL(ctx))

ctx = context.WithValue(ctx, RequestContextKey, &http.Request{
Host: "localhost:3000",
TLS: &tls.ConnectionState{},
})
assert.Equal(t, "http://cfg-host", GuessCurrentHostURL(ctx))

defer test.MockVariableValue(&setting.LocalURL, "https://localhost/sub/")()
ctx = context.WithValue(ctx, RequestContextKey, &http.Request{
Host: "localhost",
TLS: &tls.ConnectionState{},
})
assert.Equal(t, "https://localhost", GuessCurrentHostURL(ctx))
}

func TestMakeAbsoluteURL(t *testing.T) {
defer test.MockVariableValue(&setting.Protocol, "http")()
defer test.MockVariableValue(&setting.AppURL, "http://cfg-host/sub/")()
Expand Down
Loading