Skip to content
Merged
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
6 changes: 4 additions & 2 deletions .claude/docs/OBSERVABILITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,10 @@ under a named logger such as `api`, `site`, `proxy`, `ext-provisioner`, or
`prometheus`.

HTTP request logging is implemented in `coderd/httpmw/loggermw`. Request log
fields include `user_agent`, `host`, `path`, `proto`, `remote_addr`, `start`,
`status_code`, `latency_ms`, route params, and selected safe query params.
fields include `user_agent`, `host`, the effective trust-aware host,
`received_host`, the raw received Host header, `path`, `proto`,
`remote_addr`, `start`, `status_code`, `latency_ms`, route params, and
selected safe query params.
Responses with status codes of 500 or higher include the response body in the
request log. Successful `GET /api/v2` requests are skipped.

Expand Down
6 changes: 3 additions & 3 deletions agent/agentchat/log_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func TestMiddlewareAccessLog(t *testing.T) {
chatID := uuid.New()
ancestorID := uuid.New()
sink := testutil.NewFakeSink(t)
handler := tracing.StatusWriterMiddleware(loggermw.Logger(sink.Logger())(
handler := tracing.StatusWriterMiddleware(loggermw.Logger(sink.Logger(), nil)(
agentchat.Middleware(http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
rw.WriteHeader(http.StatusNoContent)
})),
Expand All @@ -46,7 +46,7 @@ func TestMiddlewareWithoutChatHeader(t *testing.T) {
t.Parallel()

sink := testutil.NewFakeSink(t)
handler := tracing.StatusWriterMiddleware(loggermw.Logger(sink.Logger())(
handler := tracing.StatusWriterMiddleware(loggermw.Logger(sink.Logger(), nil)(
agentchat.Middleware(http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
rw.WriteHeader(http.StatusNoContent)
})),
Expand All @@ -68,7 +68,7 @@ func TestMiddlewareContextFields(t *testing.T) {

chatID := uuid.New()
sink := testutil.NewFakeSink(t)
handler := tracing.StatusWriterMiddleware(loggermw.Logger(sink.Logger())(
handler := tracing.StatusWriterMiddleware(loggermw.Logger(sink.Logger(), nil)(
agentchat.Middleware(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
sink.Logger().With(agentchat.Fields(r.Context())...).Info(r.Context(), "handler log")
rw.WriteHeader(http.StatusNoContent)
Expand Down
2 changes: 1 addition & 1 deletion agent/agentproc/api_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ func TestAccessLogIncludesChatID(t *testing.T) {
t.Cleanup(func() {
_ = api.Close()
})
handler := tracing.StatusWriterMiddleware(loggermw.Logger(logger)(
handler := tracing.StatusWriterMiddleware(loggermw.Logger(logger, nil)(
agentchat.Middleware(api.Routes()),
))

Expand Down
2 changes: 1 addition & 1 deletion agent/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ func (a *agent) apiHandler() http.Handler {
r.Use(
httpmw.Recover(a.logger),
tracing.StatusWriterMiddleware,
loggermw.Logger(a.logger),
loggermw.Logger(a.logger, nil),
agentchat.Middleware,
)
r.Get("/", func(rw http.ResponseWriter, r *http.Request) {
Expand Down
4 changes: 2 additions & 2 deletions cli/testdata/coder_server_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -454,8 +454,8 @@ NETWORKING OPTIONS:
True-Client-Ip, X-Forwarded-For.

--proxy-trusted-origins string-array, $CODER_PROXY_TRUSTED_ORIGINS
Origin addresses to respect "proxy-trusted-headers". e.g.
192.168.1.0/24.
Origin addresses to respect "proxy-trusted-headers" and
X-Forwarded-Host for subdomain app routing. e.g. 192.168.1.0/24.

--redirect-to-access-url bool, $CODER_REDIRECT_TO_ACCESS_URL
Specifies whether to redirect requests that do not match the access
Expand Down
3 changes: 2 additions & 1 deletion cli/testdata/server-config.yaml.golden
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,8 @@ networking:
# True-Client-Ip, X-Forwarded-For.
# (default: <unset>, type: string-array)
proxyTrustedHeaders: []
# Origin addresses to respect "proxy-trusted-headers". e.g. 192.168.1.0/24.
# Origin addresses to respect "proxy-trusted-headers" and X-Forwarded-Host for
# subdomain app routing. e.g. 192.168.1.0/24.
# (default: <unset>, type: string-array)
proxyTrustedOrigins: []
# Controls if the 'Secure' property is set on browser session cookies.
Expand Down
4 changes: 3 additions & 1 deletion coderd/coderd.go
Original file line number Diff line number Diff line change
Expand Up @@ -1004,7 +1004,9 @@ func New(options *Options) *API {
tracing.Middleware(api.TracerProvider),
httpmw.AttachRequestID,
httpmw.ExtractRealIP(api.RealIPConfig),
loggermw.Logger(api.Logger),
loggermw.Logger(api.Logger, func(r *http.Request) string {
return httpmw.EffectiveHost(api.RealIPConfig, r)
}),
singleSlashMW,
rolestore.CustomRoleMW,
// Validate API key on every request (if present) and store
Expand Down
11 changes: 0 additions & 11 deletions coderd/httpapi/request.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,6 @@ const (
XForwardedHostHeader = "X-Forwarded-Host"
)

// RequestHost returns the name of the host from the request. It prioritizes
// 'X-Forwarded-Host' over r.Host since most requests are being proxied.
func RequestHost(r *http.Request) string {
host := r.Header.Get(XForwardedHostHeader)
if host != "" {
return host
}

return r.Host
}

func IsWebsocketUpgrade(r *http.Request) bool {
vs := r.Header.Values("Upgrade")
for _, v := range vs {
Expand Down
11 changes: 8 additions & 3 deletions coderd/httpmw/loggermw/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import (
"github.com/go-chi/chi/v5"

"cdr.dev/slog/v3"
"github.com/coder/coder/v2/coderd/httpapi"
"github.com/coder/coder/v2/coderd/tracing"
)

Expand Down Expand Up @@ -69,7 +68,7 @@ func safeQueryParams(params url.Values) []slog.Field {
return fields
}

func Logger(log slog.Logger) func(next http.Handler) http.Handler {
func Logger(log slog.Logger, hostResolver func(*http.Request) string) func(next http.Handler) http.Handler {
return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
start := time.Now()
Expand All @@ -79,9 +78,15 @@ func Logger(log slog.Logger) func(next http.Handler) http.Handler {
panic(fmt.Sprintf("ResponseWriter not a *tracing.StatusWriter; got %T", rw))
}

host := r.Host
if hostResolver != nil {
host = hostResolver(r)
}

httplog := log.With(
slog.F("user_agent", r.Header.Get("User-Agent")),
slog.F("host", httpapi.RequestHost(r)),
slog.F("host", host),
slog.F("received_host", r.Host),
slog.F("path", r.URL.Path),
slog.F("proto", r.Proto),
slog.F("remote_addr", r.RemoteAddr),
Expand Down
40 changes: 36 additions & 4 deletions coderd/httpmw/loggermw/logger_internal_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func TestLoggerMiddleware_SingleRequest(t *testing.T) {
})

// Wrap the test handler with the Logger middleware
loggerMiddleware := Logger(logger)
loggerMiddleware := Logger(logger, nil)
wrappedHandler := loggerMiddleware(testHandler)

// Create a test HTTP request
Expand All @@ -91,7 +91,7 @@ func TestLoggerMiddleware_SingleRequest(t *testing.T) {
}

// Check that the log contains the expected fields
requiredFields := []string{"host", "path", "proto", "remote_addr", "start", "took", "status_code", "user_agent", "latency_ms"}
requiredFields := []string{"host", "received_host", "path", "proto", "remote_addr", "start", "took", "status_code", "user_agent", "latency_ms"}
for _, field := range requiredFields {
_, exists := fieldsMap[field]
require.True(t, exists, "field %q is missing in log fields", field)
Expand All @@ -103,6 +103,38 @@ func TestLoggerMiddleware_SingleRequest(t *testing.T) {
require.Equal(t, fieldsMap["status_code"], http.StatusOK)
}

func TestLoggerMiddleware_HostFields(t *testing.T) {
t.Parallel()

sink := testutil.NewFakeSink(t)
logger := sink.Logger()

testHandler := http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
rw.WriteHeader(http.StatusOK)
})

loggerMiddleware := Logger(logger, func(_ *http.Request) string {
return "effective.test"
})
wrappedHandler := loggerMiddleware(testHandler)

req := httptest.NewRequest(http.MethodGet, "http://received.test/path", nil)

sw := &tracing.StatusWriter{ResponseWriter: httptest.NewRecorder()}
wrappedHandler.ServeHTTP(sw, req)

entries := sink.Entries()
require.Len(t, entries, 1, "expected exactly one log entry")

fieldsMap := make(map[string]any)
for _, field := range entries[0].Fields {
fieldsMap[field.Name] = field.Value
}

require.Equal(t, "effective.test", fieldsMap["host"])
require.Equal(t, "received.test", fieldsMap["received_host"])
}

func TestLoggerMiddleware_WebSocket(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
Expand All @@ -129,7 +161,7 @@ func TestLoggerMiddleware_WebSocket(t *testing.T) {
})

// Wrap the test handler with the Logger middleware
loggerMiddleware := Logger(logger)
loggerMiddleware := Logger(logger, nil)
wrappedHandler := loggerMiddleware(testHandler)

// RequestLogger expects the ResponseWriter to be *tracing.StatusWriter
Expand Down Expand Up @@ -186,7 +218,7 @@ func TestRequestLogger_HTTPRouteParams(t *testing.T) {
})

// Wrap the test handler with the Logger middleware
loggerMiddleware := Logger(logger)
loggerMiddleware := Logger(logger, nil)
wrappedHandler := loggerMiddleware(testHandler)

// Create a test HTTP request
Expand Down
29 changes: 29 additions & 0 deletions coderd/httpmw/realip.go
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,35 @@ func FilterUntrustedOriginHeaders(config *RealIPConfig, req *http.Request) {
}
}

// EffectiveHost returns the host Coder should trust for request handling.
// It uses X-Forwarded-Host only when the immediate peer is a configured
// trusted proxy. Otherwise it uses the received Host header.
func EffectiveHost(config *RealIPConfig, r *http.Request) string {
if config == nil {
config = &RealIPConfig{
TrustedOrigins: nil,
TrustedHeaders: nil,
}
}

// When ExtractRealIP has run, r.RemoteAddr may hold the forwarded
// client IP, and we should use the original socket peer for proxy
// trust decisions.
remoteAddr := r.RemoteAddr
state := RealIP(r.Context())
if state != nil && state.OriginalRemoteAddr != "" {
remoteAddr = state.OriginalRemoteAddr
}

if isContainedIn(config.TrustedOrigins, getRemoteAddress(remoteAddr)) {
if host := r.Header.Get(httpapi.XForwardedHostHeader); host != "" {
return host
}
}

return r.Host
}

// EnsureXForwardedForHeader ensures that the request has an X-Forwarded-For
// header. It uses the following logic:
//
Expand Down
107 changes: 107 additions & 0 deletions coderd/httpmw/realip_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (

"github.com/stretchr/testify/require"

"github.com/coder/coder/v2/coderd/httpapi"
"github.com/coder/coder/v2/coderd/httpmw"
)

Expand Down Expand Up @@ -472,6 +473,112 @@ func TestFilterUntrusted(t *testing.T) {
}
}

func TestEffectiveHost(t *testing.T) {
t.Parallel()

cidr32 := func(t *testing.T, ip string) *net.IPNet {
t.Helper()

return &net.IPNet{
IP: net.ParseIP(ip),
Mask: net.CIDRMask(32, 32),
}
}

t.Run("UntrustedPeerFallsBackToReceivedHost", func(t *testing.T) {
t.Parallel()

r := httptest.NewRequest(http.MethodGet, "http://received.test", nil)
r.RemoteAddr = "17.18.19.20:1234"
r.Header.Set(httpapi.XForwardedHostHeader, "app.test.coder.com")

require.Equal(t, "received.test", httpmw.EffectiveHost(nil, r))
})

t.Run("TrustedPeerUsesOriginalRemoteAddrForTrust", func(t *testing.T) {
t.Parallel()

config := &httpmw.RealIPConfig{
TrustedOrigins: []*net.IPNet{cidr32(t, "17.18.19.20")},
TrustedHeaders: []string{"X-Real-Ip"},
}

r := httptest.NewRequest(http.MethodGet, "http://received.test", nil)
r.RemoteAddr = "17.18.19.20:1234"
// X-Real-Ip causes ExtractRealIP to rewrite r.RemoteAddr, so
// this test can verify trust still uses OriginalRemoteAddr,
// the actual socket peer.
r.Header.Set("X-Real-Ip", "99.88.77.66")
r.Header.Set(httpapi.XForwardedHostHeader, "app.test.coder.com")

middleware := httpmw.ExtractRealIP(config)
next := http.HandlerFunc(func(_ http.ResponseWriter, r *http.Request) {
require.Equal(t, "99.88.77.66", r.RemoteAddr)
require.Equal(t, "app.test.coder.com", httpmw.EffectiveHost(config, r))
})

middleware(next).ServeHTTP(httptest.NewRecorder(), r)
})

t.Run("UntrustedPeerDoesNotHonorForwardedHost", func(t *testing.T) {
t.Parallel()

config := &httpmw.RealIPConfig{
TrustedOrigins: []*net.IPNet{cidr32(t, "99.88.77.66")},
TrustedHeaders: []string{"X-Real-Ip"},
}

r := httptest.NewRequest(http.MethodGet, "http://received.test", nil)
r.RemoteAddr = "17.18.19.20:1234"
r.Header.Set("X-Real-Ip", "99.88.77.66")
r.Header.Set(httpapi.XForwardedHostHeader, "app.test.coder.com")

middleware := httpmw.ExtractRealIP(config)
nextHandler := http.HandlerFunc(func(_ http.ResponseWriter, r *http.Request) {
require.Equal(t, "17.18.19.20", r.RemoteAddr)
require.Equal(t, "received.test", httpmw.EffectiveHost(config, r))
})

middleware(nextHandler).ServeHTTP(httptest.NewRecorder(), r)
})

t.Run("TrustedPeerWithoutForwardedHostFallsBackToReceivedHost", func(t *testing.T) {
t.Parallel()

config := &httpmw.RealIPConfig{
TrustedOrigins: []*net.IPNet{cidr32(t, "17.18.19.20")},
TrustedHeaders: []string{"X-Real-Ip"},
}

r := httptest.NewRequest(http.MethodGet, "http://received.test", nil)
r.RemoteAddr = "17.18.19.20:1234"

middleware := httpmw.ExtractRealIP(config)
nextHandler := http.HandlerFunc(func(_ http.ResponseWriter, r *http.Request) {
require.Equal(t, "received.test", httpmw.EffectiveHost(config, r))
})

middleware(nextHandler).ServeHTTP(httptest.NewRecorder(), r)
})

t.Run("MalformedRemoteAddrFallsBackToReceivedHost", func(t *testing.T) {
t.Parallel()

config := &httpmw.RealIPConfig{
TrustedOrigins: []*net.IPNet{cidr32(t, "17.18.19.20")},
TrustedHeaders: []string{"X-Real-Ip"},
}

r := httptest.NewRequest(http.MethodGet, "http://received.test", nil)
// A RemoteAddr that cannot be parsed into an IP must be treated as
// untrusted, so the forwarded host is ignored.
r.RemoteAddr = "garbage"
r.Header.Set(httpapi.XForwardedHostHeader, "app.test.coder.com")

require.Equal(t, "received.test", httpmw.EffectiveHost(config, r))
})
}

// TestApplicationProxy checks headers passed to DevURL services are as expected.
func TestApplicationProxy(t *testing.T) {
t.Parallel()
Expand Down
2 changes: 1 addition & 1 deletion coderd/workspaceapps/proxy.go
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ func (s *Server) HandleSubdomain(middlewares ...func(http.Handler) http.Handler)
}

// Step 2: Get the request Host.
host := httpapi.RequestHost(r)
host := httpmw.EffectiveHost(s.RealIPConfig, r)
if host == "" {
if r.URL.Path == "/derp" {
// The /derp endpoint is used by wireguard clients to tunnel
Expand Down
Loading
Loading