coder / coder/websocket

Reconsider and document redirect policy

Offen
#518 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Go
Sterne
5.5k
Forks
372
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

## The problem

It looks like that by default the library uses the default HTTPClient:

https://github.com/coder/websocket/blob/d1468a75eee5525d183123766fbf288dca1eed9b/dial.go#L76-L103

And [the default HTTP client](https://pkg.go.dev/net/http#Client) _does_ follow redirects:

> // If CheckRedirect is nil, the Client uses its default policy,
> // which is to stop after 10 consecutive requests.

Edit: actually, doesn't the fact that we _do_ specify a `CheckRedirect` function mean that we do not stop after 10 consecutive requests?

I am aware that it is possible to provide your own `HTTPClient` struct to the `Dial()` function, and it is nice to rely on built-in defaults, I think a WebSocket library should be more concrete in this regard. Especially given the fact that this particular one claims to be able to target WASM. And, according to [the browser WebSocket spec](https://websockets.spec.whatwg.org/#websocket-opening-handshake), redirects are not followed:

> [redirect mode](https://fetch.spec.whatwg.org/#concept-request-redirect-mode) is "error"

> The reason redirects are not followed and this handshake is generally restricted is because it could introduce serious security problems in a web browser context. For example, consider a host with a WebSocket server at one path and an open HTTP redirector at another. Suddenly, any script that can be given a particular WebSocket URL can be tricked into communicating to (and potentially sharing secrets with) any host on the internet, even if the script checks that the URL has the right hostname.

This IMO can be considered an inconsistency between different targets.
Note that changing redirect policy for the WASM version is not possible, according to this library's docs:

> HTTPClient, HTTPHeader and CompressionMode in DialOptions are no-op

***

For reference, the WebSocket spec itself states:

> the server might redirect the client using a 3xx status code (but clients are not required to follow them)

Also for reference, the Gorilla WebSocket library IMU does not follow redirects, see this issue: https://github.com/gorilla/websocket/pull/965 and [the code](https://github.com/gorilla/websocket/blob/5e002381133d322c5f1305d171f3bdd07decf229/client.go#L377-L388).

## Suggested solution

1. Document that the library follows redirects, but not in the WASM version.
2. For the next version: Do not follow redirects by default, and document this.
This can either be considered a breaking change (so it goes to v2.x.x), or a bug fix.

***

Related issue: https://github.com/coder/websocket/issues/333

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Start with dial.go at lines 76-103 and the library documentation describing DialOptions, then compare the redirect behavior with the cited WebSocket specification and WASM limitations. Clarify and document the current policy, and determine whether the default should change in a future version; related issue #333 provides additional context.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
go
Bereich
api, networking
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.