feat(net): trusted-proxy depth so real client IPs survive a proxy — #2453
Fixes the defect the operator spotted in #370 immediately after it shipped: auth.ClientIP ignored X-Forwarded-For whenever RemoteAddr was public, so a proxy on a public address — a separate host, or a CDN, i.e. anyone running this publicly, since public means TLS means a proxy — recorded the PROXY for every session. created_ip and last_ip were then always equal and the "Address changed" signal could never fire. The feature looked like it worked and reported nothing. Replaced with the standard trusted-hop model (Rails, Caddy, Traefik, nginx). XFF grows left-to-right as each proxy appends the peer it received from, so for client -> CDN -> own-proxy -> app the app sees [client, CDN] with RemoteAddr = own-proxy, and the client sits at XFF[len - hops]: 0 RemoteAddr, XFF ignored — no proxy 1 the address your own proxy observed 2 through a CDN in front of your proxy Default 1, per the operator: publicly reachable means a TLS terminator in front. The cost is real and stated rather than hidden. hops >= 1 DECLARES that a proxy exists; set it with no proxy, or deeper than the actual chain, and the index reaches attacker-supplied entries, letting a visitor choose which address their own session shows — defeating exactly the detection #370 is for. That's inherent to the model, which is why 0 is a first-class value and the admin card says "count your proxies, don't guess high" instead of just exposing a number. Both mis-set shapes are pinned by tests so they stay known consequences rather than surprises. Migration 0053 + internal/netsettings, cached under an RWMutex. That's not an optimisation: ClientIP runs in RequireUser for every authenticated request, so a per-request query would put the database on the critical path of the whole API. New() always returns a usable service so a boot-time DB hiccup degrades to the default instead of breaking that path (rule #131), and Hops() is nil-safe because test routers construct middleware without it. RequireUser now takes a func() int rather than an int — the value is operator-editable at runtime while the middleware is built once at boot, and reading it per request is what makes a save take effect with no restart (rule #25). The admin card is verifiable, not just configurable: it reports the address the CURRENT setting resolves THIS request to, the raw forwarded chain, and the socket peer — so you set the number, save, and confirm the address matches the machine you're on. It also counts the arriving chain and says how many proxies that implies. GET/PUT both return that payload, PUT recomputed under the new value, so the effect is visible without a reload. Also fixes styling in the #370 card that CI could not catch: text-destructive and bg-destructive don't exist in this Tailwind config — the palette is colors.action.destructive — so the "Address changed" warning and the sign-out-others button were rendering unstyled. Both now use text-action-destructive / bg-action-destructive / text-action-fg. Not done here: requestlog.go still logs raw RemoteAddr and will disagree with the sessions UI about who connected. Left for its own change.
This commit is contained in:
@@ -0,0 +1,98 @@
|
||||
// Package netsettings holds the DB-backed network settings the request path
|
||||
// needs. Today that's the trusted reverse-proxy depth used to pull a real
|
||||
// client address out of X-Forwarded-For (#2453).
|
||||
//
|
||||
// Values are cached under an RWMutex and refreshed on write. That isn't an
|
||||
// optimisation: auth.ClientIP runs in the RequireUser middleware for every
|
||||
// authenticated request, so a per-request query here would put the database
|
||||
// on the critical path of the entire API.
|
||||
package netsettings
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"log/slog"
|
||||
"sync"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"git.fabledsword.com/bvandeusen/minstrel/internal/db/dbq"
|
||||
)
|
||||
|
||||
const (
|
||||
// DefaultTrustedProxyHops mirrors migration 0053's column default. One
|
||||
// proxy, because anything publicly reachable needs a TLS terminator in
|
||||
// front of it.
|
||||
DefaultTrustedProxyHops = 1
|
||||
// MaxTrustedProxyHops mirrors the CHECK in migration 0053.
|
||||
MaxTrustedProxyHops = 10
|
||||
)
|
||||
|
||||
// ErrHopsOutOfRange is returned by SetHops for values the CHECK would reject,
|
||||
// so the API layer can answer 400 instead of surfacing a constraint violation.
|
||||
var ErrHopsOutOfRange = errors.New("trusted proxy hops must be between 0 and 10")
|
||||
|
||||
// Service caches the network settings and owns their persistence.
|
||||
type Service struct {
|
||||
pool *pgxpool.Pool
|
||||
logger *slog.Logger
|
||||
|
||||
mu sync.RWMutex
|
||||
hops int
|
||||
}
|
||||
|
||||
// New loads the settings once and caches them.
|
||||
//
|
||||
// It ALWAYS returns a usable Service, even alongside a non-nil error. The
|
||||
// value it holds sits on the authenticated request path, so a boot-time
|
||||
// database hiccup must degrade to the default rather than take every request
|
||||
// down with it (rule #131). The error is returned so the caller can log that
|
||||
// the cache holds a default rather than stored state.
|
||||
func New(ctx context.Context, pool *pgxpool.Pool, logger *slog.Logger) (*Service, error) {
|
||||
s := &Service{pool: pool, logger: logger, hops: DefaultTrustedProxyHops}
|
||||
if pool == nil {
|
||||
return s, nil
|
||||
}
|
||||
row, err := dbq.New(pool).GetNetworkSettings(ctx)
|
||||
if err != nil {
|
||||
return s, err
|
||||
}
|
||||
s.hops = int(row.TrustedProxyHops)
|
||||
return s, nil
|
||||
}
|
||||
|
||||
// Hops returns the cached trusted-proxy depth.
|
||||
//
|
||||
// Nil-safe: test contexts construct routers without this service, and a
|
||||
// missing setting should mean "trust nothing" rather than a panic in
|
||||
// middleware.
|
||||
func (s *Service) Hops() int {
|
||||
if s == nil {
|
||||
return 0
|
||||
}
|
||||
s.mu.RLock()
|
||||
defer s.mu.RUnlock()
|
||||
return s.hops
|
||||
}
|
||||
|
||||
// SetHops persists a new depth and refreshes the cache, so an admin change
|
||||
// takes effect on the next request with no restart (rule #25).
|
||||
func (s *Service) SetHops(ctx context.Context, hops int) error {
|
||||
if s == nil || s.pool == nil {
|
||||
// Mirrors Hops()'s nil-tolerance: handlers can be constructed without
|
||||
// this service in tests, and a write attempt there should be an error
|
||||
// rather than a panic in an HTTP handler.
|
||||
return errors.New("network settings unavailable")
|
||||
}
|
||||
if hops < 0 || hops > MaxTrustedProxyHops {
|
||||
return ErrHopsOutOfRange
|
||||
}
|
||||
row, err := dbq.New(s.pool).UpdateTrustedProxyHops(ctx, int32(hops))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
s.mu.Lock()
|
||||
s.hops = int(row.TrustedProxyHops)
|
||||
s.mu.Unlock()
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user