Milestone: next into main (#380)

Reviewed-on: #380

README.md

@@ -802,11 +802,7 @@ comes up, serves pages, and is broken in a way nothing reports.
    proxy's log names it regardless. nginx's default `combined` format already
    logs `$remote_addr`; do not replace it with one that drops the client
    address, and retain those logs as long as you would want to answer a question
-   about traffic. That log also records the full request path, so it holds the
+   about traffic.
-   entrypoint UUID of every event a sender posts. webhooker's own log never
-   does. Protect the proxy's log as you would the entrypoint URLs themselves:
-   anyone who can read it can post events to every entrypoint in it (see
-   [The entrypoint URL is the authentication secret](#the-entrypoint-url-is-the-authentication-secret)).
 
 ### nginx
 
@@ -832,9 +828,7 @@ server {
     client_max_body_size 1m;
 
     # $remote_addr is the client. webhooker's own log names it, as
-    # clientIP, only while TRUSTED_PROXIES covers this proxy. The
+    # clientIP, only while TRUSTED_PROXIES covers this proxy.
-    # request path in this log holds the entrypoint UUID, so protect
-    # the file like the entrypoint URL itself.
     access_log /var/log/nginx/webhooker.access.log combined;
 
     location / {
@@ -1166,12 +1160,7 @@ What that means for an operator:
 
 - **The URL is a capability, so treat it as a secret.** Keep it out of logs,
   ticket bodies, chat messages and screenshots. Anyone who reads it anywhere can
-  post events as that sender. webhooker's own log lines never carry the UUID:
+  post events as that sender.
-  they name a request to the receiver by the route pattern `/h/{uuid}`, and the
-  `webhook request received` line names the entrypoint by its `entrypoint_id`.
-  The reverse proxy's access log does carry the UUID, in the request path, so it
-  must be protected like the URL itself (see
-  [Deployment behind a reverse proxy](#deployment-behind-a-reverse-proxy)).
 - **Rotating means minting a new entrypoint, not changing a key.** There is no
   way to rotate the UUID in place. To retire one, delete the entrypoint (or
   deactivate it, which answers `410`) and create a new one, then point the
@@ -2427,32 +2416,27 @@ log volume it caps rather than eliminates. A path that names no entrypoint is
 recorded by the handler at `DEBUG`, and the aggregate limiter logs its own
 rejections at `DEBUG` and without the path, so neither appears at all under the
 default level. The per-entrypoint limiter is the loud one: it logs every
-rejection at `WARN`, naming the route pattern `/h/{uuid}` rather than the
+rejection at `WARN` with the request path, which on this route is
-request path. A client hammering a single invented path is served
+attacker-controlled text. A client hammering a single invented path is served
 `RECEIVER_RATE_LIMIT` requests and has the rest of its aggregate budget rejected
 there, so the aggregate limit is what bounds the _number_ of those `WARN` lines
 — to under ten times `RECEIVER_RATE_LIMIT` per minute per client IP, 1080 at the
-defaults, where before it there was no bound at all. The access log is bounded
+defaults, where before it there was no bound at all. Their _width_ is bounded by
-by neither limit: every request is recorded once at `INFO`, served or rejected
+the field budgets below, the same ones the access log spends. The access log is
-alike.
+bounded by neither limit: every request is recorded once at `INFO`, served or
+rejected alike.
 
-What the access log does bound is the _content_ of those lines. On the receiver
+What the access log does bound is the _content_ of those lines. A 3xx or 4xx
-route it logs the route pattern `/h/{uuid}` whatever the status, because the
+response logs the chi route pattern — `/h/{uuid}`, `/user/{username}//`, or the
-concrete path carries the entrypoint UUID, which is the entrypoint's credential
+literal `(unmatched)` when the request hit no route at all — in place of the
-(see
+concrete URL. Those are the outcomes an unauthenticated client can drive for
-[The entrypoint URL is the authentication secret](#the-entrypoint-url-is-the-authentication-secret)).
+free: 404 and 429 on any invented receiver path, a login redirect on any
-A request chi never routed, because it matched no route or because a middleware
+invented profile path. Logging the URL there would let a flood write text of its
-answered it first, logs the literal `(unmatched)` whatever the status. In the
+own choosing, at a length of its own choosing, into the log. 2xx and 5xx
-`dev` environment the CORS middleware answers a preflight that way, so a
+responses keep the concrete path — a success resolved against a static route or
-preflight to the receiver does not log its UUID either. On every other route, a
+against the operator's own data (on the receiver, against a stored entrypoint
-3xx or 4xx response logs the chi route pattern, such as `/user/{username}//`, in
+UUID), and a 5xx is a bug in this service, where the exact path is the evidence
-place of the concrete URL. Those are the outcomes an unauthenticated client can
+and no client can provoke one at will.
-drive for free: a 404 on any invented path, a login redirect on any invented
-profile path. Logging the URL there would let a flood write text of its own
-choosing, at a length of its own choosing, into the log. 2xx and 5xx responses
-keep the concrete path — a success resolved against a static route or against
-the operator's own data, and a 5xx is a bug in this service, where the exact
-path is the evidence and no client can provoke one at will.
 
 The query string is never logged; it is replaced by the fixed marker
 `?(redacted)`. It is client-chosen on every route, and
@@ -2478,10 +2462,9 @@ The same hook rewrites the request URL. The SDK builds it as
 `scheme://host/path` from the concrete path, which on the receiver route is
 `/h/<uuid>` in full — and that UUID is a write capability, not an identifier:
 anyone holding it can post events this service accepts and its targets then
-deliver. What is sent is the chi route pattern instead: `http://host/h/{uuid}`.
+deliver. A tracker has its own retention, access control and deletion policy, so
-A tracker has its own retention, access control and deletion policy, so the
+the rule the access log follows above does not carry across that boundary. What
-pattern is sent on every route, including the 2xx and 5xx responses outside the
+is sent is the chi route pattern instead: `http://host/h/{uuid}`.
-receiver for which the access log keeps the concrete path.
 
 The scheme and the host are kept, and everything else in the URL is discarded
 rather than edited, so a future SDK version that starts appending a query string
@@ -2610,7 +2593,9 @@ than it:
 | ------------------------------------------ | ------- | ------------------- | ------------------------------------------ |
 | `request body exceeds limit` (413)         | `WARN`  | path, method        | yes — `MaxBodySize` precedes `RequireAuth` |
 | `csrf: token validation failed` (403)      | `WARN`  | path, method        | yes — `CSRF` precedes `RequireAuth`        |
+| `... rate limit exceeded` (429)            | `WARN`  | path                | yes, on the receiver                       |
 | `auth middleware: unauthenticated request` | `DEBUG` | path, method        | yes, by definition                         |
+| `entrypoint not found`                     | `DEBUG` | entrypoint UUID     | yes, on the receiver                       |
 | `user not found` / `invalid password`      | `DEBUG` | username            | yes, on the sign-in form                   |
 | `login failure limit exceeded` (429)       | `WARN`  | path                | yes, on the sign-in form                   |
 | `password verification capacity exhausted` | `WARN`  | path                | yes, on the sign-in form                   |
@@ -2638,12 +2623,13 @@ wider of the two handlers spends more on than the client spent sending them.
 Every case holds each line to the 2,560-byte ceiling. That per-line ceiling is
 what the figure above states, and every row establishes it.
 
-Two of the sites go further and bound the whole flood's output — the total bytes
+Three of the sites go further and bound the whole flood's output — the total
-a run of distinct invented values wrote, which is the shape an operator sizing
+bytes a run of distinct invented values wrote, which is the shape an operator
-storage cares about. They are `request body exceeds limit`
+sizing storage cares about. They are `request body exceeds limit`
-(`TestMaxBodySize_FloodOfOversizePathsDoesNotGrowTheLog`) and `user not found`
+(`TestMaxBodySize_FloodOfOversizePathsDoesNotGrowTheLog`),
-(through `assertBoundedFlood`). The other rows carry no aggregate assertion; the
+`entrypoint not found` and `user not found` (the last two through
-per-line ceiling is what they establish.
+`assertBoundedFlood`). The other rows carry no aggregate assertion; the per-line
+ceiling is what they establish.
 
 `internal/logfield/logfield_test.go` measures the per-rune charge against what
 the handlers really emit, over roughly 3,000 code points on each, so an
@@ -2661,7 +2647,7 @@ everything else, so its lines take the level the operator set and the handler
 `internal/logger` selected, and every value it emits is spent through the same
 `internal/logfield` budget. A record-not-found is not logged as an error: it is
 the expected outcome on both of those paths, and each handler already records
-its own miss at `DEBUG`, without the SQL and within the ceiling above. Slow
+its own miss at `DEBUG` — bounded, per the table above — without the SQL. Slow
 statements are kept, at `WARN`, above the same 200 ms threshold GORM used and
 with the statement bounded, because that report is the one thing GORM's logger
 gave an operator that nothing else here does. The adapter orders its cases

internal/handlers/logbound_test.go

@@ -1,15 +1,19 @@
 package handlers_test
 
-// The handler-side half of the log-field audit. The slog calls in
+// The handler-side half of the log-field audit. Two slog calls in
-// this package that reach a value an UNAUTHENTICATED client picks
+// this package reach a value an UNAUTHENTICATED client picks outright
-// outright, and of a length it picks outright, are the failed-login
+// and of a length it picks outright:
-// DEBUG lines, whose username is a form field.
 //
-// They are at DEBUG, which is off in production by default. That is
+//   - the unknown-entrypoint DEBUG line on /h/{uuid}, whose
+//     path segment matched no stored entrypoint and so is bounded by
+//     nothing;
+//   - the failed-login DEBUG lines, whose username is a form field.
+//
+// Both are at DEBUG, which is off in production by default. That is
 // not a bound: an operator turning DEBUG on to diagnose a flood must
-// not thereby hand the flood an unbounded write. They spend the same
+// not thereby hand the flood an unbounded write. Both spend the same
-// internal/logfield budget as the access log, and are held here to
+// internal/logfield budget as the access log, and both are held here
-// middleware.MaxAccessLogLineBytes.
+// to middleware.MaxAccessLogLineBytes.
 //
 // The two login lines past the username lookup — "invalid password"
 // and "user logged in" — carry the same cap without needing it, since
@@ -256,6 +260,43 @@ func postLoginWithPassword(
 	return w.Code
 }
 
+// TestUnknownEntrypoint_LogLineDoesNotTrackPathSize drives 8 KB of
+// client-chosen path at the unauthenticated receiver's
+// unknown-entrypoint DEBUG line and holds it to the same ceiling the
+// access log states.
+func TestUnknownEntrypoint_LogLineDoesNotTrackPathSize(t *testing.T) {
+	t.Parallel()
+
+	for handlerName, newHandler := range logHandlers() {
+		for fillName, fill := range escapeFills() {
+			t.Run(handlerName+"/"+fillName, func(t *testing.T) {
+				t.Parallel()
+
+				h, buf := capturingHandlers(t, newHandler)
+				router := receiverRouter(h)
+
+				for i := range floodRequests {
+					assert.Equal(
+						t,
+						http.StatusNotFound,
+						postReceiver(
+							t, router,
+							oversizedFill(fill)+
+								strings.Repeat("y", i),
+						),
+					)
+				}
+
+				lines := logLines(t, buf)
+				require.Len(t, lines, floodRequests)
+				assertNoClientText(t, buf)
+
+				assertBoundedFlood(t, buf.Len())
+			})
+		}
+	}
+}
+
 // TestFailedLogin_LogLineDoesNotTrackUsernameSize drives 8 KB of
 // client-chosen username at the unauthenticated login endpoint's
 // DEBUG line and holds it to the same ceiling.

internal/handlers/webhook.go

@@ -10,6 +10,7 @@ import (
 	"gorm.io/gorm"
 	"sneak.berlin/go/webhooker/internal/database"
 	"sneak.berlin/go/webhooker/internal/delivery"
+	"sneak.berlin/go/webhooker/internal/logfield"
 	"sneak.berlin/go/webhooker/internal/middleware"
 )
 
@@ -48,13 +49,14 @@ func (h *Handlers) HandleWebhook() http.HandlerFunc {
 			return
 		}
 
-		// Logged only once the lookup has found the entrypoint, so
+		// Logged only once the UUID is known to name a real
-		// an invented path writes no INFO line; a miss is logged at
+		// entrypoint. The UUID comes straight out of the path on
-		// DEBUG. The entrypoint is named by its ID: the UUID is its
+		// the one unauthenticated endpoint, so logging it before
-		// credential and is never logged.
+		// the lookup let a client write an INFO line per invented
+		// path; the request itself is already in the access log
+		// and a miss is already logged at DEBUG.
 		h.log.Info("webhook request received",
-			"entrypoint_id", entrypoint.ID,
+			"entrypoint_uuid", entrypointUUID,
-			"webhook_id", entrypoint.WebhookID,
 			"method", r.Method,
 			"remoteIP", middleware.RemoteIP(r),
 			"clientIP", middleware.ClientIP(r),
@@ -131,10 +133,17 @@ func (h *Handlers) lookupEntrypoint(
 		"path = ?", entrypointUUID,
 	).First(&entrypoint)
 	if result.Error != nil {
-		// Not even an unknown UUID is logged. The receiver's log
+		// The receiver is unauthenticated and /h/{uuid}
-		// lines never carry the path segment, which is a credential
+		// matches any single segment, so this value is entirely
-		// whenever it names an entrypoint.
+		// client-chosen on exactly the branch where the lookup
-		h.log.Debug("entrypoint not found")
+		// failed. DEBUG is off by default; the cap is what keeps
+		// turning it on from restoring an unbounded write.
+		h.log.Debug(
+			"entrypoint not found",
+			"path", logfield.Truncate(
+				entrypointUUID, logfield.MaxBytes,
+			),
+		)
 		http.NotFound(w, r)
 
 		return entrypoint, false

internal/handlers/webhook_test.go

@@ -12,15 +12,12 @@ import (
 	"testing"
 
 	"github.com/go-chi/chi"
-	"github.com/google/uuid"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"gorm.io/gorm/clause"
 	"sneak.berlin/go/webhooker/internal/config"
 	"sneak.berlin/go/webhooker/internal/database"
 	"sneak.berlin/go/webhooker/internal/handlers"
 	"sneak.berlin/go/webhooker/internal/middleware"
-	"sneak.berlin/go/webhooker/internal/middleware/middlewaretest"
 )
 
 // TestHandleWebhook_LogsClientNextToThePeer checks that the
@@ -102,87 +99,6 @@ func TestHandleWebhook_LogsClientNextToThePeer(t *testing.T) {
 	}
 }
 
-// TestHandleWebhook_LogsNoEntrypointUUID sends an accepted event, a
-// request over the receiver rate limit and a request for an unknown
-// UUID through the receiver as routes.go mounts it, and checks that
-// nothing logged, at any level, carries either UUID.
-func TestHandleWebhook_LogsNoEntrypointUUID(t *testing.T) {
-	t.Parallel()
-
-	var (
-		h  *handlers.Handlers
-		db *database.Database
-	)
-
-	cfg := &config.Config{DataDir: t.TempDir(), ReceiverRateLimit: 1}
-
-	app := newTestAppWithConfig(t, cfg, &h, &db)
-	app.RequireStart()
-
-	t.Cleanup(app.RequireStop)
-
-	buf := new(bytes.Buffer)
-	log := slog.New(slog.NewJSONHandler(
-		buf, &slog.HandlerOptions{Level: slog.LevelDebug},
-	))
-	h.SetLogForTest(log)
-	mw := middlewaretest.New(t, log, cfg, nil)
-
-	webhook := seedWebhook(t, db)
-	entrypoint := &database.Entrypoint{
-		WebhookID: webhook.ID,
-		Path:      uuid.New().String(),
-		Active:    true,
-	}
-	require.NoError(t, db.DB().Omit(clause.Associations).
-		Create(entrypoint).Error)
-
-	unknownUUID := uuid.New().String()
-
-	router := chi.NewRouter()
-	router.Use(mw.Logging())
-	router.With(mw.ReceiverRateLimit()).HandleFunc(
-		middleware.ReceiverRoute, h.HandleWebhook(),
-	)
-
-	// In order: the limit is one request per minute per path, so the
-	// second request for the known UUID is the rejected one.
-	for _, step := range []struct {
-		entrypointUUID string
-		wantStatus     int
-	}{
-		{entrypoint.Path, http.StatusOK},
-		{entrypoint.Path, http.StatusTooManyRequests},
-		{unknownUUID, http.StatusNotFound},
-	} {
-		req := httptest.NewRequestWithContext(
-			context.Background(), http.MethodPost,
-			"/h/"+step.entrypointUUID, strings.NewReader("{}"),
-		)
-		w := httptest.NewRecorder()
-		router.ServeHTTP(w, req)
-
-		require.Equal(t, step.wantStatus, w.Code)
-	}
-
-	// The lines this test is about were all written, so the checks
-	// below are not passing on an empty log.
-	for _, msg := range []string{
-		"webhook request received",
-		"webhook receiver rate limit exceeded",
-		"entrypoint not found",
-	} {
-		assert.Contains(t, buf.String(), `"msg":"`+msg+`"`)
-	}
-
-	assert.NotContains(t, buf.String(), entrypoint.Path)
-	assert.NotContains(t, buf.String(), unknownUUID)
-
-	line := receivedLine(t, buf)
-	assert.Equal(t, entrypoint.ID, line["entrypoint_id"])
-	assert.Equal(t, webhook.ID, line["webhook_id"])
-}
-
 // receivedLine returns the one "webhook request received" line in the
 // captured JSON log.
 func receivedLine(t *testing.T, buf *bytes.Buffer) map[string]any {

internal/middleware/accesslog_test.go

@@ -7,7 +7,6 @@ import (
 	"log/slog"
 	"net/http"
 	"net/http/httptest"
-	"strconv"
 	"strings"
 	"testing"
 
@@ -28,13 +27,6 @@ const floodRequests = 64
 // line for a redirected or rejected request may contain it.
 const attackerMarker = "QQATTACKERTEXTQQ"
 
-// knownEntrypointUUID and failingEntrypointUUID are the UUIDs the
-// stand-in receiver in accessLogRouter answers 200 and 500 to.
-const (
-	knownEntrypointUUID   = "6f1e2a9c-4b7d-4e3a-9c2f-1d8b5a7e3c60"
-	failingEntrypointUUID = "0b7c3e5a-2d9f-4a61-8e4b-7c1d6f2a9e35"
-)
-
 // maxLineBytes bounds a single access log line whose client-supplied
 // fields are of ordinary size. Well above what the fixed fields need,
 // well below the length of the oversized input the amplification tests
@@ -140,21 +132,17 @@ func accessLogRouter(m *middleware.Middleware) *chi.Mux {
 	)
 
 	router.HandleFunc(
-		middleware.ReceiverRoute,
+		"/h/{uuid}",
 		func(w http.ResponseWriter, r *http.Request) {
-			// Stands in for the real handler: a known entrypoint
+			// Stands in for the real handler: an unknown entrypoint
-			// UUID succeeds, a failing one is a server error, and
+			// UUID 404s, a known one succeeds.
-			// any other 404s.
+			if chi.URLParam(r, "uuid") != "known" {
-			switch chi.URLParam(r, "uuid") {
-			case knownEntrypointUUID:
-				w.WriteHeader(http.StatusOK)
-			case failingEntrypointUUID:
-				http.Error(
-					w, "boom", http.StatusInternalServerError,
-				)
-			default:
 				http.Error(w, "not found", http.StatusNotFound)
+
+				return
 			}
+
+			w.WriteHeader(http.StatusOK)
 		},
 	)
 
@@ -661,84 +649,17 @@ func TestAccessLog_SuccessKeepsConcretePathAndRedactsQuery(
 	router := accessLogRouter(m)
 
 	assert.Equal(
-		t, http.StatusOK,
+		t, http.StatusOK, get(t, router, "/h/known?src=ci"),
-		get(t, router, "/.well-known/healthcheck?src=ci"),
 	)
 
+	// The path resolved against a stored entrypoint, so it stays. The
+	// query never does: see TestAccessLog_UnauthenticatedSuccess...
 	entries := accessLogEntries(t, buf)
 	require.Len(t, entries, 1)
-	assert.Equal(
+	assert.Equal(t, "/h/known?(redacted)", entries[0]["url"])
-		t, "/.well-known/healthcheck?(redacted)", entries[0]["url"],
-	)
 	assert.NotContains(t, buf.String(), "src=ci")
 }
 
-// TestAccessLog_ReceiverNeverLogsTheUUID covers the two statuses that
-// keep the concrete path on every other route. On the receiver that
-// path carries the entrypoint UUID, so the line names the route
-// pattern instead.
-func TestAccessLog_ReceiverNeverLogsTheUUID(t *testing.T) {
-	t.Parallel()
-
-	for entrypointUUID, wantStatus := range map[string]int{
-		knownEntrypointUUID:   http.StatusOK,
-		failingEntrypointUUID: http.StatusInternalServerError,
-	} {
-		t.Run(strconv.Itoa(wantStatus), func(t *testing.T) {
-			t.Parallel()
-
-			m, buf := capturingMiddleware(t)
-			router := accessLogRouter(m)
-
-			assert.Equal(
-				t, wantStatus,
-				get(t, router, "/h/"+entrypointUUID+"?src=ci"),
-			)
-
-			entries := accessLogEntries(t, buf)
-			require.Len(t, entries, 1)
-			assert.Equal(t, middleware.ReceiverRoute, entries[0]["url"])
-			assert.NotContains(t, buf.String(), entrypointUUID)
-		})
-	}
-}
-
-// TestAccessLog_ReceiverPreflightNeverLogsTheUUID sends a CORS
-// preflight to the receiver in dev, in the production middleware
-// order. CORS answers it with 200 before chi routes it, so the line
-// names no route and carries no UUID.
-func TestAccessLog_ReceiverPreflightNeverLogsTheUUID(t *testing.T) {
-	t.Parallel()
-
-	m, buf := capturingMiddleware(t)
-
-	router := chi.NewRouter()
-	router.Use(m.Logging())
-	router.Use(m.CORS())
-	router.HandleFunc(
-		middleware.ReceiverRoute,
-		func(w http.ResponseWriter, _ *http.Request) {
-			w.WriteHeader(http.StatusOK)
-		},
-	)
-
-	req := httptest.NewRequestWithContext(
-		context.Background(), http.MethodOptions,
-		"/h/"+knownEntrypointUUID, nil,
-	)
-	req.Header.Set("Origin", "https://sender.example")
-	req.Header.Set("Access-Control-Request-Method", http.MethodPost)
-
-	w := httptest.NewRecorder()
-	router.ServeHTTP(w, req)
-	assert.Equal(t, http.StatusOK, w.Code)
-
-	entries := accessLogEntries(t, buf)
-	require.Len(t, entries, 1)
-	assert.Equal(t, unmatchedRouteLiteral, entries[0]["url"])
-	assert.NotContains(t, buf.String(), knownEntrypointUUID)
-}
-
 func TestAccessLog_ServerErrorKeepsConcreteURL(t *testing.T) {
 	t.Parallel()
 

internal/middleware/logbound_test.go

@@ -10,10 +10,8 @@ package middleware_test
 //     the client's choosing.
 //   - CSRF's 403 rejection, at WARN, also registered ahead of
 //     RequireAuth.
-//   - The rate limiters' 429 rejection, at WARN. On the receiver
+//   - The rate limiters' 429 rejection, at WARN, on the
-//     route it names the route pattern rather than the path, and
+//     unauthenticated receiver among others.
-//     the limiters that log a path sit behind RequireAuth, so its cap
-//     is defensive.
 //   - RequireAuth's own unauthenticated-request line, at DEBUG.
 //   - RecordLoginFailure's throttle rejection, at WARN. Its cap is
 //     defensive rather than load-bearing today: chi pins the one
@@ -270,14 +268,10 @@ func logSites() map[string]logSite {
 			send:       postNoToken,
 			wantStatus: http.StatusForbidden,
 		},
-		// The 429 line every limiter but the aggregate one shares.
+		// The per-entrypoint receiver limiter, unauthenticated. Its
-		// Mounted outside any route, as here, it logs the path, as
+		// bucket is keyed on the path, so the first request through a
-		// it does for the limiters behind RequireAuth; on
+		// fresh path is served and only the ones after it are
-		// ReceiverRoute it names the pattern instead. The
+		// rejected; sendUntilLimited absorbs that.
-		// per-entrypoint receiver limiter's bucket is keyed on the
-		// path, so the first request through a fresh path is served
-		// and only the ones after it are rejected; sendUntilLimited
-		// absorbs that.
 		"receiver rate limit 429": {
 			build: func(
 				t *testing.T, m *middleware.Middleware,

internal/middleware/metrics.go

@@ -41,8 +41,7 @@ const unmatchedMethod = unmatchedRoute
 // after /h/ is client-chosen, so labelling by path lets any
 // unauthenticated client mint permanent series at will, and publishes
 // the entrypoint UUID (the receiver's only credential) in the scrape
-// while doing it. The access log and the 429 line read it for the
+// while doing it.
-// same reason: see ReceiverRoute.
 //
 // chi populates the route context during routeHTTP, so this is only
 // valid once routing has run. Every caller below is on the recording

internal/middleware/middleware.go

@@ -13,6 +13,7 @@ import (
 	"time"
 
 	basicauth "github.com/99designs/basicauth-go"
+	"github.com/go-chi/chi"
 	"github.com/go-chi/chi/middleware"
 	"github.com/go-chi/cors"
 	"github.com/prometheus/client_golang/prometheus"
@@ -95,14 +96,14 @@ const (
 	// It is also the ceiling on every OTHER line this service writes
 	// THROUGH SLOG that carries text an UNAUTHENTICATED client
 	// supplies. Those lines — the MaxBodySize rejection, the CSRF
-	// rejection, the unauthenticated-request DEBUG line, the
+	// rejection, the rate-limit rejection, the unauthenticated-request
-	// failed-login DEBUG lines, and the two login-throttle WARN
+	// and unknown-entrypoint DEBUG lines, the failed-login DEBUG
-	// lines ("login failure limit exceeded" in loginguard.go and
+	// lines, and the two login-throttle WARN lines ("login failure
-	// "password verification capacity exhausted" in
+	// limit exceeded" in loginguard.go and "password verification
-	// internal/handlers/auth.go) — spend the same per-field budgets,
+	// capacity exhausted" in internal/handlers/auth.go) — spend the
-	// and each carries strictly fewer client-supplied fields than the
+	// same per-field budgets, and each carries strictly fewer
-	// access log does, so none of them can reach a width the access
+	// client-supplied fields than the access log does,
-	// log cannot. That is
+	// so none of them can reach a width the access log cannot. That is
 	// asserted directly, per line and under both handlers, rather than
 	// left to the reasoning: see logbound_test.go in this package and
 	// in internal/handlers.
@@ -150,12 +151,6 @@ const (
 	MaxAccessLogLineBytes = 2560
 )
 
-// ReceiverRoute is the route pattern the webhook receiver is served
-// at. Its path carries the entrypoint UUID, which is the receiver's
-// only credential, so the log lines this package writes name a
-// request on this route by the pattern, never by its path.
-const ReceiverRoute = "/h/{uuid}"
-
 //nolint:revive // MiddlewareParams is a standard fx naming convention.
 type MiddlewareParams struct {
 	fx.In
@@ -273,14 +268,14 @@ func (lrw *loggingResponseWriter) Unwrap() http.ResponseWriter {
 // marker.
 //
 // The path on those branches is bounded by the service's routes or by
-// the operator's data — a 2xx under /s means the file is in the
+// the operator's data — a 2xx on the receiver means the UUID named a
-// embedded tree. The query is not bounded by anything:
+// stored entrypoint, a 2xx under /s means the file is in the embedded
-// /.well-known/healthcheck and /s/* take no authentication and sit
+// tree. The query is not bounded by anything: /.well-known/healthcheck
-// behind no rate limiter, and /pages/login behind only the login
+// and /s/* take no authentication and sit behind no rate limiter, and
-// limiter, so any of them will answer 200 to a URL carrying an
+// /pages/login behind only the login limiter, so any of them will
-// arbitrary number of arbitrary bytes after the '?'. Keeping the path
+// answer 200 to a URL carrying an arbitrary number of arbitrary bytes
-// and dropping the query is what makes this branch as bounded as the
+// after the '?'. Keeping the path and dropping the query is what makes
-// pattern branches below.
+// this branch as bounded as the pattern branches below.
 //
 // Nothing debuggable is lost. The only query parameters the service
 // reads are the login page's `next`, the page to return to,
@@ -302,40 +297,36 @@ func concreteLogURL(r *http.Request) string {
 
 // accessLogURL returns the value for the access log's url field.
 //
-// On ReceiverRoute it is the route pattern whatever the status, so
+// 2xx and 5xx responses get the concrete path (see concreteLogURL). A
-// the entrypoint UUID in the path is never logged. A request chi never
+// success resolved against a static route or against the operator's
-// routed gets unmatchedRoute whatever the status, for the same reason:
+// own data — on the receiver, a 2xx means the UUID named a stored
-// in dev, CORS answers a preflight to the receiver before routing.
+// entrypoint — and a server error is our own bug, where the exact URL
-//
+// is the primary evidence and which no client can provoke at will.
-// On every other route, 2xx and 5xx responses get the concrete path
-// (see concreteLogURL). A success resolved against a static route or
-// against the operator's own data, and a server error is our own bug,
-// where the exact URL is the primary evidence and which no client can
-// provoke at will.
 //
 // 3xx and 4xx responses get the chi route pattern instead. Those are
-// the outcomes an unauthenticated client drives for free, such as a
+// the outcomes an unauthenticated client drives for free: 404 or 429
-// 303 to the login page on any invented /user/ path. Logging the
+// on any invented /h/ path, 303 to the login page on any
-// concrete URL there lets a flood write attacker-chosen text, of
+// invented /user/ path. Logging the concrete URL there lets a flood
-// attacker-chosen length, into the operator's log at one line per
+// write attacker-chosen text, of attacker-chosen length, into the
-// request. The pattern comes from the router's own table, so it is
+// operator's log at one line per request. The pattern comes from the
-// bounded by the service's routes while still naming which class of
+// router's own table, so it is bounded by the service's routes while
-// request was rejected.
+// still naming which class of request was rejected.
 //
 // The pattern is only populated once routing has run, so this must be
 // called after the handler returns, not before.
 func accessLogURL(r *http.Request, status int) string {
-	pattern := routePatternID(r.Context())
-	if pattern == ReceiverRoute || pattern == unmatchedRoute {
-		return pattern
-	}
-
 	if status < http.StatusMultipleChoices ||
 		status >= http.StatusInternalServerError {
 		return concreteLogURL(r)
 	}
 
-	return pattern
+	if rc := chi.RouteContext(r.Context()); rc != nil {
+		if pattern := rc.RoutePattern(); pattern != "" {
+			return pattern
+		}
+	}
+
+	return unmatchedRoute
 }
 
 // Logging returns middleware that logs each HTTP request with

internal/middleware/ratelimit.go

@@ -259,28 +259,26 @@ func (m *Middleware) clientAddr(r *http.Request) (netip.Addr, bool) {
 	return peer, true
 }
 
-// tooManyRequests returns the 429 handler used by the postRateLimit
+// tooManyRequests returns the 429 handler used by the
-// limiters and the per-entrypoint receiver limiter: it logs the
+// password-change and per-entrypoint receiver limiters: it logs the
 // rejection with logMessage and answers with responseMessage.
 // httprate adds the Retry-After header (RFC 6585). The aggregate
 // receiver limiter uses floodTooManyRequests instead.
 //
-// On ReceiverRoute the line names the route pattern, so the
+// The path is capped against the same budget as the access log's url
-// entrypoint UUID in the path is never logged. Elsewhere it names the
+// field. The per-entrypoint receiver limiter is unauthenticated and
-// path, capped against the same budget as the access log's url field;
+// its path is a client-chosen segment of client-chosen length, so at
-// the limiters there sit behind RequireAuth, so the cap is defensive.
+// WARN an uncapped path would let a sender pick the size of the line
+// it writes — the same defect the access log capping closed.
 func (m *Middleware) tooManyRequests(
 	logMessage, responseMessage string,
 ) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
-		path := r.URL.Path
-		if routePatternID(r.Context()) == ReceiverRoute {
-			path = ReceiverRoute
-		}
-
 		m.log.Warn(
 			logMessage,
-			"path", logfield.Truncate(path, logfield.MaxBytes),
+			"path", logfield.Truncate(
+				r.URL.Path, logfield.MaxBytes,
+			),
 			"remoteIP", RemoteIP(r),
 			"clientIP", ClientIP(r),
 		)

internal/server/routes.go

@@ -6,8 +6,7 @@ import (
 
 	sentryhttp "github.com/getsentry/sentry-go/http"
 	"github.com/go-chi/chi"
-	chimw "github.com/go-chi/chi/middleware"
+	"github.com/go-chi/chi/middleware"
-	"sneak.berlin/go/webhooker/internal/middleware"
 	"sneak.berlin/go/webhooker/static"
 )
 
@@ -61,7 +60,7 @@ func (s *Server) SetupRoutes() {
 }
 
 func (s *Server) setupGlobalMiddleware() {
-	s.router.Use(chimw.RequestID)
+	s.router.Use(middleware.RequestID)
 	s.router.Use(s.mw.SecurityHeaders())
 	s.router.Use(s.mw.Logging())
 
@@ -346,7 +345,7 @@ func (s *Server) setupWebhookRoutes() {
 	// unauthenticated endpoint's body; TestReceiver_OversizeBodyRefused
 	// pins it.
 	s.router.With(s.mw.ReceiverRateLimit()).HandleFunc(
-		middleware.ReceiverRoute,
+		"/h/{uuid}",
 		s.h.HandleWebhook(),
 	)
 }