Skip to main content
← Back to list
01Issue
FeatureShippedSwamp Club
Assigneesstack72

Relationships

#1122 Docs: document WebSocket Bearer header and Sec-WebSocket-Protocol auth transports

Opened by stack72 · 7/13/2026· Shipped 7/13/2026

Context

#1119 adds Authorization: Bearer header and Sec-WebSocket-Protocol: bearer.* subprotocol as additional accepted token transports on the WebSocket upgrade path in swamp serve --auth-mode token. The existing ?token= query parameter continues to work.

What needs updating

The swamp-serve reference docs in swamp-club/swamp-club under content/manual/reference/swamp-serve/ should document:

  • Authorization: Bearer header: clients can send Authorization: Bearer <name>.<secret> on the WebSocket upgrade request
  • Sec-WebSocket-Protocol subprotocol: browser clients can use Sec-WebSocket-Protocol: bearer.<name>.<secret> since the browser WebSocket API cannot set custom headers
  • Query parameter: ?token=<name>.<secret> continues to work as before
  • Priority order: Bearer header > Sec-WebSocket-Protocol > query parameter (when multiple are present)
  • Security note: Bearer header avoids token exposure in proxy access logs, browser history, and Referer headers that affect query-string tokens

Automoved by swampadmin from https://github.com/swamp-club/swamp/issues/1838

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 5 MOREREVIEW+ 3 MOREPR_MERGED+ 1 MORENOTIFICATION_SKIPPED

Shipped

7/13/2026, 11:28:47 PM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack727/13/2026, 11:08:44 PM

Sign in to post a ripple.